foxBMS  1.1.1
The foxBMS Battery Management System API Documentation
soa.h File Reference

Header for SOA module, responsible for checking battery parameters against safety limits. More...

#include "soa_cfg.h"
#include "database.h"
Include dependency graph for soa.h:
This graph shows which files directly or indirectly include this file:

Go to the source code of this file.

Functions

void SOA_CheckVoltages (DATA_BLOCK_MIN_MAX_s *pMinimumMaximumCellVoltages)
 checks the abidance by the safe operating area More...
 
void SOA_CheckTemperatures (DATA_BLOCK_MIN_MAX_s *pMinimumMaximumCellTemperatures, DATA_BLOCK_PACK_VALUES_s *pCurrent)
 checks the abidance by the safe operating area More...
 
void SOA_CheckCurrent (DATA_BLOCK_PACK_VALUES_s *pTablePackValues)
 checks the abidance by the safe operating area More...
 
void SOA_CheckSlaveTemperatures (void)
 FOR FUTURE COMPATIBILITY; DUMMY FUNCTION; DO NOT USE. More...
 

Detailed Description

Header for SOA module, responsible for checking battery parameters against safety limits.

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
2020-10-14 (date of last update)
Prefix
SOA

Definition in file soa.h.

Function Documentation

◆ SOA_CheckCurrent()

void SOA_CheckCurrent ( DATA_BLOCK_PACK_VALUES_s pTablePackValues)

checks the abidance by the safe operating area

Parameters
[in]pTablePackValuespointer to pack values database entry

verify for cell current measurements (I), if minimum and maximum values are out of range

Definition at line 275 of file soa.c.

Here is the call graph for this function:

◆ SOA_CheckSlaveTemperatures()

void SOA_CheckSlaveTemperatures ( void  )

FOR FUTURE COMPATIBILITY; DUMMY FUNCTION; DO NOT USE.

FOR FUTURE COMPATIBILITY; DUMMY FUNCTION; DO NOT USE

Definition at line 357 of file soa.c.

◆ SOA_CheckTemperatures()

void SOA_CheckTemperatures ( DATA_BLOCK_MIN_MAX_s pMinimumMaximumCellTemperatures,
DATA_BLOCK_PACK_VALUES_s pCurrent 
)

checks the abidance by the safe operating area

Parameters
[in]pMinimumMaximumCellTemperaturespointer to database entry with
[in]pCurrentpointer to pack value database entry

verify for cell temperature measurements (T), if minimum and maximum values are out of range

Definition at line 143 of file soa.c.

Here is the call graph for this function:

◆ SOA_CheckVoltages()

void SOA_CheckVoltages ( DATA_BLOCK_MIN_MAX_s pMinimumMaximumCellVoltages)

checks the abidance by the safe operating area

Parameters
[in]pMinimumMaximumCellVoltagespointer to database entry with minimum and maximum cell voltages

verify for cell voltage measurements (U), if minimum and maximum values are out of range

Definition at line 77 of file soa.c.

Here is the call graph for this function: