Add config flow to canary (#14501)

Co-authored-by: Franck Nijhof <git@frenck.dev>
This commit is contained in:
Chris Talkington 2020-09-28 03:36:00 -05:00 committed by GitHub
parent 9c37f9699a
commit 2d97f2d5f1
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23

View File

@ -6,6 +6,7 @@ ha_category:
- Camera
- Sensor
ha_release: '0.60'
ha_config_flow: true
ha_iot_class: Cloud Polling
ha_domain: canary
---
@ -22,30 +23,7 @@ There is currently support for the following device types within Home Assistant:
You will need your Canary login information (username, usually your email address, and password) to use this module.
To set it up, add the following to your `configuration.yaml` file:
```yaml
# Example configuration.yaml entry
canary:
username: YOUR_USERNAME
password: YOUR_PASSWORD
```
{% configuration %}
username:
description: The username for accessing your Canary account.
required: true
type: string
password:
description: The password for accessing your Canary account.
required: true
type: string
timeout:
description: Timeout to wait for connections.
required: false
type: integer
default: 10
{% endconfiguration %}
Go to the integrations page in your configuration and click on new integration -> Canary.
Once loaded, your front end will have the following integrations:
@ -61,22 +39,6 @@ The `canary` camera platform allows you to watch the live stream of your [Canary
Once you have [Canary integration](/integrations/canary/) setup, your [Canary](https://canary.is) camera(s) should show up automatically.
## Configuration
You can add the following to your `configuration.yaml` file to configure `canary` camera with optional settings:
```yaml
camera:
- platform: canary
```
{% configuration %}
ffmpeg_arguments:
description: Extra options to pass to `ffmpeg`, e.g., image quality or video filter options. More details in [FFmpeg integration](/integrations/ffmpeg).
required: false
type: string
{% endconfiguration %}
## Sensor
The `canary` sensor platform allows you to integrate the sensors of your [Canary](https://canary.is) devices in Home Assistant.