homebridge-eufy-nvr-gateway 0.1.0 → 0.2.0

package/CHANGELOG.md

@@ -4,6 +4,29 @@ All notable changes to this project. Versions follow [Semantic Versioning](https
 This plugin is based on [Homebridge Camera FFmpeg](https://github.com/homebridge-plugins/homebridge-camera-ffmpeg)
 4.1.0; its own history is in [its changelog](https://github.com/homebridge-plugins/homebridge-camera-ffmpeg/blob/latest/CHANGELOG.md).
 
+## [0.2.0] - 2026-11-08
+
+### Changed
+
+- **Homebridge uses the gateway's stream login, not its web page login.** The stream login (the
+  one your NVR uses) now also finds and wakes the cameras, so Homebridge no longer needs or stores
+  the gateway's admin login. This needs eufy NVR Gateway 0.6.0 or later; older gateways still work
+  with the web login, which the settings page asks for only then.
+- The model shown in the Home app comes with each camera from the gateway, where the gateway
+  reports it.
+- The settings page shows the eufy NVR Gateway logo, and its support page links to this plugin and
+  the gateway.
+- The README only covers what a gateway user needs; Camera FFmpeg's documentation site is gone
+  from the repository.
+
+## [0.1.1] - 2026-11-08
+
+### Changed
+
+- Published to npm: install it from the Homebridge UI's plugin search. Every release is published
+  by the repository's workflow, with npm provenance.
+- The package no longer contains the compiled tests.
+
 ## [0.1.0] - 2026-11-08
 
 The first release: Camera FFmpeg for battery eufy cameras behind the

package/README.md

@@ -1,358 +1,156 @@
-# Homebridge eufy NVR Gateway
+# <img src="https://raw.githubusercontent.com/dbanky/homebridge-eufy-nvr-gateway/main/media/logo.png" alt="" width="48" height="48" align="absmiddle"> Homebridge eufy NVR Gateway
 
-A special version of [Homebridge Camera FFmpeg](https://github.com/homebridge-plugins/homebridge-camera-ffmpeg)
-for battery eufy cameras behind the [eufy-nvr-gateway](https://github.com/dbanky/eufy-nvr-gateway).
+[![npm](https://badgen.net/npm/v/homebridge-eufy-nvr-gateway)](https://www.npmjs.com/package/homebridge-eufy-nvr-gateway)
+
+HomeKit live view for battery-powered eufy cameras, through the
+[eufy NVR Gateway](https://github.com/dbanky/eufy-nvr-gateway). Opening a camera in the Home app
+wakes it; closing it lets the camera sleep again.
 
 > [!IMPORTANT]
-> **This plugin needs the [eufy-nvr-gateway](https://github.com/dbanky/eufy-nvr-gateway), which you
+> **This plugin needs the [eufy NVR Gateway](https://github.com/dbanky/eufy-nvr-gateway), which you
 > run separately.** The plugin doesn't talk to eufy at all: the gateway logs in to your eufy account,
-> keeps each camera's stream and wakes the cameras, and the plugin only brings its streams to HomeKit.
-> Without a running gateway, the plugin has no cameras to show.
+> keeps an always-on stream for each camera and wakes the cameras; the plugin brings those streams to
+> HomeKit. Without a running gateway, the plugin has no cameras to show.
 >
-> Set up the gateway first (it is a Docker container, e.g. on a NAS; see its
+> Set up the gateway first (a Docker container, e.g. on a NAS; see its
 > [setup in five steps](https://github.com/dbanky/eufy-nvr-gateway#setup-in-five-steps)), make sure
-> its web page shows your cameras, then install this plugin and enter the gateway's IP address on its
-> settings page.
+> its web page shows your cameras, then install this plugin.
 >
 > eufy allows one login per account at a time: if you also keep homebridge-eufy (or the eufy app on
 > another device) logged in with the gateway's account, they log each other out. Give the gateway an
 > account of its own, with the cameras shared to it
 > ([how](https://github.com/dbanky/eufy-nvr-gateway#the-eufy-account-and-its-two-factor-login)).
 
-The gateway gives every camera an always-on RTSP stream without keeping it awake: while the camera
-sleeps, the stream shows its last picture. Watching that stream does not wake the camera, so plain
-Camera FFmpeg would only ever show the sleeping picture in the Home app. This version does what
-homebridge-eufy does:
+## What it does
 
 - **Live view wakes the camera.** When the Home app opens a camera, the plugin asks the gateway to
-  wake it. The stream starts at once with the gateway's *Waking up* picture and switches to live
-  video when the camera is awake (usually a few seconds).
-- **It stays awake while you watch.** While at least one Home app viewer is open, the plugin repeats
-  the wake-up every 10 seconds, so the gateway's hold time never runs out.
-- **It sleeps when you're done.** After the last viewer leaves, the camera sleeps when the gateway's
-  hold time ends (30 s by default), or at once with `sleepWhenStreamEnds`.
-- **Snapshots never wake it.** Tiles in the Home app show the gateway's snapshot: the last picture
-  while asleep, the live picture while awake.
-
-Cameras without `gatewayCamera` work exactly as in Camera FFmpeg.
-
-## Setup page
-
-In the Homebridge UI, open the plugin's settings and enter the gateway's IP address. The page finds
-the gateway's cameras by itself; there is nothing else to type unless the gateway has logins:
-
-- **Gateway web page login**: only if the gateway's page asks for one. The page opens it when needed.
-- **Stream login**: shown only when the gateway's streams need one.
-
-For each camera the page shows its name and video source (both follow from the gateway and can't be
-changed) and fills in the branding (eufy, the model from the eufy account, the serial number, the
-gateway's version). You choose:
-
-- **Add to HomeKit**: on for every camera at the first setup; cameras the gateway gets later start off.
-- **Sound**: on when the gateway's stream for that camera has sound (`"audio": true` on the gateway).
-- **Sleep as soon as live view closes**: see `sleepWhenStreamEnds` below.
-- **Experimental – WIP → Video codec**: *Automatic* by default, which uses `copy` (no conversion,
-  almost no CPU) whenever the gateway's stream is H.264, and converts with `libx264` when it is H.265
-  or not known yet. It is picked again at every Homebridge start, so it follows the gateway once that
-  has learned a camera's format. Choosing `copy` or `libx264` fixes it.
-
-Press *Save* to store it. Cameras set up by hand in the JSON config (without `gatewayCamera`) are
-kept as they are.
-
-## Configuration
-
-What the setup page writes, for reference or for editing the JSON config by hand:
-
-```json
-{
-  "platform": "EufyNvrGateway",
-  "gateway": {
-    "url": "http://192.168.1.10:8099"
-  },
-  "cameras": [
-    { "name": "front-door", "gatewayCamera": "front-door", "videoConfig": { "audio": true } },
-    { "name": "garden", "gatewayCamera": "garden" }
-  ]
-}
-```
-
-Platform settings, under `gateway`:
-
-- `url`: _(Required for gateway cameras)_ The gateway's web page, e.g. `http://192.168.1.10:8099`.
-- `username`, `password`: The web page's login, if the gateway has one (`"web"` in its config.json).
-- `rtspPort`: The gateway's RTSP port, if not `8554`.
-- `rtspUsername`, `rtspPassword`: The streams' login, if the gateway has one (`"rtsp"` in its config.json).
-
-Camera settings:
-
-- `gatewayCamera`: The camera's `name` in the gateway's config.json. With it, `videoConfig.source`
-  can be left out: the camera streams from `rtsp://<gateway>:8554/<gatewayCamera>` over TCP.
-- `wakeOnStream`: Wake the camera for live view (default `true`).
-- `videoConfig.vcodec`: Left out, it is picked at every start from the gateway (`copy` for an H.264
-  stream, `libx264` otherwise). `copy` sends the gateway's picture at its own size and bitrate.
-- Branding (`manufacturer`, `model`, `serialNumber`, `firmwareRevision`): left out, it is filled in
-  from the gateway at startup.
-- `sleepWhenStreamEnds`: Let the camera sleep the moment the last viewer leaves, if HomeKit was what
-  woke it (default `false`). Off, it sleeps when the gateway's hold time ends; that leaves a session
-  started by motion alone, so an NVR recording the same camera keeps its recording.
-
-All other Camera FFmpeg settings work as usual. Notes for gateway cameras:
-
-- HomeKit only plays H.264, while the gateway may pass a camera's own H.265 through: such cameras
-  need `libx264`, which *Automatic* picks for them.
-- The picture changes size when a camera wakes (the sleeping picture, then the live video, which some
-  cameras start at 720p). With `libx264` the plugin fits every frame into the size HomeKit asked for,
-  with black bars where the camera's aspect ratio differs; without that, FFmpeg would keep the size
-  of the first frame for the whole stream. `copy` passes the size changes on as they are, which is
-  safe with `"transcode": true` on the gateway (one fixed size).
-- `audio: true` needs `"audio": true` for the camera on the gateway too.
-- A camera's battery pays for every live view: each one wakes it, even below the gateway's
-  `minBatteryPct`, just like the wake button on the gateway's web page.
+  wake it. The picture appears at once (the gateway's *Waking up* picture) and switches to live video
+  when the camera is awake, usually within a few seconds.
+- **It stays awake while you watch**, however long, and **sleeps when you're done**: when the
+  gateway's hold time ends (30 seconds by default), or at once with *Sleep as soon as live view
+  closes*.
+- **Tiles never wake a camera.** The pictures on the Home app's tiles come from the gateway: the last
+  picture while a camera sleeps, the live one while it is awake.
+- **Nothing to type but the gateway's address.** The settings page finds the gateway's cameras and
+  fills in the rest: names, streams, sound, video format, and the model and serial number shown in
+  the Home app.
 
 ## Installation
 
-**Before you start:** the [eufy-nvr-gateway](https://github.com/dbanky/eufy-nvr-gateway) must be
-running and reachable from the Homebridge host (its web page on port `8099`, its streams on `8554`),
-with your cameras in its `config.json`. This plugin depends on it and does not install it.
+The gateway must be running and reachable from the Homebridge host: its web page on port `8099`,
+its streams on `8554`.
 
-The plugin is not on npm. Download `homebridge-eufy-nvr-gateway-<version>.tgz` from the
-[releases](https://github.com/dbanky/homebridge-eufy-nvr-gateway/releases), or build it yourself:
+In the Homebridge UI, open *Plugins*, search for `homebridge-eufy-nvr-gateway` and install it. Or,
+in the Homebridge terminal:
 
 ```sh
-npm ci && npm run build && npm pack      # makes homebridge-eufy-nvr-gateway-<version>.tgz
-```
-
-Copy the `.tgz` to the Homebridge host (for the Homebridge Docker image: into its `/homebridge`
-folder) and install it from the Homebridge terminal:
-
-```sh
-npm install --save /homebridge/homebridge-eufy-nvr-gateway-0.1.0.tgz
-```
-
-Then restart Homebridge and add the platform `EufyNvrGateway` (the plugin's settings page in the
-Homebridge UI shows all options). It can run next to Camera FFmpeg; move a camera over by deleting it
-there and adding it here. Its accessories are published like Camera FFmpeg's: add each camera in the
-Home app with the Homebridge setup code.
-
-## Development
-
-```sh
-npm ci
-npm test          # vitest
-npm run build     # tsc into dist/
-```
-
-The gateway integration is in `src/gateway.ts` (the gateway's HTTP API and the per-camera wake keeper);
-`src/streamingDelegate.ts` calls it on stream start and stop and for snapshots, and `src/platform.ts`
-derives each gateway camera's source.
-
----
-
-The rest of this README is Camera FFmpeg's own documentation. Read `Camera-ffmpeg` there as
-`EufyNvrGateway`.
-
-# Homebridge Camera FFmpeg
-
-[![npm](https://badgen.net/npm/v/@homebridge-plugins/homebridge-camera-ffmpeg) ![npm](https://badgen.net/npm/dt/@homebridge-plugins/homebridge-camera-ffmpeg)](https://www.npmjs.com/package/@homebridge-plugins/homebridge-camera-ffmpeg) [![verified-by-homebridge](https://badgen.net/badge/homebridge/verified/purple)](https://github.com/homebridge/homebridge/wiki/Verified-Plugins) [![certified-hoobs-plugin](https://badgen.net/badge/HOOBS/certified/yellow)](https://plugins.hoobs.org/plugin/homebridge-camera-ffmpeg)
-
-[Homebridge](https://homebridge.io) Plugin Providing [FFmpeg](https://www.ffmpeg.org)-based Camera Support
-
-## Installation
-
-This plugin is supported under both [Homebridge](https://homebridge.io) and [HOOBS](https://hoobs.org/). It is highly recommended that you use either [Homebridge Config UI X](https://www.npmjs.com/package/homebridge-config-ui-x) or the HOOBS UI to install and configure this plugin.
-
-### Manual Installation
-
-1. Install this plugin using: `sudo npm install -g homebridge-camera-ffmpeg --unsafe-perm`.
-2. Edit `config.json` manually to add your cameras. See below for instructions on that.
-
-## Tested configurations
-
-Other users have been sharing configurations that work for them on our GitHub site. You may want to [check that](https://homebridge-plugins.github.io/homebridge-camera-ffmpeg/configs/) to see if anyone else has gotten your model of camera working already, or [share](https://github.com/homebridge-plugins/homebridge-camera-ffmpeg/issues/new?assignees=&labels=tested+config&template=tested_config.md) a configuration setup that works for you.
-
-## Manual Configuration
-
-### Most Important Parameters
-
-- `platform`: _(Required)_ Must always be set to `Camera-ffmpeg`.
-- `name`: _(Required)_ Set the camera name for display in the Home app.
-- `source`: _(Required)_ FFmpeg options on where to find and how to decode your camera's video stream. The most basic form is `-i` followed by your camera's URL.
-- `stillImageSource`: If your camera also provides a URL for a still image, that can be defined here with the same syntax as `source`. If not set, the plugin will grab one frame from `source`.
-
-#### Config Example
-
-```json
-{
-  "platform": "Camera-ffmpeg",
-  "cameras": [
-    {
-      "name": "Camera Name",
-      "videoConfig": {
-        "source": "-i rtsp://username:password@example.com:554",
-        "stillImageSource": "-i http://example.com/still_image.jpg",
-        "maxStreams": 2,
-        "maxWidth": 1280,
-        "maxHeight": 720,
-        "maxFPS": 30
-      }
-    }
-  ]
-}
+npm install homebridge-eufy-nvr-gateway
 ```
 
-### Optional Parameters
+Each release is also attached as a `.tgz` file on the
+[releases page](https://github.com/dbanky/homebridge-eufy-nvr-gateway/releases)
+(`npm install --save /path/to/homebridge-eufy-nvr-gateway-<version>.tgz`).
 
-- `motion`: Exposes the motion sensor for this camera. This can be triggered with [dummy switches](https://homebridge-plugins.github.io/homebridge-camera-ffmpeg/automation/switch.html), [MQTT messages](https://homebridge-plugins.github.io/homebridge-camera-ffmpeg/automation/mqtt.html), or [via HTTP](https://homebridge-plugins.github.io/homebridge-camera-ffmpeg/automation/http.html), depending on what features are enabled in the config. (Default: `false`)
-- `doorbell`: Exposes the doorbell device for this camera. This can be triggered with [dummy switches](https://homebridge-plugins.github.io/homebridge-camera-ffmpeg/automation/switch.html), [MQTT messages](https://homebridge-plugins.github.io/homebridge-camera-ffmpeg/automation/mqtt.html), or [via HTTP](https://homebridge-plugins.github.io/homebridge-camera-ffmpeg/automation/http.html), depending on what features are enabled in the config. (Default: `false`)
-- `switches`: Enables dummy switches to trigger motion and/or doorbell, if either of those are enabled. When enabled there will be an additional switch that triggers the motion or doorbell event. See the project site for [more detailed instructions](https://homebridge-plugins.github.io/homebridge-camera-ffmpeg/automation/switch.html). (Default: `false`)
-- `motionTimeout`: The number of seconds after triggering to reset the motion sensor. Set to 0 to disable resetting of motion trigger for MQTT or HTTP. (Default: `1`)
-- `motionDoorbell`: Rings the doorbell when motion is activated. This allows for motion alerts to appear on Apple TVs. (Default: `false`)
-- `manufacturer`: Set the manufacturer name for display in the Home app. (Default: `Homebridge`)
-- `model`: Set the model for display in the Home app. (Default: `Camera FFmpeg`)
-- `serialNumber`: Set the serial number for display in the Home app. (Default: `SerialNumber`)
-- `firmwareRevision`: Set the firmware revision for display in the Home app. (Default: current plugin version)
-- `unbridge`: Bridged cameras can cause slowdowns of the entire Homebridge instance. If unbridged, the camera will need to be added to HomeKit manually. (Default: `true`)
+## Setup
 
-#### Config Example with Manufacturer and Model Set
+Open the plugin's settings in the Homebridge UI and enter the gateway's IP address (its port too, if
+it isn't `8099`). The page finds the gateway's cameras at once.
 
-```json
-{
-  "platform": "Camera-ffmpeg",
-  "cameras": [
-    {
-      "name": "Camera Name",
-      "manufacturer": "ACME, Inc.",
-      "model": "ABC-123",
-      "serialNumber": "1234567890",
-      "firmwareRevision": "1.0",
-      "videoConfig": {
-        "source": "-i rtsp://username:password@example.com:554",
-        "stillImageSource": "-i http://example.com/still_image.jpg",
-        "maxStreams": 2,
-        "maxWidth": 1280,
-        "maxHeight": 720,
-        "maxFPS": 30
-      }
-    }
-  ]
-}
-```
-
-### Optional videoConfig Parameters
+**Logins.** Only if the gateway has them:
 
-- `returnAudioTarget`: _(EXPERIMENTAL - WIP)_ The FFmpeg output command for directing audio back to a two-way capable camera. This feature is still in development and a configuration that works today may not work in the future.
-- `maxStreams`: The maximum number of streams that will be allowed at once to this camera. (Default: `2`)
-- `maxWidth`: The maximum width used for video streamed to HomeKit. If set to 0, the resolution of the source is used. If not set, will use any size HomeKit requests.
-- `maxHeight`: The maximum height used for video streamed to HomeKit. If set to 0, the resolution of the source is used. If not set, will use any size HomeKit requests.
-- `maxFPS`: The maximum frame rate used for video streamed to HomeKit. If set to 0, the framerate of the source is used. If not set, will use any frame rate HomeKit requests.
-- `maxBitrate`: The maximum bitrate used for video streamed to HomeKit, in kbit/s. If not set, will use any bitrate HomeKit requests.
-- `forceMax`: If set, the settings requested by HomeKit will be overridden with any 'maximum' values defined in this config. (Default: `false`)
-- `vcodec`: Set the codec used for encoding video sent to HomeKit, must be H.264-based. You can change to a hardware accelerated video codec with this option, if one is available. (Default: `libx264`)
-- `audio`: Enables audio streaming from camera. (Default: `false`)
-- `packetSize`: If audio or video is choppy try a smaller value, should be set to a multiple of 188. (Default: `1316`)
-- `mapvideo`: Selects the stream used for video. (Default: FFmpeg [automatically selects](https://ffmpeg.org/ffmpeg.html#Automatic-stream-selection) a video stream)
-- `mapaudio`: Selects the stream used for audio. (Default: FFmpeg [automatically selects](https://ffmpeg.org/ffmpeg.html#Automatic-stream-selection) an audio stream)
-- `videoFilter`: Comma-delimited list of additional video filters for FFmpeg to run on the video. If 'none' is included, the default video filters are disabled.
-- `encoderOptions`: Options to be passed to the video encoder. (Default: `-preset ultrafast -tune zerolatency` if using libx264)
-- `debug`: Includes debugging output from the main FFmpeg process in the Homebridge log. (Default: `false`)
-- `debugReturn`: Includes debugging output from the FFmpeg used for return audio in the Homebridge log. (Default: `false`)
+- **Stream login**: the gateway's `"rtsp"` login, the one your NVR uses. The page asks for it when
+  the gateway needs a login. Homebridge plays the streams with it, and finds and wakes the cameras
+  with it.
+- **Web page login**: only for gateways before 0.6.0, which don't accept the stream login for
+  finding and waking cameras. The page asks for it only then. Updating the gateway makes it unnecessary, and the
+  page doesn't store it when the stream login is enough.
 
-#### More Complicated Example
+**For each camera** the page shows its name and stream (both follow from the gateway) and fills in
+the model and serial number. You choose:
 
-```json
-{
-  "platform": "Camera-ffmpeg",
-  "cameras": [
-    {
-      "name": "Camera Name",
-      "videoConfig": {
-        "source": "-i rtsp://myfancy_rtsp_stream",
-        "stillImageSource": "-i http://faster_still_image_grab_url/this_is_optional.jpg",
-        "maxStreams": 2,
-        "maxWidth": 1280,
-        "maxHeight": 720,
-        "maxFPS": 30,
-        "maxBitrate": 200,
-        "vcodec": "h264_omx",
-        "audio": false,
-        "packetSize": 188,
-        "hflip": true,
-        "additionalCommandline": "-x264-params intra-refresh=1:bframes=0",
-        "debug": true
-      }
-    }
-  ]
-}
-```
-
-### Camera MQTT Parameters
-
-- `motionTopic`: The MQTT topic to watch for motion alerts.
-- `motionMessage`: The message to watch for to trigger motion alerts. Will use the name of the camera if blank.
-- `motionResetTopic`: The MQTT topic to watch for motion resets.
-- `motionResetMessage`: The message to watch for to trigger motion resets. Will use the name of the camera if blank.
-- `doorbellTopic`: The MQTT topic to watch for doorbell alerts.
-- `doorbellMessage`: The message to watch for to trigger doorbell alerts. Will use the name of the camera if blank.
-
-#### Camera MQTT Example
+- **Add to HomeKit**: every camera at the first setup; cameras the gateway gets later start off.
+- **Sound**: on when the gateway's stream for that camera has sound (`"audio": true` on the gateway).
+- **Sleep as soon as live view closes**: off, the camera sleeps when the gateway's hold time ends.
+  That leaves a session the camera started for motion alone, so an NVR recording the same camera
+  keeps its recording.
+- **Experimental – WIP → Video codec**: *Automatic* passes the gateway's H.264 to HomeKit as it is
+  (`copy`, almost no CPU), and converts with `libx264` when the stream is H.265, which HomeKit can't
+  play, or when the gateway doesn't know the camera's format yet. It is decided again at every
+  Homebridge start.
+
+Press *Save* and restart Homebridge. Then add each camera in the Home app (*Add Accessory*, *More
+options…*) with the Homebridge setup code; the cameras are separate accessories.
+
+## Good to know
+
+- **Battery.** Every live view wakes the camera, even below the gateway's `minBatteryPct`, just like
+  the wake button on the gateway's web page.
+- **The first seconds of a live view** show the *Waking up* picture: a sleeping camera needs a few
+  seconds (some models longer) before it sends video.
+- **Moving from homebridge-eufy or Camera FFmpeg.** Remove the cameras there, or they appear twice in
+  the Home app. Don't run homebridge-eufy with the gateway's eufy account (see above).
+- **Too many wrong logins.** After 10 wrong logins from the Homebridge machine within 5 minutes, the
+  gateway refuses its logins for 5 minutes; the Homebridge log says so. Correct the login on the
+  settings page and wait.
+- **No sound in the Home app** with an error about `libfdk_aac` in the log: the FFmpeg that comes with
+  the plugin wasn't downloaded. Run `npm rebuild ffmpeg-for-homebridge` in the Homebridge terminal.
+- **Startup check.** At every start the log names each camera as found on the gateway, or says what
+  is wrong (address, login, or a camera name the gateway doesn't know).
+
+## Settings in config.json
+
+What the settings page writes, for reference:
 
 ```json
 {
-  "platform": "Camera-ffmpeg",
+  "platform": "EufyNvrGateway",
+  "name": "eufy NVR Gateway",
+  "gateway": {
+    "url": "http://192.168.1.10:8099",
+    "rtspUsername": "protect",
+    "rtspPassword": "choose-another-password"
+  },
   "cameras": [
     {
-      "name": "Camera Name",
-      "videoConfig": {
-        "source": "-i rtsp://myfancy_rtsp_stream"
-      },
-      "mqtt": {
-        "motionTopic": "home/camera",
-        "motionMessage": "ON",
-        "motionResetTopic": "home/camera",
-        "motionResetMessage": "OFF",
-        "doorbellTopic": "home/doobell",
-        "doorbellMessage": "ON"
-      }
+      "name": "front-door",
+      "gatewayCamera": "front-door",
+      "sleepWhenStreamEnds": false,
+      "videoConfig": { "audio": true }
     }
   ]
 }
 ```
 
-### Automation Parameters
-
-- `mqtt`: Defines the hostname or IP of the MQTT broker to connect to for MQTT-based automation. If not set, MQTT support is not started. See the project site for [more information on using MQTT](https://homebridge-plugins.github.io/homebridge-camera-ffmpeg/automation/mqtt.html).
-- `portmqtt`: The port of the MQTT broker. (Default: `1883`)
-- `tlsmqtt`: Use TLS to connect to the MQTT broker. (Default: `false`)
-- `usermqtt`: The username used to connect to your MQTT broker. If not set, no authentication is used.
-- `passmqtt`: The password used to connect to your MQTT broker. If not set, no authentication is used.
-- `porthttp`: The port to listen on for HTTP-based automation. If not set, HTTP support is not started. See the project site for [more information on using HTTP](https://homebridge-plugins.github.io/homebridge-camera-ffmpeg/automation/http.html).
-- `localhttp`: Only allow HTTP calls from localhost. Useful if using helper plugins that translate to HTTP. (Default: `false`)
+| Setting | Meaning |
+|---|---|
+| `gateway.url` | The gateway's web page |
+| `gateway.rtspUsername`, `gateway.rtspPassword` | The gateway's stream login (`"rtsp"` in its config.json), if it has one |
+| `gateway.rtspPort` | The gateway's RTSP port, if not `8554` |
+| `gateway.username`, `gateway.password` | The gateway's web page login: only for gateways before 0.6.0, which refuse the stream login for finding and waking cameras |
+| `cameras[].gatewayCamera` | The camera's `name` in the gateway's config.json |
+| `cameras[].name` | The name in the Home app (the settings page uses the gateway's name) |
+| `cameras[].wakeOnStream` | `false`: live view doesn't wake the camera (default `true`) |
+| `cameras[].sleepWhenStreamEnds` | `true`: the camera sleeps as soon as the last viewer leaves, if live view woke it (default `false`) |
+| `cameras[].videoConfig.audio` | Sound in the Home app |
+| `cameras[].videoConfig.vcodec` | `copy` or `libx264`; left out, it is chosen at every start |
+
+The model, serial number and firmware shown in the Home app (`manufacturer`, `model`,
+`serialNumber`, `firmwareRevision`) are filled in from the gateway when left out.
 
-#### Automation Example
+## Development
 
-```json
-{
-  "platform": "Camera-ffmpeg",
-  "mqtt": "127.0.0.1",
-  "porthttp": "8080",
-  "cameras": []
-}
+```sh
+npm ci
+npm test         # vitest
+npm run build    # TypeScript into dist/
 ```
 
-### Rarely Needed Parameters
-
-- `videoProcessor`: Defines which video processor is used to decode and encode videos, must take the same parameters as FFmpeg. Common uses would be `avconv` or the path to a custom-compiled version of FFmpeg. If not set, will use the included version of FFmpeg, or the version of FFmpeg installed on the system if no included version is available.
-
-#### Rare Option Example
-
-```json
-{
-  "platform": "Camera-ffmpeg",
-  "videoProcessor": "/usr/bin/ffmpeg",
-  "cameras": []
-}
-```
+The gateway integration is in `src/gateway.ts` (its API and keeping a camera awake) and
+`src/discovery.ts` (what follows from the gateway); the settings page is `src/homebridge-ui/`.
+Publishing a GitHub release publishes the package to npm (`.github/workflows/publish.yml`).
 
-## Credit
+## License
 
-Homebridge Camera FFmpeg is based on code originally written by [Khaos Tian](https://twitter.com/khaost).
+Apache License 2.0, see [LICENSE](LICENSE). Based on
+[Homebridge Camera FFmpeg](https://github.com/homebridge-plugins/homebridge-camera-ffmpeg) by Khaos
+Tian, Sunoo and the Homebridge team; the changes are listed in the [CHANGELOG](CHANGELOG.md).

package/config.schema.json

@@ -4,8 +4,8 @@
   "singular": true,
   "customUi": true,
   "customUiPath": "./dist/homebridge-ui",
-  "headerDisplay": "FFmpeg cameras for HomeKit, with wake-on-view for battery eufy cameras behind the [eufy-nvr-gateway](https://github.com/dbanky/eufy-nvr-gateway).",
-  "footerDisplay": "Based on Homebridge Camera FFmpeg. Shared configurations for ordinary cameras: [the project site](https://homebridge-plugins.github.io/homebridge-camera-ffmpeg/configs/).",
+  "headerDisplay": "HomeKit live view for battery eufy cameras behind the [eufy NVR Gateway](https://github.com/dbanky/eufy-nvr-gateway), which must run separately.",
+  "footerDisplay": "Setup and settings: [README](https://github.com/dbanky/homebridge-eufy-nvr-gateway#readme).",
   "schema": {
     "name": {
       "title": "Name",
@@ -23,13 +23,13 @@
           "placeholder": "http://192.168.1.10:8099",
           "description": "The gateway's web page. Needed for cameras that have a Gateway Camera Name."
         },
-        "username": {
-          "title": "Web Login: Username",
+        "rtspUsername": {
+          "title": "Stream Login: Username",
           "type": "string",
-          "description": "Only if the gateway's web page has a login (\"web\" in its config.json)."
+          "description": "The gateway's stream login (\"rtsp\" in its config.json), the one your NVR uses. Plays the streams, and finds and wakes the cameras."
         },
-        "password": {
-          "title": "Web Login: Password",
+        "rtspPassword": {
+          "title": "Stream Login: Password",
           "type": "string",
           "x-schema-form": {
             "type": "password"
@@ -41,13 +41,13 @@
           "placeholder": 8554,
           "description": "The gateway's RTSP port (\"ports.rtsp\" in its config.json)."
         },
-        "rtspUsername": {
-          "title": "Stream Login: Username",
+        "username": {
+          "title": "Web Page Login: Username (gateways before 0.6.0)",
           "type": "string",
-          "description": "Only if the gateway's streams have a login (\"rtsp\" in its config.json)."
+          "description": "Only for gateways before 0.6.0, which don't accept the stream login for finding and waking cameras: the login of the gateway's web page (\"web\" in its config.json)."
         },
-        "rtspPassword": {
-          "title": "Stream Login: Password",
+        "password": {
+          "title": "Web Page Login: Password (gateways before 0.6.0)",
           "type": "string",
           "x-schema-form": {
             "type": "password"
@@ -371,11 +371,11 @@
       "expanded": true,
       "items": [
         "gateway.url",
-        "gateway.username",
-        "gateway.password",
-        "gateway.rtspPort",
         "gateway.rtspUsername",
-        "gateway.rtspPassword"
+        "gateway.rtspPassword",
+        "gateway.rtspPort",
+        "gateway.username",
+        "gateway.password"
       ]
     },
     {

package/dist/discovery.d.ts

@@ -4,6 +4,7 @@ import { GatewayClient } from './gateway.js';
 export declare const DEFAULT_WEB_PORT = 8099;
 export interface GatewayCameraStatus {
     name: string;
+    model?: string | null;
     serial: string;
     state: string;
     battery?: number | null;
@@ -25,6 +26,7 @@ export interface GatewayStatus {
     gateway?: {
         version?: string;
         login?: boolean;
+        streamLoginForApi?: boolean;
     };
     cameras?: GatewayCameraStatus[];
 }
@@ -61,12 +63,13 @@ export interface Discovery {
     version: string;
     rtspPort: number;
     rtspLogin: boolean;
+    apiLogin: 'stream' | 'web' | 'none';
     cameras: DiscoveredCamera[];
 }
 export declare function normalizeGatewayAddress(input: string): string;
 export declare function firmwareFrom(version?: string): string;
-export declare function brandingFor(camera: Pick<GatewayCameraStatus, 'serial'>, devices: GatewayDevice[], version?: string): Branding;
+export declare function brandingFor(camera: Pick<GatewayCameraStatus, 'serial' | 'model'>, devices: GatewayDevice[], version?: string): Branding;
 export declare function codecFor(camera: Pick<GatewayCameraStatus, 'video'>): CodecChoice;
-export declare function discover(gateway: GatewayConfig, client?: Pick<GatewayClient, 'status' | 'devices'>): Promise<Discovery>;
+export declare function discover(gateway: GatewayConfig, client?: Pick<GatewayClient, 'status' | 'devices' | 'usedLogin'>): Promise<Discovery>;
 export declare function cameraConfigFor(camera: DiscoveredCamera, previous?: CameraConfig): CameraConfig;
 //# sourceMappingURL=discovery.d.ts.map

package/dist/discovery.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"discovery.d.ts","sourceRoot":"","sources":["../src/discovery.ts"],"names":[],"mappings":"AAIA,OAAO,KAAK,EAAE,aAAa,EAAE,MAAM,cAAc,CAAA;AACjD,OAAO,KAAK,EAAE,YAAY,EAAE,MAAM,eAAe,CAAA;AAEjD,OAAO,EAAqB,aAAa,EAAE,MAAM,cAAc,CAAA;AAE/D,eAAO,MAAM,gBAAgB,OAAO,CAAA;AAGpC,MAAM,WAAW,mBAAmB;IAClC,IAAI,EAAE,MAAM,CAAA;IACZ,MAAM,EAAE,MAAM,CAAA;IACd,KAAK,EAAE,MAAM,CAAA;IACb,OAAO,CAAC,EAAE,MAAM,GAAG,IAAI,CAAA;IACvB,UAAU,CAAC,EAAE,MAAM,CAAA;IACnB,KAAK,CAAC,EAAE,MAAM,GAAG,IAAI,CAAA;IACrB,KAAK,CAAC,EAAE;QAAE,KAAK,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;QAAC,WAAW,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;QAAC,SAAS,CAAC,EAAE,OAAO,CAAC;QAAC,SAAS,CAAC,EAAE,OAAO,CAAC;QAAC,IAAI,CAAC,EAAE,MAAM,CAAA;KAAE,CAAA;CACxH;AAED,MAAM,WAAW,aAAa;IAC5B,QAAQ,CAAC,EAAE,MAAM,CAAA;IACjB,IAAI,CAAC,EAAE;QAAE,KAAK,CAAC,EAAE,OAAO,CAAA;KAAE,CAAA;IAC1B,OAAO,CAAC,EAAE;QAAE,OAAO,CAAC,EAAE,MAAM,CAAC;QAAC,KAAK,CAAC,EAAE,OAAO,CAAA;KAAE,CAAA;IAC/C,OAAO,CAAC,EAAE,mBAAmB,EAAE,CAAA;CAChC;AAGD,MAAM,WAAW,aAAa;IAC5B,MAAM,EAAE,MAAM,CAAA;IACd,IAAI,CAAC,EAAE,MAAM,CAAA;IACb,KAAK,CAAC,EAAE,MAAM,CAAA;IACd,SAAS,CAAC,EAAE,MAAM,CAAA;CACnB;AAED,MAAM,WAAW,QAAQ;IACvB,YAAY,EAAE,MAAM,CAAA;IACpB,KAAK,EAAE,MAAM,CAAA;IACb,YAAY,EAAE,MAAM,CAAA;IACpB,gBAAgB,EAAE,MAAM,CAAA;CACzB;AAED,MAAM,WAAW,WAAW;IAC1B,MAAM,EAAE,MAAM,GAAG,SAAS,CAAA;IAC1B,IAAI,EAAE,MAAM,CAAA;CACb;AAED,MAAM,WAAW,gBAAgB;IAC/B,IAAI,EAAE,MAAM,CAAA;IACZ,MAAM,EAAE,MAAM,CAAA;IACd,KAAK,EAAE,MAAM,CAAA;IACb,OAAO,EAAE,MAAM,GAAG,IAAI,CAAA;IACtB,UAAU,EAAE,MAAM,CAAA;IAClB,KAAK,EAAE,OAAO,CAAA;IACd,KAAK,EAAE,MAAM,CAAA;IACb,QAAQ,EAAE,QAAQ,CAAA;IAClB,KAAK,EAAE,WAAW,CAAA;IAClB,MAAM,EAAE,MAAM,CAAA;CACf;AAED,MAAM,WAAW,SAAS;IACxB,GAAG,EAAE,MAAM,CAAA;IACX,OAAO,EAAE,MAAM,CAAA;IACf,QAAQ,EAAE,MAAM,CAAA;IAChB,SAAS,EAAE,OAAO,CAAA;IAClB,OAAO,EAAE,gBAAgB,EAAE,CAAA;CAC5B;AAGD,wBAAgB,uBAAuB,CAAC,KAAK,EAAE,MAAM,GAAG,MAAM,CAiB7D;AAGD,wBAAgB,YAAY,CAAC,OAAO,CAAC,EAAE,MAAM,GAAG,MAAM,CAGrD;AAED,wBAAgB,WAAW,CAAC,MAAM,EAAE,IAAI,CAAC,mBAAmB,EAAE,QAAQ,CAAC,EAAE,OAAO,EAAE,aAAa,EAAE,EAAE,OAAO,CAAC,EAAE,MAAM,GAAG,QAAQ,CAQ7H;AAID,wBAAgB,QAAQ,CAAC,MAAM,EAAE,IAAI,CAAC,mBAAmB,EAAE,OAAO,CAAC,GAAG,WAAW,CAkBhF;AAID,wBAAsB,QAAQ,CAAC,OAAO,EAAE,aAAa,EAAE,MAAM,CAAC,EAAE,IAAI,CAAC,aAAa,EAAE,QAAQ,GAAG,SAAS,CAAC,GAAG,OAAO,CAAC,SAAS,CAAC,CA0B7H;AAMD,wBAAgB,eAAe,CAAC,MAAM,EAAE,gBAAgB,EAAE,QAAQ,CAAC,EAAE,YAAY,GAAG,YAAY,CAc/F"}
+{"version":3,"file":"discovery.d.ts","sourceRoot":"","sources":["../src/discovery.ts"],"names":[],"mappings":"AAIA,OAAO,KAAK,EAAE,aAAa,EAAE,MAAM,cAAc,CAAA;AACjD,OAAO,KAAK,EAAE,YAAY,EAAE,MAAM,eAAe,CAAA;AAEjD,OAAO,EAAqB,aAAa,EAAE,MAAM,cAAc,CAAA;AAE/D,eAAO,MAAM,gBAAgB,OAAO,CAAA;AAGpC,MAAM,WAAW,mBAAmB;IAClC,IAAI,EAAE,MAAM,CAAA;IACZ,KAAK,CAAC,EAAE,MAAM,GAAG,IAAI,CAAA;IACrB,MAAM,EAAE,MAAM,CAAA;IACd,KAAK,EAAE,MAAM,CAAA;IACb,OAAO,CAAC,EAAE,MAAM,GAAG,IAAI,CAAA;IACvB,UAAU,CAAC,EAAE,MAAM,CAAA;IACnB,KAAK,CAAC,EAAE,MAAM,GAAG,IAAI,CAAA;IACrB,KAAK,CAAC,EAAE;QAAE,KAAK,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;QAAC,WAAW,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;QAAC,SAAS,CAAC,EAAE,OAAO,CAAC;QAAC,SAAS,CAAC,EAAE,OAAO,CAAC;QAAC,IAAI,CAAC,EAAE,MAAM,CAAA;KAAE,CAAA;CACxH;AAED,MAAM,WAAW,aAAa;IAC5B,QAAQ,CAAC,EAAE,MAAM,CAAA;IACjB,IAAI,CAAC,EAAE;QAAE,KAAK,CAAC,EAAE,OAAO,CAAA;KAAE,CAAA;IAC1B,OAAO,CAAC,EAAE;QAAE,OAAO,CAAC,EAAE,MAAM,CAAC;QAAC,KAAK,CAAC,EAAE,OAAO,CAAC;QAAC,iBAAiB,CAAC,EAAE,OAAO,CAAA;KAAE,CAAA;IAC5E,OAAO,CAAC,EAAE,mBAAmB,EAAE,CAAA;CAChC;AAGD,MAAM,WAAW,aAAa;IAC5B,MAAM,EAAE,MAAM,CAAA;IACd,IAAI,CAAC,EAAE,MAAM,CAAA;IACb,KAAK,CAAC,EAAE,MAAM,CAAA;IACd,SAAS,CAAC,EAAE,MAAM,CAAA;CACnB;AAED,MAAM,WAAW,QAAQ;IACvB,YAAY,EAAE,MAAM,CAAA;IACpB,KAAK,EAAE,MAAM,CAAA;IACb,YAAY,EAAE,MAAM,CAAA;IACpB,gBAAgB,EAAE,MAAM,CAAA;CACzB;AAED,MAAM,WAAW,WAAW;IAC1B,MAAM,EAAE,MAAM,GAAG,SAAS,CAAA;IAC1B,IAAI,EAAE,MAAM,CAAA;CACb;AAED,MAAM,WAAW,gBAAgB;IAC/B,IAAI,EAAE,MAAM,CAAA;IACZ,MAAM,EAAE,MAAM,CAAA;IACd,KAAK,EAAE,MAAM,CAAA;IACb,OAAO,EAAE,MAAM,GAAG,IAAI,CAAA;IACtB,UAAU,EAAE,MAAM,CAAA;IAClB,KAAK,EAAE,OAAO,CAAA;IACd,KAAK,EAAE,MAAM,CAAA;IACb,QAAQ,EAAE,QAAQ,CAAA;IAClB,KAAK,EAAE,WAAW,CAAA;IAClB,MAAM,EAAE,MAAM,CAAA;CACf;AAED,MAAM,WAAW,SAAS;IACxB,GAAG,EAAE,MAAM,CAAA;IACX,OAAO,EAAE,MAAM,CAAA;IACf,QAAQ,EAAE,MAAM,CAAA;IAChB,SAAS,EAAE,OAAO,CAAA;IAClB,QAAQ,EAAE,QAAQ,GAAG,KAAK,GAAG,MAAM,CAAA;IACnC,OAAO,EAAE,gBAAgB,EAAE,CAAA;CAC5B;AAGD,wBAAgB,uBAAuB,CAAC,KAAK,EAAE,MAAM,GAAG,MAAM,CAiB7D;AAGD,wBAAgB,YAAY,CAAC,OAAO,CAAC,EAAE,MAAM,GAAG,MAAM,CAGrD;AAGD,wBAAgB,WAAW,CAAC,MAAM,EAAE,IAAI,CAAC,mBAAmB,EAAE,QAAQ,GAAG,OAAO,CAAC,EAAE,OAAO,EAAE,aAAa,EAAE,EAAE,OAAO,CAAC,EAAE,MAAM,GAAG,QAAQ,CAQvI;AAID,wBAAgB,QAAQ,CAAC,MAAM,EAAE,IAAI,CAAC,mBAAmB,EAAE,OAAO,CAAC,GAAG,WAAW,CAkBhF;AAID,wBAAsB,QAAQ,CAAC,OAAO,EAAE,aAAa,EAAE,MAAM,CAAC,EAAE,IAAI,CAAC,aAAa,EAAE,QAAQ,GAAG,SAAS,GAAG,WAAW,CAAC,GAAG,OAAO,CAAC,SAAS,CAAC,CA8B3I;AAMD,wBAAgB,eAAe,CAAC,MAAM,EAAE,gBAAgB,EAAE,QAAQ,CAAC,EAAE,YAAY,GAAG,YAAY,CAc/F"}