From 9c6f47c144b2b6e84febeb1ffd1bf9cae57df865 Mon Sep 17 00:00:00 2001 From: Klaas Schoute Date: Wed, 13 Feb 2019 13:27:39 +0100 Subject: [PATCH] =?UTF-8?q?=F0=9F=9A=9C=20Merges/Redirect=20Deconz=20compo?= =?UTF-8?q?nent=20pages=20(#8538)?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- .../_components/binary_sensor.deconz.markdown | 35 ---- source/_components/cover.deconz.markdown | 27 --- source/_components/deconz.markdown | 170 +++++++++++++++++- source/_components/light.deconz.markdown | 31 ---- source/_components/scene.deconz.markdown | 18 -- source/_components/sensor.deconz.markdown | 70 -------- source/_components/switch.deconz.markdown | 28 --- 7 files changed, 165 insertions(+), 214 deletions(-) delete mode 100644 source/_components/binary_sensor.deconz.markdown delete mode 100644 source/_components/cover.deconz.markdown delete mode 100644 source/_components/light.deconz.markdown delete mode 100644 source/_components/scene.deconz.markdown delete mode 100644 source/_components/sensor.deconz.markdown delete mode 100644 source/_components/switch.deconz.markdown diff --git a/source/_components/binary_sensor.deconz.markdown b/source/_components/binary_sensor.deconz.markdown deleted file mode 100644 index 609eff3157a..00000000000 --- a/source/_components/binary_sensor.deconz.markdown +++ /dev/null @@ -1,35 +0,0 @@ ---- -layout: page -title: "deCONZ Binary Sensor" -description: "Instructions on how to integrate Zigbee binary sensors from deCONZ into Home Assistant." -date: 2017-11-12 16:30 -sidebar: true -comments: false -sharing: true -footer: true -logo: deconz.jpeg -ha_category: Binary Sensor -ha_release: "0.61" -ha_iot_class: "Local Push" ---- - -See the [deCONZ main component](/components/deconz/) for configuration instructions. - -The following sensor types are supported: - - * Fire/Smoke detection - * Open/Close detection - * Presence detection - * Water leakage detection - -The `entity_id` name will be `binary_sensor.device_name`, where `device_name` is defined in deCONZ. - -#### {% linkable_title Verified supported binary sensors %} - -- Open/Close Detection - - Xiaomi Smart Home Security Door & Window Contact Sensor -- Presence Detection - - IKEA Trådfri Motion Sensor - - Philips Hue Motion Sensor - - Xiaomi Motion Sensor - - Xiaomi Smart Home Aqara Human Body Sensor diff --git a/source/_components/cover.deconz.markdown b/source/_components/cover.deconz.markdown deleted file mode 100644 index 5f2e3999fc5..00000000000 --- a/source/_components/cover.deconz.markdown +++ /dev/null @@ -1,27 +0,0 @@ ---- -layout: page -title: "deCONZ Covers" -description: "Instructions on how to integrate Zigbee covers from deCONZ into Home Assistant." -date: 2018-09-20 23:32 -sidebar: true -comments: false -sharing: true -footer: true -logo: deconz.jpeg -ha_category: Cover -ha_release: "0.79" -ha_iot_class: "Local Push" ---- - -See the [deCONZ main component](/components/deconz/) for configuration instructions. - -Covers are devices like ventilation dampers or smart window covers. - -Note that devices in the cover platform identify as lights, so there is a manually curated list that defines which "lights" are covers. - -The `entity_id` name will be `cover.device_name`, where `device_name` is defined in deCONZ. - -#### {% linkable_title Verified supported covers %} - -- Keen vents -- Xiaomi Aqara Curtain controller diff --git a/source/_components/deconz.markdown b/source/_components/deconz.markdown index e665590ff74..e9f3819c529 100644 --- a/source/_components/deconz.markdown +++ b/source/_components/deconz.markdown @@ -8,17 +8,40 @@ comments: false sharing: true footer: true logo: deconz.jpeg -ha_category: Hub +ha_category: + - Hub + - Binary Sensor + - Cover + - Light + - Scene + - Sensor + - Switch ha_release: "0.61" ha_iot_class: "Local Push" ha_qa_scale: platinum +redirect_from: + - /components/binary_sensor.deconz/ + - /components/cover.deconz/ + - /components/light.deconz/ + - /components/scene.deconz/ + - /components/sensor.deconz/ + - /components/switch.deconz/ --- [deCONZ](https://www.dresden-elektronik.de/funktechnik/products/software/pc/deconz/) by [Dresden Elektronik](https://www.dresden-elektronik.de) is a software that communicates with Conbee/Raspbee Zigbee gateways and exposes Zigbee devices that are connected to the gateway. [deCONZ REST API](http://dresden-elektronik.github.io/deconz-rest-doc/). -### {% linkable_title Recommended way of running deCONZ %} +There is currently support for the following device types within Home Assistant: + +- [Binary Sensor](/components/deconz/#binary-sensor) +- [Cover](/components/deconz/#cover) +- [Light](/components/deconz/#light) +- [Scene](/components/deconz/#scene) +- [Sensor](/components/deconz/#sensor) +- [Switch](/components/deconz/#switch) + +## {% linkable_title Recommended way of running deCONZ %} Use [community container](https://hub.docker.com/r/marthoc/deconz/) by Marthoc for your deCONZ needs. It works both as a standalone container as well as with HASS.io. @@ -50,7 +73,7 @@ logger: Available services: `configure` and `deconz.refresh_devices`. -#### {% linkable_title Service `deconz.configure` %} +### {% linkable_title Service `deconz.configure` %} Set attribute of device in deCONZ using [Rest API](http://dresden-elektronik.github.io/deconz-rest-doc/rest/). @@ -97,9 +120,10 @@ For the IKEA Tradfri remote the first digit equals, 1 for the middle button, 2 f ### {% linkable_title YAML %} -#### {% linkable_title Step up and step down input number with wireless dimmer %} +#### {% linkable_title Step up and step down input number with wireless dimmer %} {% raw %} + ```yaml automation: - alias: 'Toggle lamp from dimmer' @@ -146,15 +170,18 @@ automation: {% set bri = states.light.lamp.attributes.brightness | int %} {{ [bri-30, 0] | max }} ``` + {% endraw %} ### {% linkable_title Appdaemon %} #### {% linkable_title Appdaemon event helper %} + Helper app that creates a sensor `sensor.deconz_event` with a state that represents the id from the last event and an attribute to show the event data. Put this in `apps.yaml`: {% raw %} + ```yaml deconz_helper: module: deconz_helper @@ -162,6 +189,7 @@ deconz_helper: ``` Put this in `deconz_helper.py`: + ```python import appdaemon.plugins.hass.hassapi as hass import datetime @@ -179,6 +207,7 @@ class DeconzHelper(hass.Hass): self.log("Deconz event received from {}. Event was: {}".format(event_id, event_data)) self.set_state("sensor.deconz_event", state = event_id, attributes = {"event_data": event_data, "event_received": str(event_received)}) ``` + {% endraw %} Note: the event will not be visible before one event gets sent. @@ -186,6 +215,7 @@ Note: the event will not be visible before one event gets sent. #### {% linkable_title Appdaemon remote template %} {% raw %} + ```yaml remote_control: module: remote_control @@ -215,6 +245,7 @@ class RemoteControl(hass.Hass): elif data['event'] == 4002: self.log('Button off') ``` + {% endraw %} #### {% linkable_title Appdaemon remote template %} @@ -222,6 +253,7 @@ class RemoteControl(hass.Hass): Community app from [Teachingbirds](https://community.home-assistant.io/u/teachingbirds/summary). This app uses an Ikea Tradfri remote to control Sonos speakers with play/pause, volume up and down, next and previous track. {% raw %} + ```yaml sonos_remote_control: module: sonos_remote @@ -230,9 +262,11 @@ sonos_remote_control: id: sonos_remote sonos: media_player.sonos ``` + {% endraw %} {% raw %} + ```python import appdaemon.plugins.hass.hassapi as hass @@ -259,10 +293,136 @@ class SonosRemote(hass.Hass): elif data['event'] == 4002: self.log('Button previous') - self.call_service("media_player/media_previous_track", entity_id = self.sonos) + self.call_service("media_player/media_previous_track", entity_id = self.sonos) elif data['event'] == 5002: self.log('Button next') self.call_service("media_player/media_next_track", entity_id = self.sonos) ``` + {% endraw %} + +## {% linkable_title Binary Sensor %} + +The following sensor types are supported: + +- Fire/Smoke detection +- Open/Close detection +- Presence detection +- Water leakage detection + +The `entity_id` name will be `binary_sensor.device_name`, where `device_name` is defined in deCONZ. + +### {% linkable_title Verified supported binary sensors %} + +- Open/Close Detection + - Xiaomi Smart Home Security Door & Window Contact Sensor +- Presence Detection + - IKEA Trådfri Motion Sensor + - Philips Hue Motion Sensor + - Xiaomi Motion Sensor + - Xiaomi Smart Home Aqara Human Body Sensor + +## {% linkable_title Cover %} + +Covers are devices like ventilation dampers or smart window covers. + +Note that devices in the cover platform identify as lights, so there is a manually curated list that defines which "lights" are covers. + +The `entity_id` name will be `cover.device_name`, where `device_name` is defined in deCONZ. + +### {% linkable_title Verified supported covers %} + +- Keen vents +- Xiaomi Aqara Curtain controller + +## {% linkable_title Light %} + +The `entity_id` names will be `light.device_name`, where `device_name` is defined in deCONZ. Light groups created in deCONZ will be created in Home Assistant as lights named `light.group_name_in_deconz`, allowing the user to control groups of lights with only a single API call to deCONZ. + +### {% linkable_title Verified supported lights %} + +- IKEA Trådfri bulb E14 WS opal 400lm +- IKEA Trådfri Bulb E27 WS Opal 980lm +- IKEA Trådfri Bulb E27 WS Opal 1000lm +- IKEA Trådfri Bulb GU10 W 400lm +- OSRAM Flex RGBW +- OSRAM Gardenpole RGBW +- Philips Hue White A19 +- Philips Hue White Ambiance A19 +- Philips Hue Hue White ambiance Milliskin (recessed spotlight) LTW013 +- Busch Jaeger ZigBee Light Link univ. relai (6711 U) with ZigBee Light Link control element 6735-84 + +## {% linkable_title Scene %} + +The `entity_id` name will be `scene.group_scene_name`, where `group` is which group the scene belongs to and the name of the scene, both group and name are defined in deCONZ. + +## {% linkable_title Sensor %} + +The following sensor types are supported: + +- Humidity sensor +- Light level sensor +- Pressure sensor +- Switches +- Temperature sensor + +The `entity_id` name will be `sensor.device_name`, where `device_name` is defined in deCONZ. Switches aren't exposed as ordinary entities, see the [deCONZ main component](/components/deconz/) for more details. + +### {% linkable_title Verified to be supported sensors %} + +- Humidity Sensor + - Xiaomi Aqara Humidity/Temperature Sensor + - Xiaomi MiJia Smart Temperature & Humidity Sensor +- Light Level Sensor +- Pressure Sensor +- Switches + - IKEA Trådfri Wireless Dimmer + - Philips Hue Motion Sensor + - IKEA Trådfri Remote + - Philips Hue Dimmer Switch + - Xiaomi Cube + - Xiaomi Aqara Smart Light Switch + - Xiaomi Aqara Smart Wireless Switch + - Xiaomi Smart Home Wireless Switch +- Temperature Sensor + - Xiaomi Temperature/Humidity Sensor + +### {% linkable_title deCONZ Daylight Sensor %} + +The deCONZ Daylight sensor is a special sensor built into the deCONZ software since version 2.05.12. It is represented in Home Assistant as a sensor called sensor.daylight. The sensor's state value is a string corresponding to the phase of daylight (descriptions below taken from https://github.com/mourner/suncalc, on which the deCONZ implementation is based): + +| Sensor State | Description | +|--------------|-------------| +| sunrise_start | sunrise (top edge of the sun appears on the horizon) | +| sunrise_end | sunrise ends (bottom edge of the sun touches the horizon) | +| golden_hour_1 | morning golden hour (soft light, the best time for photography) | +| solar_noon | solar noon (sun is in the highest position) | +| golden_hour_2 | evening golden hour | +| sunset_start | sunset starts (bottom edge of the sun touches the horizon) | +| sunset_end | sunset (sun disappears below the horizon, evening civil twilight starts) | +| dusk | dusk (evening nautical twilight starts) | +| nautical_dusk | nautical dusk (evening astronomical twilight starts) | +| night_start | night starts (dark enough for astronomical observations) | +| nadir | nadir (darkest moment of the night, the sun is in the lowest position) | +| night_end | night ends (morning astronomical twilight starts) | +| nautical_dawn | nautical dawn (morning nautical twilight starts) | +| dawn | dawn (morning nautical twilight ends, morning civil twilight starts) | + +The sensor also has an attribute called "daylight" that has the value `true` when the sensor's state is `golden_hour_1`, `solar_noon`, or `golden_hour_2`, and `false` otherwise. + +These states can be used in automations as a trigger (e.g., trigger when a certain phase of daylight starts or ends) or condition (e.g., trigger only if in a certain phase of daylight). + +## {% linkable_title Switch %} + +Switches are devices like power plugs and sirens. + +Note that devices in the switch platform identify as lights, so there is a manually curated list that defines which "lights" are switches. + +The `entity_id` name will be `switch.device_name`, where `device_name` is defined in deCONZ. + +### {% linkable_title Verified supported switches %} + +- Innr SP120 +- Osram Outdoor plug +- Heiman siren diff --git a/source/_components/light.deconz.markdown b/source/_components/light.deconz.markdown deleted file mode 100644 index f8949b0432b..00000000000 --- a/source/_components/light.deconz.markdown +++ /dev/null @@ -1,31 +0,0 @@ ---- -layout: page -title: "deCONZ Lights" -description: "Instructions on how to integrate Zigbee lights from deCONZ into Home Assistant." -date: 2017-11-12 16:30 -sidebar: true -comments: false -sharing: true -footer: true -logo: deconz.jpeg -ha_category: Light -ha_release: "0.61" -ha_iot_class: "Local Push" ---- - -See the [deCONZ main component](/components/deconz/) for configuration instructions. - -The `entity_id` names will be `light.device_name`, where `device_name` is defined in deCONZ. Light groups created in deCONZ will be created in Home Assistant as lights named `light.group_name_in_deconz`, allowing the user to control groups of lights with only a single API call to deCONZ. - -#### {% linkable_title Verified supported lights %} - -- IKEA Trådfri bulb E14 WS opal 400lm -- IKEA Trådfri Bulb E27 WS Opal 980lm -- IKEA Trådfri Bulb E27 WS Opal 1000lm -- IKEA Trådfri Bulb GU10 W 400lm -- OSRAM Flex RGBW -- OSRAM Gardenpole RGBW -- Philips Hue White A19 -- Philips Hue White Ambiance A19 -- Philips Hue Hue White ambiance Milliskin (recessed spotlight) LTW013 -- Busch Jaeger ZigBee Light Link univ. relai (6711 U) with ZigBee Light Link control element 6735-84 diff --git a/source/_components/scene.deconz.markdown b/source/_components/scene.deconz.markdown deleted file mode 100644 index 9c5038c3485..00000000000 --- a/source/_components/scene.deconz.markdown +++ /dev/null @@ -1,18 +0,0 @@ ---- -layout: page -title: "deCONZ Scenes" -description: "Instructions on how to integrate deCONZ scenes into Home Assistant." -date: 2017-11-19 20:00 -sidebar: true -comments: false -sharing: true -footer: true -logo: deconz.jpeg -ha_category: Scene -ha_release: "0.61" -ha_iot_class: "Local Push" ---- - -See the [deCONZ main component](/components/deconz/) for configuration instructions. - -The `entity_id` name will be `scene.group_scene_name`, where `group` is which group the scene belongs to and the name of the scene, both group and name are defined in deCONZ. diff --git a/source/_components/sensor.deconz.markdown b/source/_components/sensor.deconz.markdown deleted file mode 100644 index 7dd29e19035..00000000000 --- a/source/_components/sensor.deconz.markdown +++ /dev/null @@ -1,70 +0,0 @@ ---- -layout: page -title: deCONZ Sensor -description: "Instructions on how to integrate Zigbee sensors from deCONZ into Home Assistant." -date: 2017-11-12 16:30 -sidebar: true -comments: false -sharing: true -footer: true -logo: deconz.jpeg -ha_category: Sensor -ha_release: "0.61" -ha_iot_class: "Local Push" ---- - -See the [deCONZ main component](/components/deconz/) for configuration instructions. - -The following sensor types are supported: - - * Humidity sensor - * Light level sensor - * Pressure sensor - * Switches - * Temperature sensor - -The `entity_id` name will be `sensor.device_name`, where `device_name` is defined in deCONZ. Switches aren't exposed as ordinary entities, see the [deCONZ main component](/components/deconz/) for more details. - -#### {% linkable_title Verified to be supported sensors %} - -- Humidity Sensor - - Xiaomi Aqara Humidity/Temperature Sensor - - Xiaomi MiJia Smart Temperature & Humidity Sensor -- Light Level Sensor -- Pressure Sensor -- Switches - - IKEA Trådfri Wireless Dimmer - - Philips Hue Motion Sensor - - IKEA Trådfri Remote - - Philips Hue Dimmer Switch - - Xiaomi Cube - - Xiaomi Aqara Smart Light Switch - - Xiaomi Aqara Smart Wireless Switch - - Xiaomi Smart Home Wireless Switch -- Temperature Sensor - - Xiaomi Temperature/Humidity Sensor - -#### {% linkable_title deCONZ Daylight Sensor %} - -The deCONZ Daylight sensor is a special sensor built into the deCONZ software since version 2.05.12. It is represented in Home Assistant as a sensor called sensor.daylight. The sensor's state value is a string corresponding to the phase of daylight (descriptions below taken from https://github.com/mourner/suncalc, on which the deCONZ implementation is based): - -| Sensor State | Description | -|--------------|-------------| -| sunrise_start | sunrise (top edge of the sun appears on the horizon) | -| sunrise_end | sunrise ends (bottom edge of the sun touches the horizon) | -| golden_hour_1 | morning golden hour (soft light, the best time for photography) | -| solar_noon | solar noon (sun is in the highest position) | -| golden_hour_2 | evening golden hour | -| sunset_start | sunset starts (bottom edge of the sun touches the horizon) | -| sunset_end | sunset (sun disappears below the horizon, evening civil twilight starts) | -| dusk | dusk (evening nautical twilight starts) | -| nautical_dusk | nautical dusk (evening astronomical twilight starts) | -| night_start | night starts (dark enough for astronomical observations) | -| nadir | nadir (darkest moment of the night, the sun is in the lowest position) | -| night_end | night ends (morning astronomical twilight starts) | -| nautical_dawn | nautical dawn (morning nautical twilight starts) | -| dawn | dawn (morning nautical twilight ends, morning civil twilight starts) | - -The sensor also has an attribute called "daylight" that has the value `true` when the sensor's state is `golden_hour_1`, `solar_noon`, or `golden_hour_2`, and `false` otherwise. - -These states can be used in automations as a trigger (e.g., trigger when a certain phase of daylight starts or ends) or condition (e.g., trigger only if in a certain phase of daylight). diff --git a/source/_components/switch.deconz.markdown b/source/_components/switch.deconz.markdown deleted file mode 100644 index 4a251b9fcb9..00000000000 --- a/source/_components/switch.deconz.markdown +++ /dev/null @@ -1,28 +0,0 @@ ---- -layout: page -title: "deCONZ Switches" -description: "Instructions on how to integrate Zigbee switches from deCONZ into Home Assistant." -date: 2018-07-31 23:32 -sidebar: true -comments: false -sharing: true -footer: true -logo: deconz.jpeg -ha_category: Switch -ha_release: "0.76" -ha_iot_class: "Local Push" ---- - -See the [deCONZ main component](/components/deconz/) for configuration instructions. - -Switches are devices like power plugs and sirens. - -Note that devices in the switch platform identify as lights, so there is a manually curated list that defines which "lights" are switches. - -The `entity_id` name will be `switch.device_name`, where `device_name` is defined in deCONZ. - -#### {% linkable_title Verified supported switches %} - -- Innr SP120 -- Osram Outdoor plug -- Heiman siren