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

=== Version ===
1.0

== Compatible Products ==
* M1 Gold
* M1EZ8 with ELK-M1EZ8MSI Main Serial Port Interface

== Installation ==
1. Download these files on your computer:

[[http://code.mios.com/svn_public/mios_elk-alarm-panel/D_ElkAlarmPanel1.json|D_ElkAlarmPanel1.json]]

[[http://code.mios.com/svn_public/mios_elk-alarm-panel/D_ElkAlarmPanel1.xml|D_ElkAlarmPanel1.xml]]

[[http://code.mios.com/svn_public/mios_elk-alarm-panel/D_ElkAlarmPartition1.json|D_ElkAlarmPartition1.json]]

[[http://code.mios.com/svn_public/mios_elk-alarm-panel/D_ElkAlarmPartition1.xml|D_ElkAlarmPartition1.xml]]

[[http://code.mios.com/svn_public/mios_elk-alarm-panel/I_ElkAlarmPanel1.lua|I_ElkAlarmPanel1.lua]]

[[http://code.mios.com/svn_public/mios_elk-alarm-panel/I_ElkAlarmPanel1.xml|I_ElkAlarmPanel1.xml]]

[[http://code.mios.com/svn_public/mios_elk-alarm-panel/S_AlarmPartition2.xml|S_AlarmPartition2.xml]]

[[http://code.mios.com/svn_public/mios_elk-alarm-panel/S_ElkAlarmPanel1.xml|S_ElkAlarmPanel1.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_ElkAlarmPanel1.xml'' and in the '''Description''' field enter ''Elk M1 Alarm Panel'' (or any name you want).  Press the '''Create Device''' button.

'''NOTE:''' If the panel is connected to Vera on the '''Ethernet''' port (using Elk M1XEP or an RS232-to-Ethernet adapter), enter the IP address and port in the '''!IpAddress''' field (e.g. 192.168.8.23:5000).
5. Restart Luup by clicking the curving arrows in the upper right corner in the dashboard.
6. After Luup has restarted, reload the web page. (best use <Ctrl + F5> to do so)

== Setup ==
If the panel has been connected to Vera on an USB port, you must configure the serial port.
1. Go to '''MiOS developers''' -> '''Serial port configuration'''.
 * Set the '''Baud''' to ''115200''.
 * Select the newly created panel device from the '''Used by device''' drop-down list.
 * Optionally you can give a name to this serial port in the '''Name''' field.
2. Close this window and click '''SAVE'''.
3. After Luup has restarted reload the web page.
[[Image(serial_port_configuration.png)]]

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