blob: e56d73b237bfd18dde377f0dd78e2871b3ed103a [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
Damien George53cb0732023-05-11 11:51:02 +1000174STATIC 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) {
175 mp_arg_check_num(n_args, n_kw, 0, 1, false);
176
Glenn Moloney7fa322a2020-09-24 15:37:04 +1000177 esp_initialise_wifi();
Damien Georgeea186de2021-09-22 00:35:46 +1000178
179 int idx = (n_args > 0) ? mp_obj_get_int(args[0]) : WIFI_IF_STA;
180 if (idx == WIFI_IF_STA) {
181 return MP_OBJ_FROM_PTR(&wlan_sta_obj);
182 } else if (idx == WIFI_IF_AP) {
183 return MP_OBJ_FROM_PTR(&wlan_ap_obj);
184 } else {
185 mp_raise_ValueError(MP_ERROR_TEXT("invalid WLAN interface identifier"));
186 }
187}
Damien Georgeea186de2021-09-22 00:35:46 +1000188
189STATIC mp_obj_t network_wlan_active(size_t n_args, const mp_obj_t *args) {
190 wlan_if_obj_t *self = MP_OBJ_TO_PTR(args[0]);
191
192 wifi_mode_t mode;
193 if (!wifi_started) {
194 mode = WIFI_MODE_NULL;
195 } else {
196 esp_exceptions(esp_wifi_get_mode(&mode));
197 }
198
199 int bit = (self->if_id == WIFI_IF_STA) ? WIFI_MODE_STA : WIFI_MODE_AP;
200
201 if (n_args > 1) {
202 bool active = mp_obj_is_true(args[1]);
203 mode = active ? (mode | bit) : (mode & ~bit);
204 if (mode == WIFI_MODE_NULL) {
205 if (wifi_started) {
206 esp_exceptions(esp_wifi_stop());
207 wifi_started = false;
208 }
209 } else {
210 esp_exceptions(esp_wifi_set_mode(mode));
211 if (!wifi_started) {
212 esp_exceptions(esp_wifi_start());
213 wifi_started = true;
214 }
215 }
robert-hhd6bc34a2023-01-19 12:42:09 +0100216 // This delay is a band-aid patch for issues #8289, #8792 and #9236,
217 // allowing the esp data structures to settle. It looks like some
218 // kind of race condition, which is not yet found. But at least
219 // this small delay seems not hurt much, since wlan.active() is
220 // usually not called in a time critical part of the code.
221 mp_hal_delay_ms(1);
Damien Georgeea186de2021-09-22 00:35:46 +1000222 }
223
224 return (mode & bit) ? mp_const_true : mp_const_false;
225}
226STATIC MP_DEFINE_CONST_FUN_OBJ_VAR_BETWEEN(network_wlan_active_obj, 1, 2, network_wlan_active);
227
228STATIC 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 +0200229 enum { ARG_ssid, ARG_key, ARG_bssid };
Damien Georgeea186de2021-09-22 00:35:46 +1000230 static const mp_arg_t allowed_args[] = {
231 { MP_QSTR_, MP_ARG_OBJ, {.u_obj = mp_const_none} },
232 { MP_QSTR_, MP_ARG_OBJ, {.u_obj = mp_const_none} },
233 { MP_QSTR_bssid, MP_ARG_KW_ONLY | MP_ARG_OBJ, {.u_obj = mp_const_none} },
234 };
235
236 // parse args
237 mp_arg_val_t args[MP_ARRAY_SIZE(allowed_args)];
238 mp_arg_parse_all(n_args - 1, pos_args + 1, kw_args, MP_ARRAY_SIZE(allowed_args), allowed_args, args);
239
240 wifi_config_t wifi_sta_config = {0};
241
242 // configure any parameters that are given
243 if (n_args > 1) {
244 size_t len;
245 const char *p;
246 if (args[ARG_ssid].u_obj != mp_const_none) {
247 p = mp_obj_str_get_data(args[ARG_ssid].u_obj, &len);
248 memcpy(wifi_sta_config.sta.ssid, p, MIN(len, sizeof(wifi_sta_config.sta.ssid)));
249 }
iabdalkadera7c7feb2022-06-04 12:22:55 +0200250 if (args[ARG_key].u_obj != mp_const_none) {
251 p = mp_obj_str_get_data(args[ARG_key].u_obj, &len);
Damien Georgeea186de2021-09-22 00:35:46 +1000252 memcpy(wifi_sta_config.sta.password, p, MIN(len, sizeof(wifi_sta_config.sta.password)));
253 }
254 if (args[ARG_bssid].u_obj != mp_const_none) {
255 p = mp_obj_str_get_data(args[ARG_bssid].u_obj, &len);
256 if (len != sizeof(wifi_sta_config.sta.bssid)) {
257 mp_raise_ValueError(NULL);
258 }
259 wifi_sta_config.sta.bssid_set = 1;
260 memcpy(wifi_sta_config.sta.bssid, p, sizeof(wifi_sta_config.sta.bssid));
261 }
262 esp_exceptions(esp_wifi_set_config(ESP_IF_WIFI_STA, &wifi_sta_config));
263 }
264
Jim Mussaredeb51ca42023-02-01 14:20:45 +1100265 esp_exceptions(tcpip_adapter_set_hostname(TCPIP_ADAPTER_IF_STA, mod_network_hostname));
266
Damien Georgeea186de2021-09-22 00:35:46 +1000267 wifi_sta_reconnects = 0;
268 // connect to the WiFi AP
269 MP_THREAD_GIL_EXIT();
270 esp_exceptions(esp_wifi_connect());
271 MP_THREAD_GIL_ENTER();
272 wifi_sta_connect_requested = true;
273
274 return mp_const_none;
275}
276STATIC MP_DEFINE_CONST_FUN_OBJ_KW(network_wlan_connect_obj, 1, network_wlan_connect);
277
278STATIC mp_obj_t network_wlan_disconnect(mp_obj_t self_in) {
279 wifi_sta_connect_requested = false;
280 esp_exceptions(esp_wifi_disconnect());
281 return mp_const_none;
282}
283STATIC MP_DEFINE_CONST_FUN_OBJ_1(network_wlan_disconnect_obj, network_wlan_disconnect);
284
285STATIC mp_obj_t network_wlan_status(size_t n_args, const mp_obj_t *args) {
286 wlan_if_obj_t *self = MP_OBJ_TO_PTR(args[0]);
287 if (n_args == 1) {
288 if (self->if_id == WIFI_IF_STA) {
289 // Case of no arg is only for the STA interface
290 if (wifi_sta_connected) {
291 // Happy path, connected with IP
292 return MP_OBJ_NEW_SMALL_INT(STAT_GOT_IP);
293 } else if (wifi_sta_connect_requested
294 && (conf_wifi_sta_reconnects == 0
295 || wifi_sta_reconnects < conf_wifi_sta_reconnects)) {
296 // No connection or error, but is requested = Still connecting
297 return MP_OBJ_NEW_SMALL_INT(STAT_CONNECTING);
298 } else if (wifi_sta_disconn_reason == 0) {
299 // No activity, No error = Idle
300 return MP_OBJ_NEW_SMALL_INT(STAT_IDLE);
301 } else {
302 // Simply pass the error through from ESP-identifier
303 return MP_OBJ_NEW_SMALL_INT(wifi_sta_disconn_reason);
304 }
305 }
306 return mp_const_none;
307 }
308
309 // one argument: return status based on query parameter
310 switch ((uintptr_t)args[1]) {
311 case (uintptr_t)MP_OBJ_NEW_QSTR(MP_QSTR_stations): {
312 // return list of connected stations, only if in soft-AP mode
313 require_if(args[0], WIFI_IF_AP);
314 wifi_sta_list_t station_list;
315 esp_exceptions(esp_wifi_ap_get_sta_list(&station_list));
316 wifi_sta_info_t *stations = (wifi_sta_info_t *)station_list.sta;
317 mp_obj_t list = mp_obj_new_list(0, NULL);
318 for (int i = 0; i < station_list.num; ++i) {
319 mp_obj_tuple_t *t = mp_obj_new_tuple(1, NULL);
320 t->items[0] = mp_obj_new_bytes(stations[i].mac, sizeof(stations[i].mac));
321 mp_obj_list_append(list, t);
322 }
323 return list;
324 }
325 case (uintptr_t)MP_OBJ_NEW_QSTR(MP_QSTR_rssi): {
326 // return signal of AP, only in STA mode
327 require_if(args[0], WIFI_IF_STA);
328
329 wifi_ap_record_t info;
330 esp_exceptions(esp_wifi_sta_get_ap_info(&info));
331 return MP_OBJ_NEW_SMALL_INT(info.rssi);
332 }
333 default:
334 mp_raise_ValueError(MP_ERROR_TEXT("unknown status param"));
335 }
336
337 return mp_const_none;
338}
339STATIC MP_DEFINE_CONST_FUN_OBJ_VAR_BETWEEN(network_wlan_status_obj, 1, 2, network_wlan_status);
340
341STATIC mp_obj_t network_wlan_scan(mp_obj_t self_in) {
342 // check that STA mode is active
343 wifi_mode_t mode;
344 esp_exceptions(esp_wifi_get_mode(&mode));
345 if ((mode & WIFI_MODE_STA) == 0) {
346 mp_raise_msg(&mp_type_OSError, MP_ERROR_TEXT("STA must be active"));
347 }
348
349 mp_obj_t list = mp_obj_new_list(0, NULL);
350 wifi_scan_config_t config = { 0 };
351 config.show_hidden = true;
352 MP_THREAD_GIL_EXIT();
353 esp_err_t status = esp_wifi_scan_start(&config, 1);
354 MP_THREAD_GIL_ENTER();
355 if (status == 0) {
356 uint16_t count = 0;
357 esp_exceptions(esp_wifi_scan_get_ap_num(&count));
Damien Georgeccaf1972022-06-28 13:15:10 +1000358 if (count == 0) {
359 // esp_wifi_scan_get_ap_records must be called to free internal buffers from the scan.
360 // But it returns an error if wifi_ap_records==NULL. So allocate at least 1 AP entry.
361 // esp_wifi_scan_get_ap_records will then return the actual number of APs in count.
362 count = 1;
363 }
Damien Georgeea186de2021-09-22 00:35:46 +1000364 wifi_ap_record_t *wifi_ap_records = calloc(count, sizeof(wifi_ap_record_t));
365 esp_exceptions(esp_wifi_scan_get_ap_records(&count, wifi_ap_records));
366 for (uint16_t i = 0; i < count; i++) {
367 mp_obj_tuple_t *t = mp_obj_new_tuple(6, NULL);
368 uint8_t *x = memchr(wifi_ap_records[i].ssid, 0, sizeof(wifi_ap_records[i].ssid));
369 int ssid_len = x ? x - wifi_ap_records[i].ssid : sizeof(wifi_ap_records[i].ssid);
370 t->items[0] = mp_obj_new_bytes(wifi_ap_records[i].ssid, ssid_len);
371 t->items[1] = mp_obj_new_bytes(wifi_ap_records[i].bssid, sizeof(wifi_ap_records[i].bssid));
372 t->items[2] = MP_OBJ_NEW_SMALL_INT(wifi_ap_records[i].primary);
373 t->items[3] = MP_OBJ_NEW_SMALL_INT(wifi_ap_records[i].rssi);
374 t->items[4] = MP_OBJ_NEW_SMALL_INT(wifi_ap_records[i].authmode);
375 t->items[5] = mp_const_false; // XXX hidden?
376 mp_obj_list_append(list, MP_OBJ_FROM_PTR(t));
377 }
378 free(wifi_ap_records);
379 }
380 return list;
381}
382STATIC MP_DEFINE_CONST_FUN_OBJ_1(network_wlan_scan_obj, network_wlan_scan);
383
384STATIC mp_obj_t network_wlan_isconnected(mp_obj_t self_in) {
385 wlan_if_obj_t *self = MP_OBJ_TO_PTR(self_in);
386 if (self->if_id == WIFI_IF_STA) {
387 return mp_obj_new_bool(wifi_sta_connected);
388 } else {
389 wifi_sta_list_t sta;
390 esp_wifi_ap_get_sta_list(&sta);
391 return mp_obj_new_bool(sta.num != 0);
392 }
393}
394STATIC MP_DEFINE_CONST_FUN_OBJ_1(network_wlan_isconnected_obj, network_wlan_isconnected);
395
396STATIC mp_obj_t network_wlan_config(size_t n_args, const mp_obj_t *args, mp_map_t *kwargs) {
397 if (n_args != 1 && kwargs->used != 0) {
398 mp_raise_TypeError(MP_ERROR_TEXT("either pos or kw args are allowed"));
399 }
400
401 wlan_if_obj_t *self = MP_OBJ_TO_PTR(args[0]);
402
403 bool is_wifi = self->if_id == WIFI_IF_AP || self->if_id == WIFI_IF_STA;
404
405 wifi_config_t cfg;
406 if (is_wifi) {
407 esp_exceptions(esp_wifi_get_config(self->if_id, &cfg));
408 }
409
Damien Georgeea186de2021-09-22 00:35:46 +1000410 if (kwargs->used != 0) {
411 if (!is_wifi) {
412 goto unknown;
413 }
414
415 for (size_t i = 0; i < kwargs->alloc; i++) {
416 if (mp_map_slot_is_filled(kwargs, i)) {
417 int req_if = -1;
418
Damien George5adb1fa2021-12-10 23:28:46 +1100419 switch (mp_obj_str_get_qstr(kwargs->table[i].key)) {
420 case MP_QSTR_mac: {
Damien Georgeea186de2021-09-22 00:35:46 +1000421 mp_buffer_info_t bufinfo;
422 mp_get_buffer_raise(kwargs->table[i].value, &bufinfo, MP_BUFFER_READ);
423 if (bufinfo.len != 6) {
424 mp_raise_ValueError(MP_ERROR_TEXT("invalid buffer length"));
425 }
426 esp_exceptions(esp_wifi_set_mac(self->if_id, bufinfo.buf));
427 break;
428 }
iabdalkadera7c7feb2022-06-04 12:22:55 +0200429 case MP_QSTR_ssid:
Damien George5adb1fa2021-12-10 23:28:46 +1100430 case MP_QSTR_essid: {
Damien Georgeea186de2021-09-22 00:35:46 +1000431 req_if = WIFI_IF_AP;
432 size_t len;
433 const char *s = mp_obj_str_get_data(kwargs->table[i].value, &len);
434 len = MIN(len, sizeof(cfg.ap.ssid));
435 memcpy(cfg.ap.ssid, s, len);
436 cfg.ap.ssid_len = len;
437 break;
438 }
Damien George5adb1fa2021-12-10 23:28:46 +1100439 case MP_QSTR_hidden: {
Damien Georgeea186de2021-09-22 00:35:46 +1000440 req_if = WIFI_IF_AP;
441 cfg.ap.ssid_hidden = mp_obj_is_true(kwargs->table[i].value);
442 break;
443 }
iabdalkadera7c7feb2022-06-04 12:22:55 +0200444 case MP_QSTR_security:
Damien George5adb1fa2021-12-10 23:28:46 +1100445 case MP_QSTR_authmode: {
Damien Georgeea186de2021-09-22 00:35:46 +1000446 req_if = WIFI_IF_AP;
447 cfg.ap.authmode = mp_obj_get_int(kwargs->table[i].value);
448 break;
449 }
iabdalkadera7c7feb2022-06-04 12:22:55 +0200450 case MP_QSTR_key:
Damien George5adb1fa2021-12-10 23:28:46 +1100451 case MP_QSTR_password: {
Damien Georgeea186de2021-09-22 00:35:46 +1000452 req_if = WIFI_IF_AP;
453 size_t len;
454 const char *s = mp_obj_str_get_data(kwargs->table[i].value, &len);
455 len = MIN(len, sizeof(cfg.ap.password) - 1);
456 memcpy(cfg.ap.password, s, len);
457 cfg.ap.password[len] = 0;
458 break;
459 }
Damien George5adb1fa2021-12-10 23:28:46 +1100460 case MP_QSTR_channel: {
glenn2098d1c502022-07-31 16:36:10 +1000461 uint8_t primary;
462 wifi_second_chan_t secondary;
463 // Get the current value of secondary
464 esp_exceptions(esp_wifi_get_channel(&primary, &secondary));
465 primary = mp_obj_get_int(kwargs->table[i].value);
466 esp_err_t err = esp_wifi_set_channel(primary, secondary);
467 if (err == ESP_ERR_INVALID_ARG) {
468 // May need to swap secondary channel above to below or below to above
469 secondary = (
470 (secondary == WIFI_SECOND_CHAN_ABOVE)
471 ? WIFI_SECOND_CHAN_BELOW
472 : (secondary == WIFI_SECOND_CHAN_BELOW)
473 ? WIFI_SECOND_CHAN_ABOVE
474 : WIFI_SECOND_CHAN_NONE);
475 esp_exceptions(esp_wifi_set_channel(primary, secondary));
476 }
Damien Georgeea186de2021-09-22 00:35:46 +1000477 break;
478 }
IhorNehrutsa1ea82b62022-06-28 16:38:45 +0300479 case MP_QSTR_hostname:
Damien George5adb1fa2021-12-10 23:28:46 +1100480 case MP_QSTR_dhcp_hostname: {
Jim Mussaredeb51ca42023-02-01 14:20:45 +1100481 // TODO: Deprecated. Use network.hostname(name) instead.
482 size_t len;
483 const char *str = mp_obj_str_get_data(kwargs->table[i].value, &len);
484 if (len >= MICROPY_PY_NETWORK_HOSTNAME_MAX_LEN) {
485 mp_raise_ValueError(NULL);
486 }
487 strcpy(mod_network_hostname, str);
Damien Georgeea186de2021-09-22 00:35:46 +1000488 break;
489 }
Damien George5adb1fa2021-12-10 23:28:46 +1100490 case MP_QSTR_max_clients: {
Damien Georgeea186de2021-09-22 00:35:46 +1000491 req_if = WIFI_IF_AP;
492 cfg.ap.max_connection = mp_obj_get_int(kwargs->table[i].value);
493 break;
494 }
Damien George5adb1fa2021-12-10 23:28:46 +1100495 case MP_QSTR_reconnects: {
Damien Georgeea186de2021-09-22 00:35:46 +1000496 int reconnects = mp_obj_get_int(kwargs->table[i].value);
497 req_if = WIFI_IF_STA;
498 // parameter reconnects == -1 means to retry forever.
499 // here means conf_wifi_sta_reconnects == 0 to retry forever.
500 conf_wifi_sta_reconnects = (reconnects == -1) ? 0 : reconnects + 1;
501 break;
502 }
wemosff28d2e2022-04-11 20:12:57 +0800503 case MP_QSTR_txpower: {
504 int8_t power = (mp_obj_get_float(kwargs->table[i].value) * 4);
505 esp_exceptions(esp_wifi_set_max_tx_power(power));
506 break;
507 }
glenn2076f2e3e2022-07-31 18:17:40 +1000508 case MP_QSTR_protocol: {
509 esp_exceptions(esp_wifi_set_protocol(self->if_id, mp_obj_get_int(kwargs->table[i].value)));
510 break;
511 }
glenn201093dea2022-08-25 16:55:57 +1000512 case MP_QSTR_pm: {
513 esp_exceptions(esp_wifi_set_ps(mp_obj_get_int(kwargs->table[i].value)));
514 break;
515 }
Damien Georgeea186de2021-09-22 00:35:46 +1000516 default:
517 goto unknown;
518 }
519
520 // We post-check interface requirements to save on code size
521 if (req_if >= 0) {
522 require_if(args[0], req_if);
523 }
524 }
525 }
526
527 esp_exceptions(esp_wifi_set_config(self->if_id, &cfg));
528
529 return mp_const_none;
530 }
531
532 // Get config
533
534 if (n_args != 2) {
535 mp_raise_TypeError(MP_ERROR_TEXT("can query only one param"));
536 }
537
538 int req_if = -1;
539 mp_obj_t val = mp_const_none;
540
Damien George5adb1fa2021-12-10 23:28:46 +1100541 switch (mp_obj_str_get_qstr(args[1])) {
542 case MP_QSTR_mac: {
Damien Georgeea186de2021-09-22 00:35:46 +1000543 uint8_t mac[6];
544 switch (self->if_id) {
545 case WIFI_IF_AP: // fallthrough intentional
546 case WIFI_IF_STA:
547 esp_exceptions(esp_wifi_get_mac(self->if_id, mac));
548 return mp_obj_new_bytes(mac, sizeof(mac));
549 default:
550 goto unknown;
551 }
552 }
iabdalkadera7c7feb2022-06-04 12:22:55 +0200553 case MP_QSTR_ssid:
Damien George5adb1fa2021-12-10 23:28:46 +1100554 case MP_QSTR_essid:
Damien Georgeea186de2021-09-22 00:35:46 +1000555 switch (self->if_id) {
556 case WIFI_IF_STA:
557 val = mp_obj_new_str((char *)cfg.sta.ssid, strlen((char *)cfg.sta.ssid));
558 break;
559 case WIFI_IF_AP:
560 val = mp_obj_new_str((char *)cfg.ap.ssid, cfg.ap.ssid_len);
561 break;
562 default:
563 req_if = WIFI_IF_AP;
564 }
565 break;
Damien George5adb1fa2021-12-10 23:28:46 +1100566 case MP_QSTR_hidden:
Damien Georgeea186de2021-09-22 00:35:46 +1000567 req_if = WIFI_IF_AP;
568 val = mp_obj_new_bool(cfg.ap.ssid_hidden);
569 break;
iabdalkadera7c7feb2022-06-04 12:22:55 +0200570 case MP_QSTR_security:
Damien George5adb1fa2021-12-10 23:28:46 +1100571 case MP_QSTR_authmode:
Damien Georgeea186de2021-09-22 00:35:46 +1000572 req_if = WIFI_IF_AP;
573 val = MP_OBJ_NEW_SMALL_INT(cfg.ap.authmode);
574 break;
glenn2098d1c502022-07-31 16:36:10 +1000575 case MP_QSTR_channel: {
576 uint8_t channel;
577 wifi_second_chan_t second;
578 esp_exceptions(esp_wifi_get_channel(&channel, &second));
579 val = MP_OBJ_NEW_SMALL_INT(channel);
Damien Georgeea186de2021-09-22 00:35:46 +1000580 break;
glenn2098d1c502022-07-31 16:36:10 +1000581 }
IhorNehrutsa1ea82b62022-06-28 16:38:45 +0300582 case MP_QSTR_hostname:
Damien George5adb1fa2021-12-10 23:28:46 +1100583 case MP_QSTR_dhcp_hostname: {
Jim Mussaredeb51ca42023-02-01 14:20:45 +1100584 // TODO: Deprecated. Use network.hostname() instead.
585 req_if = WIFI_IF_STA;
586 val = mp_obj_new_str(mod_network_hostname, strlen(mod_network_hostname));
Damien Georgeea186de2021-09-22 00:35:46 +1000587 break;
588 }
Damien George5adb1fa2021-12-10 23:28:46 +1100589 case MP_QSTR_max_clients: {
Damien Georgeea186de2021-09-22 00:35:46 +1000590 val = MP_OBJ_NEW_SMALL_INT(cfg.ap.max_connection);
591 break;
592 }
Damien George5adb1fa2021-12-10 23:28:46 +1100593 case MP_QSTR_reconnects:
Damien Georgeea186de2021-09-22 00:35:46 +1000594 req_if = WIFI_IF_STA;
595 int rec = conf_wifi_sta_reconnects - 1;
596 val = MP_OBJ_NEW_SMALL_INT(rec);
597 break;
wemosff28d2e2022-04-11 20:12:57 +0800598 case MP_QSTR_txpower: {
599 int8_t power;
600 esp_exceptions(esp_wifi_get_max_tx_power(&power));
601 val = mp_obj_new_float(power * 0.25);
602 break;
603 }
glenn2076f2e3e2022-07-31 18:17:40 +1000604 case MP_QSTR_protocol: {
605 uint8_t protocol_bitmap;
606 esp_exceptions(esp_wifi_get_protocol(self->if_id, &protocol_bitmap));
607 val = MP_OBJ_NEW_SMALL_INT(protocol_bitmap);
608 break;
609 }
glenn201093dea2022-08-25 16:55:57 +1000610 case MP_QSTR_pm: {
611 wifi_ps_type_t ps_type;
612 esp_exceptions(esp_wifi_get_ps(&ps_type));
613 val = MP_OBJ_NEW_SMALL_INT(ps_type);
614 break;
615 }
Damien Georgeea186de2021-09-22 00:35:46 +1000616 default:
617 goto unknown;
618 }
619
Damien Georgeea186de2021-09-22 00:35:46 +1000620 // We post-check interface requirements to save on code size
621 if (req_if >= 0) {
622 require_if(args[0], req_if);
623 }
624
625 return val;
626
627unknown:
628 mp_raise_ValueError(MP_ERROR_TEXT("unknown config param"));
629}
630MP_DEFINE_CONST_FUN_OBJ_KW(network_wlan_config_obj, 1, network_wlan_config);
631
632STATIC const mp_rom_map_elem_t wlan_if_locals_dict_table[] = {
633 { MP_ROM_QSTR(MP_QSTR_active), MP_ROM_PTR(&network_wlan_active_obj) },
634 { MP_ROM_QSTR(MP_QSTR_connect), MP_ROM_PTR(&network_wlan_connect_obj) },
635 { MP_ROM_QSTR(MP_QSTR_disconnect), MP_ROM_PTR(&network_wlan_disconnect_obj) },
636 { MP_ROM_QSTR(MP_QSTR_status), MP_ROM_PTR(&network_wlan_status_obj) },
637 { MP_ROM_QSTR(MP_QSTR_scan), MP_ROM_PTR(&network_wlan_scan_obj) },
638 { MP_ROM_QSTR(MP_QSTR_isconnected), MP_ROM_PTR(&network_wlan_isconnected_obj) },
639 { MP_ROM_QSTR(MP_QSTR_config), MP_ROM_PTR(&network_wlan_config_obj) },
Jim Mussaredeb51ca42023-02-01 14:20:45 +1100640 { MP_ROM_QSTR(MP_QSTR_ifconfig), MP_ROM_PTR(&esp_network_ifconfig_obj) },
glenn201093dea2022-08-25 16:55:57 +1000641
642 // Constants
643 { MP_ROM_QSTR(MP_QSTR_PM_NONE), MP_ROM_INT(WIFI_PS_NONE) },
644 { MP_ROM_QSTR(MP_QSTR_PM_PERFORMANCE), MP_ROM_INT(WIFI_PS_MIN_MODEM) },
645 { MP_ROM_QSTR(MP_QSTR_PM_POWERSAVE), MP_ROM_INT(WIFI_PS_MAX_MODEM) },
Damien Georgeea186de2021-09-22 00:35:46 +1000646};
647STATIC MP_DEFINE_CONST_DICT(wlan_if_locals_dict, wlan_if_locals_dict_table);
648
Jim Mussared662b9762021-07-14 14:38:38 +1000649MP_DEFINE_CONST_OBJ_TYPE(
Damien George53cb0732023-05-11 11:51:02 +1000650 esp_network_wlan_type,
Jim Mussared662b9762021-07-14 14:38:38 +1000651 MP_QSTR_WLAN,
652 MP_TYPE_FLAG_NONE,
Damien George53cb0732023-05-11 11:51:02 +1000653 make_new, network_wlan_make_new,
Jim Mussared9dce8272022-06-24 16:27:46 +1000654 locals_dict, &wlan_if_locals_dict
Jim Mussared662b9762021-07-14 14:38:38 +1000655 );
656
Damien George53cb0732023-05-11 11:51:02 +1000657STATIC const wlan_if_obj_t wlan_sta_obj = {{&esp_network_wlan_type}, WIFI_IF_STA};
658STATIC const wlan_if_obj_t wlan_ap_obj = {{&esp_network_wlan_type}, WIFI_IF_AP};
Damien Georgeea186de2021-09-22 00:35:46 +1000659
660#endif // MICROPY_PY_NETWORK_WLAN