From 8de47c0b19ea0bd819ede75e51b0c06f863c479a Mon Sep 17 00:00:00 2001 From: cottongin Date: Mon, 31 Aug 2026 13:39:27 -0400 Subject: [PATCH] docs: add MIT license and README Co-authored-by: Cursor --- LICENSE | 21 +++++++++++++++++++ README.md | 63 +++++++++++++++++++++++++++++++++++++++++++++++++++++++ 2 files changed, 84 insertions(+) create mode 100644 LICENSE create mode 100644 README.md diff --git a/LICENSE b/LICENSE new file mode 100644 index 0000000..69f85b5 --- /dev/null +++ b/LICENSE @@ -0,0 +1,21 @@ +MIT License + +Copyright (c) 2026 cottongin + +Permission is hereby granted, free of charge, to any person obtaining a copy +of this software and associated documentation files (the "Software"), to deal +in the Software without restriction, including without limitation the rights +to use, copy, modify, merge, publish, distribute, sublicense, and/or sell +copies of the Software, and to permit persons to whom the Software is +furnished to do so, subject to the following conditions: + +The above copyright notice and this permission notice shall be included in all +copies or substantial portions of the Software. + +THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR +IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, +FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE +AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER +LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, +OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE +SOFTWARE. diff --git a/README.md b/README.md new file mode 100644 index 0000000..bc09dde --- /dev/null +++ b/README.md @@ -0,0 +1,63 @@ +# Immich Frame + +An ESP32 firmware for the [M5Stack PaperColor](https://shop.m5stack.com/products/papercolor) e-ink display that turns it into a digital photo frame powered by your [Immich](https://immich.app/) server. + +## Features + +- **Photo cycling modes** -- random, chronological, reverse-chronological, favorites-weighted, and recency-weighted +- **Deep sleep with batch caching** -- fetches multiple photo IDs per wake cycle to minimize network calls and extend battery life +- **6-color e-ink rendering** -- Floyd-Steinberg dithering calibrated to the Spectra 6 palette with blue noise smoothing +- **Portrait pairing** -- automatically pairs two portrait photos side-by-side +- **Metadata overlays** -- date, time, location, people, album, and camera info as caption bars or corner badges +- **Web UI** -- configure all settings, manage albums, trigger actions, and download wake logs from your browser +- **Wake logging** -- persistent CSV log of each photo cycle that survives reboots and deep sleep + +## Hardware + +- [M5Stack PaperColor](https://shop.m5stack.com/products/papercolor) (ESP32-S3, 600x400 Spectra 6 e-ink, 1600mAh battery) + +## Requirements + +- [PlatformIO](https://platformio.org/) (CLI or IDE plugin) +- An [Immich](https://immich.app/) server with an API key + +## Getting Started + +1. Clone the repository: + + ```bash + git clone https://code.cottongin.xyz/cottongin/immich-frame.git + cd immich-frame + ``` + +2. Build and flash: + + ```bash + pio run -t upload + ``` + +3. On first boot the device creates a `PaperColor-Setup` WiFi access point. Connect to it and open `192.168.4.1` in your browser. + +4. Enter your WiFi credentials, Immich server URL, and API key. The device reboots and begins displaying photos. + +## Configuration + +Once connected to your network, access the web UI at `http://papercolor.local` to manage: + +- **Slideshow** -- interval (2m to custom), cycling mode, image quality, deep sleep batch size +- **Display** -- metadata overlay content and position, translucent badge backgrounds +- **Albums** -- filter photos by specific Immich albums +- **Device** -- sync time, download/clear wake logs, deep sleep, reboot, factory reset + +## Tools + +The `tools/` directory contains standalone HTML utilities for analyzing wake log CSV files: + +- `log-viewer.html` -- chart and table view of a single wake log +- `log-compare.html` -- side-by-side comparison of multiple wake logs + +Open them directly in your browser; no server required. + +## License + +[MIT](LICENSE)