Access Keys:
Skip to content (Access Key - 0)

How To - DSC Security System

Introduction

This article will explain how to integrate a DSC security system containing a DSC IT-100 or the newer Envisalink 3 automation interfaces into an OpenRemote 2.0 system.

proframe

DSC integration within Professional Designer is available both with IT100 and Envisalink 3, but only Certified with Envisalink 3.

Hardware

The functionalities of the following products are supported by OpenRemote. Certified products are extensively tested in combination with Professional Designer and supported by OpenRemote certified Integrators.

Brand Product Support Functionality
DSC IT100 DSC PC1616, PC1832, PC1864 Community See "Executable and sensor commands"
DSC Envisalink 3 DSC PC1616, PC1832, PC1864 Certified See "Executable and sensor commands"

Configuration of System

First, you will have to install OR controller. Have a look to the tutorials to install it on a NAS, computer, Raspberry or get an eBox!

Then you have to make it work with your DSC compatible interface.

Configuring for DSC-IT100 Interface

It is assumed that the serial-to-Ethernet gateway has been pre-configured and can accept a TCP/IP connection. Configuration of the gateway is beyond the scope of this document. No further configuration is required.

Configuring for Envisalink Interface

After verifying that your Envisalink interface is functioning correctly, you must configure the password that is used to connect to the TPI (Third Party Interface) of the Envisalink. This password is stored in

<OpenRemote home>/webapps/controller/WEB-INF/classes/config.properties

If you have changed the default password of "user" (highly recommended) for the Envisalink web interface, this password must be entered here.

dscit100.interface.password=user

Creating devices/commands in the Designer

Once you have configured the port settings and started your OR controller, you must create devices and commands to communicate with your receiver.

  • *Create a device by clicking on New/Device, then enter the details in the "New Device" box:

  • *Click Next then Add Command to add a new command. Note that you should choose IT100 as protocol, both for configuring IT100 as well as Envisalink 3.
Command Types

There are two types of commands supported by this protocol- executable commands and sensor commands. Executable commands execute an action on the DSC security panel (i.e. Arm, Disarm). Sensor commands read state information from the security panel (i.e. Zone 1 open, Zone 2 closed, Partition 1 armed).

With the Envisalink interface, at least one Sensor must be created as this allows the connection to the panel to be authenticated. This requirement does not exist with the IT-100 as it does not require authentication.

Executable Commands
Command Target Requires Code Description
ARM_AWAY Partition to arm Yes* Arm target partition in away mode
ARM_STAY Partition to arm Yes* Arm target partition in stay mode
ARM_NO_ENTRY_DELAY Partition to arm Yes* Arm target partition with no entry delay
ARM Partition to arm Yes Arm the target partition
DISARM Partition to disarm Yes Disarm the target partition
PANIC_FIRE n/a No Trigger the fire panic alarm
PANIC_AMBULANCE n/a No Trigger the ambulance panic alarm
PANIC n/a No Trigger the general panic alarm

*Code requirement dependent on alarm system programming

Sensor Commands
Command Target Requires Code Description
PARTITION_STATE Partition to read No Retrieve the state of the target partition
ZONE_STATE Zone to read No Retrieve the state of the target zone
LED LED number No Retrieve state of the Panel LED
Example: ARM Command

Here we will create a command in the designer to ARM the alarm:

With the Alarm device highlighted, select New/Command:

Enter the IP address of your DSC interface under IT-100 Address, The Command is ARM and the target will be the partition number that you wish to ARM. This command requires a valid User code to be entered under Security Code.

You can then add a button to your UI designer and link it to the command created above.

Example: PARTITION_STATE Sensor

Here we will create a PARTITION_STATE Sensor. As with all sensors, we must first create a command. I called mine PARTITION_STATE as well although a more descriptive name could be used if you have multiple partitions. the PARTITION_STATE is always reported to OpenRemote using a Custom Sensor.

You will notice that Security Code is blank. This is fine for any command that doesn't change the ARM status of the alarm.

Then create a Custom Sensor (New/Sensor and select Type Custom)

The command should be the command created above. You can add all of the available PARTITION_STATES in the Custom state items although I did not find that necessary although If you wish to use other (custom) text then this is where you would add it.

The possible states are listed in the table below:

State Description
READY Partition is ready to be armed
NOTREADY Partition is not ready to be armed
ARMED_AWAY Partition is armed in away mode
ARMED_STAY Partition is armed in stay mode
ARMED_AWAY_NODELAY Partition is armed in away mode with no entry delay
ARMED_STAY_NODELAY Partition is armed in stay mode with no entry delay
ALARM Partition is in alarm
DISARMED Partition is disarmed
EXITDELAY Partition is in exit delay
ENTRYDELAY Partition is in entry delay
FAILTOARM Partition failed to arm
BUSY Partition is busy

Once the sensor is created, I found it best to create a Label in the UI and link it to the newly created Sensor. This will then display the current state of the alarm.

Example: ZONE_STATE Sensor

Each Zone can also be assigned to a sensor, this allows you to view the status of all alarm zones within your OpenRemote panel.

As always, first create a command for the Sensor:

The Target in this instance is the Zone number (not the Partition)

You should then create a Custom Sensor to link to this command:

The possible states for this sensor are listed in the table below and can be entered in the Custom state items section (this is required if you wish to use a seperate image to display each state)

State Description
OPEN Zone is open
RESTORED Zone is closed
FAULT Zone is in an error state

Once created, you can "beautify" your panel with images as below:

Specific Designer Remarks - UI Designer

<Is there anything you need to know related to the UI Designer?>

Reference Cases

<Are there any interesting projects to showcase this protocol/product? Add the links and a short description, this can both be a website or a video.>

Useful Links

Always check the OpenRemote forum for the latest developments.

Added by Juha Lindfors , last edit by Pierre Kil on May 13, 2014 16:55

  1. May 20, 2012

    Quintin Paulson says:

    In order to follow these instructions you need to install the dscit100 module ma...

    In order to follow these instructions you need to install the dscit100 module manually first..
    I have gone through this and posted a rough how-to here: http://www.openremote.org/display/forums/DSCit100?focusedCommentId=19988753&#comment-19988753

    1. May 21, 2012

      Juha Lindfors says:

      Thanks for pointing this out. I had thought I integrated the DSC into release b...

      Thanks for pointing this out.

      I had thought I integrated the DSC into release branches already but indeed I had missed it. I'll schedule it for the next controller release so it can be used directly with released binaries.

  2. Nov 06, 2012

    Eric Nelson says:

    Hey guys, any idea when the DSC-IT100 Serial Interface will have some work done ...

    Hey guys, any idea when the DSC-IT100 Serial Interface will have some work done on it? I currently have everything configured and ready to go on my Raspberry Pi. I also have a serial connection hooked up to my DSC-IT100 but don't have anything to transmit/receive data from it yet. I do have some initial work done in c++ to interface with it, but I really like the openRemote idea, so i'd rather go that route.

    Any help would be appreciated!

    1. Nov 07, 2012

      Juha Lindfors says:

      Hello Eric, Have not heard any updates with regards to the serial interface wor...

      Hello Eric,

      Have not heard any updates with regards to the serial interface work. Is this something you'd be able to take over (would required Java + serial library API).

      1. Nov 08, 2012

        Eric Nelson says:

        I believe the current interface will work, if the user installs socat as Quintin...

        I believe the current interface will work, if the user installs socat as Quintin Paulson mentions in this link http://www.openremote.org/display/forums/DSCit100?focusedCommentId=19988753#comment-19988753

        Note, you will need to use STDIO instead of the READLINE command to test the interface.

        I've tried this, and the tcp listener will listen for the tcp commands from the dscit100 commands etc mentioned above. I just need to get the designer UI interface done. Was hoping there was some kind of template for the DSC out there somewhere but I haven't seen anything yet.

  3. Feb 06, 2013

    Pierre Kil says:

    Thanks @Phil Taylor for updating. Hi @Eric Nelson does this help you out as well...

    Thanks @Phil Taylor for updating. Hi @Eric Nelson does this help you out as well?

    1. Jan 23, 2013

      Eric Nelson says:

      I was able to get the serial interface working with the DSC IT100 via the SOCAT ...

      I was able to get the serial interface working with the DSC IT100 via the SOCAT command etc as noted above, but I asked multiple people regarding the OpenRemote UI side of it using the Templates and Command Types above, but no one would respond to me, so instead I just wrote my own Software in Python to communicate with the DSCIT100 and monitor the security system status.

      Thanks.

      1. Feb 06, 2013

        Pierre Kil says:

        Hi Eric, does Phils' update help you out?

        Hi Eric, does Phils' update help you out?

        1. Feb 06, 2013

          Eric Nelson says:

          Thanks for the update Phil. I will have to test this to see if it helps me out....

          Thanks for the update Phil.

          I will have to test this to see if it helps me out. I'm not sure if I will have any time real soon to test, but when I do I will comment and let you know.

          Thanks!

  4. Feb 06, 2013

    Eric Nelson says:

    Great work @Phil Taylor, do you think you could release a template of your UI? I...

    Great work @Phil Taylor, do you think you could release a template of your UI? I really like that layout.

    1. Feb 11, 2013

      Pierre Belanger says:

      Phil modded the tutorial, does that make him receive updates from the thread? I...

      Phil modded the tutorial, does that make him receive updates from the thread? I'm not sure but I doubt it. This said, I'm a bit surprised there's discussion happening here that isn't directly related to the tutorial. I'd suggest to ask Phil in the forum, there's discussion on his patch in there.

      Pierre

    2. Jun 19, 2013

      Quintin Paulson says:

      Eric, Did you find a copy of the UI shown above.. I've poked around the Forum ...

      Eric,

      Did you find a copy of the UI shown above.. I've poked around the Forum and other areas, but i've not been able to find it.

      Thanks.

      1. Jun 20, 2013

        Marcus Redeker says:

        The UI is based on icon and templates which are only available in the Pro design...

        The UI is based on icon and templates which are only available in the Pro designer at the moment.

  5. Aug 15, 2013

    jules says:

    Great work - I have this set up to automate my lighting using the Envisalink int...

    Great work - I have this set up to automate my lighting using the Envisalink interface. I ran it on a Raspberry Pi and noticed that as I built up my OR project eventually I was getting TPI logouts which I think was due to the performance limitations of the Pi. I am still having problems and I've posted in the forums in more detail.

  6. Mar 12

    sean says:

    I seem to be confused. in the config.properties file I do not have anywhere to p...

    I seem to be confused. in the config.properties file I do not have anywhere to put my envisalink password. Is "dscit100.interface.password=user" supposed to already be in the code, or do I just past this in at the end of the file with my password?

© 2008-2012 OpenRemote Inc. OpenRemote is a trademark of OpenRemote, Inc.
Adaptavist Theme Builder (3.3.6-conf210) Powered by Atlassian Confluence 2.10.3, the Enterprise Wiki.