System

system.adc.vref

Abbreviationsy a v
Accessget/set

Description

Specify the ADC reference voltage, in millivolts, used by the adc_take_sample command.

Arguments

<mv>

Default

3300

Supported Platforms

Get example

> get system.adc.vref
3300

Set example

> set sy a v 3200
Set OK

system.activity.gpio

Abbreviationsy a g
Accessget/set

Description

Map GPIO to activity type. When activity is detected, the corresponding GPIO is momentarily set to the level specified by system.activity.gpio_level.

Arguments

''<GPIO#> <type> where:

Default

none - no GPIOs are mapped to activity types

Properties

Supported Platforms

Get example

> get system.activity.gpio 1
none

Set example

> set system.activity.gpio 7 softap_rx,softap_tx,wlan_tx
Set OK
> get system.activity.gpio 7
softap_rx,softap_tx,wlan_tx
>
Ready
> set system.activity.gpio -1 softap_rx
Set OK
> get system.activity.gpio 7
softap_tx,wlan_tx

system.activity.gpio_level

Abbreviationsy a l
Accessget/set

Description

Specify the GPIO level corresponding to activity. See system.activity.gpio.

Arguments

<1/0>

Default

1

Properties

Supported Platforms

Get example

> get system.activity.gpio_level 1
1

Set example

> set system.activity.gpio_level 0

system.bflash.cs_gpio

Abbreviationsy f g
Accessget/set

Description

Specify the bulk flash's chip select gpio. Set to -1 to disable the bulk flash feature.

See File System, Internal, Extended and Bulk Flash.

Arguments

<GPIO #>

Default

-1

Properties

Supported Platforms

Get example

> get system.bflash.cs_gpio
-1

Set example

> set sy f g 4
Set OK

system.boot.image

Abbreviationsy b i
Accessget/set

Description

Default boot application. The <filename> must be a valid boot application available on the filesystem.

Arguments

<filename>

Default

zentrios

Properties

Supported Platforms

Get example

> get sy b i
R000018
sys/services.bin

Set example

> set sy b i sys/services.bin
R000008
Set OK

system.build_number

Abbreviationsy b n
Accessget

Description

Returns ZentriOS build number.

Arguments

None

Default

N/A

Supported Platforms

Get example

> get sy b n
R000009
16eee81

system.cmd.buffered

Abbreviationsy c b
Accessget/set

Description

Flag to enable/disable buffering of certain command responses. This is intended for use when reading command output by machine.

If enabled, a command's response is buffered and a stream handle along with the response size in bytes is returned.

The host must use the 'read' command to retrieve the command's response data.

Note that if headers are enabled, the header is returned along with the stream handle and response size.

The following commands are buffered if the system.cmd.buffered flag is set:

See Networking and Security, Network Connections and Streams.

Arguments

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

Default

0

Properties

Supported Platforms

Get example

> get sy c b
0

Set example

> set sy c b on
Set OK

system.cmd.echo

Abbreviationsy c e
Accessget/set

Description

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

Arguments

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

Default

1

Properties

Supported Platforms

Get example

> get sy c e
R000003
1

Set example

> set sy c e on
R000008
Set OK

system.cmd.header_enabled

Abbreviationsy c h
Accessget/set

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

Supported Platforms

Get example

> get sy c h
R000003
1

Set example

> set sy c h on
R000008
Set OK

system.cmd.mode

Abbreviationsy c m
Accessset

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

Supported Platforms

Set example

> set sy c m human
R000008
Set OK

system.cmd.prompt_enabled

Abbreviationsy c p
Accessget/set

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

Supported Platforms

Get example

> get sy c p
R000003
1

Set example

> set sy c p on
R000008
Set OK

system.cmd.timestamp

Abbreviationsy c t
Accessget/set

Description

When set to value other than none, adds a millisecond resolution timestamp to each ZentriOS response. The timestamp appears before other output, and is followed by a colon and a space, e.g.
rtc output:

> get wlan.network.ip
1409819199621: 10.5.6.71

utc output:

> get wlan.network.ip
2014-09-04 | 08:27:45: 10.5.6.71

Arguments

<none/rtc/utc> where:

none

Properties

Supported Platforms

Get example

> get sy c t
2014-09-04 | 08:32:11: utc

Set example

> set sy c t rtc

system.gotosleep.timeout

Abbreviationsy s t
Accessget/set

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

Supported Platforms

Get example

> get sy s t
R000003
0

Set example

> set sy s t 12
R000008
Set OK

system.indicator.gpio

Abbreviationsy i g
Accessget/set

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

Supported Platforms

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

Abbreviationsy i s
Accessget/set

Description

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

WLAN Indicator

Wi-Fi Client status, by default GREEN LED on eval boards

State #State DescriptionDefault Behavior
state 1Wi-Fi offstatic_off
state 2Errorfast_blink
state 3Connecting to APmedium_blink
state 4Joined to APslow_blink

Network Indicator

Network status, by default YELLOW LED on eval boards

State #State DescriptionDefault Behavior
state 1No IP addressfast_blink
state 2DHCP in-progressmedium_blink
state 3DHCP successfulslow_blink

SoftAP Indicator

SoftAP status, by default RED LED on eval boards

State #State DescriptionDefault Behavior
state 1SoftAP offstatic_off
state 2SoftAP errorfast_blink
state 3SoftAP activemedium_blink
state 4Client connectedslow_blink

For blink rates, see Configuration and Setup, System Indicator State Options

Arguments

<wlan/network/softap> <csv list>

Default

<see above>

Properties

Supported Platforms

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

Abbreviationsy e u
Accessget

Description

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

Arguments

-

Default

-

Supported Platforms

Get example

> get sy e u
58

system.msg

Abbreviationsy m
Accessget/set

Description

Customize system messages for various events: initialized, sleep, wlan_joining, wlan_joined, wlan_leave, wlan_failed, softap_joined, softap_leave, network_opening, network_opened, network_closed, network_failed. Tags may be included to provide dynamic information as shown below.

TagDescriptionTag is available for ...
@tTimestampAll messages
@sSSIDAll wlan messages
@cStream handlenetwork_opened, network_closed
@hConnection host/portnetwork_opening, network_failed
@mClient MAC Addresssoftap_joined, softap_leave

Arguments

<message name> <message value>

Default

<see get example below>

Supported Platforms

Get example

> get system.msg all
R000397
initialized - [@tReady]
network_closed - [@tDisconnected: @c]
network_failed - [@tConnect failed]
network_opened - [@tConnected: @c]
network_opening - [@tConnecting: @h]
sleep - [@tSleep]
wlan_failed - [@tJoin failed]
wlan_joined - [@tAssociated]
wlan_joining - [@tAssociating to @s]
wlan_leave - [@tDisassociated]
softap_joined - [@t@m associated]
softap_leave - [@t@m disassociated]

Set example

> set sy m wlan_leave "[@t: Bye for now]"
R000008
Set OK

system.oob.event_mask

Abbreviationsy o e
Accessget/set

Description

The mask of events which assert the OOB GPIO. See system.oob.gpio.

For event/mask mapping, see the system.oob.gpio event mask table.

Arguments

<hex mask> Mask is specified in the form 0xHH where H is a hexadecimal digit 0-F.

Default

0x0

Supported Platforms

Get example

> get sy o e
0x1F

Set example

> set sy o e 0x11
Set OK

system.oob.gpio

Abbreviationsy o g
Accessget/set

Description

The system.oob variables allow creation of an out-of-band interrupt (OOB) GPIO. This GPIO is asserted whenever one or more of the configured OOB events occurs. It is de-asserted when reading the OOB status register.

Note: OOB events are in most cases related to a corresponding special function GPIO variable. However, the OOB event can be configured without setting the corresponding special function GPIO. For example, The network.status_gpio OOB event can be triggered without setting the wlan.network.status_gpio variable.

Specify the OOB GPIO with the system.oob.gpio variable.

Specify the active level of the OOB GPIO with system.oob.gpio_level.

Specify the events that cause the OOB GPIO to be asserted with system.oob.event_mask.

Specify events that trigger the OOB GPIO only on the rising edge (i.e. when the event is asserted) with system.oob.rising_edge_mask.

Read the events that triggered an OOB interrupt from the system.oob.status variable.

Only one GPIO can be specified as the OOB GPIO. Determine the OOB GPIO by reading the gpio.usage variable or the system.oob.gpio variable.

Events are mapped to the event mask, rising edge mask and status mask as shown in the following table:

OOB Event NameMask Value
ioconn.status_gpio0x001
wlan.network.status_gpio0x002
tcp.server.connected_gpio0x004
tcp.server.data_gpio0x008
udp.server.data_gpio0x010
tcp.client.data_gpio (see tcp_client -g)0x020
udp.client.data_gpio (see udp_client -g)0x040
http.server.ws_connected_gpio0x080
http.server.ws_data_gpio0x100
websocket.client.data_gpio (see websocket_client)0x200

See Handling Multiple Clients with OOB Interrupts for details of use.

Arguments

<GPIO #> The number of the OOB GPIO.

Default

No GPIO assigned to OOB

Properties

Supported Platforms

Get example

> get sy o g
22

Set example

> set system.oob.gpio 22
Set OK

system.oob.gpio_level

Abbreviationsy o l
Accessget/set

Description

The active level of the OOB GPIO. See system.oob.gpio.

Arguments

<0/1>

Default

1

Supported Platforms

Get example

> get sy o l
1

Set example

> set sy o l 0
Set OK

system.oob.rising_edge_mask

Abbreviationsy o r
Accessget/set

Description

The mask of events which should trigger the OOB GPIO only on the rising edge (i.e. when an event is asserted). See system.oob.gpio.

If the mask is cleared, then the OOB GPIO is asserted on both rising and falling edges.

For instance, when the module connects, the network status event event is considered asserted. When the module disconnects, the event is considered de-asserted.

For event/mask mapping, see the system.oob.gpio event mask table.

Arguments

<hex mask> Mask is specified in the form 0xHH where H is a hexadecimal digit 0-F.

Default

0x0

Supported Platforms

Get example

> get sy o r
0x1F

Set example

> set sy o r 0x11
Set OK

system.oob.status

Abbreviationsy o s
Accessget

Description

The mask of triggered events. When an event is triggered, the OOB GPIO is asserted and the status mask is updated with the triggering event. Reading this variable returns a mask of events that caused the OOB gpio to be asserted.

Reading this variable de-asserts the OOB GPIO and clears the status mask.

For event/mask mapping, see the system.oob.gpio event mask table.

Arguments

-

Default

0x0

Supported Platforms

Get example

get sy o e
0x0

system.powersave.mode

Abbreviationsy p m
Accessget/set

Description

Set the system powersave mode where 0 = no powersave, 1 = core powered down on idle with <5 cycles power up latency. Additional powersave modes will be added in an upcoming release. Until then, use [system.gotosleep.timeout](/zentrios/w/3.0/cmd/variables/system#system-gotosleep-timeout) to put the module into deep sleep.

Note! Wi-Fi powersave is independently configured using wlan.powersave.mode.

Arguments

<mode>

Default

1

Properties

Supported Platforms

Get example

> get sy p m
R000003
1

Set example

> set sy p m 0
R000008
Set OK

system.print_level

Abbreviationsy p
Accessget/set

Description

Print levels:

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

Supported Platforms

Get example

> get sy p
R000005
all

Set example

> set sy p 0
R000008
Set OK

system.safemode.status

Abbreviationsy s
Accessget

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

Supported Platforms

Get example

> get sy s
R000003
0

system.safemode.disabled

Abbreviationsy d
Accessget/set

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 configured with system.boot.image. 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

Supported Platforms

Get example

> get sy d
R000003
0

Set example

> set sy d 1
R000009
Success

system.uuid

Abbreviationsy u
Accessget

Description

Returns the hardware UUID of the module.

Arguments

Default

Properties

Supported Platforms

Get example

> get sy u
R000042
05B3203FA03133434E39423330363031B2303533

system.version

Abbreviationsy v
Accessget

Description

Returns the ZentriOS firmware bundle version.

Arguments

-

Default

<varies>

Properties

Supported Platforms

Get example

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

system.wakeup.events

Abbreviationsy w e
Accessget/set

Description

Control which events wake the module from sleep. Multiple options are separated by the '%%%%' character. \0 disables wake events.
Some UART interfaces do not have wake capability. See Peripherals, GPIO Functions and Pins for tables showing GPIOs with wake capability.

Note: On Zentri evaluation boards the Button 2 GPIO (GPIO11 Wallaby, GPIO22 Numbat) is by default set as one of the system.wakeup.events and also associated with the setup.gpio.control_gpio function. When using Button 2 as a wakeup event, either disable the setup.gpio.control_gpio function, or ensure the GPIO is asserted for less than 3 seconds, otherwise the module will enter web setup mode after waking.|

Arguments

<[<uartX>|<gpioX>] / [\0]>

Default

uart0

Supported Platforms

Get example

> get sy w e
R000007
uart0

Set example

> set sy w e gpio5|uart0
R000008
Set OK

system.wakeup.timeout

Abbreviationsy w t
Accessget/set

Description

The module automatically wakes from sleep after timeout . Wake events are configured with system.wakeup.events. 0 disables auto-wakeup.

Arguments

<seconds>

Default

0

Supported Platforms

Get example

> get sy w t
R000003
0

Set example

> set sy w t 60
R000008
Set OK