examples: Standardise naming of files, symbols, etc. in examples

* Use "example" in all example function & variable names,
  ie use i2c_example_xxx instead of i2c_xxx for example functions.
  Closes #198 https://github.com/espressif/esp-idf/issues/198
* Mark example functions, etc. static
* Replace uses of "test" & "demo" with "example"
* Split the UART example into two
* Rename "main" example files to end with "_main.c" for disambiguation

examples/protocols/coap_client/main/coap_client_example_main.c

@@ -65,7 +65,7 @@ static void message_handler(struct coap_context_t *ctx, const coap_endpoint_t *l
     }
 }
 
-static void coap_demo_thread(void *p)
+static void coap_example_task(void *p)
 {
     struct hostent *hp;
     struct ip4_addr *ip4_addr;
@@ -201,5 +201,5 @@ void app_main(void)
 {
     ESP_ERROR_CHECK( nvs_flash_init() );
     wifi_conn_init();
-    xTaskCreate(coap_demo_thread, "coap", 2048, NULL, 5, NULL);
+    xTaskCreate(coap_example_task, "coap", 2048, NULL, 5, NULL);
 }

examples/protocols/coap_server/main/coap_server_example_main.c

@@ -80,7 +80,7 @@ async_handler(coap_context_t *ctx, struct coap_resource_t *resource,
     async = coap_register_async(ctx, peer, request, COAP_ASYNC_SEPARATE | COAP_ASYNC_CONFIRM, (void*)"no data");
 }
 
-static void coap_demo_thread(void *p)
+static void coap_example_thread(void *p)
 {
     coap_context_t*  ctx = NULL;
     coap_address_t   serv_addr;
@@ -188,5 +188,5 @@ void app_main(void)
     ESP_ERROR_CHECK( nvs_flash_init() );
     wifi_conn_init();
 
-    xTaskCreate(coap_demo_thread, "coap", 2048, NULL, 5, NULL);
+    xTaskCreate(coap_example_thread, "coap", 2048, NULL, 5, NULL);
 }

examples/protocols/mdns/main/mdns_example_main.c

@@ -125,7 +125,7 @@ static void query_mdns_service(mdns_server_t * mdns, const char * service, const
     }
 }
 
-static void mdns_task(void *pvParameters)
+static void mdns_example_task(void *pvParameters)
 {
     mdns_server_t * mdns = NULL;
     while(1) {
@@ -180,5 +180,5 @@ void app_main()
 {
     ESP_ERROR_CHECK( nvs_flash_init() );
     initialise_wifi();
-    xTaskCreate(&mdns_task, "mdns_task", 2048, NULL, 5, NULL);
+    xTaskCreate(&mdns_example_task, "mdns_example_task", 2048, NULL, 5, NULL);
 }

examples/protocols/openssl_client/main/openssl_client_example.h

@@ -7,8 +7,8 @@
    CONDITIONS OF ANY KIND, either express or implied.
 */
 
-#ifndef _OPENSSL_DEMO_H_
-#define _OPENSSL_DEMO_H_
+#ifndef _OPENSSL_EXAMPLE_H_
+#define _OPENSSL_EXAMPLE_H_
 
 /* The examples use simple WiFi configuration that you can set via
    'make menuconfig'.
@@ -23,21 +23,21 @@
    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 OPENSSL_DEMO_TARGET_NAME "www.baidu.com"
-   and ie #define OPENSSL_DEMO_TARGET_TCP_PORT 433 
+   the config you want - ie #define OPENSSL_EXAMPLE_TARGET_NAME "www.baidu.com"
+   and ie #define OPENSSL_EXAMPLE_TARGET_TCP_PORT 433 
 */
-#define OPENSSL_DEMO_TARGET_NAME        CONFIG_TARGET_DOMAIN
-#define OPENSSL_DEMO_TARGET_TCP_PORT    CONFIG_TARGET_PORT_NUMBER
+#define OPENSSL_EXAMPLE_TARGET_NAME        CONFIG_TARGET_DOMAIN
+#define OPENSSL_EXAMPLE_TARGET_TCP_PORT    CONFIG_TARGET_PORT_NUMBER
 
-#define OPENSSL_DEMO_REQUEST            "{\"path\": \"/v1/ping/\", \"method\": \"GET\"}\r\n"
+#define OPENSSL_EXAMPLE_REQUEST            "{\"path\": \"/v1/ping/\", \"method\": \"GET\"}\r\n"
 
-#define OPENSSL_DEMO_THREAD_NAME        "OpenSSL_demo"
-#define OPENSSL_DEMO_THREAD_STACK_WORDS 10240
-#define OPENSSL_DEMO_THREAD_PRORIOTY    8
+#define OPENSSL_EXAMPLE_TASK_NAME        "openssl_example"
+#define OPENSSL_EXAMPLE_TASK_STACK_WORDS 10240
+#define OPENSSL_EXAMPLE_TASK_PRORIOTY    8
 
-#define OPENSSL_DEMO_RECV_BUF_LEN       1024
+#define OPENSSL_EXAMPLE_RECV_BUF_LEN       1024
 
-#define OPENSSL_DEMO_LOCAL_TCP_PORT     443
+#define OPENSSL_EXAMPLE_LOCAL_TCP_PORT     443
 
 #endif
 

examples/protocols/openssl_client/main/openssl_client_example_main.c

@@ -7,7 +7,7 @@
    CONDITIONS OF ANY KIND, either express or implied.
 */
 
-#include "openssl_client.h"
+#include "openssl_client_example.h"
 
 #include <string.h>
 
@@ -33,9 +33,9 @@ static EventGroupHandle_t wifi_event_group;
    to the AP with an IP? */
 const static int CONNECTED_BIT = BIT0;
 
-const static char *TAG = "Openssl_demo";
+const static char *TAG = "openssl_example";
 
-void openssl_demo_thread(void *p)
+static void openssl_example_task(void *p)
 {
     int ret;
     SSL_CTX *ctx;
@@ -46,15 +46,15 @@ void openssl_demo_thread(void *p)
     struct ip4_addr *ip4_addr;
     
     int recv_bytes = 0;
-    char recv_buf[OPENSSL_DEMO_RECV_BUF_LEN];
+    char recv_buf[OPENSSL_EXAMPLE_RECV_BUF_LEN];
     
-    const char send_data[] = OPENSSL_DEMO_REQUEST;
+    const char send_data[] = OPENSSL_EXAMPLE_REQUEST;
     const int send_bytes = sizeof(send_data);
 
     ESP_LOGI(TAG, "OpenSSL demo thread start OK");
 
     ESP_LOGI(TAG, "get target IP address");
-    hp = gethostbyname(OPENSSL_DEMO_TARGET_NAME);
+    hp = gethostbyname(OPENSSL_EXAMPLE_TARGET_NAME);
     if (!hp) {
         ESP_LOGI(TAG, "failed");
         goto failed1;
@@ -84,7 +84,7 @@ void openssl_demo_thread(void *p)
     memset(&sock_addr, 0, sizeof(sock_addr));
     sock_addr.sin_family = AF_INET;
     sock_addr.sin_addr.s_addr = 0;
-    sock_addr.sin_port = htons(OPENSSL_DEMO_LOCAL_TCP_PORT);
+    sock_addr.sin_port = htons(OPENSSL_EXAMPLE_LOCAL_TCP_PORT);
     ret = bind(socket, (struct sockaddr*)&sock_addr, sizeof(sock_addr));
     if (ret) {
         ESP_LOGI(TAG, "failed");
@@ -92,11 +92,11 @@ void openssl_demo_thread(void *p)
     }
     ESP_LOGI(TAG, "OK");
 
-    ESP_LOGI(TAG, "socket connect to remote %s ......", OPENSSL_DEMO_TARGET_NAME);
+    ESP_LOGI(TAG, "socket connect to remote %s ......", OPENSSL_EXAMPLE_TARGET_NAME);
     memset(&sock_addr, 0, sizeof(sock_addr));
     sock_addr.sin_family = AF_INET;
     sock_addr.sin_addr.s_addr = ip4_addr->addr;
-    sock_addr.sin_port = htons(OPENSSL_DEMO_TARGET_TCP_PORT);
+    sock_addr.sin_port = htons(OPENSSL_EXAMPLE_TARGET_TCP_PORT);
     ret = connect(socket, (struct sockaddr*)&sock_addr, sizeof(sock_addr));
     if (ret) {
         ESP_LOGI(TAG, "failed");
@@ -115,7 +115,7 @@ void openssl_demo_thread(void *p)
     SSL_set_fd(ssl, socket);
 
     ESP_LOGI(TAG, "SSL connected to %s port %d ......",
-        OPENSSL_DEMO_TARGET_NAME, OPENSSL_DEMO_TARGET_TCP_PORT);
+        OPENSSL_EXAMPLE_TARGET_NAME, OPENSSL_EXAMPLE_TARGET_TCP_PORT);
     ret = SSL_connect(ssl);
     if (!ret) {
         ESP_LOGI(TAG, "failed " );
@@ -124,7 +124,7 @@ void openssl_demo_thread(void *p)
     ESP_LOGI(TAG, "OK");
 
     ESP_LOGI(TAG, "send https request to %s port %d ......",
-        OPENSSL_DEMO_TARGET_NAME, OPENSSL_DEMO_TARGET_TCP_PORT);
+        OPENSSL_EXAMPLE_TARGET_NAME, OPENSSL_EXAMPLE_TARGET_TCP_PORT);
     ret = SSL_write(ssl, send_data, send_bytes);
     if (ret <= 0) {
         ESP_LOGI(TAG, "failed");
@@ -133,7 +133,7 @@ void openssl_demo_thread(void *p)
     ESP_LOGI(TAG, "OK");
 
     do {
-        ret = SSL_read(ssl, recv_buf, OPENSSL_DEMO_RECV_BUF_LEN - 1);
+        ret = SSL_read(ssl, recv_buf, OPENSSL_EXAMPLE_RECV_BUF_LEN - 1);
         if (ret <= 0) {
             break;
         }
@@ -141,7 +141,7 @@ void openssl_demo_thread(void *p)
         ESP_LOGI(TAG, "%s", recv_buf);
     } while (1);
     
-    ESP_LOGI(TAG, "totaly read %d bytes data from %s ......", recv_bytes, OPENSSL_DEMO_TARGET_NAME);
+    ESP_LOGI(TAG, "totaly read %d bytes data from %s ......", recv_bytes, OPENSSL_EXAMPLE_TARGET_NAME);
 
 failed5:
     SSL_shutdown(ssl);
@@ -159,20 +159,20 @@ failed1:
     return ;
 }
 
-static void openssl_client_init(void)
+static void openssl_example_client_init(void)
 {
     int ret;
     xTaskHandle openssl_handle;
 
-    ret = xTaskCreate(openssl_demo_thread,
-                      OPENSSL_DEMO_THREAD_NAME,
-                      OPENSSL_DEMO_THREAD_STACK_WORDS,
+    ret = xTaskCreate(openssl_example_task,
+                      OPENSSL_EXAMPLE_TASK_NAME,
+                      OPENSSL_EXAMPLE_TASK_STACK_WORDS,
                       NULL,
-                      OPENSSL_DEMO_THREAD_PRORIOTY,
-                      &openssl_handle); 
+                      OPENSSL_EXAMPLE_TASK_PRORIOTY,
+                      &openssl_handle);
 
     if (ret != pdPASS)  {
-        ESP_LOGI(TAG, "create thread %s failed", OPENSSL_DEMO_THREAD_NAME);
+        ESP_LOGI(TAG, "create thread %s failed", OPENSSL_EXAMPLE_TASK_NAME);
     }
 }
 
@@ -184,7 +184,7 @@ static esp_err_t wifi_event_handler(void *ctx, system_event_t *event)
         break;
     case SYSTEM_EVENT_STA_GOT_IP:
         xEventGroupSetBits(wifi_event_group, CONNECTED_BIT);
-        openssl_client_init();
+        openssl_example_client_init();
         break;
     case SYSTEM_EVENT_STA_DISCONNECTED:
         /* This is a workaround as ESP32 WiFi libs don't currently

examples/protocols/openssl_server/main/openssl_server_example.h

@@ -21,13 +21,13 @@
 #define EXAMPLE_WIFI_SSID               CONFIG_WIFI_SSID
 #define EXAMPLE_WIFI_PASS               CONFIG_WIFI_PASSWORD
 
-#define OPENSSL_DEMO_THREAD_NAME        "OpenSSL_demo"
-#define OPENSSL_DEMO_THREAD_STACK_WORDS 10240
-#define OPENSSL_DEMO_THREAD_PRORIOTY    8
+#define OPENSSL_EXAMPLE_TASK_NAME        "openssl_example"
+#define OPENSSL_EXAMPLE_TASK_STACK_WORDS 10240
+#define OPENSSL_EXAMPLE_TASK_PRORIOTY    8
 
-#define OPENSSL_DEMO_RECV_BUF_LEN       1024
+#define OPENSSL_EXAMPLE_RECV_BUF_LEN       1024
 
-#define OPENSSL_DEMO_LOCAL_TCP_PORT     443
+#define OPENSSL_EXAMPLE_LOCAL_TCP_PORT     443
 
 #endif
 

examples/protocols/openssl_server/main/openssl_server_example_main.c

@@ -7,7 +7,7 @@
    CONDITIONS OF ANY KIND, either express or implied.
 */
 
-#include "openssl_server.h"
+#include "openssl_server_example.h"
 
 #include <string.h>
 
@@ -33,20 +33,20 @@ static EventGroupHandle_t wifi_event_group;
    to the AP with an IP? */
 const static int CONNECTED_BIT = BIT0;
 
-const static char *TAG = "Openssl_demo";
+const static char *TAG = "Openssl_example";
 
-#define OPENSSL_DEMO_SERVER_ACK "HTTP/1.1 200 OK\r\n" \
+#define OPENSSL_EXAMPLE_SERVER_ACK "HTTP/1.1 200 OK\r\n" \
                                 "Content-Type: text/html\r\n" \
                                 "Content-Length: 98\r\n\r\n" \
                                 "<html>\r\n" \
                                 "<head>\r\n" \
-                                "<title>OpenSSL demo</title></head><body>\r\n" \
-                                "OpenSSL server demo!\r\n" \
+                                "<title>OpenSSL example</title></head><body>\r\n" \
+                                "OpenSSL server example!\r\n" \
                                 "</body>\r\n" \
                                 "</html>\r\n" \
                                 "\r\n"
 
-static void openssl_demo_thread(void *p)
+static void openssl_example_task(void *p)
 {
     int ret;
 
@@ -57,9 +57,9 @@ static void openssl_demo_thread(void *p)
     socklen_t addr_len;
     struct sockaddr_in sock_addr;
 
-    char recv_buf[OPENSSL_DEMO_RECV_BUF_LEN];
+    char recv_buf[OPENSSL_EXAMPLE_RECV_BUF_LEN];
 
-    const char send_data[] = OPENSSL_DEMO_SERVER_ACK;
+    const char send_data[] = OPENSSL_EXAMPLE_SERVER_ACK;
     const int send_bytes = sizeof(send_data);
 
     extern const unsigned char cacert_pem_start[] asm("_binary_cacert_pem_start");
@@ -110,7 +110,7 @@ static void openssl_demo_thread(void *p)
     memset(&sock_addr, 0, sizeof(sock_addr));
     sock_addr.sin_family = AF_INET;
     sock_addr.sin_addr.s_addr = 0;
-    sock_addr.sin_port = htons(OPENSSL_DEMO_LOCAL_TCP_PORT);
+    sock_addr.sin_port = htons(OPENSSL_EXAMPLE_LOCAL_TCP_PORT);
     ret = bind(socket, (struct sockaddr*)&sock_addr, sizeof(sock_addr));
     if (ret) {
         ESP_LOGI(TAG, "failed");
@@ -155,8 +155,8 @@ reconnect:
 
     ESP_LOGI(TAG, "SSL server read message ......");
     do {
-        memset(recv_buf, 0, OPENSSL_DEMO_RECV_BUF_LEN);
-        ret = SSL_read(ssl, recv_buf, OPENSSL_DEMO_RECV_BUF_LEN - 1);
+        memset(recv_buf, 0, OPENSSL_EXAMPLE_RECV_BUF_LEN);
+        ret = SSL_read(ssl, recv_buf, OPENSSL_EXAMPLE_RECV_BUF_LEN - 1);
         if (ret <= 0) {
             break;
         }
@@ -199,15 +199,15 @@ static void openssl_client_init(void)
     int ret;
     xTaskHandle openssl_handle;
 
-    ret = xTaskCreate(openssl_demo_thread,
-                      OPENSSL_DEMO_THREAD_NAME,
-                      OPENSSL_DEMO_THREAD_STACK_WORDS,
+    ret = xTaskCreate(openssl_example_task,
+                      OPENSSL_EXAMPLE_TASK_NAME,
+                      OPENSSL_EXAMPLE_TASK_STACK_WORDS,
                       NULL,
-                      OPENSSL_DEMO_THREAD_PRORIOTY,
+                      OPENSSL_EXAMPLE_TASK_PRORIOTY,
                       &openssl_handle); 
 
     if (ret != pdPASS)  {
-        ESP_LOGI(TAG, "create thread %s failed", OPENSSL_DEMO_THREAD_NAME);
+        ESP_LOGI(TAG, "create task %s failed", OPENSSL_EXAMPLE_TASK_NAME);
     }
 }