= Elk M1 Alarm Panel Plugin =
Plugin for basic integration with the Elk M1 panels.

=== Version ===
1.0[[BR]]
2.0

== Compatible Products ==
* M1 Gold Serial Port and Elk-M1XEP Ethernet Interface.

* M1EZ8 with ELK-M1EZ8MSI Main Serial Port Interface

== Connecting the panel to Vera ==
There are 3 ways to connect the panel to Vera:
* Using an '''USB RS-232 Serial Adapter''' like [http://www.usbgear.com/computer_cable_details.cfm?sku=USBG-232MM&cats=199&catid=199%2C461%2C106%2C1009%2C601 this one]. For best compatibility with Vera, I recommend a serial adapter with '''FTDI''' or '''Prolific''' chipset.
* Using a wired Ethernet connection with the [http://www.elkproducts.com/_webapp_2981439/ELK-M1XEP_M1_Ethernet_Interface Elk-M1XEP Ethernet Interface].
* Using a '''!WiFi RS-232 Serial Adapter''' like [http://www.gridconnect.com/wi232.html this one].

The first 2 options are preferable because they are easier to setup and more reliable.

== Installation & Setup ==
* For UI4 click [wiki:UI4 here].
* For UI5 click [wiki:UI5 here].

== Usage ==
[[Image(panel_dashboard.png)]]

Pressing the ''Clear Message'' button clears the status message displayed in the upper right corner of the dashboard.

[[Image(partition_dashboard.png)]]

The status displayed is the current arm mode.

[[Image(partition_toolbox.png)]]

The status displayed is the current arm mode.

The Elk M1 alarm panel requires the user code to arm/disarm a partition or to bypass/unbypass a zone. Enter the user code in the ''PIN Code'' field then click ''Store''. The user code is stored securely and can't be accessed by anyone. It is NOT stored in a state variable to be visible by anyone with access to the Vera. This also means that the user code is lost when the Luup engine restarts and it needs to be entered again.

Pressing the ''Clear'' button erases the user code from memory.

It's not necessary to store the user code to arm/disarm a partition, but it must be present in the ''PIN Code'' field.

=== Notes ===
* Arming or Bypassing zones requires the user code valid in that partition.
* Arming or Disarming a partition also requires the user code valid in that partition.

=== Debugging ===
By default, the plugin logs only the important events, like alarms and errors. To enable verbose logging go to the ''Advanced'' tab in the panel device's Toolbox and set the ''!DebugMode'' to ''1'' then restart Luup.

[[Image(debug_mode.png)]]

'''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'
}}}

=== '''Discussion''' ===
Discussion for this Luup plugin is on the !MiCasaVerde forum at http://forum.micasaverde.com/index.php?topic=6916.0