mirror of
https://github.com/wled/WLED.git
synced 2025-04-19 20:37:23 +00:00
b8685f2c39
Redesign the usermod system so that usermods are implemented as PlatformIO libraries instead of headers. This permits them to call for dependencies, and eliminates the compiler flags for enabling each one, allowing the build cache to behave better. The usermod list is built using some linker magic to construct a static list in ROM memory. This eliminates the need for wasting SRAM on something fixed at build time.
91 lines
4.7 KiB
C++
91 lines
4.7 KiB
C++
#include "wled.h"
|
|
/*
|
|
* Registration and management utility for v2 usermods
|
|
*/
|
|
|
|
// Global usermod instance list
|
|
// Table begin and end references
|
|
// Zero-length arrays -- so they'll get assigned addresses, but consume no flash
|
|
// The numeric suffix ensures they're put in the right place; the linker script will sort them
|
|
// We stick them in the '.dtors' segment because it's always included by the linker scripts
|
|
// even though it never gets called. Who calls exit() in an embedded program anyways?
|
|
// If someone ever does, though, it'll explode as these aren't function pointers.
|
|
static Usermod * const _usermod_table_begin[0] __attribute__((__section__(".dtors.tbl.usermods.0"), unused)) = {};
|
|
static Usermod * const _usermod_table_end[0] __attribute__((__section__(".dtors.tbl.usermods.99"), unused)) = {};
|
|
|
|
static size_t getCount() {
|
|
return &_usermod_table_end[0] - &_usermod_table_begin[0];
|
|
}
|
|
|
|
|
|
//Usermod Manager internals
|
|
void UsermodManager::setup() { for (auto mod = _usermod_table_begin; mod < _usermod_table_end; ++mod) (*mod)->setup(); }
|
|
void UsermodManager::connected() { for (auto mod = _usermod_table_begin; mod < _usermod_table_end; ++mod) (*mod)->connected(); }
|
|
void UsermodManager::loop() { for (auto mod = _usermod_table_begin; mod < _usermod_table_end; ++mod) (*mod)->loop(); }
|
|
void UsermodManager::handleOverlayDraw() { for (auto mod = _usermod_table_begin; mod < _usermod_table_end; ++mod) (*mod)->handleOverlayDraw(); }
|
|
void UsermodManager::appendConfigData(Print& dest) { for (auto mod = _usermod_table_begin; mod < _usermod_table_end; ++mod) (*mod)->appendConfigData(dest); }
|
|
bool UsermodManager::handleButton(uint8_t b) {
|
|
bool overrideIO = false;
|
|
for (auto mod = _usermod_table_begin; mod < _usermod_table_end; ++mod) {
|
|
if ((*mod)->handleButton(b)) overrideIO = true;
|
|
}
|
|
return overrideIO;
|
|
}
|
|
bool UsermodManager::getUMData(um_data_t **data, uint8_t mod_id) {
|
|
for (auto mod = _usermod_table_begin; mod < _usermod_table_end; ++mod) {
|
|
if (mod_id > 0 && (*mod)->getId() != mod_id) continue; // only get data form requested usermod if provided
|
|
if ((*mod)->getUMData(data)) return true; // if usermod does provide data return immediately (only one usermod can provide data at one time)
|
|
}
|
|
return false;
|
|
}
|
|
void UsermodManager::addToJsonState(JsonObject& obj) { for (auto mod = _usermod_table_begin; mod < _usermod_table_end; ++mod) (*mod)->addToJsonState(obj); }
|
|
void UsermodManager::addToJsonInfo(JsonObject& obj) { for (auto mod = _usermod_table_begin; mod < _usermod_table_end; ++mod) (*mod)->addToJsonInfo(obj); }
|
|
void UsermodManager::readFromJsonState(JsonObject& obj) { for (auto mod = _usermod_table_begin; mod < _usermod_table_end; ++mod) (*mod)->readFromJsonState(obj); }
|
|
void UsermodManager::addToConfig(JsonObject& obj) { for (auto mod = _usermod_table_begin; mod < _usermod_table_end; ++mod) (*mod)->addToConfig(obj); }
|
|
bool UsermodManager::readFromConfig(JsonObject& obj) {
|
|
bool allComplete = true;
|
|
for (auto mod = _usermod_table_begin; mod < _usermod_table_end; ++mod) {
|
|
if (!(*mod)->readFromConfig(obj)) allComplete = false;
|
|
}
|
|
return allComplete;
|
|
}
|
|
#ifndef WLED_DISABLE_MQTT
|
|
void UsermodManager::onMqttConnect(bool sessionPresent) { for (auto mod = _usermod_table_begin; mod < _usermod_table_end; ++mod) (*mod)->onMqttConnect(sessionPresent); }
|
|
bool UsermodManager::onMqttMessage(char* topic, char* payload) {
|
|
for (auto mod = _usermod_table_begin; mod < _usermod_table_end; ++mod) if ((*mod)->onMqttMessage(topic, payload)) return true;
|
|
return false;
|
|
}
|
|
#endif
|
|
#ifndef WLED_DISABLE_ESPNOW
|
|
bool UsermodManager::onEspNowMessage(uint8_t* sender, uint8_t* payload, uint8_t len) {
|
|
for (auto mod = _usermod_table_begin; mod < _usermod_table_end; ++mod) if ((*mod)->onEspNowMessage(sender, payload, len)) return true;
|
|
return false;
|
|
}
|
|
#endif
|
|
void UsermodManager::onUpdateBegin(bool init) { for (auto mod = _usermod_table_begin; mod < _usermod_table_end; ++mod) (*mod)->onUpdateBegin(init); } // notify usermods that update is to begin
|
|
void UsermodManager::onStateChange(uint8_t mode) { for (auto mod = _usermod_table_begin; mod < _usermod_table_end; ++mod) (*mod)->onStateChange(mode); } // notify usermods that WLED state changed
|
|
|
|
/*
|
|
* Enables usermods to lookup another Usermod.
|
|
*/
|
|
Usermod* UsermodManager::lookup(uint16_t mod_id) {
|
|
for (auto mod = _usermod_table_begin; mod < _usermod_table_end; ++mod) {
|
|
if ((*mod)->getId() == mod_id) {
|
|
return *mod;
|
|
}
|
|
}
|
|
return nullptr;
|
|
}
|
|
|
|
size_t UsermodManager::getModCount() { return getCount(); };
|
|
|
|
/* Usermod v2 interface shim for oappend */
|
|
Print* Usermod::oappend_shim = nullptr;
|
|
|
|
void Usermod::appendConfigData(Print& settingsScript) {
|
|
assert(!oappend_shim);
|
|
oappend_shim = &settingsScript;
|
|
this->appendConfigData();
|
|
oappend_shim = nullptr;
|
|
}
|