# SPDX-License-Identifier: MIT # SPDX-FileCopyrightText: Copyright 2025 Sam Blenny # # See NOTES.md for documentation links and pinout info. # import board from microcontroller import cpu from micropython import const import os import time import wifi from sb_chardisplay import CharDisplay from sb_ircbot import IRCBot # --------------------------------------------------------------------------- # Options for settings.toml # - `WIFI_SSID = "your ssid"` set the SSID to use for your wifi # - `WIFI_PASSWORD = "the password"` set password for your wifi # - `IRC_SERVER = ""` set IP address for your IRC server # - `IRC_NICK = ""` set nickname to use for your IRC server # WIFI_SSID = None if (val := os.getenv("WIFI_SSID")) is not None: WIFI_SSID = str(val) WIFI_PASSWORD = None if (val := os.getenv("WIFI_PASSWORD")) is not None: WIFI_PASSWORD = str(val) IRC_SERVER = None if (val := os.getenv("IRC_SERVER")) is not None: IRC_SERVER = str(val) IRC_NICK = None if (val := os.getenv("IRC_NICK")) is not None: IRC_NICK = str(val) IRC_CHAN = None if (val := os.getenv("IRC_CHAN")) is not None: IRC_CHAN = str(val) # --------------------------------------------------------------------------- def print_settings_banner(): # Print startup banner showing if settings.toml is missing something heading = '# === IRC Dashboard Gadget Settings ===' m = 'missing' print() print(heading) print('# WIFI_SSID: [%s]' % (m if WIFI_SSID is None else 'ok')) print('# WIFI_PASSWORD: [%s]' % (m if WIFI_PASSWORD is None else 'ok')) print('# IRC_SERVER: [%s]' % (m if IRC_SERVER is None else 'ok')) print('# IRC_NICK: [%s]' % (m if IRC_NICK is None else 'ok')) print('# IRC_CHAN: [%s]' % (m if IRC_CHAN is None else 'ok')) print('# ' + ('=' * (len(heading)-2))) def wifi_connect(): # Try to connect to wifi if WIFI_SSID and WIFI_PASSWORD: try: wifi.radio.connect(ssid=WIFI_SSID, password=WIFI_PASSWORD) ip = wifi.radio.ipv4_address return ip except ConnectionError as e: print(e) return None def run(): # This has the main program logic. Putting these things inside a function # helps force me to avoid spaghetti code. When lots of stuff lives in the # global namespace, it's too easy to write functions that unintentionally # reference global variables. print_settings_banner() cd = CharDisplay() # Reduce CPU frequency so the board runs cooler. The default ESP32-S3 # default frequency is 240 MHz. To avoid messing up time.monotonic(), don't # attempt to set this below 80 MHz. if 'esp32s3' in board.board_id: cpu.frequency = 80_000_000 # Wrap the radio stuff in a big retry loop RETRY_S = const(5) RETRY_S_MAX = const(180) WIFI_RETRY = const(20) READ_TIME = const(0.8) # give me time to read the screen irc_retry = RETRY_S while True: # Ensure Wifi is up if not wifi.radio.connected: while True: cd.set_status("WiFi Connect...") time.sleep(READ_TIME) ip = wifi_connect() if ip: cd.set_status('WiFi IP is %s' % ip) time.sleep(READ_TIME) break else: # Wifi problem: sleep for a bit then try again cd.set_status('Wifi Down') time.sleep(WIFI_RETRY) continue else: cd.set_status("WiFi already connected") time.sleep(READ_TIME) # Ensure IRC is up, then start responding to IRC messages cd.set_status("IRC Connect...") time.sleep(READ_TIME) radio = wifi.radio with IRCBot(IRC_NICK, IRC_CHAN, IRC_SERVER, port=6667) as irc: while radio.connected and not irc.connected: # If initial connect failed, retry with exponential backoff time.sleep(irc_retry) irc_retry = min(RETRY_S_MAX, irc_retry * 2) cd.set_status('IRC Connect Retry...') time.sleep(READ_TIME) irc.connect() irc.register() # Main IRC bot loop last_rx = time.monotonic() PING_TIMEOUT = const(200) while radio.connected and irc.connected: line = irc.recv_line() if line is None: if time.monotonic() - last_rx > PING_TIMEOUT: # Something's wrong. It's too quiet. Close & reconnect cd.set_status('IRC: connection timeout') irc.close() time.sleep(irc_retry) irc_retry = min(RETRY_S_MAX, irc_retry * 2) break time.sleep(0.010) continue last_rx = time.monotonic() (prefix, cmd, params) = line print(cmd, params) if cmd == '433': # - 433 * :Nickname already in use cd.set_status('IRC: Nick in use') irc.close() time.sleep(irc_retry) irc_retry = min(RETRY_S_MAX, irc_retry * 2) break elif cmd == 'PING': irc.pong(params) elif cmd == 'JOIN': my_nick = ':%s!' % IRC_NICK if prefix and prefix.find(my_nick) == 0: # Set status line to channel name when I join. Ignore # join notifications about other users. cd.set_status(params[1:]) # slice off leading ':' # SUCCESS: Joined OK, so reset the retry interval irc_retry = RETRY_S elif cmd == '332': # Channel topic notification for JOIN # Typical cmd+params format: `332 tftbot #sensors :!pre /` nickchan = '%s %s :' % (IRC_NICK, IRC_CHAN) pre = '!pre ' if not params.startswith(nickchan): continue text = params[len(nickchan):] if text.startswith(pre): # bot mode for displaying preformatted text with # dynamically slectable line delimeters: first char of # first word after the `!pre` is the delimeter that # gets replaced with line breaks text = text[len(pre):] if len(text) >= 1: delim = text[0] text = text[1:].replace(delim, '\n') cd.set_topic(text, wrap='pre') else: # Default to hard wrapping lines cd.set_topic(text, wrap='hard') elif cmd == 'TOPIC': # Channel topic notifiction after JOIN # Typical cmd+param format: `TOPIC #sensors :!pre /...` chan = '%s :' % IRC_CHAN pre = '!pre ' if not params.startswith(chan): continue text = params[len(chan):] if text.startswith(pre): # bot mode for displaying preformatted text with # dynamically slectable line delimeters: first char of # first word after the `!pre` is the delimeter that # gets replaced with line breaks text = text[len(pre):] if len(text) >= 1: delim = text[0] text = text[1:].replace(delim, '\n') cd.set_topic(text, wrap='pre') else: # Default to hard wrapping lines cd.set_topic(text, wrap='hard') # --- # Main entry point # --- run()