Ness D8x D16x Serial Interface. ASCII Protocol

Transcription

1 Ness 8x x Serial Interface ASCII Protocol The Ness 8x x RS2 serial interface allows two-way communications with various external devices such as automation controllers, other control panels and PCs. This document provides the full 8x/x ASCII Protocol and is intended to be used by experienced installers, integrators and software engineers.

2 FRMG023 Rev.3 N S S S C U R I T Y P R O U C T S Project Name: X ASCII Serial Interface Project oc No. Rev No. Author: J. McG ate: 21/12/05 Sheet 1 of 14 8 S 27 5 INTROUCTION The X ALARM PANLS RS2 serial interface allows communication between various external devices. This document details the input and outputs messages all of which use an ASCII Protocol. The ASCII outputs are 1. vent data. 2. Panel status. The ASCII inputs are Keypad strings User code entry Arming The serial data is always 9600 baud, 8 data bits, no parity, 1 stop bit. NOT: This document refers to hexadecimal numbers, which are represented by the prefix 0x. ecimal numbers have no prefix. 1. Output vent ata These messages are sent as they occur in the x. The format of the message is: NAM START ARSS LNGTH COMMAN ATA TIM STAMP (decimal bytes) CHCKSUM FINISH LNGTH 1 BYT 1 BYT 1 BYT 1 BYT 3 BYTS 6 BYTS 1 BYT 2 BYTS I ST A L CM I A Y M H M SC CK CR LF R TYP HX HX HX HX H X C H X C C C C C C HX HX HX 1. START. The START byte defines the structure of the message being sent. Output vent ata on the X is always an ASCII message with optional Address & Time Stamp. Therefore the START byte for the Output vent ata on the X is derived from the following bit definitions. BIT Parameter efinition Program Option 1 () ARSS included P (0x02) Basic header - always ST NON - Fixed ON 3 (0x04) TIM STAMP included P Not used NON - Always OFF 7 (0x80) ASCII format NON - Fixed ON NOT: Values starting with 0x (such as 0x80) signify a hexadecimal number. This table shows the START value for different address/ time stamp selections. START ARSS AT/TIM P199 1 P199 2 BYT (hex) included included 87 Y Y On On 86 N Y Off On 83 Y N On Off 82 N N Off Off oc I. 8S27.OC 1

3 2. ARSS. The ARSS byte identifies the X sending the message. The address is either 0x00 or the last digit of the Account Number 2 (P73). Range is 0x00 to 0x0F (the Account Number can include hex numbers). XAMPL: If Account Number 2 = 1234, ARSS = TIM STAMP. These values are in decimal format. The time stamp includes the AT and TIM. It is 6 bytes YAR, MONTH, AY of Week & AY of Month, HOURS, MINUTS & SCONS. 1. YAR - 00 to MONTH - 01 (January) to 12 (ecember). 3. AY of MONTH - 1 to. The 3 MSB can also be used to represent the ay of the week, with 1 = MONAY. 4. HOURS 00 (midnight) to 23 (11pm) (12 is midday). Always 24hr format. The 3 MSB can also be used to represent aylight Saving. 5. MINUTS 0 to SCONS 0 to LNGTH & SQUNC NUMBR BIT. The SQUNC NUMBR BIT is the MSB of the LNGTH byte. It is either 0 or 1. For each new message the sequence number bit is toggled. The length of the Output vent ata is always 3 bytes. Therefore this byte is either 0x03 or 0x83 depending on the sequence bit. 5. COMMAN. This byte is fixed at 0x61 to indicate a SYSTM STATUS message. 6. ATA MSSAG. The data message is always 3 bytes to identify the VNT, the I and the ARA data. a. VNT. The VNT categories are: Zone or User VNTS Applicable I Applicable ARA Value escription Value escription Value escription Comment 0x00 Unsealed Sealed 01 to Zone 1 to 0x00 No Area Current zone state 01 to 56 User 1 to 56 0xa1 to 0xa3 oor 1 to oor 3 User access door 0x02 0x03 Alarm Alarm Restore 01 to Zone 1 to 0x02 0x03 0x04 0x80 0x81 0x85 0xf0 Keypad 0x81 0x82 0x83 0x84 01 to 56 User 1 to 56 Area 1 Monitor ay 24 hr Fire oor Fire Panic Medical uress When Armed Area 1 When Armed When Armed Monitor When Armed ay 24 hr 24hr converted to Fire oor Open too Long Keypad Fire Keypad Panic Keypad Medical Keypad uress 0x82 Panic Radio Panic 0x00 Main Unit 0x82 Panic Keyswitch Panic 0x04 0x05 Manual xclude Manual Include 01 to Zone 1 to 0x00 Area 1 Monitor 24 hr When Armed Area 1 When Armed When Armed Monitor 24 hr oc I. 8S27.OC 2

4 0x06 0x07 0x08 0x09 Auto xclude Auto Include Tamper Unsealed Tamper Normal 01 to Zone 1 to 0x00 Main Unit 0x00 0x00 Area 1 Monitor 24 hr Internal xternal When Armed Area 1 When Armed When Armed Monitor 24 hr Internal Tamper xternal Tamper 0xF0 Keypad 0x00 No Area Keypad Tamper 01 to Zone 1 to 0x91 Radio etector Radio etector Tamper System VNTS Applicable I Applicable ARA Value escription Value escription Value escription Comment 0x10 0x11 Power Failure Power Normal 0x00 Main Unit 0x00 No Area AC Mains Fail AC Mains Restored 0x12 Battery Failure 0x00 Main Unit 0x00 No Area Main Battery 0x13 Battery Normal 01 to 56 User 1 to 0x92 Radio Key Radio Key Battery to Zone 1 to 0x91 Radio etector Radio etector Battery 0x14 Report Failure 0x00 Main Unit 0x00 No Area ialler Fail to report 0x15 Report Normal 0x 0x17 Supervision Failure Supervision 01 to Zone 1 to 0x00 No Area Supervised zone failure Normal 0x19 Real Time Clock 0x00 Main Unit 0x00 No Area RTC Time or ate Changed Area VNTS Applicable I Applicable ARA Value escription Value escription Value escription Comment 0x20 0x21 ntry elay Start ntry elay nd 01 to Zone 1 to 0x02 0x03 Area 1 Monitor When Armed Area 1 When Armed When Armed Monitor 0x22 0x23 xit elay Start xit elay nd 01 to Zone 1 to 0x02 0x03 Area 1 Monitor When Armed Area 1 When Armed When Armed Monitor 0x24 Armed Away 01 to x25 Armed Home 01 to User 1 to 56 Keyswitch 57 Short Arm 58 User 1 to 56 Keyswitch 57 Short Arm 58 0x02 Area 1 When Armed Area 1 When Armed 0x03 Monitor When Armed Monitor 0x26 Armed ay 0x04 ay When Armed ay 0x27 Armed Night x28 Armed Vacation x2e Armed Highest x2f isarmed 01 to User 1 to 56 Keyswitch 57 0x Arming delayed 01 to 56 User 1 to 56 0x02 0x03 0x04 0x02 0x03 Area 1 Monitor ay Area 1 Monitor Auto arming delayed oc I. 8S27.OC 3

5 Result VNTS Applicable I Applicable ARA Value escription Value escription Value escription Comment 0x 0x Output On Output Off 0x00 - Outputs on 8x/x 01 to Aux 1 to 10 Siren Soft Siren Soft Monitor Siren Fire Strobe Reset Sonalert Keypad isplay nable 7. CHK. The checksum byte HX character results in the LSB being zero when all the message bytes are summed. This is done before the message is converted to ASCII and excludes the FINISH bytes. 8. FINISH. This is always CR, LF (Carriage Return, Line Feed). oc I. 8S27.OC 4

6 2. INPUT COMMANS There are 2 types of input commands: 1. Keypad strings. 2. Status Requests. The format of the input message is: NAM START ARSS LNGTH COMMAN ATA CHCKSUM FINISH LNGTH 1 BYT 1 BYT 1 BYT 1 BYT 1 BYTS 1 BYT 0-3 BYTS I ST A L CM CK CR LF TYP HX HX HX HX HX HX xample A123? CR LF F 0 0A 1. START. The START byte defines the structure of the message being sent. Input vent ata on the X is an ASCII message. This table shows the START value START BYT (hex) ARSS included AT/TIM included 83 Y N 2. ARSS. The ARSS byte identifies the X receiving the message. The address is either 0x0 or the last digit of the Account Number 2 (P73). Range is 0x00 to 0x0F (the Account Number can include hex numbers). XAMPL: If Account Number 2 = 1234, ARSS = 4. i) An address of 0 is always accepted. ii) An address other than 0 must match the last digit of P LNGTH. The length of the Input vent ata is variable with a maximum of bytes. 4. COMMAN. This byte is fixed at 0x60 to indicate a CM USR INTRFAC message. 5. ATA. The ATA is from 1 to bytes. Ascii Name escription A Arm Key ARM key H Monitor Key HOM or MONITOR key nter Key NTR or key X xclude Key XCLU key F Fire Key FIR key V View Key MMORY key P Panic Key PANIC key (same as pressing double panic) Medical Key MICAL key M Program Key PROGRAM or P key * Panic1 Key * Key (* on LHS of keypad) # Panic2 Key # Key (* on RHS of keypad) Keys Number keys S Status update STATUS request (not a key). Followed by a 2 digit I. 6. CHK. The checksum byte HX character results in the LSB being zero when all the message bytes are summed. This is done before the message is converted to ASCII and excludes the FINISH bytes. 7. FINISH. It includes: a.? - Command Separator. If a number of messages are sent together then they should be separated by?. This adds a delay between processing successive messages. b. CR - Carriage Return. Optional - it is ignored by the panel. c. LF - Line Feed. Optional - it is ignored by the panel oc I. 8S27.OC 5

7 Status update This is sent in response to a STATUS request. STATUS allows remote viewing of the current arming and alarm states. The format of the status message is: NAM START ARSS LNGTH COMMAN ATA CHKSUM FINISH LNGTH 1 BYT 1 BYT 1 BYT 1 BYT 3 BYTS 1 BYT 2 BYTS I ST A L CM CK CR LF TYP HX HX HX HX HX HX xample CR LF A (This message reports a zone 7 unseal on 8x panel with address 7) 8. START. The START byte defines the structure of the message being sent. Status report ata on the X is an ASCII message = ARSS. The ARSS byte identifies the X receiving the message. The address is either 0x00 or the last digit of the Account Number 2 (P73). Range is 0x00 to 0x0F (the Account Number can include hex numbers). XAMPL: If Account Number 2 = 1234, ARSS = 4. iii) An address of 0 is always accepted. iv) An address other than 0 must match the last digit of P LNGTH. The length of the Status ata is fixed at 3 bytes. 11. COMMAN. This byte is fixed at 0x60 to indicate a CM USR INTRFAC message. 12. ATA. The ATA is 3 bytes. The 1 st byte is the received status request I. The 2 nd & 3 rd bytes are the data as explained below. I escription Size Rules No (bytes) 0 Zone Input Unsealed 2 FORM 4. Zones 1-1 Zone Radio Unsealed 2 FORM 4. Zones 1-2 Zone CBus Unsealed 2 FORM 4. Zones 1-3 Zone in elay 2 FORM 4. Zones 1-4 Zone in ouble Trigger 2 FORM 4. Zones 1-5 Zone in Alarm 2 FORM 4. Zones 1-6 Zone xcluded 2 FORM 4. Zones 1-7 Zone Auto xcluded 2 FORM 4. Zones 1-8 Zone Supervision Fail Pending 2 FORM 4. Zones 1-9 Zone Supervision Fail 2 FORM 4. Zones 1-10 Zone oors Open 2 FORM 4. Zones 1-11 Zone etector Low Battery 2 FORM 4. Zones 1-12 Zone etector Tamper 2 FORM 4. Zones 1-13 Miscellaneous Alarms 2 FORM 20. Miscellaneous alarms. 14 Arming 2 FORM Outputs 2 FORM 22. View State 2 FORM 23. oc I. 8S27.OC 6

8 FORM 4. Used to select Zones 1-. Name ATA XAMPL COMMNT Zone e CR LF 05 = Alarm, 0100 = zone 1 (panel address = 07) Zone Zone Zone Zone Zone Zone CR LF 00 = unseal, 4000 = zone 7 (panel address = 07) Zone c CR LF 00 = unseal, c000 = zone 7 & zone 8 (panel address = 07) Zone Zone Zone Zone Zone Zone Zone Zone = unseal, 0080 = zone (panel address = 07) CR LF FORM 20. Show Miscellaneous alarms. Name ATA uress 0001 Panic 0002 Medical 0004 Fire 0008 Instal nd 0010 xt Tamper 0020 Panel Tamper 0040 Keypad Tamper 0080 Pendant Panic 0100 Panel Battery Low 0200 Panel Battery Low 0400 Mains Fail 0800 CBus Fail FORM 21. Show ARMING STATUS. Name ATA ARA 1 ARM 0001 ARA 2 ARM 0002 ARA 1 FULLY ARM 0004 ARA 2 FULLY ARM 0008 MONITOR ARM 0010 ay Mode Armed 0020 ntry elay 1 ON 0040 ntry elay 2 ON 0080 Manual xclude mode 0100 Memory mode 0200 ay Zone Select oc I. 8S27.OC 7

9 FORM 22. Show output states. Name ATA Siren Loud 0001 Siren Soft 0002 Siren Soft Monitor 0004 Siren Fire 0008 Strobe 0010 Reset 0020 Sonalert 0040 Keypad isplay nable 0080 Aux Aux Aux Aux Monitor Out 1000 Power Fail 2000 Panel Batt Fail 4000 Tamper Xpand 8000 FORM 23. Show View states. Name ATA NORMAL F000 BRIF AY (CHIM) 000 HOM 000 MMORY C000 BRIF AY ZON B000 SLCT XCLU SLCT A000 USR PROGRAM 9000 INSTALLR 8000 PROGRAM 13. CHK. The checksum byte HX character results in the LSB being zero when all the message bytes are summed. This is done before the message is converted to ASCII and excludes the FINISH bytes. 14. FINISH. It includes: a. CR - Carriage Return. Optional - it is ignored by the panel. b. LF - Line Feed. Optional - it is ignored by the panel Program Options P Include address in message. The address is the lower byte of P Include time stamp in output message. 3. Include Alarms in output message. 4. Include Warnings in output message. 5. Include Access vents in output message. ASCII Bus Options oc I. 8S27.OC 8

10 APPNIX A. The format described above for the X ASCII Serial Interface is based on the NSSBus specification document. Changes made to this document that do not conform to the NSSBus specification should be noted. See below for current list. The table below is copied from the NSSBus specification document. It lists the CM_SYSTM_STATUS (0x61) command bytes. The X does not connect to the NSSBus, however it does conform to the NSSBus specification except as noted in Appendix B. vent Identity Area Zone/User States 0x00 main unit 0x00 unknown area 0x00 unsealed -0xef addition identities - 0x7f area the event is part of. sealed such as zone/user number x02 alarm 0x03 alarm restore 0x04 manual exclude 0x05 manual include 0x06 auto exclude 0x07 auto include 0x08 tamper unsealed 0x09 tamper normal xf0-0xfe keypads xff is reserved. 0x80 0x81 0x82 0x83 0x84 0x85 0x90 0x91 0x92 24 hrs Fire Panic Medical uress oor/oorbell Radio evice Radio etector Radio Pendant System States 0x10 power failure 0x11 power normal 0x12 battery failure 0x13 battery normal 0x14 report failure 0x15 report normal 0x supervision failure 0x17 supervision normal 0x19 real time clock 0xa1 0xa2 0xa3 0xa4 0xa5 0xa6 0xb0 Access (oor 1) Access (oor 2) Access (oor 3) Access (oor 4) Access (oor 5) Access (oor 6) Program_area Area States 0x20 entry delay started 0x21 entry delay ended 0x22 exit delay started 0x23 exit delay ended 0x24 armed away 0x25 armed home 0x26 armed day 0x27 armed night 0x28 armed vacation 0x2e armed highest 0x2f disarmed 0x arming delayed 0x status state Result States 0x Output On 0x Output Off 0xff is reserved 0x85-0x8f??? future 0x93-0x9f??? future 0x96-0xfe??? future 0xff is reserved. oc I. 8S27.OC 9

11 Appendix B The following do not conform to the NSSBus specification: 1. Output vent ata and the need for CM_RQUST_VNT. On the NSSBUS: This command is in response to the CM_RQUST_VNT. The message is reported so that the entire system is aware of the states of the various devices. Any device can listen to other device s system status if they wish. The CM_SYSTM_STATUS is followed by 3 bytes. These 3 bytes represent a specific event as described in the table. On the X: The CM_RQUST_VNT is generated internally. 2. Output vent ata Address. On the NSSBUS: 0x00 Address of master. 0xff Address of slave. On the X: 0x00-0xff The X identity. oc I. 8S27.OC 10

12 The following tables list the messages sent with an example showing the string data and below it the actual ASCII byte output (ie 80 is sent as the ascii bytes 38 ). ALARM VNT SCRIPTION Start Addres s Lengt h Comma nd Message ate TIM Ck Cr-LF vent /R I Area Yr Mth ay Hr Min Sec uress User 0x84 yy mm dd hh mm 00 ie 2 User d 0a 07:43 1:2:2006 byte message d 0a Fire Zone 0x81 yy mm dd hh mm 00 ie Zone 1 09:43 1:2: B 0d 0a Medical x83 yy mm dd hh mm 00 x: User 1 13:15 2:3: d 0a C0 0d 0a Panic Radio Key User 0x82 yy mm dd hh mm 00 x: User 50 13:15 2:3: d 0a =50d d 0a Panic Keypad x82 yy mm dd hh mm d 0a x: 13:15 2:3: =57d d 0a d 0a 36 Panic Keyswitch x82 yy mm dd hh mm 00 x: 13:15 2:3: A=58d d 0a d 0a 36 Tamper Internal x00 yy mm dd hh mm 00 Panel x: 23:45 10:5: A 0d 0a d 0a Tamper Radio etector x: Zone 15 Area 1 23:45 10:5: User Area yy mm dd hh mm F= 15d A 0d 0a d 0a 38 Tamper xternal x00 yy mm dd hh mm 00 x: 23:45 10:5: =57d B1 0d 0a d 0a Tamper Keypad xf0 Area yy mm dd hh mm 00 x: 23:45 10:5: F FA 0d 0a d 0a Zone Area yy mm dd hh mm 00 x: Zone 12 Area c= d 0a 23:45 10:5: d 0a ARM Open/Close Area yy mm dd hh mm 00 x: Open User = d 0a 23:45 10:5: d 0a NSS I Main unit 0 USR or ZON identifier to 0xfe User USR I 1-58 Zone ZON I 1- NSS Area Area unknown 0, area identifier to 0x7f AI ARA 1 = 1, ARA 2 = 2, MONITOR = 3, AY = 4 VNT (always even number) R RSTOR = VNT+1 (always odd number) OOR OOR I 1-3 T TIM mm MINUT 00-59, hh HOUR 00 to 23 (24hr) AT dd - AY OF MONTH 01-, mm MONTH 1-12, yy YAR oc I. 8S27.OC 11

13 ACCSS CONTROL Start Add Message TIM AT Chec ksum Cr-LF VNT SCRIPTION ven t /R NSS I NSS Area Hour s Mins ay Month Yea r Number Base Hex Hex Hex Hex Hex ec ec ec ec ec Hex oor Access 87 0x User oor hh mm dd mm yy x: User 40 oor 3 06: = d 0a d 0a oor Open Too Long x: oor 1 06: x02 oor 0x85 mm hh dd mm yy C0 0d 0a d 0a NSS I 0 is main unit to 0xfe is the USR or ZON identifier User USR I 1-58 Zone ZON I 1- NSS Area 0 is unknown area to 0x7f is the area identifier AI ARA I ARA 1 = 1, ARA 2 = 2, MONITOR = 3, AY = 4 VNT (always even number) R RSTOR = VNT+1 (always odd number) OOR OOR I 1-3 T TIM mm - MINUT, hh HOUR(24hr) AT dd - AY OF MONTH, mm - MONTH, yy - YAR oc I. 8S27.OC 12

14 WARNING Start Add Message TIM AT Chec ksum Cr-LF VNT SCRIPTION ven t /R NSS I NSS Area Hour s Mins ay Month Yea r Number Base Hex Hex Hex Hex Hex ec ec ec ec ec Hex Installer Program Mode Restore 87 0x00 0x00 mm hh dd mm yy x: 06: d 0a d 0a Power UP 87 0x11 0x00 0x00 mm hh dd mm yy Restore x: 06: d 0a d 0a Power Panel 87 0x12 0x00 0x00 mm hh dd mm yy Battery X: 06: d 0a d 0a Power Mains 87 0x10 0x00 0x00 mm hh dd mm yy X: 06: d 0a d 0a Radio Key 87 0x12 User Area mm hh dd mm yy Battery X: User 2 06: d 0a d 0a Radio etector Battery 87 0x12 Zone Area mm hh dd mm yy d 0a X: Zone 9 06: d 0a Zone Supervisor 87 0x Zone Area mm hh dd mm yy X: Zone 9 06: d 0a d 0a RTC Adjust 87 0x18 0x00 0x00 mm hh dd mm yy X: Zone 9 06: d 0a d 0a xclude Zone Manual 87 0x04 Zone Area mm hh dd mm yy d 0a X: Zone 9 06: d 0a xclude Zone Auto 87 0x06 Zone Area mm hh dd mm yy d 0a X: Zone 9 06: d 0a ntry elay 87 0x20 Zone Area mm hh dd mm yy X: Zone 1 Area 1 06: d 0a d 0a Zone SAL 83 0x00 Zone Area X Zone 06: = 00 0d 0a d 14 byte message 38 0d 0a NSS I 0 is main unit to 0xfe is the USR or ZON identifier User USR I 1-58 Zone ZON I 1- NSS Area 0 is unknown area to 0x7f is the area identifier AI ARA I ARA 1 = 1, ARA 2 = 2, MONITOR = 3, AY = 4 VNT (always even number) R RSTOR = VNT+1 (always odd number) OOR OOR I 1-3 T TIM mm - MINUT, hh HOUR(24hr) AT dd - AY OF MONTH, mm - MONTH, yy - YAR oc I. 8S27.OC 13