WLED/usermods/sht/usermod_sht.h

490 lines
14 KiB
C
Raw Normal View History

2023-01-12 20:35:34 +01:00
#ifndef WLED_ENABLE_MQTT
#error "This user mod requires MQTT to be enabled."
#endif
2022-12-11 01:16:14 +01:00
#pragma once
#include "SHT85.h"
#define USERMOD_SHT_TYPE_SHT30 0
#define USERMOD_SHT_TYPE_SHT31 1
#define USERMOD_SHT_TYPE_SHT35 2
#define USERMOD_SHT_TYPE_SHT85 3
2022-12-11 01:16:14 +01:00
class ShtUsermod : public Usermod
{
private:
2022-12-15 01:38:41 +01:00
bool enabled = false; // Is usermod enabled or not
bool firstRunDone = false; // Remembers if the first config load run had been done
2022-12-16 02:22:13 +01:00
bool pinAllocDone = true; // Remembers if we have allocated pins
2022-12-15 01:38:41 +01:00
bool initDone = false; // Remembers if the mod has been completely initialised
bool haMqttDiscovery = false; // Is MQTT discovery enabled or not
bool haMqttDiscoveryDone = false; // Remembers if we already published the HA discovery topics
2022-12-11 01:16:14 +01:00
// SHT vars
2023-05-10 21:09:28 +02:00
SHT *shtTempHumidSensor = nullptr; // Instance of SHT lib
2022-12-15 01:38:41 +01:00
byte shtType = 0; // SHT sensor type to be used. Default: SHT30
byte unitOfTemp = 0; // Temperature unit to be used. Default: Celsius (0 = Celsius, 1 = Fahrenheit)
bool shtInitDone = false; // Remembers if SHT sensor has been initialised
bool shtReadDataSuccess = false; // Did we have a successful data read and is a valid temperature and humidity available?
const byte shtI2cAddress = 0x44; // i2c address of the sensor. 0x44 is the default for all SHT sensors. Change this, if needed
unsigned long shtLastTimeUpdated = 0; // Remembers when we read data the last time
bool shtDataRequested = false; // Reading data is done async. This remembers if we asked the sensor to read data
2022-12-25 11:02:50 +01:00
float shtCurrentTempC = 0.0f; // Last read temperature in Celsius
float shtCurrentHumidity = 0.0f; // Last read humidity in RH%
2022-12-11 01:16:14 +01:00
2022-12-15 00:42:27 +01:00
void initShtTempHumiditySensor();
void cleanupShtTempHumiditySensor();
void cleanup();
2023-05-10 21:09:28 +02:00
inline bool isShtReady() { return shtInitDone; } // Checks if the SHT sensor has been initialised.
2022-12-11 01:16:14 +01:00
2022-12-15 00:42:27 +01:00
void publishTemperatureAndHumidityViaMqtt();
void publishHomeAssistantAutodiscovery();
void appendDeviceToMqttDiscoveryMessage(JsonDocument& root);
2022-12-11 01:16:14 +01:00
public:
2022-12-15 01:38:41 +01:00
// Strings to reduce flash memory usage (used more than twice)
2022-12-11 01:16:14 +01:00
static const char _name[];
static const char _enabled[];
static const char _shtType[];
2022-12-12 02:33:31 +01:00
static const char _unitOfTemp[];
2022-12-15 00:42:27 +01:00
static const char _haMqttDiscovery[];
2022-12-11 01:16:14 +01:00
2022-12-15 00:42:27 +01:00
void setup();
void loop();
void onMqttConnect(bool sessionPresent);
void appendConfigData();
void addToConfig(JsonObject &root);
bool readFromConfig(JsonObject &root);
void addToJsonInfo(JsonObject& root);
2022-12-11 01:16:14 +01:00
bool isEnabled() { return enabled; }
float getTemperature();
float getTemperatureC() { return roundf(shtCurrentTempC * 10.0f) / 10.0f; }
float getTemperatureF() { return (getTemperatureC() * 1.8f) + 32.0f; }
float getHumidity() { return roundf(shtCurrentHumidity * 10.0f) / 10.0f; }
const char* getUnitString();
2022-12-11 01:16:14 +01:00
2022-12-15 00:42:27 +01:00
uint16_t getId() { return USERMOD_ID_SHT; }
};
2022-12-11 01:16:14 +01:00
2022-12-15 01:38:41 +01:00
// Strings to reduce flash memory usage (used more than twice)
2022-12-25 11:02:50 +01:00
const char ShtUsermod::_name[] PROGMEM = "SHT-Sensor";
const char ShtUsermod::_enabled[] PROGMEM = "Enabled";
const char ShtUsermod::_shtType[] PROGMEM = "SHT-Type";
const char ShtUsermod::_unitOfTemp[] PROGMEM = "Unit";
2022-12-15 00:42:27 +01:00
const char ShtUsermod::_haMqttDiscovery[] PROGMEM = "Add-To-HA-MQTT-Discovery";
2022-12-11 01:16:14 +01:00
2022-12-15 01:38:41 +01:00
/**
* Initialise SHT sensor.
*
* Using the correct constructor according to config and initialises it using the
* global i2c pins.
*
* @return void
*/
2022-12-15 00:42:27 +01:00
void ShtUsermod::initShtTempHumiditySensor()
{
switch (shtType) {
case USERMOD_SHT_TYPE_SHT30: shtTempHumidSensor = (SHT *) new SHT30(); break;
case USERMOD_SHT_TYPE_SHT31: shtTempHumidSensor = (SHT *) new SHT31(); break;
case USERMOD_SHT_TYPE_SHT35: shtTempHumidSensor = (SHT *) new SHT35(); break;
case USERMOD_SHT_TYPE_SHT85: shtTempHumidSensor = (SHT *) new SHT85(); break;
}
shtTempHumidSensor->begin(shtI2cAddress, i2c_sda, i2c_scl);
if (shtTempHumidSensor->readStatus() == 0xFFFF) {
DEBUG_PRINTF("[%s] SHT init failed!\n", _name);
cleanup();
return;
}
shtInitDone = true;
}
2022-12-15 01:38:41 +01:00
/**
* Cleanup the SHT sensor.
*
* Properly calls "reset" for the sensor then releases it from memory.
*
* @return void
*/
2022-12-15 00:42:27 +01:00
void ShtUsermod::cleanupShtTempHumiditySensor()
{
2023-05-10 21:09:28 +02:00
if (isShtReady()) {
shtTempHumidSensor->reset();
delete shtTempHumidSensor;
shtTempHumidSensor = nullptr;
}
2022-12-15 00:42:27 +01:00
shtInitDone = false;
}
2022-12-11 01:16:14 +01:00
2022-12-15 01:38:41 +01:00
/**
* Cleanup the mod completely.
*
* Calls ::cleanupShtTempHumiditySensor() to cleanup the SHT sensor and
* deallocates pins.
*
* @return void
*/
2022-12-15 00:42:27 +01:00
void ShtUsermod::cleanup()
{
2022-12-25 11:02:50 +01:00
cleanupShtTempHumiditySensor();
2022-12-11 01:16:14 +01:00
2022-12-16 02:22:13 +01:00
if (pinAllocDone) {
PinManagerPinType pins[2] = { { i2c_sda, true }, { i2c_scl, true } };
pinManager.deallocateMultiplePins(pins, 2, PinOwner::HW_I2C);
pinAllocDone = false;
}
2022-12-15 00:42:27 +01:00
enabled = false;
}
2022-12-11 01:16:14 +01:00
2022-12-15 01:38:41 +01:00
/**
* Publish temperature and humidity to WLED device topic.
*
* Will add a "/temperature" and "/humidity" topic to the WLED device topic.
* Temperature will be written in configured unit.
*
* @return void
*/
2022-12-15 00:42:27 +01:00
void ShtUsermod::publishTemperatureAndHumidityViaMqtt() {
if (!WLED_MQTT_CONNECTED) return;
char buf[128];
snprintf_P(buf, 127, PSTR("%s/temperature"), mqttDeviceTopic);
mqtt->publish(buf, 0, false, String(getTemperature()).c_str());
snprintf_P(buf, 127, PSTR("%s/humidity"), mqttDeviceTopic);
mqtt->publish(buf, 0, false, String(getHumidity()).c_str());
2022-12-15 00:42:27 +01:00
}
2022-12-15 01:38:41 +01:00
/**
* If enabled, publishes HA MQTT device discovery topics.
*
* Will make Home Assistant add temperature and humidity as entities automatically.
*
* Note: Whenever usermods are part of the WLED integration in HA, this can be dropped.
*
* @return void
*/
2022-12-15 00:42:27 +01:00
void ShtUsermod::publishHomeAssistantAutodiscovery() {
if (!WLED_MQTT_CONNECTED) return;
char json_str[1024], buf[128];
size_t payload_size;
StaticJsonDocument<1024> json;
snprintf_P(buf, 127, PSTR("%s Temperature"), serverDescription);
2022-12-15 00:42:27 +01:00
json[F("name")] = buf;
snprintf_P(buf, 127, PSTR("%s/temperature"), mqttDeviceTopic);
2022-12-15 00:42:27 +01:00
json[F("stat_t")] = buf;
json[F("dev_cla")] = F("temperature");
json[F("stat_cla")] = F("measurement");
snprintf_P(buf, 127, PSTR("%s-temperature"), escapedMac.c_str());
2022-12-15 00:42:27 +01:00
json[F("uniq_id")] = buf;
2022-12-20 23:58:11 +01:00
json[F("unit_of_meas")] = unitOfTemp ? F("°F") : F("°C");
2022-12-15 00:42:27 +01:00
appendDeviceToMqttDiscoveryMessage(json);
payload_size = serializeJson(json, json_str);
snprintf_P(buf, 127, PSTR("homeassistant/sensor/%s/%s-temperature/config"), escapedMac.c_str(), escapedMac.c_str());
2022-12-15 00:42:27 +01:00
mqtt->publish(buf, 0, true, json_str, payload_size);
json.clear();
snprintf_P(buf, 127, PSTR("%s Humidity"), serverDescription);
2022-12-15 00:42:27 +01:00
json[F("name")] = buf;
snprintf_P(buf, 127, PSTR("%s/humidity"), mqttDeviceTopic);
2022-12-15 00:42:27 +01:00
json[F("stat_t")] = buf;
json[F("dev_cla")] = F("humidity");
json[F("stat_cla")] = F("measurement");
snprintf_P(buf, 127, PSTR("%s-humidity"), escapedMac.c_str());
2022-12-15 00:42:27 +01:00
json[F("uniq_id")] = buf;
json[F("unit_of_meas")] = F("%");
appendDeviceToMqttDiscoveryMessage(json);
payload_size = serializeJson(json, json_str);
snprintf_P(buf, 127, PSTR("homeassistant/sensor/%s/%s-humidity/config"), escapedMac.c_str(), escapedMac.c_str());
2022-12-15 00:42:27 +01:00
mqtt->publish(buf, 0, true, json_str, payload_size);
2022-12-15 01:38:41 +01:00
haMqttDiscoveryDone = true;
2022-12-15 00:42:27 +01:00
}
2022-12-15 01:38:41 +01:00
/**
* Helper to add device information to MQTT discovery topic.
*
* @return void
*/
2022-12-15 00:42:27 +01:00
void ShtUsermod::appendDeviceToMqttDiscoveryMessage(JsonDocument& root) {
2022-12-25 11:02:50 +01:00
JsonObject device = root.createNestedObject(F("dev"));
2022-12-15 00:42:27 +01:00
device[F("ids")] = escapedMac.c_str();
device[F("name")] = serverDescription;
device[F("sw")] = versionString;
device[F("mdl")] = ESP.getChipModel();
device[F("mf")] = F("espressif");
}
2022-12-15 01:38:41 +01:00
/**
* Setup the mod.
*
* Allocates i2c pins as PinOwner::HW_I2C, so they can be allocated multiple times.
* And calls ::initShtTempHumiditySensor() to initialise the sensor.
*
* @see Usermod::setup()
* @see UsermodManager::setup()
*
* @return void
*/
2022-12-15 00:42:27 +01:00
void ShtUsermod::setup()
{
if (enabled) {
PinManagerPinType pins[2] = { { i2c_sda, true }, { i2c_scl, true } };
2022-12-18 21:33:25 +01:00
// GPIOs can be set to -1 and allocateMultiplePins() will return true, so check they're gt zero
if (i2c_sda < 0 || i2c_scl < 0 || !pinManager.allocateMultiplePins(pins, 2, PinOwner::HW_I2C)) {
2022-12-15 00:42:27 +01:00
DEBUG_PRINTF("[%s] SHT pin allocation failed!\n", _name);
cleanup();
return;
}
2022-12-16 02:22:13 +01:00
pinAllocDone = true;
2022-12-11 01:16:14 +01:00
2022-12-15 00:42:27 +01:00
initShtTempHumiditySensor();
initDone = true;
}
firstRunDone = true;
}
2022-12-15 01:38:41 +01:00
/**
* Actually reading data (async) from the sensor every 30 seconds.
*
* If last reading is at least 30 seconds, it will trigger a reading using
* SHT::requestData(). We will then continiously check SHT::dataReady() if
* data is ready to be read. If so, it's read, stored locally and published
* via MQTT.
*
* @see Usermod::loop()
* @see UsermodManager::loop()
*
* @return void
*/
2022-12-15 00:42:27 +01:00
void ShtUsermod::loop()
{
if (!enabled || !initDone || strip.isUpdating()) return;
2022-12-15 00:42:27 +01:00
if (isShtReady()) {
if (millis() - shtLastTimeUpdated > 30000 && !shtDataRequested) {
shtTempHumidSensor->requestData();
shtDataRequested = true;
2022-12-11 01:16:14 +01:00
2022-12-15 00:42:27 +01:00
shtLastTimeUpdated = millis();
2022-12-11 01:16:14 +01:00
}
2022-12-15 00:42:27 +01:00
if (shtDataRequested) {
if (shtTempHumidSensor->dataReady()) {
if (shtTempHumidSensor->readData(false)) {
shtCurrentTempC = shtTempHumidSensor->getTemperature();
shtCurrentHumidity = shtTempHumidSensor->getHumidity();
2022-12-11 01:16:14 +01:00
2022-12-15 00:42:27 +01:00
publishTemperatureAndHumidityViaMqtt();
shtReadDataSuccess = true;
2022-12-25 11:02:50 +01:00
} else {
2022-12-15 00:42:27 +01:00
shtReadDataSuccess = false;
2022-12-11 01:16:14 +01:00
}
2022-12-15 00:42:27 +01:00
shtDataRequested = false;
2022-12-11 01:16:14 +01:00
}
2022-12-15 00:42:27 +01:00
}
}
}
2022-12-15 01:38:41 +01:00
/**
* Whenever MQTT is connected, publish HA autodiscovery topics.
*
* Is only donce once.
*
* @see Usermod::onMqttConnect()
* @see UsermodManager::onMqttConnect()
*
* @return void
*/
2022-12-15 00:42:27 +01:00
void ShtUsermod::onMqttConnect(bool sessionPresent) {
2022-12-15 01:38:41 +01:00
if (haMqttDiscovery && !haMqttDiscoveryDone) publishHomeAssistantAutodiscovery();
2022-12-15 00:42:27 +01:00
}
2022-12-15 01:38:41 +01:00
/**
* Add dropdown for sensor type and unit to UM config page.
*
* @see Usermod::appendConfigData()
* @see UsermodManager::appendConfigData()
*
* @return void
*/
2022-12-15 00:42:27 +01:00
void ShtUsermod::appendConfigData() {
oappend(SET_F("dd=addDropdown('"));
oappend(_name);
oappend(SET_F("','"));
oappend(_shtType);
oappend(SET_F("');"));
oappend(SET_F("addOption(dd,'SHT30',0);"));
oappend(SET_F("addOption(dd,'SHT31',1);"));
oappend(SET_F("addOption(dd,'SHT35',2);"));
oappend(SET_F("addOption(dd,'SHT85',3);"));
oappend(SET_F("dd=addDropdown('"));
oappend(_name);
oappend(SET_F("','"));
oappend(_unitOfTemp);
oappend(SET_F("');"));
oappend(SET_F("addOption(dd,'Celsius',0);"));
oappend(SET_F("addOption(dd,'Fahrenheit',1);"));
}
2022-12-15 01:38:41 +01:00
/**
* Add config data to be stored in cfg.json.
*
* @see Usermod::addToConfig()
* @see UsermodManager::addToConfig()
*
* @return void
*/
2022-12-15 00:42:27 +01:00
void ShtUsermod::addToConfig(JsonObject &root)
{
JsonObject top = root.createNestedObject(FPSTR(_name)); // usermodname
top[FPSTR(_enabled)] = enabled;
top[FPSTR(_shtType)] = shtType;
top[FPSTR(_unitOfTemp)] = unitOfTemp;
top[FPSTR(_haMqttDiscovery)] = haMqttDiscovery;
}
/**
2022-12-15 01:38:41 +01:00
* Apply config on boot or save of UM config page.
2022-12-15 00:42:27 +01:00
*
2022-12-15 01:38:41 +01:00
* This is called whenever WLED boots and loads cfg.json, or when the UM config
* page is saved. Will properly re-instantiate the SHT class upon type change and
* publish HA discovery after enabling.
*
* @see Usermod::readFromConfig()
* @see UsermodManager::readFromConfig()
*
* @return bool
2022-12-15 00:42:27 +01:00
*/
bool ShtUsermod::readFromConfig(JsonObject &root)
{
JsonObject top = root[FPSTR(_name)];
if (top.isNull()) {
DEBUG_PRINTF("[%s] No config found. (Using defaults.)\n", _name);
return false;
}
bool oldEnabled = enabled;
byte oldShtType = shtType;
byte oldUnitOfTemp = unitOfTemp;
2022-12-15 00:42:27 +01:00
bool oldHaMqttDiscovery = haMqttDiscovery;
getJsonValue(top[FPSTR(_enabled)], enabled);
getJsonValue(top[FPSTR(_shtType)], shtType);
getJsonValue(top[FPSTR(_unitOfTemp)], unitOfTemp);
getJsonValue(top[FPSTR(_haMqttDiscovery)], haMqttDiscovery);
// First run: reading from cfg.json, nothing to do here, will be all done in setup()
if (!firstRunDone) {
DEBUG_PRINTF("[%s] First run, nothing to do\n", _name);
}
// Check if mod has been en-/disabled
else if (enabled != oldEnabled) {
enabled ? setup() : cleanup();
DEBUG_PRINTF("[%s] Usermod has been en-/disabled\n", _name);
}
// Config has been changed, so adopt to changes
else if (enabled) {
if (oldShtType != shtType) {
cleanupShtTempHumiditySensor();
initShtTempHumiditySensor();
2022-12-11 01:16:14 +01:00
}
if (oldUnitOfTemp != unitOfTemp) {
publishTemperatureAndHumidityViaMqtt();
publishHomeAssistantAutodiscovery();
}
2022-12-15 01:38:41 +01:00
if (oldHaMqttDiscovery != haMqttDiscovery && haMqttDiscovery) {
publishHomeAssistantAutodiscovery();
}
2022-12-15 00:42:27 +01:00
DEBUG_PRINTF("[%s] Config (re)loaded\n", _name);
}
2022-12-11 01:16:14 +01:00
2022-12-15 00:42:27 +01:00
return true;
}
2022-12-11 01:16:14 +01:00
2022-12-15 01:38:41 +01:00
/**
* Adds the temperature and humidity actually to the info section and /json info.
*
* This is called every time the info section is opened ot /json is called.
*
* @see Usermod::addToJsonInfo()
* @see UsermodManager::addToJsonInfo()
*
* @return void
*/
2022-12-15 00:42:27 +01:00
void ShtUsermod::addToJsonInfo(JsonObject& root)
{
if (!enabled && !isShtReady()) {
return;
}
JsonObject user = root["u"];
if (user.isNull()) user = root.createNestedObject("u");
JsonArray jsonTemp = user.createNestedArray(F("Temperature"));
JsonArray jsonHumidity = user.createNestedArray(F("Humidity"));
if (shtLastTimeUpdated == 0 || !shtReadDataSuccess) {
jsonTemp.add(0);
jsonHumidity.add(0);
if (shtLastTimeUpdated == 0) {
jsonTemp.add(F(" Not read yet"));
jsonHumidity.add(F(" Not read yet"));
2022-12-25 11:02:50 +01:00
} else {
2022-12-15 00:42:27 +01:00
jsonTemp.add(F(" Error"));
jsonHumidity.add(F(" Error"));
2022-12-11 01:16:14 +01:00
}
2022-12-15 00:42:27 +01:00
return;
}
2022-12-12 02:33:31 +01:00
jsonHumidity.add(getHumidity());
2022-12-15 00:42:27 +01:00
jsonHumidity.add(F(" RH"));
2022-12-12 02:33:31 +01:00
jsonTemp.add(getTemperature());
2023-05-10 21:09:28 +02:00
jsonTemp.add(getUnitString());
// sensor object
JsonObject sensor = root[F("sensor")];
if (sensor.isNull()) sensor = root.createNestedObject(F("sensor"));
jsonTemp = sensor.createNestedArray(F("temp"));
jsonTemp.add(getTemperature());
jsonTemp.add(getUnitString());
jsonHumidity = sensor.createNestedArray(F("humidity"));
jsonHumidity.add(getHumidity());
jsonHumidity.add(F(" RH"));
2022-12-15 00:42:27 +01:00
}
2022-12-11 01:16:14 +01:00
2022-12-15 01:38:41 +01:00
/**
* Getter for last read temperature for configured unit.
2022-12-15 01:38:41 +01:00
*
* @return float
*/
float ShtUsermod::getTemperature() {
return unitOfTemp ? getTemperatureF() : getTemperatureC();
2022-12-15 00:42:27 +01:00
}
2022-12-15 01:38:41 +01:00
/**
* Returns the current configured unit as human readable string.
2022-12-15 01:38:41 +01:00
*
* @return const char*
2022-12-15 01:38:41 +01:00
*/
const char* ShtUsermod::getUnitString() {
return unitOfTemp ? "°F" : "°C";
2022-12-15 00:42:27 +01:00
}