Skip to content

CLAUDE.md

Latest commit

 

History

History
52 lines (39 loc) · 1.99 KB

CLAUDE.md

File metadata and controls

52 lines (39 loc) · 1.99 KB
Raw

CLAUDE.md

Guidance for Claude Code (claude.ai/code) when working in this repository.

Overview

ESP32 firmware (esp32dev, LILYGO T-Relay board) for a planted aquarium controller: DS18B20 thermostat, cron-scheduled lamp and CO2, MQTT telemetry to ThingSpeak. Pinout, ThingSpeak fields and HTTP endpoints — see README.md.

Architecture (where things live)

  • src/main.cpp — boot sequence, MQTT publish and loop().
  • src/modules/ — application wiring: wifi_setup (captive portal, custom fields, save callback, NTP and OTA, exposing handleWifi()), http_server and cron_setup.
  • lib/io/ — hardware abstractions behind the Actuator, TemperatureSensor and Clock interfaces, so they can be faked in native tests.
  • lib/fs/ — AppConfig: LittleFS + ArduinoJson persistence of /config.json.
  • lib/mqtt/ — MQTT, the broker client.
  • lib/core/ — cross-cutting helpers: device (chip id, AP name, waitWifi, waitNtp), Clock (formatDateTime, isTimeSet, safeCron) and its ArduinoClock implementation, and TelnetLog, a Telnet sink for log_* output.

Anything user-configurable belongs in the portal plus Config, not in build flags.

Build, Test, Upload

pio run                 # compile
pio test -e native      # host tests
pio run --target upload # flash
pio device monitor      # serial monitor @ 115200 baud
  • Always ask for explicit user confirmation before any upload/flash — it writes to physical hardware.
  • The upload path is OTA (espota) via the untracked local_settings.ini; removing it falls back to USB.

Spec-Driven Development (SDD)

This project strictly follows an agent-driven SDD flow. Artifacts for each feature live in tasks/prd-<feature-name>/.

Conventions

All code must follow .claude/rules/code-conventions.md — the single source of truth for naming, class structure, logging, constants, control flow, and the hardware-first tie-breaker rule. Read it before writing or reviewing.