December 2014

DocID027146 Rev 1

1/16

www.st.com

UM1836

User manual

STSW-BAT001 open source driver for the STC3115

Aurelien Mazard

Introduction

The STC3115 open source driver is a ready-to-use, configurable software (STSW-BAT001) which

allows the STC3115 gas gauge IC to be rapidly integrated to the final system software. The driver is

split into five C language files and can be compiled with any operating system for any processor.

The STC3115 open source driver comes with a full API which uses simple input information to initialize

and control the STC3115 registers and RAM and return battery status information in a simple structure

to the system.

The open source driver is available for free to manage system requirements and to handle the

complexity of STC3115 initialization. It is intended only for example purposes.

This user manual describes the STC3115 open source driver (STSW-BAT001) package content,

capabilities, and correct usage. It also explains the step-by-step procedure to configure and integrate

the open source driver in a complete software architecture.

The figure below shows an overview of the STC3115 software driver architecture. No additional

software is needed to manage the STC3115.

Figure 1: STC3115 software driver architecture

STC3115 driver layer

STC3115 intermediate

I2C layer

STC3115 Driver.h

STC3115 Battery.h

STC3115

I2C.C

Application layer

Application

Main

STC3115

Driver.C

Hardware driver layer

I2C dri ver

STC3115 I2C.h