Top Level

This is the top level for all HTML tags. See the Properties and methods sections below for a summary of the available tags that may be accessed from an HTML file.

Properties

Name	Description
active_search_string
camera_id
camera_name
device_view_list	Returns True if the devices view is in List view
Initialized
log_auto_update
plugin_html	Used to hold JUI HTML information for use in the plugin wrapper HTML page
plugwrapper_pluginid	For JUI plugin pages, this holds the ID of the plugin
queries	Holds the queries from the last request. Can be used to see if any queries were added to the URL
refid	Holds the reference ID of a device if selected, or an event if selected
root_device_ref
selected_plugin_id
selected_plugin_search
selected_plugin_tab
setup_tab_selected_id	Returns the last tab that was selected in Setup
StartIndex
state
system_type	Returns the system type which is one of the following HS4STANDARD HS4PRO HS4ZEES2
timers_counters_selected_tab	The currently selected tab on the timers/counters page Either "timers" or "counters"
total_log_entries_last_div_update
user	Returns the user currently logged into the page
user_agent	Returns the user agent of the browser that issued the request

Methods

Name	Description
action_build_ui	Returns a formatted HTML action Used only by plugins, standard actions are formatted in event.html
action_list	Returns a list of all available event actions
action_then_edit	Returns TRUE if an action is currently being edited, else false if not
AddDeviceToChangeQueue	Queue a device that has changed Used by devices page to update devices that have changed Called internally only
allcategories	Returns a list of all categories configured in the system
bulk_all_checked	Returns "checked" if ALL devices are checked on the bulk devices page
bulk_device_checked	On bulk devices page returns True if given device is checked
camera_id_to_name	Return the name of the camera given a camera name
camera_list	Return list of cameras installed in the system, of type "cam"
camera_snapshots	Return a list of cameras
categories	Returns a list of all categories configured for a specific device
category_icons	Return all available category icons Category icons live in html/images/Categories
child_devices	Returns a list of child device for the given root device reference number
configlist	Return a list all the .HSD HS config files in the Data folder
controls1	return the controls for the main device panel on the device list if the root device does not have any controls, add the controls from the child marked as primary this returns the controls for the first row the passed ref is already the primary device
controls2	Returns the second row of controls for a device
counters	Returns a list of all configured counters
current_config	Return the currently select HSD config file
date_short_format	Returns the current date/time in short format Used by log.html
date_time	Returns the current date and time
device_by_ref	Given a ref ID return a single device from the _devices list
device_count_unfiltered	Return the total number of devices configured in the system Includes child devices
device_inc_pages	Returns a list of pages registered as device inclusion pages
device_misc	Returns "checked" if the requested bit in the device MISC property is checked
device_name_full	Gets the full name of a device including location2, location1, and the name
device_prop	Calls a property on the device class
device_tabs	Return a list of "tabitem", one tab for each tab that is displayed in the device properties
devices	Returns a list of devices of type "device". The device list is This list of devices is stored seperately for each devices.html page using the session key
downloadv2_updates	When called forces a download of the updates control file
end_index
energy_devices	Return all energy devices
energy_graph_usage_cost	Return 0 if Y axis is Usage or 1 if Cost Graph.YAxis holds the setting
energy_graphs	Return all energy graph types
energy_stats	Return the current energy statistics
ev_trig_group_count	Returns the number of event groups in an event. An event group is a group of triggers under an "IF" or "OR IF".
ev_trigs_in_group	Returns the number of triggers in a single event group. Use ev_trig_group_count to determine the total number of groups in the trigger.
event	Return an event of type EventClass
event_action_format	Return the description for the given event action
event_actions	Return an array of event actions of type EvAct_Base
event_trigger_format	Return the description for the given event trigger
event_triggers	Return an array of event triggers of type EvTrig_Base
events	Return a list of groups of type "evgroupitem"
featured_available	Returns True if featured plugins are available
format_date	Convert a date to string in a format used with event last run
geolocations	Returns a list of all the geo locations configured in the locations.csv file
get_categories_details	Return list of all categories as class "category"
get_setting_bool	Returns the boolean setting of a specific system setting
get_setting_text	Returns the string setting of a specific system setting
get_setting_text_w_file	Returns the string setting of a specific setting that exists in a specific INI file
hs_checkbox_setting	Returns a fully formatted checkbox setting Used mainly as a shortcut on the setup.html page
includefile	include another HTML snippet into an existing file the template parser will not parse any tags in this snippet after the text is inserted so we parse the tags here and return the complete html
includefile_if_hsmobile	Includes another file into the HTML document but only if the page is being displayed on a mobile device such as HomeSeer Mobile. Any tags in the file are processed before the file is returned.
includefile_not_hsmobile	Includes another file into the HTML document but only if the page is NOT being displayed on a mobile device such as HomeSeer Mobile. Any tags in the file are processed before the file is returned.
Init
installed_plugin_details	Returns a list of installed plugins
is_act_jui_plugin	Returns true if the given event action is for a JUI based plugin, else false if for an HS3 based plugin
is_trig_jui_plugin	Returns true if the given event trigger is for a JUI based plugin, else false if for an HS3 based plugin
last_change	Returns the device last change time
latest_energy_graph	Returns the latest energy graph image file
licenseinfo	Returns a string that describes license info for the system such as license ID
location_name	Returns the name assigned to location 1
location1_display_first	Return True if location 1 should be displayed first
location2_name	Returns the name assigned to location 2
locations	Returns a string array of all locations (location 1)
locations2	Returns a string array of all locations (location 2)
log_colors_list	Returns a list of all log colors configured
log_end	Return the date/time of the end of the log
log_page	Return an array of lenty objects that represent each log entry The range returned starts with the log_start and log_end date/time
log_search_phrase	Return the currently active search phrase that the log is filtering with
log_start	Return the date of the start of the log
log_start_time	Return the time of the start of the log
log_type_selected	Return the currently selecte log type
log_types	Return a list of all available log types
max_log_date	Return the selected end date to end displaying log data
min_log_date	Return selected date to start displaying log data
NewSession	A session value is store as a Cookie in each page, this gets a new session when the cookie is not available. It is then passed in the header when the browser requests a page and put in current_session so the page can be built using existing saved information
page_logo	Returns a page to the HomeSeer logo image
plugin_details	Returns a list of all available plugins
plugin_function	Calls a function in a given plugin and returns the result
plugin_menu_items	Return the plugins that are loaded in the system, in the list format for the Nav Bar plugins menu
plugin_property_get	Access a property in a plugin
plugin_property_set	Sets a property on a plugin
plugin_search_active	Returns True if a plugin search string is populated
plugins_installed	Return list of installed plugins and info such as new version
root_devices_by_location	Returns a list of all root devices Used by event.html
selected_category	For the devices view, returns all the categories selected
selected_filter	For the devices view, returns all the filter tags selected
selected_location	For the devices view, returns all the locations selected (location 1)
selected_location2	For the devices view, returns all the locations selected (location 2)
selected_plugin_list	Return the currently selected list of tags for searching for a plugin Used by the plugins.html page
setup_tabs	Returns a list of all available setup tabs
speaker_client_list	Return a list of strings, one entry for each speaker client that is currently connected
start_index
status_image	Return the full img tag of the device status image
status_image_file	Return the file path of the device status image
status_text	Return the current device status text
sub_trigger_list	Returns the full sub trigger list for the given event ref, index, a and group Only some triggers have a sub trigger list
therm_current_cool_set	Returns the thermostat controls for the cool setpoint
therm_current_heat_set	Returns the thermostat controls for the heat setpoint
therm_current_temp	Returns the thermostat current temperature
therm_fan_controls	Return the thermostat controls for the fan
therm_fan_status_image	Returns the current image for the thermostat fan
therm_mode_controls	Returns the thermostat controls for the mode
therm_mode_status_image	Returns the current image for the thermostat mode
timers	Returns all timers configured
to_time	Returns the TIME portion of a DateTime variable
total_log_entries	Return the total number of log entries
trig_if_edit	return True if a specific event trigger is in EDIT mode
trigger_build_ui	Return the UI HTML for a trigger, used by plugins UI for standard triggers is built on the actual HTML page event.html
trigger_device_ref	Returns True if the given device ref is a trigger for the given event and trigger If the given device ref is the root device for the actual trigger device, it still returns True.
trigger_list	Returns the full list of available event triggers for the given event, index, and group
updater_get_packages	Returns the list of plugin packages available Does not download the updates file, call plugins_installed first to download the package list and parse
use_location2	Return True if location 2 should be used. If false, location 2 is not used and should not be displayed
user_has_access	Return "checked" if the given user has access to the given ref ID
users_list

Fields

Name	Description
checkedDevices	array of device refs of devices that are checked on bulk_edit page
CONST_LOG_PAGE_SIZE
current_session
SessionsList

Properties

Methods

Fields

See Also