iobroker.frigate
Version:
187 lines (114 loc) • 6.32 kB
Markdown
# ioBroker.frigate
[](https://www.npmjs.com/package/iobroker.frigate)
[](https://www.npmjs.com/package/iobroker.frigate)
[](https://nodei.co/npm/iobroker.frigate/)
**Tests:** 
**This adapter uses Sentry libraries to automatically report exceptions and code errors to the developers.** For more details and for information how to disable the error reporting see [Sentry-Plugin Documentation](https://github.com/ioBroker/plugin-sentry#plugin-sentry)! Sentry reporting is used starting with js-controller 3.0.
## frigate adapter for ioBroker
Adapter for Frigate Tool [Frigate Video](https://frigate.video/)
## Setup
- Enter Frigate url e.g. localhost:5000 or 192.168.178.2:5000
- Enter MQTT port: 1883 from the frigate config
- Enter host or ip of iobroker sytem in the frigate config under
```
mqtt:
host: ioBrokerIP
```
After Starting Frigate and the Adapter you should see a new client conntected in the log
## Usage
### stats
General Information about the system and cameras
### remotes
`frigate.0.remote.pauseNotifications`
Pause Notification for all Cameras
### events
Last Event with before and after information
`frigate.0.events.history` History of the last X events
History event has a thumbnail of the event and url to the snapshot and clip
### camera_name
Status and settings of the camera
Change state State to change the settings of the camera
[Detailed Information about all states](https://docs.frigate.video/integrations/mqtt/)
`frigate.0.camera_name.motion`
Whether camera_name is currently detecting motion. Expected values are ON and OFF. NOTE: After motion is initially detected, ON will be set until no motion has been detected for mqtt_off_delay seconds (30 by default).
`frigate.0.camera_name.person_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 in the config.
`frigate.0.camera_name.history`
Event history of the camera
`frigate.0.camera_name.remote.notificationText` custom notification text for the camera
`frigate.0.camera_name.remote.notificationMinScore` custom notification min score for the camera
`frigate.0.camera_name.remote.pauseNotifications`pause notification for the camera
`frigate.0.camera_name.remote.ptz`send ptz commands https://docs.frigate.video/integrations/mqtt/#frigatecamera_nameptz
## Notifcations
The adapter can send snapshots and clips from events and object detection to instances like telegram, pushover and signal-cbm
You can specify multiple instance or user to send snapshots or clips
Active the notification in the settings to receive the snapshots or clips
For Event can enter a minimum score before sending. 0 = Disabled
Clips are send 5s (Instance settings) after event end.
You can enter custom notification text with placeholder `{{source}} {{type}} erkannt {{status}} {{score}} {{state}}`
## Integrate in vis
You can integrate snapshots and clips in the vis:
Snapshot:
Add a `String img src` and use as Object Id: `frigate.0.camera_name.person_snapshot`
Add a `String img src` and use as Object Id: `frigate.0.events.history.01.thumbnail`
Clips:
Add a `HTML` add as HTML:
```
<video width="100%" height="auto" src="{frigate.0.events.history.01.webclip}" autoplay muted>
</video>
```
Number of persons: frigate.0.camera.person
Event with Person: frigate.0.events.after.label = person
## Discussion and questions
[https://forum.iobroker.net/topic/64928/frigate-adapter-für-iobroker](https://forum.iobroker.net/topic/64928/frigate-adapter-für-iobroker)
## Changelog
<!--
Placeholder for the next version (at the beginning of the line):
### **WORK IN PROGRESS**
-->
### 1.3.2 (2025-05-06)
- remove path_data from v0.16
- move clip url from mp4 to m3u8
- (mcm1957) Adapter requires js-controller 5.0.19 as minimum now.
- (mcm1957) Several issues reported by adapter chacker have been fixed.
### 1.3.1 (2024-08-30)
- fixed to much states
### 1.3.0 (2024-07-29)
- fix for frigate v0.14
### 1.2.1 (2024-06-06)
- add remote to restart frigate
### 1.2.0 (2024-04-10)
- add new notifications sending
- add pauseNotifications For Time
### 1.1.0 (2024-03-11)
- fix deleting of notification files
- add notification settings
### 1.0.2 (2024-01-29)
- reduce memory usage for clip notifications
### 1.0.1 (2024-01-28)
- fix frigate v12 camera fetching
- fix pushover notifications
### 1.0.0 (2024-01-26)
- New Version with new state structure. Please check you vis and scripts. The new version doesn't need the mqtt adapter and can send directly notification to telegram.
## License
MIT License
Copyright (c) 2024-2030 TA2k <tombox2020@gmail.com>
Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:
The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.