Home Assistant Integration
The best way to integrate with Home Assistant is to use the official integration.
Installation
Preparation
The Frigate integration requires the mqtt
integration to be installed and
manually configured first.
See the MQTT integration documentation for more details.
In addition, MQTT must be enabled in your Frigate configuration file and Frigate must be connected to the same MQTT server as Home Assistant for many of the entities created by the integration to function.
Integration installation
Available via HACS as a default repository. To install:
- Use HACS to install the integration:
Home Assistant > HACS > Integrations > "Explore & Add Integrations" > Frigate
- Restart Home Assistant.
- Then add/configure the integration:
Home Assistant > Settings > Devices & Services > Add Integration > Frigate
Note: You will also need media_source enabled in your Home Assistant configuration for the Media Browser to appear.
(Optional) Lovelace Card Installation
To install the optional companion Lovelace card, please see the separate installation instructions for that card.
Configuration
When configuring the integration, you will be asked for the URL
of your Frigate instance which is the URL you use to access Frigate in the browser. This may look like http://<host>:5000/
. If you are using HassOS with the addon, the URL should be one of the following depending on which addon version you are using. Note that if you are using the Proxy Addon, you do NOT point the integration at the proxy URL. Just enter the URL used to access Frigate directly from your network.
Addon Version | URL |
---|---|
Frigate NVR | http://ccab4aaf-frigate:5000 |
Frigate NVR (Full Access) | http://ccab4aaf-frigate-fa:5000 |
Frigate NVR Beta | http://ccab4aaf-frigate-beta:5000 |
Frigate NVR Beta (Full Access) | http://ccab4aaf-frigate-fa-beta:5000 |
Options
Home Assistant > Configuration > Integrations > Frigate > Options
Option | Description |
---|---|
RTSP URL Template | A jinja2 template that is used to override the standard RTSP stream URL (e.g. for use with reverse proxies). This option is only shown to users who have advanced mode enabled. See RTSP streams below. |
Entities Provided
Platform | Description |
---|---|
camera | Live camera stream (requires RTSP), camera for image of the last detected object. |
sensor | States to monitor Frigate performance, object counts for all zones and cameras. |
switch | Switch entities to toggle detection, recordings and snapshots. |
binary_sensor | A "motion" binary sensor entity per camera/zone/object. |