STC3115_driver.h Software Source Code

Below is the STC3115_driver.h software source code.

The STC3115 is a fuel gauge IC for lithium ion batteries made by STMicroelectronics.

The STC3115_driver.h source code contains register definitions and structure definitions needed for a microcontroller and the STC3115 to be able to communicate with each other via the I2C bus protocol.

This source code contains the slave address for the STC3115 chip, as well as the various internal registers that need to be read from the STC3115 in order to read the state of charge of the battery connected in hardware. It also features registers that can be written to such as the programmable alarm, which allows us to program the level of the low state of charge or battery voltage which triggers a low level alarm (if desired).

All values in this source code corresponds to values that can be found on the datasheet for the STC3115, which can be found here: STC3115 Gas Gauge IC

This source code is designed for guidance only.


/******************** (C) COPYRIGHT 2011 STMicroelectronics ******************** * File Name : stc3115_Driver.h * Author : AMS - IMS application * Version : V01 * Date : 30 July 2014 * Description : STC3115 driver definition ******************************************************************************** * THE PRESENT SOFTWARE WHICH IS FOR GUIDANCE ONLY AIMS AT PROVIDING CUSTOMERS * WITH CODING INFORMATION REGARDING THEIR PRODUCTS IN ORDER FOR THEM TO SAVE TIME. * AS A RESULT, STMICROELECTRONICS SHALL NOT BE HELD LIABLE FOR ANY DIRECT, * INDIRECT OR CONSEQUENTIAL DAMAGES WITH RESPECT TO ANY CLAIMS ARISING FROM THE * CONTENT OF SUCH SOFTWARE AND/OR THE USE MADE BY CUSTOMERS OF THE CODING * INFORMATION CONTAINED HEREIN IN CONNECTION WITH THEIR PRODUCTS. * THIS SOURCE CODE IS PROTECTED BY A LICENSE. * FOR MORE INFORMATION PLEASE CAREFULLY READ THE LICENSE AGREEMENT FILE LOCATED * IN THE ROOT DIRECTORY OF THIS FIRMWARE PACKAGE. *******************************************************************************/ /* Define to prevent recursive inclusion ---------------------------------------------- */ #ifndef __STC3115_H #define __STC3115_H /* Private define --------------------------------------------------------------------- */ #define STC3115_SLAVE_ADDRESS 0xE0 /* STC31xx 8-bit address byte */ /*STC3115 registers define ------------------------------------------------------------ */ #define STC3115_REG_MODE 0x00 /* Mode Register */ #define STC3115_REG_CTRL 0x01 /* Control and Status Register */ #define STC3115_REG_SOC 0x02 /* SOC Data (2 bytes) */ #define STC3115_REG_COUNTER 0x04 /* Number of Conversion (2 bytes) */ #define STC3115_REG_CURRENT 0x06 /* Battery Current (2 bytes) */ #define STC3115_REG_VOLTAGE 0x08 /* Battery Voltage (2 bytes) */ #define STC3115_REG_TEMPERATURE 0x0A /* Temperature */ #define STC3115_REG_CC_ADJ_HIGH 0x0B /* CC adjustement */ #define STC3115_REG_CC_ADJ_LOW 0x19 /* CC adjustement */ #define STC3115_REG_VM_ADJ_HIGH 0x0C /* VM adjustement */ #define STC3115_REG_VM_ADJ_LOW 0x1A /* VM adjustement */ #define STC3115_REG_OCV 0x0D /* Battery OCV (2 bytes) */ #define STC3115_REG_CC_CNF 0x0F /* Coulomb Counter CC configuration (2 bytes) */ #define STC3115_REG_VM_CNF 0x11 /* Voltage Mode VM configuration (2 bytes) */ #define STC3115_REG_ALARM_SOC 0x13 /* SOC alarm level */ #define STC3115_REG_ALARM_VOLTAGE 0x14 /* Low voltage alarm level */ #define STC3115_REG_CURRENT_THRES 0x15 /* Current threshold for relaxation */ #define STC3115_REG_RELAX_COUNT 0x16 /* Voltage relaxation counter */ #define STC3115_REG_RELAX_MAX 0x17 /* Voltage relaxation max count */ #define STC3115_REG_ID 0x18 #define STC3115_REG_RAM 0x20 /* General Purpose RAM Registers */ #define STC3115_REG_OCVTAB 0x30 /* OCV OFFSET table registers */ /*STC3115 STC3115_REG_MODE Bit mask definition ------------------------------------ */ #define STC3115_VMODE 0x01 /* Voltage mode bit mask */ #define STC3115_CLR_VM_ADJ 0x02 /* Clear VM ADJ register bit mask */ #define STC3115_CLR_CC_ADJ 0x04 /* Clear CC ADJ register bit mask */ #define STC3115_ALM_ENA 0x08 /* Alarm enable bit mask */ #define STC3115_GG_RUN 0x10 /* Alarm enable bit mask */ #define STC3115_FORCE_CC 0x20 /* Force CC bit mask */ #define STC3115_FORCE_VM 0x40 /* Force VM bit mask */ #define STC3115_REGMODE_DEFAULT_STANDBY 0x09 /* GG_RUN=0 (Standby mode) */ /*STC3115 STC3115_REG_CTRL Bit mask definition ------------------------------------ */ //ALM TBD #define STC3115_GG_RST 0x02 /* Convertion counter reset */ #define STC3115_GG_VM 0x04 /* STC3115 active mode: cc=0, VM=1 */ #define STC3115_BATFAIL 0x08 /* Battery presence state */ #define STC3115_PORDET 0x10 /* W = soft reset, R = POR detect */ #define STC3115_ALM_SOC 0x20 /* Low SOC alarm event */ #define STC3115_ALM_VOLT 0x40 /* Low voltage alarm event */ /*STC3115 General purpose define ---------------------------------------------------------- */ #define STC3115_ID 0x14 /* STC3115 ID */ #define STC3115_RAM_SIZE 16 /* Total RAM size of STC3115 in bytes */ #define STC3115_OCVTAB_SIZE 16 /* OCVTAB size of STC3115 in bytes */ #define VCOUNT 4 /* counter value for 1st current/temp measurements */ #define VM_MODE 1 // Voltage Mode #define CC_MODE 0 // Coulomb Counter Mode #define MIXED_MODE 0 // Mixed Mode (Voltage + Current) #define MAX_HRSOC 51200 /* 100% in 1/512% units */ #define MAX_SOC 1000 /* 100% in 0.1% units */ #define STC3115_OK 0 #define VoltageFactor 9011 /* LSB=2.20mV ~9011/4096 - convert to mV */ #define CurrentFactor 24084 /* LSB=5.88uV/R= ~24084/R/4096 - convert to mA */ #define VOLTAGE_SECURITY_RANGE 200 #define RAM_TESTWORD 0x53A9 /* STC3115 RAM test word */ #define STC3115_UNINIT 0 /* Gas gauge Not Initialiezd state */ #define STC3115_INIT 'I' /* Gas gauge Init states */ #define STC3115_RUNNING 'R' /* Gas gauge Running states */ #define STC3115_POWERDN 'D' /* Gas gauge Stop states */ /*stc3115 configuration structure --------------------------------------------- */ typedef struct { int Vmode; /* 1=Voltage mode, 0=mixed mode */ int Alm_SOC; /* SOC alarm level in % */ int Alm_Vbat; /* Vbat alarm level in mV */ int CC_cnf; /* nominal battery CC_cnf */ int VM_cnf; /* nominal battery VM cnf */ int Cnom; /* nominal battery capacity in mAh */ int Rsense; /* sense resistor in mOhms */ int RelaxCurrent; /* relaxation current(< C/20) in mA */ unsigned char OCVOffset[16]; /* OCV curve adjustment in 0.55mV */ } STC3115_ConfigData_TypeDef; /*battery output structure ---------------------------------------------------- */ typedef struct { int StatusWord; /* STC3115 status registers */ int HRSOC; /* battery relative SOC (%) in 1/512% */ int SOC; /* battery relative SOC (%) in 0.1% */ int Voltage; /* battery voltage in mV */ int Current; /* battery current in mA */ int Temperature; /* battery temperature in 0.1°C */ int ConvCounter; /* STC3115 convertion counter in 0.5s */ int OCV; /* battery relax voltage in mV */ int Presence; /* battery presence */ int ChargeValue; /* battery remaining capacity in mAh */ int RemTime; /* battery remaining operating time during discharge */ } STC3115_BatteryData_TypeDef; /* stc3115 RAM registers structure -------------------------------------------- */ static union InternalRAM { unsigned char db[STC3115_RAM_SIZE]; /* last byte holds the CRC */ struct { short TestWord; /* 0-1 RAM test word */ short HRSOC; /* 2-3 SOC backup in (1/512%) */ short CC_cnf; /* 4-5 current CC_cnf */ short VM_cnf; /* 6-7 current VM_cnf */ char SOC; /* 8 SOC (in %) */ char STC3115_State; /* 9 STC3115 working state */ char unused1; /* 10 -Bytes upto ..STC3115_RAM_SIZE-2 are free */ char unused2; /* 11 -Bytes upto ..STC3115_RAM_SIZE-2 are free */ char unused3; /* 12 -Bytes upto ..STC3115_RAM_SIZE-2 are free */ char unused4; /* 13 -Bytes upto ..STC3115_RAM_SIZE-2 are free */ char unused5; /* 14 -Bytes upto ..STC3115_RAM_SIZE-2 are free */ char CRC; /* 15 last byte STC3115_RAM_SIZE-1 is the CRC */ } reg; } RAMData; /* Exported functions prototypes----------------------------------------------- */ #ifdef __cplusplus //c++ extern "C" //c++ { //c++ #endif //c++ int GasGauge_Initialization(STC3115_ConfigData_TypeDef*, STC3115_BatteryData_TypeDef*); int GasGauge_Reset(void); int GasGauge_Stop(void); int GasGauge_Task(STC3115_ConfigData_TypeDef*, STC3115_BatteryData_TypeDef*); int STC3115_SetPowerSavingMode(void); int STC3115_StopPowerSavingMode(void); int STC3115_AlarmSet(void); int STC3115_AlarmStop(void); int STC3115_AlarmGet(void); int STC3115_AlarmClear(void); int STC3115_AlarmSetVoltageThreshold(STC3115_ConfigData_TypeDef*, int); int STC3115_AlarmSetSOCThreshold(STC3115_ConfigData_TypeDef*, int); int STC3115_CheckI2cDeviceId(void); int STC3115_GetRunningCounter(void); #ifdef __cplusplus //c++ } //c++ #endif //c++ #endif /* __Gasgauge_H */ /**** END OF FILE ****/

Related Resources