blob: 3c88f8db8682a769fd9ddc0a2e45c012ff4231c4 [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;
Damien Georgebccbaa92023-06-21 17:08:08 +100079static volatile 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");
87 wifi_sta_reconnects = 0;
88 break;
Damien Georgee4650122023-05-09 09:52:54 +100089
90 case WIFI_EVENT_STA_CONNECTED:
Damien Georgeea186de2021-09-22 00:35:46 +100091 ESP_LOGI("network", "CONNECTED");
92 break;
Damien Georgee4650122023-05-09 09:52:54 +100093
94 case WIFI_EVENT_STA_DISCONNECTED: {
Damien Georgeea186de2021-09-22 00:35:46 +100095 // This is a workaround as ESP32 WiFi libs don't currently
96 // auto-reassociate.
Damien Georgee4650122023-05-09 09:52:54 +100097
98 wifi_event_sta_disconnected_t *disconn = event_data;
Damien Georgeea186de2021-09-22 00:35:46 +100099 char *message = "";
100 wifi_sta_disconn_reason = disconn->reason;
101 switch (disconn->reason) {
102 case WIFI_REASON_BEACON_TIMEOUT:
103 // AP has dropped out; try to reconnect.
104 message = "\nbeacon timeout";
105 break;
106 case WIFI_REASON_NO_AP_FOUND:
107 // AP may not exist, or it may have momentarily dropped out; try to reconnect.
108 message = "\nno AP found";
109 break;
110 case WIFI_REASON_AUTH_FAIL:
111 // Password may be wrong, or it just failed to connect; try to reconnect.
112 message = "\nauthentication failed";
113 break;
114 default:
115 // Let other errors through and try to reconnect.
116 break;
117 }
118 ESP_LOGI("wifi", "STA_DISCONNECTED, reason:%d%s", disconn->reason, message);
119
120 wifi_sta_connected = false;
121 if (wifi_sta_connect_requested) {
122 wifi_mode_t mode;
123 if (esp_wifi_get_mode(&mode) != ESP_OK) {
124 break;
125 }
126 if (!(mode & WIFI_MODE_STA)) {
127 break;
128 }
129 if (conf_wifi_sta_reconnects) {
130 ESP_LOGI("wifi", "reconnect counter=%d, max=%d",
131 wifi_sta_reconnects, conf_wifi_sta_reconnects);
132 if (++wifi_sta_reconnects >= conf_wifi_sta_reconnects) {
133 break;
134 }
135 }
136 esp_err_t e = esp_wifi_connect();
137 if (e != ESP_OK) {
138 ESP_LOGI("wifi", "error attempting to reconnect: 0x%04x", e);
139 }
140 }
141 break;
142 }
143 default:
144 break;
145 }
146}
147
Damien Georgee4650122023-05-09 09:52:54 +1000148static void network_wlan_ip_event_handler(void *event_handler_arg, esp_event_base_t event_base, int32_t event_id, void *event_data) {
149 switch (event_id) {
150 case IP_EVENT_STA_GOT_IP:
151 ESP_LOGI("network", "GOT_IP");
152 wifi_sta_connected = true;
153 wifi_sta_disconn_reason = 0; // Success so clear error. (in case of new error will be replaced anyway)
154 #if MICROPY_HW_ENABLE_MDNS_QUERIES || MICROPY_HW_ENABLE_MDNS_RESPONDER
155 if (!mdns_initialised) {
156 mdns_init();
157 #if MICROPY_HW_ENABLE_MDNS_RESPONDER
158 mdns_hostname_set(mod_network_hostname);
159 mdns_instance_name_set(mod_network_hostname);
160 #endif
161 mdns_initialised = true;
162 }
163 #endif
164 break;
165
166 default:
167 break;
Damien Georgeea186de2021-09-22 00:35:46 +1000168 }
169}
170
Damien Georgee4650122023-05-09 09:52:54 +1000171STATIC void require_if(mp_obj_t wlan_if, int if_no) {
172 wlan_if_obj_t *self = MP_OBJ_TO_PTR(wlan_if);
173 if (self->if_id != if_no) {
174 mp_raise_msg(&mp_type_OSError, if_no == ESP_IF_WIFI_STA ? MP_ERROR_TEXT("STA required") : MP_ERROR_TEXT("AP required"));
175 }
176}
177
178void esp_initialise_wifi(void) {
Glenn Moloney7fa322a2020-09-24 15:37:04 +1000179 static int wifi_initialized = 0;
180 if (!wifi_initialized) {
Damien Georgee4650122023-05-09 09:52:54 +1000181 esp_exceptions(esp_event_handler_instance_register(WIFI_EVENT, ESP_EVENT_ANY_ID, network_wlan_wifi_event_handler, NULL, NULL));
182 esp_exceptions(esp_event_handler_instance_register(IP_EVENT, ESP_EVENT_ANY_ID, network_wlan_ip_event_handler, NULL, NULL));
183
184 wlan_sta_obj.base.type = &esp_network_wlan_type;
185 wlan_sta_obj.if_id = ESP_IF_WIFI_STA;
186 wlan_sta_obj.netif = esp_netif_create_default_wifi_sta();
187
188 wlan_ap_obj.base.type = &esp_network_wlan_type;
189 wlan_ap_obj.if_id = ESP_IF_WIFI_AP;
190 wlan_ap_obj.netif = esp_netif_create_default_wifi_ap();
191
Damien Georgeea186de2021-09-22 00:35:46 +1000192 wifi_init_config_t cfg = WIFI_INIT_CONFIG_DEFAULT();
193 ESP_LOGD("modnetwork", "Initializing WiFi");
194 esp_exceptions(esp_wifi_init(&cfg));
195 esp_exceptions(esp_wifi_set_storage(WIFI_STORAGE_RAM));
Damien Georgee4650122023-05-09 09:52:54 +1000196
Damien Georgeea186de2021-09-22 00:35:46 +1000197 ESP_LOGD("modnetwork", "Initialized");
Glenn Moloney7fa322a2020-09-24 15:37:04 +1000198 wifi_initialized = 1;
Damien Georgeea186de2021-09-22 00:35:46 +1000199 }
Glenn Moloney7fa322a2020-09-24 15:37:04 +1000200}
201
Damien George53cb0732023-05-11 11:51:02 +1000202STATIC 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) {
203 mp_arg_check_num(n_args, n_kw, 0, 1, false);
204
Glenn Moloney7fa322a2020-09-24 15:37:04 +1000205 esp_initialise_wifi();
Damien Georgeea186de2021-09-22 00:35:46 +1000206
Damien Georgee4650122023-05-09 09:52:54 +1000207 int idx = (n_args > 0) ? mp_obj_get_int(args[0]) : ESP_IF_WIFI_STA;
208 if (idx == ESP_IF_WIFI_STA) {
Damien Georgeea186de2021-09-22 00:35:46 +1000209 return MP_OBJ_FROM_PTR(&wlan_sta_obj);
Damien Georgee4650122023-05-09 09:52:54 +1000210 } else if (idx == ESP_IF_WIFI_AP) {
Damien Georgeea186de2021-09-22 00:35:46 +1000211 return MP_OBJ_FROM_PTR(&wlan_ap_obj);
212 } else {
213 mp_raise_ValueError(MP_ERROR_TEXT("invalid WLAN interface identifier"));
214 }
215}
Damien Georgeea186de2021-09-22 00:35:46 +1000216
217STATIC mp_obj_t network_wlan_active(size_t n_args, const mp_obj_t *args) {
218 wlan_if_obj_t *self = MP_OBJ_TO_PTR(args[0]);
219
220 wifi_mode_t mode;
221 if (!wifi_started) {
222 mode = WIFI_MODE_NULL;
223 } else {
224 esp_exceptions(esp_wifi_get_mode(&mode));
225 }
226
Damien Georgee4650122023-05-09 09:52:54 +1000227 int bit = (self->if_id == ESP_IF_WIFI_STA) ? WIFI_MODE_STA : WIFI_MODE_AP;
Damien Georgeea186de2021-09-22 00:35:46 +1000228
229 if (n_args > 1) {
230 bool active = mp_obj_is_true(args[1]);
231 mode = active ? (mode | bit) : (mode & ~bit);
232 if (mode == WIFI_MODE_NULL) {
233 if (wifi_started) {
234 esp_exceptions(esp_wifi_stop());
235 wifi_started = false;
236 }
237 } else {
238 esp_exceptions(esp_wifi_set_mode(mode));
239 if (!wifi_started) {
Damien Georgebccbaa92023-06-21 17:08:08 +1000240 // WIFI_EVENT_STA_START must be received before esp_wifi_connect() can be called.
241 // Use the `wifi_sta_reconnects` variable to detect that event.
242 wifi_sta_reconnects = 1;
Damien Georgeea186de2021-09-22 00:35:46 +1000243 esp_exceptions(esp_wifi_start());
244 wifi_started = true;
Damien Georgebccbaa92023-06-21 17:08:08 +1000245 while (wifi_sta_reconnects != 0) {
246 MICROPY_EVENT_POLL_HOOK;
247 }
Damien Georgeea186de2021-09-22 00:35:46 +1000248 }
249 }
250 }
251
252 return (mode & bit) ? mp_const_true : mp_const_false;
253}
254STATIC MP_DEFINE_CONST_FUN_OBJ_VAR_BETWEEN(network_wlan_active_obj, 1, 2, network_wlan_active);
255
256STATIC 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 +0200257 enum { ARG_ssid, ARG_key, ARG_bssid };
Damien Georgeea186de2021-09-22 00:35:46 +1000258 static const mp_arg_t allowed_args[] = {
259 { MP_QSTR_, MP_ARG_OBJ, {.u_obj = mp_const_none} },
260 { MP_QSTR_, MP_ARG_OBJ, {.u_obj = mp_const_none} },
261 { MP_QSTR_bssid, MP_ARG_KW_ONLY | MP_ARG_OBJ, {.u_obj = mp_const_none} },
262 };
263
264 // parse args
265 mp_arg_val_t args[MP_ARRAY_SIZE(allowed_args)];
266 mp_arg_parse_all(n_args - 1, pos_args + 1, kw_args, MP_ARRAY_SIZE(allowed_args), allowed_args, args);
267
268 wifi_config_t wifi_sta_config = {0};
269
270 // configure any parameters that are given
271 if (n_args > 1) {
272 size_t len;
273 const char *p;
274 if (args[ARG_ssid].u_obj != mp_const_none) {
275 p = mp_obj_str_get_data(args[ARG_ssid].u_obj, &len);
276 memcpy(wifi_sta_config.sta.ssid, p, MIN(len, sizeof(wifi_sta_config.sta.ssid)));
277 }
iabdalkadera7c7feb2022-06-04 12:22:55 +0200278 if (args[ARG_key].u_obj != mp_const_none) {
279 p = mp_obj_str_get_data(args[ARG_key].u_obj, &len);
Damien Georgeea186de2021-09-22 00:35:46 +1000280 memcpy(wifi_sta_config.sta.password, p, MIN(len, sizeof(wifi_sta_config.sta.password)));
281 }
282 if (args[ARG_bssid].u_obj != mp_const_none) {
283 p = mp_obj_str_get_data(args[ARG_bssid].u_obj, &len);
284 if (len != sizeof(wifi_sta_config.sta.bssid)) {
285 mp_raise_ValueError(NULL);
286 }
287 wifi_sta_config.sta.bssid_set = 1;
288 memcpy(wifi_sta_config.sta.bssid, p, sizeof(wifi_sta_config.sta.bssid));
289 }
290 esp_exceptions(esp_wifi_set_config(ESP_IF_WIFI_STA, &wifi_sta_config));
291 }
292
Damien Georgee4650122023-05-09 09:52:54 +1000293 esp_exceptions(esp_netif_set_hostname(wlan_sta_obj.netif, mod_network_hostname));
Jim Mussaredeb51ca42023-02-01 14:20:45 +1100294
Damien Georgeea186de2021-09-22 00:35:46 +1000295 wifi_sta_reconnects = 0;
296 // connect to the WiFi AP
297 MP_THREAD_GIL_EXIT();
298 esp_exceptions(esp_wifi_connect());
299 MP_THREAD_GIL_ENTER();
300 wifi_sta_connect_requested = true;
301
302 return mp_const_none;
303}
304STATIC MP_DEFINE_CONST_FUN_OBJ_KW(network_wlan_connect_obj, 1, network_wlan_connect);
305
306STATIC mp_obj_t network_wlan_disconnect(mp_obj_t self_in) {
307 wifi_sta_connect_requested = false;
308 esp_exceptions(esp_wifi_disconnect());
309 return mp_const_none;
310}
311STATIC MP_DEFINE_CONST_FUN_OBJ_1(network_wlan_disconnect_obj, network_wlan_disconnect);
312
313STATIC mp_obj_t network_wlan_status(size_t n_args, const mp_obj_t *args) {
314 wlan_if_obj_t *self = MP_OBJ_TO_PTR(args[0]);
315 if (n_args == 1) {
Damien Georgee4650122023-05-09 09:52:54 +1000316 if (self->if_id == ESP_IF_WIFI_STA) {
Damien Georgeea186de2021-09-22 00:35:46 +1000317 // Case of no arg is only for the STA interface
318 if (wifi_sta_connected) {
319 // Happy path, connected with IP
320 return MP_OBJ_NEW_SMALL_INT(STAT_GOT_IP);
321 } else if (wifi_sta_connect_requested
322 && (conf_wifi_sta_reconnects == 0
323 || wifi_sta_reconnects < conf_wifi_sta_reconnects)) {
324 // No connection or error, but is requested = Still connecting
325 return MP_OBJ_NEW_SMALL_INT(STAT_CONNECTING);
326 } else if (wifi_sta_disconn_reason == 0) {
327 // No activity, No error = Idle
328 return MP_OBJ_NEW_SMALL_INT(STAT_IDLE);
329 } else {
330 // Simply pass the error through from ESP-identifier
331 return MP_OBJ_NEW_SMALL_INT(wifi_sta_disconn_reason);
332 }
333 }
334 return mp_const_none;
335 }
336
337 // one argument: return status based on query parameter
338 switch ((uintptr_t)args[1]) {
339 case (uintptr_t)MP_OBJ_NEW_QSTR(MP_QSTR_stations): {
340 // return list of connected stations, only if in soft-AP mode
Damien Georgee4650122023-05-09 09:52:54 +1000341 require_if(args[0], ESP_IF_WIFI_AP);
Damien Georgeea186de2021-09-22 00:35:46 +1000342 wifi_sta_list_t station_list;
343 esp_exceptions(esp_wifi_ap_get_sta_list(&station_list));
344 wifi_sta_info_t *stations = (wifi_sta_info_t *)station_list.sta;
345 mp_obj_t list = mp_obj_new_list(0, NULL);
346 for (int i = 0; i < station_list.num; ++i) {
347 mp_obj_tuple_t *t = mp_obj_new_tuple(1, NULL);
348 t->items[0] = mp_obj_new_bytes(stations[i].mac, sizeof(stations[i].mac));
349 mp_obj_list_append(list, t);
350 }
351 return list;
352 }
353 case (uintptr_t)MP_OBJ_NEW_QSTR(MP_QSTR_rssi): {
354 // return signal of AP, only in STA mode
Damien Georgee4650122023-05-09 09:52:54 +1000355 require_if(args[0], ESP_IF_WIFI_STA);
Damien Georgeea186de2021-09-22 00:35:46 +1000356
357 wifi_ap_record_t info;
358 esp_exceptions(esp_wifi_sta_get_ap_info(&info));
359 return MP_OBJ_NEW_SMALL_INT(info.rssi);
360 }
361 default:
362 mp_raise_ValueError(MP_ERROR_TEXT("unknown status param"));
363 }
364
365 return mp_const_none;
366}
367STATIC MP_DEFINE_CONST_FUN_OBJ_VAR_BETWEEN(network_wlan_status_obj, 1, 2, network_wlan_status);
368
369STATIC mp_obj_t network_wlan_scan(mp_obj_t self_in) {
370 // check that STA mode is active
371 wifi_mode_t mode;
372 esp_exceptions(esp_wifi_get_mode(&mode));
373 if ((mode & WIFI_MODE_STA) == 0) {
374 mp_raise_msg(&mp_type_OSError, MP_ERROR_TEXT("STA must be active"));
375 }
376
377 mp_obj_t list = mp_obj_new_list(0, NULL);
378 wifi_scan_config_t config = { 0 };
379 config.show_hidden = true;
380 MP_THREAD_GIL_EXIT();
381 esp_err_t status = esp_wifi_scan_start(&config, 1);
382 MP_THREAD_GIL_ENTER();
383 if (status == 0) {
384 uint16_t count = 0;
385 esp_exceptions(esp_wifi_scan_get_ap_num(&count));
Damien Georgeccaf1972022-06-28 13:15:10 +1000386 if (count == 0) {
387 // esp_wifi_scan_get_ap_records must be called to free internal buffers from the scan.
388 // But it returns an error if wifi_ap_records==NULL. So allocate at least 1 AP entry.
389 // esp_wifi_scan_get_ap_records will then return the actual number of APs in count.
390 count = 1;
391 }
Damien Georgeea186de2021-09-22 00:35:46 +1000392 wifi_ap_record_t *wifi_ap_records = calloc(count, sizeof(wifi_ap_record_t));
393 esp_exceptions(esp_wifi_scan_get_ap_records(&count, wifi_ap_records));
394 for (uint16_t i = 0; i < count; i++) {
395 mp_obj_tuple_t *t = mp_obj_new_tuple(6, NULL);
396 uint8_t *x = memchr(wifi_ap_records[i].ssid, 0, sizeof(wifi_ap_records[i].ssid));
397 int ssid_len = x ? x - wifi_ap_records[i].ssid : sizeof(wifi_ap_records[i].ssid);
398 t->items[0] = mp_obj_new_bytes(wifi_ap_records[i].ssid, ssid_len);
399 t->items[1] = mp_obj_new_bytes(wifi_ap_records[i].bssid, sizeof(wifi_ap_records[i].bssid));
400 t->items[2] = MP_OBJ_NEW_SMALL_INT(wifi_ap_records[i].primary);
401 t->items[3] = MP_OBJ_NEW_SMALL_INT(wifi_ap_records[i].rssi);
402 t->items[4] = MP_OBJ_NEW_SMALL_INT(wifi_ap_records[i].authmode);
403 t->items[5] = mp_const_false; // XXX hidden?
404 mp_obj_list_append(list, MP_OBJ_FROM_PTR(t));
405 }
406 free(wifi_ap_records);
407 }
408 return list;
409}
410STATIC MP_DEFINE_CONST_FUN_OBJ_1(network_wlan_scan_obj, network_wlan_scan);
411
412STATIC mp_obj_t network_wlan_isconnected(mp_obj_t self_in) {
413 wlan_if_obj_t *self = MP_OBJ_TO_PTR(self_in);
Damien Georgee4650122023-05-09 09:52:54 +1000414 if (self->if_id == ESP_IF_WIFI_STA) {
Damien Georgeea186de2021-09-22 00:35:46 +1000415 return mp_obj_new_bool(wifi_sta_connected);
416 } else {
417 wifi_sta_list_t sta;
418 esp_wifi_ap_get_sta_list(&sta);
419 return mp_obj_new_bool(sta.num != 0);
420 }
421}
422STATIC MP_DEFINE_CONST_FUN_OBJ_1(network_wlan_isconnected_obj, network_wlan_isconnected);
423
424STATIC mp_obj_t network_wlan_config(size_t n_args, const mp_obj_t *args, mp_map_t *kwargs) {
425 if (n_args != 1 && kwargs->used != 0) {
426 mp_raise_TypeError(MP_ERROR_TEXT("either pos or kw args are allowed"));
427 }
428
429 wlan_if_obj_t *self = MP_OBJ_TO_PTR(args[0]);
430
Damien Georgee4650122023-05-09 09:52:54 +1000431 bool is_wifi = self->if_id == ESP_IF_WIFI_AP || self->if_id == ESP_IF_WIFI_STA;
Damien Georgeea186de2021-09-22 00:35:46 +1000432
433 wifi_config_t cfg;
434 if (is_wifi) {
435 esp_exceptions(esp_wifi_get_config(self->if_id, &cfg));
436 }
437
Damien Georgeea186de2021-09-22 00:35:46 +1000438 if (kwargs->used != 0) {
439 if (!is_wifi) {
440 goto unknown;
441 }
442
443 for (size_t i = 0; i < kwargs->alloc; i++) {
444 if (mp_map_slot_is_filled(kwargs, i)) {
445 int req_if = -1;
446
Damien George5adb1fa2021-12-10 23:28:46 +1100447 switch (mp_obj_str_get_qstr(kwargs->table[i].key)) {
448 case MP_QSTR_mac: {
Damien Georgeea186de2021-09-22 00:35:46 +1000449 mp_buffer_info_t bufinfo;
450 mp_get_buffer_raise(kwargs->table[i].value, &bufinfo, MP_BUFFER_READ);
451 if (bufinfo.len != 6) {
452 mp_raise_ValueError(MP_ERROR_TEXT("invalid buffer length"));
453 }
454 esp_exceptions(esp_wifi_set_mac(self->if_id, bufinfo.buf));
455 break;
456 }
iabdalkadera7c7feb2022-06-04 12:22:55 +0200457 case MP_QSTR_ssid:
Damien George5adb1fa2021-12-10 23:28:46 +1100458 case MP_QSTR_essid: {
Damien Georgee4650122023-05-09 09:52:54 +1000459 req_if = ESP_IF_WIFI_AP;
Damien Georgeea186de2021-09-22 00:35:46 +1000460 size_t len;
461 const char *s = mp_obj_str_get_data(kwargs->table[i].value, &len);
462 len = MIN(len, sizeof(cfg.ap.ssid));
463 memcpy(cfg.ap.ssid, s, len);
464 cfg.ap.ssid_len = len;
465 break;
466 }
Damien George5adb1fa2021-12-10 23:28:46 +1100467 case MP_QSTR_hidden: {
Damien Georgee4650122023-05-09 09:52:54 +1000468 req_if = ESP_IF_WIFI_AP;
Damien Georgeea186de2021-09-22 00:35:46 +1000469 cfg.ap.ssid_hidden = mp_obj_is_true(kwargs->table[i].value);
470 break;
471 }
iabdalkadera7c7feb2022-06-04 12:22:55 +0200472 case MP_QSTR_security:
Damien George5adb1fa2021-12-10 23:28:46 +1100473 case MP_QSTR_authmode: {
Damien Georgee4650122023-05-09 09:52:54 +1000474 req_if = ESP_IF_WIFI_AP;
Damien Georgeea186de2021-09-22 00:35:46 +1000475 cfg.ap.authmode = mp_obj_get_int(kwargs->table[i].value);
476 break;
477 }
iabdalkadera7c7feb2022-06-04 12:22:55 +0200478 case MP_QSTR_key:
Damien George5adb1fa2021-12-10 23:28:46 +1100479 case MP_QSTR_password: {
Damien Georgee4650122023-05-09 09:52:54 +1000480 req_if = ESP_IF_WIFI_AP;
Damien Georgeea186de2021-09-22 00:35:46 +1000481 size_t len;
482 const char *s = mp_obj_str_get_data(kwargs->table[i].value, &len);
483 len = MIN(len, sizeof(cfg.ap.password) - 1);
484 memcpy(cfg.ap.password, s, len);
485 cfg.ap.password[len] = 0;
486 break;
487 }
Damien George5adb1fa2021-12-10 23:28:46 +1100488 case MP_QSTR_channel: {
glenn2098d1c502022-07-31 16:36:10 +1000489 uint8_t primary;
490 wifi_second_chan_t secondary;
491 // Get the current value of secondary
492 esp_exceptions(esp_wifi_get_channel(&primary, &secondary));
493 primary = mp_obj_get_int(kwargs->table[i].value);
494 esp_err_t err = esp_wifi_set_channel(primary, secondary);
495 if (err == ESP_ERR_INVALID_ARG) {
496 // May need to swap secondary channel above to below or below to above
497 secondary = (
498 (secondary == WIFI_SECOND_CHAN_ABOVE)
499 ? WIFI_SECOND_CHAN_BELOW
500 : (secondary == WIFI_SECOND_CHAN_BELOW)
501 ? WIFI_SECOND_CHAN_ABOVE
502 : WIFI_SECOND_CHAN_NONE);
503 esp_exceptions(esp_wifi_set_channel(primary, secondary));
504 }
Damien Georgeea186de2021-09-22 00:35:46 +1000505 break;
506 }
IhorNehrutsa1ea82b62022-06-28 16:38:45 +0300507 case MP_QSTR_hostname:
Damien George5adb1fa2021-12-10 23:28:46 +1100508 case MP_QSTR_dhcp_hostname: {
Jim Mussaredeb51ca42023-02-01 14:20:45 +1100509 // TODO: Deprecated. Use network.hostname(name) instead.
510 size_t len;
511 const char *str = mp_obj_str_get_data(kwargs->table[i].value, &len);
512 if (len >= MICROPY_PY_NETWORK_HOSTNAME_MAX_LEN) {
513 mp_raise_ValueError(NULL);
514 }
515 strcpy(mod_network_hostname, str);
Damien Georgeea186de2021-09-22 00:35:46 +1000516 break;
517 }
Damien George5adb1fa2021-12-10 23:28:46 +1100518 case MP_QSTR_max_clients: {
Damien Georgee4650122023-05-09 09:52:54 +1000519 req_if = ESP_IF_WIFI_AP;
Damien Georgeea186de2021-09-22 00:35:46 +1000520 cfg.ap.max_connection = mp_obj_get_int(kwargs->table[i].value);
521 break;
522 }
Damien George5adb1fa2021-12-10 23:28:46 +1100523 case MP_QSTR_reconnects: {
Damien Georgeea186de2021-09-22 00:35:46 +1000524 int reconnects = mp_obj_get_int(kwargs->table[i].value);
Damien Georgee4650122023-05-09 09:52:54 +1000525 req_if = ESP_IF_WIFI_STA;
Damien Georgeea186de2021-09-22 00:35:46 +1000526 // parameter reconnects == -1 means to retry forever.
527 // here means conf_wifi_sta_reconnects == 0 to retry forever.
528 conf_wifi_sta_reconnects = (reconnects == -1) ? 0 : reconnects + 1;
529 break;
530 }
wemosff28d2e2022-04-11 20:12:57 +0800531 case MP_QSTR_txpower: {
532 int8_t power = (mp_obj_get_float(kwargs->table[i].value) * 4);
533 esp_exceptions(esp_wifi_set_max_tx_power(power));
534 break;
535 }
glenn2076f2e3e2022-07-31 18:17:40 +1000536 case MP_QSTR_protocol: {
537 esp_exceptions(esp_wifi_set_protocol(self->if_id, mp_obj_get_int(kwargs->table[i].value)));
538 break;
539 }
glenn201093dea2022-08-25 16:55:57 +1000540 case MP_QSTR_pm: {
541 esp_exceptions(esp_wifi_set_ps(mp_obj_get_int(kwargs->table[i].value)));
542 break;
543 }
Damien Georgeea186de2021-09-22 00:35:46 +1000544 default:
545 goto unknown;
546 }
547
548 // We post-check interface requirements to save on code size
549 if (req_if >= 0) {
550 require_if(args[0], req_if);
551 }
552 }
553 }
554
555 esp_exceptions(esp_wifi_set_config(self->if_id, &cfg));
556
557 return mp_const_none;
558 }
559
560 // Get config
561
562 if (n_args != 2) {
563 mp_raise_TypeError(MP_ERROR_TEXT("can query only one param"));
564 }
565
566 int req_if = -1;
567 mp_obj_t val = mp_const_none;
568
Damien George5adb1fa2021-12-10 23:28:46 +1100569 switch (mp_obj_str_get_qstr(args[1])) {
570 case MP_QSTR_mac: {
Damien Georgeea186de2021-09-22 00:35:46 +1000571 uint8_t mac[6];
572 switch (self->if_id) {
Damien Georgee4650122023-05-09 09:52:54 +1000573 case ESP_IF_WIFI_AP: // fallthrough intentional
574 case ESP_IF_WIFI_STA:
Damien Georgeea186de2021-09-22 00:35:46 +1000575 esp_exceptions(esp_wifi_get_mac(self->if_id, mac));
576 return mp_obj_new_bytes(mac, sizeof(mac));
577 default:
578 goto unknown;
579 }
580 }
iabdalkadera7c7feb2022-06-04 12:22:55 +0200581 case MP_QSTR_ssid:
Damien George5adb1fa2021-12-10 23:28:46 +1100582 case MP_QSTR_essid:
Damien Georgeea186de2021-09-22 00:35:46 +1000583 switch (self->if_id) {
Damien Georgee4650122023-05-09 09:52:54 +1000584 case ESP_IF_WIFI_STA:
Damien Georgeea186de2021-09-22 00:35:46 +1000585 val = mp_obj_new_str((char *)cfg.sta.ssid, strlen((char *)cfg.sta.ssid));
586 break;
Damien Georgee4650122023-05-09 09:52:54 +1000587 case ESP_IF_WIFI_AP:
Damien Georgeea186de2021-09-22 00:35:46 +1000588 val = mp_obj_new_str((char *)cfg.ap.ssid, cfg.ap.ssid_len);
589 break;
590 default:
Damien Georgee4650122023-05-09 09:52:54 +1000591 req_if = ESP_IF_WIFI_AP;
Damien Georgeea186de2021-09-22 00:35:46 +1000592 }
593 break;
Damien George5adb1fa2021-12-10 23:28:46 +1100594 case MP_QSTR_hidden:
Damien Georgee4650122023-05-09 09:52:54 +1000595 req_if = ESP_IF_WIFI_AP;
Damien Georgeea186de2021-09-22 00:35:46 +1000596 val = mp_obj_new_bool(cfg.ap.ssid_hidden);
597 break;
iabdalkadera7c7feb2022-06-04 12:22:55 +0200598 case MP_QSTR_security:
Damien George5adb1fa2021-12-10 23:28:46 +1100599 case MP_QSTR_authmode:
Damien Georgee4650122023-05-09 09:52:54 +1000600 req_if = ESP_IF_WIFI_AP;
Damien Georgeea186de2021-09-22 00:35:46 +1000601 val = MP_OBJ_NEW_SMALL_INT(cfg.ap.authmode);
602 break;
glenn2098d1c502022-07-31 16:36:10 +1000603 case MP_QSTR_channel: {
604 uint8_t channel;
605 wifi_second_chan_t second;
606 esp_exceptions(esp_wifi_get_channel(&channel, &second));
607 val = MP_OBJ_NEW_SMALL_INT(channel);
Damien Georgeea186de2021-09-22 00:35:46 +1000608 break;
glenn2098d1c502022-07-31 16:36:10 +1000609 }
IhorNehrutsa1ea82b62022-06-28 16:38:45 +0300610 case MP_QSTR_hostname:
Damien George5adb1fa2021-12-10 23:28:46 +1100611 case MP_QSTR_dhcp_hostname: {
Jim Mussaredeb51ca42023-02-01 14:20:45 +1100612 // TODO: Deprecated. Use network.hostname() instead.
Damien Georgee4650122023-05-09 09:52:54 +1000613 req_if = ESP_IF_WIFI_STA;
Jim Mussaredeb51ca42023-02-01 14:20:45 +1100614 val = mp_obj_new_str(mod_network_hostname, strlen(mod_network_hostname));
Damien Georgeea186de2021-09-22 00:35:46 +1000615 break;
616 }
Damien George5adb1fa2021-12-10 23:28:46 +1100617 case MP_QSTR_max_clients: {
Damien Georgeea186de2021-09-22 00:35:46 +1000618 val = MP_OBJ_NEW_SMALL_INT(cfg.ap.max_connection);
619 break;
620 }
Damien George5adb1fa2021-12-10 23:28:46 +1100621 case MP_QSTR_reconnects:
Damien Georgee4650122023-05-09 09:52:54 +1000622 req_if = ESP_IF_WIFI_STA;
Damien Georgeea186de2021-09-22 00:35:46 +1000623 int rec = conf_wifi_sta_reconnects - 1;
624 val = MP_OBJ_NEW_SMALL_INT(rec);
625 break;
wemosff28d2e2022-04-11 20:12:57 +0800626 case MP_QSTR_txpower: {
627 int8_t power;
628 esp_exceptions(esp_wifi_get_max_tx_power(&power));
629 val = mp_obj_new_float(power * 0.25);
630 break;
631 }
glenn2076f2e3e2022-07-31 18:17:40 +1000632 case MP_QSTR_protocol: {
633 uint8_t protocol_bitmap;
634 esp_exceptions(esp_wifi_get_protocol(self->if_id, &protocol_bitmap));
635 val = MP_OBJ_NEW_SMALL_INT(protocol_bitmap);
636 break;
637 }
glenn201093dea2022-08-25 16:55:57 +1000638 case MP_QSTR_pm: {
639 wifi_ps_type_t ps_type;
640 esp_exceptions(esp_wifi_get_ps(&ps_type));
641 val = MP_OBJ_NEW_SMALL_INT(ps_type);
642 break;
643 }
Damien Georgeea186de2021-09-22 00:35:46 +1000644 default:
645 goto unknown;
646 }
647
Damien Georgeea186de2021-09-22 00:35:46 +1000648 // We post-check interface requirements to save on code size
649 if (req_if >= 0) {
650 require_if(args[0], req_if);
651 }
652
653 return val;
654
655unknown:
656 mp_raise_ValueError(MP_ERROR_TEXT("unknown config param"));
657}
658MP_DEFINE_CONST_FUN_OBJ_KW(network_wlan_config_obj, 1, network_wlan_config);
659
660STATIC const mp_rom_map_elem_t wlan_if_locals_dict_table[] = {
661 { MP_ROM_QSTR(MP_QSTR_active), MP_ROM_PTR(&network_wlan_active_obj) },
662 { MP_ROM_QSTR(MP_QSTR_connect), MP_ROM_PTR(&network_wlan_connect_obj) },
663 { MP_ROM_QSTR(MP_QSTR_disconnect), MP_ROM_PTR(&network_wlan_disconnect_obj) },
664 { MP_ROM_QSTR(MP_QSTR_status), MP_ROM_PTR(&network_wlan_status_obj) },
665 { MP_ROM_QSTR(MP_QSTR_scan), MP_ROM_PTR(&network_wlan_scan_obj) },
666 { MP_ROM_QSTR(MP_QSTR_isconnected), MP_ROM_PTR(&network_wlan_isconnected_obj) },
667 { MP_ROM_QSTR(MP_QSTR_config), MP_ROM_PTR(&network_wlan_config_obj) },
Jim Mussaredeb51ca42023-02-01 14:20:45 +1100668 { MP_ROM_QSTR(MP_QSTR_ifconfig), MP_ROM_PTR(&esp_network_ifconfig_obj) },
glenn201093dea2022-08-25 16:55:57 +1000669
670 // Constants
671 { MP_ROM_QSTR(MP_QSTR_PM_NONE), MP_ROM_INT(WIFI_PS_NONE) },
672 { MP_ROM_QSTR(MP_QSTR_PM_PERFORMANCE), MP_ROM_INT(WIFI_PS_MIN_MODEM) },
673 { MP_ROM_QSTR(MP_QSTR_PM_POWERSAVE), MP_ROM_INT(WIFI_PS_MAX_MODEM) },
Damien Georgeea186de2021-09-22 00:35:46 +1000674};
675STATIC MP_DEFINE_CONST_DICT(wlan_if_locals_dict, wlan_if_locals_dict_table);
676
Jim Mussared662b9762021-07-14 14:38:38 +1000677MP_DEFINE_CONST_OBJ_TYPE(
Damien George53cb0732023-05-11 11:51:02 +1000678 esp_network_wlan_type,
Jim Mussared662b9762021-07-14 14:38:38 +1000679 MP_QSTR_WLAN,
680 MP_TYPE_FLAG_NONE,
Damien George53cb0732023-05-11 11:51:02 +1000681 make_new, network_wlan_make_new,
Jim Mussared9dce8272022-06-24 16:27:46 +1000682 locals_dict, &wlan_if_locals_dict
Jim Mussared662b9762021-07-14 14:38:38 +1000683 );
684
Damien Georgeea186de2021-09-22 00:35:46 +1000685#endif // MICROPY_PY_NETWORK_WLAN