Energy - MAX1704x

Sparkfun Fuel Gauge Sensor

Plugin details

Type: Energy

Name: MAX1704x

Status ESP32: COLLECTION B ENERGY

Status ESP8266: COLLECTION B ENERGY

GitHub: _P115_MAX1704x_v2.ino

Maintainer: TD-er

Used libraries: https://github.com/sparkfun/SparkFun_MAX1704x_Fuel_Gauge_Arduino_Library

Description

The MAX1704x are ultra-compact, low-cost, host-side fuel-gauge systems for lithium-ion (Li+) batteries in handheld and portable equipment.

• MAX17043: single lithium cell

• MAX17044: dual-cell 2S pack.

• MAX17048: single lithium cell

• MAX17049: dual-cell 2S pack.

Datasheets:

• MAX17043-MAX17044.pdf

• MAX17048-MAX17049.pdf

The MAX17048 & MAX17049 are more sophisticated versions, which support a number of extra features like measuring the change rate in percent per hour to measure load or charge rate.

Configuration

Device Settings

Device: Select the version of the MAX1704x:

• MAX17043

• MAX17044 - 2-cell version of the MAX17043 (full-scale range of 10V)

• MAX17048

• MAX17049 - 2-cell version of the MAX17048

Alert threshold : Set the MAX1704x’s percentage threshold that will trigger an alert.

Send Event on Alert : Send an event, to be used in rules, when the alert is set. This can be cleared with max1704xclearalert

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:

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.

Values

• Voltage: The measured voltage of the cell(s).

• State of Charge (SoC): The percentage left of the cell.

• Alert: Whether or not an alert was triggered (e.g. SoC below set threshold)

• Rate: The change rate of the SoC in percent per hour. Negative value is a discharge, positive is charge rate. (MAX17048 & MAX17049 only)

Events

Event	Description
<taskname>#AlertTriggered	Alert is triggered for a task running MAX1704x. This alert state can be cleared with the max1704xclearalert command.

Command Summary

Command Syntax	Extra information
max1704xclearalert	Clear the alert state. An alert event will only be sent when the alert state is set. Clearing it allows for new events to be set.

Change log

Changed in version 2.0: added 2021-05-08 Added to main repository as Plugin 115 Energy - Fuel Gauge MAX1704x