foxBMS  1.2.0
The foxBMS Battery Management System API Documentation
state_estimation.h File Reference

Header for state-estimation module responsible for the estimation of state-of-charge (SOC), state-of-energy (SOE) and state-of-health (SOH). Functions as a wrapper for the individual state-estimation algorithms. More...

#include "general.h"
#include "database.h"
Include dependency graph for state_estimation.h:
This graph shows which files directly or indirectly include this file:

Go to the source code of this file.

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 SE_SocInit (bool cc_present, uint8_t stringNumber)
 Wrapper for algorithm specific SOC initialization. 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 SE_SoeInit (bool ec_present, uint8_t stringNumber)
 Wrapper for algorithm specific SOE initialization. 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...
 
void SE_StateEstimations (void)
 Main function to perform state estimations. More...
 

Detailed Description

Header for state-estimation module responsible for the estimation of state-of-charge (SOC), state-of-energy (SOE) and state-of-health (SOH). Functions as a wrapper for the individual state-estimation algorithms.

SPDX-License-Identifier: BSD-3-Clause

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 the copyright holder 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.

We kindly request you to use one or more of the following phrases to refer to foxBMS in your hardware, software, documentation or advertising materials:

  • ″This product uses parts of foxBMS®″
  • ″This product includes parts of foxBMS®″
  • ″This product is derived from foxBMS®″
Author
foxBMS Team
Date
2020-10-14 (date of creation)
Updated
2021-05-21 (date of last update)
Prefix
SE

Definition in file state_estimation.h.

Function Documentation

◆ SE_SocInit()

void SE_SocInit ( bool  cc_present,
uint8_t  stringNumber 
)

Wrapper for algorithm specific SOC initialization.

Parameters
[in]cc_presenttrue if current sensor present, false otherwise
[in]stringNumberstring addressed

Definition at line 72 of file state_estimation.c.

Here is the call graph for this function:

◆ SE_SoeInit()

void SE_SoeInit ( bool  ec_present,
uint8_t  stringNumber 
)

Wrapper for algorithm specific SOE initialization.

Parameters
[in]ec_presenttrue if current sensor present, false otherwise
[in]stringNumberstring addressed

Definition at line 78 of file state_estimation.c.

Here is the call graph for this function:

◆ SE_StateEstimations()

void SE_StateEstimations ( void  )

Main function to perform state estimations.

Definition at line 84 of file state_estimation.c.

Here is the call graph for this function:

◆ SOC_Calculation()

void SOC_Calculation ( DATA_BLOCK_SOX_s pSocValues)

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

Parameters
[out]pSocValuespointer to SOC values

Definition at line 278 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_mVvoltage in mV of battery cell
Returns
returns SOC value in percentage from 0.0% to 100.0%

Definition at line 368 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]pSocValuespointer to SOC database entry
[in]cc_presenttrue if current sensor present, false otherwise
[in]stringNumberstring 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]pSoeValuespointer 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]pSoeValuespointer to SOE database entry
[in]ec_presenttrue if current sensor EC message received, false otherwise
[in]stringNumberstring 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