forked from Sensirion/arduino-sht
-
Notifications
You must be signed in to change notification settings - Fork 0
/
SHTSensor.cpp
442 lines (371 loc) · 11.9 KB
/
SHTSensor.cpp
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
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
/*
* Copyright (c) 2018, Sensirion AG <andreas.brauchli@sensirion.com>
* Copyright (c) 2015-2016, Johannes Winkelmann <jw@smts.ch>
* 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 the 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 <COPYRIGHT HOLDER> 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.
*/
#include <inttypes.h>
#include <Arduino.h>
#include "SHTSensor.h"
//
// class SHTSensorDriver
//
SHTSensorDriver::~SHTSensorDriver()
{
}
bool SHTSensorDriver::readSample()
{
return false;
}
//
// class SHTI2cSensor
//
const uint8_t SHTI2cSensor::EXPECTED_DATA_SIZE = 6;
bool SHTI2cSensor::readFromI2c(TwoWire & wire,
uint8_t i2cAddress,
const uint8_t *i2cCommand,
uint8_t commandLength, uint8_t *data,
uint8_t dataLength,
uint8_t duration)
{
wire.beginTransmission(i2cAddress);
for (int i = 0; i < commandLength; ++i) {
if (wire.write(i2cCommand[i]) != 1) {
return false;
}
}
if (wire.endTransmission() != 0) {
return false;
}
delay(duration);
wire.requestFrom(i2cAddress, dataLength);
// check if the same number of bytes are received that are requested.
if (wire.available() != dataLength) {
return false;
}
for (int i = 0; i < dataLength; ++i) {
data[i] = wire.read();
}
return true;
}
uint8_t SHTI2cSensor::crc8(const uint8_t *data, uint8_t len, uint8_t crcInit)
{
// adapted from SHT21 sample code from
// http://www.sensirion.com/en/products/humidity-temperature/download-center/
uint8_t crc = crcInit;
uint8_t byteCtr;
for (byteCtr = 0; byteCtr < len; ++byteCtr) {
crc ^= data[byteCtr];
for (uint8_t bit = 8; bit > 0; --bit) {
if (crc & 0x80) {
crc = (crc << 1) ^ 0x31;
} else {
crc = (crc << 1);
}
}
}
return crc;
}
bool SHTI2cSensor::readSample()
{
uint8_t data[EXPECTED_DATA_SIZE];
uint8_t cmd[mCmd_Size];
cmd[0] = mI2cCommand >> 8;
//is omitted for SHT4x Sensors
cmd[1] = mI2cCommand & 0xff;
if (!readFromI2c(mWire, mI2cAddress, cmd, mCmd_Size, data,
EXPECTED_DATA_SIZE, mDuration)) {
return false;
}
// -- Important: assuming each 2 byte of data is followed by 1 byte of CRC
// check CRC for both RH and T
if (crc8(&data[0], 2) != data[2] || crc8(&data[3], 2) != data[5]) {
return false;
}
// convert to Temperature/Humidity
uint16_t val;
val = (data[0] << 8) + data[1];
mTemperature = mA + mB * (val / mC);
val = (data[3] << 8) + data[4];
mHumidity = mX + mY * (val / mZ);
return true;
}
//
// class SHTC1Sensor
//
class SHTC1Sensor : public SHTI2cSensor
{
public:
SHTC1Sensor(TwoWire & wire)
// clock stretching disabled, high precision, T first
: SHTI2cSensor(0x70, 0x7866, 15, -45, 175, 65535, 0, 100, 65535, 2, wire)
{
}
};
//
// class SHT2xSensor (SHT20, SHT21, SHT25)
//
class SHT2xSensor : public SHTI2cSensor
{
public:
SHT2xSensor(TwoWire &wire)
// clock stretching disabled
: SHTI2cSensor(0x40, // i2cAddress
0xF3F5, // i2cCommand Hi: T, Lo: RH
85, // duration
-46.85, // a (sht_t_poly1)
175.72, // b (sht_t_poly2)
65536.0, // c (sht_t_poly3)
-6.0, // x (sht_h_poly1)
125.0, // y (sht_h_poly2)
65536.0, // z (sht_h_poly3)
1, // cmd_Size
wire)
{
}
bool readSample() override
{
uint8_t data[EXPECTED_DATA_SIZE];
uint8_t cmd[mCmd_Size];
// SHT2x sends T and RH in two separate commands (different to other sensors)
// so we have to spit the command into two bytes and
// have to read from I2C two times with EXPECTED_DATA_SIZE / 2
// Upper byte is T for SHT2x Sensors
cmd[0] = mI2cCommand >> 8;
// Lower byte is RH for SHT2x Sensors
cmd[1] = mI2cCommand & 0xff;
// read T from SHT2x Sensor
if (!readFromI2c(mWire, mI2cAddress, cmd, mCmd_Size, data,
EXPECTED_DATA_SIZE / 2, mDuration)) {
DEBUG_SHT("SHT2x readFromI2c(T) false\n");
return false;
}
// read RH from SHT2x Sensor
if (!readFromI2c(mWire, mI2cAddress, &cmd[1], mCmd_Size, &data[3],
EXPECTED_DATA_SIZE / 2, mDuration)) {
DEBUG_SHT("SHT2x readFromI2c(RH) false\n");
return false;
}
// -- Important: assuming each 2 byte of data is followed by 1 byte of CRC
// check CRC for both RH and T with a crc init value of 0
if (crc8(&data[0], 2, 0) != data[2] || crc8(&data[3], 2, 0) != data[5]) {
DEBUG_SHT("SHT2x crc8 false\n");
return false;
}
// check status bits [1..0] (see datasheet)
// bit 0: not used, bit 1: measurement type (0: temperature, 1 humidity)
if (((data[1] & 0x02) != 0x00) || ((data[4] & 0x02) != 0x02)) {
DEBUG_SHT("SHT2x status bits false\n");
return false;
}
// convert to Temperature/Humidity
uint16_t val;
val = (data[0] << 8) + (data[1] & ~0x03); // get value and clear status bits [1..0]
mTemperature = mA + mB * (val / mC);
val = (data[3] << 8) + (data[4] & ~0x03); // get value and clear status bits [1..0]
mHumidity = mX + mY * (val / mZ);
return true;
}
};
//
// class SHT3xSensor
//
class SHT3xSensor : public SHTI2cSensor
{
private:
static const uint16_t SHT3X_ACCURACY_HIGH = 0x2400;
static const uint16_t SHT3X_ACCURACY_MEDIUM = 0x240b;
static const uint16_t SHT3X_ACCURACY_LOW = 0x2416;
static const uint8_t SHT3X_ACCURACY_HIGH_DURATION = 15;
static const uint8_t SHT3X_ACCURACY_MEDIUM_DURATION = 6;
static const uint8_t SHT3X_ACCURACY_LOW_DURATION = 4;
public:
static const uint8_t SHT3X_I2C_ADDRESS_44 = 0x44;
static const uint8_t SHT3X_I2C_ADDRESS_45 = 0x45;
SHT3xSensor(TwoWire & wire, uint8_t i2cAddress = SHT3X_I2C_ADDRESS_44)
: SHTI2cSensor(i2cAddress, SHT3X_ACCURACY_HIGH,
SHT3X_ACCURACY_HIGH_DURATION,
-45, 175, 65535, 0, 100, 65535, 2, wire)
{
}
virtual bool setAccuracy(SHTSensor::SHTAccuracy newAccuracy)
{
switch (newAccuracy) {
case SHTSensor::SHT_ACCURACY_HIGH:
mI2cCommand = SHT3X_ACCURACY_HIGH;
mDuration = SHT3X_ACCURACY_HIGH_DURATION;
break;
case SHTSensor::SHT_ACCURACY_MEDIUM:
mI2cCommand = SHT3X_ACCURACY_MEDIUM;
mDuration = SHT3X_ACCURACY_MEDIUM_DURATION;
break;
case SHTSensor::SHT_ACCURACY_LOW:
mI2cCommand = SHT3X_ACCURACY_LOW;
mDuration = SHT3X_ACCURACY_LOW_DURATION;
break;
default:
return false;
}
return true;
}
};
//
// class SHT4xSensor
//
class SHT4xSensor : public SHTI2cSensor
{
private:
static const uint16_t SHT4X_ACCURACY_HIGH = 0xFD00;
static const uint16_t SHT4X_ACCURACY_MEDIUM = 0xF600;
static const uint16_t SHT4X_ACCURACY_LOW = 0xE000;
static const uint8_t SHT4X_ACCURACY_HIGH_DURATION = 10;
static const uint8_t SHT4X_ACCURACY_MEDIUM_DURATION = 4;
static const uint8_t SHT4X_ACCURACY_LOW_DURATION = 2;
public:
static const uint8_t SHT4X_I2C_ADDRESS_44 = 0x44;
static const uint8_t SHT4X_I2C_ADDRESS_45 = 0x45;
SHT4xSensor(TwoWire & wire, uint8_t i2cAddress = SHT4X_I2C_ADDRESS_44)
: SHTI2cSensor(i2cAddress, SHT4X_ACCURACY_HIGH,
SHT4X_ACCURACY_HIGH_DURATION,
-45, 175, 65535, -6, 125, 65535, 1, wire)
{
}
virtual bool setAccuracy(SHTSensor::SHTAccuracy newAccuracy)
{
switch (newAccuracy) {
case SHTSensor::SHT_ACCURACY_HIGH:
mI2cCommand = SHT4X_ACCURACY_HIGH;
mDuration = SHT4X_ACCURACY_HIGH_DURATION;
break;
case SHTSensor::SHT_ACCURACY_MEDIUM:
mI2cCommand = SHT4X_ACCURACY_MEDIUM;
mDuration = SHT4X_ACCURACY_MEDIUM_DURATION;
break;
case SHTSensor::SHT_ACCURACY_LOW:
mI2cCommand = SHT4X_ACCURACY_LOW;
mDuration = SHT4X_ACCURACY_LOW_DURATION;
break;
default:
return false;
}
return true;
}
};
//
// class SHT3xAnalogSensor
//
float SHT3xAnalogSensor::readHumidity()
{
float max_adc = (float)((1 << mReadResolutionBits) - 1);
return -12.5f + 125 * (analogRead(mHumidityAdcPin) / max_adc);
}
float SHT3xAnalogSensor::readTemperature()
{
float max_adc = (float)((1 << mReadResolutionBits) - 1);
return -66.875f + 218.75f * (analogRead(mTemperatureAdcPin) / max_adc);
}
//
// class SHTSensor
//
const SHTSensor::SHTSensorType SHTSensor::AUTO_DETECT_SENSORS[] = {
SHT4X, // IMPORTANT: SHT4x needs to be probed before the SHT3x, since they
// share their I2C address, and probing for an SHT3x can cause the
// first reading of and SHT4x to be off.
// see https://github.com/Sensirion/arduino-sht/issues/27
SHT2X,
SHT3X,
SHT3X_ALT,
SHTC1
};
const float SHTSensor::TEMPERATURE_INVALID = NAN;
const float SHTSensor::HUMIDITY_INVALID = NAN;
bool SHTSensor::init(TwoWire & wire)
{
if (mSensor != NULL) {
cleanup();
}
switch(mSensorType) {
case SHT2X:
mSensor = new SHT2xSensor(wire);
break;
case SHT3X:
case SHT85:
mSensor = new SHT3xSensor(wire);
break;
case SHT3X_ALT:
mSensor = new SHT3xSensor(wire, SHT3xSensor::SHT3X_I2C_ADDRESS_45);
break;
case SHTW1:
case SHTW2:
case SHTC1:
case SHTC3:
mSensor = new SHTC1Sensor(wire);
break;
case SHT4X:
mSensor = new SHT4xSensor(wire);
break;
case AUTO_DETECT:
{
bool detected = false;
for (unsigned int i = 0;
i < sizeof(AUTO_DETECT_SENSORS) / sizeof(AUTO_DETECT_SENSORS[0]);
++i) {
mSensorType = AUTO_DETECT_SENSORS[i];
delay(40); // TODO: this was necessary to make SHT4x autodetect work; revisit to find root cause
if (init(wire)) {
detected = true;
break;
}
}
if (!detected) {
cleanup();
}
break;
}
}
// to finish the initialization, attempt to read to make sure the communication works
// Note: readSample() will check for a NULL mSensor in case auto detect failed
return readSample();
}
bool SHTSensor::readSample()
{
if (!mSensor || !mSensor->readSample())
return false;
mTemperature = mSensor->mTemperature;
mHumidity = mSensor->mHumidity;
return true;
}
bool SHTSensor::setAccuracy(SHTAccuracy newAccuracy)
{
if (!mSensor)
return false;
return mSensor->setAccuracy(newAccuracy);
}
void SHTSensor::cleanup()
{
if (mSensor) {
delete mSensor;
mSensor = NULL;
}
}