blob: 63f01dfc25f5f2e23119835c2d591c6c85f3c351 [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
45#if MICROPY_PY_NETWORK_WLAN
46
47#if (WIFI_MODE_STA & WIFI_MODE_AP != WIFI_MODE_NULL || WIFI_MODE_STA | WIFI_MODE_AP != WIFI_MODE_APSTA)
48#error WIFI_MODE_STA and WIFI_MODE_AP are supposed to be bitfields!
49#endif
50
Damien Georgee4650122023-05-09 09:52:54 +100051typedef base_if_obj_t wlan_if_obj_t;
52
53STATIC wlan_if_obj_t wlan_sta_obj;
54STATIC wlan_if_obj_t wlan_ap_obj;
Damien Georgeea186de2021-09-22 00:35:46 +100055
56// Set to "true" if esp_wifi_start() was called
57static bool wifi_started = false;
58
59// Set to "true" if the STA interface is requested to be connected by the
60// user, used for automatic reassociation.
61static bool wifi_sta_connect_requested = false;
62
63// Set to "true" if the STA interface is connected to wifi and has IP address.
64static bool wifi_sta_connected = false;
65
66// Store the current status. 0 means None here, safe to do so as first enum value is WIFI_REASON_UNSPECIFIED=1.
67static uint8_t wifi_sta_disconn_reason = 0;
68
69#if MICROPY_HW_ENABLE_MDNS_QUERIES || MICROPY_HW_ENABLE_MDNS_RESPONDER
70// Whether mDNS has been initialised or not
71static bool mdns_initialised = false;
72#endif
73
74static uint8_t conf_wifi_sta_reconnects = 0;
75static uint8_t wifi_sta_reconnects;
76
77// This function is called by the system-event task and so runs in a different
78// thread to the main MicroPython task. It must not raise any Python exceptions.
Damien Georgee4650122023-05-09 09:52:54 +100079static void network_wlan_wifi_event_handler(void *event_handler_arg, esp_event_base_t event_base, int32_t event_id, void *event_data) {
80 switch (event_id) {
81 case WIFI_EVENT_STA_START:
Damien Georgeea186de2021-09-22 00:35:46 +100082 ESP_LOGI("wifi", "STA_START");
83 wifi_sta_reconnects = 0;
84 break;
Damien Georgee4650122023-05-09 09:52:54 +100085
86 case WIFI_EVENT_STA_CONNECTED:
Damien Georgeea186de2021-09-22 00:35:46 +100087 ESP_LOGI("network", "CONNECTED");
88 break;
Damien Georgee4650122023-05-09 09:52:54 +100089
90 case WIFI_EVENT_STA_DISCONNECTED: {
Damien Georgeea186de2021-09-22 00:35:46 +100091 // This is a workaround as ESP32 WiFi libs don't currently
92 // auto-reassociate.
Damien Georgee4650122023-05-09 09:52:54 +100093
94 wifi_event_sta_disconnected_t *disconn = event_data;
Damien Georgeea186de2021-09-22 00:35:46 +100095 char *message = "";
96 wifi_sta_disconn_reason = disconn->reason;
97 switch (disconn->reason) {
98 case WIFI_REASON_BEACON_TIMEOUT:
99 // AP has dropped out; try to reconnect.
100 message = "\nbeacon timeout";
101 break;
102 case WIFI_REASON_NO_AP_FOUND:
103 // AP may not exist, or it may have momentarily dropped out; try to reconnect.
104 message = "\nno AP found";
105 break;
106 case WIFI_REASON_AUTH_FAIL:
107 // Password may be wrong, or it just failed to connect; try to reconnect.
108 message = "\nauthentication failed";
109 break;
110 default:
111 // Let other errors through and try to reconnect.
112 break;
113 }
114 ESP_LOGI("wifi", "STA_DISCONNECTED, reason:%d%s", disconn->reason, message);
115
116 wifi_sta_connected = false;
117 if (wifi_sta_connect_requested) {
118 wifi_mode_t mode;
119 if (esp_wifi_get_mode(&mode) != ESP_OK) {
120 break;
121 }
122 if (!(mode & WIFI_MODE_STA)) {
123 break;
124 }
125 if (conf_wifi_sta_reconnects) {
126 ESP_LOGI("wifi", "reconnect counter=%d, max=%d",
127 wifi_sta_reconnects, conf_wifi_sta_reconnects);
128 if (++wifi_sta_reconnects >= conf_wifi_sta_reconnects) {
129 break;
130 }
131 }
132 esp_err_t e = esp_wifi_connect();
133 if (e != ESP_OK) {
134 ESP_LOGI("wifi", "error attempting to reconnect: 0x%04x", e);
135 }
136 }
137 break;
138 }
139 default:
140 break;
141 }
142}
143
Damien Georgee4650122023-05-09 09:52:54 +1000144static void network_wlan_ip_event_handler(void *event_handler_arg, esp_event_base_t event_base, int32_t event_id, void *event_data) {
145 switch (event_id) {
146 case IP_EVENT_STA_GOT_IP:
147 ESP_LOGI("network", "GOT_IP");
148 wifi_sta_connected = true;
149 wifi_sta_disconn_reason = 0; // Success so clear error. (in case of new error will be replaced anyway)
150 #if MICROPY_HW_ENABLE_MDNS_QUERIES || MICROPY_HW_ENABLE_MDNS_RESPONDER
151 if (!mdns_initialised) {
152 mdns_init();
153 #if MICROPY_HW_ENABLE_MDNS_RESPONDER
154 mdns_hostname_set(mod_network_hostname);
155 mdns_instance_name_set(mod_network_hostname);
156 #endif
157 mdns_initialised = true;
158 }
159 #endif
160 break;
161
162 default:
163 break;
Damien Georgeea186de2021-09-22 00:35:46 +1000164 }
165}
166
Damien Georgee4650122023-05-09 09:52:54 +1000167STATIC void require_if(mp_obj_t wlan_if, int if_no) {
168 wlan_if_obj_t *self = MP_OBJ_TO_PTR(wlan_if);
169 if (self->if_id != if_no) {
170 mp_raise_msg(&mp_type_OSError, if_no == ESP_IF_WIFI_STA ? MP_ERROR_TEXT("STA required") : MP_ERROR_TEXT("AP required"));
171 }
172}
173
174void esp_initialise_wifi(void) {
Glenn Moloney7fa322a2020-09-24 15:37:04 +1000175 static int wifi_initialized = 0;
176 if (!wifi_initialized) {
Damien Georgee4650122023-05-09 09:52:54 +1000177 esp_exceptions(esp_event_handler_instance_register(WIFI_EVENT, ESP_EVENT_ANY_ID, network_wlan_wifi_event_handler, NULL, NULL));
178 esp_exceptions(esp_event_handler_instance_register(IP_EVENT, ESP_EVENT_ANY_ID, network_wlan_ip_event_handler, NULL, NULL));
179
180 wlan_sta_obj.base.type = &esp_network_wlan_type;
181 wlan_sta_obj.if_id = ESP_IF_WIFI_STA;
182 wlan_sta_obj.netif = esp_netif_create_default_wifi_sta();
183
184 wlan_ap_obj.base.type = &esp_network_wlan_type;
185 wlan_ap_obj.if_id = ESP_IF_WIFI_AP;
186 wlan_ap_obj.netif = esp_netif_create_default_wifi_ap();
187
Damien Georgeea186de2021-09-22 00:35:46 +1000188 wifi_init_config_t cfg = WIFI_INIT_CONFIG_DEFAULT();
189 ESP_LOGD("modnetwork", "Initializing WiFi");
190 esp_exceptions(esp_wifi_init(&cfg));
191 esp_exceptions(esp_wifi_set_storage(WIFI_STORAGE_RAM));
Damien Georgee4650122023-05-09 09:52:54 +1000192
Damien Georgeea186de2021-09-22 00:35:46 +1000193 ESP_LOGD("modnetwork", "Initialized");
Glenn Moloney7fa322a2020-09-24 15:37:04 +1000194 wifi_initialized = 1;
Damien Georgeea186de2021-09-22 00:35:46 +1000195 }
Glenn Moloney7fa322a2020-09-24 15:37:04 +1000196}
197
Damien George53cb0732023-05-11 11:51:02 +1000198STATIC 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) {
199 mp_arg_check_num(n_args, n_kw, 0, 1, false);
200
Glenn Moloney7fa322a2020-09-24 15:37:04 +1000201 esp_initialise_wifi();
Damien Georgeea186de2021-09-22 00:35:46 +1000202
Damien Georgee4650122023-05-09 09:52:54 +1000203 int idx = (n_args > 0) ? mp_obj_get_int(args[0]) : ESP_IF_WIFI_STA;
204 if (idx == ESP_IF_WIFI_STA) {
Damien Georgeea186de2021-09-22 00:35:46 +1000205 return MP_OBJ_FROM_PTR(&wlan_sta_obj);
Damien Georgee4650122023-05-09 09:52:54 +1000206 } else if (idx == ESP_IF_WIFI_AP) {
Damien Georgeea186de2021-09-22 00:35:46 +1000207 return MP_OBJ_FROM_PTR(&wlan_ap_obj);
208 } else {
209 mp_raise_ValueError(MP_ERROR_TEXT("invalid WLAN interface identifier"));
210 }
211}
Damien Georgeea186de2021-09-22 00:35:46 +1000212
213STATIC mp_obj_t network_wlan_active(size_t n_args, const mp_obj_t *args) {
214 wlan_if_obj_t *self = MP_OBJ_TO_PTR(args[0]);
215
216 wifi_mode_t mode;
217 if (!wifi_started) {
218 mode = WIFI_MODE_NULL;
219 } else {
220 esp_exceptions(esp_wifi_get_mode(&mode));
221 }
222
Damien Georgee4650122023-05-09 09:52:54 +1000223 int bit = (self->if_id == ESP_IF_WIFI_STA) ? WIFI_MODE_STA : WIFI_MODE_AP;
Damien Georgeea186de2021-09-22 00:35:46 +1000224
225 if (n_args > 1) {
226 bool active = mp_obj_is_true(args[1]);
227 mode = active ? (mode | bit) : (mode & ~bit);
228 if (mode == WIFI_MODE_NULL) {
229 if (wifi_started) {
230 esp_exceptions(esp_wifi_stop());
231 wifi_started = false;
232 }
233 } else {
234 esp_exceptions(esp_wifi_set_mode(mode));
235 if (!wifi_started) {
236 esp_exceptions(esp_wifi_start());
237 wifi_started = true;
238 }
239 }
robert-hhd6bc34a2023-01-19 12:42:09 +0100240 // This delay is a band-aid patch for issues #8289, #8792 and #9236,
241 // allowing the esp data structures to settle. It looks like some
242 // kind of race condition, which is not yet found. But at least
243 // this small delay seems not hurt much, since wlan.active() is
244 // usually not called in a time critical part of the code.
245 mp_hal_delay_ms(1);
Damien Georgeea186de2021-09-22 00:35:46 +1000246 }
247
248 return (mode & bit) ? mp_const_true : mp_const_false;
249}
250STATIC MP_DEFINE_CONST_FUN_OBJ_VAR_BETWEEN(network_wlan_active_obj, 1, 2, network_wlan_active);
251
252STATIC 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 +0200253 enum { ARG_ssid, ARG_key, ARG_bssid };
Damien Georgeea186de2021-09-22 00:35:46 +1000254 static const mp_arg_t allowed_args[] = {
255 { MP_QSTR_, MP_ARG_OBJ, {.u_obj = mp_const_none} },
256 { MP_QSTR_, MP_ARG_OBJ, {.u_obj = mp_const_none} },
257 { MP_QSTR_bssid, MP_ARG_KW_ONLY | MP_ARG_OBJ, {.u_obj = mp_const_none} },
258 };
259
260 // parse args
261 mp_arg_val_t args[MP_ARRAY_SIZE(allowed_args)];
262 mp_arg_parse_all(n_args - 1, pos_args + 1, kw_args, MP_ARRAY_SIZE(allowed_args), allowed_args, args);
263
264 wifi_config_t wifi_sta_config = {0};
265
266 // configure any parameters that are given
267 if (n_args > 1) {
268 size_t len;
269 const char *p;
270 if (args[ARG_ssid].u_obj != mp_const_none) {
271 p = mp_obj_str_get_data(args[ARG_ssid].u_obj, &len);
272 memcpy(wifi_sta_config.sta.ssid, p, MIN(len, sizeof(wifi_sta_config.sta.ssid)));
273 }
iabdalkadera7c7feb2022-06-04 12:22:55 +0200274 if (args[ARG_key].u_obj != mp_const_none) {
275 p = mp_obj_str_get_data(args[ARG_key].u_obj, &len);
Damien Georgeea186de2021-09-22 00:35:46 +1000276 memcpy(wifi_sta_config.sta.password, p, MIN(len, sizeof(wifi_sta_config.sta.password)));
277 }
278 if (args[ARG_bssid].u_obj != mp_const_none) {
279 p = mp_obj_str_get_data(args[ARG_bssid].u_obj, &len);
280 if (len != sizeof(wifi_sta_config.sta.bssid)) {
281 mp_raise_ValueError(NULL);
282 }
283 wifi_sta_config.sta.bssid_set = 1;
284 memcpy(wifi_sta_config.sta.bssid, p, sizeof(wifi_sta_config.sta.bssid));
285 }
286 esp_exceptions(esp_wifi_set_config(ESP_IF_WIFI_STA, &wifi_sta_config));
287 }
288
Damien Georgee4650122023-05-09 09:52:54 +1000289 esp_exceptions(esp_netif_set_hostname(wlan_sta_obj.netif, mod_network_hostname));
Jim Mussaredeb51ca42023-02-01 14:20:45 +1100290
Damien Georgeea186de2021-09-22 00:35:46 +1000291 wifi_sta_reconnects = 0;
292 // connect to the WiFi AP
293 MP_THREAD_GIL_EXIT();
294 esp_exceptions(esp_wifi_connect());
295 MP_THREAD_GIL_ENTER();
296 wifi_sta_connect_requested = true;
297
298 return mp_const_none;
299}
300STATIC MP_DEFINE_CONST_FUN_OBJ_KW(network_wlan_connect_obj, 1, network_wlan_connect);
301
302STATIC mp_obj_t network_wlan_disconnect(mp_obj_t self_in) {
303 wifi_sta_connect_requested = false;
304 esp_exceptions(esp_wifi_disconnect());
305 return mp_const_none;
306}
307STATIC MP_DEFINE_CONST_FUN_OBJ_1(network_wlan_disconnect_obj, network_wlan_disconnect);
308
309STATIC mp_obj_t network_wlan_status(size_t n_args, const mp_obj_t *args) {
310 wlan_if_obj_t *self = MP_OBJ_TO_PTR(args[0]);
311 if (n_args == 1) {
Damien Georgee4650122023-05-09 09:52:54 +1000312 if (self->if_id == ESP_IF_WIFI_STA) {
Damien Georgeea186de2021-09-22 00:35:46 +1000313 // Case of no arg is only for the STA interface
314 if (wifi_sta_connected) {
315 // Happy path, connected with IP
316 return MP_OBJ_NEW_SMALL_INT(STAT_GOT_IP);
317 } else if (wifi_sta_connect_requested
318 && (conf_wifi_sta_reconnects == 0
319 || wifi_sta_reconnects < conf_wifi_sta_reconnects)) {
320 // No connection or error, but is requested = Still connecting
321 return MP_OBJ_NEW_SMALL_INT(STAT_CONNECTING);
322 } else if (wifi_sta_disconn_reason == 0) {
323 // No activity, No error = Idle
324 return MP_OBJ_NEW_SMALL_INT(STAT_IDLE);
325 } else {
326 // Simply pass the error through from ESP-identifier
327 return MP_OBJ_NEW_SMALL_INT(wifi_sta_disconn_reason);
328 }
329 }
330 return mp_const_none;
331 }
332
333 // one argument: return status based on query parameter
334 switch ((uintptr_t)args[1]) {
335 case (uintptr_t)MP_OBJ_NEW_QSTR(MP_QSTR_stations): {
336 // return list of connected stations, only if in soft-AP mode
Damien Georgee4650122023-05-09 09:52:54 +1000337 require_if(args[0], ESP_IF_WIFI_AP);
Damien Georgeea186de2021-09-22 00:35:46 +1000338 wifi_sta_list_t station_list;
339 esp_exceptions(esp_wifi_ap_get_sta_list(&station_list));
340 wifi_sta_info_t *stations = (wifi_sta_info_t *)station_list.sta;
341 mp_obj_t list = mp_obj_new_list(0, NULL);
342 for (int i = 0; i < station_list.num; ++i) {
343 mp_obj_tuple_t *t = mp_obj_new_tuple(1, NULL);
344 t->items[0] = mp_obj_new_bytes(stations[i].mac, sizeof(stations[i].mac));
345 mp_obj_list_append(list, t);
346 }
347 return list;
348 }
349 case (uintptr_t)MP_OBJ_NEW_QSTR(MP_QSTR_rssi): {
350 // return signal of AP, only in STA mode
Damien Georgee4650122023-05-09 09:52:54 +1000351 require_if(args[0], ESP_IF_WIFI_STA);
Damien Georgeea186de2021-09-22 00:35:46 +1000352
353 wifi_ap_record_t info;
354 esp_exceptions(esp_wifi_sta_get_ap_info(&info));
355 return MP_OBJ_NEW_SMALL_INT(info.rssi);
356 }
357 default:
358 mp_raise_ValueError(MP_ERROR_TEXT("unknown status param"));
359 }
360
361 return mp_const_none;
362}
363STATIC MP_DEFINE_CONST_FUN_OBJ_VAR_BETWEEN(network_wlan_status_obj, 1, 2, network_wlan_status);
364
365STATIC mp_obj_t network_wlan_scan(mp_obj_t self_in) {
366 // check that STA mode is active
367 wifi_mode_t mode;
368 esp_exceptions(esp_wifi_get_mode(&mode));
369 if ((mode & WIFI_MODE_STA) == 0) {
370 mp_raise_msg(&mp_type_OSError, MP_ERROR_TEXT("STA must be active"));
371 }
372
373 mp_obj_t list = mp_obj_new_list(0, NULL);
374 wifi_scan_config_t config = { 0 };
375 config.show_hidden = true;
376 MP_THREAD_GIL_EXIT();
377 esp_err_t status = esp_wifi_scan_start(&config, 1);
378 MP_THREAD_GIL_ENTER();
379 if (status == 0) {
380 uint16_t count = 0;
381 esp_exceptions(esp_wifi_scan_get_ap_num(&count));
Damien Georgeccaf1972022-06-28 13:15:10 +1000382 if (count == 0) {
383 // esp_wifi_scan_get_ap_records must be called to free internal buffers from the scan.
384 // But it returns an error if wifi_ap_records==NULL. So allocate at least 1 AP entry.
385 // esp_wifi_scan_get_ap_records will then return the actual number of APs in count.
386 count = 1;
387 }
Damien Georgeea186de2021-09-22 00:35:46 +1000388 wifi_ap_record_t *wifi_ap_records = calloc(count, sizeof(wifi_ap_record_t));
389 esp_exceptions(esp_wifi_scan_get_ap_records(&count, wifi_ap_records));
390 for (uint16_t i = 0; i < count; i++) {
391 mp_obj_tuple_t *t = mp_obj_new_tuple(6, NULL);
392 uint8_t *x = memchr(wifi_ap_records[i].ssid, 0, sizeof(wifi_ap_records[i].ssid));
393 int ssid_len = x ? x - wifi_ap_records[i].ssid : sizeof(wifi_ap_records[i].ssid);
394 t->items[0] = mp_obj_new_bytes(wifi_ap_records[i].ssid, ssid_len);
395 t->items[1] = mp_obj_new_bytes(wifi_ap_records[i].bssid, sizeof(wifi_ap_records[i].bssid));
396 t->items[2] = MP_OBJ_NEW_SMALL_INT(wifi_ap_records[i].primary);
397 t->items[3] = MP_OBJ_NEW_SMALL_INT(wifi_ap_records[i].rssi);
398 t->items[4] = MP_OBJ_NEW_SMALL_INT(wifi_ap_records[i].authmode);
399 t->items[5] = mp_const_false; // XXX hidden?
400 mp_obj_list_append(list, MP_OBJ_FROM_PTR(t));
401 }
402 free(wifi_ap_records);
403 }
404 return list;
405}
406STATIC MP_DEFINE_CONST_FUN_OBJ_1(network_wlan_scan_obj, network_wlan_scan);
407
408STATIC mp_obj_t network_wlan_isconnected(mp_obj_t self_in) {
409 wlan_if_obj_t *self = MP_OBJ_TO_PTR(self_in);
Damien Georgee4650122023-05-09 09:52:54 +1000410 if (self->if_id == ESP_IF_WIFI_STA) {
Damien Georgeea186de2021-09-22 00:35:46 +1000411 return mp_obj_new_bool(wifi_sta_connected);
412 } else {
413 wifi_sta_list_t sta;
414 esp_wifi_ap_get_sta_list(&sta);
415 return mp_obj_new_bool(sta.num != 0);
416 }
417}
418STATIC MP_DEFINE_CONST_FUN_OBJ_1(network_wlan_isconnected_obj, network_wlan_isconnected);
419
420STATIC mp_obj_t network_wlan_config(size_t n_args, const mp_obj_t *args, mp_map_t *kwargs) {
421 if (n_args != 1 && kwargs->used != 0) {
422 mp_raise_TypeError(MP_ERROR_TEXT("either pos or kw args are allowed"));
423 }
424
425 wlan_if_obj_t *self = MP_OBJ_TO_PTR(args[0]);
426
Damien Georgee4650122023-05-09 09:52:54 +1000427 bool is_wifi = self->if_id == ESP_IF_WIFI_AP || self->if_id == ESP_IF_WIFI_STA;
Damien Georgeea186de2021-09-22 00:35:46 +1000428
429 wifi_config_t cfg;
430 if (is_wifi) {
431 esp_exceptions(esp_wifi_get_config(self->if_id, &cfg));
432 }
433
Damien Georgeea186de2021-09-22 00:35:46 +1000434 if (kwargs->used != 0) {
435 if (!is_wifi) {
436 goto unknown;
437 }
438
439 for (size_t i = 0; i < kwargs->alloc; i++) {
440 if (mp_map_slot_is_filled(kwargs, i)) {
441 int req_if = -1;
442
Damien George5adb1fa2021-12-10 23:28:46 +1100443 switch (mp_obj_str_get_qstr(kwargs->table[i].key)) {
444 case MP_QSTR_mac: {
Damien Georgeea186de2021-09-22 00:35:46 +1000445 mp_buffer_info_t bufinfo;
446 mp_get_buffer_raise(kwargs->table[i].value, &bufinfo, MP_BUFFER_READ);
447 if (bufinfo.len != 6) {
448 mp_raise_ValueError(MP_ERROR_TEXT("invalid buffer length"));
449 }
450 esp_exceptions(esp_wifi_set_mac(self->if_id, bufinfo.buf));
451 break;
452 }
iabdalkadera7c7feb2022-06-04 12:22:55 +0200453 case MP_QSTR_ssid:
Damien George5adb1fa2021-12-10 23:28:46 +1100454 case MP_QSTR_essid: {
Damien Georgee4650122023-05-09 09:52:54 +1000455 req_if = ESP_IF_WIFI_AP;
Damien Georgeea186de2021-09-22 00:35:46 +1000456 size_t len;
457 const char *s = mp_obj_str_get_data(kwargs->table[i].value, &len);
458 len = MIN(len, sizeof(cfg.ap.ssid));
459 memcpy(cfg.ap.ssid, s, len);
460 cfg.ap.ssid_len = len;
461 break;
462 }
Damien George5adb1fa2021-12-10 23:28:46 +1100463 case MP_QSTR_hidden: {
Damien Georgee4650122023-05-09 09:52:54 +1000464 req_if = ESP_IF_WIFI_AP;
Damien Georgeea186de2021-09-22 00:35:46 +1000465 cfg.ap.ssid_hidden = mp_obj_is_true(kwargs->table[i].value);
466 break;
467 }
iabdalkadera7c7feb2022-06-04 12:22:55 +0200468 case MP_QSTR_security:
Damien George5adb1fa2021-12-10 23:28:46 +1100469 case MP_QSTR_authmode: {
Damien Georgee4650122023-05-09 09:52:54 +1000470 req_if = ESP_IF_WIFI_AP;
Damien Georgeea186de2021-09-22 00:35:46 +1000471 cfg.ap.authmode = mp_obj_get_int(kwargs->table[i].value);
472 break;
473 }
iabdalkadera7c7feb2022-06-04 12:22:55 +0200474 case MP_QSTR_key:
Damien George5adb1fa2021-12-10 23:28:46 +1100475 case MP_QSTR_password: {
Damien Georgee4650122023-05-09 09:52:54 +1000476 req_if = ESP_IF_WIFI_AP;
Damien Georgeea186de2021-09-22 00:35:46 +1000477 size_t len;
478 const char *s = mp_obj_str_get_data(kwargs->table[i].value, &len);
479 len = MIN(len, sizeof(cfg.ap.password) - 1);
480 memcpy(cfg.ap.password, s, len);
481 cfg.ap.password[len] = 0;
482 break;
483 }
Damien George5adb1fa2021-12-10 23:28:46 +1100484 case MP_QSTR_channel: {
glenn2098d1c502022-07-31 16:36:10 +1000485 uint8_t primary;
486 wifi_second_chan_t secondary;
487 // Get the current value of secondary
488 esp_exceptions(esp_wifi_get_channel(&primary, &secondary));
489 primary = mp_obj_get_int(kwargs->table[i].value);
490 esp_err_t err = esp_wifi_set_channel(primary, secondary);
491 if (err == ESP_ERR_INVALID_ARG) {
492 // May need to swap secondary channel above to below or below to above
493 secondary = (
494 (secondary == WIFI_SECOND_CHAN_ABOVE)
495 ? WIFI_SECOND_CHAN_BELOW
496 : (secondary == WIFI_SECOND_CHAN_BELOW)
497 ? WIFI_SECOND_CHAN_ABOVE
498 : WIFI_SECOND_CHAN_NONE);
499 esp_exceptions(esp_wifi_set_channel(primary, secondary));
500 }
Damien Georgeea186de2021-09-22 00:35:46 +1000501 break;
502 }
IhorNehrutsa1ea82b62022-06-28 16:38:45 +0300503 case MP_QSTR_hostname:
Damien George5adb1fa2021-12-10 23:28:46 +1100504 case MP_QSTR_dhcp_hostname: {
Jim Mussaredeb51ca42023-02-01 14:20:45 +1100505 // TODO: Deprecated. Use network.hostname(name) instead.
506 size_t len;
507 const char *str = mp_obj_str_get_data(kwargs->table[i].value, &len);
508 if (len >= MICROPY_PY_NETWORK_HOSTNAME_MAX_LEN) {
509 mp_raise_ValueError(NULL);
510 }
511 strcpy(mod_network_hostname, str);
Damien Georgeea186de2021-09-22 00:35:46 +1000512 break;
513 }
Damien George5adb1fa2021-12-10 23:28:46 +1100514 case MP_QSTR_max_clients: {
Damien Georgee4650122023-05-09 09:52:54 +1000515 req_if = ESP_IF_WIFI_AP;
Damien Georgeea186de2021-09-22 00:35:46 +1000516 cfg.ap.max_connection = mp_obj_get_int(kwargs->table[i].value);
517 break;
518 }
Damien George5adb1fa2021-12-10 23:28:46 +1100519 case MP_QSTR_reconnects: {
Damien Georgeea186de2021-09-22 00:35:46 +1000520 int reconnects = mp_obj_get_int(kwargs->table[i].value);
Damien Georgee4650122023-05-09 09:52:54 +1000521 req_if = ESP_IF_WIFI_STA;
Damien Georgeea186de2021-09-22 00:35:46 +1000522 // parameter reconnects == -1 means to retry forever.
523 // here means conf_wifi_sta_reconnects == 0 to retry forever.
524 conf_wifi_sta_reconnects = (reconnects == -1) ? 0 : reconnects + 1;
525 break;
526 }
wemosff28d2e2022-04-11 20:12:57 +0800527 case MP_QSTR_txpower: {
528 int8_t power = (mp_obj_get_float(kwargs->table[i].value) * 4);
529 esp_exceptions(esp_wifi_set_max_tx_power(power));
530 break;
531 }
glenn2076f2e3e2022-07-31 18:17:40 +1000532 case MP_QSTR_protocol: {
533 esp_exceptions(esp_wifi_set_protocol(self->if_id, mp_obj_get_int(kwargs->table[i].value)));
534 break;
535 }
glenn201093dea2022-08-25 16:55:57 +1000536 case MP_QSTR_pm: {
537 esp_exceptions(esp_wifi_set_ps(mp_obj_get_int(kwargs->table[i].value)));
538 break;
539 }
Damien Georgeea186de2021-09-22 00:35:46 +1000540 default:
541 goto unknown;
542 }
543
544 // We post-check interface requirements to save on code size
545 if (req_if >= 0) {
546 require_if(args[0], req_if);
547 }
548 }
549 }
550
551 esp_exceptions(esp_wifi_set_config(self->if_id, &cfg));
552
553 return mp_const_none;
554 }
555
556 // Get config
557
558 if (n_args != 2) {
559 mp_raise_TypeError(MP_ERROR_TEXT("can query only one param"));
560 }
561
562 int req_if = -1;
563 mp_obj_t val = mp_const_none;
564
Damien George5adb1fa2021-12-10 23:28:46 +1100565 switch (mp_obj_str_get_qstr(args[1])) {
566 case MP_QSTR_mac: {
Damien Georgeea186de2021-09-22 00:35:46 +1000567 uint8_t mac[6];
568 switch (self->if_id) {
Damien Georgee4650122023-05-09 09:52:54 +1000569 case ESP_IF_WIFI_AP: // fallthrough intentional
570 case ESP_IF_WIFI_STA:
Damien Georgeea186de2021-09-22 00:35:46 +1000571 esp_exceptions(esp_wifi_get_mac(self->if_id, mac));
572 return mp_obj_new_bytes(mac, sizeof(mac));
573 default:
574 goto unknown;
575 }
576 }
iabdalkadera7c7feb2022-06-04 12:22:55 +0200577 case MP_QSTR_ssid:
Damien George5adb1fa2021-12-10 23:28:46 +1100578 case MP_QSTR_essid:
Damien Georgeea186de2021-09-22 00:35:46 +1000579 switch (self->if_id) {
Damien Georgee4650122023-05-09 09:52:54 +1000580 case ESP_IF_WIFI_STA:
Damien Georgeea186de2021-09-22 00:35:46 +1000581 val = mp_obj_new_str((char *)cfg.sta.ssid, strlen((char *)cfg.sta.ssid));
582 break;
Damien Georgee4650122023-05-09 09:52:54 +1000583 case ESP_IF_WIFI_AP:
Damien Georgeea186de2021-09-22 00:35:46 +1000584 val = mp_obj_new_str((char *)cfg.ap.ssid, cfg.ap.ssid_len);
585 break;
586 default:
Damien Georgee4650122023-05-09 09:52:54 +1000587 req_if = ESP_IF_WIFI_AP;
Damien Georgeea186de2021-09-22 00:35:46 +1000588 }
589 break;
Damien George5adb1fa2021-12-10 23:28:46 +1100590 case MP_QSTR_hidden:
Damien Georgee4650122023-05-09 09:52:54 +1000591 req_if = ESP_IF_WIFI_AP;
Damien Georgeea186de2021-09-22 00:35:46 +1000592 val = mp_obj_new_bool(cfg.ap.ssid_hidden);
593 break;
iabdalkadera7c7feb2022-06-04 12:22:55 +0200594 case MP_QSTR_security:
Damien George5adb1fa2021-12-10 23:28:46 +1100595 case MP_QSTR_authmode:
Damien Georgee4650122023-05-09 09:52:54 +1000596 req_if = ESP_IF_WIFI_AP;
Damien Georgeea186de2021-09-22 00:35:46 +1000597 val = MP_OBJ_NEW_SMALL_INT(cfg.ap.authmode);
598 break;
glenn2098d1c502022-07-31 16:36:10 +1000599 case MP_QSTR_channel: {
600 uint8_t channel;
601 wifi_second_chan_t second;
602 esp_exceptions(esp_wifi_get_channel(&channel, &second));
603 val = MP_OBJ_NEW_SMALL_INT(channel);
Damien Georgeea186de2021-09-22 00:35:46 +1000604 break;
glenn2098d1c502022-07-31 16:36:10 +1000605 }
IhorNehrutsa1ea82b62022-06-28 16:38:45 +0300606 case MP_QSTR_hostname:
Damien George5adb1fa2021-12-10 23:28:46 +1100607 case MP_QSTR_dhcp_hostname: {
Jim Mussaredeb51ca42023-02-01 14:20:45 +1100608 // TODO: Deprecated. Use network.hostname() instead.
Damien Georgee4650122023-05-09 09:52:54 +1000609 req_if = ESP_IF_WIFI_STA;
Jim Mussaredeb51ca42023-02-01 14:20:45 +1100610 val = mp_obj_new_str(mod_network_hostname, strlen(mod_network_hostname));
Damien Georgeea186de2021-09-22 00:35:46 +1000611 break;
612 }
Damien George5adb1fa2021-12-10 23:28:46 +1100613 case MP_QSTR_max_clients: {
Damien Georgeea186de2021-09-22 00:35:46 +1000614 val = MP_OBJ_NEW_SMALL_INT(cfg.ap.max_connection);
615 break;
616 }
Damien George5adb1fa2021-12-10 23:28:46 +1100617 case MP_QSTR_reconnects:
Damien Georgee4650122023-05-09 09:52:54 +1000618 req_if = ESP_IF_WIFI_STA;
Damien Georgeea186de2021-09-22 00:35:46 +1000619 int rec = conf_wifi_sta_reconnects - 1;
620 val = MP_OBJ_NEW_SMALL_INT(rec);
621 break;
wemosff28d2e2022-04-11 20:12:57 +0800622 case MP_QSTR_txpower: {
623 int8_t power;
624 esp_exceptions(esp_wifi_get_max_tx_power(&power));
625 val = mp_obj_new_float(power * 0.25);
626 break;
627 }
glenn2076f2e3e2022-07-31 18:17:40 +1000628 case MP_QSTR_protocol: {
629 uint8_t protocol_bitmap;
630 esp_exceptions(esp_wifi_get_protocol(self->if_id, &protocol_bitmap));
631 val = MP_OBJ_NEW_SMALL_INT(protocol_bitmap);
632 break;
633 }
glenn201093dea2022-08-25 16:55:57 +1000634 case MP_QSTR_pm: {
635 wifi_ps_type_t ps_type;
636 esp_exceptions(esp_wifi_get_ps(&ps_type));
637 val = MP_OBJ_NEW_SMALL_INT(ps_type);
638 break;
639 }
Damien Georgeea186de2021-09-22 00:35:46 +1000640 default:
641 goto unknown;
642 }
643
Damien Georgeea186de2021-09-22 00:35:46 +1000644 // We post-check interface requirements to save on code size
645 if (req_if >= 0) {
646 require_if(args[0], req_if);
647 }
648
649 return val;
650
651unknown:
652 mp_raise_ValueError(MP_ERROR_TEXT("unknown config param"));
653}
654MP_DEFINE_CONST_FUN_OBJ_KW(network_wlan_config_obj, 1, network_wlan_config);
655
656STATIC const mp_rom_map_elem_t wlan_if_locals_dict_table[] = {
657 { MP_ROM_QSTR(MP_QSTR_active), MP_ROM_PTR(&network_wlan_active_obj) },
658 { MP_ROM_QSTR(MP_QSTR_connect), MP_ROM_PTR(&network_wlan_connect_obj) },
659 { MP_ROM_QSTR(MP_QSTR_disconnect), MP_ROM_PTR(&network_wlan_disconnect_obj) },
660 { MP_ROM_QSTR(MP_QSTR_status), MP_ROM_PTR(&network_wlan_status_obj) },
661 { MP_ROM_QSTR(MP_QSTR_scan), MP_ROM_PTR(&network_wlan_scan_obj) },
662 { MP_ROM_QSTR(MP_QSTR_isconnected), MP_ROM_PTR(&network_wlan_isconnected_obj) },
663 { MP_ROM_QSTR(MP_QSTR_config), MP_ROM_PTR(&network_wlan_config_obj) },
Jim Mussaredeb51ca42023-02-01 14:20:45 +1100664 { MP_ROM_QSTR(MP_QSTR_ifconfig), MP_ROM_PTR(&esp_network_ifconfig_obj) },
glenn201093dea2022-08-25 16:55:57 +1000665
666 // Constants
667 { MP_ROM_QSTR(MP_QSTR_PM_NONE), MP_ROM_INT(WIFI_PS_NONE) },
668 { MP_ROM_QSTR(MP_QSTR_PM_PERFORMANCE), MP_ROM_INT(WIFI_PS_MIN_MODEM) },
669 { MP_ROM_QSTR(MP_QSTR_PM_POWERSAVE), MP_ROM_INT(WIFI_PS_MAX_MODEM) },
Damien Georgeea186de2021-09-22 00:35:46 +1000670};
671STATIC MP_DEFINE_CONST_DICT(wlan_if_locals_dict, wlan_if_locals_dict_table);
672
Jim Mussared662b9762021-07-14 14:38:38 +1000673MP_DEFINE_CONST_OBJ_TYPE(
Damien George53cb0732023-05-11 11:51:02 +1000674 esp_network_wlan_type,
Jim Mussared662b9762021-07-14 14:38:38 +1000675 MP_QSTR_WLAN,
676 MP_TYPE_FLAG_NONE,
Damien George53cb0732023-05-11 11:51:02 +1000677 make_new, network_wlan_make_new,
Jim Mussared9dce8272022-06-24 16:27:46 +1000678 locals_dict, &wlan_if_locals_dict
Jim Mussared662b9762021-07-14 14:38:38 +1000679 );
680
Damien Georgeea186de2021-09-22 00:35:46 +1000681#endif // MICROPY_PY_NETWORK_WLAN