# hn/bsh-home-appliances architecture

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

- Interactive diagram: https://gitdiagram.com/hn/bsh-home-appliances
- Repository: https://github.com/hn/bsh-home-appliances

## Overview

This repository combines an ESPHome integration that parses B/S/H/ D-Bus messages into sensor entities with Open-DBus2, an ESP32 D-Bus-2 framework and appliance-diagnostic firmware. The principal firmware workflow starts in `main.cpp`: it registers protocol nodes with a manager, initializes the UART bus, and processes bus traffic; the Huda node provides a diagnostic CLI for querying and interacting with participants. Other node implementations cover monitoring, LEDs, demos, appliance interfaces, and an optional MQTT gateway. Some node implementations were not excerpted, so their internal links are omitted.

Main entry points: [`open-dbus2/src/main.cpp`](https://github.com/hn/bsh-home-appliances/blob/master/open-dbus2/src/main.cpp) (Firmware Entry), [`components/bshdbus/bshdbus.cpp`](https://github.com/hn/bsh-home-appliances/blob/master/components/bshdbus/bshdbus.cpp) (Frame Parser), [`open-dbus2/src/DBus2Manager.cpp`](https://github.com/hn/bsh-home-appliances/blob/master/open-dbus2/src/DBus2Manager.cpp) (Bus Manager), [`open-dbus2/src/FlexConsole.cpp`](https://github.com/hn/bsh-home-appliances/blob/master/open-dbus2/src/FlexConsole.cpp) (Flex Console)

## Diagram (Mermaid)

```mermaid
flowchart TD

subgraph group_integration["ESPHome Integration"]
  node_bsh_parser["Frame Parser<br/>[bshdbus.cpp]"]
  node_binary_sensor["Binary Sensors"]
  node_numeric_sensor["Numeric Sensors<br/>[bshdbus_sensor.cpp]"]
  node_text_sensor["Text Sensors"]
end

subgraph group_protocol["D-Bus Runtime"]
  node_app_entry["Firmware Entry<br/>[main.cpp]"]
  node_bus_manager["Bus Manager<br/>[DBus2Manager.cpp]"]
  node_node_base["Node Framework<br/>[DBus2Node.h]"]
  node_subsystem_base["Subsystem Framework<br/>[DBus2Subsystem.h]"]
  node_frame_format["Frame Format<br/>[DBus2Frame.h]"]
end

subgraph group_nodes["Protocol Nodes"]
  node_huda["HUDA Diagnostics<br/>[Huda.cpp]"]
  node_monitor["Bus Monitor<br/>[Monitor.cpp]"]
  node_led_status["LED Status<br/>[LedStatus.cpp]"]
  node_ping_demo["Ping Demo<br/>[PingDemo.cpp]"]
  node_pong_demo["Pong Demo<br/>[PongDemo.cpp]"]
  node_dishwasher["Dishwasher Node<br/>[Dishwasher39C3.cpp]"]
  node_dishwasher_ui["Dishwasher UI"]
  node_unbalance["Unbalance Demo<br/>[UnbalanceDemo.cpp]"]
  node_mqtt_gateway["MQTT Gateway<br/>[MqttGateway.cpp]"]
end

subgraph group_console["Console and Diagnostics"]
  node_flex_console["Flex Console<br/>[FlexConsole.cpp]"]
  node_console_page["Web Serial Page<br/>[FlexConsolePage.h]"]
  node_logging["Logging<br/>[DBus2Log.h]"]
end

node_esphome_user(("ESPHome User"))
node_appliance_bus(("Appliance Bus"))

node_esphome_user -.->|"configures"| node_bsh_parser
node_bsh_parser -->|"dispatches messages"| node_binary_sensor
node_bsh_parser -.->|"dispatches messages"| node_numeric_sensor
node_bsh_parser -.->|"dispatches messages"| node_text_sensor
node_appliance_bus -.->|"supplies frames"| node_bsh_parser
node_app_entry -->|"registers nodes"| node_bus_manager
node_app_entry -->|"registers"| node_huda
node_app_entry -->|"registers"| node_monitor
node_app_entry -->|"registers"| node_led_status
node_app_entry -->|"registers"| node_ping_demo
node_app_entry -->|"registers"| node_pong_demo
node_app_entry -->|"starts"| node_flex_console
node_app_entry -.->|"optional registration"| node_dishwasher
node_app_entry -.->|"optional registration"| node_dishwasher_ui
node_app_entry -.->|"optional registration"| node_unbalance
node_app_entry -.->|"optional registration"| node_mqtt_gateway
node_bus_manager -->|"runs node lifecycle"| node_node_base
node_node_base -->|"delegates lifecycle"| node_subsystem_base
node_subsystem_base -->|"uses frames"| node_frame_format
node_huda -->|"sends commands"| node_bus_manager
node_bus_manager -.->|"reads and writes"| node_appliance_bus
node_huda -.->|"reads user input"| node_flex_console
node_logging -->|"prints logs"| node_flex_console
node_flex_console -.->|"serves page"| node_console_page

click node_bsh_parser "https://github.com/hn/bsh-home-appliances/blob/master/components/bshdbus/bshdbus.cpp"
click node_binary_sensor "https://github.com/hn/bsh-home-appliances/blob/master/components/bshdbus/binary_sensor/bshdbus_binary_sensor.cpp"
click node_numeric_sensor "https://github.com/hn/bsh-home-appliances/blob/master/components/bshdbus/sensor/bshdbus_sensor.cpp"
click node_text_sensor "https://github.com/hn/bsh-home-appliances/blob/master/components/bshdbus/text_sensor/bshdbus_text_sensor.cpp"
click node_app_entry "https://github.com/hn/bsh-home-appliances/blob/master/open-dbus2/src/main.cpp"
click node_bus_manager "https://github.com/hn/bsh-home-appliances/blob/master/open-dbus2/src/DBus2Manager.cpp"
click node_node_base "https://github.com/hn/bsh-home-appliances/blob/master/open-dbus2/include/DBus2Node.h"
click node_subsystem_base "https://github.com/hn/bsh-home-appliances/blob/master/open-dbus2/include/DBus2Subsystem.h"
click node_frame_format "https://github.com/hn/bsh-home-appliances/blob/master/open-dbus2/include/DBus2Frame.h"
click node_huda "https://github.com/hn/bsh-home-appliances/blob/master/open-dbus2/src/nodes/Huda.cpp"
click node_monitor "https://github.com/hn/bsh-home-appliances/blob/master/open-dbus2/src/nodes/Monitor.cpp"
click node_led_status "https://github.com/hn/bsh-home-appliances/blob/master/open-dbus2/src/nodes/LedStatus.cpp"
click node_ping_demo "https://github.com/hn/bsh-home-appliances/blob/master/open-dbus2/src/nodes/PingDemo.cpp"
click node_pong_demo "https://github.com/hn/bsh-home-appliances/blob/master/open-dbus2/src/nodes/PongDemo.cpp"
click node_dishwasher "https://github.com/hn/bsh-home-appliances/blob/master/open-dbus2/src/nodes/Dishwasher39C3.cpp"
click node_dishwasher_ui "https://github.com/hn/bsh-home-appliances/blob/master/open-dbus2/src/nodes/DishwasherUIPSimple.cpp"
click node_unbalance "https://github.com/hn/bsh-home-appliances/blob/master/open-dbus2/src/nodes/UnbalanceDemo.cpp"
click node_mqtt_gateway "https://github.com/hn/bsh-home-appliances/blob/master/open-dbus2/src/nodes/MqttGateway.cpp"
click node_flex_console "https://github.com/hn/bsh-home-appliances/blob/master/open-dbus2/src/FlexConsole.cpp"
click node_console_page "https://github.com/hn/bsh-home-appliances/blob/master/open-dbus2/include/FlexConsolePage.h"
click node_logging "https://github.com/hn/bsh-home-appliances/blob/master/open-dbus2/include/DBus2Log.h"

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_bsh_parser,node_binary_sensor,node_numeric_sensor,node_text_sensor,node_esphome_user toneBlue
class node_app_entry,node_bus_manager,node_node_base,node_subsystem_base,node_frame_format toneAmber
class node_huda,node_monitor,node_led_status,node_ping_demo,node_pong_demo,node_dishwasher,node_dishwasher_ui,node_unbalance,node_mqtt_gateway toneMint
class node_flex_console,node_console_page,node_logging toneRose
class node_appliance_bus toneIndigo
```

## Components

### ESPHome Integration

- [Frame Parser](https://github.com/hn/bsh-home-appliances/blob/master/components/bshdbus/bshdbus.cpp): `components/bshdbus/bshdbus.cpp`
- [Binary Sensors](https://github.com/hn/bsh-home-appliances/blob/master/components/bshdbus/binary_sensor/bshdbus_binary_sensor.cpp): `components/bshdbus/binary_sensor/bshdbus_binary_sensor.cpp`
- [Numeric Sensors](https://github.com/hn/bsh-home-appliances/blob/master/components/bshdbus/sensor/bshdbus_sensor.cpp): `components/bshdbus/sensor/bshdbus_sensor.cpp`
- [Text Sensors](https://github.com/hn/bsh-home-appliances/blob/master/components/bshdbus/text_sensor/bshdbus_text_sensor.cpp): `components/bshdbus/text_sensor/bshdbus_text_sensor.cpp`

### D-Bus Runtime

- [Firmware Entry](https://github.com/hn/bsh-home-appliances/blob/master/open-dbus2/src/main.cpp): `open-dbus2/src/main.cpp`
- [Bus Manager](https://github.com/hn/bsh-home-appliances/blob/master/open-dbus2/src/DBus2Manager.cpp): `open-dbus2/src/DBus2Manager.cpp`
- [Node Framework](https://github.com/hn/bsh-home-appliances/blob/master/open-dbus2/include/DBus2Node.h): `open-dbus2/include/DBus2Node.h`
- [Subsystem Framework](https://github.com/hn/bsh-home-appliances/blob/master/open-dbus2/include/DBus2Subsystem.h): `open-dbus2/include/DBus2Subsystem.h`
- [Frame Format](https://github.com/hn/bsh-home-appliances/blob/master/open-dbus2/include/DBus2Frame.h): `open-dbus2/include/DBus2Frame.h`

### Protocol Nodes

- [HUDA Diagnostics](https://github.com/hn/bsh-home-appliances/blob/master/open-dbus2/src/nodes/Huda.cpp): `open-dbus2/src/nodes/Huda.cpp`
- [Bus Monitor](https://github.com/hn/bsh-home-appliances/blob/master/open-dbus2/src/nodes/Monitor.cpp): `open-dbus2/src/nodes/Monitor.cpp`
- [LED Status](https://github.com/hn/bsh-home-appliances/blob/master/open-dbus2/src/nodes/LedStatus.cpp): `open-dbus2/src/nodes/LedStatus.cpp`
- [Ping Demo](https://github.com/hn/bsh-home-appliances/blob/master/open-dbus2/src/nodes/PingDemo.cpp): `open-dbus2/src/nodes/PingDemo.cpp`
- [Pong Demo](https://github.com/hn/bsh-home-appliances/blob/master/open-dbus2/src/nodes/PongDemo.cpp): `open-dbus2/src/nodes/PongDemo.cpp`
- [Dishwasher Node](https://github.com/hn/bsh-home-appliances/blob/master/open-dbus2/src/nodes/Dishwasher39C3.cpp): `open-dbus2/src/nodes/Dishwasher39C3.cpp`
- [Dishwasher UI](https://github.com/hn/bsh-home-appliances/blob/master/open-dbus2/src/nodes/DishwasherUIPSimple.cpp): `open-dbus2/src/nodes/DishwasherUIPSimple.cpp`
- [Unbalance Demo](https://github.com/hn/bsh-home-appliances/blob/master/open-dbus2/src/nodes/UnbalanceDemo.cpp): `open-dbus2/src/nodes/UnbalanceDemo.cpp`
- [MQTT Gateway](https://github.com/hn/bsh-home-appliances/blob/master/open-dbus2/src/nodes/MqttGateway.cpp): `open-dbus2/src/nodes/MqttGateway.cpp`

### Console and Diagnostics

- [Flex Console](https://github.com/hn/bsh-home-appliances/blob/master/open-dbus2/src/FlexConsole.cpp): `open-dbus2/src/FlexConsole.cpp`
- [Web Serial Page](https://github.com/hn/bsh-home-appliances/blob/master/open-dbus2/include/FlexConsolePage.h): `open-dbus2/include/FlexConsolePage.h`
- [Logging](https://github.com/hn/bsh-home-appliances/blob/master/open-dbus2/include/DBus2Log.h): `open-dbus2/include/DBus2Log.h`

### Other components

- **ESPHome User**
- **Appliance Bus**

## Connections

- ESPHome User → Frame Parser: configures
- Frame Parser → Binary Sensors: dispatches messages (evidence: `components/bshdbus/bshdbus.cpp`)
- Frame Parser → Numeric Sensors: dispatches messages
- Frame Parser → Text Sensors: dispatches messages
- Appliance Bus → Frame Parser: supplies frames
- Firmware Entry → Bus Manager: registers nodes (evidence: `open-dbus2/src/main.cpp`)
- Firmware Entry → HUDA Diagnostics: registers (evidence: `open-dbus2/src/main.cpp`)
- Firmware Entry → Bus Monitor: registers (evidence: `open-dbus2/src/main.cpp`)
- Firmware Entry → LED Status: registers (evidence: `open-dbus2/src/main.cpp`)
- Firmware Entry → Ping Demo: registers (evidence: `open-dbus2/src/main.cpp`)
- Firmware Entry → Pong Demo: registers (evidence: `open-dbus2/src/main.cpp`)
- Firmware Entry → Flex Console: starts (evidence: `open-dbus2/src/main.cpp`)
- Firmware Entry → Dishwasher Node: optional registration (evidence: `open-dbus2/src/main.cpp`)
- Firmware Entry → Dishwasher UI: optional registration (evidence: `open-dbus2/src/main.cpp`)
- Firmware Entry → Unbalance Demo: optional registration (evidence: `open-dbus2/src/main.cpp`)
- Firmware Entry → MQTT Gateway: optional registration (evidence: `open-dbus2/src/main.cpp`)
- Bus Manager → Node Framework: runs node lifecycle (evidence: `open-dbus2/src/DBus2Manager.cpp`)
- Node Framework → Subsystem Framework: delegates lifecycle (evidence: `open-dbus2/include/DBus2Node.h`)
- Subsystem Framework → Frame Format: uses frames (evidence: `open-dbus2/include/DBus2Subsystem.h`)
- HUDA Diagnostics → Bus Manager: sends commands (evidence: `open-dbus2/src/nodes/Huda.cpp`)
- Bus Manager → Appliance Bus: reads and writes
- HUDA Diagnostics → Flex Console: reads user input
- Logging → Flex Console: prints logs (evidence: `open-dbus2/include/DBus2Log.h`)
- Flex Console → Web Serial Page: serves page
