Skip to content

Update documentation for rpi_gpio #8185

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
mikalstill wants to merge 4 commits into from
Closed

Update documentation for rpi_gpio #8185

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
2f04827
Update documentation for rpi_gpio
mikalstill Jan 16, 2019
259ff1d
:pencil2: Tweak
klaasnicolaas Jan 29, 2019
5c17bb5
:pencil2: Tweak
klaasnicolaas Jan 29, 2019
d168097
:pencil2: Tweak
klaasnicolaas Jan 29, 2019
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 3 additions & 3 deletions source/_components/binary_sensor.rpi_gpio.markdown
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
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."
description: "Instructions on how to integrate the GPIO sensor capability of a Raspberry Pi or Orange Pi into Home Assistant."
date: 2015-08-30 19:00
sidebar: true
comments: false
Expand All @@ -13,7 +13,7 @@ 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/).
The `rpi_gpio` binary sensor platform allows you to read sensor values of the GPIOs of your [Raspberry Pi](https://www.raspberrypi.org/) or [Orange Pi](http://www.orangepi.org/).

## {% linkable_title Configuration %}

Expand All @@ -35,7 +35,7 @@ ports:
type: map
keys:
"port: name":
description: The port numbers (BCM mode pin numbers) and corresponding names.
description: Port numbers and corresponding names (GPIO number). For Raspberry Pi boards this is the BCM style pin numbering, for Orange Pi it is the SUNXI style pin numbering (i.e. PA7).
required: true
type: string
bouncetime:
Expand Down
16 changes: 14 additions & 2 deletions source/_components/rpi_gpio.markdown
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
layout: page
title: "Raspberry Pi GPIO"
description: "Instructions on how to integrate the GPIO capability of a Raspberry Pi into Home Assistant."
description: "Instructions on how to integrate the GPIO capability of a Raspberry Pi or Orange Pi into Home Assistant."
date: 2016-08-30 19:00
sidebar: true
comments: false
Expand All @@ -13,5 +13,17 @@ ha_release: pre 0.7
ha_iot_class: "Local Push"
---

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.
The `rpi_gpio` component is the base for all related GPIO platforms in Home Assistant. This component supports both Raspberry Pi, as well as the Orange Pi boards.

```yaml
# Example configuration.yaml entry
rpi_gpio:
board_family: raspberry_pi
```

{% configuration %}
board_family:
description: The type of board. The default is "raspberry_pi", but "orange_pi" is also supported.
required: false
type: string
{% endconfiguration %}
6 changes: 3 additions & 3 deletions source/_components/switch.rpi_gpio.markdown
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
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."
description: "Instructions on how to integrate the GPIO of a Raspberry Pi or Orange Pi into Home Assistant as a switch."
date: 2015-08-07 14:00
sidebar: true
comments: false
Expand All @@ -14,7 +14,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/).
The `rpi_gpio` switch platform allows you to control the GPIOs of your [Raspberry Pi](https://www.raspberrypi.org/) or [Orange Pi](http://www.orangepi.org/).

## {% linkable_title Configuration %}

Expand All @@ -36,7 +36,7 @@ ports:
type: list
keys:
port:
description: Port numbers and corresponding names (GPIO #).
description: Port numbers and corresponding names (GPIO number). For Raspberry Pi boards this is the BCM style pin numbering, for Orange Pi it is the SUNXI style pin numbering (i.e. PA7).
required: true
type: [integer, string]
invert_logic:
Expand Down