From 371c66f18811aaa05e6e6e6d353f0f3b3bcbe0da Mon Sep 17 00:00:00 2001 From: Piyush Shah Date: Wed, 15 Nov 2017 13:04:21 +0530 Subject: [PATCH 1/2] wifi_scan_example: Indentation Fixes - Trailing white spaces removed - Re-formatted switch-case Basic indentation fixes were done using tools/format.sh and switch-case formatting was done manually (to identify different levels for "switch" and "case") Signed-off-by: Piyush Shah --- examples/wifi/scan/main/scan.c | 50 +++++++++++++++++----------------- 1 file changed, 25 insertions(+), 25 deletions(-) diff --git a/examples/wifi/scan/main/scan.c b/examples/wifi/scan/main/scan.c index f48464886d..28c5a704f3 100644 --- a/examples/wifi/scan/main/scan.c +++ b/examples/wifi/scan/main/scan.c @@ -9,12 +9,12 @@ /* this example shows how to use all channel scan or fast scan to connect - In the fast scan mode, scan will end after find matched AP, in this mode, you - can set the threshold of auth mode and signal, the filter will ignore the AP + In the fast scan mode, scan will end after find matched AP, in this mode, you + can set the threshold of auth mode and signal, the filter will ignore the AP whose auth mode and rssi below the threshold. - In the all channel scan, scan will end after scan all the channel, and will + In the all channel scan, scan will end after scan all the channel, and will the best AP to connect, you can sort by signal or auth mode, auth mode is follow - the rule WPA2>WPA>WEP. + the rule WPA2>WPA>WEP. */ #include "freertos/FreeRTOS.h" #include "freertos/event_groups.h" @@ -65,22 +65,22 @@ static const char *TAG = "scan"; 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\n", - 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; + 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\n", + 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; } @@ -90,18 +90,18 @@ static void wifi_scan(void) { 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)); wifi_config_t wifi_config = { - .sta = { - .ssid = DEFAULT_SSID, - .password = DEFAULT_PWD, + .sta = { + .ssid = DEFAULT_SSID, + .password = DEFAULT_PWD, .scan_method = DEFAULT_SCAN_METHOD, .sort_method = DEFAULT_SORT_METHOD, .threshold.rssi = DEFAULT_RSSI, .threshold.authmode = DEFAULT_AUTHMODE, - }, + }, }; ESP_ERROR_CHECK(esp_wifi_set_mode(WIFI_MODE_STA)); ESP_ERROR_CHECK(esp_wifi_set_config(ESP_IF_WIFI_STA, &wifi_config)); From affde01b4ce8939c4f2e367c7d5eb4717bbc93b0 Mon Sep 17 00:00:00 2001 From: Piyush Shah Date: Wed, 15 Nov 2017 14:59:13 +0530 Subject: [PATCH 2/2] wifi_scan_example: Comments improved for readability Rephrased the example's description to make it easier to understand and made other grammatical fixes. Signed-off-by: Piyush Shah --- examples/wifi/scan/main/scan.c | 25 +++++++++++++++---------- 1 file changed, 15 insertions(+), 10 deletions(-) diff --git a/examples/wifi/scan/main/scan.c b/examples/wifi/scan/main/scan.c index 28c5a704f3..ee82d859df 100644 --- a/examples/wifi/scan/main/scan.c +++ b/examples/wifi/scan/main/scan.c @@ -8,13 +8,18 @@ */ /* - this example shows how to use all channel scan or fast scan to connect - In the fast scan mode, scan will end after find matched AP, in this mode, you - can set the threshold of auth mode and signal, the filter will ignore the AP - whose auth mode and rssi below the threshold. - In the all channel scan, scan will end after scan all the channel, and will - the best AP to connect, you can sort by signal or auth mode, auth mode is follow - the rule WPA2>WPA>WEP. + This example shows how to use the All Channel Scan or Fast Scan to connect + to a Wi-Fi network. + + In the Fast Scan mode, the scan will stop as soon as the first network matching + the SSID is found. In this mode, an application can set threshold for the + authentication mode and the Signal strength. Networks that do not meet the + threshold requirements will be ignored. + + In the All Channel Scan mode, the scan will end only after all the channels + are scanned, and connection will start with the best network. The networks + can be sorted based on Authentication Mode or Signal Strength. The priority + for the Authentication mode is: WPA2 > WPA > WEP > Open */ #include "freertos/FreeRTOS.h" #include "freertos/event_groups.h" @@ -23,7 +28,7 @@ #include "esp_event_loop.h" #include "nvs_flash.h" -/*set the ssid and password via "make menuconfig"*/ +/*Set the SSID and Password via "make menuconfig"*/ #define DEFAULT_SSID CONFIG_WIFI_SSID #define DEFAULT_PWD CONFIG_WIFI_PASSWORD @@ -72,7 +77,7 @@ static esp_err_t event_handler(void *ctx, system_event_t *event) break; case SYSTEM_EVENT_STA_GOT_IP: ESP_LOGI(TAG, "SYSTEM_EVENT_STA_GOT_IP"); - ESP_LOGI(TAG, "got ip:%s\n", + ESP_LOGI(TAG, "Got IP: %s\n", ip4addr_ntoa(&event->event_info.got_ip.ip_info.ip)); break; case SYSTEM_EVENT_STA_DISCONNECTED: @@ -85,7 +90,7 @@ static esp_err_t event_handler(void *ctx, system_event_t *event) return ESP_OK; } -/*init wifi as sta and set scan method*/ +/* Initialize Wi-Fi as sta and set scan method */ static void wifi_scan(void) { tcpip_adapter_init();