/* * EMS-ESP - https://github.com/emsesp/EMS-ESP * Copyright 2020 Paul Derbyshire * * This program is free software: you can redistribute it and/or modify * it under the terms of the GNU General Public License as published by * the Free Software Foundation, either version 3 of the License, or * (at your option) any later version. * * This program is distributed in the hope that it will be useful, * but WITHOUT ANY WARRANTY; without even the implied warranty of * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the * GNU General Public License for more details. * * You should have received a copy of the GNU General Public License * along with this program. If not, see . */ #include "command.h" #include "emsdevice.h" #include "emsesp.h" namespace emsesp { uuid::log::Logger Command::logger_{F_(command), uuid::log::Facility::DAEMON}; std::vector Command::cmdfunctions_; // calls a command // id may be used to represent a heating circuit for example, it's optional // returns false if error or not found bool Command::call(const uint8_t device_type, const char * cmd, const char * value, const int8_t id) { auto cf = find_command(device_type, cmd); if ((cf == nullptr) || (cf->cmdfunction_json_)) { LOG_WARNING(F("Command %s not found"), cmd); return false; // command not found, or requires a json } #ifdef EMSESP_DEBUG std::string dname = EMSdevice::device_type_2_device_name(device_type); if (value == nullptr) { LOG_DEBUG(F("[DEBUG] Calling %s command %s"), dname.c_str(), cmd); } else if (id == -1) { LOG_DEBUG(F("[DEBUG] Calling %s command %s, value %s, id is default"), dname.c_str(), cmd, value); } else { LOG_DEBUG(F("[DEBUG] Calling %s command %s, value %s, id is %d"), dname.c_str(), cmd, value, id); } #endif return ((cf->cmdfunction_)(value, id)); } // calls a command. Takes a json object for output. // id may be used to represent a heating circuit for example // returns false if error or not found bool Command::call(const uint8_t device_type, const char * cmd, const char * value, const int8_t id, JsonObject & json) { auto cf = find_command(device_type, cmd); if (cf == nullptr) { LOG_WARNING(F("Command %s not found"), cmd); return false; // command not found or not json } #ifdef EMSESP_DEBUG std::string dname = EMSdevice::device_type_2_device_name(device_type); if (value == nullptr) { LOG_DEBUG(F("[DEBUG] Calling %s command %s"), dname.c_str(), cmd); } else if (id == -1) { LOG_DEBUG(F("[DEBUG] Calling %s command %s, value %s, id is default"), dname.c_str(), cmd, value); } else { LOG_DEBUG(F("[DEBUG] Calling %s command %s, value %s, id is %d"), dname.c_str(), cmd, value, id); } #endif // check if json object is empty, if so quit if (json.isNull()) { LOG_WARNING(F("Ignore call for command %s in %s because no json"), cmd, EMSdevice::device_type_2_device_name(device_type).c_str()); return false; } if (!cf->cmdfunction_json_) { return ((cf->cmdfunction_)(value, id)); } else { return ((cf->cmdfunction_json_)(value, id, json)); } } // add a command to the list, which does not return json void Command::add(const uint8_t device_type, const __FlashStringHelper * cmd, cmdfunction_p cb) { // if the command already exists for that device type don't add it if (find_command(device_type, uuid::read_flash_string(cmd).c_str()) != nullptr) { return; } cmdfunctions_.emplace_back(device_type, cmd, cb, nullptr); // see if we need to subscribe if (Mqtt::enabled()) { Mqtt::register_command(device_type, cmd, cb); } } // add a command to the list, which does return json object as output void Command::add_with_json(const uint8_t device_type, const __FlashStringHelper * cmd, cmdfunction_json_p cb) { // if the command already exists for that device type don't add it if (find_command(device_type, uuid::read_flash_string(cmd).c_str()) != nullptr) { return; } cmdfunctions_.emplace_back(device_type, cmd, nullptr, cb); // add command } // see if a command exists for that device type Command::CmdFunction * Command::find_command(const uint8_t device_type, const char * cmd) { if ((cmd == nullptr) || (strlen(cmd) == 0) || (cmdfunctions_.empty())) { return nullptr; } // convert cmd to lowercase and compare char lowerCmd[20]; strlcpy(lowerCmd, cmd, sizeof(lowerCmd)); for (char * p = lowerCmd; *p; p++) { *p = tolower(*p); } for (auto & cf : cmdfunctions_) { if (!strcmp_P(lowerCmd, reinterpret_cast(cf.cmd_)) && (cf.device_type_ == device_type)) { return &cf; } } return nullptr; // command not found } // output list of all commands to console for a specific DeviceType void Command::show(uuid::console::Shell & shell, uint8_t device_type) { if (cmdfunctions_.empty()) { shell.println(F("No commands")); } for (const auto & cf : cmdfunctions_) { if (cf.device_type_ == device_type) { shell.printf("%s ", uuid::read_flash_string(cf.cmd_).c_str()); } } shell.println(); } // see if a device_type is active and has associated commands // returns false if the device has no commands bool Command::device_has_commands(const uint8_t device_type) { if (device_type == EMSdevice::DeviceType::UNKNOWN) { return false; } if (device_type == EMSdevice::DeviceType::SYSTEM) { return true; // we always have System } if (device_type == EMSdevice::DeviceType::DALLASSENSOR) { return true; // we always have Sensor, but should check if there are actual sensors attached! } for (const auto & emsdevice : EMSESP::emsdevices) { if ((emsdevice) && (emsdevice->device_type() == device_type)) { // device found, now see if it has any commands for (const auto & cf : cmdfunctions_) { if (cf.device_type_ == device_type) { return true; } } } } return false; } void Command::show_devices(uuid::console::Shell & shell) { shell.printf("%s ", EMSdevice::device_type_2_device_name(EMSdevice::DeviceType::SYSTEM).c_str()); if (EMSESP::have_sensors()) { shell.printf("%s ", EMSdevice::device_type_2_device_name(EMSdevice::DeviceType::DALLASSENSOR).c_str()); } for (const auto & device_class : EMSFactory::device_handlers()) { for (const auto & emsdevice : EMSESP::emsdevices) { if ((emsdevice) && (emsdevice->device_type() == device_class.first) && (device_has_commands(device_class.first))) { shell.printf("%s ", EMSdevice::device_type_2_device_name(device_class.first).c_str()); break; // we only want to show one (not multiple of the same device types) } } } shell.println(); } // output list of all commands to console void Command::show_all(uuid::console::Shell & shell) { shell.println(F("Available commands per device: ")); // show system first shell.printf(" %s: ", EMSdevice::device_type_2_device_name(EMSdevice::DeviceType::SYSTEM).c_str()); show(shell, EMSdevice::DeviceType::SYSTEM); // show sensor if (EMSESP::have_sensors()) { shell.printf(" %s: ", EMSdevice::device_type_2_device_name(EMSdevice::DeviceType::DALLASSENSOR).c_str()); show(shell, EMSdevice::DeviceType::DALLASSENSOR); } // do this in the order of factory classes to keep a consistent order when displaying for (const auto & device_class : EMSFactory::device_handlers()) { if (Command::device_has_commands(device_class.first)) { shell.printf(" %s: ", EMSdevice::device_type_2_device_name(device_class.first).c_str()); show(shell, device_class.first); } } } } // namespace emsesp