Skip to content

Commit

Permalink
More readme additions
Browse files Browse the repository at this point in the history
  • Loading branch information
Kevin authored and Kevin committed Oct 17, 2019
1 parent c5816ec commit 4f81bb3
Showing 1 changed file with 13 additions and 8 deletions.
21 changes: 13 additions & 8 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# Unifi-Protect-Camera-Motion

This Homebridge plugin extends the standard FFMPEG Homebridge plugin and provides your cameras and motion sensors for use in Homekit.
This Homebridge plugin extends the standard [FFmpeg Homebridge plugin](https://github.com/KhaosT/homebridge-camera-ffmpeg#readme) and provides your cameras and motion sensors for use in Homekit.

This plugin will enumerate all the cameras in your protect account and provide both a camera and a motion sensor in Homekit for each camera in protect.
Motion events will be triggered either by the motion events from protect itself (when the score is sufficient) or will be processed with Tensorflow for smarter analysis.
Expand Down Expand Up @@ -55,11 +55,11 @@ Config fields:
- `password`: This field is required and contains the password that is used to login in the web ui
- `motion_interval`: This field is required and contains the interval used to check for motion, a good default is 5000(ms)
- `motion_score`: This field is required and contains the minimum score a motion event has to have to be processed, a good default is 50 (%)
- `enhanced_motion`: This field is required and enables or disables the enhanced motion detection with tensorflow, value should be true or false
- `enhanced_classes`: this field is required and contains an array of string describing the classes of objects to dispatch motion events for, can be empty when the field above is set to false!
- `enhanced_motion`: This field is required and enables or disables the enhanced motion & object detection detection with tensorflow, value should be true or false
- `enhanced_classes`: this field is required and contains an array of string describing the classes of objects to dispatch motion events for, can be an empty array when `enhanced_motion` is set to false!
- `videoConfig`: This object is required and contains the general settings for each camera
- This is the regular videoConfig you would use for the FFMPEG plugin, however the fields `source` and `stillImageSource` should be omitted as these will be generated by the plugin itself!
- See the [FFMPEG readme](homebridge-camera-ffmpeg.md) for more information.
- This is the regular videoConfig you would use for the [FFmmpeg plugin](https://github.com/KhaosT/homebridge-camera-ffmpeg#readme), however the fields `source` and `stillImageSource` should be omitted as these will be generated by the plugin itself!
- See the [FFmpeg readme](homebridge-camera-ffmpeg.md) for more information.
- Make sure that your unifi camera has anonymous snapshots enabled and that at least one RTSP stream is enabled
- To enable anonymous snapshots: <br/>
![Anonymous snapshot](resources/images/anonymous_snapshot.jpg?raw=true "CloudKey Gen2 Plus")
Expand All @@ -85,11 +85,16 @@ Config fields:

### For installation on the Raspberry Pi:

- TODO
- Can be ran on any Raspberry Pi, however when making use of the enhanced motion/object detection feature you should at least use a Raspberry Pi 3 or newer!
- Make sure that you set the `motion_interval` field to a multiple of 2 seconds per camera, so 5 cameras would mean an interval of at least 10 seconds!
This is to make sure you do not overload the Raspberry Pi! On the Latest Pi 4 the timings can be lower, experiment with this to find the best timings!
- Make sure you have FFmpeg installed, preferably compiled with OMX support
- Follow [these](https://github.com/legotheboss/YouTube-files/wiki/(RPi)-Compile-FFmpeg-with-the-OpenMAX-H.264-GPU-acceleration) instructions to compile FFmpeg with the correct options
- It is possible to use FFmpeg with the OpenMax driver (OMX) but performance will be lower!

### Tested with:

- Ubiquiti UniFi CloudKey Gen2 Plus - Cloud key with unifi protect functionality
<br/>![CloudKey Gen2 Plus](resources/images/cloudkey-gen2plus.jpg?raw=true "CloudKey Gen2 Plus")
<br/><br/>![CloudKey Gen2 Plus](resources/images/cloudkey-gen2plus.jpg?raw=true "CloudKey Gen2 Plus")
- 2x Ubiquiti UniFi Video UVC-G3-AF - PoE Camera
<br/>![Camera UVC-G3-AF](resources/images/camera.jpeg?raw=true "Camera UVC-G3-AF")
<br/><br/>![Camera UVC-G3-AF](resources/images/camera.jpeg?raw=true "Camera UVC-G3-AF")

0 comments on commit 4f81bb3

Please sign in to comment.