From 80ca6b43d1773bd1d64c12919dbe4cb1b26ee304 Mon Sep 17 00:00:00 2001 From: Flyte Date: Wed, 10 Feb 2016 18:52:41 +0000 Subject: [PATCH] Add apcupsd component documentation --- source/_components/apcupsd.markdown | 35 +++++++ .../binary_sensor.apcupsd.markdown | 22 ++++ source/_components/sensor.apcupsd.markdown | 94 ++++++++++++++++++ source/images/supported_brands/apcupsd.png | Bin 0 -> 7774 bytes 4 files changed, 151 insertions(+) create mode 100644 source/_components/apcupsd.markdown create mode 100644 source/_components/binary_sensor.apcupsd.markdown create mode 100644 source/_components/sensor.apcupsd.markdown create mode 100644 source/images/supported_brands/apcupsd.png diff --git a/source/_components/apcupsd.markdown b/source/_components/apcupsd.markdown new file mode 100644 index 00000000000..16deab840ef --- /dev/null +++ b/source/_components/apcupsd.markdown @@ -0,0 +1,35 @@ +--- +layout: page +title: "APCUPSd" +description: "Instructions on how to integrate APCUPSd status with Home Assistant." +date: 2016-02-10 17:11 +sidebar: true +comments: false +sharing: true +footer: true +logo: apcupsd.png +ha_category: Hub +--- + +[APCUPSd](http://www.apcupsd.org/) status information can be integrated into Home Assistant when the Network Information Server (NIS) [is configured](http://www.apcupsd.org/manual/manual.html#nis-server-client-configuration-using-the-net-driver). + +Create an `apcupsd` section in your configuration, optionally containing the following parameters: + +- **host**: The hostname/IP address on which the APCUPSd NIS is being served. Default: `localhost` +- **port**: The port on which the APCUPSd NIS is listening. Default: `3551` + +#### Example + +Use defaults: + +```yaml +apcupsd: +``` + +Set parameters: + +```yaml +apcupsd: + host: 192.168.1.10 + port: 1234 +``` diff --git a/source/_components/binary_sensor.apcupsd.markdown b/source/_components/binary_sensor.apcupsd.markdown new file mode 100644 index 00000000000..7e346559ae0 --- /dev/null +++ b/source/_components/binary_sensor.apcupsd.markdown @@ -0,0 +1,22 @@ +--- +layout: page +title: APCUPSd Binary Sensor +description: "Instructions on how to set up an APCUPSd binary sensor within Home Assistant." +date: 2016-02-10 18:47 +sidebar: true +comments: false +sharing: true +footer: true +logo: apcupsd.png +ha_category: Binary Sensor +--- + +In addition to the [APCUPSd Sensor](/components/sensor.apcupsd/) devices, you may also create a device which is simply `on` when the UPS status is `ONLINE` and `off` at all other times. + +#### Example + +```yaml +binary_sensor: + - name: UPS Online + platform: apcupsd +``` diff --git a/source/_components/sensor.apcupsd.markdown b/source/_components/sensor.apcupsd.markdown new file mode 100644 index 00000000000..2a1d18741d3 --- /dev/null +++ b/source/_components/sensor.apcupsd.markdown @@ -0,0 +1,94 @@ +--- +layout: page +title: APCUPSd Sensor +description: "Instructions on how to set up APCUPSd sensors within Home Assistant." +date: 2016-02-10 18:28 +sidebar: true +comments: false +sharing: true +footer: true +logo: apcupsd.png +ha_category: Sensor +--- + +Any of the lines of output from the [apcaccess](http://linux.die.net/man/8/apcaccess) command can be used as a sensor device in Home Assistant. In order to create a sensor for a value, create an entity within a `sensor` section of your configuration. The following parameters may be used: + +- **name** (*Required*): The name you'd like to give the sensor in Home Assistant. +- **platform** (*Required*): Set to `apcupsd`. +- **type** (*Required*): The label for the value you'd like to track based on the output of `apcaccess`. Refer to the examples for ideas. + +#### Example + +Given the following output from `apcaccess`: + +```yaml +APC : 001,051,1149 +DATE : 2016-02-09 17:13:31 +0000 +HOSTNAME : localhost +VERSION : 3.14.12 (29 March 2014) redhat +UPSNAME : netrack +CABLE : Custom Cable Smart +DRIVER : APC Smart UPS (any) +UPSMODE : Stand Alone +STARTTIME: 2016-02-09 16:06:47 +0000 +MODEL : SMART-UPS 1400 +STATUS : TRIM ONLINE +LINEV : 247.0 Volts +LOADPCT : 13.0 Percent +BCHARGE : 100.0 Percent +TIMELEFT : 104.0 Minutes +MBATTCHG : 5 Percent +MINTIMEL : 3 Minutes +MAXTIME : 0 Seconds +MAXLINEV : 249.6 Volts +MINLINEV : 244.4 Volts +OUTPUTV : 218.4 Volts +SENSE : High +DWAKE : 0 Seconds +DSHUTD : 180 Seconds +DLOWBATT : 2 Minutes +LOTRANS : 196.0 Volts +HITRANS : 253.0 Volts +RETPCT : 15.0 Percent +ITEMP : 30.6 C +ALARMDEL : Low Battery +BATTV : 27.6 Volts +LINEFREQ : 50.0 Hz +LASTXFER : High line voltage +NUMXFERS : 0 +TONBATT : 0 Seconds +CUMONBATT: 0 Seconds +XOFFBATT : N/A +SELFTEST : NO +STESTI : 336 +STATFLAG : 0x0500000A +DIPSW : 0x00 +REG1 : 0x00 +REG2 : 0x00 +REG3 : 0x00 +MANDATE : 07/13/99 +SERIALNO : GS9888761008 +BATTDATE : 13/11/15 +NOMOUTV : 230 Volts +NOMBATTV : 24.0 Volts +EXTBATTS : 0 +FIRMWARE : 70.11.I +END APC : 2016-02-09 17:13:46 +0000 +``` + +Use the (case insensitive) values from the left hand column as your `type`: + +```yaml +sensor: + - name: Mains Voltage + platform: apcupsd + type: linev + + - name: UPS Load + platform: apcupsd + type: loadpct + + - name: UPS Temperature + platform: apcupsd + type: itemp +``` diff --git a/source/images/supported_brands/apcupsd.png b/source/images/supported_brands/apcupsd.png new file mode 100644 index 0000000000000000000000000000000000000000..8fbad5a0fa8a8e7ff40982cb9981105bc6c20d69 GIT binary patch literal 7774 zcmV-k9--lhP)gvbH z$o~HPM_FSSH%pS4pO?1CwYj?x86el$+dOE5ae9DjmaZ&2MOlxlZmxR_0014iNkle_(n8(s`{5lVX=zIM?dR>(rt4nP*c2BzRr%T{*R_3kcPE5@P~2x-j?w;XWpB$xe|Xd|DjvF zeGqckar9~cBtNrFbm=-Qw@9Nvsi_Z3zXALlP(Jo@#y>1Bg+Y3ria;Xcw#H%4;$7mh z#l{uQHBho`)dwM?ZH0XL6(Dh*k*g`*Cq~>#bP9fsklPjmY5mv(p!7#Yr4UF%6flk% z_mF&B$}zkz?U8i$f`$HPo45IU83$jIHqRj-9fIWN$KjaK>UmJcqfLN$D_5xfZC=}E z|84L7Kc)ak*(vA-PI(^ZjkRU`A%S~Egr85RK)dL$_lu;+tJA*n7X%~*#x;@~kk;=6 zyP2j>2c=Q2$ALt{H+?`S)$bpZb|5v8c6WSeUUK_z`VOSnwhSDF>R^j+7fFpTO`hjJ zh_VM#>_8g7^Dzj@_|3`j>HHD3mcb|IPG6n1Rx(tM!GA578)B+b!V+r+K5 z>Fias0qF=N2r}OU3lJ>*0MhXyY51-W-kSU&#{fP^AL9|(2A2-!FKx*V(=8vAfgtl{ z+|FB&e%QM{NUZ@00G(b?g+cmi4?q>-{Qe1~qeW8m<;=z;{TYV<5~TBcj#^GRp|PIm?56cT z;tc;B97;ce0f`&K^m?~QdYYR0&?$fED4{`ehm>Xy5DUR#DOfDe-T|cPx6s1wPJr6C za-FpD`xF{T|9VI|pP#c%S@@Rl-%FzXdHy%=2qj1nZ`iCo_jd-`TCjB34oPWA-zo9y zu2)FDuVB1ukn(qnq}9}<+PKsoBSiLl|7WJj<9xJS-Qk=i_#- zyB$cvf@VqSDueIP&@!2>4lShOE0ok>WwWCaw4YoZVH7G!O z*7fPMGpdY5WLx}~?0k~O%MA}fhXF{}`s6iD(*{SQ*Nf^MEs~nk$p=Xdn$ zY9)((!LXDHUGp&GI=yUfGG&FtCwHke`1t)e-J0xlIv@bUZ7+OrQ0~?ofK&uQDs-)_ z>qByI(eb$l$+fLJ826Xb4y2|AkhV6(gXEu|ml7#~)MXX^BT@U5w!R@_1S!DL>nDe{ zOoPeMLc+rZuPuHap-&7*1IrZpv~an%@*>SHmA>mf+bEl4rhG@p*{2@X>4 zI}AYTo6!RaIC}l4@0z{(xWKRvA|~$Ij#5)>K+0i-f8BzFBj@!GHTJYu8WQr zF}c;6iQrjr@>==@l#a|qJ;YLb>q55}P=q!9FkU>A}Q{L5#t zn#bW|wrV%G^Fpgxo&Sn`YI9xgcR){!WAFh6@zyX%;S#$FdP<68bCdx<*L7G3ZGwV< zIMrjIK}(Xq)3zWXrv6JF2uEmA>=qRpM{XiE0l3y57)nj7@I4G5{bn_2EuH@Q^l-$a zL9}(knaxED(+%q-K)Ti@v21q6@P-`-fiUZkUJOSPl=9Y(7Ni-(ry0l^ zREKzCXml>H8yW1#egYqurXIDV26zO~xg56*vEb+1t?bzjO{OI;-A6DcN6aRZ?m-$^ zZYeMnJ!wgxJg>IKm>RbNf`Pu+uRm%}_gK!Wjo407D4-9|5|0zheUkPzAgvLQbdpj1 zWVGbSQsfL0g*Rzf;pbg8*5d=X#^Y2^ZNBFV3VH<6=|~bBAadPhyx)NM5fvHrrS0q0 zSYE7K07MTYGbkYjp3KG6m60@b!(?<7W+#xo4M=Lvz&a8>@i9~(+_}|Fdt^7!0d69eF~7yRB&`bLMyKe zk8xYzdBWBDL^g8JHfBS;I5TFb1Eo(+l7eEWh`52ai`Jjq?5WHet&wXI1BZ?pYaKZc z6au8EjHVcNW&UA0ceQ?Q=4-k27}iZlZWXXM}@8%x68}zkk7TS{apwgah( zTnz`(bzURO-Ll{fdIm+U+Qky*A7A_1!7c3-FN?U2r=VazTb9Lw6h)%9_@sLS4PEvk zR$HS75)GD*5p!5&AFb^TfrlstuTkXJ zRBB)Hwe@d6;3Zzfw#0yh@>g5R$GWPbb&cdmb`*#hh6<0=)bK=*L}$3oLf2Mu{C*pe z2Ejy)u!x6C51x#5@Y#R_y;Y=+D#jca)y?xtiqx1}D_FMM)z)wtYq_jK*MHhn4szU` z79XU+!(XX1LHlk%Qs_TP41+Yx2$GAmz!Cb{38>5QXz}HCZVP3qbZm*#$d4G%ff~K? z1t8b3e-GNG>}8S5Z4DB{{duk`GQRa3dI~ub*)p6!N2@KZRE-p$GuU)TmPiOlxUSAn zCff*1cOQ;?yn!DPL_olprsX8vMT%CG#x!;ytt>OC1C>$WGl&Hv#pI@WDW=zK9Cbbm zs0y_-p9EtpS^34+$b~CH89{31NW??RRinp&iWLjG&a1FD7)#NBHUjE$G+HX5rF1l# zWR#%7zo{|pkW^0+RMzpKeOZvr(7yr*EwPhiS(Lbn)F2Jl`8rpw5H?&fM>mUE_B2+0vBjjkcr6K0ixla~F#RhNdkhXghQU59$1k4=O_0hflLx*j*Q7L z+vf;V8UpEwrWTC56iM_e52SgXWyx`+Bg)wpAD6bIQ{CZqn;nm6+Ap{N9ur`~m#7CI zv7#iP1c`j%P%VPbe>a z{Q#_q!&jG+AXVgL$Qu&j2DHM1EJKFoY*_QX7UlUlS#krQ&b1)TR+3t&5>G*H0#z%@ zd~^N}Rk~Q3*bOxQd|!c_j^r3`Mkg34sI+n@r%1Zvf6W>jqRbH>1TUpN#o*?{B6{ z$OWMwE0LkBQVD@{b)+Jye2#ysZX&*^q=bI2HxR}6QjI_NdzXxwi0BBUOoIePtivPi z4U^4qIFK@!$RgW6mL`mBX$2hV2l+F~WE%m6((gi&9-k3eOsUEP2|&IY@hV=@a;2-w zCv|Qs(QUF4oY?&S8!)8Ml8pX#LolGdTxlgiIzO}P%?v~MEcs#g*-#Dov-^5@49=dfdWk3>=sEPq- zuD9!Kl!sgbbIv+r6H{<@j>H)v6p^0U?Th4r)MdwYCX7dR-1l>rd1_Y4S2yg&(m{~G z$pt&gWj5GU2sx(_K2@KJ5Xio(0KS3WgiMLkEyLGV5dllBjw? zYIs&O6QBc0WLc0p4z= zNJCFU&WbTjx6*Q?v0U`|msC=N1mU}z{VbqH@=H>7mjFnEPYn^0UG||X6Mj@_wFhZu z`^hBV84{#!1CrGr-L?4Z+5Wa65=rVmuDE?BYE30WUQZ>2RKqm3sPsZKzI$3sSBeh zArp0CcEZ5**y&@4yLCI_q#B`!gyhZwn~7hN(t}cweL;}iIg)ME#w{oc%7VMf+@C%g z!5f!`lF9A)0i|A!y9rmo?%Y6+HpX3UoX!ZiKMJr*7A!9hfBws?FfKeMFvuO=lt5{% z{6&C--t`9LlrAZsef4atiz!cfz^X?0lq}m&*RFvZfC)888|28Gq~Y?)DsMs33}VqF zw-M>$jkUXw1Uluo0MjDZh3pA}Me@t%NJbK~KJ7418#V}1rw5MAD8l*&bZHN7(q7ot?;XX5|=I7%LOlEC0ad{+ZdOjWoq*-UPJcw{| zgJ*HNV&w%#pd|KhH}N^GkqlclYp_d-$)1or#qQd!?y{>>N7wZvF(6@0W7r@_vpp|E zDUvjQ;kP2nvdmM(C{=`^1ZhP&D?RK%dJ0B>QJDwabxvF(T$&HMYQ88^;cHShge_fF zOg7$)-Dvd`Iuq>0;V^ZnqaMNy45COjjD1M-hc$|ndR}k!)UX-f7lle(dzDECM#f? z9$vZOMT1qII-z$G?mmYau}AwT6-X@FhQR={)^)Xwz)FH{5{IgijZ{L(YMeTl=?1Oj zx;+$kUN*NJ!_4aqHUopyLLKBz#^0YR3nYNLNW*OeOmB=G~5YAgvN4oYYcSW2d`a zVl$2rGqjqkI4`BkScb)NH&!mK-Zd&2s}y&`O_gk#kLIgr!(2%>n|nW*z=Tn>XpmL` z5?|Aap(R1GV@=QgH?W=8=<}QjNfNMDvI9w9PpuwEDgY9gGID~+5 z`_{iI9W_YEiMg~r1W6Y`DVzbYJ$VD~E^Q@95E5P=z5;jKkQ7B4i8PPPgT+WwS&|}~ zDt)0Hx$Js#`@fo^wMz4!qum!jZ}A$INiBzqq#a0+ZO2)}{Z0X^;_l{o08un{#kFOJ zXzOSvA{5fkuJ}4z=Ngb`G*GUMNb4RX@2vxtUT1+cJ`pUP`?OG(&azn@xq#}IcCUD(k{(Dd%e=QVpxce@)q%us z7iVJy8a-yCd9_RgKtl6`K%z+Lj&R+gz68CzH+2 z?7M^|>diBfRkIe21#Mpr8egRfyLR6IPH$M=$%HS2wpTIPxEU1k-<@TfXxzib>fl?l z#(;EPb+&!Vw0dkINLQET#@Y}a+jLyoR&O+=e^pw)3=BrL;4_jzuN1ip6azJ)v_=l} zXpB{PZ_Ec9keYYNlB8;X5{OirmYpqg7?QSO-fM&w+qxqJ$(A1RLE)iLX3z!O9?Nn` z59Fd(bwNpZY^3<>2Fll7hh$CAZq|zJ5T)H@6==JLZ9{2Bi<^#oka*dYnyJl-DaP8h zmMnXcq^13Ju@&|YCfk9;5iY6@Kx*h~c{LY->2zG!`onkY zw(BJ?^UHx;!zz`Rl2p9!fCawtwYMR;;yuHrOZoQnOutG|+x5FCt=!jD^n!@9Qvni} z)(>(Au`Utck7z8XTS-*wHkzwmLf~J81_|JbOzAiT(l4$A`OPnxAJQ;9AoYDT5@I#= z2{UMUc~Ban8VIZPns;f{tMB`VOTA50TC+4M{62%iN5bX>I-X%ti6KZ*gD(Y@c$93q zq(4j}U}8mG0UbDMOlb^vmjk)_$CJj7X+*XSn>{>{J(6o+)<>9 zqpw~M9(24B5Z6OA3+eB=aR7jM)>_7Zl#TA&Bgi-`xBLEnzjqzJjJNN~(=simJDpZO z;DgA%2VZja>bmakQfCtvM{9yjJ1`I!2_p!9p(@SGGST)9Pa}Agwxosq{*`%}T)S^c zsIpyB>xZ9@-~acat6<()y;%k`-0DB4JZ&R-U!2sm0U zQh#WKQ5vXJoXYQ#aU)Bf=DiKw4^`0j1IS3WEHtabej}AkIqK3Lv^Hv|nAJy>ekwi! zB;}$^`(Ohl*Q-dJ-RVjQZhL#>v-(8`D9qzgG5$M z$wj&^Sev7X(^&r(wgOIH7VHW-y5g5zO8OBj_y7g=}iBg#IMe9Z|xeG->6xUFHaq310BWgjOnSNmepn79HWQctB=#O!G^R zS!1fpg4&pMNBwktG?6k>!!RlSB8%cL8c|pD%VHNBMup?syu=CT@xXhQQri}^%(*=Y zQiBvJWk!m^<4yiGDX`d*mz;9+i$ceM!$wt@576#uuFPWrx~jIxm=YmE`zA?>%UFm? z>0fiyh&1Xh`;9_%G4!Wgpe_}9{4ZUf0K_kIS6OZPKsumlUsg=*lmS?*K2 zpxvQ08ZkkT=w1;;VJBP3kZDC)x?kX8d-XK0-Y==vz06&QY(S1(JOSTfz_m+(4sO{{ zbor@tfcKPys#ABr)jX?m_JUa*p5&Mgfbo=LBTfyMv?$_54O_D6H`p%NYM*#s|kR6 zNUk#~UqD&>O0}tl3yfEpPOPUEjg7)2VL-+YaW-F;ojUnsLpP7Pggn`nE^y_E4)CBP zb*x*-VVbB$rTw9cUM@EiZ8*10Q4Gx~K5-$TEu=JdY_PtM=~lW+r}JX{cTVjM5~QXt zFqE3#?}NCt5Ew9_^DjN>gg;Nr1HX@R`3VjJ>#$us>L?tsed)bY$pe9FCWiru;t^I< zbOZAyfh86I2^5=_jl{Gb+seg)UD7<%Dzrt)OlMbVp}ms?l(I{sl>!dO`FK(k)pgQ_2Orl$f&EP7SR_@G*U7-_-!sPF}+!vK#~z@ zxM8@8Y1-kIg(Tv4H>tgjX4*&Z>7oU=i2VxB=e?Qrt$nP4FJ`9~=E%-$rj}RDn=Dhk zLSn%@xl~XtJ%{LhoKe$aq26)i%O&j0t?S0j*cKDkWfQFZASwO4Dd(;1xH%EFjO8zW z%*CEB7e5O&;}1b9YwPBHSJRO%DtCU4M!^TE$H_LfGe~L%60eZuVD9v?L6hW%pZnc9 z$sQr`e&x~Iw%9mc@gPUPUMI=68Y!wxUVG%bJ%x9YWUsAULLF}FZu{l#7$sLHaIR(dRQqzCjd^5BC0&5^z0q$hAv);H=<$Pf zC-;t<9vH$+dzL z$DbUf<{21d58D5_&3{3xe_H9AV#mf06+Ni^FNtxO=Ya$zZuzV1hFzJz>3=!> khg|*XS>xaIH+_}<4}NDJT&?g~i2wiq07*qoM6N<$g8k;;9smFU literal 0 HcmV?d00001