Two new documents to drive the Sprint 1 approval cycle when the user
reviews in the morning. NO firmware code touched -- this is planning
material only, per brief rule #1 "Antes de cada sprint, me presentas
plan detallado y esperas mi OK. No improvises features."
docs/sprint-1-plan.md
- Sprint 1 objective (firmware boot + STANDBY + Modbus slave +
NMEA 2000 consume of PGN 127250/127251 + watchdog).
- 4 explicit technical decisions awaiting the user's go/no-go:
2.1 Framework: Arduino-as-ESP-IDF-component (recommended)
2.2 New libraries: NMEA2000-library, NMEA2000_esp32, eModbus
(asked per brief rule #4 "No agregues dependencias sin
preguntarme")
2.3 FreeRTOS core/priority mapping (PID isolated on Core 1)
2.4 Logging: ESP_LOG via UART0
- 7-phase breakdown over 3-4 weeks (mirrors brief's Sprint 1 scope).
- Acceptance criteria, risks, and the inputs needed from the user
before kickoff (hardware availability, schematic, NMEA 2000 bus).
docs/firmware-libraries-research.md
- Detailed rationale for each library choice with comparison tables.
- Pinout / hardware references aligned with the existing
firmware/ar_autopilot_v1/src/hal/pinout.h.
- Draft platformio.ini outline (NOT yet written to the firmware
directory -- needs user OK first).
- All external sources cited for traceability.
Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
Initial commit. Delivers what the brief calls 'Sprint 0 - Foundations'
(see docs/AR_Autopilot_brief.md section 12):
- Complete repository structure (arautopilot package + firmware, display,
installer, tools placeholders + docs).
- Core data model (Pydantic v2): modes, alarms, actuator config, PID
config + gain scheduling, vessel config, knob state machine, project
config with YAML/JSON serialisation.
- Seed library: 2 actuator profiles (hydraulic & electric DC reversible)
and 2 default tunings (yacht motor planeo 30 m and 40 m). Conservative
literature values, NOT the integrator's production tuning IP.
- Firmware skeleton: only src/hal/pinout.h with the 21 I/O contract for
the AR-NMEA-IO v1.0 board. No drivers, no main loop.
- Studio stubs (real PySide6 app starts in Sprint 4).
- pytest suite (80 tests, all green): modes, alarms, actuator, PID
(incl. gain interpolation and the +/-50% adaptive bound from brief
section 6), vessel, knob state, project config, library loader,
end-to-end roundtrip.
- examples/sprint0_demo.py - the acceptance demo from the brief.
Acceptance criteria met:
- pytest green (80/80)
- demo creates, saves (YAML + JSON), reloads, and verifies a full
ProjectConfig using the seed library
- repository ready for tag `sprint-0-approved`
See CHANGELOG.md for the detailed scope.
Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
alro65