blob: 8287731c31b8902f397361007aee1876fd8afa36 [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"
Damien Georgeea186de2021-09-22 00:35:46 +100044
Carlosgg1f355762023-06-25 22:48:39 +010045#ifndef NO_QSTR
46#include "mdns.h"
47#endif
48
Damien Georgeea186de2021-09-22 00:35:46 +100049#if MICROPY_PY_NETWORK_WLAN
50
51#if (WIFI_MODE_STA & WIFI_MODE_AP != WIFI_MODE_NULL || WIFI_MODE_STA | WIFI_MODE_AP != WIFI_MODE_APSTA)
52#error WIFI_MODE_STA and WIFI_MODE_AP are supposed to be bitfields!
53#endif
54
Damien Georgee4650122023-05-09 09:52:54 +100055typedef base_if_obj_t wlan_if_obj_t;
56
57STATIC wlan_if_obj_t wlan_sta_obj;
58STATIC wlan_if_obj_t wlan_ap_obj;
Damien Georgeea186de2021-09-22 00:35:46 +100059
60// Set to "true" if esp_wifi_start() was called
61static bool wifi_started = false;
62
63// Set to "true" if the STA interface is requested to be connected by the
64// user, used for automatic reassociation.
65static bool wifi_sta_connect_requested = false;
66
67// Set to "true" if the STA interface is connected to wifi and has IP address.
68static bool wifi_sta_connected = false;
69
70// Store the current status. 0 means None here, safe to do so as first enum value is WIFI_REASON_UNSPECIFIED=1.
71static uint8_t wifi_sta_disconn_reason = 0;
72
73#if MICROPY_HW_ENABLE_MDNS_QUERIES || MICROPY_HW_ENABLE_MDNS_RESPONDER
74// Whether mDNS has been initialised or not
75static bool mdns_initialised = false;
76#endif
77
78static uint8_t conf_wifi_sta_reconnects = 0;
Glenn Moloneydbced752023-07-01 13:54:44 +100079static uint8_t wifi_sta_reconnects;
Damien Georgeea186de2021-09-22 00:35:46 +100080
81// This function is called by the system-event task and so runs in a different
82// thread to the main MicroPython task. It must not raise any Python exceptions.
Damien Georgee4650122023-05-09 09:52:54 +100083static void network_wlan_wifi_event_handler(void *event_handler_arg, esp_event_base_t event_base, int32_t event_id, void *event_data) {
84 switch (event_id) {
85 case WIFI_EVENT_STA_START:
Damien Georgeea186de2021-09-22 00:35:46 +100086 ESP_LOGI("wifi", "STA_START");
Glenn Moloneydbced752023-07-01 13:54:44 +100087 wlan_sta_obj.active = true;
Damien Georgeea186de2021-09-22 00:35:46 +100088 wifi_sta_reconnects = 0;
89 break;
Damien Georgee4650122023-05-09 09:52:54 +100090
Glenn Moloneydbced752023-07-01 13:54:44 +100091 case WIFI_EVENT_STA_STOP:
92 wlan_sta_obj.active = false;
93 break;
94
Damien Georgee4650122023-05-09 09:52:54 +100095 case WIFI_EVENT_STA_CONNECTED:
Damien Georgeea186de2021-09-22 00:35:46 +100096 ESP_LOGI("network", "CONNECTED");
97 break;
Damien Georgee4650122023-05-09 09:52:54 +100098
99 case WIFI_EVENT_STA_DISCONNECTED: {
Damien Georgeea186de2021-09-22 00:35:46 +1000100 // This is a workaround as ESP32 WiFi libs don't currently
101 // auto-reassociate.
Damien Georgee4650122023-05-09 09:52:54 +1000102
103 wifi_event_sta_disconnected_t *disconn = event_data;
Damien Georgeea186de2021-09-22 00:35:46 +1000104 char *message = "";
105 wifi_sta_disconn_reason = disconn->reason;
106 switch (disconn->reason) {
107 case WIFI_REASON_BEACON_TIMEOUT:
108 // AP has dropped out; try to reconnect.
109 message = "\nbeacon timeout";
110 break;
111 case WIFI_REASON_NO_AP_FOUND:
112 // AP may not exist, or it may have momentarily dropped out; try to reconnect.
113 message = "\nno AP found";
114 break;
115 case WIFI_REASON_AUTH_FAIL:
116 // Password may be wrong, or it just failed to connect; try to reconnect.
117 message = "\nauthentication failed";
118 break;
119 default:
120 // Let other errors through and try to reconnect.
121 break;
122 }
123 ESP_LOGI("wifi", "STA_DISCONNECTED, reason:%d%s", disconn->reason, message);
124
125 wifi_sta_connected = false;
126 if (wifi_sta_connect_requested) {
127 wifi_mode_t mode;
128 if (esp_wifi_get_mode(&mode) != ESP_OK) {
129 break;
130 }
131 if (!(mode & WIFI_MODE_STA)) {
132 break;
133 }
134 if (conf_wifi_sta_reconnects) {
135 ESP_LOGI("wifi", "reconnect counter=%d, max=%d",
136 wifi_sta_reconnects, conf_wifi_sta_reconnects);
137 if (++wifi_sta_reconnects >= conf_wifi_sta_reconnects) {
138 break;
139 }
140 }
141 esp_err_t e = esp_wifi_connect();
142 if (e != ESP_OK) {
143 ESP_LOGI("wifi", "error attempting to reconnect: 0x%04x", e);
144 }
145 }
146 break;
147 }
Glenn Moloneydbced752023-07-01 13:54:44 +1000148
149 case WIFI_EVENT_AP_START:
150 wlan_ap_obj.active = true;
151 break;
152
153 case WIFI_EVENT_AP_STOP:
154 wlan_ap_obj.active = false;
155 break;
156
Damien Georgeea186de2021-09-22 00:35:46 +1000157 default:
158 break;
159 }
160}
161
Damien Georgee4650122023-05-09 09:52:54 +1000162static void network_wlan_ip_event_handler(void *event_handler_arg, esp_event_base_t event_base, int32_t event_id, void *event_data) {
163 switch (event_id) {
164 case IP_EVENT_STA_GOT_IP:
165 ESP_LOGI("network", "GOT_IP");
166 wifi_sta_connected = true;
167 wifi_sta_disconn_reason = 0; // Success so clear error. (in case of new error will be replaced anyway)
168 #if MICROPY_HW_ENABLE_MDNS_QUERIES || MICROPY_HW_ENABLE_MDNS_RESPONDER
169 if (!mdns_initialised) {
170 mdns_init();
171 #if MICROPY_HW_ENABLE_MDNS_RESPONDER
172 mdns_hostname_set(mod_network_hostname);
173 mdns_instance_name_set(mod_network_hostname);
174 #endif
175 mdns_initialised = true;
176 }
177 #endif
178 break;
179
180 default:
181 break;
Damien Georgeea186de2021-09-22 00:35:46 +1000182 }
183}
184
Damien Georgee4650122023-05-09 09:52:54 +1000185STATIC void require_if(mp_obj_t wlan_if, int if_no) {
186 wlan_if_obj_t *self = MP_OBJ_TO_PTR(wlan_if);
187 if (self->if_id != if_no) {
188 mp_raise_msg(&mp_type_OSError, if_no == ESP_IF_WIFI_STA ? MP_ERROR_TEXT("STA required") : MP_ERROR_TEXT("AP required"));
189 }
190}
191
192void esp_initialise_wifi(void) {
Glenn Moloney7fa322a2020-09-24 15:37:04 +1000193 static int wifi_initialized = 0;
194 if (!wifi_initialized) {
Damien Georgee4650122023-05-09 09:52:54 +1000195 esp_exceptions(esp_event_handler_instance_register(WIFI_EVENT, ESP_EVENT_ANY_ID, network_wlan_wifi_event_handler, NULL, NULL));
196 esp_exceptions(esp_event_handler_instance_register(IP_EVENT, ESP_EVENT_ANY_ID, network_wlan_ip_event_handler, NULL, NULL));
197
198 wlan_sta_obj.base.type = &esp_network_wlan_type;
199 wlan_sta_obj.if_id = ESP_IF_WIFI_STA;
200 wlan_sta_obj.netif = esp_netif_create_default_wifi_sta();
Glenn Moloneydbced752023-07-01 13:54:44 +1000201 wlan_sta_obj.active = false;
Damien Georgee4650122023-05-09 09:52:54 +1000202
203 wlan_ap_obj.base.type = &esp_network_wlan_type;
204 wlan_ap_obj.if_id = ESP_IF_WIFI_AP;
205 wlan_ap_obj.netif = esp_netif_create_default_wifi_ap();
Glenn Moloneydbced752023-07-01 13:54:44 +1000206 wlan_ap_obj.active = false;
Damien Georgee4650122023-05-09 09:52:54 +1000207
Damien Georgeea186de2021-09-22 00:35:46 +1000208 wifi_init_config_t cfg = WIFI_INIT_CONFIG_DEFAULT();
209 ESP_LOGD("modnetwork", "Initializing WiFi");
210 esp_exceptions(esp_wifi_init(&cfg));
211 esp_exceptions(esp_wifi_set_storage(WIFI_STORAGE_RAM));
Damien Georgee4650122023-05-09 09:52:54 +1000212
Damien Georgeea186de2021-09-22 00:35:46 +1000213 ESP_LOGD("modnetwork", "Initialized");
Glenn Moloney7fa322a2020-09-24 15:37:04 +1000214 wifi_initialized = 1;
Damien Georgeea186de2021-09-22 00:35:46 +1000215 }
Glenn Moloney7fa322a2020-09-24 15:37:04 +1000216}
217
Damien George53cb0732023-05-11 11:51:02 +1000218STATIC 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) {
219 mp_arg_check_num(n_args, n_kw, 0, 1, false);
220
Glenn Moloney7fa322a2020-09-24 15:37:04 +1000221 esp_initialise_wifi();
Damien Georgeea186de2021-09-22 00:35:46 +1000222
Damien Georgee4650122023-05-09 09:52:54 +1000223 int idx = (n_args > 0) ? mp_obj_get_int(args[0]) : ESP_IF_WIFI_STA;
224 if (idx == ESP_IF_WIFI_STA) {
Damien Georgeea186de2021-09-22 00:35:46 +1000225 return MP_OBJ_FROM_PTR(&wlan_sta_obj);
Damien Georgee4650122023-05-09 09:52:54 +1000226 } else if (idx == ESP_IF_WIFI_AP) {
Damien Georgeea186de2021-09-22 00:35:46 +1000227 return MP_OBJ_FROM_PTR(&wlan_ap_obj);
228 } else {
229 mp_raise_ValueError(MP_ERROR_TEXT("invalid WLAN interface identifier"));
230 }
231}
Damien Georgeea186de2021-09-22 00:35:46 +1000232
233STATIC mp_obj_t network_wlan_active(size_t n_args, const mp_obj_t *args) {
234 wlan_if_obj_t *self = MP_OBJ_TO_PTR(args[0]);
235
236 wifi_mode_t mode;
237 if (!wifi_started) {
238 mode = WIFI_MODE_NULL;
239 } else {
240 esp_exceptions(esp_wifi_get_mode(&mode));
241 }
242
Damien Georgee4650122023-05-09 09:52:54 +1000243 int bit = (self->if_id == ESP_IF_WIFI_STA) ? WIFI_MODE_STA : WIFI_MODE_AP;
Damien Georgeea186de2021-09-22 00:35:46 +1000244
245 if (n_args > 1) {
246 bool active = mp_obj_is_true(args[1]);
247 mode = active ? (mode | bit) : (mode & ~bit);
248 if (mode == WIFI_MODE_NULL) {
249 if (wifi_started) {
250 esp_exceptions(esp_wifi_stop());
251 wifi_started = false;
252 }
253 } else {
254 esp_exceptions(esp_wifi_set_mode(mode));
255 if (!wifi_started) {
256 esp_exceptions(esp_wifi_start());
257 wifi_started = true;
258 }
259 }
Glenn Moloneydbced752023-07-01 13:54:44 +1000260
261 // Wait for the interface to be in the correct state.
262 while (self->active != active) {
263 MICROPY_EVENT_POLL_HOOK;
264 }
Damien Georgeea186de2021-09-22 00:35:46 +1000265 }
266
267 return (mode & bit) ? mp_const_true : mp_const_false;
268}
269STATIC MP_DEFINE_CONST_FUN_OBJ_VAR_BETWEEN(network_wlan_active_obj, 1, 2, network_wlan_active);
270
271STATIC 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 +0200272 enum { ARG_ssid, ARG_key, ARG_bssid };
Damien Georgeea186de2021-09-22 00:35:46 +1000273 static const mp_arg_t allowed_args[] = {
274 { MP_QSTR_, MP_ARG_OBJ, {.u_obj = mp_const_none} },
275 { MP_QSTR_, MP_ARG_OBJ, {.u_obj = mp_const_none} },
276 { MP_QSTR_bssid, MP_ARG_KW_ONLY | MP_ARG_OBJ, {.u_obj = mp_const_none} },
277 };
278
279 // parse args
280 mp_arg_val_t args[MP_ARRAY_SIZE(allowed_args)];
281 mp_arg_parse_all(n_args - 1, pos_args + 1, kw_args, MP_ARRAY_SIZE(allowed_args), allowed_args, args);
282
283 wifi_config_t wifi_sta_config = {0};
284
285 // configure any parameters that are given
286 if (n_args > 1) {
287 size_t len;
288 const char *p;
289 if (args[ARG_ssid].u_obj != mp_const_none) {
290 p = mp_obj_str_get_data(args[ARG_ssid].u_obj, &len);
291 memcpy(wifi_sta_config.sta.ssid, p, MIN(len, sizeof(wifi_sta_config.sta.ssid)));
292 }
iabdalkadera7c7feb2022-06-04 12:22:55 +0200293 if (args[ARG_key].u_obj != mp_const_none) {
294 p = mp_obj_str_get_data(args[ARG_key].u_obj, &len);
Damien Georgeea186de2021-09-22 00:35:46 +1000295 memcpy(wifi_sta_config.sta.password, p, MIN(len, sizeof(wifi_sta_config.sta.password)));
296 }
297 if (args[ARG_bssid].u_obj != mp_const_none) {
298 p = mp_obj_str_get_data(args[ARG_bssid].u_obj, &len);
299 if (len != sizeof(wifi_sta_config.sta.bssid)) {
300 mp_raise_ValueError(NULL);
301 }
302 wifi_sta_config.sta.bssid_set = 1;
303 memcpy(wifi_sta_config.sta.bssid, p, sizeof(wifi_sta_config.sta.bssid));
304 }
305 esp_exceptions(esp_wifi_set_config(ESP_IF_WIFI_STA, &wifi_sta_config));
306 }
307
Damien Georgee4650122023-05-09 09:52:54 +1000308 esp_exceptions(esp_netif_set_hostname(wlan_sta_obj.netif, mod_network_hostname));
Jim Mussaredeb51ca42023-02-01 14:20:45 +1100309
Damien Georgeea186de2021-09-22 00:35:46 +1000310 wifi_sta_reconnects = 0;
311 // connect to the WiFi AP
312 MP_THREAD_GIL_EXIT();
313 esp_exceptions(esp_wifi_connect());
314 MP_THREAD_GIL_ENTER();
315 wifi_sta_connect_requested = true;
316
317 return mp_const_none;
318}
319STATIC MP_DEFINE_CONST_FUN_OBJ_KW(network_wlan_connect_obj, 1, network_wlan_connect);
320
321STATIC mp_obj_t network_wlan_disconnect(mp_obj_t self_in) {
322 wifi_sta_connect_requested = false;
323 esp_exceptions(esp_wifi_disconnect());
324 return mp_const_none;
325}
326STATIC MP_DEFINE_CONST_FUN_OBJ_1(network_wlan_disconnect_obj, network_wlan_disconnect);
327
328STATIC mp_obj_t network_wlan_status(size_t n_args, const mp_obj_t *args) {
329 wlan_if_obj_t *self = MP_OBJ_TO_PTR(args[0]);
330 if (n_args == 1) {
Damien Georgee4650122023-05-09 09:52:54 +1000331 if (self->if_id == ESP_IF_WIFI_STA) {
Damien Georgeea186de2021-09-22 00:35:46 +1000332 // Case of no arg is only for the STA interface
333 if (wifi_sta_connected) {
334 // Happy path, connected with IP
335 return MP_OBJ_NEW_SMALL_INT(STAT_GOT_IP);
336 } else if (wifi_sta_connect_requested
337 && (conf_wifi_sta_reconnects == 0
338 || wifi_sta_reconnects < conf_wifi_sta_reconnects)) {
339 // No connection or error, but is requested = Still connecting
340 return MP_OBJ_NEW_SMALL_INT(STAT_CONNECTING);
341 } else if (wifi_sta_disconn_reason == 0) {
342 // No activity, No error = Idle
343 return MP_OBJ_NEW_SMALL_INT(STAT_IDLE);
344 } else {
345 // Simply pass the error through from ESP-identifier
346 return MP_OBJ_NEW_SMALL_INT(wifi_sta_disconn_reason);
347 }
348 }
349 return mp_const_none;
350 }
351
352 // one argument: return status based on query parameter
353 switch ((uintptr_t)args[1]) {
354 case (uintptr_t)MP_OBJ_NEW_QSTR(MP_QSTR_stations): {
355 // return list of connected stations, only if in soft-AP mode
Damien Georgee4650122023-05-09 09:52:54 +1000356 require_if(args[0], ESP_IF_WIFI_AP);
Damien Georgeea186de2021-09-22 00:35:46 +1000357 wifi_sta_list_t station_list;
358 esp_exceptions(esp_wifi_ap_get_sta_list(&station_list));
359 wifi_sta_info_t *stations = (wifi_sta_info_t *)station_list.sta;
360 mp_obj_t list = mp_obj_new_list(0, NULL);
361 for (int i = 0; i < station_list.num; ++i) {
362 mp_obj_tuple_t *t = mp_obj_new_tuple(1, NULL);
363 t->items[0] = mp_obj_new_bytes(stations[i].mac, sizeof(stations[i].mac));
364 mp_obj_list_append(list, t);
365 }
366 return list;
367 }
368 case (uintptr_t)MP_OBJ_NEW_QSTR(MP_QSTR_rssi): {
369 // return signal of AP, only in STA mode
Damien Georgee4650122023-05-09 09:52:54 +1000370 require_if(args[0], ESP_IF_WIFI_STA);
Damien Georgeea186de2021-09-22 00:35:46 +1000371
372 wifi_ap_record_t info;
373 esp_exceptions(esp_wifi_sta_get_ap_info(&info));
374 return MP_OBJ_NEW_SMALL_INT(info.rssi);
375 }
376 default:
377 mp_raise_ValueError(MP_ERROR_TEXT("unknown status param"));
378 }
379
380 return mp_const_none;
381}
382STATIC MP_DEFINE_CONST_FUN_OBJ_VAR_BETWEEN(network_wlan_status_obj, 1, 2, network_wlan_status);
383
384STATIC mp_obj_t network_wlan_scan(mp_obj_t self_in) {
385 // check that STA mode is active
386 wifi_mode_t mode;
387 esp_exceptions(esp_wifi_get_mode(&mode));
388 if ((mode & WIFI_MODE_STA) == 0) {
389 mp_raise_msg(&mp_type_OSError, MP_ERROR_TEXT("STA must be active"));
390 }
391
392 mp_obj_t list = mp_obj_new_list(0, NULL);
393 wifi_scan_config_t config = { 0 };
394 config.show_hidden = true;
395 MP_THREAD_GIL_EXIT();
396 esp_err_t status = esp_wifi_scan_start(&config, 1);
397 MP_THREAD_GIL_ENTER();
398 if (status == 0) {
399 uint16_t count = 0;
400 esp_exceptions(esp_wifi_scan_get_ap_num(&count));
Damien Georgeccaf1972022-06-28 13:15:10 +1000401 if (count == 0) {
402 // esp_wifi_scan_get_ap_records must be called to free internal buffers from the scan.
403 // But it returns an error if wifi_ap_records==NULL. So allocate at least 1 AP entry.
404 // esp_wifi_scan_get_ap_records will then return the actual number of APs in count.
405 count = 1;
406 }
Damien Georgeea186de2021-09-22 00:35:46 +1000407 wifi_ap_record_t *wifi_ap_records = calloc(count, sizeof(wifi_ap_record_t));
408 esp_exceptions(esp_wifi_scan_get_ap_records(&count, wifi_ap_records));
409 for (uint16_t i = 0; i < count; i++) {
410 mp_obj_tuple_t *t = mp_obj_new_tuple(6, NULL);
411 uint8_t *x = memchr(wifi_ap_records[i].ssid, 0, sizeof(wifi_ap_records[i].ssid));
412 int ssid_len = x ? x - wifi_ap_records[i].ssid : sizeof(wifi_ap_records[i].ssid);
413 t->items[0] = mp_obj_new_bytes(wifi_ap_records[i].ssid, ssid_len);
414 t->items[1] = mp_obj_new_bytes(wifi_ap_records[i].bssid, sizeof(wifi_ap_records[i].bssid));
415 t->items[2] = MP_OBJ_NEW_SMALL_INT(wifi_ap_records[i].primary);
416 t->items[3] = MP_OBJ_NEW_SMALL_INT(wifi_ap_records[i].rssi);
417 t->items[4] = MP_OBJ_NEW_SMALL_INT(wifi_ap_records[i].authmode);
418 t->items[5] = mp_const_false; // XXX hidden?
419 mp_obj_list_append(list, MP_OBJ_FROM_PTR(t));
420 }
421 free(wifi_ap_records);
422 }
423 return list;
424}
425STATIC MP_DEFINE_CONST_FUN_OBJ_1(network_wlan_scan_obj, network_wlan_scan);
426
427STATIC mp_obj_t network_wlan_isconnected(mp_obj_t self_in) {
428 wlan_if_obj_t *self = MP_OBJ_TO_PTR(self_in);
Damien Georgee4650122023-05-09 09:52:54 +1000429 if (self->if_id == ESP_IF_WIFI_STA) {
Damien Georgeea186de2021-09-22 00:35:46 +1000430 return mp_obj_new_bool(wifi_sta_connected);
431 } else {
432 wifi_sta_list_t sta;
433 esp_wifi_ap_get_sta_list(&sta);
434 return mp_obj_new_bool(sta.num != 0);
435 }
436}
437STATIC MP_DEFINE_CONST_FUN_OBJ_1(network_wlan_isconnected_obj, network_wlan_isconnected);
438
439STATIC mp_obj_t network_wlan_config(size_t n_args, const mp_obj_t *args, mp_map_t *kwargs) {
440 if (n_args != 1 && kwargs->used != 0) {
441 mp_raise_TypeError(MP_ERROR_TEXT("either pos or kw args are allowed"));
442 }
443
444 wlan_if_obj_t *self = MP_OBJ_TO_PTR(args[0]);
445
Damien Georgee4650122023-05-09 09:52:54 +1000446 bool is_wifi = self->if_id == ESP_IF_WIFI_AP || self->if_id == ESP_IF_WIFI_STA;
Damien Georgeea186de2021-09-22 00:35:46 +1000447
448 wifi_config_t cfg;
449 if (is_wifi) {
450 esp_exceptions(esp_wifi_get_config(self->if_id, &cfg));
451 }
452
Damien Georgeea186de2021-09-22 00:35:46 +1000453 if (kwargs->used != 0) {
454 if (!is_wifi) {
455 goto unknown;
456 }
457
458 for (size_t i = 0; i < kwargs->alloc; i++) {
459 if (mp_map_slot_is_filled(kwargs, i)) {
460 int req_if = -1;
461
Damien George5adb1fa2021-12-10 23:28:46 +1100462 switch (mp_obj_str_get_qstr(kwargs->table[i].key)) {
463 case MP_QSTR_mac: {
Damien Georgeea186de2021-09-22 00:35:46 +1000464 mp_buffer_info_t bufinfo;
465 mp_get_buffer_raise(kwargs->table[i].value, &bufinfo, MP_BUFFER_READ);
466 if (bufinfo.len != 6) {
467 mp_raise_ValueError(MP_ERROR_TEXT("invalid buffer length"));
468 }
469 esp_exceptions(esp_wifi_set_mac(self->if_id, bufinfo.buf));
470 break;
471 }
iabdalkadera7c7feb2022-06-04 12:22:55 +0200472 case MP_QSTR_ssid:
Damien George5adb1fa2021-12-10 23:28:46 +1100473 case MP_QSTR_essid: {
Damien Georgee4650122023-05-09 09:52:54 +1000474 req_if = ESP_IF_WIFI_AP;
Damien Georgeea186de2021-09-22 00:35:46 +1000475 size_t len;
476 const char *s = mp_obj_str_get_data(kwargs->table[i].value, &len);
477 len = MIN(len, sizeof(cfg.ap.ssid));
478 memcpy(cfg.ap.ssid, s, len);
479 cfg.ap.ssid_len = len;
480 break;
481 }
Damien George5adb1fa2021-12-10 23:28:46 +1100482 case MP_QSTR_hidden: {
Damien Georgee4650122023-05-09 09:52:54 +1000483 req_if = ESP_IF_WIFI_AP;
Damien Georgeea186de2021-09-22 00:35:46 +1000484 cfg.ap.ssid_hidden = mp_obj_is_true(kwargs->table[i].value);
485 break;
486 }
iabdalkadera7c7feb2022-06-04 12:22:55 +0200487 case MP_QSTR_security:
Damien George5adb1fa2021-12-10 23:28:46 +1100488 case MP_QSTR_authmode: {
Damien Georgee4650122023-05-09 09:52:54 +1000489 req_if = ESP_IF_WIFI_AP;
Damien Georgeea186de2021-09-22 00:35:46 +1000490 cfg.ap.authmode = mp_obj_get_int(kwargs->table[i].value);
491 break;
492 }
iabdalkadera7c7feb2022-06-04 12:22:55 +0200493 case MP_QSTR_key:
Damien George5adb1fa2021-12-10 23:28:46 +1100494 case MP_QSTR_password: {
Damien Georgee4650122023-05-09 09:52:54 +1000495 req_if = ESP_IF_WIFI_AP;
Damien Georgeea186de2021-09-22 00:35:46 +1000496 size_t len;
497 const char *s = mp_obj_str_get_data(kwargs->table[i].value, &len);
498 len = MIN(len, sizeof(cfg.ap.password) - 1);
499 memcpy(cfg.ap.password, s, len);
500 cfg.ap.password[len] = 0;
501 break;
502 }
Damien George5adb1fa2021-12-10 23:28:46 +1100503 case MP_QSTR_channel: {
glenn2098d1c502022-07-31 16:36:10 +1000504 uint8_t primary;
505 wifi_second_chan_t secondary;
506 // Get the current value of secondary
507 esp_exceptions(esp_wifi_get_channel(&primary, &secondary));
508 primary = mp_obj_get_int(kwargs->table[i].value);
509 esp_err_t err = esp_wifi_set_channel(primary, secondary);
510 if (err == ESP_ERR_INVALID_ARG) {
511 // May need to swap secondary channel above to below or below to above
512 secondary = (
513 (secondary == WIFI_SECOND_CHAN_ABOVE)
514 ? WIFI_SECOND_CHAN_BELOW
515 : (secondary == WIFI_SECOND_CHAN_BELOW)
516 ? WIFI_SECOND_CHAN_ABOVE
517 : WIFI_SECOND_CHAN_NONE);
518 esp_exceptions(esp_wifi_set_channel(primary, secondary));
519 }
Damien Georgeea186de2021-09-22 00:35:46 +1000520 break;
521 }
IhorNehrutsa1ea82b62022-06-28 16:38:45 +0300522 case MP_QSTR_hostname:
Damien George5adb1fa2021-12-10 23:28:46 +1100523 case MP_QSTR_dhcp_hostname: {
Jim Mussaredeb51ca42023-02-01 14:20:45 +1100524 // TODO: Deprecated. Use network.hostname(name) instead.
525 size_t len;
526 const char *str = mp_obj_str_get_data(kwargs->table[i].value, &len);
527 if (len >= MICROPY_PY_NETWORK_HOSTNAME_MAX_LEN) {
528 mp_raise_ValueError(NULL);
529 }
530 strcpy(mod_network_hostname, str);
Damien Georgeea186de2021-09-22 00:35:46 +1000531 break;
532 }
Damien George5adb1fa2021-12-10 23:28:46 +1100533 case MP_QSTR_max_clients: {
Damien Georgee4650122023-05-09 09:52:54 +1000534 req_if = ESP_IF_WIFI_AP;
Damien Georgeea186de2021-09-22 00:35:46 +1000535 cfg.ap.max_connection = mp_obj_get_int(kwargs->table[i].value);
536 break;
537 }
Damien George5adb1fa2021-12-10 23:28:46 +1100538 case MP_QSTR_reconnects: {
Damien Georgeea186de2021-09-22 00:35:46 +1000539 int reconnects = mp_obj_get_int(kwargs->table[i].value);
Damien Georgee4650122023-05-09 09:52:54 +1000540 req_if = ESP_IF_WIFI_STA;
Damien Georgeea186de2021-09-22 00:35:46 +1000541 // parameter reconnects == -1 means to retry forever.
542 // here means conf_wifi_sta_reconnects == 0 to retry forever.
543 conf_wifi_sta_reconnects = (reconnects == -1) ? 0 : reconnects + 1;
544 break;
545 }
wemosff28d2e2022-04-11 20:12:57 +0800546 case MP_QSTR_txpower: {
547 int8_t power = (mp_obj_get_float(kwargs->table[i].value) * 4);
548 esp_exceptions(esp_wifi_set_max_tx_power(power));
549 break;
550 }
glenn2076f2e3e2022-07-31 18:17:40 +1000551 case MP_QSTR_protocol: {
552 esp_exceptions(esp_wifi_set_protocol(self->if_id, mp_obj_get_int(kwargs->table[i].value)));
553 break;
554 }
glenn201093dea2022-08-25 16:55:57 +1000555 case MP_QSTR_pm: {
556 esp_exceptions(esp_wifi_set_ps(mp_obj_get_int(kwargs->table[i].value)));
557 break;
558 }
Damien Georgeea186de2021-09-22 00:35:46 +1000559 default:
560 goto unknown;
561 }
562
563 // We post-check interface requirements to save on code size
564 if (req_if >= 0) {
565 require_if(args[0], req_if);
566 }
567 }
568 }
569
570 esp_exceptions(esp_wifi_set_config(self->if_id, &cfg));
571
572 return mp_const_none;
573 }
574
575 // Get config
576
577 if (n_args != 2) {
578 mp_raise_TypeError(MP_ERROR_TEXT("can query only one param"));
579 }
580
581 int req_if = -1;
582 mp_obj_t val = mp_const_none;
583
Damien George5adb1fa2021-12-10 23:28:46 +1100584 switch (mp_obj_str_get_qstr(args[1])) {
585 case MP_QSTR_mac: {
Damien Georgeea186de2021-09-22 00:35:46 +1000586 uint8_t mac[6];
587 switch (self->if_id) {
Damien Georgee4650122023-05-09 09:52:54 +1000588 case ESP_IF_WIFI_AP: // fallthrough intentional
589 case ESP_IF_WIFI_STA:
Damien Georgeea186de2021-09-22 00:35:46 +1000590 esp_exceptions(esp_wifi_get_mac(self->if_id, mac));
591 return mp_obj_new_bytes(mac, sizeof(mac));
592 default:
593 goto unknown;
594 }
595 }
iabdalkadera7c7feb2022-06-04 12:22:55 +0200596 case MP_QSTR_ssid:
Damien George5adb1fa2021-12-10 23:28:46 +1100597 case MP_QSTR_essid:
Damien Georgeea186de2021-09-22 00:35:46 +1000598 switch (self->if_id) {
Damien Georgee4650122023-05-09 09:52:54 +1000599 case ESP_IF_WIFI_STA:
Damien Georgeea186de2021-09-22 00:35:46 +1000600 val = mp_obj_new_str((char *)cfg.sta.ssid, strlen((char *)cfg.sta.ssid));
601 break;
Damien Georgee4650122023-05-09 09:52:54 +1000602 case ESP_IF_WIFI_AP:
Damien Georgeea186de2021-09-22 00:35:46 +1000603 val = mp_obj_new_str((char *)cfg.ap.ssid, cfg.ap.ssid_len);
604 break;
605 default:
Damien Georgee4650122023-05-09 09:52:54 +1000606 req_if = ESP_IF_WIFI_AP;
Damien Georgeea186de2021-09-22 00:35:46 +1000607 }
608 break;
Damien George5adb1fa2021-12-10 23:28:46 +1100609 case MP_QSTR_hidden:
Damien Georgee4650122023-05-09 09:52:54 +1000610 req_if = ESP_IF_WIFI_AP;
Damien Georgeea186de2021-09-22 00:35:46 +1000611 val = mp_obj_new_bool(cfg.ap.ssid_hidden);
612 break;
iabdalkadera7c7feb2022-06-04 12:22:55 +0200613 case MP_QSTR_security:
Damien George5adb1fa2021-12-10 23:28:46 +1100614 case MP_QSTR_authmode:
Damien Georgee4650122023-05-09 09:52:54 +1000615 req_if = ESP_IF_WIFI_AP;
Damien Georgeea186de2021-09-22 00:35:46 +1000616 val = MP_OBJ_NEW_SMALL_INT(cfg.ap.authmode);
617 break;
glenn2098d1c502022-07-31 16:36:10 +1000618 case MP_QSTR_channel: {
619 uint8_t channel;
620 wifi_second_chan_t second;
621 esp_exceptions(esp_wifi_get_channel(&channel, &second));
622 val = MP_OBJ_NEW_SMALL_INT(channel);
Damien Georgeea186de2021-09-22 00:35:46 +1000623 break;
glenn2098d1c502022-07-31 16:36:10 +1000624 }
IhorNehrutsa1ea82b62022-06-28 16:38:45 +0300625 case MP_QSTR_hostname:
Damien George5adb1fa2021-12-10 23:28:46 +1100626 case MP_QSTR_dhcp_hostname: {
Jim Mussaredeb51ca42023-02-01 14:20:45 +1100627 // TODO: Deprecated. Use network.hostname() instead.
Damien Georgee4650122023-05-09 09:52:54 +1000628 req_if = ESP_IF_WIFI_STA;
Jim Mussaredeb51ca42023-02-01 14:20:45 +1100629 val = mp_obj_new_str(mod_network_hostname, strlen(mod_network_hostname));
Damien Georgeea186de2021-09-22 00:35:46 +1000630 break;
631 }
Damien George5adb1fa2021-12-10 23:28:46 +1100632 case MP_QSTR_max_clients: {
Damien Georgeea186de2021-09-22 00:35:46 +1000633 val = MP_OBJ_NEW_SMALL_INT(cfg.ap.max_connection);
634 break;
635 }
Damien George5adb1fa2021-12-10 23:28:46 +1100636 case MP_QSTR_reconnects:
Damien Georgee4650122023-05-09 09:52:54 +1000637 req_if = ESP_IF_WIFI_STA;
Damien Georgeea186de2021-09-22 00:35:46 +1000638 int rec = conf_wifi_sta_reconnects - 1;
639 val = MP_OBJ_NEW_SMALL_INT(rec);
640 break;
wemosff28d2e2022-04-11 20:12:57 +0800641 case MP_QSTR_txpower: {
642 int8_t power;
643 esp_exceptions(esp_wifi_get_max_tx_power(&power));
644 val = mp_obj_new_float(power * 0.25);
645 break;
646 }
glenn2076f2e3e2022-07-31 18:17:40 +1000647 case MP_QSTR_protocol: {
648 uint8_t protocol_bitmap;
649 esp_exceptions(esp_wifi_get_protocol(self->if_id, &protocol_bitmap));
650 val = MP_OBJ_NEW_SMALL_INT(protocol_bitmap);
651 break;
652 }
glenn201093dea2022-08-25 16:55:57 +1000653 case MP_QSTR_pm: {
654 wifi_ps_type_t ps_type;
655 esp_exceptions(esp_wifi_get_ps(&ps_type));
656 val = MP_OBJ_NEW_SMALL_INT(ps_type);
657 break;
658 }
Damien Georgeea186de2021-09-22 00:35:46 +1000659 default:
660 goto unknown;
661 }
662
Damien Georgeea186de2021-09-22 00:35:46 +1000663 // We post-check interface requirements to save on code size
664 if (req_if >= 0) {
665 require_if(args[0], req_if);
666 }
667
668 return val;
669
670unknown:
671 mp_raise_ValueError(MP_ERROR_TEXT("unknown config param"));
672}
673MP_DEFINE_CONST_FUN_OBJ_KW(network_wlan_config_obj, 1, network_wlan_config);
674
675STATIC const mp_rom_map_elem_t wlan_if_locals_dict_table[] = {
676 { MP_ROM_QSTR(MP_QSTR_active), MP_ROM_PTR(&network_wlan_active_obj) },
677 { MP_ROM_QSTR(MP_QSTR_connect), MP_ROM_PTR(&network_wlan_connect_obj) },
678 { MP_ROM_QSTR(MP_QSTR_disconnect), MP_ROM_PTR(&network_wlan_disconnect_obj) },
679 { MP_ROM_QSTR(MP_QSTR_status), MP_ROM_PTR(&network_wlan_status_obj) },
680 { MP_ROM_QSTR(MP_QSTR_scan), MP_ROM_PTR(&network_wlan_scan_obj) },
681 { MP_ROM_QSTR(MP_QSTR_isconnected), MP_ROM_PTR(&network_wlan_isconnected_obj) },
682 { MP_ROM_QSTR(MP_QSTR_config), MP_ROM_PTR(&network_wlan_config_obj) },
Jim Mussaredeb51ca42023-02-01 14:20:45 +1100683 { MP_ROM_QSTR(MP_QSTR_ifconfig), MP_ROM_PTR(&esp_network_ifconfig_obj) },
glenn201093dea2022-08-25 16:55:57 +1000684
685 // Constants
686 { MP_ROM_QSTR(MP_QSTR_PM_NONE), MP_ROM_INT(WIFI_PS_NONE) },
687 { MP_ROM_QSTR(MP_QSTR_PM_PERFORMANCE), MP_ROM_INT(WIFI_PS_MIN_MODEM) },
688 { MP_ROM_QSTR(MP_QSTR_PM_POWERSAVE), MP_ROM_INT(WIFI_PS_MAX_MODEM) },
Damien Georgeea186de2021-09-22 00:35:46 +1000689};
690STATIC MP_DEFINE_CONST_DICT(wlan_if_locals_dict, wlan_if_locals_dict_table);
691
Jim Mussared662b9762021-07-14 14:38:38 +1000692MP_DEFINE_CONST_OBJ_TYPE(
Damien George53cb0732023-05-11 11:51:02 +1000693 esp_network_wlan_type,
Jim Mussared662b9762021-07-14 14:38:38 +1000694 MP_QSTR_WLAN,
695 MP_TYPE_FLAG_NONE,
Damien George53cb0732023-05-11 11:51:02 +1000696 make_new, network_wlan_make_new,
Jim Mussared9dce8272022-06-24 16:27:46 +1000697 locals_dict, &wlan_if_locals_dict
Jim Mussared662b9762021-07-14 14:38:38 +1000698 );
699
Damien Georgeea186de2021-09-22 00:35:46 +1000700#endif // MICROPY_PY_NETWORK_WLAN