Specifications

ManualsBrandsElk Products ManualsMusical equipmentELK-M1XEP

M1 Control RS-232 ASCII String Protocol Page 1 of 68 Rev. 1.79 July 16, 2009

ELK

Products, Inc.

M1 Security and Automation Controller

ASCII Protocol

RS-232 Interface Specification

Revision 1.79

July 16, 2009

Specifications subject to change without notice.

Hildebran, NC 28637 USA

Summary of content (68 pages)

PAGE 1
ELK Products, Inc. M1 Security and Automation Controller ASCII Protocol RS-232 Interface Specification Revision 1.79 July 16, 2009 Specifications subject to change without notice. All rights reserved. Copyright 2004, 2005, 2006, 2007, 2008, 2009 by Elk Products, Inc. Hildebran, NC 28637 USA M1 Control RS-232 ASCII String Protocol Page 1 of 68 Rev. 1.
PAGE 2
Table of Contents (ASCII Commands) 1. General...................................................................... 11 2. Electrical/Mechanical Specifications ..................... 11 3. Error Checking ......................................................... 11 4. Messages .................................................................. 12 4.1 Data Packet Format ....................................................................................................................12 4.1.1 4.1.2 4.1.3 4.1.
PAGE 3
4.9 Control Output Messages...........................................................................................................22 4.9.1 4.9.2 4.9.3 4.9.4 4.9.5 4.10 Control Output off (cf)............................................................................................................................ 23 Control Output On (cn)........................................................................................................................... 23 Control Output Status Request (cs) .
PAGE 4
.23.2 4.24 Zone Temperature And Keypad Temperature (LW)..............................................................38 4.24.1 4.24.2 4.25 Request Temperature Data (lw) ......................................................................................................... 38 Reply Temperature Data (LW) .......................................................................................................... 38 Power Line Carrier (PLC) Data (PC) ......................................................
PAGE 5
4.38 Zone Change Update (ZC) .........................................................................................................51 4.39 Zone Status Messages (ZB) ........................................................................................................53 4.39.1 4.39.2 4.39.3 4.39.4 4.39.5 4.39.6 4.39.7 4.40 Zone Definition (ZD)...................................................................................................................55 4.40.1 4.40.2 4.40.3 4.
PAGE 6
M1 Command Summary Lower case is command to control. Upper case is data from control.
PAGE 7
ss –Request System Trouble Status SS – System Trouble Status data st – Request temperature ST – Temperature report data sw – Speak word t2 – Request Omnistat 2 data T2 – Reply Omnistat 2 data TC – Task change update tn – Task activation tr – Request thermostat data TR – Thermostat data report ts – Set thermostat data ua – Request user code areas UA – User code areas report data vn – request Version Number of M1 VN – Reply Version Number of M1 XB – reserved by ELKRP xk – Reply from Ethernet test XK – Reques
PAGE 8
Rev. 1.16 – 8/24/04 – Added Thermostat Humidity support Rev. 1.17 – 8/27/04 – Enhanced Arming Status Request, Added Zone Definition data. Rev. 1.18 – 9/21/04 – Requesting Names, sd command, returns name whose first character is > “space” or last name in name array. Rev. 1.19 – 10/15/04 – Added checksum C code routines. Rev. 1.20 – 10/22/04 – PLC reply, “PS” command, replies with light level value to 48 (0x30) added to the value. Rev.1.21 – 10/26/04 – Added ‘*’ key to “4.
PAGE 9
Rev. 1.44 – 6/7/05 Added the “ld”, request log data command and added the index number to the “LD” log data command. Rev. 1.45 – 6/10/05 Added day of week and year to “LD” log data reply. Rev. 1.46 - 6/16/05 Added Keypad Number to “IC” command. Added Event Table. Rev. 1.47 – 6/30/05 Added lw and LW command to request temperature sensor and keypad temperature. Rev. 1.48 – 7/12/05 Added M1SDK software documentation. Rev. 1.49 – 8/15/05 Corrected length of “ZC” example.
PAGE 10
Rev. 1.76 - 4/21/2009 – Modified XK description. Rev. 1.77 – 5/04/2009 – Modified EE command to add Armed State to command string. Rev. 1.78 – 7/08/2009 – Removed ASCII audio commands (CD) and use numbers in command strings Rev. 1.79 – 7/16/2009 – Explained the SS command of extracting zone troubles from string. M1 Control RS-232 ASCII String Protocol Page 10 of 68 Rev. 1.
PAGE 11
1. General This document describes the protocol specifications for the ELK M1 Security and Automation Controller’s RS232 serial interface port and related controls including the ELK EZ8 Control. This port allows communications between the M1 and various ‘third party’ devices such as computers, lighting, HVAC, and many types of automation devices on a realtime basis. Connection to the port is via a 9-pin “DB-9” cord. You can use any PC connected to the RS232 port to communicate with the control panel.
PAGE 12
4. Messages With the exception of the message terminator, CR-LF, all characters are printable ASCII. See Appendix for an example of C source for generating a well-formed message string. A packet length and checksum generator program is available from ELK Products, Inc. to generate test ASCII packets. The program is called M1_SDK.exe. 4.1 Data Packet Format Data packets both from a PC to the control panel and from the control panel to a PC use the following format. NNMSD...
PAGE 13
4.1.7 Terminator (CR-LF) Message terminator. ASCII characters consisting of hexadecimal 0x0D and 0x0A. The 0x0A is optional. A message terminator may also use the 0x0A only. NNMSD...0 0 CC (CR-LF ) packet protocol 4.1.8 Message Processing Time: The M1’s incoming message buffer can hold up to 250 characters. Control messages take different times to process messages: Lighting control messages may take up to 500 ms to process the message and send it to a M1XSP Serial Port Expander if it is used.
PAGE 14
4.2.2 Arm to Away (a1) 0Da11001234003F(CR-LF) Example: a1=arm away, 1=Area 1, 001234=User Code 1234. 4.2.3 Arm to Stay (Home) (a2) 0Da23005678002C(CR-LF) Example: a2=arm stay, 3=Area 3, 005678=User Code 5678. 4.2.4 Arm to Stay Instant (a3) 0Da380056780026(CR-LF) Example: a3=arm stay instant, 8=Area 8, 005678=User Code 5678. 4.2.5 Arm to Night (a4) 0Da480056780025(CR-LF) Example: a4=arm night, 8=Area 8, 005678=User Code 5678. 4.2.
PAGE 15
Example: 06as0066(CR-LF) Request Arming status The control panel responds to this message with an Arming Status Report 4.2.11 Reply Arming Status Report Data (AS) 1E – Length as ASCII hex AS – Reply with zone definition data S[8] - Array of 8 area armed status. U[8] - Array of 8 area arm up state. A[8] - Array of 8 area alarm state. 00 – future use, M1 Version 4.11 and later, contains the first found Exit time if U[x] = ‘3’ or Entrance time if A[x] = ‘1’ as two digits hex in seconds.
PAGE 16
Aux3Alarm = ‘9’, //not used Aux4Alarm = ‘:’, //not used CarbonMonoxideAlarm = ‘;’, EmergencyAlarm = ‘<’, FreezeAlarm= ‘=’, GasAlarm = ‘>’, HeatAlarm = ‘?’, WaterAlarm = ‘@’, FireSupervisory = ‘A’, VerifyFire = ‘B’, 4.3 Send ASCII String To IP Address(AP) The AP command allows you to send a custom ASCII string message via TCP/IP to a specific IP address on a specific port. To accomplish this, you need to create a TEXT string in the Automation/Text section of ELKRP which is stored in the M1.
PAGE 17
CR/LF. The Zone Status is 208 bytes and is identical to the “data” portion of the “ZS” ASCII command. EXAMPLE: 00AP43SendingZoneStatus^M^J Packet Data: SendingZoneStatus(208 bytes of ZS zone status) (CR-LF) 4.4 Ethernet Central Station Reporting (AR) 4.4.1 Alarm Reporting (AR) Reporting of alarms through the built on serial port 0 consists of an ASCII string following the same data format of the digital dialer’s Contact ID transmission.
PAGE 18
Example: 07 AT 1 00 73 Send keep alive signal to the M1XEP and test IP address 1. Spaces are for readability only. 4.4.4 Alarm Reporting Test Acknowledge (at) If the Alarm Reporting Test if successful to the central station’s IP address the Acknowledge message will be sent to the M1 from the M1XEP: 06at0065. 4.4.5 Ethernet Module Test (XK) The “XK” command is automatically sent every 30 seconds. This is done regardless of whether an M1XEP Ethernet Module is present or not.
PAGE 19
4.5 Alarm By Zone Request (AZ) 06 az 00 CC – – – – Length as ASCII hex M1 version 4.3.9 and later Request alarm by zone future use Checksum Example: 06az005F (CR-LF) Request alarm by zone The control panel responds to this message with an Alarm By Zone Report 4.5.1 Reply Alarm By Zone Report Data (AZ) D6 – Length as ASCII hex M1 version 4.3.9 and later AZ – Reply with zone definition data Z[208] - Array of 208 bytes showing alarm by zone. A value of ‘0’ or 0x30 indicates the zone is not in alarm.
PAGE 20
4.6 Touchscreen Audio Command (CA) This command is used by the touchscreens to request audio status data from the M1XEP for audio control display. It is not used by the M1. The M1XEP intercepts the command packet and sends translated commands to the audio equipment. This command is available on ELKRMS touchscreen software. 4.6.1 Request Audio Data (ca) 08 ca NN 00 CC – – – – – Length as ASCII hex Read custom value Which zone to request data on.
PAGE 21
The Output Change Update will also be transmitted out M1XSP Serial Port Expanders that are configured in the Generic Mode. 4.8 Audio Equipment Command (CD) An M1XEP Ethernet Module is required to intercept the “cd” command. These commands are sent into the M1XEP via the Ethernet connection and passed through to the M1. The M1XEP builds custom audio commands to control the audio equipment and sends these commands to the audio equipment via ethernet.
PAGE 22
Play Pause Stop Select Favorite #1 Select Favorite #2 Minus Plus All Zones Off All Zones On Audio System Manufacturer 11-Starts source Play 12-Pauses Play 13-Stop Play 14-Executes Favorite Playlist 1. 15-Executes Favorite Playlist 2. 16-Down Select 17-Up Select 18-Turn all zones off 19-Turn all zones on 20-Version number, VVV value: 0 = No audio configured 1 = Russound 2 = Nuvo 3 = Proficient 99 = IP Failure 4.8.
PAGE 23
4.9.1 Control Output off (cf) 09cfDDD00CC(CR-LF) Example: turn off Control Output 2: 09cf00200DC(CR-LF ) 4.9.2 Control Output On (cn) 0EcnDDDTTTTT00CC(CR-LF) Example: turn on Control Output 1 for 10 seconds: 0Ecn0010001000D8(CR-LF ) 4.9.3 Control Output Status Request (cs) 06cs0064(CR-LF) The control panel responds with a Control Output Status Report for all 208 outputs. 4.9.
PAGE 24
4.10.2 Read ALL Custom Values (cp) 06 – Length as ASCII hex cp – Read ALL custom values 00 – future use CC – Checksum Example: 06cp0067 Read all custom values. 4.10.3 Reply With Custom Value (CR) 0E – Length as ASCII hex Length fixed in M1 Version 4.3.1 and later CR – Returned custom value NN – Which Custom Value to be returned (2 decimal ASCII digits, 1 based). ie.”16” = custom value 16. Range 1 to 20.
PAGE 25
digits, 1 1 to 20. digits) cw – write custom value NN – Which Custom Value to be written (2 decimal ASCII based). ie.”16” = custom value 16. Range DDDDD – 16 bit Custom Value to write ( 5 decimal ASCII If the Custom Value Format the hours in bytes 3 and 4 the minutes in bytes 1 and Then convert that value to DDDDD value. 00 – future use CC – Checksum = 2, Time of day, place as a hexidecimal value and 2 as a hexidecimal value.
PAGE 26
4.11.2 Reply Change User Code (CU) 0B – Length as ASCII hex CU – Reply Lighting Device Status data ccc – 000 = User code change denied due to invalid authorization code, 001 to 254 indicates user code that was changed. 255 = new code is a duplicate and change is denied. 00 – future use CC – Checksum 09CU005000A User code 005 was changed. Example: Example: 09CU000000F User code denied due to invalid authorization code. 09CU2550003 User code denied due to duplicate Example: code.
PAGE 27
digits, 1 64. NN – Which Counter Value to be returned (2 decimal ASCII based). ie.”16” = counter value 16. Range 1 to DDDDD – 16 bit Counter Value returned (Five decimal ASCII digits). Range 0 to 65535. 00 – future use CC – Checksum Example: 0Dcx011234500F1 Write counter number 1 to a value of 12345. Returns “CV” command string as reply. 4.12.3 Reply With Counter Value Format (CV) digits, 1 64.
PAGE 28
If the second line is not needed, enter a “^”as the first character of the second line. The second line will be scrolled with the first line if it is included. LCD will display: Ready To Arm abc then Ready To Arm ABCDEF 4.14 Lighting Device Status Poll (DS) This command allows the M1 to poll single light devices to obtain their on, off, dim status. This will be an automatic command issued from the M1 to the M1XSP Type modules that connect to lighting devices.
PAGE 29
ttt – Timer 1 value in seconds. Range “000” to “255” seconds. TTT – Timer 2 value in seconds. Range “000” to “255” seconds. S – Armed State 0=Disarmed 1=Armed Away 2=Armed Stay 3=Armed Stay Instant 4=Armed Night 5=Armed Night Instant 6=Armed Vacation 00 – future use CC – Checksum Example 1: 0FEE10060120100E5Area 1, Exit 1 Time = 060, Exit 2 Time = 120 seconds started, Armed Away. Example 2: 0FEE21030254200DD Area 2, Entrance 1 Time = 030, Entrance 2 Time = 254 seconds started, Armed Stay. 4.
PAGE 30
4.17 Send Valid User Number And Invalid User Code (IC) This ASCII Data Packet will be sent when a user code is entered and a valid code is found. Only the valid user code number will be returned. If a user code is not found in the M1’s User Code Data Base, the code that was enter will be sent. If the User Code Length is set to 4 digits, the invalid data packet will be sent after 4 digits are entered, then repeated for each additional invalid user code digit.
PAGE 31
Low nibble has fourth character of keypad code entry. 000 – Valid user code number. Set to 0 for an invalid user code. 01 - Keypad number 01 generated the code. 00 - Future Use CC – Checksum Example 2: 17IC 123456789012 000 01 004B Invalid 26 bit Weigand prox card code. Prox card codes use the high and low nibbles of the 6 bytes of code data. Spaces in this example are for reading clarity only. 17IC – length and command 123456789012 - Example prox card code. ASCII Hex (0 to F).
PAGE 32
4.19 Insteon Lighting Systems for the M1XSP Serial Port Expander (IR) This command allows programming and reading from the M1XSP Serial Port Expander the Insteon device addresses. The M1XSP’s jumper configuration is set for Insteon Operation and the alternate application code in the M1XSP has been loaded with the Insteon Application. Commands may be sent to program and read the Insteon device IDs. Lighting device descriptions may also be accessed from the M1.
PAGE 33
4.19.3 Request Read Of Insteon Lighting Device Data (ir) 0A – Length as ASCII hex ir – Request read of Insteon lighting device data aaa – Starting Lighting device number 001 to 192 n - Number of devices to return, 1-8 00 – future use CC – Checksum 0Air0018008B Request read of lighting device data Example: starting at device 001 and returning 8 devices. 4.19.
PAGE 34
4.20 Request Keypad Area Assignments (KA) This request command allows automation equipment to request the Areas that all keypads are assigned to. The return string contains a 16 byte array with keypad 1’s area at array index 0 and keypad 15’s area in array index 15. M1 Version 4.2.5 and after. 4.20.1 Request Keypad Area Assignment (ka) 06 ka 00 6E – – – – Length as ASCII hex Request keypad areas future use Checksum Example: 06ka006E Request keypad areas. 4.20.
PAGE 35
Key Table: NO KEY = 0 or a user code was sent from a keypad. STAR KEY (*) = 11 POUND KEY (#) = 12 F1 KEY = 13 F2 KEY = 14 F3 KEY = 15 F4 KEY = 16 STAY KEY = 17 EXIT KEY = 18 CHIME KEY = 19 BYPASS KEY = 20 ELK KEY = 21 DOWN KEY = 22 UP KEY = 23 RIGHT KEY = 24 LEFT KEY = 25 F6 Key = 26 F5 Key = 27 DATAKEYMODE = 28 Data was entered, this acts as a carriage return Beep and Chime mode bit settings by area (P[8]): Version 4.3.2 and after.
PAGE 36
Returns: 11KC01001000000009E Keypad 1’s Function Key F1 is illuminated as described in “KC” command above. 4.22 Keypad Function Key Press (KF) This command simulates a function key being pressed on a keypad. This will only be single key press even if the M1 Control is programmed for double function key press. M1 Version 4.2.5 and after. ‘*’ key M1 Version 4.2.6 and after, ‘C’ key M1 Version 4.3.2 and after. 4.22.
PAGE 37
4.23 System Log Data Update (LD) As the control log is written, the same information is sent out the RS-232 port. The log information will have the ddd index value set to “000” to indicate a logging entry. The log data may also be requested with the “ld” (lower case “LD”) command below. Modified in M1 version 4.3.2 1CLDEEEENNNAHHMMmmDDdddDYY00CC 1C – Length as ASCII hex LD – Log Data Message Command EEEE – Event NNN – Event Number Data, i.e. Zone number, user number, etc.
PAGE 38
4.23.2 Request Write Log Data (le) The Write Log Data Command “le” writes log data into the M1 log specifically to trigger communicator reporting to the central station. A valid zone must be programmed for communicator reporting. The M1 will return an “OK”crlf response when the data is written to the log.
PAGE 39
4.25 Power Line Carrier (PLC) Data (PC) The Power Line Carrier (PLC) data includes X-10 and other PLC interfaces.
PAGE 40
LL – Level/scene/state Status, 0 = OFF, 1 = ON, 2-99 = light level percentage 00 – future use CC – Checksum Example: 0BPCA01000099 PLC change – A01, changed to OFF Special: When an All_Lights_On, All_Lights_OFF, or All_Units_Off command is transmitted the Unit Code will equal 00, and the Level (LL) will be: X10_ALL_UNITS_OFF = 01 X10_ALL_LIGHTS_ON = 02 X10_ALL_LIGHTS_OFF = 07 This transmission update option transmits the updated status whenever it changes and is enabled by setting the location TRUE in the
PAGE 41
4.25.6 Returned PLC status (PS) 47PSBD… 00PCC 47 – Length as ASCII hex PS – request PLC status Command B - Bank, 0=A1 to D16, 1=E1 to H16, 2=I1 to L16, 3=M1 to P16 D - 64 bytes, current status of the PLC environment by bank 0 to 3. Subtract 48 or 0x30 hex from the value in “D”. This will give the light level value, (M1 version 4.2.6) then 0 = OFF, 1 = ON, 2 – 99 = Dim Level.
PAGE 42
4.27 ELKRP Connected (RP) The M1XEP sends the following ASCII command out to all socket connected devices when ELK RP, Upload/Download Software, disconnects from the M1: 08RP000036. ELKRP disconnected broadcast. The M1XEP replies to any poll when ELKRP is connected to the M1: 08RP010035. ELKRP is connected, poll reply The M1XEP replies to any poll when the M1XEP is initializing after a powerup or reboot: 08RP020034. M1XEP is initializing after powerup or reboot.
PAGE 43
hh – Hour as two ASCII characters decimal, “00” to “23” 24 hour D – Day of week as one ASCII character, “1”=Sunday to “7”=Saturday DM – Day of month as two ASCII characters decimal, “01” to “31” MM – Month as two ASCII characters decimal, “01” to “12” YY – Year as two ASCII characters decimal, “00” to “99” as in 2099 00 – future use CC – Checksum Example: 13rw305923111050500C0 Set Real Time Clock to: May 11, 2005 at 11:59:30 PM or 23:59:30 hours. Sunday day of week.
PAGE 44
If the first character in a requested name is a “space” or less, then the next names are searched until a name is found whose first character is greater than “space” or the “Show On Keypad” bit is set. If no valid names are found, a “000” for the NNN address is returned. This speeds up the loading of names so that invalid names are not returned. M1 version 2.4.6 or later. 4.29.
PAGE 45
EEProm Memory Error Trouble – “0” = normal, “1” = trouble Low Battery Control Trouble – “0” = normal, “1” = trouble *Transmitter Low Battery Trouble – “0” = normal Over Current Trouble – “0” = normal, “1” = trouble Telephone Fault Trouble – “0” = normal, “1” = trouble Not Used = “0” Output 2 Trouble – “0” = normal, “1” = trouble Missing Keypad Trouble – “0” = normal Zone Expander Trouble – “0” = normal, “1” = trouble Output Expander – “0” = normal, “1” = trouble Not Used = “0” ELKRP Remote Access – “0” = no
PAGE 46
4.31 Request Temperatures (ST) This request command allows automation equipment to read temperatures of the temperature probes connected to zones 1 to 16, Keypad temperature from the sensor in each LCD keypad, and Thermostat temperatures. Each Group can have upto 16 temperature sensors. Version 4.2.8 and later sends automatic temperature updates out Port 0 when any temperature device parameter changes. 4.31.
PAGE 47
4.32 System Word Messages (sp) In all system word messages, the Data field is a 1-based 3-digit decimal number corresponding to the number of the desired word or phrase. 4.32.1 Speak Word at Voice/Siren Output (sw) 09swDDD00CC(CR-LF) 4.32.2 Speak Phrase at Voice/Siren Output (sp) 09spDDD00CC(CR-LF) Example: Speak Word 123 at Voice/Siren Output is 09sw12300B7(CR-LF ) Example: Speak Phrase 123 at Voice/Siren Output is 09sp12300BE(CR-LF ) See 6.
PAGE 48
4.34.1 Task Flag Activation 09tnDDD00CC(CR-LF) Example: activate Task 1: 09tn00100C4(CR-LF ) 4.35 Thermostat Control (TR) This command allows automation equipment to monitor and control HVAC Thermostats connected to the M1. All temperature settings are expressed in ASCII Decimal, two digits. M1 Version 4.2.6 and after. 4.35.
PAGE 49
3 = Current Temperature setting from controller with thermostat else not used. Version 5.1.6 4 = CoolSetPoint VV= [Cool setpoint if in Cool/auto mode, 01 to 99] 5 = HeatSetPoint VV= [Heat setpoint if in heat/auto mode, 01 to 99] 00 – future use CC – Checksum 0Bts01704004B Set Thermostat Cool Set Point Example: element – Thermostat 01 to 70 degrees. Reply Thermostat Data will reply to Set Thermostat Data. 4.35.
PAGE 50
4.36 Version Number of M1 and M1XEP (VN) The vn command requests the M1’s version number, and the VN command replies with the version number data. If an M1XEP is connected to the M1, the M1XEP’s version number will also be included. Available in M1 version 4.1.12 or 5.1.12 and later. M1XEP 1.3.2 or later. 4.36.1 Request M1 Version Number (vn) 06 vn 00 CC 4.36.2 – – – – Length as ASCII hex Request the M1’s version number data future use Checksum 06vn0056 Request the M1’s version number.
PAGE 51
4.37 Request Valid User Code Areas (UA) This request command allows automation equipment to send a user code to the control and have returned what areas the code is valid in. The returned value is an 8 bit masked value with bit 0 corresponding to area 1, up to bit 7 corresponding to area 8. If the returned value is 0, then the code is not valid in any area. M1 Version 4.2.5 , type of code is in Version 4.3.6 and after. 4.37.
PAGE 52
Zone Status Table, S Value, hex lower nibble Hex Value 0= Normal Unconfigured 0000 1= Normal Open 0001 2= Normal EOL 0010 3= Normal Short 0011 4= not used 5= Trouble Open 0101 6= Trouble EOL 0110 7= Trouble Short 0111 8= not used 9= Violated Open 1001 A(10)= Violated EOL 1010 B(11)= Violated Short 1011 C(12)= not used D(13)= Bypassed Open 1101 E(14)= Bypassed EOL 1110 F(15)= Bypassed Short 1111 Example: 0AZC002200CE Zone change – zone 2, restored to Normal EOL This transmission update option transmits the
PAGE 53
4.39 Zone Status Messages (ZB) You can send a query to the control panel for its zone status (open, closed, trouble, alert, bypassed). The control panel will respond with a Zone Status or Zone Partition Status message for all 208 zones. In addition, the control panel can be programmed with Global Programming Location 30 to automatically send zone status messages whenever there is a change of status. 4.39.1 Zone Bypass Request (zb) This command allows for bypassing/unbypassing a zone.
PAGE 54
Example: a Zone Partition Report for a system in which Zone 1 is assigned to Partition 2. Zone 2 is assigned to no partition, and Zone 3 is assigned to Partition 8, would begin D7ZP208.... 4.39.5 Zone Status Request (zs) 06zs004D(CR-LF) The control panel responds with a Zone Status Report. Note: This message should be sent only when an initial connection is made with the control panel. It is not intended to be used as a ‘polling’ command.
PAGE 55
3= 4= 5= 6= 7= 8= 9= A(10)= B(11)= C(12)= D(13)= Normal Short not used Trouble Open Trouble EOL Trouble Short not used Violated Open Violated EOL Violated Short Soft Bypassed Bypassed Open E(14)= Bypassed EOL F(15)= Bypassed Short 0011 0101 0110 0111 1001 1010 1011 1000 temporary bypass of zone until normal 1101 not implemented through M1 version 4.2.6 1110 not implemented through M1 version 4.2.6 1111 not implemented through M1 version 4.2.
PAGE 56
4.40.
PAGE 57
4.41.3 Reply Programming Of Insteon Lighting Device Data (IP) 0A – Length as ASCII hex IP – Reply Programming of Insteon lighting device data aaa – Starting Lighting device number 001 to 192 n - Number of devices being programmed, 1-8 00 – future use CC – Checksum Example: 0AIP001400D1 Reply Acknowledge Programming Insteon lighting device ID data for device 001 to 004. Note: Insteon Lighting Device 193 to 256 corresponds to Insteon Groups 1 – 64.
PAGE 58
5. Interpreting M1/EZ8 Event Log Extended Data Information M1 and EZ8 event log data may be read from the control using the “ld” command. If enabled (via programming G35), the control will transmit events out the serial port as they are written to the log. Some events store extended information such as user, zone, or keypad number. The following table lists those events that may contain extended information. If an event is not listed in the table, its extended info does not apply and should be ignored.
PAGE 59
Type 1 2 3 4 5 Meaning Zone Number or Keypad Number and F-Key Interpretation of Ext Info Field in Log Entries If 1-208, interpret as zone number. If > 400, 401=KP1-F1, 402=KP1-F2, … 407=KP2-F1, … 496=KP16-F6. User Number If control’s firmware is older than 4.4.0, the ext info is 1-99; and 101=Installer, 102=ElkRP, 103=NoCode. If control’s firmware is 4.4.0 or higher, the ext info is 1-199; and 201=Installer, 202=ElkRP, 203=NoCode.
PAGE 60
6. Word And Phrase Table 6.1 Words 1-_Custom1 2-_Custom2 3-_Custom3 4-_Custom4 5-_Custom5 6-_Custom6 7-_Custom7 8-_Custom8 9-_Custom9 10-_Custom10 11-Not Implemented 12-Not Implemented 13-Not Implemented 14-Not Implemented 15-Not Implemented 16-Not Implemented 17-Not Implemented 18-Not Implemented 19-Not Implemented 20-Not Implemented 21-Zero.wav 22-One.wav 23-Two.wav 24-Three.wav 25-Four.wav 26-Five.wav 27-Six.wav 28-Seven.wav 29-Eight.wav 30-Nine.wav 31-Ten.wav 32-Eleven.wav 33-Twelve.wav 34-Thirteen.
PAGE 61
257-Left.wav 258-Less.wav 259-Level.wav 260-Library.wav 261-Light.wav 262-Lights.wav 263-Line.wav 264-Living_room.wav 265-Loading.wav 266-Lobby.wav 267-Location.wav 268-Lock.wav 269-Low.wav 270-Lower.wav 271-M.wav 272-Machine.wav 273-Mail.wav 274-Main.wav 275-Mains.wav 276-Manual.wav 277-Master.wav 278-Max.wav 279-Media.wav 280-Medical.wav 281-Medicine.wav 282-Memory.wav 283-Menu.wav 284-Message.wav 285-Middle.wav 286-Minute.wav 287-Missing.wav 288-Mode.wav 289-Module.wav 290-Monitor.wav 291-More.
PAGE 62
Zone 28 (vm28) Zone 29 (vm29) Zone 30 (vm30) Zone 31 (vm31) Zone 32 (vm32) Zone 33 (vm33) Zone 34 (vm34) Zone 35 (vm35) Zone 36 (vm36) Zone 37 (vm37) Zone 38 (vm38) Zone 39 (vm39) Zone 40 (vm40) Zone 41 (vm41) Zone 42 (vm42) Zone 43 (vm43) Zone 44 (vm44) Zone 45 (vm45) Zone 46 (vm46) Zone 47 (vm47) Zone 48 (vm48) Zone 49 (vm49) Zone 50 (vm50) Zone 51 (vm51) Zone 52 (vm52) Zone 53 (vm53) Zone 54 (vm54) Zone 55 (vm55) Zone 56 (vm56) Zone 57 (vm57) Zone 58 (vm58) Zone 59 (vm59) Zone 60 (vm60) Zone 61 (vm61) Zo
PAGE 63
Key Switch (vm297) Fire Message 1 (vm298) Fire Message2 (vm299) Burglary Message 1 (vm300) Burglary Message 2 (vm301) Alarm (vm302) Alarm Memory (vm303) Bypassed (vm304) Auto Bypassed (vm305) Transmitter Low Battery (vm306) Trouble (vm307) Violated (vm308) Normal (vm309) Phone Arm Level 6 - Vacation Mode (vm284) Fire (vm285) Medical (vm286) Police (vm287) Emergency (vm288) Burglary (vm289) Carbon Monoxide (vm290) Freeze (vm291) Gas (vm292) Heat (vm293) Water (vm294) Auxiliary 1 (vm295) Auxiliary 2 (vm296)
PAGE 64
8.
PAGE 65
1136 = EEPROM MEMORY ERROR TROUBLE 1137 = FLASH MEMORY ERROR TROUBLE 1138 = AC FAILURE TROUBLE 1139 = CONTROL LOW BATTERY TROUBLE 1140 = CONTROL OVER CURRENT TROUBLE 1141 = EXPANSION MODULE TROUBLE 1142 = OUTPUT 2 SUPERVISORY TROUBLE 1143 = TELEPHONE LINE FAULT TROUBLE1 144 = RESTORE FIRE ZONE 1145 = RESTORE FIRE SUPERVISORY ZONE 1146 = RESTORE BURGLAR ZONE 1147 = RESTORE MEDICAL ZONE 1148 = RESTORE POLICE ZONE 1149 = RESTORE AUX1 24 HR ZONE 1150 = RESTORE AUX2 24 HR ZONE 1151 = RESTORE CO ZONE 1152 = RESTO
PAGE 66
1276 = EXIT DELAY, ANY AREA 1277 = AREA 1 EXIT DELAY 1278 = AREA 2 EXIT DELAY 1279 = AREA 3 EXIT DELAY 1280 = AREA 4 EXIT DELAY 1281 = AREA 5 EXIT DELAY 1282 = AREA 6 EXIT DELAY 1283 = AREA 7 EXIT DELAY 1284 = AREA 8 EXIT DELAY 1285 = AREA 1 EXIT DELAY ENDS 1286 = AREA 2 EXIT DELAY ENDS 1287 = AREA 3 EXIT DELAY ENDS 1288 = AREA 4 EXIT DELAY ENDS 1289 = AREA 5 EXIT DELAY ENDS 1290 = AREA 6 EXIT DELAY ENDS 1292 = AREA 8 EXIT DELAY ENDS 1293 = AUTOMATIC CLOSING 1294 = EARLY CLOSING 1295 = CLOSING TIME EXTENDED
PAGE 67
9. Calculate Checksum Calculate checksum on received and transmitted ASCII string Example C code program return( 11 ); //INT8U is an 8 bit unsigned integer. INT8U itAscRecBuf[82]; //ASCII receive character buffer INT8U AscHexToBin(INT8U, INT8U *); //ASCII hex to binary conversion INT8U AsciiToHex( INT8U); //Ascii to Hex conversion case 'C': return( 12 ); case 'D': return( 13 ); case 'E': return( 14 ); case 'F': return( 15 ); //Calculate checksum on a received ASCII string, return checksum value.
PAGE 68
10. Contact Information: Engineering Product Development Elk Products, Inc. PO Box 100 3266 Hwy 70 West Hildebran, NC 28637 USA 828-397-4200 800-797-9355 sales@elkproducts.com www.elkproducts.com M1 Control RS-232 ASCII String Protocol Page 68 of 68 Rev. 1.