Skip to main content
Products
Auto
Light
Dark
Main navigation
Products
Auto
Light
Dark
Close navigation
Main
Main
Hubs
HomeTroller Pi
HomeTroller Pi G8 Quick Start Guide
HomeTroller Pi G8 Migration Guide
Upgrading HomeTroller Pi G3 to 800 Series Z-Wave
Upgrading HomeTroller Pi G3 Image
Legacy Hubs
HomeTroller Pro
Quick Start Guide for HomeTroller PRO
Enable Windows Updates on HomeTroller PRO
Updating your HomeTroller PRO and Setting the Time Zone
Replace CMOS Battery in the HomeTroller PRO
HomeTroller Plus
Quick Start Guide for HomeTroller Plus
Enable Windows Updates on HomeTroller Plus
Nortek Stick Driver Installation
Remote Desktop Connection on LAN
Updating your HomeTroller Plus and Setting the Time Zone
HomeTroller S6 PRO
S6 Hardware Setup
Using VNC for Local or Remote Access
Updating your HomeTroller S6 and Setting the Time Zone
HomeTroller SEL
SEL Hardware Setup
Mono 3.2.8 on SEL
Update SEL to Mono 5
Factory Reset
Power Adapter
Configuring SEL Wi-Fi
HomeTroller Zee S2
Change Volume Output
Configuring Zee S2 WiFi
How To Display 24 Hour Time
Recovery (911) is Not Working
Registering Zee S2
Set System Password
Setting Time Zone
Update Zee S2 to Mono 5 Manually
Updating Your Zee S2 or SEL
Zee S2 Hardware Setup
Zee S2 System Restore and Resetting the Network
Software
HS4 Smart Home Software
Trialing HS4
Getting Started
Initial Setup
Updating HS4
Registering HS4
Web Server Startup Problems
Unable to Access System After Registration
Quick Start Guide for HS4
Upgrading from HS3
Windows and HomeTroller S6 Upgrade
HomeTroller SEL Upgrade
HomeTroller Zee S2 Upgrade
Linux Upgrade
Auto Start HS4 on Windows
Managing MyHS Account
Running HS4 as a Service on Windows
Core Features
HS4 Plugins
HS4 Plugin Compatibility
Installing Plugins
Updating Plugins
HS4 Devices
What is a Device?
Device Grid & List Views
HS4 Device Filters
Device Settings
Bulk Editing Devices
Working With Virtual Devices
HS4 Events
What is an Event?
Triggers
The Time is...
A Device's Value Is...
A Recurring Trigger Happens
A Counter's Value is...
A Timer's Value is...
A Phrase Was Recognized
A Received EMail...
This Event is Manually Triggered
A New Notification is Available
Conditions
The Time is....
The Date or Day is...
A Device's Value is....
A Counter's Value is....
A Timer's Value is....
The Moon's phase is...
The Group Conditions Are...
Actions
Create Notification
Control A Device
Control A Timer
Control A Counter
Speak Something
Play an Audio File
Send an Email or Text Message
Wait
Run Another Event
Run a Script or Script Command
Run Commands from a Received Email
Run Another Program or Process
Run The Event Group Actions
Cancel Another Running Event
Cancel a Delayed Device Action
Cancel a Delayed Event
Change the System's Audio Output
Record From a Camera
HSTouch Actions
End This Event
Event Examples
Time Triggered Events
Device Triggered Events
Recurring Trigger Events
Timer & Counter Triggered Events
Using Group Conditions
Using Group Actions
HS4 Cameras
Live View
Recordings
HS4 Setup
General
Users
User Permissions
Categories
Network
E-Mail
Configuring Gmail with Less Secure App Access
Camera Settings
Voice
Custom
Using the HomeSeer Web Hook feature
Labs
HS4 Tools
Energy
Using the Energy Monitoring
Timers/Counters
Timers
Help
Log
Script Commands
Backup/Restore
How to Automatically Backup HS4 Locally
Setting Up and Managing Cloud Backups-
How to Restore a Backup
How to Manually Backup HS4 Locally
HS4 Notifications
HS4 Dashboards
Overview
Dashboard Layouts
Dashboard Settings
Editing Cards
Using Bulk Edit
Custom Cards
Developing Custom Cards for Dashboards
User Contributed Cards
Adding Cards to a Dashboard
Custom Card - Multi Feature
Custom Card - 5 Day Forecast
Custom Card - Gauge
Custom Card - Buttons
Custom Card - Device Status Icon
Custom Card - Status Text
Custom Card - Notifications
Scripting
About Scripts
Creating a Script
Debugging Scripts
Executing Single Script Statements
VB.NET Scripts and NameSpaces
CSharp Scripting
Common Scripting Questions
Applications and Plugins
System Information
DebugMode
AppStarting
GetAppPath
InterfaceVersion
IsLicensed
ShuttingDown
SystemUptime
SystemUpTimeTS
Version
System Functions
BackupDB
PowerFailRecovery
ScheduleFile
Shutdown
System
INI File Editing
ClearINISection
GetINISection
GetINISectionEx
GetINISetting
SaveINISetting
Plugins (Scripting)
GetHSPRef
GetPluginsList
PluginFunction
PluginPropertyGet
PluginPropertySet
RegisterLinkEx
Logging (Scripting)
GetLog
GetLog_FullFilter
GetLog_Date
GetLog_Date_Text
GetLog_Date_Priority
GetLog_Date_ErrorCode
LogEntry Structure
ClearLog
LogGet
NoLog
WriteLog
WriteLogEx
WriteLogDetail
Web Pages (Scripting)
Callbacks
RegisterStatusChangeCB
UnRegisterStatusChangeCB
ReplaceVariables
Using Replacement Variables
Computer
Serial Port Communication
OpenComPort
OpenComPortTerm
OpenComPortEx
SetComPortRTSDTR
SendToComPort
GetComPortCount
GetComPortData
CloseComPort
Network Information
LANIP
GetIPAddress
GetLastRemoteIP
Ping
WANIP
GetOSVersion
Keys
RecurseFiles
RecurseFilesEX
RestartSystem
UnZip
Zip
Devices (Scripting)
The Device Class
dvMISC
eRelationship
DeviceScriptChange
Device Value Status Pairs
VSPair
VSVGPairType
ePairStatusControl
ePairControlUse
CAPIControlButtonImage
DeviceVSP Methods
DevicesVSP_AddPair
DeviceVSP_ChangePair
DeviceVSP_CountAll
DeviceVSP_CountStatus
DeviceVSP_CountControl
DeviceVSP_ClearAll
DeviceVSP_ClearAny
DeviceVSP_ClearStatus
DeviceVSP_ClearControl
DeviceVSP_ClearBoth
DeviceVSP_Get
DeviceVSP_GetStatus
DeviceVSP_GetAllStatus
DeviceVSP_PairsProtected
Device Value Graphic Pairs
VGPair
VSVGPairType.
DeviceVGP Methods
DeviceVGP_AddPair
DeviceVGP_Count
DeviceVGP_ClearAll
DeviceVGP_Clear
DeviceVGP_Get
DeviceVGP_GetGraphic
DeviceVGP_PairsProtected
Device Type
DeviceTypeInfo Object
Device_API
eDeviceAPI
Device_Type
eDeviceType_GenericRoot
eDeviceType_Media
eDeviceType_Plugin
eDeviceType_Script
eDeviceType_Security
eDeviceType_SourceSwitch
eDeviceType_Thermostat
Device_Type_Description (Read Only)
Device_SubType
eDeviceSubType_SecurityArea
eDeviceSubType_Setpoint
eDeviceSubType_Temperature
Device_Type_String
Device Exists, Reference, Address and/or Code
DeviceExistsRef
DeviceExistsAdress
DeviceExistsAddressFull
DeviceExistsCode
GetDeviceRef
Email (Scripting)
MailMsgCount
MailDate
MailDelete
MailForm
MailFromDisplay
MailSubject
MailText
MailTo
MailToDisplay
MailTrigger
SendEmail
Events (Scripting)
Get Information
Event_Info_Group
EventCount (Event_Info_Group)
EventExists (Event_Info_Group)
GetLastEvent (Event_Info_Group)
EventCount
EventExists
GetLastEvent
Event_Group_Info_All
strEventGroupData (All)
Event_Group_Info
strEventGroupData
Event_Info_All
strEventData (All)
strEventTriggerGroupData (All)
Event_Info
strEventData
strEventTriggerGroupData
Get Event References
GetEventRefByName
GetEventRefByNameAndGroup
Modify Automatic Triggering
EnableEvent
EnableEventByRef
DisableEvent
DisableEventByRef
Getting Help
HS4 Software FAQ
HS4 Release Notes & Downloads
HS4 Release 4.2.23.0
HS4-Pi Release 4.x Software Image
Previous Releases
HS4 Beta Release 4.2.22.108
HS4 Release 4.2.22.4
HS4 Release 4.2.22.0
HS4 Beta Release 4.2.21.31
HS4 Release 4.2.21.2
HS4 Beta Release 4.2.21.15
HS4 Release 4.2.21.0
HS4 Beta Release 4.2.20.13
HS4 Release 4.2.20.0
HS4 Beta Release 4.2.18.29
HS4 Release 4.2.18.5
HS4 Release 4.2.18.3
HS4 Release 4.2.18.0
HS4 Beta Release 4.2.17.4
HS4 Release 4.2.17.0
HS4 Release 4.2.16.0
HS4 Release 4.2.15.0
HS4 Release 4.2.14.0
HS4 Release 4.2.13.0
HS4 Release 4.2.12.0
HS4 Beta 4.2.11.3
HS4 Release 4.2.11.0
HS4 Beta 4.2.9.0
HS4 Release 4.2.7.0
HS4 Release 4.2.6.0
HS4 Release 4.2.5.0
HS4 Beta 4.2.4.0
HS4 Release 4.1.9.0
HS4 Release 4.2.8.0
HS4 Beta 4.2.2.0
HS4 Beta 4.2.1.0
HS4 Beta 4.2.0.8
HS4 Beta 4.2.0.5
HS4 Release 4.2.0.0
HS4 Release 4.1.8.0
HS4 Release 4.1.6.0
HS4 Release 4.1.5.0
HS4 Release 4.1.4.0
HS4 Release 4.1.3.0
HS4 Release 4.1.2.0
HS4 Release 4.1.1.0
HS4 Release 4.1.18.0
HS4 Release 4.1.17.0
HS4 Beta 4.1.101.0 (4.2 Release Candidate)
HS4 Beta 4.1.100.0 (Beta 4.2)
HS4 Release 4.1.7.0
HS4 Release 4.1.16.0
HS4 Release 4.1.15.0
HS4 Release 4.1.14.0
HS4 Release 4.1.13.0
HS4 Release 4.1.12.0
HS4 Release 4.1.11.0
HS4 Release 4.1.10.0
HS4 RC3 4.0.10.0
HS4 RC2 4.0.9.0
HS4 RC1 4.0.8.0
HS4 4.0.7.0
HS4 4.0.6.0
HS4 4.0.5.0
HS4 4.0.4.0
HS4 4.0.3.0
HS4 4.0.1.37
HS4 4.0.1.30
HS4 4.0.1.28
HS4 4.0.1.23
HS4 4.0.0.52
HS4.0.0.44
HS4.0.0.30
HS4.0.0.29
HS4.0.0.27
HS4.0.0.24
HS4.0.0.22
HS4 Beta Release 4.2.19.31
HS4 Beta Release 4.2.19.25
HS4 Beta Release 4.2.19.17
HS4 Release 4.2.19.5
HS4 Release 4.2.19.0
How-to articles
HomeSeer HS4-Pi Install Guide
Installing HS4 on Linux
How-to Autologin a Windows User
How To Enable Alexa TTS Announcements for HomeSeer Devices
Setting up Node-Red for use with HS4
Plugins
August Home
Setting Up the August Home Plugin
Chromecast
Setting Up the Chromecast Plugin
Ecobee
Setting Up the Ecobee Plugin
Harmony Hub
Setting Up the Harmony Hub Plugin
LIFX
Setting Up the LIFX Plugin
Matter
Setting up the Matter Plugin
MyQ
Setting Up the MyQ Plugin
Nest
Setting Up the Nest Plugin
ONVIF Events
Setting Up the ONVIF Events Plugin
Philips Hue
Setting Up the Philips HUE Plugin
Rachio
Setting Up the Rachio Plugin
ESPHome
Setting Up the ESPHome Plugin
RoomMe
Setting Up the RoomMe Plugin
SmartThings
Setting up the SmartThings Plugin
Tuya
Setting Up the Tuya Plugin
Enabling Local Control for your Tuya Devices
Wemo
Setting Up the Wemo Plugin
Zigbee Plus
Setting Up the Zigbee Plus Plugin
Zigbee2MQTT Back-End
Updating Zigbee2MQTT (Manually)
HomeTroller Pro Zigbee Plus Warning Fix
Z-Wave Plus
Setting Up the Z-Wave Plus Plugin
Z-Wave Plus Menu Options
Add Device
Remove Device
Manage Devices
Manage Networks
Device Diagnostics
Update Firmware
Advanced Functions
Migrating from Z-Wave to Z-Wave Plus
HomeSeer Mobile
General Information
First Time Setup
Connect via IP
FAQ
iOS Change Log
Auto Connect with Multiple Systems
App Navigation
Clean Uninstall
Change Systems
Android Change Log
Dashboard
Add a Dashboard
Delete a Dashboard
Delete a Widget
Edit Existing Widget
Moving a Widget
Resizing Widgets
Importing a Dashboard
Exporting a Dashboard
Devices
Controlling Devices
Add a Device to Dashboard
Device Filters
Thermostats
Events
Add an Event Widget to the Dashboard
Running an Event
Cameras
Add a Camera Widget to the Dashboard
IP Camera FAQ
HS4Touch
HS4Touch Quick Start Guide
HS4Touch Elements
HS4Touch Properties
HS4Touch Actions
Replacement Variables
Date & Time Variables
New Features Added to HS4Touch
HS4Touch Release Notes & Downloads
HS4Touch Client
HS4Touch Designer
Z-Flash
Z-Flash User Guide
Z-Flash Secondary Controller Method
Z-Flash Shared Network Method
Z-Flash Independent Network Method
Adding Firmware files
Firmware Included with Z-Flash
Z-Flash Release Notes & Downloads
Z-Flash Release 1.2.0.3
Z-Seer+
Z-Seer Overview
Z-Seer Installation
Connect Z-Seer to HomeSeer
Node Map Overview
Menu Bar Functions
Working with Z-Seer+
Z-Seer+ FAQ
Z-Seer+ Release Notes & Downloads
Z-Seer+ Release 3.0.0.42
Z-Tool+
System Selection
Adding/Removing Devices
Naming Your Devices
Advanced Features
Z-Tool FAQ
Legacy Software
HS3Touch
HS3Touch Release Notes & Downloads
HS3Touch Designer
HS3Touch Android Client
How to Connect HSTouch Designer to HS
HSTouch Client Setup
Configure Weather for HSTouch
HS3
Changing Temperature Scale (HS3)
Changing the Default Username and Password (HS3)
How to Create a Full Backup (HS3)
How to Restore a Full Backup (HS3)
How to Create Email/Text Messages with HomeSeer Device Values (HS3)
Installing Plugins (HS3)
Schedule Door Lock User Codes (HS3)
Setting up non HomeSeer IP Cameras (HS3)
Using Event Engine (HS3)
HS3 Software FAQ
HS3 Legacy Help Files
Legacy Plugins
Installing a Legacy (HS3) Plugin
Updating a Legacy (HS3) Plugin
Zigbee
Zigbee Driver Setup
Zigbee Plugin and Device Setup
Z-Wave v4.0
Z-Wave Installation
Updating Z-Wave Plugin
Add Interface (Legacy)
Manage Interfaces (Legacy)
Add Device (Legacy)
Remove Device (Legacy)
Update Firmware (Legacy)
Device Diagnostics (Legacy)
Rescan
Remove Bad Node
Test Connectivity
Full Optimize
Advanced Functions (Legacy)
Add Unsecure
Node Test
Restart Interface
Backup Interface
Restore Interface From Backup
Reset Data
Manage Locks (Legacy)
Manage Associations (Legacy)
Device Information (Legacy)
Legacy Z-Wave v3.0
Importing Z-Wave Devices
Updating Z-Wave Plugin (HS3)
Adding a Z-Wave Controller
Displaying Status of Two Sensors with One Icon (HS3)
Adding and Removing Z-Wave Devices
Erasing a Z-Wave Controller
Settings
Interfaces
SmartStick
SmartStick G8 Quick Start Guide
SmartStick Firmware Updates
Z-Wave 700/800 Series Interface Issue
Z-Wave Series 500, 700 & 800 Comparison
SmartStick G8 Migrating from Another Controller
SmartStick ZB
SmartStick ZB Quick Start Guide
SmartStick ZB CH340 Driver Installation
Z-NET
Z-NET Quick Start Guide
Z-NET Integration with Home Assistant
Updating the Z-NET
Z-NET Firmware Updates
Upgrading Z-NET or Z-NET G3 to 800 Series Z-Wave
800 Upgrade Kit Spacer Installation
Z-NET G8 Migrating from Another Controller
Z-NET PRO
Z-NET PRO Quick Start Guide
Z-NET PRO Positioning Guide
Z-NET PRO Web UI & Settings
Z-NET PRO Hardware Features
Z-NET PRO IP Address Reservation Guide
Z-NET PRO Integration with HomeSeer
Z-NET PRO Integration with Home Assistant
Z-NET PRO Integration with openHAB
Z-NET PRO Integration with Zigbee2MQTT
Z-NET PRO Migrating from Another Controller
Z-NET PRO PoE Installation Guide
Migrating to 800 Series Controllers
800 Series Controller Migration Guide (SmartStick or Z-NET)
Converting Older Z-Wave Backups for Z-Wave Plus or Z-Wave JS Restore
Backup Z-Wave Interface
Restore Z-Wave Interface
Sonoff ZBDongle-E
Updating Firmware for Sonoff ZBDongle-E Zigbee USB Controller
Legacy Interfaces
SmartStick+ G3 Quick Start Guide
SmartStick+ G3 Driver Setup
Migrating from SmartStick G1 or G2 to SmartStick G3
Backup Current Z-Wave Network
Restore Z-Wave Network
Legacy Z-NET Interfaces
Remote Network Installation
Network Configuration
HS3 / Z-NET Configuration
Intro and Installation Considerations
Reset Network Settings
Network Wide Inclusion
Wall Mount Kits
SmartStick Wall Mount Kit Installation
Z-NET PRO Wall Mount Kit Installation
Lighting
WS300
WS300 Quick Start Guide
WS300 Wiring Guide
WS300 Features, Specs & Warranty
Legacy Lighting
HS-WX300
HS-WX300 R2 User Guide
WX300 Firmware Updates
HS-WX300 Triggers and Actions in Home Assistant
HS-WX300 vs HS-WD200+
HS-WX300 LED Bulb Considerations
HS-SP100
SP100 User Guide
HS-WD100+
100 Series Switch/Dimmer Installation
HS-FC200+
HS-WD200+
HS-WS200+
HS-WX300 R1 User Guide
Enabling Toggle Operation for a HomeSeer 100 or 200 Series Switch
Wall Switch Factory Reset
HS-WA100+
WA100 User Guide
Sensors
PS100 G8
PS100 Data Sheet
PS100 G8 User Guide
DS100 G8
DS100 G8 User Guide
DS150ZB
DS150ZB User Guide
LS100 G8
LS100 G8 User Guide
MS100 G8
MS100 G8 User Guide
HSM200
HSM200 User Guide
Configuring Device Settings on HSM200 (HS3)
Temperature Sensor Calibration (HS3)
Legacy Sensors
ADIO-100
Installation (ADIO-100)
Possible Uses (ADIO-100)
Terminal Strip Pinouts
HS-DS100+
HS-DS100+ User Guide
HS-FLS100+
HS-FLS100+ User Guide
HS-FLS100 Z-Wave Inclusion
HS-FS100
HS-FS100+ User Guide
HS-LS100+
HS-LS100+ User Guide
HS-LS100+ Sensor Z-Wave Installation
HS-MS100+
HS-MS100+ User Guide
Climate
Ecolink TBZ500 Association
Water Valves
HS-WV100+ User Guide
MyHS
Registering for a Free MyHS Account
Adding a System to a Free Account
Configuring a MyHS Premium Account
Updating the Primary System on Your MyHS Account
Adding Additional Systems to MyHS
Adding Users to MyHS
Setting Up & Managing Cloud Backups
Connecting with HS4Touch through MyHS
Custom MyHS Plans
Updating MyHS Subscription
Alexa & Google Integration
Alexa Smart Home Skill Integration
How to Enable Amazon Cloud Access for Devices or Features
How to Enable Amazon Cloud Access for Events
Alexa Home Automation Skill Integration
Using Alexa with Multiple HS Systems
Google Home Integration
How to Enable Google Cloud Access for Devices or Features
How to Enable Google Cloud Access for Events
How to Tell Which Devices or Features are Enabled for Voice
How to Determine Whether Devices or Features Should be Enabled for Voice
How to Change Voice Command Names
How to Change Voice Command Names for Events
Troubleshooting Google Home & Amazon Alexa
Return Policy
IP Cameras
HS-CAM-I
URL Settings for HS-CAM-I
HS-CAM-O
URL Settings for HS-CAM-O
Enabling Camera Auto-discovery
HomeSeer IP Camera Requirements
Reolink Video Doorbell
Plugin SDK
Other Docs
Terms and Definitions
HomeSeer Edge Driver for SmartThings
(snippet) Alternate Ways to Access HomeTroller Plus & PRO Hubs
(snippet) Adding Firewall Rules for Tuya Local Control
(snippet) Reverting Back to Previous HS4 Version
(snippet) Edge Driver Installation Procedure
G8 Migration Guide (SmartStick or Z-NET)
500 Series Upgrade Kit for Z-NET or HomeTroller
Extended Warranty Policy
Breadcrumbs
Home
Products
Software
HS4 Smart Home Software
Scripting
Applications and Plugins
On this Page
Web Pages (Scripting)
Information on scripting with HS web pages.
