From d1bcfebe34746a2baad3046dca34535cbbe7f964 Mon Sep 17 00:00:00 2001 From: Klaas Schoute Date: Wed, 13 Feb 2019 20:01:10 +0100 Subject: [PATCH] =?UTF-8?q?=F0=9F=9A=9C=20Merges/Redirect=20Canary=20compo?= =?UTF-8?q?nent=20pages=20(#8552)?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit * 🚜 Merges/Redirect Canary component pages * :pencil2: Remove hub category --- .../alarm_control_panel.canary.markdown | 18 ------ source/_components/camera.canary.markdown | 34 ----------- source/_components/canary.markdown | 59 +++++++++++++++++-- source/_components/sensor.canary.markdown | 24 -------- 4 files changed, 53 insertions(+), 82 deletions(-) delete mode 100644 source/_components/alarm_control_panel.canary.markdown delete mode 100644 source/_components/camera.canary.markdown delete mode 100644 source/_components/sensor.canary.markdown diff --git a/source/_components/alarm_control_panel.canary.markdown b/source/_components/alarm_control_panel.canary.markdown deleted file mode 100644 index 59125f8746a..00000000000 --- a/source/_components/alarm_control_panel.canary.markdown +++ /dev/null @@ -1,18 +0,0 @@ ---- -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/). diff --git a/source/_components/camera.canary.markdown b/source/_components/camera.canary.markdown deleted file mode 100644 index 6d46258424b..00000000000 --- a/source/_components/camera.canary.markdown +++ /dev/null @@ -1,34 +0,0 @@ ---- -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 watch the live stream of your [Canary](https://canary.is) camera in Home Assistant. This requires the [`ffmpeg` component](/components/ffmpeg/) to be already configured. - -To add `canary` camera to your installation, follow instructions in [Canary component](/components/canary/). Once you have [Canary component](/components/canary/) setup, your [Canary](https://canary.is) 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: - -```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 component](/components/ffmpeg). - required: false - type: string -{% endconfiguration %} diff --git a/source/_components/canary.markdown b/source/_components/canary.markdown index 8f43c61d53b..833302fe223 100644 --- a/source/_components/canary.markdown +++ b/source/_components/canary.markdown @@ -8,13 +8,26 @@ comments: false sharing: true footer: true logo: canary.png -ha_category: Hub +ha_category: + - Alarm + - Camera + - Sensor ha_release: "0.60" ha_iot_class: "Cloud Polling" +redirect_from: + - /components/alarm_control_panel.canary/ + - /components/camera.canary/ + - /components/sensor.canary/ --- The `canary` component allows you to integrate your [Canary](https://canary.is) devices in Home Assistant. +There is currently support for the following device types within Home Assistant: + +- Alarm +- [Camera](#camera) +- [Sensor](#sensor) + ## {% linkable_title Configuration %} You will need your Canary login information (username, usually your email address, and password) to use this module. @@ -46,8 +59,42 @@ timeout: 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. +- 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](https://canary.is) camera in Home Assistant. This requires the [`ffmpeg` component](/components/ffmpeg/) to be already configured. + +Once you have [Canary component](/components/canary/) setup, your [Canary](https://canary.is) 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: + +```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 component](/components/ffmpeg). + required: false + type: string +{% endconfiguration %} + +## {% linkable_title Sensor %} + +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 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. \ No newline at end of file diff --git a/source/_components/sensor.canary.markdown b/source/_components/sensor.canary.markdown deleted file mode 100644 index 79239f075bc..00000000000 --- a/source/_components/sensor.canary.markdown +++ /dev/null @@ -1,24 +0,0 @@ ---- -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: Environment -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.