ESP3D/docs/keywords.txt
2016-10-09 11:08:12 +02:00

151 lines
7.0 KiB
Plaintext

[COMMON]
$INCLUDE[<filename>] : only one per line and alone, others will be ignored
$IP$ : current active ip
$WEB_ADDRESS$: current active ip , if port is not 80 it will add port like xxx.xxx.xxxx.xxx:XX
$MENU_HOME$/$MENU_SYSTEM$/$MENU_AP$/$MENU_STA$/$MENU_PRINTER$/$MENU_SETTINGS$: to highlight menu of active page (css use class active for active menu)
$SERVICE_PAGE$ : to add extra code like redirection or anything not managed by page
$PAGE_TILE$ : page title
$FILENAME$ : file name of tpl
$SHORT_FILENAME$ : file name of tpl without extension
$MODE$ : the mode when displaying page AP/STA/AP_STA
$FW_VER$ : Firmware version
[HOME]
$HOSTNAME$: Hostname
$HOSTNAME_VISIBLE$ : if AP mode then hostname is not applicable so set to hidden, if in STA mode set to visible
$CHIP_ID$ : Chip ID
$CPU_FREQ$ : CPU Frequency
$FREE_MEM$ : Free memory on heap
$SDK_VER$ : SDK version
$MDNS_VISIBLE$: set to hidden if no MDNS and visible if present
$MDNS_NAME$ : mDNS name if enabled or "Not enabled" if not enabled
$SSDP_VISIBLE$ : set to hidden if no MDNS and visible if present
$SSDP_STATUS$ : set to Enabled / Not enabled according compilation settings
$CAPTIVE_PORTAL_VISIBLE$: set to hidden if no Captive portal and visible if present
$CAPTIVE_PORTAL_STATUS$: set to Enabled / Not enabled according compilation settings
$NET_PHY$ : Network type (b/g/n)
$SLEEP_MODE$ : Sleep Mode
$BOOT_VER$ : Boot version
$BAUD_RATE$ : Baud rates for serial communication
$WEB_PORT$ : Port for web access
$DATA_PORT$ : Port for tcp ip connection
$DATA_PORT_VISIBILITY$ : set to hidden if no enabled and visible if enabled
$AP_STATUS_ENABLED$ : is Access Point enabled or disabled
$AP_VISIBILITY$ : if Access Point is enabled set visible, else set to hidden
$AP_MAC$ : Mac address of AP
$AP_SSID$ : SSID of AP
$AP_IS_VISIBLE$ : Is AP visible
$AP_CHANNEL$ : Channel
$AP_AUTH$ : Autehntification mode
$AP_MAX_CON$ : Maximum connections allowed
$AP_DHCP_STATUS$ : AP DHCP server status (started/stopped)
$AP_IP$ : AP IP address
$AP_GW$ : AP gateway address
$AP_SUBNET$ : AP mask of subnet
$CONNECTED_STATIONS[ Repetive template using $ROW_NUMBER$ $MAC_CONNECTED$ $IP_CONNECTED$ ]$
$CONNECTED_STATIONS_NB_ITEMS$ : number of item for connected stations list
or can get variables in direct access:
$ROW_NUMBER[0]$
$MAC_CONNECTED[0]$
$IP_CONNECTED[0]$
until
$ROW_NUMBER[$CONNECTED_STATIONS_NB_ITEMS$ -1]$
$MAC_CONNECTED[$CONNECTED_STATIONS_NB_ITEMS$ -1]$
$IP_CONNECTED[$CONNECTED_STATIONS_NB_ITEMS$ -1]$
$STA_STATUS_ENABLED$ : is Station enabled or disabled
$STA_VISIBILITY$ : if Station is enabled set visible, else set to hidden
$STA_MAC$ : Mac address of Station
$STA_SSID$ : SSID used by STA
$STA_CHANNEL$ : Channel
$STA_STATUS$ : Connection Status
$STA_SIGNAL$ : Signal strength
$STA_DHCP_STATUS$ : DHCP Client status
$STA_IP$ : STA IP
$STA_GW$ : STA Gateway
$STA_SUBNET$ : STA Mask
[SYSTEM CONFIGURATION]
$BAUD_RATE_OPTIONS_LIST$ : Baud rate list
$SLEEP_MODE_OPTIONS_LIST$ : Sleep mode list
$POLLING_OPTIONS_LIST$ : Refresh delay list
$WEB_PORT$ : Port for web access
$DATA_PORT$ : Port for tcp ip connection
$DATA_PORT_VISIBILITY$ : set to hidden if no enabled and visible if enabled
$ERROR_MSG$ : Error message if any
$SUCCESS_MSG$ : Success message announcing restart
$ERROR_MSG_VISIBILITY$ : Show/Hide Error message
$SUCCESS_MSG_VISIBILITY$ : Show/Hide Success message
$SUBMIT_BUTTON_VISIBILITY$ : Show if no submission or any error, hide if submission is successful
$BAUD_RATE_STATUS$ : change to has-error if issue, or has-success if ok
$SLEEP_MODE_STATUS$ : change to has-error if issue, or has-success if ok
$WEB_PORT_STATUS$ : change to has-error if issue, or has-success if ok
$DATA_PORT_STATUS$ : change to has-error if issue, or has-success if ok
[AP CONFIGURATION]
$AP_SSID$ : Access point SSID
$AP_PASSWORD$ Access point password
$IS_SSID_VISIBLE$ : set to checked if SSID is visible
$NETWORK_OPTION_LIST$ : Option list for network for AP
$CHANNEL_OPTION_LIST$ : Channel list
$AUTH_OPTION_LIST$ Authentification methods list
$IS_STATIC_IP$ : set to checked if use static address
$AP_IP$ : Access point IP if static address
$AP_GW$ : Access point Gaieway if static address
$AP_SUBNET$ : : Access point network mask if static address
$ERROR_MSG$ : Error message if any
$SUCCESS_MSG$ : Success message announcing restart
$ERROR_MSG_VISIBILITY$ : Show/Hide Error message
$SUCCESS_MSG_VISIBILITY$ : Show/Hide Success message
$SUBMIT_BUTTON_VISIBILITY$ : Show if no submission or any error, hide if submission is successful
$AP_SSID_STATUS$ : change to has-error if issue, or has-success if ok
$AP_PASSWORD_STATUS$ : change to has-error if issue, or has-success if ok
$IS_SSID_VISIBLE_STATUS$ : change to has-error if issue, or has-success if ok
$NETWORK_OPTION_LIST_STATUS$ : change to has-error if issue, or has-success if ok
$CHANNEL_OPTION_LIST_STATUS$ : change to has-error if issue, or has-success if ok
$AUTH_OPTION_LIST_STATUS$ : change to has-error if issue, or has-success if ok
$AP_STATIC_IP_STATUS$ : change to has-error if issue, or has-success if ok
$AP_IP_STATUS$ : change to has-error if issue, or has-success if ok
$AP_GW_STATUS$ : change to has-error if issue, or has-success if ok
$AP_SUBNET_STATUS$ : change to has-error if issue, or has-success if ok
[STATION CONFIGURATION]
$STA_SSID$ : Access point SSID
$STA_PASSWORD$ Access point password
$NETWORK_OPTION_LIST$ : Option list for network for AP
$IS_STATIC_IP$ : set to checked if use static address
$STA_IP$ : Access point IP if static address
$STA_GW$ : Access point Gaieway if static address
$STA_SUBNET$ : : Access point network mask if static address
$ERROR_MSG$ : Error message if any
$SUCCESS_MSG$ : Success message announcing restart
$ERROR_MSG_VISIBILITY$ : Show/Hide Error message
$SUCCESS_MSG_VISIBILITY$ : Show/Hide Success message
$SUBMIT_BUTTON_VISIBILITY$ : Show if no submission or any error, hide if submission is successful
$STA_SSID_STATUS$ : change to has-error if issue, or has-success if ok
$STA_PASSWORD_STATUS$ : change to has-error if issue, or has-success if ok
$NETWORK_OPTION_LIST_STATUS$ : change to has-error if issue, or has-success if ok
$STA_STATIC_IP_STATUS$ : change to has-error if issue, or has-success if ok
$STA_IP_STATUS$ : change to has-error if issue, or has-success if ok
$STA_GW_STATUS$ : change to has-error if issue, or has-success if ok
$STA_SUBNET_STATUS$ : change to has-error if issue, or has-success if ok
$AP_SCAN_VISIBILITY$ : Hide scan table which is not executed when saving to EEPROM
[PRINTER STATUS]
$REFRESH_PAGE$ : Delay for refreshing pages
$XY_FEEDRATE$ : XY axis feedrate
$Z_FEEDRATE$ : Z axis feedrate
$E_FEEDRATE$ : Extruder feedrate
[PRINTER SETTINGS]
$REFRESH_PAGE$ : Delay for refreshing pages
$XY_FEEDRATE$ : XY axis feedrate
$Z_FEEDRATE$ : Z axis feedrate
$E_FEEDRATE$ : Extruder feedrate
$REFRESH_PAGE_STATUS$ : change to has-error if issue, or has-success if ok
$XY_FEEDRATE_STATUS$ : change to has-error if issue, or has-success if ok
$Z_FEEDRATE_STATUS$ : change to has-error if issue, or has-success if ok
$E_FEEDRATE_STATUS$ : change to has-error if issue, or has-success if ok