Skip to content

Commit

Permalink
Adding README
Browse files Browse the repository at this point in the history
  • Loading branch information
kopiro committed Aug 27, 2024
1 parent 65c352d commit 22dc99a
Showing 1 changed file with 7 additions and 3 deletions.
10 changes: 7 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -28,14 +28,17 @@ An example Home automation could be:
- If you care about your privacy, disable *Eyes* to switch on privacy mode
- If you want the camera always on, but no notifications, just disable *Alarm* and *Notifications*

### Motion detection
### Motion sensor

The motion detection is built on top of the ONVIF protocol and it is enabled by default.
The motion detection sensor is built on top of the ONVIF protocol and it is enabled by default.

Therefore you can set up automations and Homekit can send you notification in the Home app when motion is detected.

Make sure you activate "Activity Notifications" in the "Status and Notifications" tab in the accessory.

> [!NOTE]
> Some people may have issues resulting the plugin crashing at startup when this option is enabled. If you see an error like `Error: read ECONNRESET at TCP.onStreamRead` try to disable the motion sensor by setting `disableMotionSensorAccessory` to `true`
## Installation

You can install it via Homebridge UI or manually using:
Expand All @@ -52,7 +55,8 @@ It is highly recommended that you use either Homebridge Config UI X or the HOOBS

The plugin should take care of installing the `ffmpeg` automatically.

If you're getting errors like `FFmpeg exited with code: 1 and signal: null (Error)`, please follow the instructions here on how to install [ffmpeg-for-homebridge](https://github.com/homebridge/ffmpeg-for-homebridge) binaries manually.
> [!IMPORTANT]
> If you're getting errors like `FFmpeg exited with code: 1 and signal: null (Error)`, please follow the instructions here on how to install [ffmpeg-for-homebridge](https://github.com/homebridge/ffmpeg-for-homebridge) binaries manually.
### Adding the unbridged accessory to Home

Expand Down

0 comments on commit 22dc99a

Please sign in to comment.