System

system.build_number

Description

Returns ZentriOS build number.

Arguments

None

Default

N/A

Supported Platforms

• AMW007
• AMW037

Get example

> get sy n
R000009
16eee81

system.cmd.echo

Description

Enable/disable character echo. Only applies to command mode.

Arguments

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

Default

1

Properties

• available in Safe Mode
• preserved by NVM Backup

Supported Platforms

• AMW007
• AMW037

Get example

> get sy c e
R000003
1

Set example

> set sy c e on
R000008
Set OK

system.cmd.header_enabled

Description

Enable/disable a response header for commands. Only applies to command mode. Response headers make it easy to parse responses with a host MCU.

Arguments

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

Default

0

Properties

• available in Safe Mode
• preserved by NVM Backup

Supported Platforms

• AMW007
• AMW037

Get example

> get sy c h
R000003
1

Set example

> set sy c h on
R000008
Set OK

system.cmd.mode

Description

Puts the ZentriOS command interface into human or machine mode, further details are provided in Serial Interface, Command Mode. Note!: This variable is NOT readable.

Arguments

<human | machine>

Default

human

Properties

• available in Safe Mode

Supported Platforms

• AMW007
• AMW037

Set example

> set sy c m human
R000008
Set OK

system.cmd.prompt_enabled

Description

Enable/disable terminal command prompt. Only applies to command mode. A prompt makes it easy for humans to interact with ZentriOS.

Arguments

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

Default

1

Properties

• available in Safe Mode
• preserved by NVM Backup

Supported Platforms

• AMW007
• AMW037

Get example

> get sy c p
R000003
1

Set example

> set sy c p on
R000008
Set OK

system.gotosleep.timeout

Description

The module automatically goes to sleep after a timeout period of <seconds>. The timeout countdown restarts when a wake event occurs and is held off if data is available on open network connections, the minimum timeout is 10 seconds. 0 disables gotosleep. A save and reboot is required before the sleep timeout is enabled.

Arguments

<seconds>

Default

0

Properties

• save and reboot to apply change

Supported Platforms

• AMW007
• AMW037

Get example

> get sy s t
R000003
0

Set example

> set sy s t 12
R000008
Set OK

system.indicator.gpio

Description

The GPIO used for a particular system indicator. System indicators drive LEDs to indicate the state of the wlan, network and softap interfaces. -1 to disable.

Arguments

<wlan/network/softap> <GPIO#>

Default

<varies>

Properties

• save and reboot to apply change

Supported Platforms

• AMW007
• AMW037

Get example

> get sy i g network
R000004
11

Set example

> set gpio.alias 11 netstat_gpio   <- Alias GPIO 11 for simplicity
R000008
Set OK
> set sy i g network netstat_gpio
R000008
Set OK

system.indicator.state

Description

System indicator option for each state as described in the following tables.

WLAN Indicator

Wi-Fi Client status, by default unassigned on eval boards

Network Indicator

Network status, by default GREEN LED on eval boards

SoftAP Indicator

SoftAP status, by default RED LED on eval boards

Arguments

<wlan/network/softap> <csv list>

Default

See above:

• WLAN indicator
• Network Indicator
• SoftAP Indicator

Properties

• save and reboot to apply change

Supported Platforms

• AMW007
• AMW037

Get example

> get sy i s wlan
R000047
static_off|fast_blink|medium_blink|slow_blink

Set example

> set sy i s network static_off|medium_blink|static_on
R000008
Set OK

system.memory.usage

Description

Returns the heap memory currently in use, as a percentage of total heap memory. See Memory.

Arguments

-

Default

-

Supported Platforms

• AMW007
• AMW037

Get example

> get sy e u
58

system.print_level

Description

Print levels:

• 0=None
• 1=Synchronous system msgs
• 2=Synchronous logging msgs
• 3=Asynchronous system msgs
• 4/all=Asynchronous logging msgs

Each print level includes lower levels.

Set system.print_level to 0 to disable all system and log messages.

Arguments

<[0-4]/[all]>

Default

all

Properties

• available in Safe Mode
• preserved by NVM Backup

Supported Platforms

• AMW007
• AMW037

Get example

> get sy p
R000005
all

Set example

> set sy p 0
R000008
Set OK

system.safemode.status

Description

Returns a flag to indicate whether the system is in safe mode. The module switches to safe mode after eight exceptions occur with the boot application.

Arguments

-

Default

0

Properties

• available in Safe Mode

Supported Platforms

• AMW007
• AMW037

Get example

> get sy s
R000003
0

system.safemode.disabled

Description

Disables safe mode feature when set to true. When safe mode is disabled and 8 or more faults occur, ZentriOS automatically resets the fault counter and runs the boot application. It is strongly recommended to leave this setting false as it may not be possible to recover from a fatal error.

Note: A factory reset returns this setting to the default state of false.

Arguments

<true/1/0/false>

Default

0

Properties

• save and reboot to apply change
• available in Safe Mode

Supported Platforms

• AMW007
• AMW037

Get example

> get sy d
R000003
0

Set example

> set sy d 1
R000009
Success

system.uuid

Properties

• available in Safe Mode

Supported Platforms

• AMW007
• AMW037

Description

Returns the hardware UUID of the module.

Arguments

Default

Properties

Get example

> get sy u
R000042
05B3203FA03133434E39423330363031B2303533

system.version

Description

Returns the ZentriOS firmware bundle version.

Arguments

-

Default

<varies>

Properties

• available in Safe Mode

Supported Platforms

• AMW007
• AMW037

Get example

> get sy v
R000069
ZentriOS-W-3.0.0.0, Built:Dec 09 2015 for AMW004.3-E03.1

system.wakeup.timeout

Description

The module automatically wakes from sleep after timeout . 0 disables auto-wakeup.

Arguments

<seconds>

Default

0

Properties

Supported Platforms

• AMW007
• AMW037

Get example

> get sy w t
R000003
0

Set example

> set sy w t 60
R000008
Set OK