Custom Component: Unifi Protect

Andy_Miller · December 15, 2021, 1:47am

Amazing thank you.

briis · December 18, 2021, 7:20am

Release 0.11.0

Deprecations

0.11 is last major release planned before we merge the unifiprotect integration into core. As a result, a number of features are being removed when we merged into core.

The following services will be removed in the next version:

unifiprotect.set_recording_mode – use the select introduced in 0.10 instead
unifiprotect.set_ir_mode – use the select entity introduced in 0.10 instead
unifiprotect.set_status_light – use the switch entity on the camera device instead
unifiprotect.set_hdr_mode – use the switch entity on the camera device instead
unifiprotect.set_highfps_video_mode – use the switch entity on the camera device instead
unifiprotect.set_doorbell_lcd_message – use the select entity introduced in 0.10 instead
unifiprotect.set_mic_volume – use the number entity introduced in 0.10 instead
unifiprotect.set_privacy_mode – use the switch entity introduced in 0.10 instead
unifiprotect.set_zoom_position – use the number entity introduced in 0.10 instead
unifiprotect.set_wdr_value – use the number entity introduced in 0.10 instead
unifiprotect.light_settings – use the select entity introduced in 0.10 instead
unifiprotect.set_viewport_view – use the select entity introduced in 0.10 instead

The following events will be removed in the next version:

unifiprotect_doorbell – use a State Changed event on “Doorbell” binary sensor on the device instead
unifiprotect_motion – use a State Changed event on the “Motion” binary sensor on the device instead

The following entities will be removed in the next version:

The “Motion Recording” sensor for cameras (in favor of the “Recording Mode” select)
The “Light Turn On” sensor for flood lights (in favor of the “Lighting” select)

All of following attributes should be duplicated data that can be gotten from other devices/entities and as such, they will be removed in the next version.

device_model will be removed from all entities – provided in the UI as part of the “Device Info”
last_tripped_time will be removed from binary sensor entities – use the last_changed value provided by the HA state instead
up_since will be removed from camera and light entities – now has its own sensor. The sensor is disabled by default so you will need to enable it if you want to use it.
enabled_at will be removed from light entities – now has its own sensor
camera_id will be removed from camera entities – no services need the camera ID anymore so it does not need to be exposed as an attribute. You can still get device IDs for testing/debugging from the Configuration URL in the “Device Info” section
chime_duration, is_dark, mic_sensitivity, privacy_mode, wdr_value, and zoom_position will be removed from camera entities – all of them have now have their own sensors
event_object will be removed from the Motion binary sensor. Use the dedicated Detected Object sensor.

Breaking Changes in this release

CHANGE: BREAKING CHANGE The internal name of the Privacy Zone controlled by the “Privacy Mode” switch has been changed. Make sure you turn off all of your privacy mode switches before upgrading. If you do not, you will need to manually delete the old Privacy Zone from your UniFi Protect app.
CHANGE: BREAKING CHANGE WDR number entity has been removed from Cameras that have HDR. This is inline with changes made to Protect as you can no longer control WDR for cameras with HDR.
CHANGE: BREAKING CHANGE the event_length attribute has been removed from the motion and door binary sensors. The value was previously calculated in memory and not reliable between restarts.
CHANGE: BREAKING CHANGE the event_object attribute for binary motion sensors has changed the value for no object detected from “None Identified” (string) to “None” (NoneType/null)
CHANGE: BREAKING CHANGE The Doorbell Text select entity for Doorbells has been overhauled. The Config Flow option for Doorbell Messages has been removed. You now can use the the unifiprotect.add_doorbell_text and unifiprotect.remove_doorbell_text services to add/remove Doorbell messages. This will persist the messages in UniFi Protect and the choices will now be the same ones that appear in the UniFi Protect iOS/Android app. NOTE: After running one of these services, you must restart Home Assistant for the updated options to appear.

Other Changes in this release

CHANGE: Migrates UpvServer to new ProtectApiClient from pyunifiprotect.
- This should lead to a number of behind-the-scenes reliability improvements.
  - Should fix/close the following issues: #248, #255, #297, #317, #341, and #360 (TODO: Verify)
CHANGE: Overhaul Config Flow
- Adds Reauthentication support
- Adds “Verify SSL”
- Updates Setup / Reauth / Options flows to pre-populate forms from existing settings
- Removes changing username/password as part of the options flow as it is redundant with Reauthentication support
- Removes Doorbell Text option since it is handled directly by UniFi Protect now
- Adds new config option to update all metrics (storage stat usage, uptimes, CPU usage, etc.) in realtime. WARNING: Enabling this option will greatly increase your CPU usage. ~2x is what we were seeing in our testing. It is recommended to leave it disabled for now as we do not have a lot of diagnostic sensors using this data yet.
CHANGE: The state of the camera entities now reflects on whether the camera is actually recording. If you set your Recording Mode to “Detections”, your camera will switch back and forth between “Idle” and “Recording” based on if the camera is actually recording.
- Closes #337
CHANGE: Configuration URLs for UFP devices will now take you directly to the device in the UFP Web UI.
CHANGE: Default names for all entities have been updated from entity_name device_name to device_name entity_name to match how Home Assistant expects them in 2021.11+
CHANGE: The Bluetooth strength sensor for the UP Sense is now disabled by default (will not effect anyone that already has the sensor).
NEW: Adds unifiprotect.set_doorbell_message service. This is just like the unifiprotect.set_doorbell_lcd_message, but it is not deprecated and it requires the Doorbell Text Select entity instead of the Camera entity. Should only be used to set dynamic doorbell text messages (i.e. setting the current outdoor temperate on your doorbell). If you want to use static custom messages, use the Doorbell Text Select entity and the unifiprotect.add_doorbell_text / unifiprotect.remove_doorbell_text service. unifiprotect.set_doorbell_lcd_message is still deprecated and will still be removed in the next release.
- Closes #396
NEW: Adds “Override Connection Host” config option. This will force your RTSP(S) connection IP address to be the same as everything else. Should only be used if you need to forcibly use a different IP address.
- For sure closes #248
NEW: Added Dark Mode brand images to GitHub - home-assistant/brands: 🎨 Brands for Home Assistant.
NEW: Adds phy_rate and wifi_signal sensors so all connection states (BLE, WiFi and Wired) should have a diagnostic sensor. Disabled by default. Requires “Realtime metrics” option to update in realtime.
NEW: Added Detected Object sensor for cameras with smart detections. Values are none, person or vehicle. Contains event_score and event_thumb attributes.
- Closes #342
NEW: Adds Paired Camera select entity for Viewports
NEW: Adds “Received Data”, “Transferred Data”, “Oldest Recording”, “Storage Used”, and “Disk Write Rate” sensors for cameras. Disabled by default. Requires “Realtime metrics” option to update in realtime.
NEW: (requires UniFi Protect 1.20.1) Adds “Voltage” sensor for doorbells. Disabled by default.
NEW: Adds “System Sounds” switch for cameras with speakers
NEW: Adds switches to toggle overlay information for video feeds on all cameras
NEW: Adds switches to toggle smart detection types on cameras with smart detections
NEW: Adds event thumbnail proxy view.
- URL is /api/ufp/thumbnail/{thumb_id}. thumb_id is the ID of the thumbnail from UniFi Protect.
- entity_id is a required query parameters. entity_id be for an sensor that has event thumbnails on it (like the Motion binary sensor)
- token is a required query parameter is you are not authenticated. It is an attribute on the motion sensor for the Camera
- w and h are optional query string params for thumbnail resizing.
NEW: Adds event_thumbnail attribute to Motion binary sensor that uses above mentioned event thumbnail proxy view.
NEW: Adds NVR sensors. All of them are disabled by default. All of the sensors will only update every ~15 minutes unless the “Realtime metrics” config option is turned on. List of all sensors:
- Disk Health (one per disk)
- System Info: CPU Temp, CPU, Memory and Storage Utilization
- Uptime
- Recording Capacity (in seconds)
- Distributions of stored video for Resolution (4K/HD/Free)
- Distributions of stored video for Type (Continuous/Detections/Timelapse)
More clean up and improvements for upcoming Home Assistant core merge.
Adds various new blueprints to help users automate UniFi Protect. New Blueprints can be found in the README

Eoin · December 18, 2021, 9:53am

Just want to say thank you for all the effort that has gone into this component over recent times. Utterly amazing than you!

Just started playing with dynamic text on the doorbell, so cool what is now possible.

DavidDeSloovere · December 18, 2021, 1:18pm

Great reminder by @Eoin to be grateful for all the work that is done. So…

Thank you @briis

TheRookie · December 18, 2021, 2:34pm

Thank you for your efforts on this Component !

I am trying to use this, but running into issues (UnifiProtect: Person detect notification event_thumbnail not working for me)
Any pointers as to what i am (probably) doing wrong ?

AngellusMortis · December 18, 2021, 2:46pm

We need to document this better, but unfortunately UniFi Protect does not generate the event thumbnail until after the event ends. So, you cannot actually use them real-time notification unless you do a state changed for the event ending and use the thumbnail URL from the old state (I know it sucks).

We already have official blueprints that send mobile push notifications you can use if you want. That is why we did not use the event thumbnails for the blueprints. Favoring speed to get the notification out rather than using the event thumbnail.

TheRookie · December 18, 2021, 3:02pm

Thanks for the explanation, the choice for the blueprint makes sense.

For my use case, it’s OK to only send the notification after the event ends.
Am I correct in guessing that’s just a matter of using this as a trigger?

platform: state
entity_id: sensor.<name>_detected_object
from: person

Is there any documentation on how to access the “old state” in an elegant way?

AngellusMortis · December 18, 2021, 3:05pm

Yes. That works fine. And it should be in trigger.from_state.

TheRookie · December 18, 2021, 3:19pm

Thanks again

Should I include a delay before accessing trigger.from_state.sensor.<name>_detected_object.event_thumbnail ?
I’m still getting the ‘unsupported URL’ message

AngellusMortis · December 18, 2021, 3:21pm

You should not need a delay, not for the notify mobile. Make sure you are using a full qualitied URL though. The attribute is only the URI path, you still need to add your HA external base URL to it.

github.com

briis/unifiprotect/blob/925ff30c589c0ced4af38d8673fb9e6a4b984cf3/blueprints/automation/unifiprotect/push_notification_smart_event.yaml#L234

    
      
            notification_message: "{{ trigger_object.title() }} detected by {{ notification_title }}{% if trigger_time != None %} at {{ trigger_time }}{% endif %}."
            notification_message_html5: |
              {{ notification_message }}{% if notification_url != None %}
          
          
    Tap to open camera in Home Assistant.
              {% endif %}
            notification_image: |
              {% if camera_entity_id == None %}
                None
              {% else %}
                {{ input_base_image_url | trim }}{{ state_attr(camera_entity_id, 'entity_picture') }}
              {% endif %}
            silence_action: "silence-{{ input_smart_entity }}"
          
          
trigger:
            - platform: state
              entity_id: !input smart_entity
              from: "none"
          
          
condition:
            - "{{ not input_presence_filter or not is_state(input_presence_filter, 'home') }}"

TheRookie · December 18, 2021, 3:41pm

[edit]
To answer my own question, to get to the event_thumbnail, you need
{{trigger.from_state.attributes.event_thumbnail}}

I’m getting closer (no more unsupported url ), but no quite there yet.
Trigger:

trigger:
  - platform: state
    entity_id: sensor.[camera]_detected_object
    from: person

The body of the message still says “None”

service: notify.mobile_app_[me]
data:
  title: Testing
  message: >-
    Body
    {{state_attr('trigger.from_state.<camera>_detected_object','event_thumbnail')}}
  data:
    image: >-
      https://[external_host]:8123{{state_attr('trigger.from_state.<camera>_detected_object','event_thumbnail')}}
    attachment:
      url: >-
        https://[external_host]:8123{{state_attr('trigger.from_state.<camera>_detected_object','event_thumbnail')}}
      content-type: jpeg
      hide-thumbnail: false

(This is a great way to get my step count up!)

briis · December 18, 2021, 3:42pm

Thank you, but without all the work from @AngellusMortis and @bdraco, this Integration would never have been what it is now. So I will pass the thanks to these two - Thank You.

djuniah · December 20, 2021, 3:45pm

Had a question about the media player functionality. If I use the HA UI to send a TTS from the entity page, it seems to work properly (an mp3 file of the text is generated and stored in my /tts folder, and the doorbell plays the file). If I use a service call in an automation though, the file does not seem to play. I’m calling “play media”, setting the content ID to “http://MY-HA-ADDRESS/local/doorbell.mp3” and setting the content type to “audio/mp3”. Is there something else I need to be doing to get it to play? Or possibly are there some format requirements that i’m not seeing?

AngellusMortis · December 20, 2021, 3:57pm

The content URL must be accessible from Home Assistant itself. The ffmpeg command to stream the audio runs directly inside of the HA Core docker container. So, if the file is on disk, you can just use /config/www/doorbell.mp3 or whatever the path to the file is. Using a URL might cause issues if the networking routing is off.

Also, if you have not seen the patch notes yet for 0.11.1, please make sure you are running 0.11.1 and reboot your camera after upgrading.

djuniah · December 20, 2021, 4:32pm

I am using the docker container and just tried changing the path to “/config/www/doorbell.mp3” (I opened a console session into the container to verify that the file was accessible at that location). However, that didn’t seem to work either. I appreciate the help though!

Here’s the YAML for that line:

service: media_player.play_media
data:
  media_content_id: /config/www/doorbell.mp3
  media_content_type: audio/mp3
target:
  entity_id: media_player.front_door_speaker

NOTE: I also tried using /tts/NAME_OF_RECENT_TTS_FILE.mp3 since i know those files played properly, but that also failed to play when calling the service. Do i need to call one of the media player turn-on services or anything else first?

EDIT2: Just to confirm, i am running the latest (0.11.1) and have restarted the camera. TTS commands sent through the home-assistant UI do play, just not the media_player.play_media service

EDIT3: I think I got it! The media content type needs to be set to “music”

AngellusMortis · December 20, 2021, 4:44pm

Ah yeah. media_content_type is not a mimetype. Event though that is what it may seem like.

djuniah · December 20, 2021, 4:55pm

Ah, I believe I had to set it to that for the google-cast devices to pick it up, however after testing, it seems like “music” works just fine for both. However, the google-cast needs the URL, not the local path. So, i switched the path to be the URL, the type to be “music” and combined both calls into one (so it lists both the doorbell and the google cast group as the targets) and everything is working now, thanks!!!

AngellusMortis · December 20, 2021, 10:58pm

Some updates:

Release 0.11.1

As an amendment to the deprecations from 0.11.0, the last_tripped_time is no longer deprecated as last_changed is not a full replacement (#411)
FIX: Bumps version of pyunifiprotect to 1.3.4. This will fix talkback for all cameras that was not working as expected. If you previously tried to use the media player to play audio through your camera (like with TTS), you will need to reboot your camera to “fix” it so it will work again.

Blueprint Updates

Fixes some bugs (channel/tag name being generated wrong, triggering on unavailable).
Adds TTS actions to Doorbell Notification
Adds Telegram notification targets (thanks @mjdyson)
Adds Dynamic Doorbell blueprint

Lunkobelix · December 23, 2021, 1:43pm

With the new version I can no longer see my G3 Flex cameras in HA, the G4 Bullets are working just fine and it all happened when I upgraded this component. I have the same settings for RTSP so not sure what could be wrong. Did anyone else experience the same?

briis · December 23, 2021, 1:52pm

Please open an issue on Github and attach anything you might see in the HA Logfile