Functions
DrvStatusTypeDef	BSP_GG_Init (void **handle)
	Set GG Initialization. More...

DrvStatusTypeDef	BSP_GG_DeInit (void **handle)
	Deinitialize a gas gauge sensor. More...

DrvStatusTypeDef	BSP_GG_IsInitialized (void handle, uint8_t status)
	Check if the gas gauge sensor is initialized. More...

DrvStatusTypeDef	BSP_GG_IsCombo (void handle, uint8_t status)
	Check if the gas gauge sensor is combo. More...

DrvStatusTypeDef	BSP_GG_Get_WhoAmI (void handle, uint8_t who_am_i)
	Get the WHO_AM_I ID of the gas gauge sensor. More...

DrvStatusTypeDef	BSP_GG_Task (void handle, uint8_t vm_mode)
	Task to read periodically data of STC3115. More...

DrvStatusTypeDef	BSP_GG_Reset (void *handle)
	Reboot memory content of GG. More...

DrvStatusTypeDef	BSP_GG_Stop (void *handle)
	Stop the gas gauge system. More...

DrvStatusTypeDef	BSP_GG_GetOCV (void handle, uint32_t ocv)
	Get the OCV. More...

DrvStatusTypeDef	BSP_GG_GetSOC (void handle, uint32_t soc)
	Get the SOC. More...

DrvStatusTypeDef	BSP_GG_GetChargeValue (void handle, uint32_t chrgValue)
	Get the charge value. More...

DrvStatusTypeDef	BSP_GG_GetPresence (void handle, uint32_t presence)
	Get the presence. More...

DrvStatusTypeDef	BSP_GG_GetCurrent (void handle, int32_t current)
	Get the current. More...

DrvStatusTypeDef	BSP_GG_GetVoltage (void handle, uint32_t voltage)
	Get the voltage. More...

DrvStatusTypeDef	BSP_GG_GetTemperature (void handle, int32_t temp)
	Get the temperature. More...

DrvStatusTypeDef	BSP_GG_GetRemTime (void handle, int32_t remTime)
	Get the estimated remaining time. More...

Detailed Description

Function Documentation

◆ BSP_GG_DeInit()

DrvStatusTypeDef BSP_GG_DeInit ( void ** handle )

Deinitialize a gas gauge sensor.

Parameters

handle pointer to the device handle

Return values

COMPONENT_OK	in case of success
COMPONENT_ERROR	in case of failure

Definition at line 162 of file SensorTile_gg.c.

◆ BSP_GG_Get_WhoAmI()

DrvStatusTypeDef BSP_GG_Get_WhoAmI	(	void *	handle,
		uint8_t *	who_am_i
	)

Get the WHO_AM_I ID of the gas gauge sensor.

Parameters

handle	the device handle
who_am_i	pointer to the value of WHO_AM_I register

Return values

COMPONENT_OK	in case of success
COMPONENT_ERROR	in case of failure

Definition at line 258 of file SensorTile_gg.c.

◆ BSP_GG_GetChargeValue()

DrvStatusTypeDef BSP_GG_GetChargeValue	(	void *	handle,
		uint32_t *	chrgValue
	)

Get the charge value.

Parameters

handle	the device handle
chrgValue	the pointer to the remaining battery charge value

Return values

COMPONENT_OK	in case of success
COMPONENT_ERROR	in case of failure

Definition at line 434 of file SensorTile_gg.c.

◆ BSP_GG_GetCurrent()

DrvStatusTypeDef BSP_GG_GetCurrent	(	void *	handle,
		int32_t *	current
	)

Get the current.

Parameters

handle	the device handle
current	the pointer to the absorbed current value

Return values

COMPONENT_OK	in case of success
COMPONENT_ERROR	in case of failure

Definition at line 490 of file SensorTile_gg.c.

◆ BSP_GG_GetOCV()

DrvStatusTypeDef BSP_GG_GetOCV	(	void *	handle,
		uint32_t *	ocv
	)

Get the OCV.

Parameters

handle	the device handle
ocv	the pointer to the open circuit voltage value

Return values

COMPONENT_OK	in case of success
COMPONENT_ERROR	in case of failure

Definition at line 378 of file SensorTile_gg.c.

◆ BSP_GG_GetPresence()

DrvStatusTypeDef BSP_GG_GetPresence	(	void *	handle,
		uint32_t *	presence
	)

Get the presence.

Parameters

handle	the device handle
presence	the pointer to the value refers to battery presence

Return values

COMPONENT_OK	in case of success
COMPONENT_ERROR	in case of failure

Definition at line 462 of file SensorTile_gg.c.

◆ BSP_GG_GetRemTime()

DrvStatusTypeDef BSP_GG_GetRemTime	(	void *	handle,
		int32_t *	remTime
	)

Get the estimated remaining time.

Parameters

handle	the device handle
remTime	the pointer to the remaining time value

Return values

COMPONENT_OK	in case of success
COMPONENT_ERROR	in case of failure

Definition at line 573 of file SensorTile_gg.c.

◆ BSP_GG_GetSOC()

DrvStatusTypeDef BSP_GG_GetSOC	(	void *	handle,
		uint32_t *	soc
	)

Get the SOC.

Parameters

handle	the device handle
soc	the pointer to the state of charge value

Return values

COMPONENT_OK	in case of success
COMPONENT_ERROR	in case of failure

Definition at line 406 of file SensorTile_gg.c.

◆ BSP_GG_GetTemperature()

DrvStatusTypeDef BSP_GG_GetTemperature	(	void *	handle,
		int32_t *	temp
	)

Get the temperature.

Parameters

handle	the device handle
temp	the pointer to the battery temperature value

Return values

COMPONENT_OK	in case of success
COMPONENT_ERROR	in case of failure

Definition at line 546 of file SensorTile_gg.c.

◆ BSP_GG_GetVoltage()

DrvStatusTypeDef BSP_GG_GetVoltage	(	void *	handle,
		uint32_t *	voltage
	)

Get the voltage.

Parameters

handle	the device handle
voltage	the pointer to the battery voltage value

Return values

COMPONENT_OK	in case of success
COMPONENT_ERROR	in case of failure

Definition at line 518 of file SensorTile_gg.c.

◆ BSP_GG_Init()

DrvStatusTypeDef BSP_GG_Init ( void ** handle )

Set GG Initialization.

Parameters

handle pointer to the device handle

Return values

COMPONENT_OK	in case of success
COMPONENT_ERROR	in case of failure

Definition at line 102 of file SensorTile_gg.c.

◆ BSP_GG_IsCombo()

DrvStatusTypeDef BSP_GG_IsCombo	(	void *	handle,
		uint8_t *	status
	)

Check if the gas gauge sensor is combo.

Parameters

handle	the device handle
status	the pointer to the combo status

Return values

COMPONENT_OK	in case of success
COMPONENT_ERROR	in case of failure

Definition at line 231 of file SensorTile_gg.c.

◆ BSP_GG_IsInitialized()

DrvStatusTypeDef BSP_GG_IsInitialized	(	void *	handle,
		uint8_t *	status
	)

Check if the gas gauge sensor is initialized.

Parameters

handle	the device handle
status	the pointer to the initialization status

Return values

COMPONENT_OK	in case of success
COMPONENT_ERROR	in case of failure

Definition at line 203 of file SensorTile_gg.c.

◆ BSP_GG_Reset()

DrvStatusTypeDef BSP_GG_Reset ( void * handle )

Reboot memory content of GG.

Parameters

handle the device handle

Return values

COMPONENT_OK	in case of success
COMPONENT_ERROR	in case of failure

Definition at line 323 of file SensorTile_gg.c.

◆ BSP_GG_Stop()

DrvStatusTypeDef BSP_GG_Stop ( void * handle )

Stop the gas gauge system.

Parameters

handle the device handle

Return values

COMPONENT_OK	in case of success
COMPONENT_ERROR	in case of failure

Definition at line 350 of file SensorTile_gg.c.

◆ BSP_GG_Task()

DrvStatusTypeDef BSP_GG_Task	(	void *	handle,
		uint8_t *	vm_mode
	)

Task to read periodically data of STC3115.

Parameters

handle	the device handle
vm_mode	the pointer to the operating mode

Return values

COMPONENT_OK	in case of success
COMPONENT_ERROR	in case of failure

Definition at line 295 of file SensorTile_gg.c.

STSW-STLKT01: SENSORTILE_GG_Exported_Functions

STSW-STLKT01

Functions

Detailed Description

Function Documentation

◆ BSP_GG_DeInit()

◆ BSP_GG_Get_WhoAmI()

◆ BSP_GG_GetChargeValue()

◆ BSP_GG_GetCurrent()

◆ BSP_GG_GetOCV()

◆ BSP_GG_GetPresence()

◆ BSP_GG_GetRemTime()

◆ BSP_GG_GetSOC()

◆ BSP_GG_GetTemperature()

◆ BSP_GG_GetVoltage()

◆ BSP_GG_Init()

◆ BSP_GG_IsCombo()

◆ BSP_GG_IsInitialized()

◆ BSP_GG_Reset()

◆ BSP_GG_Stop()

◆ BSP_GG_Task()

Get in touch