state_estimation.h

Go to the documentation of this file.

/**
 *
 * @copyright © 2010 - 2021, Fraunhofer-Gesellschaft zur Foerderung der
 *  angewandten Forschung e.V. All rights reserved.
 *
 * BSD 3-Clause License
 * 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®″
 *
 */
 
/**
 * @file    state_estimation.h
 * @author  foxBMS Team
 * @date    2020-10-14 (date of creation)
 * @updated 2020-10-14 (date of last update)
 * @ingroup APPLICATION
 * @prefix  SE
 *
 * @brief   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.
 *
 */
 
#ifndef FOXBMS__STATE_ESTIMATION_H_
#define FOXBMS__STATE_ESTIMATION_H_
 
/*========== Includes =======================================================*/
#include "general.h"
 
/*========== Macros and Definitions =========================================*/
 
/*========== Extern Constant and Variable Declarations ======================*/
 
/*========== Extern Function Prototypes =====================================*/
/**
 * @brief   initializes startup SOC-related values like lookup from nonvolatile
 *          ram at startup
 * @param[in]    cc_present     true if current sensor present, false otherwise
 * @param[in]   stringNumber    string addressed
 */
extern void SOC_Init(bool cc_present, uint8_t stringNumber);
 
/**
 * @brief   integrates current over time to calculate SOC.
 */
extern void SOC_Calculation(void);
 
/**
 * @brief   look-up table for SOC initialization (average, min and max).
 *
 * @param[in]   voltage_mV    voltage of battery cell
 *
 * @return  SOC value
 */
extern float SOC_GetFromVoltage(int16_t voltage_mV);
 
/**
 * @brief   initializes startup state-of-energy (SOE) related values
 *
 * @param[in]   ec_present     true if current sensor EC message received, false otherwise
 * @param[in]   stringNumber   string addressed
 */
extern void SOE_Init(bool ec_present, uint8_t stringNumber);
 
/**
 * @brief   calculates state-of-energy (SOE)
 */
extern void SOE_Calculation(void);
 
/**
 * @brief   initializes startup state-of-health related values
 */
extern void SOH_Init(void);
 
/**
 * @brief   calculates state-of-health (SOH)
 */
extern void SOH_Calculation(void);
 
/*========== Externalized Static Functions Prototypes (Unit Test) ===========*/
 
#endif /* FOXBMS__STATE_ESTIMATION_H_ */