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@7:5c95614a61ee, 2017-01-24 (annotated)

Committer:
UHSLMarcus
Date:
Tue Jan 24 10:47:38 2017 +0000
Revision:
7:5c95614a61ee
Parent:
6:22c0a7f2ece2
Child:
8:58a36d9218be
ENS210 auto poll and manual env_data functionality added

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