foxBMS - Unit Tests  1.4.0
The foxBMS Unit Tests API Documentation
contactor_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 contactor_cfg.h
44  * @author foxBMS Team
45  * @date 2020-02-11 (date of creation)
46  * @updated 2022-07-28 (date of last update)
47  * @version v1.4.0
48  * @ingroup DRIVERS_CONFIGURATION
49  * @prefix CONT
50  *
51  * @brief Header for the configuration for the driver for the contactors
52  *
53  */
54 
55 #ifndef FOXBMS__CONTACTOR_CFG_H_
56 #define FOXBMS__CONTACTOR_CFG_H_
57 
58 /*========== Includes =======================================================*/
59 #include "general.h"
60 
61 #include "battery_system_cfg.h"
62 
63 #include "sps_types.h"
64 
65 /*========== Macros and Definitions =========================================*/
66 
67 /*================== Main precharge configuration ====================*/
68 
69 /*========== Extern Constant and Variable Declarations ======================*/
70 /** Symbolic names for the possible states of the contactors */
71 typedef enum {
72  CONT_SWITCH_OFF, /*!< Contactor off --> Contactor is open */
73  CONT_SWITCH_ON, /*!< Contactor on --> Contactor is closed */
74  CONT_SWITCH_UNDEF, /*!< Contactor undefined --> Contactor state not known */
76 
77 /** Symbolic names for the contactors */
78 typedef enum {
79  CONT_STRING0_PLUS, /*!< Contactor in string0 plus path */
80  CONT_STRING0_MINUS, /*!< Contactor in string0 minus path */
81  CONT_STRING1_PLUS, /*!< Contactor in string1 plus path */
82  CONT_STRING1_MINUS, /*!< Contactor in string1 minus path */
83  CONT_STRING2_PLUS, /*!< Contactor in string2 plus path */
84  CONT_STRING2_MINUS, /*!< Contactor in string2 minus path */
85  CONT_PRECHARGE, /*!< Precharge contactor */
86 } CONT_NAMES_e;
87 
88 /** Symbolic names defining the electric behavior of the contactor */
89 typedef enum {
90  CONT_FEEDBACK_NORMALLY_OPEN, /*!< Feedback line of a contactor is normally open */
91  CONT_FEEDBACK_NORMALLY_CLOSED, /*!< Feedback line of a contactor is normally closed */
92  CONT_FEEDBACK_THROUGH_CURRENT, /*!< Get feedback information through the current flowing into the contactor */
93  CONT_HAS_NO_FEEDBACK, /*!< Feedback line of the contactor is not used */
95 
96 /** Status struct for a registry of all contactors */
97 typedef struct {
98  CONT_ELECTRICAL_STATE_TYPE_e currentSet; /*!< current setpoint for the contactor */
99  CONT_ELECTRICAL_STATE_TYPE_e feedback; /*!< feedback from the contactor */
100  const CONT_FEEDBACK_TYPE_e feedbackPinType; /*!< type of feedback that the contactor uses */
101  const SPS_CHANNEL_INDEX spsChannel; /*!< channel index of the SPS to which this contactor is connected */
102  const CONT_NAMES_e name; /*!< name of the contactor */
104 
105 /** central state registry of all contactors of the system */
107 
108 /** index number of the contactor array; not to be confused with #SPS_CHANNEL_INDEX */
109 typedef uint8_t CONT_CONTACTOR_INDEX;
110 
111 /*========== Extern Function Prototypes =====================================*/
112 
113 /*========== Externalized Static Functions Prototypes (Unit Test) ===========*/
114 
115 #endif /* FOXBMS__CONTACTOR_CFG_H_ */
Configuration of the battery system (e.g., number of battery modules, battery cells,...
#define BS_NR_OF_CONTACTORS
CONT_FEEDBACK_TYPE_e
Definition: contactor_cfg.h:89
@ CONT_HAS_NO_FEEDBACK
Definition: contactor_cfg.h:93
@ CONT_FEEDBACK_THROUGH_CURRENT
Definition: contactor_cfg.h:92
@ CONT_FEEDBACK_NORMALLY_OPEN
Definition: contactor_cfg.h:90
@ CONT_FEEDBACK_NORMALLY_CLOSED
Definition: contactor_cfg.h:91
uint8_t CONT_CONTACTOR_INDEX
CONT_ELECTRICAL_STATE_TYPE_e
Definition: contactor_cfg.h:71
@ CONT_SWITCH_ON
Definition: contactor_cfg.h:73
@ CONT_SWITCH_OFF
Definition: contactor_cfg.h:72
@ CONT_SWITCH_UNDEF
Definition: contactor_cfg.h:74
CONT_NAMES_e
Definition: contactor_cfg.h:78
@ CONT_STRING2_PLUS
Definition: contactor_cfg.h:83
@ CONT_STRING1_MINUS
Definition: contactor_cfg.h:82
@ CONT_STRING0_MINUS
Definition: contactor_cfg.h:80
@ CONT_STRING2_MINUS
Definition: contactor_cfg.h:84
@ CONT_STRING1_PLUS
Definition: contactor_cfg.h:81
@ CONT_PRECHARGE
Definition: contactor_cfg.h:85
@ CONT_STRING0_PLUS
Definition: contactor_cfg.h:79
CONT_CONTACTOR_STATE_s cont_contactorStates[BS_NR_OF_CONTACTORS]
Definition: contactor_cfg.c:63
General macros and definitions for the whole platform.
Types for the SPS driver.
uint8_t SPS_CHANNEL_INDEX
Definition: sps_types.h:64
CONT_ELECTRICAL_STATE_TYPE_e currentSet
Definition: contactor_cfg.h:98
CONT_ELECTRICAL_STATE_TYPE_e feedback
Definition: contactor_cfg.h:99
const CONT_FEEDBACK_TYPE_e feedbackPinType
const CONT_NAMES_e name
const SPS_CHANNEL_INDEX spsChannel