From 4482a15a6d6323c76b293c8b2195c41a9b34f1c7 Mon Sep 17 00:00:00 2001 From: jgriff2 Date: Thu, 21 Feb 2019 01:12:03 -0800 Subject: [PATCH 1/8] Create remote_rpi_gpio.markdown Documentation for new platform remote_rpi_gpio --- remote_rpi_gpio.markdown | 127 +++++++++++++++++++++++++++++++++++++++ 1 file changed, 127 insertions(+) create mode 100644 remote_rpi_gpio.markdown diff --git a/remote_rpi_gpio.markdown b/remote_rpi_gpio.markdown new file mode 100644 index 00000000000..1a33e1fdabd --- /dev/null +++ b/remote_rpi_gpio.markdown @@ -0,0 +1,127 @@ +--- +layout: page +title: "Remote Raspberry Pi GPIO" +description: "Instructions on how to integrate the GPIO capability of a Remote Raspberry Pi into Home Assistant." +date: 2019-02-20 19:00 +sidebar: true +comments: false +sharing: true +footer: true +logo: raspberry-pi.png +ha_category: + - DIY + - Binary Sensor + - Switch +ha_release: +ha_iot_class: "Local Push" +redirect_from: + - /components/binary_sensor.remote_rpi_gpio/ + - /components/switch.remote_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 `remote_rpi_gpio` binary sensor platform allows you to read sensor values of the GPIOs of a [Remote Raspberry Pi](https://www.raspberrypi.org/). + +## {% linkable_title Configuration %} + +To use your Remote Raspberry Pi's GPIO in your installation, add the following to your `configuration.yaml` file: + +```yaml +# Example configuration.yaml entry +binary_sensor: + - platform: remote_rpi_gpio + ports: + 11: PIR Office + 12: PIR Bedroom +``` + +{% configuration %} +address: + description: IP Address of remote Raspberry Pi + required: true + type: string +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 +invert_logic: + description: If `true`, inverts the output logic + 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. + Pull-Up defaults to active LOW and Pull-down defaults to active HIGH. This can be adjusted with invert_logic + 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 Switch %} + +The `remote_rpi_gpio` switch platform allows you to control the GPIOs of a [Remote Raspberry Pi](https://www.raspberrypi.org/). + +## {% linkable_title Configuration %} + +To use your Remote Raspberry Pi's GPIO in your installation, add the following to your `configuration.yaml` file: + +```yaml +# Example configuration.yaml entry +switch: + - platform: remote_rpi_gpio + address: 192.168.0.123 + ports: + 11: Fan Office + 12: Light Desk +``` + +{% configuration %} +address: + description: IP Address of remote Raspberry Pi + required: true + type: string +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: remote_rpi_gpio + address: 192.168.0.123 + ports: + 17: Speaker Relay +``` From 17bd0f86bc79487ab35e5b3323771310646bc03e Mon Sep 17 00:00:00 2001 From: jgriff2 Date: Sun, 28 Apr 2019 13:10:51 -0700 Subject: [PATCH 2/8] Create remote_rpi_gpio.markdown --- source/_components/remote_rpi_gpio.markdown | 127 ++++++++++++++++++++ 1 file changed, 127 insertions(+) create mode 100644 source/_components/remote_rpi_gpio.markdown diff --git a/source/_components/remote_rpi_gpio.markdown b/source/_components/remote_rpi_gpio.markdown new file mode 100644 index 00000000000..1a33e1fdabd --- /dev/null +++ b/source/_components/remote_rpi_gpio.markdown @@ -0,0 +1,127 @@ +--- +layout: page +title: "Remote Raspberry Pi GPIO" +description: "Instructions on how to integrate the GPIO capability of a Remote Raspberry Pi into Home Assistant." +date: 2019-02-20 19:00 +sidebar: true +comments: false +sharing: true +footer: true +logo: raspberry-pi.png +ha_category: + - DIY + - Binary Sensor + - Switch +ha_release: +ha_iot_class: "Local Push" +redirect_from: + - /components/binary_sensor.remote_rpi_gpio/ + - /components/switch.remote_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 `remote_rpi_gpio` binary sensor platform allows you to read sensor values of the GPIOs of a [Remote Raspberry Pi](https://www.raspberrypi.org/). + +## {% linkable_title Configuration %} + +To use your Remote Raspberry Pi's GPIO in your installation, add the following to your `configuration.yaml` file: + +```yaml +# Example configuration.yaml entry +binary_sensor: + - platform: remote_rpi_gpio + ports: + 11: PIR Office + 12: PIR Bedroom +``` + +{% configuration %} +address: + description: IP Address of remote Raspberry Pi + required: true + type: string +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 +invert_logic: + description: If `true`, inverts the output logic + 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. + Pull-Up defaults to active LOW and Pull-down defaults to active HIGH. This can be adjusted with invert_logic + 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 Switch %} + +The `remote_rpi_gpio` switch platform allows you to control the GPIOs of a [Remote Raspberry Pi](https://www.raspberrypi.org/). + +## {% linkable_title Configuration %} + +To use your Remote Raspberry Pi's GPIO in your installation, add the following to your `configuration.yaml` file: + +```yaml +# Example configuration.yaml entry +switch: + - platform: remote_rpi_gpio + address: 192.168.0.123 + ports: + 11: Fan Office + 12: Light Desk +``` + +{% configuration %} +address: + description: IP Address of remote Raspberry Pi + required: true + type: string +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: remote_rpi_gpio + address: 192.168.0.123 + ports: + 17: Speaker Relay +``` From b5ffa4681ccddeeeec38df05234533d810e2d071 Mon Sep 17 00:00:00 2001 From: jgriff2 Date: Sun, 28 Apr 2019 13:11:05 -0700 Subject: [PATCH 3/8] Delete remote_rpi_gpio.markdown --- remote_rpi_gpio.markdown | 127 --------------------------------------- 1 file changed, 127 deletions(-) delete mode 100644 remote_rpi_gpio.markdown diff --git a/remote_rpi_gpio.markdown b/remote_rpi_gpio.markdown deleted file mode 100644 index 1a33e1fdabd..00000000000 --- a/remote_rpi_gpio.markdown +++ /dev/null @@ -1,127 +0,0 @@ ---- -layout: page -title: "Remote Raspberry Pi GPIO" -description: "Instructions on how to integrate the GPIO capability of a Remote Raspberry Pi into Home Assistant." -date: 2019-02-20 19:00 -sidebar: true -comments: false -sharing: true -footer: true -logo: raspberry-pi.png -ha_category: - - DIY - - Binary Sensor - - Switch -ha_release: -ha_iot_class: "Local Push" -redirect_from: - - /components/binary_sensor.remote_rpi_gpio/ - - /components/switch.remote_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 `remote_rpi_gpio` binary sensor platform allows you to read sensor values of the GPIOs of a [Remote Raspberry Pi](https://www.raspberrypi.org/). - -## {% linkable_title Configuration %} - -To use your Remote Raspberry Pi's GPIO in your installation, add the following to your `configuration.yaml` file: - -```yaml -# Example configuration.yaml entry -binary_sensor: - - platform: remote_rpi_gpio - ports: - 11: PIR Office - 12: PIR Bedroom -``` - -{% configuration %} -address: - description: IP Address of remote Raspberry Pi - required: true - type: string -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 -invert_logic: - description: If `true`, inverts the output logic - 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. - Pull-Up defaults to active LOW and Pull-down defaults to active HIGH. This can be adjusted with invert_logic - 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 Switch %} - -The `remote_rpi_gpio` switch platform allows you to control the GPIOs of a [Remote Raspberry Pi](https://www.raspberrypi.org/). - -## {% linkable_title Configuration %} - -To use your Remote Raspberry Pi's GPIO in your installation, add the following to your `configuration.yaml` file: - -```yaml -# Example configuration.yaml entry -switch: - - platform: remote_rpi_gpio - address: 192.168.0.123 - ports: - 11: Fan Office - 12: Light Desk -``` - -{% configuration %} -address: - description: IP Address of remote Raspberry Pi - required: true - type: string -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: remote_rpi_gpio - address: 192.168.0.123 - ports: - 17: Speaker Relay -``` From 25c026681830e5768ff36c686ec6695ea518f498 Mon Sep 17 00:00:00 2001 From: jgriff2 Date: Sun, 28 Apr 2019 13:15:27 -0700 Subject: [PATCH 4/8] Update remote_rpi_gpio.markdown --- source/_components/remote_rpi_gpio.markdown | 12 ++++++++++++ 1 file changed, 12 insertions(+) diff --git a/source/_components/remote_rpi_gpio.markdown b/source/_components/remote_rpi_gpio.markdown index 1a33e1fdabd..e5fe106fe08 100644 --- a/source/_components/remote_rpi_gpio.markdown +++ b/source/_components/remote_rpi_gpio.markdown @@ -38,6 +38,18 @@ binary_sensor: 12: PIR Bedroom ``` +or + +```yaml +# Example configuration.yaml entry +remote_rpi_gpio: + host: 10.0.1.9 + binary_sensors: + 6: Pin6 + switches: + 4: Pin4 +``` + {% configuration %} address: description: IP Address of remote Raspberry Pi From 2901029d10508d9c2d0cb73d52c6c5d35f4c3dc8 Mon Sep 17 00:00:00 2001 From: jgriff2 Date: Thu, 9 May 2019 22:20:38 -0700 Subject: [PATCH 5/8] Update source/_components/remote_rpi_gpio.markdown Co-Authored-By: Klaas Schoute --- source/_components/remote_rpi_gpio.markdown | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/source/_components/remote_rpi_gpio.markdown b/source/_components/remote_rpi_gpio.markdown index e5fe106fe08..e007f2e2eff 100644 --- a/source/_components/remote_rpi_gpio.markdown +++ b/source/_components/remote_rpi_gpio.markdown @@ -13,7 +13,7 @@ ha_category: - Binary Sensor - Switch ha_release: -ha_iot_class: "Local Push" +ha_iot_class: Local Push redirect_from: - /components/binary_sensor.remote_rpi_gpio/ - /components/switch.remote_rpi_gpio/ From 0f37cbda36f30b71f5b33d04cc84d34bab503436 Mon Sep 17 00:00:00 2001 From: Klaas Schoute Date: Fri, 10 May 2019 11:19:57 +0200 Subject: [PATCH 6/8] :pencil2: Remove redirect_from --- source/_components/remote_rpi_gpio.markdown | 3 --- 1 file changed, 3 deletions(-) diff --git a/source/_components/remote_rpi_gpio.markdown b/source/_components/remote_rpi_gpio.markdown index e007f2e2eff..9cc1eef6b6b 100644 --- a/source/_components/remote_rpi_gpio.markdown +++ b/source/_components/remote_rpi_gpio.markdown @@ -14,9 +14,6 @@ ha_category: - Switch ha_release: ha_iot_class: Local Push -redirect_from: - - /components/binary_sensor.remote_rpi_gpio/ - - /components/switch.remote_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. From 28aa919d0b67d303c0ba40ad2154a8116c0c8255 Mon Sep 17 00:00:00 2001 From: jgriff2 Date: Sun, 26 May 2019 14:54:40 -0700 Subject: [PATCH 7/8] Update remote_rpi_gpio.markdown --- source/_components/remote_rpi_gpio.markdown | 19 +++++++------------ 1 file changed, 7 insertions(+), 12 deletions(-) diff --git a/source/_components/remote_rpi_gpio.markdown b/source/_components/remote_rpi_gpio.markdown index 9cc1eef6b6b..ab7112f0eb8 100644 --- a/source/_components/remote_rpi_gpio.markdown +++ b/source/_components/remote_rpi_gpio.markdown @@ -30,21 +30,16 @@ To use your Remote Raspberry Pi's GPIO in your installation, add the following t # Example configuration.yaml entry binary_sensor: - platform: remote_rpi_gpio + address:
ports: 11: PIR Office 12: PIR Bedroom -``` - -or - -```yaml -# Example configuration.yaml entry -remote_rpi_gpio: - host: 10.0.1.9 - binary_sensors: - 6: Pin6 - switches: - 4: Pin4 + +switch: + - platform: remote_rpi_gpio + address:
+ ports: + 4: Garage Relay ``` {% configuration %} From 5492da48660e9e6bfa00195256fef9c6ba39e1d9 Mon Sep 17 00:00:00 2001 From: Klaas Schoute Date: Wed, 29 May 2019 23:41:30 +0200 Subject: [PATCH 8/8] :pencil2: Tweak After this we will merge it --- source/_components/remote_rpi_gpio.markdown | 6 +----- 1 file changed, 1 insertion(+), 5 deletions(-) diff --git a/source/_components/remote_rpi_gpio.markdown b/source/_components/remote_rpi_gpio.markdown index ab7112f0eb8..50f75828065 100644 --- a/source/_components/remote_rpi_gpio.markdown +++ b/source/_components/remote_rpi_gpio.markdown @@ -12,7 +12,7 @@ ha_category: - DIY - Binary Sensor - Switch -ha_release: +ha_release: 0.94 ha_iot_class: Local Push --- @@ -22,8 +22,6 @@ The `rpi_gpio` component is the base for all related GPIO platforms in Home Assi The `remote_rpi_gpio` binary sensor platform allows you to read sensor values of the GPIOs of a [Remote Raspberry Pi](https://www.raspberrypi.org/). -## {% linkable_title Configuration %} - To use your Remote Raspberry Pi's GPIO in your installation, add the following to your `configuration.yaml` file: ```yaml @@ -77,8 +75,6 @@ For more details about the GPIO layout, visit the Wikipedia [article](https://en The `remote_rpi_gpio` switch platform allows you to control the GPIOs of a [Remote Raspberry Pi](https://www.raspberrypi.org/). -## {% linkable_title Configuration %} - To use your Remote Raspberry Pi's GPIO in your installation, add the following to your `configuration.yaml` file: ```yaml