mirror of https://github.com/arendst/Tasmota.git
500 lines
14 KiB
C++
500 lines
14 KiB
C++
/*
|
|
xsns_42_scd30.ino - SC30 CO2 sensor support for Sonoff-Tasmota
|
|
|
|
Copyright (C) 2019 Frogmore42
|
|
|
|
This program is free software: you can redistribute it and/or modify
|
|
it under the terms of the GNU General Public License as published by
|
|
the Free Software Foundation, either version 3 of the License, or
|
|
(at your option) any later version.
|
|
|
|
This program is distributed in the hope that it will be useful,
|
|
but WITHOUT ANY WARRANTY; without even the implied warranty of
|
|
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
|
|
GNU General Public License for more details.
|
|
|
|
You should have received a copy of the GNU General Public License
|
|
along with this program. If not, see <http://www.gnu.org/licenses/>.
|
|
|
|
*/
|
|
#ifdef USE_I2C
|
|
#ifdef USE_SCD30
|
|
|
|
#define XSNS_42 42
|
|
|
|
#define SCD30_MAX_MISSED_READS 3
|
|
#define SONOFF_SCD30_STATE_NO_ERROR 0
|
|
#define SONOFF_SCD30_STATE_ERROR_DATA_CRC 1
|
|
#define SONOFF_SCD30_STATE_ERROR_READ_MEAS 2
|
|
#define SONOFF_SCD30_STATE_ERROR_SOFT_RESET 3
|
|
#define SONOFF_SCD30_STATE_ERROR_I2C_RESET 4
|
|
#define SONOFF_SCD30_STATE_ERROR_UNKNOWN 5
|
|
|
|
#include "Arduino.h"
|
|
#include <FrogmoreScd30.h>
|
|
|
|
#define D_CMND_SCD30 "SCD30"
|
|
|
|
const char S_JSON_SCD30_COMMAND_NVALUE[] PROGMEM = "{\"" D_CMND_SCD30 "%s\":%d}";
|
|
const char S_JSON_SCD30_COMMAND_NFW_VALUE[] PROGMEM = "{\"" D_CMND_SCD30 "%s\":%d.%d}";
|
|
const char S_JSON_SCD30_COMMAND[] PROGMEM = "{\"" D_CMND_SCD30 "%s\"}";
|
|
const char kSCD30_Commands[] PROGMEM = "Alt|Auto|Cal|FW|Int|Pres|TOff";
|
|
|
|
/*********************************************************************************************\
|
|
* enumerationsines
|
|
\*********************************************************************************************/
|
|
|
|
enum SCD30_Commands { // commands useable in console or rules
|
|
CMND_SCD30_ALTITUDE,
|
|
CMND_SCD30_AUTOMODE,
|
|
CMND_SCD30_CALIBRATE,
|
|
CMND_SCD30_FW,
|
|
CMND_SCD30_INTERVAL,
|
|
CMND_SCD30_PRESSURE,
|
|
CMND_SCD30_TEMPOFFSET
|
|
};
|
|
|
|
|
|
|
|
FrogmoreScd30 scd30;
|
|
|
|
bool scd30Found = false;
|
|
bool scd30IsDataValid = false;
|
|
int scd30ErrorState = SONOFF_SCD30_STATE_NO_ERROR;
|
|
uint16_t scd30Interval_sec;
|
|
int scd30Loop_count = 0;
|
|
int scd30DataNotAvailable_count = 0;
|
|
int scd30GoodMeas_count = 0;
|
|
int scd30Reset_count = 0;
|
|
int scd30CrcError_count = 0;
|
|
int scd30Co2Zero_count = 0;
|
|
int i2cReset_count = 0;
|
|
uint16_t scd30_CO2 = 0;
|
|
uint16_t scd30_CO2EAvg = 0;
|
|
float scd30_Humid = 0.0;
|
|
float scd30_Temp = 0.0;
|
|
|
|
bool Scd30Init()
|
|
{
|
|
int error;
|
|
bool i2c_flg = ((pin[GPIO_I2C_SCL] < 99) && (pin[GPIO_I2C_SDA] < 99));
|
|
if (i2c_flg)
|
|
{
|
|
uint8_t major = 0;
|
|
uint8_t minor = 0;
|
|
uint16_t interval_sec;
|
|
scd30.begin();
|
|
error = scd30.getFirmwareVersion(&major, &minor);
|
|
if (error)
|
|
{
|
|
#ifdef SCD30_DEBUG
|
|
snprintf_P(log_data, sizeof(log_data), "SCD30: did not find an SCD30: 0x%lX", error);
|
|
AddLog(LOG_LEVEL_DEBUG);
|
|
#endif
|
|
return false;
|
|
}
|
|
else
|
|
{
|
|
#ifdef SCD30_DEBUG
|
|
snprintf_P(log_data, sizeof(log_data), "SCD30: found an SCD30: FW v%d.%d", major, minor);
|
|
AddLog(LOG_LEVEL_INFO);
|
|
#endif
|
|
}
|
|
|
|
error = scd30.getMeasurementInterval(&scd30Interval_sec);
|
|
if (error)
|
|
{
|
|
#ifdef SCD30_DEBUG
|
|
snprintf_P(log_data, sizeof(log_data), "SCD30: error getMeasurementInterval: 0x%lX", error);
|
|
AddLog(LOG_LEVEL_ERROR);
|
|
#endif
|
|
return false;
|
|
}
|
|
|
|
error = scd30.beginMeasuring();
|
|
if (error)
|
|
{
|
|
#ifdef SCD30_DEBUG
|
|
snprintf_P(log_data, sizeof(log_data), "Error: Scd30BeginMeasuring: 0x%lX", error);
|
|
AddLog(LOG_LEVEL_ERROR);
|
|
#endif
|
|
return false;
|
|
}
|
|
|
|
return true;
|
|
}
|
|
}
|
|
|
|
// gets data from the sensor every 3 seconds or so to give the sensor time to gather new data
|
|
int Scd30Update()
|
|
{
|
|
int error = 0;
|
|
int16_t delta = 0;
|
|
scd30Loop_count++;
|
|
|
|
if (!scd30Found)
|
|
{
|
|
scd30Found = Scd30Init();
|
|
#ifdef SCD30_DEBUG
|
|
snprintf_P(log_data, sizeof(log_data), "Scd30Update: found: %d ", scd30Found);
|
|
AddLog(LOG_LEVEL_INFO);
|
|
#endif
|
|
if (!scd30Found)
|
|
{
|
|
#ifdef SCD30_DEBUG
|
|
snprintf_P(log_data, sizeof(log_data), "Scd30Update: found: %d ", scd30Found);
|
|
AddLog(LOG_LEVEL_INFO);
|
|
#endif
|
|
return (ERROR_SCD30_NOT_FOUND_ERROR);
|
|
}
|
|
}
|
|
else
|
|
{
|
|
if (scd30Loop_count > (scd30Interval_sec - 1))
|
|
{
|
|
switch (scd30ErrorState)
|
|
{
|
|
case SONOFF_SCD30_STATE_NO_ERROR:
|
|
{
|
|
error = scd30.readMeasurement(&scd30_CO2, &scd30_CO2EAvg, &scd30_Temp, &scd30_Humid);
|
|
switch (error)
|
|
{
|
|
case ERROR_SCD30_NO_ERROR:
|
|
scd30Loop_count = 0;
|
|
scd30IsDataValid = true;
|
|
scd30GoodMeas_count++;
|
|
break;
|
|
|
|
case ERROR_SCD30_NO_DATA:
|
|
scd30DataNotAvailable_count++;
|
|
break;
|
|
|
|
case ERROR_SCD30_CRC_ERROR:
|
|
scd30ErrorState = SONOFF_SCD30_STATE_ERROR_DATA_CRC;
|
|
scd30CrcError_count++;
|
|
#ifdef SCD30_DEBUG
|
|
snprintf_P(log_data, sizeof(log_data), "SCD30: CRC error, CRC error: %ld, CO2 zero: %ld, good: %ld, no data: %ld, sc30_reset: %ld, i2c_reset: %ld", scd30CrcError_count, scd30Co2Zero_count, scd30GoodMeas_count, scd30DataNotAvailable_count, scd30Reset_count, i2cReset_count);
|
|
AddLog(LOG_LEVEL_ERROR);
|
|
#endif
|
|
break;
|
|
|
|
case ERROR_SCD30_CO2_ZERO:
|
|
scd30Co2Zero_count++;
|
|
#ifdef SCD30_DEBUG
|
|
snprintf_P(log_data, sizeof(log_data), "SCD30: CO2 zero, CRC error: %ld, CO2 zero: %ld, good: %ld, no data: %ld, sc30_reset: %ld, i2c_reset: %ld", scd30CrcError_count, scd30Co2Zero_count, scd30GoodMeas_count, scd30DataNotAvailable_count, scd30Reset_count, i2cReset_count);
|
|
AddLog(LOG_LEVEL_ERROR);
|
|
#endif
|
|
break;
|
|
|
|
default:
|
|
{
|
|
scd30ErrorState = SONOFF_SCD30_STATE_ERROR_READ_MEAS;
|
|
#ifdef SCD30_DEBUG
|
|
snprintf_P(log_data, sizeof(log_data), "SCD30: Update: ReadMeasurement error: 0x%lX, counter: %ld", error, scd30Loop_count);
|
|
AddLog(LOG_LEVEL_ERROR);
|
|
#endif
|
|
return (error);
|
|
}
|
|
break;
|
|
}
|
|
}
|
|
break;
|
|
|
|
case SONOFF_SCD30_STATE_ERROR_DATA_CRC:
|
|
{
|
|
//scd30IsDataValid = false;
|
|
#ifdef SCD30_DEBUG
|
|
snprintf_P(log_data, sizeof(log_data), "SCD30: in error state: %d, good: %ld, no data: %ld, sc30 reset: %ld, i2c reset: %ld", scd30ErrorState, scd30GoodMeas_count, scd30DataNotAvailable_count, scd30Reset_count, i2cReset_count);
|
|
AddLog(LOG_LEVEL_ERROR);
|
|
snprintf_P(log_data, sizeof(log_data), "SCD30: got CRC error, try again, counter: %ld", scd30Loop_count);
|
|
AddLog(LOG_LEVEL_ERROR);
|
|
#endif
|
|
scd30ErrorState = ERROR_SCD30_NO_ERROR;
|
|
}
|
|
break;
|
|
|
|
case SONOFF_SCD30_STATE_ERROR_READ_MEAS:
|
|
{
|
|
//scd30IsDataValid = false;
|
|
#ifdef SCD30_DEBUG
|
|
snprintf_P(log_data, sizeof(log_data), "SCD30: in error state: %d, good: %ld, no data: %ld, sc30 reset: %ld, i2c reset: %ld", scd30ErrorState, scd30GoodMeas_count, scd30DataNotAvailable_count, scd30Reset_count, i2cReset_count);
|
|
AddLog(LOG_LEVEL_ERROR);
|
|
snprintf_P(log_data, sizeof(log_data), "SCD30: not answering, sending soft reset, counter: %ld", scd30Loop_count);
|
|
AddLog(LOG_LEVEL_ERROR);
|
|
#endif
|
|
scd30Reset_count++;
|
|
error = scd30.softReset();
|
|
if (error)
|
|
{
|
|
#ifdef SCD30_DEBUG
|
|
snprintf_P(log_data, sizeof(log_data), "SCD30: resetting got error: 0x%lX", error);
|
|
AddLog(LOG_LEVEL_ERROR);
|
|
#endif
|
|
error >>= 8;
|
|
if (error == 4)
|
|
{
|
|
scd30ErrorState = SONOFF_SCD30_STATE_ERROR_SOFT_RESET;
|
|
}
|
|
else
|
|
{
|
|
scd30ErrorState = SONOFF_SCD30_STATE_ERROR_UNKNOWN;
|
|
}
|
|
}
|
|
else
|
|
{
|
|
scd30ErrorState = ERROR_SCD30_NO_ERROR;
|
|
}
|
|
}
|
|
break;
|
|
|
|
case SONOFF_SCD30_STATE_ERROR_SOFT_RESET:
|
|
{
|
|
//scd30IsDataValid = false;
|
|
#ifdef SCD30_DEBUG
|
|
snprintf_P(log_data, sizeof(log_data), "SCD30: in error state: %d, good: %ld, no data: %ld, sc30 reset: %ld, i2c reset: %ld", scd30ErrorState, scd30GoodMeas_count, scd30DataNotAvailable_count, scd30Reset_count, i2cReset_count);
|
|
AddLog(LOG_LEVEL_ERROR);
|
|
snprintf_P(log_data, sizeof(log_data), "SCD30: clearing i2c bus");
|
|
AddLog(LOG_LEVEL_ERROR);
|
|
#endif
|
|
i2cReset_count++;
|
|
error = scd30.clearI2CBus();
|
|
if (error)
|
|
{
|
|
scd30ErrorState = SONOFF_SCD30_STATE_ERROR_I2C_RESET;
|
|
#ifdef SCD30_DEBUG
|
|
snprintf_P(log_data, sizeof(log_data), "SCD30: error clearing i2c bus: 0x%lX", error);
|
|
AddLog(LOG_LEVEL_ERROR);
|
|
#endif
|
|
}
|
|
else
|
|
{
|
|
scd30ErrorState = ERROR_SCD30_NO_ERROR;
|
|
}
|
|
}
|
|
break;
|
|
|
|
default:
|
|
{
|
|
//scd30IsDataValid = false;
|
|
#ifdef SCD30_DEBUG
|
|
snprintf_P(log_data, sizeof(log_data), "SCD30: unknown error state: 0x%lX", scd30ErrorState);
|
|
AddLog(LOG_LEVEL_ERROR);
|
|
#endif
|
|
scd30ErrorState = SONOFF_SCD30_STATE_ERROR_SOFT_RESET; // try again
|
|
}
|
|
}
|
|
|
|
if (scd30Loop_count > (SCD30_MAX_MISSED_READS * scd30Interval_sec))
|
|
{
|
|
scd30IsDataValid = false;
|
|
}
|
|
}
|
|
}
|
|
return (ERROR_SCD30_NO_ERROR);
|
|
}
|
|
|
|
|
|
int Scd30GetCommand(int command_code, uint16_t *pvalue)
|
|
{
|
|
switch (command_code)
|
|
{
|
|
case CMND_SCD30_ALTITUDE:
|
|
return scd30.getAltitudeCompensation(pvalue);
|
|
break;
|
|
|
|
case CMND_SCD30_AUTOMODE:
|
|
return scd30.getCalibrationType(pvalue);
|
|
break;
|
|
|
|
case CMND_SCD30_CALIBRATE:
|
|
return scd30.getForcedRecalibrationFactor(pvalue);
|
|
break;
|
|
|
|
case CMND_SCD30_INTERVAL:
|
|
return scd30.getMeasurementInterval(pvalue);
|
|
break;
|
|
|
|
case CMND_SCD30_PRESSURE:
|
|
return scd30.getAmbientPressure(pvalue);
|
|
break;
|
|
|
|
case CMND_SCD30_TEMPOFFSET:
|
|
return scd30.getTemperatureOffset(pvalue);
|
|
break;
|
|
|
|
default:
|
|
// else for Unknown command
|
|
break;
|
|
}
|
|
}
|
|
|
|
int Scd30SetCommand(int command_code, uint16_t value)
|
|
{
|
|
switch (command_code)
|
|
{
|
|
case CMND_SCD30_ALTITUDE:
|
|
return scd30.setAltitudeCompensation(value);
|
|
break;
|
|
|
|
case CMND_SCD30_AUTOMODE:
|
|
return scd30.setCalibrationType(value);
|
|
break;
|
|
|
|
case CMND_SCD30_CALIBRATE:
|
|
return scd30.setForcedRecalibrationFactor(value);
|
|
break;
|
|
|
|
case CMND_SCD30_INTERVAL:
|
|
{
|
|
int error = scd30.setMeasurementInterval(value);
|
|
if (!error)
|
|
{
|
|
scd30Interval_sec = value;
|
|
}
|
|
|
|
return error;
|
|
}
|
|
break;
|
|
|
|
case CMND_SCD30_PRESSURE:
|
|
return scd30.setAmbientPressure(value);
|
|
break;
|
|
|
|
case CMND_SCD30_TEMPOFFSET:
|
|
return scd30.setTemperatureOffset(value);
|
|
break;
|
|
|
|
default:
|
|
// else for Unknown command
|
|
break;
|
|
}
|
|
}
|
|
/*********************************************************************************************\
|
|
* Command Sensor92
|
|
\*********************************************************************************************/
|
|
|
|
bool Scd30CommandSensor()
|
|
{
|
|
char command[CMDSZ];
|
|
bool serviced = true;
|
|
uint8_t prefix_len = strlen(D_CMND_SCD30);
|
|
|
|
if (!strncasecmp_P(XdrvMailbox.topic, PSTR(D_CMND_SCD30), prefix_len)) { // prefix
|
|
int command_code = GetCommandCode(command, sizeof(command), XdrvMailbox.topic + prefix_len, kSCD30_Commands);
|
|
|
|
switch (command_code) {
|
|
case CMND_SCD30_ALTITUDE:
|
|
case CMND_SCD30_AUTOMODE:
|
|
case CMND_SCD30_CALIBRATE:
|
|
case CMND_SCD30_INTERVAL:
|
|
case CMND_SCD30_PRESSURE:
|
|
case CMND_SCD30_TEMPOFFSET:
|
|
{
|
|
uint16_t value = 0;
|
|
if (XdrvMailbox.data_len > 0)
|
|
{
|
|
value = XdrvMailbox.payload;
|
|
Scd30SetCommand(command_code, value);
|
|
}
|
|
else
|
|
{
|
|
Scd30GetCommand(command_code, &value);
|
|
}
|
|
|
|
Response_P(S_JSON_SCD30_COMMAND_NVALUE, command, value);
|
|
}
|
|
break;
|
|
|
|
case CMND_SCD30_FW:
|
|
{
|
|
uint8_t major = 0;
|
|
uint8_t minor = 0;
|
|
int error;
|
|
error = scd30.getFirmwareVersion(&major, &minor);
|
|
if (error)
|
|
{
|
|
#ifdef SCD30_DEBUG
|
|
snprintf_P(log_data, sizeof(log_data), "SCD30: error getting FW version: 0x%lX", error);
|
|
AddLog(LOG_LEVEL_ERROR);
|
|
#endif
|
|
serviced = false;
|
|
}
|
|
else
|
|
{
|
|
Response_P(S_JSON_SCD30_COMMAND_NFW_VALUE, command, major, minor);
|
|
}
|
|
}
|
|
break;
|
|
|
|
default:
|
|
// else for Unknown command
|
|
serviced = false;
|
|
break;
|
|
}
|
|
}
|
|
return serviced;
|
|
}
|
|
|
|
void Scd30Show(bool json)
|
|
{
|
|
char humidity[10];
|
|
char temperature[10];
|
|
|
|
if (scd30Found && scd30IsDataValid)
|
|
{
|
|
dtostrfd(ConvertHumidity(scd30_Humid), Settings.flag2.humidity_resolution, humidity);
|
|
dtostrfd(ConvertTemp(scd30_Temp), Settings.flag2.temperature_resolution, temperature);
|
|
if (json) {
|
|
//ResponseAppend_P(PSTR(",\"SCD30\":{\"" D_JSON_CO2 "\":%d,\"" D_JSON_TEMPERATURE "\":%s,\"" D_JSON_HUMIDITY "\":%s}"), scd30_CO2, temperature, humidity);
|
|
ResponseAppend_P(PSTR(",\"SCD30\":{\"" D_JSON_CO2 "\":%d,\"" D_JSON_ECO2 "\":%d,\"" D_JSON_TEMPERATURE "\":%s,\"" D_JSON_HUMIDITY "\":%s}"),
|
|
scd30_CO2, scd30_CO2EAvg, temperature, humidity);
|
|
#ifdef USE_DOMOTICZ
|
|
if (0 == tele_period)
|
|
{
|
|
DomoticzSensor(DZ_AIRQUALITY, scd30_CO2);
|
|
DomoticzTempHumSensor(temperature, humidity);
|
|
}
|
|
#endif // USE_DOMOTICZ
|
|
#ifdef USE_WEBSERVER
|
|
} else {
|
|
WSContentSend_PD(HTTP_SNS_CO2EAVG, "SCD30", scd30_CO2EAvg);
|
|
WSContentSend_PD(HTTP_SNS_CO2, "SCD30", scd30_CO2);
|
|
WSContentSend_PD(HTTP_SNS_TEMP, "SCD30", temperature, TempUnit());
|
|
WSContentSend_PD(HTTP_SNS_HUM, "SCD30", humidity);
|
|
#endif // USE_WEBSERVER
|
|
}
|
|
}
|
|
}
|
|
|
|
/*********************************************************************************************\
|
|
* Interface
|
|
\*********************************************************************************************/
|
|
|
|
bool Xsns42(byte function)
|
|
{
|
|
bool result = false;
|
|
|
|
if (i2c_flg) {
|
|
switch (function) {
|
|
case FUNC_EVERY_SECOND:
|
|
Scd30Update();
|
|
break;
|
|
case FUNC_COMMAND:
|
|
result = Scd30CommandSensor();
|
|
break;
|
|
case FUNC_JSON_APPEND:
|
|
Scd30Show(1);
|
|
break;
|
|
#ifdef USE_WEBSERVER
|
|
case FUNC_WEB_SENSOR:
|
|
Scd30Show(0);
|
|
break;
|
|
#endif // USE_WEBSERVER
|
|
}
|
|
}
|
|
return result;
|
|
}
|
|
|
|
#endif // USE_SCD30
|
|
#endif // USE_I2C
|