开发一种使用MAX77654和STM32F410RB的高效电源管理解决方案

利用我们的专业知识提升您的电池性能

BATT-MAN 2 Click with Nucleo 64 with STM32F410RB MCU

已发布 10月 08, 2024

点击板

BATT-MAN 2 Click

开发板

Nucleo 64 with STM32F410RB MCU

编译器

NECTO Studio

微控制器单元

STM32F410RB

确保精确充电，防止过充和过热，并实时监控电池健康状况。

硬件概览

它是如何工作的？

BATT-MAN 2 Click基于MAX77654，这是一款针对低功耗应用的高集成电池充电和电源管理解决方案，来自Analog Devices。它采用单电感、多输出(SIMO)升降压稳压器，能够高效地提供三个独立可编程电源轨，这些电源轨在板载端子上标记为VSB0、VSB1和VSB2。此外，它还有一个100mA的LDO输出，标记为VLDO，具有音频和其他对噪声敏感应用的纹波抑制功能。该LDO输出还可以配置为负载开关，通过在不需要时断开外部模块来管理功耗。通过填充JP2板载跳线可以激活/停用LDO输出。MAX77654还具有集成的高度可配置线性充电器，支持范围广泛的Li+电池容量，具有多种充电电流和充电终止电压选项，具备电池温度监测以增加安全性（JEITA）。当CHG电源无效（电源范围为4.1V至7.25V）、禁用或电池电量不足时，充

电器功能将关闭。除了板上的所有输出端子外，还有一个标记为VSYS的系统电源输出端子。除了为系统资源和设备的控制逻辑提供电源外，VSYS还设计用于外部使用。BATT-MAN 2 Click使用标准I2C 2线接口与MCU通信，以配置和检查设备状态。由于传感器的运行需要1.8V逻辑电压电平才能正常工作，因此使用了一个小型调节LDO，即Analog Devices的ADP160，从mikroBUS™导轨提供1.8V输出。因此，还配备了电压电平转换器。I2C接口总线线路被引到双向电压电平转换器，使此Click板™能够与3.3V和5V的MCU正常工作。板载开关标记为ENABLE，主要用于生成唤醒信号，通过将开关设置为适当位置1或0来打开稳压器。此外，此Click板™还具有一些额外功能，例如，复位引脚连接到mikroBUS™插座上的RST引脚，在

设备断电时将处理器保持在复位状态。它还使用中断引脚，即mikroBUS™插座的INT引脚，以指示设备状态的重要变化，而三个额外的LED指示灯，红色、黄色和蓝色LED，标记为LED2、LED3和LED4，可以用于可选的用户配置视觉指示。此外，该设备包括一个模拟多路复用器(AMX)，连接到mikroBUS™插座上的AN引脚，切换多个内部电压和电流信号到外部节点，以便通过外部ADC进行监测。此Click板™可通过VCC SEL跳线选择使用3.3V或5V逻辑电压水平，这样，既3.3V又5V的MCU都可以正确使用通信线路。此外，此Click板™配备了包含易于使用的功能和示例代码的库，可用作进一步开发的参考。

BATT-MAN 2 Click hardware overview image

功能概述

开发板

Nucleo-64 搭载 STM32F410RB MCU 提供了一种经济高效且灵活的平台，供开发者探索新想法并原型设计他们的项目。该板利用 STM32 微控制器的多功能性，使用户能够为他们的项目选择最佳的性能与功耗平衡。它配备了 LQFP64 封装的 STM32 微控制器，并包含了如用户 LED（同时作为 ARDUINO® 信号）、用户和复位按钮，以及 32.768kHz 晶体振荡器用于精确的计时操作等基本组件。Nucleo-64 板设计考虑到扩展性和灵活性，它特有的 ARDUINO® Uno

V3 扩展连接器和 ST morpho 扩展引脚头，提供了对 STM32 I/O 的完全访问，以实现全面的项目整合。电源供应选项灵活，支持 ST-LINK USB VBUS 或外部电源，确保在各种开发环境中的适应性。该板还配备了一个具有 USB 重枚举功能的板载 ST-LINK 调试器/编程器，简化了编程和调试过程。此外，该板设计旨在简化高级开发，它的外部 SMPS 为 Vcore 逻辑供电提供高效支持，支持 USB 设备全速或 USB SNK/UFP 全速，并内置加密功能，提升了项目的功效

和安全性。通过外部 SMPS 实验的专用连接器、用于 ST-LINK 的 USB 连接器以及 MIPI® 调试连接器，提供了更多的硬件接口和实验可能性。开发者将通过 STM32Cube MCU Package 提供的全面免费软件库和示例得到广泛支持。这些，加上与多种集成开发环境（IDE）的兼容性，包括 IAR Embedded Workbench®、MDK-ARM 和 STM32CubeIDE，确保了流畅且高效的开发体验，使用户能够充分利用 Nucleo-64 板在他们的项目中的能力。

Nucleo 64 with STM32C031C6 MCU double side image

微控制器概述

MCU卡片 / MCU

建筑

ARM Cortex-M4

MCU 内存 (KB)

128

硅供应商

STMicroelectronics

引脚数

RAM (字节)

32768

你完善了我！

配件

Click Shield for Nucleo-64 配备了两个专有的 mikroBUS™ 插座，使得所有的 Click board™ 设备都可以轻松地与 STM32 Nucleo-64 开发板连接。这样，Mikroe 允许其用户从不断增长的 Click boards™ 范围中添加任何功能，如 WiFi、GSM、GPS、蓝牙、ZigBee、环境传感器、LED、语音识别、电机控制、运动传感器等。您可以使用超过 1537 个 Click boards™，这些 Click boards™ 可以堆叠和集成。STM32 Nucleo-64 开发板基于 64 引脚封装的微控制器，采用 32 位 MCU，配备 ARM Cortex M4 处理器，运行速度为 84MHz，具有 512Kb Flash 和 96KB SRAM，分为两个区域，顶部区域代表 ST-Link/V2 调试器和编程器，而底部区域是一个实际的开发板。通过 USB 连接方便地控制和供电这些板子，以便直接对 Nucleo-64 开发板进行编程和高效调试，其中还需要额外的 USB 线连接到板子上的 USB 迷你接口。大多数 STM32 微控制器引脚都连接到了板子左右边缘的 IO 引脚上，然后连接到两个现有的 mikroBUS™ 插座上。该 Click Shield 还有几个开关，用于选择 mikroBUS™ 插座上模拟信号的逻辑电平和 mikroBUS™ 插座本身的逻辑电压电平。此外，用户还可以通过现有的双向电平转换器，使用任何 Click board™，无论 Click board™ 是否在 3.3V 或 5V 逻辑电压电平下运行。一旦将 STM32 Nucleo-64 开发板与我们的 Click Shield for Nucleo-64 连接，您就可以访问数百个工作于 3.3V 或 5V 逻辑电压电平的 Click boards™。

Click Shield for Nucleo-64 accessories 1 image

使用的MCU引脚

mikroBUS™映射器

Analog Signal

PC0

Reset

PC12

RST

SCK

MISO

MOSI

Power Supply

3.3V

Ground

GND

PWM

Interrupt

PC14

INT

I2C Clock

PB8

SCL

I2C Data

PB9

SDA

Power Supply

Ground

GND

“仔细看看！”

Click board™ 原理图

一步一步来

项目组装

Click Shield for Nucleo-64 accessories 1 image hardware assembly

从选择您的开发板和Click板™开始。以Nucleo 64 with STM32F410RB MCU作为您的开发板开始。

Nucleo 64 with STM32F401RE MCU front image hardware assembly

LTE IoT 5 Click front image hardware assembly

LTE IoT 5 Click complete accessories setup image hardware assembly

Nucleo-64 with STM32XXX MCU Access MB 1 Mini B Conn - upright/background hardware assembly

Clicker 4 for STM32F4 HA MCU Step hardware assembly

Necto No Display image step 8 hardware assembly

Debug Image Necto Step hardware assembly

实时跟踪您的结果

应用程序输出

1. 应用程序输出 - 在调试模式下，“应用程序输出”窗口支持实时数据监控，直接提供执行结果的可视化。请按照提供的教程正确配置环境，以确保数据正确显示。

2. UART 终端 - 使用UART Terminal通过USB to UART converter监视数据传输，实现Click board™与开发系统之间的直接通信。请根据项目需求配置波特率和其他串行设置，以确保正常运行。有关分步设置说明，请参考提供的教程。

3. Plot 输出 - Plot功能提供了一种强大的方式来可视化实时传感器数据，使趋势分析、调试和多个数据点的对比变得更加直观。要正确设置，请按照提供的教程，其中包含使用Plot功能显示Click board™读数的分步示例。在代码中使用Plot功能时，请使用以下函数：plot(insert_graph_name, variable_name);。这是一个通用格式，用户需要将“insert_graph_name”替换为实际图表名称，并将“variable_name”替换为要显示的参数。

软件支持

库描述

该库包含 BATT-MAN 2 Click 驱动程序的 API。

关键功能:

battman2_set_charger_enable - BATT-MAN 2 设置充电器使能功能
battman2_set_charger_cfg - BATT-MAN 2 设置充电器配置功能
battman2_get_charger_cfg - BATT-MAN 2 获取充电器配置功能

开源

代码示例

完整的应用程序代码和一个现成的项目可以通过NECTO Studio包管理器直接安装到NECTO Studio。应用程序代码也可以在MIKROE的GitHub账户中找到。

/*!
 * @file main.c
 * @brief BATTMAN2 Click example
 *
 * # Description
 * This library contains API for BATT-MAN 2 Click driver.
 * The library initializes and defines the I2C bus drivers 
 * to write and read data from registers. 
 * The library also includes a function for configuring appropriate charge current, 
 * charge voltage, prequalification voltage, 
 * Buck, Buck-Boost and Linear regulator configuration, etc.
 *
 * The demo application is composed of two sections :
 *
 * ## Application Init
 * The initialization of the I2C module, log UART, and additional pins. 
 * After the driver inits and executes a default configuration, 
 * the app disables charging, sets charger configuration, 
 * enables charging, displays charger configuration, 
 * or sets Buck-Boost configuration.
 *
 * ## Application Task
 * This is an example that shows the use of a BATT-MAN 2 Click board™.
 * The choice of example profile tasks depends on uncommented code.
 * Examples profile: CHARGER and BUCK-BOOST.
 * In the CHARGER profile, while on the BATT-MAN 2 click board™ the 
 * blue LED is the battery charging indicator, 
 * while the red LED indicates the cessation of battery charging. 
 * The yellow LED is an indicator of the BUCK-BOOST profile.
 * Results are being sent to the USART terminal where the user can track their changes. 
 * 
 * ## Additional Function
 * - static void display_charger_status ( void )
 * - static void display_sbb_status ( void ) 
 *
 * @author Nenad Filipovic
 *
 */

#include "board.h"
#include "log.h"
#include "battman2.h"

#define CHARGER
// #define BUCKBOOST

static battman2_t battman2;
static log_t logger;
static battman2_chg_cnfg_t chg_cfg;
static battman2_stat_chg_t chg_stat;
static battman2_sbb_cnfg_t sbb_cfg;
static uint8_t sbb_sel;

static void display_charger_status ( void ) 
{ 
    log_printf( &logger, " Charger Details :\r\n" );
    if ( chg_stat.chg_dtls == BATTMAN2_CHG_DTLS_OFF )
    {
        log_printf( &logger, "\tOff.\r\n" );    
    }
    if ( chg_stat.chg_dtls == BATTMAN2_CHG_DTLS_PREQUALIFICATION_MODE )
    {
        log_printf( &logger, "\tPrequalification mode.\r\n" );    
    }
    if ( chg_stat.chg_dtls == BATTMAN2_CHG_DTLS_FAST_CHARGE_CONSTANT_CURRENT )
    {
        log_printf( &logger, "\tFast-charge constant-current (CC) mode.\r\n" );    
    }
    if ( chg_stat.chg_dtls == BATTMAN2_CHG_DTLS_JEITA_MODIFIED_FAST_CHRG_CC )
    {
        log_printf( &logger, "\tJEITA modified fast-charge constantcurrent mode.\r\n" );    
    }
    if ( chg_stat.chg_dtls == BATTMAN2_CHG_DTLS_FAST_CHARGE_CONSTANT_VOLTAGE )
    {
        log_printf( &logger, "\tFast-charge constant-voltage (CV) mode.\r\n" );    
    }
    if ( chg_stat.chg_dtls == BATTMAN2_CHG_DTLS_JEITA_MODIFIED_FAST_CHRG_CV )
    {
        log_printf( &logger, "\tJEITA modified fast-charge constant voltage (CV) mode.\r\n" );    
    }
    if ( chg_stat.chg_dtls == BATTMAN2_CHG_DTLS_TOP_OFF_MODE )
    {
        log_printf( &logger, "\tTop-off mode.\r\n" );    
    }
    if ( chg_stat.chg_dtls == BATTMAN2_CHG_DTLS_JEITA_MODIFIED_TOP_OFF_MODE )
    {
        log_printf( &logger, "\tJEITA modified top-off mode.\r\n" );    
    }
    if ( chg_stat.chg_dtls == BATTMAN2_CHG_DTLS_DONE )
    {
        log_printf( &logger, "\tDone.\r\n" );    
    }
    if ( chg_stat.chg_dtls == BATTMAN2_CHG_DTLS_JEITA_MODIFIED_DONE )
    {
        log_printf( &logger, "\tJEITA modified done.\r\n" );    
    }
    if ( chg_stat.chg_dtls == BATTMAN2_CHG_DTLS_PREQUALIFICATION_TIMER_FAULT )
    {
        log_printf( &logger, "\tPrequalification timer fault.\r\n" );    
    }
    if ( chg_stat.chg_dtls == BATTMAN2_CHG_DTLS_FAST_CHARGE_TIMER_FAULT )
    {
        log_printf( &logger, "\tFast-charge timer fault.\r\n" );    
    }
    if ( chg_stat.chg_dtls == BATTMAN2_CHG_DTLS_BATTERY_TEMPERATURE_FAULT )
    {
        log_printf( &logger, "\tBattery temperature fault.\r\n" );    
    }

    log_printf( &logger, " Quick Charger Status :\r\n" );
    if ( chg_stat.chg == BATTMAN2_CHG_NO_CHARGING )
    {
        log_printf( &logger, "\tCharging is not happening.\r\n" ); 
        battman2_set_gpio_output( &battman2, BATTMAN2_SEL_LED_RED, BATTMAN2_PIN_STATE_ON );
        battman2_set_gpio_output( &battman2, BATTMAN2_SEL_LED_YELLOW, BATTMAN2_PIN_STATE_OFF );
        battman2_set_gpio_output( &battman2, BATTMAN2_SEL_LED_BLUE, BATTMAN2_PIN_STATE_OFF );
    }
     if ( chg_stat.chg == BATTMAN2_CHG_CHARGING )
    {
        log_printf( &logger, "\tCharging is happening.\r\n" );
        battman2_set_gpio_output( &battman2, BATTMAN2_SEL_LED_RED, BATTMAN2_PIN_STATE_OFF );
        battman2_set_gpio_output( &battman2, BATTMAN2_SEL_LED_YELLOW, BATTMAN2_PIN_STATE_OFF );
        battman2_set_gpio_output( &battman2, BATTMAN2_SEL_LED_BLUE, BATTMAN2_PIN_STATE_ON );
    }
    log_printf( &logger, "-----------------------------------------------\r\n" );
}

static void display_sbb_status ( void ) 
{ 
    log_printf( &logger, "\tSBB Channel    : VSB-%d\r\n", ( uint16_t ) sbb_sel );
    log_printf( &logger, "\tOperation Mode :" );
    if ( sbb_cfg.op_mode == BATTMAN2_OP_MODE_BUCK_AND_BOOST )
    {
        log_printf( &logger, " Buck-boost mode.\r\n" );    
    }
    if ( sbb_cfg.op_mode == BATTMAN2_OP_MODE_BUCK )
    {
        log_printf( &logger, " Buck mode.\r\n" );    
    }
    
    log_printf( &logger, "\tCurrent Limit  :" );
    if ( sbb_cfg.current_limit == BATTMAN2_CURRENT_LIMIT_1000_mA )
    {
        log_printf( &logger, " 1.000 A\r\n" );    
    }
    if ( sbb_cfg.current_limit == BATTMAN2_CURRENT_LIMIT_750_mA )
    {
        log_printf( &logger, " 0.750 A\r\n" );    
    }
    if ( sbb_cfg.current_limit == BATTMAN2_CURRENT_LIMIT_500_mA )
    {
        log_printf( &logger, " 0.500 A\r\n" );    
    }
    if ( sbb_cfg.current_limit == BATTMAN2_CURRENT_LIMIT_333_mA )
    {
        log_printf( &logger, " 0.333 A\r\n" );    
    }
    
    log_printf( &logger, "\tOutput Voltage : %.3f V\r\n", sbb_cfg.output_vtg );
    log_printf( &logger, "-----------------------------------------------\r\n" );
}

void application_init ( void ) 
{
    log_cfg_t log_cfg;            /**< Logger config object. */
    battman2_cfg_t battman2_cfg;  /**< Click config object. */

    /** 
     * Logger initialization.
     * Default baud rate: 115200
     * Default log level: LOG_LEVEL_DEBUG
     * @note If USB_UART_RX and USB_UART_TX 
     * are defined as HAL_PIN_NC, you will 
     * need to define them manually for log to work. 
     * See @b LOG_MAP_USB_UART macro definition for detailed explanation.
     */
    LOG_MAP_USB_UART( log_cfg );
    log_init( &logger, &log_cfg );
    log_info( &logger, " Application Init " );

    // Click initialization.
    battman2_cfg_setup( &battman2_cfg );
    BATTMAN2_MAP_MIKROBUS( battman2_cfg, MIKROBUS_1 );
    err_t init_flag = battman2_init( &battman2, &battman2_cfg );
    if ( I2C_MASTER_ERROR == init_flag ) 
    {
        log_error( &logger, " Application Init Error. " );
        log_info( &logger, " Please, run program again... " );

        for ( ; ; );
    }

    battman2_default_cfg ( &battman2 );
    log_info( &logger, " Application Task " );
    Delay_ms ( 100 ); 
    
    battman2_set_charger_enable( &battman2, BATTMAN2_SET_CHARGER_DISABLE );
    Delay_ms ( 100 );
        
    #ifdef CHARGER
        log_printf( &logger, "-----------------------------------------------\r\n" );
        log_printf( &logger, "                Example: CHARGER               \r\n" );
    
        chg_cfg.thm_hot           = BATTMAN2_THM_HOT_411_mV;
        chg_cfg.thm_warm          = BATTMAN2_THM_WARM_511_mV;
        chg_cfg.thm_cool          = BATTMAN2_THM_COOL_747_mV;
        chg_cfg.thm_cold          = BATTMAN2_THM_COLD_867_mV;
        chg_cfg.vchgin_min        = 4.2;
        chg_cfg.ichgin_lim        = 95.0;
        chg_cfg.i_pq              = BATTMAN2_I_PQ_10_PERCENTAGE;
        chg_cfg.chg_pq            = 3.0;
        chg_cfg.i_term            = BATTMAN2_I_TERM_5_PERCENTAGE;
        chg_cfg.t_topoff          = BATTMAN2_T_TOPOFF_0_MIN;
        chg_cfg.tj_reg            = BATTMAN2_TJ_REG_60_C;
        chg_cfg.vsys_reg          = 4.100;
        chg_cfg.chg_cc            = 112.5;
        chg_cfg.t_fast_chg        = BATTMAN2_T_FAST_CHG_TIMER_7_HOURS;
        chg_cfg.chg_cc_jeita      = 15.0;
        chg_cfg.thm_en            = BATTMAN2_THM_EN_THERMISTOR_DISABLED;
        chg_cfg.chg_cv            = 3.775;
        chg_cfg.usbs              = BATTMAN2_USBS_CHGIN_IS_NOT_SUSPENDED;
        chg_cfg.chg_cv_jeita      = 3.6;
        chg_cfg.imon_dischg_scale = BATTMAN2_IMON_DISCHG_SCALE_300_mA;
        chg_cfg.mux_sel           = BATTMAN2_MUX_SEL_MULTIPLEXER_DISABLED;
        
        battman2_set_charger_cfg( &battman2, chg_cfg );
        Delay_ms ( 100 );
        
        battman2_set_charger_enable( &battman2, BATTMAN2_SET_CHARGER_ENABLE );
        Delay_ms ( 100 );  
    #endif
        
    #ifdef BUCKBOOST
        log_printf( &logger, "-----------------------------------------------\r\n" );
        log_printf( &logger, "              Example: BUCK-BOOST              \r\n" );
        
        sbb_sel = BATTMAN2_SBB_CH_1;
        sbb_cfg.output_vtg = 5.5;
        sbb_cfg.op_mode = BATTMAN2_OP_MODE_BUCK_AND_BOOST; 
        sbb_cfg.current_limit = BATTMAN2_CURRENT_LIMIT_500_mA;
        sbb_cfg.active_discharge_enable = BATTMAN2_ACTIVE_DISCHARGE_ENABLE;
        sbb_cfg.enable_control = BATTMAN2_ENABLE_CONTROL_ON_IRRESPECTIVE_FPS;
        sbb_cfg.ichgin_lim_def = BATTMAN2_ICHGIN_LIM_95_mA;
        sbb_cfg.drv_sbb = BATTMAN2_DRV_SBB_FAST_TRANSITION_TIME;
        battman2_set_sbb_config( &battman2, sbb_sel, sbb_cfg );
        log_printf( &logger, "-----------------------------------------------\r\n" );
        battman2_set_gpio_output( &battman2, BATTMAN2_SEL_LED_RED, BATTMAN2_PIN_STATE_OFF );
        battman2_set_gpio_output( &battman2, BATTMAN2_SEL_LED_YELLOW, BATTMAN2_PIN_STATE_ON );
        battman2_set_gpio_output( &battman2, BATTMAN2_SEL_LED_BLUE, BATTMAN2_PIN_STATE_OFF );
        Delay_ms ( 1000 );
    #endif
}

void application_task ( void ) 
{   
    #ifdef CHARGER
        battman2_get_chg_status( &battman2, &chg_stat );
        Delay_ms ( 10 );
        
        display_charger_status( );
        Delay_ms ( 1000 );
        
        battman2_get_charger_cfg( &battman2, &chg_cfg );
        log_printf( &logger, " Fast-charge constant current value : %.1f mA\r\n", chg_cfg.chg_cc );
        log_printf( &logger, " Minimum CHGIN Regulation Voltage   : %.3f V\r\n", chg_cfg.vchgin_min );
        log_printf( &logger, " Battery Prequalific. Voltage Thld  : %.3f V\r\n", chg_cfg.chg_pq );
        log_printf( &logger, " System Voltage Regulation          : %.3f V\r\n", chg_cfg.vsys_reg );
        log_printf( &logger, " JEITA Ifast-chg-jeita              : %.2f mA\r\n", chg_cfg.chg_cc_jeita );
        log_printf( &logger, " Fast-charge battery Vreg           : %.3f V\r\n", chg_cfg.chg_cv );
        log_printf( &logger, " Vfast-chg-jeita                    : %.3f V\r\n", chg_cfg.chg_cv_jeita );
        log_printf( &logger, "-----------------------------------------------\r\n" );
        Delay_ms ( 1000 );
    #endif
        
    #ifdef BUCKBOOST 
        battman2_get_sbb_config( &battman2, sbb_sel, &sbb_cfg );
        Delay_ms ( 10 );
        
        display_sbb_status( );
        Delay_ms ( 1000 );
    #endif
}

int main ( void ) 
{
    /* Do not remove this line or clock might not be set correctly. */
    #ifdef PREINIT_SUPPORTED
    preinit();
    #endif
    
    application_init( );
    
    for ( ; ; ) 
    {
        application_task( );
    }

    return 0;
}

// ------------------------------------------------------------------------ END

/*!
 * @file main.c
 * @brief BATTMAN2 Click example
 *
 * # Description
 * This library contains API for BATT-MAN 2 Click driver.
 * The library initializes and defines the I2C bus drivers 
 * to write and read data from registers. 
 * The library also includes a function for configuring appropriate charge current, 
 * charge voltage, prequalification voltage, 
 * Buck, Buck-Boost and Linear regulator configuration, etc.
 *
 * The demo application is composed of two sections :
 *
 * ## Application Init
 * The initialization of the I2C module, log UART, and additional pins. 
 * After the driver inits and executes a default configuration, 
 * the app disables charging, sets charger configuration, 
 * enables charging, displays charger configuration, 
 * or sets Buck-Boost configuration.
 *
 * ## Application Task
 * This is an example that shows the use of a BATT-MAN 2 Click board™.
 * The choice of example profile tasks depends on uncommented code.
 * Examples profile: CHARGER and BUCK-BOOST.
 * In the CHARGER profile, while on the BATT-MAN 2 click board™ the 
 * blue LED is the battery charging indicator, 
 * while the red LED indicates the cessation of battery charging. 
 * The yellow LED is an indicator of the BUCK-BOOST profile.
 * Results are being sent to the USART terminal where the user can track their changes. 
 * 
 * ## Additional Function
 * - static void display_charger_status ( void )
 * - static void display_sbb_status ( void ) 
 *
 * @author Nenad Filipovic
 *
 */

#include "board.h"
#include "log.h"
#include "battman2.h"

#define CHARGER
// #define BUCKBOOST

static battman2_t battman2;
static log_t logger;
static battman2_chg_cnfg_t chg_cfg;
static battman2_stat_chg_t chg_stat;
static battman2_sbb_cnfg_t sbb_cfg;
static uint8_t sbb_sel;

static void display_charger_status ( void ) 
{ 
    log_printf( &logger, " Charger Details :\r\n" );
    if ( chg_stat.chg_dtls == BATTMAN2_CHG_DTLS_OFF )
    {
        log_printf( &logger, "\tOff.\r\n" );    
    }
    if ( chg_stat.chg_dtls == BATTMAN2_CHG_DTLS_PREQUALIFICATION_MODE )
    {
        log_printf( &logger, "\tPrequalification mode.\r\n" );    
    }
    if ( chg_stat.chg_dtls == BATTMAN2_CHG_DTLS_FAST_CHARGE_CONSTANT_CURRENT )
    {
        log_printf( &logger, "\tFast-charge constant-current (CC) mode.\r\n" );    
    }
    if ( chg_stat.chg_dtls == BATTMAN2_CHG_DTLS_JEITA_MODIFIED_FAST_CHRG_CC )
    {
        log_printf( &logger, "\tJEITA modified fast-charge constantcurrent mode.\r\n" );    
    }
    if ( chg_stat.chg_dtls == BATTMAN2_CHG_DTLS_FAST_CHARGE_CONSTANT_VOLTAGE )
    {
        log_printf( &logger, "\tFast-charge constant-voltage (CV) mode.\r\n" );    
    }
    if ( chg_stat.chg_dtls == BATTMAN2_CHG_DTLS_JEITA_MODIFIED_FAST_CHRG_CV )
    {
        log_printf( &logger, "\tJEITA modified fast-charge constant voltage (CV) mode.\r\n" );    
    }
    if ( chg_stat.chg_dtls == BATTMAN2_CHG_DTLS_TOP_OFF_MODE )
    {
        log_printf( &logger, "\tTop-off mode.\r\n" );    
    }
    if ( chg_stat.chg_dtls == BATTMAN2_CHG_DTLS_JEITA_MODIFIED_TOP_OFF_MODE )
    {
        log_printf( &logger, "\tJEITA modified top-off mode.\r\n" );    
    }
    if ( chg_stat.chg_dtls == BATTMAN2_CHG_DTLS_DONE )
    {
        log_printf( &logger, "\tDone.\r\n" );    
    }
    if ( chg_stat.chg_dtls == BATTMAN2_CHG_DTLS_JEITA_MODIFIED_DONE )
    {
        log_printf( &logger, "\tJEITA modified done.\r\n" );    
    }
    if ( chg_stat.chg_dtls == BATTMAN2_CHG_DTLS_PREQUALIFICATION_TIMER_FAULT )
    {
        log_printf( &logger, "\tPrequalification timer fault.\r\n" );    
    }
    if ( chg_stat.chg_dtls == BATTMAN2_CHG_DTLS_FAST_CHARGE_TIMER_FAULT )
    {
        log_printf( &logger, "\tFast-charge timer fault.\r\n" );    
    }
    if ( chg_stat.chg_dtls == BATTMAN2_CHG_DTLS_BATTERY_TEMPERATURE_FAULT )
    {
        log_printf( &logger, "\tBattery temperature fault.\r\n" );    
    }

    log_printf( &logger, " Quick Charger Status :\r\n" );
    if ( chg_stat.chg == BATTMAN2_CHG_NO_CHARGING )
    {
        log_printf( &logger, "\tCharging is not happening.\r\n" ); 
        battman2_set_gpio_output( &battman2, BATTMAN2_SEL_LED_RED, BATTMAN2_PIN_STATE_ON );
        battman2_set_gpio_output( &battman2, BATTMAN2_SEL_LED_YELLOW, BATTMAN2_PIN_STATE_OFF );
        battman2_set_gpio_output( &battman2, BATTMAN2_SEL_LED_BLUE, BATTMAN2_PIN_STATE_OFF );
    }
     if ( chg_stat.chg == BATTMAN2_CHG_CHARGING )
    {
        log_printf( &logger, "\tCharging is happening.\r\n" );
        battman2_set_gpio_output( &battman2, BATTMAN2_SEL_LED_RED, BATTMAN2_PIN_STATE_OFF );
        battman2_set_gpio_output( &battman2, BATTMAN2_SEL_LED_YELLOW, BATTMAN2_PIN_STATE_OFF );
        battman2_set_gpio_output( &battman2, BATTMAN2_SEL_LED_BLUE, BATTMAN2_PIN_STATE_ON );
    }
    log_printf( &logger, "-----------------------------------------------\r\n" );
}

static void display_sbb_status ( void ) 
{ 
    log_printf( &logger, "\tSBB Channel    : VSB-%d\r\n", ( uint16_t ) sbb_sel );
    log_printf( &logger, "\tOperation Mode :" );
    if ( sbb_cfg.op_mode == BATTMAN2_OP_MODE_BUCK_AND_BOOST )
    {
        log_printf( &logger, " Buck-boost mode.\r\n" );    
    }
    if ( sbb_cfg.op_mode == BATTMAN2_OP_MODE_BUCK )
    {
        log_printf( &logger, " Buck mode.\r\n" );    
    }
    
    log_printf( &logger, "\tCurrent Limit  :" );
    if ( sbb_cfg.current_limit == BATTMAN2_CURRENT_LIMIT_1000_mA )
    {
        log_printf( &logger, " 1.000 A\r\n" );    
    }
    if ( sbb_cfg.current_limit == BATTMAN2_CURRENT_LIMIT_750_mA )
    {
        log_printf( &logger, " 0.750 A\r\n" );    
    }
    if ( sbb_cfg.current_limit == BATTMAN2_CURRENT_LIMIT_500_mA )
    {
        log_printf( &logger, " 0.500 A\r\n" );    
    }
    if ( sbb_cfg.current_limit == BATTMAN2_CURRENT_LIMIT_333_mA )
    {
        log_printf( &logger, " 0.333 A\r\n" );    
    }
    
    log_printf( &logger, "\tOutput Voltage : %.3f V\r\n", sbb_cfg.output_vtg );
    log_printf( &logger, "-----------------------------------------------\r\n" );
}

void application_init ( void ) 
{
    log_cfg_t log_cfg;            /**< Logger config object. */
    battman2_cfg_t battman2_cfg;  /**< Click config object. */

    /** 
     * Logger initialization.
     * Default baud rate: 115200
     * Default log level: LOG_LEVEL_DEBUG
     * @note If USB_UART_RX and USB_UART_TX 
     * are defined as HAL_PIN_NC, you will 
     * need to define them manually for log to work. 
     * See @b LOG_MAP_USB_UART macro definition for detailed explanation.
     */
    LOG_MAP_USB_UART( log_cfg );
    log_init( &logger, &log_cfg );
    log_info( &logger, " Application Init " );

    // Click initialization.
    battman2_cfg_setup( &battman2_cfg );
    BATTMAN2_MAP_MIKROBUS( battman2_cfg, MIKROBUS_1 );
    err_t init_flag = battman2_init( &battman2, &battman2_cfg );
    if ( I2C_MASTER_ERROR == init_flag ) 
    {
        log_error( &logger, " Application Init Error. " );
        log_info( &logger, " Please, run program again... " );

        for ( ; ; );
    }

    battman2_default_cfg ( &battman2 );
    log_info( &logger, " Application Task " );
    Delay_ms ( 100 ); 
    
    battman2_set_charger_enable( &battman2, BATTMAN2_SET_CHARGER_DISABLE );
    Delay_ms ( 100 );
        
    #ifdef CHARGER
        log_printf( &logger, "-----------------------------------------------\r\n" );
        log_printf( &logger, "                Example: CHARGER               \r\n" );
    
        chg_cfg.thm_hot           = BATTMAN2_THM_HOT_411_mV;
        chg_cfg.thm_warm          = BATTMAN2_THM_WARM_511_mV;
        chg_cfg.thm_cool          = BATTMAN2_THM_COOL_747_mV;
        chg_cfg.thm_cold          = BATTMAN2_THM_COLD_867_mV;
        chg_cfg.vchgin_min        = 4.2;
        chg_cfg.ichgin_lim        = 95.0;
        chg_cfg.i_pq              = BATTMAN2_I_PQ_10_PERCENTAGE;
        chg_cfg.chg_pq            = 3.0;
        chg_cfg.i_term            = BATTMAN2_I_TERM_5_PERCENTAGE;
        chg_cfg.t_topoff          = BATTMAN2_T_TOPOFF_0_MIN;
        chg_cfg.tj_reg            = BATTMAN2_TJ_REG_60_C;
        chg_cfg.vsys_reg          = 4.100;
        chg_cfg.chg_cc            = 112.5;
        chg_cfg.t_fast_chg        = BATTMAN2_T_FAST_CHG_TIMER_7_HOURS;
        chg_cfg.chg_cc_jeita      = 15.0;
        chg_cfg.thm_en            = BATTMAN2_THM_EN_THERMISTOR_DISABLED;
        chg_cfg.chg_cv            = 3.775;
        chg_cfg.usbs              = BATTMAN2_USBS_CHGIN_IS_NOT_SUSPENDED;
        chg_cfg.chg_cv_jeita      = 3.6;
        chg_cfg.imon_dischg_scale = BATTMAN2_IMON_DISCHG_SCALE_300_mA;
        chg_cfg.mux_sel           = BATTMAN2_MUX_SEL_MULTIPLEXER_DISABLED;
        
        battman2_set_charger_cfg( &battman2, chg_cfg );
        Delay_ms ( 100 );
        
        battman2_set_charger_enable( &battman2, BATTMAN2_SET_CHARGER_ENABLE );
        Delay_ms ( 100 );  
    #endif
        
    #ifdef BUCKBOOST
        log_printf( &logger, "-----------------------------------------------\r\n" );
        log_printf( &logger, "              Example: BUCK-BOOST              \r\n" );
        
        sbb_sel = BATTMAN2_SBB_CH_1;
        sbb_cfg.output_vtg = 5.5;
        sbb_cfg.op_mode = BATTMAN2_OP_MODE_BUCK_AND_BOOST; 
        sbb_cfg.current_limit = BATTMAN2_CURRENT_LIMIT_500_mA;
        sbb_cfg.active_discharge_enable = BATTMAN2_ACTIVE_DISCHARGE_ENABLE;
        sbb_cfg.enable_control = BATTMAN2_ENABLE_CONTROL_ON_IRRESPECTIVE_FPS;
        sbb_cfg.ichgin_lim_def = BATTMAN2_ICHGIN_LIM_95_mA;
        sbb_cfg.drv_sbb = BATTMAN2_DRV_SBB_FAST_TRANSITION_TIME;
        battman2_set_sbb_config( &battman2, sbb_sel, sbb_cfg );
        log_printf( &logger, "-----------------------------------------------\r\n" );
        battman2_set_gpio_output( &battman2, BATTMAN2_SEL_LED_RED, BATTMAN2_PIN_STATE_OFF );
        battman2_set_gpio_output( &battman2, BATTMAN2_SEL_LED_YELLOW, BATTMAN2_PIN_STATE_ON );
        battman2_set_gpio_output( &battman2, BATTMAN2_SEL_LED_BLUE, BATTMAN2_PIN_STATE_OFF );
        Delay_ms ( 1000 );
    #endif
}

void application_task ( void ) 
{   
    #ifdef CHARGER
        battman2_get_chg_status( &battman2, &chg_stat );
        Delay_ms ( 10 );
        
        display_charger_status( );
        Delay_ms ( 1000 );
        
        battman2_get_charger_cfg( &battman2, &chg_cfg );
        log_printf( &logger, " Fast-charge constant current value : %.1f mA\r\n", chg_cfg.chg_cc );
        log_printf( &logger, " Minimum CHGIN Regulation Voltage   : %.3f V\r\n", chg_cfg.vchgin_min );
        log_printf( &logger, " Battery Prequalific. Voltage Thld  : %.3f V\r\n", chg_cfg.chg_pq );
        log_printf( &logger, " System Voltage Regulation          : %.3f V\r\n", chg_cfg.vsys_reg );
        log_printf( &logger, " JEITA Ifast-chg-jeita              : %.2f mA\r\n", chg_cfg.chg_cc_jeita );
        log_printf( &logger, " Fast-charge battery Vreg           : %.3f V\r\n", chg_cfg.chg_cv );
        log_printf( &logger, " Vfast-chg-jeita                    : %.3f V\r\n", chg_cfg.chg_cv_jeita );
        log_printf( &logger, "-----------------------------------------------\r\n" );
        Delay_ms ( 1000 );
    #endif
        
    #ifdef BUCKBOOST 
        battman2_get_sbb_config( &battman2, sbb_sel, &sbb_cfg );
        Delay_ms ( 10 );
        
        display_sbb_status( );
        Delay_ms ( 1000 );
    #endif
}

int main ( void ) 
{
    /* Do not remove this line or clock might not be set correctly. */
    #ifdef PREINIT_SUPPORTED
    preinit();
    #endif
    
    application_init( );
    
    for ( ; ; ) 
    {
        application_task( );
    }

    return 0;
}

// ------------------------------------------------------------------------ END