1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
|
/**
* @author Tilen Majerle
* @email tilen@majerle.eu
* @website http://stm32f4-discovery.com
* @link http://stm32f4-discovery.com/2014/05/13-reading-temperature-with-dallas-ds18b20-on-stm32f429-discovery-board/
* @version v2.0
* @ide Keil uVision
* @license GNU GPL v3
* @brief Library for interfacing DS18B20 temperature sensor from Dallas semiconductors.
*
@verbatim
----------------------------------------------------------------------
Copyright (C) Tilen Majerle, 2015
This program is free software: you can redistribute it and/or modify
it under the terms of the GNU General Public License as published by
the Free Software Foundation, either version 3 of the License, or
any later version.
This program is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
GNU General Public License for more details.
You should have received a copy of the GNU General Public License
along with this program. If not, see <http://www.gnu.org/licenses/>.
----------------------------------------------------------------------
@endverbatim
*/
/**
* Library for interfacing DS18B20 temperature sensor from Dallas semiconductors.
*
* @author Tilen Majerle
* @email tilen@majerle.eu
* @website http://stm32f4-discovery.com
* @link http://stm32f4-discovery.com/2014/05/13-reading-temperature-with-dallas-ds18b20-on-stm32f429-discovery-board/
* @version v2.0
* @ide Keil uVision
* @license GNU GPL v3
*
* |----------------------------------------------------------------------
* | Copyright (C) Tilen Majerle, 2014
* |
* | This program is free software: you can redistribute it and/or modify
* | it under the terms of the GNU General Public License as published by
* | the Free Software Foundation, either version 3 of the License, or
* | any later version.
* |
* | This program is distributed in the hope that it will be useful,
* | but WITHOUT ANY WARRANTY; without even the implied warranty of
* | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* | GNU General Public License for more details.
* |
* | You should have received a copy of the GNU General Public License
* | along with this program. If not, see <http://www.gnu.org/licenses/>.
* |----------------------------------------------------------------------
*
* Version 2.0
* - January 04, 2015
* - New system, supporting OneWire library 2.0
*
* Version 1.1
* - December 06, 2014
* - Now CRC is calculated and checked if data are valid
* - New version of OneWire library is required, download already available on stm32f4-discovery.com
*
* With this you can read temperature, set and get temperature resolution from 9 to 12 bits
* and check if device is DS18B20
*
* Pin for STM32F4xx is the same as set with TM ONEWIRE library.
*/
#ifndef TM_DS18B20_H
#define TM_DS18B20_H 200
/**
* @addtogroup TM_STM32F4xx_Libraries
* @{
*/
/**
* @defgroup TM_DS12820
* @brief Library for interfacing DS18B20 temperature sensor from Dallas semiconductors - http://stm32f4-discovery.com/2014/05/13-reading-temperature-with-dallas-ds18b20-on-stm32f429-discovery-board/
* @{
*
* With this you can read temperature, set and get temperature resolution from 9 to 12 bits and check if device is DS18B20.
*
* Pin for STM32F4xx is the same as set with TM ONEWIRE library.
*
* \par Changelog
*
@verbatim
Version 2.0
- January 04, 2015
- New system, supporting OneWire library 2.0
Version 1.1
- December 06, 2014
- Now CRC is calculated and checked if data are valid
- New version of OneWire library is required, download already available on stm32f4-discovery.com
Version 1.0
- First release
@endverbatim
*
* \par Dependencies
*
@verbatim
- STM32F4xx
- TM ONEWIRE
- TM GPIO
@endverbatim
*/
#include "stm32f4xx.h"
#include "tm_stm32f4_onewire.h"
/* OneWire version check */
#if TM_ONEWIRE_H < 200
#error "Please update TM ONEWIRE LIB, minimum required version is 2.0.0. Download available on stm32f4-discovery.com website"
#endif
/**
* @defgroup TM_DS18B20_Macros
* @brief Library defines
* @{
*/
/* Every onewire chip has different ROM code, but all the same chips has same family code */
/* in case of DS18B20 this is 0x28 and this is first byte of ROM address */
#define DS18B20_FAMILY_CODE 0x28
#define DS18B20_CMD_ALARMSEARCH 0xEC
/* DS18B20 read temperature command */
#define DS18B20_CMD_CONVERTTEMP 0x44 /* Convert temperature */
#define DS18B20_DECIMAL_STEPS_12BIT 0.0625
#define DS18B20_DECIMAL_STEPS_11BIT 0.125
#define DS18B20_DECIMAL_STEPS_10BIT 0.25
#define DS18B20_DECIMAL_STEPS_9BIT 0.5
/* Bits locations for resolution */
#define DS18B20_RESOLUTION_R1 6
#define DS18B20_RESOLUTION_R0 5
/* CRC enabled */
#ifdef DS18B20_USE_CRC
#define DS18B20_DATA_LEN 9
#else
#define DS18B20_DATA_LEN 2
#endif
/**
* @}
*/
/**
* @defgroup TM_DS18B20_Typedefs
* @brief Library Typedefs
* @{
*/
/**
* @brief DS18B0 Resolutions available
*/
typedef enum {
TM_DS18B20_Resolution_9bits = 9, /*!< DS18B20 9 bits resolution */
TM_DS18B20_Resolution_10bits = 10, /*!< DS18B20 10 bits resolution */
TM_DS18B20_Resolution_11bits = 11, /*!< DS18B20 11 bits resolution */
TM_DS18B20_Resolution_12bits = 12 /*!< DS18B20 12 bits resolution */
} TM_DS18B20_Resolution_t;
/**
* @}
*/
/**
* @defgroup TM_DS18B20_Functions
* @brief Library Functions
* @{
*/
/**
* @brief Starts temperature conversion for specific DS18B20 on specific onewire channel
* @param *OneWireStruct: Pointer to @ref TM_OneWire_t working structure (OneWire channel)
* @param *ROM: Pointer to first byte of ROM address for desired DS12B80 device.
* Entire ROM address is 8-bytes long
* @retval 1 if device is DS18B20 or 0 if not
*/
uint8_t TM_DS18B20_Start(TM_OneWire_t* OneWireStruct, uint8_t* ROM);
/**
* @brief Starts temperature conversion for all DS18B20 devices on specific onewire channel
* @note This mode will skip ROM addressing
* @param *OneWireStruct: Pointer to @ref TM_OneWire_t working structure (OneWire channel)
* @retval None
*/
void TM_DS18B20_StartAll(TM_OneWire_t* OneWireStruct);
/**
* @brief Reads temperature from DS18B20
* @param *OneWireStruct: Pointer to @ref TM_OneWire_t working structure (OneWire channel)
* @param *ROM: Pointer to first byte of ROM address for desired DS12B80 device.
* Entire ROM address is 8-bytes long
* @param *destination: Pointer to float variable to store temperature
* @retval Temperature status:
* - 0: Device is not DS18B20 or conversion is not done yet or CRC failed
* - > 0: Temperature is read OK
*/
uint8_t TM_DS18B20_Read(TM_OneWire_t* OneWireStruct, uint8_t* ROM, float* destination);
/**
* @brief Gets resolution for temperature conversion from DS18B20 device
* @param *OneWireStruct: Pointer to @ref TM_OneWire_t working structure (OneWire channel)
* @param *ROM: Pointer to first byte of ROM address for desired DS12B80 device.
* Entire ROM address is 8-bytes long
* @retval Resolution:
* - 0: Device is not DS18B20
* - 9 - 12: Resolution of DS18B20
*/
uint8_t TM_DS18B20_GetResolution(TM_OneWire_t* OneWireStruct, uint8_t* ROM);
/**
* @brief Sets resolution for specific DS18B20 device
* @param *OneWireStruct: Pointer to @ref TM_OneWire_t working structure (OneWire channel)
* @param *ROM: Pointer to first byte of ROM address for desired DS12B80 device.
* Entire ROM address is 8-bytes long
* @param resolution: Resolution for DS18B20 device. This parameter can be a value of @ref TM_DS18B20_Resolution_t enumeration.
* @retval Success status:
* - 0: Device is not DS18B20
* - > 0: Resolution set OK
*/
uint8_t TM_DS18B20_SetResolution(TM_OneWire_t* OneWireStruct, uint8_t* ROM, TM_DS18B20_Resolution_t resolution);
/**
* @brief Checks if device with specific ROM number is DS18B20
* @param *ROM: Pointer to first byte of ROM address for desired DS12B80 device.
* Entire ROM address is 8-bytes long
* @retval Device status
* - 0: Device is not DS18B20
* - > 0: Device is DS18B20
*/
uint8_t TM_DS18B20_Is(uint8_t* ROM);
/**
* @brief Sets high alarm temperature to specific DS18B20 sensor
* @param *OneWireStruct: Pointer to @ref TM_OneWire_t working structure (OneWire channel)
* @param *ROM: Pointer to first byte of ROM address for desired DS12B80 device.
* Entire ROM address is 8-bytes long
* @param temp: integer value for temperature between -55 to 125 degrees
* @retval Success status:
* - 0: Device is not DS18B20
* - > 0: High alarm set OK
*/
uint8_t TM_DS18B20_SetAlarmHighTemperature(TM_OneWire_t* OneWireStruct, uint8_t* ROM, int8_t temp);
/**
* @brief Sets low alarm temperature to specific DS18B20 sensor
* @param *OneWireStruct: Pointer to @ref TM_OneWire_t working structure (OneWire channel)
* @param *ROM: Pointer to first byte of ROM address for desired DS12B80 device.
* Entire ROM address is 8-bytes long
* @param temp: integer value for temperature between -55 to 125 degrees
* @retval Success status:
* - 0: Device is not DS18B20
* - > 0: Low alarm set OK
*/
uint8_t TM_DS18B20_SetAlarmLowTemperature(TM_OneWire_t* OneWireStruct, uint8_t* ROM, int8_t temp);
/**
* @brief Disables alarm temperature for specific DS18B20 sensor
* @param *OneWireStruct: Pointer to @ref TM_OneWire_t working structure (OneWire channel)
* @param *ROM: Pointer to first byte of ROM address for desired DS12B80 device.
* Entire ROM address is 8-bytes long
* @retval Success status:
* - 0: Device is not DS18B20
* - > 0: Alarm disabled OK
*/
uint8_t TM_DS18B20_DisableAlarmTemperature(TM_OneWire_t* OneWireStruct, uint8_t* ROM);
/**
* @brief Searches for devices with alarm flag set
* @param *OneWireStruct: Pointer to @ref TM_OneWire_t working structure (OneWire channel)
* @retval Alarm search status
* - 0: No device found with alarm flag set
* - > 0: Device is found with alarm flag
* @note To get all devices on one onewire channel with alarm flag set, you can do this:
@verbatim
while (TM_DS18B20_AlarmSearch(&OneWireStruct)) {
//Read device ID here
//Print to user device by device
}
@endverbatim
* @retval 1 if any device has flag, otherwise 0
*/
uint8_t TM_DS18B20_AlarmSearch(TM_OneWire_t* OneWireStruct);
/**
* @brief Checks if all DS18B20 sensors are done with temperature conversion
* @param *OneWireStruct: Pointer to @ref TM_OneWire_t working structure (OneWire channel)
* @retval Conversion status
* - 0: Not all devices are done
* - > 0: All devices are done with conversion
*/
uint8_t TM_DS18B20_AllDone(TM_OneWire_t* OneWireStruct);
/**
* @}
*/
/**
* @}
*/
/**
* @}
*/
#endif
|
