Update doorbird.markdown (#7817)

* Update doorbird.markdown

Added additional information on obtaining token and API-Operator Permission

* ✏️ Tweaks
This commit is contained in:
rosscullen 2019-01-01 15:11:13 +00:00 committed by Franck Nijhof
parent 3fa1181745
commit b1d966825c

View File

@ -35,11 +35,11 @@ doorbird:
{% configuration %}
token:
description: Token to be used to authenticate Doorbird calls to Home Assistant.
description: Token to be used to authenticate Doorbird calls to Home Assistant. This can be obtained from your "Digital Passport" document provided with your Doorbird.
required: true
type: string
devices:
description: List of doorbird devices.
description: List of Doorbird devices.
required: true
type: list
keys:
@ -48,7 +48,7 @@ devices:
required: true
type: string
username:
description: The username of a non-administrator user account on the device. This user needs the "API-Operator" permission enabled on doorbird.
description: The username of a non-administrator user account on the device. This user needs the "API-Operator" permission enabled on Doorbird. It is recommended to set up a new account on your Doorbird for use with Home Assistant. This can be added via the Doorbird App by choosing Administration -> (User) Add. When the new account is created, you will need to enable the permission "API-Operator" in the "permissions" option.
required: true
type: string
password:
@ -69,7 +69,7 @@ devices:
type: string
keys:
doorbell:
description: Monitor doorbell events
description: Monitor doorbell events.
motion:
description: Monitor motion events (Motion monitoring must be enabled on the doorstation via DoorBird app).
{% endconfiguration %}
@ -114,7 +114,8 @@ Please note that clearing device registrations will prevent the device from send
</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.
Each event includes live image and 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.