Skip to main content

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

TableDescription
webvarsSimple web variables
changetab
filetabThe filetab table contains the installed content files.
firmwaretab
histotabThe 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
logtabThe logtab table contains the 8 most recent syslog notifications.
netiftabThe netiftab table contains information about the two network interfaces.
outputtab
pushtab
sensortabThe sensortab table contains information on up to 4 sensors.
watchtab

webvars

VariableDescriptionFlagsFormat
abnormal_conditionsPUBLIC, RONLY
admin_name
admin_pwdRONLY
admin_pwd2RONLY
anon_read
api_keyRONLY
ca_cert_statusRONLY
changes_startPUBLIC, RONLYts
changetab_countPUBLIC, RONLYuint32
changetab_maxPUBLIC, RONLYuint32
changetab_minPUBLIC, RONLYuint32
cmnty_readSNMP Community for read-only accessSNMP_SETTINGS_CHANGEDchar[15]
cmnty_trapchar[15]
cmnty_writeSNMP Community for write accessSNMP_SETTINGS_CHANGEDchar[15]
config_usageThe configuration's current size in percentRONLYchar[]
csrf_tokenPUBLIC, PUBLIC, RONLY
datetimePUBLIC, RONLY
datetime_utcPUBLIC, RONLY
db_usagePUBLIC, RONLYint
db_usage_changesPUBLIC, RONLYint
db_usage_historyPUBLIC, RONLYint
db_usage_syslogPUBLIC, RONLYint
db_usage_unknownPUBLIC, RONLYint
db_usage_unknown_blocksPUBLIC, RONLYint
dev_typeType of device, "OpenTango"PUBLIC, RONLYchar[]
fs_has_spaceRONLY
fw_devRONLY
fw_manufacturerProducer of the active firmwarePUBLIC, RONLYchar[]
fw_nameName of the active firmwarePUBLIC, RONLYchar[]
fw_versionVersion of the active firmwarePUBLIC, RONLYchar[]
gmt_offsetDifference between local time and UTC in seconds, including summer time, if activePUBLIC, RONLYint32
gmt_offset_dstPUBLIC, RONLY
gmt_offset_normalPUBLIC, RONLY
has_passwordPUBLIC, RONLY
has_simulated_network_inputsNEEDS_REBOOT
has_simulated_sensors
histo_rateLogging rate in seconds (only full minutes)PUBLIC, SENSOR_SETTINGS_CHANGEDuin32
histo_rate_mLoggin rate in minutesPUBLIC, SENSOR_SETTINGS_CHANGEDuint32
histo_startTime stamp of the oldest recorded dataPUBLIC, RONLYts
histotab_countPUBLIC, RONLY
histotab_maxPUBLIC, RONLY
histotab_minPUBLIC, RONLY
hostnameName of the devicePUBLIC, SNMP_SETTINGS_CHANGEDchar[15]
http_hostPUBLIC, RONLY
https_activePUBLIC, RONLYuint
https_redirectPUBLIC, NEEDS_REBOOT
hw_fail_strPUBLIC, RONLY
icons_urlPUBLIC, RONLY
is_adminPUBLIC, RONLY
langIndex of language settings

0: English

1: German
PUBLICint32
led_brnDimming level of LED in normal stateuint16
mailtab_addrchar[63]
mailtab_ena
mailtab_tpl
mb_enaModbus activatedMODBUS_CHANGEDcheck
mb_wrprotModbus is read-onlyMODBUS_CHANGEDcheck
memfree_kbPUBLIC, RONLY
memfree_min_kbPUBLIC, RONLY
memusageCurrent usage of RAM in percentPUBLIC, RONLYchar[]
memusage_maxPUBLIC, RONLY
menu_contentPUBLIC, RONLY
mqtt_brokerHost name or IP address of the MQTT brokerMQTT_NEED_RECONNECTchar[63]
mqtt_client_idClient ID, that is sent to the brokerMQTT_NEED_RECONNECTchar[23]
mqtt_enaMQTT activatedMQTT_NEED_RECONNECTcheck
mqtt_intervalMQTT_NEED_RECONNECT
mqtt_keep_aliveMQTT_NEED_RECONNECTuint16
mqtt_last_will_connect_messageMQTT_NEED_RECONNECTchar[]
mqtt_last_will_messageMQTT_NEED_RECONNECTchar[]
mqtt_last_will_topicMQTT_NEED_RECONNECTchar[]
mqtt_passwordPassword for MQTTMQTT_NEED_RECONNECTchar[31]
mqtt_portPort of the MQTT brokerMQTT_NEED_RECONNECTuint16
mqtt_retain_inputs
mqtt_retain_last_willMQTT_NEED_RECONNECT
mqtt_retain_outputs
mqtt_retain_sensors
mqtt_retain_watchdogs
mqtt_send_reboot
mqtt_statusRONLY
mqtt_tlsMQTT_NEED_RECONNECT
mqtt_topic_prfx
mqtt_userUser for MQTTPUBLIC, MQTT_NEED_RECONNECTchar[31]
netifActive network interface, "ETH", "WLAN" or "WLAN AP"RONLYchar[]
ntp_enaNTP_CHANGED
ntpdNTP server's host name or IP addressNTP_CHANGEDchar[31]
remotetab_api_keyHTTP_PUSH_CHANGED
remotetab_enaHTTP_PUSH_CHANGED
remotetab_flagsHTTP_PUSH_CHANGED
remotetab_output_countHTTP_PUSH_CHANGED
remotetab_pulse_flagsHTTP_PUSH_CHANGED
remotetab_send_rebootHTTP_PUSH_CHANGED
remotetab_tplHTTP_PUSH_CHANGED
remotetab_urlHTTP_PUSH_CHANGED
reset_reqReboot requiredPUBLIC, RONLYbool
server_cert_statusRONLY
server_key_statusRONLY
smtptab_hostnameName of the SMTP serverchar[]
smtptab_loginLogin namechar[]
smtptab_passwordLogin passwordchar[]
smtptab_portSMTP server portuint16
smtptab_senderSender addresschar[]
snmp_enaSNMPv1/v2c activatedSNMP_SETTINGS_CHANGEDcheck
snmpdSNMP server's host name or IP addresschar[]
syscontactPUBLIC, SNMP_SETTINGS_CHANGEDchar[63]
sysdateCurrent date (local)PUBLIC, RONLYdate
syslocationPUBLIC, SNMP_SETTINGS_CHANGEDchar[63]
systimeCurrent time (local)PUBLIC, RONLYtime
systimestampTime stamp of current local timePUBLIC, RONLYts
timerange_endPUBLIC, RONLYts
timerange_startPUBLIC, RONLYts
timerange_stepPUBLIC, RONLY
timezonePUBLICchar[]
timezone_inputRONLY
uptimeTime since boot in days, hours, minutes and secondsPUBLIC, RONLY[Dd Hh Mm Ss](#format-dd hh mm ss)
uptime_dFull days since last bootPUBLIC, RONLYuint
uptime_hHours past full days since last bootPUBLIC, RONLYuint
uptime_mMinutes past full hours since last bootPUBLIC, RONLYuint
uptime_sSeconds past full minute since last bootPUBLIC, RONLYuint
uriPUBLIC, RONLY
uri_pathPUBLIC, RONLY
userRONLY
wlan_ap_enaNEEDS_REBOOT
wlan_ap_nameNEEDS_REBOOT
wlan_ap_passNEEDS_REBOOT
wlan_ap_secuNEEDS_REBOOT
wlan_ap_secu_inputRONLY
wlan_ap_sta_listRONLY
wlan_enaWLAN_CLIENT_CHANGED
wlan_nameName of WiFi network (SSID)PUBLIC, WLAN_CLIENT_CHANGEDchar[32]
wlan_passPassphrase for Wifi networkWLAN_CLIENT_CHANGEDchar[64]
wlan_secuSecurity 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_CHANGEDuint16
wlan_secu_inputRONLY

changetab

VariableDescriptionFlagsFormat
changetab_datePUBLIC, RONLY
changetab_descPUBLIC, RONLY
changetab_events_jsonPUBLIC, RONLY
changetab_flagsPUBLIC, RONLY
changetab_gmdatePUBLIC, RONLY
changetab_gmt_offsetPUBLIC, RONLY
changetab_gmtimePUBLIC, RONLY
changetab_idPUBLIC, RONLYuint32
changetab_next_inputsPUBLIC, RONLY
changetab_next_outputsPUBLIC, RONLY
changetab_next_watchdogsPUBLIC, RONLY
changetab_objectnamePUBLIC, RONLY
changetab_prev_inputsPUBLIC, RONLY
changetab_prev_outputsPUBLIC, RONLY
changetab_prev_watchdogsPUBLIC, RONLY
changetab_timePUBLIC, RONLY
changetab_timestampPUBLIC, RONLYts
changetab_typePUBLIC, RONLYuint32
changetab_typedescPUBLIC, RONLY
changetab_userPUBLIC, RONLYuint32
changetab_usernamePUBLIC, RONLY
changetab_valuePUBLIC, RONLY

filetab

VariableDescriptionFlagsFormat
filetab_dateDate on which the content file was uploadedRONLYdate
filetab_has_defaultRONLY
filetab_is_defaultRONLY
filetab_nameName of content fileRONLYchar[]
filetab_pathPath of content fileRONLYchar[]
filetab_sizeSize of content file in BytesRONLYuint32
filetab_timeTime of last change to content fileRONLYtime

firmwaretab

VariableDescriptionFlagsFormat
firmware_dateRONLY
firmware_idf_verRONLY
firmware_project_nameRONLY
firmware_timeRONLY
firmware_validRONLY
firmware_versionRONLY

histotab

VariableDescriptionFlagsFormat
histotab_dateDate of measurement (local time)PUBLIC, RONLYdate
histotab_flagsPUBLIC, RONLYuint16
histotab_gmdateDate of measurement (UTC)PUBLIC, RONLYdate
histotab_gmt_offsetPUBLIC, RONLY
histotab_gmtimeTime of measurement (UTC)PUBLIC, RONLYtime
histotab_raw_contentPUBLIC, RONLY
histotab_timeTime of measurement (local time)PUBLIC, RONLYtime
histotab_timestampTime stamp of measurement (UTC)PUBLIC, RONLYts

inputtab

VariableDescriptionFlagsFormat
inputtab_activityPUBLIC, RONLY
inputtab_activity_textPUBLIC, RONLY
inputtab_flagsSENSOR_SETTINGS_CHANGED
inputtab_groupPUBLIC
inputtab_min_change_durSENSOR_SETTINGS_CHANGED
inputtab_namePUBLIC
inputtab_name_defPUBLIC, RONLY
inputtab_notification_htmlRONLY
inputtab_remote0_flagsSENSOR_SETTINGS_CHANGED
inputtab_remote0_notification_htmlRONLY
inputtab_valuePUBLIC, RONLY

logtab

VariableDescriptionFlagsFormat
logtab_dateDate of eventPUBLIC, RONLYdate
logtab_msgSyslog notificationPUBLIC, RONLYchar[]
logtab_timeTime of eventPUBLIC, RONLYtime
logtab_timestampTime stamp of eventPUBLIC, RONLYts

netiftab

VariableDescriptionFlagsFormat
include_network_settingsRONLY
netiftab_cdns_ipConfigured static IP address of primary DNS serverNEEDS_REBOOTip4
netiftab_cdns_ip_secConfigured static IP address of secondary DNS serverNEEDS_REBOOTip4
netiftab_cip_addrConfigured static IP addressNEEDS_REBOOTip4
netiftab_cip_gateConfigured static IP address of gatewayNEEDS_REBOOTip4
netiftab_cip_maskConfigured static subnet maskNEEDS_REBOOTip4
netiftab_cur_dhcpRONLY
netiftab_cur_dns1RONLY
netiftab_cur_dns2RONLY
netiftab_cur_gwRONLY
netiftab_cur_ipRONLY
netiftab_cur_macPUBLIC, RONLY
netiftab_cur_maskRONLY
netiftab_cur_upRONLY
netiftab_dns_manuManual DNS IP address activatedNEEDS_REBOOTbool
netiftab_flagsBit flags for activations

Bit 0: Discovery

Bit 3: WiFi

Bit 4: DHCP

Bit 5: MDNS
NEEDS_REBOOTuint32
netiftab_ip_manuManual IP configuration activatedNEEDS_REBOOTbool
netiftab_syslogSyslog server host name or IP addressSYSLOG_CHANGEDchar[]
netiftab_syslog_portPort number of Syslog serverSYSLOG_CHANGEDuint16
netiftab_type_nameRONLY

outputtab

VariableDescriptionFlagsFormat
outputtab_activityPUBLIC, RONLY
outputtab_activity_textPUBLIC, RONLY
outputtab_flagsSENSOR_SETTINGS_CHANGED
outputtab_groupPUBLIC
outputtab_mqtt_subscribeMQTT_NEED_RECONNECT
outputtab_namePUBLIC
outputtab_name_defPUBLIC, RONLY
outputtab_notification_htmlRONLY
outputtab_pulseSENSOR_SETTINGS_CHANGED
outputtab_remote0_flagsSENSOR_SETTINGS_CHANGED
outputtab_remote0_notification_htmlRONLY
outputtab_valuePUBLIC, RONLY

pushtab

VariableDescriptionFlagsFormat
pushtab_enaHTTP_PUSH_CHANGEDbool
pushtab_rateHTTP_PUSH_CHANGEDuint16
pushtab_tplHTTP_PUSH_CHANGEDchar[15]
pushtab_urlHTTP_PUSH_CHANGEDchar[63]
pushtab_var1HTTP_PUSH_CHANGEDchar[31]
pushtab_var2HTTP_PUSH_CHANGEDchar[95]

sensortab

VariableDescriptionFlagsFormat
sensortab_activityPUBLIC, RONLY
sensortab_activity_textPUBLIC, RONLY
sensortab_al_maxPUBLIC, SENSOR_SETTINGS_CHANGEDfixed
sensortab_al_minPUBLIC, SENSOR_SETTINGS_CHANGEDfixed
sensortab_control_register
sensortab_cunitPUBLIC, SENSOR_SETTINGS_CHANGED
sensortab_firmware_infoRONLY
sensortab_firmware_info_updaterRONLY
sensortab_flagsSENSOR_SETTINGS_CHANGED
sensortab_found_hardwarePUBLIC, RONLY
sensortab_gainFactor by which the meausred sensor values are multipliedPUBLIC, SENSOR_SETTINGS_CHANGEDfixed
sensortab_groupPUBLIC
sensortab_hist_avgPUBLIC, RONLYfixed
sensortab_hist_flagsPUBLIC, RONLY
sensortab_hist_hiPUBLIC, RONLYfixed
sensortab_hist_loPUBLIC, RONLYfixed
sensortab_hystDead-band for sensor alertsPUBLIC, SENSOR_SETTINGS_CHANGEDfixed
sensortab_iunitPUBLIC, SENSOR_SETTINGS_CHANGED
sensortab_last_errorPUBLIC, RONLY
sensortab_nameName of sensorPUBLICchar[]
sensortab_name_defPUBLIC, RONLY
sensortab_notification_htmlRONLY
sensortab_offsetOffset that is added to the measured sensor valuesPUBLIC, SENSOR_SETTINGS_CHANGEDfixed
sensortab_remote0_flagsSENSOR_SETTINGS_CHANGED
sensortab_remote0_notification_htmlRONLY
sensortab_serialPUBLIC, RONLY
sensortab_serial_onewirePUBLIC
sensortab_statusCurrent 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, RONLYuint8
sensortab_status_textPUBLIC, RONLY
sensortab_unitUnit of value as text with HTML entities. Always %rh for humidity and °C, °F or K for tempertarues, depending on sensortab_userunit.PUBLIC, RONLYchar[]
sensortab_unit_inputRONLY
sensortab_updater_activePUBLIC
sensortab_valueCurrent value measured by sensorPUBLIC, RONLYfixed

watchtab

VariableDescriptionFlagsFormat
watchtab_activityPUBLIC, RONLY
watchtab_activity_textPUBLIC, RONLY
watchtab_flagsWATCHDOG_CHANGED
watchtab_groupPUBLIC
watchtab_namePUBLIC
watchtab_name_defPUBLIC, RONLY
watchtab_notification_htmlRONLY
watchtab_rateWATCHDOG_CHANGED
watchtab_remote0_flagsWATCHDOG_CHANGED
watchtab_remote0_notification_htmlRONLY
watchtab_statePUBLIC, RONLY
watchtab_targetWATCHDOG_CHANGED
watchtab_time_leftPUBLIC, RONLY
watchtab_typePUBLIC, WATCHDOG_CHANGED
watchtab_type_inputRONLY

Flag Reference

FlagMeaning
HTTP_PUSH_CHANGEDHTTP Push Changed
MODBUS_CHANGEDModbus Changed
MQTT_NEED_RECONNECTMQTT Needs Reconnect
NEEDS_REBOOTNeeds Reboot
NTP_CHANGEDNTP Changed
PUBLICPublic
RONLYRead only
SENSOR_SETTINGS_CHANGEDSensor Settings Changed
SNMP_SETTINGS_CHANGEDSNMP Settings Changed
SYSLOG_CHANGEDSyslog Changed
WATCHDOG_CHANGEDWatchdog Changed
WLAN_CLIENT_CHANGEDWLAN Client Changed

Format Reference

FormatMeaning
Dd Hh Mm Ss
bool
char[]
check
date
fixed
int
int32
ip4
time
ts
uin32
uint
uint16
uint32
uint8