From 9c9b96deff966835744f14d089e0ecc115cef96e Mon Sep 17 00:00:00 2001 From: yuanjm Date: Thu, 18 Feb 2021 11:48:00 +0800 Subject: [PATCH] examples: Add a separate static_ip example --- examples/protocols/static_ip/CMakeLists.txt | 6 + examples/protocols/static_ip/Makefile | 8 + examples/protocols/static_ip/README.md | 85 +++++++++ .../protocols/static_ip/main/CMakeLists.txt | 2 + .../static_ip/main/Kconfig.projbuild | 38 ++++ .../protocols/static_ip/main/component.mk | 8 + .../static_ip/main/static_ip_example_main.c | 172 ++++++++++++++++++ 7 files changed, 319 insertions(+) create mode 100644 examples/protocols/static_ip/CMakeLists.txt create mode 100644 examples/protocols/static_ip/Makefile create mode 100644 examples/protocols/static_ip/README.md create mode 100644 examples/protocols/static_ip/main/CMakeLists.txt create mode 100644 examples/protocols/static_ip/main/Kconfig.projbuild create mode 100644 examples/protocols/static_ip/main/component.mk create mode 100644 examples/protocols/static_ip/main/static_ip_example_main.c diff --git a/examples/protocols/static_ip/CMakeLists.txt b/examples/protocols/static_ip/CMakeLists.txt new file mode 100644 index 0000000000..a91bebf1fe --- /dev/null +++ b/examples/protocols/static_ip/CMakeLists.txt @@ -0,0 +1,6 @@ +# The following five 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) + +include($ENV{IDF_PATH}/tools/cmake/project.cmake) +project(static_ip) diff --git a/examples/protocols/static_ip/Makefile b/examples/protocols/static_ip/Makefile new file mode 100644 index 0000000000..bd2c6fc15a --- /dev/null +++ b/examples/protocols/static_ip/Makefile @@ -0,0 +1,8 @@ +# +# This is a project Makefile. It is assumed the directory this Makefile resides in is a +# project subdirectory. +# + +PROJECT_NAME := static_ip + +include $(IDF_PATH)/make/project.mk diff --git a/examples/protocols/static_ip/README.md b/examples/protocols/static_ip/README.md new file mode 100644 index 0000000000..27abccc27e --- /dev/null +++ b/examples/protocols/static_ip/README.md @@ -0,0 +1,85 @@ +# WiFi station example + +(See the README.md file in the upper level 'examples' directory for more information about examples.) + + +## How to use example + +### Configure the project + +``` +idf.py menuconfig +``` + +Set following parameters under Example Configuration Options: + +* Set `WiFi SSID` and `WiFi Password` and `Maximal retry` under Example Configuration Options. + +* Set `Static IP address` of your device static IP. + +* Set `Static netmask address` of your device static netmask address. + +* Set `Static gateway address` of your device static gateway address. + +### 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 +``` + +(To exit the serial monitor, type ``Ctrl-]``.) + +See the Getting Started Guide for full steps to configure and use ESP-IDF to build projects. + +## Example Output +Note that the output, in particular the order of the output, may vary depending on the environment. + +Console output if station connects to AP successfully: +``` +I (563) static_ip: ESP_WIFI_MODE_STA +I (573) wifi:wifi driver task: 3ffc1bfc, prio:23, stack:6656, core=0 +I (573) system_api: Base MAC address is not set +I (573) system_api: read default base MAC address from EFUSE +I (603) wifi:wifi firmware version: 6b2834e +I (603) wifi:wifi certification version: v7.0 +I (603) wifi:config NVS flash: enabled +I (603) wifi:config nano formating: disabled +I (613) wifi:Init data frame dynamic rx buffer num: 32 +I (613) wifi:Init management frame dynamic rx buffer num: 32 +I (623) wifi:Init management short buffer num: 32 +I (623) wifi:Init dynamic tx buffer num: 32 +I (633) wifi:Init static rx buffer size: 1600 +I (633) wifi:Init static rx buffer num: 10 +I (643) wifi:Init dynamic rx buffer num: 32 +I (643) wifi_init: rx ba win: 6 +I (643) wifi_init: tcpip mbox: 32 +I (653) wifi_init: udp mbox: 6 +I (653) wifi_init: tcp mbox: 6 +I (653) wifi_init: tcp tx win: 5744 +I (663) wifi_init: tcp rx win: 5744 +I (663) wifi_init: tcp mss: 1440 +I (673) wifi_init: WiFi IRAM OP enabled +I (673) wifi_init: WiFi RX IRAM OP enabled +I (723) phy_init: phy_version 4660,0162888,Dec 23 2020 +W (723) phy_init: failed to load RF calibration data (0xffffffff), falling back to full calibration +I (1093) wifi:mode : sta (4c:11:ae:ea:69:fc) +I (1093) wifi:enable tsf +I (1093) static_ip: wifi_init_sta finished. +I (2313) wifi:new:<11,0>, old:<1,0>, ap:<255,255>, sta:<11,0>, prof:1 +I (3053) wifi:state: init -> auth (b0) +I (3083) wifi:state: auth -> assoc (0) +I (3213) wifi:new:<11,2>, old:<11,0>, ap:<255,255>, sta:<11,2>, prof:1 +I (3213) wifi:state: assoc -> run (10) +I (3233) wifi:connected with myssid, aid = 2, channel 11, 40D, bssid = 34:29:12:43:c5:40 +I (3233) wifi:security: WPA2-PSK, phy: bgn, rssi: -7 +I (3243) wifi:pm start, type: 1 + +I (3253) esp_netif_handlers: sta ip: 192.168.4.2, mask: 255.255.255.0, gw: 192.168.4.1 +I (3253) static_ip: static ip:192.168.4.2 +I (3253) static_ip: connected to ap SSID:myssid password:mypassword +W (3273) wifi:idx:0 (ifx:0, 34:29:12:43:c5:40), tid:5, ssn:2, winSize:64 +I (3303) wifi:AP's beacon interval = 102400 us, DTIM period = 1 +I (3303) wifi:new:<11,0>, old:<11,2>, ap:<255,255>, sta:<11,0>, prof:1 +``` diff --git a/examples/protocols/static_ip/main/CMakeLists.txt b/examples/protocols/static_ip/main/CMakeLists.txt new file mode 100644 index 0000000000..e9d8891a84 --- /dev/null +++ b/examples/protocols/static_ip/main/CMakeLists.txt @@ -0,0 +1,2 @@ +idf_component_register(SRCS "static_ip_example_main.c" + INCLUDE_DIRS ".") diff --git a/examples/protocols/static_ip/main/Kconfig.projbuild b/examples/protocols/static_ip/main/Kconfig.projbuild new file mode 100644 index 0000000000..7fbda28f6a --- /dev/null +++ b/examples/protocols/static_ip/main/Kconfig.projbuild @@ -0,0 +1,38 @@ +menu "Example Configuration" + + config EXAMPLE_WIFI_SSID + string "WiFi SSID" + default "myssid" + help + SSID (network name) for the example to connect to. + + config EXAMPLE_WIFI_PASSWORD + string "WiFi Password" + default "mypassword" + help + WiFi password (WPA or WPA2) for the example to use. + + config EXAMPLE_MAXIMUM_RETRY + int "Maximum retry" + default 5 + help + Set the Maximum retry to avoid station reconnecting to the AP unlimited when the AP is really inexistent. + + config EXAMPLE_STATIC_IP_ADDR + string "Static IP address" + default "192.168.4.2" + help + Set static IP address. + + config EXAMPLE_STATIC_NETMASK_ADDR + string "Static netmask address" + default "255.255.255.0" + help + Set static netmask address. + + config EXAMPLE_STATIC_GW_ADDR + string "Static gateway address" + default "192.168.4.1" + help + Set static gateway address. +endmenu diff --git a/examples/protocols/static_ip/main/component.mk b/examples/protocols/static_ip/main/component.mk new file mode 100644 index 0000000000..0adf45649a --- /dev/null +++ b/examples/protocols/static_ip/main/component.mk @@ -0,0 +1,8 @@ +# +# Main component makefile. +# +# This Makefile can be left empty. By default, it will take the sources in the +# src/ directory, compile them and link them into lib(subdirectory_name).a +# in the build directory. This behaviour is entirely configurable, +# please read the ESP-IDF documents if you need to do this. +# diff --git a/examples/protocols/static_ip/main/static_ip_example_main.c b/examples/protocols/static_ip/main/static_ip_example_main.c new file mode 100644 index 0000000000..2589faa322 --- /dev/null +++ b/examples/protocols/static_ip/main/static_ip_example_main.c @@ -0,0 +1,172 @@ +/* Static IP 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 +#include "freertos/FreeRTOS.h" +#include "freertos/task.h" +#include "freertos/event_groups.h" +#include "esp_system.h" +#include "esp_wifi.h" +#include "esp_event.h" +#include "esp_log.h" +#include "nvs_flash.h" + +/* The examples use configuration that you can set via project configuration menu + + 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_EXAMPLE_WIFI_SSID +#define EXAMPLE_WIFI_PASS CONFIG_EXAMPLE_WIFI_PASSWORD +#define EXAMPLE_MAXIMUM_RETRY CONFIG_EXAMPLE_MAXIMUM_RETRY +#define EXAMPLE_STATIC_IP_ADDR CONFIG_EXAMPLE_STATIC_IP_ADDR +#define EXAMPLE_STATIC_NETMASK_ADDR CONFIG_EXAMPLE_STATIC_NETMASK_ADDR +#define EXAMPLE_STATIC_GW_ADDR CONFIG_EXAMPLE_STATIC_GW_ADDR + +/* FreeRTOS event group to signal when we are connected*/ +static EventGroupHandle_t s_wifi_event_group; + +/* The event group allows multiple bits for each event, but we only care about two events: + * - we are connected to the AP with an IP + * - we failed to connect after the maximum amount of retries */ +#define WIFI_CONNECTED_BIT BIT0 +#define WIFI_FAIL_BIT BIT1 + +static const char *TAG = "static_ip"; + +static int s_retry_num = 0; + +static void example_set_static_ip(esp_netif_t *netif) +{ + if (esp_netif_dhcpc_stop(netif) != ESP_OK) { + ESP_LOGE(TAG, "Failed to stop dhcp client"); + return; + } + esp_netif_ip_info_t ip; + memset(&ip, 0 , sizeof(esp_netif_ip_info_t)); + ip.ip.addr = ipaddr_addr(EXAMPLE_STATIC_IP_ADDR); + ip.netmask.addr = ipaddr_addr(EXAMPLE_STATIC_NETMASK_ADDR); + ip.gw.addr = ipaddr_addr(EXAMPLE_STATIC_GW_ADDR); + if (esp_netif_set_ip_info(netif, &ip) != ESP_OK) { + ESP_LOGE(TAG, "Failed to set ip info"); + return; + } + ESP_LOGD(TAG, "Success to set static ip: %s, netmask: %s, gw: %s", EXAMPLE_STATIC_IP_ADDR, EXAMPLE_STATIC_NETMASK_ADDR, EXAMPLE_STATIC_GW_ADDR); +} + +static void event_handler(void* arg, esp_event_base_t event_base, + int32_t event_id, void* event_data) +{ + if (event_base == WIFI_EVENT && event_id == WIFI_EVENT_STA_START) { + esp_wifi_connect(); + } else if (event_base == WIFI_EVENT && event_id == WIFI_EVENT_STA_CONNECTED) { + example_set_static_ip(arg); + } else if (event_base == WIFI_EVENT && event_id == WIFI_EVENT_STA_DISCONNECTED) { + if (s_retry_num < EXAMPLE_MAXIMUM_RETRY) { + esp_wifi_connect(); + s_retry_num++; + ESP_LOGI(TAG, "retry to connect to the AP"); + } else { + xEventGroupSetBits(s_wifi_event_group, WIFI_FAIL_BIT); + } + ESP_LOGI(TAG,"connect to the AP fail"); + } else if (event_base == IP_EVENT && event_id == IP_EVENT_STA_GOT_IP) { + ip_event_got_ip_t* event = (ip_event_got_ip_t*) event_data; + ESP_LOGI(TAG, "static ip:" IPSTR, IP2STR(&event->ip_info.ip)); + s_retry_num = 0; + xEventGroupSetBits(s_wifi_event_group, WIFI_CONNECTED_BIT); + } +} + +void wifi_init_sta(void) +{ + s_wifi_event_group = xEventGroupCreate(); + + ESP_ERROR_CHECK(esp_netif_init()); + + ESP_ERROR_CHECK(esp_event_loop_create_default()); + + esp_netif_t *sta_netif = esp_netif_create_default_wifi_sta(); + assert(sta_netif); + + wifi_init_config_t cfg = WIFI_INIT_CONFIG_DEFAULT(); + ESP_ERROR_CHECK(esp_wifi_init(&cfg)); + + esp_event_handler_instance_t instance_any_id; + esp_event_handler_instance_t instance_got_ip; + ESP_ERROR_CHECK(esp_event_handler_instance_register(WIFI_EVENT, + ESP_EVENT_ANY_ID, + &event_handler, + sta_netif, + &instance_any_id)); + ESP_ERROR_CHECK(esp_event_handler_instance_register(IP_EVENT, + IP_EVENT_STA_GOT_IP, + &event_handler, + sta_netif, + &instance_got_ip)); + + wifi_config_t wifi_config = { + .sta = { + .ssid = EXAMPLE_WIFI_SSID, + .password = EXAMPLE_WIFI_PASS, + /* Setting a password implies station will connect to all security modes including WEP/WPA. + * However these modes are deprecated and not advisable to be used. Incase your Access point + * doesn't support WPA2, these mode can be enabled by commenting below line */ + .threshold.authmode = WIFI_AUTH_WPA2_PSK, + + .pmf_cfg = { + .capable = true, + .required = false + }, + }, + }; + ESP_ERROR_CHECK(esp_wifi_set_mode(WIFI_MODE_STA) ); + ESP_ERROR_CHECK(esp_wifi_set_config(WIFI_IF_STA, &wifi_config) ); + ESP_ERROR_CHECK(esp_wifi_start() ); + + ESP_LOGI(TAG, "wifi_init_sta finished."); + + /* Waiting until either the connection is established (WIFI_CONNECTED_BIT) or connection failed for the maximum + * number of re-tries (WIFI_FAIL_BIT). The bits are set by event_handler() (see above) */ + EventBits_t bits = xEventGroupWaitBits(s_wifi_event_group, + WIFI_CONNECTED_BIT | WIFI_FAIL_BIT, + pdFALSE, + pdFALSE, + portMAX_DELAY); + + /* xEventGroupWaitBits() returns the bits before the call returned, hence we can test which event actually + * happened. */ + if (bits & WIFI_CONNECTED_BIT) { + ESP_LOGI(TAG, "connected to ap SSID:%s password:%s", + EXAMPLE_WIFI_SSID, EXAMPLE_WIFI_PASS); + } else if (bits & WIFI_FAIL_BIT) { + ESP_LOGI(TAG, "Failed to connect to SSID:%s, password:%s", + EXAMPLE_WIFI_SSID, EXAMPLE_WIFI_PASS); + } else { + ESP_LOGE(TAG, "UNEXPECTED EVENT"); + } + + /* The event will not be processed after unregister */ + ESP_ERROR_CHECK(esp_event_handler_instance_unregister(IP_EVENT, IP_EVENT_STA_GOT_IP, instance_got_ip)); + ESP_ERROR_CHECK(esp_event_handler_instance_unregister(WIFI_EVENT, ESP_EVENT_ANY_ID, instance_any_id)); + vEventGroupDelete(s_wifi_event_group); +} + +void app_main(void) +{ + //Initialize NVS + esp_err_t ret = nvs_flash_init(); + if (ret == ESP_ERR_NVS_NO_FREE_PAGES || ret == ESP_ERR_NVS_NEW_VERSION_FOUND) { + ESP_ERROR_CHECK(nvs_flash_erase()); + ret = nvs_flash_init(); + } + ESP_ERROR_CHECK(ret); + + ESP_LOGI(TAG, "ESP_WIFI_MODE_STA"); + wifi_init_sta(); +}