mirror of
https://github.com/home-assistant/home-assistant.io.git
synced 2025-07-21 16:27:19 +00:00
Added documentation for Canary (#4162)
* Added documentation for Canary * Addresses PR comments * Addressed PR comments * Addressed PR comments
This commit is contained in:
parent
a757a34c40
commit
88851079c2
18
source/_components/alarm_control_panel.canary.markdown
Normal file
18
source/_components/alarm_control_panel.canary.markdown
Normal file
@ -0,0 +1,18 @@
|
||||
---
|
||||
layout: page
|
||||
title: "Canary Alarm Control Panel"
|
||||
description: "Instructions on how to integrate your Canary devices into Home Assistant."
|
||||
date: 2017-12-07 22:00
|
||||
sidebar: true
|
||||
comments: false
|
||||
sharing: true
|
||||
footer: true
|
||||
logo: canary.png
|
||||
ha_category: Alarm
|
||||
ha_release: "0.60"
|
||||
ha_iot_class: "Cloud Polling"
|
||||
---
|
||||
|
||||
The `canary` alarm control panel platform allows you to integrate your [Canary](https://canary.is) alarm system in Home Assistant.
|
||||
|
||||
To add `canary` alarm control panel to your installation, follow instructions in [Canary component](/components/canary/).
|
18
source/_components/camera.canary.markdown
Normal file
18
source/_components/camera.canary.markdown
Normal file
@ -0,0 +1,18 @@
|
||||
---
|
||||
layout: page
|
||||
title: "Canary Camera"
|
||||
description: "Instructions on how to integrate your Canary devices into Home Assistant."
|
||||
date: 2017-12-07 22:00
|
||||
sidebar: true
|
||||
comments: false
|
||||
sharing: true
|
||||
footer: true
|
||||
logo: canary.png
|
||||
ha_category: Camera
|
||||
ha_release: "0.60"
|
||||
ha_iot_class: "Cloud Polling"
|
||||
---
|
||||
|
||||
The `canary` camera platform allows you to view the latest camera image (triggered by motion) by your [Canary](https://canary.is) device in Home Assistant.
|
||||
|
||||
To add `canary` camera to your installation, follow instructions in [Canary component](/components/canary/).
|
53
source/_components/canary.markdown
Normal file
53
source/_components/canary.markdown
Normal file
@ -0,0 +1,53 @@
|
||||
---
|
||||
layout: page
|
||||
title: "Canary"
|
||||
description: "Instructions on how to integrate your Canary devices into Home Assistant."
|
||||
date: 2017-12-07 22:00
|
||||
sidebar: true
|
||||
comments: false
|
||||
sharing: true
|
||||
footer: true
|
||||
logo: canary.png
|
||||
ha_category: Hub
|
||||
ha_release: "0.60"
|
||||
ha_iot_class: "Cloud Polling"
|
||||
---
|
||||
|
||||
The `canary` component allows you to integrate your [Canary](https://canary.is) devices in 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: you@example.com
|
||||
password: secret
|
||||
```
|
||||
|
||||
{% 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: int
|
||||
default: 10
|
||||
{% endconfiguration %}
|
||||
|
||||
|
||||
|
||||
Once loaded, your front end will have the following components:
|
||||
|
||||
* A camera image triggered by motion for each camera.
|
||||
* An alarm control panel for each location.
|
||||
* A sensor per camera that reports temperature.
|
||||
* A sensor per camera that reports humidity.
|
||||
* A sensor per camera that reports air quality.
|
24
source/_components/sensor.canary.markdown
Normal file
24
source/_components/sensor.canary.markdown
Normal file
@ -0,0 +1,24 @@
|
||||
---
|
||||
layout: page
|
||||
title: "Canary Sensor"
|
||||
description: "Instructions on how to integrate your Canary devices into Home Assistant."
|
||||
date: 2017-12-07 22:00
|
||||
sidebar: true
|
||||
comments: false
|
||||
sharing: true
|
||||
footer: true
|
||||
logo: canary.png
|
||||
ha_category: Sensor
|
||||
ha_release: "0.60"
|
||||
ha_iot_class: "Cloud Polling"
|
||||
---
|
||||
|
||||
The `canary` sensor platform allows you to integrate the sensors of your [Canary](https://canary.is) devices in Home Assistant.
|
||||
|
||||
To add `canary` sensors to your installation, follow instructions in [Canary component](/components/canary/).
|
||||
|
||||
Once loaded, you will see following sensors:
|
||||
|
||||
* A sensor per camera that reports temperature.
|
||||
* A sensor per camera that reports humidity.
|
||||
* A sensor per camera that reports air quality.
|
BIN
source/images/supported_brands/canary.png
Normal file
BIN
source/images/supported_brands/canary.png
Normal file
Binary file not shown.
After Width: | Height: | Size: 11 KiB |
Loading…
x
Reference in New Issue
Block a user