Revision as of 12:59, 17 December 2013

Commands

Command	Description
=	Reboot the device.
!	Configure the device via prompts.
C	Sets or retrieves configuration parameters.
L	Emulate virtual zone opens and closes.
\x01\x01\x01	Send Function Key #1
\x02\x02\x02	Send Function Key #2
\x03\x03\x03	Send Function Key #3
\x04\x04\x04	Send Function Key #4
0123456789*#	Send key to panel

Device Configuration

The AlarmDecoder configuration viewed or modified in one of two ways: prompted or programmatically

Prompted

If you send ! followed by a carriage return you will be prompted for each field. This prompt also includes a basic description of the setting as well as it's current value.

You may hit enter to keep the current value or enter a new one.

Example:

!>Ademco/DSC  Mode A/D  (A) :>
!>Keypad Address       (18) :>
!WARNING. Do not enable a module if the physical module exists on the system.
!Zone Expanders Y/N Max allowed: 02
!>expander module #01 ZN 09-16 (N) :>
!>expander module #02 ZN 17-24 (N) :>
!>expander module #03 ZN 25-32 (N) :>
!>expander module #04 ZN 33-40 (N) :>
!>expander module #05 ZN 41-48 (Y) :>
!Relay Modules Y/N Max allowed: 04
!>relay module #01 (Y) :>
!>relay module #02 (N) :>
!>relay module #03 (N) :>
!>relay module #04 (N) :>
!>Emulate Long Range Radio Y/N: (Y) :>
!>ZoneTracker track zone restore Y/N: (N) :>
!>Address Filter Mask  (ffffffff) :>
!>Deduplicate          (N) :>
!>Config Bits        (ff04) :>

Programmatically

You may retrieve all of the devices settings by sending C to the panel followed by a carriage return (\r).

Retrieving AlarmDecoder settings:

Send: C\r
Response: !CONFIG>ADDRESS=18&CONFIGBITS=ff00&LRR=N&EXP=NNNNN&REL=NNNN&MASK=ffffffff&DEDUPLICATE=N

It can also be used to set values:

Send: CADDRESS=20\r
Response: !>ADDRESS=20

The same command may be used to set multiple values:

Send: CADDRESS=20&DEDUPLICATE=Y\r
Response: !>ADDRESS=20&DEDUPLICATE=Y

Message Types

There are several types of messages produced by the AlarmDecoder. These include: Keypad, Relay Expander, Zone Expander, RFX, LRR, and AUI.

Keypad

Keypad Format
Bit field	Numeric code	Raw data	Alphanumeric Keypad Message
[001000010000--------],010,[f70700060010808c08020000],"ARMED *STAY ZONE BYPASSED "

[001000010000--------]	010	[f70700060010808c08020000]	"ARMED *STAY ZONE BYPASSED "

Zone Expander

!EXP Format
Header	Zone Expander Address	Expander Channel	Data
!EXP:07,01,01

!EXP	07	01	01

Relay Expander

!REL Format
Header	Relay Expander Address	Expander Channel	Data
!REL:12,01,01

!REL	12	01	01

RFX

!RFX Format
Header	Serial Number	Data
!RFX:0180036,80

!RFX	0180036	80

LRR

!LRR Format
Header	Event Data	Partition	Event Type
!LRR:012,1,ARM_STAY

!LRR	012	1	ARM_STAY

AUI

TODO

@@ Line 1: / Line 1: @@
-There are several types of messages produced by the AlarmDecoder.  These include: [[#Keypad|Keypad]], [[#Relay Expander|Relay Expander]], [[#Zone Expander|Zone Expander]], [[#RFX|RFX]], [[#LRR|LRR]], and [[#AUI|AUI]].
 =Commands=
+{| align="center" class="wikitable" border="1"
+! scope="col" | Command
+! scope="col" | Description
+|-
+| align="center" | =
+| align="center" | [[#Reboot|Reboot]] the device.
+|-
+| align="center" | !
+| align="center" | [[#Device Configuration|Configure]] the device via prompts.
+|-
+| align="center" | C
+| align="center" | Sets or retrieves [[#Device Configuration|configuration parameters]].
+|-
+| align="center" | L
+| align="center" | [[#Zone Emulation|Emulate]] virtual zone opens and closes.
+|-
+| align="center" | \x01\x01\x01
+| align="center" | Send [[#Function Keys|Function Key]] #1
+|-
+| align="center" | \x02\x02\x02
+| align="center" | Send [[#Function Keys|Function Key]] #2
+|-
+| align="center" | \x03\x03\x03
+| align="center" | Send [[#Function Keys|Function Key]] #3
+|-
+| align="center" | \x04\x04\x04
+| align="center" | Send [[#Function Keys|Function Key]] #4
+|-
+| align="center" | 0123456789*#
+| align="center" | Send key to panel
+|}
+=Device Configuration=
+The AlarmDecoder configuration viewed or modified in one of two ways: [[#Prompted|prompted]] or [[#Programatically|programmatically]]
+==Prompted==
+If you send <b>!</b> followed by a carriage return you will be prompted for each field.  This prompt also includes a basic description of the setting as well as it's current value.
+<b>You may hit enter to keep the current value or enter a new one.</b>
+Example:
+<pre>
+!>Ademco/DSC  Mode A/D  (A) :>
+!>Keypad Address       (18) :>
+!WARNING. Do not enable a module if the physical module exists on the system.
+!Zone Expanders Y/N Max allowed: 02
+!>expander module #01 ZN 09-16 (N) :>
+!>expander module #02 ZN 17-24 (N) :>
+!>expander module #03 ZN 25-32 (N) :>
+!>expander module #04 ZN 33-40 (N) :>
+!>expander module #05 ZN 41-48 (Y) :>
+!Relay Modules Y/N Max allowed: 04
+!>relay module #01 (Y) :>
+!>relay module #02 (N) :>
+!>relay module #03 (N) :>
+!>relay module #04 (N) :>
+!>Emulate Long Range Radio Y/N: (Y) :>
+!>ZoneTracker track zone restore Y/N: (N) :>
+!>Address Filter Mask  (ffffffff) :>
+!>Deduplicate          (N) :>
+!>Config Bits        (ff04) :>
+</pre>
+==Programmatically==
+You may retrieve all of the devices settings by sending <b>C</b> to the panel followed by a carriage return (\r).
+Retrieving AlarmDecoder settings:
+* Send: <b>C\r</b>
+* Response: <b>!CONFIG>ADDRESS=18&CONFIGBITS=ff00&LRR=N&EXP=NNNNN&REL=NNNN&MASK=ffffffff&DEDUPLICATE=N</b>
+It can also be used to set values:
+* Send: <b>CADDRESS=20\r</b>
+* Response: <b>!>ADDRESS=20</b>
+The same command may be used to set multiple values:
+* Send: <b>CADDRESS=20&DEDUPLICATE=Y\r</b>
+* Response: <b>!>ADDRESS=20&DEDUPLICATE=Y</b>
 =Message Types=
+There are several types of messages produced by the AlarmDecoder.  These include: [[#Keypad|Keypad]], [[#Relay Expander|Relay Expander]], [[#Zone Expander|Zone Expander]], [[#RFX|RFX]], [[#LRR|LRR]], and [[#AUI|AUI]].
 ==Keypad==
 {| align="center" class="wikitable" border="1"

Difference between revisions of "Protocol"

Revision as of 12:59, 17 December 2013

Contents