Outline ![]()
Files ![]()
loading...
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
/*
* SPDX-FileCopyrightText: 2024 Espressif Systems (Shanghai) CO LTD
*
* SPDX-License-Identifier: Apache-2.0
*/
#include <string.h>
#include "esp_wifi.h"
#include "esp_log.h"
#include "esp_console.h"
#include "argtable3/argtable3.h"
#include "wifi_cmd.h"
#ifndef APP_TAG
#define APP_TAG "WIFI"
#endif
typedef struct {
struct arg_str *ssid;
struct arg_str *password;
struct arg_str *bssid;
struct arg_int *channel;
struct arg_lit *no_disconnect;
struct arg_lit *no_reconnect;
struct arg_lit *full_scan;
#if ESP_IDF_VERSION >= ESP_IDF_VERSION_VAL(5, 1, 1) /* IDF commit: 52b24918f01a2e90f395f4056050511516aa0d6e */
struct arg_int *failure_retry;
#endif
#if ESP_IDF_VERSION >= ESP_IDF_VERSION_VAL(5, 4, 0) && !CONFIG_WIFI_CMD_BASIC_ONLY
struct arg_int *rssi_5g_offset;
#endif
struct arg_end *end;
} sta_connect_args_t;
static sta_connect_args_t sta_connect_args;
typedef struct {
struct arg_str *ssid;
struct arg_str *bssid;
struct arg_int *channel;
struct arg_lit *show_hidden;
/* active scan */
struct arg_int *max;
struct arg_int *min;
/* passive scan */
struct arg_lit *passive;
struct arg_int *passive_time;
#if ESP_IDF_VERSION >= ESP_IDF_VERSION_VAL(5, 3, 0)
struct arg_int *home_chan_dwell_time;
/* scan bitmap */
struct arg_int *bitmap_2g;
struct arg_int *bitmap_5g;
#endif
/* do not show scan details */
struct arg_lit *count_only;
struct arg_end *end;
} sta_scan_args_t;
static sta_scan_args_t scan_args;
static int cmd_do_sta_connect(int argc, char **argv)
{
int nerrors = arg_parse(argc, argv, (void **) &sta_connect_args);
if (nerrors != 0) {
arg_print_errors(stderr, sta_connect_args.end, argv[0]);
return 1;
}
wifi_config_t wifi_config = {
.sta = {
.scan_method = sta_connect_args.full_scan->count > 0 ? WIFI_ALL_CHANNEL_SCAN : WIFI_FAST_SCAN,
.sort_method = WIFI_CONNECT_AP_BY_SIGNAL,
},
};
const char *ssid = sta_connect_args.ssid->sval[0];
memcpy((char *) wifi_config.sta.ssid, ssid, sizeof(wifi_config.sta.ssid));
const char *pass = sta_connect_args.password->sval[0];
if (sta_connect_args.password->count > 0) {
memcpy((char *) wifi_config.sta.password, pass, sizeof(wifi_config.sta.password));
wifi_config.sta.threshold.authmode = WIFI_AUTH_WEP;
}
if (sta_connect_args.channel->count > 0) {
wifi_config.sta.channel = (uint8_t)(sta_connect_args.channel->ival[0]);
}
if (sta_connect_args.bssid->count > 0) {
if (wifi_cmd_str2mac(sta_connect_args.bssid->sval[0], wifi_config.sta.bssid) != ESP_OK) {
ESP_LOGE(APP_TAG, "Can not parse bssid: %s", sta_connect_args.bssid->sval[0]);
return 1;
}
wifi_config.sta.bssid_set = 1;
}
#if ESP_IDF_VERSION >= ESP_IDF_VERSION_VAL(5, 4, 0) && !CONFIG_WIFI_CMD_BASIC_ONLY
if (sta_connect_args.rssi_5g_offset->count > 0) {
wifi_config.sta.threshold.rssi_5g_adjustment = (uint8_t)(sta_connect_args.rssi_5g_offset->ival[0]);
} else {
wifi_config.sta.threshold.rssi_5g_adjustment = DEF_5G_CONN_RSSI_OFFSET;
}
#endif
#if ESP_IDF_VERSION >= ESP_IDF_VERSION_VAL(5, 1, 1) /* IDF commit: 52b24918f01a2e90f395f4056050511516aa0d6e */
if (sta_connect_args.failure_retry->count > 0) {
wifi_config.sta.failure_retry_cnt = sta_connect_args.failure_retry->ival[0];
}
#endif
/* clear auto-reconnect retry count */
g_wifi_connect_retry_cnt = 0;
g_wifi_cmd_config.reconnect = true;
/* Disable auto-reconnect from command --no-reconnect */
if (sta_connect_args.no_reconnect->count > 0) {
g_wifi_cmd_config.reconnect = false;
}
/* Try to disconnect from the previous AP before connect. */
if (sta_connect_args.no_disconnect->count == 0) {
esp_wifi_disconnect();
}
ESP_LOGI(APP_TAG, "Connecting to %s...", ssid);
ESP_ERROR_CHECK(esp_wifi_set_config(WIFI_IF_STA, &wifi_config));
esp_err_t err = esp_wifi_connect();
LOG_WIFI_CMD_DONE(err, "WIFI_CONNECT_START");
return 0;
}
static int cmd_do_sta_disconnect(int argc, char **argv)
{
g_wifi_cmd_config.reconnect = false;
esp_err_t err = esp_wifi_disconnect();
LOG_WIFI_CMD_DONE(err, "WIFI_DISCONNECT");
return 0;
}
#if CONFIG_WIFI_CMD_ENABLE_DEPRECATED
static int cmd_do_sta_deprecated(int argc, char **argv)
{
ESP_LOGW(APP_TAG, "'sta' is deprecated, please use 'sta_connect'.");
return cmd_do_sta_connect(argc, argv);
}
static int cmd_do_disconnect_deprecated(int argc, char **argv)
{
ESP_LOGW(APP_TAG, "'disconnect' is deprecated, please use 'sta_disconnect'.");
return cmd_do_sta_disconnect(argc, argv);
}
#endif
static void app_register_sta_connect(void)
{
sta_connect_args.ssid = arg_str1(NULL, NULL, "<ssid>", "SSID of AP");
sta_connect_args.password = arg_str0(NULL, NULL, "<pass>", "password of AP");
sta_connect_args.bssid = arg_str0("b", "bssid", "<bssid>", "bssid of AP");
sta_connect_args.channel = arg_int0("n", "channel", "<channel>", "channel of AP");
sta_connect_args.no_disconnect = arg_lit0(NULL, "no-disconnect", "For test: do not run esp_wifi_disconnect before connect.");
sta_connect_args.no_reconnect = arg_lit0(NULL, "no-reconnect", "Disable auto-reconnect in wifi disconnect handler.");
sta_connect_args.full_scan = arg_lit0(NULL, "full-scan", "do full channel scan during sta connect.");
#if ESP_IDF_VERSION >= ESP_IDF_VERSION_VAL(5, 4, 0) && !CONFIG_WIFI_CMD_BASIC_ONLY
sta_connect_args.rssi_5g_offset = arg_int0(NULL, "5g-offset", "<rssi_5g_offset>", "offset value for 5g ssid when do full scan connect");
#endif
#if ESP_IDF_VERSION >= ESP_IDF_VERSION_VAL(5, 1, 1) /* IDF commit: 52b24918f01a2e90f395f4056050511516aa0d6e */
sta_connect_args.failure_retry = arg_int0(NULL, "failure_retry", "<int>", "connect sta config: failure_retry_cnt");
#endif
sta_connect_args.end = arg_end(2);
const esp_console_cmd_t sta_connect_cmd = {
.command = "sta_connect",
.help = "WiFi is station mode, connect specified soft-AP",
.hint = NULL,
.func = &cmd_do_sta_connect,
.argtable = &sta_connect_args
};
ESP_ERROR_CHECK(esp_console_cmd_register(&sta_connect_cmd));
#if CONFIG_WIFI_CMD_ENABLE_DEPRECATED
esp_console_cmd_t sta_deprecated = sta_connect_cmd;
sta_deprecated.command = "sta";
sta_deprecated.help = "Station mode, connect to specific AP. Deprecated, please use 'sta_connect'";
sta_deprecated.func = &cmd_do_sta_deprecated;
ESP_ERROR_CHECK(esp_console_cmd_register(&sta_deprecated));
#endif
}
static void app_register_sta_disconnect(void)
{
const esp_console_cmd_t sta_disconnect_cmd = {
.command = "sta_disconnect",
.help = "WiFi is station mode, disconnect from current AP or stop reconnect.",
.hint = NULL,
.func = &cmd_do_sta_disconnect,
};
ESP_ERROR_CHECK(esp_console_cmd_register(&sta_disconnect_cmd));
#if CONFIG_WIFI_CMD_ENABLE_DEPRECATED
esp_console_cmd_t disconnect_deprecated = sta_disconnect_cmd;
disconnect_deprecated.command = "disconnect";
disconnect_deprecated.help = "stop wifi connect. Deprecated, please use 'sta_disconnect'";
disconnect_deprecated.func = &cmd_do_disconnect_deprecated;
ESP_ERROR_CHECK(esp_console_cmd_register(&disconnect_deprecated));
#endif
}
static int cmd_do_sta_scan(int argc, char **argv)
{
int nerrors = arg_parse(argc, argv, (void **) &scan_args);
if (nerrors != 0) {
arg_print_errors(stderr, scan_args.end, argv[0]);
return 1;
}
uint8_t ssid[33] = {0};
wifi_scan_config_t scan_config = {0};
if (scan_args.ssid->count > 0) {
strlcpy((char *)ssid, scan_args.ssid->sval[0], 33);
scan_config.ssid = ssid;
}
if (scan_args.bssid->count > 0) {
if (wifi_cmd_str2mac(scan_args.bssid->sval[0], scan_config.bssid) != ESP_OK) {
ESP_LOGE(APP_TAG, "Can not parse bssid: %s", scan_args.bssid->sval[0]);
return 1;
}
}
if (scan_args.channel->count > 0) {
scan_config.channel = (uint8_t)(scan_args.channel->ival[0]);
}
if (scan_args.show_hidden->count > 0) {
scan_config.show_hidden = true;
}
/* passive scan */
if (scan_args.passive->count > 0) {
scan_config.scan_type = WIFI_SCAN_TYPE_PASSIVE;
}
if (scan_args.passive_time->count > 0) {
scan_config.scan_time.passive = scan_args.passive_time->ival[0];
scan_config.scan_type = WIFI_SCAN_TYPE_PASSIVE;
}
if (scan_config.scan_type == WIFI_SCAN_TYPE_PASSIVE && scan_args.max->count + scan_args.min->count) {
ESP_LOGE(APP_TAG, "Can not set active scan and passive scan at the same time");
return 0;
}
/* active scan time */
if (scan_args.min->count > 0) {
scan_config.scan_time.active.min = scan_args.min->ival[0];
}
if (scan_args.max->count > 0) {
scan_config.scan_time.active.max = scan_args.max->ival[0];
}
#if ESP_IDF_VERSION >= ESP_IDF_VERSION_VAL(5, 3, 0)
if (scan_args.home_chan_dwell_time->count > 0) {
scan_config.home_chan_dwell_time = scan_args.home_chan_dwell_time->ival[0];
}
/* bitmap */
if (scan_args.bitmap_2g->count > 0) {
scan_config.channel_bitmap.ghz_2_channels = (uint16_t)scan_args.bitmap_2g->ival[0];
}
if (scan_args.bitmap_5g->count > 0) {
scan_config.channel_bitmap.ghz_5_channels = (uint32_t)scan_args.bitmap_5g->ival[0];
}
#endif
g_is_scan_count_only = false;
if (scan_args.count_only->count > 0) {
g_is_scan_count_only = true;
}
esp_err_t err = esp_wifi_scan_start(&scan_config, false);
LOG_WIFI_CMD_DONE(err, "STA_SCAN_START");
return 0;
}
#if CONFIG_WIFI_CMD_ENABLE_DEPRECATED
static int cmd_do_wifi_scan_deprecated(int argc, char **argv)
{
ESP_LOGW(APP_TAG, "'wifi_scan' is deprecated, please use 'sta_scan'.");
return cmd_do_sta_scan(argc, argv);
}
static int cmd_do_scan_deprecated(int argc, char **argv)
{
ESP_LOGW(APP_TAG, "'scan' is deprecated, please use 'sta_scan'.");
return cmd_do_sta_scan(argc, argv);
}
#endif
static void app_register_sta_scan(void)
{
scan_args.ssid = arg_str0(NULL, NULL, "<ssid>", "SSID of AP");
scan_args.bssid = arg_str0("b", "bssid", "<bssid>", "bssid of AP");
scan_args.channel = arg_int0("n", "channel", "<int>", "channel of AP");
scan_args.show_hidden = arg_lit0("h", "show-hidden", "Show hidden APs");
scan_args.max = arg_int0(NULL, "max", "<int>", "max active scan time");
scan_args.min = arg_int0(NULL, "min", "<int>", "min active scan time");
scan_args.passive = arg_lit0(NULL, "passive", "Set scan type to passive");
scan_args.passive_time = arg_int0(NULL, "passive-time", "<int>", "Set passive scan time, also set scan type to passive");
#if ESP_IDF_VERSION >= ESP_IDF_VERSION_VAL(5, 3, 0)
scan_args.home_chan_dwell_time = arg_int0(NULL, "dwell", "<int>", "home channel dwell time (ms)");
scan_args.bitmap_2g = arg_int0("2", "bitmap-2g", "<int/hex>", "scan bitmap 2ghz, eg: '-2 0x842'(channel:1/6/11)");
scan_args.bitmap_5g = arg_int0("5", "bitmap-5g", "<int/hex>", "scan bitmap 5ghz, eg: '-5 0x6'(channel:36/40)");
#endif
scan_args.count_only = arg_lit0(NULL, "count-only", "For test: do scan ap count only.");
scan_args.end = arg_end(2);
const esp_console_cmd_t sta_scan_cmd = {
.command = "sta_scan",
.help = "WiFi is station mode, scan APs",
.hint = NULL,
.func = &cmd_do_sta_scan,
.argtable = &scan_args
};
ESP_ERROR_CHECK(esp_console_cmd_register(&sta_scan_cmd));
#if CONFIG_WIFI_CMD_ENABLE_DEPRECATED
esp_console_cmd_t scan_deprecated = sta_scan_cmd;
scan_deprecated.command = "wifi_scan";
scan_deprecated.help = "Scan APs. Deprecated, please use 'sta_scan'";
scan_deprecated.func = &cmd_do_wifi_scan_deprecated;
ESP_ERROR_CHECK(esp_console_cmd_register(&scan_deprecated));
scan_deprecated.command = "scan";
scan_deprecated.func = &cmd_do_scan_deprecated;
ESP_ERROR_CHECK(esp_console_cmd_register(&scan_deprecated));
#endif
}
void wifi_cmd_register_sta_basic(void)
{
app_register_sta_connect();
app_register_sta_disconnect();
app_register_sta_scan();
}
Details ![]()
Show: from Types: Columns: ![]( "Show Project Names")
![]( "Show Locations")
![]( "Show Referring Symbols")
![]( "Show Scope")
This file uses the notable symbols shown below. Click anywhere in the file to view more details.