jeans/home-assistant.io
jeans/home-assistant.io
1
0
Fork 0
mirror of https://github.com/home-assistant/home-assistant.io.git synced 2025-07-18 14:56:53 +00:00
Code Issues Packages Projects Releases Wiki Activity

Add UniFi Protect global service docs (#21119)

Browse Source
This commit is contained in:
Christopher Bailey 2022-01-10 16:05:01 -05:00 committed by GitHub
parent 674b1267ea
commit 294f406c84
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 32 additions and 5 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

37
source/_integrations/unifiprotect.markdown
View File

@ -160,15 +160,42 @@ Your main UniFi Protect NVR device also gets a number of diagnostics sensors tha
## Services
### Service unifiprotect.set_doorbell_message
### Service unifiprotect.set_default_doorbell_text
Use to dynamically set the message on a Doorbell LCD screen. This service should only be used to set dynamic messages (i.e. setting the current outdoor temperature on your Doorbell).
Sets the default doorbell message. This will be the message that is automatically selected when a message "expires".
| Service data attribute | Optional | Description |
| ---------------------- | -------- | ------------------------------------------------------------------------------------------------------------ |
| `entity_id` | No | The Doorbell Text select entity for your Doorbell |
| `message` | No | The message you would like to display on the LCD screen of your Doorbell. Must be less than 30 characters |
| `duration` | Yes | Number of minutes to display the message for before returning to the default message |
| `device_id` | No | Any device from the UniFi Protect instance you want to change. In case you have multiple Protect Instances. |
| `message` | No | The default message for your Doorbell. Must be less than 30 characters. |
### Service unifiprotect.add_doorbell_text
Adds a new custom message for Doorbells.
| Service data attribute | Optional | Description |
| ---------------------- | -------- | ------------------------------------------------------------------------------------------------------------ |
| `device_id` | No | Any device from the UniFi Protect instance you want to change. In case you have multiple Protect Instances. |
| `message` | No | New custom message to add for Doorbells. Must be less than 30 characters. |
### Service unifiprotect.remove_doorbell_text
Removes an existing message for Doorbells.
| Service data attribute | Optional | Description |
| ---------------------- | -------- | ------------------------------------------------------------------------------------------------------------ |
| `device_id` | No | Any device from the UniFi Protect instance you want to change. In case you have multiple Protect Instances. |
| `message` | No | Existing custom message to remove for Doorbells. |
### Service unifiprotect.set_doorbell_message
Use to dynamically set the message on a Doorbell LCD screen. This service should only be used to set dynamic messages (i.e. setting the current outdoor temperature on your Doorbell). Static messages should still be set using the Select entity and can be added/removed using the `add_doorbell_text`/`remove_doorbell_text` services.
| Service data attribute | Optional | Description |
| ---------------------- | -------- | ------------------------------------------------------------------------------------------------------------ |
| `entity_id` | No | The Doorbell Text select entity for your Doorbell. |
| `message` | No | The message you would like to display on the LCD screen of your Doorbell. Must be less than 30 characters. |
| `duration` | Yes | Number of minutes to display the message for before returning to the default message. The default is to not expire. |
## Troubleshooting