= Honeywell Ademco Vista Alarm Panels Plugin via AD2USB =
Plugin for basic integration with the Honeywell Ademco Vista panels via the AD2USB keypad emulator.

=== Current Version ===
2.21

== Compatible Products ==
All the Honeywell Ademco Vista alarm panels that AD2USB supports.

'''NOTE:''' This plugin uses the '''GOTO''' command to switch between partitions when more than one partition is used. If the panel doesn't support this command, the plugin won't work correctly for more than one partition. From what I've seen, the only panels with two or more partitions that don't support this command are the ''SE'' panels.

=== Notes ===
* It's not recommended to assign the AD2USB to any partition. This means that it shouldn't be set on the first/default address (e.g. 16 for Vista 20P), which is not configurable.

* The AD2USB's address should not be added to the keypad addresses list for any partition.

== Installation ==
1. Download these files on your computer:
* [[http://code.mios.com/svn_public/mios_vista-alarm-panel-ad2usb/trunk/D_VistaAlarmPanel1.json | D_VistaAlarmPanel1.json]]
* [[http://code.mios.com/svn_public/mios_vista-alarm-panel-ad2usb/trunk/D_VistaAlarmPanel1.xml | D_VistaAlarmPanel1.xml]]
* [[http://code.mios.com/svn_public/mios_vista-alarm-panel-ad2usb/trunk/D_VistaAlarmPartition1.json | D_VistaAlarmPartition1.json]]
* [[http://code.mios.com/svn_public/mios_vista-alarm-panel-ad2usb/trunk/D_VistaAlarmPartition1.xml | D_VistaAlarmPartition1.xml]]
* [[http://code.mios.com/svn_public/mios_vista-alarm-panel-ad2usb/trunk/I_VistaAlarmPanel1.xml | I_VistaAlarmPanel1.xml]]
* [[http://code.mios.com/svn_public/mios_vista-alarm-panel-ad2usb/trunk/L_VistaAlarmPanel1.lua | L_VistaAlarmPanel1.lua]]
* [[http://code.mios.com/svn_public/mios_vista-alarm-panel-ad2usb/trunk/S_AlarmPartition2.xml | S_AlarmPartition2.xml]]
* [[http://code.mios.com/svn_public/mios_vista-alarm-panel-ad2usb/trunk/S_VistaAlarmPanel1.xml | S_VistaAlarmPanel1.xml]]

2. On the Vera dashboard, go to ''MiOS Developers'' -> '''Luup Files''' and upload all 8 files you downloaded.
3. If ''Restart Luup after upload'' is checked, uncheck it, then click ''GO''.
4. Go to '''Create Device'''; in the '''!UpnpDevFilename''' field enter ''D_VistaAlarmPanel1.xml'' and in the '''Description''' field enter ''Honeywell Ademco Vista'' (or any name you want). Press the ''Create Device'' button.
5. Restart Luup by clicking the curving arrows in upper right corner in the dashboard. After restart, reload the web page.
6. In the created device's control panel open the '''Advanced''' tab and enter the number of active partitions in the '''!NumPartitions''' input field. If this field doesn't exist, reload the web page.

'''Warning:''' The plugin might not work correctly if this number is incorrect.

7. Restart Luup. After restart a device for each partition is created.
8. In the partition's control panel, open the '''Advanced''' tab and in the '''!KeypadAddresses''' input field enter the addresses of the keypads assigned to this partition. If there are more than one keypad for a partition, enter the addresses of each keypad separated by a comma (e.g. If the keypads at addresses 17, 19 and 23 are assigned to this partition, the ''!KeypadAddresses'' will be ''17,19,23''). Repeat this for all the partition devices.

'''NOTE:''' If the ''!KeypadAddresses'' field doesn't exist, reload the web page.

'''WARNING''': The plugin won't work correctly if these variables aren't correctly set.

9. Restart Luup.
10. Assign and configure the serial port to the panel device: in the panel device's control panel, open the '''Settings''' tab, click on the '''I/O''' button to open the '''Serial Port configuration''' panel and select the serial port connected to the AD2USB. Set the ''Baud'' to '''115200'''.
11. Restart Luup.
12. Enjoy using the plugin. :)


== Usage ==
==== On the dashboard ====
[[Image(dashboard.png)]]

Te panel device displays its version and the faulted zones. The partitions device display the current arming status. Here are the statuses' real equivalents:

||= Displayed status =||= Real status =||
|| Ready || DISARMED, READY TO ARM ||
|| !NotReady || DISARMED, with one or more FAULTED zones ||
|| Armed || AWAY ||
|| !ArmedInstant || MAXIMUM ||
|| Stay || STAY ||
|| !StayInstant || INSTANT ||
|| Night || NIGHT-STAY ||

==== The panel device control panel ====
[[Image(cp_panel.png)]]

'''Clear Message''' clears the status messages generated by the plugin in the status box (upper-right corner of the dashboard).

==== The partition device control panel ====
[[Image(cp_partition.png)]]

'''Bypass zones'''

To bypass a zone enter the zone number in the '''Bypass Zones''' input box. To bypass several zones, enter the zone numbers separated by a comma. To bypass all the zones leave the box empty or enter ''all''.

'''Chime Mode'''

This activates or deactivates chime mode for the current partition. The button will turn green if it's active.

'''Store'''

When a partition is in the '''!NotReady''' state, the plugin will attempt to send the '''star(*)''' command to get the faulted zones. If there are two or more active partitions the plugin will use the '''GOTO''' command to switch to the partition the command was issued for. This command requires a user code valid for that partition. The plugin stores the user code for every partition in an internal variable to use it '''ONLY''' for getting the faulted zones (all the other commands still require the PIN code). If no previous command has been given to this partition, no PIN code will be available, which means that it won't be possible to get the faulted zones. This is what the '''Store''' button is for. If you see that a partition is in the ''!NotReady'' state, but the faulted zones list is empty, enter the PIN code in the ''PIN code'' field and store it. After this, you should see the faulted zones list being populated.

== Configurable parameters ==
In the panel device's control panel -> ''Advanced'' tab there are two configurable parameters.

==== TTL ====
Quote from [http://www.nutech.com/index.php?option=com_fireboard&Itemid=74&func=view&catid=4&id=5 NuTech forums]:
 The alarm panel does not sent out CLEARED messages when a zone is restored. To determine if a zone is clear you have to watch all faulted zones and if one stops reporting as faulted consider it restored. So you have to track the state of the zone messages.

The '''TTL''' is the number of seconds a zone hasn't been reported as faulted after which it will be considered ''RESTORED''. This should be set according to the number of zones. It takes few seconds to cycle through 3 zones, but many seconds to cycle through 16 zones. The default value for TTL is 60 seconds.

==== !DebugMode ====
By default, the plugin logs only the important events, like the alarms and errors. To enable verbose logging for this plugin set '''!DebugMode''' to '''1''', then restart Luup.

'''How to see the logs:'''

You can find how to see the logs here:

http://wiki.micasaverde.com/index.php/Logs

It is recommended to look only for the log entries with levels ''01'' (errors) and ''50'' (Lua):
{{{
tail -f LuaUPnP.log | grep '^01\|^50'
}}}