WLAN Interface
wlan.antenna.select
Abbreviation
wl a s
Access
get/set
Description
The default antenna used by the Wi-Fi radio.
Note : Availability of antennas is hardware dependent. On hardware with only one antenna this setting has no effect.
-
1
: antenna 1 (or the internal antenna) is selected -
2
: antenna 2 (or the external antenna) is selected -
auto
: the best antenna is automatically selected on a per-packet basis
Note
: An external antenna must be connected if
2
or
auto
mode are selected.
Arguments
<1/2/auto>
Default
1
Platforms
- WGM160P
Properties
- takes effect immediately
- available in Safe Mode
- preserved by NVM Backup
Gecko OS Plugin
Get example
> get wl a s
R000003
1
Set example
> set wl a s auto
R000008
Set OK
wlan.auto_join.enabled
Abbreviation
wl o e
Access
get/set
Description
Enable/disable network auto-join using the wlan interface on bootup.
See Procedure for Joining a WLAN Network .
Arguments
1|true|on/0|false|off
where
-
0
orfalse
oroff
: disabled -
1
ortrue
oron
: enabled
Default
0
Platforms
- WGM160P
Properties
- network_restart to apply change
Gecko OS Plugin
Get example
> get wl o e
R000003
0
Set example
> set wl o e true
R000008
Set OK
wlan.auto_join.retries
Abbreviation
wl o r
Access
get/set
Description
Maximum number of attempts to auto-join a network.
0
= retry indefinitely.
See Procedure for Joining a WLAN Network .
Arguments
<0-255>
Default
3
Platforms
- WGM160P
Properties
Gecko OS Plugin
Get example
> get wl o r
R000003
3
Set example
> set wl o r 5
R000008
Set OK
wlan.auto_join.retry_delay
Abbreviation
wl o d
Access
get/set
Description
The period between auto-join attempts in seconds.
See Procedure for Joining a WLAN Network .
Arguments
<0-255>
Default
10
Platforms
- WGM160P
Properties
Gecko OS Plugin
Get example
> get wl o d
R000004
10
Set example
> set wl o d 5
R000008
Set OK
wlan.backoff
Abbreviation
wl k
Access
get/set
Description
Get WLAN attentuation settings for all channels or a specified channel:
get wlan.backoff
get wlan.backoff 1
Set WLAN backoff attenuation for a specified channel and all modulation groups.
Attenuation can be set for all modulation groups of a specified channel, e.g.
> set wlan.backoff 1 10
For advanced users, attenuation can be specified for each modulation group of a specified channel, e.g.
> set wlan.backoff 1 10,20,30,40,50.25,60.75
Modulation groups are listed in the order below:
Modulation Groups
- MOD_GROUP_0 : B_1Mbps, B_2Mbps, B_5.5Mbps, B_11Mbps
- MOD_GROUP_1 : G_6Mbps, G_9Mbps, G_12Mbps, N_MCS0, N_MCS1,
- MOD_GROUP_2 : G_18Mbps, G_24Mbps, N_MCS2, N_MCS3,
- MOD_GROUP_3 : G_36Mbps, G_48Mbps, N_MCS4, N_MCS5
- MOD_GROUP_4 : G_54Mbps, N_MCS6
- MOD_GROUP_5 : N_MCS7
Get Arguments
[<channel>]
where:
-
<channel>
: Optional. The Wi-Fi channel for attenuation adjustment.-
Range:
1 - 14
-
Range:
Get Example
Get backoff for a specified channel:
> get wlan.backoff 11
0,0,0,0,0,0
Get backoff for all channels:
> get wl k
Ch Attenuation (dbm)
1 0,0,0,0,0,0
2 0,0,0,0,0,0
3 0,0,0,0,0,0
4 0,0,0,0,0,0
5 0,0,0,0,0,0
6 0,0,0,0,0,0
7 0,0,0,0,0,0
8 0,0,0,0,0,0
9 0,0,0,0,0,0
10 0,0,0,0,0,0
11 0,0,0,0,0,0
12 0,0,0,0,0,0
13 0,0,0,0,0,0
14 0,0,0,0,0,0
Set Arguments
<channel> <attenuation>/<mod_group_attenuation_list>
where:
-
<channel>
: The Wi-Fi channel for attenuation adjustment.-
Range:
1 - 14
-
Range:
-
<mod_group_attenuation_list>
: a comma separated list of attenuation values for the six modulation groups. The six group attenuation values are listed in the order shown in Modulation Groups above. For each modulation group attenuation is specified in dBm.-
Range:
0 - 63.75
-
Range:
Default
Default is no attenuation, for all modulation groups:
0,0,0,0,0,0
Platforms
- WGM160P
Set Example
Set attenuation for all modulation groups of a channel:
> set wlan.backoff 1 10
Set attenuation for each modulation group of a channel:
> set wlan.backoff 1 10,20,30,40,50.25,60.75
Set OK
wlan.bssid
Abbreviation
wl b
Access
get/set
Description
Specify the BSSID for the WLAN.
When
wlan.bssid
is set, Gecko OS attempts to associate with the network via the access point with the specified BSSID, regardless of the
wlan.ssid
setting. This allows connecting to hidden networks.
The wlan.passkey must be provided.
The
wlan.ssid
cannot be empty. Setting
wlan.ssid
clears
wlan.bssid
, so set
wlan.ssid
first, then set
wlan.bssid
. For example:
Gecko OS Commands | Description |
---|---|
|
|
Note : On joining a WLAN, if the WLAN SSID is advertised, it replaces the value of wlan.ssid .
To disable
wlan.bssid
, set the value to
00:00:00:00:00:00
or set
wlan.ssid
to clear it.
See Procedure for Joining a WLAN Network .
Arguments
<bssid>
Default
00:00:00:00:00:00
Platforms
- WGM160P
Properties
- network_restart to apply change
Gecko OS Plugin
Get example
> get wl b
R000019
00:00:00:00:00:00
Set example
> set wl b 7C:69:F6:35:8F:F8
R000008
Set OK
wlan.cca_mode
Abbreviation
wl e
Access
set
Description
Set WLAN clear channel assessment (CCA) mode.
Arguments
<cca_mode>
where:
-
<cca_mode>
: Allowed values:-
0
: relative - Smart: Enhanced channel assessment which takes into account potential wideband interferers, such as microwave ovens. -
1
: absolute - Based on a fixed value.
-
Default
0
Platforms
- WGM160P
Set Example
> set wlan.cca_mode 1
Set OK
> set wl e 1
Set OK
wlan.coex.mode
Abbreviation
wl c m
Access
get/set
Description
Enable Wi-Fi PTA (Packet Traffic Arbitration) support.
Arguments
<PTA_code>
where codes are:
Code | Description |
---|---|
0
|
PTA disabled |
1
|
1 wire PTA with WLAN as master |
2
|
1 wire PTA with WLAN as slave |
3
|
2 wire PTA with WLAN as master |
4
|
2 wire PTA with WLAN as slave |
Default
Platforms
- WGM160P
Gecko OS Plugin
Get example
> get wl c m
R000003
0
Set example
> set wl c m 3
R000008
Set OK
wlan.dhcp.cache_enabled
Abbreviation
wl d c
Access
get/set
Description
When DHCP caching is enabled, the received DHCP IP address and corresponding lease time is cached to RAM. When the device is rebooted via the reboot command, the RAM cache and corresponding timestamp is saved to NVM.
Upon rebooting the saved DHCP IP is restored and the lease time is updated with the amount of time that has elapsed since it was last stored. DHCP IP caching can save a considerable amount of time when re-connecting to the network as the full DHCP sequence is skipped (assuming there is enough time left on the DHCP lease).
See Networking and Security, DHCP Client .
Arguments
1|true|on/0|false|off
where
-
0
orfalse
oroff
: disabled -
1
ortrue
oron
: enabled
Default
1
Platforms
- WGM160P
Properties
- takes effect immediately
Gecko OS Plugin
Get example
> get wl d c
R000003
1
Set example
> set wl d c 0
R000008
Set OK
wlan.dhcp.enabled
Abbreviation
wl d e
Access
get/set
Description
Select whether DHCP is used to automatically obtain an IPv4 IP address on the wlan interface.
See Networking and Security, DHCP Client .
Arguments
1|true|on/0|false|off
where
-
0
orfalse
oroff
: disabled -
1
ortrue
oron
: enabled
Default
1
Platforms
- WGM160P
Properties
- network_restart to apply change
- available in Safe Mode
- preserved by NVM Backup
Gecko OS Plugin
Get example
> get wl d e
R000003
1
Set example
> set wl d e off
R000008
Set OK
wlan.dhcp.hostname
Abbreviation
wl d h
Access
get/set
Description
Configures the DHCP client's hostname (DHCP option 12) sent to the DHCP server.
See Networking and Security, DHCP Client .
Arguments
<hostname>
Default
gecko_oS-#
where:
-
A
#
character in the string is replaced by the last three digits of the WLAN MAC address.
Platforms
- WGM160P
Properties
- network_restart to apply change
Gecko OS Plugin
Get example
> get wl d h
R000009
Gecko_OS-#
Set example
> set wl d h my_dhcp_client
R000008
Set OK
wlan.dhcp.timeout
Abbreviation
wl d t
Access
get/set
Description
Amount of time in seconds the module waits as a client for an IP from a DHCP server. See wlan.dhcp.enabled .
See Networking and Security, DHCP Client .
Arguments
<timeout_seconds>
Range:
1 - 255
seconds
Default
15
Platforms
- WGM160P
Properties
- network_restart to apply change
- available in Safe Mode
- preserved by NVM Backup
Gecko OS Plugin
Get example
> get wl d t
R000004
15
Set example
> set wl d t 25
R000008
Set OK
wlan.hide_passkey
Abbreviation
wl h
Access
get/set
Description
Hide the variable
[wlan.passkey](../../cmd/variables/wlan#wlan-passkey)
. Once hidden, a factory reset must be issued to reset this variable and reveal the (reset value) of the passkey.
Note : Don't forget to save before reboot!
See Procedure for Joining a WLAN Network .
Arguments
1|true|on/0|false|off
where
-
0
orfalse
oroff
: hide passkey disabled -
1
ortrue
oron
: hide passkey enabled
Default
0
Platforms
- WGM160P
Properties
- takes effect immediately
- available in Safe Mode
- preserved by NVM Backup
Gecko OS Plugin
Get example
> get wl h
R000003
0
Set example
> set wl h true
R000008
Set OK
> save
R000009
Success
> get wlan.passkey
R000008
******
wlan.info
Abbreviation
wl i
Access
get
Description
WLAN connection status parameters: state, SSID, BSSID, channel and datarate.
Arguments
None
Default
<varies>
Platforms
- WGM160P
Gecko OS Plugin
Get example
> get wlan.info
state: up
SSID: My_Network
BSSID: 30:85:A9:E7:9C:B0
channel: 6
datarate: 450.0
wlan.join.result
Abbreviation
wl j s
Access
get
Description
Result of most recent join attempt. Returns a code:
Code | Description |
---|---|
0 | Haven't tried to join |
1 | Success - Joined network |
2 | Joining network |
3 | SSID not set |
4 | No password set and AP requires security |
5 | Specified security not supported by AP |
6 | Network not found |
7 | Failed to join network. All attempts to join have failed |
8 | Join aborted. network_down called while trying to join |
See Procedure for Joining a WLAN Network .
Arguments
None
Default
<varies>
Platforms
- WGM160P
Gecko OS Plugin
Get example
> get wl j s
1
wlan.join.retries
Abbreviation
wl j r
Access
get/set
Description
Specifies the maximum number of attempts to join a WLAN network after issuing the network_up command (or any other command requiring network access when the network is down).
See Procedure for Joining a WLAN Network .
If the network_down command is issued while attempting to join a network, the subsequent attempts are canceled.
Note :
The
wlan.join.retries
variable is separate from the
wlan.auto_join.retries
variable.
If
wlan.auto_join.retries
>
0
, then the total number of retries is calculated by the multiplication of
wlan.join.retries
with
wlan.auto_join.retries
.
Note
: If
wlan.join.retries
is set to
1
, the device attempts to connect only once. If the device has cached network details, and these details are no longer true due to network changes, the device fails to connect and does not attempt to connect again. Set
wlan.join.retries
to
2
or more to avoid this problem. See
The Network Up Sequence
.
Arguments
<retries>
where:
-
'
' is an integer, range: 1 - 255
.
Default
3
Platforms
- WGM160P
Properties
- network_restart to apply change
- available in Safe Mode
- preserved by NVM Backup
Gecko OS Plugin
Get example
> get wl j r
R000003
5
Set example
> set wl j r 5
R000008
Set OK
wlan.join.timeout
Abbreviation
wl j t
Access
get/set
Description
The maximum amount of time to wait while the module attempts to join a network.
See Procedure for Joining a WLAN Network .
Arguments
<timeout in ms>
Range:
0 - 10000
Default
7000
milliseconds
Platforms
- WGM160P
Properties
- save and reboot to apply change
- available in Safe Mode
- preserved by NVM Backup
Gecko OS Plugin
Get example
> get wlan.join.timeout
R000006
7000
Set example
> set wl j t 5000
R000008
Set OK
wlan.link_local.enabled
Abbreviation
wl i e
Access
get/set
Description
Enables and disables the link local feature.
The device obtains an IP address using the following sequence:
- IF wlan.dhcp.enabled == true THEN Attempt DHCP
- IF wlan.static.ip != 0.0.0.0 THEN Use static IP
- IF wlan.link_local.enabled == true THEN Attempt Link Local IP (e.g. Auto IP)
If all three steps fail to obtain an IP address then the
network_up
sequence fails.
Arguments
1|true|on/0|false|off
Default
0
Platforms
- WGM160P
Gecko OS Plugin
Get example
> get wlan.link_local.enabled
0
Set example
> set wl i e 1
R000008
Set OK
wlan.link_local.timeout
Abbreviation
wl i t
Access
get/set
Description
Configures the maximum time in seconds to obtain an IP via link local protocol.
Arguments
<timeout in seconds>
where:
-
<timeout in seconds>
is an integer.
Range:
1 - 255
Default
20
Platforms
- WGM160P
Gecko OS Plugin
Get example
> get wlan.link_local.timeout
20
Set example
> set wl i t 30
R000008
Set OK
wlan.mac
Abbreviation
wl m
Access
get
Description
Returns the wlan MAC address.
Arguments
None
Default
varies
Platforms
- WGM160P
Properties
- available in Safe Mode
Gecko OS Plugin
Get example
> get wl m
R000019
4C:55:CC:01:23:45
wlan.multicast.address
Abbreviation
wl m a
Access
get
Description
Configure UDP multicast address range.
When the WLAN interface is brought up, it joins the configured multicast group address. When the interface is brought down it leaves the multicast group address.
Notes
The valid multicast group address range is
224.0.0.0
to
239.255.255.255
.
0.0.0.0
disables the multicast feature
Multicast is supported only by the UDP client and server. The TCP protocol does not support multicast.
Arguments
<IP address range>
where:
-
valid range is
224.0.0.0
to239.255.255.255
-
0.0.0.0
disables multicast
Default
0.0.0.0
Platforms
- WGM160P
Properties
- takes effect immediately
Gecko OS Plugin
Get example
> get wl m a
0.0.0.0
Set example
> set wl m a 239.0.0.255
Set OK
wlan.network.dns
Abbreviation
wl n d
Access
get
Description
Return a comma separated list of the DNS server addresses that the wlan interface is using.
Note : To set a static DNS address list, use the wlan.static.dns variable.
See Networking and Security, DNS Client
Arguments
None
Default
0.0.0.0
where:
-
0.0.0.0
means no DNS address is in use.
Platforms
- WGM160P
Properties
- available in Safe Mode
Gecko OS Plugin
Get example
> get wl n d
10.5.6.1
wlan.network.gateway
Abbreviation
wl n g
Access
get
Description
Returns the wlan interface IPv4 gateway IP address resolved by DHCP.
Note : To set a static gateway, use the wlan.static.gateway variable.
Arguments
None
Default
0.0.0.0
Platforms
- WGM160P
Properties
- available in Safe Mode
Gecko OS Plugin
Get example
> get wl n g
R000013
192.168.0.1
wlan.network.ip
Abbreviation
wl n i
Access
get
Description
Returns the wlan interface IPv4 IP address resolved by DHCP.
Note : To set a static IP address, use the wlan.static.ip variable.
Arguments
None
Default
0.0.0.0
Platforms
- WGM160P
Properties
- available in Safe Mode
Gecko OS Plugin
Get example
> get wl n i
R000014
192.168.0.79
wlan.network.netmask
Abbreviation
wl n n
Access
get
Description
Returns the wlan interface IPv4 netmask resolved by DHCP.
Note : To set a static netmask, use the wlan.static.netmask variable.
Arguments
None
Default
0.0.0.0
Platforms
- WGM160P
Properties
- available in Safe Mode
Gecko OS Plugin
Get example
> get wl n n
R000015
255.255.255.0
wlan.network.status
Abbreviation
wl n s
Access
get
Description
Returns the wlan network status.
-
0
: down -
1
: WLAN connected, -
2
: IP network connected (with a valid IP address)
Arguments
None
Default
0
Platforms
- WGM160P
Properties
- available in Safe Mode
Gecko OS Plugin
Get example
> get wl n s
R000003
2
wlan.network.status_gpio
Abbreviation
wl n o
Access
get/set
Description
The GPIO used to indicate network connectivity status.
- GPIO low : not connected
- GPIO high : the default network interface is connected and has an IP address.
See also system.oob.gpio .
Arguments
<GPIO#>
where:
- Available GPIOs depends on platform.
-
-1
: no GPIO is assigned to this role.
Default
-1
Platforms
- WGM160P
Properties
Gecko OS Plugin
Get example
> get wl n o
R000004
-1
Set example
> set wl n o 4
R000008
Set OK
wlan.passkey
Abbreviation
wl p
Access
get/set
Description
The WPA passphrase, WPA PSK or WEP key used when connecting to a Wi-Fi Access Point.
Notes for WEP
- The WEP key is replicated across each of the four possible keys.
- Silicon Labs STRONGLY discourages the use of WEP - it is NOT secure!
Arguments
<passphrase> / <WEP key>
|
Description |
---|---|
WPA Passphrase | length: 8 - 63 characters |
WPA PSK | length: 64 characters |
WEP Key |
A 40-bit WEP key is specified as a 5-byte hex string, for example:
1122334455
A 104-bit WEP key is specified as 13-byte hex string, for example:
112233445566778899aabbccdd
|
""
|
Sets a NULL passphrase |
For allowable values and set syntax see: Networking and Security, Passkeys .
Default
""
Platforms
- WGM160P
Properties
- network_restart to apply change
- available in Safe Mode
- preserved by NVM Backup
Gecko OS Plugin
Get example
> get wl p
R000000
Set example
> set wl p "Use the force!"
R000008
Set OK
wlan.powersave.listen_interval
Abbreviation
wl p l
Access
get/set
Description
The Wi-Fi sub-system remains in low power mode for a period specified in units of DTIM intervals (typically multiples of
100ms
).
See:
Arguments
<sleep time>
-
<sleep time>
is in the range1 - 10
. -
If
<sleep time>
=0
, the WLAN subsystem wakes to listen to every DTIM.
Default
0
Platforms
- WGM160P
Properties
Gecko OS Plugin
Get example
> get wl p l
R000003
0
Set example
> set wl p l 90
R000008
Set OK
wlan.powersave.mode
Abbreviation
wl p m
Access
get/set
Description
Wi-Fi powersave mode. For lowest poweruse mode =
1
.
Arguments
<mode>
where:
|
Description |
---|---|
0
|
Disabled: no powersave |
1
|
Beacon skipping mode |
2
|
DTIM skipping mode |
See:
Default
0
Platforms
- WGM160P
Properties
Gecko OS Plugin
Get example
> get wl p m
R000003
0
Set example
> set wl p m 2
R000008
Set OK
wlan.rate.protocol
Abbreviation
wl r p
Access
get/set
Description
WLAN client data rate protocol selection.
Arguments
<11b/11g/11n/auto>
where:
Value | Description |
---|---|
11b
|
Restrict 802.11 PHY data rates to 802.11b |
11g
|
Restrict 802.11 PHY data rates to 802.11g |
11n
|
Restrict 802.11 PHY data rates to 802.11n |
auto
|
Automatically select the best rate from all 802.11b/g/n rates |
Default
auto
Platforms
- WGM160P
Properties
- network_restart to apply change
- available in Safe Mode
- preserved by NVM Backup
Gecko OS Plugin
Get example
> get wl r p
auto
Set example
> set wlan.rate.protocol 11b
Set OK
wlan.rate.transmit
Abbreviation
wl r x
Access
get/set
Description
Force the WLAN interface to transmit at a fixed data rate. The transmit rate is taken from valid rates specified by wlan.rate.protocol .
Arguments
<rate>
where value choices depend on protocol setting:
wlan.rate.protocol setting | protocol |
wlan.rate.transmit
<rate>
value choices
|
---|---|---|
11b
|
802.11b |
auto
,
1
,
2
,
5.5
,
11
|
11g
|
802.11g |
auto
,
6
,
9
,
12
,
18
,
24
,
36
,
48
,
54
|
11n
|
802.11n |
auto
,
mcs0
,
mcs1
,
mcs2
, ... ,
mcs7
|
auto
|
Any | All the above value choices are available |
Default
auto
- automatically select the best rate from the available choices
Platforms
- WGM160P
Properties
- network_restart to apply change
- available in Safe Mode
- preserved by NVM Backup
Gecko OS Plugin
Get example
> get wl r x
5.5
Set example
> set wlan.rate.transmit mcs3
Set OK
wlan.roam.threshold
Abbreviation
wl r t
Access
get/set
Description
The wlan interface searches for a new AP to connect to once the signal from the AP it is currently associated with drops below the roam trigger level. The trigger level is specified in dBm in the range
-1
to
-99
.
Arguments
<dBm>
Range:
-1 - -99
Default
-99
Platforms
- WGM160P
Properties
- network_restart to apply change
- available in Safe Mode
- preserved by NVM Backup
Gecko OS Plugin
Get example
> get wl r t
R000005
-99
Set example
> set wl r t -70
R000008
Set OK
wlan.rssi_average
Abbreviation
wl r
Access
get/set
Description
The number of consecutive wlan RSSI readings to average. Averaging smooths variations in the measured signal strength of the AP. Set to
0
to disable averaging.
Arguments
<# readings>
where:
-
0
: disable averaging
Range:
0 - 254
Default
0
Platforms
- WGM160P
Properties
Gecko OS Plugin
Get example
> get wl r
R000003
5
Set example
> set wl r 12
R000008
Set OK
wlan.scan.active_dwell
Abbreviation
wl s a
Access
get/set
Description
Time spent listening on a channel when actively scanning for APs.
Arguments
<milliseconds>
Range:
1 - 65535
Default
75
Platforms
- WGM160P
Properties
- network_restart to apply change
- available in Safe Mode
- preserved by NVM Backup
Gecko OS Plugin
Get example
> get wl s a
R000004
75
Set example
> set wl s a 90
R000008
Set OK
wlan.scan.channel_mask
Abbreviation
wl s m
Access
get/set
Description
Channels to scan. Specified by a hex bitmask.
Arguments
<channel_bitmask>
where bits correspond to channels, as shown in the following examples:
Channels : | 14 | 13 | 12 | 11 | 10 | 9 | 8 | 7 | 6 | 5 | 4 | 3 | 2 | 1 | channel_bitmask | |||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
Channel 1 only | 0 | 0 | 0 | 0 | 0 | 0 | 0 | 0 | 0 | 0 | 0 | 0 | 0 | 1 | 0x001 | |||
Channels 11/6/1 | 0 | 0 | 0 | 1 | 0 | 0 | 0 | 0 | 1 | 0 | 0 | 0 | 0 | 1 | 0x421 | |||
All US region channels | 0 | 0 | 0 | 1 | 1 | 1 | 1 | 1 | 1 | 1 | 1 | 1 | 1 | 1 | 0x7FF | |||
All except for channel 14 | 0 | 1 | 1 | 1 | 1 | 1 | 1 | 1 | 1 | 1 | 1 | 1 | 1 | 1 | 0x1FFF |
Default
0x07FF
Platforms
- WGM160P
Properties
- network_restart to apply change
- available in Safe Mode
- preserved by NVM Backup
Gecko OS Plugin
Get example
> get wl s m
R000007
0x07FF
Set example
Set channels
11
&
1
only
> set wl s m 0x401
R000008
Set OK
wlan.scan.home_dwell
Abbreviation
wl s h
Access
get/set
Description
Time spent listening on the softap home channel when scanning in softap mode.
Arguments
<milliseconds>
Default
50
Platforms
- WGM160P
Properties
- network_restart to apply change
- available in Safe Mode
- preserved by NVM Backup
Gecko OS Plugin
Get example
> get wl s h
R000004
50
Set example
> set wl s h 70
R000008
Set OK
wlan.scan.num_probes
Abbreviation
wl s n
Access
get/set
Description
Number of 802.11 probes to send when actively scanning.
Arguments
<# probes>
Range:
1 - 255
Default
3
Platforms
- WGM160P
Properties
- network_restart to apply change
- available in Safe Mode
- preserved by NVM Backup
Gecko OS Plugin
Get example
> get wl s n
R000003
3
Set example
> set wl s n 5
R000008
Set OK
wlan.scan.passive_dwell
Abbreviation
wl s p
Access
get/set
Description
Time spent listening on a channel when passive scanning.
Arguments
<milliseconds>
Default
110
Platforms
- WGM160P
Properties
- network_restart to apply change
- available in Safe Mode
- preserved by NVM Backup
Gecko OS Plugin
Get example
> get wl s p
R000005
110
Set example
> set wl s p 130
R000008
Set OK
wlan.scan.retries
Abbreviation
wl s r
Access
get/set
Description
Number of times to repeat a full scan when the scan command is issued.
Arguments
<# retries>
Range:
1 - 255
Default
3
Platforms
- WGM160P
Properties
- network_restart to apply change
- available in Safe Mode
- preserved by NVM Backup
Gecko OS Plugin
Get example
> get wl s r
R000003
3
Set example
> set wl s r 5
R000008
Set OK
wlan.scan.type
Abbreviation
wl s t
Access
get/set
Description
Type of scan. Passive is listen-only, active transmits 802.11 probe management frames.
Arguments
passive/active
Default
active
Platforms
- WGM160P
Properties
- network_restart to apply change
- available in Safe Mode
- preserved by NVM Backup
Gecko OS Plugin
Get example
> get wl s t
R000008
active
Set example
> set wl s t passive
R000008
Set OK
wlan.security
Abbreviation
wl c
Access
get/set
Description
The wlan security type. If set to
Auto
, the security type is automatically populated when joining a network (except WEP). Alternatively, the security type may be forced to one of the options listed in
Arguments
below.
Notes for WEP
-
wlan.security
must be manually set toWEP
BEFORE setting wlan.passkey if WEP security is used. - Silicon Labs STRONGLY discourages the use of WEP - it is NOT secure!
See Procedure for Joining a WLAN Network .
Arguments{.cmd_var_sub}
None
Options:
-
Auto
-
Open
-
WEP
-
WPA-AES
-
WPA-TKIP
-
WPA2-AES
-
WPA2-Mixed
-
WPA2-TKIP
Default
Auto
Platforms
- WGM160P
Properties
- network_restart to apply change
- available in Safe Mode
- preserved by NVM Backup
Gecko OS Plugin
Get example
> get wl c
R000006
Auto
Set example
> set wl c WPA2-AES
R000008
Set OK
wlan.ssid
Abbreviation
wl s
Access
get/set
Description
The name of the AP the WLAN client interface will attempt to join.
See Procedure for Joining a WLAN Network .
Arguments
<ssid>
A string containing spaces must be enclosed in double quotes:
> set wl s "My SSID"
Set OK
> get wl s
My SSID
A double quote in the string must be escaped with a backslash:
> set wl s "My \"SSID\""
Set OK
> get wl s
My "SSID"
ASCII characters can be input represented by their ASCII code in hex, in the form:
\x<code>
. For example a backslash is represented by
\x5C
. Unprintable ASCII characters, and the backslash, are displayed as their hex ASCII code in the
get wl s
output:
> set wl s abc\x5Cdef
Set OK
> get wl s
abc\x5Cdef
A backslash can also be entered escaped by a backslash:
> set wl s abc\\def
Set OK
> get wl s
abc\x5Cdef
Default
Platforms
- WGM160P
Properties
- network_restart to apply change
- available in Safe Mode
- preserved by NVM Backup
Gecko OS Plugin
Get example
> get wl s
R000012
My Home AP
Set example
> set wl s "Obi-wan Kenobi"
R000008
Set OK
wlan.static.dns
Abbreviation
wl t d
Access
get/set
Description
DNS server address if static network settings are used for the wlan interface.
See Networking and Security, DNS Server .
Arguments
<[IP address]/[host name]>
Default
8.8.8.8
Platforms
- WGM160P
Properties
- network_restart to apply change
- available in Safe Mode
- preserved by NVM Backup
Gecko OS Plugin
Get example
> get wl t d
R000009
8.8.8.8
Set example
> set wl t d 8.8.4.4
R000008
Set OK
wlan.static.gateway
Abbreviation
wl t g
Access
get/set
Description
Gateway address if static network settings are used for the wlan interface.
Arguments
<IP address>
Default
0.0.0.0
Platforms
- WGM160P
Properties
- network_restart to apply change
- available in Safe Mode
- preserved by NVM Backup
Gecko OS Plugin
Get example
> get wl t g
R000009
0.0.0.0
Set example
> set wl t g 192.168.0.1
R000008
Set OK
wlan.static.ip
Abbreviation
wl t i
Access
get/set
Description
Local IP address if static network settings are used for the wlan interface.
Arguments
<IP address>
Default
0.0.0.0
Platforms
- WGM160P
Properties
- network_restart to apply change
- available in Safe Mode
- preserved by NVM Backup
Gecko OS Plugin
Get example
> get wl t i
R000009
0.0.0.0
Set example
> set wl t i 192.168.0.2
R000008
Set OK
wlan.static.netmask
Abbreviation
wl t n
Access
get/set
Description
Netmask if static network settings are used for the wlan interface.
Arguments
<network mask>
Default
0.0.0.0
Platforms
- WGM160P
Properties
- network_restart to apply change
- available in Safe Mode
- preserved by NVM Backup
Gecko OS Plugin
Get example
> get wl t n
R000009
0.0.0.0
Set example
> set wl t n 255.255.255.0
R000008
Set OK
wlan.tx_power
Abbreviation
wl t
Access
get/set
Description
The Wi-Fi RF transmit power in units of dBm. Range is platform dependent.
Platform | Range |
---|---|
WGM160P |
10 - 18
|
The maximum transmit power is module dependent.
The value
auto
sets
wlan.tx_power
to the maximum value permitted by the region which is auto-detected.
This setting can be affected by
softap.tx_power
. If softAP and STA (WLAN) are running at the same time, on the same channel, then the power for both connections is
max(wlan.tx_power, softap.tx_power)
.
If softAP and STA connections are on different channels, then the
wlan.tx_power
and
softap.tx_power
limits apply as specified.
Arguments
10-18/auto/default
where value is one of the following:
-
integer in range
10 - 18
-
auto
-
default
Default
auto
Platforms
- WGM160P
Properties
- takes effect immediately
- available in Safe Mode
- preserved by NVM Backup
Gecko OS Plugin
Get example
> get wl t
R000006
auto
Set example
> set wl t 15
R000008
Set OK