Skip to content

Commit

Permalink
* webinterface refactored completely
Browse files Browse the repository at this point in the history
  • Loading branch information
@lumapu
lumapu committed Aug 14, 2022
1 parent 3c8a4c4 commit 74f053a
Show file tree
Hide file tree
Showing 12 changed files with 480 additions and 136 deletions.
99 changes: 37 additions & 62 deletions tools/esp8266/app.cpp
View file
Original file line number Diff line number Diff line change
Expand Up @@ -5,15 +5,13 @@

#include "app.h"

#include "html/h/hoymiles_html.h"
#include <ArduinoJson.h>


//-----------------------------------------------------------------------------
app::app() {
DPRINTLN(DBG_VERBOSE, F("app::app"));
mDns = new DNSServer();
//mWeb = new ESP8266WebServer(80);
mUdp = new WiFiUDP();
mEep = new eep();
Serial.begin(115200);
Expand All @@ -28,12 +26,6 @@ app::app() {
}


//-----------------------------------------------------------------------------
app::~app(void) {

}


//-----------------------------------------------------------------------------
void app::setup(uint32_t timeout) {
DPRINTLN(DBG_VERBOSE, F("app::setup"));
Expand All @@ -46,15 +38,6 @@ void app::setup(uint32_t timeout) {
#ifndef AP_ONLY
if(false == apActive)
apActive = setupStation(mWifiStationTimeout);
#endif

/*mWeb->on("/cmdstat", std::bind(&app::showStatistics, this));
mWeb->on("/hoymiles", std::bind(&app::showHoymiles, this));
mWeb->on("/livedata", std::bind(&app::showLiveData, this));
mWeb->on("/json", std::bind(&app::showJSON, this));
mWeb->on("/api",HTTP_POST, std::bind(&app::webapi, this));*/

#ifndef AP_ONLY
setupMqtt();
#endif

Expand Down Expand Up @@ -569,10 +552,26 @@ void app::cbMqtt(char* topic, byte* payload, unsigned int length) {
}


//-----------------------------------------------------------------------------
/*void app::webapi(void) { // ToDo
DPRINTLN(DBG_VERBOSE, F("app::api"));
const size_t capacity = 200; // Use arduinojson.org/assistant to compute the capacity.
DynamicJsonDocument payload(capacity);
// Parse JSON object
deserializeJson(payload, mWeb->arg("plain"));
// ToDo: error handling for payload
if (payload["tx_request"] == TX_REQ_INFO){
mSys->InfoCmd = payload["cmd"];
DPRINTLN(DBG_INFO, F("Will make tx-request 0x15 with subcmd ") + String(mSys->InfoCmd));
}
mWeb->send ( 200, "text/json", "{success:true}" );
}*/



//-----------------------------------------------------------------------------
/*void app::showStatistics(void) {
DPRINTLN(DBG_VERBOSE, F("app::showStatistics"));
String app::getStatistics(void) {
String content = F("Receive success: ") + String(mRxSuccess) + "\n";
content += F("Receive fail: ") + String(mRxFailed) + "\n";
content += F("Frames received: ") + String(mFrameCnt) + "\n";
Expand Down Expand Up @@ -617,43 +616,13 @@ void app::cbMqtt(char* topic, byte* payload, unsigned int length) {
content += F("not ");
content += F("connected\n");

mWeb->send(200, F("text/plain"), content);
}*/


//-----------------------------------------------------------------------------
/*void app::webapi(void) { // ToDo
DPRINTLN(DBG_VERBOSE, F("app::api"));
DPRINTLN(DBG_DEBUG, mWeb->arg("plain"));
const size_t capacity = 200; // Use arduinojson.org/assistant to compute the capacity.
DynamicJsonDocument payload(capacity);
// Parse JSON object
deserializeJson(payload, mWeb->arg("plain"));
// ToDo: error handling for payload
if (payload["tx_request"] == TX_REQ_INFO){
mSys->InfoCmd = payload["cmd"];
DPRINTLN(DBG_INFO, F("Will make tx-request 0x15 with subcmd ") + String(mSys->InfoCmd));
}
mWeb->send ( 200, "text/json", "{success:true}" );
}*/

return content;
}

//-----------------------------------------------------------------------------
/*void app::showHoymiles(void) {
DPRINTLN(DBG_VERBOSE, F("app::showHoymiles"));
String html = FPSTR(hoymiles_html);
html.replace(F("{DEVICE}"), mSysConfig.deviceName);
html.replace(F("{VERSION}"), version);
html.replace(F("{TS}"), String(config.sendInterval) + " ");
html.replace(F("{JS_TS}"), String(config.sendInterval * 1000));
mWeb->send(200, F("text/html"), html);
}*/


//-----------------------------------------------------------------------------
/*void app::showLiveData(void) {
DPRINTLN(DBG_VERBOSE, F("app::showLiveData"));
String app::getLiveData(void) {
String modHtml;
for(uint8_t id = 0; id < mSys->getNumInverters(); id++) {
Inverter<> *iv = mSys->getInverterByPos(id);
Expand Down Expand Up @@ -723,13 +692,13 @@ void app::cbMqtt(char* topic, byte* payload, unsigned int length) {
#endif
}
}
mWeb->send(200, F("text/html"), modHtml);
}*/
return modHtml;
}


//-----------------------------------------------------------------------------
/*void app::showJSON(void) {
DPRINTLN(DBG_VERBOSE, F("app::showJSON"));
String app::getJson(void) {
DPRINTLN(DBG_VERBOSE, F("app::showJson"));
String modJson;

modJson = F("{\n");
Expand All @@ -749,12 +718,11 @@ void app::cbMqtt(char* topic, byte* payload, unsigned int length) {
}
modJson += F("\"json_ts\": \"") + String(getDateTimeStr(mTimestamp)) + F("\"\n}\n");

// mWeb->send(200, F("text/json"), modJson);
mWeb->send(200, F("application/json"), modJson); // the preferred content-type (https://stackoverflow.com/questions/22406077/what-is-the-exact-difference-between-content-type-text-json-and-application-jso)
}*/

return modJson;
}


//-----------------------------------------------------------------------------
void app::sendMqttDiscoveryConfig(void) {
DPRINTLN(DBG_VERBOSE, F("app::sendMqttDiscoveryConfig"));

Expand Down Expand Up @@ -808,6 +776,8 @@ void app::sendMqttDiscoveryConfig(void) {
}
}


//-----------------------------------------------------------------------------
const char* app::getFieldDeviceClass(uint8_t fieldId) {
uint8_t pos = 0;
for(; pos < DEVICE_CLS_ASSIGN_LIST_LEN; pos++) {
Expand All @@ -817,6 +787,8 @@ const char* app::getFieldDeviceClass(uint8_t fieldId) {
return (pos >= DEVICE_CLS_ASSIGN_LIST_LEN) ? NULL : deviceClasses[deviceFieldAssignment[pos].deviceClsId];
}


//-----------------------------------------------------------------------------
const char* app::getFieldStateClass(uint8_t fieldId) {
uint8_t pos = 0;
for(; pos < DEVICE_CLS_ASSIGN_LIST_LEN; pos++) {
Expand Down Expand Up @@ -954,6 +926,10 @@ void app::loadDefaultConfig(void) {
// nrf24
mConfig.sendInterval = SEND_INTERVAL;
mConfig.maxRetransPerPyld = DEF_MAX_RETRANS_PER_PYLD;
mConfig.pinCs = DEF_RF24_CS_PIN;
mConfig.pinCe = DEF_RF24_CE_PIN;
mConfig.pinIrq = DEF_RF24_IRQ_PIN;
mConfig.amplifierPower = DEF_AMPLIFIERPOWER & 0x03;

// ntp
snprintf(mConfig.ntpAddr, NTP_ADDR_LEN, "%s", NTP_SERVER_NAME);
Expand All @@ -968,7 +944,7 @@ void app::loadDefaultConfig(void) {

// serial
mConfig.serialInterval = SERIAL_INTERVAL;
mConfig.serialShowIv = true;
mConfig.serialShowIv = false;
mConfig.serialDebug = false;
}

Expand Down Expand Up @@ -1082,7 +1058,6 @@ void app::saveValues(void) {
}



//-----------------------------------------------------------------------------
time_t app::getNtpTime(void) {
//DPRINTLN(DBG_VERBOSE, F("app::getNtpTime"));
Expand Down
7 changes: 5 additions & 2 deletions tools/esp8266/app.h
View file
Original file line number Diff line number Diff line change
Expand Up @@ -38,7 +38,7 @@
// #define __MQTT_NO_DISCOVERCONFIG__ // das versenden der MQTTDiscoveryConfig abschalten ( gehört eigentlich ins Setup )

typedef CircularBuffer<packet_t, PACKET_BUFFER_SIZE> BufferType;
typedef HmRadio<RF24_CE_PIN, RF24_CS_PIN, BufferType> RadioType;
typedef HmRadio<DEF_RF24_CE_PIN, DEF_RF24_CS_PIN, BufferType> RadioType;
typedef Inverter<float> InverterType;
typedef HmSystem<RadioType, BufferType, MAX_NUM_INVERTERS, InverterType> HmSystemType;

Expand Down Expand Up @@ -72,13 +72,16 @@ class web;
class app {
public:
app();
~app();
~app() {}

void setup(uint32_t timeout);
void loop(void);
void handleIntr(void);
void cbMqtt(char* topic, byte* payload, unsigned int length);
void saveValues(void);
String getStatistics(void);
String getLiveData(void);
String getJson(void);

uint8_t getIrqPin(void) {
return mConfig.pinIrq;
Expand Down
30 changes: 19 additions & 11 deletions tools/esp8266/config.h
View file
Original file line number Diff line number Diff line change
Expand Up @@ -31,20 +31,25 @@
// default device name
#define DEF_DEVICE_NAME "AHOY-DTU"

// default pinout
#define DEF_RF24_CS_PIN 15
#define DEF_RF24_CE_PIN 2
#define DEF_RF24_IRQ_PIN 0

// default NRF24 power, possible values (0 - 3)
#define DEF_AMPLIFIERPOWER 2

// number of packets hold in buffer
#define PACKET_BUFFER_SIZE 30

// number of configurable inverters
#define MAX_NUM_INVERTERS 3

// default serial interval
#define SERIAL_INTERVAL 5
#define SERIAL_INTERVAL 5

// default send interval
#define SEND_INTERVAL 30

// default mqtt interval
#define MQTT_INTERVAL 60
#define SEND_INTERVAL 30

// maximum human readable inverter name length
#define MAX_NAME_LENGTH 16
Expand All @@ -64,14 +69,14 @@
// threshold of minimum power on which the inverter is marked as inactive
#define INACT_PWR_THRESH 3

// changes the style of "/setup" page, visualized = nicer
#define LIVEDATA_VISUALIZED

// default ntp server uri
#define NTP_SERVER_NAME "pool.ntp.org"
#define NTP_SERVER_NAME "pool.ntp.org"

// default ntp server port
#define NTP_LOCAL_PORT 8888
#define NTP_LOCAL_PORT 8888

// default mqtt interval
#define MQTT_INTERVAL 60

// default MQTT broker uri
#define DEF_MQTT_BROKER "\0"
Expand All @@ -86,6 +91,9 @@
#define DEF_MQTT_PWD "\0"

// default MQTT topic
#define DEF_MQTT_TOPIC "inverter"
#define DEF_MQTT_TOPIC "inverter"

// changes the style of "/setup" page, visualized = nicer
#define LIVEDATA_VISUALIZED

#endif /*__CONFIG_H__*/
56 changes: 5 additions & 51 deletions tools/esp8266/defines.h
View file
Original file line number Diff line number Diff line change
Expand Up @@ -8,21 +8,12 @@

#include "config.h"

//-------------------------------------
// PINOUT (Default, can be changed in setup)
//-------------------------------------
#define RF24_CS_PIN 15
#define RF24_CE_PIN 2
#define RF24_IRQ_PIN 0


//-------------------------------------
// VERSION
//-------------------------------------
#define VERSION_MAJOR 0
#define VERSION_MINOR 5
#define VERSION_PATCH 10

#define VERSION_PATCH 11


//-------------------------------------
Expand Down Expand Up @@ -111,44 +102,7 @@ typedef enum {
#define SER_DEBUG_LEN 1 // uint8_t
#define SER_INTERVAL_LEN 2 // uint16_t

/*
#define ADDR_START 0
#define ADDR_SSID ADDR_START
#define ADDR_PWD ADDR_SSID + SSID_LEN
#define ADDR_DEVNAME ADDR_PWD + PWD_LEN
#define ADDR_WIFI_CRC ADDR_DEVNAME + DEVNAME_LEN
#define ADDR_START_SETTINGS ADDR_WIFI_CRC + CRC_LEN

#define ADDR_PINOUT ADDR_START_SETTINGS
#define ADDR_RF24_AMP_PWR ADDR_PINOUT + PINOUT_LEN
#define ADDR_INV_ADDR ADDR_RF24_AMP_PWR + RF24_AMP_PWR_LEN
#define ADDR_INV_NAME ADDR_INV_ADDR + INV_ADDR_LEN
#define ADDR_INV_CH_PWR ADDR_INV_NAME + INV_NAME_LEN
#define ADDR_INV_CH_NAME ADDR_INV_CH_PWR + INV_CH_CH_PWR_LEN
#define ADDR_INV_INTERVAL ADDR_INV_CH_NAME + INV_CH_CH_NAME_LEN
#define ADDR_INV_MAX_RTRY ADDR_INV_INTERVAL + INV_INTERVAL_LEN
#define ADDR_INV_PWR_LIM ADDR_INV_MAX_RTRY + INV_MAX_RTRY_LEN
#define ADDR_NTP_ADDR ADDR_INV_PWR_LIM + INV_PWR_LIM_LEN //Bugfix #125
#define ADDR_NTP_PORT ADDR_NTP_ADDR + NTP_ADDR_LEN
#define ADDR_MQTT_ADDR ADDR_NTP_PORT + NTP_PORT_LEN
#define ADDR_MQTT_USER ADDR_MQTT_ADDR + MQTT_ADDR_LEN
#define ADDR_MQTT_PWD ADDR_MQTT_USER + MQTT_USER_LEN
#define ADDR_MQTT_TOPIC ADDR_MQTT_PWD + MQTT_PWD_LEN
#define ADDR_MQTT_INTERVAL ADDR_MQTT_TOPIC + MQTT_TOPIC_LEN
#define ADDR_MQTT_PORT ADDR_MQTT_INTERVAL + MQTT_INTERVAL_LEN
#define ADDR_SER_ENABLE ADDR_MQTT_PORT + MQTT_PORT_LEN
#define ADDR_SER_DEBUG ADDR_SER_ENABLE + SER_ENABLE_LEN
#define ADDR_SER_INTERVAL ADDR_SER_DEBUG + SER_DEBUG_LEN
#define ADDR_NEXT ADDR_SER_INTERVAL + SER_INTERVAL_LEN
*/


//-------------------------------------
typedef struct {
char broker[MQTT_ADDR_LEN];
uint16_t port;
Expand Down Expand Up @@ -187,10 +141,10 @@ typedef struct {
bool serialDebug;
} config_t;

// eeprom new
#define CFG_MQTT_LEN MQTT_ADDR_LEN + 2 + MQTT_USER_LEN + MQTT_PWD_LEN +MQTT_TOPIC_LEN
#define CFG_SYS_LEN DEVNAME_LEN + SSID_LEN + PWD_LEN + 1
#define CFG_LEN 7 + NTP_ADDR_LEN + 2 + CFG_MQTT_LEN + 4

#define CFG_MQTT_LEN MQTT_ADDR_LEN + 2 + MQTT_USER_LEN + MQTT_PWD_LEN +MQTT_TOPIC_LEN
#define CFG_SYS_LEN DEVNAME_LEN + SSID_LEN + PWD_LEN + 1
#define CFG_LEN 7 + NTP_ADDR_LEN + 2 + CFG_MQTT_LEN + 4

#define ADDR_START 0
#define ADDR_CFG_SYS ADDR_START
Expand Down
2 changes: 1 addition & 1 deletion tools/esp8266/html/convert.py
View file
Original file line number Diff line number Diff line change
Expand Up @@ -34,5 +34,5 @@ def convert2Header(inFile):

convert2Header("index.html")
convert2Header("setup.html")
convert2Header("hoymiles.html")
convert2Header("visualization.html")
convert2Header("style.css")
4 changes: 0 additions & 4 deletions tools/esp8266/html/h/hoymiles_html.h
View file

This file was deleted.

2 changes: 1 addition & 1 deletion tools/esp8266/html/h/index_html.h
View file
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
#ifndef __INDEX_HTML_H__
#define __INDEX_HTML_H__
const char index_html[] PROGMEM = "<!doctype html><html><head><title>Index - {DEVICE}</title><link rel=\"stylesheet\" type=\"text/css\" href=\"style.css\"/><meta name=\"viewport\" content=\"width=device-width, initial-scale=1\"><script type=\"text/javascript\">getAjax('/uptime', 'uptime');getAjax('/time', 'time');getAjax('/cmdstat', 'cmds');window.setInterval(\"getAjax('/uptime', 'uptime')\", {JS_TS});window.setInterval(\"getAjax('/time', 'time')\", {JS_TS});window.setInterval(\"getAjax('/cmdstat', 'cmds')\", {JS_TS});function getAjax(url, resid) {var http = null;http = new XMLHttpRequest();if(http != null) {http.open(\"GET\", url, true);http.onreadystatechange = print;http.send(null);}function print() {if(http.readyState == 4) {document.getElementById(resid).innerHTML = http.responseText;}}}</script></head><body><h1>AHOY - {DEVICE}</h1><div id=\"content\" class=\"content\"><p><a href=\"/hoymiles\">Visualization</a><br/><br/><a href=\"/setup\">Setup</a><br/></p><p><span class=\"des\">Uptime: </span><span id=\"uptime\"></span></p><p><span class=\"des\">Time: </span><span id=\"time\"></span></p><p><span class=\"des\">Statistics: </span><pre id=\"cmds\"></pre></p><p>Every {TS}seconds the values are updated</p><div id=\"note\">This project was started from <a href=\"https://www.mikrocontroller.net/topic/525778\" target=\"_blank\">this discussion. (Mikrocontroller.net)</a><br/>New updates can be found on Github: <a href=\"https://github.com/grindylow/ahoy\" target=\"_blank\">https://github.com/grindylow/ahoy</a><br/><br/>Please report issues using the feature provided by <a href=\"https://github.com/grindylow/ahoy/issues\">Github</a><br/><br/>Discuss with us on <a href=\"https://discord.gg/WzhxEY62mB\">Discord</a><br/><p class=\"lic\"><a href=\"https://creativecommons.org/licenses/by-nc-sa/3.0/de\">Creative Commons - https://creativecommons.org/licenses/by-nc-sa/3.0/de/</a><br/>Check the licenses which are published on <a href=\"https://github.com/grindylow/ahoy\">https://github.com/grindylow/ahoy</a>as well</p></div></div><div id=\"footer\"><p class=\"left\">&copy 2022</p><p class=\"left\"><a href=\"/update\">Update Firmware</a></p><p class=\"right\">AHOY :: {VERSION}</p><p class=\"right\"><a href=\"/reboot\">Reboot</a></p><p class=\"right\">Git SHA: {BUILD}</p></div></body></html>";
const char index_html[] PROGMEM = "<!doctype html><html><head><title>Index - {DEVICE}</title><link rel=\"stylesheet\" type=\"text/css\" href=\"style.css\"/><meta name=\"viewport\" content=\"width=device-width, initial-scale=1\"><script type=\"text/javascript\">getAjax('/uptime', 'uptime');getAjax('/cmdstat', 'cmds');window.setInterval(\"getAjax('/uptime', 'uptime')\", {JS_TS});window.setInterval(\"getAjax('/cmdstat', 'cmds')\", {JS_TS});function getAjax(url, resid) {var http = null;http = new XMLHttpRequest();if(http != null) {http.open(\"GET\", url, true);http.onreadystatechange = print;http.send(null);}function print() {if(http.readyState == 4) {document.getElementById(resid).innerHTML = http.responseText;}}}</script></head><body><h1>AHOY - {DEVICE}</h1><div id=\"content\" class=\"content\"><p><a href=\"/visualization\">Visualization</a><br/><br/><a href=\"/setup\">Setup</a><br/></p><p><span class=\"des\">Uptime: </span><span id=\"uptime\"></span></p><p><span class=\"des\">Statistics: </span><pre id=\"cmds\"></pre></p><p>Every {TS}seconds the values are updated</p><div id=\"note\">This project was started from <a href=\"https://www.mikrocontroller.net/topic/525778\" target=\"_blank\">this discussion. (Mikrocontroller.net)</a><br/>New updates can be found on Github: <a href=\"https://github.com/grindylow/ahoy\" target=\"_blank\">https://github.com/grindylow/ahoy</a><br/><br/>Please report issues using the feature provided by <a href=\"https://github.com/grindylow/ahoy/issues\">Github</a><br/><br/>Discuss with us on <a href=\"https://discord.gg/WzhxEY62mB\">Discord</a><br/><p class=\"lic\"><a href=\"https://creativecommons.org/licenses/by-nc-sa/3.0/de\">Creative Commons - https://creativecommons.org/licenses/by-nc-sa/3.0/de/</a><br/>Check the licenses which are published on <a href=\"https://github.com/grindylow/ahoy\">https://github.com/grindylow/ahoy</a>as well</p></div></div><div id=\"footer\"><p class=\"left\">&copy 2022</p><p class=\"left\"><a href=\"/update\">Update Firmware</a></p><p class=\"right\">AHOY :: {VERSION}</p><p class=\"right\"><a href=\"/reboot\">Reboot</a></p><p class=\"right\">Git SHA: {BUILD}</p></div></body></html>";
#endif /*__INDEX_HTML_H__*/
4 changes: 4 additions & 0 deletions tools/esp8266/html/h/visualization_html.h
View file
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
#ifndef __VISUALIZATION_HTML_H__
#define __VISUALIZATION_HTML_H__
const char visualization_html[] PROGMEM = "<!doctype html><html><head><title>Index - {DEVICE}</title><link rel=\"stylesheet\" type=\"text/css\" href=\"style.css\"/><meta name=\"viewport\" content=\"width=device-width, initial-scale=1\"><script type=\"text/javascript\">getAjax('/livedata', 'livedata');window.setInterval(\"getAjax('/livedata', 'livedata')\", {JS_TS});function getAjax(url, resid) {var http = null;http = new XMLHttpRequest();if(http != null) {http.open(\"GET\", url, true);http.onreadystatechange = print;http.send(null);}function print() {if(http.readyState == 4) {document.getElementById(resid).innerHTML = http.responseText;}}}</script><style type=\"text/css\"></style></head><body><h1>AHOY - {DEVICE}</h1><div id=\"content\" class=\"content\"><div id=\"livedata\"></div><p>Every {TS}seconds the values are updated</p></div><div id=\"footer\"><p class=\"left\">&copy 2022</p><p class=\"left\"><a href=\"/\">Home</a></p><p class=\"right\">AHOY :: {VERSION}</p></div></body></html>";
#endif /*__VISUALIZATION_HTML_H__*/
Loading

0 comments on commit 74f053a

Please sign in to comment.