From d81e6d5463349226079718349415e031d6469cd0 Mon Sep 17 00:00:00 2001 From: Sourabh Jaiswal Date: Thu, 22 Jul 2021 09:01:38 +0530 Subject: [PATCH] Documentation for Selec meter (#1295) Co-authored-by: Franck Nijhof --- components/sensor/images/selec_meter_em2m.jpg | Bin 0 -> 4148 bytes components/sensor/selec_meter.rst | 117 ++++++++++++++++++ images/selec_meter_em2m.jpg | Bin 0 -> 4148 bytes index.rst | 1 + 4 files changed, 118 insertions(+) create mode 100644 components/sensor/images/selec_meter_em2m.jpg create mode 100644 components/sensor/selec_meter.rst create mode 100644 images/selec_meter_em2m.jpg diff --git a/components/sensor/images/selec_meter_em2m.jpg b/components/sensor/images/selec_meter_em2m.jpg new file mode 100644 index 0000000000000000000000000000000000000000..71117d41fd95858f8a4a44a39290e0243c4b601b GIT binary patch literal 4148 zcmb7HcTf}B(oaa}H7GR*7zCw*bdVB3xQK}KBDqunA=F40X^OPaL8M(egkB>h^lE6* z2`!*>q(~7Ekq_Uzx$k@T`|H~?^P4mC+u7aO-Pv>Ya^`Xg!0=FAQyl;V0sz3P1Gt<6 zyarH`kyDV9QBsgoP*G7*(=yZ3($LUCuQM?)bKii$xNmTA-MS+wbc;{?HW!z$qOiD> zjJ&)&kD#)evaG74oV*N>ii(PshL)Y4o?V8Qi&y6VEtl;82nApaFa`p`03;9~2m-w9 z20*U@Bmw;n^=~011A@RL zKv!n}CV>zVM)AA4pldfTX8|;zE0+)u1fUE!kA!i^-LZoOCbi_sDH_*@T}z4E=06qu^xrzH+-cYpX_FeEiirzv*lpx#J28Hs#mc81H2Y`R6Mrq6FfE z%WBe6!*8)+lPj$-K#o-h5q?5ClW(i`01jb*K!AS(sgBdH7V_MaWUxW+49m;P#}d9u zqNUEbwZ)vN>;r=o`uw`@7m1euG2I?bD=uyA@#}5xOAI60YpNmzWlaAx&S#^(X(^PA zuw@Erbf-~Iq(vtfX~iiL%s^TZig0i;`P3HuZfygGlt|%RKGb~R3q&*ZOmgXI+(M6=(4ESG;(Pu2Kc-ul>%jm#@7}a$b>v)Mz2(jz<+N1y)=N@AOBXs25J77m)bRDl$@GQx^Sr&)#ylzs%v7Y4;vQd_9U2k zIZ3z`cknI6`Axc2;5i=p@r9|wV@~h}CD;&OJjR*hEYtXpKWJWreLg>K^Q&7F=W<8W)fzAsR33kr{ry{g`^%0Wd4mEFaX zzj5}g)nKZ19vOcG-t)~4XYk^2SDpLkhU7azaG_|YuJ(TNB;W^M<4;>|Z;pQEZiXp2 z)l8hL@8lNBWh!G(BGicv~pBb~ZWVQdlzXQ$bn9+Xd)H(8!N z=?)M(Y0ziJt@e-p0+Y>Dx83eO7)^Z$@T@24TPi6bV3nWMj?;ZEae6}4aX*|-Ozulj zPH~Dal*2h-ejN&koyE~9o`x#09?oA!IDx)vF>e53`bZyj-LWj~aw_m&BrLnwnKKLk zG#jzMERj`BKUg+X$W)^Qp2dkFdg>0Kbf}ebx;Y#KXFQ=$!WCIMF$%x`RWB>)OeBwu zI`b%Ohp&6XpSh$&NJJnFJD%pf`lc{d$w_LrVaVH_*p^=UK;Ovw6yEukIjx@fspFTH z77q60VwNgz%1m*4UFS=)a5>7!#pIFH5zDDYbO0yw;re6p({j;$wDNrC7fw&O^5^0Y zAMWV88!bcbik+tOsNJln({6R9l#y2G`LN3$RzO^4VK`5cL~n~I?H76RIF@`Hd}!v_ zZ)IoXh88E0Q{kS^@_cM37`86QFKfQS02Tss5TYJ@Kto*?{rPps=up_Sf?+nTY?1o% zmLd3YN8>X~7gH5AHL%)$08V<9W|`ktC^-if4jhsgq9%B3X7K#wC{jw@u^DYG1Vi`i;YAtNZl@lK8b~(y&ms;CIjnz} z0V~UMyau4WSa*LY8dPL29$=%2j|n+++#(23a4Ps{bk z9eYmmGXPPSbzfD(k0aAM^gLT%Jn&%MoWI94@b?YOITH|n38?aB(p@#Ws61!ud%t4{ zC}T4*H8F5~cWlpk^!P+T;=S_6C%9g)>1odjF#ug@g_rRV9BeC>kF&C>I^Lsgg2H9f8P$utSr3HOedYG8u2HYVn1AWXZKUPV>fipp@Vsjf zVkPD3O0{-3Gnf!W*2$cyKws|pG7)+=d}}M$5?v;Y9s+jccCJm&Cs;}9xHl$&ENzgx zPTFC*UZFPGSlocwA-=$w%;b9(K$8|CVLo+Fi`MrdQm5m*cIS;d9d9mKFbahWT##JT zoilmLJWdMhm%?tu&_4JK@Dd(XA=*4U2gu0pr*>3?buMr-g6_&nui$tZ^ga znKS`seN~M>Hwy)+gVy&+`C{thI2rxfD&y&#AJV=#$eM3}GpuipbIsQn`{XzyWQrjt zuRZlOf`>#M_DjNc>LzNkf$oT?t_W>$mD!?HY{_j&rTa4~z--1B_kK+- zEUm1~4yr7yud($J+mhX!wWzhc`XGr>#C*=LvjAa=o%p%HO$%O_C1Q+7s{9|UZQs;w z4V=ud`PAGXno17XF&;0W#oDkQiJXYOV@frig3U%l;>3GfmF|r5-|{kbOmucrcehK? zk-qK!wbh=N?(KhVc-s)2R$nJp6B*xOF$xqU7;k{`gS-O@F8^rBvL zo0jwVqv&gTf)#N=ss*1TOr0BX;D$z-eS$kkdwyiMC@z0dS5bTq84V`cX4F&&0_pi( z-!slPcZ?3mfA$BobWS`E`o!tMEp*4PdY}i)V{khEyyC%sBwd}St z()pEE@rL!AYOGliPHJ9VB6{0ne)onvX7M7^rq~)~XdQxWeK|%JpV3QOMq5S}Nm%+g zl=xg+lT|fsO~V?RbOX^}5|)rs_#}gv@a#iO{+3BwPO?r4!sz|{aQin znba5mz{6nS|NSZpDmbcKSBaw(1r>Re3G&U;7yIt*QZ>{AZH2hu*s{52)q(2%oo7)# zoxKB_^|Qzd0bhcvgT-CgY*{Cc>SGaV?pCbut%il}`NO~LF@CP?7MzD%L1)!<181+&So=j%6agNI)on z^1mnERl^!$mx2!h_R3`9`r_1!<%X1M+9r^f;O%G-Wv%O;6R+QQ^uhqG$RM+n=at7) z*>%V29lbvcm8BYPqn@Il%kBN9q>a3whuc=F`dxMG@SJQER|vh5!V^5ZH3{JbA|M%1Sj;t>Ljx z0Y{?Im``)sxpaHbvWs;g$mn4BesGG3QAWnVoXwvHl`5uW>;uB(jsUDAtVK*nOI1tv zp8gOBA!O8l9`^vW!LH6AD~x-RfQeaXV`-C0DSoZiC`w$}gq-=(Uq zI|cqFDkAK%D0*>@WD_ z-FW#k`gjdJKcCwoVV0?N>BWop)+PN%p{G7=tbgL{ZsOy=F5cOdu(Hp*-Oe=5IWWbQ zj|pyd5IMbB;mQ$>N@5C1Crjqx#BciwYHlFCPAXEr+a)(O`Mu@D#(D&5yAT>5P4L|p z;yh7odC-k{mK&KMAYiB8PJs^TTw8TDl2B9oXVI=|=%zrI^KzbN1Cw!Z=*^m@;{i*0 e(Wj-uH9FosA{8Xu9~tuR1@>QC?7xBjlJGyxS#8Py literal 0 HcmV?d00001 diff --git a/components/sensor/selec_meter.rst b/components/sensor/selec_meter.rst new file mode 100644 index 000000000..70ad1aa64 --- /dev/null +++ b/components/sensor/selec_meter.rst @@ -0,0 +1,117 @@ +Selec Energy Monitor +========================== + +.. seo:: + :description: Instructions for setting up Selec power monitors. + :image: images/selec_meter_em2m.jpg + :keywords: EM2M + +The ``selec_meter`` sensor platform allows you to use Selec Modbus energy monitors +(`website `__) +with ESPHome. + +.. figure:: images/selec_meter_em2m.jpg + :align: center + :width: 50.0% + + Selec EM2M Energy Monitor. + +The communication with this integration is done over a :ref:`UART bus ` using :ref:`Modbus `. +You must therefore have a ``uart:`` entry in your configuration with both the TX and RX pins set +to some pins on your board and the baud rate set to 9600. + +.. code-block:: yaml + + # Example configuration entry + uart: + rx_pin: D1 + tx_pin: D2 + baud_rate: 9600 + stop_bits: 1 + + sensor: + - platform: selec_meter + total_active_energy: + name: "SelecEM2M Total Active Energy" + import_active_energy: + name: "SelecEM2M Import Active Energy" + export_active_energy: + name: "SelecEM2M Export Active Energy" + total_reactive_energy: + name: "SelecEM2M Total Reactive Energy" + import_reactive_energy: + name: "SelecEM2M Import Reactive Energy" + export_reactive_energy: + name: "SelecEM2M Export Reactive Energy" + apparent_energy: + name: "SelecEM2M Apparent Energy" + active_power: + name: "SelecEM2M Active Power" + reactive_power: + name: "SelecEM2M Reactive Power" + apparent_power: + name: "SelecEM2M Apparent Power" + voltage: + name: "SelecEM2M Voltage" + current: + name: "SelecEM2M Current" + power_factor: + name: "SelecEM2M Power Factor" + frequency: + name: "SelecEM2M Frequency" + maximum_demand_active_power: + name: "SelecEM2M Maximum Demand Active Power" + maximum_demand_reactive_power: + name: "SelecEM2M Maximum Demand Reactive Power" + maximum_demand_apparent_power: + name: "SelecEM2M Maximum Demand Apparent Power" + + + +Configuration variables: +------------------------ + +- **total_active_energy** (*Optional*): Use the total active energy value of the sensor in kilo watt + hours. All options from :ref:`Sensor `. +- **import_active_energy** (*Optional*): Use the import active energy value of the sensor in kilo watt + hours. All options from :ref:`Sensor `. +- **export_active_energy** (*Optional*): Use the export active energy value of the sensor in kilo watt + hours. All options from :ref:`Sensor `. +- **total_reactive_energy** (*Optional*): Use the total reactive energy value of the sensor in + kilo volt amps reactive hours. All options from :ref:`Sensor `. +- **import_reactive_energy** (*Optional*): Use the import reactive energy value of the sensor in + kilo volt amps reactive hours. All options from :ref:`Sensor `. +- **export_reactive_energy** (*Optional*): Use the export reactive energy value of the sensor in + kilo volt amps reactive hours. All options from :ref:`Sensor `. +- **apparent_energy** (*Optional*): Use the apparent energy value of the sensor in + kilo volt amps hours. All options from :ref:`Sensor `. +- **active_power** (*Optional*): Use the (active) power value of the sensor in watts. All options + from :ref:`Sensor `. +- **reactive_power** (*Optional*): Use the reactive power value of the sensor in VAR. All + options from :ref:`Sensor `. +- **apparent_power** (*Optional*): Use the apparent power value of the sensor in VA. All + options from :ref:`Sensor `. +- **voltage** (*Optional*): Use the voltage value of the sensor in volts. + All options from :ref:`Sensor `. +- **current** (*Optional*): Use the current value of the sensor in amperes. All options from + :ref:`Sensor `. +- **power_factor** (*Optional*): Use the power factor value of the sensor. + All options from :ref:`Sensor `. +- **frequency** (*Optional*): Use the frequency value of the sensor in hertz. + All options from :ref:`Sensor `. +- **maximum_demand_active_power** (*Optional*): Use the maximum demand (active) power value of the sensor in watts. All options + from :ref:`Sensor `. +- **maximum_demand_reactive_power** (*Optional*): Use the maximum demand reactive power value of the sensor in VAR. All + options from :ref:`Sensor `. +- **maximum_demand_apparent_power** (*Optional*): Use the maximum demand apparent power value of the sensor in VA. All + options from :ref:`Sensor `. +- **update_interval** (*Optional*, :ref:`config-time`): The interval to check the + sensor. Defaults to ``60s``. +- **address** (*Optional*, int): The address of the sensor if multiple sensors are attached to + the same UART bus. You will need to set the address of each device manually. Defaults to ``1``. + +See Also +-------- + +- :ref:`sensor-filters` +- :ghedit:`Edit` diff --git a/images/selec_meter_em2m.jpg b/images/selec_meter_em2m.jpg new file mode 100644 index 0000000000000000000000000000000000000000..71117d41fd95858f8a4a44a39290e0243c4b601b GIT binary patch literal 4148 zcmb7HcTf}B(oaa}H7GR*7zCw*bdVB3xQK}KBDqunA=F40X^OPaL8M(egkB>h^lE6* z2`!*>q(~7Ekq_Uzx$k@T`|H~?^P4mC+u7aO-Pv>Ya^`Xg!0=FAQyl;V0sz3P1Gt<6 zyarH`kyDV9QBsgoP*G7*(=yZ3($LUCuQM?)bKii$xNmTA-MS+wbc;{?HW!z$qOiD> zjJ&)&kD#)evaG74oV*N>ii(PshL)Y4o?V8Qi&y6VEtl;82nApaFa`p`03;9~2m-w9 z20*U@Bmw;n^=~011A@RL zKv!n}CV>zVM)AA4pldfTX8|;zE0+)u1fUE!kA!i^-LZoOCbi_sDH_*@T}z4E=06qu^xrzH+-cYpX_FeEiirzv*lpx#J28Hs#mc81H2Y`R6Mrq6FfE z%WBe6!*8)+lPj$-K#o-h5q?5ClW(i`01jb*K!AS(sgBdH7V_MaWUxW+49m;P#}d9u zqNUEbwZ)vN>;r=o`uw`@7m1euG2I?bD=uyA@#}5xOAI60YpNmzWlaAx&S#^(X(^PA zuw@Erbf-~Iq(vtfX~iiL%s^TZig0i;`P3HuZfygGlt|%RKGb~R3q&*ZOmgXI+(M6=(4ESG;(Pu2Kc-ul>%jm#@7}a$b>v)Mz2(jz<+N1y)=N@AOBXs25J77m)bRDl$@GQx^Sr&)#ylzs%v7Y4;vQd_9U2k zIZ3z`cknI6`Axc2;5i=p@r9|wV@~h}CD;&OJjR*hEYtXpKWJWreLg>K^Q&7F=W<8W)fzAsR33kr{ry{g`^%0Wd4mEFaX zzj5}g)nKZ19vOcG-t)~4XYk^2SDpLkhU7azaG_|YuJ(TNB;W^M<4;>|Z;pQEZiXp2 z)l8hL@8lNBWh!G(BGicv~pBb~ZWVQdlzXQ$bn9+Xd)H(8!N z=?)M(Y0ziJt@e-p0+Y>Dx83eO7)^Z$@T@24TPi6bV3nWMj?;ZEae6}4aX*|-Ozulj zPH~Dal*2h-ejN&koyE~9o`x#09?oA!IDx)vF>e53`bZyj-LWj~aw_m&BrLnwnKKLk zG#jzMERj`BKUg+X$W)^Qp2dkFdg>0Kbf}ebx;Y#KXFQ=$!WCIMF$%x`RWB>)OeBwu zI`b%Ohp&6XpSh$&NJJnFJD%pf`lc{d$w_LrVaVH_*p^=UK;Ovw6yEukIjx@fspFTH z77q60VwNgz%1m*4UFS=)a5>7!#pIFH5zDDYbO0yw;re6p({j;$wDNrC7fw&O^5^0Y zAMWV88!bcbik+tOsNJln({6R9l#y2G`LN3$RzO^4VK`5cL~n~I?H76RIF@`Hd}!v_ zZ)IoXh88E0Q{kS^@_cM37`86QFKfQS02Tss5TYJ@Kto*?{rPps=up_Sf?+nTY?1o% zmLd3YN8>X~7gH5AHL%)$08V<9W|`ktC^-if4jhsgq9%B3X7K#wC{jw@u^DYG1Vi`i;YAtNZl@lK8b~(y&ms;CIjnz} z0V~UMyau4WSa*LY8dPL29$=%2j|n+++#(23a4Ps{bk z9eYmmGXPPSbzfD(k0aAM^gLT%Jn&%MoWI94@b?YOITH|n38?aB(p@#Ws61!ud%t4{ zC}T4*H8F5~cWlpk^!P+T;=S_6C%9g)>1odjF#ug@g_rRV9BeC>kF&C>I^Lsgg2H9f8P$utSr3HOedYG8u2HYVn1AWXZKUPV>fipp@Vsjf zVkPD3O0{-3Gnf!W*2$cyKws|pG7)+=d}}M$5?v;Y9s+jccCJm&Cs;}9xHl$&ENzgx zPTFC*UZFPGSlocwA-=$w%;b9(K$8|CVLo+Fi`MrdQm5m*cIS;d9d9mKFbahWT##JT zoilmLJWdMhm%?tu&_4JK@Dd(XA=*4U2gu0pr*>3?buMr-g6_&nui$tZ^ga znKS`seN~M>Hwy)+gVy&+`C{thI2rxfD&y&#AJV=#$eM3}GpuipbIsQn`{XzyWQrjt zuRZlOf`>#M_DjNc>LzNkf$oT?t_W>$mD!?HY{_j&rTa4~z--1B_kK+- zEUm1~4yr7yud($J+mhX!wWzhc`XGr>#C*=LvjAa=o%p%HO$%O_C1Q+7s{9|UZQs;w z4V=ud`PAGXno17XF&;0W#oDkQiJXYOV@frig3U%l;>3GfmF|r5-|{kbOmucrcehK? zk-qK!wbh=N?(KhVc-s)2R$nJp6B*xOF$xqU7;k{`gS-O@F8^rBvL zo0jwVqv&gTf)#N=ss*1TOr0BX;D$z-eS$kkdwyiMC@z0dS5bTq84V`cX4F&&0_pi( z-!slPcZ?3mfA$BobWS`E`o!tMEp*4PdY}i)V{khEyyC%sBwd}St z()pEE@rL!AYOGliPHJ9VB6{0ne)onvX7M7^rq~)~XdQxWeK|%JpV3QOMq5S}Nm%+g zl=xg+lT|fsO~V?RbOX^}5|)rs_#}gv@a#iO{+3BwPO?r4!sz|{aQin znba5mz{6nS|NSZpDmbcKSBaw(1r>Re3G&U;7yIt*QZ>{AZH2hu*s{52)q(2%oo7)# zoxKB_^|Qzd0bhcvgT-CgY*{Cc>SGaV?pCbut%il}`NO~LF@CP?7MzD%L1)!<181+&So=j%6agNI)on z^1mnERl^!$mx2!h_R3`9`r_1!<%X1M+9r^f;O%G-Wv%O;6R+QQ^uhqG$RM+n=at7) z*>%V29lbvcm8BYPqn@Il%kBN9q>a3whuc=F`dxMG@SJQER|vh5!V^5ZH3{JbA|M%1Sj;t>Ljx z0Y{?Im``)sxpaHbvWs;g$mn4BesGG3QAWnVoXwvHl`5uW>;uB(jsUDAtVK*nOI1tv zp8gOBA!O8l9`^vW!LH6AD~x-RfQeaXV`-C0DSoZiC`w$}gq-=(Uq zI|cqFDkAK%D0*>@WD_ z-FW#k`gjdJKcCwoVV0?N>BWop)+PN%p{G7=tbgL{ZsOy=F5cOdu(Hp*-Oe=5IWWbQ zj|pyd5IMbB;mQ$>N@5C1Crjqx#BciwYHlFCPAXEr+a)(O`Mu@D#(D&5yAT>5P4L|p z;yh7odC-k{mK&KMAYiB8PJs^TTw8TDl2B9oXVI=|=%zrI^KzbN1Cw!Z=*^m@;{i*0 e(Wj-uH9FosA{8Xu9~tuR1@>QC?7xBjlJGyxS#8Py literal 0 HcmV?d00001 diff --git a/index.rst b/index.rst index ae3655e3b..a58c09331 100644 --- a/index.rst +++ b/index.rst @@ -213,6 +213,7 @@ Sensor Components SenseAir, components/sensor/senseair, senseair_s8.jpg SDS011 Sensor, components/sensor/sds011, sds011.jpg SDM Meter, components/sensor/sdm_meter, sdm220m.png + Selec Meter, components/sensor/selec_meter, selec_meter_em2m.jpg SCD30, components/sensor/scd30, scd30.jpg SHTCx, components/sensor/shtcx, shtc3.jpg SHT3X-D, components/sensor/sht3xd, sht3xd.jpg