foxBMS
1.1.0
The foxBMS Battery Management System API Documentation
|
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...
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... | |
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:
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:
Definition in file state_estimation.h.
void SE_SocInit | ( | bool | cc_present, |
uint8_t | stringNumber | ||
) |
Wrapper for algorithm specific SOC initialization.
[in] | cc_present | true if current sensor present, false otherwise |
[in] | stringNumber | string addressed |
Definition at line 72 of file state_estimation.c.
void SE_SoeInit | ( | bool | ec_present, |
uint8_t | stringNumber | ||
) |
Wrapper for algorithm specific SOE initialization.
[in] | ec_present | true if current sensor present, false otherwise |
[in] | stringNumber | string addressed |
Definition at line 78 of file state_estimation.c.
void SE_StateEstimations | ( | void | ) |
Main function to perform state estimations.
Definition at line 84 of file state_estimation.c.
void SOC_Calculation | ( | DATA_BLOCK_SOX_s * | pSocValues | ) |
periodically called algorithm to calculate state-of-charge (SOC)
[out] | pSocValues | pointer to SOC values |
Definition at line 278 of file soc_counting.c.
float SOC_GetFromVoltage | ( | int16_t | voltage_mV | ) |
look-up table for SOC initialization
[in] | voltage_mV | voltage in mV of battery cell |
Definition at line 368 of file soc_counting.c.
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
[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.
void SOE_Calculation | ( | DATA_BLOCK_SOX_s * | pSoeValues | ) |
periodically called algorithm to calculate state-of-energy (SOE)
[out] | pSoeValues | pointer to SOE database entry |
Definition at line 355 of file soe_counting.c.
void SOE_Init | ( | DATA_BLOCK_SOX_s * | pSoeValues, |
bool | ec_present, | ||
uint8_t | stringNumber | ||
) |
initializes startup state-of-energy (SOE) related values
[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.
void SOH_Calculation | ( | void | ) |
calculates state-of-health (SOH)
void SOH_Init | ( | void | ) |
initializes startup state-of-health related values