Gecko OS 4 Variables

• Shortcuts
• Documentation Format
• List of Variables
• Variable Properties

This page provides a list of Gecko OS variables with a full description of the function of each variable together with example usage.

Variables are cached in volatile RAM and must be saved to non-volatile flash memory to persist between reboots. To save variables to flash, use the save command. Some variables impact the operation of the entire system, wake and sleep timers for example. A save and reboot is required before new settings for these types of variables take effect.

Variable settings can be loaded using the load command.

Multiple variable configurations can be maintained in separate files. See Configuration and Setup, Variable Configuration .

The get and set Command API functions are used to read and write Gecko OS variables respectively.

When developing apps using the Gecko OS SDK , variables are referred to as settings and the settings Native API is used to read and write variables.

Shortcuts

A shortcut is assigned to each variable. The format for shortcuts is shown in the following table. The shortcut is a hybrid of the first two characters of the first word of the variable name, plus (typically) the first character of the second word (if a second word exists), plus (typically) the first character of the third word of the variable name (if a third word exists). Each of these characters is separated by a space character. In some instances, it was not possible to use the first letter of the second or third word in the variable name, in these cases another letter has been somewhat arbitrarily chosen.

Documentation Format

Many Gecko OS responses shown in the examples on this page were captured with system.print_level = 0, and system.cmd.header_enabled = 1. These machine friendly settings make it easy for a host MCU to parse responses by examining response headers . Documentation for each variable is provided in the format shown below.

variable

Abbreviation

var

Access

get/set

Description

A description of the function of the variable.

Arguments

A full list of mandatory and optional arguments.

Default

The factory reset default value.

Get example

An example of how to read the variable, including response codes.

Set example

An example of how to write the variable, including response codes (for writeable variables).

NOTE! Don't forget to check out command navigation tips to make it easier to find and type specific variable names.

List of Variables

• All Variables
  • all
• App
  • app.debug.auto_run
  • app.debug.ignore_settings
  • app.info
• Broadcast
  • broadcast.data
  • broadcast.http.host
  • broadcast.interface
  • broadcast.interval
  • broadcast.udp.ip
  • broadcast.udp.local_port
  • broadcast.udp.remote_port
• Bus
  • bus.command.read_timeout
  • bus.command.rx_bufsize
  • bus.command.write_check_enabled
  • bus.command.write_timeout
  • bus.data_bus
  • bus.log_bus
  • bus.mode
  • bus.stream.cmd_gpio
  • bus.stream.cmd_seq
  • bus.stream.flush_count
  • bus.stream.flush_time
  • bus.stream.flush_time_reset
• DFU
  • dfu.logs_enabled
  • dfu.status
• DMS
  • dms.auto_start_enabled
  • dms.bundle_id
  • dms.cmd.enabled
  • dms.connection.host
  • dms.connection.port
  • dms.connection.timeout
  • dms.interface
  • dms.product_id
  • dms.telemetry.adc_mask
  • dms.telemetry.data_mask
  • dms.telemetry.gpio_mask
  • dms.telemetry.interval
• Email
  • email.name_address
  • email.smtp.host
  • email.smtp.password
  • email.smtp.port
  • email.smtp.username
• Ethernet
  • ethernet.auto_start.enabled
  • ethernet.auto_start.retry_delay
  • ethernet.dhcp.cache_enabled
  • ethernet.dhcp.enabled
  • ethernet.dhcp.hostname
  • ethernet.dhcp.timeout
  • ethernet.link_detected_timeout
  • ethernet.link_local.enabled
  • ethernet.link_local.timeout
  • ethernet.mac
  • ethernet.multicast.address
  • ethernet.network.dns
  • ethernet.network.gateway
  • ethernet.network.ip
  • ethernet.network.netmask
  • ethernet.network.status
  • ethernet.network.status_gpio
  • ethernet.static.dns
  • ethernet.static.gateway
  • ethernet.static.ip
  • ethernet.static.netmask
• GPIO
  • gpio.alias
  • gpio.init
  • gpio.sleep
  • gpio.usage
• HTTP Client
  • http.client.retries
  • http.client.retry_period
• HTTP Server
  • http.server.api_enabled
  • http.server.auth_title
  • http.server.cors_origin
  • http.server.denied_filename
  • http.server.enabled
  • http.server.interface
  • http.server.keep_alive_enabled
  • http.server.keep_alive_timeout
  • http.server.max_clients
  • http.server.notfound_filename
  • http.server.password
  • http.server.port
  • http.server.root_filename
  • http.server.tls_cert
  • http.server.tls_client_log
  • http.server.tls_enabled
  • http.server.tls_key
  • http.server.tls_log_clients
  • http.server.tls_verify_peer
  • http.server.username
  • http.server.ws_connected_gpio
  • http.server.ws_data_gpio
• IO Connection
  • ioconn.control_gpio
  • ioconn.enabled
  • ioconn.local_port
  • ioconn.protocol
  • ioconn.remote_host
  • ioconn.remote_port
  • ioconn.status_gpio
• mDNS
  • mdns.enabled
  • mdns.interface
  • mdns.name
  • mdns.service
  • mdns.ttl
• Network
  • network.arp.lock_enabled
  • network.arp.table_size
  • network.buffer.control_size
  • network.buffer.rxtx_ratio
  • network.buffer.size
  • network.buffer.usage
  • network.default_interface
  • network.dns.timeout
  • network.tcp.delivery_type
  • network.tls.ca_cert
  • network.tls.ca_cert_verify_enabled
  • network.tls.client_cert
  • network.tls.client_key
  • network.tls.handshake_timeout
  • network.tls.version
• NTP
  • ntp.enabled
  • ntp.interface
  • ntp.interval
  • ntp.server
• Remote Terminal
  • remote_terminal.enabled
  • remote_terminal.interface
  • remote_terminal.password
  • remote_terminal.port
  • remote_terminal.timeout
• Setup
  • setup.auto.cmd
  • setup.gpio.cmd
  • setup.gpio.control_gpio
  • setup.gpio.level
  • setup.gpio.mode
  • setup.web.captive_portal_enabled
  • setup.web.client_list
  • setup.web.idle_timeout
  • setup.web.passkey
  • setup.web.root_filename
  • setup.web.ssid
  • setup.web.url
• SoftAP Interface
  • softap.auto_start
  • softap.captive_portal_enabled
  • softap.channel
  • softap.client_list
  • softap.dhcp_server.enabled
  • softap.dhcp_server.lease_time
  • softap.dns_server.enabled
  • softap.dns_server.url
  • softap.hide_ssid
  • softap.idle_timeout
  • softap.info
  • softap.mac
  • softap.max_clients
  • softap.passkey
  • softap.rssi_average
  • softap.ssid
  • softap.static.gateway
  • softap.static.ip
  • softap.static.netmask
• SPI Master
  • spi.master.active_gpio
  • spi.master.active_level
• Stream
  • stream.auto_close
• System
  • system.activity.gpio
  • system.activity.gpio_level
  • system.adc.vref
  • system.bflash.cs_gpio
  • system.bflash.port
  • system.bootloader.fsb_version
  • system.bootloader.ssb_version
  • system.build_number
  • system.cmd.aux_bus
  • system.cmd.buffered
  • system.cmd.echo
  • system.cmd.format
  • system.cmd.gpio
  • system.cmd.header_enabled
  • system.cmd.prompt_enabled
  • system.cmd.timestamp
  • system.factory_reset.gpio
  • system.factory_reset.level
  • system.hfxo.enabled
  • system.hfxo.status
  • system.indicator.gpio
  • system.indicator.state
  • system.interface.ethernet_enabled
  • system.interface.wifi_enabled
  • system.memory.usage
  • system.msg
  • system.oob.event_mask
  • system.oob.gpio
  • system.oob.gpio_level
  • system.oob.rising_edge_mask
  • system.oob.status
  • system.powersave.mode
  • system.print_level
  • system.safemode.console_timeout
  • system.safemode.disabled
  • system.safemode.ota_auto_retry
  • system.safemode.sleep_timeout
  • system.safemode.status
  • system.security_key
  • system.uuid
  • system.variable_lock
  • system.version
• TCP Client
  • tcp.client.auto_interface
  • tcp.client.auto_retries
  • tcp.client.auto_start
  • tcp.client.connect_timeout
  • tcp.client.local_port
  • tcp.client.remote_host
  • tcp.client.remote_port
  • tcp.client.retries
  • tcp.client.retry_period
  • tcp.client.tls_enabled
• TCP Keepalive
  • tcp.keepalive.enabled
  • tcp.keepalive.initial_timeout
  • tcp.keepalive.retry_count
  • tcp.keepalive.retry_timeout
• TCP Server
  • tcp.server.auto_interface
  • tcp.server.auto_start
  • tcp.server.connected_gpio
  • tcp.server.data_gpio
  • tcp.server.idle_timeout
  • tcp.server.max_clients
  • tcp.server.port
  • tcp.server.tls_cert
  • tcp.server.tls_enabled
  • tcp.server.tls_key
  • tcp.server.tls_verify_peer
• Time
  • time.last_set
  • time.rtc
  • time.uptime
  • time.zone
• UART
  • uart.baud
  • uart.data
  • uart.flow
  • uart.parity
  • uart.stop
• UDP Client
  • udp.client.auto_interface
  • udp.client.auto_retry
  • udp.client.auto_start
  • udp.client.local_port
  • udp.client.remote_host
  • udp.client.remote_port
• UDP Server
  • udp.server.auto_interface
  • udp.server.auto_start
  • udp.server.data_gpio
  • udp.server.lock_client
  • udp.server.port
  • udp.server.remote_host
  • udp.server.remote_port
• WLAN Interface
  • wlan.antenna.select
  • wlan.auto_join.enabled
  • wlan.auto_join.retries
  • wlan.auto_join.retry_delay
  • wlan.bssid
  • wlan.dhcp.cache_enabled
  • wlan.dhcp.enabled
  • wlan.dhcp.hostname
  • wlan.dhcp.timeout
  • wlan.hide_passkey
  • wlan.info
  • wlan.join.result
  • wlan.join.retries
  • wlan.join.timeout
  • wlan.link_local.enabled
  • wlan.link_local.timeout
  • wlan.mac
  • wlan.multicast.address
  • wlan.network.dns
  • wlan.network.gateway
  • wlan.network.ip
  • wlan.network.netmask
  • wlan.network.status
  • wlan.network.status_gpio
  • wlan.passkey
  • wlan.powersave.listen_interval
  • wlan.powersave.mode
  • wlan.rate.protocol
  • wlan.rate.transmit
  • wlan.roam.threshold
  • wlan.rssi_average
  • wlan.scan.active_dwell
  • wlan.scan.channel_mask
  • wlan.scan.home_dwell
  • wlan.scan.num_probes
  • wlan.scan.passive_dwell
  • wlan.scan.retries
  • wlan.scan.type
  • wlan.security
  • wlan.ssid
  • wlan.static.dns
  • wlan.static.gateway
  • wlan.static.ip
  • wlan.static.netmask
  • wlan.tx_power

Variable Properties

The table below indicates properties of variables:

• When a change in variable value takes effect:
  • Immediate - a change in the variable value takes effect immediately
  • uart_update - run the uart_update command to apply a change in the variable value
  • Network Restart - restart the network to apply a change in the variable value
  • Setup Restart - restart the web setup to apply a change in the variable value
  • Save/Reboot - a save and reboot is required to apply a change in the variable value
• Safe Mode - variable is available in safe mode
• NVM Backup - variable value is backed up. See Configuration and Setup, Variable Configuration
• Lockable - See system.variable.lock
• Fac Persist - variable persists through factory reset