home-assistant.io/source/_components/canary.markdown

layout, title, description, date, sidebar, comments, sharing, footer, logo, ha_category, ha_release, ha_iot_class, redirect_from

layout	title	description	date	sidebar	comments	sharing	footer	logo	ha_category	ha_release	ha_iot_class	redirect_from
page	Canary	Instructions on how to integrate your Canary devices into Home Assistant.	2017-12-07 22:00	true	false	true	true	canary.png	Alarm Camera Sensor	0.60	Cloud Polling	/components/alarm_control_panel.canary/ /components/camera.canary/ /components/sensor.canary/

The canary component allows you to integrate your Canary devices in Home Assistant.

There is currently support for the following device types within Home Assistant:

• Alarm
• Camera
• Sensor

{% linkable_title Configuration %}

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:

# 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 %}

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.

{% linkable_title Camera %}

The canary camera platform allows you to watch the live stream of your Canary camera in Home Assistant. This requires the ffmpeg component to be already configured.

Once you have Canary component setup, your Canary camera(s) should show up automatically.

{% linkable_title Configuration %}

You can add the following to your configuration.yaml file to configure canary camera with optional settings:

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 component. required: false type: string {% endconfiguration %}

{% linkable_title Sensor %}

The canary sensor platform allows you to integrate the sensors of your Canary devices in Home Assistant.

To add canary sensors to your installation, follow instructions above.

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.