foxBMS - Unit Tests  1.2.1
The foxBMS Unit Tests API Documentation
epcos_b57861s0103f045.c
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_b57861s0103f045.c
44  * @author foxBMS Team
45  * @date 2018-10-30 (date of creation)
46  * @updated 2021-11-08 (date of last update)
47  * @ingroup TEMPERATURE_SENSORS
48  * @prefix TS
49  *
50  * @brief Resistive divider used for measuring temperature
51  *
52  */
53 
54 /*========== Includes =======================================================*/
55 #include "epcos_b57861s0103f045.h"
56 
57 #include "foxmath.h"
59 
60 /*========== Macros and Definitions =========================================*/
61 
62 /*========== Static Constant and Variable Definitions =======================*/
63 
64 /* clang-format off */
65 /** LUT filled from higher resistance to lower resistance */
67  { -550, 963000.00f },
68  { -500, 670100.00f },
69  { -450, 471700.00f },
70  { -400, 336500.00f },
71  { -350, 242600.00f },
72  { -300, 177000.00f },
73  { -250, 130400.00f },
74  { -200, 97070.00f },
75  { -150, 72930.00f },
76  { -100, 55330.00f },
77  { -50, 42320.00f },
78  { 0, 32650.00f },
79  { 50, 25390.00f },
80  { 100, 19900.00f },
81  { 150, 15710.00f },
82  { 200, 12490.00f },
83  { 250, 10000.00f },
84  { 300, 8057.00f },
85  { 350, 6531.00f },
86  { 400, 5327.00f },
87  { 450, 4369.00f },
88  { 500, 3603.00f },
89  { 550, 2986.00f },
90  { 600, 2488.00f },
91  { 650, 2083.00f },
92  { 700, 1752.00f },
93  { 750, 1481.00f },
94  { 800, 1258.00f },
95  { 850, 1072.00f },
96  { 900, 917.70f },
97  { 950, 788.50f },
98  { 1000, 680.00f },
99  { 1050, 588.60f },
100  { 1100, 511.20f },
101  { 1150, 445.40f },
102  { 1200, 389.30f },
103  { 1250, 341.70f },
104  { 1300, 300.90f },
105  { 1350, 265.40f },
106  { 1400, 234.80f },
107  { 1450, 208.30f },
108  { 1500, 185.30f },
109  { 1550, 165.30f }
110 };
111 /* clang-format on */
112 
113 /** size of the #ts_b57861s0103f045Lut LUT */
115 
116 /*========== Extern Constant and Variable Definitions =======================*/
117 /**
118  * @brief Defines for calculating the ADC voltage on the ends of the operating range.
119  * @details The ADC voltage is calculated with the following formula:
120  *
121  * V_adc = ((V_supply * R_ntc) / (R + R_ntc))
122  *
123  * Depending on the position of the NTC in the voltage resistor (R1/R2),
124  * different R_ntc values are used for the calculation.
125  */
126 /**@{*/
127 #if TS_EPCOS_B57861S0103F045_POSITION_IN_RESISTOR_DIVIDER_IS_R_1 == true
128 #define TS_EPCOS_B57861S0103F045_ADC_VOLTAGE_V_MAX_V \
129  (float)((TS_EPCOS_B57861S0103F045_RESISTOR_DIVIDER_SUPPLY_VOLTAGE_V * ts_b57861s0103f045Lut[ts_b57861s0103f045LutSize-1].resistance_Ohm) / (ts_b57861s0103f045Lut[ts_b57861s0103f045LutSize-1].resistance_Ohm+TS_EPCOS_B57861S0103F045_RESISTOR_DIVIDER_RESISTANCE_R_1_R_2_Ohm))
130 #define TS_EPCOS_B57861S0103F045_ADC_VOLTAGE_V_MIN_V \
131  (float)((TS_EPCOS_B57861S0103F045_RESISTOR_DIVIDER_SUPPLY_VOLTAGE_V * ts_b57861s0103f045Lut[0].resistance_Ohm) / (ts_b57861s0103f045Lut[0].resistance_Ohm+TS_EPCOS_B57861S0103F045_RESISTOR_DIVIDER_RESISTANCE_R_1_R_2_Ohm))
132 #else /* TS_EPCOS_B57861S0103F045_POSITION_IN_RESISTOR_DIVIDER_IS_R_1 == false */
133 #define TS_EPCOS_B57861S0103F045_ADC_VOLTAGE_V_MIN_V \
134  (float)((TS_EPCOS_B57861S0103F045_RESISTOR_DIVIDER_SUPPLY_VOLTAGE_V * ts_b57861s0103f045Lut[ts_b57861s0103f045LutSize-1].resistance_Ohm) / (ts_b57861s0103f045Lut[ts_b57861s0103f045LutSize-1].resistance_Ohm+TS_EPCOS_B57861S0103F045_RESISTOR_DIVIDER_RESISTANCE_R_1_R_2_Ohm))
135 #define TS_EPCOS_B57861S0103F045_ADC_VOLTAGE_V_MAX_V \
136  (float)((TS_EPCOS_B57861S0103F045_RESISTOR_DIVIDER_SUPPLY_VOLTAGE_V * ts_b57861s0103f045Lut[0].resistance_Ohm) / (ts_b57861s0103f045Lut[0].resistance_Ohm+TS_EPCOS_B57861S0103F045_RESISTOR_DIVIDER_RESISTANCE_R_1_R_2_Ohm))
137 #endif
138 /**@}*/
139 
140 /*========== Static Function Prototypes =====================================*/
141 
142 /*========== Static Function Implementations ================================*/
143 
144 /*========== Extern Function Implementations ================================*/
145 
146 extern int16_t TS_Epc01GetTemperatureFromLut(uint16_t adcVoltage_mV) {
147  int16_t temperature_ddegC = 0;
148  float resistance_Ohm = 0.0f;
149  float adcVoltage_V = adcVoltage_mV / 1000.0f; /* Convert mV to V */
150 
151  /* Check for valid ADC measurements to prevent undefined behavior */
153  /* Invalid measured ADC voltage -> sensor out of operating range or disconnected/shorted */
154  temperature_ddegC = INT16_MIN;
155  } else if (adcVoltage_V < TS_EPCOS_B57861S0103F045_ADC_VOLTAGE_V_MIN_V) {
156  /* Invalid measured ADC voltage -> sensor out of operating range or shorted/disconnected */
157  temperature_ddegC = INT16_MAX;
158  } else {
159  /* Calculate NTC resistance based on measured ADC voltage */
160 #if B57861S0103F045_POSITION_IN_RESISTOR_DIVIDER_IS_R_1 == true
161  /* R_1 = R_2 * ( ( V_supply / V_adc ) - 1 ) */
164 #else /* B57861S0103F045_POSITION_IN_RESISTOR_DIVIDER_IS_R_1 == false */
165  /* R_2 = R_1 * ( V_2 / ( V_supply - V_adc ) ) */
167  (adcVoltage_V / (TS_EPCOS_B57861S0103F045_RESISTOR_DIVIDER_SUPPLY_VOLTAGE_V - adcVoltage_V));
168 #endif /* B57861S0103F045_POSITION_IN_RESISTOR_DIVIDER_IS_R_1 */
169 
170  /* Variables for interpolating LUT value */
171  uint16_t between_high = 0;
172  uint16_t between_low = 0;
173  for (uint16_t i = 1; i < ts_b57861s0103f045LutSize; i++) {
174  if (resistance_Ohm < ts_b57861s0103f045Lut[i].resistance_Ohm) {
175  between_low = i + 1u;
176  between_high = i;
177  }
178  }
179 
180  /* Interpolate between LUT values, but do not extrapolate LUT! */
181  if (!(((between_high == 0u) && (between_low == 0u)) || /* measured resistance > maximum LUT resistance */
182  (between_low >= ts_b57861s0103f045LutSize))) { /* measured resistance < minimum LUT resistance */
183  temperature_ddegC = (int16_t)MATH_LinearInterpolation(
184  ts_b57861s0103f045Lut[between_low].resistance_Ohm,
185  ts_b57861s0103f045Lut[between_low].temperature_ddegC,
186  ts_b57861s0103f045Lut[between_high].resistance_Ohm,
187  ts_b57861s0103f045Lut[between_high].temperature_ddegC,
188  resistance_Ohm);
189  }
190  }
191 
192  /* Return temperature based on measured NTC resistance */
193  return temperature_ddegC;
194 }
195 
196 extern int16_t TS_Epc01GetTemperatureFromPolynomial(uint16_t adcVoltage_mV) {
197  float temperature_degC = 0.0f;
198  float vadc_V = adcVoltage_mV / 1000.0f;
199  float vadc2 = vadc_V * vadc_V;
200  float vadc3 = vadc2 * vadc_V;
201  float vadc4 = vadc3 * vadc_V;
202  float vadc5 = vadc4 * vadc_V;
203 
204  /* 5th grade polynomial for EPCOS B57861S0103F045 NTC-Thermistor, 10 kOhm, Series B57861S, Vref = 3V, R in series 10k */
205  temperature_degC = (-6.2765f * vadc5) + (49.0397f * vadc4) - (151.3602f * vadc3) + (233.2521f * vadc2) -
206  (213.4588f * vadc_V) + 130.5822f;
207 
208  return (int16_t)(temperature_degC * 10.0f); /* Convert to deci &deg;C */
209 }
210 
211 /*========== Externalized Static Function Implementations (Unit Test) =======*/
int16_t TS_Epc01GetTemperatureFromPolynomial(uint16_t adcVoltage_mV)
returns temperature based on measured ADC voltage
static uint16_t ts_b57861s0103f045LutSize
int16_t TS_Epc01GetTemperatureFromLut(uint16_t adcVoltage_mV)
returns temperature based on measured ADC voltage
#define TS_EPCOS_B57861S0103F045_ADC_VOLTAGE_V_MAX_V
Defines for calculating the ADC voltage on the ends of the operating range.
static const TS_TEMPERATURE_SENSOR_LUT_s ts_b57861s0103f045Lut[]
#define TS_EPCOS_B57861S0103F045_ADC_VOLTAGE_V_MIN_V
Defines for calculating the ADC voltage on the ends of the operating range.
Resistive divider used for measuring temperature.
#define TS_EPCOS_B57861S0103F045_RESISTOR_DIVIDER_SUPPLY_VOLTAGE_V
#define TS_EPCOS_B57861S0103F045_RESISTOR_DIVIDER_RESISTANCE_R_1_R_2_Ohm
float MATH_LinearInterpolation(const float x1, const float y1, const float x2, const float y2, const float x_interpolate)
Linear inter-/extrapolates a third point according to two given points.
Definition: foxmath.c:84
math library for often used math functions