OpenHAB Frigate NVR binding [5.0.0;6.0.0)

Add-on Marketplace Bundles
, ,
1

logo

This is a comprehensive binding for the Frigate NVR system (https://docs.frigate.video/). It allows access to all configured cameras, and realtime event information from the cameras can be used in rules. It tracks Frigate server status and can alert if the Frigate server goes offline.The binding supports:

  • multiple Frigate server instances
  • tracking and notification of Frigate server status
  • autodiscovery of your cameras as listed in the Frigate configuration
  • comprehensive camera event notification on a per-camera basis
  • ability to change individual camera settings (such as turning recording and object detection on/off, enabling ‘improve contrast’ etc) via suitable channels.
  • availability of JPEG snapshots (with boundary boxes) of last-detected object to OpenHAB as a channel.
  • statistics information on a per-camera basis (fps etc).
  • an API forwarder, allowing a local UI to use the Frigate server’s HTTP API via a local endpoint on the OpenHAB server.
  • a streaming mechanism, allowing video for the ‘birdseye’ view and individual camera feeds to be viewed on the OpenHAB API.

Please note this binding requires a configured MQTT broker to which your Frigate instance must be able to send messages. The Frigate binding ‘sits’ on top of the MQTT bridge. To use it, please create the server and camera ‘Things’ from under the MQTT bridge binding, rather than directly from the Frigate binding itself. Full documentation is on Github (see Documentation link below)

Changelog

Version 3.01

This is a bugfix release, functionally identical to v3.0 - other than that v3.0 has a bug that prevents events being correctly handled. v3.0 has been withdrawn; please update to v3.01

Version 3.0

BREAKING CHANGES: this release introduces a new, substantially different and cleaner architecture to the binding. As a result you will likely have to re-create and re-link your server and camera Things. Please see README.md and CHANGELOG.md on Github for more details

There are new channels, supporting more of the Frigate event block and the active event counts

New ThingActions, including PTZ

ThingActions are no longer asynchronous.

Version 2.4

Supports TLS to Frigate server, and use of the authenticated Frigate API (backport from forthcoming v3.x)

Version 2.3

  • Fix for later ffmpegs not reporting fps (backported from v3.x)

  • Fix for short stream creation timeouts

  • Additional parameter allowing the wait time for stream creation to be configurable.

Version 2.2

  • Channel updates
  • Documentation updates.

Resources

V3.01 (OH V5.2.1)

Source repository and Documentation

2

Leaving a comment for future me:

The url for the configuration must include the API port, 5000. Not the web ui one.

/facepalm

3

I really love this binding – great work, it’s very comprehensive and extremely useful :+1:
It would be really cool to see this become an official binding at some point!

Just a quick note: on my setup, the channels hasSnapshot and hasClip don’t seem to work at the moment.
Not sure if this is a known issue or something specific to my configuration, but I wanted to mention it.

Thanks again for all the effort you’ve put into this!

4

Hi @jgow,
may I ask if the binding works with openhab 5.1?

BR Andreas

5

I am currently running OpenHAB 5.1 I was able to create a Frigate server thing. It seems to work fine although I did not yet add camera things for the moment. I am working on it.

EDIT: I confirm that it works. Camera successfully added ! This is a really great work ! Thanks to @jgow !