examples/protocols/openssl: use common network component

examples/protocols/openssl_client/CMakeLists.txt

@@ -2,5 +2,9 @@
 # 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(openssl_client)

examples/protocols/openssl_client/Makefile

@@ -5,5 +5,7 @@
 
 PROJECT_NAME := openssl_client
 
+EXTRA_COMPONENT_DIRS = $(IDF_PATH)/examples/common_components/protocol_examples_common
+
 include $(IDF_PATH)/make/project.mk
 

examples/protocols/openssl_client/README.md

@@ -2,12 +2,13 @@
 
 The Example contains of OpenSSL client demo.
 
-First you should config the project by "make menuconfig":
+To configure the project, run `make menuconfig` (or `idf.py menuconfig` if using CMake build system).
-  Example Configuration ->
+
-    1. Target Domain : the domain that you want to connect to, and default is "www.baidu.com".
+* Configure Wi-Fi or Ethernet under "Example Connection Configuration" menu. See "Establishing Wi-Fi or Ethernet Connection" section in [examples/protocols/README.md](../README.md) for more details.
-    2. Target port number : the port number of the target domain, and default is 443.
+
-    3. WIFI SSID : your own WIFI, which is connected to the Internet, and default is "myssid".
+* When using Make build system, set `Default serial port` under `Serial flasher config`.
-    4. WIFI Password : WIFI password, and default is "mypassword"
+
+* Configure target domain and port number under "Example Configuration"
 
 If you want to test the OpenSSL client demo:
   1. compile the code and load the firmware

examples/protocols/openssl_client/main/Kconfig.projbuild

@@ -13,16 +13,4 @@ menu "Example Configuration"
         help
             Target port number for the example to connect to.
 
-    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.
-
 endmenu

examples/protocols/openssl_client/main/openssl_client_example.h

@@ -10,15 +10,6 @@
 #ifndef _OPENSSL_EXAMPLE_H_
 #define _OPENSSL_EXAMPLE_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
-
 /* The examples use domain of "www.baidu.com" and port number of 433 that 
    you can set via 'make menuconfig'.
 

examples/protocols/openssl_client/main/openssl_client_example_main.c

@@ -15,24 +15,17 @@
 
 #include "freertos/FreeRTOS.h"
 #include "freertos/task.h"
-#include "freertos/event_groups.h"
 
 #include "esp_log.h"
 #include "esp_wifi.h"
-#include "esp_event_loop.h"
+#include "esp_event.h"
-
 #include "nvs_flash.h"
+#include "tcpip_adapter.h"
+#include "protocol_examples_common.h"
 
 #include "lwip/sockets.h"
 #include "lwip/netdb.h"
 
-static EventGroupHandle_t wifi_event_group;
-
-/* The event group allows multiple bits for each event,
-   but we only care about one event - are we connected
-   to the AP with an IP? */
-const static int CONNECTED_BIT = BIT0;
-
 const static char *TAG = "openssl_example";
 
 static void openssl_example_task(void *p)
@@ -142,7 +135,7 @@ static void openssl_example_task(void *p)
         ESP_LOGI(TAG, "%s", recv_buf);
     } while (1);
     
-    ESP_LOGI(TAG, "totaly read %d bytes data from %s ......", recv_bytes, OPENSSL_EXAMPLE_TARGET_NAME);
+    ESP_LOGI(TAG, "totally read %d bytes data from %s ......", recv_bytes, OPENSSL_EXAMPLE_TARGET_NAME);
 
 failed5:
     SSL_shutdown(ssl);
@@ -177,50 +170,18 @@ static void openssl_example_client_init(void)
     }
 }
 
-static esp_err_t wifi_event_handler(void *ctx, system_event_t *event)
-{
-    switch(event->event_id) {
-    case SYSTEM_EVENT_STA_START:
-        esp_wifi_connect();
-        break;
-    case SYSTEM_EVENT_STA_GOT_IP:
-        xEventGroupSetBits(wifi_event_group, CONNECTED_BIT);
-        openssl_example_client_init();
-        break;
-    case SYSTEM_EVENT_STA_DISCONNECTED:
-        /* This is a workaround as ESP32 WiFi libs don't currently
-           auto-reassociate. */
-        esp_wifi_connect(); 
-        xEventGroupClearBits(wifi_event_group, CONNECTED_BIT);
-        break;
-    default:
-        break;
-    }
-    return ESP_OK;
-}
-
-static void wifi_conn_init(void)
-{
-    tcpip_adapter_init();
-    wifi_event_group = xEventGroupCreate();
-    ESP_ERROR_CHECK( esp_event_loop_init(wifi_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_ERROR_CHECK( esp_wifi_set_mode(WIFI_MODE_STA) );
-    ESP_ERROR_CHECK( esp_wifi_set_config(ESP_IF_WIFI_STA, &wifi_config) );
-    ESP_LOGI(TAG, "start the WIFI SSID:[%s] password:[%s]\n", EXAMPLE_WIFI_SSID, EXAMPLE_WIFI_PASS);
-    ESP_ERROR_CHECK( esp_wifi_start() );
-}
-
 void app_main(void)
 {
     ESP_ERROR_CHECK( nvs_flash_init() );
-    wifi_conn_init();
+    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());
+
+    openssl_example_client_init();
 }

examples/protocols/openssl_server/CMakeLists.txt

@@ -2,5 +2,9 @@
 # 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(openssl_server)

examples/protocols/openssl_server/Makefile

@@ -5,5 +5,7 @@
 
 PROJECT_NAME := openssl_server
 
+EXTRA_COMPONENT_DIRS = $(IDF_PATH)/examples/common_components/protocol_examples_common
+
 include $(IDF_PATH)/make/project.mk
 

examples/protocols/openssl_server/README.md

@@ -2,10 +2,11 @@
 
 The Example contains of OpenSSL server demo.
 
-First you should configure the project by "make menuconfig":
+To configure the project, run `make menuconfig` (or `idf.py menuconfig` if using CMake build system).
-  Example Configuration -> 
+
-    1. WIFI SSID: WIFI network to which your PC is also connected to. 
+* Configure Wi-Fi or Ethernet under "Example Connection Configuration" menu. See "Establishing Wi-Fi or Ethernet Connection" section in [examples/protocols/README.md](../README.md) for more details.
-    2. WIFI Password: WIFI password
+
+* When using Make build system, set `Default serial port` under `Serial flasher config`.
     
 IF you want to test the OpenSSL server demo: 
   1. compile the code and load the firmware 

examples/protocols/openssl_server/main/Kconfig.projbuild

@@ -1,15 +0,0 @@
-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.
-
-endmenu

examples/protocols/openssl_server/main/openssl_server_example.h

@@ -12,15 +12,6 @@
 
 #include "sdkconfig.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
-
 #define OPENSSL_EXAMPLE_TASK_NAME        "openssl_example"
 #define OPENSSL_EXAMPLE_TASK_STACK_WORDS 10240
 #define OPENSSL_EXAMPLE_TASK_PRIORITY    8

examples/protocols/openssl_server/main/openssl_server_example_main.c

@@ -15,23 +15,17 @@
 
 #include "freertos/FreeRTOS.h"
 #include "freertos/task.h"
-#include "freertos/event_groups.h"
 
 #include "esp_log.h"
 #include "esp_wifi.h"
-#include "esp_event_loop.h"
+#include "esp_event.h"
-
+#include "tcpip_adapter.h"
 #include "nvs_flash.h"
+#include "protocol_examples_common.h"
 
 #include "lwip/sockets.h"
 #include "lwip/netdb.h"
 
-static EventGroupHandle_t wifi_event_group;
-
-/* The event group allows multiple bits for each event,
-   but we only care about one event - are we connected
-   to the AP with an IP? */
-const static int CONNECTED_BIT = BIT0;
 
 const static char *TAG = "Openssl_example";
 
@@ -211,50 +205,17 @@ static void openssl_server_init(void)
     }
 }
 
-static esp_err_t wifi_event_handler(void *ctx, system_event_t *event)
-{
-    switch(event->event_id) {
-    case SYSTEM_EVENT_STA_START:
-        esp_wifi_connect();
-        break;
-    case SYSTEM_EVENT_STA_GOT_IP:
-        xEventGroupSetBits(wifi_event_group, CONNECTED_BIT);
-        openssl_server_init();
-        break;
-    case SYSTEM_EVENT_STA_DISCONNECTED:
-        /* This is a workaround as ESP32 WiFi libs don't currently
-           auto-reassociate. */
-        esp_wifi_connect(); 
-        xEventGroupClearBits(wifi_event_group, CONNECTED_BIT);
-        break;
-    default:
-        break;
-    }
-    return ESP_OK;
-}
-
-static void wifi_conn_init(void)
-{
-    tcpip_adapter_init();
-    wifi_event_group = xEventGroupCreate();
-    ESP_ERROR_CHECK( esp_event_loop_init(wifi_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_ERROR_CHECK( esp_wifi_set_mode(WIFI_MODE_STA) );
-    ESP_ERROR_CHECK( esp_wifi_set_config(ESP_IF_WIFI_STA, &wifi_config) );
-    ESP_LOGI(TAG, "start the WIFI SSID:[%s] password:[%s]\n", EXAMPLE_WIFI_SSID, EXAMPLE_WIFI_PASS);
-    ESP_ERROR_CHECK( esp_wifi_start() );
-}
-
 void app_main(void)
 {
-    ESP_ERROR_CHECK( nvs_flash_init() );
+    ESP_ERROR_CHECK(nvs_flash_init());
-    wifi_conn_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());
+
+    openssl_server_init();
 }