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