ZentriOS Variables

This page provides a list of ZentriOS 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 ZentriOS variables respectively.

When developing apps using the ZentriOS 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.

Variable NameShortcut
Templatefirst_word.second_word.third_wordfi s t
Example 1time.uptimeti u
Example 2wlan.scan.retrieswl s r

Documentation Format

Many ZentriOS 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

Abbreviationvar
Accessget/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

Variable Properties

The table below indicates properties of variables:

VariableImmediateuart_updateNetwork RestartSetup RestartSave and RebootSafe ModeNVM BackupLockable
broadcast.dataImmediate
broadcast.http.hostImmediate
broadcast.interfaceSave and Reboot
broadcast.intervalSave and Reboot
broadcast.udp.ipImmediate
broadcast.udp.portImmediate
bus.command.read_timeoutImmediate
bus.command.rx_bufsizeSave and Reboot
bus.command.write_check_enabledImmediate
bus.command.write_timeoutImmediate
bus.data_busSave and RebootSafe ModeNVM BackupLockable
bus.log_busSave and RebootSafe ModeNVM BackupLockable
bus.modeSave and RebootSafe ModeNVM BackupLockable
bus.stream.cmd_gpioSave and Reboot
bus.stream.cmd_seqSave and Reboot
bus.stream.flush_countSave and Reboot
bus.stream.flush_timeSave and Reboot
bus.stream.flush_time_resetSave and Reboot
dms.cmd.enabledImmediate
dms.geolocate.intervalImmediate
dms.telemetry.adc_maskImmediate
dms.telemetry.data_maskImmediate
dms.telemetry.gpio_maskImmediate
dms.telemetry.intervalImmediate
dms.tokenImmediate
email.name_addressImmediate
email.smtp.hostImmediate
email.smtp.passwordImmediate
email.smtp.portImmediate
email.smtp.usernameImmediate
gpio.aliasImmediate
gpio.config_fileSave and Reboot
gpio.initSave and Reboot
gpio.sleepSave and Reboot
http.client.retriesImmediate
http.client.retry_periodImmediate
http.server.api_enabledNetwork Restart
http.server.auth_titleImmediate
http.server.cors_originNetwork Restart
http.server.denied_filenameNetwork Restart
http.server.enabledNetwork Restart
http.server.interfaceNetwork Restart
http.server.max_clientsNetwork Restart
http.server.notfound_filenameNetwork Restart
http.server.passwordNetwork Restart
http.server.portNetwork Restart
http.server.root_filenameNetwork Restart
http.server.tls_certNetwork Restart
http.server.tls_enabledNetwork Restart
http.server.tls_keyNetwork Restart
http.server.tls_log_clientsNetwork Restart
http.server.tls_verify_peerNetwork Restart
http.server.usernameNetwork Restart
http.server.ws_connected_gpioNetwork Restart
http.server.ws_data_gpioNetwork Restart
ioconn.control_gpioSave and Reboot
ioconn.enabledSave and Reboot
ioconn.local_portImmediate
ioconn.protocolImmediate
ioconn.remote_hostImmediate
ioconn.remote_portImmediate
ioconn.status_gpioSave and Reboot
mdns.enabledNetwork Restart
mdns.interfaceNetwork Restart
mdns.nameNetwork Restart
mdns.serviceNetwork Restart
mdns.ttlNetwork Restart
network.arp.lock_enabledImmediate
network.arp.table_sizeImmediate
network.buffer.control_sizeImmediate
network.buffer.rxtx_ratioSave and Reboot
network.buffer.sizeSave and Reboot
network.default_interfaceImmediate
network.tcp.delivery_typeImmediate
network.tls.ca_certImmediateSafe Mode
network.tls.client_certImmediate
network.tls.client_keyImmediate
network.tls.versionImmediate
ntp.enabledSave and Reboot
ntp.interfaceSave and Reboot
ntp.intervalSave and Reboot
ntp.serverSave and Reboot
remote_terminal.enabledNetwork Restart
remote_terminal.interfaceNetwork Restart
remote_terminal.passwordImmediate
remote_terminal.portNetwork Restart
remote_terminal.timeoutImmediate
setup.auto.cmdSave and Reboot
setup.gpio.cmdImmediate
setup.gpio.control_gpioSave and Reboot
setup.gpio.levelSave and Reboot
setup.gpio.modeSave and Reboot
setup.web.idle_timeoutSetup Restart
setup.web.passkeySetup Restart
setup.web.root_filenameSetup Restart
setup.web.ssidSetup Restart
setup.web.urlSetup Restart
softap.auto_startNetwork Restart
softap.channelNetwork Restart
softap.dhcp_server.enabledNetwork Restart
softap.dhcp_server.lease_timeImmediate
softap.dns_server.enabledNetwork Restart
softap.dns_server.urlNetwork Restart
softap.hide_ssidNetwork Restart
softap.idle_timeoutNetwork Restart
softap.max_clientsImmediate
softap.passkeyNetwork Restart
softap.rate.protocolNetwork Restart
softap.rate.transmitNetwork Restart
softap.rssi_averageSave and Reboot
softap.ssidNetwork Restart
softap.static.gatewayNetwork Restart
softap.static.ipNetwork Restart
softap.static.netmaskNetwork Restart
spi.master.active_gpioSave and RebootSafe Mode
spi.master.active_levelSave and RebootSafe Mode
stream.auto_closeImmediate
system.activity.gpioSave and Reboot
system.activity.gpio_levelSave and Reboot
system.adc.vrefImmediate
system.bflash.cs_gpioSave and Reboot
system.boot.imageSave and RebootSafe Mode
system.cmd.aux_busImmediate
system.cmd.bufferedImmediateSafe ModeNVM Backup
system.cmd.echoImmediateSafe ModeNVM Backup
system.cmd.gpioSave and Reboot
system.cmd.header_enabledImmediateSafe ModeNVM Backup
system.cmd.modeImmediateSafe Mode
system.cmd.prompt_enabledImmediateSafe ModeNVM Backup
system.cmd.timestampImmediateSafe ModeNVM Backup
system.factory_reset.aux_gpioSave and Reboot
system.factory_reset.aux_levelSave and Reboot
system.gotosleep.timeoutSave and Reboot
system.indicator.gpioSave and Reboot
system.indicator.stateSave and Reboot
system.msgImmediate
system.oob.event_maskImmediate
system.oob.gpioSave and Reboot
system.oob.gpio_levelImmediate
system.oob.rising_edge_maskImmediate
system.powersave.modeSave and Reboot
system.print_levelImmediateSafe ModeNVM Backup
system.safemode.disabledSave and RebootSafe Mode
system.safemode.statusSafe Mode
system.security_keyImmediate
system.uuidSafe Mode
system.variable_lockImmediate
system.versionSafe Mode
system.wakeup.eventsImmediate
system.wakeup.timeoutImmediate
tcp.client.auto_interfaceSave and Reboot
tcp.client.auto_retriesSave and Reboot
tcp.client.auto_startSave and Reboot
tcp.client.connect_timeoutImmediateSafe ModeNVM Backup
tcp.client.local_portImmediateSafe ModeNVM Backup
tcp.client.remote_hostImmediate
tcp.client.remote_portImmediate
tcp.client.retriesImmediateSafe ModeNVM Backup
tcp.client.retry_periodImmediateSafe ModeNVM Backup
tcp.client.tls_enabledImmediate
tcp.keepalive.enabledImmediateNVM Backup
tcp.keepalive.initial_timeoutImmediateNVM Backup
tcp.keepalive.retry_countImmediateNVM Backup
tcp.keepalive.retry_timeoutImmediateNVM Backup
tcp.server.auto_interfaceNetwork Restart
tcp.server.auto_startNetwork Restart
tcp.server.connected_gpioNetwork Restart
tcp.server.data_gpioNetwork Restart
tcp.server.idle_timeoutNetwork Restart
tcp.server.max_clientsNetwork Restart
tcp.server.portNetwork Restart
tcp.server.tls_certNetwork Restart
tcp.server.tls_enabledNetwork Restart
tcp.server.tls_keyNetwork Restart
tcp.server.tls_verify_peerNetwork Restart
time.rtcImmediate
time.zoneImmediate
uart.bauduart_updateSave and RebootSafe ModeNVM BackupLockable
uart.datauart_updateSave and RebootSafe ModeNVM BackupLockable
uart.flowuart_updateSave and RebootSafe ModeNVM BackupLockable
uart.parityuart_updateSave and RebootSafe ModeNVM BackupLockable
uart.stopuart_updateSave and RebootSafe ModeNVM BackupLockable
udp.client.auto_interfaceNetwork Restart
udp.client.auto_retryImmediate
udp.client.auto_startNetwork Restart
udp.client.remote_hostImmediate
udp.client.remote_portImmediate
udp.server.auto_interfaceNetwork Restart
udp.server.auto_startNetwork Restart
udp.server.data_gpioNetwork Restart
udp.server.lock_clientNetwork Restart
udp.server.portNetwork Restart
udp.server.remote_hostNetwork Restart
udp.server.remote_portNetwork Restart
wlan.antenna.selectImmediateSafe ModeNVM Backup
wlan.auto_join.enabledNetwork Restart
wlan.auto_join.retriesSave and Reboot
wlan.auto_join.retry_delaySave and Reboot
wlan.bssidNetwork Restart
wlan.dhcp.cache_enabledImmediate
wlan.dhcp.enabledNetwork RestartSafe ModeNVM Backup
wlan.dhcp.hostnameNetwork Restart
wlan.dhcp.timeoutNetwork RestartSafe ModeNVM Backup
wlan.hide_passkeyImmediateSafe ModeNVM Backup
wlan.join.retriesNetwork RestartSafe ModeNVM Backup
wlan.join.timeoutSave and RebootSafe ModeNVM Backup
wlan.macSafe Mode
wlan.multicast.addressImmediate
wlan.network.dnsSafe Mode
wlan.network.gatewaySafe Mode
wlan.network.ipSafe Mode
wlan.network.netmaskSafe Mode
wlan.network.statusSafe Mode
wlan.network.status_gpioSave and Reboot
wlan.passkeyNetwork RestartSafe ModeNVM Backup
wlan.powersave.listen_intervalSave and Reboot
wlan.powersave.modeSave and Reboot
wlan.powersave.sleep_delaySave and Reboot
wlan.rate.protocolNetwork RestartSafe ModeNVM Backup
wlan.rate.transmitNetwork RestartSafe ModeNVM Backup
wlan.regionNetwork Restart
wlan.roam.thresholdNetwork RestartSafe ModeNVM Backup
wlan.rssi_averageSave and Reboot
wlan.scan.active_dwellNetwork RestartSafe ModeNVM Backup
wlan.scan.channel_maskNetwork RestartSafe ModeNVM Backup
wlan.scan.home_dwellNetwork RestartSafe ModeNVM Backup
wlan.scan.num_probesNetwork RestartSafe ModeNVM Backup
wlan.scan.passive_dwellNetwork RestartSafe ModeNVM Backup
wlan.scan.retriesNetwork RestartSafe ModeNVM Backup
wlan.scan.typeNetwork RestartSafe ModeNVM Backup
wlan.securityNetwork RestartSafe ModeNVM Backup
wlan.ssidNetwork RestartSafe ModeNVM Backup
wlan.static.dnsNetwork RestartSafe ModeNVM Backup
wlan.static.gatewayNetwork RestartSafe ModeNVM Backup
wlan.static.ipNetwork RestartSafe ModeNVM Backup
wlan.static.netmaskNetwork RestartSafe ModeNVM Backup
wlan.tx_powerImmediateSafe ModeNVM Backup
zap.auto_runSave and RebootLockable
zap.debug.auto_runImmediate
zap.debug.enabledImmediate
zap.debug.ignore_settingsImmediate