| 1 | | = GE Caddx NetworX NX-584 and NX-8E Alarm Plugin = |
| 2 | | |
| 3 | | Discussion for this Luup plugin is on the Micasaverde forum at http://forum.micasaverde.com/index.php?topic=4060.0 |
| 4 | | |
| 5 | | '''Got one of these panels? You can help''' by testing [wiki:TestScenarios test scenarios] that I don't have equipment for. |
| 6 | | |
| 7 | | == Introduction == |
| 8 | | |
| 9 | | 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. |
| 10 | | |
| 11 | | 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. |
| 12 | | |
| 13 | | 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. |
| 14 | | |
| 15 | | == Preparing the alarm system interface == |
| 16 | | |
| 17 | | The NX-584 must be programmed from a keypad connected to the alarm system. |
| 18 | | |
| 19 | | Set the baud rate to match the setting on the other end of the serial cable. I use 38400, the default. |
| 20 | | |
| 21 | | The interface must accept the following message types: |
| 22 | | |
| 23 | | * Interface configuration message 01h |
| 24 | | * Zone status message 04h |
| 25 | | * Zones snapshot message 05h |
| 26 | | * Partition status message 06h |
| 27 | | * Partitions snapshot message 07h |
| 28 | | * System status message 08h |
| 29 | | * Interface configuration request 21h |
| 30 | | * Zone status request 24h |
| 31 | | * Zones snapshot request 25h |
| 32 | | * Partition status request 26h |
| 33 | | * Partitions snapshot request 27h |
| 34 | | * System status request 28h |
| 35 | | |
| 36 | | Optional message types: |
| 37 | | |
| 38 | | * 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. |
| 39 | | * Set clock/calendar command 3Bh, if you want Vera to set the clock on the panel whenever the Luup plugin is started. |
| 40 | | * Primary keypad function with PIN 3Ch, if you want Vera to be able to arm or disarm a partition with a PIN. |
| 41 | | * Secondary keypad function 3Eh, if you want Vera to be able to run Quick Arm and Quick Stay. |
| 42 | | * Zone bypass toggle 3Fh, if you want Vera to be able to arm or bypass zones. |
| 43 | | * Log Message 0Ah, if you want to get system status information from the panel. |
| 44 | | |
| 45 | | (Todo: write instructions for this, referring to the NX-584 installation manual.) |
| 46 | | |
| 47 | | == Connecting Vera to the NX-584/NX-8E == |
| 48 | | |
| 49 | | [wiki:PhysicalConnection Physically connecting the alarm panel to Vera] varies depending on your own situation. |
| 50 | | |
| 51 | | == Install and set up the plugin == |
| 52 | | |
| 53 | | * Direct installation of files on your Vera on UI4 or UI5. [wiki:UI4 Installation instructions for direct transfer]. |
| 54 | | * There is a version of this plugin modified by Micasaverde, appearing on the apps.mios.com portal. [wiki:UI5 Installation instructions for apps.mios.com version]. |
| 55 | | |
| 56 | | == Scan for zones == |
| 57 | | |
| 58 | | Zones are not detected automatically, so you must scan for the zones that your alarm system has. Click on the main alarm device's configuration icon (spanner/wrench), and go to the '''Zones''' tab. (It may be necessary to click the tab a second time.) |
| 59 | | |
| 60 | | To scan for zones, enter the highest-numbered zone in your system into the '''Maximum zone''' text box, and click '''Scan'''. The plugin asks the alarm panel for all zones from 1 to the maximum, and (if it is supported and you have enabled it), each zone's name. Edit each zone's name and click '''Add'''. |
| 61 | | |
| 62 | | [[Image(CaddxNX584ZoneScanBefore.png)]] |
| 63 | | |
| 64 | | On the next Luup engine reload (press '''SAVE''' on the main window), the new zones will be created as child devices. |
| 65 | | |
| 66 | | [[Image(CaddxNX584WithZones.png)]] |
| 67 | | |
| 68 | | You can rename and relocate zones to other rooms. If you want to delete a zone, do this from the same '''Zones''' tab that you used to add zones. |
| 69 | | |
| 70 | | [[Image(CaddxNX584ZoneScanAfter.png)]] |
| | 1 | This plugin is now maintained at https://github.com/futzle/MiOS-CaddxNX584 |
