administrator/frigate
1
0
Fork 0
mirror of https://github.com/blakeblackshear/frigate.git synced 2026-07-28 06:39:01 +03:00
Code Issues Actions 1 Packages Projects Releases Wiki Activity

update Home Assistant brand identity references

Browse Source
This commit is contained in:
Jason Hunter
2021-05-19 06:48:50 -05:00
committed by Blake Blackshear
parent c52782aa3f
commit e89697fab0
9 changed files with 69 additions and 67 deletions
Download Patch File Download Diff File Expand all files Collapse all files
docs/docs/usage/api.md
+7 -7
View File
@@ -55,7 +55,7 @@ Example parameters:
### `/api/stats`
Contains some granular debug info that can be used for sensors in HomeAssistant.
Contains some granular debug info that can be used for sensors in Home Assistant.
Sample response:
@@ -125,26 +125,26 @@ Sample response:
"total": 1000,
"used": 700,
"free": 300,
"mnt_type": "ext4",
"mnt_type": "ext4"
},
"/media/frigate/recordings": {
"total": 1000,
"used": 700,
"free": 300,
"mnt_type": "ext4",
"mnt_type": "ext4"
},
"/tmp/cache": {
"total": 256,
"used": 100,
"free": 156,
"mnt_type": "tmpfs",
"mnt_type": "tmpfs"
},
"/dev/shm": {
"total": 256,
"used": 100,
"free": 156,
"mnt_type": "tmpfs",
},
"mnt_type": "tmpfs"
}
}
}
}
@@ -176,7 +176,7 @@ Events from the database. Accepts the following query string parameters:
### `/api/events/summary`
Returns summary data for events in the database. Used by the HomeAssistant integration.
Returns summary data for events in the database. Used by the Home Assistant integration.
### `/api/events/<id>`
docs/docs/usage/home-assistant.md
+9 -8
View File
@@ -4,7 +4,7 @@ title: Integration with Home Assistant
sidebar_label: Home Assistant
---
The best way to integrate with HomeAssistant is to use the [official integration](https://github.com/blakeblackshear/frigate-hass-integration). When configuring the integration, you will be asked for the `Host` of your frigate instance. This value should be the url you use to access Frigate in the browser and will look like `http://<host>:5000/`. If you are using HassOS with the addon, the host should be `http://ccab4aaf-frigate:5000` (or `http://ccab4aaf-frigate-beta:5000` if your are using the beta version of the addon). HomeAssistant needs access to port 5000 (api) and 1935 (rtmp) for all features. The integration will setup the following entities within HomeAssistant:
The best way to integrate with Home Assistant is to use the [official integration](https://github.com/blakeblackshear/frigate-hass-integration). When configuring the integration, you will be asked for the `Host` of your frigate instance. This value should be the url you use to access Frigate in the browser and will look like `http://<host>:5000/`. If you are using HassOS with the addon, the host should be `http://ccab4aaf-frigate:5000` (or `http://ccab4aaf-frigate-beta:5000` if your are using the beta version of the addon). Home Assistant needs access to port 5000 (api) and 1935 (rtmp) for all features. The integration will setup the following entities within Home Assistant:
## Sensors:
@@ -30,17 +30,19 @@ The best way to integrate with HomeAssistant is to use the [official integration
Frigate publishes event information in the form of a change feed via MQTT. This allows lots of customization for notifications to meet your needs. Event changes are published with `before` and `after` information as shown [here](#frigateevents).
Note that some people may not want to expose frigate to the web, so you can leverage the HA API that frigate custom_integration ties into (which is exposed to the web, and thus can be used for mobile notifications etc):
To load an image taken by frigate from HomeAssistants API see below:
```
To load an image taken by frigate from Home Assistants API see below:
```
https://HA_URL/api/frigate/notifications/<event-id>/thumbnail.jpg
```
To load a video clip taken by frigate from HomeAssistants API :
```
To load a video clip taken by frigate from Home Assistants API :
```
https://HA_URL/api/frigate/notifications/<event-id>/<camera>/clip.mp4
```
Here is a simple example of a notification automation of events which will update the existing notification for each change. This means the image you see in the notification will update as frigate finds a "better" image.
Here is a simple example of a notification automation of events which will update the existing notification for each change. This means the image you see in the notification will update as frigate finds a "better" image.
```yaml
automation:
@@ -57,7 +59,6 @@ automation:
tag: '{{trigger.payload_json["after"]["id"]}}'
```
```yaml
automation:
- alias: When a person enters a zone named yard
@@ -106,7 +107,7 @@ automation:
action:
- service: notify.mobile_app_pixel_3
data_template:
message: 'High confidence dog detection.'
message: "High confidence dog detection."
data:
image: "https://url.com/api/frigate/notifications/{{trigger.payload_json['after']['id']}}/thumbnail.jpg"
tag: "{{trigger.payload_json['after']['id']}}"
docs/docs/usage/mqtt.md
+3 -3
View File
@@ -7,17 +7,17 @@ These are the MQTT messages generated by Frigate. The default topic_prefix is `f
### `frigate/available`
Designed to be used as an availability topic with HomeAssistant. Possible message are:
Designed to be used as an availability topic with Home Assistant. Possible message are:
"online": published when frigate is running (on startup)
"offline": published right before frigate stops
### `frigate/<camera_name>/<object_name>`
Publishes the count of objects for the camera for use as a sensor in HomeAssistant.
Publishes the count of objects for the camera for use as a sensor in Home Assistant.
### `frigate/<zone_name>/<object_name>`
Publishes the count of objects for the zone for use as a sensor in HomeAssistant.
Publishes the count of objects for the zone for use as a sensor in Home Assistant.
### `frigate/<camera_name>/<object_name>/snapshot`