# milovv13/menumanager architecture

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

- Interactive diagram: https://gitdiagram.com/milovv13/menumanager
- Repository: https://github.com/milovv13/menumanager

## Overview

Arduino Menu System is a compile-time-configured menu library for Arduino-compatible boards. A user calls its init/update API from the application loop; the manager reads the selected input, navigates or edits configuration, and redraws through the selected display. The documented capabilities include hierarchical menus, IP/integer/string editors, callbacks, three input backends, three display backends, and three platforms. The graph shows the main runtime dispatch and data/model layers; backend details not shown in source excerpts are limited to README or SOURCE INDEX evidence.

Main entry points: [`src/MenuManager.cpp`](https://github.com/milovv13/menumanager/blob/main/src/MenuManager.cpp) (Menu manager), [`src/InputKey.h`](https://github.com/milovv13/menumanager/blob/main/src/InputKey.h) (Input selector), [`src/Display.h`](https://github.com/milovv13/menumanager/blob/main/src/Display.h) (Display selector), [`src/MenuUtils.h`](https://github.com/milovv13/menumanager/blob/main/src/MenuUtils.h) (Menu utilities)

## Diagram (Mermaid)

```mermaid
flowchart TD

subgraph group_api["Menu runtime"]
  node_manager["Menu manager<br/>[MenuManager.cpp]"]
  node_public_api["Public API<br/>[MenuManager.h]"]
  node_entry["Example entry<br/>[main.cpp]"]
end

subgraph group_model["Menu data"]
  node_menu_data["Menu data<br/>[MenuData.h]"]
  node_menu_types["Menu types<br/>[MenuTypes.h]"]
  node_menu_utils["Menu utilities<br/>[MenuUtils.h]"]
  node_platform_config["Platform config<br/>[config.h]"]
end

subgraph group_input["Input backends"]
  node_input_select["Input selector<br/>[InputKey.h]"]
  node_joystick["Joystick input<br/>[JeyKey.h]"]
  node_encoder["Encoder input<br/>[EncKey.h]"]
  node_serial_input["Serial input<br/>[SerialKey.h]"]
end

subgraph group_display["Display backends"]
  node_display_select["Display selector<br/>[Display.h]"]
  node_serial_display["Serial display<br/>[SerialDisp.h]"]
  node_oled_display["SSD1306 display<br/>[SSD1306Disp.h]"]
  node_lcd_display["LCD display<br/>[LCDDisp.h]"]
end

node_application(("Application"))

node_application -->|"calls API"| node_public_api
node_entry -->|"uses API"| node_public_api
node_public_api -->|"declares API"| node_manager
node_manager -->|"reads input"| node_input_select
node_manager -->|"dispatches display"| node_display_select
node_manager -->|"uses menu"| node_menu_data
node_manager -->|"uses helpers"| node_menu_utils
node_input_select -->|"selects backend"| node_joystick
node_input_select -->|"selects backend"| node_encoder
node_input_select -->|"selects backend"| node_serial_input
node_display_select -->|"selects backend"| node_serial_display
node_display_select -->|"selects backend"| node_oled_display
node_display_select -->|"selects backend"| node_lcd_display
node_menu_data -->|"defines instances"| node_menu_types
node_menu_utils -->|"uses types"| node_menu_types
node_serial_display -->|"uses helpers"| node_menu_utils
node_oled_display -->|"uses helpers"| node_menu_utils
node_lcd_display -->|"uses helpers"| node_menu_utils
node_input_select -->|"reads settings"| node_platform_config
node_display_select -->|"reads settings"| node_platform_config
node_encoder -->|"uses pin settings"| node_platform_config

click node_manager "https://github.com/milovv13/menumanager/blob/main/src/MenuManager.cpp"
click node_public_api "https://github.com/milovv13/menumanager/blob/main/src/MenuManager.h"
click node_input_select "https://github.com/milovv13/menumanager/blob/main/src/InputKey.h"
click node_joystick "https://github.com/milovv13/menumanager/blob/main/src/JeyKey.h"
click node_encoder "https://github.com/milovv13/menumanager/blob/main/src/EncKey.h"
click node_serial_input "https://github.com/milovv13/menumanager/blob/main/src/SerialKey.h"
click node_display_select "https://github.com/milovv13/menumanager/blob/main/src/Display.h"
click node_serial_display "https://github.com/milovv13/menumanager/blob/main/src/SerialDisp.h"
click node_oled_display "https://github.com/milovv13/menumanager/blob/main/src/SSD1306Disp.h"
click node_lcd_display "https://github.com/milovv13/menumanager/blob/main/src/LCDDisp.h"
click node_menu_data "https://github.com/milovv13/menumanager/blob/main/src/MenuData.h"
click node_menu_types "https://github.com/milovv13/menumanager/blob/main/src/MenuTypes.h"
click node_menu_utils "https://github.com/milovv13/menumanager/blob/main/src/MenuUtils.h"
click node_platform_config "https://github.com/milovv13/menumanager/blob/main/src/config.h"
click node_entry "https://github.com/milovv13/menumanager/blob/main/src/main.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_manager,node_public_api,node_entry toneBlue
class node_menu_data,node_menu_types,node_menu_utils,node_platform_config toneAmber
class node_input_select,node_joystick,node_encoder,node_serial_input toneMint
class node_display_select,node_serial_display,node_oled_display,node_lcd_display toneRose
class node_application toneIndigo
```

## Components

### Menu runtime

- [Menu manager](https://github.com/milovv13/menumanager/blob/main/src/MenuManager.cpp): `src/MenuManager.cpp`
- [Public API](https://github.com/milovv13/menumanager/blob/main/src/MenuManager.h): `src/MenuManager.h`
- [Example entry](https://github.com/milovv13/menumanager/blob/main/src/main.cpp): `src/main.cpp`

### Menu data

- [Menu data](https://github.com/milovv13/menumanager/blob/main/src/MenuData.h): `src/MenuData.h`
- [Menu types](https://github.com/milovv13/menumanager/blob/main/src/MenuTypes.h): `src/MenuTypes.h`
- [Menu utilities](https://github.com/milovv13/menumanager/blob/main/src/MenuUtils.h): `src/MenuUtils.h`
- [Platform config](https://github.com/milovv13/menumanager/blob/main/src/config.h): `src/config.h`

### Input backends

- [Input selector](https://github.com/milovv13/menumanager/blob/main/src/InputKey.h): `src/InputKey.h`
- [Joystick input](https://github.com/milovv13/menumanager/blob/main/src/JeyKey.h): `src/JeyKey.h`
- [Encoder input](https://github.com/milovv13/menumanager/blob/main/src/EncKey.h): `src/EncKey.h`
- [Serial input](https://github.com/milovv13/menumanager/blob/main/src/SerialKey.h): `src/SerialKey.h`

### Display backends

- [Display selector](https://github.com/milovv13/menumanager/blob/main/src/Display.h): `src/Display.h`
- [Serial display](https://github.com/milovv13/menumanager/blob/main/src/SerialDisp.h): `src/SerialDisp.h`
- [SSD1306 display](https://github.com/milovv13/menumanager/blob/main/src/SSD1306Disp.h): `src/SSD1306Disp.h`
- [LCD display](https://github.com/milovv13/menumanager/blob/main/src/LCDDisp.h): `src/LCDDisp.h`

### Other components

- **Application**

## Connections

- Application → Public API: calls API (evidence: `README.md`)
- Example entry → Public API: uses API (evidence: `src/main.cpp`)
- Public API → Menu manager: declares API (evidence: `src/MenuManager.h`)
- Menu manager → Input selector: reads input (evidence: `src/MenuManager.cpp`)
- Menu manager → Display selector: dispatches display (evidence: `src/MenuManager.cpp`)
- Menu manager → Menu data: uses menu (evidence: `src/MenuManager.cpp`)
- Menu manager → Menu utilities: uses helpers (evidence: `src/MenuManager.cpp`)
- Input selector → Joystick input: selects backend (evidence: `src/InputKey.h`)
- Input selector → Encoder input: selects backend (evidence: `src/InputKey.h`)
- Input selector → Serial input: selects backend (evidence: `src/InputKey.h`)
- Display selector → Serial display: selects backend (evidence: `src/Display.h`)
- Display selector → SSD1306 display: selects backend (evidence: `src/Display.h`)
- Display selector → LCD display: selects backend (evidence: `src/Display.h`)
- Menu data → Menu types: defines instances (evidence: `src/MenuData.h`)
- Menu utilities → Menu types: uses types (evidence: `src/MenuUtils.h`)
- Serial display → Menu utilities: uses helpers (evidence: `src/SerialDisp.h`)
- SSD1306 display → Menu utilities: uses helpers (evidence: `src/SSD1306Disp.h`)
- LCD display → Menu utilities: uses helpers (evidence: `src/LCDDisp.h`)
- Input selector → Platform config: reads settings (evidence: `src/InputKey.h`)
- Display selector → Platform config: reads settings (evidence: `src/Display.h`)
- Encoder input → Platform config: uses pin settings (evidence: `src/EncKey.h`)
