mirror of https://github.com/espressif/esp-idf.git synced 2026-04-27 19:13:21 +00:00

Files

T

Frantisek Hrbata ad15109daa change(examples): explicitly specify component dependencies for examples

Currently, several examples do not explicitly state their component
dependencies, relying instead on the default behavior that includes all
registered components and commonly required ones in the build.
Explicitly adding component dependencies can reduce build time when
set(COMPONENTS main) is used.

Signed-off-by: Frantisek Hrbata <frantisek.hrbata@espressif.com>

2024-11-20 14:11:24 +01:00

main

change(examples): explicitly specify component dependencies for examples

2024-11-20 14:11:24 +01:00

CMakeLists.txt

refactor(linux): excluded all non-Linux components from build

2023-10-16 17:06:54 +08:00

pytest_http_server_simple.py

examples/protocols: Added URI encoding/decoding feature

2023-01-25 17:47:14 +05:30

README.md

ci(esp_eth): enabled build and test for c61 in eth/proto examples

2024-09-18 08:44:58 +02:00

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

sdkconfig.defaults

refactor(linux): excluded all non-Linux components from build

2023-10-16 17:06:54 +08:00

README.md

Supported Targets	ESP32	ESP32-C2	ESP32-C3	ESP32-C5	ESP32-C6	ESP32-C61	ESP32-H2	ESP32-P4	ESP32-S2	ESP32-S3

Simple HTTPD Server Example

The Example consists of HTTPD server demo with demonstration 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 (assuming 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