Files
AR-VMS-Seaman/vmssailor/core/__init__.py
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

101 lines
2.6 KiB
Python

"""vmssailor.core — Modelo de datos compartido entre Studio y Runtime.
Este módulo es el **corazón del sistema**. Define todas las entidades del
producto y se construye en Sprint 0 antes de cualquier UI o driver.
Entidades principales:
- `ShipCoord` — sistema de coordenadas naval (x_pp, y_cl, z_bl)
- `Vessel`, `Deck` — definición física del buque
- `Equipment`,
`EquipmentModel`,
`Sensor` — equipos y sus sensores típicos
- `Tag`, `AlarmConfig`,
`TagBinding` — punto I/O concreto y su mapeo físico
- `CardInstance`,
`Bus`, `Topology` — tarjetas AR-NMEA-IO y la red
- `Alarm` — instancia activa de alarma
- `PermissiveRule`,
`Condition` — pre-condiciones para acciones de control
- `Project` — agregado raíz que une todo lo anterior
Reglas de oro relevantes:
- Coordenadas navales SIEMPRE: ShipCoord.
- Unidades SI internas SIEMPRE: m, kg, Pa, °C, s.
- Idioma: español por defecto (campos `name`, `description` libres).
- Persistencia portable a SQLite (`.vmsproj`).
"""
from vmssailor.core.alarm import Alarm
from vmssailor.core.card import Bus, CardInstance, Topology
from vmssailor.core.coords import ShipCoord
from vmssailor.core.enums import (
AlarmPriority,
AlarmState,
AuthorityRequired,
BusRole,
ChannelType,
ControlMode,
EquipmentCategory,
FilterType,
Protocol,
Quality,
SignalType,
SystemId,
UnitSI,
VesselSubtype,
VesselType,
)
from vmssailor.core.equipment import Equipment, EquipmentModel, EquipmentSpec, Sensor
from vmssailor.core.permissive import Condition, PermissiveRule
from vmssailor.core.project import Project
from vmssailor.core.tag import AlarmConfig, Scaling, Tag, TagBinding
from vmssailor.core.vessel import Bulkhead, Deck, Vessel
__all__ = [ # noqa: RUF022 -- agrupado por entidad, no alfabético, para legibilidad
# coords
"ShipCoord",
# enums
"AlarmPriority",
"AlarmState",
"AuthorityRequired",
"BusRole",
"ChannelType",
"ControlMode",
"EquipmentCategory",
"FilterType",
"Protocol",
"Quality",
"SignalType",
"SystemId",
"UnitSI",
"VesselSubtype",
"VesselType",
# vessel
"Bulkhead",
"Deck",
"Vessel",
# equipment
"Equipment",
"EquipmentModel",
"EquipmentSpec",
"Sensor",
# tag
"AlarmConfig",
"Scaling",
"Tag",
"TagBinding",
# card
"Bus",
"CardInstance",
"Topology",
# alarm
"Alarm",
# permissive
"Condition",
"PermissiveRule",
# project (root aggregate)
"Project",
]