Introduction

I hope you enjoy homebridge-unifi-protect as much as I enjoy developing it. All my projects are labors of love. If you'd like to show your appreciation - star this project on Github and do some good in your community, either financially or with your time: a food bank, an animal shelter (two of my passions), or whatever resonates with you that can give something back to the world around you.

Getting Started

• Installation : installing this plugin, including system requirements.
• Plugin Configuration : how to quickly get up and running.
• Best Practices : best practices for getting the most of your HomeKit setup and UniFi Protect.
• Troubleshooting : running into login problems or streaming issues? Give this a read before looking anywhere else.

Advanced Topics

• Autoconfiguration: how Protect controller autoconfiguration, transcoding and transmuxing work in HBUP, and why.
• Feature Options: granular options to allow you to set the camera quality individually, show or hide specific cameras, controllers, and more.
• Audio Options: options to further tailor how audio is handled from Protect, such as background noise reduction.
• Doorbells: how UniFi Protect doorbell support works in this plugin, and how to use all the available features including doorbell messages.
• HomeKit Secure Video: how HomeKit Secure Video support works in this plugin with UniFi Protect.
• Liveview Scenes: use the UniFi Protect liveviews feature (available in the UniFi Protect controller webUI) to create motion-detection scenes.
• MQTT: how to configure MQTT support.
• Advanced Configuration: complete list of configuration options available in this plugin.
• Realtime API Documentation: documentation of how the Ubiquiti realtime updates API works and how to decode the binary protocol.
• Changelog: changes and release history of this plugin, starting with v3.0.

Support

• Discord Support Channel
• Create a Developer Support Request
• View the Changelog and Release Notes