Charger Utils Exported Functions

group CHARGER_UTILS_Exported_Functions

Functions

T_CHARGER_UTILS_ERROR charger_utils_get_batt_volt(uint16_t *volt)

Get charging voltage.

charger_utils.h

Experimental Added Since 2.13.0.0:

Example usage

void charger_utils_demo(void)
{
    T_CHARGER_UTILS_ERROR status;
    uint16_t voltage;

    status = charger_utils_get_batt_volt(&voltage);
    if(status == CHARGER_UTILS_SUCCESS)
    {
         APP_PRINT_INFO1("charger_utils_demo: voltage %d", voltage);
    }
    else
    {
         APP_PRINT_ERROR1("charger_utils_demo: error code %d", status);
    }
}

Parameters:

volt -- [out] Battery voltage, unit: mV.

Return values:

CHARGER_UTILS_SUCCESS -- Current charging info is getting successfully.
CHARGER_UTILS_NOT_SUPPROTED -- Charging info getting failed.
CHARGER_UTILS_NOT_ENABLED -- Charger is not enabled. could not get battery information from charger module.

Returns:

The status of getting voltage.

T_CHARGER_UTILS_ERROR charger_utils_get_batt_curr(int16_t *current)

Get charging current, unit: mA.

charger_utils.h

Experimental Added Since 2.13.0.0:

Example usage

void charger_utils_demo(void)
{
    T_CHARGER_UTILS_ERROR status;
    int16_t current;

    status = charger_utils_get_batt_curr(&current);
    if(status == CHARGER_UTILS_SUCCESS)
    {
         APP_PRINT_INFO1("charger_utils_demo: current %d", current);
    }
    else
    {
         APP_PRINT_ERROR1("charger_utils_demo: error code %d", status);
    }
}

Parameters:

current -- [out] Charging current, positive in charging mode, negative in discharging mode.

Return values:

CHARGER_UTILS_SUCCESS -- Current charging info is getting successfully.
CHARGER_UTILS_NOT_SUPPROTED -- Charging info getting failed.
CHARGER_UTILS_NOT_ENABLED -- Charger is not enabled. could not get battery information from charger module.

Returns:

The status of getting current.

T_CHARGER_UTILS_ERROR charger_utils_get_batt_temp(uint16_t *temperature1, uint16_t *temperature2)

Get charging temperature1 and temperature2.

Experimental Added Since 2.13.0.0:

Example usage

void charger_utils_demo(void)
{
    T_CHARGER_UTILS_ERROR status;
    uint16_t temperature1, temperature2;

    status = charger_utils_get_batt_temp(&temperature1, &temperature2);
    if(status == CHARGER_UTILS_SUCCESS)
    {
         APP_PRINT_INFO2("charger_utils_demo: temperature1 %d, temperature2 %d", temperature1, temperature2);
    }
    else
    {
         APP_PRINT_ERROR1("charger_utils_demo: error code %d", status);
    }
}

Parameters:

temperature1 -- [out] Temperature1, unit: mV.
temperature2 -- [out] Temperature2, unit: mV.

Return values:

CHARGER_UTILS_SUCCESS -- Temperature obtained successfully.
CHARGER_UTILS_NOT_SUPPROTED -- Getting temperature is not supported.
CHARGER_UTILS_NOT_ENABLED -- Charger is not enabled. Could not get temperature information from charger module.

Returns:

The status of getting temperature.

T_CHARGER_UTILS_ERROR charger_utils_get_adapter_volt(uint16_t *volt)

Get charging adapter voltage, unit: mV.

charger_utils.h

Experimental Added Since 2.13.0.0:

Example usage

void charger_utils_demo(void)
{
    T_CHARGER_UTILS_ERROR status;
    uint16_t voltage;

    status = charger_utils_get_adapter_volt(&voltage);
    if(status == CHARGER_UTILS_SUCCESS)
    {
         APP_PRINT_INFO1("charger_utils_demo: voltage %d", voltage);
    }
    else
    {
         APP_PRINT_ERROR1("charger_utils_demo: error code %d", status);
    }
}

Parameters:

volt -- [out] Adapter voltage.

Return values:

CHARGER_UTILS_SUCCESS -- Adapter voltage obtained successfully.
CHARGER_UTILS_NOT_SUPPROTED -- Getting adapter voltage is not supported.
CHARGER_UTILS_NOT_ENABLED -- Charger is not enabled. Could not get adapter voltage information from charger module.

Returns:

The status of getting adapter voltage.

void charger_utils_charger_auto_enable(bool enable)

Enable or disable charger.

charger_utils.h

Experimental Added Since 2.13.0.0:

Parameters:

enable -- [in] Enable or disable charger. This parameter can be one of the following values:

true: Enable charger.
false: Disable charger.

Example usage

void charger_utils_demo(void)
{
    charger_utils_charger_auto_enable(true);
}

bool charger_utils_get_thermistor_enable_state(void)

Get charger thermistor detection enable status.

charger_utils.h

Experimental Added Since 2.13.0.0:

Example usage

void charger_utils_demo(void)
{
    bool status = charger_utils_get_thermistor_enable_state();
}

Return values:

true -- Charger thermistor detection is supported.
false -- Charger thermistor detection is not supported.

Returns:

Charger thermistor detection enable state.

T_CHARGER_UTILS_ERROR charger_utils_set_all_param(T_CHARGER_UTILS_CONFIG *p_charger_config)

Set charging current and full voltage, restart charger fsm if charger is running.

charger_utils.h

Experimental Added Since 2.13.0.0:

Example usage

void charger_utils_demo(void)
{
    T_CHARGER_UTILS_CONFIG charger_config;

    if(charger_utils_get_all_param(&charger_config) == CHARGER_UTILS_SUCCESS)
    {
         charger_config.fast_charge_current = 50;
         if(charger_utils_set_all_param(&charger_config) != CHARGER_UTILS_SUCCESS)
         {
             APP_PRINT_ERROR0("charger_utils_demo: set param fail!");
         }
    }
}

Parameters:

p_charger_config -- [in] The configuration structure of charging current and full voltage.

Return values:

CHARGER_UTILS_SUCCESS -- The charging current and full voltage are set successfully.
CHARGER_UTILS_INVALID_PARAM -- Invalid charging current and full voltage parameters.

Returns:

The status of setting charging current and full voltage.

T_CHARGER_UTILS_ERROR charger_utils_get_all_param(T_CHARGER_UTILS_CONFIG *p_charger_config)

Get charging current and full voltage configurations.

charger_utils.h

Experimental Added Since 2.13.0.0:

Example usage

void charger_utils_demo(void)
{
    T_CHARGER_UTILS_CONFIG charger_config;

    if(charger_utils_get_all_param(&charger_config) == CHARGER_UTILS_SUCCESS)
    {
         charger_config.fast_charge_current = 50;
         if(charger_utils_set_all_param(&charger_config) != CHARGER_UTILS_SUCCESS)
         {
             APP_PRINT_ERROR0("charger_utils_demo: set param fail!");
         }
    }
}

Parameters:

p_charger_config -- [in] The configuration structure of charging current and full voltage.

Return values:

CHARGER_UTILS_SUCCESS -- The charging current and full voltage configurations are obtained successfully.
CHARGER_UTILS_INVALID_PARAM -- Invalid parameter.

Returns:

The status of getting charging current and full voltage configurations.

T_CHARGER_UTILS_ERROR charger_utils_get_thermistor_1_pin(uint8_t *p_thermistor_adc_channel)

Get charging thermistor1 adc channel configurations.

charger_utils.h

Experimental Added Since 2.13.0.0:

Example usage

void charger_utils_demo(void)
{
    T_CHARGER_UTILS_ERROR status;
    uint8_t thermistor_adc_channel;

    status = charger_utils_get_thermistor_1_pin(&thermistor_adc_channel);
    if(status == CHARGER_UTILS_SUCCESS)
    {
         APP_PRINT_INFO1("charger_utils_demo: thermistor_adc_channel %d", thermistor_adc_channel);
    }
    else
    {
         APP_PRINT_ERROR1("charger_utils_demo: error code %d", status);
    }
}

Parameters:

p_thermistor_adc_channel -- [in] Charging thermistor1 adc channel configurations.

Return values:

CHARGER_UTILS_SUCCESS -- The charging thermistor1 adc channel configurations are obtained successfully.
CHARGER_UTILS_INVALID_PARAM -- Invalid parameter.

Returns:

The status of getting charging thermistor1 adc channel configurations.