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>
28 lines
797 B
Python
28 lines
797 B
Python
"""Typed identifier wrappers.
|
|
|
|
Pydantic v2 ``Annotated[str, ...]`` aliases that prevent accidentally
|
|
passing a ``VesselId`` where a ``ProjectId`` is expected (mypy-enforced).
|
|
At runtime they are plain strings — UUID v4 hex by default.
|
|
"""
|
|
|
|
from __future__ import annotations
|
|
|
|
import uuid
|
|
from typing import NewType
|
|
|
|
ProjectId = NewType("ProjectId", str)
|
|
"""Unique identifier of a customer project (one vessel = one project)."""
|
|
|
|
VesselId = NewType("VesselId", str)
|
|
"""Unique identifier of a vessel within a project."""
|
|
|
|
|
|
def new_project_id() -> ProjectId:
|
|
"""Generate a fresh, random ``ProjectId`` (UUID v4 hex)."""
|
|
return ProjectId(uuid.uuid4().hex)
|
|
|
|
|
|
def new_vessel_id() -> VesselId:
|
|
"""Generate a fresh, random ``VesselId`` (UUID v4 hex)."""
|
|
return VesselId(uuid.uuid4().hex)
|