-
Notifications
You must be signed in to change notification settings - Fork 6
/
sht4x_i2c.h
375 lines (349 loc) · 13 KB
/
sht4x_i2c.h
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
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
/*
* THIS FILE IS AUTOMATICALLY GENERATED
*
* Generator: sensirion-driver-generator 0.40.0
* Product: sht4x
* Model-Version: 2.1.1
*/
/*
* Copyright (c) 2024, Sensirion AG
* All rights reserved.
*
* Redistribution and use in source and binary forms, with or without
* modification, are permitted provided that the following conditions are met:
*
* * Redistributions of source code must retain the above copyright notice, this
* list of conditions and the following disclaimer.
*
* * Redistributions in binary form must reproduce the above copyright notice,
* this list of conditions and the following disclaimer in the documentation
* and/or other materials provided with the distribution.
*
* * Neither the name of Sensirion AG nor the names of its
* contributors may be used to endorse or promote products derived from
* this software without specific prior written permission.
*
* THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
* AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
* IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
* ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE
* LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
* CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
* SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
* INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
* CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
* ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
* POSSIBILITY OF SUCH DAMAGE.
*/
#ifndef SHT4X_I2C_H
#define SHT4X_I2C_H
#ifdef __cplusplus
extern "C" {
#endif
#include "sensirion_config.h"
#define SHT40_I2C_ADDR_44 0x44
#define SHT40_I2C_ADDR_45 0x45
#define SHT41_I2C_ADDR_44 0x44
#define SHT41_I2C_ADDR_45 0x45
#define SHT45_I2C_ADDR_44 0x44
#define SHT45_I2C_ADDR_45 0x45
typedef enum {
SHT4X_MEASURE_HIGH_PRECISION_TICKS_CMD_ID = 0xfd,
SHT4X_MEASURE_MEDIUM_PRECISION_TICKS_CMD_ID = 0xf6,
SHT4X_MEASURE_LOWEST_PRECISION_TICKS_CMD_ID = 0xe0,
SHT4X_ACTIVATE_HIGHEST_HEATER_POWER_LONG_TICKS_CMD_ID = 0x39,
SHT4X_ACTIVATE_HIGHEST_HEATER_POWER_SHORT_TICKS_CMD_ID = 0x32,
SHT4X_ACTIVATE_MEDIUM_HEATER_POWER_LONG_TICKS_CMD_ID = 0x2f,
SHT4X_ACTIVATE_MEDIUM_HEATER_POWER_SHORT_TICKS_CMD_ID = 0x24,
SHT4X_ACTIVATE_LOWEST_HEATER_POWER_LONG_TICKS_CMD_ID = 0x1e,
SHT4X_ACTIVATE_LOWEST_HEATER_POWER_SHORT_TICKS_CMD_ID = 0x15,
SHT4X_SERIAL_NUMBER_CMD_ID = 0x89,
SHT4X_SOFT_RESET_CMD_ID = 0x94,
} SHT4X_CMD_ID;
/**
* @brief Initialize i2c address of driver
*
* @param[in] i2c_address Used i2c address
*
*/
void sht4x_init(uint8_t i2c_address);
/**
* sht4x_measure_high_precision() - SHT4x command for a single shot
* measurement with high repeatability.
*
* @param temperature Temperature in milli degrees centigrade.
*
* @param humidity Humidity in milli percent relative humidity.
*
* @return 0 on success, an error code otherwise
*/
int16_t sht4x_measure_high_precision(int32_t* temperature, int32_t* humidity);
/**
* sht4x_measure_medium_precision() - SHT4x command for a single shot
* measurement with medium repeatability.
*
* @param temperature Temperature in milli degrees centigrade.
*
* @param humidity Humidity in milli percent relative humidity.
*
* @return 0 on success, an error code otherwise
*/
int16_t sht4x_measure_medium_precision(int32_t* temperature, int32_t* humidity);
/**
* sht4x_measure_lowest_precision() - SHT4x command for a single shot
* measurement with lowest repeatability.
*
* @param temperature Temperature in milli degrees centigrade.
*
* @param humidity Humidity in milli percent relative humidity.
*
* @return 0 on success, an error code otherwise
*/
int16_t sht4x_measure_lowest_precision(int32_t* temperature, int32_t* humidity);
/**
* sht4x_activate_highest_heater_power_long() - SHT4x command to activate
* highest heater power and perform a single shot high precision measurement for
* 1s.
*
* @param temperature Temperature in milli degrees centigrade.
*
* @param humidity Humidity in milli percent relative humidity.
*
* @return 0 on success, an error code otherwise
*/
int16_t sht4x_activate_highest_heater_power_long(int32_t* temperature,
int32_t* humidity);
/**
* sht4x_activate_highest_heater_power_short() - SHT4x command to activate
* highest heater power and perform a single shot high precision measurement for
* 0.1s.
*
* @param temperature Temperature in milli degrees centigrade.
*
* @param humidity Humidity in milli percent relative humidity.
*
* @return 0 on success, an error code otherwise
*/
int16_t sht4x_activate_highest_heater_power_short(int32_t* temperature,
int32_t* humidity);
/**
* sht4x_activate_medium_heater_power_long() - SHT4x command to activate
* medium heater power and perform a single shot high precision measurement for
* 1s.
*
* @param temperature Temperature in milli degrees centigrade.
*
* @param humidity Humidity in milli percent relative humidity.
*
* @return 0 on success, an error code otherwise
*/
int16_t sht4x_activate_medium_heater_power_long(int32_t* temperature,
int32_t* humidity);
/**
* sht4x_activate_medium_heater_power_short() - SHT4x command to activate
* medium heater power and perform a single shot high precision measurement for
* 0.1s.
*
* @param temperature Temperature in milli degrees centigrade.
*
* @param humidity Humidity in milli percent relative humidity.
*
* @return 0 on success, an error code otherwise
*/
int16_t sht4x_activate_medium_heater_power_short(int32_t* temperature,
int32_t* humidity);
/**
* sht4x_activate_lowest_heater_power_long() - SHT4x command to activate
* lowest heater power and perform a single shot high precision measurement for
* 1s.
*
* @param temperature Temperature in milli degrees centigrade.
*
* @param humidity Humidity in milli percent relative humidity.
*
* @return 0 on success, an error code otherwise
*/
int16_t sht4x_activate_lowest_heater_power_long(int32_t* temperature,
int32_t* humidity);
/**
* sht4x_activate_lowest_heater_power_short() - SHT4x command to activate
* lowest heater power and perform a single shot high precision measurement for
* 0.1s.
*
* @param temperature Temperature in milli degrees centigrade.
*
* @param humidity Humidity in milli percent relative humidity.
*
* @return 0 on success, an error code otherwise
*/
int16_t sht4x_activate_lowest_heater_power_short(int32_t* temperature,
int32_t* humidity);
/**
* @brief sht4x_measure_high_precision_ticks
*
* SHT4x command for a single shot measurement with high repeatability.
*
* @param[out] temperature_ticks Temperature ticks. Convert to degrees celsius
* by (175 * value / 65535) - 45
* @param[out] humidity_ticks Humidity ticks. Convert to degrees celsius by (125
* * value / 65535) - 6
*
* @return error_code 0 on success, an error code otherwise.
*/
int16_t sht4x_measure_high_precision_ticks(uint16_t* temperature_ticks,
uint16_t* humidity_ticks);
/**
* @brief sht4x_measure_medium_precision_ticks
*
* SHT4x command for a single shot measurement with medium repeatability.
*
* @param[out] temperature_ticks Temperature ticks. Convert to degrees celsius
* by (175 * value / 65535) - 45
* @param[out] humidity_ticks Humidity ticks. Convert to degrees celsius by (125
* * value / 65535) - 6
*
* @return error_code 0 on success, an error code otherwise.
*/
int16_t sht4x_measure_medium_precision_ticks(uint16_t* temperature_ticks,
uint16_t* humidity_ticks);
/**
* @brief sht4x_measure_lowest_precision_ticks
*
* SHT4x command for a single shot measurement with lowest repeatability.
*
* @param[out] temperature_ticks Temperature ticks. Convert to degrees celsius
* by (175 * value / 65535) - 45
* @param[out] humidity_ticks Humidity ticks. Convert to degrees celsius by (125
* * value / 65535) - 6
*
* @return error_code 0 on success, an error code otherwise.
*/
int16_t sht4x_measure_lowest_precision_ticks(uint16_t* temperature_ticks,
uint16_t* humidity_ticks);
/**
* @brief sht4x_activate_highest_heater_power_long_ticks
*
* SHT4x command to activate highest heater power and perform a single shot high
* precision measurement for 1s.
*
* @param[out] temperature_ticks Temperature ticks. Convert to degrees celsius
* by (175 * value / 65535) - 45
* @param[out] humidity_ticks Humidity ticks. Convert to degrees celsius by (125
* * value / 65535) - 6
*
* @return error_code 0 on success, an error code otherwise.
*/
int16_t
sht4x_activate_highest_heater_power_long_ticks(uint16_t* temperature_ticks,
uint16_t* humidity_ticks);
/**
* @brief sht4x_activate_highest_heater_power_short_ticks
*
* SHT4x command to activate highest heater power and perform a single shot high
* precision measurement for 0.1s.
*
* @param[out] temperature_ticks Temperature ticks. Convert to degrees celsius
* by (175 * value / 65535) - 45
* @param[out] humidity_ticks Humidity ticks. Convert to degrees celsius by (125
* * value / 65535) - 6
*
* @return error_code 0 on success, an error code otherwise.
*/
int16_t
sht4x_activate_highest_heater_power_short_ticks(uint16_t* temperature_ticks,
uint16_t* humidity_ticks);
/**
* @brief sht4x_activate_medium_heater_power_long_ticks
*
* SHT4x command to activate medium heater power and perform a single shot high
* precision measurement for 1s.
*
* @param[out] temperature_ticks Temperature ticks. Convert to degrees celsius
* by (175 * value / 65535) - 45
* @param[out] humidity_ticks Humidity ticks. Convert to degrees celsius by (125
* * value / 65535) - 6
*
* @return error_code 0 on success, an error code otherwise.
*/
int16_t
sht4x_activate_medium_heater_power_long_ticks(uint16_t* temperature_ticks,
uint16_t* humidity_ticks);
/**
* @brief sht4x_activate_medium_heater_power_short_ticks
*
* SHT4x command to activate medium heater power and perform a single shot high
* precision measurement for 0.1s.
*
* @param[out] temperature_ticks Temperature ticks. Convert to degrees celsius
* by (175 * value / 65535) - 45
* @param[out] humidity_ticks Humidity ticks. Convert to degrees celsius by (125
* * value / 65535) - 6
*
* @return error_code 0 on success, an error code otherwise.
*/
int16_t
sht4x_activate_medium_heater_power_short_ticks(uint16_t* temperature_ticks,
uint16_t* humidity_ticks);
/**
* @brief sht4x_activate_lowest_heater_power_long_ticks
*
* SHT4x command to activate lowest heater power and perform a single shot high
* precision measurement for 1s.
*
* @param[out] temperature_ticks Temperature ticks. Convert to degrees celsius
* by (175 * value / 65535) - 45
* @param[out] humidity_ticks Humidity ticks. Convert to degrees celsius by (125
* * value / 65535) - 6
*
* @return error_code 0 on success, an error code otherwise.
*/
int16_t
sht4x_activate_lowest_heater_power_long_ticks(uint16_t* temperature_ticks,
uint16_t* humidity_ticks);
/**
* @brief sht4x_activate_lowest_heater_power_short_ticks
*
* SHT4x command to activate lowest heater power and perform a single shot high
* precision measurement for 0.1s.
*
* @param[out] temperature_ticks Temperature ticks. Convert to degrees celsius
* by (175 * value / 65535) - 45
* @param[out] humidity_ticks Humidity ticks. Convert to degrees celsius by (125
* * value / 65535) - 6
*
* @return error_code 0 on success, an error code otherwise.
*/
int16_t
sht4x_activate_lowest_heater_power_short_ticks(uint16_t* temperature_ticks,
uint16_t* humidity_ticks);
/**
* @brief sht4x_serial_number
*
* Read out the serial number
*
* @param[out] serial_number Unique serial number
*
* @note Each sensor has a unique serial number that is assigned by Sensirion
* during production.It is stored in the one-time-programmable memory and cannot
* be manipulated after production.
*
* @return error_code 0 on success, an error code otherwise.
*/
int16_t sht4x_serial_number(uint32_t* serial_number);
/**
* @brief sht4x_soft_reset
*
* Perform a soft reset.
*
* @note A reset of the sensor can be achieved in three ways: • Soft reset: use
* this function • I2C general call: all devices on the I2C bus are reset by
* sending the command 0x06 to the I2C address 0x00. • Power down (incl.pulling
* SCL and SDA low)
*
* @return error_code 0 on success, an error code otherwise.
*/
int16_t sht4x_soft_reset();
#ifdef __cplusplus
}
#endif
#endif // SHT4X_I2C_H