Web Variables
Web variables 'web vars' are special expressions, that are provided by the template engine and can be used to render a variety of information about the system state with the Templates feature.
How to use this document
The main content (reference of available web vars) is organized into multiple lists by their respective table structure. At the end, there is a list of Simple Web vars, that dont belong to a table structure.
Refer to the table of contents for more information.
After the web variables reference, you will find glossaries of used flags and used data formats/types.
info
A machine readable reference of all available web variables in the form of a .json file (e.g. for use by LLMs) is available here.
Web Variables Reference
Table of Contents
| Table | Description |
|---|---|
webvars | Simple web variables |
changetab | |
filetab | The filetab table contains the installed content files. |
firmwaretab | |
histotab | The histotab table contains the results of the most recently queried history. The table is generated dynamically from the parameters of the query. The calculated dew- point is not saved in the history and is not treated as a sensor. Therefore, sensor 3 in histotab corresponds to sensor 4 in sensortab. |
inputtab | |
logtab | The logtab table contains the 8 most recent syslog notifications. |
netiftab | The netiftab table contains information about the two network interfaces. |
outputtab | |
pushtab | |
sensortab | The sensortab table contains information on up to 4 sensors. |
watchtab |
webvars
| Variable | Description | Flags | Format |
|---|---|---|---|
| abnormal_conditions | PUBLIC, RONLY | ||
| admin_name | |||
| admin_pwd | RONLY | ||
| admin_pwd2 | RONLY | ||
| anon_read | |||
| api_key | RONLY | ||
| ca_cert_status | RONLY | ||
| changes_start | PUBLIC, RONLY | ts | |
| changetab_count | PUBLIC, RONLY | uint32 | |
| changetab_max | PUBLIC, RONLY | uint32 | |
| changetab_min | PUBLIC, RONLY | uint32 | |
| cmnty_read | SNMP Community for read-only access | SNMP_SETTINGS_CHANGED | char[15] |
| cmnty_trap | char[15] | ||
| cmnty_write | SNMP Community for write access | SNMP_SETTINGS_CHANGED | char[15] |
| config_usage | The configuration's current size in percent | RONLY | char[] |
| csrf_token | PUBLIC, PUBLIC, RONLY | ||
| datetime | PUBLIC, RONLY | ||
| datetime_utc | PUBLIC, RONLY | ||
| db_usage | PUBLIC, RONLY | int | |
| db_usage_changes | PUBLIC, RONLY | int | |
| db_usage_history | PUBLIC, RONLY | int | |
| db_usage_syslog | PUBLIC, RONLY | int | |
| db_usage_unknown | PUBLIC, RONLY | int | |
| db_usage_unknown_blocks | PUBLIC, RONLY | int | |
| dev_type | Type of device, "OpenTango" | PUBLIC, RONLY | char[] |
| fs_has_space | RONLY | ||
| fw_dev | RONLY | ||
| fw_manufacturer | Producer of the active firmware | PUBLIC, RONLY | char[] |
| fw_name | Name of the active firmware | PUBLIC, RONLY | char[] |
| fw_version | Version of the active firmware | PUBLIC, RONLY | char[] |
| gmt_offset | Difference between local time and UTC in seconds, including summer time, if active | PUBLIC, RONLY | int32 |
| gmt_offset_dst | PUBLIC, RONLY | ||
| gmt_offset_normal | PUBLIC, RONLY | ||
| has_password | PUBLIC, RONLY | ||
| has_simulated_network_inputs | NEEDS_REBOOT | ||
| has_simulated_sensors | |||
| histo_rate | Logging rate in seconds (only full minutes) | PUBLIC, SENSOR_SETTINGS_CHANGED | uin32 |
| histo_rate_m | Loggin rate in minutes | PUBLIC, SENSOR_SETTINGS_CHANGED | uint32 |
| histo_start | Time stamp of the oldest recorded data | PUBLIC, RONLY | ts |
| histotab_count | PUBLIC, RONLY | ||
| histotab_max | PUBLIC, RONLY | ||
| histotab_min | PUBLIC, RONLY | ||
| hostname | Name of the device | PUBLIC, SNMP_SETTINGS_CHANGED | char[15] |
| http_host | PUBLIC, RONLY | ||
| https_active | PUBLIC, RONLY | uint | |
| https_redirect | PUBLIC, NEEDS_REBOOT | ||
| hw_fail_str | PUBLIC, RONLY | ||
| icons_url | PUBLIC, RONLY | ||
| is_admin | PUBLIC, RONLY | ||
| lang | Index of language settings 0: English 1: German | PUBLIC | int32 |
| led_brn | Dimming level of LED in normal state | uint16 | |
| mailtab_addr | char[63] | ||
| mailtab_ena | |||
| mailtab_tpl | |||
| mb_ena | Modbus activated | MODBUS_CHANGED | check |
| mb_wrprot | Modbus is read-only | MODBUS_CHANGED | check |
| memfree_kb | PUBLIC, RONLY | ||
| memfree_min_kb | PUBLIC, RONLY | ||
| memusage | Current usage of RAM in percent | PUBLIC, RONLY | char[] |
| memusage_max | PUBLIC, RONLY | ||
| menu_content | PUBLIC, RONLY | ||
| mqtt_broker | Host name or IP address of the MQTT broker | MQTT_NEED_RECONNECT | char[63] |
| mqtt_client_id | Client ID, that is sent to the broker | MQTT_NEED_RECONNECT | char[23] |
| mqtt_ena | MQTT activated | MQTT_NEED_RECONNECT | check |
| mqtt_interval | MQTT_NEED_RECONNECT | ||
| mqtt_keep_alive | MQTT_NEED_RECONNECT | uint16 | |
| mqtt_last_will_connect_message | MQTT_NEED_RECONNECT | char[] | |
| mqtt_last_will_message | MQTT_NEED_RECONNECT | char[] | |
| mqtt_last_will_topic | MQTT_NEED_RECONNECT | char[] | |
| mqtt_password | Password for MQTT | MQTT_NEED_RECONNECT | char[31] |
| mqtt_port | Port of the MQTT broker | MQTT_NEED_RECONNECT | uint16 |
| mqtt_retain_inputs | |||
| mqtt_retain_last_will | MQTT_NEED_RECONNECT | ||
| mqtt_retain_outputs | |||
| mqtt_retain_sensors | |||
| mqtt_retain_watchdogs | |||
| mqtt_send_reboot | |||
| mqtt_status | RONLY | ||
| mqtt_tls | MQTT_NEED_RECONNECT | ||
| mqtt_topic_prfx | |||
| mqtt_user | User for MQTT | PUBLIC, MQTT_NEED_RECONNECT | char[31] |
| netif | Active network interface, "ETH", "WLAN" or "WLAN AP" | RONLY | char[] |
| ntp_ena | NTP_CHANGED | ||
| ntpd | NTP server's host name or IP address | NTP_CHANGED | char[31] |
| remotetab_api_key | HTTP_PUSH_CHANGED | ||
| remotetab_ena | HTTP_PUSH_CHANGED | ||
| remotetab_flags | HTTP_PUSH_CHANGED | ||
| remotetab_output_count | HTTP_PUSH_CHANGED | ||
| remotetab_pulse_flags | HTTP_PUSH_CHANGED | ||
| remotetab_send_reboot | HTTP_PUSH_CHANGED | ||
| remotetab_tpl | HTTP_PUSH_CHANGED | ||
| remotetab_url | HTTP_PUSH_CHANGED | ||
| reset_req | Reboot required | PUBLIC, RONLY | bool |
| server_cert_status | RONLY | ||
| server_key_status | RONLY | ||
| smtptab_hostname | Name of the SMTP server | char[] | |
| smtptab_login | Login name | char[] | |
| smtptab_password | Login password | char[] | |
| smtptab_port | SMTP server port | uint16 | |
| smtptab_sender | Sender address | char[] | |
| snmp_ena | SNMPv1/v2c activated | SNMP_SETTINGS_CHANGED | check |
| snmpd | SNMP server's host name or IP address | char[] | |
| syscontact | PUBLIC, SNMP_SETTINGS_CHANGED | char[63] | |
| sysdate | Current date (local) | PUBLIC, RONLY | date |
| syslocation | PUBLIC, SNMP_SETTINGS_CHANGED | char[63] | |
| systime | Current time (local) | PUBLIC, RONLY | time |
| systimestamp | Time stamp of current local time | PUBLIC, RONLY | ts |
| timerange_end | PUBLIC, RONLY | ts | |
| timerange_start | PUBLIC, RONLY | ts | |
| timerange_step | PUBLIC, RONLY | ||
| timezone | PUBLIC | char[] | |
| timezone_input | RONLY | ||
| uptime | Time since boot in days, hours, minutes and seconds | PUBLIC, RONLY | [Dd Hh Mm Ss](#format-dd hh mm ss) |
| uptime_d | Full days since last boot | PUBLIC, RONLY | uint |
| uptime_h | Hours past full days since last boot | PUBLIC, RONLY | uint |
| uptime_m | Minutes past full hours since last boot | PUBLIC, RONLY | uint |
| uptime_s | Seconds past full minute since last boot | PUBLIC, RONLY | uint |
| uri | PUBLIC, RONLY | ||
| uri_path | PUBLIC, RONLY | ||
| user | RONLY | ||
| wlan_ap_ena | NEEDS_REBOOT | ||
| wlan_ap_name | NEEDS_REBOOT | ||
| wlan_ap_pass | NEEDS_REBOOT | ||
| wlan_ap_secu | NEEDS_REBOOT | ||
| wlan_ap_secu_input | RONLY | ||
| wlan_ap_sta_list | RONLY | ||
| wlan_ena | WLAN_CLIENT_CHANGED | ||
| wlan_name | Name of WiFi network (SSID) | PUBLIC, WLAN_CLIENT_CHANGED | char[32] |
| wlan_pass | Passphrase for Wifi network | WLAN_CLIENT_CHANGED | char[64] |
| wlan_secu | Security of WiFi network 0: Unknown 1: WEP-OPEN 2: WEP-PSK 3: WEP-SHARED 4: WPA-PSK-TKIP 5: WPA-PSK-AES 6: WPA2-PSK-AES 7: WPA2-PSK-TKIP 8: WPA2-PSK-MIXED | WLAN_CLIENT_CHANGED | uint16 |
| wlan_secu_input | RONLY |
changetab
| Variable | Description | Flags | Format |
|---|---|---|---|
| changetab_date | PUBLIC, RONLY | ||
| changetab_desc | PUBLIC, RONLY | ||
| changetab_events_json | PUBLIC, RONLY | ||
| changetab_flags | PUBLIC, RONLY | ||
| changetab_gmdate | PUBLIC, RONLY | ||
| changetab_gmt_offset | PUBLIC, RONLY | ||
| changetab_gmtime | PUBLIC, RONLY | ||
| changetab_id | PUBLIC, RONLY | uint32 | |
| changetab_next_inputs | PUBLIC, RONLY | ||
| changetab_next_outputs | PUBLIC, RONLY | ||
| changetab_next_watchdogs | PUBLIC, RONLY | ||
| changetab_objectname | PUBLIC, RONLY | ||
| changetab_prev_inputs | PUBLIC, RONLY | ||
| changetab_prev_outputs | PUBLIC, RONLY | ||
| changetab_prev_watchdogs | PUBLIC, RONLY | ||
| changetab_time | PUBLIC, RONLY | ||
| changetab_timestamp | PUBLIC, RONLY | ts | |
| changetab_type | PUBLIC, RONLY | uint32 | |
| changetab_typedesc | PUBLIC, RONLY | ||
| changetab_user | PUBLIC, RONLY | uint32 | |
| changetab_username | PUBLIC, RONLY | ||
| changetab_value | PUBLIC, RONLY |
filetab
| Variable | Description | Flags | Format |
|---|---|---|---|
| filetab_date | Date on which the content file was uploaded | RONLY | date |
| filetab_has_default | RONLY | ||
| filetab_is_default | RONLY | ||
| filetab_name | Name of content file | RONLY | char[] |
| filetab_path | Path of content file | RONLY | char[] |
| filetab_size | Size of content file in Bytes | RONLY | uint32 |
| filetab_time | Time of last change to content file | RONLY | time |
firmwaretab
| Variable | Description | Flags | Format |
|---|---|---|---|
| firmware_date | RONLY | ||
| firmware_idf_ver | RONLY | ||
| firmware_project_name | RONLY | ||
| firmware_time | RONLY | ||
| firmware_valid | RONLY | ||
| firmware_version | RONLY |
histotab
| Variable | Description | Flags | Format |
|---|---|---|---|
| histotab_date | Date of measurement (local time) | PUBLIC, RONLY | date |
| histotab_flags | PUBLIC, RONLY | uint16 | |
| histotab_gmdate | Date of measurement (UTC) | PUBLIC, RONLY | date |
| histotab_gmt_offset | PUBLIC, RONLY | ||
| histotab_gmtime | Time of measurement (UTC) | PUBLIC, RONLY | time |
| histotab_raw_content | PUBLIC, RONLY | ||
| histotab_time | Time of measurement (local time) | PUBLIC, RONLY | time |
| histotab_timestamp | Time stamp of measurement (UTC) | PUBLIC, RONLY | ts |
inputtab
| Variable | Description | Flags | Format |
|---|---|---|---|
| inputtab_activity | PUBLIC, RONLY | ||
| inputtab_activity_text | PUBLIC, RONLY | ||
| inputtab_flags | SENSOR_SETTINGS_CHANGED | ||
| inputtab_group | PUBLIC | ||
| inputtab_min_change_dur | SENSOR_SETTINGS_CHANGED | ||
| inputtab_name | PUBLIC | ||
| inputtab_name_def | PUBLIC, RONLY | ||
| inputtab_notification_html | RONLY | ||
| inputtab_remote0_flags | SENSOR_SETTINGS_CHANGED | ||
| inputtab_remote0_notification_html | RONLY | ||
| inputtab_value | PUBLIC, RONLY |
logtab
| Variable | Description | Flags | Format |
|---|---|---|---|
| logtab_date | Date of event | PUBLIC, RONLY | date |
| logtab_msg | Syslog notification | PUBLIC, RONLY | char[] |
| logtab_time | Time of event | PUBLIC, RONLY | time |
| logtab_timestamp | Time stamp of event | PUBLIC, RONLY | ts |
netiftab
| Variable | Description | Flags | Format |
|---|---|---|---|
| include_network_settings | RONLY | ||
| netiftab_cdns_ip | Configured static IP address of primary DNS server | NEEDS_REBOOT | ip4 |
| netiftab_cdns_ip_sec | Configured static IP address of secondary DNS server | NEEDS_REBOOT | ip4 |
| netiftab_cip_addr | Configured static IP address | NEEDS_REBOOT | ip4 |
| netiftab_cip_gate | Configured static IP address of gateway | NEEDS_REBOOT | ip4 |
| netiftab_cip_mask | Configured static subnet mask | NEEDS_REBOOT | ip4 |
| netiftab_cur_dhcp | RONLY | ||
| netiftab_cur_dns1 | RONLY | ||
| netiftab_cur_dns2 | RONLY | ||
| netiftab_cur_gw | RONLY | ||
| netiftab_cur_ip | RONLY | ||
| netiftab_cur_mac | PUBLIC, RONLY | ||
| netiftab_cur_mask | RONLY | ||
| netiftab_cur_up | RONLY | ||
| netiftab_dns_manu | Manual DNS IP address activated | NEEDS_REBOOT | bool |
| netiftab_flags | Bit flags for activations Bit 0: Discovery Bit 3: WiFi Bit 4: DHCP Bit 5: MDNS | NEEDS_REBOOT | uint32 |
| netiftab_ip_manu | Manual IP configuration activated | NEEDS_REBOOT | bool |
| netiftab_syslog | Syslog server host name or IP address | SYSLOG_CHANGED | char[] |
| netiftab_syslog_port | Port number of Syslog server | SYSLOG_CHANGED | uint16 |
| netiftab_type_name | RONLY |
outputtab
| Variable | Description | Flags | Format |
|---|---|---|---|
| outputtab_activity | PUBLIC, RONLY | ||
| outputtab_activity_text | PUBLIC, RONLY | ||
| outputtab_flags | SENSOR_SETTINGS_CHANGED | ||
| outputtab_group | PUBLIC | ||
| outputtab_mqtt_subscribe | MQTT_NEED_RECONNECT | ||
| outputtab_name | PUBLIC | ||
| outputtab_name_def | PUBLIC, RONLY | ||
| outputtab_notification_html | RONLY | ||
| outputtab_pulse | SENSOR_SETTINGS_CHANGED | ||
| outputtab_remote0_flags | SENSOR_SETTINGS_CHANGED | ||
| outputtab_remote0_notification_html | RONLY | ||
| outputtab_value | PUBLIC, RONLY |
pushtab
| Variable | Description | Flags | Format |
|---|---|---|---|
| pushtab_ena | HTTP_PUSH_CHANGED | bool | |
| pushtab_rate | HTTP_PUSH_CHANGED | uint16 | |
| pushtab_tpl | HTTP_PUSH_CHANGED | char[15] | |
| pushtab_url | HTTP_PUSH_CHANGED | char[63] | |
| pushtab_var1 | HTTP_PUSH_CHANGED | char[31] | |
| pushtab_var2 | HTTP_PUSH_CHANGED | char[95] |
sensortab
| Variable | Description | Flags | Format |
|---|---|---|---|
| sensortab_activity | PUBLIC, RONLY | ||
| sensortab_activity_text | PUBLIC, RONLY | ||
| sensortab_al_max | PUBLIC, SENSOR_SETTINGS_CHANGED | fixed | |
| sensortab_al_min | PUBLIC, SENSOR_SETTINGS_CHANGED | fixed | |
| sensortab_control_register | |||
| sensortab_cunit | PUBLIC, SENSOR_SETTINGS_CHANGED | ||
| sensortab_firmware_info | RONLY | ||
| sensortab_firmware_info_updater | RONLY | ||
| sensortab_flags | SENSOR_SETTINGS_CHANGED | ||
| sensortab_found_hardware | PUBLIC, RONLY | ||
| sensortab_gain | Factor by which the meausred sensor values are multiplied | PUBLIC, SENSOR_SETTINGS_CHANGED | fixed |
| sensortab_group | PUBLIC | ||
| sensortab_hist_avg | PUBLIC, RONLY | fixed | |
| sensortab_hist_flags | PUBLIC, RONLY | ||
| sensortab_hist_hi | PUBLIC, RONLY | fixed | |
| sensortab_hist_lo | PUBLIC, RONLY | fixed | |
| sensortab_hyst | Dead-band for sensor alerts | PUBLIC, SENSOR_SETTINGS_CHANGED | fixed |
| sensortab_iunit | PUBLIC, SENSOR_SETTINGS_CHANGED | ||
| sensortab_last_error | PUBLIC, RONLY | ||
| sensortab_name | Name of sensor | PUBLIC | char[] |
| sensortab_name_def | PUBLIC, RONLY | ||
| sensortab_notification_html | RONLY | ||
| sensortab_offset | Offset that is added to the measured sensor values | PUBLIC, SENSOR_SETTINGS_CHANGED | fixed |
| sensortab_remote0_flags | SENSOR_SETTINGS_CHANGED | ||
| sensortab_remote0_notification_html | RONLY | ||
| sensortab_serial | PUBLIC, RONLY | ||
| sensortab_serial_onewire | PUBLIC | ||
| sensortab_status | Current sensor status * Bit 0: Lower limit alarm * Bit 1: Upper limit alarm * Bit 2: Falling limit alarm * Bit 3: Rising limit alarm * Bit 7: Sensor error | PUBLIC, RONLY | uint8 |
| sensortab_status_text | PUBLIC, RONLY | ||
| sensortab_unit | Unit of value as text with HTML entities. Always %rh for humidity and °C, °F or K for tempertarues, depending on sensortab_userunit. | PUBLIC, RONLY | char[] |
| sensortab_unit_input | RONLY | ||
| sensortab_updater_active | PUBLIC | ||
| sensortab_value | Current value measured by sensor | PUBLIC, RONLY | fixed |
watchtab
| Variable | Description | Flags | Format |
|---|---|---|---|
| watchtab_activity | PUBLIC, RONLY | ||
| watchtab_activity_text | PUBLIC, RONLY | ||
| watchtab_flags | WATCHDOG_CHANGED | ||
| watchtab_group | PUBLIC | ||
| watchtab_name | PUBLIC | ||
| watchtab_name_def | PUBLIC, RONLY | ||
| watchtab_notification_html | RONLY | ||
| watchtab_rate | WATCHDOG_CHANGED | ||
| watchtab_remote0_flags | WATCHDOG_CHANGED | ||
| watchtab_remote0_notification_html | RONLY | ||
| watchtab_state | PUBLIC, RONLY | ||
| watchtab_target | WATCHDOG_CHANGED | ||
| watchtab_time_left | PUBLIC, RONLY | ||
| watchtab_type | PUBLIC, WATCHDOG_CHANGED | ||
| watchtab_type_input | RONLY |
Flag Reference
| Flag | Meaning |
|---|---|
HTTP_PUSH_CHANGED | HTTP Push Changed |
MODBUS_CHANGED | Modbus Changed |
MQTT_NEED_RECONNECT | MQTT Needs Reconnect |
NEEDS_REBOOT | Needs Reboot |
NTP_CHANGED | NTP Changed |
PUBLIC | Public |
RONLY | Read only |
SENSOR_SETTINGS_CHANGED | Sensor Settings Changed |
SNMP_SETTINGS_CHANGED | SNMP Settings Changed |
SYSLOG_CHANGED | Syslog Changed |
WATCHDOG_CHANGED | Watchdog Changed |
WLAN_CLIENT_CHANGED | WLAN Client Changed |
Format Reference
| Format | Meaning |
|---|---|
Dd Hh Mm Ss | |
bool | |
char[] | |
check | |
date | |
fixed | |
int | |
int32 | |
ip4 | |
time | |
ts | |
uin32 | |
uint | |
uint16 | |
uint32 | |
uint8 |