Changes between Version 1 and Version 2 of WikiStart


Ignore:
Timestamp:
2010-08-15 09:38:27 (14 years ago)
Author:
futzle
Comment:

Import from wiki.micasaverde.com

Legend:

Unmodified
Added
Removed
Modified

  • WikiStart

    v1 v2  
    1 = Welcome to Trac 0.11.6 = 
     1Early access is available to a Plugin supporting the GE Caddx/Networx, NX-584 and NX-8E Alarm Panels:  
    22 
    3 Trac is a '''minimalistic''' approach to '''web-based''' management of 
    4 '''software projects'''. Its goal is to simplify effective tracking and handling of software issues, enhancements and overall progress. 
     3    http://forum.micasaverde.com/index.php?topic=4060.0 
    54 
    6 All aspects of Trac have been designed with the single goal to  
    7 '''help developers write great software''' while '''staying out of the way''' 
    8 and imposing as little as possible on a team's established process and 
    9 culture. 
     5= Introduction  = 
    106 
    11 As all Wiki pages, this page is editable, this means that you can 
    12 modify the contents of this page simply by using your 
    13 web-browser. Simply click on the "Edit this page" link at the bottom 
    14 of the page. WikiFormatting will give you a detailed description of 
    15 available Wiki formatting commands. 
     7The NX series of alarm panels from (in various parts of the world) GE Caddx, Networx or DAS Systems has a serial interface which lets you monitor partitions and zones, arm and disarm the system, and program the panel. 
    168 
    17 "[wiki:TracAdmin trac-admin] ''yourenvdir'' initenv" created 
    18 a new Trac environment, containing a default set of wiki pages and some sample 
    19 data. This newly created environment also contains  
    20 [wiki:TracGuide documentation] to help you get started with your project. 
     9Some 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. 
    2110 
    22 You can use [wiki:TracAdmin trac-admin] to configure 
    23 [http://trac.edgewall.org/ Trac] to better fit your project, especially in 
    24 regard to ''components'', ''versions'' and ''milestones''.  
     11This 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. 
    2512 
     13= Screenshots  = 
    2614 
    27 TracGuide is a good place to start. 
     15Main panel device, with partitions appearing as children.  
    2816 
    29 Enjoy! [[BR]] 
    30 ''The Trac Team'' 
     17[[Image:CaddxNX584Partition.png]]  
    3118 
    32 == Starting Points == 
     19Zone devices can be placed in any room.  
    3320 
    34  * TracGuide --  Built-in Documentation 
    35  * [http://trac.edgewall.org/ The Trac project] -- Trac Open Source Project 
    36  * [http://trac.edgewall.org/wiki/TracFaq Trac FAQ] -- Frequently Asked Questions 
    37  * TracSupport --  Trac Support 
     21[[Image:CaddxNX584Zone.png]] 
    3822 
    39 For a complete list of local wiki pages, see TitleIndex. 
     23= Preparing the alarm system interface = 
     24 
     25The NX-584 must be programmed from a keypad connected to the alarm system.  
     26 
     27Set the baud rate to match the setting on the other end of the serial cable. I use 38400, the default.  
     28 
     29The interface must accept the following message types:  
     30 
     31 * Interface configuration message 01h  
     32 * Zone status message 04h  
     33 * Zones snapshot message 05h  
     34 * Partition status message 06h  
     35 * Partitions snapshot message 07h  
     36 * System status message 08h  
     37 * Interface configuration request 21h  
     38 * Zone status request 24h  
     39 * Zones snapshot request 25h  
     40 * Partition status request 26h  
     41 * Partitions snapshot request 27h  
     42 * System status request 28h 
     43 
     44Optional message types:  
     45 
     46 * 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.  
     47 * Set clock/calendar command 3Bh, if you want Vera to set the clock on the panel whenever the Luup plugin is started.  
     48 * Primary keypad function with PIN 3Ch, if you want Vera to be able to arm or disarm a partition with a PIN.  
     49 * Secondary keypad function 3Eh, if you want Vera to be able to run Quick Arm and Quick Stay.  
     50 * Zone bypass toggle 3Fh, if you want Vera to be able to arm or bypass zones. 
     51 
     52(Todo: write instructions for this, referring to the NX-584 installation manual.)  
     53 
     54= Connecting Vera to the NX-584  = 
     55 
     56The NX-584/NX-8E has a male DB9 serial interface. To connect the interface to another computer, either:  
     57 
     58 * Use a female-to-female null modem cable, which swaps RX/TX and CTS/RTS to allow connection to a computer with a serial port, or  
     59 * Use a female-to-female gender changer or a straight female-to-female cable, and adjust the jumpers on the NX-584/NX-8E board to make it swap RX and TX pins and RTS and CTS pins. 
     60 
     61To connect the Vera directly, get a USB-to-serial adapter, plug the DB9 end into the null modem cable or gender changer, and plug the USB end into Vera.  
     62 
     63Alternatively you can use an IP-to-Serial bridge such as ser2net on a computer near the NX-584/NX-8E, and set up an IPSerial interface on Vera.  
     64 
     65= Upload the plugin files to Vera  = 
     66 
     67Files are attached to the thread on forum.micasaverde.com. 
     68 
     69 * D_CaddxNX584Security.xml  
     70 * I_CaddxNX584Security.xml  
     71 * D_AlarmPartition1.xml  
     72 * S_AlarmPartition1.xml 
     73 
     74= Create the Luup device  = 
     75 
     76 1. Enter Vera setup, select Devices, the Luup Plugins. Scroll to the bottom to Add Device. 
     77 2. In the UpnpDevFilename text box, enter D_CaddxNX584Security.xml and click Add Device. 
     78 3. Give the device a name and assign it to a room.  
     79 4. Go to Serial Port Configuration and assign the serial port (local or IPSerial) to the Luup device you just created.  
     80 5. Save. 
     81 
     82= Assign zones to rooms  = 
     83 
     84If 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.  
     85 
     86Note: 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. 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.  
     87 
     88= Adding a scene to arm a partition (UI2)  = 
     89 
     90 1. Go to Setup > Scenes.  
     91 2. Add a new scene (global or in a room).  
     92 3. Click Advanced and pick a partition device (e.g., Partition 1). Click Add.  
     93 4. Select action RequestArm and type a PIN code for a user already registered with the alarm system.  
     94 5. Save. 
     95 
     96[[Image:CaddxNX584RequestArm.png]] 
     97 
     98Similar scenes can be created to disarm the panel or to arm the panel in Stay (Partial) mode. 
     99 
     100Tip: 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.