MLELKM1 Plugin

From Cinemar Wiki
Jump to: navigation, search

About

The following paragraphs detail the installation, configuration and usage of the MainLobby / MLServer Elk M1 Plug-In. This plug-in is capable of supporting an Elk M1 controller via the Elk network interface or attached to a PC serial port or a Global Cache GC100 style serial port. Please note that this plug-in requires the Elk M1 controller to be running firmware version 4.3.5 or better in order to support full functionality.

SoftwareRequirements

  • MLServer 3
  • MainLobby 3

SupportedHardware

  • ELK-M1
  • ELK-M1EZ8

Installation

Run the MLELKM1-Setup.exe program and follow the prompts.

Configuration

This plug-in must be configured prior to using it in a MainLobby scene. Highlight the MLELKM1 plug-in in MLServer and click on the Settings button to bring up the ELK M1 configuration screen. You will be presented with a tabbed dialog box of configuration settings as shown in Figure 1.

The Events Tab

This tab is used to collect and view the status of the plug-in while is use. This is a diagnostic feature and is useful during the initial setup of the plug-in. Click on the Start Logging button to enable the display of plug-in events while the plug-in is in use. See Figure 2.


The Connections Tab

Use this tab to configure the serial port that will be used to control the Elk M1 controller. You can use either a PC serial port, a Global Cache serial port or the Elk network interface. If you use a Global Cache serial port make sure you configure the serial port using the Global Cache web interface. The interface that is currently enabled will be used to control the Elk M1 controller. Make sure that the baud rate set in this plug-in matches the baud rate you set on the Elk M1 controller. See Figure 3.

If you are using the serial port make sure all the comm settings are correct. If you are using the TCP/IP interface make sure you have configured the Elk to accept connections on port 2101 and not the SSL port 2601.


The Scheduling Tab Use this tab to configure polling intervals for the M1 thermostats and PLC components and FKey events. Check each thermostat in your system that you want to have polled by the plug-in. Specify the polling interval and check whether or not you would like to start polling when the plug-in loads. For the PLC circuits specify which banks of PLC equipment you want to poll and the polling interval for those circuits. You can also specify if you want to start polling the PLC circuits when the plug-in loads. You may enter the MLServer command to be executed whenever one of the six FKey events are triggered. Finally, please specify if your security system is using four or six digit security codes. See Figure 4.


The Registration Menu

This plug-in requires registration to enable permanent functionality. When you first install this plug-in it will be installed in evaluation mode. While in evaluation mode the plug-in will remain fully functional for a period of thirty days after you install the software. After thirty days the plug-in will stop responding to commands and interrupts. Use the registration menu option to bring up links to purchase and activate the plug-in.

Once activated this plug-in will only run on the PC that it is registered to. Please make sure that you request activation for this plug-in from the PC that it will be running on. See Figure 5.

ReleaseNotes

Supported Commands

Activate Task (AT)

{MLServeCmd}Script Usage

MLServeCmd.MLELKM1|AT~task


(Literal)

MLServeCmd.MLELKM1|AT~12


Parameters
task = Task to Activate (1..32)


Description

Activates a Task configured in your ELK.


Arm

{MLServeCmd}Script Usage

MLServeCmd.MLELKM1|Arm~Level~Area~UserPIN


(Literal)

MLServeCmd.MLELKM1|Arm~1~2~1234


Parameters
Level = 0 = Disarm, 1 = Away, 2 = Stay, 3 = Stay Instant, 4 = Night, 5 = Night Instant, 6 = Vacation, 7 = Step to Next Away Mode, 8 = Step to Next Stay Mode
Area = (1..8)
UserPIN = User's Security Code


Description

Arm the specified Area.


Arming Status Request (ASR)

{MLServeCmd}Script Usage

MLServeCmd.MLELKM1|ASR


(Literal)

MLServeCmd.MLELKM1|ASR


Parameters
none =


Description

Requests the current Armed Status


Control Any PLC Device (PC)

{MLServeCmd}Script Usage

MLServeCmd.MLELKM1|PC~House~Unit~Function~Extended~Time


(Literal)

MLServeCmd.MLELKM1|PC~A~2~9~50~12


Parameters
House = House Code (A..P)
Unit = Unit Code (1..16)
Function = Function Code (1..16)
Extended = Extended Code (0..99)
Ttime = On Time in Seconds (0..9999)


Description





Control Output On (CN)

{MLServeCmd}Script Usage

MLServeCmd.MLELKM1|CN~Output~Seconds


(Literal)

MLServeCmd.MLELKM1|CN~1~90


Parameters
Output = Control Output to Turn On (1..208)
Seconds = Length of Time to Remain On in Seconds (1..65535), 0 = Turn on Continuous


Description

Turn a specified Output On


Control Output Off (CF)

{MLServeCmd}Script Usage

MLServeCmd.MLELKM1|CF~Output


(Literal)

MLServeCmd.MLELKM1|CF~103


Parameters
Output = Control Output to Turn Off (1..208)


Description

Turn a specified Output Off


Control Output Toggle (CT)

{MLServeCmd}Script Usage

MLServeCmd.MLELKM1|CT~Output


(Literal)

MLServeCmd.MLELKM1|CT~22


Parameters
Output = Control Output to Toggle (1..208)


Description

Toggles the specified Output to On if it is Off and Off if it is On.


Control Output Status Request (CS)

{MLServeCmd}Script Usage

MLServeCmd.MLELKM1|CS


(Literal)

MLServeCmd.MLELKM1|CS


Parameters
none


Description

Gets Status of Control Ouputs and returns them to MLServer Variables.


Decrement Cool Setpoint 1 Degree (CSPDEC)

{MLServeCmd}Script Usage

MLServeCmd.MLELKM1|CSPDEC~TStat


(Literal)

MLServeCmd.MLELKM1|CSPDEC~1


Parameters
TStat = Thermostat Number (1..16)


Description

Decreases the current specified Thermostat Cool Setpoint by One Degree.


Decrement Heat Setpoint 1 Degree (HSPDEC)

{MLServeCmd}Script Usage

MLServeCmd.MLELKM1|HSPDEC~TStat


(Literal)

MLServeCmd.MLELKM1|HSPDEC~1


Parameters
TStat = Thermostat Number (1..16)


Description

Decreases the current specified Thermostat Heat Setpoint by One Degree.


Display Message on LCD Screen (DM)

{MLServeCmd}Script Usage

MLServeCmd.MLELKM1|DM~Area~Clear~Beep~Time~Line1~Line2


(Literal)

MLServeCmd.MLELKM1|DM~A~2~0~0~10~Hello~World


Parameters
Area = Keypad Area (1..8)
Clear = 0 = Clear Message, 1 = Clear Message with *, 2 = Display Until Timeout
Beep = 0 = No Beep, 1 = Beep
Time = Time in Seconds to Display Message (1..65535), 0 = No Timeout
Line1 = Message to Display on Line1 (Max 16 Characters)
Line2 = Message to Display on Line2 (Max 16 Characters)


Description

Display a message on a specified Elk keypad.


Zone Status Request (ZSR)

{MLServeCmd}Script Usage

MLServeCmd.MLELKM1|ZSR


(Literal)

MLServeCmd.MLELKM1|ZSR


Parameters
none


Description

Gets Status of All Zones and Returns the results to MLServer Variables.


Zone Partition Request (ZPR)

{MLServeCmd}Script Usage

MLServeCmd.MLELKM1|ZPR


(Literal)

MLServeCmd.MLELKM1|ZPR


Parameters
none


Description

Gets Status of All Partitions and Returns the results to MLServer Variables.


Zone Bypass Request (ZBR)

{MLServeCmd}Script Usage

MLServeCmd.MLELKM1|ZBR~Zone~Area~UserPIN


(Literal)

MLServeCmd.MLELKM1|ZBR~1~2~1234


Parameters
Zone = Zone to Bypass (1..n), 000 = Unbypass all Burglar Zones in Area, 999 = Bypass all Violated Burglar Zones in Area
Area = Keypad Area (1..8)
UserPIN = User's Security Code


Description

Bypass a specified Zone.


Key Press (KEY)

{MLServeCmd}Script Usage

MLServeCmd.MLELKM1|KEY~Key


(Literal)

MLServeCmd.MLELKM1|Key~1


Parameters
Key = Virtual Keypad Key to Press (0..9, *, #, B)


Description

Use this command as part of a virtual keypad scene to send keypress commands to the built-in Elk keypad simulator.


Keypad Exit (KPEXIT)

{MLServeCmd}Script Usage

MLServeCmd.MLELKM1|KPExit~KPad


(Literal)

MLServeCmd.MLELKM1|KPExit~1


Parameters
KPad = Virtual Keypad to Exit (1..16)


Description

Use this command as part of a virtual keypad scene exit command. This will stop the automatic updates of keypad components when they are not needed.


Keypad Initialize (KPINIT)

{MLServeCmd}Script Usage

MLServeCmd.MLELKM1|KPINIT~KPad


(Literal)

MLServeCmd.MLELKM1|KPINIT~1


Parameters
KPad = Virtual Keypad to Exit (1..16)


Description

Use this command as part of a virtual keypad scene startup command. This will initiate the automatic updates of keypad components.


Keypad Function Key Press (KF)

{MLServeCmd}Script Usage

MLServeCmd.MLELKM1|KF~Keypad~FKey


(Literal)

MLServeCmd.MLELKM1|KF~1~3


Parameters
Keypad = Keypad (1..16)
FKey = Function Key (1..6)


Description

Sends a Function Keypress to a specified ELK keypad.


Increment Cool Setpoint 1 Degree (CSPINC)

{MLServeCmd}Script Usage

MLServeCmd.MLELKM1|CSPINC~TStat


(Literal)

MLServeCmd.MLELKM1|CSPINC~1


Parameters
TStat = Thermostat Number (1..16)


Description

Increases the current specified Thermostat Cool Setpoint by One Degree.


Increment Heat Setpoint 1 Degree (HSPINC)

{MLServeCmd}Script Usage

MLServeCmd.MLELKM1|HSPINC~TStat


(Literal)

MLServeCmd.MLELKM1|HSPINC~1


Parameters
TStat = Thermostat Number (1..16)


Description

Increases the current specified Thermostat Heat Setpoint by One Degree.


Read Custom Value (RCV)

{MLServeCmd}Script Usage

MLServeCmd.MLELKM1|RCV~Value


(Literal)

MLServeCmd.MLELKM1|RCV~1


Parameters
Value = Custom Value (1..20)


Description

Reads the custom value from the ELK and stores them in an MLServer Variable.


Request ASCII String Text Descriptions (SD)

{MLServeCmd}Script Usage

MLServeCmd.MLELKM1|SD~Type~Range


(Literal)

MLServeCmd.MLELKM1|SD~0~1


Parameters
Type = 0 = Zone Name, Range (1..208)
Type = 1 = Area Name, Range (1..8)
Type = 2 = User Name, Range (1..99)
Type = 3 = Keypad Name, Range (1..16)
Type = 4 = Output Name, Range (1..32)
Type = 5 = Task Name, Range (1..322)
Type = 6 = Telephone Name, Range (1..8)
Type = 7 = Light Name, Range (1..256)
Type = 8 = Alarm Duration Name, Range (1..12)
Type = 9 = Custom Settings, Range (1..20)
Type = 10 = Counter Name, Range (1..64)
Type = 11 = Thermostat Name, Range (1..16)
Type = 12 = Function Key 1 Name, Range (1..16)
Type = 13 = Function Key 2 Name, Range (1..16)
Type = 14 = Function Key 3 Name, Range (1..16)
Type = 15 = Function Key 4 Name, Range (1..16)
Type = 16 = Function Key 5 Name, Range (1..16)
Type = 17 = Function Key 6 Name, Range (1..16)


Description

Returns a defined name from the ELK to an MLServer Variable.


Request Function Key Illumination Status (RFKIS)

{MLServeCmd}Script Usage

MLServeCmd.MLELKM1|RFKIS~Keypad


(Literal)

MLServeCmd.MLELKM1|RFKIS~1


Parameters
Keypad = Keypad Number (1..16)


Description

Sets a variable in MLServer based on the illimunation of a specified keypad.


Request Keypad Area Assignment (KA)

{MLServeCmd}Script Usage

MLServeCmd.MLELKM1|KA


(Literal)

MLServeCmd.MLELKM1|KA


Parameters
None


Description

Returns the Keypad Area Assignment to an MLServer Variable.


Request PLC Status (PS)

{MLServeCmd}Script Usage

MLServeCmd.MLELKM1|PS~Bank


(Literal)

MLServeCmd.MLELKM1|PS~2


Parameters
Bank = 0 = A1 to D16, 1 = E1 to H16, 2 = I1 to L16, 3 = M1 to P16


Description

Returns the status of a bank of lights to MLServer Variables.


Request System Log Data (RLD)

{MLServeCmd}Script Usage

MLServeCmd.MLELKM1|RLD~LogEntry


(Literal)

MLServeCmd.MLELKM1|RLD~1


Parameters
LogEntry = Decimal Log Entry (1..511), 1 = Latest Log Entry


Description

Return the specified System Log Data to an MLServer Variable.


Request Temperature (RT)

{MLServeCmd}Script Usage

MLServeCmd.MLELKM1|RT~Group~Device


(Literal)

MLServeCmd.MLELKM1|RT~0~1


Parameters
Group = 0 = Temperature Probe, 1 = Keypad, 2 = Thermostat
Device = Device Number (1..16)


Description

Request the temperature of the specified Device.


Request Thermostat Data (TR)

{MLServeCmd}Script Usage

MLServeCmd.MLELKM1|TR~TStat


(Literal)

MLServeCmd.MLELKM1|TR~1


Parameters
TStat = Thermostat (1..16)


Description

Request all data for the specified Thermostat.


Request Valid User Code Areas (UA)

{MLServeCmd}Script Usage

MLServeCmd.MLELKM1|UA~Code


(Literal)

MLServeCmd.MLELKM1|UA~143210


Parameters
Code = 6 Digit User Code


Description

Requests Valud User Code Areas.


Request Zone Definition (ZD)

{MLServeCmd}Script Usage

MLServeCmd.MLELKM1|ZD


(Literal)

MLServeCmd.MLELKM1|ZD


Parameters
None


Description

Returns to MLServer Variables the Zone Definitions of all Zones.


Set Thermostat Data (TS)

{MLServeCmd}Script Usage

MLServeCmd.MLELKM1|TS~TStat~Element~Value


(Literal)

MLServeCmd.MLELKM1|TS~1~1


Parameters
TStat = Thermostat (1..16)
Element = 0 = Mode, Value: 0 = Off, 1 = Heat, 2 = Cool, 3 = Auto, 4 = Emergency Heat
Element = 1 = Hold Current Temp, Value: 0 = False, 1 = True
Element = 2 = Fan, Value: 0 = Auto, 1 = Fan On
Element = 4 = Cool Set Point, Value: 1..99
Element = 5 = Heat Set Point, Value: 1..99


Description

Control the specified thermostat setting.


Speak Word (SW)

{MLServeCmd}Script Usage

MLServeCmd.MLELKM1|SW~Word Number


(Literal)

MLServeCmd.MLELKM1|SW~88


Parameters
Word Number = Word Number (1..473)


Description

Speaks the word specified in the ELK through the Elk speaker outputs.


Speak Phrase (SP)

{MLServeCmd}Script Usage

MLServeCmd.MLELKM1|SP~Phrase Number


(Literal)

MLServeCmd.MLELKM1|SP~56


Parameters
Phrase Number = Phrase Number (1..319)


Description

Speaks the phrase specified in the ELK through the Elk speaker outputs.


Toggle PLC Device (PT)

{MLServeCmd}Script Usage

MLServeCmd.MLELKM1|PT~House~Unit


(Literal)

MLServeCmd.MLELKM1|PT~A~2


Parameters
House = House Code (A..P)
Unit = Unit Code (1..16)


Description

Toggle the specified PLC device.


Turn Off PLC Device (PF)

{MLServeCmd}Script Usage

MLServeCmd.MLELKM1|PF~House~Unit


(Literal)

MLServeCmd.MLELKM1|PT~A~2


Parameters
House = House Code (A..P)
Unit = Unit Code (1..16)


Description

Turn off the specified PLC device.


Turn On PLC Device (PN)

{MLServeCmd}Script Usage

MLServeCmd.MLELKM1|PN~House~Unit


(Literal)

MLServeCmd.MLELKM1|PN~A~2


Parameters
House = House Code (A..P)
Unit = Unit Code (1..16)


Description

Turn on the specified PLC device.


Write Custom Value (WCV)

{MLServeCmd}Script Usage

MLServeCmd.MLELKM1|WCV~Value~Data


(Literal)

MLServeCmd.MLELKM1|WCV~1~43210


Parameters
Value = (1..20)
Data = (0..65535)


Description

Write a custom value to the ELK.


MLServer Variables

MLElkM1_Area_{{Elk_Area}}_AlarmStateMsg

Description:

Values: (No Alarm, Entrance Delay, Alarm Abort, Fire Alarm, Medical Alarm, Police Alarm, Burglar Alarm, Aux1 Alarm, Aux2 Alarm, Aux3 Alarm, Aux4 Alarm, Carbon Monoxide Alarm, Emergency Alarm, Freeze Alarm, Gas Alarm, Heat Alarm, Water Alarm, Fire Supervisory, Verify Fire)

MLElkM1_Area_{{Elk_Area}}_AlarmStateVal

Description:

Values: (0,1,2,3,4,5,6,7,8,9,10,11,12,13,14,15,16,17,18)

MLElkM1_Area_{{Elk_Area}}_ArmUpMsg

Description:

Values: (Not Ready, Ready, Ready w/ Violation, Armed, Force Armed, Armed w/ Bypass)

MLElkM1_Area_{{Elk_Area}}_ArmUpVal

Description:

Values: (0,1,2,4,5,6)

MLElkM1_Area_{{Elk_Area}}_BCMode

Description:

Values: BeepChime Mode 0..1

MLElkM1_Area_{{Elk_Area}}_Name

Description:

Values: User defined string

MLElkM1_Area_{{Elk_Area}}_StatusMsg

Description:

Values: (Disarmed, Armed Away, Armed Stay, Armed Stay Instant, Armed to Night, Armed to Night Instant, Armed to Vacation)

MLElkM1_Area_{{Elk_Area}}_StatusVal

Description:

Values: (0,1,2,3,4,5,6)

MLElkM1_{{Elk_Control}}_ControlStatusVal

Description:

Values: (0,1)

MLElkM1_{{Elk_Control}}_ControlStatusMsg

Description:

Values: (Off, On)

MLElkM1_SystemLog_Area

Description:

Values: (1..8)

MLElkM1_SystemLog_Date

Description:

Values: mm/dd

MLElkM1_SystemLog_EData

Description: Event Data

Values:

MLElkM1_SystemLog_Event

Description: Event Number

Values:

MLElkM1_SystemLog_Time

Description:

Values: hh:mm

MLElkM1_Time_ClockMode

Description:

Values: 1=12 hr, 0=24hr

MLElkM1_Time_Day

Description:

Values: (1..31)

MLElkM1_Time_DispMode

Description:

Values: mm/dd or dd/mm

MLElkM1_Time_DOW

Description:

Values: (Sunday..Saturday)

MLElkM1_Time_DST

Description:

Values: 1=DST, 0=Not DST

MLElkM1_Time_Hrs

Description:

Values: hh

MLElkM1_Time_Mins

Description:

Values: mm

MLElkM1_Time_Month

Description:

Values: mm

MLElkM1_Time_Secs

Description:

Values: ss

MLElkM1_Time_Year

Description:

Values: yy

MLElkM1_PLC_{{Elk_House_Code}}_{{Elk_Unit_Code}}_Val

Description:

Values: (0,2..100)

MLElkM1_PLC_{{Elk_House_Code}}_{{Elk_Unit_Code}}_Msg

Description:

Values: (On, Off)

MLElkM1_PLC_{{Elk_House_Code}}_AllUnitsOff

Description:

Values:

(True, False)

MLElkM1_PLC_{{Elk_House_Code}}_AllLightsOff

Description:

Values: (True, False)

MLElkM1_Keypad_{{Elk_Keypad}}_Area

Description:

Values: (1..8)

MLElkM1_Keypad_{{Elk_Keypad}}_ArmedMode

Description:

Values: (0,1)

MLElkM1_Keypad_{{Elk_Keypad}}_BCMode

Description:

Values: (0,1)

MLElkM1_Keypad_{{Elk_Keypad}}_BypassKey

Description:

Values: (0,1)

MLElkM1_Keypad_{{Elk_Keypad}}_BypassMode

Description:

Values: (0,1)

MLElkM1_Keypad_{{Elk_Keypad}}_ChimeKey

Description:

Values: (0,1)

MLElkM1_Keypad_{{Elk_Keypad}}_DataKey

Description:

Values: (0,1)

MLElkM1_Keypad_{{Elk_Keypad}}_DispLine1

Description:

Values: Variable Text

MLElkM1_Keypad_{{Elk_Keypad}}_DispLine2

Description:

Values: Variable Text

MLElkM1_Keypad_{{Elk_Keypad}}_DownKey

Description:

Values: (0,1)

MLElkM1_Keypad_{{Elk_Keypad}}_ElkKey

Description:

Values: (0,1)

MLElkM1_Keypad_{{Elk_Keypad}}_ExitKey

Description:

Values: (0,1)

MLElkM1_Keypad_{{Elk_Keypad}}_ExitMode

Description:

Values: (0,1)

MLElkM1_Keypad_{{Elk_Keypad}}_F1Key

Description:

Values: (0,1)

MLElkM1_Keypad_{{Elk_Keypad}}_F1Mode

Description:

Values: (0,1)

MLElkM1_Keypad_{{Elk_Keypad}}_F2Key

Description:

Values: (0,1)

MLElkM1_Keypad_{{Elk_Keypad}}_F2Mode

Description:

Values: (0,1)

MLElkM1_Keypad_{{Elk_Keypad}}_F3Key

Description:

Values: (0,1)

MLElkM1_Keypad_{{Elk_Keypad}}_F3Mode

Description:

Values: (0,1)

MLElkM1_Keypad_{{Elk_Keypad}}_F4Key

Description:

Values: (0,1)

MLElkM1_Keypad_{{Elk_Keypad}}_F4Mode

Description:

Values: (0,1)

MLElkM1_Keypad_{{Elk_Keypad}}_F5Key

Description:

Values: (0,1)

MLElkM1_Keypad_{{Elk_Keypad}}_F5Mode

Description:

Values: (0,1)

MLElkM1_Keypad_{{Elk_Keypad}}_F6Key

Description:

Values: (0,1)

MLElkM1_Keypad_{{Elk_Keypad}}_F6Mode

Description:

Values: (0,1)

MLElkM1_Keypad_{{Elk_Keypad}}_LeftKey

Description:

Values: (0,1)

MLElkM1_Keypad_{{Elk_Keypad}}_PoundKey

Description:

Values: (0,1)

MLElkM1_Keypad_{{Elk_Keypad}}_ReadyMode

Description:

Values: (0,1)

MLElkM1_Keypad_{{Elk_Keypad}}_RightKey

Description:

Values: (0,1)

MLElkM1_Keypad_{{Elk_Keypad}}_StarKey

Description:

Values: (0,1)

MLElkM1_Keypad_{{Elk_Keypad}}_StayKey

Description:

Values: (0,1)

MLElkM1_Keypad_{{Elk_Keypad}}_StayMode

Description:

Values: (0,1)

MLElkM1_Keypad_{{Elk_Keypad}}_UpKey

Description:

Values: (0,1)

MLElkM1_KPProbe_{{Elk_Keypad}}_Temp

Description:

Values: Actual Temperature at keypad

MLElkM1_CV_{{Elk_Custom_Value}}_Val

Description:

Values: (0..65535)

MLElkM1_CV_{{Elk_Custom_Value}}_Style

Description: xx = Custom Value (01..20)

Values: (0-Number, 1=Timer, 2=Time Of Day)

MLElkM1_TaskChange

Description:

Values: (1..32)

MLElkM1_{{Elk_Thermostat}}_Mode

Description: Where xx = Thermostat # (01..16)

Values: (0=Off, 1=Heat, 2=Cool, 3=Auto, 4=Emergency Heat)

MLElkM1_{{Elk_Thermostat}}_Hold

Description:

Values: (0=False, 1=True)

MLElkM1_{{Elk_Thermostat}}_Fan

Description:

Values: (0=Auto, 1=Fan On)

MLElkM1_{{Elk_Thermostat}}_CurrentTemp

Description: Actual Temperature

Values:

MLElkM1_{{Elk_Thermostat}}_HeatSetPoint

Description: Set Point Value

Values:

MLElkM1_{{Elk_Thermostat}}_HeatSetPointGoal

Description: Desired Set Point Value

Values:

MLElkM1_{{Elk_Thermostat}}_CoolsetPoint

Description: Set Point Value

Values:

MLElkM1_{{Elk_Thermostat}}_HeatSetPoint

Description: Set Point Value

Values:

MLElkM1_{{Elk_Thermostat}}_HeatSetPointGoal

Description: Desired Set Point Value

Values:

MLElkM1_{{Elk_Thermostat}}_CoolsetPoint

Description: Set Point Value

Values:

MLElkM1_{{Elk_Thermostat}}_CoolsetPointGoal

Description: Desired Set Point Value

Values:

MLElkM1_{{Elk_Thermostat}}_CurrentHumidity

Description:

Values: (1..99, 0=N/A)

MLElkM1_Zone_{{Elk_Zone}}_Name

Description: Where xxx = Zone # (001..208)

Values: User Defined String

MLElkM1_Zone_{{Elk_Zone}}_PartitionVal

Description:

Values: (0,1,2,3,4,5,6)

MLElkM1_Zone_{{Elk_Zone}}_StatusMsg

Description:

Values: Normal - Unconfigured, Normal, Open, Normal, EOL, Normal, Short, Trouble, Open, Trouble, EOL, Trouble, Short, Violated, Open, Violated,EOL, Violated, Short, Bypassed, Open, Bypassed, EOL, Bypassed - Short)

MLElkM1_Zone_{{Elk_Zone}}_StatusVal

Description:

Values: (0,1,2,3,5,6,7,9,10,11,13,14,15)

MLElkM1_Zone_{{Elk_Zone}}_DefinitionVal

Description:

Values: (0..36)

MLElkM1_Zone_{{Elk_Zone}}_DefinitionMsg

Description:

Values: (Disabled, Burglar Entry/Exit 1, Burglar Entry/Exit 2, Burglar Perimeter Instant, Burglar Interior, Burglar Interior Follower, Burglar Interior Night, Burglar Interior Night Delay, Burglar 24 Hour, Burglar Box Tamper, Fire Alarm, Fire Verified, Fire Supervisory, Aux Alarm 1, Aux Alarm 2, Keyfob, Non Alarm, Carbon Monoxide, Emergency Alarm, Freeze Alarm, Gas Alarm, Heat Alarm, Medical Alarm, Police Alarm, Police No Indication, Water Alarm, Key Momentary Arm / Disarm, Key Momentary Arm Away, Key Momentary Arm Stay, Key Momentary Disarm, Key On/Off, Mute Audibles, Power Supervisory, Temperature, Analog Zone, Phone Key, Intercom Key)

MLElkM1_{{Elk_Zone}}_ZoneBypassVal

Description:

Values: (0,1)

MLElkM1_{{Elk_Zone}}_ZoneBypassMsg

Description:

Values: (Unbypassed, Bypassed)

Workshop

Sending MLServeCmd's from the ELK

  1. Load the ELKRP Software
  2. After selecting your account, select RULES from the tree menu on the left
  3. Based on any condition, you can specify sending an MLServeCmd Through Port 0. Each command should be followed by ^M.
Example

WHENEVER Counter02 (Counter 2) CHANGES TO 20

THEN SEND THE FOLLOWING TEXT: "MLServeCmd.SetVariable|MLElkCounter02~20^M" THROUGH PORT 0