-
Notifications
You must be signed in to change notification settings - Fork 0
/
sgp30.c
636 lines (486 loc) · 21 KB
/
sgp30.c
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
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
/*
* This library is based on an Arduino library written for the SPG30
* Arduino Library written by Ciara Jekel @ SparkFun Electronics, June 18th, 2018
* Modified for Simplicity Studio by CGerrish (Gerrikoio) @ June 2021
* Modified @ 27 July 2021 - fixed error in setHumidity function
* https://github.com/sparkfun/SparkFun_SGP30_Arduino_Library
* Original development environment specifics: Arduino IDE 1.8.5
* Modified development environment specifics: Simplicity Studio 5 (Gecko SDK v 3.2)
* SparkFun labored with love to create this code. Feel like supporting open
* source hardware? Buy a board from SparkFun!
* https://www.sparkfun.com/products/14813
* CRC lookup table from Bastian Molkenthin http://www.sunshine2k.de/coding/javascript/crc/crc_js.html
* Copyright (c) 2015 Bastian Molkenthin
* Permission is hereby granted, free of charge, to any person obtaining a copy
* of this software and associated documentation files (the "Software"), to deal
* in the Software without restriction, including without limitation the rights
* to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
* copies of the Software, and to permit persons to whom the Software is
* furnished to do so, subject to the following conditions:
* The above copyright notice and this permission notice shall be included in
* all copies or substantial portions of the Software.
* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
* IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
* FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
* AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
* LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
* OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
* THE SOFTWARE.
*/
#include "sgp30.h"
// ---------------------------------------------------------------------------
// Globals
// ===========================================================================
const uint8_t init_air_quality[2] = {0x20, 0x03};
const uint8_t measure_air_quality[2] = {0x20, 0x08};
const uint8_t get_baseline[2] = {0x20, 0x15};
const uint8_t set_baseline[2] = {0x20, 0x1E};
const uint8_t set_humidity[2] = {0x20, 0x61};
const uint8_t measure_test[2] = {0x20, 0x32};
const uint8_t get_feature_set_version[2] = {0x20, 0x2F};
const uint8_t get_serial_id[2] = {0x36, 0x82};
const uint8_t measure_raw_signals[2] = {0x20, 0x50};
//SGP30's I2C address
const uint8_t SGP30Address = 0x58 <<1;
//Generates CRC8 for SGP30 from lookup table
static uint8_t _CRC8(uint16_t twoBytes);
#ifdef SGP30_LOOKUP_TABLE
//lookup table for CRC8 http://www.sunshine2k.de/coding/javascript/crc/crc_js.html
const uint8_t _CRC8LookupTable[16][16] = {
{0x00, 0x31, 0x62, 0x53, 0xC4, 0xF5, 0xA6, 0x97, 0xB9, 0x88, 0xDB, 0xEA, 0x7D, 0x4C, 0x1F, 0x2E},
{0x43, 0x72, 0x21, 0x10, 0x87, 0xB6, 0xE5, 0xD4, 0xFA, 0xCB, 0x98, 0xA9, 0x3E, 0x0F, 0x5C, 0x6D},
{0x86, 0xB7, 0xE4, 0xD5, 0x42, 0x73, 0x20, 0x11, 0x3F, 0x0E, 0x5D, 0x6C, 0xFB, 0xCA, 0x99, 0xA8},
{0xC5, 0xF4, 0xA7, 0x96, 0x01, 0x30, 0x63, 0x52, 0x7C, 0x4D, 0x1E, 0x2F, 0xB8, 0x89, 0xDA, 0xEB},
{0x3D, 0x0C, 0x5F, 0x6E, 0xF9, 0xC8, 0x9B, 0xAA, 0x84, 0xB5, 0xE6, 0xD7, 0x40, 0x71, 0x22, 0x13},
{0x7E, 0x4F, 0x1C, 0x2D, 0xBA, 0x8B, 0xD8, 0xE9, 0xC7, 0xF6, 0xA5, 0x94, 0x03, 0x32, 0x61, 0x50},
{0xBB, 0x8A, 0xD9, 0xE8, 0x7F, 0x4E, 0x1D, 0x2C, 0x02, 0x33, 0x60, 0x51, 0xC6, 0xF7, 0xA4, 0x95},
{0xF8, 0xC9, 0x9A, 0xAB, 0x3C, 0x0D, 0x5E, 0x6F, 0x41, 0x70, 0x23, 0x12, 0x85, 0xB4, 0xE7, 0xD6},
{0x7A, 0x4B, 0x18, 0x29, 0xBE, 0x8F, 0xDC, 0xED, 0xC3, 0xF2, 0xA1, 0x90, 0x07, 0x36, 0x65, 0x54},
{0x39, 0x08, 0x5B, 0x6A, 0xFD, 0xCC, 0x9F, 0xAE, 0x80, 0xB1, 0xE2, 0xD3, 0x44, 0x75, 0x26, 0x17},
{0xFC, 0xCD, 0x9E, 0xAF, 0x38, 0x09, 0x5A, 0x6B, 0x45, 0x74, 0x27, 0x16, 0x81, 0xB0, 0xE3, 0xD2},
{0xBF, 0x8E, 0xDD, 0xEC, 0x7B, 0x4A, 0x19, 0x28, 0x06, 0x37, 0x64, 0x55, 0xC2, 0xF3, 0xA0, 0x91},
{0x47, 0x76, 0x25, 0x14, 0x83, 0xB2, 0xE1, 0xD0, 0xFE, 0xCF, 0x9C, 0xAD, 0x3A, 0x0B, 0x58, 0x69},
{0x04, 0x35, 0x66, 0x57, 0xC0, 0xF1, 0xA2, 0x93, 0xBD, 0x8C, 0xDF, 0xEE, 0x79, 0x48, 0x1B, 0x2A},
{0xC1, 0xF0, 0xA3, 0x92, 0x05, 0x34, 0x67, 0x56, 0x78, 0x49, 0x1A, 0x2B, 0xBC, 0x8D, 0xDE, 0xEF},
{0x82, 0xB3, 0xE0, 0xD1, 0x46, 0x77, 0x24, 0x15, 0x3B, 0x0A, 0x59, 0x68, 0xFF, 0xCE, 0x9D, 0xAC}};
//Generates CRC8 for SGP30 from lookup table
static uint8_t _CRC8(uint16_t data)
{
uint8_t CRC = 0xFF; //initial value
CRC ^= (uint8_t)(data >> 8); //start with MSB
CRC = _CRC8LookupTable[CRC >> 4][CRC & 0xF]; //look up table [MSnibble][LSnibble]
CRC ^= (uint8_t)data; //use LSB
CRC = _CRC8LookupTable[CRC >> 4][CRC & 0xF]; //look up table [MSnibble][LSnibble]
return CRC;
}
#endif
#ifndef SGP30_LOOKUP_TABLE
//Given an array and a number of bytes, this calculate CRC8 for those bytes
//CRC is only calc'd on the data portion (two bytes) of the four bytes being sent
//From: http://www.sunshine2k.de/articles/coding/crc/understanding_crc.html
//Tested with: http://www.sunshine2k.de/coding/javascript/crc/crc_js.html
//x^8+x^5+x^4+1 = 0x31
static uint8_t _CRC8(uint16_t data)
{
uint8_t crc = 0xFF; //Init with 0xFF
crc ^= (data >> 8); // XOR-in the first input byte
for (uint8_t i = 0; i < 8; i++)
{
if ((crc & 0x80) != 0)
crc = (uint8_t)((crc << 1) ^ 0x31);
else
crc <<= 1;
}
crc ^= (uint8_t)data; // XOR-in the last input byte
for (uint8_t i = 0; i < 8; i++)
{
if ((crc & 0x80) != 0)
crc = (uint8_t)((crc << 1) ^ 0x31);
else
crc <<= 1;
}
return crc; //No output reflection
}
#endif
//Initialises sensor for air quality readings
//measureAirQuality should be called in 1 second intervals after this function
SGP30ERR initAirQuality(void)
{
I2C_TransferSeq_TypeDef seq;
I2C_TransferReturn_TypeDef ret;
uint8_t i2c_read_data[1];
// Initialising I2C transferSGP30_I2C_ADDRESS
seq.addr = (uint16_t)(SGP30Address);
seq.flags = I2C_FLAG_WRITE;
seq.buf[0].data = (uint8_t*)init_air_quality;
seq.buf[0].len = 2;
/* Select length of data to be read */
seq.buf[1].data = i2c_read_data;
seq.buf[1].len = 0;
// Do a polled transfer
ret = I2C_TransferInit(sl_i2cspm_mikroe, &seq);
while (ret == i2cTransferInProgress)
{
ret = I2C_Transfer(sl_i2cspm_mikroe);
}
if(ret != i2cTransferDone) return SGP30_ERR_I2C_TIMEOUT;
else return SGP30_SUCCESS;
}
//Measure air quality
//Call in regular intervals of 1 second to maintain dynamic baseline calculations
//CO2 returned in ppm, Total Volatile Organic Compounds (TVOC) returned in ppb
//Will give fixed values of CO2=400 and TVOC=0 for first 15 seconds after init
//Returns SGP30_SUCCESS if successful or other error code if unsuccessful
SGP30ERR measureAirQuality(uint16_t* CO2, uint16_t* TVOC)
{
I2C_TransferSeq_TypeDef seq;
I2C_TransferReturn_TypeDef ret;
uint8_t i2c_read_data[1];
// Initialising I2C transferSGP30_I2C_ADDRESS
seq.addr = (uint16_t)(SGP30Address);
seq.flags = I2C_FLAG_WRITE;
seq.buf[0].data = (uint8_t*)measure_air_quality;
seq.buf[0].len = 2;
/* Select length of data to be read */
seq.buf[1].data = i2c_read_data;
seq.buf[1].len = 0;
// Do a polled transfer
ret = I2C_TransferInit(sl_i2cspm_mikroe, &seq);
while (ret == i2cTransferInProgress)
{
ret = I2C_Transfer(sl_i2cspm_mikroe);
}
if(ret != i2cTransferDone) return SGP30_ERR_I2C_TIMEOUT;
//Hang out while measurement is taken. datasheet says 10-12ms
sl_sleeptimer_delay_millisecond(11);
//Comes back in 6 bytes, CO2 data(MSB) / data(LSB) / Checksum / TVOC data(MSB) / data(LSB) / Checksum
uint8_t rx_buff[6];
seq.flags = I2C_FLAG_READ;
seq.buf[0].data = rx_buff;
seq.buf[0].len = 6;
// Do a polled transfer
ret = I2C_TransferInit(sl_i2cspm_mikroe, &seq);
while (ret == i2cTransferInProgress)
{
ret = I2C_Transfer(sl_i2cspm_mikroe);
}
if(ret != i2cTransferDone) return SGP30_ERR_I2C_TIMEOUT;
uint16_t _CO2 = rx_buff[0] << 8 | rx_buff[1]; //store MSB then LSB in CO2
uint8_t checkSum = rx_buff[2]; //verify checksum
if (checkSum != _CRC8(_CO2)) return SGP30_ERR_BAD_CRC; //checksum failed
uint16_t _TVOC = rx_buff[3] << 8 | rx_buff[4]; //store MSB & LSB in TVOC
checkSum = rx_buff[5]; //verify checksum
if (checkSum != _CRC8(_TVOC)) return SGP30_ERR_BAD_CRC; //checksum failed
*CO2 = _CO2; //publish valid data
*TVOC = _TVOC; //publish valid data
return SGP30_SUCCESS;
}
//Returns the current calculated baseline from
//the sensor's dynamic baseline calculations
//Save baseline periodically to non volatile memory
//(like EEPROM) to restore after new power up or
//after soft reset using setBaseline();
//Returns SGP30_SUCCESS if successful or other error code if unsuccessful
SGP30ERR getBaseline(uint16_t* baselineCO2, uint16_t* baselineTVOC)
{
I2C_TransferSeq_TypeDef seq;
I2C_TransferReturn_TypeDef ret;
uint8_t i2c_read_data[1];
// Initialising I2C transferSGP30_I2C_ADDRESS
seq.addr = (uint16_t)(SGP30Address);
seq.flags = I2C_FLAG_WRITE;
seq.buf[0].data = (uint8_t*)get_baseline;
seq.buf[0].len = 2;
/* Select length of data to be read */
seq.buf[1].data = i2c_read_data;
seq.buf[1].len = 0;
// Do a polled transfer
ret = I2C_TransferInit(sl_i2cspm_mikroe, &seq);
while (ret == i2cTransferInProgress)
{
ret = I2C_Transfer(sl_i2cspm_mikroe);
}
if(ret != i2cTransferDone) return SGP30_ERR_I2C_TIMEOUT;
//Hang out while measurement is taken. datasheet says 10ms (11ms to be sure)
sl_sleeptimer_delay_millisecond(11);
uint8_t rx_buff[6];
seq.flags = I2C_FLAG_READ;
seq.buf[0].data = rx_buff;
seq.buf[0].len = 6;
// Do a polled transfer
ret = I2C_TransferInit(sl_i2cspm_mikroe, &seq);
while (ret == i2cTransferInProgress)
{
ret = I2C_Transfer(sl_i2cspm_mikroe);
}
if(ret != i2cTransferDone) return SGP30_ERR_I2C_TIMEOUT;
uint16_t _baselineCO2 = rx_buff[0] << 8 | rx_buff[1]; //store MSB then LSB in _baselineCO2
uint8_t checkSum = rx_buff[2]; //verify checksum
if (checkSum != _CRC8(_baselineCO2)) return SGP30_ERR_BAD_CRC; //checksum failed
uint16_t _baselineTVOC = rx_buff[3] | rx_buff[4]; //store MSB & LSB in _baselineTVOC
checkSum = rx_buff[5]; //verify checksum
if (checkSum != _CRC8(_baselineTVOC)) return SGP30_ERR_BAD_CRC; //checksum failed
*baselineCO2 = _baselineCO2; //publish valid data
*baselineTVOC = _baselineTVOC; //publish valid data
return SGP30_SUCCESS;
}
//Updates the baseline to a previous baseline
//Should only use with previously retrieved baselines
//to maintain accuracy
SGP30ERR setBaseline(uint16_t baselineCO2, uint16_t baselineTVOC)
{
I2C_TransferSeq_TypeDef seq;
I2C_TransferReturn_TypeDef ret;
uint8_t TXbuff[6];
TXbuff[0] = baselineTVOC >> 8; //write baseline TVOC MSB
TXbuff[1] = baselineTVOC; //write baseline TVOC MSB
TXbuff[2] = _CRC8(baselineTVOC); //write checksum TVOC baseline
TXbuff[3] = baselineCO2 >> 8; //write baseline TVOC MSB
TXbuff[4] = baselineCO2; //write baseline TVOC MSB
TXbuff[5] = _CRC8(baselineCO2); //write checksum TVOC baseline
// Initialising I2C transferSGP30_I2C_ADDRESS
seq.addr = (uint16_t)(SGP30Address);
seq.flags = I2C_FLAG_WRITE_WRITE;
seq.buf[0].data = (uint8_t*)set_baseline;
seq.buf[0].len = 2;
seq.buf[1].data = TXbuff;
seq.buf[1].len = 6;
// Do a polled transfer
ret = I2C_TransferInit(sl_i2cspm_mikroe, &seq);
while (ret == i2cTransferInProgress)
{
ret = I2C_Transfer(sl_i2cspm_mikroe);
}
if(ret != i2cTransferDone) return SGP30_ERR_I2C_TIMEOUT;
return SGP30_SUCCESS;
}
//Set humidity
//humidity value is a fixed point 8.8 bit number
//Value should be absolute humidity from humidity sensor
//default value 0x0F80 = 15.5g/m^3
//minimum value 0x0001 = 1/256g/m^3
//maximum value 0xFFFF = 255+255/256 g/m^3
//sending 0x0000 resets to default and turns off humidity compensation
SGP30ERR setHumidity(uint16_t humidity)
{
I2C_TransferSeq_TypeDef seq;
I2C_TransferReturn_TypeDef ret;
uint8_t TXbuff[3];
TXbuff[0] = humidity >> 8; //write humidity MSB
TXbuff[1] = humidity; //write humidity LSB
TXbuff[2] = _CRC8(humidity); //write checksum humidity
// Initialising I2C transferSGP30_I2C_ADDRESS
seq.addr = (uint16_t)(SGP30Address);
seq.flags = I2C_FLAG_WRITE_WRITE;
seq.buf[0].data = (uint8_t*)set_humidity;
seq.buf[0].len = 2;
seq.buf[1].data = TXbuff;
seq.buf[1].len = 3;
// Do a polled transfer
ret = I2C_TransferInit(sl_i2cspm_mikroe, &seq);
while (ret == i2cTransferInProgress)
{
ret = I2C_Transfer(sl_i2cspm_mikroe);
}
if(ret != i2cTransferDone) return SGP30_ERR_I2C_TIMEOUT;
return SGP30_SUCCESS;
}
//gives feature set version number (see data sheet)
//Returns SGP30_SUCCESS if successful or other error code if unsuccessful
SGP30ERR getFeatureSetVersion(uint16_t* featureSetVersion)
{
I2C_TransferSeq_TypeDef seq;
I2C_TransferReturn_TypeDef ret;
uint8_t i2c_read_data[1];
// Initialising I2C transferSGP30_I2C_ADDRESS
seq.addr = (uint16_t)(SGP30Address);
seq.flags = I2C_FLAG_WRITE;
seq.buf[0].data = (uint8_t*)get_feature_set_version;
seq.buf[0].len = 2;
/* Select length of data to be read */
seq.buf[1].data = i2c_read_data;
seq.buf[1].len = 0;
// Do a polled transfer
ret = I2C_TransferInit(sl_i2cspm_mikroe, &seq);
while (ret == i2cTransferInProgress)
{
ret = I2C_Transfer(sl_i2cspm_mikroe);
}
if(ret != i2cTransferDone) return SGP30_ERR_I2C_TIMEOUT;
//Hang out while measurement is taken. datasheet says 1-2ms
sl_sleeptimer_delay_millisecond(2);
uint8_t rx_buff[3];
seq.flags = I2C_FLAG_READ;
seq.buf[0].data = rx_buff;
seq.buf[0].len = 3;
// Do a polled transfer
ret = I2C_TransferInit(sl_i2cspm_mikroe, &seq);
while (ret == i2cTransferInProgress)
{
ret = I2C_Transfer(sl_i2cspm_mikroe);
}
if(ret != i2cTransferDone) return SGP30_ERR_I2C_TIMEOUT;
uint16_t _featureSetVersion = rx_buff[0] << 8 | rx_buff[1]; //store MSB & LSB in featureSetVerison
uint8_t checkSum = rx_buff[2]; //verify checksum
if (checkSum != _CRC8(_featureSetVersion)) return SGP30_ERR_BAD_CRC; //checksum failed
*featureSetVersion = _featureSetVersion; //publish valid data
return SGP30_SUCCESS;
}
//Intended for part verification and testing
//these raw signals are used as inputs to the onchip calibrations and algorithms
//Returns SUCCESS if successful or other error code if unsuccessful
SGP30ERR measureRawSignals(uint16_t* H2, uint16_t* ethanol)
{
I2C_TransferSeq_TypeDef seq;
I2C_TransferReturn_TypeDef ret;
uint8_t i2c_read_data[1];
// Initialising I2C transferSGP30_I2C_ADDRESS
seq.addr = (uint16_t)(SGP30Address);
seq.flags = I2C_FLAG_WRITE;
seq.buf[0].data = (uint8_t*)measure_raw_signals;
seq.buf[0].len = 2;
/* Select length of data to be read */
seq.buf[1].data = i2c_read_data;
seq.buf[1].len = 0;
// Do a polled transfer
ret = I2C_TransferInit(sl_i2cspm_mikroe, &seq);
while (ret == i2cTransferInProgress)
{
ret = I2C_Transfer(sl_i2cspm_mikroe);
}
if(ret != i2cTransferDone) return SGP30_ERR_I2C_TIMEOUT;
//Hang out while measurement is taken. datasheet says 20-25ms
sl_sleeptimer_delay_millisecond(25);
uint8_t rx_buff[6];
seq.flags = I2C_FLAG_READ;
seq.buf[0].data = rx_buff;
seq.buf[0].len = 6;
// Do a polled transfer
ret = I2C_TransferInit(sl_i2cspm_mikroe, &seq);
while (ret == i2cTransferInProgress)
{
ret = I2C_Transfer(sl_i2cspm_mikroe);
}
if(ret != i2cTransferDone) return SGP30_ERR_I2C_TIMEOUT;
uint16_t _H2 = rx_buff[0] << 8 | rx_buff[1]; //store MSB + LSB in _H2
uint8_t checkSum = rx_buff[2]; //verify checksum
if (checkSum != _CRC8(_H2)) return SGP30_ERR_BAD_CRC; //checksumfailed
uint16_t _ethanol = rx_buff[3] << 8 | rx_buff[4]; //store MSB + LSB in ethanol
checkSum = rx_buff[5]; //verify checksum
if (checkSum != _CRC8(_ethanol)) return SGP30_ERR_BAD_CRC; //checksum failed
*H2 = _H2; //publish valid data
*ethanol = _ethanol; //publish valid data
return SGP30_SUCCESS;
}
//Soft reset - not device specific
//will reset all devices that support general call mode
void generalCallReset(void)
{
I2C_TransferSeq_TypeDef seq;
I2C_TransferReturn_TypeDef ret;
uint8_t i2c_read_data[1];
// Initialising I2C transferSGP30_I2C_ADDRESS
seq.addr = 0x0000; // this is a general call address
seq.flags = I2C_FLAG_WRITE;
seq.buf[0].data = (uint8_t*)0x06; // the soft reset command
seq.buf[0].len = 1;
/* Select length of data to be read */
seq.buf[1].data = i2c_read_data;
seq.buf[1].len = 0;
// Do a polled transfer
ret = I2C_TransferInit(sl_i2cspm_mikroe, &seq);
while (ret == i2cTransferInProgress)
{
ret = I2C_Transfer(sl_i2cspm_mikroe);
}
}
//readout of serial ID register can identify chip and verify sensor presence
//Returns SGP30_SUCCESS if successful or other error code if unsuccessful
SGP30ERR getSerialID(uint64_t* serialID)
{
I2C_TransferSeq_TypeDef seq;
I2C_TransferReturn_TypeDef ret;
uint8_t i2c_read_data[1];
// Initialising I2C transferSGP30_I2C_ADDRESS
seq.addr = (uint16_t)(SGP30Address);
seq.flags = I2C_FLAG_WRITE;
seq.buf[0].data = (uint8_t*)get_serial_id;
seq.buf[0].len = 2;
/* Select length of data to be read */
seq.buf[1].data = i2c_read_data;
seq.buf[1].len = 0;
// Do a polled transfer
ret = I2C_TransferInit(sl_i2cspm_mikroe, &seq);
while (ret == i2cTransferInProgress)
{
ret = I2C_Transfer(sl_i2cspm_mikroe);
}
if(ret != i2cTransferDone) return SGP30_ERR_I2C_TIMEOUT;
//Hang out while measurement is taken. datasheet says 1ms
sl_sleeptimer_delay_millisecond(1);
uint8_t rx_buff[9];
seq.flags = I2C_FLAG_READ;
seq.buf[0].data = rx_buff;
seq.buf[0].len = 9;
// Do a polled transfer
ret = I2C_TransferInit(sl_i2cspm_mikroe, &seq);
while (ret == i2cTransferInProgress)
{
ret = I2C_Transfer(sl_i2cspm_mikroe);
}
if(ret != i2cTransferDone) return SGP30_ERR_I2C_TIMEOUT;
//Comes back in 9 bytes, H2 data(MSB) / data(LSB) / Checksum / ethanol data(MSB) / data(LSB) / Checksum
uint16_t _serialID1 = rx_buff[0] << 8 | rx_buff[1]; //store MSB + LSB to top of _serialID1
uint8_t checkSum1 = rx_buff[2]; //verify checksum
if (checkSum1 != _CRC8(_serialID1)) return SGP30_ERR_BAD_CRC; //checksum failed
uint16_t _serialID2 = rx_buff[3] << 8 | rx_buff[4]; //store next MSB + LSB bytes to top of _serialID2
uint8_t checkSum2 = rx_buff[5]; //verify checksum
if (checkSum2 != _CRC8(_serialID2)) return SGP30_ERR_BAD_CRC; //checksum failed
uint16_t _serialID3 = rx_buff[6] << 8 | rx_buff[7]; //store next byte MSB + LSB to top of _serialID3
uint8_t checkSum3 = rx_buff[8]; //verify checksum
if (checkSum3 != _CRC8(_serialID3)) return SGP30_ERR_BAD_CRC; //checksum failed
*serialID = ((uint64_t)_serialID1 << 32) + ((uint64_t)_serialID2 << 16) + ((uint64_t)_serialID3); //publish valid data
return SGP30_SUCCESS;
}
//Sensor runs on chip self test
//Returns SGP30_SUCCESS if successful or other error code if unsuccessful
SGP30ERR measureTest(void)
{
I2C_TransferSeq_TypeDef seq;
I2C_TransferReturn_TypeDef ret;
uint8_t i2c_read_data[1];
// Initialising I2C transferSGP30_I2C_ADDRESS
seq.addr = (uint16_t)(SGP30Address);
seq.flags = I2C_FLAG_WRITE;
seq.buf[0].data = (uint8_t*)measure_test;
seq.buf[0].len = 2;
/* Select length of data to be read */
seq.buf[1].data = i2c_read_data;
seq.buf[1].len = 0;
// Do a polled transfer
ret = I2C_TransferInit(sl_i2cspm_mikroe, &seq);
while (ret == i2cTransferInProgress)
{
ret = I2C_Transfer(sl_i2cspm_mikroe);
}
if(ret != i2cTransferDone) return SGP30_ERR_I2C_TIMEOUT;
//Hang out while measurement is taken. datasheet says 200-220ms
sl_sleeptimer_delay_millisecond(220);
uint8_t rx_buff[3];
seq.flags = I2C_FLAG_READ;
seq.buf[0].data = rx_buff;
seq.buf[0].len = 3;
// Do a polled transfer
ret = I2C_TransferInit(sl_i2cspm_mikroe, &seq);
while (ret == i2cTransferInProgress)
{
ret = I2C_Transfer(sl_i2cspm_mikroe);
}
if(ret != i2cTransferDone) return SGP30_ERR_I2C_TIMEOUT;
//Comes back in 3 bytes, data(MSB) / data(LSB) / Checksum
uint16_t results = rx_buff[0] << 8 | rx_buff[1]; //store MSB + LSB in results
uint8_t checkSum = rx_buff[2]; //verify checksum
if (checkSum != _CRC8(results)) return SGP30_ERR_BAD_CRC; //checksum failed
if (results != 0xD400) return SGP30_SELF_TEST_FAIL; //self test results incorrect
return SGP30_SUCCESS;
}