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 |
Returns True if the devices view is in List view | |
Used to hold JUI HTML information for use in the plugin wrapper HTML page | |
For JUI plugin pages, this holds the ID of the plugin | |
Holds the queries from the last request. Can be used to see if any queries were added to the URL | |
Holds the reference ID of a device if selected, or an event if selected | |
Returns the last tab that was selected in Setup | |
Returns the system type which is one of the following HS4STANDARD HS4PRO HS4ZEES2 | |
The currently selected tab on the timers/counters page Either "timers" or "counters" | |
Returns the user currently logged into the page | |
Returns the user agent of the browser that issued the request |
Methods
Name | Description |
Returns a formatted HTML action Used only by plugins, standard actions are formatted in event.html | |
Returns a list of all available event actions | |
Returns TRUE if an action is currently being edited, else false if not | |
Queue a device that has changed Used by devices page to update devices that have changed Called internally only | |
Returns a list of all categories configured in the system | |
Returns "checked" if ALL devices are checked on the bulk devices page | |
On bulk devices page returns True if given device is checked | |
Return the name of the camera given a camera name | |
Return list of cameras installed in the system, of type "cam" | |
Return a list of cameras | |
Returns a list of all categories configured for a specific device | |
Return all available category icons Category icons live in html/images/Categories | |
Returns a list of child device for the given root device reference number | |
Return a list all the .HSD HS config files in the Data folder | |
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 | |
Returns the second row of controls for a device | |
Returns a list of all configured counters | |
Return the currently select HSD config file | |
Returns the current date/time in short format Used by log.html | |
Returns the current date and time | |
Given a ref ID return a single device from the _devices list | |
Return the total number of devices configured in the system Includes child devices | |
Returns a list of pages registered as device inclusion pages | |
Returns "checked" if the requested bit in the device MISC property is checked | |
Gets the full name of a device including location2, location1, and the name | |
Calls a property on the device class | |
Return a list of "tabitem", one tab for each tab that is displayed in the device properties | |
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 | |
When called forces a download of the updates control file | |
Return all energy devices | |
Return 0 if Y axis is Usage or 1 if Cost Graph.YAxis holds the setting | |
Return all energy graph types | |
Return the current energy statistics | |
Returns the number of event groups in an event. An event group is a group of triggers under an "IF" or "OR IF". | |
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. | |
Return an event of type EventClass | |
Return the description for the given event action | |
Return an array of event actions of type EvAct_Base | |
Return the description for the given event trigger | |
Return an array of event triggers of type EvTrig_Base | |
Return a list of groups of type "evgroupitem" | |
Returns True if featured plugins are available | |
Convert a date to string in a format used with event last run | |
Returns a list of all the geo locations configured in the locations.csv file | |
Return list of all categories as class "category" | |
Returns the boolean setting of a specific system setting | |
Returns the string setting of a specific system setting | |
Returns the string setting of a specific setting that exists in a specific INI file | |
Returns a fully formatted checkbox setting Used mainly as a shortcut on the setup.html page | |
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 | |
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. | |
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. | |
Returns a list of installed plugins | |
Returns true if the given event action is for a JUI based plugin, else false if for an HS3 based plugin | |
Returns true if the given event trigger is for a JUI based plugin, else false if for an HS3 based plugin | |
Returns the device last change time | |
Returns the latest energy graph image file | |
Returns a string that describes license info for the system such as license ID | |
Returns the name assigned to location 1 | |
Return True if location 1 should be displayed first | |
Returns the name assigned to location 2 | |
Returns a string array of all locations (location 1) | |
Returns a string array of all locations (location 2) | |
Returns a list of all log colors configured | |
Return the date/time of the end of the log | |
Return an array of lenty objects that represent each log entry The range returned starts with the log_start and log_end date/time | |
Return the currently active search phrase that the log is filtering with | |
Return the date of the start of the log | |
Return the time of the start of the log | |
Return the currently selecte log type | |
Return a list of all available log types | |
Return the selected end date to end displaying log data | |
Return selected date to start displaying log data | |
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 | |
Returns a page to the HomeSeer logo image | |
Returns a list of all available plugins | |
Calls a function in a given plugin and returns the result | |
Return the plugins that are loaded in the system, in the list format for the Nav Bar plugins menu | |
Access a property in a plugin | |
Sets a property on a plugin | |
Returns True if a plugin search string is populated | |
Return list of installed plugins and info such as new version | |
Returns a list of all root devices Used by event.html | |
For the devices view, returns all the categories selected | |
For the devices view, returns all the filter tags selected | |
For the devices view, returns all the locations selected (location 1) | |
For the devices view, returns all the locations selected (location 2) | |
Return the currently selected list of tags for searching for a plugin Used by the plugins.html page | |
Returns a list of all available setup tabs | |
Return a list of strings, one entry for each speaker client that is currently connected | |
Return the full img tag of the device status image | |
Return the file path of the device status image | |
Return the current device status text | |
Returns the full sub trigger list for the given event ref, index, a and group Only some triggers have a sub trigger list | |
Returns the thermostat controls for the cool setpoint | |
Returns the thermostat controls for the heat setpoint | |
Returns the thermostat current temperature | |
Return the thermostat controls for the fan | |
Returns the current image for the thermostat fan | |
Returns the thermostat controls for the mode | |
Returns the current image for the thermostat mode | |
Returns all timers configured | |
Returns the TIME portion of a DateTime variable | |
Return the total number of log entries | |
return True if a specific event trigger is in EDIT mode | |
Return the UI HTML for a trigger, used by plugins UI for standard triggers is built on the actual HTML page event.html | |
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. | |
Returns the full list of available event triggers for the given event, index, and group | |
Returns the list of plugin packages available Does not download the updates file, call plugins_installed first to download the package list and parse | |
Return True if location 2 should be used. If false, location 2 is not used and should not be displayed | |
Return "checked" if the given user has access to the given ref ID | |
Fields
Name | Description |
array of device refs of devices that are checked on bulk_edit page | |