From 0f16f812c8f301acc10186a1d2a2684cf22c2296 Mon Sep 17 00:00:00 2001 From: Klaas Schoute Date: Tue, 29 Jan 2019 01:07:58 +0100 Subject: [PATCH] =?UTF-8?q?=F0=9F=9A=9C=20Merges/Redirect=20Homematic=20co?= =?UTF-8?q?mponent=20pages=20(#8331)?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- .../binary_sensor.homematic.markdown | 18 --- source/_components/climate.homematic.markdown | 19 --- source/_components/cover.homematic.markdown | 19 --- source/_components/homematic.markdown | 131 +++++++++++++++++- source/_components/light.homematic.markdown | 19 --- source/_components/lock.homematic.markdown | 18 --- source/_components/notify.homematic.markdown | 111 --------------- source/_components/sensor.homematic.markdown | 19 --- source/_components/switch.homematic.markdown | 18 --- 9 files changed, 130 insertions(+), 242 deletions(-) delete mode 100644 source/_components/binary_sensor.homematic.markdown delete mode 100644 source/_components/climate.homematic.markdown delete mode 100644 source/_components/cover.homematic.markdown delete mode 100644 source/_components/light.homematic.markdown delete mode 100644 source/_components/lock.homematic.markdown delete mode 100644 source/_components/notify.homematic.markdown delete mode 100644 source/_components/sensor.homematic.markdown delete mode 100644 source/_components/switch.homematic.markdown diff --git a/source/_components/binary_sensor.homematic.markdown b/source/_components/binary_sensor.homematic.markdown deleted file mode 100644 index f237976a094..00000000000 --- a/source/_components/binary_sensor.homematic.markdown +++ /dev/null @@ -1,18 +0,0 @@ ---- -layout: page -title: "Homematic Binary Sensor" -description: "Instructions on how to integrate binary Homematic sensors within Home Assistant." -date: 2016-06-28 08:30 -sidebar: true -comments: false -sharing: true -footer: true -logo: homematic.png -ha_category: Binary Sensor -ha_release: 0.23 -ha_iot_class: "Local Push" ---- - -The `homematic` binary sensor platform lets you observe the state changes of binary [Homematic](http://www.homematic.com/) sensors through Home Assistant. - -Devices will be configured automatically. Please refer to the [component](/components/homematic/) configuration on how to setup Homematic. diff --git a/source/_components/climate.homematic.markdown b/source/_components/climate.homematic.markdown deleted file mode 100644 index 86e38fdb497..00000000000 --- a/source/_components/climate.homematic.markdown +++ /dev/null @@ -1,19 +0,0 @@ ---- -layout: page -title: "Homematic Thermostats" -description: "Instructions on how to integrate Homematic thermostats within Home Assistant." -date: 2016-06-28 08:30 -sidebar: true -comments: false -sharing: true -footer: true -logo: homematic.png -ha_category: Climate -ha_release: 0.23 -ha_iot_class: "Local Push" ---- - - -The `homematic` climate platform lets you control [Homematic](http://www.homematic.com/) thermostats through Home Assistant. - -Devices will be configured automatically. Please refer to the [component](/components/homematic/) configuration on how to setup Homematic. diff --git a/source/_components/cover.homematic.markdown b/source/_components/cover.homematic.markdown deleted file mode 100644 index e5f3a8930e2..00000000000 --- a/source/_components/cover.homematic.markdown +++ /dev/null @@ -1,19 +0,0 @@ ---- -layout: page -title: "Homematic Cover" -description: "Instructions on how to integrate Homematic covers within Home Assistant." -date: 2016-08-24 14:25 -sidebar: true -comments: false -sharing: true -footer: true -logo: homematic.png -ha_category: Cover -ha_release: 0.27 -ha_iot_class: "Local Push" ---- - - -The `homematic` cover platform lets you control [Homematic](http://www.homematic.com/) covers such as rollershutters through Home Assistant. - -Devices will be configured automatically. Please refer to the [component](/components/homematic/) configuration on how to setup Homematic. diff --git a/source/_components/homematic.markdown b/source/_components/homematic.markdown index d10b708a7e5..4588d1d5b8a 100644 --- a/source/_components/homematic.markdown +++ b/source/_components/homematic.markdown @@ -8,15 +8,44 @@ comments: false sharing: true footer: true logo: homematic.png -ha_category: Hub +ha_category: + - Hub + - Binary Sensor + - Climate + - Cover + - Light + - Lock + - Notify + - Sensor + - Switch ha_iot_class: "Local Push" ha_release: 0.23 featured: false +redirect_from: + - /components/binary_sensor.homematic/ + - /components/climate.homematic/ + - /components/cover.homematic/ + - /components/light.homematic/ + - /components/lock.homematic/ + - /components/notify.homematic/ + - /components/sensor.homematic/ + - /components/switch.homematic/ --- The [Homematic](http://www.homematic.com/) component provides bi-directional communication with your CCU/Homegear. It uses a XML-RPC connection to set values on devices and subscribes to receive events the devices and the CCU emit. If you are using Homegear with paired [Intertechno](http://intertechno.at/) devices, uni-directional communication is possible as well. +There is currently support for the following device types within Home Assistant: + +- Binary Sensor +- Climate +- Cover +- Light +- Lock +- Notify +- Sensor +- Switch + Device support is available for most of the wired and wireless devices, as well as a lot of IP devices. If you have a setup with mixed protocols, you have to configure additional [interfaces](/components/homematic#interfaces) with the appropriate ports. The default is using port 2001, which are wireless devices. Wired devices usually are available through port 2000 and IP devices through port 2010. The virtual thermostatgroups the CCU provides use port 9292 **and** require you to set the `path` setting to `/groups`. When using SSL on a CCU3, by default the same ports as usual with a prepended 4 are available. So 2001 becomes 42001, 2010 becomes 42010 etc.. If you want to see if a specific device you have is supported, head over to the [pyhomematic](https://github.com/danielperna84/pyhomematic/tree/master/pyhomematic/devicetypes) repository and browse through the source code. A dictionary with the device identifiers (e.g., HM-Sec-SC-2) can be found within the relevant modules near the bottom. If your device is not supported, feel free to contribute. @@ -413,3 +442,103 @@ When the connection to your HomeMatic CCU or Homegear is lost, Home Assistant wi action: service: homematic.reconnect ``` + +## {% linkable_title Notifications %} + +The `homematic` notification platform enables invoking Homematic devices. + +To use this notification platform in your installation, add the following to your `configuration.yaml` file: + +## {% linkable_title Configuration %} + +```yaml +# Example configuration.yaml entry +notify: + - name: my_hm + platform: homematic + address: NEQXXXXXXX + channel: 2 + param: "SUBMIT" + value: "1,1,108000,8" +``` + +{% configuration %} +address: + description: The address of your Homematic device. The address is the serial number of the device shown in the CCU in the `devices` section in the column `serial number`. + required: true + type: string +channel: + description: The channel of your Homematic device. + required: true + type: integer +param: + description: An additional parameter for the Homematic device. + required: true + type: string +interface: + description: Set the name of the interface from the config. + required: false + type: string +value: + description: This is the value that is set on the device. Its device specific. + required: true + type: string +{% endconfiguration %} + +### {% linkable_title Usage %} + +`homematic` is a notify platform and can be controlled by calling the notify service [as described here](/components/notify/). + +Only the `data` part of the event payload is processed. This part can specify or override the value given as configuration variable: + +```json +{ + "data": { + "address": "NEQXXXXXXX", + "channel": 2, + "param": "SUBMIT", + "value": "1,1,108000,8" + } +} +``` + +It is possible to provide a template in order to compute the value: + +{% raw %} +```json +{ + "data": { + "value": "1,1,108000{% if is_state('binary_sensor.oeqxxxxxxx_state', 'on') %},1{% endif %}{% if is_state('binary_sensor.oeqxxxxxxx_state', 'on') %},2{% endif %}" + } +} +``` +{% endraw %} + +You can also specify the event payload using a group notification (instead of specifying the value for the notify itself): + +{% raw %} +```yaml +notify: + - name: my_hm + platform: homematic + address: NEQXXXXXXX + - name: group_hm + platform: group + services: + - service: my_hm + data: + data: + value: "1,1,108000{% if is_state('binary_sensor.oeqxxxxxxx_state', 'on') %},1{% endif %}{% if is_state('binary_sensor.oeqxxxxxxx_state', 'on') %},2{% endif %}" + +alert: + temperature: + name: Temperature too high + done_message: Temperature OK + entity_id: binary_sensor.temperature_too_high + can_acknowledge: true + notifiers: + - group_hm +``` +{% endraw %} + +Please note that the first `data` element belongs to the service `my_hm`, while the second one belongs to the event payload. \ No newline at end of file diff --git a/source/_components/light.homematic.markdown b/source/_components/light.homematic.markdown deleted file mode 100644 index 86249ce98e0..00000000000 --- a/source/_components/light.homematic.markdown +++ /dev/null @@ -1,19 +0,0 @@ ---- -layout: page -title: "Homematic Light" -description: "Instructions on how to integrate Homematic lights within Home Assistant." -date: 2016-06-28 08:30 -sidebar: true -comments: false -sharing: true -footer: true -logo: homematic.png -ha_category: Light -ha_release: 0.23 -ha_iot_class: "Local Push" ---- - - -The `homematic` light platform lets you control [Homematic](http://www.homematic.com/) lights through Home Assistant. - -Devices will be configured automatically. Please refer to the [component](/components/homematic/) configuration on how to setup Homematic. \ No newline at end of file diff --git a/source/_components/lock.homematic.markdown b/source/_components/lock.homematic.markdown deleted file mode 100644 index d536312e2ea..00000000000 --- a/source/_components/lock.homematic.markdown +++ /dev/null @@ -1,18 +0,0 @@ ---- -layout: page -title: "Homematic Lock (KeyMatic)" -description: "Instructions how to integrate Homematic locks (KeyMatic) within Home Assistant." -date: 2018-01-28 03:00 -sidebar: true -comments: false -sharing: true -footer: true -logo: homematic.png -ha_category: Lock -ha_release: 0.66 -ha_iot_class: "Local Push" ---- - -The `homematic` lock platform lets you observe and control the state of the HomeMatic [Homematic](http://www.homematic.com/) KeyMatic lock through Home Assistant. - -Devices will be configured automatically. Please refer to the [component](/components/homematic/) configuration on how to setup Homematic. diff --git a/source/_components/notify.homematic.markdown b/source/_components/notify.homematic.markdown deleted file mode 100644 index 3f7cd5f64e0..00000000000 --- a/source/_components/notify.homematic.markdown +++ /dev/null @@ -1,111 +0,0 @@ ---- -layout: page -title: "Homematic Notifications" -description: "Instructions on how to notify Homematic devices." -date: 2018-10-03 11:44 -sidebar: true -comments: false -sharing: true -footer: true -logo: homematic.png -ha_category: Notifications -ha_release: 0.81 ---- - -The `homematic` notification platform enables invoking Homematic devices. - -To use this notification platform in your installation, add the following to your `configuration.yaml` file: - -## {% linkable_title Configuration %} - -```yaml -# Example configuration.yaml entry -notify: - - name: my_hm - platform: homematic - address: NEQXXXXXXX - channel: 2 - param: "SUBMIT" - value: "1,1,108000,8" -``` - -{% configuration %} -address: - description: The address of your Homematic device. The address is the serial number of the device shown in the CCU in the `devices` section in the column `serial number`. - required: true - type: string -channel: - description: The channel of your Homematic device. - required: true - type: integer -param: - description: An additional parameter for the Homematic device. - required: true - type: string -interface: - description: Set the name of the interface from the config. - required: false - type: string -value: - description: This is the value that is set on the device. Its device specific. - required: true - type: string -{% endconfiguration %} - -### {% linkable_title Usage %} - -`homematic` is a notify platform and can be controlled by calling the notify service [as described here](/components/notify/). - -Only the `data` part of the event payload is processed. This part can specify or override the value given as configuration variable: - -```json -{ - "data": { - "address": "NEQXXXXXXX", - "channel": 2, - "param": "SUBMIT", - "value": "1,1,108000,8" - } -} -``` - -It is possible to provide a template in order to compute the value: - -{% raw %} -```json -{ - "data": { - "value": "1,1,108000{% if is_state('binary_sensor.oeqxxxxxxx_state', 'on') %},1{% endif %}{% if is_state('binary_sensor.oeqxxxxxxx_state', 'on') %},2{% endif %}" - } -} -``` -{% endraw %} - -You can also specify the event payload using a group notification (instead of specifying the value for the notify itself): - -{% raw %} -```yaml -notify: - - name: my_hm - platform: homematic - address: NEQXXXXXXX - - name: group_hm - platform: group - services: - - service: my_hm - data: - data: - value: "1,1,108000{% if is_state('binary_sensor.oeqxxxxxxx_state', 'on') %},1{% endif %}{% if is_state('binary_sensor.oeqxxxxxxx_state', 'on') %},2{% endif %}" - -alert: - temperature: - name: Temperature too high - done_message: Temperature OK - entity_id: binary_sensor.temperature_too_high - can_acknowledge: true - notifiers: - - group_hm -``` -{% endraw %} - -Please note that the first `data` element belongs to the service `my_hm`, while the second one belongs to the event payload. diff --git a/source/_components/sensor.homematic.markdown b/source/_components/sensor.homematic.markdown deleted file mode 100644 index 005011cea61..00000000000 --- a/source/_components/sensor.homematic.markdown +++ /dev/null @@ -1,19 +0,0 @@ ---- -layout: page -title: "Homematic Sensor" -description: "Instructions on how to integrate Homematic sensors within Home Assistant." -date: 2016-06-28 08:30 -sidebar: true -comments: false -sharing: true -footer: true -logo: homematic.png -ha_category: Sensor -ha_release: 0.23 -ha_iot_class: "Local Push" ---- - - -The `homematic` sensor platform lets you observe the state of [Homematic](http://www.homematic.com/) sensors through Home Assistant. - -Devices will be configured automatically. Please refer to the [component](/components/homematic/) configuration on how to setup Homematic. \ No newline at end of file diff --git a/source/_components/switch.homematic.markdown b/source/_components/switch.homematic.markdown deleted file mode 100644 index ceaa29fc9e6..00000000000 --- a/source/_components/switch.homematic.markdown +++ /dev/null @@ -1,18 +0,0 @@ ---- -layout: page -title: "Homematic Switch" -description: "Instructions on how to integrate Homematic switches within Home Assistant." -date: 2016-06-28 08:30 -sidebar: true -comments: false -sharing: true -footer: true -logo: homematic.png -ha_category: Switch -ha_release: 0.23 -ha_iot_class: "Local Push" ---- - -The `homematic` switch platform lets you control [Homematic](http://www.homematic.com/) switches through Home Assistant. - -Devices will be configured automatically. Please refer to the [component](/components/homematic/) configuration on how to setup Homematic. \ No newline at end of file