mirror of
https://github.com/emsesp/EMS-ESP32.git
synced 2025-12-07 08:19:52 +03:00
137 lines
4.7 KiB
C++
137 lines
4.7 KiB
C++
/*
|
|
* 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 <http://www.gnu.org/licenses/>.
|
|
*/
|
|
|
|
#ifndef EMSESP_COMMAND_H_
|
|
#define EMSESP_COMMAND_H_
|
|
|
|
#include <Arduino.h>
|
|
#include <ArduinoJson.h>
|
|
|
|
#include <string>
|
|
#include <vector>
|
|
#include <functional>
|
|
|
|
#include "console.h"
|
|
|
|
#include <uuid/log.h>
|
|
|
|
using uuid::console::Shell;
|
|
|
|
namespace emsesp {
|
|
|
|
// mqtt flags for command subscriptions
|
|
enum CommandFlag : uint8_t {
|
|
MQTT_SUB_FLAG_NORMAL = 0, // 0
|
|
MQTT_SUB_FLAG_HC = (1 << 0), // 1
|
|
MQTT_SUB_FLAG_WWC = (1 << 1), // 2
|
|
MQTT_SUB_FLAG_NOSUB = (1 << 2), // 4
|
|
HIDDEN = (1 << 3), // 8
|
|
ADMIN_ONLY = (1 << 4), // 16
|
|
MQTT_SUB_FLAG_WW = (1 << 5) // 32
|
|
|
|
};
|
|
|
|
// return status after calling a Command
|
|
enum CommandRet : uint8_t {
|
|
ERRORED = 0,
|
|
OK, // 1 or TRUE
|
|
NOT_FOUND, // 2
|
|
ERROR, // 3
|
|
NOT_ALLOWED // needs authentication
|
|
|
|
};
|
|
|
|
using cmd_function_p = std::function<bool(const char * data, const int8_t id)>;
|
|
using cmd_json_function_p = std::function<bool(const char * data, const int8_t id, JsonObject & json)>;
|
|
|
|
class Command {
|
|
public:
|
|
struct CmdFunction {
|
|
uint8_t device_type_; // DeviceType::
|
|
uint8_t flags_; // mqtt flags for command subscriptions
|
|
const __FlashStringHelper * cmd_;
|
|
const cmd_function_p cmdfunction_;
|
|
const cmd_json_function_p cmdfunction_json_;
|
|
const __FlashStringHelper * description_;
|
|
|
|
CmdFunction(const uint8_t device_type,
|
|
const uint8_t flags,
|
|
const __FlashStringHelper * cmd,
|
|
const cmd_function_p cmdfunction,
|
|
const cmd_json_function_p cmdfunction_json,
|
|
const __FlashStringHelper * description)
|
|
: device_type_(device_type)
|
|
, flags_(flags)
|
|
, cmd_(cmd)
|
|
, cmdfunction_(cmdfunction)
|
|
, cmdfunction_json_(cmdfunction_json)
|
|
, description_(description) {
|
|
}
|
|
|
|
inline void add_flags(uint8_t flags) {
|
|
flags_ |= flags;
|
|
}
|
|
inline bool has_flags(uint8_t flags) const {
|
|
return (flags_ & flags) == flags;
|
|
}
|
|
inline void remove_flags(uint8_t flags) {
|
|
flags_ &= ~flags;
|
|
}
|
|
inline uint8_t flags() const {
|
|
return flags_;
|
|
}
|
|
};
|
|
|
|
static std::vector<CmdFunction> commands() {
|
|
return cmdfunctions_;
|
|
}
|
|
|
|
static uint8_t call(const uint8_t device_type, const char * cmd, const char * value, bool authenticated, const int8_t id, JsonObject & json);
|
|
static uint8_t call(const uint8_t device_type, const char * cmd, const char * value, bool authenticated, const int8_t id = -1);
|
|
|
|
static void add(const uint8_t device_type,
|
|
const __FlashStringHelper * cmd,
|
|
const cmd_function_p cb,
|
|
const __FlashStringHelper * description,
|
|
uint8_t flags = CommandFlag::MQTT_SUB_FLAG_NORMAL);
|
|
|
|
static void add_json(const uint8_t device_type,
|
|
const __FlashStringHelper * cmd,
|
|
const cmd_json_function_p cb,
|
|
const __FlashStringHelper * description,
|
|
uint8_t flags = CommandFlag::MQTT_SUB_FLAG_NORMAL);
|
|
|
|
static void show_all(uuid::console::Shell & shell);
|
|
static Command::CmdFunction * find_command(const uint8_t device_type, const char * cmd);
|
|
static Command::CmdFunction * find_command(const uint8_t device_type, char * cmd, int8_t & id);
|
|
|
|
static void show(uuid::console::Shell & shell, uint8_t device_type, bool verbose);
|
|
static void show_devices(uuid::console::Shell & shell);
|
|
static bool device_has_commands(const uint8_t device_type);
|
|
|
|
static bool list(const uint8_t device_type, JsonObject & json);
|
|
|
|
private:
|
|
static uuid::log::Logger logger_;
|
|
|
|
static std::vector<CmdFunction> cmdfunctions_; // list of commands
|
|
};
|
|
|
|
} // namespace emsesp
|
|
|
|
#endif |