foxBMS - Unit Tests  1.4.0
The foxBMS Unit Tests API Documentation
tsi.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 tsi.h
44  * @author foxBMS Team
45  * @date 2020-08-25 (date of creation)
46  * @updated 2022-07-28 (date of last update)
47  * @version v1.4.0
48  * @ingroup DRIVER
49  * @prefix TSI
50  *
51  * @brief Temperature Sensor Interface on Slave Unit driver header
52  *
53  * @details This header must not expose any other interfaces than
54  * #TSI_GetTemperature().
55  */
56 
57 #ifndef FOXBMS__TSI_H_
58 #define FOXBMS__TSI_H_
59 
60 /*========== Includes =======================================================*/
61 #include "general.h"
62 
63 /*========== Macros and Definitions =========================================*/
64 
65 /*========== Extern Constant and Variable Declarations ======================*/
66 
67 /*========== Extern Function Prototypes =====================================*/
68 
69 /**
70  * @brief translate a voltage to a temperature
71  * @details Takes a voltage in mV as input and returns a temperature in int16_t
72  * according to the chosen temperature sensor implementation.
73  * @param adcVoltage_mV ADC voltage value in mV
74  * @returns temperature in int16_t in deci °C
75  */
76 extern int16_t TSI_GetTemperature(uint16_t adcVoltage_mV);
77 
78 /**
79  * @brief Return the maximum plausible temperature
80  * @details Returns the maximum plausible temperature that can be returned
81  * from the TSI in deci °C.
82  * @returns temperature as deci °C
83  */
84 extern int16_t TSI_GetMaximumPlausibleTemperature(void);
85 
86 /**
87  * @brief Return the minimum plausible temperature
88  * @details Returns the minimum plausible temperature that can be returned
89  * from the TSI in deci °C.
90  * @returns temperature as deci °C
91  */
92 extern int16_t TSI_GetMinimumPlausibleTemperature(void);
93 
94 /*========== Externalized Static Functions Prototypes (Unit Test) ===========*/
95 
96 #endif /* FOXBMS__TSI_H_ */
General macros and definitions for the whole platform.
int16_t TSI_GetMaximumPlausibleTemperature(void)
Return the maximum plausible temperature.
Definition: tsi_limits.c:81
int16_t TSI_GetMinimumPlausibleTemperature(void)
Return the minimum plausible temperature.
Definition: tsi_limits.c:85
int16_t TSI_GetTemperature(uint16_t adcVoltage_mV)
translate a voltage to a temperature