# peterantypas/maiana architecture

> Architecture diagram of the GitHub repository peterantypas/maiana, generated by GitDiagram from its file tree, README and a sample of source files (last updated 2026-10-08). It is an AI-made overview: check details against the source.

- Interactive diagram: https://gitdiagram.com/peterantypas/maiana
- Repository: https://github.com/peterantypas/maiana

## Overview

MAIANA is an embedded AIS transponder with separate transponder and NMEA 2000 adapter firmware, plus host-side firmware-update tooling. The primary workflow is GNSS timing and position plus configured station data feeding AIS reception/transmission, then NMEA output through the chosen boat-system interface. A bootloader supports firmware updates; OpenPlotter can manage and update the device. The README documents product-level capabilities; source excerpts are limited, so several subsystem links are documented rather than verified from implementation calls.

Main entry points: [`latest/Firmware/Transponder/Src/RadioManager.cpp`](https://github.com/peterantypas/maiana/blob/master/latest/Firmware/Transponder/Src/RadioManager.cpp) (AIS radio control), [`latest/Firmware/NMEA2000Adapter/Core/Src/main.cpp`](https://github.com/peterantypas/maiana/blob/master/latest/Firmware/NMEA2000Adapter/Core/Src/main.cpp) (NMEA0183 consumer), [`latest/Firmware/Bootloader/Src/main.c`](https://github.com/peterantypas/maiana/blob/master/latest/Firmware/Bootloader/Src/main.c) (Firmware bootloader), [`latest/Firmware/Transponder/Src/main.cpp`](https://github.com/peterantypas/maiana/blob/master/latest/Firmware/Transponder/Src/main.cpp) (Transponder firmware)

## Diagram (Mermaid)

```mermaid
flowchart TD

subgraph group_transponder["Transponder firmware"]
  node_ais_radio["AIS radio control<br/>[RadioManager.cpp]"]
  node_channel_mgr["Channel manager<br/>[ChannelManager.cpp]"]
  node_station_config["Station provisioning<br/>[bsp.hpp]"]
  node_transponder_app["Transponder firmware<br/>[main.cpp]"]
end

subgraph group_interfaces["Boat interfaces"]
  node_uart_nmea["UART NMEA0183"]
  node_nmea_consumer["NMEA0183 consumer<br/>[main.cpp]"]
  node_nmea_parser["Sentence handling<br/>[NMEASentence.cpp]"]
  node_n2k_stack["NMEA 2000 stack<br/>[NMEA2000.cpp]"]
  node_can_interface["CAN adapter<br/>[NMEA2000_mcp.cpp]"]
  node_adapter_events["Adapter event queue<br/>[EventQueue.cpp]"]
end

subgraph group_updates["Firmware updates"]
  node_updater_ui["Update application<br/>[mainframe.py]"]
  node_updater_client["Device update client<br/>[maianaclient.py]"]
  node_bootloader["Firmware bootloader<br/>[main.c]"]
  node_flash[("Firmware flash")]
end

subgraph group_hardware["Hardware services"]
  node_hal["STM32 hardware layer<br/>[stm32l4xx_hal.c]"]
end

node_operator(("Boat operator"))
node_gnss["GNSS receiver"]
node_boat_systems(("Boat systems"))

node_gnss -.->|"provides timing"| node_ais_radio
node_station_config -.->|"configures station"| node_transponder_app
node_transponder_app -.->|"controls radio"| node_ais_radio
node_channel_mgr -.->|"selects channels"| node_ais_radio
node_ais_radio -.->|"outputs AIS data"| node_uart_nmea
node_uart_nmea -.->|"sends serial data"| node_nmea_consumer
node_nmea_consumer -.->|"processes sentences"| node_nmea_parser
node_nmea_consumer -->|"dispatches events"| node_adapter_events
node_nmea_parser -.->|"encodes NMEA data"| node_n2k_stack
node_n2k_stack -.->|"uses CAN adapter"| node_can_interface
node_can_interface -.->|"outputs NMEA 2000"| node_boat_systems
node_operator -.->|"requests update"| node_updater_ui
node_updater_ui -.->|"starts update"| node_updater_client
node_updater_client -.->|"transfers firmware"| node_bootloader
node_bootloader -->|"validates and installs"| node_flash
node_bootloader -.->|"controls hardware"| node_hal

click node_ais_radio "https://github.com/peterantypas/maiana/blob/master/latest/Firmware/Transponder/Src/RadioManager.cpp"
click node_channel_mgr "https://github.com/peterantypas/maiana/blob/master/latest/Firmware/Transponder/Src/ChannelManager.cpp"
click node_station_config "https://github.com/peterantypas/maiana/blob/master/latest/Firmware/Transponder/Inc/bsp/bsp.hpp"
click node_transponder_app "https://github.com/peterantypas/maiana/blob/master/latest/Firmware/Transponder/Src/main.cpp"
click node_uart_nmea "https://github.com/peterantypas/maiana/tree/master/latest/Firmware/Transponder/Inc"
click node_nmea_consumer "https://github.com/peterantypas/maiana/blob/master/latest/Firmware/NMEA2000Adapter/Core/Src/main.cpp"
click node_nmea_parser "https://github.com/peterantypas/maiana/blob/master/latest/Firmware/NMEA2000Adapter/Core/Src/NMEASentence.cpp"
click node_n2k_stack "https://github.com/peterantypas/maiana/blob/master/latest/Firmware/NMEA2000Adapter/nmea2000/NMEA2000.cpp"
click node_can_interface "https://github.com/peterantypas/maiana/blob/master/latest/Firmware/NMEA2000Adapter/n2k_mcp/NMEA2000_mcp.cpp"
click node_updater_ui "https://github.com/peterantypas/maiana/blob/master/latest/Apps/maiana-update/mainframe.py"
click node_updater_client "https://github.com/peterantypas/maiana/blob/master/latest/Apps/maiana-update/maianaclient.py"
click node_bootloader "https://github.com/peterantypas/maiana/blob/master/latest/Firmware/Bootloader/Src/main.c"
click node_hal "https://github.com/peterantypas/maiana/blob/master/latest/Firmware/Bootloader/Drivers/STM32L4xx_HAL_Driver/Src/stm32l4xx_hal.c"
click node_adapter_events "https://github.com/peterantypas/maiana/blob/master/latest/Firmware/NMEA2000Adapter/Core/Src/EventQueue.cpp"

classDef toneNeutral fill:#f8fafc,stroke:#334155,stroke-width:1.5px,color:#0f172a
classDef toneBlue fill:#dbeafe,stroke:#2563eb,stroke-width:1.5px,color:#172554
classDef toneAmber fill:#fef3c7,stroke:#d97706,stroke-width:1.5px,color:#78350f
classDef toneMint fill:#dcfce7,stroke:#16a34a,stroke-width:1.5px,color:#14532d
classDef toneRose fill:#ffe4e6,stroke:#e11d48,stroke-width:1.5px,color:#881337
classDef toneIndigo fill:#e0e7ff,stroke:#4f46e5,stroke-width:1.5px,color:#312e81
classDef toneTeal fill:#ccfbf1,stroke:#0f766e,stroke-width:1.5px,color:#134e4a
class node_ais_radio,node_channel_mgr,node_station_config,node_transponder_app toneBlue
class node_uart_nmea,node_nmea_consumer,node_nmea_parser,node_n2k_stack,node_can_interface,node_adapter_events toneAmber
class node_updater_ui,node_updater_client,node_bootloader,node_flash toneMint
class node_hal toneRose
class node_operator,node_gnss,node_boat_systems toneIndigo
```

## Components

### Transponder firmware

- [AIS radio control](https://github.com/peterantypas/maiana/blob/master/latest/Firmware/Transponder/Src/RadioManager.cpp): `latest/Firmware/Transponder/Src/RadioManager.cpp`
- [Channel manager](https://github.com/peterantypas/maiana/blob/master/latest/Firmware/Transponder/Src/ChannelManager.cpp): `latest/Firmware/Transponder/Src/ChannelManager.cpp`
- [Station provisioning](https://github.com/peterantypas/maiana/blob/master/latest/Firmware/Transponder/Inc/bsp/bsp.hpp): `latest/Firmware/Transponder/Inc/bsp/bsp.hpp`
- [Transponder firmware](https://github.com/peterantypas/maiana/blob/master/latest/Firmware/Transponder/Src/main.cpp): `latest/Firmware/Transponder/Src/main.cpp`

### Boat interfaces

- [UART NMEA0183](https://github.com/peterantypas/maiana/tree/master/latest/Firmware/Transponder/Inc): `latest/Firmware/Transponder/Inc`
- [NMEA0183 consumer](https://github.com/peterantypas/maiana/blob/master/latest/Firmware/NMEA2000Adapter/Core/Src/main.cpp): `latest/Firmware/NMEA2000Adapter/Core/Src/main.cpp`
- [Sentence handling](https://github.com/peterantypas/maiana/blob/master/latest/Firmware/NMEA2000Adapter/Core/Src/NMEASentence.cpp): `latest/Firmware/NMEA2000Adapter/Core/Src/NMEASentence.cpp`
- [NMEA 2000 stack](https://github.com/peterantypas/maiana/blob/master/latest/Firmware/NMEA2000Adapter/nmea2000/NMEA2000.cpp): `latest/Firmware/NMEA2000Adapter/nmea2000/NMEA2000.cpp`
- [CAN adapter](https://github.com/peterantypas/maiana/blob/master/latest/Firmware/NMEA2000Adapter/n2k_mcp/NMEA2000_mcp.cpp): `latest/Firmware/NMEA2000Adapter/n2k_mcp/NMEA2000_mcp.cpp`
- [Adapter event queue](https://github.com/peterantypas/maiana/blob/master/latest/Firmware/NMEA2000Adapter/Core/Src/EventQueue.cpp): `latest/Firmware/NMEA2000Adapter/Core/Src/EventQueue.cpp`

### Firmware updates

- [Update application](https://github.com/peterantypas/maiana/blob/master/latest/Apps/maiana-update/mainframe.py): `latest/Apps/maiana-update/mainframe.py`
- [Device update client](https://github.com/peterantypas/maiana/blob/master/latest/Apps/maiana-update/maianaclient.py): `latest/Apps/maiana-update/maianaclient.py`
- [Firmware bootloader](https://github.com/peterantypas/maiana/blob/master/latest/Firmware/Bootloader/Src/main.c): `latest/Firmware/Bootloader/Src/main.c`
- **Firmware flash**

### Hardware services

- [STM32 hardware layer](https://github.com/peterantypas/maiana/blob/master/latest/Firmware/Bootloader/Drivers/STM32L4xx_HAL_Driver/Src/stm32l4xx_hal.c): `latest/Firmware/Bootloader/Drivers/STM32L4xx_HAL_Driver/Src/stm32l4xx_hal.c`

### Other components

- **Boat operator**
- **GNSS receiver**
- **Boat systems**

## Connections

- GNSS receiver → AIS radio control: provides timing
- Station provisioning → Transponder firmware: configures station
- Transponder firmware → AIS radio control: controls radio
- Channel manager → AIS radio control: selects channels
- AIS radio control → UART NMEA0183: outputs AIS data (evidence: `latest/Firmware/Transponder/Src/RadioManager.cpp`)
- UART NMEA0183 → NMEA0183 consumer: sends serial data
- NMEA0183 consumer → Sentence handling: processes sentences (evidence: `latest/Firmware/NMEA2000Adapter/Core/Src/main.cpp`)
- NMEA0183 consumer → Adapter event queue: dispatches events (evidence: `latest/Firmware/NMEA2000Adapter/Core/Src/main.cpp`)
- Sentence handling → NMEA 2000 stack: encodes NMEA data
- NMEA 2000 stack → CAN adapter: uses CAN adapter
- CAN adapter → Boat systems: outputs NMEA 2000
- Boat operator → Update application: requests update
- Update application → Device update client: starts update (evidence: `latest/Apps/maiana-update/mainframe.py`)
- Device update client → Firmware bootloader: transfers firmware
- Firmware bootloader → Firmware flash: validates and installs (evidence: `latest/Firmware/Bootloader/Src/main.c`)
- Firmware bootloader → STM32 hardware layer: controls hardware (evidence: `latest/Firmware/Bootloader/Src/main.c`)
