esp_websocket_client: Add websocket client component

Closes https://github.com/espressif/esp-idf/issues/2829


* Original commit: espressif/esp-idf@2a2d932cfe

examples/protocols/websocket/CMakeLists.txt

@@ -0,0 +1,10 @@
+# The following four lines of boilerplate have to be in your project's CMakeLists
+# 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(websocket-example)

examples/protocols/websocket/Makefile

@@ -0,0 +1,10 @@
+#
+# This is a project Makefile. It is assumed the directory this Makefile resides in is a
+# project subdirectory.
+#
+PROJECT_NAME := websocket-example
+
+EXTRA_COMPONENT_DIRS = $(IDF_PATH)/examples/common_components/protocol_examples_common
+
+include $(IDF_PATH)/make/project.mk
+

examples/protocols/websocket/README.md

@@ -0,0 +1 @@
+# Websocket Sample application

examples/protocols/websocket/example_test.py

@@ -0,0 +1,41 @@
+import re
+import os
+import sys
+import IDF
+
+# this is a test case write with tiny-test-fw.
+# to run test cases outside tiny-test-fw,
+# we need to set environment variable `TEST_FW_PATH`,
+# then get and insert `TEST_FW_PATH` to sys path before import FW module
+test_fw_path = os.getenv("TEST_FW_PATH")
+if test_fw_path and test_fw_path not in sys.path:
+    sys.path.insert(0, test_fw_path)
+
+
+@IDF.idf_example_test(env_tag="Example_WIFI", ignore=True)
+def test_examples_protocol_websocket(env, extra_data):
+    """
+    steps: |
+      1. join AP
+      2. connect to ws://echo.websocket.org
+      3. send and receive data
+    """
+    dut1 = env.get_dut("websocket", "examples/protocols/websocket")
+    # check and log bin size
+    binary_file = os.path.join(dut1.app.binary_path, "websocket-example.bin")
+    bin_size = os.path.getsize(binary_file)
+    IDF.log_performance("websocket_bin_size", "{}KB".format(bin_size // 1024))
+    IDF.check_performance("websocket_bin_size", bin_size // 1024)
+    # start test
+    dut1.start_app()
+    dut1.expect("Waiting for wifi ...")
+    dut1.expect("Connection established...", timeout=30)
+    dut1.expect("WEBSOCKET_EVENT_CONNECTED")
+    for i in range(0, 10):
+        dut1.expect(re.compile(r"Sending hello (\d)"))
+        dut1.expect(re.compile(r"Received=hello (\d)"))
+    dut1.expect("Websocket Stopped")
+
+
+if __name__ == '__main__':
+    test_examples_protocol_websocket()

examples/protocols/websocket/main/CMakeLists.txt

@@ -0,0 +1,4 @@
+set(COMPONENT_SRCS "websocket_example.c")
+set(COMPONENT_ADD_INCLUDEDIRS ".")
+
+register_component()

examples/protocols/websocket/main/Kconfig.projbuild

@@ -0,0 +1,9 @@
+menu "Example Configuration"
+
+    config WEBSOCKET_URI
+        string "Websocket endpoint URI"
+        default "ws://echo.websocket.org";
+        help
+            URL of websocket endpoint this example connects to and sends echo
+
+endmenu

examples/protocols/websocket/main/websocket_example.c

@@ -0,0 +1,103 @@
+/* ESP HTTP Client Example
+
+   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 <stdio.h>
+#include "esp_wifi.h"
+#include "esp_system.h"
+#include "nvs_flash.h"
+#include "esp_event_loop.h"
+#include "protocol_examples_common.h"
+
+#include "freertos/FreeRTOS.h"
+#include "freertos/task.h"
+#include "freertos/event_groups.h"
+
+
+#include "esp_log.h"
+#include "esp_websocket_client.h"
+#include "esp_event.h"
+#include "esp_event_loop.h"
+
+static const char *TAG = "WEBSOCKET";
+static const char *WEBSOCKET_ECHO_ENDPOINT = CONFIG_WEBSOCKET_URI;
+
+
+static void websocket_event_handler(void *handler_args, esp_event_base_t base, int32_t event_id, void *event_data)
+{
+    // esp_websocket_client_handle_t client = (esp_websocket_client_handle_t)handler_args;
+    esp_websocket_event_data_t *data = (esp_websocket_event_data_t *)event_data;
+    switch (event_id) {
+        case WEBSOCKET_EVENT_CONNECTED:
+            ESP_LOGI(TAG, "WEBSOCKET_EVENT_CONNECTED");
+
+
+            break;
+        case WEBSOCKET_EVENT_DISCONNECTED:
+            ESP_LOGI(TAG, "WEBSOCKET_EVENT_DISCONNECTED");
+            break;
+
+        case WEBSOCKET_EVENT_DATA:
+            ESP_LOGI(TAG, "WEBSOCKET_EVENT_DATA");
+            ESP_LOGW(TAG, "Received=%.*s\r\n", data->data_len, (char*)data->data_ptr);
+            break;
+        case WEBSOCKET_EVENT_ERROR:
+            ESP_LOGI(TAG, "WEBSOCKET_EVENT_ERROR");
+            break;
+    }
+}
+
+static void websocket_app_start(void)
+{
+    ESP_LOGI(TAG, "Connectiong to %s...", WEBSOCKET_ECHO_ENDPOINT);
+
+    const esp_websocket_client_config_t websocket_cfg = {
+        .uri = WEBSOCKET_ECHO_ENDPOINT, // or wss://echo.websocket.org for websocket secure
+    };
+
+    esp_websocket_client_handle_t client = esp_websocket_client_init(&websocket_cfg);
+    esp_websocket_register_events(client, WEBSOCKET_EVENT_ANY, websocket_event_handler, (void *)client);
+
+    esp_websocket_client_start(client);
+    char data[32];
+    int i = 0;
+    while (i < 10) {
+        if (esp_websocket_client_is_connected(client)) {
+            int len = sprintf(data, "hello %04d", i++);
+            ESP_LOGI(TAG, "Sending %s", data);
+            esp_websocket_client_send(client, data, len, portMAX_DELAY);
+        }
+        vTaskDelay(1000 / portTICK_RATE_MS);
+    }
+    esp_websocket_client_stop(client);
+    ESP_LOGI(TAG, "Websocket Stopped");
+    esp_websocket_client_destroy(client);
+}
+
+void app_main()
+{
+    ESP_LOGI(TAG, "[APP] Startup..");
+    ESP_LOGI(TAG, "[APP] Free memory: %d bytes", esp_get_free_heap_size());
+    ESP_LOGI(TAG, "[APP] IDF version: %s", esp_get_idf_version());
+    esp_log_level_set("*", ESP_LOG_INFO);
+    esp_log_level_set("WEBSOCKET_CLIENT", ESP_LOG_DEBUG);
+    esp_log_level_set("TRANS_TCP", ESP_LOG_DEBUG);
+
+    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());
+
+    websocket_app_start();
+}