WPS on ESP32-S3

[AndreaPici]

Hi there,

I'm trying to import the WPS example that can be found in ESP-IDF examples into micropython. I'm trying to integrate it into the network.WLAN class.

Here is the modnetwork.c event handler that I'm using:

static esp_err_t event_handler(void *ctx, system_event_t *event) {
    switch (event->event_id) {
        #if MICROPY_PY_NETWORK_WLAN
        case SYSTEM_EVENT_STA_START:
        case SYSTEM_EVENT_STA_CONNECTED:
        case SYSTEM_EVENT_STA_GOT_IP:
        case SYSTEM_EVENT_STA_DISCONNECTED:
            network_wlan_event_handler(event);
            break;
        #endif
        case SYSTEM_EVENT_GOT_IP6:
            ESP_LOGI("network", "Got IPv6");
            break;
        case SYSTEM_EVENT_ETH_START:
            ESP_LOGI("ethernet", "start");
            break;
        case SYSTEM_EVENT_ETH_STOP:
            ESP_LOGI("ethernet", "stop");
            break;
        case SYSTEM_EVENT_ETH_CONNECTED:
            ESP_LOGI("ethernet", "LAN cable connected");
            break;
        case SYSTEM_EVENT_ETH_DISCONNECTED:
            ESP_LOGI("ethernet", "LAN cable disconnected");
            break;
        case SYSTEM_EVENT_ETH_GOT_IP:
            ESP_LOGI("ethernet", "Got IP");
            break;
	#if MICROPY_PY_WPS
	case SYSTEM_EVENT_STA_WPS_ER_SUCCESS:
	case SYSTEM_EVENT_STA_WPS_ER_FAILED:
	case SYSTEM_EVENT_STA_WPS_ER_TIMEOUT:
	case SYSTEM_EVENT_STA_WPS_ER_PIN:
	case SYSTEM_EVENT_STA_WPS_ER_PBC_OVERLAP:
		wps_event_handler(event);
		break;
	#endif
        default:
            ESP_LOGI("network", "event %d", event->event_id);
            break;
    }
    return ESP_OK;
}

and this is the way i manage the system events into the network_wlan.c file:

#if MICROPY_PY_WPS
void wps_event_handler(system_event_t *event) {
	switch (event->event_id) {
        case SYSTEM_EVENT_STA_WPS_ER_SUCCESS:
        	{
        		system_event_sta_wps_er_success_t *evt = &event->event_info.sta_er_success;
        		ESP_LOGI(TAG, "WIFI_EVENT_STA_WPS_ER_SUCCESS");
			if (evt) {
				s_ap_creds_num = evt->ap_cred_cnt;
			}
			ESP_LOGI(TAG, "Received %d credentials", s_ap_creds_num);
			memcpy(wps_ap_creds[0].sta.ssid, evt->ap_cred[0].ssid, sizeof(evt->ap_cred[0].ssid));
			memcpy(wps_ap_creds[0].sta.password, evt->ap_cred[0].passphrase, sizeof(evt->ap_cred[0].passphrase));
			ESP_LOGI(TAG, "Received: %s, Passphrase: %s", wps_ap_creds[0].sta.ssid, wps_ap_creds[0].sta.password);
			ESP_ERROR_CHECK(esp_wifi_set_config(WIFI_IF_STA, &wps_ap_creds[0]));
			ESP_ERROR_CHECK(esp_wifi_wps_disable());
			ESP_ERROR_CHECK(esp_wifi_connect());
        	}
			break;
		case SYSTEM_EVENT_STA_WPS_ER_FAILED:
			ESP_LOGI(TAG, "WIFI_EVENT_STA_WPS_ER_FAILED");
			ESP_ERROR_CHECK(esp_wifi_wps_disable());
			break;
		case SYSTEM_EVENT_STA_WPS_ER_TIMEOUT:
			ESP_LOGI(TAG, "WIFI_EVENT_STA_WPS_ER_TIMEOUT");
			ESP_ERROR_CHECK(esp_wifi_wps_disable());
			break;
		case SYSTEM_EVENT_STA_WPS_ER_PIN:
			ESP_LOGI(TAG, "WIFI_EVENT_STA_WPS_ER_PIN");
			/* display the PIN code */
			system_event_sta_wps_er_pin_t *evt = &event->event_info.sta_er_pin;
			ESP_LOGI(TAG, "WPS_PIN = " PINSTR, PIN2STR(evt->pin_code));
			break;
		default:
			break;
	}
}
#endif

It seems that the system event is caught correctly, since I'm able to see the "WIFI_EVENT_STA_WPS_ER_SUCCESS" message.
The problem is that I'm not seeing the right SSID and Passphrase since what I'm getting is:

I (31625) wifi: STA_DISCONNECTED, reason:0
D (32525) event: no handlers have been registered for event WIFI_EVENT:7 posted to loop 0x3fce8dac
D (32525) event: running post SYSTEM_EVENT:10 with handler 0x4206450c and context 0x3fce9d04 on loop 0x3fce8dac
I (32535) WPS: WIFI_EVENT_STA_WPS_ER_SUCCESS
I (32545) WPS: Received 148 credentials
I (32545) WPS: Received: ▒?▒▒?3fcb391c▒D<, Passphrase: 2▒?
V (32555) esp_adapter: thread sem get: sem=0x3fcb3f60

What's wrong with the code? Thank you very much

[karfas]

This has nothing to do with micropython.

According to the ESP-IDF docs found on https://docs.espressif.com/projects/esp-idf/en/v4.4.3/esp32/api-guides/event-handling.html, the SYSTEM_EVENT_STA_WPS_ER_SUCCESS doesn't come with an "event data structure", so I would not rely on anything found in event->event_info.

Maybe you used a (too) old example ?

[AndreaPici]

Hi @karfas thanks for your help.

I'm using the latest esp-idf/examples/wifi/wps/main/wps.c example from esp-idf.
I know this has nothing to do directly with micropython but I'm porting that example on micropython.

The example itself works great compiling it with the same esp-idf I use to compile Micropython. So I'd like to know what differs.

Thank you

[AndreaPici]

I've solved changing the wps_event_handler into network_wlan.c file.

#if MICROPY_PY_WPS
void wps_event_handler(system_event_t *event) {
	switch (event->event_id) {
        case SYSTEM_EVENT_STA_WPS_ER_SUCCESS:
        	{
			ESP_ERROR_CHECK(esp_wifi_wps_disable());
			ESP_ERROR_CHECK(esp_wifi_connect());
        	}
			break;
		case SYSTEM_EVENT_STA_WPS_ER_FAILED:
			ESP_LOGI(TAG, "WIFI_EVENT_STA_WPS_ER_FAILED");
			ESP_ERROR_CHECK(esp_wifi_wps_disable());
			break;
		case SYSTEM_EVENT_STA_WPS_ER_TIMEOUT:
			ESP_LOGI(TAG, "WIFI_EVENT_STA_WPS_ER_TIMEOUT");
			ESP_ERROR_CHECK(esp_wifi_wps_disable());
			break;
		case SYSTEM_EVENT_STA_WPS_ER_PIN:
			ESP_LOGI(TAG, "WIFI_EVENT_STA_WPS_ER_PIN");
			/* display the PIN code */
			system_event_sta_wps_er_pin_t *evt = &event->event_info.sta_er_pin;
			ESP_LOGI(TAG, "WPS_PIN = " PINSTR, PIN2STR(evt->pin_code));
			break;
		default:
			break;
	}
}
#endif

I noticed that WPS scan and connection attemp finished successfully. Then I got the disconnect event that disconnected from my router.
Once I get the WPS success event I simply retry to connect to the last AP, the one I got from the WPS scan.