Changes between Version 13 and Version 14 of WikiStart


Ignore:
Timestamp:
2011-08-28 12:11:38 (13 years ago)
Author:
futzle
Comment:

Rev36 updates. UI4 modernization.

Legend:

Unmodified
Added
Removed
Modified

  • WikiStart

    v13 v14  
    1010 
    1111This 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. 
    12  
    13 = Screenshots  = 
    14  
    15 Main panel device, with partitions appearing as children.  
    16 [[Image(CaddxNX584Partition.png)]]  
    17  
    18 Zone devices can be placed in any room.  
    19  
    20 [[Image(CaddxNX584Zone.png)]] 
    2112 
    2213= Preparing the alarm system interface = 
    … …  
    4839 * Secondary keypad function 3Eh, if you want Vera to be able to run Quick Arm and Quick Stay.  
    4940 * Zone bypass toggle 3Fh, if you want Vera to be able to arm or bypass zones. 
     41 * Log Message 0Ah, if you want to get system status information from the panel. 
    5042 
    5143(Todo: write instructions for this, referring to the NX-584 installation manual.)  
    … …  
    5749= Upload the plugin files to Vera  = 
    5850 
    59 Download these files from [http://code.mios.com/trac/mios_caddxnx584/browser/trunk]: 
     51Download these files from [http://code.mios.com/trac/mios_caddxnx584/browser/trunk] and transfer them all to Vera: 
    6052 
    6153 * [http://code.mios.com/trac/mios_caddxnx584/browser/trunk/D_CaddxNX584Security.xml?format=txt D_CaddxNX584Security.xml] 
     54 * [http://code.mios.com/trac/mios_caddxnx584/browser/trunk/D_CaddxNX584Security.json?format=txt D_CaddxNX584Security.json] 
    6255 * [http://code.mios.com/trac/mios_caddxnx584/browser/trunk/I_CaddxNX584Security.xml?format=txt I_CaddxNX584Security.xml] 
     56 * [http://code.mios.com/trac/mios_caddxnx584/browser/trunk/J_CaddxNX584Security.js?format=txt J_CaddxNX584Security.js] 
     57 * [http://code.mios.com/trac/mios_caddxnx584/browser/trunk/L_CaddxNX584Security.lua?format=txt L_CaddxNX584Security.lua] 
     58 * [http://code.mios.com/trac/mios_caddxnx584/browser/trunk/S_CaddxNX584Security.lua?format=txt S_CaddxNX584Security.lua] 
    6359 * [http://code.mios.com/trac/mios_caddxnx584/browser/trunk/D_CaddxNX584Partition2.xml?format=txt D_CaddxNX584Partition2.xml] 
    6460 * [http://code.mios.com/trac/mios_caddxnx584/browser/trunk/D_CaddxNX584Partition2.json?format=txt D_CaddxNX584Partition2.json] 
    65  * [http://code.mios.com/trac/mios_caddxnx584/browser/trunk/S_AlarmPartition2.xml?format=txt S_AlarmPartition2.xml] (This is the de facto standard Alarm Partition file) 
     61 * [http://code.mios.com/trac/mios_caddxnx584/browser/trunk/S_AlarmPartition2.xml?format=txt S_AlarmPartition2.xml] (This is the de facto standard Alarm Partition file, so a copy may already be on your Vera.) 
    6662 
    6763= Create the Luup device  = 
    … …  
    7369 5. Save. 
    7470 
    75 = Assign zones to rooms  = 
     71The plugin creates a device for the alarm system, and one device for each alarm partition.  Partitions are detected automatically. 
    7672 
    77 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.  
     73[[Image(CaddxNX584AfterCreation.png)]] 
    7874 
    79 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.  
     75= Scan for zones = 
    8076 
    81 = Adding a scene to arm a partition (UI2)  = 
     77Zones 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.) 
    8278 
    83  1. Go to Setup > Scenes.  
    84  2. Add a new scene (global or in a room).  
    85  3. Click Advanced and pick a partition device (e.g., Partition 1). Click Add.  
    86  4. Select action !RequestArm and type a PIN code for a user already registered with the alarm system.  
    87  5. Save. 
     79To 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'''. 
    8880 
    89 [[Image(CaddxNX584RequestArm.png)]] 
     81[[Image(CaddxNX584ZoneScanBefore.png)]] 
    9082 
    91 Similar scenes can be created to disarm the panel or to arm the panel in Stay (Partial) mode. 
     83On the next Luup engine reload (press '''SAVE''' on the main window), the new zones will be created as child devices. 
    9284 
    93 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. 
     85[[Image(CaddxNX584WithZones.png)]] 
     86 
     87You 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. 
     88 
     89[[Image(CaddxNX584ZoneScanAfter.png)]]