homebridge-unifi-protect

6.18.0 (2024-02-11)

• New feature: Stream cropping. You can now selectively crop your Protect video stream feed in HBUP. This option will force transcoding on in all circumstances when viewing livestreams. My thanks to @dansimau for the initial PR that implemented this feature and contributed it to the community. This feature utilized the FFmpeg crop filter behind the scenes - you can read more about how cropping in FFmpeg works in the FFmpeg documentation to orient yourself if you're struggling with this feature at first. My recommendation: play with it and you'll eventually get a feel for the settings if they don't seem intuitive at first.
• Improvement: Protect device availability is now provided to HomeKit on a realtime basis. This should help folks more easily see when devices are disconnected from the Protect controller.
• Housekeeping.

6.17.0 (2024-02-04)

• Improvement: add support for UniFi Protect-driven animal smart occupancy in the HBUP webUI.
• Housekeeping.

6.16.0 (2023-11-05)

• Housekeeping.

6.15.1 (2023-10-08)

• Improvement: more robust validation of hardware acceleration before enabling it. For users who are trying to use QSV - there's some known issues that'll be worked on in a future release of ffmpeg-for-homebridge to enable these capabilities more fully, bear with me.
• Housekeeping.

6.15.0 (2023-10-02)

• New feature: sync Protect device names between HomeKit and Protect (available under device feature options in the HBUP webUI). Protect device name synchronization is one-way, from Protect to HomeKit, and is not real-time. Name synchronization with HomeKit will be delivered to HomeKit on plugin startup. In reality - name synchronization is a real-time activity in HBUP, but there seems to be an issue somewhere along the way that'll be resolved in either a future HBUP or Homebridge release. This feature is off by default, but may become the default in a future release.
• New feature: license plate telemetry contact sensor support (available under motion feature options in the HBUP webUI). If you have an AI-series camera and have license plate detection enabled, you can now look for individual license plates and potentially execute specific automation scenarios (say in combination with homebridge-myq and automatically open or close a garage door when detected). This works by using Protect's native detection of individual license plates - in my testing, it's imperfect but works the vast majority of the time in good lighting conditions. If you enable motion event logging, you'll see the license plate telemetry logged and, of course, there is MQTT support available as well. You must enable smart motion event detection in HBUP to use this feature - and of course, it's available in the webUI. One last thing: you can set detections for multiple license plates by hyphenating the license plates (PLATE1-PLATE2-PLATE3...) when enabling the feature option and you'll get a contact sensor for each plate.
• New feature: ring delay intervals. For those situations where you want to prevent someone from hitting the doorbell too many times in a row, you can now configure how much time must pass in between each doorbell ring. Available in the settings tab in the HBUP webUI under additional options and defaults to no delay between rings. Thanks to @vincer for the suggestion.
• New feature: device removal delay feature option (available under NVR feature options). There are certain unique scenarios (almost entirely revolving around UniFi Protect bugs related to stacked NVR configurations) where real-time removal of Protect devices from HomeKit is undesirable. This feature option allows users to configure a delay once a device removal event has been detected before HBUP removes the device from HomeKit. This can be helpful in instances where Protect devices temporarily disappear from a Protect controller before reappearing a short time later.
• Improvement: motion event delivery is more robust, with several under-the-hood optimizations that should make motion detection feel even snappier than they already are for users. Additionally, HBUP now warns users when Protect controller settings will prevent HBUP from seeing motion events.
• Improvement: native Intel QSV support comes to this release, courtesy of the latest ffmpeg-for-homebridge has now been updated with support for Intel Quick Sync Video GPU hardware acceleration. For users of QSV-enabled systems, you can give hardware-accelerated transcoding a try and see what we've been enjoying on the macOS end of the world.
• Housekeeping.

6.14.0 (2023-09-11)

• New feature: you can now trigger doorbell ring events through MQTT. See the MQTT documentation reference for more details. Thanks to @glynd for the contribution.
• Fix: address two edge cases on which Protect camera streams are used when HBUP tries to be smart about selecting one to use. One edge case relates to hardware transcoding and the other to some of the more exotic camera resolutions Protect uses. Thanks to @bSr43 for encountering one part of this bug and raising it to my attention wherein I discovered the second part of my shame and corrected both problems.

6.13.1 (2023-08-26)

• Fix: ensure audio settings are honored for HKSV event recordings.

6.13.0 (2023-08-26)

• Improvement: webUI enhancements. Users now default into the feature options tab, and new users will get a first run screen prompting for Protect controller and login credentials. Protect API errors are reported in the webUI. And more.
• Improvement: modernized and refined motion detection event delivery.
• Housekeeipng. Lots of housekeeping.

6.12.2 (2023-08-19)

6.12.1 (2023-08-19)

• Housekeeping.

6.12.1 (2023-08-19)

• Housekeeping.

6.12.0 (2023-08-06)

• Fix: correctly detect Raspberry Pi Compute Module 4 variants.
• Housekeeping.

6.11.1 (2023-07-27)

• Housekeeping and minor bugfixes.

6.11.0 (2023-07-16)

• New feature: Protect doorbells with attached physical chimes can now be controlled. This option adds three switch accessories that you can toggle between: none, mechanical, and digital. It allows those who have physical chimes attached to their Protect doorbells to be able to silence them selectively. Note: these switches are special in that they can only be set to on. Trying to turn off the individual switches won't work. If you want to turn off the physical chime, you turn on the "None" switch, which will turn off the others. Inelegant, but it's the only meaningful way to add three-state switches in the HomeKit world. This option will appear in the webUI under the Doorbell configuration section, if you have a Protect doorbell with a physical chime. Enabling it will expose an additional feature option, allowing you to select the duration for digital chimes, which should correspond to the same settings in the Protect webUI and app.
• Improvement: further refinements to M3U playlist generation, including live guide data and keywords for consuming apps that support it.
• Housekeeping.

6.10.0 (2023-07-08)

• Note: as of 6.10.0, HBUP requires UniFi OS 3.0 or greater. Given Ubiquiti has completed the rollout of UniFi OS 3.0+ to all supported console platforms, if you're running on recent GA firmware releases of UniFi Protect controllers, this requirement will have no impact to you. If you don't, please note that while HBUP may continue to work for the time being, there is no support or guarantee of compatibility for future releases.
• New feature: You can now enable a new feature option that will enable HBUP to publish an M3U playlist that can be ingested by other apps. This is useful in certain scenarios, such as an app that can make Protect livestreams available through it's own UI, but doesn't know how to speak to the Protect API. An example of this would be creating a custom channel in Channels DVR. M3U playlist will be made available on a user-selectable port, via HTTP. The playlist contains additional metadata that is especially useful in Channels DVR. See the HBUP webUI for more under NVR feature options.
• New feature: Protect sensors now display battery percentages in the Home app.
• Improvement: webUI refinements and branding updates.
• Fix: further refinements to ensuring HomeKit recording and streaming profile requirements are met.
• Housekeeping, documentation updates, and visual refreshes.

6.9.2 (2023-06-24)

• Fix: ensure HKSV recording can be enabled on Protect cameras with native frame rates that are different than what HomeKit accepts.

6.9.1 (2023-06-23)

• Fix: improve webUI compatibility across browsers for value-centric feature options.
• Housekeeping.

6.9.0 (2023-06-19)

• New feature: package camera HKSV support is here. Ubiquiti has stabilized access to the package camera and finally provided reliable access to it through the API. Package cameras will appear as HKSV-capable within the Home app, you can configure it the same as any other camera.
• New feature: leak sensor support, now that it's fully available in UniFi Protect sensors, are now fully supported. A leak sensor service will be configured in HomeKit if you enable the functionality is enabled in the Protect webUI or app. I also realized that I hadn't previously updated the MQTT documentation for Protect sensors - that's now documented as well.
• New feature: motion and occupancy event durations can now be granularly controlled through feature options. You can configure them using the webUI. Note: if you previously set a default motion or occupancy event as an advanced setting - these will no longer be used. To replicate the behavior, set a global feature option for motion and occupancy event durations.
• New feature: the webUI now will hide or show feature options that are dependent on other feature options being enabled or disabled, reducing visual clutter and making the webUI easier to navigate for people.
• New feature: value-centric feature options can now be configured using the webUI. This completes the feature set for the webUI - all feature options should be configured using the webUI moving forward.
• Improvement: additional speed and quality improvements for those that have hardware acceleration available to them. When using hardware acceleration, the highest stream quality will always be used by HBUP now, which significantly improves transcoding speed and quality.
• Improvement: ViewPort liveview state changes from the Protect webUI are now detected in realtime.
• Housekeeping.

6.8.0 (2023-06-04)

• Improvement: when using occupancy sensors in combination with smart motion detection, you can now tailor which Protect object detection types trigger occupancy. See the webUI or documentation for more.
• Improvement: the webUI now visually shows you the scope of a feature option (global, controller, or device), and allows you to cycle between them. This makes it easier to set a global or controller default, but individually override it for a device.
• Fix: ensure occupancy sensors are available to all Protect device types that support motion detection.
• Housekeeping.

6.8.0 (2023-06-04)

• Improvement: when using occupancy sensors in combination with smart motion detection, you can now tailor which Protect object detection types trigger occupancy. See the webUI or documentation for more.
• Improvement: the webUI now visually shows you the scope of a feature option (global, controller, or device), and allows you to cycle between them. This makes it easier to set a global or controller default, but individually override it for a device.
• Fix: ensure occupancy sensors are available to all Protect device types that support motion detection.
• Housekeeping.

6.7.0 (2023-05-21)

• New feature: occupancy sensors for Protect devices with motion sensors. If you enable the occupancy sensor feature option on a Protect device, an occupancy sensor accessory will be added to that device. The occupancy sensor works like this: when any motion is detected by that device's motion sensor, occupancy is triggered. When no motion has been detected for a certain amount of time (5 minutes by default), occupancy will no longer be triggered. This is useful in various automation scenarios that folks might want (e.g. occupancy triggering a light turning on/off). If you enable the smart motion events feature option as well, the occupancy sensor will use smart motion events to determine occupancy state, meaning rather than trigger occupancy on any motion, occupancy will only be triggered when Protect thinks it has detected a person.
• Housekeeping and minor bugfixes.