patrick/OpenDTU
1
0
Fork 0
Code Issues Pull Requests Actions 1 Packages Projects Releases Wiki Activity

Introduce numeric error codes in inverter webapi

Browse Source
This commit is contained in:
Thomas Basler 2022-12-23 18:52:48 +01:00
parent ac6c10759d
commit 4dc50777ef
2 changed files with 38 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

12
include/WebApi_errors.h
View File

@ -16,5 +16,15 @@ enum WebApiError {
ConfigBase = 3000, ConfigBase = 3000,
ConfigNotDeleted, ConfigNotDeleted,
ConfigSuccess ConfigSuccess,
InverterBase = 4000,
InverterSerialZero,
InverterNameLength,
InverterCount,
InverterAdded,
InverterInvalidId,
InverterInvalidMaxChannel,
InverterChanged,
InverterDeleted,
}; };

27
src/WebApi_inverter.cpp
View File

@ -6,6 +6,7 @@
#include "Configuration.h" #include "Configuration.h"
#include "MqttHandleHass.h" #include "MqttHandleHass.h"
#include "WebApi.h" #include "WebApi.h"
#include "WebApi_errors.h"
#include "helper.h" #include "helper.h"
#include <AsyncJson.h> #include <AsyncJson.h>
#include <Hoymiles.h> #include <Hoymiles.h>
@ -86,6 +87,7 @@ void WebApiInverterClass::onInverterAdd(AsyncWebServerRequest* request)
if (!request->hasParam("data", true)) { if (!request->hasParam("data", true)) {
retMsg[F("message")] = F("No values found!"); retMsg[F("message")] = F("No values found!");
retMsg[F("code")] = WebApiError::GenericNoValueFound;
response->setLength(); response->setLength();
request->send(response); request->send(response);
return; return;
@ -95,6 +97,7 @@ void WebApiInverterClass::onInverterAdd(AsyncWebServerRequest* request)
if (json.length() > 1024) { if (json.length() > 1024) {
retMsg[F("message")] = F("Data too large!"); retMsg[F("message")] = F("Data too large!");
retMsg[F("code")] = WebApiError::GenericDataTooLarge;
response->setLength(); response->setLength();
request->send(response); request->send(response);
return; return;
@ -105,6 +108,7 @@ void WebApiInverterClass::onInverterAdd(AsyncWebServerRequest* request)
if (error) { if (error) {
retMsg[F("message")] = F("Failed to parse data!"); retMsg[F("message")] = F("Failed to parse data!");
retMsg[F("code")] = WebApiError::GenericParseError;
response->setLength(); response->setLength();
request->send(response); request->send(response);
return; return;
@ -112,6 +116,7 @@ void WebApiInverterClass::onInverterAdd(AsyncWebServerRequest* request)
if (!(root.containsKey("serial") && root.containsKey("name"))) { if (!(root.containsKey("serial") && root.containsKey("name"))) {
retMsg[F("message")] = F("Values are missing!"); retMsg[F("message")] = F("Values are missing!");
retMsg[F("code")] = WebApiError::GenericValueMissing;
response->setLength(); response->setLength();
request->send(response); request->send(response);
return; return;
@ -119,6 +124,7 @@ void WebApiInverterClass::onInverterAdd(AsyncWebServerRequest* request)
if (root[F("serial")].as<uint64_t>() == 0) { if (root[F("serial")].as<uint64_t>() == 0) {
retMsg[F("message")] = F("Serial must be a number > 0!"); retMsg[F("message")] = F("Serial must be a number > 0!");
retMsg[F("code")] = WebApiError::InverterSerialZero;
response->setLength(); response->setLength();
request->send(response); request->send(response);
return; return;
@ -126,6 +132,8 @@ void WebApiInverterClass::onInverterAdd(AsyncWebServerRequest* request)
if (root[F("name")].as<String>().length() == 0 || root[F("name")].as<String>().length() > INV_MAX_NAME_STRLEN) { if (root[F("name")].as<String>().length() == 0 || root[F("name")].as<String>().length() > INV_MAX_NAME_STRLEN) {
retMsg[F("message")] = F("Name must between 1 and " STR(INV_MAX_NAME_STRLEN) " characters long!"); retMsg[F("message")] = F("Name must between 1 and " STR(INV_MAX_NAME_STRLEN) " characters long!");
retMsg[F("code")] = WebApiError::InverterNameLength;
retMsg[F("param")][F("max")] = INV_MAX_NAME_STRLEN;
response->setLength(); response->setLength();
request->send(response); request->send(response);
return; return;
@ -135,6 +143,8 @@ void WebApiInverterClass::onInverterAdd(AsyncWebServerRequest* request)
if (!inverter) { if (!inverter) {
retMsg[F("message")] = F("Only " STR(INV_MAX_COUNT) " inverters are supported!"); retMsg[F("message")] = F("Only " STR(INV_MAX_COUNT) " inverters are supported!");
retMsg[F("code")] = WebApiError::InverterCount;
retMsg[F("param")][F("max")] = INV_MAX_COUNT;
response->setLength(); response->setLength();
request->send(response); request->send(response);
return; return;
@ -148,6 +158,7 @@ void WebApiInverterClass::onInverterAdd(AsyncWebServerRequest* request)
retMsg[F("type")] = F("success"); retMsg[F("type")] = F("success");
retMsg[F("message")] = F("Inverter created!"); retMsg[F("message")] = F("Inverter created!");
retMsg[F("code")] = WebApiError::InverterAdded;
response->setLength(); response->setLength();
request->send(response); request->send(response);
@ -175,6 +186,7 @@ void WebApiInverterClass::onInverterEdit(AsyncWebServerRequest* request)
if (!request->hasParam("data", true)) { if (!request->hasParam("data", true)) {
retMsg[F("message")] = F("No values found!"); retMsg[F("message")] = F("No values found!");
retMsg[F("code")] = WebApiError::GenericNoValueFound;
response->setLength(); response->setLength();
request->send(response); request->send(response);
return; return;
@ -184,6 +196,7 @@ void WebApiInverterClass::onInverterEdit(AsyncWebServerRequest* request)
if (json.length() > 1024) { if (json.length() > 1024) {
retMsg[F("message")] = F("Data too large!"); retMsg[F("message")] = F("Data too large!");
retMsg[F("code")] = WebApiError::GenericDataTooLarge;
response->setLength(); response->setLength();
request->send(response); request->send(response);
return; return;
@ -194,6 +207,7 @@ void WebApiInverterClass::onInverterEdit(AsyncWebServerRequest* request)
if (error) { if (error) {
retMsg[F("message")] = F("Failed to parse data!"); retMsg[F("message")] = F("Failed to parse data!");
retMsg[F("code")] = WebApiError::GenericParseError;
response->setLength(); response->setLength();
request->send(response); request->send(response);
return; return;
@ -201,6 +215,7 @@ void WebApiInverterClass::onInverterEdit(AsyncWebServerRequest* request)
if (!(root.containsKey("id") && root.containsKey("serial") && root.containsKey("name") && root.containsKey("channel"))) { if (!(root.containsKey("id") && root.containsKey("serial") && root.containsKey("name") && root.containsKey("channel"))) {
retMsg[F("message")] = F("Values are missing!"); retMsg[F("message")] = F("Values are missing!");
retMsg[F("code")] = WebApiError::GenericValueMissing;
response->setLength(); response->setLength();
request->send(response); request->send(response);
return; return;
@ -208,6 +223,7 @@ void WebApiInverterClass::onInverterEdit(AsyncWebServerRequest* request)
if (root[F("id")].as<uint8_t>() > INV_MAX_COUNT - 1) { if (root[F("id")].as<uint8_t>() > INV_MAX_COUNT - 1) {
retMsg[F("message")] = F("Invalid ID specified!"); retMsg[F("message")] = F("Invalid ID specified!");
retMsg[F("code")] = WebApiError::InverterInvalidId;
response->setLength(); response->setLength();
request->send(response); request->send(response);
return; return;
@ -215,6 +231,7 @@ void WebApiInverterClass::onInverterEdit(AsyncWebServerRequest* request)
if (root[F("serial")].as<uint64_t>() == 0) { if (root[F("serial")].as<uint64_t>() == 0) {
retMsg[F("message")] = F("Serial must be a number > 0!"); retMsg[F("message")] = F("Serial must be a number > 0!");
retMsg[F("code")] = WebApiError::InverterSerialZero;
response->setLength(); response->setLength();
request->send(response); request->send(response);
return; return;
@ -222,6 +239,8 @@ void WebApiInverterClass::onInverterEdit(AsyncWebServerRequest* request)
if (root[F("name")].as<String>().length() == 0 || root[F("name")].as<String>().length() > INV_MAX_NAME_STRLEN) { if (root[F("name")].as<String>().length() == 0 || root[F("name")].as<String>().length() > INV_MAX_NAME_STRLEN) {
retMsg[F("message")] = F("Name must between 1 and " STR(INV_MAX_NAME_STRLEN) " characters long!"); retMsg[F("message")] = F("Name must between 1 and " STR(INV_MAX_NAME_STRLEN) " characters long!");
retMsg[F("code")] = WebApiError::InverterNameLength;
retMsg[F("param")][F("max")] = INV_MAX_NAME_STRLEN;
response->setLength(); response->setLength();
request->send(response); request->send(response);
return; return;
@ -230,6 +249,7 @@ void WebApiInverterClass::onInverterEdit(AsyncWebServerRequest* request)
JsonArray channelArray = root[F("channel")].as<JsonArray>(); JsonArray channelArray = root[F("channel")].as<JsonArray>();
if (channelArray.size() == 0 || channelArray.size() > INV_MAX_CHAN_COUNT) { if (channelArray.size() == 0 || channelArray.size() > INV_MAX_CHAN_COUNT) {
retMsg[F("message")] = F("Invalid amount of max channel setting given!"); retMsg[F("message")] = F("Invalid amount of max channel setting given!");
retMsg[F("code")] = WebApiError::InverterInvalidMaxChannel;
response->setLength(); response->setLength();
request->send(response); request->send(response);
return; return;
@ -254,6 +274,7 @@ void WebApiInverterClass::onInverterEdit(AsyncWebServerRequest* request)
Configuration.write(); Configuration.write();
retMsg[F("type")] = F("success"); retMsg[F("type")] = F("success");
retMsg[F("code")] = WebApiError::InverterChanged;
retMsg[F("message")] = F("Inverter changed!"); retMsg[F("message")] = F("Inverter changed!");
response->setLength(); response->setLength();
@ -294,6 +315,7 @@ void WebApiInverterClass::onInverterDelete(AsyncWebServerRequest* request)
if (!request->hasParam("data", true)) { if (!request->hasParam("data", true)) {
retMsg[F("message")] = F("No values found!"); retMsg[F("message")] = F("No values found!");
retMsg[F("code")] = WebApiError::GenericNoValueFound;
response->setLength(); response->setLength();
request->send(response); request->send(response);
return; return;
@ -303,6 +325,7 @@ void WebApiInverterClass::onInverterDelete(AsyncWebServerRequest* request)
if (json.length() > 1024) { if (json.length() > 1024) {
retMsg[F("message")] = F("Data too large!"); retMsg[F("message")] = F("Data too large!");
retMsg[F("code")] = WebApiError::GenericDataTooLarge;
response->setLength(); response->setLength();
request->send(response); request->send(response);
return; return;
@ -313,6 +336,7 @@ void WebApiInverterClass::onInverterDelete(AsyncWebServerRequest* request)
if (error) { if (error) {
retMsg[F("message")] = F("Failed to parse data!"); retMsg[F("message")] = F("Failed to parse data!");
retMsg[F("code")] = WebApiError::GenericParseError;
response->setLength(); response->setLength();
request->send(response); request->send(response);
return; return;
@ -320,6 +344,7 @@ void WebApiInverterClass::onInverterDelete(AsyncWebServerRequest* request)
if (!(root.containsKey("id"))) { if (!(root.containsKey("id"))) {
retMsg[F("message")] = F("Values are missing!"); retMsg[F("message")] = F("Values are missing!");
retMsg[F("code")] = WebApiError::GenericValueMissing;
response->setLength(); response->setLength();
request->send(response); request->send(response);
return; return;
@ -327,6 +352,7 @@ void WebApiInverterClass::onInverterDelete(AsyncWebServerRequest* request)
if (root[F("id")].as<uint8_t>() > INV_MAX_COUNT - 1) { if (root[F("id")].as<uint8_t>() > INV_MAX_COUNT - 1) {
retMsg[F("message")] = F("Invalid ID specified!"); retMsg[F("message")] = F("Invalid ID specified!");
retMsg[F("code")] = WebApiError::InverterInvalidId;
response->setLength(); response->setLength();
request->send(response); request->send(response);
return; return;
@ -343,6 +369,7 @@ void WebApiInverterClass::onInverterDelete(AsyncWebServerRequest* request)
retMsg[F("type")] = F("success"); retMsg[F("type")] = F("success");
retMsg[F("message")] = F("Inverter deleted!"); retMsg[F("message")] = F("Inverter deleted!");
retMsg[F("code")] = WebApiError::InverterDeleted;
response->setLength(); response->setLength();
request->send(response); request->send(response);