# pepperdash/essentials architecture

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

- Interactive diagram: https://gitdiagram.com/pepperdash/essentials
- Repository: https://github.com/pepperdash/essentials

## Overview

PepperDash Essentials is a configuration-driven Crestron control framework for standalone systems, SIMPL Windows partner applications, and hybrids. Its principal workflow is to load configuration, construct and activate devices, then expose room/device control and feedback through routing, bridges, or mobile clients. The tree and README document those product capabilities; source excerpts show selected device lifecycle, monitoring, and mobile-controller relationships. Several major subsystems are represented by their existing directories because their implementation files were not sampled.

Main entry points: [`src/PepperDash.Essentials.Core/Devices/DeviceManager.cs`](https://github.com/pepperdash/essentials/blob/main/src/PepperDash.Essentials.Core/Devices/DeviceManager.cs) (Device manager), [`src/PepperDash.Essentials.MobileControl/MobileControlSystemController.cs`](https://github.com/pepperdash/essentials/blob/main/src/PepperDash.Essentials.MobileControl/MobileControlSystemController.cs) (Mobile controller), [`src/PepperDash.Essentials.Core/Devices/EssentialsDeviceFactory.cs`](https://github.com/pepperdash/essentials/blob/main/src/PepperDash.Essentials.Core/Devices/EssentialsDeviceFactory.cs) (Device factories), [`src/PepperDash.Essentials.Core/Devices/EssentialsDevice.cs`](https://github.com/pepperdash/essentials/blob/main/src/PepperDash.Essentials.Core/Devices/EssentialsDevice.cs) (Essentials device)

## Diagram (Mermaid)

```mermaid
flowchart TD

subgraph group_configuration["Configuration"]
  node_config["Device configuration<br/>[DeviceConfig.cs]"]
  node_config_reader["Config reader<br/>[ConfigReader.cs]"]
  node_config_writer["Config writer<br/>[ConfigWriter.cs]"]
end

subgraph group_runtime["Device Runtime"]
  node_device_factory["Device factories"]
  node_device_manager["Device manager<br/>[DeviceManager.cs]"]
  node_essentials_device["Essentials device"]
  node_base_device["Core device lifecycle<br/>[Device.cs]"]
end

subgraph group_control["Control Features"]
  node_device_types["Common device types"]
  node_room["Room behaviors<br/>[Room]"]
  node_routing["Signal routing"]
  node_feedback["Device feedback<br/>[BoolFeedback.cs]"]
end

subgraph group_interfaces["Integration Interfaces"]
  node_mobile_controller["Mobile controller"]
  node_mobile_services["Mobile API services"]
  node_mobile_websocket["Mobile WebSocket<br/>[WebSocketServer]"]
  node_touchpanel["Touchpanel control"]
  node_bridges["SIMPL bridges<br/>[BridgeBase.cs]"]
end

subgraph group_platform["Platform Services"]
  node_monitoring["System monitoring"]
  node_communications["Communications<br/>[Comm and IR]"]
  node_logging["Logging<br/>[Debug.cs]"]
  node_conversion["Data conversion<br/>[Convert.cs]"]
end

node_operator(("System designer"))
node_simpl(("SIMPL Windows"))

node_operator -->|"defines system"| node_config
node_config -.->|"loads"| node_config_reader
node_config_reader -.->|"configures creation"| node_device_factory
node_device_factory -.->|"registers devices"| node_device_manager
node_device_manager -->|"tracks devices"| node_essentials_device
node_essentials_device -->|"waits for activation"| node_device_manager
node_essentials_device -->|"inherits lifecycle"| node_base_device
node_device_manager -->|"logs events"| node_logging
node_device_manager -->|"converts values"| node_conversion
node_device_manager -.->|"manages configured system"| node_room
node_device_manager -.->|"coordinates routes"| node_routing
node_device_factory -.->|"creates device types"| node_device_types
node_device_types -.->|"publishes state"| node_feedback
node_operator -.->|"uses controls"| node_mobile_controller
node_mobile_controller -->|"exposes room control"| node_room
node_mobile_controller -->|"uses services"| node_mobile_services
node_mobile_controller -->|"registers server"| node_mobile_websocket
node_mobile_controller -.->|"supports panels"| node_touchpanel
node_simpl -->|"exchanges control"| node_bridges
node_bridges -.->|"bridges runtime devices"| node_device_manager
node_monitoring -->|"updates feedback"| node_feedback
node_room -.->|"coordinates room routes"| node_routing
node_communications -.->|"communicates with devices"| node_device_types

click node_config "https://github.com/pepperdash/essentials/blob/main/src/PepperDash.Essentials.Core/Config/DeviceConfig.cs"
click node_config_reader "https://github.com/pepperdash/essentials/blob/main/src/PepperDash.Essentials.Core/Config/Essentials/ConfigReader.cs"
click node_config_writer "https://github.com/pepperdash/essentials/blob/main/src/PepperDash.Essentials.Core/Config/Essentials/ConfigWriter.cs"
click node_device_factory "https://github.com/pepperdash/essentials/blob/main/src/PepperDash.Essentials.Core/Devices/EssentialsDeviceFactory.cs"
click node_device_manager "https://github.com/pepperdash/essentials/blob/main/src/PepperDash.Essentials.Core/Devices/DeviceManager.cs"
click node_essentials_device "https://github.com/pepperdash/essentials/blob/main/src/PepperDash.Essentials.Core/Devices/EssentialsDevice.cs"
click node_base_device "https://github.com/pepperdash/essentials/blob/main/src/PepperDash.Core/Device.cs"
click node_device_types "https://github.com/pepperdash/essentials/tree/main/src/PepperDash.Essentials.Devices.Common"
click node_room "https://github.com/pepperdash/essentials/tree/main/src/PepperDash.Essentials.Core/Room"
click node_routing "https://github.com/pepperdash/essentials/blob/main/src/PepperDash.Essentials.Core/Routing/RoutingFeedbackManager.cs"
click node_feedback "https://github.com/pepperdash/essentials/blob/main/src/PepperDash.Essentials.Core/Feedbacks/BoolFeedback.cs"
click node_mobile_controller "https://github.com/pepperdash/essentials/blob/main/src/PepperDash.Essentials.MobileControl/MobileControlSystemController.cs"
click node_mobile_services "https://github.com/pepperdash/essentials/blob/main/src/PepperDash.Essentials.MobileControl/Services/MobileControlApiService.cs"
click node_mobile_websocket "https://github.com/pepperdash/essentials/tree/main/src/PepperDash.Essentials.MobileControl/WebSocketServer"
click node_touchpanel "https://github.com/pepperdash/essentials/blob/main/src/PepperDash.Essentials.MobileControl/Touchpanel/MobileControlTouchpanelController.cs"
click node_bridges "https://github.com/pepperdash/essentials/blob/main/src/PepperDash.Essentials.Core/Bridges/BridgeBase.cs"
click node_monitoring "https://github.com/pepperdash/essentials/blob/main/src/PepperDash.Essentials.Core/Monitoring/SystemMonitorController.cs"
click node_communications "https://github.com/pepperdash/essentials/tree/main/src/PepperDash.Essentials.Core/Comm%20and%20IR"
click node_logging "https://github.com/pepperdash/essentials/blob/main/src/PepperDash.Core/Logging/Debug.cs"
click node_conversion "https://github.com/pepperdash/essentials/blob/main/src/PepperDash.Core/Conversion/Convert.cs"

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_config,node_config_reader,node_config_writer toneBlue
class node_device_factory,node_device_manager,node_essentials_device,node_base_device toneAmber
class node_device_types,node_room,node_routing,node_feedback toneMint
class node_mobile_controller,node_mobile_services,node_mobile_websocket,node_touchpanel,node_bridges toneRose
class node_monitoring,node_communications,node_logging,node_conversion,node_operator,node_simpl toneIndigo
```

## Components

### Configuration

- [Device configuration](https://github.com/pepperdash/essentials/blob/main/src/PepperDash.Essentials.Core/Config/DeviceConfig.cs): `src/PepperDash.Essentials.Core/Config/DeviceConfig.cs`
- [Config reader](https://github.com/pepperdash/essentials/blob/main/src/PepperDash.Essentials.Core/Config/Essentials/ConfigReader.cs): `src/PepperDash.Essentials.Core/Config/Essentials/ConfigReader.cs`
- [Config writer](https://github.com/pepperdash/essentials/blob/main/src/PepperDash.Essentials.Core/Config/Essentials/ConfigWriter.cs): `src/PepperDash.Essentials.Core/Config/Essentials/ConfigWriter.cs`

### Device Runtime

- [Device factories](https://github.com/pepperdash/essentials/blob/main/src/PepperDash.Essentials.Core/Devices/EssentialsDeviceFactory.cs): `src/PepperDash.Essentials.Core/Devices/EssentialsDeviceFactory.cs`
- [Device manager](https://github.com/pepperdash/essentials/blob/main/src/PepperDash.Essentials.Core/Devices/DeviceManager.cs): `src/PepperDash.Essentials.Core/Devices/DeviceManager.cs`
- [Essentials device](https://github.com/pepperdash/essentials/blob/main/src/PepperDash.Essentials.Core/Devices/EssentialsDevice.cs): `src/PepperDash.Essentials.Core/Devices/EssentialsDevice.cs`
- [Core device lifecycle](https://github.com/pepperdash/essentials/blob/main/src/PepperDash.Core/Device.cs): `src/PepperDash.Core/Device.cs`

### Control Features

- [Common device types](https://github.com/pepperdash/essentials/tree/main/src/PepperDash.Essentials.Devices.Common): `src/PepperDash.Essentials.Devices.Common`
- [Room behaviors](https://github.com/pepperdash/essentials/tree/main/src/PepperDash.Essentials.Core/Room): `src/PepperDash.Essentials.Core/Room`
- [Signal routing](https://github.com/pepperdash/essentials/blob/main/src/PepperDash.Essentials.Core/Routing/RoutingFeedbackManager.cs): `src/PepperDash.Essentials.Core/Routing/RoutingFeedbackManager.cs`
- [Device feedback](https://github.com/pepperdash/essentials/blob/main/src/PepperDash.Essentials.Core/Feedbacks/BoolFeedback.cs): `src/PepperDash.Essentials.Core/Feedbacks/BoolFeedback.cs`

### Integration Interfaces

- [Mobile controller](https://github.com/pepperdash/essentials/blob/main/src/PepperDash.Essentials.MobileControl/MobileControlSystemController.cs): `src/PepperDash.Essentials.MobileControl/MobileControlSystemController.cs`
- [Mobile API services](https://github.com/pepperdash/essentials/blob/main/src/PepperDash.Essentials.MobileControl/Services/MobileControlApiService.cs): `src/PepperDash.Essentials.MobileControl/Services/MobileControlApiService.cs`
- [Mobile WebSocket](https://github.com/pepperdash/essentials/tree/main/src/PepperDash.Essentials.MobileControl/WebSocketServer): `src/PepperDash.Essentials.MobileControl/WebSocketServer`
- [Touchpanel control](https://github.com/pepperdash/essentials/blob/main/src/PepperDash.Essentials.MobileControl/Touchpanel/MobileControlTouchpanelController.cs): `src/PepperDash.Essentials.MobileControl/Touchpanel/MobileControlTouchpanelController.cs`
- [SIMPL bridges](https://github.com/pepperdash/essentials/blob/main/src/PepperDash.Essentials.Core/Bridges/BridgeBase.cs): `src/PepperDash.Essentials.Core/Bridges/BridgeBase.cs`

### Platform Services

- [System monitoring](https://github.com/pepperdash/essentials/blob/main/src/PepperDash.Essentials.Core/Monitoring/SystemMonitorController.cs): `src/PepperDash.Essentials.Core/Monitoring/SystemMonitorController.cs`
- [Communications](https://github.com/pepperdash/essentials/tree/main/src/PepperDash.Essentials.Core/Comm%20and%20IR): `src/PepperDash.Essentials.Core/Comm and IR`
- [Logging](https://github.com/pepperdash/essentials/blob/main/src/PepperDash.Core/Logging/Debug.cs): `src/PepperDash.Core/Logging/Debug.cs`
- [Data conversion](https://github.com/pepperdash/essentials/blob/main/src/PepperDash.Core/Conversion/Convert.cs): `src/PepperDash.Core/Conversion/Convert.cs`

### Other components

- **System designer**
- **SIMPL Windows**

## Connections

- System designer → Device configuration: defines system (evidence: `README.md`)
- Device configuration → Config reader: loads
- Config reader → Device factories: configures creation
- Device factories → Device manager: registers devices
- Device manager → Essentials device: tracks devices (evidence: `src/PepperDash.Essentials.Core/Devices/DeviceManager.cs`)
- Essentials device → Device manager: waits for activation (evidence: `src/PepperDash.Essentials.Core/Devices/EssentialsDevice.cs`)
- Essentials device → Core device lifecycle: inherits lifecycle (evidence: `src/PepperDash.Essentials.Core/Devices/EssentialsDevice.cs`)
- Device manager → Logging: logs events (evidence: `src/PepperDash.Essentials.Core/Devices/DeviceManager.cs`)
- Device manager → Data conversion: converts values (evidence: `src/PepperDash.Essentials.Core/Devices/DeviceManager.cs`)
- Device manager → Room behaviors: manages configured system
- Device manager → Signal routing: coordinates routes (evidence: `src/PepperDash.Essentials.Core/Routing/RoutingFeedbackManager.cs`)
- Device factories → Common device types: creates device types (evidence: `src/PepperDash.Essentials.Devices.Common/Displays/ScreenLiftController.cs`)
- Common device types → Device feedback: publishes state (evidence: `src/PepperDash.Essentials.Devices.Common/Displays/ScreenLiftController.cs`)
- System designer → Mobile controller: uses controls
- Mobile controller → Room behaviors: exposes room control (evidence: `src/PepperDash.Essentials.MobileControl/MobileControlSystemController.cs`)
- Mobile controller → Mobile API services: uses services (evidence: `src/PepperDash.Essentials.MobileControl/MobileControlSystemController.cs`)
- Mobile controller → Mobile WebSocket: registers server (evidence: `src/PepperDash.Essentials.MobileControl/MobileControlSystemController.cs`)
- Mobile controller → Touchpanel control: supports panels (evidence: `src/PepperDash.Essentials.MobileControl/Touchpanel/MobileControlTouchpanelController.cs`)
- SIMPL Windows → SIMPL bridges: exchanges control (evidence: `README.md`)
- SIMPL bridges → Device manager: bridges runtime devices
- System monitoring → Device feedback: updates feedback (evidence: `src/PepperDash.Essentials.Core/Monitoring/SystemMonitorController.cs`)
- Room behaviors → Signal routing: coordinates room routes (evidence: `src/PepperDash.Essentials.Core/Routing/RoutingFeedbackManager.cs`)
- Communications → Common device types: communicates with devices
