Ness/ELK M1 Gold Security Interface

(c) 2009-2011 My Device.

www.mydevice.com.au

This driver provides control, 2-way feedback and event notification for the Ness/ELK M1G alarm panel.

Note:

Please report any bugs found to bugs@mydevice.com.au. Include driver version number and steps to reproduce the issue where possible.

Driver Configuration Settings:

Connection:

Connection Type - Set the type of connection between the XP8 and the M1G (Network / Serial). A Network connection requires the M1XEP module, a Serial connection requires the M1XSP module.

TCP Settings:

These settings are only requires if the connection type Network is used.

TCP Address - The IP address of the M1G.

TCP Port - The IP port of the M1G. Only an unencrypted connection is currently supported, which normally resides on port 2101. You must enable unencrypted communication via the RP software (as it is disabled by default).

Serial Settings:

These settings are only requires if the connection type Serial is used.

Serial Port - Set the serial port the M1G is connected to.

Baud Rate - Set the baud rate. The default value of the M1G is 9600. Only change this if you've changed the M1G's baud rate too!

Alarm Settings:

Area - This is the area the driver will control.

System Log:

These settings affect how system log entries are displayed in a 2-way list.

Show day of the week - Check this to display the day of the week (Monday, Tuesday, etc).

Show date - Check this to display the date in the format dd.mm.yyyy.

Show time - Check this to display the time of day in the format hh:mm.

Show event id - Check this to display the M1G's event code for this entry.

Show description - Check this to display the description of the event that occurred.

Functions:

Arm / Disarm:

Arm or Disarm the panel

This function affects the armed state of an area.

Arming Level : Disarm/Armed Away/Armed Stay/Armed Stay Instant/Armed Night/Armed Night Instant/Armed Vacation/Arm to next Away Mode/Arm to next Stay Mode.

Partition/Area : 1 - 8.

User Code: This is the code to arm/disarm the system (4 - 6 digits).

Arm or Disarm the panel (buffer)

This function affects the armed state of an area using the User Code entered via the Keypad functions (see below).

Arming Level : Disarm/Armed Away/Armed Stay/Armed Stay Instant/Armed Night/Armed Night Instant/Armed Vacation/Arm to next Away Mode/Arm to next Stay Mode.

Partition/Area : 1 - 8.

Request Arming State

This function updates the feedback variables (Arming Status, Arm Up Status, Alarm Area) with the current status of the system.

Request Alarm By Zone

This function updates the feedback variables (Alarm Status) for all zones.

Request Valid User Code Areas

This function updates feedback variables (Area 1-8 Valid) based on the user code supplied. Indicates which areas the user has access to.

User Code: Code to request area access for.

Zone Status:

Zone Status Request

This function updates the feedback variables (Physical Status, Logical Status) for all zones.

Zone Partition Request

This function updates the feedback variable (Partition) for all zones, indicating which area each zone belongs to.

Zone Bypass Request

This function enables/disables zone bypassing. Selecting zone 0 will unbypass all zones in the area. Zone 999 will bypass all violated zones.

Zone Number : 1 - 32, 0, 999

Area : 1 - 8

User Code: Code to set zone bypass for.

System Status:

Request System Trouble Status

This function updates the feedback variables (System Trouble) to indicate any problems.

System Word:

Speak Word at Voice/Siren Output

This function speaks a word from the inbuilt table.

Word id: 1 - 999

Speak Phrase at Voice/Siren Output

This function speaks a phrase from the inbuilt table.

Phrase id: 1 - 999

Keypad:

These functions imitate a physical keypad.

Clear Buffer

This function clears the keypad buffer (Keypad Buffer, Keypad Buffer Hidden), useful if the user has made a mistake entering a User Code. Two buffer variables are available, one that displays the user code as it's entered, the other shows the code masked by asterisks. Nothing is sent to the M1G.

Add Keypress to Buffer

This function adds a keypress to the keypad buffer (Keypad Buffer, Keypad Buffer Hidden). Nothing is sent to the M1G.

Key : 0 - 9, #, *

Request Keypad Area Assignments

This function updates the feedback variable (Keypad 1-16 Area) indicating which area each keypad belongs to.

Keypad Function Key Press

This function imitates pressing a function key.

Keypad : 1 - 16

Function key : 1 - 6, Silence trouble beep, Control chime, Get status

LCD:

Set LCD Display Clear Method

This function determines the method in which the LCD is cleared.

Method: Clear message, Clear message with * key, Display until timeout.

Set LCD Display Beep Method

This function determines if the keypad beeps.

Method: No beep, beep.

Set LCD Display Text

This function displays text on keypads in an area.

Area : 1 - 8

Display Time : 0 - no timeout, 1 - 65535 seconds,

Line 1 : 16 character string to display

Line 2: 16 character string to alternately scroll with line 1. Set to ^ if line 2 is not needed.

Strings:

Request String

This function requests the current value of a system string.

String Type : Zone name, Area name, User name, Keypad name, Output name, Task name, Telephone name, Light name, Alarm duration name, Custom settings, Counters names, Thermostat names, Function Key 1 name, Function Key 2 name, Function Key 3 name, Function Key 4 name, Function Key 5 name, Function Key 6 name.

Index : Index value of string. For example to get Area 3's name, set to 3.

Request String Range

This function requests the current value of a range of system strings.

String Type : Zone name, Area name, User name, Keypad name, Output name, Task name, Telephone name, Light name, Alarm duration name, Custom settings, Counters names, Thermostat names, Function Key 1 name, Function Key 2 name, Function Key 3 name, Function Key 4 name, Function Key 5 name, Function Key 6 name.

Range Start : Index of the first value.

Range End : Index of the last value.

Do not set end to less than start!

Temperature:

Request Temperature

This function requests the temperature of a probe/keypad/thermostat.

Group : Probe, Keypad, Thermostat.

Device : 1 - 16

System Log:

Request Log Data

This function retrieves the specified log value and updates feedback variables (Log 1 - 5, Log List).

Index : 1 (or higher). If the log doesn't exist you won't get back any data.

Request Log Data (Range)

This function retrieves the newest log values and updates feedback variables (Log 1 - 5, Log List).

Number of logs to request : 1 (or higher). If you request more data than is available only the available data will be sent.

Clear Log Data

This function clears the system log on the M1G.

Set ID Description

This function associates a string with a system log ID. As there are hundreds of possible event IDs I have only described the most frequent.

ID : The ID you wish to add a string to.

Description : A string.

Control Output:

Control Output On

This function switches an output on for a period of time.

Output : 1 - 208.

Duration: 0 - 65535. Set to zero to remain on indefinately.

Control Output Off

This function switches an output off.

Output : 1 - 208.

Control Output Toggle

This function switches toggles the state of an output.

Output : 1 - 208.

Control Output Request Status

This function gets the current status of all 208 outputs. The result is stored in Control Output system variables. Normally the M1 will automatically notify the driver of a change in state of an output, so you should only need to call this function during system initialization.

Tasks:

Activate Task

This function triggers a task stored on the M1.

Task: 1 - 32.