# kde/cutehmi architecture

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

- Interactive diagram: https://gitdiagram.com/kde/cutehmi
- Repository: https://github.com/kde/cutehmi

## Overview

CuteHMI is a modular Qt/C++ and QML HMI framework: extensions provide reusable libraries and QML components, while tools load and run them. The primary user workflow is selecting an extension/component and launching it with cutehmi.view.4; the console tool additionally accepts interactive input, and the daemon runs projects in daemon or application mode. The graph includes documented extension capabilities and sampled Modbus, service, and console internals. Several extension paths are represented from the tree; their internal links are omitted where source evidence was not provided.

Main entry points: [`extensions`](https://github.com/kde/cutehmi/tree/master/extensions) (Extensions), [`tools/cutehmi.view.4/src/main.cpp`](https://github.com/kde/cutehmi/blob/master/tools/cutehmi.view.4/src/main.cpp) (View launcher), [`tools/cutehmi.console.0/src/main.cpp`](https://github.com/kde/cutehmi/blob/master/tools/cutehmi.console.0/src/main.cpp) (Console tool), [`tools/cutehmi.daemon.3/src/main.cpp`](https://github.com/kde/cutehmi/blob/master/tools/cutehmi.daemon.3/src/main.cpp) (Daemon tool)

## Diagram (Mermaid)

```mermaid
flowchart TD

subgraph group_tools["Runtime tools"]
  node_view["View launcher<br/>[main.cpp]"]
  node_console["Console tool<br/>[main.cpp]"]
  node_input["Line input<br/>[InputHandler.cpp]"]
  node_interpreter["Command interpreter<br/>[Interpreter.cpp]"]
  node_daemon["Daemon tool<br/>[main.cpp]"]
  node_qml_dump["QML plugin dumper<br/>[main.cpp]"]
end

subgraph group_core["Shared runtime"]
  node_extension_ecosystem["Extensions"]
  node_core_runtime["Core runtime<br/>[Worker.cpp]"]
end

subgraph group_industrial["Industrial extensions"]
  node_modbus["Modbus devices<br/>[AbstractDevice.hpp]"]
  node_register_controller["Register control"]
  node_register16["16-bit controller"]
  node_data_acquisition["Data acquisition<br/>[DataAcquisition.1]"]
  node_gpio["GPIO access<br/>[GPIO.0]"]
end

subgraph group_application["Application extensions"]
  node_services["Service management"]
  node_service_state["Service state"]
  node_shared_database[("Shared database<br/>[Database.cpp]")]
  node_gui["GUI theming<br/>[Theme.cpp]"]
  node_lockscreen["Lock screen<br/>[Gatekeeper.cpp]"]
  node_bitcoin_cash["Bitcoin Cash<br/>[Address.cpp]"]
end

node_user(("HMI user"))

node_user -->|"launches"| node_view
node_view -->|"loads extension"| node_extension_ecosystem
node_user -->|"starts tool"| node_console
node_console -->|"reads lines"| node_input
node_input -->|"sends lines"| node_interpreter
node_interpreter -->|"requests next line"| node_input
node_user -->|"starts tool"| node_daemon
node_daemon -->|"runs project"| node_extension_ecosystem
node_view -->|"uses runtime"| node_core_runtime
node_console -->|"uses runtime"| node_core_runtime
node_daemon -->|"uses runtime"| node_core_runtime
node_extension_ecosystem -->|"includes capability"| node_modbus
node_extension_ecosystem -.->|"includes capability"| node_data_acquisition
node_extension_ecosystem -.->|"includes capability"| node_gpio
node_extension_ecosystem -.->|"includes capability"| node_services
node_extension_ecosystem -.->|"includes capability"| node_shared_database
node_extension_ecosystem -.->|"includes capability"| node_gui
node_extension_ecosystem -.->|"includes capability"| node_lockscreen
node_extension_ecosystem -.->|"includes capability"| node_bitcoin_cash
node_modbus -->|"supports controller"| node_register_controller
node_register16 -->|"uses mixin"| node_register_controller
node_services -->|"tracks state"| node_service_state
node_user -.->|"inspects plugins"| node_qml_dump

click node_view "https://github.com/kde/cutehmi/blob/master/tools/cutehmi.view.4/src/main.cpp"
click node_console "https://github.com/kde/cutehmi/blob/master/tools/cutehmi.console.0/src/main.cpp"
click node_input "https://github.com/kde/cutehmi/blob/master/tools/cutehmi.console.0/src/cutehmi/console/InputHandler.cpp"
click node_interpreter "https://github.com/kde/cutehmi/blob/master/tools/cutehmi.console.0/src/cutehmi/console/Interpreter.cpp"
click node_daemon "https://github.com/kde/cutehmi/blob/master/tools/cutehmi.daemon.3/src/main.cpp"
click node_qml_dump "https://github.com/kde/cutehmi/blob/master/tools/cutehmi.qmlplugindump.0/src/5/14/0/main.cpp"
click node_extension_ecosystem "https://github.com/kde/cutehmi/tree/master/extensions"
click node_core_runtime "https://github.com/kde/cutehmi/blob/master/extensions/CuteHMI.2/src/cutehmi/Worker.cpp"
click node_modbus "https://github.com/kde/cutehmi/blob/master/extensions/CuteHMI/Modbus.4/include/cutehmi/modbus/AbstractDevice.hpp"
click node_register_controller "https://github.com/kde/cutehmi/blob/master/extensions/CuteHMI/Modbus.4/include/cutehmi/modbus/internal/RegisterControllerMixin.hpp"
click node_register16 "https://github.com/kde/cutehmi/blob/master/extensions/CuteHMI/Modbus.4/include/cutehmi/modbus/Register16Controller.hpp"
click node_data_acquisition "https://github.com/kde/cutehmi/tree/master/extensions/CuteHMI/DataAcquisition.1"
click node_gpio "https://github.com/kde/cutehmi/tree/master/extensions/CuteHMI/GPIO.0"
click node_services "https://github.com/kde/cutehmi/blob/master/extensions/CuteHMI/Services.3/include/cutehmi/services/AbstractService.hpp"
click node_service_state "https://github.com/kde/cutehmi/blob/master/extensions/CuteHMI/Services.3/src/cutehmi/services/internal/ServiceStateInterface.cpp"
click node_shared_database "https://github.com/kde/cutehmi/blob/master/extensions/CuteHMI/SharedDatabase.1/src/cutehmi/shareddatabase/Database.cpp"
click node_gui "https://github.com/kde/cutehmi/blob/master/extensions/CuteHMI/GUI.1/src/cutehmi/gui/Theme.cpp"
click node_lockscreen "https://github.com/kde/cutehmi/blob/master/extensions/CuteHMI/LockScreen.2/src/cutehmi/lockscreen/Gatekeeper.cpp"
click node_bitcoin_cash "https://github.com/kde/cutehmi/blob/master/extensions/CuteHMI/BitcoinCash.0/src/cutehmi/bitcoincash/Address.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_view,node_console,node_input,node_interpreter,node_daemon,node_qml_dump,node_user toneBlue
class node_extension_ecosystem,node_core_runtime toneAmber
class node_modbus,node_register_controller,node_register16,node_data_acquisition,node_gpio toneMint
class node_services,node_service_state,node_shared_database,node_gui,node_lockscreen,node_bitcoin_cash toneRose
```

## Components

### Runtime tools

- [View launcher](https://github.com/kde/cutehmi/blob/master/tools/cutehmi.view.4/src/main.cpp): `tools/cutehmi.view.4/src/main.cpp`
- [Console tool](https://github.com/kde/cutehmi/blob/master/tools/cutehmi.console.0/src/main.cpp): `tools/cutehmi.console.0/src/main.cpp`
- [Line input](https://github.com/kde/cutehmi/blob/master/tools/cutehmi.console.0/src/cutehmi/console/InputHandler.cpp): `tools/cutehmi.console.0/src/cutehmi/console/InputHandler.cpp`
- [Command interpreter](https://github.com/kde/cutehmi/blob/master/tools/cutehmi.console.0/src/cutehmi/console/Interpreter.cpp): `tools/cutehmi.console.0/src/cutehmi/console/Interpreter.cpp`
- [Daemon tool](https://github.com/kde/cutehmi/blob/master/tools/cutehmi.daemon.3/src/main.cpp): `tools/cutehmi.daemon.3/src/main.cpp`
- [QML plugin dumper](https://github.com/kde/cutehmi/blob/master/tools/cutehmi.qmlplugindump.0/src/5/14/0/main.cpp): `tools/cutehmi.qmlplugindump.0/src/5/14/0/main.cpp`

### Shared runtime

- [Extensions](https://github.com/kde/cutehmi/tree/master/extensions): `extensions`
- [Core runtime](https://github.com/kde/cutehmi/blob/master/extensions/CuteHMI.2/src/cutehmi/Worker.cpp): `extensions/CuteHMI.2/src/cutehmi/Worker.cpp`

### Industrial extensions

- [Modbus devices](https://github.com/kde/cutehmi/blob/master/extensions/CuteHMI/Modbus.4/include/cutehmi/modbus/AbstractDevice.hpp): `extensions/CuteHMI/Modbus.4/include/cutehmi/modbus/AbstractDevice.hpp`
- [Register control](https://github.com/kde/cutehmi/blob/master/extensions/CuteHMI/Modbus.4/include/cutehmi/modbus/internal/RegisterControllerMixin.hpp): `extensions/CuteHMI/Modbus.4/include/cutehmi/modbus/internal/RegisterControllerMixin.hpp`
- [16-bit controller](https://github.com/kde/cutehmi/blob/master/extensions/CuteHMI/Modbus.4/include/cutehmi/modbus/Register16Controller.hpp): `extensions/CuteHMI/Modbus.4/include/cutehmi/modbus/Register16Controller.hpp`
- [Data acquisition](https://github.com/kde/cutehmi/tree/master/extensions/CuteHMI/DataAcquisition.1): `extensions/CuteHMI/DataAcquisition.1`
- [GPIO access](https://github.com/kde/cutehmi/tree/master/extensions/CuteHMI/GPIO.0): `extensions/CuteHMI/GPIO.0`

### Application extensions

- [Service management](https://github.com/kde/cutehmi/blob/master/extensions/CuteHMI/Services.3/include/cutehmi/services/AbstractService.hpp): `extensions/CuteHMI/Services.3/include/cutehmi/services/AbstractService.hpp`
- [Service state](https://github.com/kde/cutehmi/blob/master/extensions/CuteHMI/Services.3/src/cutehmi/services/internal/ServiceStateInterface.cpp): `extensions/CuteHMI/Services.3/src/cutehmi/services/internal/ServiceStateInterface.cpp`
- [Shared database](https://github.com/kde/cutehmi/blob/master/extensions/CuteHMI/SharedDatabase.1/src/cutehmi/shareddatabase/Database.cpp): `extensions/CuteHMI/SharedDatabase.1/src/cutehmi/shareddatabase/Database.cpp`
- [GUI theming](https://github.com/kde/cutehmi/blob/master/extensions/CuteHMI/GUI.1/src/cutehmi/gui/Theme.cpp): `extensions/CuteHMI/GUI.1/src/cutehmi/gui/Theme.cpp`
- [Lock screen](https://github.com/kde/cutehmi/blob/master/extensions/CuteHMI/LockScreen.2/src/cutehmi/lockscreen/Gatekeeper.cpp): `extensions/CuteHMI/LockScreen.2/src/cutehmi/lockscreen/Gatekeeper.cpp`
- [Bitcoin Cash](https://github.com/kde/cutehmi/blob/master/extensions/CuteHMI/BitcoinCash.0/src/cutehmi/bitcoincash/Address.cpp): `extensions/CuteHMI/BitcoinCash.0/src/cutehmi/bitcoincash/Address.cpp`

### Other components

- **HMI user**

## Connections

- HMI user → View launcher: launches (evidence: `README.md`)
- View launcher → Extensions: loads extension (evidence: `tools/cutehmi.view.4/src/main.cpp`)
- HMI user → Console tool: starts tool (evidence: `README.md`)
- Console tool → Line input: reads lines (evidence: `tools/cutehmi.console.0/src/main.cpp`)
- Line input → Command interpreter: sends lines
- Command interpreter → Line input: requests next line
- HMI user → Daemon tool: starts tool (evidence: `README.md`)
- Daemon tool → Extensions: runs project (evidence: `tools/cutehmi.daemon.3/src/main.cpp`)
- View launcher → Core runtime: uses runtime (evidence: `tools/cutehmi.view.4/src/main.cpp`)
- Console tool → Core runtime: uses runtime (evidence: `tools/cutehmi.console.0/src/main.cpp`)
- Daemon tool → Core runtime: uses runtime (evidence: `tools/cutehmi.daemon.3/src/main.cpp`)
- Extensions → Modbus devices: includes capability (evidence: `README.md`)
- Extensions → Data acquisition: includes capability
- Extensions → GPIO access: includes capability
- Extensions → Service management: includes capability (evidence: `extensions/CuteHMI/Services.3/src/cutehmi/services/internal/ServiceStateInterface.cpp`)
- Extensions → Shared database: includes capability
- Extensions → GUI theming: includes capability
- Extensions → Lock screen: includes capability
- Extensions → Bitcoin Cash: includes capability
- Modbus devices → Register control: supports controller (evidence: `extensions/CuteHMI/Modbus.4/include/cutehmi/modbus/internal/RegisterControllerMixin.hpp`)
- 16-bit controller → Register control: uses mixin (evidence: `extensions/CuteHMI/Modbus.4/include/cutehmi/modbus/Register16Controller.hpp`)
- Service management → Service state: tracks state (evidence: `extensions/CuteHMI/Services.3/src/cutehmi/services/internal/ServiceStateInterface.cpp`)
- HMI user → QML plugin dumper: inspects plugins
