tfaour
7013311249
Build and push server image / build-and-push (push) Successful in 32s
- LICENSE: MIT, with attribution notes for the vendored qrcode/epaper_fonts/ dns_server code and the epd7in3e driver's transcription of Waveshare's register sequence. - Top-level README.md: project overview, hardware list, quick-start pointing at firmware/ and server/, repo layout, license, Claude Code attribution. - firmware/README.md: full rewrite (was still the stock ESP-IDF captive portal example's README) -- build/flash instructions, Kconfig reference table, first-boot walkthrough, and how to reset to provisioning mode via NVS erase (the only way in right now; a proper reconfigure trigger is a future addition). - docs/hardware.md: wiring table + parts list + strapping-pin/SPI-speed notes. - docs/architecture.md: sequence diagram and walkthrough of the full provision -> connect -> fetch -> display -> sleep cycle, plus the reasoning behind doing image processing server-side and reusing Immich's face detection instead of bundling a detector. - server/README.md: fixed stale endpoint docs (missing GET /frame/config, POST /api/config still describing removed immich_url/api_key fields).
40 lines
1.8 KiB
Plaintext
40 lines
1.8 KiB
Plaintext
MIT License
|
|
|
|
Copyright (c) 2026 Thomas Faour
|
|
|
|
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.
|
|
|
|
---
|
|
|
|
This repository vendors a small amount of third-party code under their own
|
|
permissive licenses, unmodified, each in its own directory with attribution:
|
|
|
|
- `firmware/components/qrcode/` -- Nayuki's QR Code generator library, MIT.
|
|
- `firmware/components/epaper_fonts/` -- an STMicroelectronics bitmap font
|
|
table redistributed by Waveshare, BSD-3-Clause.
|
|
- `firmware/components/dns_server/` -- from Espressif's ESP-IDF examples,
|
|
Unlicense OR CC0-1.0.
|
|
|
|
See each directory's source comments / README for full license text.
|
|
`firmware/components/epd7in3e/` is original code written for this project,
|
|
but its register/command sequence is a transcription of values from
|
|
Waveshare's MIT-licensed `EPD_7in3e.c` reference driver (this panel has no
|
|
public datasheet) -- see the attribution comment at the top of
|
|
`epd7in3e.c`.
|