soa_cfg.h File Reference

Configuration header for SOA. More...

#include "general.h"
#include "bms.h"

Include dependency graph for soa_cfg.h:

This graph shows which files directly or indirectly include this file:

Go to the source code of this file.

Functions
bool	SOA_IsPackCurrentLimitViolated (uint32_t current_mA, BMS_CURRENT_FLOW_STATE_e currentDirection)
	Checks if pack current limit is violated. More...
bool	SOA_IsStringCurrentLimitViolated (uint32_t current_mA, BMS_CURRENT_FLOW_STATE_e currentDirection)
	Checks if string current limit is violated. More...
bool	SOA_IsCellCurrentLimitViolated (uint32_t current_mA, BMS_CURRENT_FLOW_STATE_e currentDirection)
	Checks if cell current limit is violated. More...
bool	SOA_IsCurrentOnOpenString (BMS_CURRENT_FLOW_STATE_e currentDirection, uint8_t stringNumber)
	Checks if string current is floating while contactors are open. More...

Detailed Description

Configuration header for SOA.

Copyright

© 2010 - 2021, Fraunhofer-Gesellschaft zur Foerderung der angewandten Forschung e.V. All rights reserved.

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_cfg.h.

Function Documentation

SOA_IsCellCurrentLimitViolated()

bool SOA_IsCellCurrentLimitViolated	(	uint32_t	current_mA,
		BMS_CURRENT_FLOW_STATE_e	currentDirection
	)

Checks if cell current limit is violated.

Parameters

[in]	current_mA	actual floating current
[in]	currentDirection	charging or discharging

Returns

true if cell current limit is violated, otherwise false

Definition at line 93 of file soa_cfg.c.

SOA_IsCurrentOnOpenString()

bool SOA_IsCurrentOnOpenString	(	BMS_CURRENT_FLOW_STATE_e	currentDirection,
		uint8_t	stringNumber
	)

Checks if string current is floating while contactors are open.

Parameters

[in]	currentDirection	charging, discharging, relaxing or at rest
[in]	stringNumber	string that is checked

Returns

true if cell current limit is violated, otherwise false

Definition at line 111 of file soa_cfg.c.

Here is the call graph for this function:

SOA_IsPackCurrentLimitViolated()

bool SOA_IsPackCurrentLimitViolated	(	uint32_t	current_mA,
		BMS_CURRENT_FLOW_STATE_e	currentDirection
	)

Checks if pack current limit is violated.

Parameters

[in]	current_mA	actual floating pack current
[in]	currentDirection	charging or discharging

Returns

true if pack current limit is violated, otherwise false

Definition at line 71 of file soa_cfg.c.

SOA_IsStringCurrentLimitViolated()

bool SOA_IsStringCurrentLimitViolated	(	uint32_t	current_mA,
		BMS_CURRENT_FLOW_STATE_e	currentDirection
	)

Checks if string current limit is violated.

Parameters

[in]	current_mA	actual floating current
[in]	currentDirection	charging or discharging

Returns

true if string current limit is violated, otherwise false

Definition at line 82 of file soa_cfg.c.