Discussion for this Luup plugin is on the Micasaverde forum at ​http://forum.micasaverde.com/index.php?topic=4060.0

Got one of these panels? You can help by testing test scenarios that I don't have equipment for.

Introduction

The NX series of alarm panels from (in various parts of the world) GE, Interlogix, Caddx, Networx, Hills or DAS Systems has a serial interface which lets you monitor partitions and zones, arm and disarm the system, and program the panel.

Some alarm panels (e.g., the NX-8E) have this serial interface built in. Other panels have no onboard serial interface and require the connection of the NX-584 expander, which contains only the serial interface. The protocol for the NX-8E and the NX-584 is the same.

This Luup plugin provides continuous monitoring of partitions and zones, reporting partitions' armed status and zones' tripped and bypass status, whether the system is armed or not. Additionally, if configured, the plugin can send Arm and Disarm events to the panel, allowing remote arming and disarming of partitions through scenes.

Screenshots

Main panel device, with partitions appearing as children.

Zone devices can be placed in any room.

Preparing the alarm system interface

The NX-584 must be programmed from a keypad connected to the alarm system.

Set the baud rate to match the setting on the other end of the serial cable. I use 38400, the default.

The interface must accept the following message types:

• Interface configuration message 01h
• Zone status message 04h
• Zones snapshot message 05h
• Partition status message 06h
• Partitions snapshot message 07h
• System status message 08h
• Interface configuration request 21h
• Zone status request 24h
• Zones snapshot request 25h
• Partition status request 26h
• Partitions snapshot request 27h
• System status request 28h

Optional message types:

• Zone name message 03h and Zone name request 23h, if you have keypads that can display zone names and you want the plugin to fetch the names of the zones from the keypad.
• Set clock/calendar command 3Bh, if you want Vera to set the clock on the panel whenever the Luup plugin is started.
• Primary keypad function with PIN 3Ch, if you want Vera to be able to arm or disarm a partition with a PIN.
• Secondary keypad function 3Eh, if you want Vera to be able to run Quick Arm and Quick Stay.
• Zone bypass toggle 3Fh, if you want Vera to be able to arm or bypass zones.

(Todo: write instructions for this, referring to the NX-584 installation manual.)

Connecting Vera to the NX-584/NX-8E

Physically connecting the alarm panel to Vera varies depending on your own situation.

Upload the plugin files to Vera

Download these files from http://code.mios.com/trac/mios_caddxnx584/browser/trunk:

• D_CaddxNX584Security.xml
• I_CaddxNX584Security.xml
• D_AlarmPartition1.xml (original from the ​Paradox Alarm Plugin)
• S_AlarmPartition1.xml (original from the ​Paradox Alarm Plugin)
• D_AlarmPartition1.json (Ignored in UI2) (original from the ​Paradox Alarm Plugin)

Create the Luup device

1. Enter Vera setup, select Devices, the Luup Plugins. Scroll to the bottom to Add Device.
2. In the UpnpDevFilename text box, enter D_CaddxNX584Security.xml and click Add Device.
3. Give the device a name and assign it to a room.
4. Go to Serial Port Configuration and assign the serial port (local or IPSerial) to the Luup device you just created.
5. Save.

Assign zones to rooms

If Vera can successfully talk to the panel, it now asks you to assign each zone to a room. Assign each zone to a room and press Continue.

Note: The NX-584 attached to an NX-4 alarm panel cannot tell if a zone is valid or not, so you may get asked about zones that don't exist. After the plugin runs once, you can edit the Zones variable (in the Advanced tab) to shorten or lengthen the list of zones that you know are on your system. Alternatively, there is a constant variable MAXIMUM_ZONE in the file I_CaddxNX584Security.xml which you can set to limit the number of zones that the plugin assumes are connected.

Adding a scene to arm a partition (UI2)

1. Go to Setup > Scenes.
2. Add a new scene (global or in a room).
3. Click Advanced and pick a partition device (e.g., Partition 1). Click Add.
4. Select action RequestArm and type a PIN code for a user already registered with the alarm system.
5. Save.

Similar scenes can be created to disarm the panel or to arm the panel in Stay (Partial) mode.

Tip: On the Caddx alarm system it is possible to create users with permission to Arm a partition but not Disarm a partition. If you prefer to not allow Vera to disarm, give it the PIN for a user restricted in this way, and the RequestDisarm action will fail.