/
bme680.c
1105 lines (957 loc) · 35.1 KB
/
bme680.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
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
/**\mainpage
* Copyright (C) 2017 - 2018 Bosch Sensortec GmbH
*
* 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 copyright holder nor the names of the
* 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
* 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
*
* The information provided is believed to be accurate and reliable.
* The copyright holder assumes no responsibility
* for the consequences of use
* of such information nor for any infringement of patents or
* other rights of third parties which may result from its use.
* No license is granted by implication or otherwise under any patent or
* patent rights of the copyright holder.
*
* File bme680.c
* @date 5 Jul 2017
* @version 3.5.1
*
*/
/*! @file bme680.c
@brief Sensor driver for BME680 sensor */
#include "bme680.h"
/**static variables */
/**Look up table for the possible gas range values */
uint32_t lookupTable1[16] = { UINT32_C(2147483647), UINT32_C(2147483647), UINT32_C(2147483647), UINT32_C(2147483647),
UINT32_C(2147483647), UINT32_C(2126008810), UINT32_C(2147483647), UINT32_C(2130303777), UINT32_C(2147483647),
UINT32_C(2147483647), UINT32_C(2143188679), UINT32_C(2136746228), UINT32_C(2147483647), UINT32_C(2126008810),
UINT32_C(2147483647), UINT32_C(2147483647) };
/**Look up table for the possible gas range values */
uint32_t lookupTable2[16] = { UINT32_C(4096000000), UINT32_C(2048000000), UINT32_C(1024000000), UINT32_C(512000000),
UINT32_C(255744255), UINT32_C(127110228), UINT32_C(64000000), UINT32_C(32258064), UINT32_C(16016016), UINT32_C(
8000000), UINT32_C(4000000), UINT32_C(2000000), UINT32_C(1000000), UINT32_C(500000), UINT32_C(250000),
UINT32_C(125000) };
/*!
* @brief This internal API is used to read the calibrated data from the sensor.
*
* This function is used to retrieve the calibration
* data from the image registers of the sensor.
*
* @note Registers 89h to A1h for calibration data 1 to 24
* from bit 0 to 7
* @note Registers E1h to F0h for calibration data 25 to 40
* from bit 0 to 7
* @param[in] dev :Structure instance of bme680_dev.
*
* @return Result of API execution status.
* @retval zero -> Success / +ve value -> Warning / -ve value -> Error
*/
static int8_t get_calib_data(struct bme680_dev *dev);
/*!
* @brief This internal API is used to set the gas configuration of the sensor.
*
* @param[in] dev :Structure instance of bme680_dev.
*
* @return Result of API execution status.
* @retval zero -> Success / +ve value -> Warning / -ve value -> Error
*/
static int8_t set_gas_config(struct bme680_dev *dev);
/*!
* @brief This internal API is used to get the gas configuration of the sensor.
*
* @param[in] dev :Structure instance of bme680_dev.
*
* @return Result of API execution status.
* @retval zero -> Success / +ve value -> Warning / -ve value -> Error
*/
static int8_t get_gas_config(struct bme680_dev *dev);
/*!
* @brief This internal API is used to calculate the Heat duration value.
*
* @param[in] dur :Value of the duration to be shared.
*
* @return uint8_t threshold duration after calculation.
*/
static uint8_t calc_heater_dur(uint16_t dur);
/*!
* @brief This internal API is used to calculate the temperature value.
*
* @param[in] dev :Structure instance of bme680_dev.
* @param[in] temp_adc :Contains the temperature ADC value .
*
* @return uint32_t calculated temperature.
*/
static int16_t calc_temperature(uint32_t temp_adc, struct bme680_dev *dev);
/*!
* @brief This internal API is used to calculate the pressure value.
*
* @param[in] dev :Structure instance of bme680_dev.
* @param[in] pres_adc :Contains the pressure ADC value .
*
* @return uint32_t calculated pressure.
*/
static uint32_t calc_pressure(uint32_t pres_adc, const struct bme680_dev *dev);
/*!
* @brief This internal API is used to calculate the humidity value.
*
* @param[in] dev :Structure instance of bme680_dev.
* @param[in] hum_adc :Contains the humidity ADC value.
*
* @return uint32_t calculated humidity.
*/
static uint32_t calc_humidity(uint16_t hum_adc, const struct bme680_dev *dev);
/*!
* @brief This internal API is used to calculate the Gas Resistance value.
*
* @param[in] dev :Structure instance of bme680_dev.
* @param[in] gas_res_adc :Contains the Gas Resistance ADC value.
* @param[in] gas_range :Contains the range of gas values.
*
* @return uint32_t calculated gas resistance.
*/
static uint32_t calc_gas_resistance(uint16_t gas_res_adc, uint8_t gas_range, const struct bme680_dev *dev);
/*!
* @brief This internal API is used to calculate the Heat Resistance value.
*
* @param[in] dev :Structure instance of bme680_dev.
* @param[in] temp :Contains the temporary value.
*
* @return uint8_t calculated heater resistance.
*/
static uint8_t calc_heater_res(uint16_t temp, const struct bme680_dev *dev);
/*!
* @brief This internal API is used to calculate the field data of sensor.
*
* @param[out] data :Structure instance to hold the data
* @param[in] dev :Structure instance of bme680_dev.
*
* @return int8_t result of the field data from sensor.
*/
static int8_t read_field_data(struct bme680_field_data *data, struct bme680_dev *dev);
/*!
* @brief This internal API is used to set the memory page
* based on register address.
*
* The value of memory page
* value | Description
* --------|--------------
* 0 | BME680_PAGE0_SPI
* 1 | BME680_PAGE1_SPI
*
* @param[in] dev :Structure instance of bme680_dev.
* @param[in] reg_addr :Contains the register address array.
*
* @return Result of API execution status
* @retval zero -> Success / +ve value -> Warning / -ve value -> Error
*/
static int8_t set_mem_page(uint8_t reg_addr, struct bme680_dev *dev);
/*!
* @brief This internal API is used to get the memory page based
* on register address.
*
* The value of memory page
* value | Description
* --------|--------------
* 0 | BME680_PAGE0_SPI
* 1 | BME680_PAGE1_SPI
*
* @param[in] dev :Structure instance of bme680_dev.
*
* @return Result of API execution status
* @retval zero -> Success / +ve value -> Warning / -ve value -> Error
*/
static int8_t get_mem_page(struct bme680_dev *dev);
/*!
* @brief This internal API is used to validate the device pointer for
* null conditions.
*
* @param[in] dev :Structure instance of bme680_dev.
*
* @return Result of API execution status
* @retval zero -> Success / +ve value -> Warning / -ve value -> Error
*/
static int8_t null_ptr_check(const struct bme680_dev *dev);
/*!
* @brief This internal API is used to check the boundary
* conditions.
*
* @param[in] value :pointer to the value.
* @param[in] min :minimum value.
* @param[in] max :maximum value.
* @param[in] dev :Structure instance of bme680_dev.
*
* @return Result of API execution status
* @retval zero -> Success / +ve value -> Warning / -ve value -> Error
*/
static int8_t boundary_check(uint8_t *value, uint8_t min, uint8_t max, struct bme680_dev *dev);
/****************** Global Function Definitions *******************************/
/*!
*@brief This API is the entry point.
*It reads the chip-id and calibration data from the sensor.
*/
int8_t bme680_init(struct bme680_dev *dev)
{
int8_t rslt;
/* Check for null pointer in the device structure*/
rslt = null_ptr_check(dev);
if (rslt == BME680_OK)
{
/* Soft reset to restore it to default values*/
rslt = bme680_soft_reset(dev);
if (rslt == BME680_OK) {
rslt = bme680_get_regs(BME680_CHIP_ID_ADDR, &dev->chip_id, 1, dev);
if (rslt == BME680_OK) {
if (dev->chip_id == BME680_CHIP_ID) {
rslt = get_calib_data(dev);
} else {
rslt = BME680_E_DEV_NOT_FOUND;
}
}
}
}
return rslt;
}
/*!
* @brief This API reads the data from the given register address of the sensor.
*/
int8_t bme680_get_regs(uint8_t reg_addr, uint8_t *reg_data, uint16_t len, struct bme680_dev *dev)
{
int8_t rslt;
/* Check for null pointer in the device structure*/
rslt = null_ptr_check(dev);
if (rslt == BME680_OK) {
if (dev->intf == BME680_SPI_INTF) {
/* Set the memory page */
rslt = set_mem_page(reg_addr, dev);
if (rslt == BME680_OK)
reg_addr = reg_addr | BME680_SPI_RD_MSK;
}
dev->com_rslt = dev->read(dev->dev_id, reg_addr, reg_data, len);
if (dev->com_rslt != 0)
rslt = BME680_E_COM_FAIL;
}
return rslt;
}
/*!
* @brief This API writes the given data to the register address
* of the sensor.
*/
int8_t bme680_set_regs(const uint8_t *reg_addr, const uint8_t *reg_data, uint8_t len, struct bme680_dev *dev)
{
int8_t rslt;
/* Length of the temporary buffer is 2*(length of register)*/
uint8_t tmp_buff[BME680_TMP_BUFFER_LENGTH] = { 0 };
uint16_t index;
/* Check for null pointer in the device structure*/
rslt = null_ptr_check(dev);
if (rslt == BME680_OK) {
if ((len > 0) && (len < BME680_TMP_BUFFER_LENGTH / 2)) {
/* Interleave the 2 arrays */
for (index = 0; index < len; index++) {
if (dev->intf == BME680_SPI_INTF) {
/* Set the memory page */
rslt = set_mem_page(reg_addr[index], dev);
tmp_buff[(2 * index)] = reg_addr[index] & BME680_SPI_WR_MSK;
} else {
tmp_buff[(2 * index)] = reg_addr[index];
}
tmp_buff[(2 * index) + 1] = reg_data[index];
}
/* Write the interleaved array */
if (rslt == BME680_OK) {
dev->com_rslt = dev->write(dev->dev_id, tmp_buff[0], &tmp_buff[1], (2 * len) - 1);
if (dev->com_rslt != 0)
rslt = BME680_E_COM_FAIL;
}
} else {
rslt = BME680_E_INVALID_LENGTH;
}
}
return rslt;
}
/*!
* @brief This API performs the soft reset of the sensor.
*/
int8_t bme680_soft_reset(struct bme680_dev *dev)
{
int8_t rslt;
uint8_t reg_addr = BME680_SOFT_RESET_ADDR;
/* 0xb6 is the soft reset command */
uint8_t soft_rst_cmd = BME680_SOFT_RESET_CMD;
/* Check for null pointer in the device structure*/
rslt = null_ptr_check(dev);
if (rslt == BME680_OK) {
if (dev->intf == BME680_SPI_INTF)
rslt = get_mem_page(dev);
/* Reset the device */
if (rslt == BME680_OK) {
rslt = bme680_set_regs(®_addr, &soft_rst_cmd, 1, dev);
/* Wait for 5ms */
dev->delay_ms(BME680_RESET_PERIOD);
if (rslt == BME680_OK) {
/* After reset get the memory page */
if (dev->intf == BME680_SPI_INTF)
rslt = get_mem_page(dev);
}
}
}
return rslt;
}
/*!
* @brief This API is used to set the oversampling, filter and T,P,H, gas selection
* settings in the sensor.
*/
int8_t bme680_set_sensor_settings(uint16_t desired_settings, struct bme680_dev *dev)
{
int8_t rslt;
uint8_t reg_addr;
uint8_t data = 0;
uint8_t count = 0;
uint8_t reg_array[BME680_REG_BUFFER_LENGTH] = { 0 };
uint8_t data_array[BME680_REG_BUFFER_LENGTH] = { 0 };
uint8_t intended_power_mode = dev->power_mode; /* Save intended power mode */
/* Check for null pointer in the device structure*/
rslt = null_ptr_check(dev);
if (rslt == BME680_OK) {
if (desired_settings & BME680_GAS_MEAS_SEL)
rslt = set_gas_config(dev);
dev->power_mode = BME680_SLEEP_MODE;
if (rslt == BME680_OK)
rslt = bme680_set_sensor_mode(dev);
/* Selecting the filter */
if (desired_settings & BME680_FILTER_SEL) {
rslt = boundary_check(&dev->tph_sett.filter, BME680_FILTER_SIZE_0, BME680_FILTER_SIZE_127, dev);
reg_addr = BME680_CONF_ODR_FILT_ADDR;
if (rslt == BME680_OK)
rslt = bme680_get_regs(reg_addr, &data, 1, dev);
if (desired_settings & BME680_FILTER_SEL)
data = BME680_SET_BITS(data, BME680_FILTER, dev->tph_sett.filter);
reg_array[count] = reg_addr; /* Append configuration */
data_array[count] = data;
count++;
}
/* Selecting heater control for the sensor */
if (desired_settings & BME680_HCNTRL_SEL) {
rslt = boundary_check(&dev->gas_sett.heatr_ctrl, BME680_ENABLE_HEATER, BME680_DISABLE_HEATER, dev);
reg_addr = BME680_CONF_HEAT_CTRL_ADDR;
if (rslt == BME680_OK)
rslt = bme680_get_regs(reg_addr, &data, 1, dev);
data = BME680_SET_BITS_POS_0(data, BME680_HCTRL, dev->gas_sett.heatr_ctrl);
reg_array[count] = reg_addr; /* Append configuration */
data_array[count] = data;
count++;
}
/* Selecting heater T,P oversampling for the sensor */
if (desired_settings & (BME680_OST_SEL | BME680_OSP_SEL)) {
rslt = boundary_check(&dev->tph_sett.os_temp, BME680_OS_NONE, BME680_OS_16X, dev);
reg_addr = BME680_CONF_T_P_MODE_ADDR;
if (rslt == BME680_OK)
rslt = bme680_get_regs(reg_addr, &data, 1, dev);
if (desired_settings & BME680_OST_SEL)
data = BME680_SET_BITS(data, BME680_OST, dev->tph_sett.os_temp);
if (desired_settings & BME680_OSP_SEL)
data = BME680_SET_BITS(data, BME680_OSP, dev->tph_sett.os_pres);
reg_array[count] = reg_addr;
data_array[count] = data;
count++;
}
/* Selecting humidity oversampling for the sensor */
if (desired_settings & BME680_OSH_SEL) {
rslt = boundary_check(&dev->tph_sett.os_hum, BME680_OS_NONE, BME680_OS_16X, dev);
reg_addr = BME680_CONF_OS_H_ADDR;
if (rslt == BME680_OK)
rslt = bme680_get_regs(reg_addr, &data, 1, dev);
data = BME680_SET_BITS_POS_0(data, BME680_OSH, dev->tph_sett.os_hum);
reg_array[count] = reg_addr; /* Append configuration */
data_array[count] = data;
count++;
}
/* Selecting the runGas and NB conversion settings for the sensor */
if (desired_settings & (BME680_RUN_GAS_SEL | BME680_NBCONV_SEL)) {
rslt = boundary_check(&dev->gas_sett.run_gas, BME680_RUN_GAS_DISABLE, BME680_RUN_GAS_ENABLE, dev);
if (rslt == BME680_OK)
rslt = boundary_check(&dev->gas_sett.nb_conv, BME680_NBCONV_MIN, BME680_NBCONV_MAX, dev);
reg_addr = BME680_CONF_ODR_RUN_GAS_NBC_ADDR;
if (rslt == BME680_OK)
rslt = bme680_get_regs(reg_addr, &data, 1, dev);
if (desired_settings & BME680_RUN_GAS_SEL)
data = BME680_SET_BITS(data, BME680_RUN_GAS, dev->gas_sett.run_gas);
if (desired_settings & BME680_NBCONV_SEL)
data = BME680_SET_BITS_POS_0(data, BME680_NBCONV, dev->gas_sett.nb_conv);
reg_array[count] = reg_addr; /* Append configuration */
data_array[count] = data;
count++;
}
if (rslt == BME680_OK)
rslt = bme680_set_regs(reg_array, data_array, count, dev);
/* Restore previous intended power mode */
dev->power_mode = intended_power_mode;
}
return rslt;
}
/*!
* @brief This API is used to get the oversampling, filter and T,P,H, gas selection
* settings in the sensor.
*/
int8_t bme680_get_sensor_settings(uint16_t desired_settings, struct bme680_dev *dev)
{
int8_t rslt;
/* starting address of the register array for burst read*/
uint8_t reg_addr = BME680_CONF_HEAT_CTRL_ADDR;
uint8_t data_array[BME680_REG_BUFFER_LENGTH] = { 0 };
/* Check for null pointer in the device structure*/
rslt = null_ptr_check(dev);
if (rslt == BME680_OK) {
rslt = bme680_get_regs(reg_addr, data_array, BME680_REG_BUFFER_LENGTH, dev);
if (rslt == BME680_OK) {
if (desired_settings & BME680_GAS_MEAS_SEL)
rslt = get_gas_config(dev);
/* get the T,P,H ,Filter,ODR settings here */
if (desired_settings & BME680_FILTER_SEL)
dev->tph_sett.filter = BME680_GET_BITS(data_array[BME680_REG_FILTER_INDEX], BME680_FILTER);
if (desired_settings & (BME680_OST_SEL | BME680_OSP_SEL)) {
dev->tph_sett.os_temp = BME680_GET_BITS(data_array[BME680_REG_TEMP_INDEX], BME680_OST);
dev->tph_sett.os_pres = BME680_GET_BITS(data_array[BME680_REG_PRES_INDEX], BME680_OSP);
}
if (desired_settings & BME680_OSH_SEL)
dev->tph_sett.os_hum = BME680_GET_BITS_POS_0(data_array[BME680_REG_HUM_INDEX], BME680_OSH);
/* get the gas related settings */
if (desired_settings & BME680_HCNTRL_SEL)
dev->gas_sett.heatr_ctrl = BME680_GET_BITS_POS_0(data_array[BME680_REG_HCTRL_INDEX], BME680_HCTRL);
if (desired_settings & (BME680_RUN_GAS_SEL | BME680_NBCONV_SEL)) {
dev->gas_sett.nb_conv = BME680_GET_BITS_POS_0(data_array[BME680_REG_NBCONV_INDEX], BME680_NBCONV);
dev->gas_sett.run_gas = BME680_GET_BITS(data_array[BME680_REG_RUN_GAS_INDEX], BME680_RUN_GAS);
}
}
} else {
rslt = BME680_E_NULL_PTR;
}
return rslt;
}
/*!
* @brief This API is used to set the power mode of the sensor.
*/
int8_t bme680_set_sensor_mode(struct bme680_dev *dev)
{
int8_t rslt;
uint8_t tmp_pow_mode;
uint8_t pow_mode = 0;
uint8_t reg_addr = BME680_CONF_T_P_MODE_ADDR;
/* Check for null pointer in the device structure*/
rslt = null_ptr_check(dev);
if (rslt == BME680_OK) {
/* Call recursively until in sleep */
do {
rslt = bme680_get_regs(BME680_CONF_T_P_MODE_ADDR, &tmp_pow_mode, 1, dev);
if (rslt == BME680_OK) {
/* Put to sleep before changing mode */
pow_mode = (tmp_pow_mode & BME680_MODE_MSK);
if (pow_mode != BME680_SLEEP_MODE) {
tmp_pow_mode = tmp_pow_mode & (~BME680_MODE_MSK); /* Set to sleep */
rslt = bme680_set_regs(®_addr, &tmp_pow_mode, 1, dev);
dev->delay_ms(BME680_POLL_PERIOD_MS);
}
}
} while (pow_mode != BME680_SLEEP_MODE);
/* Already in sleep */
if (dev->power_mode != BME680_SLEEP_MODE) {
tmp_pow_mode = (tmp_pow_mode & ~BME680_MODE_MSK) | (dev->power_mode & BME680_MODE_MSK);
if (rslt == BME680_OK)
rslt = bme680_set_regs(®_addr, &tmp_pow_mode, 1, dev);
}
}
return rslt;
}
/*!
* @brief This API is used to get the power mode of the sensor.
*/
int8_t bme680_get_sensor_mode(struct bme680_dev *dev)
{
int8_t rslt;
uint8_t mode;
/* Check for null pointer in the device structure*/
rslt = null_ptr_check(dev);
if (rslt == BME680_OK) {
rslt = bme680_get_regs(BME680_CONF_T_P_MODE_ADDR, &mode, 1, dev);
/* Masking the other register bit info*/
dev->power_mode = mode & BME680_MODE_MSK;
}
return rslt;
}
/*!
* @brief This API is used to set the profile duration of the sensor.
*/
void bme680_set_profile_dur(uint16_t duration, struct bme680_dev *dev)
{
uint32_t tph_dur; /* Calculate in us */
/* TPH measurement duration */
tph_dur = ((uint32_t) (dev->tph_sett.os_temp + dev->tph_sett.os_pres + dev->tph_sett.os_hum) * UINT32_C(1963));
tph_dur += UINT32_C(477 * 4); /* TPH switching duration */
tph_dur += UINT32_C(477 * 5); /* Gas measurement duration */
tph_dur += UINT32_C(500); /* Get it to the closest whole number.*/
tph_dur /= UINT32_C(1000); /* Convert to ms */
tph_dur += UINT32_C(1); /* Wake up duration of 1ms */
/* The remaining time should be used for heating */
dev->gas_sett.heatr_dur = duration - (uint16_t) tph_dur;
}
/*!
* @brief This API is used to get the profile duration of the sensor.
*/
void bme680_get_profile_dur(uint16_t *duration, struct bme680_dev *dev)
{
uint32_t tph_dur; /* Calculate in us */
/* TPH measurement duration */
tph_dur = ((uint32_t) (dev->tph_sett.os_temp + dev->tph_sett.os_pres + dev->tph_sett.os_hum) * UINT32_C(1963));
tph_dur += UINT32_C(477 * 4); /* TPH switching duration */
tph_dur += UINT32_C(477 * 5); /* Gas measurement duration */
tph_dur += UINT32_C(500); /* Get it to the closest whole number.*/
tph_dur /= UINT32_C(1000); /* Convert to ms */
tph_dur += UINT32_C(1); /* Wake up duration of 1ms */
/* The remaining time should be used for heating */
*duration = dev->gas_sett.heatr_dur + (uint16_t) tph_dur;
}
/*!
* @brief This API reads the pressure, temperature and humidity and gas data
* from the sensor, compensates the data and store it in the bme680_data
* structure instance passed by the user.
*/
int8_t bme680_get_sensor_data(struct bme680_field_data *data, struct bme680_dev *dev)
{
int8_t rslt;
/* Check for null pointer in the device structure*/
rslt = null_ptr_check(dev);
if (rslt == BME680_OK) {
/* Reading the sensor data in forced mode only */
rslt = read_field_data(data, dev);
if (rslt == BME680_OK) {
if (data->status & BME680_NEW_DATA_MSK)
dev->new_fields = 1;
else
dev->new_fields = 0;
}
}
return rslt;
}
/*!
* @brief This internal API is used to read the calibrated data from the sensor.
*/
static int8_t get_calib_data(struct bme680_dev *dev)
{
int8_t rslt;
uint8_t coeff_array[BME680_COEFF_SIZE] = { 0 };
/* Check for null pointer in the device structure*/
rslt = null_ptr_check(dev);
if (rslt == BME680_OK) {
rslt = bme680_get_regs(BME680_COEFF_ADDR1, coeff_array, BME680_COEFF_ADDR1_LEN, dev);
/* Append the second half in the same array */
if (rslt == BME680_OK)
rslt = bme680_get_regs(BME680_COEFF_ADDR2, &coeff_array[BME680_COEFF_ADDR1_LEN], BME680_COEFF_ADDR2_LEN,
dev);
/* Temperature related coefficients */
dev->calib.par_t1 = (uint16_t) (BME680_CONCAT_BYTES(coeff_array[BME680_T1_MSB_REG],
coeff_array[BME680_T1_LSB_REG]));
dev->calib.par_t2 = (int16_t) (BME680_CONCAT_BYTES(coeff_array[BME680_T2_MSB_REG],
coeff_array[BME680_T2_LSB_REG]));
dev->calib.par_t3 = (int8_t) (coeff_array[BME680_T3_REG]);
/* Pressure related coefficients */
dev->calib.par_p1 = (uint16_t) (BME680_CONCAT_BYTES(coeff_array[BME680_P1_MSB_REG],
coeff_array[BME680_P1_LSB_REG]));
dev->calib.par_p2 = (int16_t) (BME680_CONCAT_BYTES(coeff_array[BME680_P2_MSB_REG],
coeff_array[BME680_P2_LSB_REG]));
dev->calib.par_p3 = (int8_t) coeff_array[BME680_P3_REG];
dev->calib.par_p4 = (int16_t) (BME680_CONCAT_BYTES(coeff_array[BME680_P4_MSB_REG],
coeff_array[BME680_P4_LSB_REG]));
dev->calib.par_p5 = (int16_t) (BME680_CONCAT_BYTES(coeff_array[BME680_P5_MSB_REG],
coeff_array[BME680_P5_LSB_REG]));
dev->calib.par_p6 = (int8_t) (coeff_array[BME680_P6_REG]);
dev->calib.par_p7 = (int8_t) (coeff_array[BME680_P7_REG]);
dev->calib.par_p8 = (int16_t) (BME680_CONCAT_BYTES(coeff_array[BME680_P8_MSB_REG],
coeff_array[BME680_P8_LSB_REG]));
dev->calib.par_p9 = (int16_t) (BME680_CONCAT_BYTES(coeff_array[BME680_P9_MSB_REG],
coeff_array[BME680_P9_LSB_REG]));
dev->calib.par_p10 = (uint8_t) (coeff_array[BME680_P10_REG]);
/* Humidity related coefficients */
dev->calib.par_h1 = (uint16_t) (((uint16_t) coeff_array[BME680_H1_MSB_REG] << BME680_HUM_REG_SHIFT_VAL)
| (coeff_array[BME680_H1_LSB_REG] & BME680_BIT_H1_DATA_MSK));
dev->calib.par_h2 = (uint16_t) (((uint16_t) coeff_array[BME680_H2_MSB_REG] << BME680_HUM_REG_SHIFT_VAL)
| ((coeff_array[BME680_H2_LSB_REG]) >> BME680_HUM_REG_SHIFT_VAL));
dev->calib.par_h3 = (int8_t) coeff_array[BME680_H3_REG];
dev->calib.par_h4 = (int8_t) coeff_array[BME680_H4_REG];
dev->calib.par_h5 = (int8_t) coeff_array[BME680_H5_REG];
dev->calib.par_h6 = (uint8_t) coeff_array[BME680_H6_REG];
dev->calib.par_h7 = (int8_t) coeff_array[BME680_H7_REG];
/* Gas heater related coefficients */
dev->calib.par_gh1 = (int8_t) coeff_array[BME680_GH1_REG];
dev->calib.par_gh2 = (int16_t) (BME680_CONCAT_BYTES(coeff_array[BME680_GH2_MSB_REG],
coeff_array[BME680_GH2_LSB_REG]));
dev->calib.par_gh3 = (int8_t) coeff_array[BME680_GH3_REG];
/* Other coefficients */
uint8_t temp_var = 0; /* Temporary variable */
if (rslt == BME680_OK) {
rslt = bme680_get_regs(BME680_ADDR_RES_HEAT_RANGE_ADDR, &temp_var, 1, dev);
dev->calib.res_heat_range = ((temp_var & BME680_RHRANGE_MSK) / 16);
if (rslt == BME680_OK) {
rslt = bme680_get_regs(BME680_ADDR_RES_HEAT_VAL_ADDR, &temp_var, 1, dev);
dev->calib.res_heat_val = (int8_t) temp_var;
if (rslt == BME680_OK)
rslt = bme680_get_regs(BME680_ADDR_RANGE_SW_ERR_ADDR, &temp_var, 1, dev);
}
}
dev->calib.range_sw_err = ((int8_t) temp_var & (int8_t) BME680_RSERROR_MSK) / 16;
}
return rslt;
}
/*!
* @brief This internal API is used to set the gas configuration of the sensor.
*/
static int8_t set_gas_config(struct bme680_dev *dev)
{
int8_t rslt;
/* Check for null pointer in the device structure*/
rslt = null_ptr_check(dev);
if (rslt == BME680_OK) {
uint8_t reg_addr[2], reg_data[2];
if (dev->power_mode == BME680_FORCED_MODE) {
reg_addr[0] = BME680_RES_HEAT0_ADDR;
reg_data[0] = calc_heater_res(dev->gas_sett.heatr_temp, dev);
reg_addr[1] = BME680_GAS_WAIT0_ADDR;
reg_data[1] = calc_heater_dur(dev->gas_sett.heatr_dur);
dev->gas_sett.nb_conv = 0;
} else {
rslt = BME680_W_DEFINE_PWR_MODE;
}
if (rslt == BME680_OK)
rslt = bme680_set_regs(reg_addr, reg_data, 2, dev);
}
return rslt;
}
/*!
* @brief This internal API is used to get the gas configuration of the sensor.
*/
static int8_t get_gas_config(struct bme680_dev *dev)
{
int8_t rslt;
/* starting address of the register array for burst read*/
uint8_t reg_addr1 = BME680_ADDR_SENS_CONF_START;
uint8_t reg_addr2 = BME680_ADDR_GAS_CONF_START;
uint8_t data_array[BME680_GAS_HEATER_PROF_LEN_MAX] = { 0 };
uint8_t index;
/* Check for null pointer in the device structure*/
rslt = null_ptr_check(dev);
if (rslt == BME680_OK) {
if (BME680_SPI_INTF == dev->intf) {
/* Memory page switch the SPI address*/
rslt = set_mem_page(reg_addr1, dev);
}
if (rslt == BME680_OK) {
rslt = bme680_get_regs(reg_addr1, data_array, BME680_GAS_HEATER_PROF_LEN_MAX, dev);
if (rslt == BME680_OK) {
for (index = 0; index < BME680_GAS_HEATER_PROF_LEN_MAX; index++)
dev->gas_sett.heatr_temp = data_array[index];
}
rslt = bme680_get_regs(reg_addr2, data_array, BME680_GAS_HEATER_PROF_LEN_MAX, dev);
if (rslt == BME680_OK) {
for (index = 0; index < BME680_GAS_HEATER_PROF_LEN_MAX; index++)
dev->gas_sett.heatr_dur = data_array[index];
}
}
}
return rslt;
}
/*!
* @brief This internal API is used to calculate the temperature value.
*/
static int16_t calc_temperature(uint32_t temp_adc, struct bme680_dev *dev)
{
int64_t var1;
int64_t var2;
int64_t var3;
int16_t calc_temp;
var1 = ((int32_t) temp_adc / 8) - ((int32_t) dev->calib.par_t1 * 2);
var2 = (var1 * (int32_t) dev->calib.par_t2) / 2048;
var3 = ((var1 / 2) * (var1 / 2)) / 4096;
var3 = ((var3) * ((int32_t) dev->calib.par_t3 * 16)) / 16384;
dev->calib.t_fine = (int32_t) (var2 + var3);
calc_temp = (int16_t) (((dev->calib.t_fine * 5) + 128) / 256);
return calc_temp;
}
/*!
* @brief This internal API is used to calculate the pressure value.
*/
static uint32_t calc_pressure(uint32_t pres_adc, const struct bme680_dev *dev)
{
int32_t var1;
int32_t var2;
int32_t var3;
int32_t calc_pres;
var1 = (((int32_t) dev->calib.t_fine) / 2) - 64000;
var2 = ((var1 / 4) * (var1 / 4)) / 2048;
var2 = ((var2) * (int32_t) dev->calib.par_p6) / 4;
var2 = var2 + ((var1 * (int32_t) dev->calib.par_p5) * 2);
var2 = (var2 / 4) + ((int32_t) dev->calib.par_p4 * 65536);
var1 = ((var1 / 4) * (var1 / 4)) / 8192;
var1 = (((var1) * ((int32_t) dev->calib.par_p3 * 32)) / 8) + (((int32_t) dev->calib.par_p2 * var1) / 2);
var1 = var1 / 262144;
var1 = ((32768 + var1) * (int32_t) dev->calib.par_p1) / 32768;
calc_pres = (int32_t) (1048576 - pres_adc);
calc_pres = (int32_t) ((calc_pres - (var2 / 4096)) * (3125));
calc_pres = ((calc_pres / var1) * 2);
var1 = ((int32_t) dev->calib.par_p9 * (int32_t) (((calc_pres / 8) * (calc_pres / 8)) / 8192)) / 4096;
var2 = ((int32_t) (calc_pres / 4) * (int32_t) dev->calib.par_p8) / 8192;
var3 = ((int32_t) (calc_pres / 256) * (int32_t) (calc_pres / 256) * (int32_t) (calc_pres / 256)
* (int32_t) dev->calib.par_p10) / 131072;
calc_pres = (int32_t) (calc_pres) + ((var1 + var2 + var3 + ((int32_t) dev->calib.par_p7 * 128)) / 16);
return (uint32_t) calc_pres;
}
/*!
* @brief This internal API is used to calculate the humidity value.
*/
static uint32_t calc_humidity(uint16_t hum_adc, const struct bme680_dev *dev)
{
int32_t var1;
int32_t var2;
int32_t var3;
int32_t var4;
int32_t var5;
int32_t var6;
int32_t temp_scaled;
int32_t calc_hum;
temp_scaled = (((int32_t) dev->calib.t_fine * 5) + 128) / 256;
var1 = (int32_t) (hum_adc - ((int32_t) ((int32_t) dev->calib.par_h1 * 16)))
- (((temp_scaled * (int32_t) dev->calib.par_h3) / ((int32_t) 100)) / 2);
var2 = ((int32_t) dev->calib.par_h2
* (((temp_scaled * (int32_t) dev->calib.par_h4) / ((int32_t) 100))
+ (((temp_scaled * ((temp_scaled * (int32_t) dev->calib.par_h5) / ((int32_t) 100))) / 64)
/ ((int32_t) 100)) + (int32_t) (1 * 16384))) / 1024;
var3 = var1 * var2;
var4 = (int32_t) dev->calib.par_h6 * 128;
var4 = ((var4) + ((temp_scaled * (int32_t) dev->calib.par_h7) / ((int32_t) 100))) / 16;
var5 = ((var3 / 16384) * (var3 / 16384)) / 1024;
var6 = (var4 * var5) / 2;
calc_hum = (((var3 + var6) / 1024) * ((int32_t) 1000)) / 4096;
if (calc_hum > 100000) /* Cap at 100%rH */
calc_hum = 100000;
else if (calc_hum < 0)
calc_hum = 0;
return (uint32_t) calc_hum;
}
/*!
* @brief This internal API is used to calculate the Gas Resistance value.
*/
static uint32_t calc_gas_resistance(uint16_t gas_res_adc, uint8_t gas_range, const struct bme680_dev *dev)
{
int64_t var1;
uint64_t var2;
int64_t var3;
uint32_t calc_gas_res;
var1 = (int64_t) ((1340 + (5 * (int64_t) dev->calib.range_sw_err)) * ((int64_t) lookupTable1[gas_range])) / 65536;
var2 = (((int64_t) ((int64_t) gas_res_adc * 32768) - (int64_t) (16777216)) + var1);
var3 = (((int64_t) lookupTable2[gas_range] * (int64_t) var1) / 512);
calc_gas_res = (uint32_t) ((var3 + ((int64_t) var2 / 2)) / (int64_t) var2);
return calc_gas_res;
}
/*!
* @brief This internal API is used to calculate the Heat Resistance value.
*/
static uint8_t calc_heater_res(uint16_t temp, const struct bme680_dev *dev)
{
uint8_t heatr_res;
int32_t var1;
int32_t var2;
int32_t var3;
int32_t var4;
int32_t var5;
int32_t heatr_res_x100;
if (temp < 200) /* Cap temperature */
temp = 200;
else if (temp > 400)
temp = 400;
var1 = (((int32_t) dev->amb_temp * dev->calib.par_gh3) / 1000) * 256;
var2 = (dev->calib.par_gh1 + 784) * (((((dev->calib.par_gh2 + 154009) * temp * 5) / 100) + 3276800) / 10);
var3 = var1 + (var2 / 2);
var4 = (var3 / (dev->calib.res_heat_range + 4));
var5 = (131 * dev->calib.res_heat_val) + 65536;
heatr_res_x100 = (int32_t) (((var4 / var5) - 250) * 34);
heatr_res = (uint8_t) ((heatr_res_x100 + 50) / 100);
return heatr_res;
}
/*!
* @brief This internal API is used to calculate the Heat duration value.
*/
static uint8_t calc_heater_dur(uint16_t dur)
{
uint8_t factor = 0;
uint8_t durval;
if (dur >= 0xfc0) {
durval = 0xff; /* Max duration*/
} else {
while (dur > 0x3F) {
dur = dur / 4;
factor += 1;
}
durval = (uint8_t) (dur + (factor * 64));
}
return durval;
}
/*!
* @brief This internal API is used to calculate the field data of sensor.
*/
static int8_t read_field_data(struct bme680_field_data *data, struct bme680_dev *dev)
{
int8_t rslt;
uint8_t buff[BME680_FIELD_LENGTH] = { 0 };
uint8_t gas_range;
uint32_t adc_temp;
uint32_t adc_pres;
uint16_t adc_hum;
uint16_t adc_gas_res;
uint8_t tries = 10;
/* Check for null pointer in the device structure*/
rslt = null_ptr_check(dev);
do {
if (rslt == BME680_OK) {
rslt = bme680_get_regs(((uint8_t) (BME680_FIELD0_ADDR)), buff, (uint16_t) BME680_FIELD_LENGTH, dev);
data->status = buff[0] & BME680_NEW_DATA_MSK;
data->gas_index = buff[0] & BME680_GAS_INDEX_MSK;
data->meas_index = buff[1];
/* read the raw data from the sensor */
adc_pres = (uint32_t) (((uint32_t) buff[2] * 4096) | ((uint32_t) buff[3] * 16) | ((uint32_t) buff[4] / 16));
adc_temp = (uint32_t) (((uint32_t) buff[5] * 4096) | ((uint32_t) buff[6] * 16) | ((uint32_t) buff[7] / 16));
adc_hum = (uint16_t) (((uint32_t) buff[8] * 256) | (uint32_t) buff[9]);
adc_gas_res = (uint16_t) ((uint32_t) buff[13] * 4 | (((uint32_t) buff[14]) / 64));
gas_range = buff[14] & BME680_GAS_RANGE_MSK;
data->status |= buff[14] & BME680_GASM_VALID_MSK;
data->status |= buff[14] & BME680_HEAT_STAB_MSK;
if (data->status & BME680_NEW_DATA_MSK) {
data->temperature = calc_temperature(adc_temp, dev);
data->pressure = calc_pressure(adc_pres, dev);
data->humidity = calc_humidity(adc_hum, dev);
data->gas_resistance = calc_gas_resistance(adc_gas_res, gas_range, dev);
break;
} else {
dev->delay_ms(BME680_POLL_PERIOD_MS);
}
}
tries--;
} while (tries);
if (!tries)
rslt = BME680_W_NO_NEW_DATA;
return rslt;
}