From 9200aa58a3450b44fd5d84aa596681770f7207b7 Mon Sep 17 00:00:00 2001 From: Ravi Dondaputi Date: Fri, 19 Apr 2024 12:53:40 +0530 Subject: [PATCH] doc: wifi: Update description for `connect` command The `connect` command has been updated to take key-value style arguments. Update the description to include this information. Fixes SHEL-2699. Signed-off-by: Ravi Dondaputi --- samples/wifi/shell/README.rst | 20 +++++++++++--------- 1 file changed, 11 insertions(+), 9 deletions(-) diff --git a/samples/wifi/shell/README.rst b/samples/wifi/shell/README.rst index 7ca03d68c890..e12a3186a116 100644 --- a/samples/wifi/shell/README.rst +++ b/samples/wifi/shell/README.rst @@ -114,16 +114,18 @@ Supported CLI commands | 2:1,6-11,14_5:36,149-165,44 | [-h, --help] : Print out the help for the scan command. * - connect - - | Connect to a Wi-Fi AP with the following parameters: - | "" - | [channel number/band: > 0:Channel, 0:any channel, - | < 0:band (-2:2.4GHz, -5:5GHz, -6:6GHz] - | [PSK: valid only for secure SSIDs] - | [Security type: valid only for secure SSIDs] - | 0:None, 1:WPA2-PSK, 2:WPA2-PSK-256, 3:SAE, 4:WAPI, 5:EAP, 6:WEP, 7: - | WPA-PSK - | [MFP (optional: needs security type to be specified)] + - | Connect to a Wi-Fi AP + | <-s --ssid \"\">: SSID. + | [-c --channel]: Channel that needs to be scanned for connection. 0:any channel + | [-b, --band] 0: any band (2:2.4GHz, 5:5GHz, 6:6GHz) + | [-p, --psk]: Passphrase (valid only for secure SSIDs) + | [-k, --key-mgmt]: Key management type. + | 0:None, 1:WPA2-PSK, 2:WPA2-PSK-256, 3:SAE, 4:WAPI, 5:EAP, 6:WEP, + | 7:WPA-PSK, 8: WPA-Auto-Personal + | [-w, --ieee-80211w]: MFP (optional: needs security type to be specified) | : 0:Disable, 1:Optional, 2:Required. + | [-m, --bssid]: MAC address of the AP (BSSID). + | [-h, --help]: Print out the help for the connect command. * - disconnect - Disconnect from the Wi-Fi AP * - status