diff --git a/README.md b/README.md index 363969699..9a9b438f0 100644 --- a/README.md +++ b/README.md @@ -52,6 +52,13 @@ HassOS users can install via the addon repository. Frigate requires that an MQTT 1. Start the addon container ### 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: ```yaml 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 +You can test your mask by temporarily configuring it as a [zone](#zones) and enabling`draw_zones` in your config. + [Back to top](#documentation) ## Zones @@ -666,21 +675,21 @@ Sample response: ## MQTT Topics 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: "online": published when frigate is running (on startup) "offline": published right before frigate stops -### frigate// +### `frigate//` 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///snapshot +### `frigate///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 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//events/start +### `frigate//events/start` Message published at the start of any tracked object. JSON looks as follows: ```json { @@ -716,11 +725,11 @@ Message published at the start of any tracked object. JSON looks as follows: } ``` -### frigate//events/end +### `frigate//events/end` Same as `frigate//events/start`, but with an `end_time` property as well. -### frigate// -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. +### `frigate//` +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) @@ -754,5 +763,8 @@ ffmpeg: - 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)