From d5095bf32026c42c83f8525dd37cdb0aec5e5525 Mon Sep 17 00:00:00 2001 From: Klaas Schoute Date: Mon, 28 Jan 2019 19:04:27 +0100 Subject: [PATCH 01/13] =?UTF-8?q?=F0=9F=9A=9C=20Merges/Redirect=20Neato=20?= =?UTF-8?q?component=20pages=20(#8328)?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- source/_components/camera.neato.markdown | 18 ----------- source/_components/neato.markdown | 39 +++++++++++++++++++++++- source/_components/switch.neato.markdown | 17 ----------- source/_components/vacuum.neato.markdown | 35 --------------------- 4 files changed, 38 insertions(+), 71 deletions(-) delete mode 100644 source/_components/camera.neato.markdown delete mode 100644 source/_components/switch.neato.markdown delete mode 100644 source/_components/vacuum.neato.markdown diff --git a/source/_components/camera.neato.markdown b/source/_components/camera.neato.markdown deleted file mode 100644 index 4027e94fd24..00000000000 --- a/source/_components/camera.neato.markdown +++ /dev/null @@ -1,18 +0,0 @@ ---- -layout: page -title: "Neato Camera" -description: "Instructions on how to setup the Neato cleaning maps within Home Assistant." -date: 2017-04-05 13:10 -sidebar: true -comments: false -sharing: true -footer: true -logo: neato.png -ha_category: Camera -ha_release: 0.42 -ha_iot_class: "Cloud Polling" ---- - -The `neato` camera platform allows you to view the latest cleaning map of your [Neato Botvac Connected](https://www.neatorobotics.com/robot-vacuum/botvac-connected-series/botvac-connected/). - -To add `neato` camera to your installation, follow instructions in [Neato component](/components/neato/). diff --git a/source/_components/neato.markdown b/source/_components/neato.markdown index 43aca42701f..6d17e1ccdea 100644 --- a/source/_components/neato.markdown +++ b/source/_components/neato.markdown @@ -8,8 +8,15 @@ comments: false sharing: true footer: true logo: neato.png -ha_category: Hub +ha_category: + - Camera + - Switch + - Vacuum ha_release: 0.33 +redirect_from: + - /components/camera.neato/ + - /components/switch.neato/ + - /components/vacuum.neato/ --- The `neato` component allows you to control your [Neato Botvac Connected Robots](https://www.neatorobotics.com/robot-vacuum/botvac-connected-series/). @@ -37,3 +44,33 @@ password:

After the update to firmware 4.0 (which adds cleaning maps) there is also support for displaying the maps of the Botvac D3 Connected and Botvac D5 Connected robots. More information on how to update can be found [here](https://support.neatorobotics.com/hc/en-us/articles/115004320694-Software-Update-4-0-for-Neato-Botvac-Connected-D3-D5-).

+ +## {% linkable_title Vacuum %} + +The `neato` vacuum platform allows you to control your [Neato Botvac Connected](https://www.neatorobotics.com/robot-vacuum/botvac-connected-series/). +The status will contain attributes on the robots last clean session. + +

+If you notice the robot stops responding to commands check the state to see if the robot is "unavailable". If you see "unavailable" first try to restart the vacuum and wait about 5 minutes to see if it is no longer "unavailable". If you are still having issues check the Neato app and make sure your robot is connected and working. If it is not then follow the steps in the app to reset your robot and give it the same name as before then restart Home Assistant. +

+ +### {% linkable_title Configuration %} + +Currently supported services are: + +- `start` +- `pause` +- `stop` +- `return_to_base` +- `locate` +- `spot_clean` + +## {% linkable_title Camera %} + +The `neato` camera platform allows you to view the latest cleaning map of your [Neato Botvac Connected](https://www.neatorobotics.com/robot-vacuum/botvac-connected-series/botvac-connected/). + +## {% linkable_title Switch %} + +The `neato` switch platform allows you to enable or disable the schedule of your [Neato Botvac Connected](https://www.neatorobotics.com/robot-vacuum/botvac-connected-series/botvac-connected/). + +To add `neato` switch, camera and vacuum to your installation, follow instructions above. \ No newline at end of file diff --git a/source/_components/switch.neato.markdown b/source/_components/switch.neato.markdown deleted file mode 100644 index 2f0e1e8d1ee..00000000000 --- a/source/_components/switch.neato.markdown +++ /dev/null @@ -1,17 +0,0 @@ ---- -layout: page -title: "Neato Robotics Switch" -description: "Instructions on how to integrate a Neato Botvac Connected switch within Home Assistant." -date: 2016-10-19 17:10 -sidebar: true -comments: false -sharing: true -footer: true -logo: neato.png -ha_category: Switch -ha_release: 0.31 ---- - -The `neato` switch platform allows you to enable or disable the schedule of your [Neato Botvac Connected](https://www.neatorobotics.com/robot-vacuum/botvac-connected-series/botvac-connected/). - -To add `neato` switch to your installation, follow instructions in [Neato component](/components/neato/). diff --git a/source/_components/vacuum.neato.markdown b/source/_components/vacuum.neato.markdown deleted file mode 100644 index 3b38389171b..00000000000 --- a/source/_components/vacuum.neato.markdown +++ /dev/null @@ -1,35 +0,0 @@ ---- -layout: page -title: "Neato Robotics Vacuum" -description: "Instructions on how to integrate a Neato Botvac Connected Vacuum within Home Assistant." -date: 2017-10-18 16:11 -sidebar: true -comments: false -sharing: true -footer: true -logo: neato.png -ha_category: Vacuum -ha_release: 0.57 -ha_iot_class: "Cloud Polling" -redirect_from: /components/sensor.neato/ ---- - -The `neato` vacuum platform allows you to control your [Neato Botvac Connected](https://www.neatorobotics.com/robot-vacuum/botvac-connected-series/). -The status will contain attributes on the robots last clean session. - -

-If you notice the robot stops responding to commands check the state to see if the robot is "unavailable". If you see "unavailable" first try to restart the vacuum and wait about 5 minutes to see if it is no longer "unavailable". If you are still having issues check the Neato app and make sure your robot is connected and working. If it is not then follow the steps in the app to reset your robot and give it the same name as before then restart Home Assistant. -

- -## {% linkable_title Configuration %} - -To add `neato` vacuum to your installation, please follow instructions in [Neato component](/components/neato/). - -Currently supported services are: - -- `start` -- `pause` -- `stop` -- `return_to_base` -- `locate` -- `spot_clean` From c0b54fb0178cde72fb7fffc60160e5fba2b6112f Mon Sep 17 00:00:00 2001 From: Pieter Ennes Date: Tue, 29 Jan 2019 02:07:05 +0200 Subject: [PATCH 02/13] Needs libffi-dev to compile on Debian 9.7. (#8330) --- source/_docs/installation/raspberry-pi.markdown | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/source/_docs/installation/raspberry-pi.markdown b/source/_docs/installation/raspberry-pi.markdown index 31af033f9d6..136c1ae2bb5 100644 --- a/source/_docs/installation/raspberry-pi.markdown +++ b/source/_docs/installation/raspberry-pi.markdown @@ -45,7 +45,7 @@ $ sudo apt-get upgrade -y Install the dependencies. ```bash -$ sudo apt-get install python3 python3-venv python3-pip +$ sudo apt-get install python3 python3-venv python3-pip libffi-dev ``` Add an account for Home Assistant called `homeassistant`. From 0f16f812c8f301acc10186a1d2a2684cf22c2296 Mon Sep 17 00:00:00 2001 From: Klaas Schoute Date: Tue, 29 Jan 2019 01:07:58 +0100 Subject: [PATCH 03/13] =?UTF-8?q?=F0=9F=9A=9C=20Merges/Redirect=20Homemati?= =?UTF-8?q?c=20component=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 From 9255332fbf849faa0f7678e28d93e18c89a38577 Mon Sep 17 00:00:00 2001 From: Klaas Schoute Date: Tue, 29 Jan 2019 02:27:33 +0100 Subject: [PATCH 04/13] =?UTF-8?q?=F0=9F=9A=9C=20Merges/Redirect=20Homekit?= =?UTF-8?q?=20controller=20component=20pages=20(#8333)?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- ..._control_panel.homekit_controller.markdown | 16 ---------- .../climate.homekit_controller.markdown | 16 ---------- .../cover.homekit_controller.markdown | 16 ---------- .../_components/homekit_controller.markdown | 30 ++++++++++++++----- .../light.homekit_controller.markdown | 16 ---------- .../lock.homekit_controller.markdown | 16 ---------- .../switch.homekit_controller.markdown | 16 ---------- 7 files changed, 23 insertions(+), 103 deletions(-) delete mode 100644 source/_components/alarm_control_panel.homekit_controller.markdown delete mode 100644 source/_components/climate.homekit_controller.markdown delete mode 100644 source/_components/cover.homekit_controller.markdown delete mode 100644 source/_components/light.homekit_controller.markdown delete mode 100644 source/_components/lock.homekit_controller.markdown delete mode 100644 source/_components/switch.homekit_controller.markdown diff --git a/source/_components/alarm_control_panel.homekit_controller.markdown b/source/_components/alarm_control_panel.homekit_controller.markdown deleted file mode 100644 index ae24f556192..00000000000 --- a/source/_components/alarm_control_panel.homekit_controller.markdown +++ /dev/null @@ -1,16 +0,0 @@ ---- -layout: page -title: "HomeKit Alarm Control Panel" -description: "Instructions how to setup HomeKit security systems within Home Assistant." -date: 2018-12-27 20:00 -sidebar: true -comments: false -sharing: true -footer: true -logo: apple-homekit.png -ha_category: Alarm Control Panel -ha_iot_class: "Local Polling" -ha_release: 0.86 ---- - -To get your HomeKit security system working with Home Assistant, follow the instructions for the general [HomeKit controller component](/components/homekit_controller/). diff --git a/source/_components/climate.homekit_controller.markdown b/source/_components/climate.homekit_controller.markdown deleted file mode 100644 index 8e0414cf551..00000000000 --- a/source/_components/climate.homekit_controller.markdown +++ /dev/null @@ -1,16 +0,0 @@ ---- -layout: page -title: "HomeKit Climate" -description: "Instructions how to setup HomeKit thermostats within Home Assistant." -date: 2018-06-19 20:00 -sidebar: true -comments: false -sharing: true -footer: true -logo: apple-homekit.png -ha_category: Climate -ha_iot_class: "Local Polling" -ha_release: 0.73 ---- - -To get your HomeKit thermostats and air conditioners working with Home Assistant, follow the instructions for the general [HomeKit controller component](/components/homekit_controller/). diff --git a/source/_components/cover.homekit_controller.markdown b/source/_components/cover.homekit_controller.markdown deleted file mode 100644 index d641ac746a9..00000000000 --- a/source/_components/cover.homekit_controller.markdown +++ /dev/null @@ -1,16 +0,0 @@ ---- -layout: page -title: "HomeKit Cover" -description: "Instructions how to setup HomeKit covers within Home Assistant." -date: 2019-1-8 5:30 -sidebar: true -comments: false -sharing: true -footer: true -logo: apple-homekit.png -ha_category: Cover -ha_iot_class: "Local Polling" -ha_release: 0.86 ---- - -To get your HomeKit garage door openers, windows, or window coverings working with Home Assistant, follow the instructions for the general [HomeKit controller component](/components/homekit_controller/). diff --git a/source/_components/homekit_controller.markdown b/source/_components/homekit_controller.markdown index 1992d84b1d8..b347b0873ae 100644 --- a/source/_components/homekit_controller.markdown +++ b/source/_components/homekit_controller.markdown @@ -8,9 +8,24 @@ comments: false sharing: true footer: true logo: apple-homekit.png -ha_category: Hub +ha_category: + - Hub + - Alarm Panel Control + - Climate + - Cover + - Light + - Lock + - Switch + - Binary Sensor ha_release: 0.68 ha_iot_class: "Local Polling" +redirect_from: + - /components/alarm_control_panel.homekit_controller/ + - /components/climate.homekit_controller/ + - /components/cover.homekit_controller/ + - /components/light.homekit_controller/ + - /components/lock.homekit_controller/ + - /components/switch.homekit_controller/ --- [HomeKit](https://developer.apple.com/homekit/) controller integration for Home Assistant allows you to connect HomeKit accessories to Home Assistant. This component should not be confused with the [HomeKit](/components/homekit/) component, which allows you to control Home Assistant devices via HomeKit. @@ -22,12 +37,13 @@ ha_iot_class: "Local Polling" There is currently support for the following device types within Home Assistant: -- [Alarm Control Panel](/components/alarm_control_panel.homekit_controller/) -- [Climate](/components/climate.homekit_controller/) -- [Cover](/components/cover.homekit_controller/) -- [Light](/components/light.homekit_controller/) -- [Lock](/components/lock.homekit_controller/) -- [Switch](/components/switch.homekit_controller/) +- Alarm Control Panel (HomeKit security system) +- Climate (HomeKit thermostats and air conditioners) +- Cover (HomeKit garage door openers, windows, or window coverings) +- Light (HomeKit lights) +- Lock (HomeKit lock) +- Switch (HomeKit switches) +- Binary Sensor (HomeKit motion sensors) The component will be automatically configured if the [`discovery:`](/components/discovery/) component is enabled and an enable entry added for HomeKit: diff --git a/source/_components/light.homekit_controller.markdown b/source/_components/light.homekit_controller.markdown deleted file mode 100644 index f3f7243a10f..00000000000 --- a/source/_components/light.homekit_controller.markdown +++ /dev/null @@ -1,16 +0,0 @@ ---- -layout: page -title: "HomeKit Light" -description: "Instructions how to setup HomeKit lights within Home Assistant." -date: 2017-03-19 21:08 -sidebar: true -comments: false -sharing: true -footer: true -logo: apple-homekit.png -ha_category: Light -ha_iot_class: "Local Polling" -ha_release: 0.68 ---- - -To get your HomeKit lights working with Home Assistant, follow the instructions for the general [HomeKit controller component](/components/homekit_controller/). diff --git a/source/_components/lock.homekit_controller.markdown b/source/_components/lock.homekit_controller.markdown deleted file mode 100644 index 399acb61c73..00000000000 --- a/source/_components/lock.homekit_controller.markdown +++ /dev/null @@ -1,16 +0,0 @@ ---- -layout: page -title: "HomeKit Lock" -description: "Instructions how to setup HomeKit locks within Home Assistant." -date: 2019-1-8 7:00 -sidebar: true -comments: false -sharing: true -footer: true -logo: apple-homekit.png -ha_category: Lock -ha_iot_class: "Local Polling" -ha_release: 0.86 ---- - -To get your HomeKit lock working with Home Assistant, follow the instructions for the general [HomeKit controller component](/components/homekit_controller/). diff --git a/source/_components/switch.homekit_controller.markdown b/source/_components/switch.homekit_controller.markdown deleted file mode 100644 index d4b50659595..00000000000 --- a/source/_components/switch.homekit_controller.markdown +++ /dev/null @@ -1,16 +0,0 @@ ---- -layout: page -title: "HomeKit Switch" -description: "Instructions on how to setup HomeKit switches within Home Assistant." -date: 2017-03-19 21:08 -sidebar: true -comments: false -sharing: true -footer: true -logo: apple-homekit.png -ha_category: Switch -ha_iot_class: "Local Polling" -ha_release: 0.68 ---- - -To get your HomeKit switches working with Home Assistant, follow the instructions for the general [HomeKit controller component](/components/homekit_controller/). From a3a19976f2b76acb097dabd70bbf63688bb1b033 Mon Sep 17 00:00:00 2001 From: Paulus Schoutsen Date: Mon, 28 Jan 2019 20:29:04 -0800 Subject: [PATCH 05/13] Version bump to 0.86.4 --- _config.yml | 4 ++-- source/_posts/2019-01-23-release-86.markdown | 15 +++++++++++++++ 2 files changed, 17 insertions(+), 2 deletions(-) diff --git a/_config.yml b/_config.yml index 0ed1eca7007..a01e12f706e 100644 --- a/_config.yml +++ b/_config.yml @@ -144,8 +144,8 @@ social: # Home Assistant release details current_major_version: 0 current_minor_version: 86 -current_patch_version: 3 -date_released: 2019-01-26 +current_patch_version: 4 +date_released: 2019-01-29 # Either # or the anchor link to latest release notes in the blog post. # Must be prefixed with a # and have double quotes around it. diff --git a/source/_posts/2019-01-23-release-86.markdown b/source/_posts/2019-01-23-release-86.markdown index 6fd29d8ee4c..ae9a47d6f62 100644 --- a/source/_posts/2019-01-23-release-86.markdown +++ b/source/_posts/2019-01-23-release-86.markdown @@ -102,6 +102,21 @@ Another noteworthy breaking change (sorry!), is that the automation `time` trigg [@starkillerOG]: https://github.com/starkillerOG [hue docs]: /components/hue/ +## {% linkable_title Release 0.86.4 - January 28 %} + +- Bumps aioasuswrt ([@kennedyshead] - [#20432]) ([asuswrt docs]) +- Add check to validate gamut ([@starkillerOG] - [#20518]) +- fix #20387 devices without model/protocol ([@fredrike] - [#20530]) ([tellduslive docs]) + +[#20432]: https://github.com/home-assistant/home-assistant/pull/20432 +[#20518]: https://github.com/home-assistant/home-assistant/pull/20518 +[#20530]: https://github.com/home-assistant/home-assistant/pull/20530 +[@fredrike]: https://github.com/fredrike +[@kennedyshead]: https://github.com/kennedyshead +[@starkillerOG]: https://github.com/starkillerOG +[asuswrt docs]: /components/asuswrt/ +[tellduslive docs]: /components/tellduslive/ + ## {% linkable_title If you need help... %} ...don't hesitate to use our very active [forums](https://community.home-assistant.io/) or join us for a little [chat](https://discord.gg/c5DvZ4e). The release notes have comments enabled but it's preferred if you use the former communication channels. Thanks. From d602f1acd68dda2b6d4ced0972a8526bf1d62c9f Mon Sep 17 00:00:00 2001 From: Klaas Schoute Date: Wed, 30 Jan 2019 08:31:26 +0100 Subject: [PATCH 06/13] =?UTF-8?q?=F0=9F=9A=9C=20Merges/Redirect=20Joaoapps?= =?UTF-8?q?=5Fjoin=20controller=20component=20pages=20(#8336)?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- source/_components/joaoapps_join.markdown | 6 +++++- source/_components/notify.joaoapps_join.markdown | 16 ---------------- 2 files changed, 5 insertions(+), 17 deletions(-) delete mode 100644 source/_components/notify.joaoapps_join.markdown diff --git a/source/_components/joaoapps_join.markdown b/source/_components/joaoapps_join.markdown index abc7f3eedf5..eba9cbd0576 100644 --- a/source/_components/joaoapps_join.markdown +++ b/source/_components/joaoapps_join.markdown @@ -8,8 +8,12 @@ comments: false sharing: true footer: true logo: joaoapps_join.png -ha_category: Hub +ha_category: + - Hub + - Notify ha_release: "0.24" +redirect_from: + - /components/notify.joaoapps_join/ --- The `joaoapps_join` component exposes services from diff --git a/source/_components/notify.joaoapps_join.markdown b/source/_components/notify.joaoapps_join.markdown deleted file mode 100644 index e5b6c76e90a..00000000000 --- a/source/_components/notify.joaoapps_join.markdown +++ /dev/null @@ -1,16 +0,0 @@ ---- -layout: page -title: "Join Notify" -description: "Instructions on how to setup the Join notification platform within Home Assistant." -date: 2016-07-12 09:00 -sidebar: true -comments: false -sharing: true -footer: true -logo: joaoapps_join.png -ha_category: Notifications -ha_release: "0.24" ---- - -See the [Joaoapps Join component page](/components/joaoapps_join/) for -information how to get the join notify platform running. From effc2cb90408e1503d9345f21f8470a47fa08ebf Mon Sep 17 00:00:00 2001 From: Klaas Schoute Date: Wed, 30 Jan 2019 08:32:02 +0100 Subject: [PATCH 07/13] =?UTF-8?q?=F0=9F=9A=9C=20Merges/Redirect=20BeagleBo?= =?UTF-8?q?ne=20Black=20GPIO=20component=20pages=20(#8337)?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- source/_components/bbb_gpio.markdown | 111 +++++++++++++++++- .../binary_sensor.bbb_gpio.markdown | 65 ---------- source/_components/switch.bbb_gpio.markdown | 60 ---------- 3 files changed, 109 insertions(+), 127 deletions(-) delete mode 100644 source/_components/binary_sensor.bbb_gpio.markdown delete mode 100644 source/_components/switch.bbb_gpio.markdown diff --git a/source/_components/bbb_gpio.markdown b/source/_components/bbb_gpio.markdown index cb9f7a4c0dc..285f6bcdb7c 100644 --- a/source/_components/bbb_gpio.markdown +++ b/source/_components/bbb_gpio.markdown @@ -8,10 +8,117 @@ comments: false sharing: true footer: true logo: beaglebone-black.png -ha_category: DIY +ha_category: + - DIY + - Binary Sensor + - Switch ha_release: 0.36 ha_iot_class: "Local Push" +redirect_from: + - /components/binary_sensor.bbb_gpio/ + - /components/switch.bbb_gpio/ --- The `bbb_gpio` component is the base for all [BeagleBone Black](https://beagleboard.org/black) related GPIO platforms in Home Assistant. -There is no setup needed for the component itself, for the platforms please check their corresponding pages. +There is no setup needed for the component itself. + +## {% linkable_title Binary Sensor %} + +The `bbb_gpio` binary sensor platform allows you to read sensor values of the GPIOs of your [BeagleBone Black](https://beagleboard.org/black). + +## {% linkable_title Configuration %} + +To use your BeagleBone Black's GPIO in your installation, add the following to your `configuration.yaml` file: + +```yaml +# Example configuration.yaml entry +binary_sensor: + - platform: bbb_gpio + pins: + P8_12: + name: Door + GPIO0_26: + name: Window +``` + +{% configuration %} +pins: + description: List of used pins. + required: true + type: map + keys: + pin_name: + description: Port numbers and corresponding names. + required: true + type: map + keys: + name: + description: Friendly name to use for the frontend. + required: true + type: string + bouncetime: + description: Debounce time for reading input pin defined in milliseconds [ms]. + required: false + type: integer + default: 50 + invert_logic: + description: If `true`, inverts the input logic to ACTIVE LOW + required: false + type: boolean + default: false + pull_mode: + description: Type of internal pull resistor connected to input. Options are `UP` - pull-up resistor and `DOWN` - pull-down resistor. + required: false + type: string + default: UP +{% endconfiguration %} + +For more details about the GPIO layout, visit the [article](http://elinux.org/Beagleboard:BeagleBoneBlack) about the BeagleBone Black. + +## {% linkable_title Switch %} + +The `bbb_gpio` switch platform allows you to control the GPIOs of your [BeagleBone Black](https://beagleboard.org/black). + +## {% linkable_title Configuration %} + +To use your BeagleBone Black's GPIO in your installation, add the following to your `configuration.yaml` file: + +```yaml +# Example configuration.yaml entry +switch: + - platform: bbb_gpio + pins: + GPIO0_7: + name: LED Red + P9_12: + name: LED Green +``` + +{% configuration %} +pins: + description: List of used pins. + required: true + type: map + keys: + pin_name: + description: Port numbers and corresponding names. + required: true + type: map + keys: + name: + description: Friendly name to use for the frontend. + required: false + type: string + initial: + description: Initial state of the pin. + required: false + default: false + type: boolean + invert_logic: + description: If `true`, inverts the input logic to ACTIVE LOW + required: false + default: false + type: boolean +{% endconfiguration %} + +For more details about the GPIO layout, visit the [article](http://elinux.org/Beagleboard:BeagleBoneBlack) about the BeagleBone Black. \ No newline at end of file diff --git a/source/_components/binary_sensor.bbb_gpio.markdown b/source/_components/binary_sensor.bbb_gpio.markdown deleted file mode 100644 index 069c6c9eb1d..00000000000 --- a/source/_components/binary_sensor.bbb_gpio.markdown +++ /dev/null @@ -1,65 +0,0 @@ ---- -layout: page -title: "BeagleBone Black GPIO Binary Sensor" -description: "Instructions on how to integrate the GPIO sensor capability of a BeagleBone Black into Home Assistant." -date: 2017-01-14 10:00 -sidebar: true -comments: false -sharing: true -footer: true -logo: beaglebone-black.png -ha_category: DIY -ha_release: 0.37 -ha_iot_class: "Local Push" ---- - -The `bbb_gpio` binary sensor platform allows you to read sensor values of the GPIOs of your [BeagleBone Black](https://beagleboard.org/black). - -## {% linkable_title Configuration %} - -To use your BeagleBone Black's GPIO in your installation, add the following to your `configuration.yaml` file: - -```yaml -# Example configuration.yaml entry -binary_sensor: - - platform: bbb_gpio - pins: - P8_12: - name: Door - GPIO0_26: - name: Window -``` - -{% configuration %} -pins: - description: List of used pins. - required: true - type: map - keys: - pin_name: - description: Port numbers and corresponding names. - required: true - type: map - keys: - name: - description: Friendly name to use for the frontend. - required: true - type: string - bouncetime: - description: Debounce time for reading input pin defined in milliseconds [ms]. - required: false - type: integer - default: 50 - invert_logic: - description: If `true`, inverts the input logic to ACTIVE LOW - required: false - type: boolean - default: false - pull_mode: - description: Type of internal pull resistor connected to input. Options are `UP` - pull-up resistor and `DOWN` - pull-down resistor. - required: false - type: string - default: UP -{% endconfiguration %} - -For more details about the GPIO layout, visit the [article](http://elinux.org/Beagleboard:BeagleBoneBlack) about the BeagleBone Black. diff --git a/source/_components/switch.bbb_gpio.markdown b/source/_components/switch.bbb_gpio.markdown deleted file mode 100644 index 6efd8f88159..00000000000 --- a/source/_components/switch.bbb_gpio.markdown +++ /dev/null @@ -1,60 +0,0 @@ ---- -layout: page -title: "BeagleBone Black GPIO Switch" -description: "Instructions on how to integrate the GPIO of a BeagleBone Black into Home Assistant as a switch." -date: 2017-01-14 10:00 -sidebar: true -comments: false -sharing: true -footer: true -logo: beaglebone-black.png -ha_category: DIY -ha_release: 0.36 -ha_iot_class: "Local Push" ---- - -The `bbb_gpio` switch platform allows you to control the GPIOs of your [BeagleBone Black](https://beagleboard.org/black). - -## {% linkable_title Configuration %} - -To use your BeagleBone Black's GPIO in your installation, add the following to your `configuration.yaml` file: - -```yaml -# Example configuration.yaml entry -switch: - - platform: bbb_gpio - pins: - GPIO0_7: - name: LED Red - P9_12: - name: LED Green -``` - -{% configuration %} -pins: - description: List of used pins. - required: true - type: map - keys: - pin_name: - description: Port numbers and corresponding names. - required: true - type: map - keys: - name: - description: Friendly name to use for the frontend. - required: false - type: string - initial: - description: Initial state of the pin. - required: false - default: false - type: boolean - invert_logic: - description: If `true`, inverts the input logic to ACTIVE LOW - required: false - default: false - type: boolean -{% endconfiguration %} - -For more details about the GPIO layout, visit the [article](http://elinux.org/Beagleboard:BeagleBoneBlack) about the BeagleBone Black. From 2e2e91fbaf390a6a4916bdbfe256b9166558bc63 Mon Sep 17 00:00:00 2001 From: Klaas Schoute Date: Wed, 30 Jan 2019 08:32:42 +0100 Subject: [PATCH 08/13] =?UTF-8?q?=F0=9F=9A=9C=20Merges/Redirect=20Raspberr?= =?UTF-8?q?y=20Pi=20GPIO=20component=20pages=20(#8339)?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- .../binary_sensor.rpi_gpio.markdown | 60 ------ source/_components/cover.rpi_gpio.markdown | 99 --------- source/_components/rpi_gpio.markdown | 194 +++++++++++++++++- source/_components/switch.rpi_gpio.markdown | 63 ------ 4 files changed, 193 insertions(+), 223 deletions(-) delete mode 100644 source/_components/binary_sensor.rpi_gpio.markdown delete mode 100644 source/_components/cover.rpi_gpio.markdown delete mode 100644 source/_components/switch.rpi_gpio.markdown diff --git a/source/_components/binary_sensor.rpi_gpio.markdown b/source/_components/binary_sensor.rpi_gpio.markdown deleted file mode 100644 index 8494c3af37c..00000000000 --- a/source/_components/binary_sensor.rpi_gpio.markdown +++ /dev/null @@ -1,60 +0,0 @@ ---- -layout: page -title: "Raspberry Pi GPIO Binary Sensor" -description: "Instructions on how to integrate the GPIO sensor capability of a Raspberry Pi into Home Assistant." -date: 2015-08-30 19:00 -sidebar: true -comments: false -sharing: true -footer: true -logo: raspberry-pi.png -ha_category: DIY -ha_release: pre 0.7 -ha_iot_class: "Local Push" ---- - -The `rpi_gpio` binary sensor platform allows you to read sensor values of the GPIOs of your [Raspberry Pi](https://www.raspberrypi.org/). - -## {% linkable_title Configuration %} - -To use your Raspberry Pi's GPIO in your installation, add the following to your `configuration.yaml` file: - -```yaml -# Example configuration.yaml entry -binary_sensor: - - platform: rpi_gpio - ports: - 11: PIR Office - 12: PIR Bedroom -``` - -{% configuration %} -ports: - description: List of used ports. - required: true - type: map - keys: - "port: name": - description: The port numbers (BCM mode pin numbers) and corresponding names. - required: true - type: string -bouncetime: - description: The time in milliseconds for port debouncing. - required: false - type: integer - default: 50 -invert_logic: - description: If `true`, inverts the output logic to ACTIVE LOW. - required: false - type: boolean - default: "`false` (ACTIVE HIGH)" -pull_mode: - description: > - Type of internal pull resistor to use. - Options are `UP` - pull-up resistor and `DOWN` - pull-down resistor. - required: false - type: string - default: "`UP`" -{% endconfiguration %} - -For more details about the GPIO layout, visit the Wikipedia [article](https://en.wikipedia.org/wiki/Raspberry_Pi#GPIO_connector) about the Raspberry Pi. diff --git a/source/_components/cover.rpi_gpio.markdown b/source/_components/cover.rpi_gpio.markdown deleted file mode 100644 index 635502caeb3..00000000000 --- a/source/_components/cover.rpi_gpio.markdown +++ /dev/null @@ -1,99 +0,0 @@ ---- -layout: page -title: "Raspberry Pi GPIO Cover" -description: "Instructions on how to setup the Raspberry Pi GPIO covers within Home Assistant." -date: 2016-08-24 14:28 -sidebar: true -comments: false -sharing: true -footer: true -logo: raspberry-pi.png -ha_category: DIY -ha_release: 0.23 -ha_iot_class: "Local Push" ---- - -The `rpi_gpio` cover platform allows you to use a Raspberry Pi to control your cover such as Garage doors. - -It uses two pins on the Raspberry Pi. - -- The `state_pin` will detect if the cover is closed, and -- the `relay_pin` will trigger the cover to open or close. - -Although you do not need Andrews Hilliday's software controller when you run Home Assistant, he has written clear instructions on how to hook your garage door and sensors up to your Raspberry Pi, which can be found [here](https://github.com/andrewshilliday/garage-door-controller#hardware-setup). - -## {% linkable_title Configuration %} - -To enable Raspberry Pi Covers in your installation, add the following to your `configuration.yaml` file: - -```yaml -# Example configuration.yaml entry -cover: - - platform: rpi_gpio - covers: - - relay_pin: 10 - state_pin: 11 -``` - -{% configuration %} -relay_time: - description: The time that the relay will be on for in seconds. - required: false - default: 0.2 - type: float -invert_relay: - description: Invert the relay pin output so that it is active-high (True). - required: false - default: false - type: boolean -state_pull_mode: - description: The direction the State pin is pulling. It can be UP or DOWN. - required: false - default: UP - type: string -invert_state: - description: Invert the value of the State pin so that 0 means closed. - required: false - default: false - type: boolean -covers: - description: List of your doors. - required: true - type: list - keys: - relay_pin: - description: The pin of your Raspberry Pi where the relay is connected. - required: true - type: integer - state_pin: - description: The pin of your Raspberry Pi to retrieve the state. - required: true - type: integer - name: - description: The name to use in the frontend. - required: false - type: string -{% endconfiguration %} - -## {% linkable_title Full example %} - -```yaml -# Example configuration.yaml entry -cover: - - platform: rpi_gpio - relay_time: 0.2 - invert_relay: false - state_pull_mode: 'UP' - invert_state: true - covers: - - relay_pin: 10 - state_pin: 11 - - relay_pin: 12 - state_pin: 13 - name: 'Right door' -``` - -## {% linkable_title Remote Raspberry Pi Cover %} - -If you don't have Home Assistant running on your Raspberry Pi and you want to use it as a remote cover instead, there is a project called [GarageQTPi](https://github.com/Jerrkawz/GarageQTPi) that will work remotely with the [MQTT Cover Component](/components/cover.mqtt/). Follow the Github instructions to install and configure GarageQTPi and once configured follow the Home Assistant instructions to configure the MQTT Cover. - diff --git a/source/_components/rpi_gpio.markdown b/source/_components/rpi_gpio.markdown index 31a1befde2e..e282d94a166 100644 --- a/source/_components/rpi_gpio.markdown +++ b/source/_components/rpi_gpio.markdown @@ -8,10 +8,202 @@ comments: false sharing: true footer: true logo: raspberry-pi.png -ha_category: DIY +ha_category: + - DIY + - Binary Sensor + - Cover + - Switch ha_release: pre 0.7 ha_iot_class: "Local Push" +redirect_from: + - /components/binary_sensor.rpi_gpio/ + - /components/cover.rpi_gpio/ + - /components/switch.rpi_gpio/ --- The `rpi_gpio` component is the base for all related GPIO platforms in Home Assistant. There is no setup needed for the component itself, for the platforms please check their corresponding pages. +## {% linkable_title Binary Sensor %} + +The `rpi_gpio` binary sensor platform allows you to read sensor values of the GPIOs of your [Raspberry Pi](https://www.raspberrypi.org/). + +## {% linkable_title Configuration %} + +To use your Raspberry Pi's GPIO in your installation, add the following to your `configuration.yaml` file: + +```yaml +# Example configuration.yaml entry +binary_sensor: + - platform: rpi_gpio + ports: + 11: PIR Office + 12: PIR Bedroom +``` + +{% configuration %} +ports: + description: List of used ports. + required: true + type: map + keys: + "port: name": + description: The port numbers (BCM mode pin numbers) and corresponding names. + required: true + type: string +bouncetime: + description: The time in milliseconds for port debouncing. + required: false + type: integer + default: 50 +invert_logic: + description: If `true`, inverts the output logic to ACTIVE LOW. + required: false + type: boolean + default: "`false` (ACTIVE HIGH)" +pull_mode: + description: > + Type of internal pull resistor to use. + Options are `UP` - pull-up resistor and `DOWN` - pull-down resistor. + required: false + type: string + default: "`UP`" +{% endconfiguration %} + +For more details about the GPIO layout, visit the Wikipedia [article](https://en.wikipedia.org/wiki/Raspberry_Pi#GPIO_connector) about the Raspberry Pi. + +## {% linkable_title Cover %} + +The `rpi_gpio` cover platform allows you to use a Raspberry Pi to control your cover such as Garage doors. + +It uses two pins on the Raspberry Pi. + +- The `state_pin` will detect if the cover is closed, and +- the `relay_pin` will trigger the cover to open or close. + +Although you do not need Andrews Hilliday's software controller when you run Home Assistant, he has written clear instructions on how to hook your garage door and sensors up to your Raspberry Pi, which can be found [here](https://github.com/andrewshilliday/garage-door-controller#hardware-setup). + +## {% linkable_title Configuration %} + +To enable Raspberry Pi Covers in your installation, add the following to your `configuration.yaml` file: + +```yaml +# Example configuration.yaml entry +cover: + - platform: rpi_gpio + covers: + - relay_pin: 10 + state_pin: 11 +``` + +{% configuration %} +relay_time: + description: The time that the relay will be on for in seconds. + required: false + default: 0.2 + type: float +invert_relay: + description: Invert the relay pin output so that it is active-high (True). + required: false + default: false + type: boolean +state_pull_mode: + description: The direction the State pin is pulling. It can be UP or DOWN. + required: false + default: UP + type: string +invert_state: + description: Invert the value of the State pin so that 0 means closed. + required: false + default: false + type: boolean +covers: + description: List of your doors. + required: true + type: list + keys: + relay_pin: + description: The pin of your Raspberry Pi where the relay is connected. + required: true + type: integer + state_pin: + description: The pin of your Raspberry Pi to retrieve the state. + required: true + type: integer + name: + description: The name to use in the frontend. + required: false + type: string +{% endconfiguration %} + +## {% linkable_title Full example %} + +```yaml +# Example configuration.yaml entry +cover: + - platform: rpi_gpio + relay_time: 0.2 + invert_relay: false + state_pull_mode: 'UP' + invert_state: true + covers: + - relay_pin: 10 + state_pin: 11 + - relay_pin: 12 + state_pin: 13 + name: 'Right door' +``` + +## {% linkable_title Remote Raspberry Pi Cover %} + +If you don't have Home Assistant running on your Raspberry Pi and you want to use it as a remote cover instead, there is a project called [GarageQTPi](https://github.com/Jerrkawz/GarageQTPi) that will work remotely with the [MQTT Cover Component](/components/cover.mqtt/). Follow the Github instructions to install and configure GarageQTPi and once configured follow the Home Assistant instructions to configure the MQTT Cover. + +## {% linkable_title Switch %} + +The `rpi_gpio` switch platform allows you to control the GPIOs of your [Raspberry Pi](https://www.raspberrypi.org/). + +## {% linkable_title Configuration %} + +To use your Raspberry Pi's GPIO in your installation, add the following to your `configuration.yaml` file: + +```yaml +# Example configuration.yaml entry +switch: + - platform: rpi_gpio + ports: + 11: Fan Office + 12: Light Desk +``` + +{% configuration %} +ports: + description: Array of used ports. + required: true + type: list + keys: + port: + description: Port numbers and corresponding names (GPIO #). + required: true + type: [integer, string] +invert_logic: + description: If true, inverts the output logic to ACTIVE LOW. + required: false + default: false + type: boolean +{% endconfiguration %} + +For more details about the GPIO layout, visit the Wikipedia [article](https://en.wikipedia.org/wiki/Raspberry_Pi#GPIO_connector) about the Raspberry Pi. + +

+Note that a pin managed by HASS is expected to be exclusive to HASS. +

+ +A common question is what does Port refer to, this number is the actual GPIO #, not the pin #. +For example, if you have a relay connected to pin 11 its GPIO # is 17. + +```yaml +# Example configuration.yaml entry +switch: + - platform: rpi_gpio + ports: + 17: Speaker Relay +``` diff --git a/source/_components/switch.rpi_gpio.markdown b/source/_components/switch.rpi_gpio.markdown deleted file mode 100644 index c40f8b85ec7..00000000000 --- a/source/_components/switch.rpi_gpio.markdown +++ /dev/null @@ -1,63 +0,0 @@ ---- -layout: page -title: "Raspberry Pi GPIO Switch" -description: "Instructions on how to integrate the GPIO of a Raspberry Pi into Home Assistant as a switch." -date: 2015-08-07 14:00 -sidebar: true -comments: false -sharing: true -footer: true -logo: raspberry-pi.png -ha_category: DIY -ha_release: pre 0.7 -ha_iot_class: "Local Push" ---- - -The `rpi_gpio` switch platform allows you to control the GPIOs of your [Raspberry Pi](https://www.raspberrypi.org/). - -## {% linkable_title Configuration %} - -To use your Raspberry Pi's GPIO in your installation, add the following to your `configuration.yaml` file: - -```yaml -# Example configuration.yaml entry -switch: - - platform: rpi_gpio - ports: - 11: Fan Office - 12: Light Desk -``` - -{% configuration %} -ports: - description: Array of used ports. - required: true - type: list - keys: - port: - description: Port numbers and corresponding names (GPIO #). - required: true - type: [integer, string] -invert_logic: - description: If true, inverts the output logic to ACTIVE LOW. - required: false - default: false - type: boolean -{% endconfiguration %} - -For more details about the GPIO layout, visit the Wikipedia [article](https://en.wikipedia.org/wiki/Raspberry_Pi#GPIO_connector) about the Raspberry Pi. - -

-Note that a pin managed by HASS is expected to be exclusive to HASS. -

- -A common question is what does Port refer to, this number is the actual GPIO #, not the pin #. -For example, if you have a relay connected to pin 11 its GPIO # is 17. - -```yaml -# Example configuration.yaml entry -switch: - - platform: rpi_gpio - ports: - 17: Speaker Relay -``` From 30a99163a8492d873eced32736007eb4133e5547 Mon Sep 17 00:00:00 2001 From: Klaas Schoute Date: Wed, 30 Jan 2019 08:33:02 +0100 Subject: [PATCH 09/13] =?UTF-8?q?=F0=9F=9A=9C=20Merges/Redirect=20WaterFur?= =?UTF-8?q?nace=20component=20pages=20(#8340)?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- source/_components/sensor.waterfurnace.markdown | 17 ----------------- source/_components/waterfurnace.markdown | 2 ++ 2 files changed, 2 insertions(+), 17 deletions(-) delete mode 100644 source/_components/sensor.waterfurnace.markdown diff --git a/source/_components/sensor.waterfurnace.markdown b/source/_components/sensor.waterfurnace.markdown deleted file mode 100644 index 12545ff5a61..00000000000 --- a/source/_components/sensor.waterfurnace.markdown +++ /dev/null @@ -1,17 +0,0 @@ ---- -layout: page -title: "WaterFurnace Sensors" -description: "Instructions on how to integrate WaterFurnace Geothermal System sensors into Home Assistant." -date: 2018-01-19 17:00 -sidebar: true -comments: false -sharing: true -footer: true -logo: waterfurnace.png -ha_category: Sensor -ha_release: 0.62 -ha_iot_class: "Cloud Polling" ---- - -Integrates WaterFurnace sensors into Home Assistant. See the [main component](/components/waterfurnace/) for configuration instructions. - diff --git a/source/_components/waterfurnace.markdown b/source/_components/waterfurnace.markdown index e530d87f9d4..d260a96553b 100644 --- a/source/_components/waterfurnace.markdown +++ b/source/_components/waterfurnace.markdown @@ -11,6 +11,8 @@ logo: waterfurnace.png ha_category: Sensor ha_release: 0.62 ha_iot_class: "Cloud Polling" +redirect_frome: + - /components/sensor.waterfurnace/ --- The `waterfurnace` component communicates with the WaterFurnace Symphony website's WebSocket to show you many of the sensors in your system. While not an official API, this is the same backend the Symphony website is based on, and should be reasonably stable. From d67546451f3f9ec9000485e06d4e082822eaf1d5 Mon Sep 17 00:00:00 2001 From: Klaas Schoute Date: Wed, 30 Jan 2019 08:33:21 +0100 Subject: [PATCH 10/13] =?UTF-8?q?=F0=9F=9A=9C=20Merges/Redirect=20OpenUV?= =?UTF-8?q?=20component=20pages=20(#8341)?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- .../_components/binary_sensor.openuv.markdown | 18 ------------------ source/_components/openuv.markdown | 11 ++++++++--- source/_components/sensor.openuv.markdown | 19 ------------------- 3 files changed, 8 insertions(+), 40 deletions(-) delete mode 100644 source/_components/binary_sensor.openuv.markdown delete mode 100644 source/_components/sensor.openuv.markdown diff --git a/source/_components/binary_sensor.openuv.markdown b/source/_components/binary_sensor.openuv.markdown deleted file mode 100644 index 9b93806fa72..00000000000 --- a/source/_components/binary_sensor.openuv.markdown +++ /dev/null @@ -1,18 +0,0 @@ ---- -layout: page -title: "OpenUV Binary Sensor" -description: "Instructions on how to integrate OpenUV binary sensors within Home Assistant." -date: 2018-07-31 22:01 -sidebar: true -comments: false -sharing: true -footer: true -logo: openuv.jpg -ha_category: Health -ha_release: 0.76 -ha_iot_class: "Cloud Polling" ---- - -The `openuv` binary sensor platform allows you to view binary sensor data from [OpenUV](http://openuv.io). - -You must have the [`openuv` component](/components/openuv/) configured to use this platform. After configuring that component, binary sensors will automatically appear. diff --git a/source/_components/openuv.markdown b/source/_components/openuv.markdown index ede5c5838db..0d9985a0257 100644 --- a/source/_components/openuv.markdown +++ b/source/_components/openuv.markdown @@ -8,13 +8,18 @@ comments: false sharing: true footer: true logo: openuv.jpg -ha_category: Health +ha_category: + - Health + - Binary Sensor + - Sensor ha_release: 0.76 ha_iot_class: "Cloud Polling" +redirect_from: + - /components/binary_sensor.openuv/ + - /components/sensor.openuv/ --- -The `openuv` component displays UV and Ozone data from -[openuv.io](http://openuv.io). +The `openuv` component displays UV and Ozone data from [openuv.io](http://openuv.io). ## {% linkable_title Generating an API Key %} diff --git a/source/_components/sensor.openuv.markdown b/source/_components/sensor.openuv.markdown deleted file mode 100644 index 61240520043..00000000000 --- a/source/_components/sensor.openuv.markdown +++ /dev/null @@ -1,19 +0,0 @@ ---- -layout: page -title: "OpenUV Sensor" -description: "Instructions on how to integrate OpenUV sensors within Home Assistant." -date: 2018-07-31 22:01 -sidebar: true -comments: false -sharing: true -footer: true -logo: openuv.jpg -ha_category: Health -ha_release: 0.76 -ha_iot_class: "Cloud Polling" ---- - -The `openuv` sensor platform allows you to view sensor data from [OpenUV](http://openuv.io). - -You must have the [`openuv` component](/components/openuv/) configured to use this platform. After configuring that component, sensors will automatically appear. - From e600aa163d27e83cad91d422d855bb680d223331 Mon Sep 17 00:00:00 2001 From: Pascal Vizeli Date: Wed, 30 Jan 2019 16:56:48 +0100 Subject: [PATCH 11/13] Update beta to RC --- source/hassio/installation.markdown | 14 +++++++------- 1 file changed, 7 insertions(+), 7 deletions(-) diff --git a/source/hassio/installation.markdown b/source/hassio/installation.markdown index 23d9c02361c..09d00d86aa3 100644 --- a/source/hassio/installation.markdown +++ b/source/hassio/installation.markdown @@ -120,14 +120,14 @@ A detailed guide about running Hass.io as a virtual machine is available in the [pi2]: https://github.com/home-assistant/hassos/releases/download/1.13/hassos_rpi2-1.13.img.gz [pi3-32]: https://github.com/home-assistant/hassos/releases/download/1.13/hassos_rpi3-1.13.img.gz [pi3-64]: https://github.com/home-assistant/hassos/releases/download/1.13/hassos_rpi3-64-1.13.img.gz -[tinker]: https://github.com/home-assistant/hassos/releases/download/2.6/hassos_tinker-2.6.img.gz -[odroid-c2]: https://github.com/home-assistant/hassos/releases/download/2.6/hassos_odroid-c2-2.6.img.gz -[odroid-xu4]: https://github.com/home-assistant/hassos/releases/download/2.6/hassos_odroid-xu4-2.6.img.gz -[opi-prime]: https://github.com/home-assistant/hassos/releases/download/2.6/hassos_opi-prime-2.6.img.gz -[intel-nuc]: https://github.com/home-assistant/hassos/releases/download/2.6/hassos_intel-nuc-2.6.img.gz +[tinker]: https://github.com/home-assistant/hassos/releases/download/2.7/hassos_tinker-2.7.img.gz +[odroid-c2]: https://github.com/home-assistant/hassos/releases/download/2.7/hassos_odroid-c2-2.7.img.gz +[odroid-xu4]: https://github.com/home-assistant/hassos/releases/download/2.7/hassos_odroid-xu4-2.7.img.gz +[opi-prime]: https://github.com/home-assistant/hassos/releases/download/2.7/hassos_opi-prime-2.7.img.gz +[intel-nuc]: https://github.com/home-assistant/hassos/releases/download/2.7/hassos_intel-nuc-2.7.img.gz [vmdk]: https://github.com/home-assistant/hassos/releases/download/1.13/hassos_ova-1.13.vmdk.gz -[vhdx]: https://github.com/home-assistant/hassos/releases/download/2.6/hassos_ova-2.6.vhdx.gz -[vdi]: https://github.com/home-assistant/hassos/releases/download/2.6/hassos_ova-2.6.vdi.gz +[vhdx]: https://github.com/home-assistant/hassos/releases/download/2.7/hassos_ova-2.7.vhdx.gz +[vdi]: https://github.com/home-assistant/hassos/releases/download/2.7/hassos_ova-2.7.vdi.gz [linux]: https://github.com/home-assistant/hassio-build/tree/master/install#install-hassio [local]: http://hassio.local:8123 [samba]: /addons/samba/ From e6d2c29dc33aef690774e10cdcae61b35c29b71f Mon Sep 17 00:00:00 2001 From: Paulus Schoutsen Date: Wed, 30 Jan 2019 09:54:07 -0800 Subject: [PATCH 12/13] Fix typo Thanks to @cgtobi --- source/_posts/2019-01-23-release-86.markdown | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/source/_posts/2019-01-23-release-86.markdown b/source/_posts/2019-01-23-release-86.markdown index ae9a47d6f62..a9285550d58 100644 --- a/source/_posts/2019-01-23-release-86.markdown +++ b/source/_posts/2019-01-23-release-86.markdown @@ -38,7 +38,7 @@ The Zigbee team is also planning a bunch of cool things for 2019. Direct device ## {% linkable_title Noteworthy breaking changes %} -Update: the entity ID one was too harsh, it's not a warning. +Update: the entity ID one was too harsh, it's now a warning. This release also includes two noteworthy breaking changes. One is a follow-up on the slugify breaking change from last release. We did not update the validation check for config options that need to be valid slugs. This means that some of your config values might be invalid. Keep an eye at the console as we have a new message to tell you which ones are wrong. From f6456a98bf9a94bd4701dfc9888c78cbb7ca1612 Mon Sep 17 00:00:00 2001 From: Tony Mitchell Date: Wed, 30 Jan 2019 17:17:01 -0800 Subject: [PATCH 13/13] Update dhcp_software option in docs to match code (#8348) The code uses 'odhcpd' while the document listed the option as 'dhcpd'. Fixing documentation --- source/_components/device_tracker.ubus.markdown | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/source/_components/device_tracker.ubus.markdown b/source/_components/device_tracker.ubus.markdown index 2e921769617..23fa853e6d8 100644 --- a/source/_components/device_tracker.ubus.markdown +++ b/source/_components/device_tracker.ubus.markdown @@ -83,7 +83,7 @@ password: required: true type: string dhcp_software: - description: "The DHCP software used in your router: `dnsmasq`, `dhcpd`, or `none`." + description: "The DHCP software used in your router: `dnsmasq`, `odhcpd`, or `none`." required: false default: dnsmasq type: string