home-assistant.io/source/_integrations/orangepi_gpio.markdown

title, description, ha_category, ha_release, ha_iot_class, ha_codeowners, ha_domain

title	description	ha_category	ha_release	ha_iot_class	ha_codeowners	ha_domain
Orangepi GPIO	Instructions on how to integrate the GPIO capability of a Orange Pi into Home Assistant.	DIY Binary Sensor	0.93	Local Push	@pascallj	orangepi_gpio

The orangepi_gpio integration is the base for all related GPIO platforms in Home Assistant. There is no setup needed for the integration itself, for the platforms please check their corresponding pages.

Binary Sensor

The orangepi_gpio binary sensor platform allows you to read sensor values of the GPIOs of your Orange Pi or NanoPi.

Configuration

To use your Orange Pi's GPIO in your installation, add the following to your configuration.yaml file:

# Example configuration.yaml entry
binary_sensor:
  - platform: orangepi_gpio
    pin_mode: pc
    ports:
      11: PIR Office
      12: PIR Bedroom

{% configuration %} pin_mode: description: Type of pin mode to use. This depends on which device you are actually using (Pin modes). required: true type: string ports: description: List of used ports. required: true type: map keys: "port: name": description: The port numbers (physical pin numbers) and corresponding names. required: true type: string invert_logic: description: If true, inverts the output logic to ACTIVE LOW. required: false type: boolean default: "false (ACTIVE HIGH)" {% endconfiguration %}

Compared to the Raspberry Pi GPIO component, this integration does not support pull-up resistors or port debouncing. Use external pull-ups and external port-debouncing.

Pin modes

As this platform supports different types of GPIO pinouts for difference Orange Pi or Nano Pi devices, we use the pin_mode value to specify which one to use. Enabled values are:

Value	Description
lite	Supports the Orange Pi Lite
lite2	Supports the Orange Pi Lite 2
one	Supports the Orange Pi One
oneplus	Supports the Orange Pi One Plus
pc	Supports the Orange Pi PC
pc2	Supports the Orange Pi PC 2
pcplus	Supports the Orange Pi PC Plus
pi3	Supports the Orange Pi 3
plus2e	Supports the Orange Pi Plus 2E
prime	Supports the Orange Pi Prime
r1	Supports the Orange Pi R1
winplus	Supports the Orange Pi WinPlus
zero	Supports the Orange Pi Zero
zeroplus	Supports the Orange Pi Zero Plus
zeroplus2	Supports the Orange Pi Zero Plus 2
duo	Supports the NanoPi Duo
neocore2	Supports the NanoPi Neocore 2

Additional steps

This integration uses the SYSFS filesystem to get control of the GPIOs. Therefore an operating system with CONFIG_GPIO_SYSFS is required. As far as I know, most out-of-the-box distributions still enable this by default.

As of Linux 4.8 sysfs-gpio is marked as obsolete. However as of today, the alternative GPIO character device is not widely used. Therefore we will use this until the new character device is more widely supported.

Normally the /sys/class/gpio path is owned by root, so Home Assistant does not have access. As we don't want to run Home Assistant as root, we will add the group gpio to have control over this path. I will assume you added the homeassistant user already to the gpio group as recommended in the Manual installation guide

Create a new file in /etc/udev/rules.d/ named 10-gpio.rules with the following contents:

SUBSYSTEM=="gpio*", PROGRAM="/bin/sh -c 'find -L /sys/class/gpio/ -maxdepth 2 -exec chown root:gpio {} \; -exec chmod 770 {} \; || true'"

Home Assistant will now be able to control your GPIO pins.