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.

Note: An external antenna must be connected if 2 or auto mode are selected.

Arguments

<1/2/auto>

Default

1

Properties

Gecko OS Kernel 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

Default

0

Properties

Gecko OS Kernel 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

Properties

Gecko OS Kernel 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

Properties

Gecko OS Kernel Plugin

Get example

> get wl o d
R000004
10

Set example

> set wl o d 5
R000008
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
set wlan.ssid my_network
set wlan.bssid 11:22:33:44:55:66
set wlan.passkey my_password
network_up
first set the SSID
next set the BSSID
set the network's password (if required)
connect to the network

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

Properties

Gecko OS Kernel 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.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.
Note: Renamed from network.dhcp after Gecko OS v1.2. Renamed from network.dhcp.enabled in Gecko OS 3.0.

See Networking and Security, DHCP Client.

Arguments

<1|true|on/0|false|off>

where

Default

1

Properties

Gecko OS Kernel Plugin

Get example

> get wl d e
R000003
1

Set example

> set wl d e off
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

Default

1

Properties

Gecko OS Kernel Plugin

Get example

> get wl d c
R000003
1

Set example

> set wl d c 0
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 # is replaced by the last three digits of the WLAN MAC address

Properties

Gecko OS Kernel 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

Properties

Gecko OS Kernel 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. 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

Default

0

Properties

Gecko OS Kernel 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

-

Default

<varies>

Gecko OS Kernel 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:

CodeDescription
0Haven't tried to join
1Success - Joined network
2Joining network
3SSID not set
4No password set and AP requires security
5Specified security not supported by AP
6Network not found
7Failed to join network. All attempts to join have failed
8Join aborted. network_down called while trying to join

See Procedure for Joining a WLAN Network.

Arguments

-

Default

<varies>

Gecko OS Kernel 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 that wlan.join.retries 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 ranging 1-255.

Default

3

Properties

Gecko OS Kernel 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>

Default

7000 ms

Properties

Gecko OS Kernel Plugin

Get example

> get wlan.join.timeout
R000006
7000

Set example

> set wl j t 5000
R000008
Set OK

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:

  1. IF wlan.dhcp.enabled == true THEN Attempt DHCP
  2. IF wlan.static.ip != 0.0.0.0 THEN Use static IP
  3. 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

Properties

Gecko OS Kernel Plugin

Get example

> get wlan.link_local.enabled
0

Set example

> set wl i e 1
R000008
Set OK

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:

Default

20

Properties

Gecko OS Kernel 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

-

Default

varies

Properties

Gecko OS Kernel 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:

Default

0.0.0.0

Properties

Gecko OS Kernel 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

-

Default

0.0.0.0 (i.e. No DNS addresses in use)

Properties

Gecko OS Kernel 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

-

Default

0.0.0.0

Properties

Gecko OS Kernel 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

-

Default

0.0.0.0

Properties

Gecko OS Kernel 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

-

Default

0.0.0.0

Properties

Gecko OS Kernel 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

-

Default

0

Properties

Gecko OS Kernel 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#>

Default

-1

Properties

Gecko OS Kernel 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

Arguments

<passphrase> / <WEP key>Description
WPA Passphraselength: 8 - 63 characters
WPA PSKlength: 64 characters
WEP KeyA 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

""

Properties

Gecko OS Kernel 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).

Arguments

<sleep time>

Default

0

Properties

Gecko OS Kernel 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>

valueDescription
0Disabled: no powersave
1Beacon skipping mode
2DTIM skipping mode

Default

0

Properties

Gecko OS Kernel 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>

ValueDescription
11bRestrict 802.11 PHY data rates to 802.11b
11gRestrict 802.11 PHY data rates to 802.11g
11nRestrict 802.11 PHY data rates to 802.11n
autoAutomatically select the best rate from all 802.11b/g/n rates

Default

auto

Properties

Gecko OS Kernel 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 settingprotocolwlan.rate.transmit <rate> value choices
11b802.11bauto, 1, 2, 5.5, 11
11g802.11gauto, 6, 9, 12, 18, 24, 36, 48, 54
11n802.11nauto, mcs0, mcs1, mcs2, ... , mcs7
autoAnyAll the above value choices are available

Default

auto - automatically select the best rate from the available choices

Properties

Gecko OS Kernel 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>

Default

-99

Properties

Gecko OS Kernel 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>

Default

0

Properties

Gecko OS Kernel 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>

Default

75

Properties

Gecko OS Kernel 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 :1413121110987654321channel_bitmask
Channel 1 only000000000000010x001
Channels 11/6/1000100001000010x421
All US region channels000111111111110x7FF
All except for channel 14011111111111110x1FFF
All EU, Japan, Rest of World channels111111111111110x3FFF

Note: Availability of channels 12, 13 and 14 depends on the wlan.region.

Default

0x07FF

Properties

Gecko OS Kernel Plugin

Get example

> get wl s m
R000007
0x7FF

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

Properties

Gecko OS Kernel 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>

Default

3

Properties

Gecko OS Kernel 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

Properties

Gecko OS Kernel 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>

Default

3

Properties

Gecko OS Kernel 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

Properties

Gecko OS Kernel 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

See Procedure for Joining a WLAN Network.

Arguments

<security type>

Options:

Default

Auto

Properties

Gecko OS Kernel 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

""

Properties

Gecko OS Kernel 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

Properties

Gecko OS Kernel 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

Properties

Gecko OS Kernel 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

Properties

Gecko OS Kernel 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

Properties

Gecko OS Kernel 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 0-31.

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.

Arguments

0-31/auto

Default

auto

Properties

Gecko OS Kernel Plugin

Get example

> get wl t
R000006
auto

Set example

> set wl t 15
R000008
Set OK