Create orangepi_gpio.markdown

source/_components/orangepi_gpio.markdown

@@ -0,0 +1,210 @@
+---
+layout: page
+title: "Orange Pi GPIO"
+description: "Instructions on how to integrate the GPIO capability of a Orange Pi into Home Assistant."
+date: 2019-03-29 19:00
+sidebar: true
+comments: false
+sharing: true
+footer: true
+ha_category:
+  - DIY
+  - Binary Sensor
+  - Cover
+  - Switch
+ha_release: 0.92
+ha_iot_class: Local Push
+---
+
+The `orangepi_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 `orangepi_gpio` binary sensor platform allows you to read sensor values of the GPIOs of your Orange Pi or NanoPi.
+
+## {% linkable_title Configuration %}
+
+To use your Orange Pi's GPIO in your installation, add the following to your `configuration.yaml` file:
+
+```yaml
+# Example configuration.yaml entry
+binary_sensor:
+  - platform: orangepi_gpio
+    pinmode: pc
+    ports:
+      11: PIR Office
+      12: PIR Bedroom
+```
+
+{% configuration %}
+pinmode:
+  description: Type of pinmode to use. This depends on which device you are actually using it ([PINMODE](/components/orangepi_gpio#pinmode)).
+  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](/components/rpi_gpio/) component, this component does not support pull-up resistors or port debouncing. Use external pull-ups and external port-debouncing.
+
+## {% linkable_title Cover %}
+
+The `orangepi_gpio` cover platform allows you to use a Orange Pi to control your cover such as Garage doors.
+
+It uses two pins on the Orange Pi.
+
+- The `state_pin` will detect if the cover is closed, and
+- the `relay_pin` will trigger the cover to open or close.
+
+## {% linkable_title Configuration %}
+
+To enable Orange Pi Covers in your installation, add the following to your `configuration.yaml` file:
+
+```yaml
+# Example configuration.yaml entry
+cover:
+  - platform: orangepi_gpio
+    pinmode: pc
+    covers:
+      - relay_pin: 10
+        state_pin: 11
+```
+
+{% configuration %}
+pinmode:
+  description: Type of pinmode to use. This depends on which device you are actually using it ([PINMODE](/components/orangepi_gpio#pinmode)).
+  required: true
+  type: string
+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
+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 Orange Pi where the relay is connected.
+      required: true
+      type: integer
+    state_pin:
+      description: The pin of your Orange 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: orangepi_gpio
+    pinmode: pc
+    relay_time: 0.2
+    invert_relay: false
+    invert_state: true
+    covers:
+      - relay_pin: 10
+        state_pin: 11
+      - relay_pin: 12
+        state_pin: 13
+        name: 'Right door'
+```
+
+## {% linkable_title Switch %}
+
+The `orangepi_gpio` switch platform allows you to control the GPIOs of your Orange Pi or NanoPi.
+
+## {% linkable_title Configuration %}
+
+To use your Orange Pi's GPIO in your installation, add the following to your `configuration.yaml` file:
+
+```yaml
+# Example configuration.yaml entry
+switch:
+  - platform: orangepi_gpio
+    pinmode: pc
+    ports:
+      11: Fan Office
+      12: Light Desk
+```
+
+{% configuration %}
+pinmode:
+  description: Type of pinmode to use. This depends on which device you are actually using it ([PINMODE](/components/orangepi_gpio#pinmode)).
+  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 %}
+
+<p class='note warning'>
+Note that a pin managed by HASS is expected to be exclusive to HASS.
+</p>
+
+## {% linkable_title Pinmode %}
+
+As this platform supports different types of GPIO pinouts for difference Orange Pi or Nano Pi devices, we use the `pinmode` value to specify which one to use. Enabled values are:
+
+| Value | Description |
+| ----- | ----------- |
+| `pc` | Supports the Orange Pi Lite, One, PC and Prime |
+| `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 |
+
+## {% linkable_title Additional steps %}
+This component uses the `SYSFS` filesystem to get control of the GPIOs. Therefore an operatings 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.6 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](/docs/installation/raspberry-pi/)
+
+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.

source/_components/upnp.markdown

@@ -64,3 +64,14 @@ ports:
   type: map
   default: Open same port on external router as that HASS runs locally and forwards it.
 {% endconfiguration %}
+
+## {% linkable_title Troubleshooting %}
+
+If Home Assistant is not able to discover UPnP sensors, it may be because the local IP address was not auto-detected correctly. To prevent this, you may add the `local_ip` option to your UPnP configuration:
+
+```yaml
+# Example configuration.yaml with UPnP sensors enabled and local_ip set
+upnp:
+  sensors: true
+  local_ip: 192.168.1.2
+```