CasCap.Api.Buderus
0.10.18
Prefix Reserved
dotnet add package CasCap.Api.Buderus --version 0.10.18
NuGet\Install-Package CasCap.Api.Buderus -Version 0.10.18
This command is intended to be used within the Package Manager Console in Visual Studio, as it uses the NuGet module's version of Install-Package.
<PackageReference Include="CasCap.Api.Buderus" Version="0.10.18" />
For projects that support PackageReference, copy this XML node into the project file to reference the package.
<PackageVersion Include="CasCap.Api.Buderus" Version="0.10.18" />
<PackageReference Include="CasCap.Api.Buderus" />
For projects that support Central Package Management (CPM), copy this XML node into the solution Directory.Packages.props file to version the package.
paket add CasCap.Api.Buderus --version 0.10.18
The NuGet Team does not provide support for this client. Please contact its maintainers for support.
#r "nuget: CasCap.Api.Buderus, 0.10.18"
#r directive can be used in F# Interactive and Polyglot Notebooks. Copy this into the interactive tool or source code of the script to reference the package.
#:package CasCap.Api.Buderus@0.10.18
#:package directive can be used in C# file-based apps starting in .NET 10 preview 4. Copy this into a .cs file before any lines of code to reference the package.
#addin nuget:?package=CasCap.Api.Buderus&version=0.10.18
#tool nuget:?package=CasCap.Api.Buderus&version=0.10.18
The NuGet Team does not provide support for this client. Please contact its maintainers for support.
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
| Sink | Description |
|---|---|
| Console | Logs every event via the .NET logger (Debug level) |
| Redis | Persists the latest value for each datapoint ID to a Redis hash |
| Channel | Exposes events on an in-process Channel<BuderusEvent> (capacity 1,000) for MCP/AI tooling |
| Azure Tables | Writes detailed readings and a rolling snapshot to Azure Table Storage |
| OpenTelemetry | Emits temperature gauges via OpenTelemetry metrics |
| gRPC | Streams events to connected gRPC clients (backed by a dedicated channel) |
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 The Unlicense. See the LICENSE file for details.
| Product | Versions Compatible and additional computed target framework versions. |
|---|---|
| .NET | net8.0 is compatible. net8.0-android was computed. net8.0-browser was computed. net8.0-ios was computed. net8.0-maccatalyst was computed. net8.0-macos was computed. net8.0-tvos was computed. net8.0-windows was computed. net9.0 was computed. net9.0-android was computed. net9.0-browser was computed. net9.0-ios was computed. net9.0-maccatalyst was computed. net9.0-macos was computed. net9.0-tvos was computed. net9.0-windows was computed. net10.0 is compatible. net10.0-android was computed. net10.0-browser was computed. net10.0-ios was computed. net10.0-maccatalyst was computed. net10.0-macos was computed. net10.0-tvos was computed. net10.0-windows was computed. |
Compatible target framework(s)
Included target framework(s) (in package)
Learn more about Target Frameworks and .NET Standard.
-
net10.0
- Asp.Versioning.Mvc (>= 10.0.0)
- CasCap.Common.Configuration (>= 4.11.3)
- CasCap.Common.Extensions (>= 4.11.3)
- CasCap.Common.Extensions.Diagnostics.HealthChecks (>= 4.11.3)
- CasCap.Common.Logging (>= 4.11.3)
- CasCap.Common.Net (>= 4.11.3)
- Microsoft.AspNetCore.Mvc.Core (>= 2.3.10)
- Microsoft.Extensions.Diagnostics.HealthChecks (>= 10.0.8)
- Microsoft.Extensions.Http (>= 10.0.8)
- PeterPuff.BuderusKm200Reader (>= 1.1.0)
-
net8.0
- Asp.Versioning.Mvc (>= 8.1.1)
- CasCap.Common.Configuration (>= 4.11.3)
- CasCap.Common.Extensions (>= 4.11.3)
- CasCap.Common.Extensions.Diagnostics.HealthChecks (>= 4.11.3)
- CasCap.Common.Logging (>= 4.11.3)
- CasCap.Common.Net (>= 4.11.3)
- Microsoft.AspNetCore.Mvc.Core (>= 2.3.10)
- Microsoft.Extensions.Diagnostics.HealthChecks (>= 10.0.8)
- Microsoft.Extensions.Http (>= 10.0.8)
- PeterPuff.BuderusKm200Reader (>= 1.1.0)
NuGet packages (1)
Showing the top 1 NuGet packages that depend on CasCap.Api.Buderus:
| Package | Downloads |
|---|---|
|
CasCap.Api.Buderus.Sinks
Pluggable event sink implementations (Redis, Azure Tables) for the CasCap.Api.Buderus heating integration library. |
GitHub repositories
This package is not used by any popular GitHub repositories.