8000 Updated readme · omega2amm/esp32_https_server@e9ec021 · GitHub
[go: up one dir, main page]
Skip to content

Commit e9ec021

Browse files
fhesselfhessel
committed
Updated readme
1 parent eb26348 commit e9ec021

File tree

1 file changed

+21
-6
lines changed

1 file changed

+21
-6
lines changed

‎README.md

Lines changed: 21 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,14 +1,17 @@
11
# ESP32 HTTPS Server
22

3-
**Disclaimer**: This code is work-in-progress and contains many non-existing features and bugs which are not documented.
3+
**Disclaimer**: This code is work-in-progress! It may contain several bugs, but it should be roughly working
44

55
This repository contains an HTTPS server implementation that can be used with the [ESP32 Arduino Core](https://github.com/espressif/arduino-esp32).
66

77
The main goals for the server are:
8-
- Ability to handle multiple clients in parallel
9-
- Possibility to be executed in a task without interrupting the main program
10-
- Ability to handle `Connection: keep-alive` and WebSockets to reduce the SSL-overhead for streaming data operations
11-
- Abstraction of handling the HTTP(S) protocol
8+
- Ability to handle multiple clients in parallel (works)
9+
- Possibility to be executed in a task without interrupting the main program (works)
10+
- Ability to handle `Connection: keep-alive` (works) and WebSockets (tbd) to reduce the SSL-overhead for streaming data operations
11+
- Abstraction of handling the HTTP(S) protocol (tbd)
12+
13+
For the future, the project structure will be converted to serve as a regular Arduino Library. For the moment, you may just
14+
copy the https folder into your project, it is self-contained and needs only the WiFi-Library.
1215

1316
## Setup instructions
1417

@@ -20,4 +23,16 @@ Roughly:
2023

2124
## Usage
2225

23-
(todo)
26+
Until there is an explicit documentation, the file https_server.cpp contains a script that shows how the server can be
27+
used and be integrated in a project including comments on the various functions.
28+
29+
After compiling and flashing the script to your ESP32 module, you should be able to access the following resources on
30+
the esp via HTTPS:
31+
32+
- your-ip/ - Welcome page showing the uptime and some parameterized SVG-images
33+
- your-ip/favicon.ico - Favicon that is stored in data/favicon.h
34+
- /images/awesome.svg?color=de58fe - SVG-Image, using the optional parameter as background color
35+
- /echo - Will return request body for POST and PUT requests
36+
- /param/[a]/[b] - Will show the parsed parameters a and b
37+
- Any OPTIONS request - Will return some CORS-headers
38+
- Everything else - JSON error object

0 commit comments

Comments
 (0)
0