backend: Add support for scheduled door

Author: matevz

Diff for: README.md

@@ -11,6 +11,7 @@ Supports:
 - controlling IR illuminator relay for night vision
 - reading input button, if you want to open/close door manually on-site without
   a smart phone
+- support for scheduled door opening and closing on sunrise and sunset
 - stores the current state into config file so the door remain in position
   in case of power shortage
 
@@ -31,7 +32,7 @@ Install dependencies:
 
 ```sh
 sudo apt install python3-libgpiod # also installs libgpiod2
-pip install adafruit-circuitpython-dht
+pip install adafruit-circuitpython-dht astral
 ```
 
 Run backend with

Diff for: backend/chickencoop_backend.py

@@ -1,15 +1,17 @@
 #!/usr/bin/python
 
-import json
 import dataclasses
+from datetime import datetime, timezone
 from http.server import BaseHTTPRequestHandler, HTTPServer
+import json
 import logging
 import RPi.GPIO as GPIO
+from urllib.parse import parse_qs
 
-from datetime import datetime, timezone
 import config
 from status import Status
 import manual_door
+import schedule
 import temperature
 
 HOSTNAME = ''
@@ -40,14 +42,10 @@ def do_GET(s):
 			status.temperature = avgT
 			status.current_datetime = datetime.now(timezone.utc)
 			s.wfile.write(json.dumps(dataclasses.asdict(status), default=str).encode())
-		elif s.path.startswith("/door_down"):
-			status.door = False
-			config.save_cfg_from_status(status)
-			update_gpio()
-		elif s.path.startswith("/door_up"):
-			status.door = True
-			config.save_cfg_from_status(status)
-			update_gpio()
+		elif s.path.startswith("/door_open"):
+			door_open()
+		elif s.path.startswith("/door_close"):
+			door_close()
 		elif s.path.startswith("/light_on"):
 			status.light = True
 			config.save_cfg_from_status(status)
@@ -59,6 +57,25 @@ def do_GET(s):
 		else:
 			s.send_response(404)
 
+	def do_POST(s):
+		content_length = int(s.headers['Content-Length'])
+		post_raw = s.rfile.read(content_length)
+		post = parse_qs(post_raw.decode(), strict_parsing=True)
+		print(post_raw)
+		print(post)
+		if "action" in post and len(post["action"])==1:
+			if post["action"][0] == "apply_schedule":
+				status.schedule_city = post["schedule_city"][0]
+				status.schedule_door_open = ("schedule_door_open" in post)
+				status.schedule_door_close = ("schedule_door_close" in post)
+				status.schedule_door_open_offset = int(post["schedule_door_open_offset"][0])
+				status.schedule_door_close_offset = int(post["schedule_door_close_offset"][0])
+				config.save_cfg_from_status(status)
+				schedule.reset_today_state()
+
+		s.send_response(200)
+		s.send_header("Content-type", "application/json")
+		s.end_headers()
 
 def init_gpio():
 	GPIO.cleanup()
@@ -78,6 +95,20 @@ def update_gpio():
 	GPIO.output(config.MASTER_SWITCH_PIN, status.master)
 
 
+def door_open():
+	global status
+	status.door = True
+	config.save_cfg_from_status(status)
+	update_gpio()
+
+
+def door_close():
+	global status
+	status.door = False
+	config.save_cfg_from_status(status)
+	update_gpio()
+
+
 def switch_door():
 	global status
 
@@ -89,12 +120,14 @@ def switch_door():
 
 
 if __name__ == '__main__':
+	status = config.load_cfg_to_status()
+
 	logging.basicConfig(level=logging.DEBUG)
 	init_gpio()
 	manual_door.init_manual_door_service(switch_door)
 	temperature.init_temperature_service()
+	schedule.init_schedule_service(door_open, door_close, status)
 
-	status = config.load_cfg_to_status()
 	update_gpio()
 
 	httpd = HTTPServer((HOSTNAME, PORT), ChickenCoopHTTPHandler)
@@ -104,7 +137,9 @@ def switch_door():
 	except:
 		pass
 	httpd.server_close()
+	schedule.stop_schedule_service()
 	temperature.stop_temperature_service()
 	manual_door.stop_manual_door_service()
+	GPIO.output(config.MASTER_SWITCH_PIN, False)
 	GPIO.cleanup()
 	logging.info('Server stopped - keyboard interrupt')

Diff for: backend/config.py

@@ -25,15 +25,25 @@
 
 @dataclass
 class Config:
-    door: bool # True=up, False=down
-    light: bool # True=on, False=off
-    master: bool # True=on, False=off
+    door: bool                         # True=door opened, False=door closed
+    light: bool                        # True=on, False=off
+    master: bool                       # True=on, False=off
+    schedule_city: str = ""            # Closest city to the chicken coop to compute accurate sunrise/sunset times
+    schedule_door_open: bool = False   # Is scheduled door opening enabled
+    schedule_door_close: bool = False  # Is scheduled door closing enabled
+    schedule_door_open_offset: int = 0  # Offset in opening the door on sunrise in minutes
+    schedule_door_close_offset: int = 0 # Offset in closing the door on sunset in minutes
 
 def default_cfg() -> Config:
     return Config(
         door=False,
         light=False,
         master=True,
+        schedule_city="",
+        schedule_door_open=False,
+        schedule_door_close=False,
+        schedule_door_open_offset=0,
+        schedule_door_close_offset=0,
     )
 
 
@@ -61,6 +71,11 @@ def load_cfg_to_status() -> Status:
         humidity=0,
         current_datetime=datetime.min,
         last_manual_door_datetime=datetime.min,
+        schedule_city=cfg.schedule_city,
+        schedule_door_open=cfg.schedule_door_open,
+        schedule_door_close=cfg.schedule_door_close,
+        schedule_door_open_offset=cfg.schedule_door_open_offset,
+        schedule_door_close_offset=cfg.schedule_door_close_offset,
     )
 
 
@@ -69,6 +84,11 @@ def save_cfg_from_status(status: Status):
         door=status.door,
         light=status.light,
         master=status.master,
+        schedule_city=status.schedule_city,
+        schedule_door_open=status.schedule_door_open,
+        schedule_door_close=status.schedule_door_close,
+        schedule_door_open_offset=status.schedule_door_open_offset,
+        schedule_door_close_offset=status.schedule_door_close_offset,
     ))
 
 

Diff for: backend/schedule.py

@@ -0,0 +1,101 @@
+import astral, astral.geocoder, astral.sun
+from datetime import datetime, timedelta, timezone
+import logging
+import RPi.GPIO as GPIO
+import threading
+from typing import Any, Dict
+import time
+
+from status import Status
+
+from config import MANUAL_DOOR_BUTTON_PIN
+
+# Number of seconds between two schedule checks.
+SCHEDULE_SLEEP = 60
+
+# Number of seconds after the door up/down event is still considered.
+SCHEDULE_THRESHOLD = 300
+
+# Is checking the schedule service main loop running.
+SCHEDULE_ENABLED = False
+
+# Configuration.
+status: Status
+
+# Main door loop thread.
+t: threading.Thread
+
+# Current astral's sun info, updated regularly by the main loop.
+sun: Dict[str, Any]
+
+# Status for today.
+today_date = datetime.min
+today_door_opened = False
+today_door_closed = False
+
+
+def init_schedule_service(door_open_callback, door_close_callback, s):
+	global SCHEDULE_ENABLED, t, status
+	status = s
+
+	t = threading.Thread(target=check_time, args=[door_open_callback, door_close_callback])
+	SCHEDULE_ENABLED = True
+	t.start()
+
+
+def stop_schedule_service():
+	global SCHEDULE_ENABLED
+	SCHEDULE_ENABLED = False
+	t.join()
+
+
+def check_time(door_open_callback, door_close_callback):
+	global status, SCHEDULE_SLEEP, SCHEDULE_THRESHOLD, SCHEDULE_ENABLED, sun, today_date, today_door_opened, today_door_closed
+
+	reset_today_state()
+
+	while SCHEDULE_ENABLED:
+		if today_date != datetime.now().date():
+			reset_today_state()
+
+		city = astral.geocoder.lookup("London", astral.geocoder.database())
+		try:
+			city = astral.geocoder.lookup("London" if status.schedule_city == "" else status.schedule_city,
+										  astral.geocoder.database())
+		except KeyError:
+
+
+		sun = astral.sun.sun(city.observer)
+		status.schedule_sunrise = sun['sunrise']
+		status.schedule_sunset = sun['sunset']
+
+		opening_time = sun['sunrise'] + timedelta(minutes=status.schedule_door_open_offset)
+		closing_time = sun['sunset'] + timedelta(minutes=status.schedule_door_close_offset)
+
+		logging.info(f'schedule: now {datetime.now()}')
+		logging.info(f'schedule: city: {city}, sun: {sun}')
+		logging.info(f'schedule: opening_time {opening_time}, closing_time {closing_time}')
+		logging.info(f'schedule: opening_time + threshold: {opening_time + timedelta(seconds=SCHEDULE_THRESHOLD)}, closing_time + threshold: {closing_time + timedelta(seconds=SCHEDULE_THRESHOLD)}')
+		logging.info(f'schedule: today_door_opened {today_door_opened}, today_door_closed {today_door_closed}')
+		logging.info(f'schedule: schedule_door_open {status.schedule_door_open}, schedule_door_close {status.schedule_door_close}')
+
+		if not today_door_opened and status.schedule_door_open and opening_time < datetime.now(timezone.utc) < opening_time + timedelta(seconds=SCHEDULE_THRESHOLD):
+			logging.info("Door open schedule event! Good morning 🌅")
+			door_open_callback()
+			today_door_opened = True
+
+		if not today_door_closed and status.schedule_door_close and closing_time < datetime.now(timezone.utc) < closing_time + timedelta(seconds=SCHEDULE_THRESHOLD):
+			logging.info("Door close schedule event! Good night 🌇")
+			door_close_callback()
+			today_door_closed = True
+
+		time.sleep(SCHEDULE_SLEEP)
+
+
+def reset_today_state():
+	global today_date, today_door_opened, today_door_closed
+
+	logging.info(f'schedule: resetting today state, old values: {today_date}, {today_door_opened}, {today_door_closed}')
+	today_date = datetime.now().date()
+	today_door_opened = False
+	today_door_closed = False

Diff for: backend/status.py

@@ -11,3 +11,10 @@ class Status:
     master: bool
     current_datetime: datetime
     last_manual_door_datetime: datetime
+    schedule_city: str
+    schedule_door_open: bool
+    schedule_door_close: bool
+    schedule_door_open_offset: int
+    schedule_door_close_offset: int
+    schedule_sunrise: datetime = datetime.min
+    schedule_sunset: datetime = datetime.min