foxBMS - Unit Tests  1.4.0
The foxBMS Unit Tests API Documentation
epcos_b57251v5103j060.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 epcos_b57251v5103j060.h
44  * @author foxBMS Team
45  * @date 2018-10-30 (date of creation)
46  * @updated 2022-07-28 (date of last update)
47  * @version v1.4.0
48  * @ingroup TEMPERATURE_SENSORS
49  * @prefix TS
50  *
51  * @brief Resistive divider used for measuring temperature
52  *
53  * @details Schematics:
54  *
55  * V_supply
56  * --.--
57  * |
58  * +-.-+
59  * | |
60  * | | R_1
61  * | |
62  * +-.-+
63  * |
64  * .--- V_adc
65  * |
66  * +-.-+
67  * | |
68  * | | R_2
69  * | |
70  * +-.-+
71  * |
72  * --.--
73  * GND
74  *
75  */
76 
77 #ifndef FOXBMS__EPCOS_B57251V5103J060_H_
78 #define FOXBMS__EPCOS_B57251V5103J060_H_
79 
80 /*========== Includes =======================================================*/
81 #include "general.h"
82 
83 /*========== Macros and Definitions =========================================*/
84 /**
85  * Position of the NTC in the voltage resistor
86  * true: NTC is positioned above the voltage tap for the ADC voltage.
87  * This equals resistor R_1 in the above circuit diagram
88  *
89  * false: NTC is positioned below the voltage tap for the ADC voltage.
90  * This equals resistor R_2 in the above circuit diagram
91  */
92 #define TS_EPCOS_B57251V5103J060_POSITION_IN_RESISTOR_DIVIDER_IS_R_1 (false)
93 
94 /** Resistor divider supply voltage in volt */
95 #define TS_EPCOS_B57251V5103J060_RESISTOR_DIVIDER_SUPPLY_VOLTAGE_V (2.5f)
96 
97 /**
98  * Resistance value of the other resistor (not the NTC) in the resistor
99  * divider in Ohm.
100  */
101 #define TS_EPCOS_B57251V5103J060_RESISTOR_DIVIDER_RESISTANCE_R_1_R_2_Ohm (10000.0f)
102 
103 /*========== Extern Constant and Variable Declarations ======================*/
104 /**
105  * @brief returns temperature based on measured ADC voltage
106  * @param adcVoltage_mV voltage in mV
107  * @return corresponding temperature in deci °C or INT16_MAX/INT16_MIN if
108  * NTC is shorted or got disconnected. The caller of this functions
109  * needs to check for these return values to prevent invalid data.
110  */
111 extern int16_t TS_Epc00GetTemperatureFromLut(uint16_t adcVoltage_mV);
112 
113 /**
114  * @brief returns temperature based on measured ADC voltage
115  * @param adcVoltage_mV voltage in mV
116  * @return corresponding temperature in deci °C
117  */
118 extern int16_t TS_Epc00GetTemperatureFromPolynomial(uint16_t adcVoltage_mV);
119 
120 /*========== Extern Function Prototypes =====================================*/
121 
122 /*========== Externalized Static Functions Prototypes (Unit Test) ===========*/
123 
124 #endif /* FOXBMS__EPCOS_B57251V5103J060_H_ */
int16_t TS_Epc00GetTemperatureFromPolynomial(uint16_t adcVoltage_mV)
returns temperature based on measured ADC voltage
int16_t TS_Epc00GetTemperatureFromLut(uint16_t adcVoltage_mV)
returns temperature based on measured ADC voltage
General macros and definitions for the whole platform.