KalebClark · oxivanisher · Dec 15, 2019 · Dec 15, 2019 · Dec 15, 2019 · Dec 15, 2019
diff --git a/.gitattributes b/.gitattributes
@@ -0,0 +1,20 @@
+# Set default behavior to automatically normalize line endings
+* text=auto
+
+# Force LF line endings for all text files
+*.py text eol=lf
+*.txt text eol=lf
+*.md text eol=lf
+*.json text eol=lf
+*.sh text eol=lf
+*.yml text eol=lf
+*.yaml text eol=lf
+
+# Binary files
+*.png binary
+*.jpg binary
+*.jpeg binary
+*.gif binary
+*.ico binary
+*.ttf binary
+*.pickle binary
diff --git a/.gitignore b/.gitignore
@@ -2,7 +2,15 @@ google_secret.json
 *.pickle
 *.code-workspace
 *.pyc
+__pycache__/
+*.egg-info/
+dist/build/
+.mypy_cache/
 icons/*.png
 test.py
 config.json
-
+infowindow.jpg
+venv/
+.venv/
+.idea/
+driver
diff --git a/3d_files/fusion360/README.md b/3d_files/fusion360/README.md
@@ -1 +1 @@
-This file is the "Assembly" of all the parts needed to print. I left out the model of the Raspberry PI due to licensing. If you need the raspberry pi model, do a search on GrabCad there are a ton!
+This file is the "Assembly" of all the parts needed to print. I left out the model of the Raspberry PI due to licensing. If you need the raspberry pi model, do a search on GrabCad there are a ton!
diff --git a/README.md b/README.md
@@ -1,55 +1,223 @@
-![alt text](infowindow.jpg)
+![InfoWindow on a shelf](infowindow.jpg)
 
+# InfoWindow
 
-# Infowindow
-Rapsberry pi powered e-ink display for displaying information in an always on state. There are several other iterations of this project online, but they didnt do quite what I wanted them to. This is my version. Also keeping up my python skills as they dont get used as much as they used to!
+Raspberry Pi powered e-ink display showing calendar, todo items and weather in an always-on state.
+Built for the **Waveshare 7.5" V2 three-colour (black/red/white)** e-ink display.
+
+The goal is not a full-featured PIM — it is an *in your face* reminder of what is coming up next.
+Details stay in your calendar app, phone, or browser.
 
-The functionality is not meant to be an "end all solution for calendaring and Todo lists" The intent is to provide an *always  on* display to show me what is coming up next. I can then check in browser, phone, etc for details and updates to the data. In your face reminder.
 <div align="center">
   <a href="#features">Features</a> |
-  <a href="#installation">Installation</a> | 
-  <a href="#configuration">Configuration</a> | 
-  <a href="#running">Running</a> | 
+  <a href="#hardware-setup">Hardware</a> |
+  <a href="#installation">Installation</a> |
+  <a href="#configuration">Configuration</a> |
+  <a href="#running">Running</a> |
+  <a href="#local-development">Local development</a>
 </div>
 
+---
+
 ## Features
-* **Calendar**
-  * Google Calendar is the only calendar currently supported
-* **Todo List**
-  * Todoist
-  * Teamwork.com
-* **Weather**
-  * Open Weather Map current data only. Future plan for forecast data.
+
+| Area | Backends |
+|---|---|
+| **Calendar** | Google Calendar, CalDAV (Nextcloud etc.) |
+| **Todo** | Google Tasks, CalDAV (Nextcloud etc.), Teamwork |
+| **Weather** | OpenWeatherMap (current conditions) |
+
+Multiple backends can be enabled simultaneously — results are merged and sorted.
+
+---
+
+## Hardware setup
+
+### Enable SPI
+```bash
+sudo raspi-config   # Interface Options → SPI → Enable
+sudo reboot
+```
+
+### System packages
+```bash
+sudo apt install python3-dev libopenjp2-7 libxslt1.1
+```
+
+### Clone this repo
+```bash
+git clone https://github.com/oxivanisher/InfoWindow.git /home/pi/InfoWindow
+```
+
+### Clone the Waveshare e-Paper driver
+The driver is not bundled — clone it separately and symlink it into the project.
+Waveshare occasionally restructures their repo, so the path may need adjusting.
+```bash
+git clone https://github.com/waveshareteam/e-Paper.git /home/pi/e-Paper
+ln -s /home/pi/e-Paper/RaspberryPi_JetsonNano/python/lib/waveshare_epd/ \
+      /home/pi/InfoWindow/driver
+```
+
+---
 
 ## Installation
-### Get software
-Clone this repo onto your raspberry pi. Does not really matter where it is, but good option is in the `pi` users home directory: `/home/pi/InfoWindow`
 
-### Setup python modules
-Run `pip install -r requirements.txt`. This should install all required modules. I stuck to basic standard modules for ease of installation.
+```bash
+cd /home/pi/InfoWindow
+python3 -m venv venv
+source venv/bin/activate
+pip install -e ".[rpi,google,caldav]"
+```
+
+Install only the extras you need:
+
+| Extra | Installs |
+|---|---|
+| `rpi` | Raspberry Pi GPIO libraries (required on Pi) |
+| `google` | Google Calendar / Tasks API client |
+| `caldav` | CalDAV client (Nextcloud, etc.) |
+| `todoist` | Todoist stub *(v8 API discontinued — not functional)* |
+
+---
 
 ## Configuration
-You will need to configure a few things such as API Keys and location. Copy config.json-sample to config.json. Edit config.json to add your api keys and other information. 
+
+Copy the sample and fill in your details:
+```bash
+cp config.json-sample config.json
+```
 
 ### General
-* rotation: 0 - This is the rotation of the display in degrees. Leave at zero if you use it as a desktop display. Change to 180 if you have it mounted and hanging from a shelf.
+| Key | Values | Description |
+|---|---|---|
+| `rotation` | `0` / `180` | `0` for desktop use, `180` if mounted hanging from a shelf |
+| `timeformat` | `12h` / `24h` | Clock format used throughout |
+| `sunday_first_dow` | `true` / `false` | Week start day for calendar grouping |
+| `cell_spacing` | integer | Pixel padding inside cells |
+| `timezone` | e.g. `Europe/Zurich` | Local timezone |
+
+### Weather — OpenWeatherMap
+```json
+"weather": {
+    "api_key": "your-owm-key",
+    "city": "Zurich,CH",
+    "units": "metric"
+}
+```
+`units` accepts `metric`, `imperial`, or `standard` (Kelvin).
+
+### Google Calendar and Tasks
+
+1. Go to the [Google Cloud Console](https://console.cloud.google.com/apis/).
+2. Create a project (e.g. `infowindow`).
+3. Create an [OAuth consent screen](https://console.cloud.google.com/apis/credentials/consent).
+4. Create an [OAuth 2.0 client ID](https://console.cloud.google.com/apis/credentials) (type: *Desktop app*).
+5. Download the JSON file and save it as `google_secret.json` in the project directory.
+
+Enable the backends in `config.json`:
+```json
+"calendar_google": { "enabled": true, "additional": ["Contacts", "Birthdays"] },
+"todo_google":     { "enabled": true }
+```
+
+> **Note:** There is a known Google API bug where repeated tasks stop appearing once one
+> instance is marked complete. See the [Google support thread](https://support.google.com/calendar/thread/3706294).
 
-### Todo
-Todoist is the current active module in this code. It only requires `api_key`. Teamwork also requires a 'site' key. If using google tasks, leave this as null `todo: null`
-* api_key: Enter your todoist API key.
+### CalDAV (Nextcloud etc.)
 
-### Weather
-Open Weather Map is where the data is coming from in the default module. This requires a few keys.
-* api_key: Get your api key from OWM website.
-* city: Look at OWM docs to figure what your city name is. Mine is "Sacramento,US"
-* units: This can either be `imperial` or `metric`
+For Nextcloud the CalDAV URL is usually:
+`https://cloud.example.com/remote.php/dav/calendars/USERNAME`
 
+```json
+"calendar_caldav": {
+    "enabled": true,
+    "caldav_url": "https://cloud.example.com/remote.php/dav/calendars/USERNAME",
+    "username": "john",
+    "password": "secret",
+    "additional": ["Personal", "Birthdays"]
+},
+"todo_caldav": {
+    "enabled": true,
+    "caldav_url": "https://cloud.example.com/remote.php/dav/calendars/USERNAME",
+    "username": "john",
+    "password": "secret",
+    "additional": ["Tasks"]
+}
+```
+
+`additional` is a list of calendar names to include. Leave it empty (`[]`) to include all.
+
+`ignored` (under `calendar`) is a list of event titles to suppress from the display.
+
+---
 
 ## Running
-### First Run
-You should run the script manually the first time so that Googles auth modules can run interactivly. Once that has completed you will want to add this to CRON so it runs every few minutes automatically.
 
-### Cron Run (Normal use)
-* Run `crontab -e`
-* insert `*/6 * * * * /usr/bin/python /home/pi/InfoWindow/infowindow.py --cron` 
+### First run — Google authentication
+If you use Google backends, run the script **manually once** so the OAuth flow can open
+interactively and save a token:
+```bash
+source venv/bin/activate
+python infowindow.py
+```
+
+Subsequent runs use the saved `token.pickle` and refresh it automatically.
+
+### systemd (recommended)
+
+The `dist/` directory contains ready-to-use systemd units.
+Link them into place — no need to copy, so pulling updates keeps them current:
+
+```bash
+sudo ln -s /home/pi/InfoWindow/dist/infowindow.service          /etc/systemd/system/
+sudo ln -s /home/pi/InfoWindow/dist/infowindow.timer            /etc/systemd/system/
+sudo ln -s /home/pi/InfoWindow/dist/infowindow-screensaver.service /etc/systemd/system/
+sudo ln -s /home/pi/InfoWindow/dist/infowindow-screensaver.timer   /etc/systemd/system/
+
+sudo systemctl daemon-reload
+sudo systemctl enable --now infowindow.timer
+sudo systemctl enable --now infowindow-screensaver.timer
+```
+
+> **Note:** The service files currently hardcode `User=pi`. Adjust if your username differs.
+
+The **updater** runs every 6 minutes. The **screensaver** runs once daily at 05:01 to cycle
+the display through black, red, and white — preventing image retention.
+
+#### Useful commands
+```bash
+journalctl -u infowindow -f          # live logs from the updater
+journalctl -u infowindow-screensaver # screensaver logs
+systemctl status infowindow.timer    # next scheduled run
+```
+
+---
+
+## Optional: extend SD-card lifetime
+
+Add this line to `/etc/fstab` and reboot to keep `/tmp` in RAM:
+```
+tmpfs    /tmp    tmpfs    defaults,noatime,nosuid,size=100m    0 0
+```
+
+---
+
+## Local development
+
+The display driver is not available outside a Raspberry Pi, but a **mock display**
+activates automatically on any other machine. It composites the black and red layers
+into a colour preview PNG and opens it with your default image viewer.
+
+```bash
+# One-time setup (no rpi extra needed)
+python3 -m venv .venv
+source .venv/bin/activate
+pip install -e ".[google,caldav]"
+
+# Run
+python infowindow.py
+# → preview saved to /tmp/InfoWindowPreview.png
+```
 
+The mock faithfully reproduces the Waveshare rendering rules: red wins over black when
+both layers have ink at the same pixel.
diff --git a/clearScreen.py b/clearScreen.py
diff --git a/config.json-sample b/config.json-sample
@@ -1,14 +1,44 @@
-{
-    "general": {
-        "rotation": 180
-    },
-    "todo": {
-        "api_key": "1234"
-    },
-    "calendar": null,
-    "weather": {
-        "api_key": "1234",
-        "city": "Sacramento,US",
-        "units": "imperial"
-    }
-}
+{
+    "general": {
+        "rotation": 180,
+        "timeformat": "12h",
+        "sunday_first_dow": false,
+        "cell_spacing": 2,
+        "timezone": "Europe/Zurich"
+    },
+    "calendar": {
+        "font_size": 22,
+        "ignored": ["Buy ticket!"],
+        "today_text_color": "red",
+        "today_background_color": "white"
+    },
+    "todo": {
+        "font_size": 22
+    },
+    "calendar_google": {
+        "enabled": true,
+        "additional": ["Contacts", "Birthdays"]
+    },
+    "calendar_caldav": {
+        "enabled": true,
+        "caldav_url": "https://your.domain.tld/some/caldav",
+        "username": "john",
+        "password": "supersecret",
+        "additional": ["Contact birthdays", "some calendar"]
+    },
+    "todo_google": {
+        "enabled": true
+    },
+    "todo_caldav": {
+        "enabled": true,
+        "caldav_url": "https://your.domain.tld/some/caldav",
+        "username": "john",
+        "password": "supersecret",
+        "additional": ["another calendar"]
+    },
+    "weather": {
+        "api_key": "1234",
+        "city": "Sacramento,US",
+        "units": "imperial"
+    }
+}
diff --git a/dist/infowindow-screensaver.service b/dist/infowindow-screensaver.service
@@ -0,0 +1,20 @@
+[Unit]
+Description=InfoWindow screensaver
+After=network.target
+
+[Service]
+ExecStart=/home/pi/InfoWindow/venv/bin/python3 /home/pi/InfoWindow/screensaver.py
+WorkingDirectory=/home/pi/InfoWindow/
+CacheDirectory=InfoWindow
+TimeoutStartSec=3m
+StandardOutput=journal
+StandardError=journal
+SyslogIdentifier=infowindow-screensaver
+NotifyAccess=all
+User=pi
+Group=pi
+Nice=1
+Type=oneshot
+
+[Install]
+WantedBy=multi-user.target
diff --git a/dist/infowindow-screensaver.timer b/dist/infowindow-screensaver.timer
@@ -0,0 +1,10 @@
+[Unit]
+Description=InfoWindow screensaver
+
+[Timer]
+Unit=infowindow-screensaver.service
+#OnCalendar=5:1
+OnCalendar=5:1
+
+[Install]
+WantedBy=timers.target
Original file line number	Diff line number	Diff line change
		@@ -1 +1 @@
		This file is the "Assembly" of all the parts needed to print. I left out the model of the Raspberry PI due to licensing. If you need the raspberry pi model, do a search on GrabCad there are a ton!
		This file is the "Assembly" of all the parts needed to print. I left out the model of the Raspberry PI due to licensing. If you need the raspberry pi model, do a search on GrabCad there are a ton!