esp32/esp8266: Rename WLAN.PM_* constants.

glenn20 · glenn20 · commit 4f56f71b6fe3 · 2023-05-06T13:33:41.000+10:00
Adopt new names for PM_ constants:
- PM_PERFORMANCE, PM_POWERSAVE, PM_NONE.
diff --git a/docs/library/network.WLAN.rst b/docs/library/network.WLAN.rst
@@ -139,12 +139,14 @@ Methods
 Constants
 ---------
 
-.. data:: WLAN.PM_NONE
-        WLAN.PM_MIN_MODEM
-        WLAN.PM_MAX_MODEM
-        WLAN.PM_LIGHT_SLEEP  (``esp8266 only``)
-
-    Allowed values for the ``WLAN.config(pm=...)`` network interface parameter.
-    ``PM_NONE``, ``PM_MIN_MODEM`` and ``PM_MAX_MODEM`` are supported on the
-    esp32 and esp8266 ports. ``PM_LIGHT_SLEEP`` is supported on the esp8266
-    port.
+.. data:: WLAN.PM_PERFORMANCE
+        WLAN.PM_POWERSAVE
+        WLAN.PM_NONE
+
+    Allowed values for the ``WLAN.config(pm=...)`` network interface parameter:
+
+        * ``PM_PERFORMANCE``: enable WiFi power management to balance power
+          savings and WiFi performance
+        * ``PM_POWERSAVE``: enable WiFi power management with additional power
+          savings and reduced WiFi performance
+        * ``PM_NONE``: disable wifi power management
diff --git a/ports/esp32/network_wlan.c b/ports/esp32/network_wlan.c
@@ -640,8 +640,8 @@ STATIC const mp_rom_map_elem_t wlan_if_locals_dict_table[] = {
 
     // Constants
     { MP_ROM_QSTR(MP_QSTR_PM_NONE), MP_ROM_INT(WIFI_PS_NONE) },
-    { MP_ROM_QSTR(MP_QSTR_PM_MIN_MODEM), MP_ROM_INT(WIFI_PS_MIN_MODEM) },
-    { MP_ROM_QSTR(MP_QSTR_PM_MAX_MODEM), MP_ROM_INT(WIFI_PS_MAX_MODEM) },
+    { MP_ROM_QSTR(MP_QSTR_PM_PERFORMANCE), MP_ROM_INT(WIFI_PS_MIN_MODEM) },
+    { MP_ROM_QSTR(MP_QSTR_PM_POWERSAVE), MP_ROM_INT(WIFI_PS_MAX_MODEM) },
 };
 STATIC MP_DEFINE_CONST_DICT(wlan_if_locals_dict, wlan_if_locals_dict_table);
 
diff --git a/ports/esp8266/network_wlan.c b/ports/esp8266/network_wlan.c
@@ -522,9 +522,8 @@ STATIC const mp_rom_map_elem_t wlan_if_locals_dict_table[] = {
 
     // Constants
     { MP_ROM_QSTR(MP_QSTR_PM_NONE), MP_ROM_INT(NONE_SLEEP_T) },
-    { MP_ROM_QSTR(MP_QSTR_PM_MIN_MODEM), MP_ROM_INT(MODEM_SLEEP_T) },
-    { MP_ROM_QSTR(MP_QSTR_PM_MAX_MODEM), MP_ROM_INT(MODEM_SLEEP_T) },
-    { MP_ROM_QSTR(MP_QSTR_PM_LIGHT_SLEEP), MP_ROM_INT(LIGHT_SLEEP_T) },
+    { MP_ROM_QSTR(MP_QSTR_PM_PERFORMANCE), MP_ROM_INT(MODEM_SLEEP_T) },
+    { MP_ROM_QSTR(MP_QSTR_PM_POWERSAVE), MP_ROM_INT(LIGHT_SLEEP_T) },
 };
 
 STATIC MP_DEFINE_CONST_DICT(wlan_if_locals_dict, wlan_if_locals_dict_table);
