blob: 81410f209bf3d4b70cf69d1607153ed88eec6fe4 [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"
44#include "mdns.h"
45
46#if MICROPY_PY_NETWORK_WLAN
47
48#if (WIFI_MODE_STA & WIFI_MODE_AP != WIFI_MODE_NULL || WIFI_MODE_STA | WIFI_MODE_AP != WIFI_MODE_APSTA)
49#error WIFI_MODE_STA and WIFI_MODE_AP are supposed to be bitfields!
50#endif
51
Jim Mussared662b9762021-07-14 14:38:38 +100052STATIC const wlan_if_obj_t wlan_sta_obj;
53STATIC const wlan_if_obj_t wlan_ap_obj;
Damien Georgeea186de2021-09-22 00:35:46 +100054
55// Set to "true" if esp_wifi_start() was called
56static bool wifi_started = false;
57
58// Set to "true" if the STA interface is requested to be connected by the
59// user, used for automatic reassociation.
60static bool wifi_sta_connect_requested = false;
61
62// Set to "true" if the STA interface is connected to wifi and has IP address.
63static bool wifi_sta_connected = false;
64
65// Store the current status. 0 means None here, safe to do so as first enum value is WIFI_REASON_UNSPECIFIED=1.
66static uint8_t wifi_sta_disconn_reason = 0;
67
68#if MICROPY_HW_ENABLE_MDNS_QUERIES || MICROPY_HW_ENABLE_MDNS_RESPONDER
69// Whether mDNS has been initialised or not
70static bool mdns_initialised = false;
71#endif
72
73static uint8_t conf_wifi_sta_reconnects = 0;
74static uint8_t wifi_sta_reconnects;
75
76// This function is called by the system-event task and so runs in a different
77// thread to the main MicroPython task. It must not raise any Python exceptions.
78void network_wlan_event_handler(system_event_t *event) {
79 switch (event->event_id) {
80 case SYSTEM_EVENT_STA_START:
81 ESP_LOGI("wifi", "STA_START");
82 wifi_sta_reconnects = 0;
83 break;
84 case SYSTEM_EVENT_STA_CONNECTED:
85 ESP_LOGI("network", "CONNECTED");
86 break;
87 case SYSTEM_EVENT_STA_GOT_IP:
88 ESP_LOGI("network", "GOT_IP");
89 wifi_sta_connected = true;
90 wifi_sta_disconn_reason = 0; // Success so clear error. (in case of new error will be replaced anyway)
91 #if MICROPY_HW_ENABLE_MDNS_QUERIES || MICROPY_HW_ENABLE_MDNS_RESPONDER
92 if (!mdns_initialised) {
93 mdns_init();
94 #if MICROPY_HW_ENABLE_MDNS_RESPONDER
Jim Mussaredeb51ca42023-02-01 14:20:45 +110095 mdns_hostname_set(mod_network_hostname);
96 mdns_instance_name_set(mod_network_hostname);
Damien Georgeea186de2021-09-22 00:35:46 +100097 #endif
98 mdns_initialised = true;
99 }
100 #endif
101 break;
102 case SYSTEM_EVENT_STA_DISCONNECTED: {
103 // This is a workaround as ESP32 WiFi libs don't currently
104 // auto-reassociate.
105 system_event_sta_disconnected_t *disconn = &event->event_info.disconnected;
106 char *message = "";
107 wifi_sta_disconn_reason = disconn->reason;
108 switch (disconn->reason) {
109 case WIFI_REASON_BEACON_TIMEOUT:
110 // AP has dropped out; try to reconnect.
111 message = "\nbeacon timeout";
112 break;
113 case WIFI_REASON_NO_AP_FOUND:
114 // AP may not exist, or it may have momentarily dropped out; try to reconnect.
115 message = "\nno AP found";
116 break;
117 case WIFI_REASON_AUTH_FAIL:
118 // Password may be wrong, or it just failed to connect; try to reconnect.
119 message = "\nauthentication failed";
120 break;
121 default:
122 // Let other errors through and try to reconnect.
123 break;
124 }
125 ESP_LOGI("wifi", "STA_DISCONNECTED, reason:%d%s", disconn->reason, message);
126
127 wifi_sta_connected = false;
128 if (wifi_sta_connect_requested) {
129 wifi_mode_t mode;
130 if (esp_wifi_get_mode(&mode) != ESP_OK) {
131 break;
132 }
133 if (!(mode & WIFI_MODE_STA)) {
134 break;
135 }
136 if (conf_wifi_sta_reconnects) {
137 ESP_LOGI("wifi", "reconnect counter=%d, max=%d",
138 wifi_sta_reconnects, conf_wifi_sta_reconnects);
139 if (++wifi_sta_reconnects >= conf_wifi_sta_reconnects) {
140 break;
141 }
142 }
143 esp_err_t e = esp_wifi_connect();
144 if (e != ESP_OK) {
145 ESP_LOGI("wifi", "error attempting to reconnect: 0x%04x", e);
146 }
147 }
148 break;
149 }
150 default:
151 break;
152 }
153}
154
155STATIC void require_if(mp_obj_t wlan_if, int if_no) {
156 wlan_if_obj_t *self = MP_OBJ_TO_PTR(wlan_if);
157 if (self->if_id != if_no) {
158 mp_raise_msg(&mp_type_OSError, if_no == WIFI_IF_STA ? MP_ERROR_TEXT("STA required") : MP_ERROR_TEXT("AP required"));
159 }
160}
161
Glenn Moloney7fa322a2020-09-24 15:37:04 +1000162void esp_initialise_wifi() {
163 static int wifi_initialized = 0;
164 if (!wifi_initialized) {
Damien Georgeea186de2021-09-22 00:35:46 +1000165 wifi_init_config_t cfg = WIFI_INIT_CONFIG_DEFAULT();
166 ESP_LOGD("modnetwork", "Initializing WiFi");
167 esp_exceptions(esp_wifi_init(&cfg));
168 esp_exceptions(esp_wifi_set_storage(WIFI_STORAGE_RAM));
169 ESP_LOGD("modnetwork", "Initialized");
Glenn Moloney7fa322a2020-09-24 15:37:04 +1000170 wifi_initialized = 1;
Damien Georgeea186de2021-09-22 00:35:46 +1000171 }
Glenn Moloney7fa322a2020-09-24 15:37:04 +1000172}
173
174STATIC mp_obj_t get_wlan(size_t n_args, const mp_obj_t *args) {
175 esp_initialise_wifi();
Damien Georgeea186de2021-09-22 00:35:46 +1000176
177 int idx = (n_args > 0) ? mp_obj_get_int(args[0]) : WIFI_IF_STA;
178 if (idx == WIFI_IF_STA) {
179 return MP_OBJ_FROM_PTR(&wlan_sta_obj);
180 } else if (idx == WIFI_IF_AP) {
181 return MP_OBJ_FROM_PTR(&wlan_ap_obj);
182 } else {
183 mp_raise_ValueError(MP_ERROR_TEXT("invalid WLAN interface identifier"));
184 }
185}
Jim Mussaredeb51ca42023-02-01 14:20:45 +1100186MP_DEFINE_CONST_FUN_OBJ_VAR_BETWEEN(esp_network_get_wlan_obj, 0, 1, get_wlan);
Damien Georgeea186de2021-09-22 00:35:46 +1000187
188STATIC mp_obj_t network_wlan_active(size_t n_args, const mp_obj_t *args) {
189 wlan_if_obj_t *self = MP_OBJ_TO_PTR(args[0]);
190
191 wifi_mode_t mode;
192 if (!wifi_started) {
193 mode = WIFI_MODE_NULL;
194 } else {
195 esp_exceptions(esp_wifi_get_mode(&mode));
196 }
197
198 int bit = (self->if_id == WIFI_IF_STA) ? WIFI_MODE_STA : WIFI_MODE_AP;
199
200 if (n_args > 1) {
201 bool active = mp_obj_is_true(args[1]);
202 mode = active ? (mode | bit) : (mode & ~bit);
203 if (mode == WIFI_MODE_NULL) {
204 if (wifi_started) {
205 esp_exceptions(esp_wifi_stop());
206 wifi_started = false;
207 }
208 } else {
209 esp_exceptions(esp_wifi_set_mode(mode));
210 if (!wifi_started) {
211 esp_exceptions(esp_wifi_start());
212 wifi_started = true;
213 }
214 }
robert-hhd6bc34a2023-01-19 12:42:09 +0100215 // This delay is a band-aid patch for issues #8289, #8792 and #9236,
216 // allowing the esp data structures to settle. It looks like some
217 // kind of race condition, which is not yet found. But at least
218 // this small delay seems not hurt much, since wlan.active() is
219 // usually not called in a time critical part of the code.
220 mp_hal_delay_ms(1);
Damien Georgeea186de2021-09-22 00:35:46 +1000221 }
222
223 return (mode & bit) ? mp_const_true : mp_const_false;
224}
225STATIC MP_DEFINE_CONST_FUN_OBJ_VAR_BETWEEN(network_wlan_active_obj, 1, 2, network_wlan_active);
226
227STATIC 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 +0200228 enum { ARG_ssid, ARG_key, ARG_bssid };
Damien Georgeea186de2021-09-22 00:35:46 +1000229 static const mp_arg_t allowed_args[] = {
230 { MP_QSTR_, MP_ARG_OBJ, {.u_obj = mp_const_none} },
231 { MP_QSTR_, MP_ARG_OBJ, {.u_obj = mp_const_none} },
232 { MP_QSTR_bssid, MP_ARG_KW_ONLY | MP_ARG_OBJ, {.u_obj = mp_const_none} },
233 };
234
235 // parse args
236 mp_arg_val_t args[MP_ARRAY_SIZE(allowed_args)];
237 mp_arg_parse_all(n_args - 1, pos_args + 1, kw_args, MP_ARRAY_SIZE(allowed_args), allowed_args, args);
238
239 wifi_config_t wifi_sta_config = {0};
240
241 // configure any parameters that are given
242 if (n_args > 1) {
243 size_t len;
244 const char *p;
245 if (args[ARG_ssid].u_obj != mp_const_none) {
246 p = mp_obj_str_get_data(args[ARG_ssid].u_obj, &len);
247 memcpy(wifi_sta_config.sta.ssid, p, MIN(len, sizeof(wifi_sta_config.sta.ssid)));
248 }
iabdalkadera7c7feb2022-06-04 12:22:55 +0200249 if (args[ARG_key].u_obj != mp_const_none) {
250 p = mp_obj_str_get_data(args[ARG_key].u_obj, &len);
Damien Georgeea186de2021-09-22 00:35:46 +1000251 memcpy(wifi_sta_config.sta.password, p, MIN(len, sizeof(wifi_sta_config.sta.password)));
252 }
253 if (args[ARG_bssid].u_obj != mp_const_none) {
254 p = mp_obj_str_get_data(args[ARG_bssid].u_obj, &len);
255 if (len != sizeof(wifi_sta_config.sta.bssid)) {
256 mp_raise_ValueError(NULL);
257 }
258 wifi_sta_config.sta.bssid_set = 1;
259 memcpy(wifi_sta_config.sta.bssid, p, sizeof(wifi_sta_config.sta.bssid));
260 }
261 esp_exceptions(esp_wifi_set_config(ESP_IF_WIFI_STA, &wifi_sta_config));
262 }
263
Jim Mussaredeb51ca42023-02-01 14:20:45 +1100264 esp_exceptions(tcpip_adapter_set_hostname(TCPIP_ADAPTER_IF_STA, mod_network_hostname));
265
Damien Georgeea186de2021-09-22 00:35:46 +1000266 wifi_sta_reconnects = 0;
267 // connect to the WiFi AP
268 MP_THREAD_GIL_EXIT();
269 esp_exceptions(esp_wifi_connect());
270 MP_THREAD_GIL_ENTER();
271 wifi_sta_connect_requested = true;
272
273 return mp_const_none;
274}
275STATIC MP_DEFINE_CONST_FUN_OBJ_KW(network_wlan_connect_obj, 1, network_wlan_connect);
276
277STATIC mp_obj_t network_wlan_disconnect(mp_obj_t self_in) {
278 wifi_sta_connect_requested = false;
279 esp_exceptions(esp_wifi_disconnect());
280 return mp_const_none;
281}
282STATIC MP_DEFINE_CONST_FUN_OBJ_1(network_wlan_disconnect_obj, network_wlan_disconnect);
283
284STATIC mp_obj_t network_wlan_status(size_t n_args, const mp_obj_t *args) {
285 wlan_if_obj_t *self = MP_OBJ_TO_PTR(args[0]);
286 if (n_args == 1) {
287 if (self->if_id == WIFI_IF_STA) {
288 // Case of no arg is only for the STA interface
289 if (wifi_sta_connected) {
290 // Happy path, connected with IP
291 return MP_OBJ_NEW_SMALL_INT(STAT_GOT_IP);
292 } else if (wifi_sta_connect_requested
293 && (conf_wifi_sta_reconnects == 0
294 || wifi_sta_reconnects < conf_wifi_sta_reconnects)) {
295 // No connection or error, but is requested = Still connecting
296 return MP_OBJ_NEW_SMALL_INT(STAT_CONNECTING);
297 } else if (wifi_sta_disconn_reason == 0) {
298 // No activity, No error = Idle
299 return MP_OBJ_NEW_SMALL_INT(STAT_IDLE);
300 } else {
301 // Simply pass the error through from ESP-identifier
302 return MP_OBJ_NEW_SMALL_INT(wifi_sta_disconn_reason);
303 }
304 }
305 return mp_const_none;
306 }
307
308 // one argument: return status based on query parameter
309 switch ((uintptr_t)args[1]) {
310 case (uintptr_t)MP_OBJ_NEW_QSTR(MP_QSTR_stations): {
311 // return list of connected stations, only if in soft-AP mode
312 require_if(args[0], WIFI_IF_AP);
313 wifi_sta_list_t station_list;
314 esp_exceptions(esp_wifi_ap_get_sta_list(&station_list));
315 wifi_sta_info_t *stations = (wifi_sta_info_t *)station_list.sta;
316 mp_obj_t list = mp_obj_new_list(0, NULL);
317 for (int i = 0; i < station_list.num; ++i) {
318 mp_obj_tuple_t *t = mp_obj_new_tuple(1, NULL);
319 t->items[0] = mp_obj_new_bytes(stations[i].mac, sizeof(stations[i].mac));
320 mp_obj_list_append(list, t);
321 }
322 return list;
323 }
324 case (uintptr_t)MP_OBJ_NEW_QSTR(MP_QSTR_rssi): {
325 // return signal of AP, only in STA mode
326 require_if(args[0], WIFI_IF_STA);
327
328 wifi_ap_record_t info;
329 esp_exceptions(esp_wifi_sta_get_ap_info(&info));
330 return MP_OBJ_NEW_SMALL_INT(info.rssi);
331 }
332 default:
333 mp_raise_ValueError(MP_ERROR_TEXT("unknown status param"));
334 }
335
336 return mp_const_none;
337}
338STATIC MP_DEFINE_CONST_FUN_OBJ_VAR_BETWEEN(network_wlan_status_obj, 1, 2, network_wlan_status);
339
340STATIC mp_obj_t network_wlan_scan(mp_obj_t self_in) {
341 // check that STA mode is active
342 wifi_mode_t mode;
343 esp_exceptions(esp_wifi_get_mode(&mode));
344 if ((mode & WIFI_MODE_STA) == 0) {
345 mp_raise_msg(&mp_type_OSError, MP_ERROR_TEXT("STA must be active"));
346 }
347
348 mp_obj_t list = mp_obj_new_list(0, NULL);
349 wifi_scan_config_t config = { 0 };
350 config.show_hidden = true;
351 MP_THREAD_GIL_EXIT();
352 esp_err_t status = esp_wifi_scan_start(&config, 1);
353 MP_THREAD_GIL_ENTER();
354 if (status == 0) {
355 uint16_t count = 0;
356 esp_exceptions(esp_wifi_scan_get_ap_num(&count));
Damien Georgeccaf1972022-06-28 13:15:10 +1000357 if (count == 0) {
358 // esp_wifi_scan_get_ap_records must be called to free internal buffers from the scan.
359 // But it returns an error if wifi_ap_records==NULL. So allocate at least 1 AP entry.
360 // esp_wifi_scan_get_ap_records will then return the actual number of APs in count.
361 count = 1;
362 }
Damien Georgeea186de2021-09-22 00:35:46 +1000363 wifi_ap_record_t *wifi_ap_records = calloc(count, sizeof(wifi_ap_record_t));
364 esp_exceptions(esp_wifi_scan_get_ap_records(&count, wifi_ap_records));
365 for (uint16_t i = 0; i < count; i++) {
366 mp_obj_tuple_t *t = mp_obj_new_tuple(6, NULL);
367 uint8_t *x = memchr(wifi_ap_records[i].ssid, 0, sizeof(wifi_ap_records[i].ssid));
368 int ssid_len = x ? x - wifi_ap_records[i].ssid : sizeof(wifi_ap_records[i].ssid);
369 t->items[0] = mp_obj_new_bytes(wifi_ap_records[i].ssid, ssid_len);
370 t->items[1] = mp_obj_new_bytes(wifi_ap_records[i].bssid, sizeof(wifi_ap_records[i].bssid));
371 t->items[2] = MP_OBJ_NEW_SMALL_INT(wifi_ap_records[i].primary);
372 t->items[3] = MP_OBJ_NEW_SMALL_INT(wifi_ap_records[i].rssi);
373 t->items[4] = MP_OBJ_NEW_SMALL_INT(wifi_ap_records[i].authmode);
374 t->items[5] = mp_const_false; // XXX hidden?
375 mp_obj_list_append(list, MP_OBJ_FROM_PTR(t));
376 }
377 free(wifi_ap_records);
378 }
379 return list;
380}
381STATIC MP_DEFINE_CONST_FUN_OBJ_1(network_wlan_scan_obj, network_wlan_scan);
382
383STATIC mp_obj_t network_wlan_isconnected(mp_obj_t self_in) {
384 wlan_if_obj_t *self = MP_OBJ_TO_PTR(self_in);
385 if (self->if_id == WIFI_IF_STA) {
386 return mp_obj_new_bool(wifi_sta_connected);
387 } else {
388 wifi_sta_list_t sta;
389 esp_wifi_ap_get_sta_list(&sta);
390 return mp_obj_new_bool(sta.num != 0);
391 }
392}
393STATIC MP_DEFINE_CONST_FUN_OBJ_1(network_wlan_isconnected_obj, network_wlan_isconnected);
394
395STATIC mp_obj_t network_wlan_config(size_t n_args, const mp_obj_t *args, mp_map_t *kwargs) {
396 if (n_args != 1 && kwargs->used != 0) {
397 mp_raise_TypeError(MP_ERROR_TEXT("either pos or kw args are allowed"));
398 }
399
400 wlan_if_obj_t *self = MP_OBJ_TO_PTR(args[0]);
401
402 bool is_wifi = self->if_id == WIFI_IF_AP || self->if_id == WIFI_IF_STA;
403
404 wifi_config_t cfg;
405 if (is_wifi) {
406 esp_exceptions(esp_wifi_get_config(self->if_id, &cfg));
407 }
408
Damien Georgeea186de2021-09-22 00:35:46 +1000409 if (kwargs->used != 0) {
410 if (!is_wifi) {
411 goto unknown;
412 }
413
414 for (size_t i = 0; i < kwargs->alloc; i++) {
415 if (mp_map_slot_is_filled(kwargs, i)) {
416 int req_if = -1;
417
Damien George5adb1fa2021-12-10 23:28:46 +1100418 switch (mp_obj_str_get_qstr(kwargs->table[i].key)) {
419 case MP_QSTR_mac: {
Damien Georgeea186de2021-09-22 00:35:46 +1000420 mp_buffer_info_t bufinfo;
421 mp_get_buffer_raise(kwargs->table[i].value, &bufinfo, MP_BUFFER_READ);
422 if (bufinfo.len != 6) {
423 mp_raise_ValueError(MP_ERROR_TEXT("invalid buffer length"));
424 }
425 esp_exceptions(esp_wifi_set_mac(self->if_id, bufinfo.buf));
426 break;
427 }
iabdalkadera7c7feb2022-06-04 12:22:55 +0200428 case MP_QSTR_ssid:
Damien George5adb1fa2021-12-10 23:28:46 +1100429 case MP_QSTR_essid: {
Damien Georgeea186de2021-09-22 00:35:46 +1000430 req_if = WIFI_IF_AP;
431 size_t len;
432 const char *s = mp_obj_str_get_data(kwargs->table[i].value, &len);
433 len = MIN(len, sizeof(cfg.ap.ssid));
434 memcpy(cfg.ap.ssid, s, len);
435 cfg.ap.ssid_len = len;
436 break;
437 }
Damien George5adb1fa2021-12-10 23:28:46 +1100438 case MP_QSTR_hidden: {
Damien Georgeea186de2021-09-22 00:35:46 +1000439 req_if = WIFI_IF_AP;
440 cfg.ap.ssid_hidden = mp_obj_is_true(kwargs->table[i].value);
441 break;
442 }
iabdalkadera7c7feb2022-06-04 12:22:55 +0200443 case MP_QSTR_security:
Damien George5adb1fa2021-12-10 23:28:46 +1100444 case MP_QSTR_authmode: {
Damien Georgeea186de2021-09-22 00:35:46 +1000445 req_if = WIFI_IF_AP;
446 cfg.ap.authmode = mp_obj_get_int(kwargs->table[i].value);
447 break;
448 }
iabdalkadera7c7feb2022-06-04 12:22:55 +0200449 case MP_QSTR_key:
Damien George5adb1fa2021-12-10 23:28:46 +1100450 case MP_QSTR_password: {
Damien Georgeea186de2021-09-22 00:35:46 +1000451 req_if = WIFI_IF_AP;
452 size_t len;
453 const char *s = mp_obj_str_get_data(kwargs->table[i].value, &len);
454 len = MIN(len, sizeof(cfg.ap.password) - 1);
455 memcpy(cfg.ap.password, s, len);
456 cfg.ap.password[len] = 0;
457 break;
458 }
Damien George5adb1fa2021-12-10 23:28:46 +1100459 case MP_QSTR_channel: {
glenn2098d1c502022-07-31 16:36:10 +1000460 uint8_t primary;
461 wifi_second_chan_t secondary;
462 // Get the current value of secondary
463 esp_exceptions(esp_wifi_get_channel(&primary, &secondary));
464 primary = mp_obj_get_int(kwargs->table[i].value);
465 esp_err_t err = esp_wifi_set_channel(primary, secondary);
466 if (err == ESP_ERR_INVALID_ARG) {
467 // May need to swap secondary channel above to below or below to above
468 secondary = (
469 (secondary == WIFI_SECOND_CHAN_ABOVE)
470 ? WIFI_SECOND_CHAN_BELOW
471 : (secondary == WIFI_SECOND_CHAN_BELOW)
472 ? WIFI_SECOND_CHAN_ABOVE
473 : WIFI_SECOND_CHAN_NONE);
474 esp_exceptions(esp_wifi_set_channel(primary, secondary));
475 }
Damien Georgeea186de2021-09-22 00:35:46 +1000476 break;
477 }
IhorNehrutsa1ea82b62022-06-28 16:38:45 +0300478 case MP_QSTR_hostname:
Damien George5adb1fa2021-12-10 23:28:46 +1100479 case MP_QSTR_dhcp_hostname: {
Jim Mussaredeb51ca42023-02-01 14:20:45 +1100480 // TODO: Deprecated. Use network.hostname(name) instead.
481 size_t len;
482 const char *str = mp_obj_str_get_data(kwargs->table[i].value, &len);
483 if (len >= MICROPY_PY_NETWORK_HOSTNAME_MAX_LEN) {
484 mp_raise_ValueError(NULL);
485 }
486 strcpy(mod_network_hostname, str);
Damien Georgeea186de2021-09-22 00:35:46 +1000487 break;
488 }
Damien George5adb1fa2021-12-10 23:28:46 +1100489 case MP_QSTR_max_clients: {
Damien Georgeea186de2021-09-22 00:35:46 +1000490 req_if = WIFI_IF_AP;
491 cfg.ap.max_connection = mp_obj_get_int(kwargs->table[i].value);
492 break;
493 }
Damien George5adb1fa2021-12-10 23:28:46 +1100494 case MP_QSTR_reconnects: {
Damien Georgeea186de2021-09-22 00:35:46 +1000495 int reconnects = mp_obj_get_int(kwargs->table[i].value);
496 req_if = WIFI_IF_STA;
497 // parameter reconnects == -1 means to retry forever.
498 // here means conf_wifi_sta_reconnects == 0 to retry forever.
499 conf_wifi_sta_reconnects = (reconnects == -1) ? 0 : reconnects + 1;
500 break;
501 }
wemosff28d2e2022-04-11 20:12:57 +0800502 case MP_QSTR_txpower: {
503 int8_t power = (mp_obj_get_float(kwargs->table[i].value) * 4);
504 esp_exceptions(esp_wifi_set_max_tx_power(power));
505 break;
506 }
glenn2076f2e3e2022-07-31 18:17:40 +1000507 case MP_QSTR_protocol: {
508 esp_exceptions(esp_wifi_set_protocol(self->if_id, mp_obj_get_int(kwargs->table[i].value)));
509 break;
510 }
glenn201093dea2022-08-25 16:55:57 +1000511 case MP_QSTR_pm: {
512 esp_exceptions(esp_wifi_set_ps(mp_obj_get_int(kwargs->table[i].value)));
513 break;
514 }
Damien Georgeea186de2021-09-22 00:35:46 +1000515 default:
516 goto unknown;
517 }
518
519 // We post-check interface requirements to save on code size
520 if (req_if >= 0) {
521 require_if(args[0], req_if);
522 }
523 }
524 }
525
526 esp_exceptions(esp_wifi_set_config(self->if_id, &cfg));
527
528 return mp_const_none;
529 }
530
531 // Get config
532
533 if (n_args != 2) {
534 mp_raise_TypeError(MP_ERROR_TEXT("can query only one param"));
535 }
536
537 int req_if = -1;
538 mp_obj_t val = mp_const_none;
539
Damien George5adb1fa2021-12-10 23:28:46 +1100540 switch (mp_obj_str_get_qstr(args[1])) {
541 case MP_QSTR_mac: {
Damien Georgeea186de2021-09-22 00:35:46 +1000542 uint8_t mac[6];
543 switch (self->if_id) {
544 case WIFI_IF_AP: // fallthrough intentional
545 case WIFI_IF_STA:
546 esp_exceptions(esp_wifi_get_mac(self->if_id, mac));
547 return mp_obj_new_bytes(mac, sizeof(mac));
548 default:
549 goto unknown;
550 }
551 }
iabdalkadera7c7feb2022-06-04 12:22:55 +0200552 case MP_QSTR_ssid:
Damien George5adb1fa2021-12-10 23:28:46 +1100553 case MP_QSTR_essid:
Damien Georgeea186de2021-09-22 00:35:46 +1000554 switch (self->if_id) {
555 case WIFI_IF_STA:
556 val = mp_obj_new_str((char *)cfg.sta.ssid, strlen((char *)cfg.sta.ssid));
557 break;
558 case WIFI_IF_AP:
559 val = mp_obj_new_str((char *)cfg.ap.ssid, cfg.ap.ssid_len);
560 break;
561 default:
562 req_if = WIFI_IF_AP;
563 }
564 break;
Damien George5adb1fa2021-12-10 23:28:46 +1100565 case MP_QSTR_hidden:
Damien Georgeea186de2021-09-22 00:35:46 +1000566 req_if = WIFI_IF_AP;
567 val = mp_obj_new_bool(cfg.ap.ssid_hidden);
568 break;
iabdalkadera7c7feb2022-06-04 12:22:55 +0200569 case MP_QSTR_security:
Damien George5adb1fa2021-12-10 23:28:46 +1100570 case MP_QSTR_authmode:
Damien Georgeea186de2021-09-22 00:35:46 +1000571 req_if = WIFI_IF_AP;
572 val = MP_OBJ_NEW_SMALL_INT(cfg.ap.authmode);
573 break;
glenn2098d1c502022-07-31 16:36:10 +1000574 case MP_QSTR_channel: {
575 uint8_t channel;
576 wifi_second_chan_t second;
577 esp_exceptions(esp_wifi_get_channel(&channel, &second));
578 val = MP_OBJ_NEW_SMALL_INT(channel);
Damien Georgeea186de2021-09-22 00:35:46 +1000579 break;
glenn2098d1c502022-07-31 16:36:10 +1000580 }
IhorNehrutsa1ea82b62022-06-28 16:38:45 +0300581 case MP_QSTR_hostname:
Damien George5adb1fa2021-12-10 23:28:46 +1100582 case MP_QSTR_dhcp_hostname: {
Jim Mussaredeb51ca42023-02-01 14:20:45 +1100583 // TODO: Deprecated. Use network.hostname() instead.
584 req_if = WIFI_IF_STA;
585 val = mp_obj_new_str(mod_network_hostname, strlen(mod_network_hostname));
Damien Georgeea186de2021-09-22 00:35:46 +1000586 break;
587 }
Damien George5adb1fa2021-12-10 23:28:46 +1100588 case MP_QSTR_max_clients: {
Damien Georgeea186de2021-09-22 00:35:46 +1000589 val = MP_OBJ_NEW_SMALL_INT(cfg.ap.max_connection);
590 break;
591 }
Damien George5adb1fa2021-12-10 23:28:46 +1100592 case MP_QSTR_reconnects:
Damien Georgeea186de2021-09-22 00:35:46 +1000593 req_if = WIFI_IF_STA;
594 int rec = conf_wifi_sta_reconnects - 1;
595 val = MP_OBJ_NEW_SMALL_INT(rec);
596 break;
wemosff28d2e2022-04-11 20:12:57 +0800597 case MP_QSTR_txpower: {
598 int8_t power;
599 esp_exceptions(esp_wifi_get_max_tx_power(&power));
600 val = mp_obj_new_float(power * 0.25);
601 break;
602 }
glenn2076f2e3e2022-07-31 18:17:40 +1000603 case MP_QSTR_protocol: {
604 uint8_t protocol_bitmap;
605 esp_exceptions(esp_wifi_get_protocol(self->if_id, &protocol_bitmap));
606 val = MP_OBJ_NEW_SMALL_INT(protocol_bitmap);
607 break;
608 }
glenn201093dea2022-08-25 16:55:57 +1000609 case MP_QSTR_pm: {
610 wifi_ps_type_t ps_type;
611 esp_exceptions(esp_wifi_get_ps(&ps_type));
612 val = MP_OBJ_NEW_SMALL_INT(ps_type);
613 break;
614 }
Damien Georgeea186de2021-09-22 00:35:46 +1000615 default:
616 goto unknown;
617 }
618
Damien Georgeea186de2021-09-22 00:35:46 +1000619 // We post-check interface requirements to save on code size
620 if (req_if >= 0) {
621 require_if(args[0], req_if);
622 }
623
624 return val;
625
626unknown:
627 mp_raise_ValueError(MP_ERROR_TEXT("unknown config param"));
628}
629MP_DEFINE_CONST_FUN_OBJ_KW(network_wlan_config_obj, 1, network_wlan_config);
630
631STATIC const mp_rom_map_elem_t wlan_if_locals_dict_table[] = {
632 { MP_ROM_QSTR(MP_QSTR_active), MP_ROM_PTR(&network_wlan_active_obj) },
633 { MP_ROM_QSTR(MP_QSTR_connect), MP_ROM_PTR(&network_wlan_connect_obj) },
634 { MP_ROM_QSTR(MP_QSTR_disconnect), MP_ROM_PTR(&network_wlan_disconnect_obj) },
635 { MP_ROM_QSTR(MP_QSTR_status), MP_ROM_PTR(&network_wlan_status_obj) },
636 { MP_ROM_QSTR(MP_QSTR_scan), MP_ROM_PTR(&network_wlan_scan_obj) },
637 { MP_ROM_QSTR(MP_QSTR_isconnected), MP_ROM_PTR(&network_wlan_isconnected_obj) },
638 { MP_ROM_QSTR(MP_QSTR_config), MP_ROM_PTR(&network_wlan_config_obj) },
Jim Mussaredeb51ca42023-02-01 14:20:45 +1100639 { MP_ROM_QSTR(MP_QSTR_ifconfig), MP_ROM_PTR(&esp_network_ifconfig_obj) },
glenn201093dea2022-08-25 16:55:57 +1000640
641 // Constants
642 { MP_ROM_QSTR(MP_QSTR_PM_NONE), MP_ROM_INT(WIFI_PS_NONE) },
643 { MP_ROM_QSTR(MP_QSTR_PM_PERFORMANCE), MP_ROM_INT(WIFI_PS_MIN_MODEM) },
644 { MP_ROM_QSTR(MP_QSTR_PM_POWERSAVE), MP_ROM_INT(WIFI_PS_MAX_MODEM) },
Damien Georgeea186de2021-09-22 00:35:46 +1000645};
646STATIC MP_DEFINE_CONST_DICT(wlan_if_locals_dict, wlan_if_locals_dict_table);
647
Jim Mussared662b9762021-07-14 14:38:38 +1000648MP_DEFINE_CONST_OBJ_TYPE(
649 wlan_if_type,
650 MP_QSTR_WLAN,
651 MP_TYPE_FLAG_NONE,
Jim Mussared9dce8272022-06-24 16:27:46 +1000652 locals_dict, &wlan_if_locals_dict
Jim Mussared662b9762021-07-14 14:38:38 +1000653 );
654
655STATIC const wlan_if_obj_t wlan_sta_obj = {{&wlan_if_type}, WIFI_IF_STA};
656STATIC const wlan_if_obj_t wlan_ap_obj = {{&wlan_if_type}, WIFI_IF_AP};
Damien Georgeea186de2021-09-22 00:35:46 +1000657
658#endif // MICROPY_PY_NETWORK_WLAN