foxBMS  1.6.0
The foxBMS Battery Management System API Documentation
adi_ades183x_balancing.h
Go to the documentation of this file.
1 /**
2  *
3  * @copyright © 2010 - 2023, 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 adi_ades183x_balancing.h
44  * @author foxBMS Team
45  * @date 2015-09-01 (date of creation)
46  * @updated 2023-10-12 (date of last update)
47  * @version v1.6.0
48  * @ingroup DRIVERS
49  * @prefix ADI
50  *
51  * @brief Headers for the driver for the ADI analog front-end.
52  *
53  */
54 
55 #ifndef FOXBMS__ADI_ADES183X_BALANCING_H_
56 #define FOXBMS__ADI_ADES183X_BALANCING_H_
57 
58 /*========== Includes =======================================================*/
59 #include "adi_ades183x_defs.h"
60 
61 /*========== Macros and Definitions =========================================*/
62 
63 /*========== Extern Constant and Variable Declarations ======================*/
64 
65 /*========== Extern Function Prototypes =====================================*/
66 /**
67  * @brief Disable balancing
68  * @param adiState state of the driver
69  */
70 extern void ADI_DeactivateBalancing(ADI_STATE_s *adiState);
71 
72 /**
73  * @brief Determines how the balancing registers need to be set
74  * @details Dependent on the actually used cell inputs this functions sets the
75  * registers accordingly.
76  * @param adiState state of the driver
77  */
78 extern void ADI_DetermineBalancingRegisterConfiguration(ADI_STATE_s *adiState);
79 
80 /*========== Externalized Static Functions Prototypes (Unit Test) ===========*/
81 #ifdef UNITY_UNIT_TEST
82 #endif
83 
84 #endif /* FOXBMS__ADI_ADES183X_BALANCING_H_ */
ADI_DeactivateBalancing
void ADI_DeactivateBalancing(ADI_STATE_s *adiState)
Disable balancing.
Definition: adi_ades1830_balancing.c:79
ADI_DetermineBalancingRegisterConfiguration
void ADI_DetermineBalancingRegisterConfiguration(ADI_STATE_s *adiState)
Determines how the balancing registers need to be set.
Definition: adi_ades1830_balancing.c:104
adi_ades183x_defs.h
Headers for the driver for the ades183x analog front-end.
ADI_STATE_s
Definition: adi_ades183x_defs.h:1201