mirror of
https://github.com/xoseperez/espurna.git
synced 2026-03-04 15:34:19 +01:00
b8fc8cd1fd
Change the underlying command line handling: - switch to a custom parser, inspired by redis / sds - update terminalRegisterCommand signature, pass only bare minimum - clean-up `help` & `commands`. update settings `set`, `get` and `del` - allow our custom test suite to run command-line tests - clean-up Stream IO to allow us to print large things into debug stream (for example, `eeprom.dump`) - send parsing errors to the debug log As a proof of concept, introduce `TERMINAL_MQTT_SUPPORT` and `TERMINAL_WEB_API_SUPPORT` - MQTT subscribes to the `<root>/cmd/set` and sends response to the `<root>/cmd`. We can't output too much, as we don't have any large-send API. - Web API listens to the `/api/cmd?apikey=...&line=...` (or PUT, params inside the body). This one is intended as a possible replacement of the `API_SUPPORT`. Internals introduce a 'task' around the AsyncWebServerRequest object that will simulate what WiFiClient does and push data into it continuously, switching between CONT and SYS. Both are experimental. We only accept a single command and not every command is updated to use Print `ctx.output` object. We are also somewhat limited by the Print / Stream overall, perhaps I am overestimating the usefulness of Arduino compatibility to such an extent :) Web API handler can also sometimes show only part of the result, whenever the command tries to yield() by itself waiting for something. Perhaps we would need to create a custom request handler for that specific use-case.
200 lines
5.5 KiB
C++
200 lines
5.5 KiB
C++
/*
|
|
|
|
NOFUSS MODULE
|
|
|
|
Copyright (C) 2016-2019 by Xose Pérez <xose dot perez at gmail dot com>
|
|
|
|
*/
|
|
|
|
#include "nofuss.h"
|
|
|
|
#if NOFUSS_SUPPORT
|
|
|
|
#include "wifi.h"
|
|
#include "mdns.h"
|
|
#include "terminal.h"
|
|
#include "ws.h"
|
|
|
|
unsigned long _nofussLastCheck = 0;
|
|
unsigned long _nofussInterval = 0;
|
|
bool _nofussEnabled = false;
|
|
|
|
// -----------------------------------------------------------------------------
|
|
// NOFUSS
|
|
// -----------------------------------------------------------------------------
|
|
|
|
#if WEB_SUPPORT
|
|
|
|
bool _nofussWebSocketOnKeyCheck(const char * key, JsonVariant& value) {
|
|
return (strncmp(key, "nofuss", 6) == 0);
|
|
}
|
|
|
|
void _nofussWebSocketOnVisible(JsonObject& root) {
|
|
root["nofussVisible"] = 1;
|
|
}
|
|
|
|
void _nofussWebSocketOnConnected(JsonObject& root) {
|
|
root["nofussEnabled"] = getSetting("nofussEnabled", 1 == NOFUSS_ENABLED);
|
|
root["nofussServer"] = getSetting("nofussServer", NOFUSS_SERVER);
|
|
}
|
|
|
|
#endif
|
|
|
|
void _nofussConfigure() {
|
|
|
|
String nofussServer = getSetting("nofussServer", NOFUSS_SERVER);
|
|
#if MDNS_CLIENT_SUPPORT
|
|
nofussServer = mdnsResolve(nofussServer);
|
|
#endif
|
|
|
|
if (nofussServer.length() == 0) {
|
|
setSetting("nofussEnabled", 0);
|
|
_nofussEnabled = false;
|
|
} else {
|
|
_nofussEnabled = getSetting("nofussEnabled", 1 == NOFUSS_ENABLED);
|
|
}
|
|
_nofussInterval = getSetting("nofussInterval", NOFUSS_INTERVAL);
|
|
_nofussLastCheck = 0;
|
|
|
|
if (!_nofussEnabled) {
|
|
|
|
DEBUG_MSG_P(PSTR("[NOFUSS] Disabled\n"));
|
|
|
|
} else {
|
|
|
|
NoFUSSClient.setServer(nofussServer);
|
|
NoFUSSClient.setDevice(APP_NAME "_" DEVICE);
|
|
NoFUSSClient.setVersion(APP_VERSION);
|
|
NoFUSSClient.setBuild(String(__UNIX_TIMESTAMP__));
|
|
|
|
DEBUG_MSG_P(PSTR("[NOFUSS] Server : %s\n"), nofussServer.c_str());
|
|
DEBUG_MSG_P(PSTR("[NOFUSS] Device: %s\n"), APP_NAME "_" DEVICE);
|
|
DEBUG_MSG_P(PSTR("[NOFUSS] Version: %s\n"), APP_VERSION);
|
|
DEBUG_MSG_P(PSTR("[NOFUSS] Build: %s\n"), String(__UNIX_TIMESTAMP__).c_str());
|
|
DEBUG_MSG_P(PSTR("[NOFUSS] Enabled\n"));
|
|
|
|
}
|
|
|
|
}
|
|
|
|
// -----------------------------------------------------------------------------
|
|
|
|
void nofussRun() {
|
|
NoFUSSClient.handle();
|
|
_nofussLastCheck = millis();
|
|
}
|
|
|
|
void _nofussLoop() {
|
|
|
|
if (!_nofussEnabled) return;
|
|
if (!wifiConnected()) return;
|
|
if ((_nofussLastCheck > 0) && ((millis() - _nofussLastCheck) < _nofussInterval)) return;
|
|
|
|
nofussRun();
|
|
|
|
}
|
|
|
|
#if TERMINAL_SUPPORT
|
|
|
|
void _nofussInitCommands() {
|
|
|
|
terminalRegisterCommand(F("NOFUSS"), [](const terminal::CommandContext&) {
|
|
terminalOK();
|
|
nofussRun();
|
|
});
|
|
|
|
}
|
|
|
|
#endif // TERMINAL_SUPPORT
|
|
|
|
void nofussSetup() {
|
|
|
|
_nofussConfigure();
|
|
|
|
NoFUSSClient.onMessage([](nofuss_t code) {
|
|
|
|
if (code == NOFUSS_START) {
|
|
DEBUG_MSG_P(PSTR("[NoFUSS] Start\n"));
|
|
}
|
|
|
|
if (code == NOFUSS_UPTODATE) {
|
|
DEBUG_MSG_P(PSTR("[NoFUSS] Already in the last version\n"));
|
|
}
|
|
|
|
if (code == NOFUSS_NO_RESPONSE_ERROR) {
|
|
DEBUG_MSG_P(PSTR("[NoFUSS] Wrong server response: %d %s\n"), NoFUSSClient.getErrorNumber(), (char *) NoFUSSClient.getErrorString().c_str());
|
|
}
|
|
|
|
if (code == NOFUSS_PARSE_ERROR) {
|
|
DEBUG_MSG_P(PSTR("[NoFUSS] Error parsing server response\n"));
|
|
}
|
|
|
|
if (code == NOFUSS_UPDATING) {
|
|
DEBUG_MSG_P(PSTR("[NoFUSS] Updating\n"));
|
|
DEBUG_MSG_P(PSTR(" New version: %s\n"), (char *) NoFUSSClient.getNewVersion().c_str());
|
|
DEBUG_MSG_P(PSTR(" Firmware: %s\n"), (char *) NoFUSSClient.getNewFirmware().c_str());
|
|
DEBUG_MSG_P(PSTR(" File System: %s\n"), (char *) NoFUSSClient.getNewFileSystem().c_str());
|
|
#if WEB_SUPPORT
|
|
wsSend_P(PSTR("{\"message\": 1}"));
|
|
#endif
|
|
|
|
// Disabling EEPROM rotation to prevent writing to EEPROM after the upgrade
|
|
eepromRotate(false);
|
|
|
|
// Force backup right now, because NoFUSS library will immediatly reset on success
|
|
eepromBackup(0);
|
|
}
|
|
|
|
if (code == NOFUSS_FILESYSTEM_UPDATE_ERROR) {
|
|
DEBUG_MSG_P(PSTR("[NoFUSS] File System Update Error: %s\n"), (char *) NoFUSSClient.getErrorString().c_str());
|
|
}
|
|
|
|
if (code == NOFUSS_FILESYSTEM_UPDATED) {
|
|
DEBUG_MSG_P(PSTR("[NoFUSS] File System Updated\n"));
|
|
}
|
|
|
|
if (code == NOFUSS_FIRMWARE_UPDATE_ERROR) {
|
|
DEBUG_MSG_P(PSTR("[NoFUSS] Firmware Update Error: %s\n"), (char *) NoFUSSClient.getErrorString().c_str());
|
|
}
|
|
|
|
if (code == NOFUSS_FIRMWARE_UPDATED) {
|
|
DEBUG_MSG_P(PSTR("[NoFUSS] Firmware Updated\n"));
|
|
}
|
|
|
|
if (code == NOFUSS_RESET) {
|
|
DEBUG_MSG_P(PSTR("[NoFUSS] Resetting board\n"));
|
|
#if WEB_SUPPORT
|
|
wsSend_P(PSTR("{\"action\": \"reload\"}"));
|
|
#endif
|
|
// TODO: NoFUSS will reset the board after this callback returns.
|
|
// Maybe this should be optional
|
|
customResetReason(CUSTOM_RESET_NOFUSS);
|
|
nice_delay(100);
|
|
}
|
|
|
|
if (code == NOFUSS_END) {
|
|
DEBUG_MSG_P(PSTR("[NoFUSS] End\n"));
|
|
eepromRotate(true);
|
|
}
|
|
|
|
});
|
|
|
|
#if WEB_SUPPORT
|
|
wsRegister()
|
|
.onVisible(_nofussWebSocketOnVisible)
|
|
.onConnected(_nofussWebSocketOnConnected)
|
|
.onKeyCheck(_nofussWebSocketOnKeyCheck);
|
|
#endif
|
|
|
|
#if TERMINAL_SUPPORT
|
|
_nofussInitCommands();
|
|
#endif
|
|
|
|
// Main callbacks
|
|
espurnaRegisterLoop(_nofussLoop);
|
|
espurnaRegisterReload(_nofussConfigure);
|
|
|
|
}
|
|
|
|
#endif // NOFUSS_SUPPORT
|