andry/EMS-ESP32
1
0
Fork 0
mirror of https://github.com/emsesp/EMS-ESP32.git synced 2026-06-13 19:36:26 +03:00
Code Issues Packages Projects Releases Wiki Activity

optional value when calling commands

Browse Source
This commit is contained in:
proddy
2026-06-08 20:42:08 +02:00
parent 192357f4f3
commit fd359ab9ed
2 changed files with 39 additions and 29 deletions
Download Patch File Download Diff File Expand all files Collapse all files

62
src/web/WebCommandService.cpp
View File

@@ -24,8 +24,8 @@
namespace emsesp { namespace emsesp {
WebCommandService::WebCommandService(AsyncWebServer * server, FS * fs, SecurityManager * securityManager) WebCommandService::WebCommandService(AsyncWebServer * server, FS * fs, SecurityManager * securityManager)
: _httpEndpoint(WebCommands::read, WebCommands::update, this, server, EMSESP_COMMAND_SERVICE_PATH, securityManager, AuthenticationPredicates::IS_AUTHENTICATED) : _httpEndpoint(WebCommands::read, WebCommands::update, this, server, EMSESP_COMMANDS_SERVICE_PATH, securityManager, AuthenticationPredicates::IS_AUTHENTICATED)
, _fsPersistence(WebCommands::read, WebCommands::update, this, fs, EMSESP_COMMAND_FILE) { , _fsPersistence(WebCommands::read, WebCommands::update, this, fs, EMSESP_COMMANDS_FILE) {
} }
void WebCommandService::begin() { void WebCommandService::begin() {
@@ -67,14 +67,14 @@ StateUpdateResult WebCommands::update(JsonObject root, WebCommands & webCommands
strlcpy(ci.name, item["name"].as<const char *>(), sizeof(ci.name)); strlcpy(ci.name, item["name"].as<const char *>(), sizeof(ci.name));
webCommands.commandItems.push_back(ci); webCommands.commandItems.push_back(ci);
if (webCommands.commandItems.back().name[0] != '\0') { Command::add(
Command::add( EMSdevice::DeviceType::COMMAND,
EMSdevice::DeviceType::COMMAND, webCommands.commandItems.back().name,
webCommands.commandItems.back().name, [name = std::string(webCommands.commandItems.back().name)](const char * value, const int8_t id) {
[](const char * value, const int8_t id) { return EMSESP::webCommandService.executeCommand(value); }, return EMSESP::webCommandService.executeCommand(name.c_str(), value); // value is optional
FL_(command_cmd), },
CommandFlag::ADMIN_ONLY); FL_(command_cmd),
} CommandFlag::ADMIN_ONLY);
} }
return StateUpdateResult::CHANGED; return StateUpdateResult::CHANGED;
} }
@@ -94,14 +94,15 @@ const CommandItem * WebCommandService::find(const char * name) {
} }
// execute a named command — looks up by name and runs it // execute a named command — looks up by name and runs it
// called from console 'call commands <name>', API/MQTT, web UI bool WebCommandService::executeCommand(const char * name, const char * value) {
bool WebCommandService::executeCommand(const char * name) {
const CommandItem * ci = find(name); const CommandItem * ci = find(name);
if (!ci) { if (!ci) {
EMSESP::logger().warning("Command '%s' not found", name ? name : ""); EMSESP::logger().warning("Command '%s' not found", name ? name : "");
return false; return false;
} }
return executeCommand(ci->name, std::string(ci->cmd.c_str()), std::string(ci->value.c_str())); // if there is a value use it, otherwise use the command's default value
std::string cmd_value = value ? value : ci->value.c_str();
return executeCommand(ci->name, std::string(ci->cmd.c_str()), cmd_value);
} }
// execute a command with explicit cmd and value strings // execute a command with explicit cmd and value strings
@@ -231,22 +232,22 @@ std::string WebCommandService::get_metrics_prometheus() {
} }
void WebCommandService::get_value_json(JsonObject output, const CommandItem & ci) { void WebCommandService::get_value_json(JsonObject output, const CommandItem & ci) {
output["name"] = (const char *)ci.name; output["name"] = (const char *)ci.name;
output["fullname"] = (const char *)ci.name; // output["fullname"] = (const char *)ci.name;
output["type"] = "command"; // output["type"] = "command";
output["command"] = ci.cmd; output["command"] = ci.cmd;
output["cmd_data"] = ci.value; output["value"] = ci.value;
bool hasName = ci.name[0] != '\0'; // bool hasName = ci.name[0] != '\0';
output["readable"] = hasName; // output["readable"] = hasName;
output["writeable"] = hasName; // output["writeable"] = hasName;
output["visible"] = hasName; // output["visible"] = hasName;
} }
void WebCommandService::publish(const bool force) { void WebCommandService::publish(const bool force) {
if (!Mqtt::enabled() || commandItems_->empty()) { if (!Mqtt::enabled() || commandItems_->empty()) {
return; return;
} }
if (force && !EMSESP::mqtt_.get_publish_onchange(0)) { if (force && !EMSESP::mqtt_.get_publish_onchange(EMSdevice::DeviceType::SYSTEM)) {
return; return;
} }
@@ -278,21 +279,30 @@ void WebCommandService::load_test_data() {
auto ci = CommandItem(); auto ci = CommandItem();
ci.cmd = "system/fetch"; ci.cmd = "system/fetch";
ci.value = "10"; ci.value = "10";
strcpy(ci.name, "test_cmd1"); strcpy(ci.name, "fetch_values");
webCommands.commandItems.push_back(ci); webCommands.commandItems.push_back(ci);
ci = CommandItem(); ci = CommandItem();
ci.cmd = "system/message"; ci.cmd = "system/message";
ci.value = "hello"; ci.value = "hello";
strcpy(ci.name, "test_cmd2"); strcpy(ci.name, "send_message");
webCommands.commandItems.push_back(ci); webCommands.commandItems.push_back(ci);
ci = CommandItem();
ci.cmd = "system/message";
ci.value = "{\"url\":\"http://emsesp.org/versions.json\"}";
strcpy(ci.name, "get_versions");
webCommands.commandItems.push_back(ci);
// manually add the commands
for (const auto & item : webCommands.commandItems) { for (const auto & item : webCommands.commandItems) {
if (item.name[0] != '\0') { if (item.name[0] != '\0') {
Command::add( Command::add(
EMSdevice::DeviceType::COMMAND, EMSdevice::DeviceType::COMMAND,
item.name, item.name,
[](const char * value, const int8_t id) { return EMSESP::webCommandService.executeCommand(value); }, [name = std::string(item.name)](const char * value, const int8_t id) {
return EMSESP::webCommandService.executeCommand(name.c_str(), value);
},
FL_(command_cmd), FL_(command_cmd),
CommandFlag::ADMIN_ONLY); CommandFlag::ADMIN_ONLY);
} }

6
src/web/WebCommandService.h
View File

@@ -21,8 +21,8 @@
#ifndef WebCommandService_h #ifndef WebCommandService_h
#define WebCommandService_h #define WebCommandService_h
#define EMSESP_COMMAND_FILE "/config/emsespCommands.json" #define EMSESP_COMMANDS_FILE "/config/emsespCommands.json"
#define EMSESP_COMMAND_SERVICE_PATH "/rest/commands" // GET and POST #define EMSESP_COMMANDS_SERVICE_PATH "/rest/commands" // GET and POST
namespace emsesp { namespace emsesp {
@@ -50,7 +50,7 @@ class WebCommandService : public StatefulService<WebCommands> {
bool get_value_info(JsonObject output, const char * cmd); bool get_value_info(JsonObject output, const char * cmd);
void get_value_json(JsonObject output, const CommandItem & commandItem); void get_value_json(JsonObject output, const CommandItem & commandItem);
bool executeCommand(const char * name); bool executeCommand(const char * name, const char * value = nullptr);
bool executeCommand(const char * name, const std::string & cmd, const std::string & value); bool executeCommand(const char * name, const std::string & cmd, const std::string & value);
const CommandItem * find(const char * name); const CommandItem * find(const char * name);