briis/unifiprotect v0.10.0-beta.3

Version 0.10.0-beta.3

on GitHub

REMINDER This version is only valid for V1.20.0-beta.2 or higher of UniFi Protect. If you are not on that version, stick with V0.9.1.

Upgrade Instructions

Due to the many changes and entities that have been removed and replaced, we recommend the following process to upgrade from an earlier Beta or from an earlier release:

• Upgrade the Integration files, either through HACS (Recommended) or by copying the files manually to your custom_components/unifiprotect directory.
• Restart Home Assistant
• Remove the UniFi Protect Integration by going to the Integrations page, click the 3 dots in the lower right corner of the UniFi Protect Integration and select Delete
• While still on this page, click the + ADD INTEGRATION button in the lower right corner, search for UnFi Protect, and start the installation, supplying your credentials.

Changes in this release

Everything from Beta 1 and 2 is included here, plus the following:

• CHANGE: BREAKING CHANGE There has been a substansial rewite of the underlying IO API Module (pyunifiprotect) over the last few month. The structure is now much better and makes it easier to maintain going forward. It will take too long to list all the changes, but one important change is that we have removed the support for Non UnifiOS devices. These are CloudKey+ devices with a FW lower than 2.0.24. I want to give a big thank you to @AngellusMortis and @bdraco for making this happen.
• CHANGE: BREAKING CHANGE As this release has removed the support for Non UnifiOS devices, we could also remove the Polling function for Events as this is served through Websockets. This also means that the Scan Interval is no longer present in the Configuration.
• CHANGE: BREAKING CHANGE To future proof the Select entities, we had to change the the way the Unique ID is populated. The entity names are not changing, but the Unique ID's are If you have installed a previous beta of V0.10.0 you will get a duplicate of all Select entities, and the ones that were there before, will be marked as unavailable. You can either remove them manually from the Integration page, or even easier, just delete the UniFi Protect integration, and add it again. (The later is the recommended method)
• CHANGE: BREAKING CHANGE All switches called switch.ir_active_CAMERANAME have been removed from the system. They are being migrated to a Select Entity which you can read more about below. If you have automations that turns these switches on and off, you will have to replace this with the select.select_option service, using the valid options described below for the option data.
• CHANGE: BREAKING CHANGE The Service unifiprotect.set_ir_mode now supports the following values for ir_mode: "auto, autoFilterOnly, on, off". This is a change from the previous valid options and if you have automations that uses this service you will need to make sure that you only use these supported modes.
• CHANGE: BREAKING CHANGE The Service unifiprotect.save_thumbnail_image has been removed from the Integration. This service proved to be unreliable as the Thumbnail image very often was not available, when this service was called. Please use the service camera.snapshot instead.
• NEW: For each Camera there will now be a Select Entity from where you can select the Infrared mode for each Camera. Valid options are Auto, Always Enable, Auto (Filter Only, no LED's), Always Disable. These are the same options you can use if you set this through the UniFi Protect App.
• NEW: Added a new Number entity called number.wide_dynamic_range_CAMERANAME. You can now set the Wide Dynamic Range for a camera directly from the UI. This is a supplement to the already existing service unifiprotect.set_wdr_value.
• NEW: Added select.doorbell_text_DOORBELL_NAME to be able to change the LCD Text on the Doorbell from the UI. In the configuration menu of the Integration there is now a field where you can type a list of Custom Texts that can be displayed on the Doorbell and then these options plus the two standard texts built-in to the Doorbell can now all be selected. The format of the custom text list has to ba a comma separated list, f.ex.: RING THE BELL, WE ARE SLEEPING, GO AWAY... etc.
• NEW: Added a new Number entity called number.microphone_level_CAMERANAME. From here you can set the Microphone Sensitivity Level for a camera directly from the UI. This is a supplement to the already existing service unifiprotect.set_mic_volume.
• NEW: Added a new Number entity called number.zoom_position_CAMERANAME. From here you can set the optical Zoom Position for a camera directly from the UI. This entity will only be added for Cameras that support optical zoom. This is a supplement to the already existing service unifiprotect.set_zoom_position.