System
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
Supported Platforms
- AMW007
- AMW037
Get example
> get sy n
R000009
16eee81
system.cmd.echo
Abbreviation
sy c e
Access
get/set
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.format
Abbreviation
sy c f
Access
set
Description
Puts the Gecko OS command interface into human or machine format. For further details, see Serial Interface, Command Format Configuration .
Note : This variable is NOT readable.
Arguments
<human | machine>
Default
human
Properties
- available in Safe Mode
Set example
> set sy c f human
R000008
Set OK
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
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.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
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
Abbreviation
sy s t
Access
get/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
- AMW007
- AMW037
Get example
> get sy s t
R000003
0
Set example
> set sy s t 12
R000008
Set OK
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
<wlan/network/softap> <GPIO#>
Default
<varies>
Properties
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
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 unassigned on eval boards
State # | State Description | Default Behavior |
---|---|---|
state 1 | Wi-Fi off | static_off |
state 2 | Error | fast_blink |
state 3 | Connecting to AP | medium_blink |
state 4 | Joined to AP | slow_blink |
Network Indicator
Network status, by default GREEN LED on eval boards
State # | State Description | Default Behavior |
---|---|---|
state 1 | No IP address | fast_blink |
state 2 | DHCP in-progress | medium_blink |
state 3 | DHCP successful | slow_blink |
SoftAP Indicator
SoftAP status, by default RED LED on eval boards
State # | State Description | Default Behavior |
---|---|---|
state 1 | SoftAP off | static_off |
state 2 | SoftAP error | fast_blink |
state 3 | SoftAP active | medium_blink |
state 4 | Client connected | slow_blink |
Arguments
<wlan/network/softap> <csv list>
Default
See above:
Properties
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
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
-
Supported Platforms
- AMW007
- AMW037
Get example
> get sy e u
58
system.oob.event_mask
Abbreviation
sy o e
Access
get/set
Description
The mask of events which assert the 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
Supported Platforms
- AMW007
- AMW037
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.
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 Name | Mask Value |
---|---|
ioconn.status_gpio | 0x001 |
tcp.server.connected_gpio | 0x004 |
tcp.server.data_gpio | 0x008 |
HTTP data ready (see http_get , http_post commands) | 0x400 |
Arguments
<GPIO #>
The number of the OOB GPIO.
Default
No GPIO assigned to OOB
Properties
Supported Platforms
- AMW007
- AMW037
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
Supported Platforms
- AMW007
- AMW037
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
Supported Platforms
- AMW007
- AMW037
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
Supported Platforms
- AMW007
- AMW037
Get example
get sy o e
0x0
system.print_level
Abbreviation
sy p
Access
get/set
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
Abbreviation
sy 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
- available in Safe Mode
Supported Platforms
- AMW007
- AMW037
Get example
> get sy s
R000003
0
system.safemode.disabled
Abbreviation
sy 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
<true/1/0/false>
Default
0
Properties
Supported Platforms
- AMW007
- AMW037
Get example
> get sy d
R000003
0
Set example
> set sy d 1
R000009
Success
system.uuid
Abbreviation
sy u
Access
get
Description
Returns the hardware UUID of the module.
Arguments
Default
Properties
- available in Safe Mode
Supported Platforms
- AMW007
- AMW037
Get example
> get sy u
R000042
05B3203FA03133434E39423330363031B2303533
system.version
Abbreviation
sy v
Access
get
Description
Returns the Gecko OS firmware bundle version.
Arguments
-
Default
<varies>
Properties
- available in Safe Mode
Supported Platforms
- AMW007
- AMW037
Get example
> get sy v
R000052
SILABS-AMW007-2.1.5, Gecko OS-2.1.5, AMW007-W00001
system.wakeup.timeout
Abbreviation
sy w t
Access
get/set
Description
The module automatically wakes from sleep after timeout
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