👁 Image
CasCap.Api.DoorBird 0.10.22

CasCap.Api.DoorBird

A .NET library that integrates with a DoorBird IP door station via its local LAN API, captures door events (doorbell, motion, RFID), and fans them out to a configurable set of sinks for storage and streaming.

Installation

dotnet add package CasCap.Api.DoorBird

Purpose

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

DoorBirdMonitorBgService – Acquires a distributed lock, waits for the device health check to pass, then polls the DoorBird LAN API every 60 seconds. Each door event (doorbell press, motion detection, RFID scan) is captured as a DoorBirdEvent containing the event type, timestamp, and optionally an associated JPEG image snapshot. The event is then dispatched in parallel to every registered IEventSink<DoorBirdEvent> implementation.

A REST API (DoorBirdController) exposes real-time photo, MJPEG video stream, relay trigger, and light-on endpoints, as well as event callbacks for push notifications from the device.

Blob upload is handled by BlobProcessorBgService in the project, which reads from the internal BlobStatics.UploadQueue channel and uploads each image blob to Azure Blob Storage via IDoorBirdAzBlobStorageService.

Sinks

Event Flow

flowchart TD
 DEVICE["DoorBird Device\n(LAN REST API)"]

 subgraph Monitor["DoorBirdMonitorBgService (every 60 s)"]
 LOCK["Acquire distributed lock\n(RedLock)"]
 HEALTH["Await connection\nhealth check"]
 POLL["Poll device API"]
 BUILD["Build DoorBirdEvent\n(EventId, EventType, Timestamp, JPEG bytes)"]
 DISPATCH["Fan-out to all sinks\nTask.WhenAll"]
 end

 SINK_CONSOLE["Console Sink\n(logger)"]
 SINK_AZBLOB["Azure Blob Sink\n(enqueue to UploadQueue)"]

 UPLOAD_QUEUE["BlobStatics.UploadQueue\n(in-process channel)"]

 subgraph BlobProcessor["BlobProcessorBgService (Sinks)"]
 UPLOAD["Upload JPEG to\nAzure Blob Storage"]
 end

 AZURE_BLOB["Azure Blob Storage"]

 CLIENT["DoorBirdClientService\n(getSession, getImage, lightOn, triggerRelay, …)"]

 DEVICE -->|HTTP REST| CLIENT
 CLIENT --> POLL
 LOCK --> HEALTH --> POLL --> BUILD --> DISPATCH
 DISPATCH --> SINK_CONSOLE
 DISPATCH --> SINK_AZBLOB
 SINK_AZBLOB --> UPLOAD_QUEUE
 UPLOAD_QUEUE --> UPLOAD --> AZURE_BLOB

Configuration Examples

Minimal

{
 "CasCap": {
 "DoorBirdConfig": {
 "BaseAddress": "http://192.168.1.248",
 "Username": "<device-username>",
 "Password": "<device-password>",
 "DoorControllerID": "<controller-id>",
 "DoorControllerRelayID": "<relay-id>",
 "AzureBlobStorageConnectionString": "https://<account>.blob.core.windows.net",
 "AzureBlobStorageContainerName": "doorbird",
 "AzureTableStorageConnectionString": "https://<account>.table.core.windows.net",
 "Sinks": {
 "AvailableSinks": {
 "Console": { "Enabled": true },
 "AzBlob": { "Enabled": true }
 }
 }
 }
 }
}

Fully configured

{
 "CasCap": {
 "DoorBirdConfig": {
 "IsEnabled": true,
 "BaseAddress": "http://192.168.1.248",
 "Username": "<device-username>",
 "Password": "<device-password>",
 "DoorControllerID": "<controller-id>",
 "DoorControllerRelayID": "<relay-id>",
 "HealthCheckUri": "bha-api/info.cgi",
 "HealthCheck": "Readiness",
 "PollingIntervalMs": 60000,
 "ConnectionPollingDelayMs": 1000,
 "ConnectionLogEscalationInterval": 10,
 "AzureBlobStorageConnectionString": "https://<account>.blob.core.windows.net",
 "AzureBlobStorageContainerName": "doorbird",
 "HealthCheckAzureBlobStorage": "None",
 "AzureTableStorageConnectionString": "https://<account>.table.core.windows.net",
 "HealthCheckAzureTableStorage": "None",
 "Sinks": {
 "AvailableSinks": {
 "Console": { "Enabled": true },
 "Memory": { "Enabled": true },
 "Metrics": { "Enabled": true },
 "AzureTables": { "Enabled": true },
 "AzBlob": { "Enabled": true },
 "Redis": {
 "Enabled": true,
 "Settings": {
 "SnapshotValues": "doorbell,motionsensor,rfid"
 }
 },
 "SignalR": { "Enabled": true }
 }
 }
 }
 }
}

License

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