Added documentation for the rpi_pfio platform. (#2597)

* Added documentation for the rpi_pfio platform.

* Changed version to next release

* Removed unused pull mode
This commit is contained in:
Bas Schipper 2017-05-10 07:36:40 +02:00 committed by Paulus Schoutsen
parent 6d2624f31f
commit f90d92996d
3 changed files with 92 additions and 0 deletions

View File

@ -0,0 +1,39 @@
---
layout: page
title: "PiFace Digital I/O Binary Sensor"
description: "Instructions how to integrate the PiFace Digital I/O module into Home Assistant as a binary sensor."
date: 2016-05-08 15:00
sidebar: true
comments: false
sharing: true
footer: true
logo: raspberry-pi.png
ha_category: Binary Sensor
ha_release: 0.45
---
The `rpi_pfio` binary sensor platform allows you to read sensor values of the [PiFace Digital I/O](https://www.element14.com/community/docs/DOC-69001) .
To use your PiFace Digital I/O module in your installation, add the following to your `configuration.yaml` file:
```yaml
# Example configuration.yaml entry
binary_sensor:
- platform: rpi_pfio
ports:
0:
name: PIR Office
invert_logic: true
1:
name: Doorbell
settle_time: 50
```
Configuration variables:
- **ports** array (*Required*): Array of used ports.
- **num** (*Required*): Port number.
- **name** (*Required*): Port name.
- **settle_time** (*Optional*): The time in milliseconds for port debouncing. Default is 20ms.
- **invert_logic** (*Optional*): If true, inverts the output logic to ACTIVE LOW. Default is false (ACTIVE HIGH).

View File

@ -0,0 +1,16 @@
---
layout: page
title: "PiFace Digital I/O"
description: "Instructions how to integrate the PiFace Digital I/O module into Home Assistant."
date: 2016-05-08 15:00
sidebar: true
comments: false
sharing: true
footer: true
logo: raspberry-pi.png
ha_category: DIY
ha_release: 0.45
---
The `rpi_pfio` component is the base for all related PFIO platforms in Home Assistant. There is no setup needed for the component itself, for the platforms please check their corresponding pages.

View File

@ -0,0 +1,37 @@
---
layout: page
title: "PiFace Digital I/O Switch"
description: "Instructions how to integrate the PiFace Digital I/O module into Home Assistant as a switch."
date: 2016-05-08 15:00
sidebar: true
comments: false
sharing: true
footer: true
logo: raspberry-pi.png
ha_category: Switch
ha_release: 0.45
---
The `rpi_pfio` switch platform allows you to control the [PiFace Digital I/O](https://www.element14.com/community/docs/DOC-69001) module.
To use your PiFace Digital I/O module in your installation, add the following to your `configuration.yaml` file:
```yaml
# Example configuration.yaml entry
switch:
- platform: rpi_pfio
ports:
0:
name: Doorlock
invert_logic: true
1:
name: Light Desk
```
Configuration variables:
- **ports** array (*Required*): Array of used ports.
- **num** (*Required*): Port number.
- **name** (*Required*): Port name.
- **invert_logic** (*Optional*): If true, inverts the output logic to ACTIVE LOW. Default is false (ACTIVE HIGH).