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.

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

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 Mode
broadcast.dataImmediate
broadcast.http.hostImmediate
broadcast.interfaceSave and Reboot
broadcast.intervalSave and Reboot
broadcast.udp.ipImmediate
broadcast.udp.portImmediate
bus.command.rx_bufsizeSave and Reboot
bus.modeSave and RebootSafe Mode
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
gpio.initSave and Reboot
http.server.api_enabledNetwork Restart
http.server.cors_originNetwork Restart
http.server.enabledNetwork Restart
http.server.interfaceNetwork Restart
http.server.max_clientsNetwork Restart
http.server.notfound_filenameNetwork Restart
http.server.portNetwork Restart
http.server.root_filenameNetwork 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
network.default_interfaceImmediate
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.passwordImmediate
remote_terminal.portNetwork Restart
remote_terminal.timeoutImmediate
setup.gpio.control_gpioSave 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.dns_server.enabledNetwork Restart
softap.dns_server.urlNetwork Restart
softap.hide_ssidNetwork Restart
softap.idle_timeoutNetwork Restart
softap.passkeyNetwork Restart
softap.ssidNetwork Restart
softap.static.gatewayNetwork Restart
softap.static.ipNetwork Restart
softap.static.netmaskNetwork Restart
system.cmd.echoImmediateSafe Mode
system.cmd.header_enabledImmediateSafe Mode
system.cmd.modeImmediateSafe Mode
system.cmd.prompt_enabledImmediateSafe Mode
system.gotosleep.timeoutSave and Reboot
system.indicator.gpioSave and Reboot
system.indicator.stateSave and Reboot
system.oob.event_maskImmediate
system.oob.gpioSave and Reboot
system.oob.gpio_levelImmediate
system.oob.rising_edge_maskImmediate
system.print_levelImmediateSafe Mode
system.safemode.disabledSave and RebootSafe Mode
system.safemode.statusSafe Mode
system.uuidSafe Mode
system.versionSafe Mode
system.wakeup.timeoutImmediate
tcp.client.auto_retriesSave and Reboot
tcp.client.auto_startSave and Reboot
tcp.client.connect_timeoutImmediateSafe Mode
tcp.client.local_portImmediateSafe Mode
tcp.client.remote_hostImmediate
tcp.client.remote_portImmediate
tcp.client.retriesImmediateSafe Mode
tcp.client.retry_periodImmediateSafe Mode
tcp.client.tls_enabledImmediate
tcp.server.auto_startNetwork Restart
tcp.server.connected_gpioNetwork Restart
tcp.server.data_gpioNetwork Restart
tcp.server.idle_timeoutNetwork Restart
tcp.server.portNetwork Restart
time.rtcImmediate
time.zoneImmediate
uart.bauduart_updateSave and RebootSafe Mode
uart.datauart_updateSave and RebootSafe Mode
uart.flowuart_updateSave and RebootSafe Mode
uart.parityuart_updateSave and RebootSafe Mode
uart.stopuart_updateSave and RebootSafe Mode
udp.client.auto_interfaceNetwork Restart
udp.client.auto_startNetwork Restart
udp.client.remote_hostImmediate
udp.client.remote_portImmediate
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.auto_join.enabledNetwork Restart
wlan.auto_join.retriesSave and Reboot
wlan.auto_join.retry_delaySave and Reboot
wlan.dhcp.enabledNetwork RestartSafe Mode
wlan.dhcp.hostnameNetwork Restart
wlan.hide_passkeyImmediateSafe Mode
wlan.join.retriesNetwork RestartSafe Mode
wlan.join.timeoutSave and RebootSafe Mode
wlan.macSafe Mode
wlan.network.dnsSafe Mode
wlan.network.gatewaySafe Mode
wlan.network.ipSafe Mode
wlan.network.netmaskSafe Mode
wlan.network.statusSafe Mode
wlan.passkeyNetwork RestartSafe Mode
wlan.rate.protocolNetwork RestartSafe Mode
wlan.ssidNetwork RestartSafe Mode
wlan.static.dnsNetwork RestartSafe Mode
wlan.static.gatewayNetwork RestartSafe Mode
wlan.static.ipNetwork RestartSafe Mode
wlan.static.netmaskNetwork RestartSafe Mode
wlan.tx_powerImmediateSafe Mode