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.
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 Name | Shortcut | |
---|---|---|
Template | first_word.second_word.third_word | fi s t |
Example 1 | time.uptime | ti u |
Example 2 | wlan.scan.retries | wl 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
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.
Properties
Special properties of the variable, such as special procedures to apply changes, and whether available in Safe Mode.
Platforms
List of platforms supported in this OS version, with the first OS version on which supported.
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
- Broadcast
- Bus
- DMS
- GPIO
- HTTP Server
- http.server.api_enabled
- http.server.cors_origin
- http.server.denied_filename
- http.server.enabled
- http.server.interface
- 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
- mDNS
- Network
- NTP
- Remote Terminal
- Setup
- SoftAP Interface
- SPI Settings
- Stream
- System
- system.activity.gpio
- system.activity.gpio_level
- system.adc.vref
- system.bflash.cs_gpio
- system.boot.image
- system.build_number
- system.cmd.buffered
- system.cmd.echo
- system.cmd.header_enabled
- system.cmd.mode
- system.cmd.prompt_enabled
- system.cmd.timestamp
- system.gotosleep.timeout
- system.indicator.gpio
- system.indicator.state
- 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.disabled
- system.safemode.status
- system.uuid
- system.version
- system.wakeup.events
- system.wakeup.timeout
- TCP Client
- TCP Keepalive
- TCP Server
- Time
- UART
- UDP Client
- UDP Server
- WLAN Interface
- wlan.antenna.select
- wlan.auto_join.enabled
- wlan.auto_join.retries
- wlan.auto_join.retry_delay
- wlan.bssid
- wlan.dhcp.enabled
- wlan.dhcp.hostname
- wlan.dhcp.timeout
- wlan.hide_passkey
- wlan.info
- wlan.join.result
- wlan.join.retries
- wlan.join.timeout
- wlan.mac
- 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.powersave.sleep_delay
- wlan.rate.protocol
- wlan.rate.transmit
- wlan.region
- 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:
Save/Reboot
- a save and reboot is required to apply a change in the variable valueuart_update
- run the uart_update command to apply a change in the variable valueNetwork Restart
- restart the network to apply a change in the variable valueSetup Restart
- restart the web setup to apply a change in the variable valueSafe Mode
- variable is available in safe mode
Variable | Immediate | uart_update | Network Restart | Setup Restart | Save and Reboot | Safe Mode | NVM Backup | Lockable |
---|---|---|---|---|---|---|---|---|
broadcast.data | Immediate | |||||||
broadcast.http.host | Immediate | |||||||
broadcast.interface | Save and Reboot | |||||||
broadcast.interval | Save and Reboot | |||||||
broadcast.udp.ip | Immediate | |||||||
broadcast.udp.port | Immediate | |||||||
bus.command.read_timeout | Immediate | |||||||
bus.command.rx_bufsize | Save and Reboot | |||||||
bus.command.write_timeout | Immediate | |||||||
bus.data_bus | Save and Reboot | Safe Mode | NVM Backup | Lockable | ||||
bus.log_bus | Save and Reboot | Safe Mode | NVM Backup | Lockable | ||||
bus.mode | Save and Reboot | Safe Mode | NVM Backup | Lockable | ||||
bus.stream.cmd_gpio | Save and Reboot | |||||||
bus.stream.cmd_seq | Save and Reboot | |||||||
bus.stream.flush_count | Save and Reboot | |||||||
bus.stream.flush_time | Save and Reboot | |||||||
bus.stream.flush_time_reset | Save and Reboot | |||||||
email.name_address | Immediate | |||||||
email.smtp.host | Immediate | |||||||
email.smtp.password | Immediate | |||||||
email.smtp.port | Immediate | |||||||
email.smtp.username | Immediate | |||||||
gpio.alias | Immediate | |||||||
gpio.config_file | Save and Reboot | |||||||
gpio.init | Save and Reboot | |||||||
gpio.sleep | Save and Reboot | |||||||
http.server.api_enabled | Network Restart | |||||||
http.server.cors_origin | Network Restart | |||||||
http.server.denied_filename | Network Restart | |||||||
http.server.enabled | Network Restart | |||||||
http.server.interface | Network Restart | |||||||
http.server.max_clients | Network Restart | |||||||
http.server.notfound_filename | Network Restart | |||||||
http.server.password | Network Restart | |||||||
http.server.port | Network Restart | |||||||
http.server.root_filename | Network Restart | |||||||
http.server.tls_cert | Network Restart | |||||||
http.server.tls_enabled | Network Restart | |||||||
http.server.tls_key | Network Restart | |||||||
http.server.tls_log_clients | Network Restart | |||||||
http.server.tls_verify_peer | Network Restart | |||||||
http.server.username | Network Restart | |||||||
http.server.ws_connected_gpio | Network Restart | |||||||
http.server.ws_data_gpio | Network Restart | |||||||
ioconn.control_gpio | Save and Reboot | |||||||
ioconn.enabled | Save and Reboot | |||||||
ioconn.local_port | Immediate | |||||||
ioconn.protocol | Immediate | |||||||
ioconn.remote_host | Immediate | |||||||
ioconn.remote_port | Immediate | |||||||
ioconn.status_gpio | Save and Reboot | |||||||
mdns.enabled | Network Restart | |||||||
mdns.interface | Network Restart | |||||||
mdns.name | Network Restart | |||||||
mdns.service | Network Restart | |||||||
mdns.ttl | Network Restart | |||||||
network.buffer.rxtx_ratio | Save and Reboot | |||||||
network.buffer.size | Save and Reboot | |||||||
network.default_interface | Immediate | |||||||
network.tls.ca_cert | Immediate | Safe Mode | ||||||
network.tls.client_cert | Immediate | |||||||
network.tls.client_key | Immediate | |||||||
network.tls.version | Immediate | |||||||
ntp.enabled | Save and Reboot | |||||||
ntp.interface | Save and Reboot | |||||||
ntp.interval | Save and Reboot | |||||||
ntp.server | Save and Reboot | |||||||
remote_terminal.enabled | Network Restart | |||||||
remote_terminal.interface | Network Restart | |||||||
remote_terminal.password | Immediate | |||||||
remote_terminal.port | Network Restart | |||||||
remote_terminal.timeout | Immediate | |||||||
setup.auto.cmd | Save and Reboot | |||||||
setup.gpio.cmd | Immediate | |||||||
setup.gpio.control_gpio | Save and Reboot | |||||||
setup.gpio.level | Save and Reboot | |||||||
setup.gpio.mode | Save and Reboot | |||||||
setup.web.idle_timeout | Setup Restart | |||||||
setup.web.passkey | Setup Restart | |||||||
setup.web.root_filename | Setup Restart | |||||||
setup.web.ssid | Setup Restart | |||||||
setup.web.url | Setup Restart | |||||||
softap.auto_start | Network Restart | |||||||
softap.channel | Network Restart | |||||||
softap.dhcp_server.enabled | Network Restart | |||||||
softap.dns_server.enabled | Network Restart | |||||||
softap.dns_server.url | Network Restart | |||||||
softap.hide_ssid | Network Restart | |||||||
softap.idle_timeout | Network Restart | |||||||
softap.passkey | Network Restart | |||||||
softap.rate.protocol | Network Restart | |||||||
softap.rate.transmit | Network Restart | |||||||
softap.ssid | Network Restart | |||||||
softap.static.gateway | Network Restart | |||||||
softap.static.ip | Network Restart | |||||||
softap.static.netmask | Network Restart | |||||||
spi.master.active_gpio | Save and Reboot | Safe Mode | ||||||
spi.master.active_level | Save and Reboot | Safe Mode | ||||||
stream.auto_close | Immediate | |||||||
system.activity.gpio | Save and Reboot | |||||||
system.activity.gpio_level | Save and Reboot | |||||||
system.adc.vref | Immediate | |||||||
system.bflash.cs_gpio | Save and Reboot | |||||||
system.boot.image | Save and Reboot | Safe Mode | ||||||
system.cmd.buffered | Immediate | Safe Mode | NVM Backup | |||||
system.cmd.echo | Immediate | Safe Mode | NVM Backup | |||||
system.cmd.header_enabled | Immediate | Safe Mode | NVM Backup | |||||
system.cmd.mode | Immediate | Safe Mode | ||||||
system.cmd.prompt_enabled | Immediate | Safe Mode | NVM Backup | |||||
system.cmd.timestamp | Immediate | Safe Mode | NVM Backup | |||||
system.gotosleep.timeout | Save and Reboot | |||||||
system.indicator.gpio | Save and Reboot | |||||||
system.indicator.state | Save and Reboot | |||||||
system.msg | Immediate | |||||||
system.oob.event_mask | Immediate | |||||||
system.oob.gpio | Save and Reboot | |||||||
system.oob.gpio_level | Immediate | |||||||
system.oob.rising_edge_mask | Immediate | |||||||
system.powersave.mode | Save and Reboot | |||||||
system.print_level | Immediate | Safe Mode | NVM Backup | |||||
system.safemode.disabled | Save and Reboot | Safe Mode | ||||||
system.safemode.status | Safe Mode | |||||||
system.uuid | Safe Mode | |||||||
system.version | Safe Mode | |||||||
system.wakeup.events | Immediate | |||||||
system.wakeup.timeout | Immediate | |||||||
tcp.client.auto_interface | Save and Reboot | |||||||
tcp.client.auto_retries | Save and Reboot | |||||||
tcp.client.auto_start | Save and Reboot | |||||||
tcp.client.connect_timeout | Immediate | Safe Mode | NVM Backup | |||||
tcp.client.local_port | Immediate | Safe Mode | NVM Backup | |||||
tcp.client.remote_host | Immediate | |||||||
tcp.client.remote_port | Immediate | |||||||
tcp.client.retries | Immediate | Safe Mode | NVM Backup | |||||
tcp.client.retry_period | Immediate | Safe Mode | NVM Backup | |||||
tcp.keepalive.enabled | Immediate | NVM Backup | ||||||
tcp.keepalive.initial_timeout | Immediate | NVM Backup | ||||||
tcp.keepalive.retry_count | Immediate | NVM Backup | ||||||
tcp.keepalive.retry_timeout | Immediate | NVM Backup | ||||||
tcp.server.auto_interface | Network Restart | |||||||
tcp.server.auto_start | Network Restart | |||||||
tcp.server.connected_gpio | Network Restart | |||||||
tcp.server.data_gpio | Network Restart | |||||||
tcp.server.idle_timeout | Network Restart | |||||||
tcp.server.max_clients | Network Restart | |||||||
tcp.server.port | Network Restart | |||||||
tcp.server.tls_cert | Network Restart | |||||||
tcp.server.tls_enabled | Network Restart | |||||||
tcp.server.tls_key | Network Restart | |||||||
tcp.server.tls_verify_peer | Network Restart | |||||||
time.rtc | Immediate | |||||||
time.zone | Immediate | |||||||
uart.baud | uart_update | Save and Reboot | Safe Mode | NVM Backup | Lockable | |||
uart.data | uart_update | Save and Reboot | Safe Mode | NVM Backup | Lockable | |||
uart.flow | uart_update | Save and Reboot | Safe Mode | NVM Backup | Lockable | |||
uart.parity | uart_update | Save and Reboot | Safe Mode | NVM Backup | Lockable | |||
uart.stop | uart_update | Save and Reboot | Safe Mode | NVM Backup | Lockable | |||
udp.client.auto_interface | Network Restart | |||||||
udp.client.auto_start | Network Restart | |||||||
udp.client.remote_host | Immediate | |||||||
udp.client.remote_port | Immediate | |||||||
udp.server.auto_interface | Network Restart | |||||||
udp.server.auto_start | Network Restart | |||||||
udp.server.data_gpio | Network Restart | |||||||
udp.server.lock_client | Network Restart | |||||||
udp.server.port | Network Restart | |||||||
udp.server.remote_host | Network Restart | |||||||
udp.server.remote_port | Network Restart | |||||||
wlan.antenna.select | Immediate | Safe Mode | NVM Backup | |||||
wlan.auto_join.enabled | Network Restart | |||||||
wlan.auto_join.retries | Save and Reboot | |||||||
wlan.auto_join.retry_delay | Save and Reboot | |||||||
wlan.bssid | Network Restart | |||||||
wlan.dhcp.enabled | Network Restart | Safe Mode | NVM Backup | |||||
wlan.dhcp.hostname | Network Restart | |||||||
wlan.dhcp.timeout | Network Restart | Safe Mode | NVM Backup | |||||
wlan.hide_passkey | Immediate | Safe Mode | NVM Backup | |||||
wlan.join.retries | Network Restart | Safe Mode | NVM Backup | |||||
wlan.join.timeout | Save and Reboot | Safe Mode | NVM Backup | |||||
wlan.mac | Safe Mode | |||||||
wlan.network.dns | Safe Mode | |||||||
wlan.network.gateway | Safe Mode | |||||||
wlan.network.ip | Safe Mode | |||||||
wlan.network.netmask | Safe Mode | |||||||
wlan.network.status | Safe Mode | |||||||
wlan.network.status_gpio | Save and Reboot | |||||||
wlan.passkey | Network Restart | Safe Mode | NVM Backup | |||||
wlan.powersave.listen_interval | Save and Reboot | |||||||
wlan.powersave.mode | Save and Reboot | |||||||
wlan.powersave.sleep_delay | Save and Reboot | |||||||
wlan.rate.protocol | Network Restart | Safe Mode | NVM Backup | |||||
wlan.rate.transmit | Network Restart | Safe Mode | NVM Backup | |||||
wlan.region | Network Restart | |||||||
wlan.roam.threshold | Network Restart | Safe Mode | NVM Backup | |||||
wlan.rssi_average | Save and Reboot | |||||||
wlan.scan.active_dwell | Network Restart | Safe Mode | NVM Backup | |||||
wlan.scan.channel_mask | Network Restart | Safe Mode | NVM Backup | |||||
wlan.scan.home_dwell | Network Restart | Safe Mode | NVM Backup | |||||
wlan.scan.num_probes | Network Restart | Safe Mode | NVM Backup | |||||
wlan.scan.passive_dwell | Network Restart | Safe Mode | NVM Backup | |||||
wlan.scan.retries | Network Restart | Safe Mode | NVM Backup | |||||
wlan.scan.type | Network Restart | Safe Mode | NVM Backup | |||||
wlan.security | Network Restart | Safe Mode | NVM Backup | |||||
wlan.ssid | Network Restart | Safe Mode | NVM Backup | |||||
wlan.static.dns | Network Restart | Safe Mode | NVM Backup | |||||
wlan.static.gateway | Network Restart | Safe Mode | NVM Backup | |||||
wlan.static.ip | Network Restart | Safe Mode | NVM Backup | |||||
wlan.static.netmask | Network Restart | Safe Mode | NVM Backup | |||||
wlan.tx_power | Immediate | Safe Mode | NVM Backup |