Add webserver #98

lenvm · 2023-11-16T20:45:49Z

What

This pull request adds webserver functionality.
The devboard creates a WiFi Access Point named Battery Emulator that can be connected to using the password "123456789". The IP address of the board as Access Point is printed via Serial. The IP address allows you to connect to the webserver via a webbrowser.
The devboard simultaneously connects to an existing network using the ssid and password settings provided in webserver.cpp. If the connection is successful, the IP address obtained is printed via Serial. This IP address you can connect to via a webbrowser, while you are connected to your local network.

The webserver currently displays:

LED status
WiFi SSID it is trying to connect to
WiFi status: connected or not connected
IP address obtained from the WiFi it has connected to

The webserver also allows for updating over the air. Please see the README.md file for details.

How

The webserver is implemented by using the existing ESP32 Wifi.h library.
The over-the-air capability is implemented by adding 3 new libraries:

me-no-dev/AsyncTCP
me-no-dev/ESPAsyncWebServer
ayushsharma82/ElegantOTA

The specific commit of each library is added to the README.md file of the respective library. Adding the libraries as a git submodule would be an alternative, however some specific changes to make the libraries work in the directory that they are stored in are needed, therefore this approach of storing the commit used in the README.md file is taken, for traceability.

Why

It is useful to be able to know the state of the devboard without connecting to it using Serial. Now you are able to check the state of the battery emulation from your couch 😎

This PR opens the possibility to add more webserver functionalities, such as:

displaying more variables, such as state of health, power, etc.
configuring which battery is used and which inverter protocol shall be emulated
configuring which WiFi network shall be connected to
displaying current CAN state
displaying detailed diagnosis messages for the battery and the inverter, helping users to debug potential issues
etc.

rjsc · 2023-11-16T22:12:16Z

You must store the strings in the program memory explicitly, or else, every string gets loaded to RAM at boot. The RAM is getting filled up with strings plus the many Modbus registers from LUNA protocol.
Check https://arduino-esp8266.readthedocs.io/en/latest/PROGMEM.html

I would also recommend using a asynchronous webserver implentacion such as https://github.com/me-no-dev/ESPAsyncWebServer

lenvm · 2023-11-19T15:16:44Z

Thanks @rjsc!

I’ll have a go at implementing the webserver as an asynchronous webserver that saves the HTML and CSS files in SPIFFS, as described in this tutorial.

dalathegreat · 2023-11-20T20:51:27Z

@lenvm The Luna2000 registers are not confirmed to need 50k space. For now we can reduce this line in LUNA2000-MODBUS.h and Software.ino

#define MB_RTU_NUM_VALUES 30000

This will make it compile.

matvey83 · 2023-11-21T16:45:34Z

Software/src/devboard/webserver/webserver.cpp

+  const char* ssidAP = "Battery Emulator";  // maximum of 63 characters;
+  const char* passwordAP = "123456789";  // minimum of 8 characters; set to NULL if you want the access point to be open


Should probably move these to USER_SETTINGS.h

As well as a boolean flag to enable/disable the web server.

Yes, I fully agree with you on both points:

The ssid, password, ssidAP and passwordAP should be user settings.

There should be a #define to determine whether WiFi and the webserver should be active.

I had not implemented these points yet, as I first wanted to figure out how to resolve the issue with the code not compiling for LUNA2000_MODBUS.

@matvey83, I have implemented the two points above.

matvey83 · 2023-11-21T16:48:03Z

Software/src/devboard/webserver/webserver.cpp

+          if (current_line.length() == 0) {
+            // HTTP headers always start with a response code (e.g. HTTP/1.1 200 OK)
+            // and a content-type so the client knows what's coming, then a blank line:
+            client.println("HTTP/1.1 200 OK");


Would be nice to pull the code that generates the response HTML into a separate file, as I imagine it will grow to be quite big eventually.

And also just would be nice to have logic for this separated from the rest of the web server logic.

Yes, I agree with you on this as well. The folder structure as suggested by the ESP32 Web Server using SPIFFS tutorial uses a data folder and index.html and ccs.style files. This seems a good file structure to me.

@matvey83, due to SPIFFS currently not being supported by Arduino 2.0, I have decided not to proceed an implementation using SPIFFS at this point in time. Therefore there are is also no separate HTML file at this point in time. We can implement this as a future improvement of the code.

lenvm · 2023-11-21T17:03:15Z

@lenvm The Luna2000 registers are not confirmed to need 50k space. For now we can reduce this line in LUNA2000-MODBUS.h and Software.ino

#define MB_RTU_NUM_VALUES 30000

This will make it compile.

Thanks @dalathegreat, that is great to know! In order to also address the other comments in this PR, I am of the opinion that the best way forward is to try to implement the webserver as an asynchronous webserver, with the HTML and CSS files stored in SPIFFS. I'll give this a go and update this PR accordingly, before modifying the DRAM space defined for Luna2000.

lenvm · 2023-11-26T14:05:17Z

@dalathegreat I have implemented the code as asynchronous webserver, but I have not implemented the code using SPIFFS, as this is currently not supported in Arduino 2.0.

I have therefore followed your suggestion and changed the value for the Luna2000 registers from 50k to 30k.

dalathegreat · 2023-11-26T19:17:56Z

@lenvm Should we mention that an external antenna should be fitted to the board?

Maybe we could open a Wiki page for the Webserver side of this

StarkJohan · 2023-11-26T19:35:57Z

It's not necessary to connect an external antenna as the board includes a ceramic antenna which is connected by default (the red component marked C3). If an external antenna is to be used, the zero ohm resistor needs to be moved 90 degrees to the alternate position.

lenvm · 2023-12-02T19:04:59Z

@dalathegreat, can you please review this pull request? In my opinion it is ready to be merged.

dalathegreat

Just tested this out locally, and it seems like a great feature! Approving this 👍

… repository

…tory

matvey83 reviewed Nov 21, 2023

View reviewed changes

lenvm force-pushed the feature/webserver branch from af0327c to 4961358 Compare November 26, 2023 13:59

lenvm marked this pull request as ready for review November 26, 2023 14:05

lenvm requested a review from dalathegreat November 30, 2023 08:32

dalathegreat approved these changes Dec 3, 2023

View reviewed changes

lenvm added 12 commits December 3, 2023 20:09

add AsyncTCP library

3d86496

add ESPAsyncWebserver library

19900e6

modify ESPAsyncWebServer library such that it works correctly in this…

ace426c

… repository

add initial version of asynchronous webserver

34ab0a0

display network information on webserver

9fddd27

display LED color on webserver

5678453

add ElegantOTA library

ed1b6e7

modify ElegantOTA library such that it works correctly in this reposi…

16d38fd

…tory

define ELEGANTOTA_USE_ASYNC_WEBSERVER as 1 to enable Async Mode

e5586e9

add ElegantOTA to webserver

ce47ffd

add WEBSERVER macro to enable or disable webserver functionality

e7b1958

reduce Luna2000 register allocation from 50k to 30k

e37b8f7

lenvm force-pushed the feature/webserver branch from 4961358 to e37b8f7 Compare December 3, 2023 19:10

lenvm merged commit 85db9c3 into dalathegreat:main Dec 3, 2023
16 checks passed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Add webserver #98

Add webserver #98

lenvm commented Nov 16, 2023 •

edited

Loading

rjsc commented Nov 16, 2023 •

edited

Loading

lenvm commented Nov 19, 2023

dalathegreat commented Nov 20, 2023

matvey83 Nov 21, 2023

lenvm Nov 21, 2023

lenvm Nov 26, 2023

matvey83 Nov 21, 2023

lenvm Nov 21, 2023

lenvm Nov 26, 2023

lenvm commented Nov 21, 2023

lenvm commented Nov 26, 2023

dalathegreat commented Nov 26, 2023

StarkJohan commented Nov 26, 2023

lenvm commented Dec 2, 2023

dalathegreat left a comment

		const char* ssidAP = "Battery Emulator"; // maximum of 63 characters;
		const char* passwordAP = "123456789"; // minimum of 8 characters; set to NULL if you want the access point to be open

Add webserver #98

Add webserver #98

Conversation

lenvm commented Nov 16, 2023 • edited Loading

What

How

Why

rjsc commented Nov 16, 2023 • edited Loading

lenvm commented Nov 19, 2023

dalathegreat commented Nov 20, 2023

matvey83 Nov 21, 2023

Choose a reason for hiding this comment

lenvm Nov 21, 2023

Choose a reason for hiding this comment

lenvm Nov 26, 2023

Choose a reason for hiding this comment

matvey83 Nov 21, 2023

Choose a reason for hiding this comment

lenvm Nov 21, 2023

Choose a reason for hiding this comment

lenvm Nov 26, 2023

Choose a reason for hiding this comment

lenvm commented Nov 21, 2023

lenvm commented Nov 26, 2023

dalathegreat commented Nov 26, 2023

StarkJohan commented Nov 26, 2023

lenvm commented Dec 2, 2023

dalathegreat left a comment

Choose a reason for hiding this comment

lenvm commented Nov 16, 2023 •

edited

Loading

rjsc commented Nov 16, 2023 •

edited

Loading