SensorTile_gg.h File Reference

This file contains definitions for SensorTile_gg.c firmware driver. More...

#include "SensorTile.h" #include "../Components/stc3115/STC3115_Driver.h"

Go to the source code of this file.

Macros
#define	GG_MAX_NUM   1
#define	GG1   0

Enumerations
enum	GG_StatusTypeDef { GG_OK = 0, GG_ERROR = 1, GG_TIMEOUT = 2 }
enum	GG_ID_t { GG_AUTO = -1, STC3115_0 }

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_GetTemperature (void *handle, int32_t *temp)
	Get the temperature. More...
DrvStatusTypeDef	BSP_GG_GetVoltage (void *handle, uint32_t *voltage)
	Get the voltage. More...
DrvStatusTypeDef	BSP_GG_GetRemTime (void *handle, int32_t *remTime)
	Get the estimated remaining time. More...

Detailed Description

This file contains definitions for SensorTile_gg.c firmware driver.

Author

Central Labs

Version

V1.3.1

Date

27-Apr-2017

Attention

© COPYRIGHT(c) 2014 STMicroelectronics

Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met:

1. Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer.
2. Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following disclaimer in the documentation and/or other materials provided with the distribution.
3. Neither the name of STMicroelectronics nor the names of its contributors may be used to endorse or promote products derived from this software without specific prior written permission.

THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

Definition in file SensorTile_gg.h.