Historia

Harshit Malpani 7decf3e344 fix: Fix protocols example to build without setting target Protocol examples used to raise an error if the target was not set and `idf.py build` command was used. This commit fix this error and when IDF_TARGET is not set, ESP32 is selected as default target		2023-09-25 16:57:22 +05:30
..
main	fix: Fix protocols example to build without setting target	2023-09-25 16:57:22 +05:30
CMakeLists.txt	fix: Fix protocols example to build without setting target	2023-09-25 16:57:22 +05:30
README.md	protocols/examples: Disable Wifi connection if not supported	2023-07-12 06:19:20 +00:00
pytest_http_server_simple.py	examples/protocols: Added URI encoding/decoding feature	2023-01-25 17:47:14 +05:30
sdkconfig.ci	CI: use ssid password from stdin for pytest cases	2022-07-15 01:16:36 +08:00
sdkconfig.ci.ipv6_only	lwip: Support IPv6 only mode	2023-02-27 08:53:34 +01:00

README.md

Supported Targets	ESP32	ESP32-C2	ESP32-C3	ESP32-C6	ESP32-H2	ESP32-S2	ESP32-S3

Simple HTTPD Server Example

The Example consists of HTTPD server demo with demostration of URI handling : 1. URI \hello for GET command returns "Hello World!" message 2. URI \echo for POST command echoes back the POSTed message

How to use example

Hardware Required

A development board with ESP32/ESP32-S2/ESP32-C3 SoC (e.g., ESP32-DevKitC, ESP-WROVER-KIT, etc.)
A USB cable for power supply and programming

Configure the project

idf.py menuconfig

Open the project configuration menu (idf.py menuconfig) to configure Wi-Fi or Ethernet. See "Establishing Wi-Fi or Ethernet Connection" section in examples/protocols/README.md for more details.

Build and Flash

Build the project and flash it to the board, then run monitor tool to view serial output:

idf.py -p PORT flash monitor

(Replace PORT with the name of the serial port to use.)

(To exit the serial monitor, type Ctrl-].)

See the Getting Started Guide for full steps to configure and use ESP-IDF to build projects.

Test the example :

    * run the test script : "python scripts/client.py \<IP\> \<port\> \<MSG\>"
        * the provided test script first does a GET \hello and displays the response
        * the script does a POST to \echo with the user input \<MSG\> and displays the response
    * or use curl (asssuming IP is 192.168.43.130):
        1. "curl 192.168.43.130:80/hello"  - tests the GET "\hello" handler
        2. "curl -X POST --data-binary @anyfile 192.168.43.130:80/echo > tmpfile"
            * "anyfile" is the file being sent as request body and "tmpfile" is where the body of the response is saved
            * since the server echoes back the request body, the two files should be same, as can be confirmed using : "cmp anyfile tmpfile"
        3. "curl -X PUT -d "0" 192.168.43.130:80/ctrl" - disable /hello and /echo handlers
        4. "curl -X PUT -d "1" 192.168.43.130:80/ctrl" -  enable /hello and /echo handlers

Example Output

I (9580) example_connect: - IPv4 address: 192.168.194.219
I (9580) example_connect: - IPv6 address: fe80:0000:0000:0000:266f:28ff:fe80:2c74, type: ESP_IP6_ADDR_IS_LINK_LOCAL
I (9590) example: Starting server on port: '80'
I (9600) example: Registering URI handlers
I (66450) example: Found header => Host: 192.168.194.219
I (66460) example: Request headers lost

Troubleshooting

If the server log shows "httpd_parse: parse_block: request URI/header too long", especially when handling POST requests, then you probably need to increase HTTPD_MAX_REQ_HDR_LEN, which you can find in the project configuration menu (idf.py menuconfig): Component config -> HTTP Server -> Max HTTP Request Header Length