👁 Image
CasCap.Api.Buderus 0.10.22

CasCap.Api.Buderus

A .NET library that integrates with a Buderus KM200 heat-pump controller via its encrypted HTTPS local API, polls temperature datapoints every 60 seconds, and fans each reading out to a configurable set of sinks for persistence, streaming, and observability.

Installation

dotnet add package CasCap.Api.Buderus

Purpose

The library is built around one background service that forms the core pipeline:

BuderusKm200MonitorBgService – Waits for the device health check to pass, then fetches the full datapoint tree recursively from the device (caching the result locally for subsequent startups). The list is filtered to only the datapoints that carry a temperature reading in °C (excluding /application, /gateway, and most of /system except the outside-temperature path /system/.../t1). For each qualifying datapoint the service calls GetDataPoint (with a 500 ms pause between calls), wraps the response in a BuderusEvent, and dispatches it in parallel to every registered IEventSink<BuderusEvent> implementation.

A REST API (BuderusController) exposes endpoints for listing all current datapoint values, querying events by datapoint ID, and retrieving the latest snapshot.

Sinks

Event Flow

flowchart TD
 KM200["Buderus KM200\n(HTTPS, encrypted LAN API)"]

 subgraph Monitor["BuderusKm200MonitorBgService (every 60 s)"]
 HEALTH["Await connection\nhealth check"]
 LOAD["Load datapoint list\n(fetch from device & cache)"]
 FILTER["Filter to temperature\ndatapoints in °C"]
 LOOP["For each datapoint\n(500 ms between calls)"]
 BUILD["Build BuderusEvent\n(Id, Value, Type, UtcDt)"]
 DISPATCH["Fan-out to all sinks\nTask.WhenAll"]
 end

 SINK_CONSOLE["Console Sink\n(logger)"]
 SINK_REDIS["Redis Sink\n(latest value per datapoint)"]
 SINK_CHANNEL["Channel Sink\n(in-process, capacity 1,000)"]
 SINK_AZTABLES["Azure Tables Sink\n(readings + snapshot)"]
 SINK_OTEL["OpenTelemetry Sink\n(temperature gauges)"]
 SINK_GRPC["gRPC Sink\n(streaming, dedicated channel)"]

 CLIENT["BuderusKm200ClientService\n(encrypted GET/POST, recursive datapoint discovery)"]

 KM200 -->|encrypted HTTPS| CLIENT
 CLIENT --> LOAD
 HEALTH --> LOAD --> FILTER --> LOOP
 LOOP -->|GetDataPoint| CLIENT
 LOOP --> BUILD --> DISPATCH
 DISPATCH --> SINK_CONSOLE
 DISPATCH --> SINK_REDIS
 DISPATCH --> SINK_CHANNEL
 DISPATCH --> SINK_AZTABLES
 DISPATCH --> SINK_OTEL
 DISPATCH --> SINK_GRPC

Configuration Examples

Minimal

{
 "CasCap": {
 "BuderusConfig": {
 "BaseAddress": "http://192.168.1.248",
 "GatewayPassword": "<gateway-password>",
 "PrivatePassword": "<private-password>",
 "AzureTableStorageConnectionString": "https://<account>.table.core.windows.net",
 "Sinks": {
 "AvailableSinks": {
 "Console": { "Enabled": true },
 "Metrics": { "Enabled": true }
 }
 }
 }
 }
}

Fully configured

{
 "CasCap": {
 "BuderusConfig": {
 "BaseAddress": "http://192.168.1.248",
 "Port": 80,
 "HealthCheckUri": "system",
 "HealthCheck": "Readiness",
 "GatewayPassword": "<gateway-password>",
 "PrivatePassword": "<private-password>",
 "PollingIntervalMs": 60000,
 "DatapointDelayMs": 500,
 "ConnectionPollingDelayMs": 1000,
 "ConnectionLogEscalationInterval": 10,
 "AzureTableStorageConnectionString": "https://<account>.table.core.windows.net",
 "HealthCheckAzureTableStorage": "None",
 "DatapointMappings": {
 "/dhwCircuits/dhw1/actualTemp": {
 "ColumnName": "Dhw1ActualTemp",
 "MetricName": "haus.hvac.temperature",
 "MetricUnit": "Cel",
 "MetricDescription": "DHW circuit 1 actual temperature"
 },
 "/system/sensors/outdoorTemperatures/t1": {
 "ColumnName": "OutdoorTemperature",
 "MetricName": "haus.hvac.temperature",
 "MetricUnit": "Cel",
 "MetricDescription": "Outdoor temperature"
 }
 },
 "Sinks": {
 "AvailableSinks": {
 "Console": { "Enabled": true },
 "Memory": { "Enabled": true },
 "Metrics": { "Enabled": true },
 "AzureTables": { "Enabled": true },
 "Redis": {
 "Enabled": true,
 "Settings": {
 "SnapshotValues": "Dhw1ActualTemp,OutdoorTemperature"
 }
 },
 "CommsStream": { "Enabled": true },
 "SignalR": { "Enabled": true }
 }
 }
 }
 }
}

License

This project is released under . See the file for details.