sascha/esphome
1
0
Fork 0
mirror of https://github.com/esphome/esphome.git synced 2025-03-13 22:28:14 +00:00
Code Issues Releases Wiki Activity

Add support for SGP30 eCO2 and TVOC sensors

Browse Source
This commit is contained in:
valordk 2019-08-03 06:52:13 +02:00
parent 7210ad7ed9
commit 05f9221ea4
4 changed files with 398 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

0
esphome/components/sgp30/__init__.py Normal file
View File

55
esphome/components/sgp30/sensor.py Normal file
View File

@ -0,0 +1,55 @@
import esphome.codegen as cg
import esphome.config_validation as cv
from esphome.components import i2c, sensor
from esphome.const import CONF_ID, ICON_RADIATOR, UNIT_PARTS_PER_MILLION, \
UNIT_PARTS_PER_BILLION, CONF_HUMIDITY, CONF_TEMPERATURE, ICON_PERIODIC_TABLE_CO2
DEPENDENCIES = ['i2c']
sgp30_ns = cg.esphome_ns.namespace('sgp30')
SGP30Component = sgp30_ns.class_('SGP30Component', cg.PollingComponent, i2c.I2CDevice)
CONF_ECO2 = 'eco2'
CONF_TVOC = 'tvoc'
CONF_BASELINE = 'baseline'
CONF_UPTIME = 'uptime'
CONFIG_SCHEMA = cv.Schema({
cv.GenerateID(): cv.declare_id(SGP30Component),
cv.Required(CONF_ECO2): sensor.sensor_schema(UNIT_PARTS_PER_MILLION, ICON_PERIODIC_TABLE_CO2,
0),
cv.Required(CONF_TVOC): sensor.sensor_schema(UNIT_PARTS_PER_BILLION, ICON_RADIATOR, 0),
cv.Optional(CONF_BASELINE): cv.hex_uint16_t,
cv.Optional(CONF_HUMIDITY): cv.use_id(sensor.Sensor),
cv.Optional(CONF_TEMPERATURE): cv.use_id(sensor.Sensor),
cv.Optional(CONF_UPTIME): cv.use_id(sensor.Sensor),
}).extend(cv.polling_component_schema('60s')).extend(i2c.i2c_device_schema(0x58))
def to_code(config):
var = cg.new_Pvariable(config[CONF_ID])
yield cg.register_component(var, config)
yield i2c.register_i2c_device(var, config)
if CONF_ECO2 in config:
sens = yield sensor.new_sensor(config[CONF_ECO2])
cg.add(var.set_eco2_sensor(sens))
if CONF_TVOC in config:
sens = yield sensor.new_sensor(config[CONF_TVOC])
cg.add(var.set_tvoc_sensor(sens))
if CONF_BASELINE in config:
cg.add(var.set_baseline(config[CONF_BASELINE]))
if CONF_HUMIDITY in config:
sens = yield cg.get_variable(config[CONF_HUMIDITY])
cg.add(var.set_humidity_sensor(sens))
if CONF_TEMPERATURE in config:
sens = yield cg.get_variable(config[CONF_TEMPERATURE])
cg.add(var.set_temperature_sensor(sens))
if CONF_UPTIME in config:
sens = yield cg.get_variable(config[CONF_UPTIME])
cg.add(var.set_uptime_sensor(sens))

288
esphome/components/sgp30/sgp30.cpp Normal file
View File

@ -0,0 +1,288 @@
#include "sgp30.h"
#include "esphome/core/log.h"
namespace esphome {
namespace sgp30 {
static const char *TAG = "sgp30";
static const uint16_t SGP30_CMD_GET_SERIAL_ID = 0x3682;
static const uint16_t SGP30_CMD_GET_FEATURESET = 0x202f;
static const uint16_t SGP30_CMD_IAQ_INIT = 0x2003;
static const uint16_t SGP30_CMD_MEASURE_IAQ = 0x2008;
static const uint16_t SGP30_CMD_SET_ABSOLUTE_HUMIDITY = 0x2061;
static const uint16_t SGP30_CMD_GET_IAQ_BASELINE = 0x2015;
static const uint16_t SGP30_CMD_SET_IAQ_BASELINE = 0x201E;
/// Sensor baseline should first be relied on after 1H of operation,
/// if the sensor starts with a baseline value provided
const long IAQ_BASELINE_WARM_UP_SECONDS_WITH_BASELINE_PROVIDED = 3600;
/// Sensor baseline could first be relied on after 12H of operation,
/// if the sensor starts without any prior baseline value provided
const long IAQ_BASELINE_WARM_UP_SECONDS_WITHOUT_BASELINE = 43200;
void SGP30Component::setup() {
ESP_LOGCONFIG(TAG, "Setting up SGP30...");
///Serial Number identification
if (!this->write_command_(SGP30_CMD_GET_SERIAL_ID)) {
this->error_code_ = COMMUNICATION_FAILED;
this->mark_failed();
return;
}
uint16_t raw_serial_number[3];
if (!this->read_data_(raw_serial_number, 3)) {
this->mark_failed();
return;
}
this->serial_number_ = (uint64_t(raw_serial_number[0]) << 24) | \
(uint64_t(raw_serial_number[1]) << 16) | (uint64_t(uint32_t(raw_serial_number[2])));
ESP_LOGD(TAG, "Serial Number: %llu", this->serial_number_);
///Featureset identification for future use
if (!this->write_command_(SGP30_CMD_GET_FEATURESET)) {
this->mark_failed();
return;
}
uint16_t raw_featureset[1];
if (!this->read_data_(raw_featureset, 1)) {
this->mark_failed();
return;
}
this->featureset_ = raw_featureset[0];
if (uint16_t(this->featureset_>>12) != 0x0) {
if (uint16_t(this->featureset_>>12) == 0x1) {
///ID matching a different sensor: SGPC3
this->error_code_ = UNSUPPORTED_ID;
} else {
///Unknown ID
this->error_code_ = INVALID_ID;
}
this->mark_failed();
return;
}
ESP_LOGD(TAG, "Product version: 0x%0X", uint16_t(this->featureset_ & 0x1FF));
///Sensor initialization
if (!this->write_command_(SGP30_CMD_IAQ_INIT)) {
ESP_LOGE(TAG, "Sensor sgp30_iaq_init failed.");
this->error_code_ = MEASUREMENT_INIT_FAILED;
this->mark_failed();
return;
}
///Sensor baseline reliability timer
if (this->baseline_ > 0) {
this->required_warm_up_time = IAQ_BASELINE_WARM_UP_SECONDS_WITH_BASELINE_PROVIDED;
this->write_iaq_baseline(this->baseline_);
} else {
this->required_warm_up_time = IAQ_BASELINE_WARM_UP_SECONDS_WITHOUT_BASELINE;
}
}
bool SGP30Component::isSensorBaselineReliable() {
if (this->uptime_sensor_ != nullptr) {
return ((id(uptime_sensor_).state) >= this->required_warm_up_time);
}
return false;
}
void SGP30Component::read_iaq_baseline(){
if (this->isSensorBaselineReliable()) {
if (!this->write_command_(SGP30_CMD_GET_IAQ_BASELINE)) {
ESP_LOGD(TAG, "Error getting baseline");
this->status_set_warning();
return;
}
this->set_timeout(50, [this]() {
uint16_t raw_data[2];
if (!this->read_data_(raw_data, 2)) {
this->status_set_warning();
return;
}
uint8_t eco2baseline = (raw_data[0]);
uint8_t tvocbaseline = (raw_data[1]);
ESP_LOGI(TAG, "Current eCO2 & TVOC baseline: 0x%04X", uint16_t((eco2baseline << 8) | (tvocbaseline & 0xFF)));
this->status_clear_warning();
});
} else {
if (!isnan(id(uptime_sensor_).state))
ESP_LOGD(TAG, "Baseline reading not available for: %.0fs", (this->required_warm_up_time - id(uptime_sensor_).state));
}
}
void SGP30Component::send_env_data() {
bool compensation_possible = true;
if (this->humidity_sensor_ == nullptr && this->temperature_sensor_ == nullptr)
return;
float humidity = NAN;
if (this->humidity_sensor_ != nullptr)
humidity = this->humidity_sensor_->state;
if (isnan(humidity) || humidity < 0.0f || humidity > 100.0f) {
ESP_LOGW(TAG, "Compensation not possible yet: bad humidity data.");
compensation_possible = false;
} else {
ESP_LOGD(TAG, "External compensation data received: Humidity %0.2f%%", humidity);
}
float temperature = NAN;
if (this->temperature_sensor_ != nullptr) {
temperature = float(this->temperature_sensor_->state);
}
if (isnan(temperature) || temperature < -40.0f || temperature > 85.0f) {
compensation_possible = false;
ESP_LOGW(TAG, "Compensation not possible yet: bad temperature value data.");
} else {
ESP_LOGD(TAG, "External compensation data received: Temperature %0.2f°C", temperature);
}
if (compensation_possible) {
float absolute_humidity = 216.7f * (((humidity / 100) * 6.112f * \
exp((17.62f * temperature) / (243.12f + temperature))) / (273.15f + temperature));
uint8_t humidity_full = uint8_t(floor(absolute_humidity));
uint8_t humidity_dec = uint8_t(floor((absolute_humidity - floor(absolute_humidity)) * 256));
ESP_LOGD(TAG, "Calculated Absolute humidity: %0.3f g/m³ (0x%04X)", \
absolute_humidity, uint16_t(uint16_t(humidity_full) << 8 | uint16_t(humidity_dec)));
uint8_t crc = sht_crc(humidity_full, humidity_dec);
uint8_t data[4];
data[0] = SGP30_CMD_SET_ABSOLUTE_HUMIDITY & 0xFF;
data[1] = humidity_full;
data[2] = humidity_dec;
data[3] = crc;
if (!this->write_bytes(SGP30_CMD_SET_ABSOLUTE_HUMIDITY >>8, data, 4)) {
ESP_LOGE(TAG, "Error sending compensation data.");
}
}
}
void SGP30Component::write_iaq_baseline(uint16_t baseline) {
uint8_t eCO2_baseline = baseline >> 8;
uint8_t TVOC_baseline = baseline & 0xFF;
uint8_t data[4];
data[0] = SGP30_CMD_SET_IAQ_BASELINE & 0xFF;
data[1] = eCO2_baseline;
data[2] = TVOC_baseline;
data[3] = sht_crc(eCO2_baseline, TVOC_baseline);
if (!this->write_bytes(SGP30_CMD_SET_IAQ_BASELINE >>8, data, 4)) {
ESP_LOGE(TAG, "Error applying baseline: 0x%04X", baseline);
} else
ESP_LOGI(TAG, "Initial baseline 0x%04X applied successfully!", baseline);
}
void SGP30Component::dump_config() {
ESP_LOGCONFIG(TAG, "SGP30:");
LOG_I2C_DEVICE(this);
if (this->is_failed()) {
switch (this->error_code_) {
case COMMUNICATION_FAILED:
ESP_LOGW(TAG, "Communication failed! Is the sensor connected?");
break;
case MEASUREMENT_INIT_FAILED:
ESP_LOGW(TAG, "Measurement Initialization failed!");
break;
case INVALID_ID:
ESP_LOGW(TAG, "Sensor reported an invalid ID. Is this an SGP30?");
break;
case UNSUPPORTED_ID:
ESP_LOGW(TAG, "Sensor reported an unsupported ID (SGPC3).");
break;
default:
ESP_LOGW(TAG, "Unknown setup error!");
break;
}
} else {
ESP_LOGCONFIG(TAG, " Serial number: %llu", this->serial_number_);
ESP_LOGCONFIG(TAG, " Baseline: 0x%04X%s", this->baseline_, ((this->baseline_ != 0x0000) ? " (enabled)":" (disabled)"));
ESP_LOGCONFIG(TAG, " Warm up time: %lds", this->required_warm_up_time);
}
LOG_UPDATE_INTERVAL(this);
LOG_SENSOR(" ", "eCO2", this->eco2_sensor_);
LOG_SENSOR(" ", "TVOC", this->tvoc_sensor_);
}
void SGP30Component::update() {
if (!this->write_command_(SGP30_CMD_MEASURE_IAQ)) {
this->status_set_warning();
return;
}
this->set_timeout(50, [this]() {
uint16_t raw_data[2];
if (!this->read_data_(raw_data, 2)) {
this->status_set_warning();
return;
}
float eco2 = (raw_data[0]);
float tvoc = (raw_data[1]);
ESP_LOGD(TAG, "Got eCO2=%.1fppm TVOC=%.1fppb", eco2, tvoc);
if (this->eco2_sensor_ != nullptr)
this->eco2_sensor_->publish_state(eco2);
if (this->tvoc_sensor_ != nullptr)
this->tvoc_sensor_->publish_state(tvoc);
this->status_clear_warning();
this->send_env_data();
if (this->uptime_sensor_ != nullptr) {
this->read_iaq_baseline();
}
});
}
bool SGP30Component::write_command_(uint16_t command) {
// Warning ugly, trick the I2Ccomponent base by setting register to the first 8 bit.
return this->write_byte(command >> 8, command & 0xFF);
}
uint8_t SGP30Component::sht_crc(uint8_t data1, uint8_t data2) {
uint8_t bit;
uint8_t crc = 0xFF;
crc ^= data1;
for (bit = 8; bit > 0; --bit) {
if (crc & 0x80)
crc = (crc << 1) ^ 0x131;
else
crc = (crc << 1);
}
crc ^= data2;
for (bit = 8; bit > 0; --bit) {
if (crc & 0x80)
crc = (crc << 1) ^ 0x131;
else
crc = (crc << 1);
}
return crc;
}
bool SGP30Component::read_data_(uint16_t *data, uint8_t len) {
const uint8_t num_bytes = len * 3;
auto *buf = new uint8_t[num_bytes];
if (!this->parent_->raw_receive(this->address_, buf, num_bytes)) {
delete[](buf);
return false;
}
for (uint8_t i = 0; i < len; i++) {
const uint8_t j = 3 * i;
uint8_t crc = sht_crc(buf[j], buf[j + 1]);
if (crc != buf[j + 2]) {
ESP_LOGE(TAG, "CRC8 Checksum invalid! 0x%02X != 0x%02X", buf[j + 2], crc);
delete[](buf);
return false;
}
data[i] = (buf[j] << 8) | buf[j + 1];
}
delete[](buf);
return true;
}
} // namespace sgp30
} // namespace esphome

55
esphome/components/sgp30/sgp30.h Normal file
View File

@ -0,0 +1,55 @@
#pragma once
#include "esphome/core/component.h"
#include "esphome/components/sensor/sensor.h"
#include "esphome/components/i2c/i2c.h"
namespace esphome {
namespace sgp30 {
/// This class implements support for the Sensirion SGP30 i2c GAS (VOC and CO2eq) sensors.
class SGP30Component : public PollingComponent, public i2c::I2CDevice {
public:
void set_eco2_sensor(sensor::Sensor *eco2) { eco2_sensor_ = eco2; }
void set_tvoc_sensor(sensor::Sensor *tvoc) { tvoc_sensor_ = tvoc; }
void set_baseline(uint16_t baseline) { baseline_ = baseline; }
void set_humidity_sensor(sensor::Sensor *humidity) { humidity_sensor_ = humidity; }
void set_temperature_sensor(sensor::Sensor *temperature) { temperature_sensor_ = temperature; }
void set_uptime_sensor(sensor::Sensor *uptime) { uptime_sensor_ = uptime; }
void setup() override;
void update() override;
void dump_config() override;
float get_setup_priority() const override { return setup_priority::DATA; }
protected:
bool write_command_(uint16_t command);
bool read_data_(uint16_t *data, uint8_t len);
void send_env_data();
void read_iaq_baseline();
bool isSensorBaselineReliable();
void write_iaq_baseline(uint16_t baseline);
uint8_t sht_crc(uint8_t data1, uint8_t data2);
uint64_t serial_number_;
uint16_t featureset_;
long required_warm_up_time;
enum ErrorCode {
COMMUNICATION_FAILED,
MEASUREMENT_INIT_FAILED,
INVALID_ID,
UNSUPPORTED_ID,
UNKNOWN
} error_code_{UNKNOWN};
sensor::Sensor *eco2_sensor_{nullptr};
sensor::Sensor *tvoc_sensor_{nullptr};
uint16_t baseline_{0x0000};
/// Input sensor for humidity and temperature compensation.
sensor::Sensor *humidity_sensor_{nullptr};
sensor::Sensor *temperature_sensor_{nullptr};
sensor::Sensor *uptime_sensor_{nullptr};
};
} // namespace sgp30
} // namespace esphome