Skip to main content
Plugin SDK
Auto
Light
Dark
Main navigation
Plugin SDK
Auto
Light
Dark
Close navigation
Main
Main
Using the SDK
Creating a Plugin
Install File Format
Plugin Packaging
Testing Installation
HS3 to HS4 API Reference
AbstractHsDevice Class (DeviceClass Class)
IPlugin Interface (IPluginAPI Interface)
StatusGraphic Class (VGPair Class)
StatusControl Class (VSPair Class)
Reading Legacy PlugExtraData
Reading Legacy Event Data
HSEvent Changes
Find.HomeSeer.com
Design Guidelines
Device Layouts
Control Grids
JUI
Views
Input Field
Label
Select List
Toggle
View Group
Pages
Settings Pages
Device Configuration Pages
Colors
Product Image Guidelines
Feature Pages
HTML Pages
HomeSeer HTML Tags
Top Level
Tags Properties
Tags Classes
child Class
child Constructor
child.child Properties
child.has_controls Property
child.name Property
child.name_short Property
child.ref Property
child.status Property
child.status_image Property
child.status_short Property
child.status_suffix Property
device Class
device Constructor
device.device Properties
device.child_count Property
device.children Property
device.device_type Property
device.location Property
device.location2 Property
device.name Property
device.primary_ref Property
device.ref Property
device.status Property
device.status_image Property
active_search_string Property
camera_id Property
camera_name Property
device_view_list Property
Initialized Property
log_auto_update Property
plugin_html Property
plugwrapper_pluginid Property
queries Property
refid Property
root_device_ref Property
selected_plugin_id Property
selected_plugin_search Property
selected_plugin_tab Property
setup_tab_selected_id Property
StartIndex Property
state Property
system_type Property
timers_counters_selected_tab Property
total_log_entries_last_div_update Property
user Property
user_agent Property
Tags Methods
action_build_ui Method
action_list Method
action_then_edit Method
AddDeviceToChangeQueue Method
allcategories Method
bulk_all_checked Method
bulk_device_checked Method
camera_id_to_name Method
camera_list Method
camera_snapshots Method
categories Method
category_icons Method
child_devices Method
configlist Method
controls1 Method
controls2 Method
counters Method
current_config Method
date_short_format Method
date_time Method
device_by_ref Method
device_count_unfiltered Method
device_inc_pages Method
device_misc Method
device_name_full Method
device_prop Method
device_tabs Method
devices Method
downloadv2_updates Method
end_index Method
energy_devices Method
energy_graph_usage_cost Method
energy_graphs Method
energy_stats Method
ev_trig_group_count Method
ev_trigs_in_group Method
event Method
event_action_format Method
event_actions Method
event_trigger_format Method
event_triggers Method
events Method
featured_available Method
format_date Method
geolocations Method
get_categories_details Method
get_setting_bool Method
get_setting_text Method
get_setting_text_w_file Method
hs_checkbox_setting Method
includefile Method
includefile_if_hsmobile Method
includefile_not_hsmobile Method
Init Method
installed_plugin_details Method
is_act_jui_plugin Method
is_trig_jui_plugin Method
last_change Method
latest_energy_graph Method
licenseinfo Method
location_name Method
location1_display_first Method
location2_name Method
locations Method
locations2 Method
log_colors_list Method
log_end Method
log_page Method
log_search_phrase Method
log_start Method
log_start_time Method
log_type_selected Method
log_types Method
max_log_date Method
min_log_date Method
NewSession Method
page_logo Method
plugin_details Method
plugin_function Method
plugin_menu_items Method
plugin_property_get Method
plugin_property_set Method
plugin_search_active Method
plugins_installed Method
root_devices_by_location Method
selected_category Method
selected_filter Method
selected_location Method
selected_location2 Method
selected_plugin_list Method
setup_tabs Method
speaker_client_list Method
start_index Method
status_image Method
status_image_file Method
status_text Method
sub_trigger_list Method
therm_current_cool_set Method
therm_current_heat_set Method
therm_current_temp Method
therm_fan_controls Method
therm_fan_status_image Method
therm_mode_controls Method
therm_mode_status_image Method
timers Method
to_time Method
total_log_entries Method
trig_if_edit Method
trigger_build_ui Method
trigger_device_ref Method
trigger_list Method
updater_get_packages Method
use_location2 Method
user_has_access Method
users_list Method
functions Fields
checkedDevices Field
CONST_LOG_PAGE_SIZE Field
current_session Field
SessionsList Field
cam Class
cam Constructor
cam.cam Fields
cam.camurl Field
cam.ip Field
cam.ismanual Field
cam.mac Field
cam.model Field
cam.name Field
cam.namehex Field
cam.pan_down_start Field
cam.pan_down_stop Field
cam.pan_left_start Field
cam.pan_left_stop Field
cam.pan_right_start Field
cam.pan_right_stop Field
cam.pan_up_start Field
cam.pan_up_stop Field
cam.pass Field
cam.stream Field
cam.supports_pantilt Field
cam.user Field
cam_item Class
cam_item Constructor
cam_item.cam_item Fields
cam_item.id Field
cam_item.name Field
clsuser Class
clsuser Constructor
clsuser.clsuser Properties
clsuser.counters_access Property
clsuser.event_access Property
clsuser.index Property
clsuser.isadmin Property
clsuser.isguest Property
clsuser.isnormal Property
clsuser.log_access Property
clsuser.name Property
clsuser.pass Property
clsuser.use_local Property
counter_item Class
counter_item Constructor
counter_item.counter_item Fields
counter_item.countername Field
counter_item.id Field
counter_item.value Field
estats Class
estats Constructor
estats.estats Fields
estats.current Field
estats.last_hour Field
estats.this_month Field
estats.this_month_projected Field
estats.today Field
estats.today_projected Field
evgroupitem Class
evgroupitem Constructor
evgroupitem.evgroupitem Fields
evgroupitem.events Field
evgroupitem.id Field
evgroupitem.name Field
lentry Class
lentry Constructor
lentry.lentry Fields
lentry.lstyle Field
lentry.lstyle_is_class Field
lentry.lstyle_is_color Field
lentry.ltext Field
lentry.ltime Field
lentry.ltype Field
logcolor Class
logcolor Constructor
logcolor.logcolor Fields
logcolor.color_hex Field
logcolor.key Field
logcolor.keyword Field
NameValue Structure
NameValue.NameValue Fields
NameValue.Name Field
NameValue.Selected Field
NameValue.Value Field
plug_item Class
plug_item Constructor
plug_item.plug_item Properties
plug_item.HasCOMPort Property
plug_item.icon Property
plug_item.id Property
plug_item.Included Property
plug_item.License Property
plug_item.Loaded Property
plug_item.LoadedRemotely Property
plug_item.Name Property
plug_item.Status Property
plug_item.UpdateAvailable Property
plug_item.Version Property
plug_item.VersionAvailable Property
SessionItem Class
SessionItem Constructor
SessionItem.SessionItem Properties
SessionItem.selected_category Property
SessionItem.selected_filter Property
SessionItem.selected_location Property
SessionItem.selected_location2 Property
SessionItem.SessionItem Fields
SessionItem.ChangeQueue Field
SessionItem.Devices Field
SessionItem.LastAccessed Field
SessionItem.SortDevices Field
tabitem Class
tabitem Constructor
tabitem.tabitem Fields
tabitem.id Field
tabitem.is_plugin_tab Field
tabitem.name Field
tabitem.plugin_html Field
tabitem.selected Field
timer_item Class
timer_item Constructor
timer_item.timer_item Fields
timer_item.elapsed Field
timer_item.id Field
timer_item.running Field
timer_item.timername Field
Process Steppers
Sample Plugins
Release Notes
HS4 Z-Wave Plugin Release Notes
HS4ZWAVE 4.1.0.3 Beta
HS4ZWAVE 4.1.0.2 Beta
HS4ZWAVE 4.0.3.0
Old
HS4ZWAVE 4.0.1.0 Beta
HS4ZWAVE 4.0.2.0 Beta
HS3 Z-Wave Plugin Release Notes
HS3ZWAVE CORE 3.0.11.0
HS3 Z-Wave Archive
HS3ZWAVE 3.0.2.4 (Beta)
HS3ZWAVE 3.0.9.0
HS3ZWAVE 3.0.2.1
Plugin Portal
Submitting and Updating Plugins
Plugin Release Notes
HS4 Plugins
Tags, Plugin Summary
Beta Plugin Updates
Cloning HS3 Plugins to HS4
Using the Stats Page
Navigating the Portal
Plugin Information
Changing Plugin Names
Becoming a Developer
Offering Upgrades
JSON API
Getting Started
controldevicebycontroluse
controldevicebylabel
controldevicebyindex
controldevicebyvalue
getcameras
getcamerasnapshot
getcategories
getcontrol
getcontrol2
getcounter
getdeviceinfo
getdeviceschanged
getevents
getimage
getlocations
getsessionconfig
getsetting
getstatus
getsystems
hsversion
pancamera
pluginfunction
pluginlist
pluginversion
register
removecamera
runevent
setdeviceproperty
setdevicestatus
speak
updateplugin
voicecommand
Breadcrumbs
Home
Plugin SDK
JSON API
On this Page
getcontrol2
Same as getcontrol but always returns a a control array even if no controls exist
