Energy (DC) - INA219

.

Plugin details

Type: Energy (DC)

Name: INA219

Status ESP32: NORMAL ENERGY

Status ESP8266: NORMAL ENERGY

GitHub: P027_INA219.ino

Maintainer: .

Used libraries: .

.

Description

The INA219 sensor can read DC voltage and current and calculate the power from that.

Configuration

Device configuration

  • Name: Required by ESPEasy, must be unique among the list of available devices/tasks.

  • Enabled: The device can be disabled or enabled. When not enabled the device should not use any resources.

I2C options

The available settings here depend on the build used. At least the Force Slow I2C speed option is available, but selections for the I2C Multiplexer can also be shown. For details see the I2C Bus page

Selectable I2C addresses:

Address

A0

A1

0x40

GND

GND

0x41

VS+

GND

0x42

SDA

GND

0x43

SCL

GND

0x44

GND

VS+

0x45

VS+

VS+

0x46

SDA

VS+

0x47

SCL

VS+

0x48

GND

SDA

0x49

VS+

SDA

0x4A

SDA

SDA

0x4B

SCL

SDA

0x4C

GND

SCL

0x4D

VS+

SCL

0x4E

SDA

SCL

0x4F

SCL

SCL

Device Settings

  • Measure range: Select the range of the input voltage that’s expected, using the most common shunt resistor of 0.1 Ohm. Available options:

../_images/P027_MeasureRangeOptions.png

  • Measurement Type: Select the desired measurement type. Values not selected will not be updated when reading the sensor. Available options:

../_images/P027_MeasurementTypeOptions.png

  • Use Powerdown mode: When enabled will bring the sensor in Powerdown mode after initialization, wake it from that mode to start measuring when requesting a read (either via TaskRun or by Interval), and after reading the values bring it back in Powerdown mode. This mode is available to reduce the quiescent current used during sleep mode in battery operated setups.

Data Acquisition

This group of settings are standard available configuration items.

  • Single event with all values: When this setting is enabled, all available values will be sent in a single event <TaskName>#All, with all values in order as arguments to the event.

  • Show derived values: When checked, the Devices overview page, and the /json endpoint (used for updating the Devices overview page) will include any Derived values as defined. See the TaskValueSetDerived and TaskValueSetPresentation commands.

  • Event & Log derived values: When checked, the Derived values will be generated as Events, to be handled in Rules, and sent to logging devices like the Syslog server and/or SD-card logging.

(The derived values options are only available if String variables feature is included in the build.)


  • Send to Controller: Select the Controller(s) to send the Values to, either on a TaskRun command applied to the task, or on an Interval time action.

Send to Controller is only visible when one or more Controllers are configured.

Depending on the controller capabilities, some configuration settings may be shown:

../_images/Task_config_page_Controllers_section.png

All configured Controllers are shown here, including the enabled or disabled state (multiple Controllers can be enabled, only a single MQTT Controller can be enabled at one time!).

For each controller the user can select wether the data should be sent on each Interval (or explicit TaskRun).

For the Domoticz controllers the value index (IDX) has to be configured.

For some controllers, like Home Assistant/openHAB, there are extra options available.

  • Group: This represents the group id to combine all values from multiple tasks into a single grouped-device during MQTT AutoDiscovery. Groups, by design, can span multiple ESPEasy devices, if desired, as long as the Task/Valuename combinations are unique. If a group should only combine Tasks from a single ESPEasy unit, the group id should be unique across multiple ESPEasy units. The group description, default Group <n>, can be adjusted in Home Assistant. If the Group value matches the current Unit nr, the Unit name, %sysname%, is used instead of Group <nr>.

  • Retained: For MQTT Controllers, this setting can be enabled to send the values for the current task with the Retain flag set. The Publish Retain flag in the Controller settings will override this by sending all task values with Retain flag enabled.

  • Send derived: This checkbox determines if any configured Derived values should also be sent to the controller (and included in the AutoDiscovery if that’s available and enabled).

  • Resend MQTT Discovery: When checked, will start a resend of the MQTT Discovery process for this task after a random delay, when Submit is clicked, so any changed settings will be updated in the MQTT broker. This setting is only available if the controller is enabled, the Auto Discovery feature is available and enabled for the controller. This setting is not stored.

Other controllers, like f.e. FHEM HTTP, do not support additional settings besides the checkbox to enable sending the data.


  • Interval By default, Interval will be set to 60 sec. The data will be collected and optionally sent to any configured controllers using this interval.

Values

The plugin provides measurements Voltage, Current, and Power. These names can be adjusted if desired.

Per Value is a Stats checkbox available, that when checked, gathers the data and presents recent data in a graph, as described here: Task Value Statistics:

Change log

Changed in version 2.0: …

added 2024-07-16: Optional Powerdown mode.

added Major overhaul for 2.0 release.

Added in version 1.0: …

added Initial release version.