Skip to content

Commit 59c2b8c

Browse files
authored
Update Documentation
1 parent 5b10751 commit 59c2b8c

File tree

1 file changed

+23
-3
lines changed
  • libraries/WebServer/examples/WebServer

1 file changed

+23
-3
lines changed

libraries/WebServer/examples/WebServer/README.md

Lines changed: 23 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -10,6 +10,12 @@ This example requires some space for a filesystem and runs fine boards with 4 MB
1010
* Partition Scheme: Default 4MB with spiffs (1.2MB APP/1.5MB SPIFFS)
1111
but LittleFS will be used in the partition (not SPIFFS)
1212

13+
or
14+
15+
* Board: Arduino Nano ESP32
16+
* Partition Scheme: "With FAT partition"
17+
18+
1319
It features
1420

1521
* Setup a web server
@@ -28,9 +34,9 @@ It features
2834

2935
Currently, this example supports the following targets.
3036

31-
| Supported Targets | ESP32 | ESP32-S2 | ESP32-C3 |
32-
| ----------------- | ----- | -------- | -------- |
33-
| | yes | yes | yes |
37+
| Supported Targets | ESP32 | ESP32-S2 | ESP32-S3 | ESP32-C3 |
38+
| ----------------- | ----- | -------- | -------- | -------- |
39+
| | yes | no | yes | yes |
3440

3541
## Use the Example
3642

@@ -200,6 +206,7 @@ This class has to implements several functions and works in a more detailed way:
200206
201207
* The `canUpload()`and `upload()` methods work similar while the `upload()` method is called multiple times to create, append data and close the new file.
202208
209+
203210
## File upload
204211
205212
By opening <http://webserver/$upload.htm> you can easily upload files by dragging them over the drop area.
@@ -238,6 +245,7 @@ You can see on the Serial output that one filesystem write error is reported.
238245
Please be patient and wait for the upload ending even when writing to the filesystem is disabled
239246
it maybe take more than a minute.
240247
248+
241249
## Registering a special handler for "file not found"
242250
243251
Any other incoming request that was not handled by the registered plug-ins above can be detected by registering
@@ -253,6 +261,7 @@ Any other incoming request that was not handled by the registered plug-ins above
253261
This allows sending back an "friendly" result for the browser. Here a simple html page is created from a static string.
254262
You can easily change the html code in the file `builtinfiles.h`.
255263
264+
256265
## customizations
257266
258267
You may like to change the hostname and the timezone in the lines:
@@ -262,10 +271,19 @@ You may like to change the hostname and the timezone in the lines:
262271
> #define TIMEZONE "CET-1CEST,M3.5.0,M10.5.0/3"
263272
> ```
264273
274+
265275
## Troubleshooting
266276
267277
Have a look in the Serial output for some additional runtime information.
268278
279+
280+
## Changes
281+
282+
* 2024-08-02 -- Fixing for board implementation 3.0.4 ff.
283+
* 2024-08-02 -- Support for FAT
284+
* 2024-08-02 -- Tested with Arduino Nano ESP32
285+
286+
269287
## Contribute
270288
271289
To know how to contribute to this project, see [How to contribute.](https://github.com/espressif/arduino-esp32/blob/master/CONTRIBUTING.rst)
@@ -274,11 +292,13 @@ If you have any **feedback** or **issue** to report on this example/library, ple
274292
275293
Before creating a new issue, be sure to try Troubleshooting and check if the same issue was already created by someone else.
276294
295+
277296
## Resources
278297
279298
* Official ESP32 Forum: [Link](https://esp32.com)
280299
* Arduino-ESP32 Official Repository: [espressif/arduino-esp32](https://github.com/espressif/arduino-esp32)
281300
* ESP32 Datasheet: [Link to datasheet](https://www.espressif.com/sites/default/files/documentation/esp32_datasheet_en.pdf)
282301
* ESP32-S2 Datasheet: [Link to datasheet](https://www.espressif.com/sites/default/files/documentation/esp32-s2_datasheet_en.pdf)
302+
* ESP32-S3 Datasheet: [Link to datasheet](https://www.espressif.com/sites/default/files/documentation/esp32-s3_datasheet_en.pdf)
283303
* ESP32-C3 Datasheet: [Link to datasheet](https://www.espressif.com/sites/default/files/documentation/esp32-c3_datasheet_en.pdf)
284304
* Official ESP-IDF documentation: [ESP-IDF](https://idf.espressif.com)

0 commit comments

Comments
 (0)