# in this exact order for cmake to work correctly
cmake_minimum_required(VERSION 3.5)
+# (Not part of the boilerplate)
+# This example uses an extra component for common functions such as Wi-Fi and Ethernet connection.
+set(EXTRA_COMPONENT_DIRS $ENV{IDF_PATH}/examples/common_components/protocol_examples_common)
+
include($ENV{IDF_PATH}/tools/cmake/project.cmake)
project(tests)
-
-target_include_directories(tests.elf PRIVATE main/include)
PROJECT_NAME := tests
+EXTRA_COMPONENT_DIRS = $(IDF_PATH)/examples/common_components/protocol_examples_common
+
include $(IDF_PATH)/make/project.mk
# Parse IP address of STA
Utility.console_log("Waiting to connect with AP")
- got_ip = dut1.expect(re.compile(r"(?:[\s\S]*)Got IP: '(\d+.\d+.\d+.\d+)'"), timeout=30)[0]
+ got_ip = dut1.expect(re.compile(r"(?:[\s\S]*)IPv4 address: (\d+.\d+.\d+.\d+)"), timeout=30)[0]
got_port = dut1.expect(re.compile(r"(?:[\s\S]*)Started HTTP server on port: '(\d+)'"), timeout=15)[0]
result = dut1.expect(re.compile(r"(?:[\s\S]*)Max URI handlers: '(\d+)'(?:[\s\S]*)Max Open Sessions: " # noqa: W605
+++ /dev/null
-menu "Example Configuration"
-
- config WIFI_SSID
- string "WiFi SSID"
- default "myssid"
- help
- SSID (network name) for the example to connect to.
-
- config WIFI_PASSWORD
- string "WiFi Password"
- default "mypassword"
- help
- WiFi password (WPA or WPA2) for the example to use.
- Can be left blank if the network has no security set.
-
-endmenu
+/* HTTP Server Tests
+
+ This example code is in the Public Domain (or CC0 licensed, at your option.)
+
+ Unless required by applicable law or agreed to in writing, this
+ software is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR
+ CONDITIONS OF ANY KIND, either express or implied.
+*/
+
#include "esp_wifi.h"
#include "esp_event_loop.h"
#include "esp_log.h"
#include "esp_system.h"
#include "nvs_flash.h"
+#include "tcpip_adapter.h"
+#include "esp_eth.h"
+#include "protocol_examples_common.h"
#include "tests.h"
-/* The examples use simple WiFi configuration that you can set via
- 'make menuconfig'.
-
- If you'd rather not, just change the below entries to strings with
- the config you want - ie #define EXAMPLE_WIFI_SSID "mywifissid"
-*/
-#define EXAMPLE_WIFI_SSID CONFIG_WIFI_SSID
-#define EXAMPLE_WIFI_PASS CONFIG_WIFI_PASSWORD
-
-static const char *TAG="TEST_WIFI";
+static const char *TAG = "example";
-static esp_err_t event_handler(void *ctx, system_event_t *event)
+static void disconnect_handler(void* arg, esp_event_base_t event_base,
+ int32_t event_id, void* event_data)
{
- httpd_handle_t *hd = (httpd_handle_t *) ctx;
-
- switch(event->event_id) {
- case SYSTEM_EVENT_STA_START:
- ESP_LOGI(TAG, "SYSTEM_EVENT_STA_START");
- ESP_ERROR_CHECK(esp_wifi_connect());
- break;
- case SYSTEM_EVENT_STA_GOT_IP:
- ESP_LOGI(TAG, "SYSTEM_EVENT_STA_GOT_IP");
- ESP_LOGI(TAG, "Got IP: '%s'",
- ip4addr_ntoa(&event->event_info.got_ip.ip_info.ip));
-
- // Start webserver tests
- if (*hd == NULL) {
- *hd = start_tests();
- }
-
- break;
- case SYSTEM_EVENT_STA_DISCONNECTED:
- ESP_LOGI(TAG, "SYSTEM_EVENT_STA_DISCONNECTED");
- ESP_ERROR_CHECK(esp_wifi_connect());
-
- // Stop webserver tests
- if (*hd) {
- stop_tests(*hd);
- *hd = NULL;
- }
-
- break;
- default:
- break;
+ httpd_handle_t* server = (httpd_handle_t*) arg;
+ if (*server) {
+ ESP_LOGI(TAG, "Stopping webserver");
+ stop_tests(*server);
+ *server = NULL;
}
- return ESP_OK;
}
-static void initialise_wifi(void)
+static void connect_handler(void* arg, esp_event_base_t event_base,
+ int32_t event_id, void* event_data)
{
- tcpip_adapter_init();
- static httpd_handle_t hd = NULL;
- ESP_ERROR_CHECK(esp_event_loop_init(event_handler, &hd));
- wifi_init_config_t cfg = WIFI_INIT_CONFIG_DEFAULT();
- ESP_ERROR_CHECK(esp_wifi_init(&cfg));
- ESP_ERROR_CHECK(esp_wifi_set_storage(WIFI_STORAGE_RAM));
- wifi_config_t wifi_config = {
- .sta = {
- .ssid = EXAMPLE_WIFI_SSID,
- .password = EXAMPLE_WIFI_PASS,
- },
- };
- ESP_LOGI(TAG, "Setting WiFi configuration SSID %s...", wifi_config.sta.ssid);
- ESP_ERROR_CHECK(esp_wifi_set_mode(WIFI_MODE_STA));
- ESP_ERROR_CHECK(esp_wifi_set_config(ESP_IF_WIFI_STA, &wifi_config));
- ESP_ERROR_CHECK(esp_wifi_start());
+ httpd_handle_t* server = (httpd_handle_t*) arg;
+ if (*server == NULL) {
+ ESP_LOGI(TAG, "Starting webserver");
+ *server = start_tests();
+ }
}
void app_main()
{
+ static httpd_handle_t server = NULL;
+
ESP_ERROR_CHECK(nvs_flash_init());
- initialise_wifi();
+ tcpip_adapter_init();
+ ESP_ERROR_CHECK(esp_event_loop_create_default());
+
+ /* This helper function configures Wi-Fi or Ethernet, as selected in menuconfig.
+ * Read "Establishing Wi-Fi or Ethernet Connection" section in
+ * examples/protocols/README.md for more information about this function.
+ */
+ ESP_ERROR_CHECK(example_connect());
+
+ /* Register event handlers to stop the server when Wi-Fi or Ethernet is disconnected,
+ * and re-start it upon connection.
+ */
+#ifdef CONFIG_EXAMPLE_CONNECT_WIFI
+ ESP_ERROR_CHECK(esp_event_handler_register(IP_EVENT, IP_EVENT_STA_GOT_IP, &connect_handler, &server));
+ ESP_ERROR_CHECK(esp_event_handler_register(WIFI_EVENT, WIFI_EVENT_STA_DISCONNECTED, &disconnect_handler, &server));
+#endif // CONFIG_EXAMPLE_CONNECT_WIFI
+#ifdef CONFIG_EXAMPLE_CONNECT_ETHERNET
+ ESP_ERROR_CHECK(esp_event_handler_register(IP_EVENT, IP_EVENT_ETH_GOT_IP, &connect_handler, &server));
+ ESP_ERROR_CHECK(esp_event_handler_register(ETH_EVENT, ETHERNET_EVENT_DISCONNECTED, &disconnect_handler, &server));
+#endif // CONFIG_EXAMPLE_CONNECT_ETHERNET
+
+ /* Start the server for the first time */
+ server = start_tests();
}
#include "tests.h"
-static const char *TAG="TESTS";
+static const char *TAG = "TESTS";
-int pre_start_mem, post_stop_mem, post_stop_min_mem;
-bool basic_sanity = true;
+static int pre_start_mem, post_stop_mem;
struct async_resp_arg {
httpd_handle_t hd;
/********************* Basic Handlers Start *******************/
-esp_err_t hello_get_handler(httpd_req_t *req)
+static esp_err_t hello_get_handler(httpd_req_t *req)
{
#define STR "Hello World!"
ESP_LOGI(TAG, "Free Stack for server task: '%d'", uxTaskGetStackHighWaterMark(NULL));
#undef STR
}
-esp_err_t hello_type_get_handler(httpd_req_t *req)
+static esp_err_t hello_type_get_handler(httpd_req_t *req)
{
#define STR "Hello World!"
httpd_resp_set_type(req, HTTPD_TYPE_TEXT);
#undef STR
}
-esp_err_t hello_status_get_handler(httpd_req_t *req)
+static esp_err_t hello_status_get_handler(httpd_req_t *req)
{
#define STR "Hello World!"
httpd_resp_set_status(req, HTTPD_500);
#undef STR
}
-esp_err_t echo_post_handler(httpd_req_t *req)
+static esp_err_t echo_post_handler(httpd_req_t *req)
{
ESP_LOGI(TAG, "/echo handler read content length %d", req->content_len);
return ESP_OK;
}
-void adder_free_func(void *ctx)
+static void adder_free_func(void *ctx)
{
ESP_LOGI(TAG, "Custom Free Context function called");
free(ctx);
/* Create a context, keep incrementing value in the context, by whatever was
* received. Return the result
*/
-esp_err_t adder_post_handler(httpd_req_t *req)
+static esp_err_t adder_post_handler(httpd_req_t *req)
{
char buf[10];
char outbuf[50];
return ESP_OK;
}
-esp_err_t leftover_data_post_handler(httpd_req_t *req)
+static esp_err_t leftover_data_post_handler(httpd_req_t *req)
{
/* Only echo the first 10 bytes of the request, leaving the rest of the
* request data as is.
return ESP_OK;
}
-int httpd_default_send(httpd_handle_t hd, int sockfd, const char *buf, unsigned buf_len, int flags);
-void generate_async_resp(void *arg)
+extern int httpd_default_send(httpd_handle_t hd, int sockfd, const char *buf, unsigned buf_len, int flags);
+
+static void generate_async_resp(void *arg)
{
char buf[250];
struct async_resp_arg *resp_arg = (struct async_resp_arg *)arg;
free(arg);
}
-esp_err_t async_get_handler(httpd_req_t *req)
+static esp_err_t async_get_handler(httpd_req_t *req)
{
#define STR "Hello World!"
httpd_resp_send(req, STR, strlen(STR));
}
-httpd_uri_t basic_handlers[] = {
+static const httpd_uri_t basic_handlers[] = {
{ .uri = "/hello/type_html",
.method = HTTP_GET,
.handler = hello_type_get_handler,
}
};
-int basic_handlers_no = sizeof(basic_handlers)/sizeof(httpd_uri_t);
-void register_basic_handlers(httpd_handle_t hd)
+static const int basic_handlers_no = sizeof(basic_handlers)/sizeof(httpd_uri_t);
+
+static void register_basic_handlers(httpd_handle_t hd)
{
int i;
ESP_LOGI(TAG, "Registering basic handlers");
ESP_LOGI(TAG, "Success");
}
-httpd_handle_t test_httpd_start()
+static httpd_handle_t test_httpd_start()
{
pre_start_mem = esp_get_free_heap_size();
httpd_handle_t hd;
return NULL;
}
-void test_httpd_stop(httpd_handle_t hd)
+static void test_httpd_stop(httpd_handle_t hd)
{
httpd_stop(hd);
post_stop_mem = esp_get_free_heap_size();
# in this exact order for cmake to work correctly
cmake_minimum_required(VERSION 3.5)
+# (Not part of the boilerplate)
+# This example uses an extra component for common functions such as Wi-Fi and Ethernet connection.
+set(EXTRA_COMPONENT_DIRS $ENV{IDF_PATH}/examples/common_components/protocol_examples_common)
+
include($ENV{IDF_PATH}/tools/cmake/project.cmake)
project(file_server)
PROJECT_NAME := file_server
+EXTRA_COMPONENT_DIRS = $(IDF_PATH)/examples/common_components/protocol_examples_common
+
include $(IDF_PATH)/make/project.mk
+++ /dev/null
-menu "Example Configuration"
-
- config WIFI_SSID
- string "WiFi SSID"
- default "myssid"
- help
- SSID (network name) for the example to connect to.
-
- config WIFI_PASSWORD
- string "WiFi Password"
- default "mypassword"
- help
- WiFi password (WPA or WPA2) for the example to use.
- Can be left blank if the network has no security set.
-
-endmenu
#include "esp_system.h"
#include "esp_spiffs.h"
#include "nvs_flash.h"
+#include "tcpip_adapter.h"
+#include "protocol_examples_common.h"
/* This example demonstrates how to create file server
* using esp_http_server. This file has only startup code.
* Look in file_server.c for the implementation */
-/* The example uses simple WiFi configuration that you can set via
- * 'make menuconfig'.
- * If you'd rather not, just change the below entries to strings
- * with the config you want -
- * ie. #define EXAMPLE_WIFI_SSID "mywifissid"
-*/
-#define EXAMPLE_WIFI_SSID CONFIG_WIFI_SSID
-#define EXAMPLE_WIFI_PASS CONFIG_WIFI_PASSWORD
-
static const char *TAG="example";
-/* Wi-Fi event handler */
-static esp_err_t event_handler(void *ctx, system_event_t *event)
-{
- switch(event->event_id) {
- case SYSTEM_EVENT_STA_START:
- ESP_LOGI(TAG, "SYSTEM_EVENT_STA_START");
- ESP_ERROR_CHECK(esp_wifi_connect());
- break;
- case SYSTEM_EVENT_STA_GOT_IP:
- ESP_LOGI(TAG, "SYSTEM_EVENT_STA_GOT_IP");
- ESP_LOGI(TAG, "Got IP: '%s'",
- ip4addr_ntoa(&event->event_info.got_ip.ip_info.ip));
- break;
- case SYSTEM_EVENT_STA_DISCONNECTED:
- ESP_LOGI(TAG, "SYSTEM_EVENT_STA_DISCONNECTED");
- ESP_ERROR_CHECK(esp_wifi_connect());
- break;
- default:
- break;
- }
- return ESP_OK;
-}
-
-/* Function to initialize Wi-Fi at station */
-static void initialise_wifi(void)
-{
- ESP_ERROR_CHECK(nvs_flash_init());
- tcpip_adapter_init();
- ESP_ERROR_CHECK(esp_event_loop_init(event_handler, NULL));
- wifi_init_config_t cfg = WIFI_INIT_CONFIG_DEFAULT();
- ESP_ERROR_CHECK(esp_wifi_init(&cfg));
- ESP_ERROR_CHECK(esp_wifi_set_storage(WIFI_STORAGE_RAM));
- wifi_config_t wifi_config = {
- .sta = {
- .ssid = EXAMPLE_WIFI_SSID,
- .password = EXAMPLE_WIFI_PASS,
- },
- };
- ESP_LOGI(TAG, "Setting WiFi configuration SSID %s...", wifi_config.sta.ssid);
- ESP_ERROR_CHECK(esp_wifi_set_mode(WIFI_MODE_STA));
- ESP_ERROR_CHECK(esp_wifi_set_config(ESP_IF_WIFI_STA, &wifi_config));
- ESP_ERROR_CHECK(esp_wifi_start());
-}
-
/* Function to initialize SPIFFS */
static esp_err_t init_spiffs(void)
{
void app_main()
{
- initialise_wifi();
+ ESP_ERROR_CHECK(nvs_flash_init());
+ tcpip_adapter_init();
+ ESP_ERROR_CHECK(esp_event_loop_create_default());
+
+ /* This helper function configures Wi-Fi or Ethernet, as selected in menuconfig.
+ * Read "Establishing Wi-Fi or Ethernet Connection" section in
+ * examples/protocols/README.md for more information about this function.
+ */
+ ESP_ERROR_CHECK(example_connect());
/* Initialize file storage */
ESP_ERROR_CHECK(init_spiffs());
# in this exact order for cmake to work correctly
cmake_minimum_required(VERSION 3.5)
+# (Not part of the boilerplate)
+# This example uses an extra component for common functions such as Wi-Fi and Ethernet connection.
+set(EXTRA_COMPONENT_DIRS $ENV{IDF_PATH}/examples/common_components/protocol_examples_common)
+
include($ENV{IDF_PATH}/tools/cmake/project.cmake)
project(persistent_sockets)
PROJECT_NAME := persistent_sockets
+EXTRA_COMPONENT_DIRS = $(IDF_PATH)/examples/common_components/protocol_examples_common
+
include $(IDF_PATH)/make/project.mk
-# HTTPD Server Persistant Sockets Example
+# HTTPD Server Persistent Sockets Example
The Example consists of HTTPD server persistent sockets demo.
-This sort of persistancy enables the server to have independent sessions/contexts per client.
+This sort of persistency enables the server to have independent sessions/contexts per client.
-* Configure the project using "make menuconfig" and goto :
- * Example Configuration ->
- 1. WIFI SSID: WIFI network to which your PC is also connected to.
- 2. WIFI Password: WIFI password
+* Run `make menuconfig` (or `idf.py menuconfig` if using CMake build system) to configure Wi-Fi or Ethernet. See "Establishing Wi-Fi or Ethernet Connection" section in [examples/protocols/README.md](../../README.md) for more details.
* In order to test the HTTPD server persistent sockets demo :
1. compile and burn the firmware "make flash"
# Parse IP address of STA
Utility.console_log("Waiting to connect with AP")
- got_ip = dut1.expect(re.compile(r"(?:[\s\S]*)Got IP: '(\d+.\d+.\d+.\d+)'"), timeout=120)[0]
+ got_ip = dut1.expect(re.compile(r"(?:[\s\S]*)IPv4 address: (\d+.\d+.\d+.\d+)"), timeout=30)[0]
got_port = dut1.expect(re.compile(r"(?:[\s\S]*)Starting server on port: '(\d+)'"), timeout=30)[0]
Utility.console_log("Got IP : " + got_ip)
+++ /dev/null
-menu "Example Configuration"
-
- config WIFI_SSID
- string "WiFi SSID"
- default "myssid"
- help
- SSID (network name) for the example to connect to.
-
- config WIFI_PASSWORD
- string "WiFi Password"
- default "mypassword"
- help
- WiFi password (WPA or WPA2) for the example to use.
- Can be left blank if the network has no security set.
-
-endmenu
#include <esp_log.h>
#include <esp_system.h>
#include <nvs_flash.h>
+#include "tcpip_adapter.h"
+#include "esp_eth.h"
+#include "protocol_examples_common.h"
#include <esp_http_server.h>
/* An example to demonstrate persistent sockets, with context maintained across
* multiple requests on that socket.
- * The examples use simple WiFi configuration that you can set via 'make menuconfig'.
- * If you'd rather not, just change the below entries to strings with
- * the config you want - ie #define EXAMPLE_WIFI_SSID "mywifissid"
*/
-#define EXAMPLE_WIFI_SSID CONFIG_WIFI_SSID
-#define EXAMPLE_WIFI_PASS CONFIG_WIFI_PASSWORD
-
-static const char *TAG="APP";
+static const char *TAG = "example";
+
/* Function to free context */
-void adder_free_func(void *ctx)
+static void adder_free_func(void *ctx)
{
ESP_LOGI(TAG, "/adder Free Context function called");
free(ctx);
/* This handler keeps accumulating data that is posted to it into a per
* socket/session context. And returns the result.
*/
-esp_err_t adder_post_handler(httpd_req_t *req)
+static esp_err_t adder_post_handler(httpd_req_t *req)
{
/* Log total visitors */
unsigned *visitors = (unsigned *)req->user_ctx;
}
/* This handler gets the present value of the accumulator */
-esp_err_t adder_get_handler(httpd_req_t *req)
+static esp_err_t adder_get_handler(httpd_req_t *req)
{
/* Log total visitors */
unsigned *visitors = (unsigned *)req->user_ctx;
}
/* This handler resets the value of the accumulator */
-esp_err_t adder_put_handler(httpd_req_t *req)
+static esp_err_t adder_put_handler(httpd_req_t *req)
{
/* Log total visitors */
unsigned *visitors = (unsigned *)req->user_ctx;
* the "/adder" URI has been visited */
static unsigned visitors = 0;
-httpd_uri_t adder_post = {
+static const httpd_uri_t adder_post = {
.uri = "/adder",
.method = HTTP_POST,
.handler = adder_post_handler,
.user_ctx = &visitors
};
-httpd_uri_t adder_get = {
+static const httpd_uri_t adder_get = {
.uri = "/adder",
.method = HTTP_GET,
.handler = adder_get_handler,
.user_ctx = &visitors
};
-httpd_uri_t adder_put = {
+static const httpd_uri_t adder_put = {
.uri = "/adder",
.method = HTTP_PUT,
.handler = adder_put_handler,
.user_ctx = &visitors
};
-httpd_handle_t start_webserver(void)
+static httpd_handle_t start_webserver(void)
{
httpd_config_t config = HTTPD_DEFAULT_CONFIG();
// Start the httpd server
return NULL;
}
-void stop_webserver(httpd_handle_t server)
+static void stop_webserver(httpd_handle_t server)
{
// Stop the httpd server
httpd_stop(server);
}
-static esp_err_t event_handler(void *ctx, system_event_t *event)
+
+static void disconnect_handler(void* arg, esp_event_base_t event_base,
+ int32_t event_id, void* event_data)
{
- httpd_handle_t *server = (httpd_handle_t *) ctx;
-
- switch(event->event_id) {
- case SYSTEM_EVENT_STA_START:
- ESP_LOGI(TAG, "SYSTEM_EVENT_STA_START");
- ESP_ERROR_CHECK(esp_wifi_connect());
- break;
- case SYSTEM_EVENT_STA_GOT_IP:
- ESP_LOGI(TAG, "SYSTEM_EVENT_STA_GOT_IP");
- ESP_LOGI(TAG, "Got IP: '%s'",
- ip4addr_ntoa(&event->event_info.got_ip.ip_info.ip));
-
- /* Start the web server */
- if (*server == NULL) {
- *server = start_webserver();
- }
- break;
- case SYSTEM_EVENT_STA_DISCONNECTED:
- ESP_LOGI(TAG, "SYSTEM_EVENT_STA_DISCONNECTED");
- ESP_ERROR_CHECK(esp_wifi_connect());
-
- /* Stop the webserver */
- if (*server) {
- stop_webserver(*server);
- *server = NULL;
- }
- break;
- default:
- break;
+ httpd_handle_t* server = (httpd_handle_t*) arg;
+ if (*server) {
+ ESP_LOGI(TAG, "Stopping webserver");
+ stop_webserver(*server);
+ *server = NULL;
}
- return ESP_OK;
}
-static void initialise_wifi(void *arg)
+static void connect_handler(void* arg, esp_event_base_t event_base,
+ int32_t event_id, void* event_data)
{
- tcpip_adapter_init();
- ESP_ERROR_CHECK(esp_event_loop_init(event_handler, arg));
- wifi_init_config_t cfg = WIFI_INIT_CONFIG_DEFAULT();
- ESP_ERROR_CHECK(esp_wifi_init(&cfg));
- ESP_ERROR_CHECK(esp_wifi_set_storage(WIFI_STORAGE_RAM));
- wifi_config_t wifi_config = {
- .sta = {
- .ssid = EXAMPLE_WIFI_SSID,
- .password = EXAMPLE_WIFI_PASS,
- },
- };
- ESP_LOGI(TAG, "Setting WiFi configuration SSID %s...", wifi_config.sta.ssid);
- ESP_ERROR_CHECK(esp_wifi_set_mode(WIFI_MODE_STA));
- ESP_ERROR_CHECK(esp_wifi_set_config(ESP_IF_WIFI_STA, &wifi_config));
- ESP_ERROR_CHECK(esp_wifi_start());
+ httpd_handle_t* server = (httpd_handle_t*) arg;
+ if (*server == NULL) {
+ ESP_LOGI(TAG, "Starting webserver");
+ *server = start_webserver();
+ }
}
+
void app_main()
{
static httpd_handle_t server = NULL;
+
ESP_ERROR_CHECK(nvs_flash_init());
- initialise_wifi(&server);
+ tcpip_adapter_init();
+ ESP_ERROR_CHECK(esp_event_loop_create_default());
+
+ /* This helper function configures Wi-Fi or Ethernet, as selected in menuconfig.
+ * Read "Establishing Wi-Fi or Ethernet Connection" section in
+ * examples/protocols/README.md for more information about this function.
+ */
+ ESP_ERROR_CHECK(example_connect());
+
+ /* Register event handlers to stop the server when Wi-Fi or Ethernet is disconnected,
+ * and re-start it upon connection.
+ */
+#ifdef CONFIG_EXAMPLE_CONNECT_WIFI
+ ESP_ERROR_CHECK(esp_event_handler_register(IP_EVENT, IP_EVENT_STA_GOT_IP, &connect_handler, &server));
+ ESP_ERROR_CHECK(esp_event_handler_register(WIFI_EVENT, WIFI_EVENT_STA_DISCONNECTED, &disconnect_handler, &server));
+#endif // CONFIG_EXAMPLE_CONNECT_WIFI
+#ifdef CONFIG_EXAMPLE_CONNECT_ETHERNET
+ ESP_ERROR_CHECK(esp_event_handler_register(IP_EVENT, IP_EVENT_ETH_GOT_IP, &connect_handler, &server));
+ ESP_ERROR_CHECK(esp_event_handler_register(ETH_EVENT, ETHERNET_EVENT_DISCONNECTED, &disconnect_handler, &server));
+#endif // CONFIG_EXAMPLE_CONNECT_ETHERNET
+
+ /* Start the server for the first time */
+ server = start_webserver();
}
# in this exact order for cmake to work correctly
cmake_minimum_required(VERSION 3.5)
+# (Not part of the boilerplate)
+# This example uses an extra component for common functions such as Wi-Fi and Ethernet connection.
+set(EXTRA_COMPONENT_DIRS $ENV{IDF_PATH}/examples/common_components/protocol_examples_common)
+
include($ENV{IDF_PATH}/tools/cmake/project.cmake)
project(simple)
PROJECT_NAME := simple
+EXTRA_COMPONENT_DIRS = $(IDF_PATH)/examples/common_components/protocol_examples_common
+
include $(IDF_PATH)/make/project.mk
1. URI \hello for GET command returns "Hello World!" message
2. URI \echo for POST command echoes back the POSTed message
-* Configure the project using "make menuconfig" and goto :
- * Example Configuration ->
- 1. WIFI SSID: WIFI network to which your PC is also connected to.
- 2. WIFI Password: WIFI password
+* Run `make menuconfig` (or `idf.py menuconfig` if using CMake build system) to configure Wi-Fi or Ethernet. See "Establishing Wi-Fi or Ethernet Connection" section in [examples/protocols/README.md](../../README.md) for more details.
* In order to test the HTTPD server persistent sockets demo :
1. compile and burn the firmware "make flash"
# Parse IP address of STA
Utility.console_log("Waiting to connect with AP")
- got_ip = dut1.expect(re.compile(r"(?:[\s\S]*)Got IP: '(\d+.\d+.\d+.\d+)'"), timeout=120)[0]
+ got_ip = dut1.expect(re.compile(r"(?:[\s\S]*)IPv4 address: (\d+.\d+.\d+.\d+)"), timeout=30)[0]
got_port = dut1.expect(re.compile(r"(?:[\s\S]*)Starting server on port: '(\d+)'"), timeout=30)[0]
Utility.console_log("Got IP : " + got_ip)
+++ /dev/null
-menu "Example Configuration"
-
- config WIFI_SSID
- string "WiFi SSID"
- default "myssid"
- help
- SSID (network name) for the example to connect to.
-
- config WIFI_PASSWORD
- string "WiFi Password"
- default "mypassword"
- help
- WiFi password (WPA or WPA2) for the example to use.
- Can be left blank if the network has no security set.
-
-endmenu
*/
#include <esp_wifi.h>
-#include <esp_event_loop.h>
+#include <esp_event.h>
#include <esp_log.h>
#include <esp_system.h>
#include <nvs_flash.h>
#include <sys/param.h>
+#include "nvs_flash.h"
+#include "tcpip_adapter.h"
+#include "esp_eth.h"
+#include "protocol_examples_common.h"
#include <esp_http_server.h>
/* A simple example that demonstrates how to create GET and POST
* handlers for the web server.
- * The examples use simple WiFi configuration that you can set via
- * 'make menuconfig'.
- * If you'd rather not, just change the below entries to strings
- * with the config you want -
- * ie. #define EXAMPLE_WIFI_SSID "mywifissid"
-*/
-#define EXAMPLE_WIFI_SSID CONFIG_WIFI_SSID
-#define EXAMPLE_WIFI_PASS CONFIG_WIFI_PASSWORD
+ */
-static const char *TAG="APP";
+static const char *TAG = "example";
/* An HTTP GET handler */
-esp_err_t hello_get_handler(httpd_req_t *req)
+static esp_err_t hello_get_handler(httpd_req_t *req)
{
char* buf;
size_t buf_len;
return ESP_OK;
}
-httpd_uri_t hello = {
+static const httpd_uri_t hello = {
.uri = "/hello",
.method = HTTP_GET,
.handler = hello_get_handler,
};
/* An HTTP POST handler */
-esp_err_t echo_post_handler(httpd_req_t *req)
+static esp_err_t echo_post_handler(httpd_req_t *req)
{
char buf[100];
int ret, remaining = req->content_len;
return ESP_OK;
}
-httpd_uri_t echo = {
+static const httpd_uri_t echo = {
.uri = "/echo",
.method = HTTP_POST,
.handler = echo_post_handler,
/* An HTTP PUT handler. This demonstrates realtime
* registration and deregistration of URI handlers
*/
-esp_err_t ctrl_put_handler(httpd_req_t *req)
+static esp_err_t ctrl_put_handler(httpd_req_t *req)
{
char buf;
int ret;
return ESP_OK;
}
-httpd_uri_t ctrl = {
+static const httpd_uri_t ctrl = {
.uri = "/ctrl",
.method = HTTP_PUT,
.handler = ctrl_put_handler,
.user_ctx = NULL
};
-httpd_handle_t start_webserver(void)
+static httpd_handle_t start_webserver(void)
{
httpd_handle_t server = NULL;
httpd_config_t config = HTTPD_DEFAULT_CONFIG();
return NULL;
}
-void stop_webserver(httpd_handle_t server)
+static void stop_webserver(httpd_handle_t server)
{
// Stop the httpd server
httpd_stop(server);
}
-static esp_err_t event_handler(void *ctx, system_event_t *event)
+static void disconnect_handler(void* arg, esp_event_base_t event_base,
+ int32_t event_id, void* event_data)
{
- httpd_handle_t *server = (httpd_handle_t *) ctx;
-
- switch(event->event_id) {
- case SYSTEM_EVENT_STA_START:
- ESP_LOGI(TAG, "SYSTEM_EVENT_STA_START");
- ESP_ERROR_CHECK(esp_wifi_connect());
- break;
- case SYSTEM_EVENT_STA_GOT_IP:
- ESP_LOGI(TAG, "SYSTEM_EVENT_STA_GOT_IP");
- ESP_LOGI(TAG, "Got IP: '%s'",
- ip4addr_ntoa(&event->event_info.got_ip.ip_info.ip));
-
- /* Start the web server */
- if (*server == NULL) {
- *server = start_webserver();
- }
- break;
- case SYSTEM_EVENT_STA_DISCONNECTED:
- ESP_LOGI(TAG, "SYSTEM_EVENT_STA_DISCONNECTED");
- ESP_ERROR_CHECK(esp_wifi_connect());
-
- /* Stop the web server */
- if (*server) {
- stop_webserver(*server);
- *server = NULL;
- }
- break;
- default:
- break;
+ httpd_handle_t* server = (httpd_handle_t*) arg;
+ if (*server) {
+ ESP_LOGI(TAG, "Stopping webserver");
+ stop_webserver(*server);
+ *server = NULL;
}
- return ESP_OK;
}
-static void initialise_wifi(void *arg)
+static void connect_handler(void* arg, esp_event_base_t event_base,
+ int32_t event_id, void* event_data)
{
- tcpip_adapter_init();
- ESP_ERROR_CHECK(esp_event_loop_init(event_handler, arg));
- wifi_init_config_t cfg = WIFI_INIT_CONFIG_DEFAULT();
- ESP_ERROR_CHECK(esp_wifi_init(&cfg));
- ESP_ERROR_CHECK(esp_wifi_set_storage(WIFI_STORAGE_RAM));
- wifi_config_t wifi_config = {
- .sta = {
- .ssid = EXAMPLE_WIFI_SSID,
- .password = EXAMPLE_WIFI_PASS,
- },
- };
- ESP_LOGI(TAG, "Setting WiFi configuration SSID %s...", wifi_config.sta.ssid);
- ESP_ERROR_CHECK(esp_wifi_set_mode(WIFI_MODE_STA));
- ESP_ERROR_CHECK(esp_wifi_set_config(ESP_IF_WIFI_STA, &wifi_config));
- ESP_ERROR_CHECK(esp_wifi_start());
+ httpd_handle_t* server = (httpd_handle_t*) arg;
+ if (*server == NULL) {
+ ESP_LOGI(TAG, "Starting webserver");
+ *server = start_webserver();
+ }
}
+
void app_main()
{
static httpd_handle_t server = NULL;
+
ESP_ERROR_CHECK(nvs_flash_init());
- initialise_wifi(&server);
+ tcpip_adapter_init();
+ ESP_ERROR_CHECK(esp_event_loop_create_default());
+
+ /* This helper function configures Wi-Fi or Ethernet, as selected in menuconfig.
+ * Read "Establishing Wi-Fi or Ethernet Connection" section in
+ * examples/protocols/README.md for more information about this function.
+ */
+ ESP_ERROR_CHECK(example_connect());
+
+ /* Register event handlers to stop the server when Wi-Fi or Ethernet is disconnected,
+ * and re-start it upon connection.
+ */
+#ifdef CONFIG_EXAMPLE_CONNECT_WIFI
+ ESP_ERROR_CHECK(esp_event_handler_register(IP_EVENT, IP_EVENT_STA_GOT_IP, &connect_handler, &server));
+ ESP_ERROR_CHECK(esp_event_handler_register(WIFI_EVENT, WIFI_EVENT_STA_DISCONNECTED, &disconnect_handler, &server));
+#endif // CONFIG_EXAMPLE_CONNECT_WIFI
+#ifdef CONFIG_EXAMPLE_CONNECT_ETHERNET
+ ESP_ERROR_CHECK(esp_event_handler_register(IP_EVENT, IP_EVENT_ETH_GOT_IP, &connect_handler, &server));
+ ESP_ERROR_CHECK(esp_event_handler_register(ETH_EVENT, ETHERNET_EVENT_DISCONNECTED, &disconnect_handler, &server));
+#endif // CONFIG_EXAMPLE_CONNECT_ETHERNET
+
+ /* Start the server for the first time */
+ server = start_webserver();
}
# in this exact order for cmake to work correctly
cmake_minimum_required(VERSION 3.5)
+# (Not part of the boilerplate)
+# This example uses an extra component for common functions such as Wi-Fi and Ethernet connection.
+set(EXTRA_COMPONENT_DIRS $ENV{IDF_PATH}/examples/common_components/protocol_examples_common)
+
include($ENV{IDF_PATH}/tools/cmake/project.cmake)
project(https_server)
PROJECT_NAME := https_server
+EXTRA_COMPONENT_DIRS = $(IDF_PATH)/examples/common_components/protocol_examples_common
+
include $(IDF_PATH)/make/project.mk
See the `esp_https_server` component documentation for details.
+Before using the example, run `make menuconfig` (or `idf.py menuconfig` if using CMake build system) to configure Wi-Fi or Ethernet. See "Establishing Wi-Fi or Ethernet Connection" section in [examples/protocols/README.md](../README.md) for more details.
+
## Certificates
You will need to approve a security exception in your browser. This is because of a self signed
+++ /dev/null
-menu "Example Configuration"
-
- config WIFI_SSID
- string "WiFi SSID"
- default "myssid"
- help
- SSID (network name) for the example to connect to.
-
- config WIFI_PASSWORD
- string "WiFi Password"
- default "mypassword"
- help
- WiFi password (WPA or WPA2) for the example to use.
- Can be left blank if the network has no security set.
-
-endmenu
#include <esp_system.h>
#include <nvs_flash.h>
#include <sys/param.h>
+#include "tcpip_adapter.h"
+#include "esp_eth.h"
+#include "protocol_examples_common.h"
#include <esp_https_server.h>
/* A simple example that demonstrates how to create GET and POST
- * handlers for the web server.
- * The examples use simple WiFi configuration that you can set via
- * 'make menuconfig'.
- * If you'd rather not, just change the below entries to strings
- * with the config you want -
- * ie. #define EXAMPLE_WIFI_SSID "mywifissid"
+ * handlers and start an HTTPS server.
*/
-#define EXAMPLE_WIFI_SSID CONFIG_WIFI_SSID
-#define EXAMPLE_WIFI_PASS CONFIG_WIFI_PASSWORD
-static const char *TAG="APP";
+static const char *TAG = "example";
/* An HTTP GET handler */
-esp_err_t root_get_handler(httpd_req_t *req)
+static esp_err_t root_get_handler(httpd_req_t *req)
{
httpd_resp_set_type(req, "text/html");
httpd_resp_send(req, "<h1>Hello Secure World!</h1>", -1); // -1 = use strlen()
return ESP_OK;
}
-const httpd_uri_t root = {
+static const httpd_uri_t root = {
.uri = "/",
.method = HTTP_GET,
.handler = root_get_handler
};
-httpd_handle_t start_webserver(void)
+static httpd_handle_t start_webserver(void)
{
httpd_handle_t server = NULL;
return server;
}
-void stop_webserver(httpd_handle_t server)
+static void stop_webserver(httpd_handle_t server)
{
// Stop the httpd server
httpd_ssl_stop(server);
}
-
-
-
-// ------------------------- application boilerplate ------------------------
-
-static esp_err_t event_handler(void *ctx, system_event_t *event)
+static void disconnect_handler(void* arg, esp_event_base_t event_base,
+ int32_t event_id, void* event_data)
{
- httpd_handle_t *server = (httpd_handle_t *) ctx;
-
- switch(event->event_id) {
- case SYSTEM_EVENT_STA_START:
- ESP_LOGI(TAG, "SYSTEM_EVENT_STA_START");
- ESP_ERROR_CHECK(esp_wifi_connect());
- break;
- case SYSTEM_EVENT_STA_GOT_IP:
- ESP_LOGI(TAG, "SYSTEM_EVENT_STA_GOT_IP");
- ESP_LOGI(TAG, "Got IP: '%s'",
- ip4addr_ntoa(&event->event_info.got_ip.ip_info.ip));
-
- /* Start the web server */
- if (*server == NULL) {
- *server = start_webserver();
- }
- break;
- case SYSTEM_EVENT_STA_DISCONNECTED:
- ESP_LOGI(TAG, "SYSTEM_EVENT_STA_DISCONNECTED");
- ESP_ERROR_CHECK(esp_wifi_connect());
-
- /* Stop the web server */
- if (*server) {
- stop_webserver(*server);
- *server = NULL;
- }
- break;
- default:
- break;
+ httpd_handle_t* server = (httpd_handle_t*) arg;
+ if (*server) {
+ stop_webserver(*server);
+ *server = NULL;
}
- return ESP_OK;
}
-static void initialise_wifi(void *arg)
+static void connect_handler(void* arg, esp_event_base_t event_base,
+ int32_t event_id, void* event_data)
{
- tcpip_adapter_init();
- ESP_ERROR_CHECK(esp_event_loop_init(event_handler, arg));
- wifi_init_config_t cfg = WIFI_INIT_CONFIG_DEFAULT();
- ESP_ERROR_CHECK(esp_wifi_init(&cfg));
- ESP_ERROR_CHECK(esp_wifi_set_storage(WIFI_STORAGE_RAM));
- wifi_config_t wifi_config = {
- .sta = {
- .ssid = EXAMPLE_WIFI_SSID,
- .password = EXAMPLE_WIFI_PASS,
- },
- };
- ESP_LOGI(TAG, "Setting WiFi configuration SSID %s...", wifi_config.sta.ssid);
- ESP_ERROR_CHECK(esp_wifi_set_mode(WIFI_MODE_STA));
- ESP_ERROR_CHECK(esp_wifi_set_config(ESP_IF_WIFI_STA, &wifi_config));
- ESP_ERROR_CHECK(esp_wifi_start());
+ httpd_handle_t* server = (httpd_handle_t*) arg;
+ if (*server == NULL) {
+ *server = start_webserver();
+ }
}
void app_main()
{
static httpd_handle_t server = NULL;
+
ESP_ERROR_CHECK(nvs_flash_init());
- initialise_wifi(&server);
+ tcpip_adapter_init();
+ ESP_ERROR_CHECK(esp_event_loop_create_default());
+
+ /* Register event handlers to start server when Wi-Fi or Ethernet is connected,
+ * and stop server when disconnection happens.
+ */
+
+#ifdef CONFIG_EXAMPLE_CONNECT_WIFI
+ ESP_ERROR_CHECK(esp_event_handler_register(IP_EVENT, IP_EVENT_STA_GOT_IP, &connect_handler, &server));
+ ESP_ERROR_CHECK(esp_event_handler_register(WIFI_EVENT, WIFI_EVENT_STA_DISCONNECTED, &disconnect_handler, &server));
+#endif // CONFIG_EXAMPLE_CONNECT_WIFI
+#ifdef CONFIG_EXAMPLE_CONNECT_ETHERNET
+ ESP_ERROR_CHECK(esp_event_handler_register(IP_EVENT, IP_EVENT_ETH_GOT_IP, &connect_handler, &server));
+ ESP_ERROR_CHECK(esp_event_handler_register(ETH_EVENT, ETHERNET_EVENT_DISCONNECTED, &disconnect_handler, &server));
+#endif // CONFIG_EXAMPLE_CONNECT_ETHERNET
+
+ /* This helper function configures Wi-Fi or Ethernet, as selected in menuconfig.
+ * Read "Establishing Wi-Fi or Ethernet Connection" section in
+ * examples/protocols/README.md for more information about this function.
+ */
+ ESP_ERROR_CHECK(example_connect());
}
projects / esp-idf / commitdiff