Setup

setup.auto.cmd

Abbreviationse a c
Accessget/set

Description

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

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

Supported Platforms

Get example

> get se a c
R000005
wps

Set example

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

setup.gpio.cmd

Abbreviationse g c
Accessget/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

Supported Platforms

Get example

> get se g c
R000011
setup web

Set example

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

setup.gpio.control_gpio

Abbreviationse g g
Accessget/set

Description

Asserting the GPIO specified by setup.gpio.control_gpio for 3 seconds during and immediately after reset causes the ZentriOS 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

Supported Platforms

Get example

> get se g g
R000003
3

Set example

> set se g g 12
R000008
Set OK

setup.gpio.level

Abbreviationse g l
Accessget/set

Description

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

Arguments

<GPIO#>

Default

1

Properties

Supported Platforms

Get example

> get se g l
R000003
1

Set example

> set se g l 0
R000008
Set OK

setup.gpio.mode

Abbreviationse g m
Accessget/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:

ModeEvent Causing Command to RunNote
bootThe command is run on PoR (Power on Reset, or reboot)The operation ignores the control GPIO.
gpioIf 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.
anyIf 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

Supported Platforms

Get example

> get se g m
gpio

Set example

> set se g m boot
R000008
Set OK

setup.web.client_list

Abbreviationse w c
Accessget

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.

A list of possible 'User-Agent' values is found here: http://www.useragentstring.com/pages/useragentstring.php.

The following is a list of supported OSs:

Arguments

-

Default

-

Supported Platforms

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

Abbreviationse w i
Accessget/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, ZentriOS attempts to re-join the WLAN network.

Arguments

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

Default

300 (5 minutes)

Properties

Supported Platforms

Get example

> get setup.web.idle_timeout
R000005
300

Set example

> set se w i 0
R000008
Set OK

setup.web.passkey

Abbreviationse w p
Accessget/set

Description

The softAP WPA2-AES passphrase used for web setup, must be between 8-32 characters in length.

Arguments

<passphrase>

Default

password

Properties

Supported Platforms

Get example

> get we p
R000010
password

Set example

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

setup.web.root_filename

Abbreviationse w r
Accessget/set

Description

The root filename of the web setup: in response to a request for http://zentrios.com, the web server returns http://ZentriOS.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:

ExtensionMIME
.csstext/css
.jsapplication/javascript
.html/.htmtext/html
.pngimage/png
.icoimage/x-icon
.gifimage/gif
.jpg/.jpegimage/jpeg
.txttext/plain

Arguments

<root_filename>

Default

/setup/index.html

Properties

Supported Platforms

Get example

> get se w r
/setup/index.html

Set example

> set se w r home.htm
R000008
Set OK

setup.web.ssid

Abbreviationse w s
Accessget/set

Description

The softAP SSID used for web setup. If the SSID ends in a # character, the last 6 digits of the wlan MAC address are automatically appended to the SSID.

Arguments

<ssid>

Default

ZentriOS Web Setup #

Properties

Supported Platforms

Get example

> get we s
R000021
ZentriOS Web Setup #

Set example

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

setup.web.url

Abbreviationse w u
Accessget/set

Description

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

Arguments

<url list>

Default

zentrios.com,www.zentrios.com,setup.com,www.setup.com

Properties

Supported Platforms

Get example

> get we u
R000057
zentrios.com,www.zentrios.com,setup.com,www.setup.com

Set example

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