Doorbird auth and event data (#6245)

This commit is contained in:
Matt Snyder 2018-11-01 17:20:34 -05:00 committed by Alok Saboo
parent dcb0cf1ac5
commit fe26c4e8bd

View File

@ -22,6 +22,7 @@ To connect your device, add the following to your `configuration.yaml` file:
```yaml
# Example configuration.yaml entry
doorbird:
token: RANDOM_STRING
devices:
- host: DOORBIRD_IP_OR_HOSTNAME
username: YOUR_USERNAME
@ -38,6 +39,10 @@ doorbird:
```
{% configuration %}
token:
description: Token to be used to authenticate Doorbird calls to Home Assistant.
required: true
type: string
devices:
description: List of doorbird devices.
required: true
@ -91,6 +96,13 @@ This should not cause any problems, but if you would like to remove it, open a n
Please note that clearing device registrations will prevent the device from sending pushes to Home Assistant until you restart your instance with the component enabled. It could also affect other third-party applications you may use with your DoorBird device. It will not break the official mobile app in any way, so mobile push notifications will still work.
</p>
#### {% linkable_title Event Data %}
Each event includes live image and live video URLs for the Doorbird device that triggered the event. These URLs can be found on the event data and can be useful in automation actions. For example, you could use `html5_viewer_url` on a notification to be linked directly to the live view of the device that triggered the automation.
<p class="note">
The URLs on the event will be based on the configuration used to connect to your Doorbird device. Ability to connect from outside your network will depend on your configuration.
</p>
### {% linkable_title Automation Example %}
```yaml
- alias: Doorbird Ring