Steven Cooreman / AMS_CCS811_gas_sensor

simple CCS811 driver

Dependencies:   AMS_ENS210_temp_humid_sensor

Dependents:   TBSense2_Sensor_Demo

Fork of AMS_CCS811_gas_sensor by Marcus Lee

AMS_CCS811.cpp@9:3f0733792717, 2017-01-24 (annotated)

Committer:
UHSLMarcus
Date:
Tue Jan 24 11:32:49 2017 +0000
Revision:
9:3f0733792717
Parent:
8:58a36d9218be
Child:
10:225a71ec316c
removed some printfs

Who changed what in which revision?

UserRevisionLine numberNew contents of line
UHSLMarcus 0:5edbf3550350 1
UHSLMarcus 2:e394671ef5f6 2 #include "AMS_CCS811.h"
UHSLMarcus 0:5edbf3550350 3
UHSLMarcus 0:5edbf3550350 4 AMS_CCS811::AMS_CCS811(I2C * i2c, PinName n_wake_pin) {
UHSLMarcus 5:41e97348e9e7 5 _n_wake_out = new (std::nothrow) DigitalOut(n_wake_pin, 1);
UHSLMarcus 4:a6b8881eae87 6 _i2c = i2c;
UHSLMarcus 0:5edbf3550350 7 }
UHSLMarcus 0:5edbf3550350 8
UHSLMarcus 0:5edbf3550350 9 AMS_CCS811::AMS_CCS811(I2C * i2c, PinName n_wake_pin, I2C * ens210_i2c) {
UHSLMarcus 5:41e97348e9e7 10 _n_wake_out = new (std::nothrow) DigitalOut(n_wake_pin, 1);
UHSLMarcus 0:5edbf3550350 11 _i2c = i2c;
UHSLMarcus 7:5c95614a61ee 12 ens210_i2c_interface(ens210_i2c);
UHSLMarcus 0:5edbf3550350 13 }
UHSLMarcus 0:5edbf3550350 14
UHSLMarcus 1:acfca1d3256d 15 AMS_CCS811::~AMS_CCS811() {
UHSLMarcus 1:acfca1d3256d 16 delete _n_wake_out;
UHSLMarcus 1:acfca1d3256d 17 delete _addr_out;
UHSLMarcus 1:acfca1d3256d 18 delete _int_data;
UHSLMarcus 7:5c95614a61ee 19 delete _ens210;
UHSLMarcus 1:acfca1d3256d 20 }
UHSLMarcus 1:acfca1d3256d 21
UHSLMarcus 1:acfca1d3256d 22 bool AMS_CCS811::init() {
UHSLMarcus 5:41e97348e9e7 23
UHSLMarcus 5:41e97348e9e7 24 bool success = false;
UHSLMarcus 5:41e97348e9e7 25
UHSLMarcus 5:41e97348e9e7 26 _init_errors();
UHSLMarcus 7:5c95614a61ee 27 _init_fractions();
UHSLMarcus 5:41e97348e9e7 28 set_defaults();
UHSLMarcus 5:41e97348e9e7 29
UHSLMarcus 8:58a36d9218be 30 temp_reading = 0;
UHSLMarcus 8:58a36d9218be 31 humid_reading = 0;
UHSLMarcus 8:58a36d9218be 32
UHSLMarcus 5:41e97348e9e7 33 if (_n_wake_out) {
UHSLMarcus 5:41e97348e9e7 34
UHSLMarcus 5:41e97348e9e7 35 int fw_mode = firmware_mode();
UHSLMarcus 5:41e97348e9e7 36
UHSLMarcus 5:41e97348e9e7 37 if (fw_mode == 1) {
UHSLMarcus 5:41e97348e9e7 38 enable_ens210(true);
UHSLMarcus 5:41e97348e9e7 39 success = write_config();
UHSLMarcus 5:41e97348e9e7 40
UHSLMarcus 5:41e97348e9e7 41 } else if (fw_mode == 0) { // is in boot mode, needs to be loaded into app mode
UHSLMarcus 5:41e97348e9e7 42 if (boot_app_start()) // if succesfully writes to app_start, retry init
UHSLMarcus 5:41e97348e9e7 43 init();
UHSLMarcus 5:41e97348e9e7 44 }
UHSLMarcus 5:41e97348e9e7 45 }
UHSLMarcus 5:41e97348e9e7 46 return success;
UHSLMarcus 4:a6b8881eae87 47 }
UHSLMarcus 4:a6b8881eae87 48
UHSLMarcus 4:a6b8881eae87 49 void AMS_CCS811::i2c_interface(I2C * i2c) {
UHSLMarcus 4:a6b8881eae87 50 _i2c = i2c;
UHSLMarcus 4:a6b8881eae87 51 }
UHSLMarcus 4:a6b8881eae87 52
UHSLMarcus 7:5c95614a61ee 53 bool AMS_CCS811::ens210_i2c_interface(I2C * i2c) {
UHSLMarcus 7:5c95614a61ee 54 bool success;
UHSLMarcus 7:5c95614a61ee 55 if (_ens210 == NULL) {
UHSLMarcus 7:5c95614a61ee 56 _ens210 = new (std::nothrow) AMS_ENS210(i2c, true, true);
UHSLMarcus 7:5c95614a61ee 57 if (_ens210 != NULL) {
UHSLMarcus 7:5c95614a61ee 58 if (_ens210->init()) {
UHSLMarcus 7:5c95614a61ee 59 success = _ens210->start();
UHSLMarcus 7:5c95614a61ee 60 }
UHSLMarcus 7:5c95614a61ee 61 }
UHSLMarcus 7:5c95614a61ee 62 } else {
UHSLMarcus 7:5c95614a61ee 63 _ens210->i2c_interface(i2c);
UHSLMarcus 7:5c95614a61ee 64 success = true;
UHSLMarcus 7:5c95614a61ee 65 }
UHSLMarcus 7:5c95614a61ee 66
UHSLMarcus 7:5c95614a61ee 67 if (!success) new_error(CCS811_LIB_ENS210_INIT_ID);
UHSLMarcus 7:5c95614a61ee 68
UHSLMarcus 7:5c95614a61ee 69 return success;
UHSLMarcus 4:a6b8881eae87 70 }
UHSLMarcus 4:a6b8881eae87 71
UHSLMarcus 4:a6b8881eae87 72 bool AMS_CCS811::enable_ens210(bool enable) {
UHSLMarcus 4:a6b8881eae87 73
UHSLMarcus 4:a6b8881eae87 74 _ens210_enabled = false;
UHSLMarcus 7:5c95614a61ee 75 if (_ens210 != NULL) {
UHSLMarcus 7:5c95614a61ee 76 if (_ens210->i2c_interface() != NULL) _ens210_enabled = enable;
UHSLMarcus 7:5c95614a61ee 77 }
UHSLMarcus 4:a6b8881eae87 78 update_ens210_timer();
UHSLMarcus 4:a6b8881eae87 79 return _ens210_enabled;
UHSLMarcus 4:a6b8881eae87 80 }
UHSLMarcus 4:a6b8881eae87 81
UHSLMarcus 4:a6b8881eae87 82 bool AMS_CCS811::ens210_is_enabled() {
UHSLMarcus 7:5c95614a61ee 83 enable_ens210(_ens210_enabled); // Make sure the state is representive
UHSLMarcus 4:a6b8881eae87 84 return _ens210_enabled;
UHSLMarcus 4:a6b8881eae87 85 }
UHSLMarcus 4:a6b8881eae87 86
UHSLMarcus 4:a6b8881eae87 87 void AMS_CCS811::ens210_poll_interval(int poll_ms) {
UHSLMarcus 4:a6b8881eae87 88 _ens210_poll_split = poll_ms;
UHSLMarcus 7:5c95614a61ee 89 enable_ens210(_ens210_enabled); // makes sure the state is representive, and will also update the timer
UHSLMarcus 4:a6b8881eae87 90 }
UHSLMarcus 4:a6b8881eae87 91
UHSLMarcus 4:a6b8881eae87 92 int AMS_CCS811::ens210_poll_interval() {
UHSLMarcus 4:a6b8881eae87 93 return _ens210_poll_split;
UHSLMarcus 1:acfca1d3256d 94 }
UHSLMarcus 1:acfca1d3256d 95
UHSLMarcus 5:41e97348e9e7 96 int AMS_CCS811::firmware_mode() {
UHSLMarcus 5:41e97348e9e7 97 int firmware_result = -1;
UHSLMarcus 5:41e97348e9e7 98
UHSLMarcus 6:22c0a7f2ece2 99 clear_errors();
UHSLMarcus 6:22c0a7f2ece2 100
UHSLMarcus 5:41e97348e9e7 101 read_byte_result read_result = read_status();
UHSLMarcus 5:41e97348e9e7 102 if (read_result.success) {
UHSLMarcus 5:41e97348e9e7 103 firmware_result = (read_result.byte >> 7) & 1;
UHSLMarcus 6:22c0a7f2ece2 104 }
UHSLMarcus 5:41e97348e9e7 105
UHSLMarcus 5:41e97348e9e7 106 return firmware_result;
UHSLMarcus 5:41e97348e9e7 107 }
UHSLMarcus 5:41e97348e9e7 108
UHSLMarcus 1:acfca1d3256d 109 bool AMS_CCS811::mode(OP_MODES mode) {
UHSLMarcus 6:22c0a7f2ece2 110 clear_errors();
UHSLMarcus 6:22c0a7f2ece2 111
UHSLMarcus 1:acfca1d3256d 112 OP_MODES old = _mode; // incase the write fails, to roll back
UHSLMarcus 1:acfca1d3256d 113 _mode = mode;
UHSLMarcus 1:acfca1d3256d 114
UHSLMarcus 1:acfca1d3256d 115 bool success = write_config();
UHSLMarcus 1:acfca1d3256d 116 if (!success)
UHSLMarcus 1:acfca1d3256d 117 _mode = old;
UHSLMarcus 1:acfca1d3256d 118
UHSLMarcus 1:acfca1d3256d 119 return success;
UHSLMarcus 1:acfca1d3256d 120 }
UHSLMarcus 1:acfca1d3256d 121
UHSLMarcus 1:acfca1d3256d 122 AMS_CCS811::OP_MODES AMS_CCS811::mode() {
UHSLMarcus 6:22c0a7f2ece2 123 clear_errors();
UHSLMarcus 6:22c0a7f2ece2 124
UHSLMarcus 5:41e97348e9e7 125 OP_MODES result = INVALID;
UHSLMarcus 1:acfca1d3256d 126
UHSLMarcus 5:41e97348e9e7 127 read_byte_result read_result = read_config();
UHSLMarcus 1:acfca1d3256d 128 if (read_result.success) {
UHSLMarcus 1:acfca1d3256d 129 int mode = (read_result.byte >> 4) & 0b111;
UHSLMarcus 2:e394671ef5f6 130 result = mode > 4 ? INVALID : (OP_MODES)mode;
UHSLMarcus 6:22c0a7f2ece2 131 }
UHSLMarcus 1:acfca1d3256d 132
UHSLMarcus 2:e394671ef5f6 133 return result;
UHSLMarcus 1:acfca1d3256d 134 }
UHSLMarcus 1:acfca1d3256d 135
UHSLMarcus 1:acfca1d3256d 136 bool AMS_CCS811::addr_mode(bool high) {
UHSLMarcus 1:acfca1d3256d 137 _addr_dir = high;
UHSLMarcus 5:41e97348e9e7 138 if (_addr_out != NULL) _addr_out->write(_addr_dir);
UHSLMarcus 1:acfca1d3256d 139
UHSLMarcus 2:e394671ef5f6 140 update_slave_addr();
UHSLMarcus 2:e394671ef5f6 141
UHSLMarcus 1:acfca1d3256d 142 return addr_mode() == high;
UHSLMarcus 1:acfca1d3256d 143 }
UHSLMarcus 1:acfca1d3256d 144
UHSLMarcus 1:acfca1d3256d 145 bool AMS_CCS811::addr_mode() {
UHSLMarcus 1:acfca1d3256d 146 if (_addr_out != NULL) {
UHSLMarcus 5:41e97348e9e7 147 _addr_dir = _addr_out->read();
UHSLMarcus 1:acfca1d3256d 148 }
UHSLMarcus 1:acfca1d3256d 149
UHSLMarcus 1:acfca1d3256d 150 return _addr_dir;
UHSLMarcus 1:acfca1d3256d 151 }
UHSLMarcus 1:acfca1d3256d 152
UHSLMarcus 1:acfca1d3256d 153 bool AMS_CCS811::addr_pin(PinName pin) {
UHSLMarcus 1:acfca1d3256d 154 _addr_out = _addr_out == NULL ? new (std::nothrow) DigitalOut(pin) : new (_addr_out) DigitalOut(pin);
UHSLMarcus 1:acfca1d3256d 155 addr_mode(_addr_dir);
UHSLMarcus 1:acfca1d3256d 156
UHSLMarcus 1:acfca1d3256d 157 return _addr_out != NULL;
UHSLMarcus 1:acfca1d3256d 158 }
UHSLMarcus 1:acfca1d3256d 159
UHSLMarcus 1:acfca1d3256d 160 bool AMS_CCS811::n_wake_pin(PinName pin) {
UHSLMarcus 1:acfca1d3256d 161 _n_wake_out = _n_wake_out == NULL ? new (std::nothrow) DigitalOut(pin) : new (_n_wake_out) DigitalOut(pin);
UHSLMarcus 1:acfca1d3256d 162 return _n_wake_out != NULL;
UHSLMarcus 1:acfca1d3256d 163 }
UHSLMarcus 1:acfca1d3256d 164
UHSLMarcus 2:e394671ef5f6 165 bool AMS_CCS811::env_data(float humid, float temp) {
UHSLMarcus 7:5c95614a61ee 166 char bytes[4];
UHSLMarcus 7:5c95614a61ee 167 if (humid > CCS811_MAX_HUMID) humid = CCS811_MAX_HUMID;
UHSLMarcus 7:5c95614a61ee 168 if (humid < 0) humid = 0;
UHSLMarcus 7:5c95614a61ee 169
UHSLMarcus 7:5c95614a61ee 170 temp += 25;
UHSLMarcus 7:5c95614a61ee 171 if (temp > CCS811_MAX_TEMP) humid = CCS811_MAX_TEMP;
UHSLMarcus 7:5c95614a61ee 172 if (temp < 0) temp = 0;
UHSLMarcus 7:5c95614a61ee 173
UHSLMarcus 7:5c95614a61ee 174 float_to_short(humid, bytes);
UHSLMarcus 7:5c95614a61ee 175 float_to_short(temp, bytes+2);
UHSLMarcus 7:5c95614a61ee 176
UHSLMarcus 7:5c95614a61ee 177 return i2c_write(ENV_DATA, bytes, 4) == 4;
UHSLMarcus 1:acfca1d3256d 178 }
UHSLMarcus 1:acfca1d3256d 179
UHSLMarcus 1:acfca1d3256d 180
UHSLMarcus 5:41e97348e9e7 181 int AMS_CCS811::has_new_data() {
UHSLMarcus 6:22c0a7f2ece2 182
UHSLMarcus 6:22c0a7f2ece2 183 clear_errors();
UHSLMarcus 6:22c0a7f2ece2 184
UHSLMarcus 5:41e97348e9e7 185 int result = -1;
UHSLMarcus 5:41e97348e9e7 186
UHSLMarcus 6:22c0a7f2ece2 187 char meas_mode[1];
UHSLMarcus 6:22c0a7f2ece2 188 if(i2c_read(MEAS_MODE, meas_mode, 1) == 1) { // one read here is quicker than calling read_config() twice
UHSLMarcus 6:22c0a7f2ece2 189
UHSLMarcus 6:22c0a7f2ece2 190 int curr_mode = (meas_mode[0] >> 4) & 0b111;
UHSLMarcus 6:22c0a7f2ece2 191 if (curr_mode < 5) {
UHSLMarcus 6:22c0a7f2ece2 192 if (curr_mode > 0) { // check for all valid modes other than idle
UHSLMarcus 6:22c0a7f2ece2 193 if (((meas_mode[0] >> 3) & 1) == 0) { // check if interrupts are disabled
UHSLMarcus 6:22c0a7f2ece2 194 char status[1];
UHSLMarcus 6:22c0a7f2ece2 195 if (i2c_read(STATUS, status, 1) == 1) // for some reason the status register in ALG_RESULT_DATA is not updated after reading data, however the STATUS register is
UHSLMarcus 6:22c0a7f2ece2 196 result = (status[0] >> 3) & 1;
UHSLMarcus 6:22c0a7f2ece2 197
UHSLMarcus 6:22c0a7f2ece2 198 } else result = 1;
UHSLMarcus 6:22c0a7f2ece2 199
UHSLMarcus 6:22c0a7f2ece2 200 if (result == 1)
UHSLMarcus 6:22c0a7f2ece2 201 if (i2c_read(ALG_RESULT_DATA, _alg_result_data, 8) != 8) result = -1;
UHSLMarcus 6:22c0a7f2ece2 202
UHSLMarcus 6:22c0a7f2ece2 203
UHSLMarcus 6:22c0a7f2ece2 204 } else result = 0; // return 0 when in idle
UHSLMarcus 6:22c0a7f2ece2 205 } else new_error(CCS811_LIB_INV_MODE_ID);
UHSLMarcus 5:41e97348e9e7 206 }
UHSLMarcus 5:41e97348e9e7 207
UHSLMarcus 5:41e97348e9e7 208 return result;
UHSLMarcus 1:acfca1d3256d 209 }
UHSLMarcus 1:acfca1d3256d 210
UHSLMarcus 1:acfca1d3256d 211 uint16_t AMS_CCS811::co2_read() {
UHSLMarcus 6:22c0a7f2ece2 212 return 0 | (_alg_result_data[0] << 8) | _alg_result_data[1];
UHSLMarcus 2:e394671ef5f6 213 }
UHSLMarcus 1:acfca1d3256d 214
UHSLMarcus 1:acfca1d3256d 215 uint16_t AMS_CCS811::tvoc_read() {
UHSLMarcus 6:22c0a7f2ece2 216 return 0 | (_alg_result_data[2] << 8) | _alg_result_data[3];
UHSLMarcus 1:acfca1d3256d 217 }
UHSLMarcus 1:acfca1d3256d 218
UHSLMarcus 1:acfca1d3256d 219 uint16_t AMS_CCS811::raw_read() {
UHSLMarcus 6:22c0a7f2ece2 220 return 0 | (_alg_result_data[6] << 8) | _alg_result_data[7];
UHSLMarcus 1:acfca1d3256d 221 }
UHSLMarcus 1:acfca1d3256d 222
UHSLMarcus 8:58a36d9218be 223 float AMS_CCS811::temp_read() {
UHSLMarcus 8:58a36d9218be 224 return temp_reading;
UHSLMarcus 8:58a36d9218be 225 }
UHSLMarcus 8:58a36d9218be 226
UHSLMarcus 8:58a36d9218be 227 float AMS_CCS811::humid_read() {
UHSLMarcus 8:58a36d9218be 228 return humid_reading;
UHSLMarcus 8:58a36d9218be 229 }
UHSLMarcus 8:58a36d9218be 230
UHSLMarcus 5:41e97348e9e7 231 bool AMS_CCS811::error_status() {
UHSLMarcus 5:41e97348e9e7 232 bool result = false;
UHSLMarcus 5:41e97348e9e7 233
UHSLMarcus 5:41e97348e9e7 234 read_byte_result read_result = read_status();
UHSLMarcus 5:41e97348e9e7 235 if (read_result.success) {
UHSLMarcus 5:41e97348e9e7 236 result = read_result.byte & 1;
UHSLMarcus 5:41e97348e9e7 237 }
UHSLMarcus 5:41e97348e9e7 238
UHSLMarcus 5:41e97348e9e7 239 result = result || (_error_count > 0);
UHSLMarcus 5:41e97348e9e7 240
UHSLMarcus 5:41e97348e9e7 241 return result;
UHSLMarcus 5:41e97348e9e7 242 }
UHSLMarcus 5:41e97348e9e7 243
UHSLMarcus 5:41e97348e9e7 244 AMS_CCS811::ccs811_errors AMS_CCS811::errors() {
UHSLMarcus 5:41e97348e9e7 245 ccs811_errors error_result;
UHSLMarcus 5:41e97348e9e7 246
UHSLMarcus 5:41e97348e9e7 247 char byte[1];
UHSLMarcus 5:41e97348e9e7 248 if (i2c_read(ERROR_ID, byte, 1) == 1) {
UHSLMarcus 5:41e97348e9e7 249 for(int i = 0; i < CCS811_ERR_NUM; i++) {
UHSLMarcus 5:41e97348e9e7 250 if ((byte[0] << i) & 1) {
UHSLMarcus 5:41e97348e9e7 251 error_result.codes[error_result.count++] = i;
UHSLMarcus 5:41e97348e9e7 252 }
UHSLMarcus 5:41e97348e9e7 253 }
UHSLMarcus 5:41e97348e9e7 254 }
UHSLMarcus 5:41e97348e9e7 255 for(int i = 0; i < CCS811_LIB_ERR_NUM; i++) {
UHSLMarcus 5:41e97348e9e7 256 if (_errors[i]) {
UHSLMarcus 5:41e97348e9e7 257 error_result.codes[error_result.count++] = i + CCS811_ERR_NUM;
UHSLMarcus 5:41e97348e9e7 258 }
UHSLMarcus 5:41e97348e9e7 259 }
UHSLMarcus 5:41e97348e9e7 260
UHSLMarcus 5:41e97348e9e7 261 return error_result;
UHSLMarcus 5:41e97348e9e7 262
UHSLMarcus 5:41e97348e9e7 263 }
UHSLMarcus 5:41e97348e9e7 264
UHSLMarcus 5:41e97348e9e7 265 const char * AMS_CCS811::error_string(int err_code){
UHSLMarcus 5:41e97348e9e7 266 static char result[255];
UHSLMarcus 5:41e97348e9e7 267 result[0] = 0;
UHSLMarcus 5:41e97348e9e7 268 if (err_code < CCS811_TOTAL_ERR_NUM && err_code > -1)
UHSLMarcus 5:41e97348e9e7 269 strcpy(result, _error_strings[err_code]);
UHSLMarcus 5:41e97348e9e7 270 else
UHSLMarcus 5:41e97348e9e7 271 sprintf(result, "Invalid Code: %d is out of range (0 - %d)", err_code, CCS811_TOTAL_ERR_NUM-1);
UHSLMarcus 5:41e97348e9e7 272
UHSLMarcus 5:41e97348e9e7 273 return result;
UHSLMarcus 1:acfca1d3256d 274 }
UHSLMarcus 1:acfca1d3256d 275
UHSLMarcus 1:acfca1d3256d 276 bool AMS_CCS811::enable_interupt(bool enable) {
UHSLMarcus 1:acfca1d3256d 277 bool old = _int_data_enabled; // incase the write fails, to roll back
UHSLMarcus 1:acfca1d3256d 278 _int_data_enabled = enable;
UHSLMarcus 1:acfca1d3256d 279
UHSLMarcus 1:acfca1d3256d 280 bool success = write_config();
UHSLMarcus 1:acfca1d3256d 281 if (!success)
UHSLMarcus 1:acfca1d3256d 282 _int_data_enabled = old;
UHSLMarcus 1:acfca1d3256d 283
UHSLMarcus 1:acfca1d3256d 284 return success;
UHSLMarcus 1:acfca1d3256d 285
UHSLMarcus 1:acfca1d3256d 286 }
UHSLMarcus 1:acfca1d3256d 287
UHSLMarcus 5:41e97348e9e7 288 int AMS_CCS811::interupt_enabled() {
UHSLMarcus 5:41e97348e9e7 289 int enabled = -1;
UHSLMarcus 1:acfca1d3256d 290
UHSLMarcus 5:41e97348e9e7 291 read_byte_result read_result = read_config();
UHSLMarcus 1:acfca1d3256d 292 if (read_result.success) {
UHSLMarcus 1:acfca1d3256d 293 enabled = (read_result.byte >> 3) & 1;
UHSLMarcus 6:22c0a7f2ece2 294 }
UHSLMarcus 1:acfca1d3256d 295
UHSLMarcus 2:e394671ef5f6 296 return enabled;
UHSLMarcus 1:acfca1d3256d 297 }
UHSLMarcus 1:acfca1d3256d 298
UHSLMarcus 1:acfca1d3256d 299 bool AMS_CCS811::interrupt_pin(PinName pin) {
UHSLMarcus 1:acfca1d3256d 300 bool success = false;
UHSLMarcus 1:acfca1d3256d 301
UHSLMarcus 2:e394671ef5f6 302 _int_data = _int_data == NULL ? new (std::nothrow) InterruptIn(pin) : new (_int_data) InterruptIn(pin);
UHSLMarcus 1:acfca1d3256d 303 if (_int_data != NULL) {
UHSLMarcus 2:e394671ef5f6 304 _int_data->fall(callback(this, &AMS_CCS811::_isr_data));
UHSLMarcus 1:acfca1d3256d 305 success = true;
UHSLMarcus 1:acfca1d3256d 306 }
UHSLMarcus 1:acfca1d3256d 307
UHSLMarcus 1:acfca1d3256d 308 return success;
UHSLMarcus 1:acfca1d3256d 309 }
UHSLMarcus 0:5edbf3550350 310
UHSLMarcus 0:5edbf3550350 311
UHSLMarcus 0:5edbf3550350 312
UHSLMarcus 1:acfca1d3256d 313
UHSLMarcus 1:acfca1d3256d 314 /** Private **/
UHSLMarcus 1:acfca1d3256d 315
UHSLMarcus 5:41e97348e9e7 316 void AMS_CCS811::set_defaults() {
UHSLMarcus 1:acfca1d3256d 317 if (_mode == NULL)
UHSLMarcus 1:acfca1d3256d 318 _mode = CONFIG_OP_MODE;
UHSLMarcus 1:acfca1d3256d 319 if (_addr_dir == NULL)
UHSLMarcus 1:acfca1d3256d 320 _addr_dir = CONFIG_ADDR_DIR;
UHSLMarcus 1:acfca1d3256d 321 if (_int_data_enabled == NULL)
UHSLMarcus 1:acfca1d3256d 322 _int_data_enabled = CONFIG_INTR;
UHSLMarcus 2:e394671ef5f6 323 if (_ens210_poll_split == NULL)
UHSLMarcus 2:e394671ef5f6 324 _ens210_poll_split = CONFIG_ENS210_POLL;
UHSLMarcus 2:e394671ef5f6 325
UHSLMarcus 5:41e97348e9e7 326 update_slave_addr();
UHSLMarcus 5:41e97348e9e7 327 }
UHSLMarcus 5:41e97348e9e7 328
UHSLMarcus 5:41e97348e9e7 329 void AMS_CCS811::_init_errors() {
UHSLMarcus 5:41e97348e9e7 330 clear_errors();
UHSLMarcus 5:41e97348e9e7 331 /* Sensor errors */
UHSLMarcus 5:41e97348e9e7 332 strcpy(_error_strings[0], CCS811_WRITE_REG_INVALID);
UHSLMarcus 5:41e97348e9e7 333 strcpy(_error_strings[1], CCS811_READ_REG_INVALID);
UHSLMarcus 5:41e97348e9e7 334 strcpy(_error_strings[2], CCS811_MEASMODE_INVALID);
UHSLMarcus 5:41e97348e9e7 335 strcpy(_error_strings[3], CCS811_MAX_RESISTANCE);
UHSLMarcus 5:41e97348e9e7 336 strcpy(_error_strings[4], CCS811_HEATER_FAULT);
UHSLMarcus 5:41e97348e9e7 337 strcpy(_error_strings[5], CCS811_HEATER_SUPPLY);
UHSLMarcus 5:41e97348e9e7 338 strcpy(_error_strings[6], CCS811_RESERVED);
UHSLMarcus 5:41e97348e9e7 339 strcpy(_error_strings[7], CCS811_RESERVED);
UHSLMarcus 5:41e97348e9e7 340 /* Library errors */
UHSLMarcus 5:41e97348e9e7 341 strcpy(_error_strings[CCS811_LIB_N_WAKE_ID+CCS811_ERR_NUM], CCS811_LIB_N_WAKE);
UHSLMarcus 5:41e97348e9e7 342 strcpy(_error_strings[CCS811_LIB_I2C_ID+CCS811_ERR_NUM], CCS811_LIB_I2C);
UHSLMarcus 5:41e97348e9e7 343 strcpy(_error_strings[CCS811_LIB_SLAVE_W_ID+CCS811_ERR_NUM], CCS811_LIB_SLAVE_W);
UHSLMarcus 5:41e97348e9e7 344 strcpy(_error_strings[CCS811_LIB_REG_ADDR_ID+CCS811_ERR_NUM], CCS811_LIB_REG_ADDR);
UHSLMarcus 5:41e97348e9e7 345 strcpy(_error_strings[CCS811_LIB_I2CWRITE_ID+CCS811_ERR_NUM], CCS811_LIB_I2CWRITE);
UHSLMarcus 5:41e97348e9e7 346 strcpy(_error_strings[CCS811_LIB_SLAVE_R_ID+CCS811_ERR_NUM], CCS811_LIB_SLAVE_R);
UHSLMarcus 6:22c0a7f2ece2 347 strcpy(_error_strings[CCS811_LIB_INV_MODE_ID+CCS811_ERR_NUM], CCS811_LIB_INV_MODE);
UHSLMarcus 7:5c95614a61ee 348 strcpy(_error_strings[CCS811_LIB_ENS210_INIT_ID+CCS811_ERR_NUM], CCS811_LIB_ENS210_INIT);
UHSLMarcus 5:41e97348e9e7 349 }
UHSLMarcus 5:41e97348e9e7 350
UHSLMarcus 5:41e97348e9e7 351 void AMS_CCS811::clear_errors() {
UHSLMarcus 5:41e97348e9e7 352 _error_count = 0;
UHSLMarcus 5:41e97348e9e7 353 for (int i = 0; i < CCS811_LIB_ERR_NUM; i++) {
UHSLMarcus 5:41e97348e9e7 354 _errors[i] = false;
UHSLMarcus 5:41e97348e9e7 355 }
UHSLMarcus 5:41e97348e9e7 356 }
UHSLMarcus 5:41e97348e9e7 357
UHSLMarcus 5:41e97348e9e7 358 void AMS_CCS811::new_error(int error_id) {
UHSLMarcus 5:41e97348e9e7 359 if (!_errors[error_id]) {
UHSLMarcus 5:41e97348e9e7 360 _errors[error_id] = true;
UHSLMarcus 5:41e97348e9e7 361 _error_count++;
UHSLMarcus 5:41e97348e9e7 362 }
UHSLMarcus 1:acfca1d3256d 363 }
UHSLMarcus 2:e394671ef5f6 364
UHSLMarcus 4:a6b8881eae87 365 void AMS_CCS811::update_ens210_timer() {
UHSLMarcus 4:a6b8881eae87 366 _ens210_poll_t.detach();
UHSLMarcus 4:a6b8881eae87 367 if (_ens210_enabled)
UHSLMarcus 4:a6b8881eae87 368 _ens210_poll_t.attach_us(callback(this, &AMS_CCS811::ens210_isr), _ens210_poll_split*1000);
UHSLMarcus 4:a6b8881eae87 369 }
UHSLMarcus 4:a6b8881eae87 370
UHSLMarcus 4:a6b8881eae87 371 void AMS_CCS811::ens210_isr() {
UHSLMarcus 8:58a36d9218be 372 temp_reading = ((float)_ens210->temp_read() / 64) - - 273.15;
UHSLMarcus 8:58a36d9218be 373 humid_reading = (float)_ens210->humid_read()/512;
UHSLMarcus 8:58a36d9218be 374 env_data(humid_reading, temp_reading);
UHSLMarcus 7:5c95614a61ee 375 }
UHSLMarcus 7:5c95614a61ee 376
UHSLMarcus 7:5c95614a61ee 377 void AMS_CCS811::_init_fractions() {
UHSLMarcus 7:5c95614a61ee 378
UHSLMarcus 7:5c95614a61ee 379 fractions[0] = 0.5;
UHSLMarcus 7:5c95614a61ee 380 fractions[1] = 0.25;
UHSLMarcus 7:5c95614a61ee 381 fractions[2] = 0.125;
UHSLMarcus 7:5c95614a61ee 382 fractions[3] = 0.0625;
UHSLMarcus 7:5c95614a61ee 383 fractions[4] = 0.03125;
UHSLMarcus 7:5c95614a61ee 384 fractions[5] = 0.015625;
UHSLMarcus 7:5c95614a61ee 385 fractions[6] = 0.0078125;
UHSLMarcus 7:5c95614a61ee 386 fractions[7] = 0.00390625;
UHSLMarcus 7:5c95614a61ee 387 fractions[8] = 0.001953125;
UHSLMarcus 7:5c95614a61ee 388
UHSLMarcus 7:5c95614a61ee 389 }
UHSLMarcus 7:5c95614a61ee 390
UHSLMarcus 7:5c95614a61ee 391 void AMS_CCS811::float_to_short(float in, char * output) {
UHSLMarcus 7:5c95614a61ee 392
UHSLMarcus 7:5c95614a61ee 393 uint8_t int_part = (uint8_t)in;
UHSLMarcus 7:5c95614a61ee 394 float dec_part = in - int_part;
UHSLMarcus 7:5c95614a61ee 395
UHSLMarcus 7:5c95614a61ee 396 uint16_t _short = 0;
UHSLMarcus 7:5c95614a61ee 397 for (int i = 0; i < 9; i++) {
UHSLMarcus 7:5c95614a61ee 398 if (dec_part == 0) break;
UHSLMarcus 7:5c95614a61ee 399 if (dec_part >= fractions[i]) {
UHSLMarcus 7:5c95614a61ee 400 dec_part -= fractions[i];
UHSLMarcus 7:5c95614a61ee 401 _short |= 256 >> i;
UHSLMarcus 7:5c95614a61ee 402 } else USBserialComms.printf("no\r");
UHSLMarcus 7:5c95614a61ee 403 }
UHSLMarcus 7:5c95614a61ee 404
UHSLMarcus 7:5c95614a61ee 405 _short |= int_part << 9;
UHSLMarcus 7:5c95614a61ee 406
UHSLMarcus 7:5c95614a61ee 407 output[0] = _short >> 8;
UHSLMarcus 7:5c95614a61ee 408 output[1] = _short;
UHSLMarcus 4:a6b8881eae87 409 }
UHSLMarcus 4:a6b8881eae87 410
UHSLMarcus 3:782a719f47a5 411 void AMS_CCS811::update_slave_addr() {
UHSLMarcus 5:41e97348e9e7 412 _slave_addr = addr_mode() ? CCS811_SLAVE_ADDR_RAW_H : CCS811_SLAVE_ADDR_RAW_L;
UHSLMarcus 2:e394671ef5f6 413 }
UHSLMarcus 1:acfca1d3256d 414
UHSLMarcus 1:acfca1d3256d 415 void AMS_CCS811::_isr_data() {
UHSLMarcus 6:22c0a7f2ece2 416 has_new_data(); // populate the data array
UHSLMarcus 3:782a719f47a5 417 _isr_data_fp.call();
UHSLMarcus 1:acfca1d3256d 418 }
UHSLMarcus 1:acfca1d3256d 419
UHSLMarcus 1:acfca1d3256d 420 bool AMS_CCS811::write_config() {
UHSLMarcus 3:782a719f47a5 421 char cmd[1] = {0 | (_int_data_enabled << 3) | (_mode << 4)};
UHSLMarcus 5:41e97348e9e7 422 return i2c_write(MEAS_MODE, cmd, 1) == 1;
UHSLMarcus 5:41e97348e9e7 423 }
UHSLMarcus 5:41e97348e9e7 424
UHSLMarcus 5:41e97348e9e7 425 AMS_CCS811::read_byte_result AMS_CCS811::read_config() {
UHSLMarcus 5:41e97348e9e7 426 read_byte_result result;
UHSLMarcus 5:41e97348e9e7 427 char byte[1];
UHSLMarcus 5:41e97348e9e7 428 if (i2c_read(MEAS_MODE, byte, 1) == 1) {
UHSLMarcus 5:41e97348e9e7 429 result.success = true;
UHSLMarcus 5:41e97348e9e7 430 result.byte = byte[0];
UHSLMarcus 5:41e97348e9e7 431 }
UHSLMarcus 5:41e97348e9e7 432 return result;
UHSLMarcus 1:acfca1d3256d 433 }
UHSLMarcus 1:acfca1d3256d 434
UHSLMarcus 5:41e97348e9e7 435 AMS_CCS811::read_byte_result AMS_CCS811::read_status() {
UHSLMarcus 5:41e97348e9e7 436 read_byte_result result;
UHSLMarcus 2:e394671ef5f6 437 char byte[1];
UHSLMarcus 5:41e97348e9e7 438 if (i2c_read(STATUS, byte, 1) == 1) {
UHSLMarcus 2:e394671ef5f6 439 result.success = true;
UHSLMarcus 5:41e97348e9e7 440 result.byte = byte[0];
UHSLMarcus 5:41e97348e9e7 441 }
UHSLMarcus 6:22c0a7f2ece2 442
UHSLMarcus 5:41e97348e9e7 443 return result;
UHSLMarcus 5:41e97348e9e7 444 }
UHSLMarcus 5:41e97348e9e7 445
UHSLMarcus 5:41e97348e9e7 446 bool AMS_CCS811::boot_app_start() {
UHSLMarcus 5:41e97348e9e7 447 bool success = false;
UHSLMarcus 5:41e97348e9e7 448
UHSLMarcus 5:41e97348e9e7 449 if (i2c_write(APP_START, NULL, 0) == 0) {
UHSLMarcus 5:41e97348e9e7 450 wait_ms(70);
UHSLMarcus 5:41e97348e9e7 451 success = true;
UHSLMarcus 2:e394671ef5f6 452 }
UHSLMarcus 2:e394671ef5f6 453
UHSLMarcus 5:41e97348e9e7 454 return success;
UHSLMarcus 2:e394671ef5f6 455 }
UHSLMarcus 2:e394671ef5f6 456
UHSLMarcus 2:e394671ef5f6 457 int AMS_CCS811::i2c_read(char reg_addr, char* output, int len) {
UHSLMarcus 2:e394671ef5f6 458
UHSLMarcus 2:e394671ef5f6 459 int read_count = 0;
UHSLMarcus 2:e394671ef5f6 460 if (_n_wake_out != NULL) { // check nWAKE pin is set
UHSLMarcus 5:41e97348e9e7 461 _n_wake_out->write(0); // Hold low
UHSLMarcus 5:41e97348e9e7 462 wait_us(CCS811_T_AWAKE); // tAWAKE time to allow sensor I2C to wake up
UHSLMarcus 2:e394671ef5f6 463 if (_i2c != NULL) { // check I2C interface is set
UHSLMarcus 2:e394671ef5f6 464 _i2c->start(); // send start condition for write
UHSLMarcus 5:41e97348e9e7 465 if(_i2c->write(CCS811_SLAVE_ADDR_W) == 1) { // write slave address with write bit
UHSLMarcus 2:e394671ef5f6 466 if(_i2c->write(reg_addr) == 1) { // write register address
UHSLMarcus 2:e394671ef5f6 467 _i2c->start(); // send another start condition for read
UHSLMarcus 5:41e97348e9e7 468 if(_i2c->write(CCS811_SLAVE_ADDR_R) == 1) { // write slave address with read bit
UHSLMarcus 2:e394671ef5f6 469 for (int i = 0; i < len; i++) { // read len bytes
UHSLMarcus 2:e394671ef5f6 470 output[i] = _i2c->read(i < len-1 ? 1 : 0); // ack all reads aside from the final one (i == len-1)
UHSLMarcus 2:e394671ef5f6 471 read_count++;
UHSLMarcus 2:e394671ef5f6 472 }
UHSLMarcus 5:41e97348e9e7 473 } else new_error(CCS811_LIB_SLAVE_R_ID);
UHSLMarcus 5:41e97348e9e7 474 } else new_error(CCS811_LIB_REG_ADDR_ID);
UHSLMarcus 5:41e97348e9e7 475 } else new_error(CCS811_LIB_SLAVE_W_ID);
UHSLMarcus 2:e394671ef5f6 476 _i2c->stop(); // send stop condition
UHSLMarcus 5:41e97348e9e7 477 } else new_error(CCS811_LIB_I2C_ID);
UHSLMarcus 5:41e97348e9e7 478 _n_wake_out->write(1); // Set back to high
UHSLMarcus 5:41e97348e9e7 479 wait_us(CCS811_T_DWAKE); // tDWAKE time to allow sensor I2C to sleep
UHSLMarcus 5:41e97348e9e7 480 } else new_error(CCS811_LIB_N_WAKE_ID);
UHSLMarcus 2:e394671ef5f6 481
UHSLMarcus 2:e394671ef5f6 482 return read_count;
UHSLMarcus 2:e394671ef5f6 483 }
UHSLMarcus 2:e394671ef5f6 484
UHSLMarcus 5:41e97348e9e7 485 int AMS_CCS811::i2c_write(char reg_addr, char* input, int len) {
UHSLMarcus 2:e394671ef5f6 486
UHSLMarcus 5:41e97348e9e7 487 int write_count = -1;
UHSLMarcus 2:e394671ef5f6 488 if (_n_wake_out != NULL) { // check nWAKE pin is set
UHSLMarcus 5:41e97348e9e7 489 _n_wake_out->write(0); // Hold low
UHSLMarcus 5:41e97348e9e7 490 wait_us(CCS811_T_AWAKE); // tAWAKE time to allow sensor I2C to wake up
UHSLMarcus 2:e394671ef5f6 491 if (_i2c != NULL) { // check I2C interface is set
UHSLMarcus 2:e394671ef5f6 492 _i2c->start(); // send start condition for write
UHSLMarcus 5:41e97348e9e7 493 if(_i2c->write(CCS811_SLAVE_ADDR_W) == 1) { // write slave address
UHSLMarcus 2:e394671ef5f6 494 if(_i2c->write(reg_addr) == 1) { // write register address
UHSLMarcus 5:41e97348e9e7 495 write_count = 0;
UHSLMarcus 2:e394671ef5f6 496 for (int i = 0; i < len; i++) { // write len bytes
UHSLMarcus 2:e394671ef5f6 497 if(_i2c->write(input[i]) == 1) write_count++; // write each byte, if successful increment count
UHSLMarcus 5:41e97348e9e7 498 else new_error(CCS811_LIB_I2CWRITE_ID);
UHSLMarcus 2:e394671ef5f6 499 }
UHSLMarcus 5:41e97348e9e7 500 } else new_error(CCS811_LIB_REG_ADDR_ID);
UHSLMarcus 5:41e97348e9e7 501 } else new_error(CCS811_LIB_SLAVE_W_ID);
UHSLMarcus 2:e394671ef5f6 502 _i2c->stop(); // send stop condition
UHSLMarcus 5:41e97348e9e7 503 } else new_error(CCS811_LIB_I2C_ID);
UHSLMarcus 5:41e97348e9e7 504 _n_wake_out->write(1); // set back to high
UHSLMarcus 5:41e97348e9e7 505 wait_us(CCS811_T_DWAKE); // tDWAKE time to allow sensor I2C to sleep
UHSLMarcus 5:41e97348e9e7 506 }else new_error(CCS811_LIB_N_WAKE_ID);
UHSLMarcus 2:e394671ef5f6 507
UHSLMarcus 2:e394671ef5f6 508 return write_count;
UHSLMarcus 1:acfca1d3256d 509 }