Power mgt - IP5306 Power management¶

Power management controller

Plugin details¶

Type: Power mgt

Name: IP5306 Power management

Status ESP32: COLLECTION DISPLAY ENERGY NEOPIXEL

Status ESP8266: .

GitHub: P138_IP5306.ino

Maintainer: tonhuisman

Used libraries: https://github.com/codewitch-honey-crisis/htcw_ip5306

Description¶

I2C Power management controller. As found in some ESP32 models of M5Stack and TTGO.

Plugin is only available in ESP32 builds, as this controller is currently only found to be used with ESP32 boards. It can be used on ESP8266, though untested.

Configuration¶

Name A unique name should be entered here.
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

Device Settings¶

Decimals for config values: The number of decimals to use for presenting the Config values (see below for a list of available values).
Event on PowerSource change: When checked the plugin will generate an event <taskname>#PowerChanged with argument 0 or 1 for battery or external power (the new state).

Output Configuration¶

Number Output Values: Select the number of values that have to be available. The default is set to Quad, as there are far more than 4 values available for display.

../_images/P138_NumberOutputValuesOptions.png

Available options: Single (1), Dual (2), Triple (3) and Quad (4).

Value 1..4: Select the desired value to be available in the Values fields. The name of the Values will be set to a matching default automatically, but can be changed afterward.

Available options:

None: To leave the value empty/0.00
Battery current: The current measured at the Battery connection.
Charge undervoltage: The (fixed) voltage at which charging of the battery is started by the controller.
Stop voltage: The (fixed) configured voltage at which the battery is no longer being charged.
Input current: The input current used by the controller.
Charge level: The charge level of the battery.
Power source: The power source used by the ESP, 0 = battery, 1 = External (USB) power.

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 0 sec. as it is optional. When set > 0 it is the frequency used to read sensor values and send these to any Controllers configured for this device.

Values¶

The measured values are available in variables, where the names are determined by the selected Value 1..4 settings. A formula can be set to recalculate. The number of decimals can be set as desired, and defaults to 2.

Extra values¶

As this plugin has more values available than can be set to the regular Values outputs, all values are also available from the Get Config feature.

`[<taskname>#batterycurrent]`	The current measured at the Battery connection.
`[<taskname>#chargeundervoltage]`	The (fixed) voltage at which charging of the battery is started by the controller.
`[<taskname>#stopvoltage]`	The (fixed) configured voltage at which the battery is no longer being charged.
`[<taskname>#inputcurrent]`	The input current used by the controller.
`[<taskname>#chargelevel]`	The charge level of the battery.
`[<taskname>#powersource]`	The power source used by the ESP, 0 = battery, 1 = External (USB) power.

Extra events¶

Besides the regular events, of <taskname>#<valuename>=<value> or <taskname>#All=<value1>,..<valueN> when the Interval is set, there can be an extra event generated:

Event	Extra information
`<taskname>#PowerChanged=<source>` `source`: `0` (Battery power) or `1` (External / USB power).	Event generated when the Event on PowerSource change is enabled.

Change log¶

Changed in version 2.0: added 2022-08-26 Initially added.