ConfigurationReference.md

Homebridge UniFi Protect

Complete HomeKit support for the UniFi Protect ecosystem using Homebridge.

homebridge-unifi-protect is a Homebridge plugin that provides HomeKit support to the UniFi Protect device ecosystem. UniFi Protect is Ubiquiti's video security platform, with rich camera, doorbell, and NVR controller hardware options for you to choose from, as well as an app which you can use to view, configure and manage your video camera and doorbells.

Configuration Reference

This is a complete reference of the HBUP settings JSON. The defaults should work well for almost everyone and configuration of this plugin should be done exclusively within the HBUP webUI and not manually editing JSONs which can be error-prone and lead to undesired behavior.

"platforms": [
  {
    "platform": "UniFi Protect",
    "videoProcessor": "/usr/local/bin/ffmpeg",
    "ffmpegOptions": [
    ]
    "verboseFfmpeg": false,

    "options": [
      "Disable.Video.Stream.High"
    ],

    "controllers": [
      {
        "name": "My UniFi Protect Controller",
        "address": "1.2.3.4",
        "addressOverride": "a.b.c.d",
        "username": "some-homebridge-user (or create a new one just for homebridge)",
        "password": "some-password",
        "doorbellMessages": [
          {
             "message": "Be right there.",
             "duration": 90
          }
        ],
        "mqttUrl": "mqtt://test.mosquitto.org",
        "mqttTopic": "unifi/protect"
      }
    ]
  }
]

Fields	Description	Default	Required
platform	Must always be UniFi Protect.	UniFi Protect	Yes
address	Host or IP address of your UniFi Protect controller.		Yes
username	Your UniFi Protect username.		Yes
password	Your UniFi Protect password.		Yes
addressOverride	Override the address used when HBUP accesses camera URLs.		No
doorbellMessages	Configure doorbell messages for your UniFi Protect controller.	[]	No
videoProcessor	Specify path of ffmpeg or avconv.	"ffmpeg"	No
ffmpegOptions	Additional parameters to pass ffmpeg to render video.		No
options	Configure plugin feature options.	[]	No
name	Controller name to use for homebridge logging purposes.	UniFi Protect controller name	No
mqttUrl	The URL of your MQTT broker. This must be in URL form, e.g.: mqtt://user:[email protected].		No
mqttTopic	The base topic to use when publishing MQTT messages.	"unifi/protect"	No
verboseFfmpeg	Enable additional logging for video streaming.	false	No