c928df9d70
Moved initDone, addToConfig and readFromConfig to Usermod superclass
Updated cleanup procedure:
Part 1
- remove bool enabled = false/true (now default false)
- remove static const char _name[] and _enabled[]
- add constructor which calls superclass (temp?): XXXUsermod(const char *name, bool enabled):Usermod(name, enabled) {}
- replace _enabled with "enabled"
- remove const char PROGMEM init for _name[] and _enabled[]
Part 2
- Remove bool initDone = false;
- addToConfig: replace createNestedObject with Usermod::addToConfig(root); JsonObject top = root[FPSTR(_name)];
- readFromConfig: replace !top.isNull and enabled with bool configComplete = Usermod::readFromConfig(root);JsonObject top = root[FPSTR(_name)];
See Temperature, MPU6050 and weather as examples (rest to be done)
80 lines
3.5 KiB
C++
80 lines
3.5 KiB
C++
#include "wled.h"
|
|
/*
|
|
* Registration and management utility for v2 usermods
|
|
*/
|
|
|
|
//Usermod Manager internals
|
|
void UsermodManager::setup() { for (byte i = 0; i < numMods; i++) ums[i]->setup(); }
|
|
void UsermodManager::connected() { for (byte i = 0; i < numMods; i++) ums[i]->connected(); }
|
|
void UsermodManager::loop() { for (byte i = 0; i < numMods; i++) ums[i]->loop(); }
|
|
void UsermodManager::handleOverlayDraw() { for (byte i = 0; i < numMods; i++) ums[i]->handleOverlayDraw(); }
|
|
// void UsermodManager::appendConfigData() { for (byte i = 0; i < numMods; i++) ums[i]->appendConfigData(); } //WLEDMM not used
|
|
bool UsermodManager::handleButton(uint8_t b) {
|
|
bool overrideIO = false;
|
|
for (byte i = 0; i < numMods; i++) {
|
|
if (ums[i]->handleButton(b)) overrideIO = true;
|
|
}
|
|
return overrideIO;
|
|
}
|
|
bool UsermodManager::getUMData(um_data_t **data, uint8_t mod_id) {
|
|
for (byte i = 0; i < numMods; i++) {
|
|
if (mod_id > 0 && ums[i]->getId() != mod_id) continue; // only get data form requested usermod if provided
|
|
if (ums[i]->getUMData(data)) return true; // if usermod does provide data return immediately (only one usermod can povide data at one time)
|
|
}
|
|
return false;
|
|
}
|
|
void UsermodManager::addToJsonState(JsonObject& obj) { for (byte i = 0; i < numMods; i++) ums[i]->addToJsonState(obj); }
|
|
void UsermodManager::addToJsonInfo(JsonObject& obj) { for (byte i = 0; i < numMods; i++) ums[i]->addToJsonInfo(obj); }
|
|
void UsermodManager::readFromJsonState(JsonObject& obj) { for (byte i = 0; i < numMods; i++) ums[i]->readFromJsonState(obj); }
|
|
void UsermodManager::addToConfig(JsonObject& obj) { for (byte i = 0; i < numMods; i++) ums[i]->addToConfig(obj); }
|
|
bool UsermodManager::readFromConfig(JsonObject& obj) {
|
|
bool allComplete = true;
|
|
for (byte i = 0; i < numMods; i++) {
|
|
if (!ums[i]->readFromConfig(obj)) allComplete = false;
|
|
}
|
|
return allComplete;
|
|
}
|
|
void UsermodManager::onMqttConnect(bool sessionPresent) { for (byte i = 0; i < numMods; i++) ums[i]->onMqttConnect(sessionPresent); }
|
|
bool UsermodManager::onMqttMessage(char* topic, char* payload) {
|
|
for (byte i = 0; i < numMods; i++) if (ums[i]->onMqttMessage(topic, payload)) return true;
|
|
return false;
|
|
}
|
|
void UsermodManager::onUpdateBegin(bool init) { for (byte i = 0; i < numMods; i++) ums[i]->onUpdateBegin(init); } // notify usermods that update is to begin
|
|
void UsermodManager::onStateChange(uint8_t mode) { for (byte i = 0; i < numMods; i++) ums[i]->onStateChange(mode); } // notify usermods that WLED state changed
|
|
|
|
/*
|
|
* Enables usermods to lookup another Usermod.
|
|
*/
|
|
Usermod* UsermodManager::lookup(uint16_t mod_id) {
|
|
for (byte i = 0; i < numMods; i++) {
|
|
if (ums[i]->getId() == mod_id) {
|
|
return ums[i];
|
|
}
|
|
}
|
|
return nullptr;
|
|
}
|
|
|
|
//WLEDMM: used by Usermods in xml.cpp
|
|
Usermod* UsermodManager::lookupName(const char *mod_name) {
|
|
//WLEDMM: hack to get the usermod object with the mod_name (better would be to store the usermod name in the class but that requires change to all usermods)
|
|
for (byte i = 0; i < numMods; i++) {
|
|
// StaticJsonDocument <1024> docx;
|
|
JsonObject um = doc.createNestedObject("um"); //WLEDMM reuse the global doc variable here
|
|
|
|
ums[i]->addToConfig(um);
|
|
|
|
//check the name in the config of ums[i]
|
|
for (JsonPair kv : um) {
|
|
if (strcmp(kv.key().c_str(), mod_name) == 0) return ums[i]; //if same as mod_name, return this mod
|
|
}
|
|
}
|
|
return nullptr;
|
|
}
|
|
|
|
bool UsermodManager::add(Usermod* um)
|
|
{
|
|
if (numMods >= WLED_MAX_USERMODS || um == nullptr) return false;
|
|
ums[numMods++] = um;
|
|
return true;
|
|
}
|