SoftAP Interface

softap.auto_start

Abbreviationso a
Accessget/set

Description

Auto start softap at boot up.

See Wi-Fi Interface, SoftAP Interface.

Arguments

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

Default

0

Properties

Supported Platforms

Get example

> get so a
R000003
0

Set example

> set so a off
R000008
Set OK

softap.captive_portal_enabled

Abbreviationso v
Accessget/set

Description

Captive portal is supported during websetup and optionally for the softap.

During websetup, or if softap.captive_portal_enabled is enabled for the softap, if the HTTP server receives a request for one of the following:

then ZentriOS automatically returns the HTTP response:

HTTP/1.1 302 Redirect\r\n
Location: http://<server domain>/\r\n\r\n

This notification redirects the user to the root HTTP server webpage.

The DNS server AND HTTP server must be configured to run on the softap interface for this feature to work.

Note: if captive portal is NOT enabled for the softap, then when a request for one of the above resources is received, the HTTP server automatically returns:

HTTP/1.1 204 Ok\r\n\r\n

This makes it appear as if the softap has internet access. This allows for a better user experience as:

The DNS server automatically resolves the following domains to enable captive portal:

Arguments

<0/1>

Default

0

Supported Platforms

Get example

> get softap.captive_portal_enabled 
R000003
0

Set example

> set softap.captive_portal_enabled 1
R000008
Set OK

softap.channel

Abbreviationso c
Accessget/set

Description

The SoftAP channel.

If a WLAN interface is already active, the value of softap.channel is ignored, since the WLAN interface has channel set priority.

If WLAN interface is not active, and softap.channel is 0, SoftAP starts on the least busy of channels 1, 6 and 11.

See Wi-Fi Interface, SoftAP Interface.

Arguments

<channel>

Default

0

Properties

Supported Platforms

Get example

> get so c
R000003
0

Set example

> set so c 6
R000008
Set OK

softap.client_list

Abbreviationso l
Accessget

Description

Return list of connected softap clients.

Note: The SoftAP is limited to a maximum of 4 WLAN clients for ZentriOS on the AMW004 (Wallaby) and AMWx06 (Numbat) modules.

See Wi-Fi Interface, SoftAP Interface.

Arguments

-

Default

-

Supported Platforms

Get example

 get so l
! Connected: 2
! # MAC               IP Address
# 1 F8:16:54:35:0F:8E 10.10.10.2
# 2 11:22:33:44:55:66 10.10.10.17

softap.dhcp_server.enabled

Abbreviationso d e
Accessget/set

Description

Enable DHCP server on the softap interface.

See:

Arguments

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

Default

1

Properties

Supported Platforms

Get example

> get so d e
R000003
1

Set example

> set so d e true
R000008
Set OK

softap.dhcp_server.lease_time

Abbreviationso d l
Accessget/set

Description

Get or set the DHCP server lease time.

See:

Arguments

<seconds>

Default

86400

One day.

Properties

Supported Platforms

Get example

> get so d l
R000007
86400

Set example

> set so d l 3600
R000008
Set OK

softap.dns_server.enabled

Abbreviationso n e
Accessget/set

Description

Enable DNS redirect server on the softap interface.

See:

Arguments

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

Default

1

Properties

Supported Platforms

Get example

> get so n e
R000003
1

Set example

> set so n e 0
R000008
Set OK

softap.dns_server.url

Abbreviationso n u
Accessget/set

Description

Comma separated list of domains to resolve. Maximum of 63 characters.

See:

Arguments

<comma separated list>

Default

zentrios,zentrios.com,www.zentrios.com

Properties

Supported Platforms

Get example

> get so n u
R000043
zentrios,zentrios.com,www.zentrios.com

Set example

> set so n u mydevice,mydevice.com
R000008
Set OK

softap.hide_ssid

Abbreviationso h
Accessget/set

Description

When enabled, this variable disables broadcast of the softap's SSID, for security purposes.

See Wi-Fi Interface, SoftAP Interface.

Arguments

<0/1>

Default

0

Properties

Supported Platforms

Get example

> get so h
0

Set example

> set so h 1
Set OK

softap.idle_timeout

Abbreviationso t
Accessget/set

Description

Maximum client idle time before the client is automatically disassociated.

See Wi-Fi Interface, SoftAP Interface.

Arguments

<# seconds>

Default

7

Properties

Supported Platforms

Get example

> get so t
R000003
7

Set example

> set so t 20
R000008
Set OK

softap.info

Abbreviationso o
Accessget

Description

Soft AP connection status parameters: state, SSID, channel and clients.

See Wi-Fi Interface, SoftAP Interface.

Arguments

-

Default

<varies>

Supported Platforms

Get example

> get softap.info
state: up
SSID: ZentriOS-#
channel: 0
clients: 1

softap.max_clients

Abbreviationso m
Accessget/set

Description

Limit the number of clients that may connect to the SoftAP interface.

Note: Due to a hardware limitation, more than softap.max_clients are able to associate to the soft AP, however the client's ethernet packets are dropped. Thus clients are able to monitor soft AP network traffic, but are not able to send packets to the device.

Arguments

<clients>

where <clients> is an integer ranging from 1 to 4

Default

4

Properties

Supported Platforms

Get example

> get so m
R000003
4

Set example

> set so m 1
R000008
Set OK

softap.passkey

Abbreviationso p
Accessget/set

Description

The WPA2-AES passphrase for the softap interface, or none to disable security.

See Wi-Fi Interface, SoftAP Interface.

Arguments

<passphrase>

Default

""

Properties

Supported Platforms

Get example

> get so p
R000000

Set example

> set so p "My softAP password"
R000008
Set OK

softap.rate.protocol

Abbreviationso r p
Accessget/set

Description

SoftAP data rate protocol selection. Use 11b to restrict 802.11 PHY data rates to 802.11b, 11g for 802.11g data rates, 11n for 802.11n data rates, and auto to automatically select the best rate from all 802.11b/g/n rates. To set a fixed softAP transmit data rate, see softap.rate.transmit.

See Wi-Fi Interface, SoftAP Interface.

Arguments

<11b/11g/11n/auto>

Default

auto

Properties

Supported Platforms

Get example

> get so r p
auto

Set example

> set softap.rate.protocol 11b
Set OK

softap.rate.transmit

Abbreviationso r t
Accessget/set

Description

Force the softAP interface to transmit at a fixed data rate. The transmit rate is chosen from the subset specified by softap.rate.protocol.

See Wi-Fi Interface, SoftAP Interface.

Arguments

<rate> where:

softap.rate.protocol settingprotocolsoftap.rate.transmit <rate> value choices
11b802.11b1, 2, 5.5, 11
11g802.11g6, 9, 12, 18, 24, 36, 48, 54
11n802.11nmcs0, mcs1, mcs2, ... , mcs7
autoAnySet to any of the above choices
autoAnyauto: best available of the above choices

Default

auto

Properties

Supported Platforms

Get example

> get so r t
5.5

Set example

> set softap.rate.transmit mcs3
Set OK

softap.rssi_average

Abbreviationso r
Accessget/set

Description

The number of consecutive softap client RSSI readings to average in the result for the softap_get_rssi command. Averaging smooths variations in the measured signal strength of the AP. Set to 0 to disable averaging.

Arguments

<0-255> - decimal number specifying the count of consecutive readings to average

Default

0

Properties

Supported Platforms

Get example

> get so r 
0

Set example

> set so r 10
Set OK

softap.ssid

Abbreviationso s
Accessget/set

Description

The SSID of the softAP. If the SSID ends with #, the last three hex characters of the WLAN MAC address replace the #.

For example, if the device MAC address is 4C:55:CC:10:26:05, and softap.ssid is set to ZentriOS-#, then SSID becomes: ZentriOS-605.

See Wi-Fi Interface, SoftAP Interface.

Arguments

<ssid>

Default

ZentriOS-#

Properties

Supported Platforms

Get example

> get so s
R000012
ZentriOS-#

Set example

> set so s myssid#
R000008
Set OK

softap.static.gateway

Abbreviationso s g
Accessget/set

Description

Determines the SoftAP interface's gateway advertised during a DHCP response. This allows the SoftAP gateway to be set independently of the softap.static.ip. If softap.static.gateway is set to 0.0.0.0, then use the softap.static.ip setting as the gateway.

This setting is only used if softap.dhcp_server.enabled = true. This setting is used in the DHCP response Router option (and optionally in the DNS Server option).

Use Cases

softap.static.gatewaysoftap.dns_server.enabledRouter
DHCP response option
DNS Server
DHCP response option
0.0.0.0truesoftap.static.ipsoftap.static.ip
valid and not 0.0.0.0truesoftap.static.gatewaysoftap.static.gateway, softap.static.ip
valid and not 0.0.0.0falsesoftap.static.gatewaysoftap.static.gateway
255.255.255.255true or falseNot advertisedNot advertised

See also:

Arguments

<gateway>

Default

0.0.0.0

Properties

Supported Platforms

Get example

> get so s g
R000012
10.10.10.1

Set example

> set so s g 0.0.0.0
R000008
Set OK

softap.static.ip

Abbreviationso s i
Accessget/set

Description

The IP address used for the softap network interface. The netmask is 255.255.255.0.

The softAP gateway depends on the softap.static.gateway setting. If softap.static.gateway is 0.0.0.0, the gateway is set to softap.static.ip.

Note: The softap.static.ip settings are also used for web setup.

See Wi-Fi Interface, SoftAP Interface.

Arguments

<IP address>

Default

10.10.10.1

Properties

Supported Platforms

Get example

> get so s i
R000013
10.10.10.1

Set example

> set so s i 192.168.10.1
R000008
Set OK

softap.static.netmask

Abbreviationso s m
Accessget/set

Description

Determines the range of IP addresses offered by the Soft AP.

For example, a netmask of 255.255.255.0 gives a range of 254 IP addresses.

Some platforms, such as Windows 8, send ARP (Address Resolution Protocol) packets to all available IP addresses, which can overload the module WL chip.

The work-around is to set a default network mask pf 255.255.255.240, so valid IPs are limited to the range x.x.x.1-7. Consequently only 8 ARP packets are sent.

Arguments

<netmask address>

Default

255.255.255.240

Properties

Supported Platforms

Get example

> get so s m
R000017
255.255.255.240

Set example

> set so s m 255.255.255.0
R000008
Set OK