knx/examples/knx-bme680/knx-bme680.ino

287 lines
11 KiB
Arduino
Raw Normal View History

2019-06-03 22:59:42 +02:00
// used version: BSEC_1.4.7.3_Generic_Release_20190410
// 2 changes needed for version: BSEC_1.4.7.4_Generic_Release see below
2018-10-08 21:51:27 +02:00
#include <bsec.h>
2018-11-07 22:16:00 +01:00
#include <knx.h>
2019-06-02 01:55:26 +02:00
#ifdef ARDUINO_ARCH_ESP8266
#include <WiFiManager.h>
2019-06-02 01:55:26 +02:00
#endif
2018-10-08 21:51:27 +02:00
// create named references for easy access to group objects
#define goRawTemperature knx.getGroupObject(1)
#define goPressure knx.getGroupObject(2)
#define goRawHumidity knx.getGroupObject(3)
#define goGasResistance knx.getGroupObject(4)
#define goIaqEstimate knx.getGroupObject(5)
#define goIaqAccurace knx.getGroupObject(6)
#define goTemperature knx.getGroupObject(7)
#define goHumidity knx.getGroupObject(8)
#define goTriggerSample knx.getGroupObject(9)
#define goCo2Ppm knx.getGroupObject(10)
2018-10-08 21:51:27 +02:00
#define STATE_SAVE_PERIOD UINT32_C(360 * 60 * 1000) // 360 minutes - 4 times a day
// Helper functions declarations
void checkIaqSensorStatus(void);
void errLeds(void);
uint8_t* saveBme680State(uint8_t* buffer);
const uint8_t* loadBme680State(const uint8_t* buffer);
2018-10-08 21:51:27 +02:00
void triggerCallback(GroupObject& go);
void updateState();
2019-07-08 20:00:36 +02:00
// from ulp plus example
2019-06-03 22:59:42 +02:00
const uint8_t bsec_config_iaq[454] =
2019-07-08 20:00:36 +02:00
{3, 7, 4, 1, 61, 0, 0, 0, 0, 0, 0, 0, 174, 1, 0, 0, 48, 0, 1, 0, 0, 168, 19, 73, 64, 49, 119, 76, 0, 0, 225, 68, 137, 65, 0, 63, 205, 204, 204, 62, 0, 0, 64, 63, 205, 204, 204, 62, 0, 0, 0, 0, 0, 80, 5, 95, 0, 0, 0, 0, 0, 0, 0, 0, 28, 0, 2, 0, 0, 244, 1, 225, 0, 25, 0, 0, 128, 64, 0, 0, 32, 65, 144, 1, 0, 0, 112, 65, 0, 0, 0, 63, 16, 0, 3, 0, 10, 215, 163, 60, 10, 215, 35, 59, 10, 215, 35, 59, 9, 0, 5, 0, 0, 0, 0, 0, 1, 88, 0, 9, 0, 229, 208, 34, 62, 0, 0, 0, 0, 0, 0, 0, 0, 218, 27, 156, 62, 225, 11, 67, 64, 0, 0, 160, 64, 0, 0, 0, 0, 0, 0, 0, 0, 94, 75, 72, 189, 93, 254, 159, 64, 66, 62, 160, 191, 0, 0, 0, 0, 0, 0, 0, 0, 33, 31, 180, 190, 138, 176, 97, 64, 65, 241, 99, 190, 0, 0, 0, 0, 0, 0, 0, 0, 167, 121, 71, 61, 165, 189, 41, 192, 184, 30, 189, 64, 12, 0, 10, 0, 0, 0, 0, 0, 0, 0, 0, 0, 229, 0, 254, 0, 2, 1, 5, 48, 117, 100, 0, 44, 1, 112, 23, 151, 7, 132, 3, 197, 0, 92, 4, 144, 1, 64, 1, 64, 1, 144, 1, 48, 117, 48, 117, 48, 117, 48, 117, 100, 0, 100, 0, 100, 0, 48, 117, 48, 117, 48, 117, 100, 0, 100, 0, 48, 117, 48, 117, 100, 0, 100, 0, 100, 0, 100, 0, 48, 117, 48, 117, 48, 117, 100, 0, 100, 0, 100, 0, 48, 117, 48, 117, 100, 0, 100, 0, 44, 1, 44, 1, 44, 1, 44, 1, 44, 1, 44, 1, 44, 1, 44, 1, 44, 1, 44, 1, 44, 1, 44, 1, 44, 1, 44, 1, 8, 7, 8, 7, 8, 7, 8, 7, 8, 7, 8, 7, 8, 7, 8, 7, 8, 7, 8, 7, 8, 7, 8, 7, 8, 7, 8, 7, 112, 23, 112, 23, 112, 23, 112, 23, 112, 23, 112, 23, 112, 23, 112, 23, 112, 23, 112, 23, 112, 23, 112, 23, 112, 23, 112, 23, 255, 255, 255, 255, 255, 255, 255, 255, 220, 5, 220, 5, 220, 5, 255, 255, 255, 255, 255, 255, 220, 5, 220, 5, 255, 255, 255, 255, 255, 255, 255, 255, 255, 255, 255, 255, 255, 255, 255, 255, 255, 255, 255, 255, 255, 255, 255, 255, 255, 255, 255, 255, 255, 255, 255, 255, 44, 1, 0, 0, 0, 0, 222, 38, 0, 0};
2018-10-08 21:51:27 +02:00
// Create an object of the class Bsec
Bsec iaqSensor;
uint16_t stateUpdateCounter = 0;
uint8_t sendCounter = 0;
uint32_t cyclSend = 0;
bool trigger = false;
// Entry point for the example
void setup(void)
{
Serial.begin(115200);
ArduinoPlatform::SerialDebug = &Serial;
2018-10-08 21:51:27 +02:00
delay(5000);
Serial.println("start");
2019-06-02 01:55:26 +02:00
#ifdef ARDUINO_ARCH_ESP8266
WiFiManager wifiManager;
wifiManager.autoConnect("knx-bme680");
2019-06-02 01:55:26 +02:00
#endif
// set save and restore callbacks
knx.setSaveCallback(saveBme680State);
knx.setRestoreCallback(loadBme680State);
2018-10-08 21:51:27 +02:00
// read adress table, association table, groupobject table and parameters from eeprom
knx.readMemory();
// register callback for reset GO
if(knx.configured())
goTriggerSample.callback(triggerCallback);
2018-10-08 21:51:27 +02:00
2019-07-08 20:00:36 +02:00
// Configure Wire pins before this call if needed.
2019-07-24 22:28:11 +02:00
Wire.begin();
// depends on sensor board. Try BME680_I2C_ADDR_PRIMARY if it doen't work.
2018-10-08 21:51:27 +02:00
iaqSensor.begin(BME680_I2C_ADDR_SECONDARY, Wire);
checkIaqSensorStatus();
2019-07-08 20:00:36 +02:00
//iaqSensor.setConfig(bsec_config_iaq);
2018-10-08 21:51:27 +02:00
checkIaqSensorStatus();
2018-11-12 22:05:11 +01:00
bsec_virtual_sensor_t sensorList[] = {
2019-07-08 20:00:36 +02:00
BSEC_OUTPUT_IAQ,
BSEC_OUTPUT_STATIC_IAQ,
BSEC_OUTPUT_CO2_EQUIVALENT,
BSEC_OUTPUT_BREATH_VOC_EQUIVALENT,
2018-10-08 21:51:27 +02:00
BSEC_OUTPUT_RAW_TEMPERATURE,
BSEC_OUTPUT_RAW_PRESSURE,
BSEC_OUTPUT_RAW_HUMIDITY,
BSEC_OUTPUT_RAW_GAS,
2019-07-08 20:00:36 +02:00
BSEC_OUTPUT_STABILIZATION_STATUS,
BSEC_OUTPUT_RUN_IN_STATUS,
2018-10-08 21:51:27 +02:00
BSEC_OUTPUT_SENSOR_HEAT_COMPENSATED_TEMPERATURE,
BSEC_OUTPUT_SENSOR_HEAT_COMPENSATED_HUMIDITY,
2019-07-08 20:00:36 +02:00
BSEC_OUTPUT_COMPENSATED_GAS,
BSEC_OUTPUT_GAS_PERCENTAGE
2018-10-08 21:51:27 +02:00
};
if (knx.configured())
{
cyclSend = knx.paramInt(0);
Serial.print("Zykl. send:");
Serial.println(cyclSend);
2019-09-02 22:00:45 +02:00
goRawTemperature.dataPointType(Dpt(9, 1));
goPressure.dataPointType(Dpt(9, 1));
goRawHumidity.dataPointType(Dpt(9, 1));
goGasResistance.dataPointType(Dpt(9, 1));
goIaqEstimate.dataPointType(Dpt(9, 1));
goIaqAccurace.dataPointType(Dpt(9, 1));
goTemperature.dataPointType(Dpt(9, 1));
goHumidity.dataPointType(Dpt(9, 1));
goCo2Ppm.dataPointType(Dpt(9, 1));
goTriggerSample.dataPointType(Dpt(1, 1));
2018-10-08 21:51:27 +02:00
}
2019-07-08 20:00:36 +02:00
// start the framework.
2018-10-08 21:51:27 +02:00
knx.start();
2019-07-08 20:00:36 +02:00
iaqSensor.updateSubscription(sensorList, sizeof(sensorList)/sizeof(bsec_virtual_sensor_t), BSEC_SAMPLE_RATE_LP);
2018-10-08 21:51:27 +02:00
checkIaqSensorStatus();
String output = "Timestamp [ms], raw temperature [°C], temperature[°C], pressure [hPa], raw relative humidity [%], humidity [%], gas [Ohm], IAQ, IAQ accuracy, CO2, CO2 Accuracy, breathVocEquivalent, breathVocAccuracy, compGasValue, compGas Accuracy, gasPercentage, gasPercentage Accuracy, staticIAQ, staticIAQ Accuracy, runInStatus, stabStatus";
Serial.println(output);
2018-10-08 21:51:27 +02:00
}
// Function that is looped forever
void loop(void)
{
// don't delay here to much. Otherwise you might lose packages or mess up the timing with ETS
knx.loop();
// only run the application code if the device was configured with ETS
if(!knx.configured())
return;
if (iaqSensor.run())
{
String output = String(millis());
2019-06-04 00:46:23 +02:00
output += ", " + String(iaqSensor.rawTemperature);
2019-07-08 20:00:36 +02:00
output += ", " + String(iaqSensor.temperature);
output += ", " + String(iaqSensor.pressure);
output += ", " + String(iaqSensor.rawHumidity);
2019-07-08 20:00:36 +02:00
output += ", " + String(iaqSensor.humidity);
output += ", " + String(iaqSensor.gasResistance);
output += ", " + String(iaqSensor.iaq); //.iaqEstimate for BSEC_1.4.7.4
output += ", " + String(iaqSensor.iaqAccuracy);
output += ", " + String(iaqSensor.co2Equivalent);
output += ", " + String(iaqSensor.co2Accuracy);
2019-07-08 20:00:36 +02:00
output += ", " + String(iaqSensor.breathVocEquivalent);
output += ", " + String(iaqSensor.breathVocAccuracy);
output += ", " + String(iaqSensor.compGasValue);
output += ", " + String(iaqSensor.compGasAccuracy);
output += ", " + String(iaqSensor.gasPercentage);
output += ", " + String(iaqSensor.gasPercentageAcccuracy);
2019-07-08 20:00:36 +02:00
output += ", " + String(iaqSensor.staticIaq);
output += ", " + String(iaqSensor.staticIaqAccuracy);
output += ", " + String(iaqSensor.runInStatus);
output += ", " + String(iaqSensor.stabStatus);
2019-06-04 00:46:23 +02:00
Serial.println(output);
2018-10-08 21:51:27 +02:00
updateState();
if (sendCounter++ == cyclSend || trigger)
{
sendCounter = 0;
trigger = false;
2019-06-03 22:59:42 +02:00
goRawTemperature.value(iaqSensor.rawTemperature);
goPressure.value(iaqSensor.pressure);
goRawHumidity.value(iaqSensor.rawHumidity);
goGasResistance.value(iaqSensor.gasResistance);
goIaqEstimate.value(iaqSensor.iaq); //.iaqEstimate for BSEC_1.4.7.4
2019-06-03 22:59:42 +02:00
goIaqAccurace.value(iaqSensor.iaqAccuracy);
goTemperature.value(iaqSensor.temperature);
goHumidity.value(iaqSensor.humidity);
goCo2Ppm.value(iaqSensor.co2Equivalent);
2018-10-08 21:51:27 +02:00
}
}
else {
checkIaqSensorStatus();
}
}
// Helper function definitions
void checkIaqSensorStatus(void)
{
if (iaqSensor.status != BSEC_OK) {
if (iaqSensor.status < BSEC_OK) {
String output = "BSEC error code : " + String(iaqSensor.status);
Serial.println(output);
2018-10-08 21:51:27 +02:00
for (;;)
errLeds(); /* Halt in case of failure */
}
else {
String output = "BSEC warning code : " + String(iaqSensor.status);
Serial.println(output);
2018-10-08 21:51:27 +02:00
}
}
if (iaqSensor.bme680Status != BME680_OK) {
if (iaqSensor.bme680Status < BME680_OK) {
String output = "BME680 error code : " + String(iaqSensor.bme680Status);
Serial.println(output);
2018-10-08 21:51:27 +02:00
for (;;)
errLeds(); /* Halt in case of failure */
}
else {
String output = "BME680 warning code : " + String(iaqSensor.bme680Status);
Serial.println(output);
2018-10-08 21:51:27 +02:00
}
}
}
void errLeds(void)
{
pinMode(LED_BUILTIN, OUTPUT);
digitalWrite(LED_BUILTIN, HIGH);
delay(100);
digitalWrite(LED_BUILTIN, LOW);
delay(100);
}
const uint8_t* loadBme680State(const uint8_t* buffer)
2018-10-08 21:51:27 +02:00
{
// Existing state in EEPROM
Serial.println("Reading state from EEPROM");
2018-10-08 21:51:27 +02:00
for (uint8_t i = 0; i < BSEC_MAX_STATE_BLOB_SIZE; i++) {
Serial.println(buffer[i], HEX);
2018-10-08 21:51:27 +02:00
}
iaqSensor.setState(buffer);
checkIaqSensorStatus();
return buffer + BSEC_MAX_STATE_BLOB_SIZE;
}
uint8_t* saveBme680State(uint8_t* buffer)
{
iaqSensor.getState(buffer);
checkIaqSensorStatus();
Serial.println("Writing state to EEPROM");
2018-10-08 21:51:27 +02:00
for (uint8_t i = 0; i < BSEC_MAX_STATE_BLOB_SIZE; i++) {
Serial.println(buffer[i], HEX);
2018-10-08 21:51:27 +02:00
}
return buffer + BSEC_MAX_STATE_BLOB_SIZE;
}
void updateState(void)
{
bool update = false;
if (stateUpdateCounter == 0) {
/* First state update when IAQ accuracy is >= 1 */
if (iaqSensor.iaqAccuracy >= 3) {
update = true;
stateUpdateCounter++;
}
}
else {
/* Update every STATE_SAVE_PERIOD minutes */
if ((stateUpdateCounter * STATE_SAVE_PERIOD) < millis()) {
update = true;
stateUpdateCounter++;
}
}
if (update) {
knx.writeMemory();
}
}
// callback from trigger-GO
void triggerCallback(GroupObject& go)
{
Serial.println("trigger");
Serial.println((bool)go.value());
2019-06-12 21:33:33 +02:00
if (!go.value())
2018-10-08 21:51:27 +02:00
return;
trigger = true;
/* We call bsec_update_subscription() in order to instruct BSEC to perform an extra measurement at the next
possible time slot
*/
Serial.println("Triggering ULP plus.");
2018-11-12 22:05:11 +01:00
bsec_virtual_sensor_t sensorList[] = {
BSEC_OUTPUT_IAQ, BSEC_OUTPUT_CO2_EQUIVALENT
2018-10-08 21:51:27 +02:00
};
iaqSensor.updateSubscription(sensorList, 1, BSEC_SAMPLE_RATE_ULP_MEASUREMENT_ON_DEMAND);
checkIaqSensorStatus();
}