diff --git a/components/sensor/images/selec_meter_em2m.jpg b/components/sensor/images/selec_meter_em2m.jpg new file mode 100644 index 000000000..71117d41f Binary files /dev/null and b/components/sensor/images/selec_meter_em2m.jpg differ 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 000000000..71117d41f Binary files /dev/null and b/images/selec_meter_em2m.jpg differ 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