mirror of
https://github.com/wled/WLED.git
synced 2026-03-13 08:29:49 +08:00
b97b46ae12
Use a custom linker section to hold dynamic arrays such as the usermod list. This provides an extensible solution for wider use in the future (such as FX or Bus drivers), as well as IDF v5 compatibility.
101 lines
5.0 KiB
C++
101 lines
5.0 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__(".dynarray.usermods.0"), unused)) = {};
|
|
static Usermod * const _usermod_table_end[0] __attribute__((__section__(".dynarray.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) {
|
|
auto um_id_list = obj.createNestedArray("um");
|
|
for (auto mod = _usermod_table_begin; mod < _usermod_table_end; ++mod) {
|
|
um_id_list.add((*mod)->getId());
|
|
(*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
|
|
bool UsermodManager::onUdpPacket(uint8_t* payload, size_t len) {
|
|
for (auto mod = _usermod_table_begin; mod < _usermod_table_end; ++mod) if ((*mod)->onUdpPacket(payload, len)) return true;
|
|
return false;
|
|
}
|
|
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;
|
|
}
|