No announcement yet.

EnvisaLink DSC Plug-in - HS3 User Guide

This topic is closed.
This is a sticky topic.
  • Filter
  • Time
  • Show
Clear All
new posts

    EnvisaLink DSC Plug-in - HS3 User Guide


    System Requirements:

    The EnvisaLink DSC Plug-in is designed to control your DSC Security System using the EnvisaLink interface: Both EVL3 and EVL4 are supported.
    This plugin is for HS3/HS3PRO. It works with both Windows and Linux versions. For HS2/HS2PRO version click here

    Plugin Installation:
    Download and install from the updater (Security plug-ins section) or download package from the Beta Testing thread and follow instructions to install.

    Plugin Configuration
    - Start the plugin from the "PLUG-INS > Manage" page
    - Go to the config page "PLUG-INS > EnvisaLink > Config"

    Click image for larger version

Name:	config.png
Views:	2
Size:	58.8 KB
ID:	1211242

    Chosse your Inteface Type (EVL3 or EVL4), set the IP Address of your EnvisaLink interface as well as the Password which is the same password than the one used to log into the Envisalink's local web page. It's 6 characters max for EVL3, and 10 characters max for EVL4, and the default one is "user".

    Set your number of partitions and zones and your panel's master code.

    By default the plug-in will recreate any missing zone devices when it starts, if there are some zones you are not using at all you can manually delete the corresponding devices and then tick the "Do not recreate missing devices" checkbox, this will prevent them to be recreated.

    If you have an EVL4 or EVL3 with firmware 1.12.182 or later, you can get additional devices to know the bypassed status of ech zone (Bypassed or Active). If you don't care about this information, simply untick the "Create additional devices for zone bypassed status" checkbox.

    In the Zones section, you can rename and change the type of each zone. When "Update zone devices" is clicked all zone devices will be renamed accordingly and status text and icons corresponding to their types will be assigned.

    Optionnally, in the User Settings section, assign one or several DSC User Ids to HS users. To create new HS users go to "Tools > Setup > Network tab". To assign more than one DSC User Ids to one HS User, separate the ids with dashes.

    If you tick the "Log to File" checkbox, logs will be written to Logs/EnvisaLink.txt, and you will be able to choose a specific log level for the file. The first "Log Level" setting is for the logs written to the HS logs database. To troubleshoot any problem I would recommend to set at least one of these log level to Debug to be able to see all the messages sent by the panel.
    Last edited by spud; July 17, 2017, 08:01 AM.


    If everything is ok, the plug-in will create one root device, one "User Access" device, one device per partition and two devices per zone. Then the plugin will connect to your EnvisaLink interface and start listening for messages from your panel, and update your devices status accordingly.

    Click image for larger version

Name:	deviceswithbypass.png
Views:	2
Size:	136.0 KB
ID:	1191598

    Event Actions:
    You can configure Event to perform some actions on your security panel.
    Here is the current list of possible actions:
    • "Partition Arm"
    • "Partition Arm - Away"
    • "Partition Arm - Stay"
    • "Partition Arm - Zero Entry Delay"
    • "Partition Disarm"
    • "Trigger Panic Alarm - Fire"
    • "Trigger Panic Alarm - Ambulance"
    • "Trigger Panic Alarm - Police"
    • "Sync Alarm Time"
    • "Trigger PGM Output"
    • "Send Keystroke String"
    • "Enable Log For Device Status Change"
    • "Disable Log For Device Status Change"

    The "Send Keystroke String" action can use a replacement variable as parameter. For example here is an event that Disarm the panel wih a specific code stored in a global variable:

    Click image for larger version

Name:	keystroke_withe_globalvar.png
Views:	1
Size:	18.5 KB
ID:	1190512

    Event Triggers:
    This plugin can trigger events based on changes in the Security panel. Basically there is one trigger type for each message type the panel send to the plugin. Here is the current list:

    • "Command Acknowledge"
    • "Command Error"
    • "System Error"
    • "Ring Detected"
    • "Zone Alarm"
    • "Zone Alarm Restore"
    • "Zone Tamper"
    • "Zone Tamper Restore"
    • "Zone Fault"
    • "Zone Fault Restore"
    • "Zone Open"
    • "Zone Restored"
    • "Duress Alarm"
    • "[F] Key Alarm"
    • "[F] Key Restore"
    • "[A] Key Alarm"
    • "[A] Key Restore"
    • "[P] Key Alarm"
    • "[P] Key Restore"
    • "2-Wire Smoke/Aux Alarm"
    • "2-Wire Smoke/Aux Restore"
    • "Partition Ready"
    • "Partition Not Ready"
    • "Partition Armed"
    • "Partition Ready - Force Arming Enabled"
    • "Partition In Alarm"
    • "Partition Disarmed"
    • "Exit Delay in Progress"
    • "Entry Delay in Progress"
    • "Keypad Lock-out"
    • "Partition Failed to Arm"
    • "PGM Output is in Progress"
    • "Chime Enabled"
    • "Chime Disabled"
    • "Invalid Access Code"
    • "Function Not Available"
    • "Failure to Arm"
    • "Partition is Busy"
    • "System Arming in Progress"
    • "User Closing"
    • "Special Closing"
    • "Partial Closing"
    • "User Opening"
    • "Special Opening"
    • "Panel Battery Trouble"
    • "Panel Battery Trouble Restore"
    • "Panel AC Trouble"
    • "Panel AC Restore"
    • "System Bell Trouble"
    • "System Bell Trouble Restoral"
    • "FTC Trouble"
    • "Buffer Near Full"
    • "General System Tamper"
    • "General System Tamper Restore"
    • "Trouble LED ON"
    • "Trouble LED OFF"
    • "Fire Trouble Alarm"
    • "Fire Trouble Alarm Restore"
    • "Command Output Pressed"
    • "Verbose Trouble Status"

    Click image for larger version

Name:	verbosetroublestatustrigger.png
Views:	1
Size:	25.1 KB
ID:	1191599

    By default any status change for a Zone or a Partition device is logged at the Info level.:
    EnvisaLink 	INFO Partition 1 status change: Ready
    EnvisaLink 	INFO Motion detector status change: Closed
    however you can disable these log entries at the device level: from the device management page, click on the device you want to change, go to the EnvisaLink tab, then tick the "Do not log status change" checkbox like on the screenshot below:

    Click image for larger version

Name:	logcobfigbydevice.jpg
Views:	2
Size:	31.6 KB
ID:	1180855

    You can also use an event action to change these settings (see list above)


    The "Send Keystroke String" action is also available as a scripting function.

    Here is the function signature:
    void SendKeystrokeString(int partition, string data)
    And here is an example of C# script that sends the keystroke string 1234 to the partition 1:

    public object Main(object[] Parms)
    	hs.PluginFunction("EnvisaLink", "", "SendKeystrokeString", new object[] { 1, "1234" });
    	return 0;
    As with the event action, you can also use a replacement variable as the parameter of this function.
    Last edited by spud; July 17, 2017, 08:18 AM.



      If you want to monitor multiple DSC seurity panels which each has an EnvisaLink board connected to it, you can do so by creating new instances of the plug-in.

      Click image for larger version

Name:	multiinstance.png
Views:	2
Size:	25.6 KB
ID:	1184677

      From the PLUG-INS > Manage page, click the green '+' button to create a second instance of the plugin, enter a name then start it. You will have access to a second config page, and a second set of device will be created.