alro65
700756c16f
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>
20 lines
625 B
Markdown
20 lines
625 B
Markdown
# JSON Schemas
|
|
|
|
This directory is reserved for JSON Schemas auto-generated from the Pydantic
|
|
models in `arautopilot.core`. They are useful for:
|
|
|
|
- IDE autocompletion / validation when editing actuator profiles or PID
|
|
tunings outside the Studio
|
|
- External tooling that consumes `.appack` configurations
|
|
- Documentation generation
|
|
|
|
Schemas are not generated in Sprint 0 but can be produced on demand:
|
|
|
|
```python
|
|
from arautopilot.core.actuator_config import ActuatorConfig
|
|
import json
|
|
print(json.dumps(ActuatorConfig.model_json_schema(), indent=2))
|
|
```
|
|
|
|
A `tools/regenerate_schemas.py` script will be added later (Sprint 4+).
|