Fix SPS30 not detected on ESP8266 (#24780)

This commit is contained in:
Theo Arends
2026-06-01 17:44:51 +02:00
parent 7a37821ecf
commit 696255995a
3 changed files with 203 additions and 225 deletions
+197 -225
View File
@@ -19,21 +19,23 @@
#ifdef USE_I2C
#ifdef USE_SPS30
/*********************************************************************************************\
* SPS30 - Particulate Matter (PM)
*
* I2C Address: 0x69
\*********************************************************************************************/
#define XSNS_44 44
#define XI2C_30 30 // See I2CDEVICES.md
#define XSNS_44 44
#define XI2C_30 30 // See I2CDEVICES.md
#define SPS30_ADDR 0x69
//#define SPS30_PARTS_PER_DECILITER // Report NCPM as parts per deciliter instead of parts per cm3
//#define SENSIRION_DEBUG // Adds 1k2 to code size
#include <Wire.h>
#ifdef ESP8266
#include <twi.h>
#endif
#include <SensirionI2cSps30.h>
uint8_t sps30_ready = 0;
uint8_t sps30_running;
SensirionI2cSps30 sps30;
struct SPS30 {
struct SPS30DATA_s {
float PM1_0;
float PM2_5;
float PM4_0;
@@ -44,273 +46,243 @@ struct SPS30 {
float NCPM4_0;
float NCPM10;
float TYPSIZ;
} sps30_result;
uint8_t running;
} *SPS30DATA = nullptr;
#define SPS_CMD_START_MEASUREMENT 0x0010
#define SPS_CMD_START_MEASUREMENT_ARG 0x0300
#define SPS_CMD_STOP_MEASUREMENT 0x0104
#define SPS_CMD_READ_MEASUREMENT 0x0300
#define SPS_CMD_GET_DATA_READY 0x0202
#define SPS_CMD_AUTOCLEAN_INTERVAL 0x8004
#define SPS_CMD_CLEAN 0x5607
#define SPS_CMD_GET_ACODE 0xd025
#define SPS_CMD_GET_SERIAL 0xd033
#define SPS_CMD_RESET 0xd304
#define SPS_WRITE_DELAY_US 20000
#define SPS_MAX_SERIAL_LEN 32
/********************************************************************************************/
uint8_t sps30_calc_CRC(uint8_t *data) {
uint8_t crc = 0xFF;
for (uint32_t i = 0; i < 2; i++) {
crc ^= data[i];
for (uint32_t bit = 8; bit > 0; --bit) {
if(crc & 0x80) {
crc = (crc << 1) ^ 0x31u;
} else {
crc = (crc << 1);
}
}
}
return crc;
}
void CmdClean(void);
#ifdef ESP8266
unsigned char twi_readFrom(unsigned char address, unsigned char* buf, unsigned int len, unsigned char sendStop);
bool Sps30Error(const char* func, int error) {
bool result = (error != 0);
if (result) {
#ifdef SENSIRION_DEBUG
char error_msg[64];
errorToString(error, error_msg, sizeof(error_msg));
AddLog(LOG_LEVEL_DEBUG, PSTR("SPS: %s error %d %s"), func, error, error_msg);
#else
AddLog(LOG_LEVEL_DEBUG, PSTR("SPS: %s error %d"), func, error);
#endif
}
return result;
}
void sps30_get_data(uint16_t cmd, uint8_t *data, uint8_t dlen) {
unsigned char cmdb[2];
uint8_t tmp[3];
uint8_t index=0;
memset(data,0,dlen);
uint8_t twi_buff[64];
/********************************************************************************************/
Wire.beginTransmission(SPS30_ADDR);
cmdb[0]=cmd>>8;
cmdb[1]=cmd;
Wire.write(cmdb,2);
Wire.endTransmission();
// need 60 bytes max
dlen/=2;
dlen*=3;
#ifdef ESP8266
twi_readFrom(SPS30_ADDR,twi_buff,dlen,1);
#endif // ESP8266
#ifdef ESP32
Wire.requestFrom((uint16_t)SPS30_ADDR, dlen, true);
Wire.readBytes(twi_buff, dlen);
#endif // ESP32
uint8_t bind=0;
while (bind<dlen) {
tmp[0] = twi_buff[bind++];
tmp[1] = twi_buff[bind++];
tmp[2] = twi_buff[bind++];
if (sps30_calc_CRC(tmp)!=tmp[2]) {
// chksum error
index+=2;
} else {
data[index++]=tmp[0];
data[index++]=tmp[1];
void Sps30Init(void) {
PowerOnDelay(60); // Sensor startup time (Time after power-on until I2C communication can be started)
for (uint32_t bus = 0; bus < MAX_I2C; bus++) {
if (!I2cSetDevice(SPS30_I2C_ADDR_69, bus)) {
// Sps30Error("Scan", bus +1);
continue;
}
}
}
sps30.begin(I2cGetWire(bus), SPS30_I2C_ADDR_69);
void sps30_cmd(uint16_t cmd) {
unsigned char cmdb[6];
Wire.beginTransmission(SPS30_ADDR);
cmdb[0]=cmd>>8;
cmdb[1]=cmd;
if (sps30.wakeUp()) { // Switch from sleep to idle mode. Performs delay(5) if no error
if (Sps30Error("WakeUp", sps30.wakeUp())) {
continue;
}
}
if (cmd==SPS_CMD_START_MEASUREMENT) {
cmdb[2]=SPS_CMD_START_MEASUREMENT_ARG>>8;
cmdb[3]=SPS_CMD_START_MEASUREMENT_ARG&0xff;
cmdb[4]=sps30_calc_CRC(&cmdb[2]);
Wire.write(cmdb,5);
} else {
Wire.write(cmdb,2);
}
Wire.endTransmission();
}
if (sps30.deviceReset()) { // Switch to power reset state (idle mode). Performs delay(100) if no error
if (Sps30Error("Reset", sps30.deviceReset())) { // See https://github.com/arendst/Tasmota/discussions/24452
continue;
}
}
void SPS30_Detect(void)
{
if (!I2cSetDevice(SPS30_ADDR)) { return; }
uint8_t dcode[32];
sps30_get_data(SPS_CMD_GET_SERIAL,dcode,sizeof(dcode));
if(dcode[0] == 0) {
uint8_t major;
uint8_t minor;
if (Sps30Error("Version", sps30.readFirmwareVersion(major, minor))) {
continue;
}
int8_t serial_number[32] = { 0 };
if (Sps30Error("Serialnumber", sps30.readSerialNumber(serial_number, sizeof(serial_number)))) {
continue;
}
/*
// (always “00080000” without terminating null-character, recommended to use as product identifier)
int8_t product_type[8] = { 0 };
if (Sps30Error("Producttype", sps30.readProductType(product_type, sizeof(product_type)))) {
continue;
}
*/
if (Sps30Error("StartMeasurement", sps30.startMeasurement(SPS30_OUTPUT_FORMAT_OUTPUT_FORMAT_FLOAT))) {
continue;
}
SPS30DATA = (SPS30DATA_s *)calloc(1, sizeof(struct SPS30DATA_s));
if (nullptr == SPS30DATA) { return; }
SPS30DATA->running = 1;
I2cSetActiveFound(SPS30_I2C_ADDR_69, "SPS30", bus);
AddLog(LOG_LEVEL_DEBUG, PSTR("SPS: SPS30 serialnumber %s v%d.%d"), serial_number, major, minor);
return;
}
AddLog(LOG_LEVEL_DEBUG, PSTR("sps30 found with serial: %s"), dcode);
sps30_cmd(SPS_CMD_START_MEASUREMENT);
sps30_running = 1;
sps30_ready = 1;
I2cSetActiveFound(SPS30_ADDR, "SPS30");
}
#define D_UNIT_PM "ug/m3"
#define D_UNIT_NCPM "#/cm3"
void Sps30EverySecond(void) {
if (!SPS30DATA->running) { return; }
#ifdef USE_WEBSERVER
const char HTTP_SNS_SPS30_a[] PROGMEM ="{s}SPS30 " "%s" "{m}%s " D_UNIT_PM "{e}";
const char HTTP_SNS_SPS30_b[] PROGMEM ="{s}SPS30 " "%s" "{m}%s " D_UNIT_NCPM "{e}";
const char HTTP_SNS_SPS30_c[] PROGMEM ="{s}SPS30 " "TYPSIZ" "{m}%s " "um" "{e}";
#endif // USE_WEBSERVER
#define PMDP 2
#define SPS30_HOURS Settings->sps30_inuse_hours
//#define SPS30_HOURS sps30_inuse_hours
//uint8_t sps30_inuse_hours;
void SPS30_Every_Second() {
if (!sps30_running) return;
if (TasmotaGlobal.uptime%10==0) {
uint8_t vars[sizeof(float)*10];
sps30_get_data(SPS_CMD_READ_MEASUREMENT,vars,sizeof(vars));
float *fp=&sps30_result.PM1_0;
typedef union {
uint8_t array[4];
float value;
} ByteToFloat;
ByteToFloat conv;
for (uint32_t count=0; count<10; count++) {
for (uint32_t i = 0; i < 4; i++){
conv.array[3-i] = vars[count*sizeof(float)+i];
}
*fp++=conv.value;
if (TasmotaGlobal.uptime % 10 == 0) {
float PM1_0;
float PM2_5;
float PM4_0;
float PM10;
float NCPM0_5;
float NCPM1_0;
float NCPM2_5;
float NCPM4_0;
float NCPM10;
float TYPSIZ;
if (!Sps30Error("Measurement", sps30.readMeasurementValuesFloat(
PM1_0, PM2_5, PM4_0, PM10, NCPM0_5, NCPM1_0, NCPM2_5, NCPM4_0, NCPM10, TYPSIZ))) {
SPS30DATA->PM1_0 = PM1_0;
SPS30DATA->PM2_5 = PM2_5;
SPS30DATA->PM4_0 = PM4_0;
SPS30DATA->PM10 = PM10;
#ifdef SPS30_PARTS_PER_DECILITER
SPS30DATA->NCPM0_5 = NCPM0_5 * 100; // ppd = 100 cm3
SPS30DATA->NCPM1_0 = NCPM1_0 * 100;
SPS30DATA->NCPM2_5 = NCPM2_5 * 100;
SPS30DATA->NCPM4_0 = NCPM4_0 * 100;
SPS30DATA->NCPM10 = NCPM10 * 100;
#else // Number per cm3
SPS30DATA->NCPM0_5 = NCPM0_5;
SPS30DATA->NCPM1_0 = NCPM1_0;
SPS30DATA->NCPM2_5 = NCPM2_5;
SPS30DATA->NCPM4_0 = NCPM4_0;
SPS30DATA->NCPM10 = NCPM10;
#endif // SPS30_PARTS_PER_DECILITER
SPS30DATA->TYPSIZ = TYPSIZ;
}
}
if (TasmotaGlobal.uptime%3600==0 && TasmotaGlobal.uptime>60) {
if (TasmotaGlobal.uptime % 3600 == 0 && TasmotaGlobal.uptime > 60) {
// should auto clean once per week runtime
// so count hours, should be in Settings
SPS30_HOURS++;
if (SPS30_HOURS>(7*24)) {
CmdClean();
SPS30_HOURS=0;
Settings->sps30_inuse_hours++;
if (Settings->sps30_inuse_hours > (7*24)) {
Settings->sps30_inuse_hours = 0;
sps30.startFanCleaning();
ResponseTime_P(PSTR(",\"SPS30\":\"FanCleaning\"}"));
MqttPublishTeleSensor();
}
}
}
void SPS30_Show(bool json)
{
if (!sps30_running) { return; }
/*********************************************************************************************\
* Commands
\*********************************************************************************************/
char str[64];
if (json) {
dtostrfd(sps30_result.PM1_0,PMDP,str);
ResponseAppend_P(PSTR(",\"SPS30\":{\"" "PM1_0" "\":%s"), str);
dtostrfd(sps30_result.PM2_5,PMDP,str);
ResponseAppend_P(PSTR(",\"" "PM2_5" "\":%s"), str);
dtostrfd(sps30_result.PM4_0,PMDP,str);
ResponseAppend_P(PSTR(",\"" "PM4_0" "\":%s"), str);
dtostrfd(sps30_result.PM10,PMDP,str);
ResponseAppend_P(PSTR(",\"" "PM10" "\":%s"), str);
dtostrfd(sps30_result.NCPM0_5,PMDP,str);
ResponseAppend_P(PSTR(",\"" "NCPM0_5" "\":%s"), str);
dtostrfd(sps30_result.NCPM1_0,PMDP,str);
ResponseAppend_P(PSTR(",\"" "NCPM1_0" "\":%s"), str);
dtostrfd(sps30_result.NCPM2_5,PMDP,str);
ResponseAppend_P(PSTR(",\"" "NCPM2_5" "\":%s"), str);
dtostrfd(sps30_result.NCPM4_0,PMDP,str);
ResponseAppend_P(PSTR(",\"" "NCPM4_0" "\":%s"), str);
dtostrfd(sps30_result.NCPM10,PMDP,str);
ResponseAppend_P(PSTR(",\"" "NCPM10" "\":%s"), str);
dtostrfd(sps30_result.TYPSIZ,PMDP,str);
ResponseAppend_P(PSTR(",\"" "TYPSIZ" "\":%s}"), str);
#ifdef USE_WEBSERVER
} else {
dtostrfd(sps30_result.PM1_0,PMDP,str);
WSContentSend_PD(HTTP_SNS_SPS30_a,"PM 1.0",str);
dtostrfd(sps30_result.PM2_5,PMDP,str);
WSContentSend_PD(HTTP_SNS_SPS30_a,"PM 2.5",str);
dtostrfd(sps30_result.PM4_0,PMDP,str);
WSContentSend_PD(HTTP_SNS_SPS30_a,"PM 4.0",str);
dtostrfd(sps30_result.PM10,PMDP,str);
WSContentSend_PD(HTTP_SNS_SPS30_a,"PM 10",str);
dtostrfd(sps30_result.NCPM0_5,PMDP,str);
WSContentSend_PD(HTTP_SNS_SPS30_b,"NCPM 0.5",str);
dtostrfd(sps30_result.NCPM1_0,PMDP,str);
WSContentSend_PD(HTTP_SNS_SPS30_b,"NCPM 1.0",str);
dtostrfd(sps30_result.NCPM2_5,PMDP,str);
WSContentSend_PD(HTTP_SNS_SPS30_b,"NCPM 2.5",str);
dtostrfd(sps30_result.NCPM4_0,PMDP,str);
WSContentSend_PD(HTTP_SNS_SPS30_b,"NCPM 4.0",str);
dtostrfd(sps30_result.NCPM10,PMDP,str);
WSContentSend_PD(HTTP_SNS_SPS30_b,"NCPM 10",str);
dtostrfd(sps30_result.TYPSIZ,PMDP,str);
WSContentSend_PD(HTTP_SNS_SPS30_c,str);
#endif
}
}
void CmdClean(void)
{
sps30_cmd(SPS_CMD_CLEAN);
ResponseTime_P(PSTR(",\"SPS30\":{\"CFAN\":\"true\"}}"));
MqttPublishTeleSensor();
}
bool SPS30_cmd(void)
{
bool Sps30Command(void) {
// Sensor44 0 - Stop measurment
// Sensor44 1 - Start measurment
// Sensor44 c - Clean
bool serviced = true;
if (XdrvMailbox.data_len > 0) {
char *cp=XdrvMailbox.data;
if (*cp=='c') {
// clean cmd
CmdClean();
} else if (*cp=='0' || *cp=='1') {
sps30_running=*cp&1;
sps30_cmd(sps30_running?SPS_CMD_START_MEASUREMENT:SPS_CMD_STOP_MEASUREMENT);
char *cp = XdrvMailbox.data;
if (*cp == 'c') {
// clean cmd
sps30.startFanCleaning();
Response_P(PSTR("{\"SPS30\":\"FanCleaning\"}"));
return true;
}
else if (*cp == '0' || *cp == '1') {
SPS30DATA->running = *cp &1;
if (SPS30DATA->running) {
sps30.startMeasurement(SPS30_OUTPUT_FORMAT_OUTPUT_FORMAT_FLOAT);
} else {
serviced=false;
sps30.stopMeasurement();
}
} else {
return false;;
}
}
Response_P(PSTR("{\"SPS30\":\"%s\"}"), sps30_running?"running":"stopped");
Response_P(PSTR("{\"SPS30\":\"%s\"}"), SPS30DATA->running ? "Running" : "Stopped");
return serviced;
}
/*********************************************************************************************\
* Presentation
\*********************************************************************************************/
#define D_UNIT_NUMBER_PER_CUBIC_CM "#/cm³"
#define D_TYPICAL_PARTICLE_SIZE "Typical Size"
#define D_NUMBER_ENVIRONMENTAL_CONCENTRATION "NCPM"
#ifdef USE_WEBSERVER
#ifndef SPS30_PARTS_PER_DECILITER
const char HTTP_SNS_F_NUMBER_ENVIRONMENTAL_CONCENTRATION[] PROGMEM = "{s}%s " D_NUMBER_ENVIRONMENTAL_CONCENTRATION " %s " D_UNIT_MICROMETER "{m}%1_f " D_UNIT_NUMBER_PER_CUBIC_CM "{e}";
#endif // No SPS30_PARTS_PER_DECILITER
const char HTTP_SNS_F_TYPICAL_PARTICLE_SIZE[] PROGMEM ="{s}%s " D_TYPICAL_PARTICLE_SIZE "{m}%2_f " D_UNIT_MICROMETER "{e}";
#endif // USE_WEBSERVER
void Sps30Show(bool json) {
if (!SPS30DATA->running) { return; }
if (json) {
ResponseAppend_P(PSTR(",\"SPS30\":{\"PM1_0\":%2_f,\"PM2_5\":%2_f,\"PM4_0\":%2_f,\"PM10\":%2_f"),
&SPS30DATA->PM1_0, &SPS30DATA->PM2_5, &SPS30DATA->PM4_0, &SPS30DATA->PM10);
#ifdef SPS30_PARTS_PER_DECILITER
ResponseAppend_P(PSTR(",\"NCPM0_5\":%d,\"NCPM1_0\":%d,\"NCPM2_5\":%d,\"NCPM4_0\":%d,\"NCPM10\":%d"),
(uint32_t)SPS30DATA->NCPM0_5, (uint32_t)SPS30DATA->NCPM1_0, (uint32_t)SPS30DATA->NCPM2_5, (uint32_t)SPS30DATA->NCPM4_0, (uint32_t)SPS30DATA->NCPM10);
#else // Number per cm3
ResponseAppend_P(PSTR(",\"NCPM0_5\":%2_f,\"NCPM1_0\":%2_f,\"NCPM2_5\":%2_f,\"NCPM4_0\":%2_f,\"NCPM10\":%2_f"),
&SPS30DATA->NCPM0_5, &SPS30DATA->NCPM1_0, &SPS30DATA->NCPM2_5, &SPS30DATA->NCPM4_0, &SPS30DATA->NCPM10);
#endif // SPS30_PARTS_PER_DECILITER
ResponseAppend_P(PSTR(",\"TYPSIZ\":%2_f}"), &SPS30DATA->TYPSIZ);
#ifdef USE_WEBSERVER
} else {
WSContentSend_PD(HTTP_SNS_F_ENVIRONMENTAL_CONCENTRATION, "SPS30", "1", &SPS30DATA->PM1_0);
WSContentSend_PD(HTTP_SNS_F_ENVIRONMENTAL_CONCENTRATION, "SPS30", "2.5", &SPS30DATA->PM2_5);
WSContentSend_PD(HTTP_SNS_F_ENVIRONMENTAL_CONCENTRATION, "SPS30", "4", &SPS30DATA->PM4_0);
WSContentSend_PD(HTTP_SNS_F_ENVIRONMENTAL_CONCENTRATION, "SPS30", "10", &SPS30DATA->PM10);
#ifdef SPS30_PARTS_PER_DECILITER
WSContentSend_PD(HTTP_SNS_PARTICALS_BEYOND, "SPS30", "0.5", (uint32_t)SPS30DATA->NCPM0_5);
WSContentSend_PD(HTTP_SNS_PARTICALS_BEYOND, "SPS30", "1", (uint32_t)SPS30DATA->NCPM1_0);
WSContentSend_PD(HTTP_SNS_PARTICALS_BEYOND, "SPS30", "2.5", (uint32_t)SPS30DATA->NCPM2_5);
WSContentSend_PD(HTTP_SNS_PARTICALS_BEYOND, "SPS30", "4", (uint32_t)SPS30DATA->NCPM4_0);
WSContentSend_PD(HTTP_SNS_PARTICALS_BEYOND, "SPS30", "10", (uint32_t)SPS30DATA->NCPM10);
#else // Number per cm3
WSContentSend_PD(HTTP_SNS_F_NUMBER_ENVIRONMENTAL_CONCENTRATION, "SPS30", "0.5", &SPS30DATA->NCPM0_5);
WSContentSend_PD(HTTP_SNS_F_NUMBER_ENVIRONMENTAL_CONCENTRATION, "SPS30", "1", &SPS30DATA->NCPM1_0);
WSContentSend_PD(HTTP_SNS_F_NUMBER_ENVIRONMENTAL_CONCENTRATION, "SPS30", "2.5", &SPS30DATA->NCPM2_5);
WSContentSend_PD(HTTP_SNS_F_NUMBER_ENVIRONMENTAL_CONCENTRATION, "SPS30", "4", &SPS30DATA->NCPM4_0);
WSContentSend_PD(HTTP_SNS_F_NUMBER_ENVIRONMENTAL_CONCENTRATION, "SPS30", "10", &SPS30DATA->NCPM10);
#endif // SPS30_PARTS_PER_DECILITER
WSContentSend_PD(HTTP_SNS_F_TYPICAL_PARTICLE_SIZE, "SPS30", &SPS30DATA->TYPSIZ);
#endif // USE_WEBSERVER
}
}
/*********************************************************************************************\
* Interface
\*********************************************************************************************/
bool Xsns44(uint32_t function)
{
bool Xsns44(uint32_t function) {
if (!I2cEnabled(XI2C_30)) { return false; }
bool result = false;
if (FUNC_INIT == function) {
SPS30_Detect();
Sps30Init();
}
else if (sps30_ready) {
else if (SPS30DATA) {
switch (function) {
case FUNC_EVERY_SECOND:
SPS30_Every_Second();
Sps30EverySecond();
break;
case FUNC_JSON_APPEND:
SPS30_Show(1);
Sps30Show(1);
break;
#ifdef USE_WEBSERVER
#ifdef USE_WEBSERVER
case FUNC_WEB_SENSOR:
SPS30_Show(0);
Sps30Show(0);
break;
#endif // USE_WEBSERVER
#endif // USE_WEBSERVER
case FUNC_COMMAND_SENSOR:
if (XSNS_44 == XdrvMailbox.index) {
result = SPS30_cmd();
result = Sps30Command();
}
break;
}