From 89d0899afa47990f1e156892c859cc05e76b6e6e Mon Sep 17 00:00:00 2001 From: Anton Verburg <47820045+antonverburg@users.noreply.github.com> Date: Mon, 20 Apr 2020 12:38:03 +0200 Subject: [PATCH] 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 * Removed not-required config parameters * Update source/_integrations/pi4ioe5v9xxxx.markdown Co-Authored-By: Marc Randolph * Update source/_integrations/pi4ioe5v9xxxx.markdown Co-Authored-By: Franck Nijhof * Update pi4ioe5v9xxxx.markdown * Update source/_integrations/pi4ioe5v9xxxx.markdown Co-Authored-By: Franck Nijhof * 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 * :pencil2: Tweaks Co-authored-by: Klaas Schoute Co-authored-by: Marc Randolph Co-authored-by: Franck Nijhof --- source/_integrations/pi4ioe5v9xxxx.markdown | 135 ++++++++++++++++++++ source/images/supported_brands/diodes.png | Bin 0 -> 3802 bytes 2 files changed, 135 insertions(+) create mode 100644 source/_integrations/pi4ioe5v9xxxx.markdown create mode 100644 source/images/supported_brands/diodes.png diff --git a/source/_integrations/pi4ioe5v9xxxx.markdown b/source/_integrations/pi4ioe5v9xxxx.markdown new file mode 100644 index 00000000000..8343beb4416 --- /dev/null +++ b/source/_integrations/pi4ioe5v9xxxx.markdown @@ -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 %} diff --git a/source/images/supported_brands/diodes.png b/source/images/supported_brands/diodes.png new file mode 100644 index 0000000000000000000000000000000000000000..2608e875de9d330a903e5fb4640201274c280ad6 GIT binary patch literal 3802 zcmaKvc{~#U8^CRZy%Zlfv2 zTp>qTq1XF)|9}7ZeSgpM&+qx~`8-eZJrg}nc0qOq1_n;JJ`{24%LaNF@_2#n;m=6nMiK6YAgP8+ zh1$;>fBx0tBOqRM*PVX^VL$gY7J2L0x-0uZW<+bxu6E|`pqQZ!0 zn<-xe6#{#1D4;%?OoaZl`8_N5Xx#LvwB`3`PY>1TY$2VTDQ2!*8GSE^My))-tTQ;nIRI1R1>(z;< zt(o3Z@8i_HS?`61JcF>Op9zSS$`_&WlF2jcmH(=}RfGw@%;;lC-wNxzbSt3{1b_pO zRI%_GmF+=)kD9*%fW}q=gzyDg@z|H&;F};1 ztUy%r@KyC}V#3Cph-(UFBq7B6fR=j4^WJ#?_-Lv8`C9vNSwPEq_eDZ@mRLGC=Dtg7 zK9m1ofp-%S%G?QdfA@0xBU0w!2N5~p6*f-7^%}EI{^ss5M-BStq*BknojFiuzkBl( zFlbRvsN4U0sN=$gj74M#$HQba~ zOj=!0D+-gRiiy?amcey{4t9OlpClW+xY0d1@qtBp68Ph5qH3VtQ!CDjyKNmI_Q$^! zeGN;7YA=Oe%=I49S*q523=4k;!)=TRxGeZ`Y#Dr8=m)yCUV~cp$}k!PL_Q*1p|8J9b_yB-&pBFTzM>8|UeYWK2xO~vW|ahF8!eEoG(+Wt2G$n?S& zm`b7UY=$zMlsSsrMI0{Y4#JDtC-Mrsej#-tvLGtKl!8Dp|E-c)=jp!Us5t6mCG*an z1F%}mdm4ro$F4FxW=ub`icUM+E^1*l2FSZgX8~ zBr>=@;J=tTPuY*;-d==HSuqchH%ky)f~5g_UE^n)6RyBeG4-w;s8q0!ILqt-1Y?NG zX(JrQyMK}S4hq9EPFCT?UW^}0r(K84OkzZx+~TA*Me1GMx~_m`)n%)R4B9RZk5ccV zM~B2u$4X_qDaps1@dD279hs>G_<=p67+xodnqnMI5`$meDcI1U68;vU&l_16RNLCM z9LTVe61}&V7mhDZuI}Sxa2R42usdH9zNseWh--kfJZlLFf6lja#l0@~0D4&fy%tL9 zZ-U9gZrUEbMfJMg>0S3!8->5YLt)72g`vBC+P&vizm0TKzKEE+`=QU*7HSSD2`sDR zjyG@u9-Q%yrqPu2yIa=1LE_lgP18;a89Rdo8Fup}AQhT#O@jsyZAv1j+8$}A>Y$qT zkB6mT^;DPDbn04Fbhb?L;=+XjY4doRkL9bIskfUlc?AwfzysCW%UMXpWail8V1gSH z_G}_VR(eAT`jn2N|8y=Ui>Uc5MUUTVnchl{ztAu^|6q$_>m)<8{!$-H!j&YVRt`m+ zj{jHA;hMjZ--K5F4DKdT5LgPb%S9kNPlYsuix`!Wk1;PFlh_&L;0>ZLhut?X__T|v zo@kOM@h}Qq@m6(B(=7P*YN;L`L3hn zCkCUcwQ3V+uQ#_la~A8 zK`nI;t~|HQvuPWrF{cjWgnhYEUEY4yFtxI>(G3y80ifMtA{}MMwt}bV185LVjM=YAhK^Y@U;IxrYFxhD}PE7?2W0WTT&{ z@F_iTex@8J0J|)(Ek<8E2P<^`7;B#02&X6JzpwTfgiYzZx(SrO-G9ZGn|u+pT7v(i zCQ8%h#)s}`g7uwbD~aV2wrvpHOUFJ@`LjWxC{?mk@jBX$7toXcVsnr7qZEa6%1aMO zH6f={9oUz;P*{zO8j~0v*;(aQ5P(V%9!;Ab^|$W>$#?Z5ZNuV2KA|!3c}OF^Zn&-( zMUP124H_`cnY#KziW=Iicsc2^Kznn5MbU1S&$!eBEPVZYW0sT+*39pY*eW;IDmKOf zMGD5ZE4j7dWm@qpI9lqITodbg1Ks{+rB$+`P7vhM+V8V|)VYzWnpMsP0#Lz$_!A_E zMQY5~6bAp0f)JGK&~+rFK?O0U;ck4>o^nS42dNle7J8#wGoW;cZiPuD>T>}3RXHAS}M+Kp<$5U=g#;BYJml6v0hAb@X@+Dy`|AsPU0mVPM zB^`FW1SKyU7lU0zi?4cUw`J}f(n)c`MgDG!i6(=lu&W(zxD1!OOs*w492MSb zypcj=5QF1{8O?|w(g`HytJlF|UJjB_FTJS0|3{GA%2)hEKd(YU_j3vchGwn5QAuRr z1br5!0!iVB#KxUbf<%~)HHtv{0h&qro&{W$%xAfA zod%#6%8dva+RrD-^9^Wfl#RVg_*%|410`_1ri&~kE`2=F+kfwja06r#^`RCEL%PsA z4sBuRWCQRcdo!(m@8JfsKS9=ZyG_y7y?p_J_K%7nB8YE8i&G_Xj=nx-uV-${-2SK7 zZl|vNLEH43n~zG7UWGBsu;vAkVbyhfitRw%LR@X8lFJan9h zKlol8dU9mFl_EsI)tUnxLbN$o{_*|p$B+Dp7C#ETAw_ivhj2K=u~GGc(926^I^*xY zq-)9-aMaY)cvAjK1lZ{?A0T#@jm`A9q8IH0b#!zhlLF3P8`m+8I4&Wmv^MTS&qU`d z`dBSRu0K_8{Sc_1gtR7K-Qv27dV0&4my~;4%QY`PMQJ63SyFi5s8T=2wjUkVJ2Q<{ zDx@BY>T2ghL$?oZ+HvtL2dlp#!~VgAmFg_jGGA-h*Yq5OG`*kc^v#ymI&s|IG5$VbQ?gvfXI1_X7c+*Z$=)sRr$PuaQl!}3O)7uT#uV=r@l9^eWDawJ4Rb4 z6-(D~foxB*6(!f=9?PUhAf~|1&)<~NUR|M0TRvS6S!p}$tVa+?+E)61W5%&e0c{Bd zziCj4^r2CdjSXr*_}oPS&Qt@uUlNbCZXb)vwXkE^>50k5tiJh=*ezyed6@S%c4O9N zmMmM4@bD<0{El|mVVnE>`K?N!Iwn>(CZEy3KjRzHOCtPO?1e0@-T{z!ERWhlPZb#z zd2yqj(unSux~R-+Y({x+jB4$@-80HM9QJ2j&s`=jMt4?fj!_MCAJ~S!i@XEnxA5}! z&k9z!Ym#5>8NI)De_%%FvU)yKLhN2cX`$gD5GWt!a~p@%pRs*e-@Dg`p@E$%s{DPq zVJL3!90s*Kl)t}8OcT2M@_wz}=Gc-!2Zl(@yX2Ql!k`x6XMpmf8i8Mwj+M87V!Z literal 0 HcmV?d00001