2018-03-29 08:54:02 +00:00
|
|
|
#ifndef Service_h
|
|
|
|
#define Service_h
|
|
|
|
|
2018-11-11 16:44:29 +00:00
|
|
|
#if defined(ESP8266)
|
|
|
|
#include <ESP8266WiFi.h>
|
|
|
|
#include <ESPAsyncTCP.h>
|
|
|
|
#elif defined(ESP_PLATFORM)
|
|
|
|
#include <WiFi.h>
|
|
|
|
#include <AsyncTCP.h>
|
|
|
|
#endif
|
|
|
|
|
2018-03-29 08:54:02 +00:00
|
|
|
#include <ESPAsyncWebServer.h>
|
|
|
|
#include <ArduinoJson.h>
|
2019-04-14 07:52:40 +00:00
|
|
|
#include <AsyncArduinoJson6.h>
|
2019-05-18 18:35:27 +00:00
|
|
|
#include <AsyncJsonWebHandler.h>
|
2018-03-29 08:54:02 +00:00
|
|
|
|
|
|
|
/**
|
|
|
|
* At the moment, not expecting services to have to deal with large JSON
|
|
|
|
* files this could be made configurable fairly simply, it's exposed on
|
2019-05-18 18:35:27 +00:00
|
|
|
* AsyncJsonWebHandler with a setter.
|
2018-03-29 08:54:02 +00:00
|
|
|
*/
|
|
|
|
#define MAX_SETTINGS_SIZE 1024
|
|
|
|
|
|
|
|
/*
|
|
|
|
* Abstraction of a service which reads and writes data from an endpoint.
|
|
|
|
*
|
|
|
|
* Not currently used, but indended for use by features which do not
|
|
|
|
* require setting persistance.
|
|
|
|
*/
|
|
|
|
class SimpleService {
|
|
|
|
|
|
|
|
private:
|
|
|
|
|
2019-05-18 18:35:27 +00:00
|
|
|
AsyncJsonWebHandler _updateHandler;
|
2018-03-29 08:54:02 +00:00
|
|
|
|
2019-07-14 21:13:26 +00:00
|
|
|
void fetchConfig(AsyncWebServerRequest *request) {
|
2019-04-14 07:52:40 +00:00
|
|
|
AsyncJsonResponse * response = new AsyncJsonResponse(MAX_SETTINGS_SIZE);
|
|
|
|
JsonObject jsonObject = response->getRoot();
|
|
|
|
writeToJsonObject(jsonObject);
|
2018-03-29 08:54:02 +00:00
|
|
|
response->setLength();
|
|
|
|
request->send(response);
|
|
|
|
}
|
|
|
|
|
2019-07-14 21:13:26 +00:00
|
|
|
void updateConfig(AsyncWebServerRequest *request, JsonDocument &jsonDocument) {
|
|
|
|
if (jsonDocument.is<JsonObject>()) {
|
2019-04-14 07:52:40 +00:00
|
|
|
JsonObject newConfig = jsonDocument.as<JsonObject>();
|
2018-03-29 08:54:02 +00:00
|
|
|
readFromJsonObject(newConfig);
|
2019-04-14 07:52:40 +00:00
|
|
|
|
2018-03-29 08:54:02 +00:00
|
|
|
// write settings back with a callback to reconfigure the wifi
|
2019-04-14 07:52:40 +00:00
|
|
|
AsyncJsonCallbackResponse * response = new AsyncJsonCallbackResponse([this] () {onConfigUpdated();}, MAX_SETTINGS_SIZE);
|
|
|
|
JsonObject jsonObject = response->getRoot();
|
|
|
|
writeToJsonObject(jsonObject);
|
2018-03-29 08:54:02 +00:00
|
|
|
response->setLength();
|
|
|
|
request->send(response);
|
2019-04-14 07:52:40 +00:00
|
|
|
} else {
|
2018-03-29 08:54:02 +00:00
|
|
|
request->send(400);
|
|
|
|
}
|
|
|
|
}
|
|
|
|
|
|
|
|
protected:
|
|
|
|
|
|
|
|
// will serve setting endpoints from here
|
2019-07-14 21:13:26 +00:00
|
|
|
char const* _servicePath;
|
2018-03-29 08:54:02 +00:00
|
|
|
|
|
|
|
// reads the local config from the
|
2019-07-14 21:13:26 +00:00
|
|
|
virtual void readFromJsonObject(JsonObject& root) {}
|
|
|
|
virtual void writeToJsonObject(JsonObject& root) {}
|
2018-03-29 08:54:02 +00:00
|
|
|
|
|
|
|
// implement to perform action when config has been updated
|
2019-07-14 21:13:26 +00:00
|
|
|
virtual void onConfigUpdated() {}
|
2018-03-29 08:54:02 +00:00
|
|
|
|
|
|
|
public:
|
|
|
|
|
2019-07-14 21:13:26 +00:00
|
|
|
SimpleService(char const* servicePath): _servicePath(servicePath) {
|
2018-03-29 08:54:02 +00:00
|
|
|
_updateHandler.setUri(servicePath);
|
|
|
|
_updateHandler.setMethod(HTTP_POST);
|
|
|
|
_updateHandler.setMaxContentLength(MAX_SETTINGS_SIZE);
|
|
|
|
_updateHandler.onRequest(std::bind(&SimpleService::updateConfig, this, std::placeholders::_1, std::placeholders::_2));
|
|
|
|
}
|
2019-07-14 21:13:26 +00:00
|
|
|
|
2018-03-29 08:54:02 +00:00
|
|
|
virtual ~SimpleService() {}
|
|
|
|
|
2019-07-14 21:13:26 +00:00
|
|
|
void init(AsyncWebServer* server) {
|
|
|
|
server->on(_servicePath, HTTP_GET, std::bind(&SimpleService::fetchConfig, this, std::placeholders::_1));
|
|
|
|
server->addHandler(&_updateHandler);
|
|
|
|
}
|
|
|
|
|
2018-03-29 08:54:02 +00:00
|
|
|
};
|
|
|
|
|
|
|
|
#endif // end SimpleService
|