Library Description

This library allows user to perform a battery monitoring. User can get battery voltage, battery current, temperature, SOC, OCV value from the device. This library offers a choice to set SOC and voltage alarm value and to check alarm interrupt status. For more details check documentation.

Key functions:

• T_BATTMON_RETVAL battmon_readBytes( uint8_t regAddr, uint8_t *dataOut, uint8_t nBytes ) - This function reads the desired number of bytes starting from the selected register.
• T_BATTMON_RETVAL battmon_writeByte( uint8_t regAddr, uint8_t dataIn ) - This function writes one byte data to the selected register.
• float battmon_getData( uint8_t data_addr ) - This function allows user to get the desired data calculated to the properly unit.

Examples description

The application is composed of three sections :

• System Initialization - Initializes peripherals and pins.
• Application Initialization - Initializes I2C serial interface, reads the part ID and performs a device configuration and alarm setting.
• Application Task - (code snippet) - Checks the conversion counter value and when conversion was done reads data calculated to the properly unit and checks the alarm status. All results will be sent to the uart terminal. Note: Voltage and current conversion will be done after 4 seconds. Temperature conversion will be done after 16 seconds. After temperature reading the conversion counter will be cleared. Clearing the alarm while the corresponding low-voltage or low-SOC condition is still in progress does not generate another interrupt. This condition must disappear first and must be detected again before another interrupt (ALM pin driven low or alarm interrupt bits are set high) is generated for this alarm. Another alarm condition, if not yet triggered, can still generate an interrupt. Input voltage must be in the range from 2.7V to 4.5V. Maximal battery current is 5A.

void applicationTask()
{
    conv_cnt = battmon_getData( _BATTMON_REG_COUNTER );

    if (((conv_cnt % 4) == 0) && (conv_cnt > 0))
    {
        data_read = battmon_getData( _BATTMON_REG_SOC );
    
        FloatToStr( data_read, text );
        floatCut();
        mikrobus_logWrite( "** Gas Gauge Relative SOC : ", _LOG_TEXT );
        mikrobus_logWrite( text, _LOG_TEXT );
        mikrobus_logWrite( " %", _LOG_LINE );
    
        data_read = battmon_getData( _BATTMON_REG_CURRENT );
    
        FloatToStr( data_read, text );
        floatCut();
        mikrobus_logWrite( "** Battery Current : ", _LOG_TEXT );
        mikrobus_logWrite( text, _LOG_TEXT );
        mikrobus_logWrite( " mA", _LOG_LINE );
        
        data_read = battmon_getData( _BATTMON_REG_VOLTAGE );
        
        FloatToStr( data_read, text );
        floatCut();
        mikrobus_logWrite( "** Battery Voltage : ", _LOG_TEXT );
        mikrobus_logWrite( text, _LOG_TEXT );
        mikrobus_logWrite( " mV", _LOG_LINE );
        
        if ((conv_cnt % 16) == 0)
        {
            data_read = battmon_getData( _BATTMON_REG_TEMPERATURE );
            battmon_reset_conv_cnt();
            
            FloatToStr( data_read, text );
            floatCut();
            mikrobus_logWrite( "** Temperature : ", _LOG_TEXT );
            mikrobus_logWrite( text, _LOG_TEXT );
            mikrobus_logWrite( cels_symbol, _LOG_LINE );
        }
        
        reg_read = battmon_check_clear_alarm();

        if ((reg_read & _BATTMON_ALM_SOC_DET_MASK) != _BATTMON_LOG_LOW)
        {
            mikrobus_logWrite( "** Low-SOC Condition!", _LOG_LINE );
            alarmPlay();
        }
        if ((reg_read & _BATTMON_ALM_VOLT_DET_MASK) != _BATTMON_LOG_LOW)
        {
            mikrobus_logWrite( "** Low-Voltage Condition!", _LOG_LINE );
            alarmPlay();
        }
        
        mikrobus_logWrite( "*********************************", _LOG_LINE );
        Delay_ms( 1000 );
    }
    else
    {
        Delay_ms( 200 );
    }
}

Additional Functions :

• floatCut - Allows to real values be rounded on two decimal places.
• alarmPlay - Makes sound on buzzer for alarm detection.

Other mikroE Libraries used in the example:

• Conversions
• I2C
• Sound
• UART

Additional notes and informations

Depending on the development board you are using, you may need USB UART click, USB UART 2 click or RS232 click to connect to your PC, for development systems with no UART to USB interface available on the board. The terminal available in all MikroElektronika compilers, or any other terminal application of your choice, can be used to read the message.