foxBMS  1.4.0
The foxBMS Battery Management System API Documentation
State Estimation API

Functions

void SE_InitializeStateOfCharge (DATA_BLOCK_SOX_s *pSocValues, bool ccPresent, uint8_t stringNumber)
 initializes startup SOC-related values like lookup from nonvolatile ram at startup More...
 
void SE_CalculateStateOfCharge (DATA_BLOCK_SOX_s *pSocValues)
 periodically called algorithm to calculate state-of-charge (SOC) More...
 
float SE_GetStateOfChargeFromVoltage (int16_t voltage_mV)
 look-up table for SOC initialization More...
 
void SE_InitializeStateOfEnergy (DATA_BLOCK_SOX_s *pSoeValues, bool ec_present, uint8_t stringNumber)
 initializes startup state-of-energy (SOE) related values More...
 
void SE_CalculateStateOfEnergy (DATA_BLOCK_SOX_s *pSoeValues)
 periodically called algorithm to calculate state-of-energy (SOE) More...
 
void SE_InitializeStateOfHealth (DATA_BLOCK_SOX_s *pSohValues, uint8_t stringNumber)
 initializes startup state-of-health related values More...
 
void SE_CalculateStateOfHealth (DATA_BLOCK_SOX_s *pSohValues)
 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

◆ SE_CalculateStateOfCharge()

void SE_CalculateStateOfCharge ( DATA_BLOCK_SOX_s pSocValues)

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

Parameters
[out]pSocValuespointer to SOC values

Definition at line 280 of file soc_counting.c.

Here is the call graph for this function:

◆ SE_CalculateStateOfEnergy()

void SE_CalculateStateOfEnergy ( DATA_BLOCK_SOX_s pSoeValues)

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

Parameters
[out]pSoeValuespointer to SOE database entry

Definition at line 356 of file soe_counting.c.

Here is the call graph for this function:

◆ SE_CalculateStateOfHealth()

void SE_CalculateStateOfHealth ( DATA_BLOCK_SOX_s pSohValues)

calculates state-of-health (SOH)

Parameters
[out]pSohValuespointer to SOH database entry

Definition at line 79 of file soh_debug.c.

◆ SE_GetStateOfChargeFromVoltage()

float SE_GetStateOfChargeFromVoltage ( int16_t  voltage_mV)

look-up table for SOC initialization

Parameters
[in]voltage_mVvoltage in mV of battery cell
Returns
returns SOC value in percentage from 0.0% to 100.0%

Definition at line 359 of file soc_counting.c.

Here is the call graph for this function:

◆ SE_InitializeStateOfCharge()

void SE_InitializeStateOfCharge ( DATA_BLOCK_SOX_s pSocValues,
bool  ccPresent,
uint8_t  stringNumber 
)

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

Parameters
[out]pSocValuespointer to SOC database entry
[in]ccPresenttrue if current sensor present, false otherwise
[in]stringNumberstring addressed

Definition at line 238 of file soc_counting.c.

Here is the call graph for this function:

◆ SE_InitializeStateOfEnergy()

void SE_InitializeStateOfEnergy ( DATA_BLOCK_SOX_s pSoeValues,
bool  ec_present,
uint8_t  stringNumber 
)

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

Parameters
[out]pSoeValuespointer to SOE database entry
[in]ec_presenttrue if current sensor EC message received, false otherwise
[in]stringNumberstring addressed

Definition at line 312 of file soe_counting.c.

Here is the call graph for this function:

◆ SE_InitializeStateOfHealth()

void SE_InitializeStateOfHealth ( DATA_BLOCK_SOX_s pSohValues,
uint8_t  stringNumber 
)

initializes startup state-of-health related values

Parameters
[out]pSohValuespointer to SOH database entry
[in]stringNumberstring addressed

Definition at line 69 of file soh_debug.c.