foxBMS - Unit Tests  1.5.0
The foxBMS Unit Tests API Documentation
sps_types.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 sps_types.h
44  * @author foxBMS Team
45  * @date 2020-12-01 (date of creation)
46  * @updated 2023-02-03 (date of last update)
47  * @version v1.5.0
48  * @ingroup DRIVERS
49  * @prefix SPS
50  *
51  * @brief Types for the SPS driver.
52  *
53  */
54 
55 #ifndef FOXBMS__SPS_TYPES_H_
56 #define FOXBMS__SPS_TYPES_H_
57 
58 /*========== Includes =======================================================*/
59 #include <stdint.h>
60 
61 /*========== Macros and Definitions =========================================*/
62 
63 /*========== Extern Constant and Variable Declarations ======================*/
64 /** index of a SPS channel; not to be confused with #CONT_CONTACTOR_INDEX */
65 typedef uint8_t SPS_CHANNEL_INDEX;
66 
67 /**
68  * @brief affiliation type of a sps channel
69  * @details These values are used to mark if the SPS channel is a contactor or
70  * general IO (or possibly something else in the future). This has
71  * implication on the type of interface that may access the channel.
72  */
73 typedef enum {
74  SPS_AFF_CONTACTOR, /*!< affiliation of channel is contactor */
75  SPS_AFF_GENERAL_IO, /*!< affiliation of channel is general IO */
76 } SPS_CHANNEL_AFFILIATION_e;
77 
78 /*========== Extern Function Prototypes =====================================*/
79 
80 /*========== Externalized Static Functions Prototypes (Unit Test) ===========*/
81 #ifdef UNITY_UNIT_TEST
82 #endif
83 
84 #endif /* FOXBMS__SPS_TYPES_H_ */
SPS_CHANNEL_INDEX
uint8_t SPS_CHANNEL_INDEX
Definition: sps_types.h:65
SPS_CHANNEL_AFFILIATION_e
SPS_CHANNEL_AFFILIATION_e
affiliation type of a sps channel
Definition: sps_types.h:73
SPS_AFF_CONTACTOR
@ SPS_AFF_CONTACTOR
Definition: sps_types.h:74
SPS_AFF_GENERAL_IO
@ SPS_AFF_GENERAL_IO
Definition: sps_types.h:75