foxBMS-UnitTests  1.0.0
The foxBMS Unit Tests API Documentation
sps_types.h
Go to the documentation of this file.
1 /**
2  *
3  * @copyright © 2010 - 2021, Fraunhofer-Gesellschaft zur Foerderung der
4  * angewandten Forschung e.V. All rights reserved.
5  *
6  * BSD 3-Clause License
7  * Redistribution and use in source and binary forms, with or without
8  * modification, are permitted provided that the following conditions are met:
9  * 1. Redistributions of source code must retain the above copyright notice,
10  * this list of conditions and the following disclaimer.
11  * 2. Redistributions in binary form must reproduce the above copyright
12  * notice, this list of conditions and the following disclaimer in the
13  * documentation and/or other materials provided with the distribution.
14  * 3. Neither the name of the copyright holder nor the names of its
15  * contributors may be used to endorse or promote products derived from
16  * this software without specific prior written permission.
17  *
18  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
19  * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
20  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
21  * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE
22  * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
23  * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
24  * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
25  * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
26  * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
27  * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
28  * POSSIBILITY OF SUCH DAMAGE.
29  *
30  * We kindly request you to use one or more of the following phrases to refer
31  * to foxBMS in your hardware, software, documentation or advertising
32  * materials:
33  *
34  * ″This product uses parts of foxBMS®″
35  *
36  * ″This product includes parts of foxBMS®″
37  *
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 2020-12-01 (date of last update)
47  * @ingroup DRIVERS
48  * @prefix SPS
49  *
50  * @brief Types for the SPS driver.
51  *
52  */
53 
54 #ifndef FOXBMS__SPS_TYPES_H_
55 #define FOXBMS__SPS_TYPES_H_
56 
57 /*========== Includes =======================================================*/
58 
59 /*========== Macros and Definitions =========================================*/
60 
61 /*========== Extern Constant and Variable Declarations ======================*/
62 /** index of a SPS channel; not to be confused with #CONT_CONTACTOR_INDEX */
63 typedef uint8_t SPS_CHANNEL_INDEX;
64 
65 /**
66  * @brief affiliation type of a sps channel
67  * @details These values are used to mark if the SPS channel is a contactor or
68  * general IO (or possibly something else in the future). This has
69  * implication on the type of interface that may access the channel.
70  */
71 typedef enum SPS_CHANNEL_AFFILIATION {
72  SPS_AFF_CONTACTOR, /*!< affiliation of channel is contactor */
73  SPS_AFF_GENERAL_IO, /*!< affiliation of channel is general IO */
74 } SPS_CHANNEL_AFFILIATION_e;
75 
76 /*========== Extern Function Prototypes =====================================*/
77 
78 /*========== Externalized Static Functions Prototypes (Unit Test) ===========*/
79 
80 #endif /* FOXBMS__SPS_TYPES_H_ */
SPS_AFF_CONTACTOR
@ SPS_AFF_CONTACTOR
Definition: sps_types.h:72
SPS_CHANNEL_AFFILIATION
SPS_CHANNEL_AFFILIATION
affiliation type of a sps channel
Definition: sps_types.h:71
SPS_CHANNEL_INDEX
uint8_t SPS_CHANNEL_INDEX
Definition: sps_types.h:63
SPS_AFF_GENERAL_IO
@ SPS_AFF_GENERAL_IO
Definition: sps_types.h:73
SPS_CHANNEL_AFFILIATION_e
enum SPS_CHANNEL_AFFILIATION SPS_CHANNEL_AFFILIATION_e
affiliation type of a sps channel