klubhaus/klubhaus-doorbell
3
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

feat(docs): update README and AGENTS.md with RTK instructions

Browse Source
This commit is contained in:
David Gwilliam
2026-02-19 13:01:55 -08:00
parent 16f02ed967
commit 3dc66a536e
12 changed files with 296 additions and 104 deletions
Download Patch File Download Diff File Expand all files Collapse all files

32
README.md
View File

@@ -4,10 +4,11 @@ Multi-target doorbell alert system powered by [ntfy.sh](https://ntfy.sh).
## Targets
| Board | Display | Library | Build Task |
| Board | Display | Library | Build Command |
|---|---|---|---|
| ESP32-32E | SPI TFT (ILI9341 etc.) | TFT_eSPI | `mise run compile-32e` |
| ESP32-S3-Touch-LCD-4.3 | 800x480 RGB parallel | Arduino_GFX | `mise run compile-s3-43` |
| ESP32-32E | SPI TFT (ILI9341 etc.) | TFT_eSPI | `BOARD=esp32-32e mise run compile` |
| ESP32-32E-4" | SPI TFT 320x480 (ST7796) | TFT_eSPI | `BOARD=esp32-32e-4 mise run compile` |
| ESP32-S3-Touch-LCD-4.3 | 800x480 RGB parallel | LovyanGFX | `BOARD=esp32-s3-lcd-43 mise run compile` |
## Quick Start
@@ -22,11 +23,14 @@ Multi-target doorbell alert system powered by [ntfy.sh](https://ntfy.sh).
3. Build and upload:
mise run compile-s3-43
mise run upload-s3-43
BOARD=esp32-s3-lcd-43 mise run compile
BOARD=esp32-s3-lcd-43 mise run upload
mise run compile-32e
mise run upload-32e
BOARD=esp32-32e-4 mise run compile
BOARD=esp32-32e-4 mise run upload
BOARD=esp32-32e mise run compile
BOARD=esp32-32e mise run upload
## Project Structure
@@ -45,17 +49,25 @@ Multi-target doorbell alert system powered by [ntfy.sh](https://ntfy.sh).
│ ├── esp32-32e/ ESP32-32E sketch
│ │ ├── esp32-32e.ino
│ │ ├── board_config.h
│ │ ├── secrets.h (gitignored)
│ │ ├── secrets.h (gitignored, copy from .example)
│ │ ├── tft_user_setup.h
│ │ └── DisplayDriverTFT.*
│ ├── esp32-32e-4/ ESP32-32E-4" sketch
│ │ ├── esp32-32e-4.ino
│ │ ├── board_config.h
│ │ ├── secrets.h (gitignored, copy from .example)
│ │ ├── tft_user_setup.h
│ │ └── DisplayDriverTFT.*
│ └── esp32-s3-lcd-43/ ESP32-S3-LCD-4.3 sketch
│ ├── esp32-s3-lcd-43.ino
│ ├── board_config.h
│ ├── secrets.h (gitignored)
│ ├── secrets.h (gitignored, copy from .example)
│ ├── LovyanPins.h
│ └── DisplayDriverGFX.*
├── vendor/ Per-board vendored display libs
│ ├── esp32-32e/TFT_eSPI/
│ └── esp32-s3-lcd-43/GFX_Library_for_Arduino/
│ ├── esp32-32e-4/TFT_eSPI/
│ └── esp32-s3-lcd-43/LovyanGFX/
└── mise.toml Build harness
## Serial Commands