System

system.activity.gpio

Abbreviation

sy a g

Access

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

Gecko OS Kernel Plugin

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

Abbreviation

sy a l

Access

get/set

Description

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

Arguments

<1/0>

Default

1

Properties

Gecko OS Kernel Plugin

Get example

> get system.activity.gpio_level
1

Set example

> set system.activity.gpio_level 0

system.adc.vref

Abbreviation

sy a v

Access

get/set

Description

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

Arguments

<mv>

Default

3300

Properties

Gecko OS Kernel Plugin

Get example

> get system.adc.vref
3300

Set example

> set sy a v 3200
Set OK

system.bflash.cs_gpio

Abbreviation

sy f g

Access

get/set

Description

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

See File System, Flash Storage.

Arguments

<GPIO #>

Default

-1

Properties

Gecko OS Kernel Plugin

Get example

> get system.bflash.cs_gpio
-1

Set example

> set sy f g 4
Set OK

system.bflash.port

Abbreviation

sy f p

Access

get/set

Description

Specify the bulk flash SPI port. This complements the system.bflash.cs_gpio variable.

See File System, Flash Storage.

Note: Set this variable before setting system.bflash.cs_gpio.

The DFU package is also able to specify the bulk flash SPI port and CS GPIO. See DFU.

Arguments

spi0/spi1

Default

spi1 (on WGM160P)

Properties

Gecko OS Kernel Plugin

Get example

> get system.bflash.port
-1

Set example

> set sy f g 4
Set OK

system.bootloader.fsb_version

Abbreviation

sy b f

Access

get

Description

This variable returns the version of the first stage bootloader.

Arguments

None

Default

None

Gecko OS Kernel Plugin

Get example

> get sy b f
R000018
sys/services.bin???

system.bootloader.ssb_version

Abbreviation

sy b s

Access

get

Description

This variable returns the version of the second stage bootloader.

Arguments

None

Default

None

Gecko OS Kernel Plugin

Get example

> get sy b s
R000018
sys/services.bin???

system.build_number

Abbreviation

sy n (in some versions: sy b n)

Access

get

Description

Returns Gecko OS build number.

Arguments

None

Default

N/A

Gecko OS Kernel Plugin

Get example

> get sy n
R000009
16eee81

system.cmd.aux_bus

Abbreviation

sy c x

Access

get/set

Description

Enables or disables the aux_bus which maps to the log bus, acting as an auxiliary command console.

If system.cmd.aux_bus is set to 1 then an additional command console is allocated to the log bus.

The following command sequence shows an example of using this variable. The data bus, UART0, is used in stream mode and the log bus, UART1, is used for receiving logs and sending commands.

set bus.log_bus uart1
set bus.data_bus uart0
set system.cmd.aux_bus 1
set bus.mode stream
set wlan.ssid <network name>
set wlan.passkey <network password>
set wlan.auto_join.enabled 1
set tcp.client.auto_start 1
set tcp.client.remote_host test.zentri.com
set tcp.client.remote_port 50007
save
reboot

On rebooting, UART0 will send to, and receive data from, the remote TCP server test.zentri.com.

UART1 can be used to receive logs as well as send commands to Gecko OS.

Note that the $$$ break-in sequence can still be used to break in to command mode via UART0. See Serial Interface, Breaking out of Stream Mode.

Arguments

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

Default

0

Properties

Gecko OS Kernel Plugin

Get example

> get sy c x
0

Set example

> set sy c x 1
Set OK

system.cmd.buffered

Abbreviation

sy c b

Access

get/set

Description

Flag to enable/disable buffering of certain command responses. This is intended for use when reading command output by machine. See Serial Interface, Command Protocol.

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:

Stream Type: CMD. See Networking and Security, Network Connections and Streams.

Arguments

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

where

Default

0

Properties

Gecko OS Kernel Plugin

Get example

> get sy c b
0

Set example

> set sy c b on
Set OK

system.cmd.echo

Abbreviation

sy c e

Access

get/set

Description

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

Arguments

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

where

Default

1

Properties

Gecko OS Kernel Plugin

Get example

> get sy c e
R000003
1

Set example

> set sy c e on
R000008
Set OK

system.cmd.format

Abbreviation

sy c f

Access

set

Description

Puts the Gecko OS command API interface into human or machine format. For further details, see Serial Interface, Configuring Bus Command Mode.

Note: This variable is NOT readable.

Arguments

<human | machine>

Default

human

Properties

Gecko OS Kernel Plugin

Set example

> set sy c f human
R000008
Set OK

system.cmd.gpio

Abbreviation

sy c g

Access

get/set

Description

When configured, this GPIO is asserted HIGH AFTER Gecko OS issues a command response. It is cleared (i.e. set LOW) on the start of the next command.

Note: The system.cmd_gpio is triggered only for commands FROM the serial bus. Commands from other sources such as the remote terminal and REST API have no effect.

This makes sending commands to Gecko OS much easier:

With DMA, the processor has to do little work. The command TX and response RX can be done in the background. An external pin interrupt triggers when the command/response sequence is complete.

Arguments

<gpio #>

Default

None

Properties

Gecko OS Kernel Plugin

Set example

> set sy c g 9
R000008
Set OK

Get example

> get sy c g
R000003
9

system.cmd.header_enabled

Abbreviation

sy c h

Access

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

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

where

Default

0

Properties

Gecko OS Kernel Plugin

Get example

> get sy c h
R000003
1

Set example

> set sy c h on
R000008
Set OK

system.cmd.prompt_enabled

Abbreviation

sy c p

Access

get/set

Description

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

Arguments

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

where

Default

1

Properties

Gecko OS Kernel Plugin

Get example

> get sy c p
R000003
1

Set example

> set sy c p on
R000008
Set OK

system.cmd.timestamp

Abbreviation

sy c t

Access

get/set

Description

When set to value other than none, adds a millisecond resolution timestamp to each Gecko OS 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
20149-01-01 | 08:27:45: 10.5.6.71

Arguments

<none/rtc/utc> where:

Default

none

Properties

Gecko OS Kernel Plugin

Get example

> get sy c t
2019-01-01 | 08:32:11: utc

Set example

> set sy c t rtc

system.factory_reset.gpio

Abbreviation

sy r g

Access

get/set

Description

If configured, this GPIO acts as an auxiliary GPIO. It has the same functionality as the hardcoded factory reset GPIO. See Update and Recovery, Factory Reset GPIO.

To disable, use GPIO# = -1:

> system.factory_reset.aux_gpio -1 SILABS

To set level, see system.factory_reset.level.

Notes

Arguments

<GPIO#> SILABS where

Default

16

Properties

Gecko OS Kernel Plugin

Get example

> get sy r g 
-1

Set example

> set sy r g 20 SILABS
Aux factory reset GPIO set
Set OK

system.factory_reset.level

Abbreviation

sy r l

Access

get/set

Description

Configures the active level of system.factory_reset.gpio.

Set system.factory_reset.gpio to apply change.

Arguments

<0/1>

Default

1

Properties

Gecko OS Kernel Plugin

Get example

> get sy r l
1

Set example

> set sy r l 0
Aux factory reset GPIO level set
Set OK

system.hfxo.enabled

Abbreviation

sy h e

Access

get/set

Description

Enable the external High Frequency Crystal Oscillator.

Arguments

0|off|false/1|on|true

Default

0

Get example

> get sy h e
R000003
0

Set example

> set sy h e 1
R000008
Set OK

system.hfxo.status

Abbreviation

sy h s

Access

get

Description

Display the status of the external High Frequency Crystal Oscillator.

Arguments

-

Default

-

Get example

> get sy h s
R000003
0

system.indicator.gpio

Abbreviation

sy i g

Access

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

get

<wlan/network/softap/ethernet/all>

set

<wlan/network/softap/ethernet> <GPIO#>

Default

<varies>

Properties

Gecko OS Kernel Plugin

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

Abbreviation

sy i s

Access

get/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 activefast_blink
state 3SoftAP errormedium_blink
state 4Client connectedslow_blink

Ethernet Indicator

Ethernet status

State #State DescriptionDefault Behavior
state 1Ethernet downstatic_off
state 2Ethernet errorfast_blink
state 3Ethernet connectingmedium_blink
state 4Ethernet upslow_blink

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

Arguments

get

<wlan/network/softap/ethernet/all>

set

<wlan/network/softap/ethernet> <psv list>

where:

Default

See above:

Properties

Gecko OS Kernel Plugin

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.interface.ethernet_enabled

Abbreviation

sy i e

Access

get/set

Description

Enable the Ethernet interface.

Arguments

0|off|false/1|on|true

Default

0

Gecko OS Kernel Plugin

Get example

> get sy i e
0
> set system.interface.ethernet_enabled 1
Set OK

system.interface.wifi_enabled

Abbreviation

sy i w

Access

get/set

Description

Enable the Wi-Fi interface.

Arguments

0|off|false/1|on|true

Default

1

Gecko OS Kernel Plugin

Get example

> get sy i w
1
> set system.interface.wifi_enabled 0
Set OK

system.memory.usage

Abbreviation

sy e u

Access

get

Description

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

Arguments

-

Default

-

Gecko OS Kernel Plugin

Get example

> get sy e u
58

system.msg

Abbreviation

sy m

Access

get/set

Description

Customize the system messages that are displayed for various events. Tags may be included to provide dynamic information as shown in the tag availability table below.

Note: In the current version, you need to use the full variable name system.msg when setting a message value. Setting with sy m returns an error.

Default values for messages are:

MessageDefault Value
initialized[@tReady]
stream_closed[@tClosed: @c]
stream_failed[@tOpen failed]
stream_opened[@tOpened: @c]
stream_opening[@tOpening: @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]
ethernet_starting[@tEthernet Starting]
ethernet_started[@tEthernet Started]
ethernet_stopped[@tEthernet Stopped]
ethernet_failed[@tEthernet Failed]

Tag availability:

TagDescriptionTag is available for ...
@tTimestampCan be set for all messages, but displays a value only for ethernet messages.
@sSSIDWLAN messages
@cStream handlestream_closed, stream_opened
@hConnection host/portstream_failed, stream_opening
@mClient MAC Addresssoftap_joined, softap_leave

Arguments

<message name> <message value>

Default

<see get example below>

Properties

Gecko OS Kernel Plugin

Get example

> get system.msg all
initialized - [@tReady]
stream_closed - [@tClosed: @c]
stream_failed - [@tOpen failed]
stream_opened - [@tOpened: @c]
stream_opening - [@tOpening: @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]
ethernet_starting - [@tEthernet Starting]
ethernet_started - [@tEthernet Started]
ethernet_stopped - [@tEthernet Stopped]
ethernet_failed - [@tEthernet Failed]

Set example

> set system.msg wlan_leave "[@t: Bye for now]"
R000008
Set OK

system.oob.event_mask

Abbreviation

sy o e

Access

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

Properties

Gecko OS Kernel Plugin

Get example

> get sy o e
0x1F

Set example

> set sy o e 0x11
Set OK

system.oob.gpio

Abbreviation

sy o g

Access

get/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
HTTP data ready (see http_get, http_post commands)0x400

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

Gecko OS Kernel Plugin

Get example

> get sy o g
22

Set example

> set system.oob.gpio 22
Set OK

system.oob.gpio_level

Abbreviation

sy o l

Access

get/set

Description

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

Arguments

<0/1>

Default

1

Properties

Gecko OS Kernel Plugin

Get example

> get sy o l
1

Set example

> set sy o l 0
Set OK

system.oob.rising_edge_mask

Abbreviation

sy o r

Access

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

Properties

Gecko OS Kernel Plugin

Get example

> get sy o r
0x1F

Set example

> set sy o r 0x11
Set OK

system.oob.status

Abbreviation

sy o s

Access

get

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

Gecko OS Kernel Plugin

Get example

get sy o e
0x0

system.powersave.mode

Abbreviation

sy p m

Access

get/set

Description

Set the system powersave mode. Current modes are either off (0) or on (1). Additional powersave modes will be added in an upcoming release.

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

Arguments

0/1 where:

Default

1

Properties

Gecko OS Kernel Plugin

Get example

> get sy p m
R000003
1

Set example

> set sy p m 0
R000008
Set OK

system.print_level

Abbreviation

sy p

Access

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

Gecko OS Kernel Plugin

Get example

> get sy p
R000005
all

Set example

> set sy p 0
R000008
Set OK

system.safemode.console_timeout

Abbreviation

sy s c

Access

get/set

The amount of time in seconds for the Gecko OS terminal command console to be active while in safemode. After this timeout the device either:

If a command is issued before the console timeout:

See also:

Note: This variable is immune to factory reset.

Arguments

<seconds>

Range: 3 - 1440

Default

300

Get example

> get sy s c
R000005
120

Set example

> set sy s c 200
R000009
Success

system.safemode.disabled

Abbreviation

sy s d

Access

get/set

Description

Disables safe mode feature when set to true. When safe mode is disabled and 8 or more faults occur, Gecko OS 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

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

where

Default

0

Properties

Gecko OS Kernel Plugin

Get example

> get sy s d
R000003
0

Set example

> set sy s d 1
R000009
Success

system.safemode.ota_auto_retry

Abbreviation

sy s o

Access

get/set

Description

If enabled, the Kernel remains in DFU mode on OTA failure. The Kernel periodically re-attempts to OTA based on the system.safemode.console_timeout and system.safemode.sleep_timeout configuration. The Kernel remains in DFU mode mode until the OTA successfully completes or the dfu --exit command is issued.

Notes

This variable is used only for 'pull' DFU (i.e. direct OTA DFU with DMS).

If an invalid DFU package is received from the DMS, this variable is ignored and DFU exits.

See also:

Arguments

0|False|Off/1|True|On

Default

1

Properties

Gecko OS Kernel Plugin

Get example

> get sy s o
R000003
1

Set example

> set sy s o 0
R000009
Success

system.safemode.sleep_timeout

Abbreviation

sy s t

Access

get/set

Description

The amount of time in seconds the devices sleeps before rebooting.

Note: Setting this value to 0 effectively disables this feature.

Note: This variable is immune to factory reset.

See also:

Arguments

0|False|Off/1|True|On

Default

0

Range: 0 - 1440

Properties

Gecko OS Kernel Plugin

Get example

> get sy s t
R000003
0

Set example

> set sy s t 1000
R000009
Success

system.safemode.status

Abbreviation

sy s s

Access

get

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

Gecko OS Kernel Plugin

Get example

> get sy s
R000003
0

system.security_key

Abbreviation

sy k

Access

set

Description

The system.security_key variable specifies an AES-128 encryption key. This is sometimes referred to as the user key, because the user can set the value of this key. This is distinct from the device key, a hidden key supplied with the Gecko OS device that the user cannot see or set.

The key is stored in a special section of the NVM.

The variable value cannot be read with the get command.

The following commands use this key for encrypting the file saved on flash and set the User Encrypted file flag:

When Gecko OS reads a file with the Encrypted flag set, for internal use (within the device MCU only), it automatically decrypts the file with the system.security_key.

For example, this may take place when Gecko OS:

To decrypt a file with the Encrypted flag set, use one of the following commands, supplying a <security key> argument matching the system.security_key:

To clear system.security_key, set value to none.

Arguments

<32 hex char string>

where:

Default

Properties

Gecko OS Kernel Plugin

Set example

> set sy k 57678F0C...
Set OK

system.uuid

Abbreviation

sy u

Access

get

Description

Returns the hardware UUID of the module.

Arguments

Default

Properties

Gecko OS Kernel Plugin

Get example

> get sy u
R000042
05B3203FA03133434E39423330363031B2303533

system.variable_lock

Abbreviation

sy l

Access

get/set

Description

Some variables can be locked to prevent their value being changed by factory reset. With system.variable_lock you supply a bitmask indicating which variables to lock. If the corresponding bit is SET, then the variable is locked and its value will persist through factory reset. If the corresponding bit is CLEARED then the variable is not locked.

Notes:

Arguments

<mask> where <mask>has the following bitmask meaning:

Default

0x00

Properties

Gecko OS Kernel Plugin

Get example

> get sy l
0x00

Set example

> set sy l 0x10
Variable lock set
Set OK

system.version

Abbreviation

sy v

Access

get

Description

Returns the Gecko OS firmware bundle version.

Arguments

-

Default

<varies>

Properties

Gecko OS Kernel Plugin

Get example

> get sy v
R000069
SILABS-WGM160P-4.0.0, Gecko_OS-STANDARD-4.0.12-1198, WGM160P