foxBMS - Unit Tests
1.3.0
The foxBMS Unit Tests API Documentation
bal_cfg.h
Go to the documentation of this file.
1
/**
2
*
3
* @copyright © 2010 - 2022, Fraunhofer-Gesellschaft zur Foerderung der angewandten Forschung e.V.
4
* All rights reserved.
5
*
6
* SPDX-License-Identifier: BSD-3-Clause
7
*
8
* Redistribution and use in source and binary forms, with or without
9
* modification, are permitted provided that the following conditions are met:
10
*
11
* 1. Redistributions of source code must retain the above copyright notice, this
12
* list of conditions and the following disclaimer.
13
*
14
* 2. Redistributions in binary form must reproduce the above copyright notice,
15
* this list of conditions and the following disclaimer in the documentation
16
* and/or other materials provided with the distribution.
17
*
18
* 3. Neither the name of the copyright holder nor the names of its
19
* contributors may be used to endorse or promote products derived from
20
* this software without specific prior written permission.
21
*
22
* THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
23
* AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
24
* IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
25
* DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE
26
* FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
27
* DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
28
* SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
29
* CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
30
* OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
31
* OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
32
*
33
* We kindly request you to use one or more of the following phrases to refer to
34
* foxBMS in your hardware, software, documentation or advertising materials:
35
*
36
* - ″This product uses parts of foxBMS®″
37
* - ″This product includes parts of foxBMS®″
38
* - ″This product is derived from foxBMS®″
39
*
40
*/
41
42
/**
43
* @file bal_cfg.h
44
* @author foxBMS Team
45
* @date 2020-02-24 (date of creation)
46
* @updated 2022-05-30 (date of last update)
47
* @version v1.3.0
48
* @ingroup DRIVERS_CONFIGURATION
49
* @prefix BAL
50
*
51
* @brief Header for the configuration for the driver for balancing
52
*
53
*/
54
55
#ifndef FOXBMS__BAL_CFG_H_
56
#define FOXBMS__BAL_CFG_H_
57
58
/*========== Includes =======================================================*/
59
#include "
general.h
"
60
61
/*========== Macros and Definitions =========================================*/
62
63
/** BAL statemachine short time definition in 100*ms */
64
#define BAL_STATEMACH_SHORTTIME_100ms (1U)
65
66
/** BAL statemachine long time definition in 100*ms */
67
68
#define BAL_STATEMACH_LONGTIME_100ms (50U)
69
70
/** BAL statemachine balancing time in 100*ms */
71
#define BAL_STATEMACH_BALANCINGTIME_100ms (10U)
72
73
/** default value for the BAL voltage threshold */
74
#define BAL_DEFAULT_THRESHOLD_mV (200)
75
76
/** maximum value that BAL voltage threshold may take */
77
#define BAL_MAXIMUM_THRESHOLD_mV (5000)
78
79
/** minimum value that BAL voltage threshold may take */
80
#define BAL_MINIMUM_THRESHOLD_mV (0)
81
82
/** BAL hysteresis for voltage threshold when balancing was finished in mV */
83
#define BAL_HYSTERESIS_mV (200)
84
85
/** BAL lower voltage limit in MV */
86
#define BAL_LOWER_VOLTAGE_LIMIT_mV (2000)
87
88
/** BAL upper temperature limit in deci °C */
89
#define BAL_UPPER_TEMPERATURE_LIMIT_ddegC (700)
90
91
/*========== Extern Constant and Variable Declarations ======================*/
92
93
/*========== Extern Function Prototypes =====================================*/
94
/**
95
* @brief set balancing threshold
96
* @param[in] threshold_mV threshold in mV
97
*/
98
extern
void
BAL_SetBalancingThreshold
(int32_t threshold_mV);
99
100
/**
101
* @brief get balancing threshold
102
* @returns balancing threshold in mV
103
*/
104
extern
int32_t
BAL_GetBalancingThreshold_mV
(
void
);
105
106
/*========== Externalized Static Functions Prototypes (Unit Test) ===========*/
107
108
#endif
/* FOXBMS__BAL_CFG_H_ */
BAL_SetBalancingThreshold
void BAL_SetBalancingThreshold(int32_t threshold_mV)
set balancing threshold
Definition:
bal_cfg.c:73
BAL_GetBalancingThreshold_mV
int32_t BAL_GetBalancingThreshold_mV(void)
get balancing threshold
Definition:
bal_cfg.c:86
general.h
General macros and definitions for the whole platform.
src
app
application
config
bal_cfg.h
Generated by
1.9.1