From 2bf8e2135ba4d0892c8ee7b9204beee035d61280 Mon Sep 17 00:00:00 2001 From: Jonathan Keljo Date: Thu, 1 Nov 2018 04:39:06 -0700 Subject: [PATCH] GreenEye Monitor component docs (#6177) * GreenEye Monitor component docs * Update for consolidation of sensor components * Apply suggested changes * :fire: Removed featured tag --- source/_components/greeneye_monitor.markdown | 126 ++++++++++++++++++ .../sensor.greeneye_monitor.markdown | 18 +++ source/images/supported_brands/brultech.png | Bin 0 -> 8783 bytes 3 files changed, 144 insertions(+) create mode 100644 source/_components/greeneye_monitor.markdown create mode 100644 source/_components/sensor.greeneye_monitor.markdown create mode 100644 source/images/supported_brands/brultech.png diff --git a/source/_components/greeneye_monitor.markdown b/source/_components/greeneye_monitor.markdown new file mode 100644 index 00000000000..596751358d5 --- /dev/null +++ b/source/_components/greeneye_monitor.markdown @@ -0,0 +1,126 @@ +--- +layout: page +title: "GreenEye Monitor" +description: "Instructions on how to integrate your GreenEye Monitor within Home Assistant." +date: 2018-09-02 11:15 +sidebar: true +comments: false +sharing: true +footer: true +logo: brultech.png +ha_category: Hub +ha_release: 0.82 +ha_iot_class: "Local Push" +--- + +The [GreenEye Monitor (GEM)](http://www.brultech.com/greeneye/) integration for Home Assistant allows you to create sensors for the various data channels of the GEM. Each current transformer (CT) channel, pulse counter, and temperature sensor appears in Home Assistant as a sensor, and can be used in automations. + +Configure your GEM(s) to produce binary-format packets (for example, "Bin32 NET" for a 32-channel GEM with some channels configured for net metering) and send them to an unused port on your Home Assistant machine. (These settings are in the "Packet Send" and "Network" pages of the GEM UI.) Then specify that port and information about your monitor(s) and the data channels you wish to monitor in your `configuration.yaml`: + +```yaml +# Example configuration.yaml entry +greeneye_monitor: + port: 8000 + monitors: + - serial_number: YOUR_SERIAL_NUMBER + channels: + - number: 1 + name: total_power + - number: 2 + name: solar_panels_power + net_metering: true + pulse_counters: + - number: 1 + name: sprinklers_water_usage + counted_quantity: "gal" + counted_quantity_per_pulse: 1 + time_unit: "min" + temperature_sensors: + - number: 1 + name: back_porch_temperature +``` + +By default, GEM will send updates every 5 seconds. That's a lot of data, and the databases used by the [`recorder`](/components/recorder) component for history don't do well with that much data, so it is recommended to configure the [`influxdb`](/components/influxdb) component and exclude the GEM sensors from `recorder`. + +{% configuration %} +port: + description: The port on which Home Assistant should listen for packets from your GEM. Must match the port set in the "Network" tab of the GEM setup UI. + required: true + type: string +monitors: + description: The list of monitors that should appear in Home Assistant. Data from other monitors will be ignored. + required: false + type: list + keys: + serial_number: + description: The last five digits (omitting leading zeroes) of your GEM serial number. + required: true + type: integer + channels: + description: The list of channels that should appear in Home Assistant for this monitor. Data from other channels will be ignored. + required: false + type: list + keys: + number: + description: The channel number as it appears in the GEM UI. + required: true + type: integer + name: + description: The name that should be used for this channel's sensor in Home Assistant. + required: true + type: string + net_metering: + description: Set to `true` if the channel is configured for net metering in the GEM, otherwise `false`. + required: false + type: bool + default: false + temperature_sensors: + description: Configuration for temperature sensors + required: false + keys: + temperature_unit: + description: The unit of measure to use for the temperature (F or C) + type: string + required: true + sensors: + description: The list of temperature sensors that should appear in Home Assistant for this monitor. Data from other sensors will be ignored. + required: true + type: list + keys: + number: + description: The sensor number as it appears in the GEM UI. + required: true + type: integer + name: + description: The name that should be used for this sensor in Home Assistant. + required: true + type: string + pulse_counters: + description: The list of pulse counters that should appear in Home Assistant for this monitor. Data from other pulse counters will be ignored. + required: false + type: list + keys: + number: + description: The pulse counter's number as it appears in the GEM UI. + required: true + type: integer + name: + description: The name that should be used for this pulse counter in Home Assistant. + required: true + type: string + counted_quantity: + description: The unit being counted by this pulse counter (e.g., gal, L) + required: true + type: string + counted_quantity_per_pulse: + description: The number of the counted quantity represented by each pulse. + required: false + type: float + default: 1.0 + time_unit: + description: The time unit to use when computing rates (s, min, or h) + required: false + type: string + default: s +{% endconfiguration %} + diff --git a/source/_components/sensor.greeneye_monitor.markdown b/source/_components/sensor.greeneye_monitor.markdown new file mode 100644 index 00000000000..ed0de5f7268 --- /dev/null +++ b/source/_components/sensor.greeneye_monitor.markdown @@ -0,0 +1,18 @@ +--- +layout: page +title: "GreenEye Monitor Sensors" +description: "Instructions on how to integrate the various sensors on your Greeneye Monitor into Home Assistant." +date: 2018-09-02 14:13 +sidebar: true +comments: false +sharing: true +footer: true +logo: brultech.png +ha_category: Sensor +ha_iot_class: "Local Push" +ha_release: 0.82 +--- + +The [GreenEye Monitor (GEM)](http://www.brultech.com/greeneye/) integration for Home Assistant allows you to create sensors for the various data channels of the GEM. + +Add sensors via the configuration for the hub [GreenEye Monitor component](/components/greeneye_monitor/). diff --git a/source/images/supported_brands/brultech.png b/source/images/supported_brands/brultech.png new file mode 100644 index 0000000000000000000000000000000000000000..7b0fe6e02049a327709f3190248c8a4a05e701e0 GIT binary patch literal 8783 zcmZ`n(+ZGeVzwjKwOC^J9I#?a6T#TutUgo6P z(}4}C{Z)_2C~`i_J}3dBV#5DP{p@`CXz^#h>7dzZv31U} zPr<7mAA9KU6%(a~QR*e0?ew9ixQ$dDzpHlqCsZNbyndL)Csv`jN~9x*zGFI&9gH*w zH$(zsXd~n(GKHmT3bHX^{Lq?>`Q znvmafNq+9EWPFyeI6i^Z1x0t9E65JRTx@8+Xqmwjssd$AJ+eJX2B|_WwkblN0-I>r&b-vn>k%XREze>i z?Sid3SOe?NcTY$^Y*ryCvuN1Oy3Np_wntk_H!Lr@UVG}xy9_83SOsdnog;yOT&_=m z2*C+eNtP}`5)C~dLR>>V5l-~>o5vQ

bYYm!eoORtLY05^U@f<|HWL0FHk!j{@o; z*a#OAd}1!pQMDxcTH#Ok9V#7m{u%nG=@;|FZBUX8jUG`a|Sv{ONI6e~l6@&7OD> zIc2?nzU8dvO)wxtLNwR-Z-{gn(p)C)Ia7{xug>US+apHzx)RM|mQ1K+dP?8G#fQBT zbiCqox&uaxw{0T1mEc>sH4AUQW-nuj8a6h?Rhmup1PN8;;G9fJxPN@D)NKIDcKWTY!~8 z5Rp)UnwHqWDv@GJ>@Ssc*xsanT~rNRic94f3co^`mcLp}{EBA5RUd%I(sYSkNkO9) z*_1{?B3s`hz}Z|pUnzPu@PXPs4M>TsQ>DqFiL_iH_noc@&Ph52q$By4Jl0{(itvjO zcEjLaXZXFlK0GF;mgdc;*bfNB59iEW7UZ2jU}Tu*+5}QOB59Md1rQT+^aJ@)r6L{3 z1OALl&Gj4kq-cwfRB&C3s8GARTTB2y{-_Es9STY_gUQ+`dmeA~zgZX3K|#hwOirCf zlu`^EF&Gyj7waczX`%BjGrXXO2Kbls(v)(9M{iAV@pVfD3dvCp|1EO%`|N7UaG(b9 zi-qQ4h&Ct-D+p<(aKfM7W&H?Fej*pw!iB2Z**m&?uAxZ4$$N`;ZQ2fJU@IA)Pq9I- zL9bz`2T#o;)MMI1ih*El%we55pZ6pj2Rq@b@l%CHV^WOrNDmWhQDj6AG4|Gc1v|4R zeoh{+5LxU|JY?51n~krs9jb1h2o-;K9d`zWC832aef(ugsf$6O85$LimV{!vpmTo3_*UY=lG76%liJNO>=ICMY3GcfQV4no<^5rHiS zI5_2}sY)w-twUO;`|2;g9k5<6eJycaWY@PZYw`8?xHMI9G=^tn-@ zw!%!7E(F(6bBmd7PD{9~Q|at0L>yZZc9x8ZS3&zozo&P}?G@1Q@7yUtjCSSN&09o7 zPuRa~N#v)8f|yyP2UyG~lH{&GG|jn5(ynL$V{-wzL}B>yw#u2@@7(&^H`Qzo`FmlZ zIt=w&|E6=?&9ZRQ=!WOWTnRcy5*>T<|V$kfS{q>TQd42kPGzYpD;~O z+dH};JyxXLDGUz8=SbKPQOke~Fn+*H~g0<8+JK^Vu7-lSB<#i|jF>2$IdPGRkxZ-tPF^=(0 zwBqfDx)GY6W{j)p1fThHoTGwGC&J^3%aV#8d#(F_)p(Fx39`V+`9S=aui=n7@;XEJ zin^kcu-Jk=ITQY@(%0C6i?_;cv))WZ1W6!&%XiQ7vD)oZr#g^_Xp7|C8ipRm6dLw# z`2{Y@))wQ56+W$3g>mK^Bu!Ts$DK=tel6%BsHGq}izwJCx24Q#dywx-4+H$vOE|@g zTggd1ln*4CaEEf7^?Z4#`{&iq1Bt(d1{QA^?uC=TyaiEPgTK+5`nld#H5jCG@D#63 zd*R~Zh4?}Xz6uMUl6XENQ_JLgHm`2y;)Rx$1e_CfZ_6cG5i>QG# z+Z2qj6*m;jdM+0&PAgjM=O`hgz?A5u>)03W>GZ+Bwm+CAC2Q<77PQ)ExwL7!q{us| zK(gZyLA_?C*vg+;!8y6_G#WywH>)D2fASeA|2-Myl*Z&Sjr?Bx0uSxuCiq!*FC*C7 zyPI-P%)?X=CnTDQ)>3|S2Wn4%ptCslgjd0t6T?oc^e1WY`y-hn2Y>v={1nthnm|m6 zJYC_)l#-LXdU zSnA!FtO}o*uCHEd{@ic`>W>EC8~(QQPEPt(`%oTOeoDALJ#BJEA)}97dBaG+XfU_k zu>r6JfxSE5cs0{$x0=j7qq3@lb!B2*ulcGeXQQQni&=upoQ$0vvA}#8XP+h}i9>O|*AE$e}7uVx@vRkH3_lrdB2)6vmD9 zD*V=s)FY{o=)bN;DB!I5lToPjrvq#KqQ@xIhxp-6pcyX-;DjbTw~?50yl>b}D69G8 zxL;Og)?zAy@4&8qtLS2bKgVOSYeSa=ctP9hhoTR0oP95Je{fw3ANt6x5h9BpnCmTt zLP|Va_oniMRBAgrmD6VXry*l zT_ihW0q^CPMh+J7b3|LB6ti~aVs7Kf?FGqiMHqYGWvQ6<^fCJ7vFJH}x(j1H>>Yj9 zR{JD!a8szND>qIOi-ogy>Lka%GM!;%SnBk^0k(KJ3dV509vLD%{%)eg0w4t-^>|3X z4Qsu_;9?jqP$Q^~o9F~3W0~#85wz;lnI zAE*R`8I(>X(}Xr&a~8A4$m^oTtxRNXoBMr@Qy7Kd{4W#iLZe*SN*S2~Tvn`4tdyGX zF5uaU@WAN{nfNR{k&EVe7dQ5STRq!9BFr6UU^JQ4rTN9m5t+#^YpNMZA0$?=Y7jHC zD;)oNc4f~vpxz2woKdWIZ6^i(njRgs zV9zCVtH6RJ%-Iw}Y#SG; zqS);94bojfItC)1!O}VCt=m$25sFQlU?_;M6! zZ-*z^qxb2~%f#r}xBNU@N=B?p(29E;Un*HeTU_hCa|t{)9BSoAVlRWE@rS2u zSmtRo?5%dhkNM&+Z~L*&CFTzAKIN(=(;(Hku0#FI(YPQ?EPu)#e z?|UiuXpI*gk4{d1l3>~Y7QfJK&~B|Dc}pm|_$wc$>wS~^6I9ZHV6G0TK*CIH_oVG5ne80{2@*Q_ zkeCJ^0Jz0BS-G1s!wv`YVUa|Uw%AsKw`Wm!NJ%8>bx#xG&x?%+6i;*md0vqdXL|ZiYSRB2 za{u*eoF#>bk+0F0eGS;p?6T`f{f6L+dLk3dxMDg7$*ZV04`*m_IFtmk2sAa4qVUMU zQhBLW9Lqj~4@kA1N-OpV1(C&e6Y&wHHyNqUac?fvP7uQ5;Q^5!!((_+I|!*d*!(?- z2|<^~z^dOGuo2>8qyRp54Gbb%=7VTUsnS4}<|C8X*+pH2c}>%@H&O)f4Tm3tSQ>5q zJfeCed8RV=E|Z8JVg@&aMdC2os!$Hi0D7a~v%uP}iXTIZm`nQ_Las6@smEVqRS~;$ z6x<1fs}&nDIp&Il$PFU35x~WUQSPKYz`;@v>G|h`q(C2}!n-ONVrF(W2Cd59t1+sX z6|4o<>am!ZL>c*V3i0hiDQtws@@VKMex=7ODrnMz0e_a#1lns%>b?ryEH>BNgLQ4# z4gQhO)xq?i1iA2IkIDmo!`=&kE?m0JH0X{Qu_~G!ElhMbI(Y)jb$YX)%ZHlv?y#iE zq$80l>tMj(Bel@YT2Hf+#;2j?Q%K7BdZ>!A?0ksB#Atw_FYb08)+((EcK=)?wpsA# zSVD!~`nBbln*xff@BxqCX>HcOy{jAGaz$L54(sNa;uQx&0-4bP)bQIJf8naptZfD9 z%cZn*h^*U9q|=HjF%q1(yMp4wVJ9KP+G9vl#R1nVG0oncfFUtfB-@=-mg){6Q=@mx zQjLVH0#hw@j~VVb1rkMd7h=09yzMdD@9VhsmR}Iii!esb?*5sz#~j70{hp-dd-~d@ z2y|bG%>e@KB6+*_}zbA9wV*6O2SUd&~1AS04A&VtUh z#?{Z~(~^o@k3M-Q;XVa%XH!W5R}o&MAHvOM%(Ei$(0D=~>nvb2 z|IQB$4ee%rUL;W^8`PzRE+p78DWyfC%>_n^l)!(YHNLrii*UP{s5)>mddRPbz$1Tt z)SoB%^S#9-8*tRUfl-v@9aGOO`!IvRAzcRBscUvpp*Hr&P4-zS|xc=32}o zVke`p5U_+|fZy_3f8`HD#vs)uEH!#i%??7bavEeScf!3q zyy3r;^7B^YLY4SQ%%#-uQAOYIQ`p`PFb~$b2JNI`EIU6Dxtdz9Q9f-rwtL|z8p~a| zF<}h=YjQWpPs4A?B?VJP{?G#Ba{!cxdAZou7MCdcajy6RV0|>{RBVy`fzI(Udjw>Om)c{^Dl*W z3Wfra*2R$!n2Rz0&oXKs`LO&84Iu++rEK%K+4P|)W2zcHH1ak79!NJ#3IY$Cq{@86 z)i8EX7>!O_;kJShr2o+Qu}vNi1B-7UFEh+;)G-7WE7Pn$q+93Kt;jcI59yFNeN!$% zW`)A^r**Xk3C%Gw9Z{r>wxK75{l4U%4v=y@61jOetw-z275|}J+-SAzLn}Pd7cm(Z z>N`2CcM`GOyp0il8o66KEP3()Z{KiSOY+qzK<0M&g!7^fPZed#1e*4lhW(fjn#{JB zTa;W@69vnTF(fE!TiGJ=_&|wWc`Y?c`v$n{fTmMaF_%m+-l@|E&8t_@W$}8_PoEDB}LLQri^XRnaJs_kx~`B_u~R$-ZSY+1CRSf zNO8a-WQ#J}Iy^{4Bm@oKZYeL(El+XpJJzAgAMtesT2?+IZ5rZ=)3V)zFX3jhMco43 zWUMfr&pp!4(SW&cZOnTNS{%(T1+NzBZMzbUP}&~kz)+lma)=_%N1ObzFt5s$*&>Lm z(c)PiY_)E=-D#`_39I@wb*=7yWJdQdadOzL1VFAV7!Q+(3&}=en_Yxclv&XK*rvB2 z;q0a4^Z^f*d=aP6-UW|LXQC}$$FW&*Reg0BB!Pm7E5icX{%&uKiRvBuDAswZ51!%t z@-`u?4B&b$Y_2Gj*-;B!LRkf?5XTBTJLQ?sEB&CWs9=vI57ca_H*;x>5qGC zBqVR=@nakAm!zX6KmAhBhK*8`1+o6YF#>A~NKBMXkka%W-5^lws1^#hAzI-uW#^7l zs%WnC4CI$o+lRm!LDlaayY?=PjhHS7KGi2H??ERqNMye7Vt}4=XxTyHK3v%oC%kIN zs{HvKh1lu;9`}nexR3X{%Fh>As?t554VNL&p`M?50ANmC_Kz9srWJ6VgJ_`Fh-N%Z z;%0~MFhSoV>m_Hv(aY7x%dabI^$i8>!3!q8>Oo1VW4L13&RlcDm$QA(<2W_?>jv!a zEBQZgxtMtEY?{pEc#M9e%rR$Ou&qf&x`R*fIR*pGdZbhZf2x@9QVQ{OlFb;i#gU4 zb|N9wsI0>8z4r&PV|A!3u>>Uwo@QO8%#A-6lCvo|z~2x>n*8UCc7F#6c&D*mu&pHr>?l{md(_;k-7+4DVW#+Yx}pmJKI0=bjk66%^<0mqX$*6BoRSv!y2l z%bz+yQXJy1c8W<$!2f00PVRm>F;wSJs5pr9JQ%j%t#M;#TCZ>jXhCjm)tzZ)~z+T7wIe99xB#dYI0_dIx?cspi_7fefe9^Z0f| z#}&BaorRn5M%#L3V-7!Ld5&@FuHKfMXyC(EC1%x5gVs&BqiYO0PoA(!akt(Wgrk{l%H}C9f;9;?8KHSpYZ>R{~k@DIRXq)ujk(Q8gx8E_nSez+TXn5 z>PPs(#~)=Ec0A{VJE!6TWg|1DRwGG#^|#_HOE1Qm%?@b`k30JnNEl_LsbpyP56Kze z!)Hr+8hs>SZbzf!nvJHmtvpMa?yV;ty0Lrp{RpI zb7um0dR_gzmCRm&^{-{v7pcRj~-hLMV|sm$!f(gs*}De}6b6Ixdl*olG+8BsSz*BCzWf-904^7xF*)2R13KVpe^kO{L|3yP_Lv z_OzRf*%{PGU!KU7|3All)E$p4-xZQTMv84b+iBZYG6jI z21)Fzo10Xse-rr=7MK#)%G3DU`IzVatDb8WIWzzwY=PHcIvBT_`m)l=YIrrLE0Qr9!bX;sbeJtE<0In7e&Ys-PHlB2X+`QaEHc|XGuX6w@K#)SM IoO$^F0B$^>g#Z8m literal 0 HcmV?d00001