WLAN Interface

wlan.auto_join.enabled

Abbreviation

wl o e

Access

get/set

Description

Enable/disable network auto-join using the wlan interface on bootup.

Arguments

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

Default

0

Properties

Supported Platforms

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.

Arguments

<0-255>

Default

3

Properties

Supported Platforms

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.

Arguments

<0-255>

Default

10

Properties

Supported Platforms

Get example

> get wl o d
R000004
10

Set example

> set wl o d 5
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 ZentriOS v1.2. Renamed from network.dhcp.enabled in ZentriOS 3.0.

See Networking and Security, DHCP Client.

Arguments

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

Default

1

Properties

Supported Platforms

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

Zentri-# where # is replaced by the last three digits of the WLAN MAC address

Properties

Supported Platforms

Get example

> get wl d h
R000009
Zentri-#

Set example

> set wl d h my_dhcp_client
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!

Arguments

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

Default

0

Properties

Supported Platforms

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>

Supported Platforms

Get example

> get wlan.info
state: up
SSID: Zentri
BSSID: 30:85:A9:E7:9C:B0
channel: 6
datarate: 450.0

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).

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.

Arguments

<retries> where '' is an integer ranging 1-255.

Default

3

Properties

Supported Platforms

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.

Arguments

<timeout in ms>

Default

7000 ms

Properties

Supported Platforms

Get example

> get wlan.join.timeout
R000006
7000

Set example

> set wl j t 5000
R000008
Set OK

wlan.mac

Abbreviation

wl m

Access

get

Description

Returns the wlan MAC address.

Arguments

-

Default

varies

Properties

Supported Platforms

Get example

> get wl m
R000019
4C:55:CC:01:23:45

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

Supported Platforms

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

Supported Platforms

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

Supported Platforms

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

Supported Platforms

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

Supported Platforms

Get example

> get wl n s
R000003
2

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

Default

""

Properties

Supported Platforms

Get example

> get wl p
R000000

Set example

> set wl p "Use the force!"
R000008
Set OK

wlan.rate.protocol

Abbreviation

wl r p

Access

get/set

Description

WLAN client data rate protocol selection.

Arguments

<11b/11g/auto>

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

Default

auto

Properties

Supported Platforms

Get example

> get wl r p
auto

Set example

> set wlan.rate.protocol 11b
Set OK

wlan.ssid

Abbreviation

wl s

Access

get/set

Description

The name of the AP the wlan client interface will attempt to join.

Arguments

<ssid>

Default

""

Properties

Supported Platforms

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

Supported Platforms

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

Supported Platforms

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

Supported Platforms

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

Supported Platforms

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 achievable transmit power is dependent on the capability of the module (see Module Comparison).

The maximum transmit power is module dependent. The limit is +18dBm for the AMW004, AMW006 and AMW106 modules in all regions.

Regulatory Compliance in Europe & Japan

In Europe and Japan, the antenna gain must be taken into account to limit transmit power to +18dBm. Antenna gain is subtracted from the maximum of +18dBm to calculate the value of wlan.tx_power.

For a device with an internal antenna, the known antenna gain is programmed into the firmware, and is automatically subtracted by ZentriOS.

For a device with an external antenna, the antenna gain must be measured, and the maximum wlan.tx_power value manually set to:

wlan.tx_power = 18 - antenna_gain

Arguments

0-31/auto

Default

auto

Properties

Supported Platforms

Get example

> get wl t
R000006
auto

Set example

> set wl t 15
R000008
Set OK