UM1836

How to use the driver

DocID027146 Rev 1

11/16

4

How to use the driver

There are three basic steps to using the driver. They are

•

Hardware initialization

•

Software initialization

•

Periodic update of the battery state

These steps are described in more detail in the three sections below.

4.1

Hardware initialization

1.

Update the I2C_Write and I2C_Read functions in the stc3115_I2C.c file with the I

driver functions of the application.

2.

Initialize the STC3115 dedicated hardware externally from the driver (e.g. the I

interface, GPIOs, etc).

4.2

Software initialization

1.

Fill the STC3115_Battery.h file with the battery and application parameters

2.

Declare one STC3115_ConfigData_TypeDef structure and one

STC3115_BatteryData_TypeDef parameter structure.

3.

At application start-up, call once only the GasGauge_Initialization function with un-

initialized structures as parameters. This:

−

Fills the STC3115_ConfigData_TypeDef structure with STC3115_Battery.h data.

−

Fills the STC3115_BatteryData_TypeDef structure with the STC3115 algorithm

results which returns the battery state to the application.

GasGauge_initialization function

•

Initialize the software structures

•

Check the battery history, for example, is it a new battery, a swapped battery, or is the

battery already connected?

•

Initialize the STC3115 registers according to the battery history

•

Initialize the RAM memory of the STC3115 according to the battery history

GasGauge_initialization returns

•

(-1) indicates that the STC3115 cannot be accessed. Either the I

configured or the STC3115 is not power supplied.

•

(0) indicates that initialization has been successful