Welcome to the BLSecurity Plug-In for HomeSeer


Top     Overview     Options     Maintain Devices/Zones     Maintain Users     Reports     HomeSeer Triggers and Actions     Scripting Methods     Support     Bottom

Overview

The BLSecurity Plugin for Homeseer allows the user to use security devices and motion sensors for security purposes.

There is a web interface with this plugin that can be accessed through the HomeSeer Web Server.

NOTE:
The user can specify to be warned if any DS10A devices are in alert status when arming the system.
When arming the system and any DS10A security devices are in alert status (meaning that they are open), the system will wait until all devices are returned to normal status OR the user executes the arming function again. If the user chooses to execute the arming function again, then all devices that are in alert will be temporarily ignored. The user can also specify a timeout (configurable in the options page) that will cause the system to return to disarmed if nothing is done within the timeout limit.

BLRadar Import:
Under the Tools web page, the user can choose to import all motion sensors from the BLRadar Plug-In. This will save the user some time in manually adding the devices. The import option will not show if the BLRadar Plug-In is not installed or enabled.



Options

This is the Options web page where various configuration settings can be modified.





Maintain Devices/Zones

This is where the devices/zones configured in the plug-in can be maintained.





Maintain Users

This is where the users configured in the plug-in can be maintained.

NOTE:  If you add a user with an alarm code then you will be required to provide the alarm code when arming, disarming and resetting the system using the Alarm Panel interface web page.





Reports

The reports web page is where specific reports can be executed.





HomeSeer Triggers and Actions

The BLSecurity Plug-In For HomeSeer provides many triggers and actions which can be used in your HomeSeer events.

BLSecurity Triggers

  1. Security Mode Changed to ARMED
  2. Security Mode Changed to PERIMETER
  3. Security Mode Changed to SLEEP
  4. Security Mode Changed to DISARMED
  5. Alert Status Reset
  6. Security Alert Triggered
  7. Security Device in Alert When Arming
  8. Security Device in Communication Error When Arming

BLSecurity Actions

  1. Set Security Mode to ARMED
  2. Set Security Mode to PERIMETER
  3. Set Security Mode to SLEEP
  4. Set Security Mode to DISARMED
  5. Reset Alert Status



Scripting Methods

Here is a list of the scripting methods that can be utilized with this plug-in.

SetSecurityModeArmed Method

Parameter Type Description
forceMode Boolean True or false to force the mode. This is optional.

Return Values Type Description
None

Description

This method sets the security mode to ARMED mode.

VB.Net Scripting Example

hs.PluginFunction("BLSecurity", "", "SetSecurityModeArmed", new Object(){False})


SetSecurityModePerimeter Method

Parameter Type Description
forceMode Boolean True or false to force the mode. This is optional.

Return Values Type Description
None

Description

This method sets the security mode to PERIMETER mode.

VB.Net Scripting Example

hs.PluginFunction("BLSecurity", "", "SetSecurityModePerimeter", new Object(){False})


SetSecurityModeSleep Method

Parameter Type Description
forceMode Boolean True or false to force the mode. This is optional.

Return Values Type Description
None

Description

This method sets the security mode to SLEEP mode.

VB.Net Scripting Example

hs.PluginFunction("BLSecurity", "", "SetSecurityModeSleep", new Object(){False})


SetSecurityModeDisarmed Method

Parameter Type Description
None

Return Values Type Description
None

Description

This method sets the security mode to DISARMED mode.

VB.Net Scripting Example

hs.PluginFunction("BLSecurity", "", "SetSecurityModeDisarmed", Nothing)


ResetAlertStatus Method

Parameter Type Description
manualReset Boolean True or false whether it is a manual reset. This is optional.

Return Values Type Description
None

Description

This method resets the alert status to NORMAL.

VB.Net Scripting Example

hs.PluginFunction("BLSecurity", "", "ResetAlertStatus", new Object(){True})


GetSecurityDevicesInAlert Method

Parameter Type Description
None

Return Values Type Description
Device Array Device String Array Returns a string array of devices.

Description

This method returns a Device string array of devices in alert.

VB.Net Scripting Example

For Each d As String In hs.PluginFunction("BLSecurity", "", "GetSecurityDevicesInAlert", Nothing)
    hs.writelog("Info", "Device: " & d & " is a device in alert!")
Next


GetSecurityDevicesInError Method

Parameter Type Description
None

Return Values Type Description
Device Array Device String Array Returns a string array of devices.

Description

This method returns a Device string array of devices in communication error.

VB.Net Scripting Example

For Each d As String In hs.PluginFunction("BLSecurity", "", "GetSecurityDevicesInError", Nothing)
    hs.writelog("Info", "Device: " & d & " is a device in communication error!")
Next


GetMotionDevicesInAlert Method

Parameter Type Description
None

Return Values Type Description
Device Array Device String Array Returns a string array of devices.

Description

This method returns a Device string array of motion devices in alert.

VB.Net Scripting Example

For Each d As String In hs.PluginFunction("BLSecurity", "", "GetMotionDevicesInAlert", Nothing)
    hs.writelog("Info", "Device: " & d & " is a device in alert!")
Next


GetAllDevicesInAlert Method

Parameter Type Description
None

Return Values Type Description
Device Array Device String Array Returns a string array of devices.

Description

This method returns a Device string array of all devices in alert.

VB.Net Scripting Example

For Each d As String In hs.PluginFunction("BLSecurity", "", "GetAllDevicesInAlert", Nothing)
    hs.writelog("Info", "Device: " & d & " is a device in alert!")
Next


GetCurrentUser Method

Parameter Type Description
None

Return Values Type Description
CurrentUser String The current user.

Description

This method returns the current user who has armed or disarmed the system.

VB.Net Scripting Example

Dim currentUser As String = hs.PluginFunction("BLSecurity", "", "GetCurrentUser", Nothing)
hs.writelog("Info", "The current user is: " & currentUser)




Support

For support, please use the Message Board


Top     Overview     Options     Maintain Devices/Zones     Maintain Users     Reports     HomeSeer Triggers and Actions     Scripting Methods     Support     Bottom

BLSecurity Plug-in for HomeSeer
(c) 2004 by Bob Maslen