Wifi listen interval

Author: Daniel Dunn

ports/espressif/common-hal/wifi/Radio.c

@@ -139,6 +139,25 @@ void common_hal_wifi_radio_set_tx_power(wifi_radio_obj_t *self, const mp_float_t
     esp_wifi_set_max_tx_power(tx_power * 4.0f);
 }
 
+mp_int_t common_hal_wifi_radio_get_listen_interval(wifi_radio_obj_t *self) {
+    wifi_config_t *config = &self->sta_config;
+    return config->sta.listen_interval;
+}
+
+void common_hal_wifi_radio_set_listen_interval(wifi_radio_obj_t *self, const mp_int_t listen_interval) {
+    wifi_config_t *config = &self->sta_config;
+    config->sta.listen_interval = listen_interval;
+    if (listen_interval == 1) {
+        esp_wifi_set_ps(WIFI_PS_MIN_MODEM);
+    } else if (listen_interval > 1) {
+        esp_wifi_set_ps(WIFI_PS_MAX_MODEM);
+    } else {
+        esp_wifi_set_ps(WIFI_PS_NONE);
+    }
+
+    esp_wifi_set_config(ESP_IF_WIFI_STA, config);
+}
+
 mp_obj_t common_hal_wifi_radio_get_mac_address_ap(wifi_radio_obj_t *self) {
     uint8_t mac[MAC_ADDRESS_LENGTH];
     esp_wifi_get_mac(ESP_IF_WIFI_AP, mac);
@@ -198,7 +217,8 @@ void common_hal_wifi_radio_start_ap(wifi_radio_obj_t *self, uint8_t *ssid, size_
     set_mode_ap(self, true);
 
     uint8_t esp_authmode = 0;
-    switch (authmode) {
+    switch (authmode)
+    {
         case AUTHMODE_OPEN:
             esp_authmode = WIFI_AUTH_OPEN;
             break;
@@ -249,7 +269,8 @@ mp_obj_t common_hal_wifi_radio_get_stations_ap(wifi_radio_obj_t *self) {
     }
 
     esp_netif_pair_mac_ip_t mac_ip_pair[esp_sta_list.num];
-    for (int i = 0; i < esp_sta_list.num; i++) {
+    for (int i = 0; i < esp_sta_list.num; i++)
+    {
         memcpy(mac_ip_pair[i].mac, esp_sta_list.sta[i].mac, MAC_ADDRESS_LENGTH);
         mac_ip_pair[i].ip.addr = 0;
     }
@@ -260,7 +281,8 @@ mp_obj_t common_hal_wifi_radio_get_stations_ap(wifi_radio_obj_t *self) {
     }
 
     mp_obj_t mp_sta_list = mp_obj_new_list(0, NULL);
-    for (int i = 0; i < esp_sta_list.num; i++) {
+    for (int i = 0; i < esp_sta_list.num; i++)
+    {
         mp_obj_t elems[3] = {
             mp_obj_new_bytes(esp_sta_list.sta[i].mac, MAC_ADDRESS_LENGTH),
             MP_OBJ_NEW_SMALL_INT(esp_sta_list.sta[i].rssi),
@@ -307,7 +329,8 @@ wifi_radio_error_t common_hal_wifi_radio_connect(wifi_radio_obj_t *self, uint8_t
             xEventGroupClearBits(self->event_group_handle, WIFI_DISCONNECTED_BIT);
             // Trying to switch networks so disconnect first.
             esp_wifi_disconnect();
-            do {
+            do
+            {
                 RUN_BACKGROUND_TASKS;
                 bits = xEventGroupWaitBits(self->event_group_handle,
                     WIFI_DISCONNECTED_BIT,
@@ -351,7 +374,8 @@ wifi_radio_error_t common_hal_wifi_radio_connect(wifi_radio_obj_t *self, uint8_t
     self->retries_left = 5;
     esp_wifi_connect();
 
-    do {
+    do
+    {
         RUN_BACKGROUND_TASKS;
         bits = xEventGroupWaitBits(self->event_group_handle,
             WIFI_CONNECTED_BIT | WIFI_DISCONNECTED_BIT,
@@ -369,8 +393,7 @@ wifi_radio_error_t common_hal_wifi_radio_connect(wifi_radio_obj_t *self, uint8_t
             (self->last_disconnect_reason == WIFI_REASON_AUTH_FAIL) ||
             (self->last_disconnect_reason == WIFI_REASON_4WAY_HANDSHAKE_TIMEOUT) ||
             (self->last_disconnect_reason == WIFI_REASON_NO_AP_FOUND_W_COMPATIBLE_SECURITY) ||
-            (self->last_disconnect_reason == WIFI_REASON_NO_AP_FOUND_IN_AUTHMODE_THRESHOLD)
-            ) {
+            (self->last_disconnect_reason == WIFI_REASON_NO_AP_FOUND_IN_AUTHMODE_THRESHOLD)) {
             return WIFI_RADIO_ERROR_AUTH_FAIL;
         } else if (self->last_disconnect_reason == WIFI_REASON_NO_AP_FOUND) {
             return WIFI_RADIO_ERROR_NO_AP_FOUND;
@@ -471,7 +494,8 @@ static mp_obj_t common_hal_wifi_radio_get_addresses_netif(wifi_radio_obj_t *self
     mp_obj_tuple_t *result = MP_OBJ_TO_PTR(mp_obj_new_tuple(n_addresses, NULL));
 
     #if CIRCUITPY_SOCKETPOOL_IPV6
-    for (int i = 0; i < n_addresses6; i++) {
+    for (int i = 0; i < n_addresses6; i++)
+    {
         result->items[i] = espaddr6_to_str(&addresses[i]);
     }
     #endif

ports/espressif/mpconfigport.mk

@@ -20,6 +20,10 @@ CIRCUITPY_FULL_BUILD ?= 1
 # If SSL is enabled, it's mbedtls
 CIRCUITPY_SSL_MBEDTLS = 1
 
+# Wifi Power Save
+CIRCUITPY_WIFI_RADIO_SETTABLE_LISTEN_INTERVAL = 1
+
+
 # These modules are implemented in ports/<port>/common-hal:
 CIRCUITPY_ALARM ?= 1
 CIRCUITPY_ALARM_TOUCH ?= 0

py/circuitpy_mpconfig.mk

@@ -674,6 +674,9 @@ CFLAGS += -DCIRCUITPY_WEB_WORKFLOW=$(CIRCUITPY_WEB_WORKFLOW)
 CIRCUITPY_WIFI_RADIO_SETTABLE_MAC_ADDRESS?= 1
 CFLAGS += -DCIRCUITPY_WIFI_RADIO_SETTABLE_MAC_ADDRESS=$(CIRCUITPY_WIFI_RADIO_SETTABLE_MAC_ADDRESS)
 
+CIRCUITPY_WIFI_RADIO_SETTABLE_LISTEN_INTERVAL?= 0
+CFLAGS += -DCIRCUITPY_WIFI_RADIO_SETTABLE_LISTEN_INTERVAL=$(CIRCUITPY_WIFI_RADIO_SETTABLE_LISTEN_INTERVAL)
+
 # tinyusb port tailored configuration
 CIRCUITPY_TUSB_MEM_ALIGN ?= 4
 CFLAGS += -DCIRCUITPY_TUSB_MEM_ALIGN=$(CIRCUITPY_TUSB_MEM_ALIGN)