foxBMS - Unit Tests  1.2.0
The foxBMS Unit Tests API Documentation
sof.h File Reference

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

#include "sof_cfg.h"
Include dependency graph for sof.h:
This graph shows which files directly or indirectly include this file:

Go to the source code of this file.

Data Structures

struct  SOF_CURRENT_LIMITS
 
struct  SOF_CURVE
 

Typedefs

typedef struct SOF_CURRENT_LIMITS SOF_CURRENT_LIMITS_s
 
typedef struct SOF_CURVE SOF_CURVE_s
 

Functions

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...
 
void TEST_SOF_CalculateVoltageBasedCurrentLimit (int16_t minimumCellVoltage_mV, int16_t maximumCellVoltage_mV, SOF_CURRENT_LIMITS_s *pAllowedVoltageBasedCurrent, const SOF_CONFIG_s *pConfigLimitValues, SOF_CURVE_s *pCalculatedSofCurves)
 
void TEST_SOF_CalculateTemperatureBasedCurrentLimit (int16_t minimumCellTemperature_ddegC, int16_t maximumCellTemperature_ddegC, SOF_CURRENT_LIMITS_s *pAllowedTemperatureBasedCurrent, const SOF_CONFIG_s *pConfigLimitValues, SOF_CURVE_s *pCalculatedSofCurves)
 
SOF_CURRENT_LIMITS_s TEST_SOF_MinimumOfTwoSofValues (SOF_CURRENT_LIMITS_s voltageBasedLimits, SOF_CURRENT_LIMITS_s temperatureBasedLimits)
 

Detailed Description

Header for 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
2020-10-07 (date of last update)
Prefix
SOX

Definition in file sof.h.

Typedef Documentation

◆ SOF_CURRENT_LIMITS_s

struct definition for 4 different values: in two current directions (charge, discharge) for two use cases (peak and continuous)

◆ SOF_CURVE_s

typedef struct SOF_CURVE SOF_CURVE_s

struct definition for calculating the linear SOF curve. The SOF curve is voltage, temperature and charge/discharge dependent.

Function Documentation

◆ 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:

◆ TEST_SOF_CalculateTemperatureBasedCurrentLimit()

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

Definition at line 526 of file sof.c.

Here is the call graph for this function:

◆ TEST_SOF_CalculateVoltageBasedCurrentLimit()

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

Definition at line 513 of file sof.c.

Here is the call graph for this function:

◆ TEST_SOF_MinimumOfTwoSofValues()

SOF_CURRENT_LIMITS_s TEST_SOF_MinimumOfTwoSofValues ( SOF_CURRENT_LIMITS_s  voltageBasedLimits,
SOF_CURRENT_LIMITS_s  temperatureBasedLimits 
)

Definition at line 539 of file sof.c.

Here is the call graph for this function:
{"cc_re__cc_re__cc_by_4_0": ["ass=\"el\" href=\"dir_0bc466e2b67e0b5ff82f55a5b52d88e9.html\">state_estimation</a></li><li class=\"navelem\"><a class=\"el\" href=\"dir_c606fb306c1262ad78077f952891b080.html\">sof</a></li><li class=\"navelem\"><a class=\"el\" href=\"dir_e5d2c30d0fbef0f95250c96475b64067.html\">trapezoid</a></li><li class=\"navelem\"><a class=\"el\" href=\"sof_8h.html\">sof.h</a></li>\n    <li class=\"footer\">Generated by\n    <a href=\"http://www.doxygen.org/index.html\">\n    <img class=\"footer\" src=\"doxygen.png\" alt=\"doxygen\"/></a> 1.9.1 <a rel=\"license\" href=\"http://creativecommons.org/licenses/by/4.0/\"><img alt=\"Creative Commons license\" style=\"border-width:0;height:24px\" src=\"https://i.creativecommons.org/l/by/4.0/88x31.png\" /></a> </li>\n  </ul>\n</div>\n</body>\n</html>\n"], "copyright__copyright__copyright": ["nt16_t\u00a0 maximumCellVoltage_mV,\nSOF_CURRENT_LIMITS_s pAllowedVoltageBasedCurrent,\nconst SOF_CONFIG_s pConfigLimitValues,\nSOF_CURVE_s pCalculatedSofCurves\u00a0\n)\n\nDefinition at line 513 of file sof.c.\n\nHere is the call graph for this function:\n\n\u25c6\u00a0TEST_SOF_MinimumOfTwoSofValues()\n\nSOF_CURRENT_LIMITS_s TEST_SOF_MinimumOfTwoSofValues ( SOF_CURRENT_LIMITS_s\u00a0 voltageBasedLimits,\nSOF_CURRENT_LIMITS_s\u00a0 temperatureBasedLimits\u00a0\n)\n\nDefinition at line 539 of file sof.c.\n\nHere is the call graph for this function:", "nt16_t\u00a0 maximumCellVoltage_mV,\nSOF_CURRENT_LIMITS_s pAllowedVoltageBasedCurrent,\nconst SOF_CONFIG_s pConfigLimitValues,\nSOF_CURVE_s pCalculatedSofCurves\u00a0\n)\n\nDefinition at line 513 of file sof.c.\n\nHere is the call graph for this function:\n\n\u25c6\u00a0TEST_SOF_MinimumOfTwoSofValues()\n\nSOF_CURRENT_LIMITS_s TEST_SOF_MinimumOfTwoSofValues ( SOF_CURRENT_LIMITS_s\u00a0 voltageBasedLimits,\nSOF_CURRENT_LIMITS_s\u00a0 temperatureBasedLimits\u00a0\n)\n\nDefinition at line 539 of file sof.c.\n\nHere is the call graph for this function:", "nt16_t\u00a0 maximumCellVoltage_mV,\nSOF_CURRENT_LIMITS_s pAllowedVoltageBasedCurrent,\nconst SOF_CONFIG_s pConfigLimitValues,\nSOF_CURVE_s pCalculatedSofCurves\u00a0\n)\n\nDefinition at line 513 of file sof.c.\n\nHere is the call graph for this function:\n\n\u25c6\u00a0TEST_SOF_MinimumOfTwoSofValues()\n\nSOF_CURRENT_LIMITS_s TEST_SOF_MinimumOfTwoSofValues ( SOF_CURRENT_LIMITS_s\u00a0 voltageBasedLimits,\nSOF_CURRENT_LIMITS_s\u00a0 temperatureBasedLimits\u00a0\n)\n\nDefinition at line 539 of file sof.c.\n\nHere is the call graph for this function:", "nt16_t\u00a0 maximumCellVoltage_mV,\nSOF_CURRENT_LIMITS_s pAllowedVoltageBasedCurrent,\nconst SOF_CONFIG_s pConfigLimitValues,\nSOF_CURVE_s pCalculatedSofCurves\u00a0\n)\n\nDefinition at line 513 of file sof.c.\n\nHere is the call graph for this function:\n\n\u25c6\u00a0TEST_SOF_MinimumOfTwoSofValues()\n\nSOF_CURRENT_LIMITS_s TEST_SOF_MinimumOfTwoSofValues ( SOF_CURRENT_LIMITS_s\u00a0 voltageBasedLimits,\nSOF_CURRENT_LIMITS_s\u00a0 temperatureBasedLimits\u00a0\n)\n\nDefinition at line 539 of file sof.c.\n\nHere is the call graph for this function:", "nt16_t\u00a0 maximumCellVoltage_mV,\nSOF_CURRENT_LIMITS_s pAllowedVoltageBasedCurrent,\nconst SOF_CONFIG_s pConfigLimitValues,\nSOF_CURVE_s pCalculatedSofCurves\u00a0\n)\n\nDefinition at line 513 of file sof.c.\n\nHere is the call graph for this function:\n\n\u25c6\u00a0TEST_SOF_MinimumOfTwoSofValues()\n\nSOF_CURRENT_LIMITS_s TEST_SOF_MinimumOfTwoSofValues ( SOF_CURRENT_LIMITS_s\u00a0 voltageBasedLimits,\nSOF_CURRENT_LIMITS_s\u00a0 temperatureBasedLimits\u00a0\n)\n\nDefinition at line 539 of file sof.c.\n\nHere is the call graph for this function:", "nt16_t\u00a0 maximumCellVoltage_mV,\nSOF_CURRENT_LIMITS_s pAllowedVoltageBasedCurrent,\nconst SOF_CONFIG_s pConfigLimitValues,\nSOF_CURVE_s pCalculatedSofCurves\u00a0\n)\n\nDefinition at line 513 of file sof.c.\n\nHere is the call graph for this function:\n\n\u25c6\u00a0TEST_SOF_MinimumOfTwoSofValues()\n\nSOF_CURRENT_LIMITS_s TEST_SOF_MinimumOfTwoSofValues ( SOF_CURRENT_LIMITS_s\u00a0 voltageBasedLimits,\nSOF_CURRENT_LIMITS_s\u00a0 temperatureBasedLimits\u00a0\n)\n\nDefinition at line 539 of file sof.c.\n\nHere is the call graph for this function:"]}