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

1|true|on/0|false|off

where

Default

0

Platforms

Properties

Gecko OS Plugin

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 if setup.web.captive_portal_enabled is true, or if softap.captive_portal_enabled is true, when the HTTP server receives a request for one of the following:

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

1|true|on/0|false|off

where:

Default

1

Platforms

Gecko OS Plugin

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

Platforms

Properties

Gecko OS Plugin

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 8 WLAN clients for Gecko OS.

See Wi-Fi Interface, SoftAP Interface .

Arguments

None

Default

None

Platforms

Gecko OS Plugin

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

1|true|on/0|false|off

where:

Default

1

Platforms

Properties

Gecko OS Plugin

Get example 

> get so d e
R000003
1

Set example 

> set so d e true
R000008
Set OK

softap.dhcp_server.lease_time

Abbreviation

so d l

Access

get/set

Description

Get or set the DHCP server lease time.

See:

Arguments

<seconds>

86400 seconds = 1 day

Default

86400

One day.

Platforms

Properties

Gecko OS Plugin

Get example 

> get so d l
R000007
86400

Set example 

> set so d l 3600
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

1|true|on/0|false|off

where

Default

1

Platforms

Properties

Gecko OS Plugin

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

gecko-os,gecko-os.com,www.gecko-os.com

Platforms

Properties

Gecko OS Plugin

Get example 

> get so n u
R000043
gecko-os,gecko-os.com,www.gecko-os.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

1|true|on/0|false|off

where:

Default

0

Platforms

Properties

Gecko OS Plugin

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

Platforms

Properties

Gecko OS Plugin

Get example 

> get so t
R000003
7

Set example 

> set so t 20
R000008
Set OK

softap.info

Abbreviation

so o

Access

get

Description

SoftAP connection status parameters: state, SSID, channel and clients.

See Wi-Fi Interface, SoftAP Interface .

Arguments

None

Default

<varies>

Platforms

Gecko OS Plugin

Get example 

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

softap.mac

Abbreviation

so m

Access

get

Description

Returns the softAP MAC address.

Arguments

None

Default

Varies

Platforms

Gecko OS Plugin

Get example 

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

softap.mac_filter.enabled

Abbreviation

sm e

Access

get/set

Description

Enable softAP MAC filter.

See:

Arguments

0|false|off/1|true|on

Default

0

Platforms

Gecko OS Plugin

Get example 

> get sm e
R000003
0

Set example 

> set softap.mac_filter.enabled true
Set OK

softap.mac_filter.info

Abbreviation

sm i

Access

get

Description

Display the contents of the softAP MAC filter list.

See:

Arguments

Default

Platforms

Gecko OS Plugin

Get example 

> get sm i
MAC Addresses:
# 1 F8:16:54:35:0F:8E
# 2 11:22:33:44:55:66

softap.mac_filter.mode

Abbreviation

sm m

Access

get/set

Description

Get or set the softAP MAC filter mode. Modes are:

See:

Arguments

<mode>

where:

Default

whitelist

Platforms

Gecko OS Plugin

Get example 

> get sm m
R000011
whitelist

Set example 

> set sm m blacklist
R000000

softap.max_clients

Abbreviation

so x

Access

get/set

Description

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

Note : The maximum number of clients is 4 .

Arguments

<clients>

where:

Default

4

Platforms

Properties

Gecko OS Plugin

Get example 

> get so x
R000003
4

Set example 

> set so x 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>

where <passphrase> is one of the following:

<passphrase> / <WEP key> Description
WPA Passphrase length: 8 - 63 characters
WPA PSK length: 64 characters
"" Sets a NULL passphrase

For allowable values and set syntax see: Networking and Security, Passkeys .

Default

password

Platforms

Properties

Gecko OS Plugin

Get example 

> get so p
R000000

Set example 

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

softap.rssi_average

Abbreviation

so r

Access

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

Range: 0 - 255

Default

0

Platforms

Properties

Gecko OS Plugin

Get example 

> get so r
0

Set example 

> set so r 10
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 Gecko OS-# , then SSID becomes: Gecko OS-605 .

See Wi-Fi Interface, SoftAP Interface .

Arguments

<ssid>

Default

Gecko_OS-#

Platforms

Properties

Gecko OS Plugin

Get example 

> get so s
R000012
Gecko_OS-#

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

Platforms

Properties

Gecko OS Plugin

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

Platforms

Properties

Gecko OS Plugin

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

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

Platforms

Properties

Gecko OS Plugin

Get example 

> get so s m
R000017
255.255.255.240

Set example 

> set so s m 255.255.255.0
R000008
Set OK

softap.tx_power

Abbreviation

so w

Access

get/set

Description

The Wi-Fi RF transmit power in units of dBm. Range is 0 - 20 .

The maximum transmit power is module dependent.

The value auto sets softap.tx_power to the maximum value permitted by the region, which is auto-detected.

This setting can be affected by wlan.tx_power . If softAP and STA (WLAN) are running at the same time, on the same channel, then the power for both connections is max(wlan.tx_power, softap.tx_power) .

If softAP and STA connections are on different channels, then the wlan.tx_power and softap.tx_power limits apply as specified.

Arguments

<power>

where:

Default

auto

Platforms

Gecko OS Plugin

Get example 

> get so w
R00006
auto

Set example 

> set so w 10
Set OK