Mirrors/blakeblackshear.frigate
1
0
Fork 0
mirror of https://github.com/blakeblackshear/frigate.git synced 2024-11-21 19:07:46 +01:00
Code Issues Projects Releases Wiki Activity

tweaks for recent issues

Browse Source
This commit is contained in:
Blake Blackshear 2020-10-24 08:52:40 -05:00
parent 5a081e4f00
commit 49258d6dbe
1 changed files with 20 additions and 8 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

28
README.md
View File

@ -52,6 +52,13 @@ HassOS users can install via the addon repository. Frigate requires that an MQTT
1. Start the addon container 1. Start the addon container
### Docker ### Docker
Make sure you choose the right image for your architecture:
|Arch|Image Name|
|-|-|
|amd64|blakeblackshear/frigate:stable-amd64|
|armv7|blakeblackshear/frigate:stable-armv7|
|aarch64|blakeblackshear/frigate:stable-aarch64|
It is recommended to run with docker-compose: It is recommended to run with docker-compose:
```yaml ```yaml
frigate: frigate:
@ -459,6 +466,8 @@ mask: 'poly,0,461,3,0,1919,0,1919,843,1699,492,1344,458,1346,336,973,317,869,375
<a href="docs/example-mask-poly.png"><img src="docs/example-mask-poly.png" height="300"></a> <a href="docs/example-mask-poly.png"><img src="docs/example-mask-poly.png" height="300"></a>
You can test your mask by temporarily configuring it as a [zone](#zones) and enabling`draw_zones` in your config.
[Back to top](#documentation) [Back to top](#documentation)
## Zones ## Zones
@ -666,21 +675,21 @@ Sample response:
## MQTT Topics ## MQTT Topics
These are the MQTT messages generated by Frigate. The default topic_prefix is `frigate`, but can be changed in the config file. These are the MQTT messages generated by Frigate. The default topic_prefix is `frigate`, but can be changed in the config file.
### frigate/available ### `frigate/available`
Designed to be used as an availability topic with HomeAssistant. Possible message are: Designed to be used as an availability topic with HomeAssistant. Possible message are:
"online": published when frigate is running (on startup) "online": published when frigate is running (on startup)
"offline": published right before frigate stops "offline": published right before frigate stops
### frigate/<camera_name>/<object_name> ### `frigate/<camera_name>/<object_name>`
Publishes `ON` or `OFF` and is designed to be used a as a binary sensor in HomeAssistant for whether or not that object type is detected. Publishes `ON` or `OFF` and is designed to be used a as a binary sensor in HomeAssistant for whether or not that object type is detected.
### frigate/<camera_name>/<object_name>/snapshot ### `frigate/<camera_name>/<object_name>/snapshot`
Publishes a jpeg encoded frame of the detected object type. When the object is no longer detected, the highest confidence image is published or the original image Publishes a jpeg encoded frame of the detected object type. When the object is no longer detected, the highest confidence image is published or the original image
is published again. is published again.
The height and crop of snapshots can be configured as shown in the example config. The height and crop of snapshots can be configured in the config.
### frigate/<camera_name>/events/start ### `frigate/<camera_name>/events/start`
Message published at the start of any tracked object. JSON looks as follows: Message published at the start of any tracked object. JSON looks as follows:
```json ```json
{ {
@ -716,11 +725,11 @@ Message published at the start of any tracked object. JSON looks as follows:
} }
``` ```
### frigate/<camera_name>/events/end ### `frigate/<camera_name>/events/end`
Same as `frigate/<camera_name>/events/start`, but with an `end_time` property as well. Same as `frigate/<camera_name>/events/start`, but with an `end_time` property as well.
### frigate/<zone_name>/<object_name> ### `frigate/<zone_name>/<object_name>`
Publishes `ON` or `OFF` and is designed to be used a as a binary sensor in HomeAssistant for whether or not that object type is detected in the zone. Publishes `ON` when the object enters the zone and `OFF` when the object disappears or exits the zone. Designed to be used a as a binary sensor in HomeAssistant for whether or not that object type is detected in the zone.
[Back to top](#documentation) [Back to top](#documentation)
@ -754,5 +763,8 @@ ffmpeg:
- info - info
``` ```
### "On connect called"
If you see repeated "On connect called" messages in your config, check for another instance of frigate. This happens when multiple frigate containers are trying to connect to mqtt with the same client_id.
[Back to top](#documentation) [Back to top](#documentation)