@apocaliss92/nodelink-js 0.6.4 → 0.6.6

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/README.md CHANGED
@@ -102,6 +102,32 @@ For single-owner consumers that already manage their own bridge (e.g. a custom r
102
102
 
103
103
  ---
104
104
 
105
+ ## Always-On Stream for Battery Cameras
106
+
107
+ Battery cameras sleep between events, breaking continuous consumers like Frigate. Both `createRfc4571TcpServer` and `BaichuanRtspServer` accept an `alwaysOn` option that keeps the stream alive: the real feed is served during motion windows; while the camera sleeps the last keyframe is repeated at a low rate, optionally decorated with a dimmed placeholder overlay.
108
+
109
+ ```typescript
110
+ const server = await createRfc4571TcpServer({
111
+ api,
112
+ profile: "sub",
113
+ channel: 0,
114
+ // ...auth/host...
115
+ alwaysOn: {
116
+ enabled: true,
117
+ triggers: ["motion", "people", "doorbell"], // events that open a live window
118
+ windowMs: 15000, // live window duration in ms
119
+ idleFps: 1, // placeholder repeat rate while sleeping
120
+ placeholder: { enabled: true, text: "Sleeping", opacity: 0.5 },
121
+ },
122
+ });
123
+ ```
124
+
125
+ The decorated placeholder requires **ffmpeg** on PATH and the `jimp` package. Without them the library falls back to repeating the raw last keyframe — the stream stays uninterrupted either way. Works for battery cameras both standalone and attached to an NVR / Home Hub.
126
+
127
+ See [documentation/streaming.md — Always-On Stream for Battery Cameras](./documentation/streaming.md#always-on-stream-for-battery-cameras) for the full option reference.
128
+
129
+ ---
130
+
105
131
  ## Contributing: Share Your Camera Fixtures
106
132
 
107
133
  Help improve device support by sharing the API responses from your camera model. The diagnostics dump captures all capability and configuration data (credentials, IPs, and serial numbers are **automatically sanitized**).