foxBMS  1.2.0
The foxBMS Battery Management System API Documentation
sof.c File Reference

SOX module responsible for current derating calculation. More...

#include "sof.h"
#include "battery_cell_cfg.h"
#include "battery_system_cfg.h"
#include "bms.h"
#include "database.h"
#include "foxmath.h"
#include <float.h>
Include dependency graph for sof.c:

Go to the source code of this file.

Functions

static void SOF_CalculateCurves (const SOF_CONFIG_s *pConfigurationValues, SOF_CURVE_s *pCalculatedSofCurveValues)
 calculate SOF curve depending on configured configuration values More...
 
static void SOF_CalculateVoltageBasedCurrentLimit (int16_t minimumCellVoltage_mV, int16_t maximumCellVoltage_mV, SOF_CURRENT_LIMITS_s *pAllowedVoltageBasedCurrent, const SOF_CONFIG_s *pConfigLimitValues, SOF_CURVE_s *pCalculatedSofCurves)
 calculates the SoF from voltage data (i.e., minimum and maximum voltage) More...
 
static void SOF_CalculateTemperatureBasedCurrentLimit (int16_t minimumCellTemperature_ddegC, int16_t maximumCellTemperature_ddegC, SOF_CURRENT_LIMITS_s *pAllowedTemperatureBasedCurrent, const SOF_CONFIG_s *pConfigLimitValues, SOF_CURVE_s *pCalculatedSofCurves)
 calculates the SoF from temperature data (i.e., minimum and maximum temperature of cells) More...
 
static SOF_CURRENT_LIMITS_s SOF_MinimumOfTwoSofValues (SOF_CURRENT_LIMITS_s voltageBasedLimits, SOF_CURRENT_LIMITS_s temperatureBasedLimits)
 get the minimum current values of all variants of SoF calculation More...
 
void SOF_Init (void)
 initializes the area for SOF (where derating starts and is fully active). More...
 
void SOF_Calculation (void)
 triggers SOF calculation More...
 

Variables

static SOF_CURVE_s sof_curveRecommendedOperatingCurrent
 
static SOF_CURVE_s sof_curveMol
 
static SOF_CURVE_s sof_curveRsl
 
static SOF_CURVE_s sof_curveMsl
 
static DATA_BLOCK_MIN_MAX_s sof_tableMinimumMaximumValues = {.header.uniqueId = DATA_BLOCK_ID_MIN_MAX}
 
static DATA_BLOCK_SOF_s sof_tableSofValues = {.header.uniqueId = DATA_BLOCK_ID_SOF}
 

Detailed Description

SOX module responsible for current derating calculation.

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-07 (date of creation)
Updated
2021-03-24 (date of last update)
Prefix
SOX

Definition in file sof.c.

Function Documentation

◆ SOF_CalculateCurves()

static void SOF_CalculateCurves ( const SOF_CONFIG_s pConfigurationValues,
SOF_CURVE_s pCalculatedSofCurveValues 
)
static

calculate SOF curve depending on configured configuration values

Parameters
[in]pConfigurationValuesSOF curve configuration values
[out]pCalculatedSofCurveValuescalculate SOF curve

Definition at line 141 of file sof.c.

◆ SOF_CalculateTemperatureBasedCurrentLimit()

static void SOF_CalculateTemperatureBasedCurrentLimit ( int16_t  minimumCellTemperature_ddegC,
int16_t  maximumCellTemperature_ddegC,
SOF_CURRENT_LIMITS_s pAllowedTemperatureBasedCurrent,
const SOF_CONFIG_s pConfigLimitValues,
SOF_CURVE_s pCalculatedSofCurves 
)
static

calculates the SoF from temperature data (i.e., minimum and maximum temperature of cells)

Parameters
[in]minimumCellTemperature_ddegCminimum temperature of cells
[in]maximumCellTemperature_ddegCmaximum temperature of cells
[out]pAllowedTemperatureBasedCurrentpointer where to store the results
[in]pConfigLimitValuespointer to the structure used for SOF calculation
[in]pCalculatedSofCurvespointer to the structure containing limit values

Definition at line 232 of file sof.c.

Here is the call graph for this function:

◆ SOF_CalculateVoltageBasedCurrentLimit()

static void SOF_CalculateVoltageBasedCurrentLimit ( int16_t  minimumCellVoltage_mV,
int16_t  maximumCellVoltage_mV,
SOF_CURRENT_LIMITS_s pAllowedVoltageBasedCurrent,
const SOF_CONFIG_s pConfigLimitValues,
SOF_CURVE_s pCalculatedSofCurves 
)
static

calculates the SoF from voltage data (i.e., minimum and maximum voltage)

Parameters
[in]minimumCellVoltage_mVminimum cell voltage
[in]maximumCellVoltage_mVmaximum cell voltage
[out]pAllowedVoltageBasedCurrentVoltage-based SOF
[in]pConfigLimitValuespointer to the SOF configuration structure
[in]pCalculatedSofCurvespointer to the SOF curve structure

Definition at line 189 of file sof.c.

◆ SOF_Calculation()

void SOF_Calculation ( void  )

triggers SOF calculation

TODO

Definition at line 358 of file sof.c.

Here is the call graph for this function:

◆ SOF_Init()

void SOF_Init ( void  )

initializes the area for SOF (where derating starts and is fully active).

Pseudocode for linear function parameter extraction with 2 points:

  • slope = (y2 - y1) / (x2-x1)
  • offset = y1 - (slope) * x1
  • function y= slope * x + offset

Definition at line 342 of file sof.c.

Here is the call graph for this function:

◆ SOF_MinimumOfTwoSofValues()

static SOF_CURRENT_LIMITS_s SOF_MinimumOfTwoSofValues ( SOF_CURRENT_LIMITS_s  voltageBasedLimits,
SOF_CURRENT_LIMITS_s  temperatureBasedLimits 
)
static

get the minimum current values of all variants of SoF calculation

Parameters
[in]voltageBasedLimitsvoltage constrained current derating values
[in]temperatureBasedLimitstemperature constrained current derating values
Returns
minimum SoF current values

Definition at line 326 of file sof.c.

Here is the call graph for this function:

Variable Documentation

◆ sof_curveMol

SOF_CURVE_s sof_curveMol
static

module-local static Variables that are calculated at startup and used later to avoid divisions at runtime

Definition at line 73 of file sof.c.

◆ sof_curveMsl

SOF_CURVE_s sof_curveMsl
static

module-local static Variables that are calculated at startup and used later to avoid divisions at runtime

Definition at line 75 of file sof.c.

◆ sof_curveRecommendedOperatingCurrent

SOF_CURVE_s sof_curveRecommendedOperatingCurrent
static

module-local static Variables that are calculated at startup and used later to avoid divisions at runtime

Definition at line 72 of file sof.c.

◆ sof_curveRsl

SOF_CURVE_s sof_curveRsl
static

module-local static Variables that are calculated at startup and used later to avoid divisions at runtime

Definition at line 74 of file sof.c.

◆ sof_tableMinimumMaximumValues

DATA_BLOCK_MIN_MAX_s sof_tableMinimumMaximumValues = {.header.uniqueId = DATA_BLOCK_ID_MIN_MAX}
static

local copies of database tables

Definition at line 80 of file sof.c.

◆ sof_tableSofValues

DATA_BLOCK_SOF_s sof_tableSofValues = {.header.uniqueId = DATA_BLOCK_ID_SOF}
static

local copies of database tables

Definition at line 81 of file sof.c.