Merge pull request #38 from jef41/feature/wifi_reconnect

v1.2.0 release, wifi reconnect rewritten & status now shown in card stack
prior 1.2.0 was a bit too soon

Author: jef41

README.md

@@ -77,7 +77,6 @@ Custom configurations can be used by creating a file `config.json` in the root d
 |`ssid` (str) | SSID for your wifi newtork | None | [Example config](examples/wifi.md) |
 |`password` (str) | password for your wifi newtork | None | [Example config](examples/wifi.md) |
 |`country_code` (str) | ISO 3166-1 alpha-2 character country code for wifi | `None` | [Example config](examples/wifi.md) |
-|`wifi_check_interval` (int) | Check there is a working internet conenction every n seconds | `3600` | [Example config](examples/wifi.md) |
 |`debug_log` (list) | How many kb in each and how many debug backup files to keep | `[20, 1]` |  |
 |`display_type` (str) | currently only option is "DISPLAY_PICO_DISPLAY" | None | [Example config](examples/display.md) |
 |`display_update_secs` (float) | how frequently to cycle content of display screen | `5` | [Example config](examples/display.md) |
@@ -197,19 +196,21 @@ SIMULATE_BEACONS = False
 
 # Status LED
 
-The Pico board has an onbaord LED. This is used to give a basic visual indication of the condittion of the code. The table below should help to interpret the LED status;
+The Pico board has an onboard LED. This is used to give a basic visual indication of the condition of the code. The table below should help to interpret the LED status;
 
 
 | Condition                     | Appearance                 | Timing (on/off) milliseconds           | Indication                |
 | ---------------------------- | ---------------------------- | --------------------- | --------------------- |
 |STARTUP | solid ON | None | The Pico is in its initial startup state, loading variables etc. It should progress within 1 second to initiate a wifi connection |
-|CONNECTING | fast blink (on-off ~ twice per second) | 10, 400 | Initial configuration loaded, connecting to wifi |
-|CONNECTED | 1Hz blink brief | 200, 800 | The Pico has connected to wifi. It willl progress from this state once a stable wifi connection has been established |
-|NOT CONNECTED | 1Hz blink slow | 800, 200 | A wifi connection has not been established. If not using wifi (i.e. logging locally to file) this will not be a problem |
-|RUNNING | blink once per 3 secs | 10, 3,000 | The application is running and listenting for data from Tilt devices |
+|CONNECTING | fast blink (on-off ~ twice per second) | 10, 400 | Initial configuration loaded, in process of connecting to wifi |
+|CONNECTED | 1Hz blink brief | 200, 800 | The Pico has connected to wifi. After 5 seconds it will progress from this state once a stable wifi connection has been established, or try to reconnect |
+|NOT CONNECTED | 1Hz blink slow | 800, 200 | A wifi connection has not been established. If not requiring wifi (i.e. logging locally to file) this will not be a problem |
+|RUNNING | blink once per 3 secs | 10, 3,000 | Once the startup routine has finished the LED should change to this status to indicate that the application is running and listenting for data from Tilt devices |
 
 If the LED remains solidly lit this indicates that the Pico has encountered an error. It is most likely that either the config.json file is not present, or this file is invalid. In this situation, use Thonny to connect to the device, inspect the debug.log file and correct the issue.
 
+During startup, if a LCD display is present, some information on progress (and errors) will be shown. Once starup has completed and the device is running, the display will normally report Tilt beacon data. If the wifi connection becomes disconnected the LED will revert to its `NOT CONNECTED` state and (if an LCD is present) the wifi connection status will be added to the display pages. The device will try to reconnect every 2 minutes, unless the password is detected as being incorrect, in which case the device will stop and cease to record Tilt data.
+
 # Integrations
 
 * [ ] [Prometheus](#Prometheus-Metrics)

bridge/lib/bridge_main.py

@@ -1,6 +1,5 @@
-"""central handler holds most coros & passes data between
-1.1.1 use enabled_tilts instead of colours_enabled - needs test
-TODO track how to store HD or SD
+""" central handler holds most coros & passes data between
+    1.1.1 use enabled_tilts instead of colours_enabled
 """
 import logging
 import gc
@@ -25,7 +24,7 @@
 class BridgeMain:
     logger = logging.getLogger("bridge")
 
-    def __init__(self):
+    def __init__(self, onboard_led=None):
         self.config = None
         self.providers = None
         self.data_archive = bytearray()  # Queue for holding incoming data from scans
@@ -36,7 +35,7 @@ def __init__(self):
         self.enabled_tilts = list()
         self.rtc = None
         self.wdt = None
-        self.onboard_led = None
+        self.onboard_led = onboard_led
         # Load config from file, with defaults, and args
         result = True
         gc.collect()
@@ -62,15 +61,10 @@ def __init__(self):
     def initialised(self):
         return self.rtc
 
-    async def bridge_main(self, onboard_led, simulate_beacons: bool = False):
+    async def bridge_main(self, simulate_beacons: bool = False):
         gc.collect()
-        self.onboard_led = onboard_led
-        # if providers is None:
-        #    self.providers = self.set_providers()
-        # else:
-        #    self.providers = providers
         # add any webhooks defined in config
-        # todo !! not currently implemented/tested
+        # TODO not currently implemented/tested
         self.webhook_providers = self._get_webhook_providers()
 
         if self.webhook_providers:
@@ -137,10 +131,7 @@ async def bridge_main(self, onboard_led, simulate_beacons: bool = False):
             self.logger.info("starting beacon scanner...")
             self.scanner = asyncio.create_task(self._scan_for_ibeacons())
             # pass
-        # either way create a task to update the display
-        # TODO self.display_enabled - def to test for attached display
-        #lcd_colours = {"simulated"} #, "red"}
-        #time.sleep(5)
+        # in either case create a task to update the display
         if self.display:
             self.display_updater = asyncio.create_task(self.display.card_stack(self.data_archive, self.enabled_tilts))
         try:
@@ -190,16 +181,13 @@ async def _scan_for_ibeacons(self, simulate=False):
                 adv_data = b"".join([pre, col, post, major, minor, tx_pwr])
                 #print(adv_data)
                 iBeacon_data = iBeaconStatus(adv_data, 0, "00:00:00:00:00:00")
-                # await _beacon_callback(uuid, major, minor, 0, 0, simulate)#, bridge_q)
-                # print(f'{iBeacon_data.colour} {col} {iBeacon_data.major} {iBeacon_data.minor}')
                 try:
                     task = asyncio.create_task(
                         self._beacon_callback(iBeacon_data, simulate)
                     )
                     # task running
                     await asyncio.sleep_ms(randrange(80, 120))  # pause here & give way
                     await task  # then wait for task to complete
-                    # res = await asyncio.gather(t1,t2, return_exceptions=True)
                 except (
                     asyncio.TimeoutError
                 ):  # These only happen if return_exceptions is False
@@ -208,8 +196,6 @@ async def _scan_for_ibeacons(self, simulate=False):
                     )  # With the default times, cancellation occurs first
                 except asyncio.CancelledError:
                     logger.warning("scanner Cancelled")
-                # asyncio.sleep_ms(randrange(100, 750))
-                # pckt_complete = True
             else:
                 async with aioble_central.scan(
                     duration_ms=5000,
@@ -437,17 +423,6 @@ def set_providers(self, network=False):
             )
         self.providers = normal_providers
 
-    def get_time(self):
-        result = False
-        try:
-            ntptime.settime()
-            self.logger.info("time set to UTC:{}".format(self.rtc.datetime()))
-            result = True
-        except:
-            # todo catch more specific exception
-            self.logger.info("npttime.settime() failed.")
-        return result
-
 
 def max_av_period(en_providers, tilt_devices):
     # return the maximum averaging value (seconds) for enabled providers
@@ -487,4 +462,4 @@ async def debug_memory(logger):
         logger.debug(f"gc: {gc.mem_free()}")
 
 
-__version__ = "1.0.2"
+__version__ = "1.1.2"

bridge/lib/configuration/__init__.py

@@ -1,4 +1,4 @@
 from .bridge_config import BridgeConfig
 #from .pitch_config import PitchConfig
 
-__version__ = '1.0.0'
+__version__ = '1.1.0'

bridge/lib/configuration/bridge_config.py

@@ -11,7 +11,6 @@ def __init__(self, data: dict):
         self.ssid = None
         self.password = None
         self.country_code = None
-        self.wifi_check_interval = 3600
         # Debug log
         self.debug_log = [20, 1]
         # Defaults
@@ -86,9 +85,6 @@ def get_original_gravity(self, colour: str):
         return self.__dict__.get(colour + '_original_gravity')
         #return getattr(self,colour + '_original_gravity', None)
 
-    #def get_temp_offset(self, colour: str):
-    #    return self.__dict__.get(colour + '_temp_offset', 0)
-
     def get_brew_name(self, colour: str):
         return self.__dict__.get(colour + '_name', colour)
         #return getattr(self, colour + '_name', colour)

bridge/lib/display_driver.py

@@ -1,5 +1,5 @@
-"""Classes to mediate between bridge_main and LCD LED devices
-16,17,18,19 SPI0_RX, SPI0_CSN, SPI0_SCK, SPI0_TX GPIO numbering
+""" Classes to mediate between bridge_main and LCD LED devices
+    16,17,18,19 SPI0_RX, SPI0_CSN, SPI0_SCK, SPI0_TX GPIO numbering
 """
 
 import gc
@@ -57,14 +57,10 @@ def __new__(cls, config: BridgeConfig):
     def __init__(self, config: BridgeConfig):
         self.config = config
         self.lcd = None  # getattr gpio pins
-        self.update_intvl = None
+        self.update_intvl = getattr(self.config, "display_update_secs", 3)
         self.brightness = None  # getattr
         self.indicator = True
         self.startup_msg = []
-        # lcd = PicoGraphics(display=DISPLAY_PICO_DISPLAY, pen_type=PEN_P4,rotate=0)
-        # lcd.set_backlight(1.0)
-        # update_frequency = 3 # seconds to cycle through each screen
-        # self._check_for_display(pins) if (pins := getattr(config, 'lcd_spi_gpio', None)) else None
         (
             self._check_for_display(display_type)
             if (display_type := getattr(self.config, "display_type", None))
@@ -80,7 +76,6 @@ def _check_for_display(self, display_type):
             pen_type=picographics.PEN_P4,
             rotate=0,
         )
-        # self.lcd = PicoGraphics(display=DISPLAY_PICO_DISPLAY, pen_type=PEN_P4,rotate=0)
         # Create palette mapping dynamically
         self.colour_to_palette = {
             colour: self.lcd.create_pen(*get_color_values(colour, 1))
@@ -109,20 +104,23 @@ async def card_stack(
     ):  #: TiltDevice
         # display the most recent data as basic & extended info for each tilt
         # some sort of loading screen
-        #blinky = asyncio.create_task(self.display_heartbeat())
-        del self.startup_msg
-        self.lcd.set_font("serif")
+        self.startup_msg = [] # clear startup messages
         while True:
             #index = 0
+            self.lcd.set_font("serif")
             for tilt in cards:
                 #if index == 0:
                 #    # print("show clock")
                 #    await self.display_clock()
                 # show standard info for each configured tilt colour
+                # & test for extended info
                 extended_info = await self.display_sg_t(tilt, tilt_data_store)
                 # return a tilt_status object or None
                 if extended_info:
                     await self.display_extended(tilt, extended_info)
+                if len(self.startup_msg):
+                    # there's probably a wifi disconnection
+                    await self.show_msg()
                 #index = (index + 1) % len(cards)
 
     def read_latest_vals(self, tilt_data_store, tilt_colour):
@@ -131,7 +129,7 @@ def read_latest_vals(self, tilt_data_store, tilt_colour):
         uncal_tempF, uncal_SG = tilt_data_store.get_data(
             tilt_colour,
             av_period=0,
-            log_period=(3 * getattr(self.config, "display_update_secs", 3)),
+            log_period=(3 * self.update_intvl),
         )
         if uncal_tempF and uncal_SG:
             tilt_status = TiltStatus(
@@ -152,11 +150,12 @@ def read_latest_vals(self, tilt_data_store, tilt_colour):
             uncal_temp, uncal_gravity, tilt_status = None, None, None
         return (uncal_temp, uncal_gravity, tilt_status)
 
+    '''
     async def display_clock(self):
         # show a clock or a MOTD or something
         width, height = self.lcd.get_bounds()
         offset = None
-        for _ in range(getattr(self.config, "display_update_secs", 3)):
+        for _ in range(self.update_intvl):
             self.lcd.set_pen(self.colour_to_palette["BG"])
             self.lcd.clear()
             self.lcd.set_thickness(2)
@@ -178,6 +177,7 @@ async def display_clock(self):
             self.lcd.update()
             await asyncio.sleep(1)
             # TODO subtract processing time from 1 second ticks_diff
+    '''
 
     async def display_sg_t(self, tilt, tilt_data_store):
         #
@@ -191,6 +191,7 @@ async def display_sg_t(self, tilt, tilt_data_store):
             tilt_data_store, tilt.colour
         )
         n = 4 if tilt.hd else 3
+        self.lcd.set_font("serif")
         self.lcd.set_pen(self.colour_to_palette["BG"])
         '''self.lcd.polygon([
           (0, 0),
@@ -275,11 +276,12 @@ async def display_sg_t(self, tilt, tilt_data_store):
         self.lcd.update()
         # t2 = time.ticks_ms()
         # print(f"standard drawing took:{time.ticks_diff(t1, t_start)}, update took:{time.ticks_diff(t2, t1)}")
-        await asyncio.sleep(getattr(self.config, "display_update_secs", 3))
+        await asyncio.sleep(self.update_intvl)
         return tilt_values if getattr(tilt_values, "original_gravity", None) else None
 
     async def display_extended(self, tilt, tilt_values):
         #
+        self.lcd.set_font("serif")
         self.lcd.set_pen(self.colour_to_palette["BG"])
         '''self.lcd.polygon([
           (0, 0),
@@ -327,7 +329,7 @@ async def display_extended(self, tilt, tilt_values):
         self.lcd.update()
         # t2 = time.ticks_ms()
         # print(f"extended drawing took:{time.ticks_diff(t1, t_start)}, update took:{time.ticks_diff(t2, t1)}")
-        await asyncio.sleep(getattr(self.config, "display_update_secs", 3))
+        await asyncio.sleep(self.update_intvl)
 
     def update_indicator(self):
         # alternate a little indicator so we know values are being received even if they are not changing
@@ -338,43 +340,45 @@ def update_indicator(self):
         self.indicator = not self.indicator
         self.lcd.circle(10, 60, 5) # x, y, r
 
-    def show_msg(self, msg, append=True):
-        #self.lcd.set_font("serif")
-        if append:
-            #self.startup_msg = self.startup_msg + "\n" + msg
-            try:
-                self.startup_msg.append(msg)
-            except NameError:
-                self.startup_msg = [msg]
+    async def show_msg(self, msg=None, append=True):
+        ''' if msg then add to list
+            display text
+        '''
+        intvl = 1 # 
+        if msg:
+            if append:
+                # not currently used, could remove append() property
+                try:
+                    self.startup_msg.append(msg)
+                except NameError:
+                    self.startup_msg = [msg]
+            else:
+                # overwrite last line
+                try:
+                    self.startup_msg[-1] = msg
+                except NameError:
+                    self.startup_msg = [msg]
         else:
-            # overwrite last line
-            #self.overwrite_msg(msg)
-            try:
-                self.startup_msg[-1] = msg
-            except NameError:
-                self.startup_msg = [msg]
+            # not adding a message
+            intvl = self.update_intvl
         self.lcd.set_font("bitmap8")
         self.lcd.set_pen(self.colour_to_palette["BG"])
         self.lcd.clear()
         self.lcd.set_thickness(1)
         self.lcd.set_pen(self.colour_to_palette["WHITE"])
         #self.lcd.text(msg, 0, 65, scale=1)
         #self.lcd.text(self.startup_msg, 0, 0)
+        while len(self.startup_msg) > 7:
+            # remove oldest messages
+            del self.startup_msg[0]
         self.lcd.text('\n'.join([item for item in self.startup_msg]), 0, 0)
         self.lcd.update()
-        time.sleep(1)
+        #time.sleep(1)
+        await asyncio.sleep(intvl)
 
-    '''def overwrite_msg(self, new_msg):
-        # overwrite the last line of a messgae
-        import re
-        regex = re.compile("[\n]")
-        msgs = regex.split(self.startup_msg)
-        if len(msgs)>0:
-            msgs[len(msgs)-1] = new_msg
-        else:
-            msgs[0] = new_msg
-        self.startup_msg = '\n'.join([item for item in msgs])
-        '''
+    def blocking_show_msg(self, msg, append=True):
+        ''' allow a synchronous display method  - used from main.py '''
+        asyncio.run(self.show_msg(msg, append))
 
 
 class RGB_Driver:
@@ -401,10 +405,6 @@ def off(self):
         # turn off
         self._led.set_rgb(0, 0, 0)
 
-    # def _init_rgb_task(self):
-    #    # ensure off at start
-    #    self.rgb_led.set_rgb(0,0,0)
-
     async def _flash_rgb_task(self, rgb_colours):
         #
         self._led.set_rgb(*rgb_colours)
@@ -435,4 +435,4 @@ def r_align(lcd_obj, txt, sz, width):
     return int(width - lcd_obj.measure_text(txt, sz))
 
 
-__version__ = "1.1.2"
+__version__ = "1.2.0"