Documentation for pi4ioe5v9xxxx integration (#11220)

* Logo of diodes.com, for pi4ioe5v9xxxx devices 

Added integration for pi4ioe5v9xxxx devices of Diodes.com

* Create pi4ioe5v9xxxx.markdown

Add documentation for new integration pi4ioe5v9xxxx

* Update source/_integrations/pi4ioe5v9xxxx.markdown

Co-Authored-By: Klaas Schoute <klaas_schoute@hotmail.com>

* Removed not-required config parameters

* Update source/_integrations/pi4ioe5v9xxxx.markdown

Co-Authored-By: Marc Randolph <mrand@users.noreply.github.com>

* Update source/_integrations/pi4ioe5v9xxxx.markdown

Co-Authored-By: Franck Nijhof <frenck@frenck.nl>

* Update pi4ioe5v9xxxx.markdown

* Update source/_integrations/pi4ioe5v9xxxx.markdown

Co-Authored-By: Franck Nijhof <frenck@frenck.nl>

* I2C bus number to optional

Modified bus from required to optional, as it will normally default to 1.

* Create analog_output.markdown

Initial description of new analog-output entity, to be used to create new platforms.

* Added data attributed, fix typo

* Initial docu for slow_pwm

* Delete analog_output.markdown

* Delete slow_pwm.markdown

* Update HA-release to 0.108

* ✏️ Tweaks

Co-authored-by: Klaas Schoute <klaas_schoute@hotmail.com>
Co-authored-by: Marc Randolph <mrand@users.noreply.github.com>
Co-authored-by: Franck Nijhof <frenck@frenck.nl>
This commit is contained in:
Anton Verburg 2020-04-20 12:38:03 +02:00 committed by GitHub
parent fcf6ce7260
commit 89d0899afa
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
2 changed files with 135 additions and 0 deletions

View File

@ -0,0 +1,135 @@
---
title: "pi4ioe5v9xxxx IO Expander"
description: "Instructions on how to integrate the pi4ioe5v9xxxx IO pin expander with I2C interface into Home Assistant."
logo: diodes.png
ha_category:
- DIY
- Binary Sensor
- Switch
ha_release: 0.109
ha_iot_class: Local Polling
---
The `pi4ioe5v9xxxx` integration provides support for the quasi-bidirectional devices PI4IOE5V9570, PI4IOE5V9674, PI4IOE5V9673, PI4IOE5V96224 and PI4IOE5V96248 from digital.com.
For more details about the pi4ioe5v9xxxx I2C I/O port expander you can find the datasheets here:
- [PI4IOE5V9570](https://www.diodes.com/assets/Datasheets/PI4IOE5V9570.pdf)
- [PI4IOE5V9674](https://www.diodes.com/assets/Datasheets/PI4IOE5V9674.pdf)
- [PI4IOE5V9673](https://www.diodes.com/assets/Datasheets/PI4IOE5V9673.pdf)
- [PI4IOE5V96224](https://www.diodes.com/assets/Datasheets/PI4IOE5V96224.pdf)
- [PI4IOE5V96248](https://www.diodes.com/assets/Datasheets/PI4IOE5V96248.pdf).
## Binary Sensor
The `pi4ioe5v9xxxx` binary sensor platform allows you to read sensor values from the I/O pins of your I/O expander.
The pin numbers are from 1 to X where: 1-8 correspond to port 0 (00-07) and 9-16 to port 1, etc.
### Configuration
To use the I/O pins of an pi4ioe5v9xxxx connected to an I2C bus of your Raspberry Pi as binary sensors, add the following to your `configuration.yaml` file:
```yaml
# Example configuration.yaml entry
binary_sensor:
- platform: pi4ioe5v9xxxx
pins:
1: Pin_01/PI0_0
2: Pin_02/PI0_1
3: Pin_03/PI0_2
4: Pin_04/PI0_3
5: Pin_05/PI0_4
6: Pin_06/PI0_5
7: Pin_07/PI0_6
8: Pin_08/PI0_7
```
{% configuration %}
pins:
description: List of used pins.
required: true
type: map
keys:
"pin: name":
description: The pin numbers (from 1 to X) and corresponding names.
required: true
type: [integer, string]
i2c_bus:
description: i2c bus containing the pi4ioe5v9xxxx chip.
required: false
type: integer
default: "`1`"
i2c_address:
description: i2c address of pi4ioe5v9xxxx chip.
required: false
type: integer
default: "`0x20`"
bits:
description: number of bits of pi4ioe5v9xxxx chip, see particular datasheet for your device for the right number.
required: false
type: integer
default: "`24`"
invert_logic:
description: If `true`, inverts the input logic to ACTIVE LOW.
required: false
type: boolean
default: "`false` (ACTIVE HIGH)"
{% endconfiguration %}
## Switch
The `pi4ioe5v9xxxx` switch platform allows you to write to the I/O pins of your I2C I/O expander.
The pin numbers are from 1 to X, where 1-8 correspond to port A (A1-A8) and 9-16 to port B (B1-B8), etc.
### Configuration
To use the I/O pins of an pi4ioe5v9xxxx connected to an I2C bus as switches, add the following to your `configuration.yaml` file:
```yaml
# Example configuration.yaml entry
switch:
- platform: pi4ioe5v9xxxx
pins:
1: Pin_01/PI0_0
2: Pin_02/PI0_1
3: Pin_03/PI0_2
4: Pin_04/PI0_3
5: Pin_05/PI0_4
6: Pin_06/PI0_5
7: Pin_07/PI0_6
8: Pin_08/PI0_7
```
{% configuration %}
pins:
description: List of used pins.
required: true
type: map
keys:
"pin: name":
description: The pin numbers (from 1 to X) and corresponding names.
required: true
type: [integer, string]
i2c_bus:
description: i2c bus containing the pi4ioe5v9xxxx chip.
required: false
type: integer
default: "`1`"
i2c_address:
description: i2c address of pi4ioe5v9xxxx chip.
required: false
type: integer
default: "`0x20`"
bits:
description: number of bits of pi4ioe5v9xxxx chip, see particular datasheet for your device for the right number.
required: false
type: integer
default: "`24`"
invert_logic:
description: If `true`, inverts the output logic to ACTIVE LOW.
required: false
type: boolean
default: "`false` (ACTIVE HIGH)"
{% endconfiguration %}

Binary file not shown.

After

Width:  |  Height:  |  Size: 3.7 KiB