Merge branch 'rain-per-hour-and-day' into weather-underground

Author: sjefferson99

documentation/boards/enviro-weather.md

@@ -22,7 +22,9 @@ Enviro Weather is a super slimline all in one board for keeping a (weather) eye
 |Wind Speed|`wind_speed`|metres per second|m/s|`0.45`|
 |Voltage|`voltage`|volts|V|`4.035`|
 
-The rain today value is adjusted for local time (and/or DST) by modifying the utc_offset value in config.py
+The rain today value is adjusted for DST in the UK by setting uk_bst = True in config.py
+For static time zone offsets (not taking account of DST), modify the utc_offset value in config.py
+The time zone offset value is ignored if uk_bst = True
 
 ## On-board devices
 

enviro/boards/weather.py

@@ -148,39 +148,56 @@ def wind_direction():
 
 def rainfall(seconds_since_last):
   new_rain_entries = []
-  amount = 0
+  amount = 0 # rain since last reading
   per_hour = 0
   today = 0
+  offset = 0 # UTC offset hours
+  
+  # configure offset variable for UK BST or timezone offset from config file
+  # and BST lookup function
+  if config.uk_bst == True:
+    if helpers.uk_bst():
+      offset = 1
+  elif config.utc_offset != 0:
+    offset += config.utc_offset
+
+  # determine current day number and timestamp
   now = helpers.timestamp(helpers.datetime_string())
-  now_day = helpers.timestamp_day(helpers.datetime_string(), config.utc_offset)
+  now_day = helpers.timestamp_day(helpers.datetime_string(), offset)
   logging.info(f"> current day number is {now_day}")
+  
+  # process the rain file data
   if helpers.file_exists("rain.txt"):
     with open("rain.txt", "r") as rainfile:
       rain_entries = rainfile.read().split("\n")
 
-    # process the rain file data
+    # populate latest, per second, today and last hour readings from rain log
+    # file, write new rain log file dropping any yesterday readings
     for entry in rain_entries:
       if entry:
         ts = helpers.timestamp(entry)
         tsday = helpers.timestamp_day(entry, config.utc_offset)
         logging.info(f"> rain reading day number is {tsday}")
-        # count how many rain ticks since the last reading
+        # populate amount with rain since the last reading
         if now - ts < seconds_since_last:
           amount += RAIN_MM_PER_TICK
-          # Pick up any untracked yesterday data if current reading is a new day
-          # Techincally this should be yesterday, but capturing in today is much
-          # less complex than backdating in the readings file from here
+          # add any rain ticks from yesterday since the previous reading
+          # this will misallocate day totals, but will ensure the hourly total
+          # is correct without introducing complexity backdating yesterday and
+          # the error will be minimised with frequent readings
+          # TODO sum yesterday rain and generate a rain_today reading with
+          # 23:59:59 timestamp of yesterday
           if tsday != now_day:
             today += RAIN_MM_PER_TICK
         # count how many rain ticks in the last hour
         if now - ts < 3600:
           per_hour += RAIN_MM_PER_TICK
-        # count how many rain ticks today and delete older entries
+        # count how many rain ticks today and drop older entries for new file
         if tsday == now_day:
           today += RAIN_MM_PER_TICK
           new_rain_entries.append(entry)
 
-    # write out adjusted rain log
+    # write out new adjusted rain log
     with open("rain.txt", "w") as newrainfile:
       newrainfile.write("\n".join(new_rain_entries))
 

enviro/config_defaults.py

@@ -2,6 +2,8 @@
 from phew import logging
 
 DEFAULT_USB_POWER_TEMPERATURE_OFFSET = 4.5
+DEFAULT_UTC_OFFSET = 0
+DEFAULT_UK_BST = True
 
 
 def add_missing_config_settings():
@@ -42,11 +44,17 @@ def add_missing_config_settings():
     warn_missing_config_setting("height_above_sea_level")
     config.height_above_sea_level = 0
 
+  try:
+    config.uk_bst
+  except AttributeError:
+    warn_missing_config_setting("uk_bst")
+    config.uk_bst = DEFAULT_UK_BST
+
   try:
     config.utc_offset
   except AttributeError:
     warn_missing_config_setting("utc_offset")
-    config.utc_offset = 0
+    config.utc_offset = DEFAULT_UTC_OFFSET
 
 def warn_missing_config_setting(setting):
     logging.warn(f"> config setting '{setting}' missing, please add it to config.py")

enviro/config_template.py

@@ -12,8 +12,12 @@
 wifi_ssid = None
 wifi_password = None
 
-# For local time corrections to daily rain logging (include DST)
-utc_offset = 1
+# Adjust daily rain day for UK BST
+uk_bst = True
+
+# For local time corrections to daily rain logging other than BST
+# Ignored if uk_bst = True
+utc_offset = 0
 
 # how often to wake up and take a reading (in minutes)
 reading_frequency = 15

enviro/helpers.py

@@ -1,5 +1,6 @@
 from enviro.constants import *
 import machine, math, os, time, utime
+from phew import logging
 
 # miscellany
 # ===========================================================================
@@ -24,6 +25,32 @@ def timestamp(dt):
   second = int(dt[17:19])
   return time.mktime((year, month, day, hour, minute, second, 0, 0))
 
+def uk_bst():
+  # Return True if in UK BST - manually update bst_timestamps {} as needed
+  dt = datetime_string()
+  year = int(dt[0:4])
+  ts = timestamp(dt)
+  bst = False
+
+  bst_timestamps = {
+    2023: {"start": 1679792400, "end": 1698541200},
+    2024: {"start": 1711846800, "end": 1729990800},
+    2025: {"start": 1743296400, "end": 1761440400},
+    2026: {"start": 1774746000, "end": 1792890000},
+    2027: {"start": 1806195600, "end": 1824944400},
+    2028: {"start": 1837645200, "end": 1856394000},
+    2029: {"start": 1869094800, "end": 1887843600},
+    2030: {"start": 1901149200, "end": 1919293200}
+  }
+
+  if year in bst_timestamps:
+    if bst_timestamps[year]["start"] < ts and bst_timestamps[year]["end"] > ts:
+      bst = True
+  else:
+    logging.warn(f"> Current year is not in BST lookup dictionary: {year}")
+  return bst
+  
+
 # Return the day number of your timestamp string accommodating UTC offsets
 def timestamp_day(dt, offset_hours):
   # Bounce via timestamp to properly calculate hours change