Add documentation for Skybell config flow (#18108)

This commit is contained in:
Robert Hillis 2022-06-12 15:45:18 -04:00 committed by GitHub
parent c5e4b8d800
commit 2eb56d35aa
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23

View File

@ -9,6 +9,7 @@ ha_category:
- Sensor - Sensor
- Switch - Switch
ha_release: 0.56 ha_release: 0.56
ha_config_flow: true
ha_iot_class: Cloud Polling ha_iot_class: Cloud Polling
ha_domain: skybell ha_domain: skybell
ha_platforms: ha_platforms:
@ -17,6 +18,8 @@ ha_platforms:
- light - light
- sensor - sensor
- switch - switch
ha_codeowners:
- '@tkdrob'
ha_integration_type: integration ha_integration_type: integration
--- ---
@ -32,157 +35,32 @@ There is currently support for the following device types within Home Assistant:
Currently only the SkyBell HD is supported by this platform. Currently only the SkyBell HD is supported by this platform.
## Configuration {% include integrations/config_flow.md %}
To enable devices set up with your [Skybell.com](http://www.skybell.com/) account, add the following to your `configuration.yaml` file: ## Integration Entities
```yaml
# Example configuration.yaml entry
skybell:
username: YOUR_USERNAME
password: YOUR_PASSWORD
```
{% configuration %}
username:
description: The username for accessing your SkyBell account.
required: true
type: string
password:
description: The password for accessing your SkyBell account.
required: true
type: string
{% endconfiguration %}
### Binary Sensor ### Binary Sensor
Once you have enabled the SkyBell component, add the following to your `configuration.yaml` file: Each added configuration entry will create the following binary sensors:
```yaml - **Button**: When the doorbell button has been pushed.
# Example configuration.yaml entry - **Motion**: When motion has been detected.
binary_sensor:
- platform: skybell
monitored_conditions:
- button
- motion
```
{% configuration %} ## Camera
monitored_conditions:
description: Conditions to display in the frontend. The following conditions can be monitored.
required: true
type: list
keys:
button:
description: Returns whether the doorbell button was pressed.
motion:
description: Returns whether movement was detected by the SkyBell doorbell.
{% endconfiguration %}
### Camera
Once you have enabled the SkyBell component, add the following to your `configuration.yaml` file:
```yaml
# Example configuration.yaml entry
camera:
- platform: skybell
```
{% configuration %}
monitored_conditions:
description: The camera images to display. Default is `avatar`. The full list is `avatar`, `activity`.
required: false
type: list
avatar_name:
description: Name to append to the device name for the avatar image. Default is empty string.
required: false
type: string
activity_name:
description: Name to append to the device name for the last activity image. Default is empty string.
required: false
type: string
{% endconfiguration %}
#### Camera Types
There are two available camera types "Avatar", which is the default, displays the SkyBell avatar image. There are two available camera types "Avatar", which is the default, displays the SkyBell avatar image.
It is periodically updated with a fresh image. The other type is "Activity", which displays a snapshot from It is periodically updated with a fresh image. The other type is "Activity", which displays a snapshot from
the latest event (motion, bell, or on demand) captured by the camera. You may show either camera, or both, by the latest event (motion, bell, or on demand) captured by the camera.
specifying its name under monitored_condtions. It's recommended, but not required, to set either avatar_name or activity_name
if you are showing both cameras so you can tell them apart. The name will be appended to the SkyBell device name.
```yaml
# Example configuration.yaml with both images
camera:
- platform: skybell
monitored_conditions:
- avatar
- activity
activity_name: "Last Activity"
```
```yaml
# Example configuration.yaml with just last activity image
camera:
- platform: skybell
monitored_conditions:
- activity
```
### Light ### Light
Once you have enabled the SkyBell component, add the following to your `configuration.yaml` file: The light supports switching and RGB color.
```yaml
# Example configuration.yaml entry
light:
- platform: skybell
```
### Sensor ### Sensor
Once you have enabled the SkyBell component, add the following to your `configuration.yaml` file: - **Chime Level**: The volume level for the outside ringer. (0 equals off)
```yaml
# Example configuration.yaml entry
sensor:
- platform: skybell
monitored_conditions:
- chime_level
```
{% configuration %}
monitored_conditions:
type: list
required: true
description: Conditions to display in the frontend. The following conditions can be monitored.
keys:
chime_level:
description: Return a value between 0-3, indicating no chime, low, medium, and high respectively.
{% endconfiguration %}
### Switch ### Switch
Once you have enabled the SkyBell integration, add the following to your `configuration.yaml` file: - **Do Not Disturb**: Disable the indoor ringer.
- **Motion Sensor**: Turn on/off motion sensing. (Enabling this will reset in-app notifications to on)
```yaml
# Example configuration.yaml entry
switch:
- platform: skybell
monitored_conditions:
- do_not_disturb
- motion_sensor
```
{% configuration %}
monitored_conditions:
description: Conditions to display in the frontend.
required: true
type: list
keys:
do_not_disturb:
description: Control the state of your doorbells indoor chime.
motion_sensor:
description: Control the state of your doorbells motion sensor.
{% endconfiguration %}