alro65/AR-VMS-Seaman
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity
Files
main
AR-VMS-Seaman/CHANGELOG.md
T
alro65 deb04c9315 sprint-0: fundaciones VMS-Sailor 
Sprint 0 completo del producto VMS-Sailor (Vessel Management System
integrado para buques 30-40m). Brief de referencia en
VMS_Sailor_v2_Parte_*.md (intacto).

Core (vmssailor.core, 95.17% coverage, 99 tests verde):
- ShipCoord: sistema naval x_pp/y_cl/z_bl frozen
- Vessel, Deck, Bulkhead
- Equipment, EquipmentModel, Sensor, EquipmentSpec
- Tag, AlarmConfig, TagBinding, Scaling
- CardInstance, Bus, Topology con validacion 21 puntos I/O AR-NMEA-IO-v1.0
- Alarm, PermissiveRule, Condition
- Project agregado raiz con validacion cross-entity
- Persistencia portable .vmsproj (SQLite) con roundtrip verificable

Biblioteca curada seed (vmssailor.library):
- systems_catalog.json completo (catalogo maestro Parte 1 sec 7)
- 2 vessels: Sunseeker 76, Ferretti 850
- 2 motores: MTU 12V 2000 M96, Volvo D13-900
- 1 genset: Northern Lights M65C13
- yacht_motor_planeo.yaml (reglas heuristicas)
- TODO marcado data_source=seed_estimate - requiere validacion datasheets

Tools:
- vms-validate-library: CLI valida biblioteca completa
- vms-generate-test-project: CLI demo + verificacion roundtrip persistencia

Design System + 8 mockups HTML estaticos:
- docs/design_system.md (paleta Deep Ocean, gradientes, typography, motion)
- docs/brand/ (logo + variantes SVG)
- docs/mockups/splash, studio_main, runtime_overview,
  runtime_mimic_fuel (P&ID animado), runtime_alarms, runtime_trim (panel
  estrella con horizonte artificial), mobile_overview, mobile_trim
- docs/mockups/index.html (galeria)

Firmware (Sprint 12+ implementacion):
- firmware/ar_nmea_io_v1/src/config/pinout.h con macros GPIO

Decisiones autonomas documentadas en docs/decisions_sprint0.md.

Stack: Python 3.11 + uv + Pydantic v2 + SQLite stdlib + hatchling +
pytest 9 + ruff + mypy. Sin PySide6, FastAPI, Flutter ni firmware
funcional (entran en sprints siguientes).

Criterio de aceptacion Sprint 0: cumplido.
- uv sync: OK
- pytest: 99/99 verde
- cov vmssailor.core: 95.17% (objetivo >=80%)
- ruff: clean
- vms-validate-library: OK
- vms-generate-test-project: INTEGRIDAD OK

Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
2026-05-17 07:26:06 -04:00

4.8 KiB
Raw Permalink Blame History

Changelog VMS-Sailor

Formato basado en Keep a Changelog + SemVer.

[0.1.0-sprint0] — 2026-05-16

Added — Fundaciones (Sprint 0)

Estructura del proyecto

  • pyproject.toml configurado con uv, ruff, mypy, pytest
  • Python 3.11 fijado en .python-version
  • .gitignore cubriendo Python, build, IDE, mobile (Flutter), firmware (PlatformIO), artefactos Runtime
  • Estructura de carpetas completa: vmssailor/, firmware/, mobile/, tests/, tools/, docs/, installer/

Modelo de datos core (vmssailor/core/)

  • coords.py: ShipCoord(x_pp, y_cl, z_bl) frozen Pydantic model, sistema naval estándar
  • enums.py: catálogo completo de enums (SignalType, ChannelType, AlarmPriority, AlarmState, ControlMode, AuthorityRequired, Protocol, BusRole, FilterType, Quality, EquipmentCategory, SystemId, UnitSI, VesselType, VesselSubtype)
  • vessel.py: Vessel, Deck, Bulkhead
  • equipment.py: Equipment, EquipmentModel, Sensor, EquipmentSpec
  • tag.py: Tag, AlarmConfig, TagBinding, Scaling
  • card.py: CardInstance, Bus, Topology, validación de capacidades 21 puntos I/O
  • alarm.py: Alarm (instancia activa)
  • permissive.py: PermissiveRule, Condition
  • project.py: Project (agregado raíz)
  • validation.py: invariantes cross-entity

Persistencia (vmssailor/core/persistence/)

  • Schema SQLite portable .vmsproj (15+ tablas, versionado en schema_version)
  • Writer + Reader con roundtrip verificable
  • migrations.py placeholder versionado

Biblioteca curada seed (vmssailor/library/)

  • systems_catalog.json: catálogo maestro completo con TODOS los sistemas de la Parte 1 sec 7 (propulsión, maniobra, generación eléctrica, fluidos, seguridad, ambiente, iluminación, tanques, cubierta, específicos por tipo)
  • vessels/sunseeker_76.json
  • vessels/ferretti_850.json
  • equipment/engines/mtu_12v_2000_m96.json
  • equipment/engines/volvo_d13_900hp.json
  • equipment/gensets/northern_lights_m65c13.json
  • rules/yacht_motor_planeo.yaml: reglas heurísticas
  • loader.py: carga + validación de toda la biblioteca

NOTA: todos los archivos seed traen data_source: "seed_estimate" — valores plausibles que requieren validación de Álvaro contra datasheets oficiales antes de Sprint 1.

Tools

  • tools/validate_library.py: CLI que valida integridad de toda vmssailor/library/
  • tools/generate_test_project.py: demo que crea un proyecto completo (Sunseeker 76 + equipos + tags + cards) → guarda .vmsproj → lo relee → verifica integridad campo por campo

Tests (tests/)

  • tests/core/ — unit tests por entidad (≥ 80% cobertura objetivo)
  • tests/core/persistence/test_roundtrip.py — test crítico de serialización
  • tests/library/ — tests de integridad de la seed

Design System

  • docs/design_system.md: paleta (Deep Ocean + Sailor Cyan + Compass Amber + ...), tipografía (Inter UI + JetBrains Mono valores), gradientes (deep-sea, horizon, glow, glass), 5 niveles de sombra, motion principles, iconografía naval
  • docs/mockups/ 8 mockups HTML+CSS+SVG estáticos:
    • splash.html — pantalla de bienvenida
    • studio_main.html — Studio Sprint 1 preview
    • runtime_overview.html — dashboard del buque
    • runtime_mimic_fuel.html — mímico sistema combustible con válvulas y bombas
    • runtime_alarms.html — panel de alarmas con prioridades
    • runtime_trim.html — panel Trim & Maniobra (estrella) con sliders y gauge roll/pitch
    • mobile_overview.html — versión iPhone
    • mobile_trim.html — Trim móvil
  • docs/brand/ — logo SVG + variantes

Documentación

  • docs/architecture.md — overview 1-pager con links a briefs
  • docs/coords.md — sistema de coordenadas navales explicado
  • docs/seed_data_notes.md — qué entradas requieren validación de Álvaro
  • docs/decisions_sprint0.md — decisiones tomadas autónomamente durante Sprint 0

Firmware

  • firmware/ar_nmea_io_v1/src/config/pinout.h: definiciones GPIO según Parte 4 sec 1 (sin código compilable aún)
  • firmware/ar_nmea_io_v1/README.md

Decisiones tomadas autónomamente (revisar en docs/decisions_sprint0.md)

  • Pydantic v2 (no v1, no dataclasses) — validación + serialización built-in
  • SQLite stdlib (no SQLAlchemy en Sprint 0) — .vmsproj es portable y plano
  • hatchling como build backend (no setuptools) — moderno, integra con uv
  • data_source flag obligatorio en entradas de biblioteca
  • IDs de tags deterministas: {equipment.tag_prefix}.{sensor.id}
  • Encoding de coordenadas: tres float Pydantic con validadores de rango razonable

Not Yet

  • Sin PySide6, FastAPI, pymodbus, duckdb, pywin32 (entran en sprints siguientes)
  • Sin compilador .vmspack (Sprint 7)
  • Sin Flutter (Sprint 11)
  • Sin firmware funcional (Sprint 12)
Reference in New Issue View Git Blame Copy Permalink