refactor(Style): Add font abstraction and CSS-like styling constants
This commit is contained in:
83
AGENTS.md
83
AGENTS.md
@@ -4,31 +4,38 @@ Multi-target Arduino/ESP32 doorbell alert system using ntfy.sh.
|
||||
|
||||
## Quick Reference
|
||||
|
||||
**Default BOARD**: `esp32-s3-lcd-43` (set in mise.toml). To switch boards:
|
||||
|
||||
```bash
|
||||
# Compile, upload, monitor
|
||||
BOARD=esp32-32e-4 mise run compile # compile
|
||||
BOARD=esp32-32e-4 mise run upload # upload (auto-kills monitor)
|
||||
BOARD=esp32-32e-4 mise run monitor # start JSON monitor daemon
|
||||
BOARD=esp32-32e-4 mise run log-tail # watch colored logs
|
||||
BOARD=esp32-32e-4 mise run cmd COMMAND=dashboard # send command
|
||||
BOARD=esp32-32e-4 mise run state # show device state
|
||||
mise set BOARD=esp32-32e-4 # switch to ESP32-32E-4"
|
||||
mise set BOARD=esp32-32e # switch to ESP32-32E
|
||||
mise set BOARD=esp32-s3-lcd-43 # switch to ESP32-S3-LCD-4.3
|
||||
```
|
||||
|
||||
Then run commands without `BOARD=` prefix:
|
||||
|
||||
```bash
|
||||
mise run compile # compile
|
||||
mise run upload # upload (auto-kills monitor)
|
||||
mise run monitor # start JSON monitor daemon
|
||||
mise run log-tail # watch colored logs
|
||||
mise run cmd COMMAND=dashboard # send command
|
||||
mise run state # show device state
|
||||
|
||||
# Install libs (run after cloning)
|
||||
mise run install-libs-shared # shared libs (ArduinoJson, NTPClient)
|
||||
BOARD=esp32-32e-4 mise run install # shared + board-specific libs
|
||||
mise run install # shared + board-specific libs
|
||||
```
|
||||
|
||||
**Default BOARD**: `esp32-s3-lcd-43` (set in mise.toml)
|
||||
|
||||
## Project Overview
|
||||
|
||||
Three board targets share business logic via a common library:
|
||||
|
||||
| Board | Display | Library | Build Command |
|
||||
|-------|---------|---------|--------------|
|
||||
| ESP32-32E | SPI TFT 320x240 (ILI9341) | 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` |
|
||||
| ESP32-32E | SPI TFT 320x240 (ILI9341) | TFT_eSPI | `mise set BOARD=esp32-32e && mise run compile` |
|
||||
| ESP32-32E-4" | SPI TFT 320x480 (ST7796) | TFT_eSPI | `mise set BOARD=esp32-32e-4 && mise run compile` |
|
||||
| ESP32-S3-Touch-LCD-4.3 | 800x480 RGB parallel | LovyanGFX | `mise set BOARD=esp32-s3-lcd-43 && mise run compile` |
|
||||
|
||||
## Essential Commands
|
||||
|
||||
@@ -39,18 +46,21 @@ All commands run via **mise**:
|
||||
mise run install-libs-shared
|
||||
mise run install # install shared + board-specific libs (requires BOARD env)
|
||||
|
||||
# Generic commands (set BOARD environment variable)
|
||||
BOARD=esp32-32e mise run compile # compile for ESP32-32E
|
||||
BOARD=esp32-32e mise run upload # upload to ESP32-32E
|
||||
BOARD=esp32-32e mise run monitor # monitor ESP32-32E
|
||||
# Generic commands (set BOARD with mise set first)
|
||||
mise set BOARD=esp32-32e # switch to ESP32-32E
|
||||
mise run compile # compile for ESP32-32E
|
||||
mise run upload # upload to ESP32-32E
|
||||
mise run monitor # monitor ESP32-32E
|
||||
|
||||
BOARD=esp32-32e-4 mise run compile # compile for ESP32-32E-4"
|
||||
BOARD=esp32-32e-4 mise run upload # upload to ESP32-32E-4"
|
||||
BOARD=esp32-32e-4 mise run monitor # monitor ESP32-32E-4"
|
||||
mise set BOARD=esp32-32e-4 # switch to ESP32-32E-4"
|
||||
mise run compile # compile for ESP32-32E-4"
|
||||
mise run upload # upload to ESP32-32E-4"
|
||||
mise run monitor # monitor ESP32-32E-4"
|
||||
|
||||
BOARD=esp32-s3-lcd-43 mise run compile # compile for ESP32-S3-LCD-4.3
|
||||
BOARD=esp32-s3-lcd-43 mise run upload # upload to ESP32-S3-LCD-4.3
|
||||
BOARD=esp32-s3-lcd-43 mise run monitor # monitor ESP32-S3-LCD-4.3
|
||||
mise set BOARD=esp32-s3-lcd-43 # switch to ESP32-S3-LCD-4.3
|
||||
mise run compile # compile for ESP32-S3-LCD-4.3
|
||||
mise run upload # upload to ESP32-S3-LCD-4.3
|
||||
mise run monitor # monitor ESP32-S3-LCD-4.3
|
||||
|
||||
# Other useful tasks
|
||||
mise run format # format code
|
||||
@@ -92,7 +102,7 @@ LIBS="--libraries ./vendor/esp32-32e-4/TFT_eSPI"
|
||||
OPTS="-DDEBUG_MODE -DBOARD_HAS_PSRAM"
|
||||
```
|
||||
|
||||
**Port override**: `PORT=/dev/ttyXXX BOARD=esp32-32e mise run upload`
|
||||
**Port override**: `mise set PORT=/dev/ttyXXX` before running upload/monitor commands.
|
||||
|
||||
**Prerequisites**: arduino-cli with `esp32:esp32` platform installed, mise.
|
||||
|
||||
@@ -193,8 +203,8 @@ Use `#pragma once` (not `#ifndef` guards).
|
||||
**No unit tests exist** - This is an embedded Arduino sketch. Verify changes by building and deploying to hardware:
|
||||
|
||||
```bash
|
||||
BOARD=esp32-s3-lcd-43 mise run compile # compile for default board
|
||||
BOARD=esp32-32e-4 mise run compile # compile for ESP32-32E-4"
|
||||
mise set BOARD=esp32-s3-lcd-43 # compile for esp32-s3-lcd-43
|
||||
mise set BOARD=esp32-32e-4 # compile for ESP32-32E-4"
|
||||
```
|
||||
|
||||
**Serial commands** (type into serial monitor at 115200 baud):
|
||||
@@ -232,10 +242,11 @@ The build system includes a Python-based monitor agent that provides JSON loggin
|
||||
Commands to interact with the daemon:
|
||||
|
||||
```bash
|
||||
BOARD=esp32-32e mise run monitor # Start monitor daemon (background)
|
||||
BOARD=esp32-32e mise run log-tail # Tail colored logs
|
||||
BOARD=esp32-32e mise run cmd COMMAND=dashboard # Send command
|
||||
BOARD=esp32-32e mise run state # Show current device state
|
||||
mise set BOARD=esp32-32e
|
||||
mise run monitor # Start monitor daemon (background)
|
||||
mise run log-tail # Tail colored logs
|
||||
mise run cmd COMMAND=dashboard # Send command
|
||||
mise run state # Show current device state
|
||||
```
|
||||
|
||||
The monitor daemon automatically starts after upload and is killed before upload to avoid serial port conflicts.
|
||||
@@ -260,7 +271,7 @@ The monitor daemon automatically starts after upload and is killed before upload
|
||||
|
||||
6. **WiFi credentials are per-board**: Each board directory has its own `secrets.h` because boards may be on different networks.
|
||||
|
||||
7. **Use BOARD environment variable**: All build commands require the `BOARD` environment variable (e.g., `BOARD=esp32-32e mise run compile`). The default BOARD is `esp32-s3-lcd-43` (set in mise.toml).
|
||||
7. **Use BOARD environment variable**: All build commands require the `BOARD` environment variable. The default BOARD is `esp32-s3-lcd-43` (set in mise.toml). Use `mise set BOARD=xxx` to switch boards.
|
||||
|
||||
8. **Serial port contention**: The `upload`, `monitor`, and `monitor-raw` tasks automatically depend on `kill` which uses `fuser` to terminate any process using the serial port before starting.
|
||||
|
||||
@@ -325,9 +336,9 @@ Track changes that were reverted to avoid flapping:
|
||||
|
||||
| Issue | Solution |
|
||||
|-------|----------|
|
||||
| "Another instance is running" error | Run `mise run kill BOARD=<board>` or `FORCE=1 mise run <task> BOARD=<board>` |
|
||||
| "Another instance is running" error | Run `mise run kill` to stop monitor daemon and release port |
|
||||
| Upload fails - port in use | Run `mise run kill` to stop monitor daemon and release port |
|
||||
| Build fails - missing libraries | Run `mise run install-libs-shared` then `BOARD=<board> mise run install` |
|
||||
| Build fails - missing libraries | Run `mise run install-libs-shared` then `mise run install` |
|
||||
| LSP shows errors but build works | Run `mise run gen-compile-commands` to generate compile_commands.json for your BOARD |
|
||||
| No serial output | Check baud rate is set to 115200 in serial monitor |
|
||||
| State file not updating | Ensure serial output contains `[STATE]` or `[ADMIN]` tags |
|
||||
@@ -355,13 +366,15 @@ The project uses **clangd** for C++ via the `compile_commands.json` generated by
|
||||
**Generate compile_commands.json** for accurate IDE diagnostics:
|
||||
|
||||
```bash
|
||||
BOARD=esp32-32e-4 mise run gen-compile-commands
|
||||
mise set BOARD=esp32-32e-4
|
||||
mise run gen-compile-commands
|
||||
```
|
||||
|
||||
**Generate static .crush.json** for a specific board:
|
||||
|
||||
```bash
|
||||
BOARD=esp32-32e-4 mise run gen-crush-config
|
||||
mise set BOARD=esp32-32e-4
|
||||
mise run gen-crush-config
|
||||
```
|
||||
|
||||
## Hardware Research Log
|
||||
|
||||
Reference in New Issue
Block a user