Terminal: change command-line parser (#2247)
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. 4 years ago |
|
- /*
-
- Part of the WEBSERVER MODULE
-
- Copyright (C) 2016-2019 by Xose Pérez <xose dot perez at gmail dot com>
-
- */
-
- #pragma once
-
- #include "web.h"
- #include "libs/TypeChecks.h"
-
- #include <Schedule.h>
-
- #if WEB_SUPPORT
-
- namespace asyncwebprint_traits {
-
- template <typename T>
- using print_callable_t = decltype(std::declval<T>()(std::declval<Print&>()));
-
- template <typename T>
- using is_print_callable = is_detected<print_callable_t, T>;
-
- }
-
- template<typename CallbackType>
- void AsyncWebPrint::scheduleFromRequest(const AsyncWebPrintConfig& config, AsyncWebServerRequest* request, CallbackType callback) {
- static_assert(asyncwebprint_traits::is_print_callable<CallbackType>::value, "CallbackType needs to be a callable with void(Print&)");
-
- // because of async nature of the server, we need to make sure we outlive 'request' object
- auto print = std::shared_ptr<AsyncWebPrint>(new AsyncWebPrint(config, request));
-
- // attach one ptr to onDisconnect capture, so we can detect disconnection before scheduled function runs
- request->onDisconnect([print]() {
- print->setState(AsyncWebPrint::State::Done);
- });
-
- // attach another capture to the scheduled function, so we execute as soon as we exit next loop()
- schedule_function([callback, print]() {
- if (State::None != print->getState()) return;
- callback(*print.get());
- print->flush();
- });
- }
-
- constexpr AsyncWebPrintConfig AsyncWebPrintDefaults {
- /*mimeType =*/ "text/plain",
- /*backlogCountMax=*/ 2,
- /*backlogSizeMax= */ TCP_MSS,
- /*backlogTimeout= */ 5000
- };
-
- template<typename CallbackType>
- void AsyncWebPrint::scheduleFromRequest(AsyncWebServerRequest* request, CallbackType callback) {
- AsyncWebPrint::scheduleFromRequest(AsyncWebPrintDefaults, request, callback);
- }
-
- #endif
|