blob: e9918efa5ed0b63420abd6355aefb0b22c989d8f [file] [log] [blame]
Damien Georgeea186de2021-09-22 00:35:46 +10001/*
2 * This file is part of the MicroPython project, http://micropython.org/
3 *
4 * Development of the code in this file was sponsored by Microbric Pty Ltd
5 * and Mnemote Pty Ltd
6 *
7 * The MIT License (MIT)
8 *
9 * Copyright (c) 2016, 2017 Nick Moore @mnemote
10 * Copyright (c) 2017 "Eric Poulsen" <eric@zyxod.com>
11 *
12 * Based on esp8266/modnetwork.c which is Copyright (c) 2015 Paul Sokolovsky
13 * And the ESP IDF example code which is Public Domain / CC0
14 *
15 * Permission is hereby granted, free of charge, to any person obtaining a copy
16 * of this software and associated documentation files (the "Software"), to deal
17 * in the Software without restriction, including without limitation the rights
18 * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
19 * copies of the Software, and to permit persons to whom the Software is
20 * furnished to do so, subject to the following conditions:
21 *
22 * The above copyright notice and this permission notice shall be included in
23 * all copies or substantial portions of the Software.
24 *
25 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
26 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
27 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
28 * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
29 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
30 * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
31 * THE SOFTWARE.
32 */
33
34#include <string.h>
35
36#include "py/objlist.h"
37#include "py/runtime.h"
robert-hhd6bc34a2023-01-19 12:42:09 +010038#include "py/mphal.h"
Jim Mussaredeb51ca42023-02-01 14:20:45 +110039#include "extmod/modnetwork.h"
Damien Georgeea186de2021-09-22 00:35:46 +100040#include "modnetwork.h"
41
42#include "esp_wifi.h"
43#include "esp_log.h"
Angus Gratton960eef72023-11-14 16:46:55 +110044#include "esp_psram.h"
Damien Georgeea186de2021-09-22 00:35:46 +100045
Carlosgg1f355762023-06-25 22:48:39 +010046#ifndef NO_QSTR
47#include "mdns.h"
48#endif
49
Damien Georgeea186de2021-09-22 00:35:46 +100050#if MICROPY_PY_NETWORK_WLAN
51
52#if (WIFI_MODE_STA & WIFI_MODE_AP != WIFI_MODE_NULL || WIFI_MODE_STA | WIFI_MODE_AP != WIFI_MODE_APSTA)
53#error WIFI_MODE_STA and WIFI_MODE_AP are supposed to be bitfields!
54#endif
55
Damien Georgee4650122023-05-09 09:52:54 +100056typedef base_if_obj_t wlan_if_obj_t;
57
58STATIC wlan_if_obj_t wlan_sta_obj;
59STATIC wlan_if_obj_t wlan_ap_obj;
Damien Georgeea186de2021-09-22 00:35:46 +100060
61// Set to "true" if esp_wifi_start() was called
62static bool wifi_started = false;
63
64// Set to "true" if the STA interface is requested to be connected by the
65// user, used for automatic reassociation.
66static bool wifi_sta_connect_requested = false;
67
68// Set to "true" if the STA interface is connected to wifi and has IP address.
69static bool wifi_sta_connected = false;
70
71// Store the current status. 0 means None here, safe to do so as first enum value is WIFI_REASON_UNSPECIFIED=1.
72static uint8_t wifi_sta_disconn_reason = 0;
73
74#if MICROPY_HW_ENABLE_MDNS_QUERIES || MICROPY_HW_ENABLE_MDNS_RESPONDER
75// Whether mDNS has been initialised or not
76static bool mdns_initialised = false;
77#endif
78
79static uint8_t conf_wifi_sta_reconnects = 0;
Glenn Moloneydbced752023-07-01 13:54:44 +100080static uint8_t wifi_sta_reconnects;
Damien Georgeea186de2021-09-22 00:35:46 +100081
82// This function is called by the system-event task and so runs in a different
83// thread to the main MicroPython task. It must not raise any Python exceptions.
Damien Georgee4650122023-05-09 09:52:54 +100084static void network_wlan_wifi_event_handler(void *event_handler_arg, esp_event_base_t event_base, int32_t event_id, void *event_data) {
85 switch (event_id) {
86 case WIFI_EVENT_STA_START:
Damien Georgeea186de2021-09-22 00:35:46 +100087 ESP_LOGI("wifi", "STA_START");
Glenn Moloneydbced752023-07-01 13:54:44 +100088 wlan_sta_obj.active = true;
Damien Georgeea186de2021-09-22 00:35:46 +100089 wifi_sta_reconnects = 0;
90 break;
Damien Georgee4650122023-05-09 09:52:54 +100091
Glenn Moloneydbced752023-07-01 13:54:44 +100092 case WIFI_EVENT_STA_STOP:
93 wlan_sta_obj.active = false;
94 break;
95
Damien Georgee4650122023-05-09 09:52:54 +100096 case WIFI_EVENT_STA_CONNECTED:
Damien Georgeea186de2021-09-22 00:35:46 +100097 ESP_LOGI("network", "CONNECTED");
98 break;
Damien Georgee4650122023-05-09 09:52:54 +100099
100 case WIFI_EVENT_STA_DISCONNECTED: {
Damien Georgeea186de2021-09-22 00:35:46 +1000101 // This is a workaround as ESP32 WiFi libs don't currently
102 // auto-reassociate.
Damien Georgee4650122023-05-09 09:52:54 +1000103
104 wifi_event_sta_disconnected_t *disconn = event_data;
Damien Georgeea186de2021-09-22 00:35:46 +1000105 char *message = "";
106 wifi_sta_disconn_reason = disconn->reason;
107 switch (disconn->reason) {
108 case WIFI_REASON_BEACON_TIMEOUT:
109 // AP has dropped out; try to reconnect.
110 message = "\nbeacon timeout";
111 break;
112 case WIFI_REASON_NO_AP_FOUND:
113 // AP may not exist, or it may have momentarily dropped out; try to reconnect.
114 message = "\nno AP found";
115 break;
116 case WIFI_REASON_AUTH_FAIL:
117 // Password may be wrong, or it just failed to connect; try to reconnect.
118 message = "\nauthentication failed";
119 break;
120 default:
121 // Let other errors through and try to reconnect.
122 break;
123 }
124 ESP_LOGI("wifi", "STA_DISCONNECTED, reason:%d%s", disconn->reason, message);
125
126 wifi_sta_connected = false;
127 if (wifi_sta_connect_requested) {
128 wifi_mode_t mode;
129 if (esp_wifi_get_mode(&mode) != ESP_OK) {
130 break;
131 }
132 if (!(mode & WIFI_MODE_STA)) {
133 break;
134 }
135 if (conf_wifi_sta_reconnects) {
136 ESP_LOGI("wifi", "reconnect counter=%d, max=%d",
137 wifi_sta_reconnects, conf_wifi_sta_reconnects);
138 if (++wifi_sta_reconnects >= conf_wifi_sta_reconnects) {
139 break;
140 }
141 }
142 esp_err_t e = esp_wifi_connect();
143 if (e != ESP_OK) {
144 ESP_LOGI("wifi", "error attempting to reconnect: 0x%04x", e);
145 }
146 }
147 break;
148 }
Glenn Moloneydbced752023-07-01 13:54:44 +1000149
150 case WIFI_EVENT_AP_START:
151 wlan_ap_obj.active = true;
152 break;
153
154 case WIFI_EVENT_AP_STOP:
155 wlan_ap_obj.active = false;
156 break;
157
Damien Georgeea186de2021-09-22 00:35:46 +1000158 default:
159 break;
160 }
161}
162
Damien Georgee4650122023-05-09 09:52:54 +1000163static void network_wlan_ip_event_handler(void *event_handler_arg, esp_event_base_t event_base, int32_t event_id, void *event_data) {
164 switch (event_id) {
165 case IP_EVENT_STA_GOT_IP:
166 ESP_LOGI("network", "GOT_IP");
167 wifi_sta_connected = true;
168 wifi_sta_disconn_reason = 0; // Success so clear error. (in case of new error will be replaced anyway)
169 #if MICROPY_HW_ENABLE_MDNS_QUERIES || MICROPY_HW_ENABLE_MDNS_RESPONDER
170 if (!mdns_initialised) {
171 mdns_init();
172 #if MICROPY_HW_ENABLE_MDNS_RESPONDER
Jim Mussared65a3ce32023-10-03 13:32:48 +1100173 mdns_hostname_set(mod_network_hostname_data);
174 mdns_instance_name_set(mod_network_hostname_data);
Damien Georgee4650122023-05-09 09:52:54 +1000175 #endif
176 mdns_initialised = true;
177 }
178 #endif
179 break;
180
181 default:
182 break;
Damien Georgeea186de2021-09-22 00:35:46 +1000183 }
184}
185
Damien Georgee4650122023-05-09 09:52:54 +1000186STATIC void require_if(mp_obj_t wlan_if, int if_no) {
187 wlan_if_obj_t *self = MP_OBJ_TO_PTR(wlan_if);
188 if (self->if_id != if_no) {
189 mp_raise_msg(&mp_type_OSError, if_no == ESP_IF_WIFI_STA ? MP_ERROR_TEXT("STA required") : MP_ERROR_TEXT("AP required"));
190 }
191}
192
193void esp_initialise_wifi(void) {
Glenn Moloney7fa322a2020-09-24 15:37:04 +1000194 static int wifi_initialized = 0;
195 if (!wifi_initialized) {
Damien Georgee4650122023-05-09 09:52:54 +1000196 esp_exceptions(esp_event_handler_instance_register(WIFI_EVENT, ESP_EVENT_ANY_ID, network_wlan_wifi_event_handler, NULL, NULL));
197 esp_exceptions(esp_event_handler_instance_register(IP_EVENT, ESP_EVENT_ANY_ID, network_wlan_ip_event_handler, NULL, NULL));
198
199 wlan_sta_obj.base.type = &esp_network_wlan_type;
200 wlan_sta_obj.if_id = ESP_IF_WIFI_STA;
201 wlan_sta_obj.netif = esp_netif_create_default_wifi_sta();
Glenn Moloneydbced752023-07-01 13:54:44 +1000202 wlan_sta_obj.active = false;
Damien Georgee4650122023-05-09 09:52:54 +1000203
204 wlan_ap_obj.base.type = &esp_network_wlan_type;
205 wlan_ap_obj.if_id = ESP_IF_WIFI_AP;
206 wlan_ap_obj.netif = esp_netif_create_default_wifi_ap();
Glenn Moloneydbced752023-07-01 13:54:44 +1000207 wlan_ap_obj.active = false;
Damien Georgee4650122023-05-09 09:52:54 +1000208
Damien Georgeea186de2021-09-22 00:35:46 +1000209 wifi_init_config_t cfg = WIFI_INIT_CONFIG_DEFAULT();
Angus Gratton960eef72023-11-14 16:46:55 +1100210 #if CONFIG_SPIRAM_IGNORE_NOTFOUND
211 if (!esp_psram_is_initialized()) {
212 // If PSRAM failed to initialize, disable "Wi-Fi Cache TX Buffers"
213 // (default SPIRAM config ESP32_WIFI_CACHE_TX_BUFFER_NUM==32, this is 54,400 bytes of heap)
214 cfg.cache_tx_buf_num = 0;
215 cfg.feature_caps &= ~CONFIG_FEATURE_CACHE_TX_BUF_BIT;
216
217 // Set some other options back to the non-SPIRAM default values
218 // to save more RAM.
219 //
220 // These can be determined from ESP-IDF components/esp_wifi/Kconfig and the
221 // WIFI_INIT_CONFIG_DEFAULT macro
222 cfg.tx_buf_type = 1; // Dynamic, this "magic number" is defined in IDF KConfig
223 cfg.static_tx_buf_num = 0; // Probably don't need, due to tx_buf_type
224 cfg.dynamic_tx_buf_num = 32; // ESP-IDF default value (maximum)
225 }
226 #endif
Damien Georgeea186de2021-09-22 00:35:46 +1000227 ESP_LOGD("modnetwork", "Initializing WiFi");
228 esp_exceptions(esp_wifi_init(&cfg));
229 esp_exceptions(esp_wifi_set_storage(WIFI_STORAGE_RAM));
Damien Georgee4650122023-05-09 09:52:54 +1000230
Damien Georgeea186de2021-09-22 00:35:46 +1000231 ESP_LOGD("modnetwork", "Initialized");
Glenn Moloney7fa322a2020-09-24 15:37:04 +1000232 wifi_initialized = 1;
Damien Georgeea186de2021-09-22 00:35:46 +1000233 }
Glenn Moloney7fa322a2020-09-24 15:37:04 +1000234}
235
Damien George53cb0732023-05-11 11:51:02 +1000236STATIC mp_obj_t network_wlan_make_new(const mp_obj_type_t *type, size_t n_args, size_t n_kw, const mp_obj_t *args) {
237 mp_arg_check_num(n_args, n_kw, 0, 1, false);
238
Glenn Moloney7fa322a2020-09-24 15:37:04 +1000239 esp_initialise_wifi();
Damien Georgeea186de2021-09-22 00:35:46 +1000240
Damien Georgee4650122023-05-09 09:52:54 +1000241 int idx = (n_args > 0) ? mp_obj_get_int(args[0]) : ESP_IF_WIFI_STA;
242 if (idx == ESP_IF_WIFI_STA) {
Damien Georgeea186de2021-09-22 00:35:46 +1000243 return MP_OBJ_FROM_PTR(&wlan_sta_obj);
Damien Georgee4650122023-05-09 09:52:54 +1000244 } else if (idx == ESP_IF_WIFI_AP) {
Damien Georgeea186de2021-09-22 00:35:46 +1000245 return MP_OBJ_FROM_PTR(&wlan_ap_obj);
246 } else {
247 mp_raise_ValueError(MP_ERROR_TEXT("invalid WLAN interface identifier"));
248 }
249}
Damien Georgeea186de2021-09-22 00:35:46 +1000250
251STATIC mp_obj_t network_wlan_active(size_t n_args, const mp_obj_t *args) {
252 wlan_if_obj_t *self = MP_OBJ_TO_PTR(args[0]);
253
254 wifi_mode_t mode;
255 if (!wifi_started) {
256 mode = WIFI_MODE_NULL;
257 } else {
258 esp_exceptions(esp_wifi_get_mode(&mode));
259 }
260
Damien Georgee4650122023-05-09 09:52:54 +1000261 int bit = (self->if_id == ESP_IF_WIFI_STA) ? WIFI_MODE_STA : WIFI_MODE_AP;
Damien Georgeea186de2021-09-22 00:35:46 +1000262
263 if (n_args > 1) {
264 bool active = mp_obj_is_true(args[1]);
265 mode = active ? (mode | bit) : (mode & ~bit);
266 if (mode == WIFI_MODE_NULL) {
267 if (wifi_started) {
268 esp_exceptions(esp_wifi_stop());
269 wifi_started = false;
270 }
271 } else {
272 esp_exceptions(esp_wifi_set_mode(mode));
273 if (!wifi_started) {
274 esp_exceptions(esp_wifi_start());
275 wifi_started = true;
276 }
277 }
Glenn Moloneydbced752023-07-01 13:54:44 +1000278
279 // Wait for the interface to be in the correct state.
280 while (self->active != active) {
281 MICROPY_EVENT_POLL_HOOK;
282 }
Damien Georgeea186de2021-09-22 00:35:46 +1000283 }
284
285 return (mode & bit) ? mp_const_true : mp_const_false;
286}
287STATIC MP_DEFINE_CONST_FUN_OBJ_VAR_BETWEEN(network_wlan_active_obj, 1, 2, network_wlan_active);
288
289STATIC mp_obj_t network_wlan_connect(size_t n_args, const mp_obj_t *pos_args, mp_map_t *kw_args) {
iabdalkadera7c7feb2022-06-04 12:22:55 +0200290 enum { ARG_ssid, ARG_key, ARG_bssid };
Damien Georgeea186de2021-09-22 00:35:46 +1000291 static const mp_arg_t allowed_args[] = {
292 { MP_QSTR_, MP_ARG_OBJ, {.u_obj = mp_const_none} },
293 { MP_QSTR_, MP_ARG_OBJ, {.u_obj = mp_const_none} },
294 { MP_QSTR_bssid, MP_ARG_KW_ONLY | MP_ARG_OBJ, {.u_obj = mp_const_none} },
295 };
296
297 // parse args
298 mp_arg_val_t args[MP_ARRAY_SIZE(allowed_args)];
299 mp_arg_parse_all(n_args - 1, pos_args + 1, kw_args, MP_ARRAY_SIZE(allowed_args), allowed_args, args);
300
301 wifi_config_t wifi_sta_config = {0};
302
303 // configure any parameters that are given
304 if (n_args > 1) {
305 size_t len;
306 const char *p;
307 if (args[ARG_ssid].u_obj != mp_const_none) {
308 p = mp_obj_str_get_data(args[ARG_ssid].u_obj, &len);
309 memcpy(wifi_sta_config.sta.ssid, p, MIN(len, sizeof(wifi_sta_config.sta.ssid)));
310 }
iabdalkadera7c7feb2022-06-04 12:22:55 +0200311 if (args[ARG_key].u_obj != mp_const_none) {
312 p = mp_obj_str_get_data(args[ARG_key].u_obj, &len);
Damien Georgeea186de2021-09-22 00:35:46 +1000313 memcpy(wifi_sta_config.sta.password, p, MIN(len, sizeof(wifi_sta_config.sta.password)));
314 }
315 if (args[ARG_bssid].u_obj != mp_const_none) {
316 p = mp_obj_str_get_data(args[ARG_bssid].u_obj, &len);
317 if (len != sizeof(wifi_sta_config.sta.bssid)) {
318 mp_raise_ValueError(NULL);
319 }
320 wifi_sta_config.sta.bssid_set = 1;
321 memcpy(wifi_sta_config.sta.bssid, p, sizeof(wifi_sta_config.sta.bssid));
322 }
323 esp_exceptions(esp_wifi_set_config(ESP_IF_WIFI_STA, &wifi_sta_config));
324 }
325
Jim Mussared65a3ce32023-10-03 13:32:48 +1100326 esp_exceptions(esp_netif_set_hostname(wlan_sta_obj.netif, mod_network_hostname_data));
Jim Mussaredeb51ca42023-02-01 14:20:45 +1100327
Damien Georgeea186de2021-09-22 00:35:46 +1000328 wifi_sta_reconnects = 0;
329 // connect to the WiFi AP
330 MP_THREAD_GIL_EXIT();
331 esp_exceptions(esp_wifi_connect());
332 MP_THREAD_GIL_ENTER();
333 wifi_sta_connect_requested = true;
334
335 return mp_const_none;
336}
337STATIC MP_DEFINE_CONST_FUN_OBJ_KW(network_wlan_connect_obj, 1, network_wlan_connect);
338
339STATIC mp_obj_t network_wlan_disconnect(mp_obj_t self_in) {
340 wifi_sta_connect_requested = false;
341 esp_exceptions(esp_wifi_disconnect());
342 return mp_const_none;
343}
344STATIC MP_DEFINE_CONST_FUN_OBJ_1(network_wlan_disconnect_obj, network_wlan_disconnect);
345
346STATIC mp_obj_t network_wlan_status(size_t n_args, const mp_obj_t *args) {
347 wlan_if_obj_t *self = MP_OBJ_TO_PTR(args[0]);
348 if (n_args == 1) {
Damien Georgee4650122023-05-09 09:52:54 +1000349 if (self->if_id == ESP_IF_WIFI_STA) {
Damien Georgeea186de2021-09-22 00:35:46 +1000350 // Case of no arg is only for the STA interface
351 if (wifi_sta_connected) {
352 // Happy path, connected with IP
353 return MP_OBJ_NEW_SMALL_INT(STAT_GOT_IP);
354 } else if (wifi_sta_connect_requested
355 && (conf_wifi_sta_reconnects == 0
356 || wifi_sta_reconnects < conf_wifi_sta_reconnects)) {
357 // No connection or error, but is requested = Still connecting
358 return MP_OBJ_NEW_SMALL_INT(STAT_CONNECTING);
359 } else if (wifi_sta_disconn_reason == 0) {
360 // No activity, No error = Idle
361 return MP_OBJ_NEW_SMALL_INT(STAT_IDLE);
362 } else {
363 // Simply pass the error through from ESP-identifier
364 return MP_OBJ_NEW_SMALL_INT(wifi_sta_disconn_reason);
365 }
366 }
367 return mp_const_none;
368 }
369
370 // one argument: return status based on query parameter
371 switch ((uintptr_t)args[1]) {
372 case (uintptr_t)MP_OBJ_NEW_QSTR(MP_QSTR_stations): {
373 // return list of connected stations, only if in soft-AP mode
Damien Georgee4650122023-05-09 09:52:54 +1000374 require_if(args[0], ESP_IF_WIFI_AP);
Damien Georgeea186de2021-09-22 00:35:46 +1000375 wifi_sta_list_t station_list;
376 esp_exceptions(esp_wifi_ap_get_sta_list(&station_list));
377 wifi_sta_info_t *stations = (wifi_sta_info_t *)station_list.sta;
378 mp_obj_t list = mp_obj_new_list(0, NULL);
379 for (int i = 0; i < station_list.num; ++i) {
380 mp_obj_tuple_t *t = mp_obj_new_tuple(1, NULL);
381 t->items[0] = mp_obj_new_bytes(stations[i].mac, sizeof(stations[i].mac));
382 mp_obj_list_append(list, t);
383 }
384 return list;
385 }
386 case (uintptr_t)MP_OBJ_NEW_QSTR(MP_QSTR_rssi): {
387 // return signal of AP, only in STA mode
Damien Georgee4650122023-05-09 09:52:54 +1000388 require_if(args[0], ESP_IF_WIFI_STA);
Damien Georgeea186de2021-09-22 00:35:46 +1000389
390 wifi_ap_record_t info;
391 esp_exceptions(esp_wifi_sta_get_ap_info(&info));
392 return MP_OBJ_NEW_SMALL_INT(info.rssi);
393 }
394 default:
395 mp_raise_ValueError(MP_ERROR_TEXT("unknown status param"));
396 }
397
398 return mp_const_none;
399}
400STATIC MP_DEFINE_CONST_FUN_OBJ_VAR_BETWEEN(network_wlan_status_obj, 1, 2, network_wlan_status);
401
402STATIC mp_obj_t network_wlan_scan(mp_obj_t self_in) {
403 // check that STA mode is active
404 wifi_mode_t mode;
405 esp_exceptions(esp_wifi_get_mode(&mode));
406 if ((mode & WIFI_MODE_STA) == 0) {
407 mp_raise_msg(&mp_type_OSError, MP_ERROR_TEXT("STA must be active"));
408 }
409
410 mp_obj_t list = mp_obj_new_list(0, NULL);
411 wifi_scan_config_t config = { 0 };
412 config.show_hidden = true;
413 MP_THREAD_GIL_EXIT();
414 esp_err_t status = esp_wifi_scan_start(&config, 1);
415 MP_THREAD_GIL_ENTER();
416 if (status == 0) {
417 uint16_t count = 0;
418 esp_exceptions(esp_wifi_scan_get_ap_num(&count));
Damien Georgeccaf1972022-06-28 13:15:10 +1000419 if (count == 0) {
420 // esp_wifi_scan_get_ap_records must be called to free internal buffers from the scan.
421 // But it returns an error if wifi_ap_records==NULL. So allocate at least 1 AP entry.
422 // esp_wifi_scan_get_ap_records will then return the actual number of APs in count.
423 count = 1;
424 }
Damien Georgeea186de2021-09-22 00:35:46 +1000425 wifi_ap_record_t *wifi_ap_records = calloc(count, sizeof(wifi_ap_record_t));
426 esp_exceptions(esp_wifi_scan_get_ap_records(&count, wifi_ap_records));
427 for (uint16_t i = 0; i < count; i++) {
428 mp_obj_tuple_t *t = mp_obj_new_tuple(6, NULL);
429 uint8_t *x = memchr(wifi_ap_records[i].ssid, 0, sizeof(wifi_ap_records[i].ssid));
430 int ssid_len = x ? x - wifi_ap_records[i].ssid : sizeof(wifi_ap_records[i].ssid);
431 t->items[0] = mp_obj_new_bytes(wifi_ap_records[i].ssid, ssid_len);
432 t->items[1] = mp_obj_new_bytes(wifi_ap_records[i].bssid, sizeof(wifi_ap_records[i].bssid));
433 t->items[2] = MP_OBJ_NEW_SMALL_INT(wifi_ap_records[i].primary);
434 t->items[3] = MP_OBJ_NEW_SMALL_INT(wifi_ap_records[i].rssi);
435 t->items[4] = MP_OBJ_NEW_SMALL_INT(wifi_ap_records[i].authmode);
436 t->items[5] = mp_const_false; // XXX hidden?
437 mp_obj_list_append(list, MP_OBJ_FROM_PTR(t));
438 }
439 free(wifi_ap_records);
440 }
441 return list;
442}
443STATIC MP_DEFINE_CONST_FUN_OBJ_1(network_wlan_scan_obj, network_wlan_scan);
444
445STATIC mp_obj_t network_wlan_isconnected(mp_obj_t self_in) {
446 wlan_if_obj_t *self = MP_OBJ_TO_PTR(self_in);
Damien Georgee4650122023-05-09 09:52:54 +1000447 if (self->if_id == ESP_IF_WIFI_STA) {
Damien Georgeea186de2021-09-22 00:35:46 +1000448 return mp_obj_new_bool(wifi_sta_connected);
449 } else {
450 wifi_sta_list_t sta;
451 esp_wifi_ap_get_sta_list(&sta);
452 return mp_obj_new_bool(sta.num != 0);
453 }
454}
455STATIC MP_DEFINE_CONST_FUN_OBJ_1(network_wlan_isconnected_obj, network_wlan_isconnected);
456
457STATIC mp_obj_t network_wlan_config(size_t n_args, const mp_obj_t *args, mp_map_t *kwargs) {
458 if (n_args != 1 && kwargs->used != 0) {
459 mp_raise_TypeError(MP_ERROR_TEXT("either pos or kw args are allowed"));
460 }
461
462 wlan_if_obj_t *self = MP_OBJ_TO_PTR(args[0]);
463
Damien Georgee4650122023-05-09 09:52:54 +1000464 bool is_wifi = self->if_id == ESP_IF_WIFI_AP || self->if_id == ESP_IF_WIFI_STA;
Damien Georgeea186de2021-09-22 00:35:46 +1000465
466 wifi_config_t cfg;
467 if (is_wifi) {
468 esp_exceptions(esp_wifi_get_config(self->if_id, &cfg));
469 }
470
Damien Georgeea186de2021-09-22 00:35:46 +1000471 if (kwargs->used != 0) {
472 if (!is_wifi) {
473 goto unknown;
474 }
475
476 for (size_t i = 0; i < kwargs->alloc; i++) {
477 if (mp_map_slot_is_filled(kwargs, i)) {
478 int req_if = -1;
479
Damien George5adb1fa2021-12-10 23:28:46 +1100480 switch (mp_obj_str_get_qstr(kwargs->table[i].key)) {
481 case MP_QSTR_mac: {
Damien Georgeea186de2021-09-22 00:35:46 +1000482 mp_buffer_info_t bufinfo;
483 mp_get_buffer_raise(kwargs->table[i].value, &bufinfo, MP_BUFFER_READ);
484 if (bufinfo.len != 6) {
485 mp_raise_ValueError(MP_ERROR_TEXT("invalid buffer length"));
486 }
487 esp_exceptions(esp_wifi_set_mac(self->if_id, bufinfo.buf));
488 break;
489 }
iabdalkadera7c7feb2022-06-04 12:22:55 +0200490 case MP_QSTR_ssid:
Damien George5adb1fa2021-12-10 23:28:46 +1100491 case MP_QSTR_essid: {
Damien Georgee4650122023-05-09 09:52:54 +1000492 req_if = ESP_IF_WIFI_AP;
Damien Georgeea186de2021-09-22 00:35:46 +1000493 size_t len;
494 const char *s = mp_obj_str_get_data(kwargs->table[i].value, &len);
495 len = MIN(len, sizeof(cfg.ap.ssid));
496 memcpy(cfg.ap.ssid, s, len);
497 cfg.ap.ssid_len = len;
498 break;
499 }
Damien George5adb1fa2021-12-10 23:28:46 +1100500 case MP_QSTR_hidden: {
Damien Georgee4650122023-05-09 09:52:54 +1000501 req_if = ESP_IF_WIFI_AP;
Damien Georgeea186de2021-09-22 00:35:46 +1000502 cfg.ap.ssid_hidden = mp_obj_is_true(kwargs->table[i].value);
503 break;
504 }
iabdalkadera7c7feb2022-06-04 12:22:55 +0200505 case MP_QSTR_security:
Damien George5adb1fa2021-12-10 23:28:46 +1100506 case MP_QSTR_authmode: {
Damien Georgee4650122023-05-09 09:52:54 +1000507 req_if = ESP_IF_WIFI_AP;
Damien Georgeea186de2021-09-22 00:35:46 +1000508 cfg.ap.authmode = mp_obj_get_int(kwargs->table[i].value);
509 break;
510 }
iabdalkadera7c7feb2022-06-04 12:22:55 +0200511 case MP_QSTR_key:
Damien George5adb1fa2021-12-10 23:28:46 +1100512 case MP_QSTR_password: {
Damien Georgee4650122023-05-09 09:52:54 +1000513 req_if = ESP_IF_WIFI_AP;
Damien Georgeea186de2021-09-22 00:35:46 +1000514 size_t len;
515 const char *s = mp_obj_str_get_data(kwargs->table[i].value, &len);
516 len = MIN(len, sizeof(cfg.ap.password) - 1);
517 memcpy(cfg.ap.password, s, len);
518 cfg.ap.password[len] = 0;
519 break;
520 }
Damien George5adb1fa2021-12-10 23:28:46 +1100521 case MP_QSTR_channel: {
glenn2098d1c502022-07-31 16:36:10 +1000522 uint8_t primary;
523 wifi_second_chan_t secondary;
524 // Get the current value of secondary
525 esp_exceptions(esp_wifi_get_channel(&primary, &secondary));
526 primary = mp_obj_get_int(kwargs->table[i].value);
527 esp_err_t err = esp_wifi_set_channel(primary, secondary);
528 if (err == ESP_ERR_INVALID_ARG) {
529 // May need to swap secondary channel above to below or below to above
530 secondary = (
531 (secondary == WIFI_SECOND_CHAN_ABOVE)
532 ? WIFI_SECOND_CHAN_BELOW
533 : (secondary == WIFI_SECOND_CHAN_BELOW)
534 ? WIFI_SECOND_CHAN_ABOVE
535 : WIFI_SECOND_CHAN_NONE);
536 esp_exceptions(esp_wifi_set_channel(primary, secondary));
537 }
Damien Georgeea186de2021-09-22 00:35:46 +1000538 break;
539 }
IhorNehrutsa1ea82b62022-06-28 16:38:45 +0300540 case MP_QSTR_hostname:
Damien George5adb1fa2021-12-10 23:28:46 +1100541 case MP_QSTR_dhcp_hostname: {
Jim Mussaredeb51ca42023-02-01 14:20:45 +1100542 // TODO: Deprecated. Use network.hostname(name) instead.
Jim Mussared65a3ce32023-10-03 13:32:48 +1100543 mod_network_hostname(1, &kwargs->table[i].value);
Damien Georgeea186de2021-09-22 00:35:46 +1000544 break;
545 }
Damien George5adb1fa2021-12-10 23:28:46 +1100546 case MP_QSTR_max_clients: {
Damien Georgee4650122023-05-09 09:52:54 +1000547 req_if = ESP_IF_WIFI_AP;
Damien Georgeea186de2021-09-22 00:35:46 +1000548 cfg.ap.max_connection = mp_obj_get_int(kwargs->table[i].value);
549 break;
550 }
Damien George5adb1fa2021-12-10 23:28:46 +1100551 case MP_QSTR_reconnects: {
Damien Georgeea186de2021-09-22 00:35:46 +1000552 int reconnects = mp_obj_get_int(kwargs->table[i].value);
Damien Georgee4650122023-05-09 09:52:54 +1000553 req_if = ESP_IF_WIFI_STA;
Damien Georgeea186de2021-09-22 00:35:46 +1000554 // parameter reconnects == -1 means to retry forever.
555 // here means conf_wifi_sta_reconnects == 0 to retry forever.
556 conf_wifi_sta_reconnects = (reconnects == -1) ? 0 : reconnects + 1;
557 break;
558 }
wemosff28d2e2022-04-11 20:12:57 +0800559 case MP_QSTR_txpower: {
560 int8_t power = (mp_obj_get_float(kwargs->table[i].value) * 4);
561 esp_exceptions(esp_wifi_set_max_tx_power(power));
562 break;
563 }
glenn2076f2e3e2022-07-31 18:17:40 +1000564 case MP_QSTR_protocol: {
565 esp_exceptions(esp_wifi_set_protocol(self->if_id, mp_obj_get_int(kwargs->table[i].value)));
566 break;
567 }
glenn201093dea2022-08-25 16:55:57 +1000568 case MP_QSTR_pm: {
569 esp_exceptions(esp_wifi_set_ps(mp_obj_get_int(kwargs->table[i].value)));
570 break;
571 }
Damien Georgeea186de2021-09-22 00:35:46 +1000572 default:
573 goto unknown;
574 }
575
576 // We post-check interface requirements to save on code size
577 if (req_if >= 0) {
578 require_if(args[0], req_if);
579 }
580 }
581 }
582
583 esp_exceptions(esp_wifi_set_config(self->if_id, &cfg));
584
585 return mp_const_none;
586 }
587
588 // Get config
589
590 if (n_args != 2) {
591 mp_raise_TypeError(MP_ERROR_TEXT("can query only one param"));
592 }
593
594 int req_if = -1;
595 mp_obj_t val = mp_const_none;
596
Damien George5adb1fa2021-12-10 23:28:46 +1100597 switch (mp_obj_str_get_qstr(args[1])) {
598 case MP_QSTR_mac: {
Damien Georgeea186de2021-09-22 00:35:46 +1000599 uint8_t mac[6];
600 switch (self->if_id) {
Damien Georgee4650122023-05-09 09:52:54 +1000601 case ESP_IF_WIFI_AP: // fallthrough intentional
602 case ESP_IF_WIFI_STA:
Damien Georgeea186de2021-09-22 00:35:46 +1000603 esp_exceptions(esp_wifi_get_mac(self->if_id, mac));
604 return mp_obj_new_bytes(mac, sizeof(mac));
605 default:
606 goto unknown;
607 }
608 }
iabdalkadera7c7feb2022-06-04 12:22:55 +0200609 case MP_QSTR_ssid:
Damien George5adb1fa2021-12-10 23:28:46 +1100610 case MP_QSTR_essid:
Damien Georgeea186de2021-09-22 00:35:46 +1000611 switch (self->if_id) {
Damien Georgee4650122023-05-09 09:52:54 +1000612 case ESP_IF_WIFI_STA:
Damien Georgeea186de2021-09-22 00:35:46 +1000613 val = mp_obj_new_str((char *)cfg.sta.ssid, strlen((char *)cfg.sta.ssid));
614 break;
Damien Georgee4650122023-05-09 09:52:54 +1000615 case ESP_IF_WIFI_AP:
Damien Georgeea186de2021-09-22 00:35:46 +1000616 val = mp_obj_new_str((char *)cfg.ap.ssid, cfg.ap.ssid_len);
617 break;
618 default:
Damien Georgee4650122023-05-09 09:52:54 +1000619 req_if = ESP_IF_WIFI_AP;
Damien Georgeea186de2021-09-22 00:35:46 +1000620 }
621 break;
Damien George5adb1fa2021-12-10 23:28:46 +1100622 case MP_QSTR_hidden:
Damien Georgee4650122023-05-09 09:52:54 +1000623 req_if = ESP_IF_WIFI_AP;
Damien Georgeea186de2021-09-22 00:35:46 +1000624 val = mp_obj_new_bool(cfg.ap.ssid_hidden);
625 break;
iabdalkadera7c7feb2022-06-04 12:22:55 +0200626 case MP_QSTR_security:
Damien George5adb1fa2021-12-10 23:28:46 +1100627 case MP_QSTR_authmode:
Damien Georgee4650122023-05-09 09:52:54 +1000628 req_if = ESP_IF_WIFI_AP;
Damien Georgeea186de2021-09-22 00:35:46 +1000629 val = MP_OBJ_NEW_SMALL_INT(cfg.ap.authmode);
630 break;
glenn2098d1c502022-07-31 16:36:10 +1000631 case MP_QSTR_channel: {
632 uint8_t channel;
633 wifi_second_chan_t second;
634 esp_exceptions(esp_wifi_get_channel(&channel, &second));
635 val = MP_OBJ_NEW_SMALL_INT(channel);
Damien Georgeea186de2021-09-22 00:35:46 +1000636 break;
glenn2098d1c502022-07-31 16:36:10 +1000637 }
Daniƫl van de Giessenba8aad32023-07-04 15:36:37 +0200638 case MP_QSTR_ifname: {
639 val = esp_ifname(self->netif);
640 break;
641 }
IhorNehrutsa1ea82b62022-06-28 16:38:45 +0300642 case MP_QSTR_hostname:
Damien George5adb1fa2021-12-10 23:28:46 +1100643 case MP_QSTR_dhcp_hostname: {
Jim Mussaredeb51ca42023-02-01 14:20:45 +1100644 // TODO: Deprecated. Use network.hostname() instead.
Damien Georgee4650122023-05-09 09:52:54 +1000645 req_if = ESP_IF_WIFI_STA;
Jim Mussared65a3ce32023-10-03 13:32:48 +1100646 val = mod_network_hostname(0, NULL);
Damien Georgeea186de2021-09-22 00:35:46 +1000647 break;
648 }
Damien George5adb1fa2021-12-10 23:28:46 +1100649 case MP_QSTR_max_clients: {
Damien Georgeea186de2021-09-22 00:35:46 +1000650 val = MP_OBJ_NEW_SMALL_INT(cfg.ap.max_connection);
651 break;
652 }
Damien George5adb1fa2021-12-10 23:28:46 +1100653 case MP_QSTR_reconnects:
Damien Georgee4650122023-05-09 09:52:54 +1000654 req_if = ESP_IF_WIFI_STA;
Damien Georgeea186de2021-09-22 00:35:46 +1000655 int rec = conf_wifi_sta_reconnects - 1;
656 val = MP_OBJ_NEW_SMALL_INT(rec);
657 break;
wemosff28d2e2022-04-11 20:12:57 +0800658 case MP_QSTR_txpower: {
659 int8_t power;
660 esp_exceptions(esp_wifi_get_max_tx_power(&power));
661 val = mp_obj_new_float(power * 0.25);
662 break;
663 }
glenn2076f2e3e2022-07-31 18:17:40 +1000664 case MP_QSTR_protocol: {
665 uint8_t protocol_bitmap;
666 esp_exceptions(esp_wifi_get_protocol(self->if_id, &protocol_bitmap));
667 val = MP_OBJ_NEW_SMALL_INT(protocol_bitmap);
668 break;
669 }
glenn201093dea2022-08-25 16:55:57 +1000670 case MP_QSTR_pm: {
671 wifi_ps_type_t ps_type;
672 esp_exceptions(esp_wifi_get_ps(&ps_type));
673 val = MP_OBJ_NEW_SMALL_INT(ps_type);
674 break;
675 }
Damien Georgeea186de2021-09-22 00:35:46 +1000676 default:
677 goto unknown;
678 }
679
Damien Georgeea186de2021-09-22 00:35:46 +1000680 // We post-check interface requirements to save on code size
681 if (req_if >= 0) {
682 require_if(args[0], req_if);
683 }
684
685 return val;
686
687unknown:
688 mp_raise_ValueError(MP_ERROR_TEXT("unknown config param"));
689}
690MP_DEFINE_CONST_FUN_OBJ_KW(network_wlan_config_obj, 1, network_wlan_config);
691
692STATIC const mp_rom_map_elem_t wlan_if_locals_dict_table[] = {
693 { MP_ROM_QSTR(MP_QSTR_active), MP_ROM_PTR(&network_wlan_active_obj) },
694 { MP_ROM_QSTR(MP_QSTR_connect), MP_ROM_PTR(&network_wlan_connect_obj) },
695 { MP_ROM_QSTR(MP_QSTR_disconnect), MP_ROM_PTR(&network_wlan_disconnect_obj) },
696 { MP_ROM_QSTR(MP_QSTR_status), MP_ROM_PTR(&network_wlan_status_obj) },
697 { MP_ROM_QSTR(MP_QSTR_scan), MP_ROM_PTR(&network_wlan_scan_obj) },
698 { MP_ROM_QSTR(MP_QSTR_isconnected), MP_ROM_PTR(&network_wlan_isconnected_obj) },
699 { MP_ROM_QSTR(MP_QSTR_config), MP_ROM_PTR(&network_wlan_config_obj) },
Jim Mussaredeb51ca42023-02-01 14:20:45 +1100700 { MP_ROM_QSTR(MP_QSTR_ifconfig), MP_ROM_PTR(&esp_network_ifconfig_obj) },
glenn201093dea2022-08-25 16:55:57 +1000701
702 // Constants
703 { MP_ROM_QSTR(MP_QSTR_PM_NONE), MP_ROM_INT(WIFI_PS_NONE) },
704 { MP_ROM_QSTR(MP_QSTR_PM_PERFORMANCE), MP_ROM_INT(WIFI_PS_MIN_MODEM) },
705 { MP_ROM_QSTR(MP_QSTR_PM_POWERSAVE), MP_ROM_INT(WIFI_PS_MAX_MODEM) },
Damien Georgeea186de2021-09-22 00:35:46 +1000706};
707STATIC MP_DEFINE_CONST_DICT(wlan_if_locals_dict, wlan_if_locals_dict_table);
708
Jim Mussared662b9762021-07-14 14:38:38 +1000709MP_DEFINE_CONST_OBJ_TYPE(
Damien George53cb0732023-05-11 11:51:02 +1000710 esp_network_wlan_type,
Jim Mussared662b9762021-07-14 14:38:38 +1000711 MP_QSTR_WLAN,
712 MP_TYPE_FLAG_NONE,
Damien George53cb0732023-05-11 11:51:02 +1000713 make_new, network_wlan_make_new,
Jim Mussared9dce8272022-06-24 16:27:46 +1000714 locals_dict, &wlan_if_locals_dict
Jim Mussared662b9762021-07-14 14:38:38 +1000715 );
716
Damien Georgeea186de2021-09-22 00:35:46 +1000717#endif // MICROPY_PY_NETWORK_WLAN