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:

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 Variables

username

(string)(Required)The username for accessing your Canary account.

password

(string)(Required)The password for accessing your Canary account.

timeout

(integer)(Optional)Timeout to wait for connections.

Default value: 10

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.

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.

Configuration

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

camera:
  - platform: canary

Configuration Variables

ffmpeg_arguments

(string)(Optional)Extra options to pass to ffmpeg, e.g., image quality or video filter options. More details in FFmpeg component.

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.