Skip to content

README.md

Latest commit

 

History

History
125 lines (103 loc) · 4.27 KB

README.md

File metadata and controls

125 lines (103 loc) · 4.27 KB

CasCap.Api.Fronius

A .NET library that integrates with a Fronius solar inverter (Symo Gen24) via its local Solar API v1, samples power-flow data every second, and fans each reading out to a configurable set of sinks for persistence, streaming, and observability.

Installation

dotnet add package CasCap.Api.Fronius

Purpose

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

FroniusMonitorBgService – Waits for the device health check to pass, then polls GetPowerFlowRealtimeData every second. Each response is wrapped in a FroniusEvent containing the five key power metrics (SOC, P_Akku, P_Grid, P_Load, P_PV) and a UTC timestamp. OpenTelemetry gauges are recorded for each metric before the event is dispatched in parallel to every registered IEventSink<FroniusEvent> implementation.

A REST API (FroniusController) exposes endpoints for real-time power flow, inverter data, meter readings, storage state, and historical line items.

Sinks

Sink Description
Console Logs every event via the .NET logger (Debug level)
Redis Persists the latest five power metrics to a Redis hash (SOC, P_Akku, P_Grid, P_Load, P_PV)
Channel Exposes events on an in-process Channel<FroniusEvent> (capacity 1,000) for MCP/AI tooling
Azure Tables Writes detailed readings and a rolling snapshot to Azure Table Storage
OpenTelemetry Emits power and percentage gauges via OpenTelemetry metrics
gRPC Streams events to connected gRPC clients (backed by a dedicated channel)

Event Flow

flowchart TD
    INVERTER["Fronius Inverter\n(LAN REST API v1)"]

    subgraph Monitor["FroniusMonitorBgService (every 1 s)"]
        HEALTH["Await connection\nhealth check"]
        FETCH["GetPowerFlowRealtimeData"]
        BUILD["Build FroniusEvent\n(SOC, P_Akku, P_Grid, P_Load, P_PV, UtcDateTime)"]
        METRICS["Record OpenTelemetry gauges"]
        DISPATCH["Fan-out to all sinks\nTask.WhenAll"]
    end

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

    CLIENT["FroniusClientService\n(powerflow, inverter, meter, storage, …)"]

    INVERTER -->|HTTP REST| CLIENT
    CLIENT --> FETCH
    HEALTH --> FETCH --> BUILD --> METRICS --> DISPATCH
    DISPATCH --> SINK_CONSOLE
    DISPATCH --> SINK_REDIS
    DISPATCH --> SINK_CHANNEL
    DISPATCH --> SINK_AZTABLES
    DISPATCH --> SINK_OTEL
    DISPATCH --> SINK_GRPC
Loading

Configuration Examples

Minimal

{
  "CasCap": {
    "FroniusConfig": {
      "BaseAddress": "http://192.168.1.248",
      "AzureTableStorageConnectionString": "https://<account>.table.core.windows.net",
      "Sinks": {
        "AvailableSinks": {
          "Console": { "Enabled": true },
          "Metrics": { "Enabled": true }
        }
      }
    }
  }
}

Fully configured

{
  "CasCap": {
    "FroniusConfig": {
      "BaseAddress": "http://192.168.1.248",
      "HealthCheckUri": "solar_api/v1/GetPowerFlowRealtimeData.fcgi",
      "HealthCheck": "Readiness",
      "PollingIntervalMs": 1000,
      "ConnectionPollingDelayMs": 1000,
      "ConnectionLogEscalationInterval": 10,
      "SocAlertThreshold": 0.95,
      "SocAlertHysteresis": 0.05,
      "SocAlertCooldownMs": 300000,
      "AzureTableStorageConnectionString": "https://<account>.table.core.windows.net",
      "HealthCheckAzureTableStorage": "None",
      "Sinks": {
        "AvailableSinks": {
          "Console": { "Enabled": true },
          "Memory": { "Enabled": true },
          "Metrics": { "Enabled": true },
          "AzureTables": { "Enabled": true },
          "Redis": {
            "Enabled": true,
            "Settings": {
              "SnapshotValues": "SOC,P_Akku,P_Grid,P_Load,P_PV"
            }
          },
          "CommsStream": { "Enabled": true },
          "SignalR": { "Enabled": true }
        }
      }
    }
  }
}

License

This project is released under The Unlicense. See the LICENSE file for details.