- v4.0 - Gecko OS API Documentation Silicon Labs

Setup

setup.auto.cmd

Abbreviation

se a c

Access

get/set

Description

The Gecko OS command specified by setup.auto.cmd is run after boot up if:

setup.gpio.control_gpio is NOT asserted AND
wlan.ssid is NOT configured.

This corresponds to the 'out-of-the-box' default state of a module. You can set setup.auto.cmd to setup cmd to run a setup script file. See Setup Configuration Script .

Arguments

<command>

Default

-

Properties

save and reboot to apply change

Gecko OS Kernel Plugin

setup.gpio

Get example

> get se a c
R000005
wps

Set example

> set se a c "setup web"
R000008
Set OK

setup.gpio.cmd

Abbreviation

se g c

Access

get/set

Description

The specified command is executed in response to a reboot, or a specified GPIO being asserted, depending on the setting of the setup.gpio.control_gpio and the setup.gpio.mode .

Arguments

<command>

Default

setup_web

Properties

takes effect immediately

Gecko OS Kernel Plugin

setup.gpio

Get example

> get se g c
R000011
setup_web

Set example

> set se g c setup_web
R000008
Set OK

setup.gpio.control_gpio

Abbreviation

se g g

Access

get/set

Description

Asserting the GPIO specified by setup.gpio.control_gpio for 3 seconds during and immediately after reset causes the Gecko OS command specified by setup.gpio.cmd to run. A value of -1 disables this feature.

Arguments

<GPIO#>

Default

The default GPIO is platform dependent and is typically mapped
to button 2 on evaluation boards (the wake button)

Properties

save and reboot to apply change

Gecko OS Kernel Plugin

setup.gpio

Get example

> get se g g
R000003
3

Set example

> set se g g 12
R000008
Set OK

setup.gpio.level

Abbreviation

se g l

Access

get/set

Description

The active logic level used when setup.gpio.control_gpio is asserted.

Arguments

<GPIO#>

Default

1

Properties

save and reboot to apply change

Gecko OS Kernel Plugin

setup.gpio

Get example

> get se g l
R000003
1

Set example

> set se g l 0
R000008
Set OK

setup.gpio.mode

Abbreviation

se g m

Access

get/set

Description

The mode setting determines what events result in running the command string specified by setup.gpio.cmd .

If the setup.gpio.cmd is set, the command is run as follows:

Mode	Event Causing Command to Run	Note
`boot`	The command is run on PoR (Power on Reset, or reboot)	The operation ignores the control GPIO.
`gpio`	If setup.gpio.control_gpio is set, the command runs when the GPIO is asserted for 3 seconds through a PoR.	This corresponds to the legacy behavior of running `setup_web` using Button 2 on evaluation boards. Control GPIO is not registered so may be used as another function.
`any`	If setup.gpio.control_gpio is set, the command runs any time the GPIO is asserted.	Control GPIO is registered so cannot be used as another function.

Otherwise the command does not run.

Arguments

<boot/gpio/any>

Default

-

Properties

save and reboot to apply change

Gecko OS Kernel Plugin

setup.gpio

Get example

> get se g m
gpio

Set example

> set se g m boot
R000008
Set OK

setup.web.captive_portal_enabled

Abbreviation

se w a

Access

get/set

Description

Enable or disable captive portal during web setup. See softap.captive_portal_enabled .

Arguments

<1/0>

Default

1

Get example

> get setup.web.captive_portal_enabled

1

Set example

> set setup.web.captive_portal_enabled 0

Set OK

setup.web.client_list

Abbreviation

se w c

Access

get

Description

List MAC address, IP address and OS of connected websetup clients.

Note : 'Invalid' means the client has not yet connected to the webpage (but is connected to the softap).

The additional info comes from the browser's 'User-Agent' field in its HTTP request header.

The following is a list of supported OSs:

Windows
Windows Mobile
Linux
Mac
Android
iPhone
iPod
iPad
Blackberry
Chrome
Symbian
Unknown

Arguments

-

Default

-

Gecko OS Kernel Plugin

setup.web

Get example

> get setup.web.client_list
R000143
! Connected: 2
! # MAC               IP Address   OS
# 1 90:18:7C:34:CB:97 10.10.10.2   Android
# 2 F8:16:54:35:0F:8E 0.0.0.0      Windows

setup.web.idle_timeout

Abbreviation

se w i

Access

get/set

Description

If no client connects to the web setup webpage after setup.web.idle_timeout seconds, web setup times out and is terminated. Upon timeout, if a wlan.ssid has previously been set, Gecko OS attempts to re-join the WLAN network.

setup.web.idle_timeout is disabled when a client requests the root index of the webapp.

Arguments

<seconds> Note : Setting this variable to 0 disables web setup idle timeout.

Default

300 (5 minutes)

Properties

restart setup to apply change

Gecko OS Kernel Plugin

setup.web

Get example

> get setup.web.idle_timeout
R000005
300

Set example

> set se w i 0
R000008
Set OK

setup.web.passkey

Abbreviation

se w p

Access

get/set

Description

The softAP WPA2-AES passphrase used for web setup.

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

Properties

restart setup to apply change

Gecko OS Kernel Plugin

setup.web

Get example

> get we p
R000010
password

Set example

> set we p my-new-password
R000008
Set OK

setup.web.root_filename

Abbreviation

se w r

Access

get/set

Description

The root filename of the web setup: in response to a request for http://gecko-os.com , the web server returns http://Gecko OS.com/<root_filename> .

Note : The file must be a supported type for it to appear correctly in the browser. The type is determined by the file extension. The following types are supported:

Extension	MIME
.css	text/css
.js	application/javascript
.html/.htm	text/html
.png	image/png
.ico	image/x-icon
.gif	image/gif
.jpg/.jpeg	image/jpeg
.txt	text/plain

Arguments

<root_filename>

Default

/setup/index.html

Properties

restart setup to apply change

Gecko OS Kernel Plugin

setup.web

Get example

> get se w r
/setup/index.html

Set example

> set se w r home.htm
R000008
Set OK

setup.web.ssid

Abbreviation

se w s

Access

get/set

Description

The softAP SSID used for web setup. If the SSID ends in a # character, 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 setup.web.ssid is set to Gecko OS Web Setup # , then SSID becomes: Gecko OS Web Setup 605 .

Arguments

<ssid>

Default

Gecko_OS-#

Properties

restart setup to apply change

Gecko OS Kernel Plugin

setup.web

Get example

> get we s
R000021
Gecko_OS-#

Set example

> set we s "This is my softAP!"
R000012
Set OK

setup.web.url

Abbreviation

se w u

Access

get/set

Description

A comma separated list of host names the webserver responds to in web setup mode.

Arguments

<url list>

Default

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

Properties

restart setup to apply change

Gecko OS Kernel Plugin

setup.web

Get example

> get we u
R000057
gecko-os.com,www.gecko-os.com,setup.com,www.setup.com

Set example

> set we u setup,start,lets.go,hello
R000008
Set OK