Power mgt - IP5306 Power management¶

Power management controller

Plugin details¶

Type: Power mgt

Name: IP5306 Power management

Status: COLLECTION DISPLAY ENERGY NEOPIXEL

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 Hardware 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, Single event with all values, Send to Controller and Interval settings are standard available configuration items. Send to Controller is only visible when one or more Controllers are configured.

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.