Show only dates with events (#5)

* Rename Arduino sketch
* Render the next 5 days of events, skipping empty days
* Fix timezone issues
* Update README
* poetry update
* Bump version

Author: stefanthoss

README.md

@@ -37,7 +37,7 @@ Some features of the dashboard:
 
 4. Using the DNS name or IP of your host machine, you can go to  <http://IP_ADDRESS:5000/docs> to see whether the API is running.
 
-5. As for the Inkplate, I'm not going to devote too much space here since there are [official resources that describe how to set it up](https://inkplate.readthedocs.io/en/latest/get-started.html). It may take some trial and error for those new to microcontroller programming but it's all worth it! Only the Arduino portion of the guide is relevant, and you'll need to be able to run *.ino scripts via Arduino IDE before proceeding. From there, run the `inkplate.ino` file from the `inkplate` folder from the Arduino IDE when connected to the Inkplate.
+5. As for the Inkplate, I'm not going to devote too much space here since there are [official resources that describe how to set it up](https://inkplate.readthedocs.io/en/latest/get-started.html). It may take some trial and error for those new to microcontroller programming but it's all worth it! Only the Arduino portion of the guide is relevant, and you'll need to be able to run *.ino scripts via Arduino IDE before proceeding. From there, run the `inkplate10.ino` file from the `inkplate10` folder from the Arduino IDE when connected to the Inkplate.
 
 6. That's all! Your Magic Dashboard should now be refreshed every hour! 
 
@@ -57,10 +57,9 @@ DISPLAY_TZ | No | America/Los_Angeles | Time zone for displaying the calendar
 LAT | No | 34.118333 | Latitude in decimal of the location to retrieve weather forecast for
 LNG | No | -118.300333 | Longitude in decimal of the location to retrieve weather forecast for
 WEATHER_UNITS | No | metric | Units of measurement for the temperature, `metric` and `imperial` units are available
-NUM_CAL_DATS_TO_SHOW | No | 5 | Number of days to show from the calendar
+NUM_CAL_DAYS_TO_QUERY | No | 30 | Number of days to query from the calendar
 IMAGE_WIDTH | No | 1200 | Width of image to be generated for display
 IMAGE_HEIGHT | No | 825 | Height of image to be generated for display
-ROTATE_ANGLE | No | 0 | If image is rendered in portrait orientation, angle to rotate to fit screen
 
 ## Development
 

inkplate/inkplate.ino renamed to inkplate10/inkplate10.ino

@@ -1,6 +1,6 @@
 [tool.poetry]
 name = "mag-ink-dash-plus"
-version = "0.2.0"
+version = "0.3.0"
 description = "E-Ink Magic Dashboard that runs off a battery powered Inkplate 10; displaying content from an ICS calendar feed and OpenWeatherMap that are retrieved and rendered by a Docker container."
 authors = ["speedyg0nz", "stefanthoss"]
 license = "Apache License 2.0"

poetry.lock

@@ -2,7 +2,6 @@
 import sys
 
 import structlog
-from pytz import timezone
 
 from owm.owm import WeatherUnits
 
@@ -20,14 +19,16 @@ class MagInkDashConfig:
     if not OWM_API_KEY:
         logger.error("OWM_API_KEY needs to be set.")
         sys.exit(1)
-    DISPLAY_TZ: timezone = timezone(os.getenv("DISPLAY_TZ", "America/Los_Angeles"))
-    NUM_CAL_DATS_TO_SHOW: int = int(os.getenv("NUM_CAL_DATS_TO_SHOW", 5))
+    DISPLAY_TZ: str = os.getenv("DISPLAY_TZ", "America/Los_Angeles")
+    NUM_CAL_DAYS_TO_QUERY: int = int(os.getenv("NUM_CAL_DAYS_TO_QUERY", 30))
     IMAGE_WIDTH: int = int(os.getenv("IMAGE_WIDTH", 1200))
     IMAGE_HEIGHT: int = int(os.getenv("IMAGE_HEIGHT", 825))
-    ROTATE_ANGLE: int = int(os.getenv("ROTATE_ANGLE", 0))
     LAT: float = float(os.getenv("LAT", 34.118333))
     LNG: float = float(os.getenv("LNG", -118.300333))
     WEATHER_UNITS: WeatherUnits = WeatherUnits[os.getenv("WEATHER_UNITS", "metric")]
+    NUM_DAYS_IN_TEMPLATE: int = (
+        5  # Not configurable because it's hard-coded in the HTML template
+    )
 
     def get_config():
         global _current_config

pyproject.toml

@@ -2,6 +2,8 @@
 This is where we retrieve events from an ICS calendar.
 """
 
+import datetime as dt
+
 import structlog
 
 from ics_cal.icshelper import IcsHelper
@@ -12,10 +14,6 @@ def __init__(self):
         self.logger = structlog.get_logger()
         self.calHelper = IcsHelper()
 
-    def get_day_in_cal(self, startDate, eventDate):
-        delta = eventDate - startDate
-        return delta.days
-
     def get_short_time(self, datetimeObj):
         datetime_str = ""
         if datetimeObj.minute > 0:
@@ -31,28 +29,23 @@ def get_short_time(self, datetimeObj):
             datetime_str = "{}{}am".format(str(datetimeObj.hour), datetime_str)
         return datetime_str
 
-    def get_events(
-        self, currDate, ics_url, calStartDatetime, calEndDatetime, displayTZ, numDays
-    ):
+    def get_events(self, ics_url, calStartDatetime, calEndDatetime, displayTZ, numDays):
         eventList = self.calHelper.retrieve_events(
             ics_url, calStartDatetime, calEndDatetime, displayTZ
         )
 
-        # check if event stretches across multiple days
-        calList = []
-        for i in range(numDays):
-            calList.append([])
+        calDict = {}
+
         for event in eventList:
-            idx = self.get_day_in_cal(currDate, event["startDatetime"].date())
             if event["isMultiday"]:
-                end_idx = self.get_day_in_cal(currDate, event["endDatetime"].date())
-                if idx < 0:
-                    idx = 0
-                if end_idx >= len(calList):
-                    end_idx = len(calList) - 1
-                for i in range(idx, end_idx + 1):
-                    calList[i].append(event)
-            elif idx >= 0:
-                calList[idx].append(event)
-
-        return calList
+                numDays = (
+                    event["endDatetime"].date() - event["startDatetime"].date()
+                ).days
+                for day in range(0, numDays):
+                    calDict.setdefault(
+                        event["startDatetime"].date() + dt.timedelta(days=day), []
+                    ).append(event)
+            else:
+                calDict.setdefault(event["startDatetime"].date(), []).append(event)
+
+        return calDict

src/config.py

@@ -9,6 +9,7 @@
 import datetime as dt
 import sys
 
+import arrow
 import requests
 import structlog
 from ics import Calendar
@@ -18,37 +19,11 @@ class IcsHelper:
     def __init__(self):
         self.logger = structlog.get_logger()
 
-    def to_datetime(self, isoDatetime, localTZ):
-        # replace Z with +00:00 is a workaround until datetime library decides what to do with the Z notation
-        to_datetime = dt.datetime.fromisoformat(isoDatetime.replace("Z", "+00:00"))
-        return to_datetime.astimezone(localTZ)
-
-    def adjust_end_time(self, endTime, localTZ):
-        # check if end time is at 00:00 of next day, if so set to max time for day before
-        if endTime.hour == 0 and endTime.minute == 0 and endTime.second == 0:
-            newEndtime = localTZ.localize(
-                dt.datetime.combine(
-                    endTime.date() - dt.timedelta(days=1), dt.datetime.max.time()
-                )
-            )
-            return newEndtime
-        else:
-            return endTime
-
-    def is_multiday(self, start, end):
-        # check if event stretches across multiple days
-        return start.date() != end.date()
-
     def retrieve_events(self, ics_url, startDatetime, endDatetime, localTZ):
-        # Call the Google Calendar API and return a list of events that fall within the specified dates
+        # Call the ICS calendar and return a list of events that fall within the specified dates
         event_list = []
 
-        # TODO: Filter calendar events by time
-        min_time_str = startDatetime.isoformat()
-        max_time_str = endDatetime.isoformat()
-
         self.logger.info("Retrieving events from ICS...")
-
         response = requests.get(ics_url)
         if response.ok:
             cal = Calendar(response.text)
@@ -61,19 +36,34 @@ def retrieve_events(self, ics_url, startDatetime, endDatetime, localTZ):
         if not cal.events:
             self.logger.info("No upcoming calendar events found.")
         for event in cal.events:
-            # extracting and converting events data into a new list
-            new_event = {"summary": event.name}
-            new_event["allday"] = event.all_day
-            new_event["startDatetime"] = self.to_datetime(
-                event.begin.isoformat(), localTZ
-            )
-            new_event["endDatetime"] = self.adjust_end_time(
-                self.to_datetime(event.end.isoformat(), localTZ), localTZ
-            )
-            new_event["isMultiday"] = self.is_multiday(
-                new_event["startDatetime"], new_event["endDatetime"]
-            )
-            event_list.append(new_event)
+            if event.begin >= arrow.Arrow.fromdatetime(
+                startDatetime
+            ) and event.begin < arrow.Arrow.fromdatetime(endDatetime):
+                # extracting and converting events data into a new list
+                new_event = {"summary": event.name}
+                new_event["allday"] = event.all_day
+
+                if new_event["allday"]:
+                    # All-day events are always midnight UTC to midnight UTC, therefore timezone needs to be set
+                    new_event["startDatetime"] = dt.datetime.fromisoformat(
+                        event.begin.replace(tzinfo=localTZ).isoformat()
+                    )
+                    new_event["endDatetime"] = dt.datetime.fromisoformat(
+                        event.end.replace(tzinfo=localTZ).isoformat()
+                    )
+                else:
+                    # Other events need to be translated to local timezone
+                    new_event["startDatetime"] = dt.datetime.fromisoformat(
+                        event.begin.to(localTZ).isoformat()
+                    )
+                    new_event["endDatetime"] = dt.datetime.fromisoformat(
+                        event.end.to(localTZ).isoformat()
+                    )
+
+                new_event["isMultiday"] = (
+                    new_event["endDatetime"] - new_event["startDatetime"]
+                ) > dt.timedelta(days=1)
+                event_list.append(new_event)
 
         # We need to sort eventList because the event will be sorted in "calendar order" instead of hours order
         # TODO: improve because of double cycle for now is not much cost

src/ics_cal/ics.py

@@ -6,13 +6,11 @@
 retrieve the information. So feel free to change up the code and amend it to your needs.
 """
 
-import datetime
-import os
+import datetime as dt
 import tempfile
 import time
-from datetime import datetime as dt
-from typing import Optional
 
+import pytz
 import structlog
 import uvicorn
 from fastapi import FastAPI
@@ -25,7 +23,7 @@
 
 cfg = MagInkDashConfig.get_config()
 
-app = FastAPI(title="MagInkDashPlus Server", version="0.2.0")
+app = FastAPI(title="MagInkDashPlus Server", version="0.3.0")
 
 logger = structlog.get_logger()
 
@@ -56,24 +54,23 @@ def get_image() -> FileResponse:
         cfg.LAT, cfg.LNG, cfg.OWM_API_KEY, cfg.WEATHER_UNITS
     )
 
-    # Retrieve Calendar Data
-    currTime = dt.now(cfg.DISPLAY_TZ)
+    currTime = dt.datetime.now(pytz.timezone(cfg.DISPLAY_TZ))
     currDate = currTime.date()
-    calStartDatetime = cfg.DISPLAY_TZ.localize(dt.combine(currDate, dt.min.time()))
-    calEndDatetime = cfg.DISPLAY_TZ.localize(
-        dt.combine(
-            currDate + datetime.timedelta(days=cfg.NUM_CAL_DATS_TO_SHOW - 1),
-            dt.max.time(),
-        )
+    calStartDatetime = currTime.replace(hour=0, minute=0, second=0, microsecond=0)
+    calEndDatetime = calStartDatetime + dt.timedelta(
+        days=cfg.NUM_CAL_DAYS_TO_QUERY, seconds=-1
     )
-    eventList = calModule.get_events(
-        currDate,
+
+    events = calModule.get_events(
         cfg.ICS_URL,
         calStartDatetime,
         calEndDatetime,
         cfg.DISPLAY_TZ,
-        cfg.NUM_CAL_DATS_TO_SHOW,
+        cfg.NUM_CAL_DAYS_TO_QUERY,
     )
+    events_sorted = sorted(
+        events.items(), key=lambda x: x[0]
+    )  # sort by date so we can later take the first N days
 
     end_time = time.time()
     logger.info(
@@ -87,16 +84,13 @@ def get_image() -> FileResponse:
         start_time = time.time()
         logger.info(f"Generating image...")
 
-        renderService = RenderHelper(
-            cfg.IMAGE_WIDTH, cfg.IMAGE_HEIGHT, cfg.ROTATE_ANGLE
-        )
+        renderService = RenderHelper(cfg)
         renderService.process_inputs(
             currTime,
             current_weather,
             hourly_forecast,
             daily_forecast,
-            eventList,
-            cfg.NUM_CAL_DATS_TO_SHOW,
+            events_sorted[: cfg.NUM_DAYS_IN_TEMPLATE],
             tf.name,
         )