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>
59 lines
2.8 KiB
Plaintext
59 lines
2.8 KiB
Plaintext
AR-Autopilot
|
|
Copyright (c) 2026 Alvaro Romero. All Rights Reserved.
|
|
|
|
PROPRIETARY AND CONFIDENTIAL — NOT FOR REDISTRIBUTION
|
|
================================================================================
|
|
|
|
This software, including but not limited to its source code, firmware,
|
|
configuration files, default tuning parameters, schematics, documentation,
|
|
and any accompanying assets (collectively, the "Software"), is the exclusive
|
|
property of Alvaro Romero ("the Author") and is protected by international
|
|
copyright law and treaty provisions.
|
|
|
|
PERMITTED USE
|
|
--------------------------------------------------------------------------------
|
|
No license, express or implied, is granted to any person or entity to:
|
|
|
|
(a) use, copy, modify, merge, publish, distribute, sublicense, or sell
|
|
copies of the Software, in whole or in part;
|
|
|
|
(b) reverse-engineer, decompile, disassemble, or otherwise attempt to
|
|
derive the source code from compiled binaries or firmware images;
|
|
|
|
(c) extract, reuse, or redistribute the default PID tuning parameters,
|
|
gain schedules, actuator profiles, vessel profiles, or any other
|
|
proprietary parameter set bundled with the Software, which constitute
|
|
trade secrets of the Author;
|
|
|
|
(d) use the Software, or any derivative thereof, for the development of
|
|
competing autopilot, dynamic positioning, or vessel control products;
|
|
|
|
except under the terms of a separate written commercial license agreement
|
|
signed by the Author.
|
|
|
|
COMMERCIAL LICENSING
|
|
--------------------------------------------------------------------------------
|
|
Commercial deployment of the Software on board a vessel requires a per-vessel
|
|
license bound to the unique hardware identifier (HWID) of the installation,
|
|
issued by the Author. Contact the Author for licensing inquiries.
|
|
|
|
SAFETY-CRITICAL DISCLAIMER
|
|
--------------------------------------------------------------------------------
|
|
THE SOFTWARE CONTROLS VESSEL STEERING SYSTEMS AND IS SAFETY-CRITICAL.
|
|
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
|
|
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
|
|
FITNESS FOR A PARTICULAR PURPOSE, AND NONINFRINGEMENT. IN NO EVENT SHALL THE
|
|
AUTHOR BE LIABLE FOR ANY CLAIM, DAMAGES, INJURY, LOSS OF LIFE, LOSS OF
|
|
VESSEL, OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR
|
|
OTHERWISE, ARISING FROM, OUT OF, OR IN CONNECTION WITH THE SOFTWARE OR THE
|
|
USE OR OTHER DEALINGS IN THE SOFTWARE.
|
|
|
|
Installation, commissioning, and operation of the Software must comply with
|
|
the relevant maritime regulations and standards applicable to the vessel and
|
|
its area of operation, including but not limited to ISO 11674, ISO 16329, and
|
|
IMO MSC.64(67).
|
|
|
|
================================================================================
|
|
For licensing inquiries: alro65@gmail.com
|
|
================================================================================
|