Display timestamp of last update (#3)

* Add update timestamp
* Bump version
* Update README
* poetry update
* black formatting
* Change timestamp formatting
* Low battery on display

Author: stefanthoss

README.md

@@ -62,19 +62,21 @@ 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
 
-## Limitations
-
-* Recurring events in the ICS calendar feed are currently not supported
-
 ## Development
 
 Run
 
+```shell
+poetry run python src/main.py
+```
+
+or
+
 ```shell
 docker compose -f docker-compose.dev.yml up --build
 ```
 
-locally to build a new image and start it, API docs will be served at <http://localhost:5000/docs>.
+locally to start the application, API docs will be served at <http://localhost:5000/docs>.
 
 ## Acknowledgements
 

inkplate/inkplate.ino

@@ -1,12 +1,13 @@
 /*
   Adapted from the Inkplate10_Image_Frame_From_Web example for Soldered Inkplate 10
-  https://github.com/SolderedElectronics/Inkplate-Arduino-library/blob/2dd263f2f9548aadac8638413a143beddf068a64/examples/Inkplate10/Projects/Inkplate10_Image_Frame_From_Web/Inkplate10_Image_Frame_From_Web.ino
+  https://github.com/SolderedElectronics/Inkplate-Arduino-library/blob/2dd263f2f9548aadac8638413a143beddf068a64/examples/Inkplate10/Projects/Inkplate10_Image_Frame_From_Web/Inkplate10_Image_Frame_From_Web.ino and
+  https://github.com/SolderedElectronics/Inkplate-Arduino-library/blob/2dd263f2f9548aadac8638413a143beddf068a64/examples/Inkplate10/Advanced/Other/Inkplate10_Read_Battery_Voltage/Inkplate10_Read_Battery_Voltage.ino
 
   What this code does:
     1. Connect to a WiFi access point
     2. Retrieve an image from a web address
     3. Display the image on the Inkplate 10 device
-    4. (Optional) Check the battery level on the Inkplate device
+    4. Check the battery level on the Inkplate device
     5. Set a sleep timer for 60 minutes, and allow the Inkplate to go into deep sleep to conserve battery
 */
 
@@ -23,10 +24,9 @@ const char ssid[] = "YOUR WIFI SSID";  // Your WiFi SSID
 const char *password = "YOUR WIFI PASSWORD";  // Your WiFi password
 const char *imgurl = "http://url.to.your.server/image";  // Your dashboard image web address
 
-// Battery values
-#define BATTV_MAX    4.1     // maximum voltage of battery
-#define BATTV_MIN    3.2     // what we regard as an empty battery
-#define BATTV_LOW    3.4     // voltage considered to be low battery
+#define BATTV_MAX 4.1  // maximum voltage of battery
+#define BATTV_MIN 3.2  // what we regard as an empty battery
+#define BATTV_LOW 3.4  // voltage considered to be low battery
 
 void setup()
 {
@@ -36,25 +36,29 @@ void setup()
     // Join wifi
     display.connectWiFi(ssid, password);
 
+    // Display image from API
     if (!display.drawImage(imgurl, display.PNG, 0, 0))
     {
         // If is something failed (wrong filename or format), write error message on the screen.
         display.println("Image open error");
     }
-    display.display();
 
     double battvoltage = display.readBattery();
     int battpc = calc_battery_percentage(battvoltage);
     if (battvoltage < BATTV_LOW) {
-        char msg [100];
-        sprintf (msg, "Inkplate battery at %d%%, voltage at %.2fV", battpc, battvoltage); 
-        Serial.println(msg);
+        char msg [20];
+        sprintf (msg, "Battery: %d%%", battpc); 
+        display.setCursor(1100, 800);  // Inkplate 10 has a 9.7 inch, 1,200 x 825 pixel display
+        display.setTextSize(2);
+        display.setTextColor(BLACK);
+        display.print(msg);
     }
 
-    // Let display go to sleep to conserve battery, and wake up an hour later    
+    display.display();  // Send everything to display (refresh the screen)
+
     Serial.println("Going to sleep");
     delay(100);
-    esp_sleep_enable_timer_wakeup(60ll * 60 * 1000 * 1000); //wakeup in 60min time - 60min * 60s * 1000ms * 1000us
+    esp_sleep_enable_timer_wakeup(60ll * 60 * 1000 * 1000);  // Wake up in 60min time - 60min * 60s * 1000ms * 1000us
     esp_deep_sleep_start();
 }
 
@@ -74,4 +78,4 @@ int calc_battery_percentage(double battv)
         battery_percentage = 100;
 
     return battery_percentage;
-}
+}

poetry.lock

@@ -1,6 +1,6 @@
 [tool.poetry]
 name = "mag-ink-dash-plus"
-version = "0.1.0"
+version = "0.2.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"

pyproject.toml

@@ -25,7 +25,7 @@
 
 cfg = MagInkDashConfig.get_config()
 
-app = FastAPI(title="MagInkDashPlus Server", version="0.1.0")
+app = FastAPI(title="MagInkDashPlus Server", version="0.2.0")
 
 logger = structlog.get_logger()
 
@@ -38,7 +38,10 @@ def health_check():
     return {"status": "ok"}
 
 
-@app.get("/test", summary="Background image for testing",)
+@app.get(
+    "/test",
+    summary="Background image for testing",
+)
 def get_background() -> FileResponse:
     return FileResponse("render/background.png", media_type="image/png")
 
@@ -54,7 +57,8 @@ def get_image() -> FileResponse:
     )
 
     # Retrieve Calendar Data
-    currDate = dt.now(cfg.DISPLAY_TZ).date()
+    currTime = dt.now(cfg.DISPLAY_TZ)
+    currDate = currTime.date()
     calStartDatetime = cfg.DISPLAY_TZ.localize(dt.combine(currDate, dt.min.time()))
     calEndDatetime = cfg.DISPLAY_TZ.localize(
         dt.combine(
@@ -87,7 +91,7 @@ def get_image() -> FileResponse:
             cfg.IMAGE_WIDTH, cfg.IMAGE_HEIGHT, cfg.ROTATE_ANGLE
         )
         renderService.process_inputs(
-            currDate,
+            currTime,
             current_weather,
             hourly_forecast,
             daily_forecast,

src/main.py

@@ -8,10 +8,10 @@
         <link rel="stylesheet" href="css/styles.css">
         <link rel="stylesheet" href="css/weather-icons.min.css">
     </head>
-    <body style="background: url('background.png') no-repeat center center fixed; background-size: cover;>
+    <body style="background: url('background.png') no-repeat center center fixed; background-size: cover;">
         <div class="container">
-            <!-- Calendar -->
             <div class="row justify-content-center">
+                <!-- Weather -->
                 <div class="col-md-6">
                     <div class="row">
                         <div class="col-md-12">
@@ -88,9 +88,15 @@ <h3>{dayafter}<br />{dayafter_weather_pop}% | {dayafter_weather_min}-{dayafter_w
                         <div class="col-md-12"  style="height: 50px"></div>
                     </div>
                 </div>
+                <!-- Calendar -->
                 <div class="col-md-6">
                     <div class="row align-items-start ">
-                        <div class="col-md-12"  style="height: 50px"></div>
+                        <div class="col-md-12 text-right"  style="height: 25px">
+                            Last Updated: {update_time}
+                        </div>
+                    </div>
+                    <div class="row align-items-start ">
+                        <div class="col-md-12"  style="height: 25px"></div>
                     </div>
                     <div class="row align-items-start ">
                         <div class="col-md-12">

src/render/dashboard_template.html

@@ -71,7 +71,7 @@ def get_short_time(self, datetimeObj, is24hour=False):
             datetime_str = "{}:{:02d}".format(datetimeObj.hour, datetimeObj.minute)
         else:
             if datetimeObj.minute > 0:
-                datetime_str = ".{:02d}".format(datetimeObj.minute)
+                datetime_str = ":{:02d}".format(datetimeObj.minute)
 
             if datetimeObj.hour == 0:
                 datetime_str = "12{}am".format(datetime_str)
@@ -85,7 +85,7 @@ def get_short_time(self, datetimeObj, is24hour=False):
 
     def process_inputs(
         self,
-        current_date,
+        current_time,
         current_weather,
         hourly_forecast,
         daily_forecast,
@@ -97,6 +97,8 @@ def process_inputs(
         with open(self.currPath + "/dashboard_template.html", "r") as file:
             dashboard_template = file.read()
 
+        current_date = current_time.date()
+
         # Populate the date and events
         cal_events_list = []
         for i in range(num_cal_days):
@@ -124,6 +126,7 @@ def process_inputs(
         htmlFile = open(self.currPath + "/dashboard.html", "w")
         htmlFile.write(
             dashboard_template.format(
+                update_time=current_time.strftime("%x %H:%M"),
                 day=current_date.strftime("%-d"),
                 month=current_date.strftime("%B"),
                 weekday=current_date.strftime("%A"),