foxBMS - Unit Tests  1.4.0
The foxBMS Unit Tests 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 SE_InitializeSoc (bool ccPresent, uint8_t stringNumber)
 Wrapper for algorithm specific SOC initialization. More...
 
void SE_InitializeSoe (bool ec_present, uint8_t stringNumber)
 Wrapper for algorithm specific SOE initialization. More...
 
void SE_InitializeSoh (uint8_t stringNumber)
 Wrapper for algorithm specific SOH initialization. More...
 
void SE_RunStateEstimations (void)
 Main function to perform state estimations. More...
 
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

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
2022-07-28 (date of last update)
Version
v1.4.0
Prefix
SE

Definition in file state_estimation.h.

Function Documentation

◆ SE_InitializeSoc()

void SE_InitializeSoc ( bool  ccPresent,
uint8_t  stringNumber 
)

Wrapper for algorithm specific SOC initialization.

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

Definition at line 73 of file state_estimation.c.

Here is the call graph for this function:

◆ SE_InitializeSoe()

void SE_InitializeSoe ( 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 79 of file state_estimation.c.

Here is the call graph for this function:

◆ SE_InitializeSoh()

void SE_InitializeSoh ( uint8_t  stringNumber)

Wrapper for algorithm specific SOH initialization.

Parameters
[in]stringNumberstring addressed

Definition at line 85 of file state_estimation.c.

Here is the call graph for this function:

◆ SE_RunStateEstimations()

void SE_RunStateEstimations ( void  )

Main function to perform state estimations.

Definition at line 91 of file state_estimation.c.

Here is the call graph for this function: