ZentriOS-WL-1.4 Command API - Zentri Documentation

SoftAP Interface

softap.auto_start

Abbreviation

so a

Access

get/set

Description

Auto start softap at boot up.

See Wi-Fi Interface, SoftAP Interface.

Arguments

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

Default

0

Properties

network_restart to apply change

Supported Platforms

Get example

> get so a
R000003
0

Set example

> set so a off
R000008
Set OK

softap.captive_portal_enabled

Abbreviation

so v

Access

get/set

Description

Captive portal is optional during websetup and for the softap.

During web setup, or if softap.captive_portal_enabled is true, when the HTTP server receives a request for one of the following:

/generate_204 - Android
/hotspot-detect.html - iOS
/ncsi.txt - Windows

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:

A mobile will automatically reconnect to the softap
No 'no internet' notification is displayed to the user

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

captive.apple.com
www.msftconnecttest.com
www.msftncsi.com
connectivitycheck.gstatic.com
clients3.google.com

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

Abbreviation

so c

Access

get/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

network_restart to apply change

Supported Platforms

Get example

> get so c
R000003
0

Set example

> set so c 6
R000008
Set OK

softap.client_list

Abbreviation

so l

Access

get

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

Abbreviation

so d e

Access

get/set

Description

Enable DHCP server on the softap interface.

See:

Arguments

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

Default

1

Properties

network_restart to apply change

Supported Platforms

Get example

> get so d e
R000003
1

Set example

> set so d e true
R000008
Set OK

softap.dns_server.enabled

Abbreviation

so n e

Access

get/set

Description

Enable DNS redirect server on the softap interface.

See:

Arguments

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

Default

1

Properties

network_restart to apply change

Supported Platforms

Get example

> get so n e
R000003
1

Set example

> set so n e 0
R000008
Set OK

softap.dns_server.url

Abbreviation

so n u

Access

get/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

network_restart to apply change

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

Abbreviation

so h

Access

get/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

network_restart to apply change

Supported Platforms

Get example

> get so h
0

Set example

> set so h 1
Set OK

softap.idle_timeout

Abbreviation

so t

Access

get/set

Description

Maximum client idle time before the client is automatically disassociated.

See Wi-Fi Interface, SoftAP Interface.

Arguments

<# seconds>

Default

7

Properties

network_restart to apply change

Supported Platforms

Get example

> get so t
R000003
7

Set example

> set so t 20
R000008
Set OK

softap.info

Abbreviation

so o

Access

get

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

Abbreviation

so m

Access

get/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. A maximum of 4 clients can send packets to the device.

Arguments

<clients>

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

Default

2.

Properties

Supported Platforms

Get example

> get so m
R000003
4

Set example

> set so m 1
R000008
Set OK

softap.passkey

Abbreviation

so p

Access

get/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

network_restart to apply change

Supported Platforms

Get example

> get so p
R000000

Set example

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

softap.ssid

Abbreviation

so s

Access

get/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

network_restart to apply change

Supported Platforms

Get example

> get so s
R000012
ZentriOS-#

Set example

> set so s myssid#
R000008
Set OK

softap.static.gateway

Abbreviation

so s g

Access

get/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.gateway	softap.dns_server.enabled	Router DHCP response option	DNS Server DHCP response option
`0.0.0.0`	`true`	`softap.static.ip`	`softap.static.ip`
valid and not `0.0.0.0`	`true`	`softap.static.gateway`	`softap.static.gateway`, `softap.static.ip`
valid and not `0.0.0.0`	`false`	`softap.static.gateway`	`softap.static.gateway`
`255.255.255.255`	`true` or `false`	Not advertised	Not advertised

softap.static.ip

Abbreviation

so s i

Access

get/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

network_restart to apply change

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

Abbreviation

so s m

Access

get/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

network_restart to apply change

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