foxBMS - Unit Tests  1.4.0
The foxBMS Unit Tests API Documentation
beta.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 beta.h
44  * @author foxBMS Team
45  * @date 2020-01-17 (date of creation)
46  * @updated 2022-07-28 (date of last update)
47  * @version v1.4.0
48  * @ingroup TEMPERATURE_SENSORS
49  * @prefix BETA
50  *
51  * @brief Resistive divider used for measuring temperature
52  *
53  * V_supply
54  * --.--
55  * |
56  * +-.-+
57  * | |
58  * | | R_1
59  * | |
60  * +-.-+
61  * |
62  * .--- V_adc
63  * |
64  * +-.-+
65  * | |
66  * | | R_2
67  * | |
68  * +-.-+
69  * |
70  * --.--
71  * GND
72  *
73  */
74 
75 #ifndef FOXBMS__BETA_H_
76 #define FOXBMS__BETA_H_
77 
78 /*========== Includes =======================================================*/
79 #include "general.h"
80 
81 /*========== Macros and Definitions =========================================*/
82 /**
83  * Position of the NTC in the voltage resistor
84  * true: NTC is positioned above the voltage tap for the ADC voltage.
85  * This equals resistor R_1 in the above circuit diagram
86  *
87  * false: NTC is positioned below the voltage tap for the ADC voltage.
88  * This equals resistor R2 in the above circuit diagram
89  */
90 #define BETA_POSITION_IN_RESISTOR_DIVIDER_IS_R_1 (false)
91 
92 /** Resistor divider supply voltage in volt */
93 #define BETA_RESISTOR_DIVIDER_SUPPLY_VOLTAGE_V (4.096f)
94 
95 /**
96  * Resistance value of the other resistor (not the NTC) in the resistor
97  * divider in kOhm.
98  */
99 #define BETA_RESISTOR_DIVIDER_RESISTANCE_R_1_R_2_Ohm (10000.0f)
100 
101 /** Reference temperature */
102 #define BETA_T_REF_C (25.0f)
103 
104 /** NTC resistance at reference temperature */
105 #define BETA_R_REF_Ohm (10000.0f)
106 
107 /** BEta coefficient of the NTC */
108 #define BETA_BETACOEFFICIENT (3984.0f)
109 
110 /*========== Extern Constant and Variable Declarations ======================*/
111 
112 /*========== Extern Function Prototypes =====================================*/
113 /**
114  * @brief returns temperature based on measured ADC voltage
115  * @param adcVoltage_mV voltage in mV
116  * @return corresponding temperature in deci °C or FLT_MAX/FLT_MIN if NTC
117  * is shorted or got disconnected. The caller of this functions needs
118  * to check for these return values to prevent invalid data.
119  */
120 extern int16_t BETA_GetTemperatureFromBeta(uint16_t adcVoltage_mV);
121 
122 /**
123  * @brief returns temperature corresponding to NTC resistance
124  * @param resistance_Ohm resistance in Ohm
125  * @return corresponding temperature in deci °C
126  *
127  */
128 extern int16_t BETA_TemperatureFromResistance(float resistance_Ohm);
129 
130 /**
131  * @brief returns NTC resistance corresponding to temperature,
132  * used to compute Vmin and Vmax of the divider
133  * @param temperature_ddegC in deci °C
134  * @return corresponding resistance in Ohm
135  *
136  */
137 extern float BETA_ResistanceFromTemperature(int16_t temperature_ddegC);
138 
139 /*========== Externalized Static Functions Prototypes (Unit Test) ===========*/
140 
141 #endif /* FOXBMS__BETA_H_ */
int16_t BETA_TemperatureFromResistance(float resistance_Ohm)
returns temperature corresponding to NTC resistance
Definition: beta.c:127
float BETA_ResistanceFromTemperature(int16_t temperature_ddegC)
returns NTC resistance corresponding to temperature, used to compute Vmin and Vmax of the divider
Definition: beta.c:141
int16_t BETA_GetTemperatureFromBeta(uint16_t adcVoltage_mV)
returns temperature based on measured ADC voltage
Definition: beta.c:96
General macros and definitions for the whole platform.