State Estimation API

Functions
void	SOC_Init (DATA_BLOCK_SOX_s *pSocValues, bool cc_present, uint8_t stringNumber)
	initializes startup SOC-related values like lookup from nonvolatile ram at startup More...
void	SOC_Calculation (DATA_BLOCK_SOX_s *pSocValues)
	periodically called algorithm to calculate state-of-charge (SOC) More...
float	SOC_GetFromVoltage (int16_t voltage_mV)
	look-up table for SOC initialization More...
void	SOE_Init (DATA_BLOCK_SOX_s *pSoeValues, bool ec_present, uint8_t stringNumber)
	initializes startup state-of-energy (SOE) related values More...
void	SOE_Calculation (DATA_BLOCK_SOX_s *pSoeValues)
	periodically called algorithm to calculate state-of-energy (SOE) More...
void	SOH_Init (void)
	initializes startup state-of-health related values More...
void	SOH_Calculation (void)
	calculates state-of-health (SOH) More...

Detailed Description

This API is implemented by the state estimation functions and called by the state estimation module.

INCLUDE MARKER FOR THE DOCUMENTATION; DO NOT MOVE se-state-estimation-api-start-include

Function Documentation

SOC_Calculation()

void SOC_Calculation

(

DATA_BLOCK_SOX_s *

pSocValues

)

periodically called algorithm to calculate state-of-charge (SOC)

Parameters

[out]

pSocValues

pointer to SOC values

Definition at line 279 of file soc_counting.c.

Here is the call graph for this function:

SOC_GetFromVoltage()

float SOC_GetFromVoltage

(

int16_t

voltage_mV

)

look-up table for SOC initialization

Parameters

[in]

voltage_mV

voltage in mV of battery cell

Returns

returns SOC value in percentage from 0.0% to 100.0%

Definition at line 370 of file soc_counting.c.

Here is the call graph for this function:

SOC_Init()

void SOC_Init	(	DATA_BLOCK_SOX_s *	pSocValues,
		bool	cc_present,
		uint8_t	stringNumber
	)

initializes startup SOC-related values like lookup from nonvolatile ram at startup

Parameters

[out]	pSocValues	pointer to SOC database entry
[in]	cc_present	true if current sensor present, false otherwise
[in]	stringNumber	string addressed

Definition at line 236 of file soc_counting.c.

Here is the call graph for this function:

SOE_Calculation()

void SOE_Calculation

(

DATA_BLOCK_SOX_s *

pSoeValues

)

periodically called algorithm to calculate state-of-energy (SOE)

Parameters

[out]

pSoeValues

pointer to SOE database entry

Definition at line 355 of file soe_counting.c.

Here is the call graph for this function:

SOE_Init()

void SOE_Init	(	DATA_BLOCK_SOX_s *	pSoeValues,
		bool	ec_present,
		uint8_t	stringNumber
	)

initializes startup state-of-energy (SOE) related values

Parameters

[out]	pSoeValues	pointer to SOE database entry
[in]	ec_present	true if current sensor EC message received, false otherwise
[in]	stringNumber	string addressed

Definition at line 311 of file soe_counting.c.

Here is the call graph for this function:

SOH_Calculation()

void SOH_Calculation

(

void

)

calculates state-of-health (SOH)

SOH_Init()

void SOH_Init

(

void

)

initializes startup state-of-health related values