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.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 Wi-Fi Interface, SoftAP Interface.
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 Wi-Fi Interface, SoftAP Interface.
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 Wi-Fi Interface, SoftAP Interface.
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.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.rate.protocol
Abbreviation | so r p |
Access | get/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
- network_restart to apply change
Supported Platforms
Get example
> get so r p
auto
Set example
> set softap.rate.protocol 11b
Set OK
softap.rate.transmit
Abbreviation | so r t |
Access | get/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 setting | protocol | softap.rate.transmit <rate> value choices |
---|---|---|
11b | 802.11b | 1 , 2 , 5.5 , 11 |
11g | 802.11g | 6 , 9 , 12 , 18 , 24 , 36 , 48 , 54 |
11n | 802.11n | mcs0 , mcs1 , mcs2 , ... , mcs7 |
auto | Any | Set to any of the above choices |
auto | Any | auto : best available of the above choices |
Default
auto
Properties
- network_restart to apply change
Supported Platforms
Get example
> get so r t
5.5
Set example
> set softap.rate.transmit mcs3
Set OK
softap.ssid
Abbreviation | so s |
Access | get/set |
Description
The SSID of the softAP. If the SSID ends with #, the last 6 digits of the WLAN MAC address are appended to the SSID
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 |
See also:
Arguments
<gateway>
Default
0.0.0.0
Properties
- network_restart to apply change
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
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