Merge pull request #113 from pimoroni/patch

Major patch to fix a lot of the issues with Enviro

enviro/__init__.py

@@ -93,12 +93,17 @@ def stop_activity_led():
   # control never returns to here, provisioning takes over completely
 
 # all the other imports, so many shiny modules
-import machine, sys, os, json
+import machine, sys, os, ujson
 from machine import RTC, ADC
 import phew
 from pcf85063a import PCF85063A
 import enviro.helpers as helpers
 
+# read the state of vbus to know if we were woken up by USB
+vbus_present = Pin("WL_GPIO2", Pin.IN).value()
+
+#BUG Temporarily disabling battery reading, as it seems to cause issues when connected to Thonny
+"""
 # read battery voltage - we have to toggle the wifi chip select
 # pin to take the reading - this is probably not ideal but doesn't
 # seem to cause issues. there is no obvious way to shut down the
@@ -113,17 +118,20 @@ def stop_activity_led():
 battery_voltage /= sample_count
 battery_voltage = round(battery_voltage, 3)
 Pin(WIFI_CS_PIN).value(old_state)
+"""
 
 # set up the button, external trigger, and rtc alarm pins
 rtc_alarm_pin = Pin(RTC_ALARM_PIN, Pin.IN, Pin.PULL_DOWN)
-external_trigger_pin = Pin(EXTERNAL_INTERRUPT_PIN, Pin.IN, Pin.PULL_DOWN)
+# BUG This should only be set up for Enviro Camera
+# external_trigger_pin = Pin(EXTERNAL_INTERRUPT_PIN, Pin.IN, Pin.PULL_DOWN)
 
 # intialise the pcf85063a real time clock chip
 rtc = PCF85063A(i2c)
 i2c.writeto_mem(0x51, 0x00, b'\x00') # ensure rtc is running (this should be default?)
 rtc.enable_timer_interrupt(False)
 
 t = rtc.datetime()
+# BUG ERRNO 22, EINVAL, when date read from RTC is invalid for the pico's RTC.
 RTC().datetime((t[0], t[1], t[2], t[6], t[3], t[4], t[5], 0)) # synch PR2040 rtc too
 
 # jazz up that console! toot toot!
@@ -143,37 +151,68 @@ def stop_activity_led():
 print("")
 
 
-
+import network # TODO this was removed from 0.0.8
 def connect_to_wifi():
+  """ TODO what it was changed to
   if phew.is_connected_to_wifi():
     logging.info(f"> already connected to wifi")
     return True
+  """
 
   wifi_ssid = config.wifi_ssid
   wifi_password = config.wifi_password
 
   logging.info(f"> connecting to wifi network '{wifi_ssid}'")
+  """ TODO what it was changed to
   ip = phew.connect_to_wifi(wifi_ssid, wifi_password, timeout_seconds=30)
 
   if not ip:
     logging.error(f"! failed to connect to wireless network {wifi_ssid}")
     return False
 
   logging.info("  - ip address: ", ip)
+  """
+  wlan = network.WLAN(network.STA_IF)
+  wlan.active(True)
+  wlan.connect(wifi_ssid, wifi_password)
+
+  start = time.ticks_ms()
+  while time.ticks_diff(time.ticks_ms(), start) < 30000:
+    if wlan.status() < 0 or wlan.status() >= 3:
+      break
+    time.sleep(0.5)
 
-  return True
+  seconds_to_connect = int(time.ticks_diff(time.ticks_ms(), start) / 1000)
 
-# returns the reason we woke up
-def wake_reason():
-  reason = get_wake_reason()
-  return wake_reason_name(reason)
+  if wlan.status() != 3:
+    logging.error(f"! failed to connect to wireless network {wifi_ssid}")
+    return False
+
+  # a slow connection time will drain the battery faster and may
+  # indicate a poor quality connection
+  if seconds_to_connect > 5:
+    logging.warn("  - took", seconds_to_connect, "seconds to connect to wifi")
+
+  ip_address = wlan.ifconfig()[0]
+  logging.info("  - ip address: ", ip_address)
+
+  return True
 
 # log the error, blink the warning led, and go back to sleep
 def halt(message):
   logging.error(message)
   warn_led(WARN_LED_BLINK)
   sleep()
 
+# log the exception, blink the warning led, and go back to sleep
+def exception(exc):
+  import sys, io
+  buf = io.StringIO()
+  sys.print_exception(exc, buf)
+  logging.exception("! " + buf.getvalue())
+  warn_led(WARN_LED_BLINK)
+  sleep()
+
 # returns True if we've used up 90% of the internal filesystem
 def low_disk_space():
   if not phew.remote_mount: # os.statvfs doesn't exist on remote mounts
@@ -189,10 +228,13 @@ def sync_clock_from_ntp():
   from phew import ntp
   if not connect_to_wifi():
     return False
+  #TODO Fetch only does one attempt. Can also optionally set Pico RTC (do we want this?)
   timestamp = ntp.fetch()
   if not timestamp:
+    logging.error("  - failed to fetch time from ntp server")
     return False  
   rtc.datetime(timestamp) # set the time on the rtc chip
+  logging.info("  - rtc synched")
   return True
 
 # set the state of the warning led (off, on, blinking)
@@ -210,13 +252,18 @@ def warn_led(state):
 
 # returns the reason the board woke up from deep sleep
 def get_wake_reason():
+  import wakeup
+
   wake_reason = None
-  if button_pin.value():
+  if wakeup.get_gpio_state() & (1 << BUTTON_PIN):
     wake_reason = WAKE_REASON_BUTTON_PRESS
-  elif rtc_alarm_pin.value():
+  elif wakeup.get_gpio_state() & (1 << RTC_ALARM_PIN):
     wake_reason = WAKE_REASON_RTC_ALARM
-  elif not external_trigger_pin.value():
-    wake_reason = WAKE_REASON_EXTERNAL_TRIGGER
+  # TODO Temporarily removing this as false reporting on non-camera boards
+  #elif not external_trigger_pin.value():
+  #  wake_reason = WAKE_REASON_EXTERNAL_TRIGGER
+  elif vbus_present:
+    wake_reason = WAKE_REASON_USB_POWERED
   return wake_reason
 
 # convert a wake reason into it's name
@@ -227,26 +274,53 @@ def wake_reason_name(wake_reason):
     WAKE_REASON_BUTTON_PRESS: "button",
     WAKE_REASON_RTC_ALARM: "rtc_alarm",
     WAKE_REASON_EXTERNAL_TRIGGER: "external_trigger",
-    WAKE_REASON_RAIN_TRIGGER: "rain_sensor"
+    WAKE_REASON_RAIN_TRIGGER: "rain_sensor",
+    WAKE_REASON_USB_POWERED: "usb_powered"
   }
   return names.get(wake_reason)
 
 # get the readings from the on board sensors
 def get_sensor_readings():
-  readings = get_board().get_sensor_readings()
-  readings["voltage"] = battery_voltage
+  seconds_since_last = 0
+  now_str = helpers.datetime_string()
+  if helpers.file_exists("last_time.txt"):
+    now = helpers.timestamp(now_str)
+
+    time_entries = []
+    with open("last_time.txt", "r") as timefile:
+      time_entries = timefile.read().split("\n")
+
+    # read the first line from the time file
+    last = now
+    for entry in time_entries:
+      if entry:
+        last = helpers.timestamp(entry)
+        break
+
+    seconds_since_last = now - last
+    logging.info(f"  - seconds since last reading: {seconds_since_last}")
+
+
+  readings = get_board().get_sensor_readings(seconds_since_last)
+  readings["voltage"] = 0.0 # battery_voltage #Temporarily removed until issue is fixed
+
+  # write out the last time log
+  with open("last_time.txt", "w") as timefile:
+    timefile.write(now_str)  
+
   return readings
 
 # save the provided readings into a todays readings data file
 def save_reading(readings):
   # open todays reading file and save readings
   helpers.mkdir_safe("readings")
-  readings_filename = f"readings/{helpers.date_string()}.txt"
+  readings_filename = f"readings/{helpers.datetime_file_string()}.txt"
   new_file = not helpers.file_exists(readings_filename)
   with open(readings_filename, "a") as f:
     if new_file:
       # new readings file so write out column headings first
       f.write("timestamp," + ",".join(readings.keys()) + "\r\n")
+
     # write sensor data
     row = [helpers.datetime_string()]
     for key in readings.keys():
@@ -263,10 +337,12 @@ def cache_upload(readings):
     "model": model,
     "uid": helpers.uid()
   }
-  uploads_filename = f"uploads/{helpers.datetime_string()}.json"
+
+  uploads_filename = f"uploads/{helpers.datetime_file_string()}.json"
   helpers.mkdir_safe("uploads")
   with open(uploads_filename, "w") as upload_file:
-    json.dump(payload, upload_file)
+    #json.dump(payload, upload_file) # TODO what it was changed to
+    upload_file.write(ujson.dumps(payload))
 
 # return the number of cached results waiting to be uploaded
 def cached_upload_count():
@@ -279,56 +355,104 @@ def is_upload_needed():
 # upload cached readings to the configured destination
 def upload_readings():
   if not connect_to_wifi():
+    logging.error(f"  - cannot upload readings, wifi connection failed")
     return False
 
   destination = config.destination
-  exec(f"import enviro.destinations.{destination}")
-  destination_module = sys.modules[f"enviro.destinations.{destination}"]
-  for cache_file in os.ilistdir("uploads"):
-    with open(f"uploads/{cache_file[0]}", "r") as upload_file:
-      success = destination_module.upload_reading(json.load(upload_file))
-      if not success:
-        logging.error(f"! failed to upload '{cache_file[0]}' to {destination}")
+  try:
+    exec(f"import enviro.destinations.{destination}")
+    destination_module = sys.modules[f"enviro.destinations.{destination}"]
+    destination_module.log_destination()
+
+    for cache_file in os.ilistdir("uploads"):
+      try:
+        with open(f"uploads/{cache_file[0]}", "r") as upload_file:
+          status = destination_module.upload_reading(ujson.load(upload_file))
+          if status == UPLOAD_SUCCESS:
+            os.remove(f"uploads/{cache_file[0]}")
+            logging.info(f"  - uploaded {cache_file[0]}")
+          elif status == UPLOAD_RATE_LIMITED:
+            # write out that we want to attempt a reupload
+            with open("reattempt_upload.txt", "w") as attemptfile:
+              attemptfile.write("")
+
+            logging.info(f"  - rate limited, going to sleep for 1 minute")
+            sleep(1)
+          else:
+            logging.error(f"  ! failed to upload '{cache_file[0]}' to {destination}")
+            return False
+
+      except OSError:
+        logging.error(f"  ! failed to open '{cache_file[0]}'")
         return False
 
-      # remove the cache file now uploaded
-      logging.info(f"  - uploaded {cache_file[0]} to {destination}")
-
-    os.remove(f"uploads/{cache_file[0]}")
+      except KeyError:
+        logging.error(f"  ! skipping '{cache_file[0]}' as it is missing data. It was likely created by an older version of the enviro firmware")
 
+  except ImportError:
+    logging.error(f"! cannot find destination {destination}")
+    return False
+
   return True
 
 def startup():
   # write startup banner into log file
   logging.debug("> performing startup")
 
+  # get the reason we were woken up
+  reason = get_wake_reason()
+
   # give each board a chance to perform any startup it needs
   # ===========================================================================
   board = get_board()
   if hasattr(board, "startup"):
-    board.startup()
+    continue_startup = board.startup(reason)
+    # put the board back to sleep if the startup doesn't need to continue
+    # and the RTC has not triggered since we were awoken
+    if not continue_startup and not rtc.read_alarm_flag():
+      logging.debug("  - wake reason: trigger")
+      sleep()
 
   # log the wake reason
-  logging.info("  - wake reason:", wake_reason())
+  logging.info("  - wake reason:", wake_reason_name(reason))
 
   # also immediately turn on the LED to indicate that we're doing something
   logging.debug("  - turn on activity led")
   pulse_activity_led(0.5)
 
-def sleep():
+  # see if we were woken to attempt a reupload
+  if helpers.file_exists("reattempt_upload.txt"):
+    os.remove("reattempt_upload.txt")
+
+    logging.info(f"> {cached_upload_count()} cache file(s) still to upload")
+    if not upload_readings():
+      halt("! reading upload failed")
+
+    # if it was the RTC that woke us, go to sleep until our next scheduled reading
+    # otherwise continue with taking new readings etc
+    # Note, this *may* result in a missed reading
+    if reason == WAKE_REASON_RTC_ALARM:
+      sleep()
+
+def sleep(time_override=None):
   logging.info("> going to sleep")
 
   # make sure the rtc flags are cleared before going back to sleep
-  logging.debug("  - clearing and disabling timer and alarm")
+  logging.debug("  - clearing and disabling previous alarm")
+  rtc.clear_timer_flag() # TODO this was removed from 0.0.8
   rtc.clear_alarm_flag()
 
   # set alarm to wake us up for next reading
   dt = rtc.datetime()
   hour, minute = dt[3:5]
 
   # calculate how many minutes into the day we are
-  minute = math.floor(minute / config.reading_frequency) * config.reading_frequency
-  minute += config.reading_frequency
+  if time_override is not None:
+    minute += time_override
+  else:
+    minute = math.floor(minute / config.reading_frequency) * config.reading_frequency
+    minute += config.reading_frequency
+
   while minute >= 60:      
     minute -= 60
     hour += 1
@@ -356,14 +480,18 @@ def sleep():
     sys.exit()
 
   # we'll wait here until the rtc timer triggers and then reset the board
-  logging.debug("  - on usb power (so can't shutdown) halt and reset instead")
-  while not rtc.read_alarm_flag():    
-    time.sleep(0.25)
+  logging.debug("  - on usb power (so can't shutdown). Halt and wait for alarm or user reset instead")
+  board = get_board()
+  while not rtc.read_alarm_flag():
+    if hasattr(board, "check_trigger"):
+      board.check_trigger()
+
+    #time.sleep(0.25)
 
     if button_pin.value(): # allow button to force reset
       break
 
   logging.debug("  - reset")
 
   # reset the board
-  machine.reset()
+  machine.reset()