Support for CCS811 CO2/VOC sensor

Author: user2684

.travis.yml

@@ -490,3 +490,10 @@ jobs:
        - sed -r -i 's/\/\/(#include <sensors\/SensorPN532.h>)/\1/' $SKETCH
        - eval $OTA_CONFIGURATION
        - eval $COMPILE
+    - name: "SensorCCS811"
+      script: 
+       - arduino --install-library "Adafruit CCS811 Library"
+       - sed -r -i 's/\/\/(SensorCCS811 .+)/\1/' $SKETCH
+       - sed -r -i 's/\/\/(#include <sensors\/SensorCCS811.h>)/\1/' $SKETCH
+       - eval $OTA_CONFIGURATION
+       - eval $COMPILE

README.md

@@ -149,6 +149,7 @@ SensorPca9685Rgb         | 2     | Generic RGB-dimmer sensor (S_RGB_LIGHT) used
 SensorPca9685Rgbw        | 2     | Generic RGBW-dimmer sensor (S_RGBW_LIGHT) used to drive RGBW resp. 4-channel pwm output of PCA9685| https://github.com/adafruit/Adafruit-PWM-Servo-Driver-Library
 SensorDSM501A            | 1     | Dust sensor module DSM501A for PM1.0 and PM2.5 particles                                          | -
 SensorPN532              | 1     | PN532 NFC RFID Module                                                                             | https://github.com/elechouse/PN532
+SensorCCS811             | 1     | CCS811 gas/Air Quality sensor. Measure VOC and eCO2                                               | https://github.com/adafruit/Adafruit_CCS811
 
 Those sensors requiring a pin to operate would take it as an argument in the constructor. 
 NodeManager automatically creates all the child_ids, assigning an incremental counter. If you need to set your own child_id, pass it as the last argument to the constructor
@@ -955,6 +956,14 @@ Each sensor class may expose additional methods.
 	bool getCardIsValid();
 ~~~	
 
+* SensorCCS811
+~~~c
+    // [101] set the temperature for calibrating the sensor
+	void setTemperature(float value);
+	// Set to true if the board has a temperature sensor embedded that can be used for calibration (default: false)
+	void setTemperatureSensor(bool value);
+~~~	
+
 ### OTA Configuration
 
 When `NODEMANAGER_OTA_CONFIGURATION` is set to ON the API presented above can be also called remotely through `SensorConfiguration`, which is automatically added to NodeManager. SensorConfiguration exposes by default child id 200 that can be used to interact with the service by sending `V_CUSTOM` type of messages and commands within the payload. For each `REQ` message, the node will respond with a `SET` message if successful. 

examples/Template/Template.ino

@@ -361,6 +361,9 @@ NodeManager. Just uncomment the settings you need and the sensors you want to ad
 //#include <sensors/SensorPN532.h>
 //SensorPN532 pn532;
 
+//#include <sensors/SensorCCS811.h>
+//SensorCCS811 ccs811;
+
 /***********************************
  * Main Sketch
  */

keywords.txt

@@ -217,3 +217,4 @@ SensorPca9685Rgbw	KEYWORD1
 SensorPca9685W	KEYWORD1
 SensorDSM501A	KEYWORD1
 SensorPN532	KEYWORD1
+SensorCCS811	KEYWORD1

sensors/SensorCCS811.h

@@ -0,0 +1,90 @@
+/*
+* The MySensors Arduino library handles the wireless radio link and protocol
+* between your home built sensors/actuators and HA controller of choice.
+* The sensors forms a self healing radio network with optional repeaters. Each
+* repeater and gateway builds a routing tables in EEPROM which keeps track of the
+* network topology allowing messages to be routed to nodes.
+*
+* Created by Henrik Ekblad <[email protected]>
+* Copyright (C) 2013-2017 Sensnology AB
+* Full contributor list: https://github.com/mysensors/Arduino/graphs/contributors
+*
+* Documentation: http://www.mysensors.org
+* Support Forum: http://forum.mysensors.org
+*
+* This program is free software; you can redistribute it and/or
+* modify it under the terms of the GNU General Public License
+* version 2 as published by the Free Software Foundation.
+*/
+#ifndef SensorCCS811_h
+#define SensorCCS811_h
+
+/*
+SensorCCS811
+*/
+
+#include "Adafruit_CCS811.h"
+
+class SensorCCS811: public Sensor {
+protected:
+	Adafruit_CCS811* _ccs = new Adafruit_CCS811();
+	bool _temperature_sensor = false;
+
+public:
+	SensorCCS811(uint8_t child_id = 0): Sensor(-1) {
+		_name = "CCS811";
+		children.allocateBlocks(2);
+		new Child(this,INT,nodeManager.getAvailableChildId(child_id),S_AIR_QUALITY,V_LEVEL,_name);
+		new Child(this,INT,child_id > 0 ? nodeManager.getAvailableChildId(child_id+1) : nodeManager.getAvailableChildId(child_id),S_AIR_QUALITY,V_LEVEL,_name);
+	};
+	
+	// [101] set the temperature for calibrating the sensor
+	void setTemperature(float value) {
+		_ccs->setTempOffset(value - 25.0);
+	};
+	
+	// Set to true if the board has a temperature sensor embedded that can be used for calibration (default: false)
+	void setTemperatureSensor(bool value) {
+		_temperature_sensor = value;
+	};
+	
+	// what to do during setup
+	void onSetup() {
+		// initialize the library
+		if(!_ccs->begin()) debug(PSTR(LOG_SENSOR "%s: KO\n"),_name);
+		if (_temperature_sensor) {
+			// use the on-board temperature sensor for calibration
+			wait(500);
+			setTemperature(_ccs->calculateTemperature());
+		}
+	};
+
+	// what to do during loop
+	void onLoop(Child* child) {
+		if (_ccs->available() && ! _ccs->readData()) {
+			if (child == children.get(1)) {
+				// eCO2
+				child->setValue((int)_ccs->geteCO2());
+			}
+			if (child == children.get(2)) {
+				// TVOC
+				child->setValue((int)_ccs->getTVOC());
+			}
+		} else {
+			debug(PSTR(LOG_SENSOR "%s: ERROR\n"),_name);
+		}
+		// we need to wait otherwise during loop, two consecutive readData() would result in an error
+		wait(500);
+	};
+	
+#if NODEMANAGER_OTA_CONFIGURATION == ON
+	// define what to do when receiving an OTA configuration request
+	void onOTAConfiguration(ConfigurationRequest* request) {
+		switch(request->getFunction()) {
+		case 101: setTemperature(request->getValueFloat()); break;
+		default: return;
+		}
+	};
+#endif
+};
+#endif