HAT 18650C

HAT 18650C V1.1 integrates an AW32257 charger and an INA226 power monitor. It can measure battery voltage, current, and power, control battery charging, set charge current, read charge status/fault status, and control the AW32257 Boost/OTG output.

Support the following products:

Note

With the current hardware direction, charging current is usually negative and discharging current is usually positive. Charge current and voltage settings are written through AW32257 register steps, so the actual value is mapped to a supported gear rather than an arbitrary value.

UiFlow2 Example

Charge Test

Open the sticks3_hat18650c_charge_example.m5f2 project in UiFlow2.

This example reads battery voltage and current, shows charging state, and controls Charge ON/OFF with the button on StickS3.

UiFlow2 Code Block:

Example output:

None

Output Test

Open the sticks3_hat18650c_output_example.m5f2 project in UiFlow2.

This example reads battery voltage and current, shows OTG output state, and controls OTG Output ON/OFF with the button on StickS3.

UiFlow2 Code Block:

Example output:

None

MicroPython Example

Charge Test

Read battery voltage and current, show charging state, and control Charge ON/OFF with the button on StickS3.

MicroPython Code Block:

# SPDX-FileCopyrightText: 2024 M5Stack Technology CO LTD
#
# SPDX-License-Identifier: MIT

import os, sys, io
import M5
from M5 import *
from hat import HAT18650CHat
from hardware import Pin
from hardware import I2C
import time


label_title = None
label_voltage = None
label_current = None
label_iset = None
label_ctrl = None
i2c0 = None
hat_18650c_v11_0 = None


iset = None
last_time = None
bat_voltage = None
bat_current = None


def btna_was_clicked_event(state):
    global \
        label_title, \
        label_voltage, \
        label_current, \
        label_iset, \
        label_ctrl, \
        i2c0, \
        hat_18650c_v11_0, \
        iset, \
        last_time, \
        bat_voltage, \
        bat_current
    if hat_18650c_v11_0.get_charge_enable():
        hat_18650c_v11_0.set_charge_enable(False)
        label_ctrl.setText(str("Chg: OFF"))
    else:
        hat_18650c_v11_0.set_charge_enable(True)
        label_ctrl.setText(str("Chg: ON"))


def btnb_was_clicked_event(state):
    global \
        label_title, \
        label_voltage, \
        label_current, \
        label_iset, \
        label_ctrl, \
        i2c0, \
        hat_18650c_v11_0, \
        iset, \
        last_time, \
        bat_voltage, \
        bat_current
    iset = iset + 500
    if iset > 2500:
        iset = 500
    hat_18650c_v11_0.set_charge_current(iset)
    label_iset.setText(str((str("ISET: ") + str((str(iset) + str(" mA"))))))


def setup():
    global \
        label_title, \
        label_voltage, \
        label_current, \
        label_iset, \
        label_ctrl, \
        i2c0, \
        hat_18650c_v11_0, \
        iset, \
        last_time, \
        bat_voltage, \
        bat_current

    M5.begin()
    Widgets.setRotation(0)
    Widgets.fillScreen(0x000000)
    label_title = Widgets.Label(
        "Charge", 22, 5, 1.0, 0x17EE6A, 0x000000, Widgets.FONTS.Montserrat24
    )
    label_voltage = Widgets.Label(
        "Vol:", 7, 45, 1.0, 0xFFFFFF, 0x000000, Widgets.FONTS.Montserrat18
    )
    label_current = Widgets.Label(
        "Cur:", 3, 70, 1.0, 0xFFFFFF, 0x000000, Widgets.FONTS.Montserrat18
    )
    label_iset = Widgets.Label(
        "ISET: 500mA", 3, 179, 1.0, 0xFFFFFF, 0x000000, Widgets.FONTS.Montserrat18
    )
    label_ctrl = Widgets.Label(
        "CHG: ON", 26, 214, 1.0, 0xFFFFFF, 0x000000, Widgets.FONTS.Montserrat18
    )

    BtnA.setCallback(type=BtnA.CB_TYPE.WAS_CLICKED, cb=btna_was_clicked_event)
    BtnB.setCallback(type=BtnB.CB_TYPE.WAS_CLICKED, cb=btnb_was_clicked_event)

    i2c0 = I2C(0, scl=Pin(0), sda=Pin(8), freq=100000)
    hat_18650c_v11_0 = HAT18650CHat(i2c0)
    hat_18650c_v11_0.set_charge_enable(True)
    iset = 500
    hat_18650c_v11_0.set_charge_voltage(4.2)


def loop():
    global \
        label_title, \
        label_voltage, \
        label_current, \
        label_iset, \
        label_ctrl, \
        i2c0, \
        hat_18650c_v11_0, \
        iset, \
        last_time, \
        bat_voltage, \
        bat_current
    M5.update()
    if (time.ticks_diff((time.ticks_ms()), last_time)) >= 500:
        last_time = time.ticks_ms()
        bat_voltage = hat_18650c_v11_0.get_battery_voltage()
        bat_current = hat_18650c_v11_0.get_battery_current()
        print(hat_18650c_v11_0.get_battery_power())
        label_voltage.setText(str((str("Vol: ") + str((str(bat_voltage) + str("V"))))))
        label_current.setText(str((str("Cur: ") + str((str(bat_current) + str("A"))))))
        if hat_18650c_v11_0.is_charging():
            label_voltage.setColor(0x009900, 0x000000)
            label_current.setColor(0x009900, 0x000000)
        else:
            label_voltage.setColor(0xFFFFFF, 0x000000)
            label_current.setColor(0xFFFFFF, 0x000000)


if __name__ == "__main__":
    try:
        setup()
        while True:
            loop()
    except (Exception, KeyboardInterrupt) as e:
        try:
            from utility import print_error_msg

            print_error_msg(e)
        except ImportError:
            print("please update to latest firmware")

Example output:

None

Output Test

Read battery voltage and current, show OTG output state, and control OTG Output ON/OFF with the button on StickS3.

MicroPython Code Block:

# SPDX-FileCopyrightText: 2024 M5Stack Technology CO LTD
#
# SPDX-License-Identifier: MIT

import os, sys, io
import M5
from M5 import *
from hardware import Pin
from hardware import I2C
from hat import HAT18650CHat
import time


label_title = None
label_voltage = None
label_current = None
label_ctrl = None
i2c0 = None
hat_18650c_v11_0 = None


output = None
last_time = None
bat_voltage = None
bat_current = None


def btna_was_clicked_event(state):
    global \
        label_title, \
        label_voltage, \
        label_current, \
        label_ctrl, \
        i2c0, \
        hat_18650c_v11_0, \
        output, \
        last_time, \
        bat_voltage, \
        bat_current
    output = not output
    if output:
        hat_18650c_v11_0.set_boost_enable(True)
        label_ctrl.setText(str("OUT: ON"))
        label_voltage.setColor(0xCC0000, 0x000000)
        label_current.setColor(0xCC0000, 0x000000)
    else:
        hat_18650c_v11_0.set_boost_enable(False)
        label_ctrl.setText(str("OUT: OFF"))
        label_voltage.setColor(0xFFFFFF, 0x000000)
        label_current.setColor(0xFFFFFF, 0x000000)


def setup():
    global \
        label_title, \
        label_voltage, \
        label_current, \
        label_ctrl, \
        i2c0, \
        hat_18650c_v11_0, \
        output, \
        last_time, \
        bat_voltage, \
        bat_current

    M5.begin()
    Widgets.setRotation(0)
    Widgets.fillScreen(0x000000)
    label_title = Widgets.Label(
        "OUTPUT", 28, 5, 1.0, 0x17EE6A, 0x000000, Widgets.FONTS.Montserrat18
    )
    label_voltage = Widgets.Label(
        "Vol:", 7, 45, 1.0, 0xFFFFFF, 0x000000, Widgets.FONTS.Montserrat18
    )
    label_current = Widgets.Label(
        "Cur:", 3, 70, 1.0, 0xFFFFFF, 0x000000, Widgets.FONTS.Montserrat18
    )
    label_ctrl = Widgets.Label(
        "OUT: OFF", 23, 205, 1.0, 0xFFFFFF, 0x000000, Widgets.FONTS.Montserrat18
    )

    BtnA.setCallback(type=BtnA.CB_TYPE.WAS_CLICKED, cb=btna_was_clicked_event)

    i2c0 = I2C(0, scl=Pin(0), sda=Pin(8), freq=100000)
    hat_18650c_v11_0 = HAT18650CHat(i2c0)
    output = 0
    output = False
    hat_18650c_v11_0.set_boost_enable(False)


def loop():
    global \
        label_title, \
        label_voltage, \
        label_current, \
        label_ctrl, \
        i2c0, \
        hat_18650c_v11_0, \
        output, \
        last_time, \
        bat_voltage, \
        bat_current
    M5.update()
    if (time.ticks_diff((time.ticks_ms()), last_time)) >= 500:
        last_time = time.ticks_ms()
        bat_voltage = hat_18650c_v11_0.get_battery_voltage()
        bat_current = hat_18650c_v11_0.get_battery_current()
        label_voltage.setText(str((str("Vol: ") + str(bat_voltage))))
        label_current.setText(str((str("Cur: ") + str(bat_current))))


if __name__ == "__main__":
    try:
        setup()
        while True:
            loop()
    except (Exception, KeyboardInterrupt) as e:
        try:
            from utility import print_error_msg

            print_error_msg(e)
        except ImportError:
            print("please update to latest firmware")

Example output:

None

API

HAT18650CHat

class hat.hat18650c.HAT18650CHat(i2c, charger_address=micropython.const, monitor_address=micropython.const, shunt_resistor=0.01, max_expected_current=10)

Bases: object

Create a HAT18650CHat object.

The AW32257 controls battery charging and Boost/OTG output. The INA226 measures battery bus voltage, current, and power.

Parameters:

• i2c (I2C) – I2C bus.

• charger_address (int) – AW32257 I2C address. Default is 0x6A.

• monitor_address (int) – INA226 I2C address. Default is 0x41.

• shunt_resistor (float) – INA226 shunt resistor value in ohms. Default is 0.01.

• max_expected_current (float) – Maximum expected current for INA226 calibration in amps. Default is 10.

UiFlow2 Code Block:

MicroPython Code Block:

from hardware import I2C, Pin
from hat import HAT18650CHat

i2c0 = I2C(0, scl=Pin(0), sda=Pin(8), freq=100000)
hat18650c = HAT18650CHat(i2c0)

set_charge_enable(enable)

Enable or disable battery charging.

Parameters:

enable (bool) – True to enable charging, False to disable charging.

Return type:

None

UiFlow2 Code Block:

MicroPython Code Block:

hat18650c.set_charge_enable(True)
hat18650c.set_charge_enable(False)

get_charge_enable()

Get battery charging enable state.

Returns:

True if charging is enabled, False otherwise.

Return type:

bool

UiFlow2 Code Block:

MicroPython Code Block:

charge_enable = hat18650c.get_charge_enable()

set_charge_current(current_ma)

Set fast-charge current.

The target current is clamped to the HAT 18650C supported table. The closest supported table value not greater than the target is used internally, so the written value may be lower than the requested value.

Parameters:

current_ma (int) – Target charge current in mA.

Return type:

None

UiFlow2 Code Block:

MicroPython Code Block:

hat18650c.set_charge_current(1000)

get_charge_current()

Get fast-charge current setting.

Returns the actual selected current-table value.

Returns:

Charge current setting in mA.

Return type:

int

UiFlow2 Code Block:

MicroPython Code Block:

current_ma = hat18650c.get_charge_current()

set_charge_voltage(voltage)

Set charge regulation voltage.

The target voltage is clamped to the valid AW32257 range and rounded to the nearest register step, so the written value may be only close to the requested value.

Parameters:

voltage (float) – Target charge voltage in volts. Valid range is 3.50V to 4.50V.

Return type:

None

UiFlow2 Code Block:

MicroPython Code Block:

hat18650c.set_charge_voltage(4.2)

get_charge_voltage()

Get charge regulation voltage.

Returns the actual selected voltage step.

Returns:

Charge regulation voltage in volts.

Return type:

float

UiFlow2 Code Block:

MicroPython Code Block:

voltage = hat18650c.get_charge_voltage()

set_termination_current(current_ma)

Set charge termination current.

The target current is rounded to the nearest termination-current table value supported by AW32257.

Parameters:

current_ma (int) – Target termination current in mA. Options are 62 to 496 mA.

Return type:

None

UiFlow2 Code Block:

MicroPython Code Block:

hat18650c.set_termination_current(124)

get_termination_current()

Get charge termination current setting.

Returns the actual selected termination-current table value.

Returns:

Termination current setting in mA.

Return type:

int

UiFlow2 Code Block:

MicroPython Code Block:

current_ma = hat18650c.get_termination_current()

set_safety_charge_current(current_ma)

Set maximum allowed charge current.

The target current is rounded to the nearest charge-current table value supported by AW32257.

Parameters:

current_ma (int) – Target safety current in mA. Valid range is 496 to 2480 mA.

Return type:

None

UiFlow2 Code Block:

MicroPython Code Block:

hat18650c.set_safety_charge_current(1000)

get_safety_charge_current()

Get maximum allowed charge current.

Returns the actual selected safety-current table value.

Returns:

Safety current limit in mA.

Return type:

int

UiFlow2 Code Block:

MicroPython Code Block:

current_ma = hat18650c.get_safety_charge_current()

set_safety_charge_voltage(voltage)

Set maximum allowed charge regulation voltage.

The target voltage is rounded to the nearest safety-voltage table value supported by AW32257.

Parameters:

voltage (float) – Target safety voltage in volts. Valid range is 4.20V to 4.50V.

Return type:

None

UiFlow2 Code Block:

MicroPython Code Block:

hat18650c.set_safety_charge_voltage(4.2)

get_safety_charge_voltage()

Get maximum allowed charge regulation voltage.

Returns the actual selected safety-voltage table value.

Returns:

Safety voltage limit in volts.

Return type:

float

UiFlow2 Code Block:

MicroPython Code Block:

voltage = hat18650c.get_safety_charge_voltage()

set_recharge_threshold(threshold_mv)

Set automatic recharge threshold below VOREG.

Parameters:

threshold_mv (int) – Target recharge threshold in mV. Options are 50, 100, 150, and 200.

Return type:

None

UiFlow2 Code Block:

MicroPython Code Block:

hat18650c.set_recharge_threshold(100)

get_recharge_threshold()

Get automatic recharge threshold below VOREG.

Return type:

int

UiFlow2 Code Block:

MicroPython Code Block:

threshold_mv = hat18650c.get_recharge_threshold()

get_charge_status()

Get charger status text.

Returns:

Charge status text: ready, charging, done, or fault.

Return type:

str

UiFlow2 Code Block:

MicroPython Code Block:

status = hat18650c.get_charge_status()

get_charge_status_code()

Get charger status code.

Returns:

One of STAT_READY, STAT_CHARGING, STAT_DONE, or STAT_FAULT.

Return type:

int

UiFlow2 Code Block:

MicroPython Code Block:

status = hat18650c.get_charge_status_code()

is_charging()

Check whether charging is in progress.

Returns:

True if charging is in progress, False otherwise.

Return type:

bool

UiFlow2 Code Block:

MicroPython Code Block:

charging = hat18650c.is_charging()

is_charge_done()

Check whether charging is complete.

Returns:

True if charging is complete, False otherwise.

Return type:

bool

UiFlow2 Code Block:

MicroPython Code Block:

done = hat18650c.is_charge_done()

get_charge_fault()

Get charger fault text.

Returns:

Charge fault text.

Return type:

str

UiFlow2 Code Block:

MicroPython Code Block:

fault = hat18650c.get_charge_fault()

get_charge_fault_code()

Get charger fault code.

Returns:

Charge fault code. Use CHARGE_FAULT_* constants for comparison.

Return type:

int

UiFlow2 Code Block:

MicroPython Code Block:

fault = hat18650c.get_charge_fault_code()
if fault == HAT18650CHat.CHARGE_FAULT_NO_BATTERY:
    print("No battery")

set_boost_enable(enable)

Enable or disable AW32257 Boost/OTG mode.

Parameters:

enable (bool) – True to enable Boost/OTG mode, False to disable it.

Return type:

None

UiFlow2 Code Block:

MicroPython Code Block:

hat18650c.set_boost_enable(True)
hat18650c.set_boost_enable(False)

get_boost_enable()

Get AW32257 Boost/OTG enable state.

Returns:

True if Boost/OTG mode is enabled, False otherwise.

Return type:

bool

UiFlow2 Code Block:

MicroPython Code Block:

boost_enable = hat18650c.get_boost_enable()

get_boost_fault()

Get Boost/OTG fault text.

Returns:

Boost/OTG fault text.

Return type:

str

UiFlow2 Code Block:

MicroPython Code Block:

fault = hat18650c.get_boost_fault()

get_boost_fault_code()

Get Boost/OTG fault code.

Returns:

Boost/OTG fault code. Use BOOST_FAULT_* constants for comparison.

Return type:

int

UiFlow2 Code Block:

MicroPython Code Block:

fault = hat18650c.get_boost_fault_code()
if fault == HAT18650CHat.BOOST_FAULT_BATTERY_LOW:
    print("Battery low")

get_battery_voltage()

Get battery bus voltage from INA226.

Returns:

Battery voltage in volts.

Return type:

float

UiFlow2 Code Block:

MicroPython Code Block:

voltage = hat18650c.get_battery_voltage()

get_battery_current()

Get battery current from INA226.

With the current hardware direction, charging current is usually negative and discharging current is usually positive.

Returns:

Battery current in amps.

Return type:

float

UiFlow2 Code Block:

MicroPython Code Block:

current = hat18650c.get_battery_current()

get_battery_power()

Get battery power from INA226.

Returns:

Battery power in watts.

Return type:

float

UiFlow2 Code Block:

MicroPython Code Block:

power = hat18650c.get_battery_power()