Alarm Decoder Wiki - User contributions [en]

Protocol

2017-09-19T20:05:40Z

204.10.16.29: /* CONFIGBITS */

[[Category:FAQ]]
[[Category:Documentation]]
[[Category:Specifications]]
[[Category:Features]]

=Commands=
{| 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" | E
| align="center" | Dump error report and clear error history. [[#Error_message_report|Error report]]
|-
| align="center" | V
| align="center" | Dump the version, serial number and flags used in the firmware.
|-
| align="center" | K
| align="center" | Send message from specific partition or keypad address. [[#Addressed Message|Addressed Message]]
|-
| align="center" | R
| align="center" | Host Acknowledge the [[#CRC|CRC]] message was valid.
|-
| align="center" | \x01\x01\x01
| align="center" | Send [[#Special Keys|Special Key]] #1
|-
| align="center" | \x02\x02\x02
| align="center" | Send [[#Special Keys|Special Key]] #2
|-
| align="center" | \x03\x03\x03
| align="center" | Send [[#Special Keys|Special Key]] #3
|-
| align="center" | \x04\x04\x04
| align="center" | Send [[#Special Keys|Special Key]] #4
|-
| align="center" | \x05\x05\x05
| align="center" | Send [[#Special Keys|Special Key]] #5
|-
| align="center" | \x06\x06\x06
| align="center" | Send [[#Special Keys|Special Key]] #6
|-
| align="center" | \x07\x07\x07
| align="center" | Send [[#Special Keys|Special Key]] #7
|-
| align="center" | \x08\x08\x08
| align="center" | Send [[#Special Keys|Special Key]] #8
|-
| align="center" | a
| align="center" | DSC ONLY(deprecated use Special Keys): Arm Away
|-
| align="center" | s
| align="center" | DSC ONLY(deprecated use Special Keys): Arm Stay
|-
| align="center" | c
| align="center" | DSC ONLY(deprecated use Special Keys): Toggle Chime
|-
| align="center" | 0123456789*#<>
| align="center" | Send key to panel
|}

==Reboot==
Rebooting the device is as simple as sending = to it.

During the boot process you can trigger a firmware upload by sending a second = to the device after the !boot message is received. At this point you'll receive a !load and can begin uploading.

==Zone Emulation==
Zone Expander Emulation allows the AlarmDecoder to act in place of a physical expander board and make use of virtual zones with your panel. After enabling it on both the panel and the AlarmDecoder you can begin opening and closing zones, which will be relayed back to the panel.

The L command can be used to open or close zones. There are two parameters: the zone and the state. The zone is a zero-padded two-digit number and the state is either 0 or 1.

Example - open zone 12:
* L121\r

Example - close zone 12:
* L120\r

==Addressed Message==
* It is possible to send a message from a specific keypad on Ademco/Vista or to a specific partition on DSC.
The K command can be used to send a message to the panel from a specific keypad address or keypad partition for DSC. There are two parameters: The address or partition a zero padded 2 digit address or partition and the message to send. The AD2* will stay fixed on this new address until a new K message is received or the AD2* is reset.

Example - Send keypad string 1234 to DSC partition 01:
* K011234\r

Example - Send keypad string 12343 from keypad address 19:
* K1912343\r

==Special Keys==
The specialty keys are identified by ASCII character codes 1 through 8. In order to prevent false positives these must be sent three times in a row.

{| class="wikitable" border="1"
|+ Special Key Codes
! scope="col" | Code
! scope="col" | Description
! scope="col" | Ademco
! scope="col" | DSC
|-
| \x01\x01\x01
| Special Key #1
| Fire/Prog.
| Fire
|-
| \x02\x02\x02
| Special Key #2
| Police/Prog.
| Police
|-
| \x03\x03\x03
| Special Key #3
| Medical/AUX/Prog.
| Medical/AUX
|-
| \x04\x04\x04
| Special Key #4
| Programmable
| Stay
|-
| \x05\x05\x05
| Special Key #5
| N/A
| Away
|-
| \x06\x06\x06
| Special Key #6
| N/A
| Chime
|-
| \x07\x07\x07
| Special Key #7
| N/A
| Reset
|-
| \x08\x08\x08
| Special Key #8
| N/A
| Exit
|}

----

=Device Configuration=
The AlarmDecoder configuration can be viewed or modified in one of two ways: [[#Prompted|prompted]] or [[#Programatic|programmatically]].

==Prompted==
If you send ! followed by a carriage return you will be prompted to configure 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 provide a new one.

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) :>
!>Address Filter Mask (ffffffff) :>
!>Deduplicate (N) :>
!>Config Bits (ff04) :>
</pre>

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

Retrieving 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

===Configuration Parameters===
{| class="wikitable" border="1"
! scope="col" | Name
! scope="col" | Default Value
! scope="col" | Valid Values (Regex)
! scope="col" | Description
|-
| align="left" | ADDRESS
| align="left" | 18
| align="left" | [0-9]{2}
| align="left" | Keypad address assigned to the AlarmDecoder.
|-
| align="left" | CONFIGBITS
| align="left" | FF00
| align="left" | [0-9a-f]{4}
| align="left" | Special settings for the device. See [[#CONFIGBITS|CONFIGBITS]] for more information.
|-
| align="left" | MASK
| align="left" | FFFFFFFF
| align="left" | [0-9a-f]{8}
| align="left" | Address mask used to filter for keypad alphanumeric messages.
|-
| align="left" | EXP
| align="left" | NNNNN
| align="left" | [YN]{5}
| align="left" | Emulation of zone expanders 1-5
|-
| align="left" | REL
| align="left" | NNNN
| align="left" | [YN]{4}
| align="left" | Emulation of relay expanders 1-4
|-
| align="left" | LRR
| align="left" | N
| align="left" | [YN]
| align="left" | Emulation of Long Range Radio expander
|-
| align="left" | DEDUPLICATE
| align="left" | N
| align="left" | [YN]
| align="left" | If enabled, removes duplicate alphanumeric keypad messages.
|-
|}

====CONFIGBITS====
CONFIGBITS is a setting that's used to enable special functionality on the AlarmDecoder. You can enable these by masking the correct bits.

{| class="wikitable" border="1"
|+ CONFIGBITS Definition
! scope="col" | Mask
! scope="col" | Description
|-
| align="left" | 0x0001
| align="left" | Enable reporting of [[#AUI|AUI]] messages.
|-
| align="left" | 0x0002
| align="left" | Enable reporting of [[#Keypress Events|keypress events]].
|-
| align="left" | 0x0004
| align="left" | Disable prompts for L and | commands.
|-
| align="left" | 0x0008
| align="left" | Enable the prefixing of panel messages with !KMP.
|-
| align="left" | 0x0010
| align="left" | Disable DSC locking (experimental).
|-
| align="left" | 0x0080
| align="left" | enable CRC Delivery confirmation for LRR,EXP,REL etc.
|-
| align="left" | 0x0100
| align="left" | Enable reporting of [[#RFX|RFX]] messages.
|}

----

=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]].

* All lines starting with ! are informational.
* Lines that start with !> are prompts.
* All other lines are panel data in the form of a [[#Keypad|Keypad message]].

==Keypad==
Keypad messages are by far the most common message type produced by the AlarmDecoder. These messages also have an optional header that can be enabled in the [[#CONFIGBITS|CONFIGBITS]]. This setting prefixes all keypad messages with !KPM:.

===Format===
{| class="wikitable" border="1"
|+ Keypad Format
| colspan="4" align="center" style="background-color: #DEDEDE; font-weight: bold" | [00110011000000003A--],010,[f70700000010808c18020000000000],"ARMED ***STAY** ZONE BYPASSED "
|-
| colspan="4" |  
|-
! scope="col" width="160px" style="color: #F56464" | Bit field
! scope="col" width="100px" style="color: #8C8CF5" | Numeric code
! scope="col" width="200px" style="color: #70BA66" | Raw data
! scope="col" width="220px" style="color: #804580" | Alphanumeric Keypad Message
|-
| align="center" | [00110011000000003A--]
| align="center" | 010
| align="center" | [f70700000010808c18020000000000]
| align="center" | "ARMED ***STAY** ZONE BYPASSED "
|-
|}

====Bit field====
The bit field present on the keypad messages is where you're going to get most of the information on your alarm system's current state. These are all represented by a zero or one aside from the one exception. (beep)

{| class="wikitable" border="1"
! scope="col" | Position
! scope="col" | Description
|-
| 1
| Indicates if the panel is READY
|-
| 2
| Indicates if the panel is ARMED AWAY
|-
| 3
| Indicates if the panel is ARMED HOME
|-
| 4
| Indicates if the keypad backlight is on
|-
| 5
| Indicates if the keypad is in programming mode
|-
| 6
| Number (1-7) indicating how many beeps are associated with the message
|-
| 7
| Indicates that a zone has been bypassed
|-
| 8
| Indicates if the panel is on AC power
|-
| 9
| Indicates if the chime is enabled
|-
| 10
| Indicates that an alarm has occurred. This is sticky and will be cleared after a second disarm.
|-
| 11
| Indicates that an alarm is currently sounding. This is cleared after the first disarm.
|-
| 12
| Indicates that the battery is low
|-
| 13
| Indicates that entry delay is off (ARMED INSTANT/MAX)
|-
| 14
| Indicates that there is a fire
|-
| 15
| Indicates a system issue
|-
| 16
| Indicates that the panel is only watching the perimeter (ARMED STAY/NIGHT)
|-
| 17
| System specific bits. 4 bits packed into a HEX Nibble [0-9,A-F]
|-
| 18
| Ademco or DSC Mode A or D
|-
| 19
| Unused
|-
| 20
| Unused
|-
|}

====Numeric Code====
This number specifies which zone is affected by the message. For example, if this message is for CHECK ZONE 22 then the numeric code would be 022. Most of the time this is zero-padded base10, but there are rare occurrences where this may be base16, such as ECP bus failures.

====Raw data====
This is the binary data associated with the message. It includes all of the bit field entries that were separated out for you in the first field, as well as the rest of the message for debugging and exploratory purposes.

There is one important piece of data included only in this field: the keypad address mask. The four bytes starting at position 2 (zero-indexed) indicate which keypads this message is intended for.

Inside this mask each bit represents a specific keypad. Each byte represents a group of eight keypad addresses, which the least-significant-bit being the start of the range.

{| class="wikitable" border="1"
! scope="col" | Byte
! scope="col" | Addresses
|-
| 1
| 0-7
|-
| 2
| 8-15
|-
| 3
| 16-23
|-
| 4
| 24-31
|}

For example:
* f70700060010808c08020000 - our keypad address mask is 07000600.

Using the above mask example of 07000600 we find that this message was destined for keypads 0, 1, 2, 17 and 18.

There is one special case: system messages will have no address mask bits set and are intended for common keypads or monitoring multiple zones.

For the most part the address mask details only become really important when you're working with a setup that has multiple partitions since the AlarmDecoder will see all messages by default.

====Alphanumeric Keypad Message====
This section is the data that would be displayed on your keypad's screen.

==Zone Expander==
If you have one or more zone expanders connected to the alarm panel you will be able to see messages from the expanders as zones are faulted and restored. On DSC panels all zones are expressed as EXP messages.
===Examples===
Example of zone expander at address 7, channel 1 faulting and then restoring:
<pre>
!EXP:07,01,01
!EXP:07,01,00
</pre>

===Format===
{| class="wikitable" border="1"
|+ !EXP Format
| colspan="4" align="center" style="background-color: #DEDEDE; font-weight: bold" | !EXP:07,01,01
|-
| colspan="4" |  
|-
! scope="col" width="80px" style="color: #F56464" | Header
! scope="col" width="160px" style="color: #8C8CF5" | Zone Expander Address
! scope="col" width="140px" style="color: #70BA66" | Expander Channel
! scope="col" width="100px" style="color: #804580" | Data
|-
| align="center" | !EXP
| align="center" | 07
| align="center" | 01
| align="center" | 01
|-
|}

====Zone Expander Address====
This is the address that the zone expander occupies.

====Expander Channel====
This is the channel generating the message.

====Data====
00 and 01 indicate that the zone is restored and faulted, respectively.

==Relay Expander==
If you have one or more relay expanders connected to your alarm panel you will be able to see messages when the relays are opened or closed.

===Examples===
Examples of a relay expander at address 12, relay #1 closing and then opening:
<pre>
!REL:12,01,01
!REL:12,01,00
</pre>

===Format===
{| class="wikitable" border="1"
|+ !REL Format
| colspan="4" align="center" style="background-color: #DEDEDE; font-weight: bold" | !REL:12,01,01
|-
| colspan="4" |  
|-
! scope="col" width="80px" style="color: #F56464" | Header
! scope="col" width="160px" style="color: #8C8CF5" | Relay Expander Address
! scope="col" width="140px" style="color: #70BA66" | Expander Channel
! scope="col" width="100px" style="color: #804580" | Data
|-
| align="center" | !REL
| align="center" | 12
| align="center" | 01
| align="center" | 01
|-
|}

====Relay Expander Address====
This is the address that the relay expander occupies.

====Expander Channel====
This is the channel generating the message.

====Data====
00 and 01 indicate that the relay is opened and closed, respectively.

==RFX==
If you have an RF receiver attached to your panel you will see messages from any 5800 RF device in range of the receiver, regardless of whether or not the panel was configured to listen to it.

This also functions when the system is ARMED STAY. Normally you won't see fault messages for interior zones when armed this way so you lose visibility of interior motion sensors. One option is to put the interior sensors on a separate partition so you still see the inside zones and the outside sensors are on their own. The other option is to listen to the !RFX messages directly which could then be used to tell your home automation system that the zones are faulted.

===Examples===
Example of a 5800Micra sensor faulting and restoring:
<pre>
!RFX:0180036,80
!RFX:0180036,00
</pre>

Example of a 5804 keyfob pressing the loop #2 button and having a low battery:
<pre>
!RFX:0307854,22
</pre>

===Format===
{| class="wikitable" border="1"
|+ !RFX Format
| colspan="4" align="center" style="background-color: #DEDEDE; font-weight: bold" | !RFX:0180036,80
|-
| colspan="4" |  
|-
! scope="col" width="80px" style="color: #F56464" | Header
! scope="col" width="100px" style="color: #8C8CF5" | Serial Number
! scope="col" width="100px" style="color: #70BA66" | Data
|-
| align="center" | !RFX
| align="center" | 0180036
| align="center" | 80
|-
|}

====Serial Number====
This is the 7-digit serial number of the device the message originated from.

====Data====
The data is an 8-bit hex message with several indicators. Please refer to the '''5800 SERIES TRANSMITTER INPUT LOOP IDENTIFICATION''' section of your programming manual for what the loops relate to for your specific device.

{| class="wikitable" border="1"
|+ RFX Data Format
|-
! scope="col" | Bit
! scope="col" | Description
|-
| align="center" | 1
| Unknown - Seems that the loop indicators should be ignored if set.
|-
| align="center" | 2
| Low battery indication
|-
| align="center" | 3
| Supervision required indication
|-
| align="center" | 4
| Unknown
|-
| align="center" | 5
| Loop #3 indication
|-
| align="center" | 6
| Loop #2 indication
|-
| align="center" | 7
| Loop #4 indication
|-
| align="center" | 8
| Loop #1 indication
|}

==LRR==
If you have a Long Range Radio device attached or have emulation enabled the AlarmDecoder will report LRR messages from the panel to the radio.

===Examples===
This example shows User 12 arming and disarming the system:
<pre>
!LRR:012,1,ARM_STAY
!LRR:012,1,ARM_AWAY
!LRR:012,1,OPEN
!LRR:003,1,BYPASS
</pre>

===Format===
{| class="wikitable" border="1"
|+ !LRR Format
| colspan="4" align="center" style="background-color: #DEDEDE; font-weight: bold" | !LRR:012,1,ARM_STAY
|-
| colspan="4" |  
|-
! scope="col" width="80px" style="color: #F56464" | Header
! scope="col" width="100px" style="color: #8C8CF5" | Event Data
! scope="col" width="80px" style="color: #70BA66" | Partition
! scope="col" width="100px" style="color: #804580" | Event Type
|-
| align="center" | !LRR
| align="center" | 012
| align="center" | 1
| align="center" | ARM_STAY
|-
|}

====Event Data====
This is either the user number of the person performing the action or the zone that was bypassed.

====Partition====
The panel partition the event applies to. Partition 0 indicates that it's destined for all partitions.

====Event Type====
This is the type of the LRR event. See below for a description and what (if any) programming fields are required for activation.

{| class="wikitable" border="1"
|+ LRR Event Types
! scope="col" | Name
! scope="col" | Program Fields
! scope="col" | Description
|-
| ALARM_EXIT_ERROR
| *59
| Indicates an error when a zone is not closed during arming
|-
| TROUBLE
| *60
| Indicates that a zone is reporting a tamper or failure
|-
| BYPASS
| *61
| Indicates that a zone has been bypassed
|-
| ACLOSS
| *62
| Indicates that AC power was lost
|-
| LOWBAT
| *63
| Low battery indication
|-
| TEST_CALL
| *64
| Indicates a phone test when in testing mode
|-
| OPEN
| *65, requires *66
| Indicates that the alarm is disarmed
|-
| ARM_AWAY
| *66
| Indicates that the system was armed AWAY
|-
| ARM_STAY
| *66
| Indicates that the system was armed STAY
|-
| RFLOWBAT
| *67
| Low battery indication for the RF transmitter
|-
| CANCEL
| *68
| Indicates that the alarm was canceled after second disarm
|-
| RESTORE
| *70
| Indicates that the alarm was restored
|-
| TROUBLE_RESTORE
| *71
| Indicates that the trouble event was restored
|-
| BYPASS_RESTORE
| *72
| Indicates that the bypassed zonew as restored
|-
| AC_RESTORE
| *73
| Indicates that AC power was restored
|-
| LOWBAT_RESTORE
| *74
| Indicates that the low battery has been restored
|-
| RFLOWBAT_RESTORE
| *75
| Indicates that the low battery on the RF transmitter has been restored.
|-
| TEST_RESTORE
| *76
| Indicates that a zone was restored in testing mode
|-
| ALARM_PANIC
|
| Indicates that there is a panic
|-
| ALARM_FIRE
|
| Indicates that there is a fire
|-
| ALARM_ENTRY
|
| Indicates that there was an entry alarm
|-
| ALARM_AUX
|
| Indicates that an auxiliary alarm type was triggered
|-
| ALARM_AUDIBLE
|
| Indicates that an audible alarm is in progress
|-
| ALARM_SILENT
|
| Indicates that there was a silent alarm
|-
| ALARM_PERIMETER
|
| Indicates that there was a perimeter alarm
|}

==AUI==
AUI messages are generated for "Advanced User Interface" keypads. These include a lot of extra data than what's destined for regular keypads.

===Format===
{| class="wikitable" border="1"
|+ !AUI Format
| colspan="4" align="center" style="background-color: #DEDEDE; font-weight: bold" | !AUI:126600000000656c02456cf5ec01017f0002
|-
| colspan="4" |  
|-
! scope="col" width="80px" style="color: #F56464" | Header
! scope="col" width="100px" style="color: #8C8CF5" | AUI Data
|-
| align="center" | !AUI
| align="center" | 126600000000656c02456cf5ec01017f0002
|-
|}

====AUI Data====
This is a large binary blob that's destined for a graphical panel. This data has not been fully decoded. Please see the [[AUI|AUI]] page for information on what has been discovered so far.

==Keypress Events==
Keypress events are generated when keys are pressed on a keypad and can be enabled inside [[#CONFIGBITS|CONFIGBITS]].

===Format===
{| class="wikitable" border="1"
|+ !KPE Format
| colspan="4" align="center" style="background-color: #DEDEDE; font-weight: bold" | !KPE:18
|-
| colspan="4" |  
|-
! scope="col" width="80px" style="color: #F56464" | Header
! scope="col" width="100px" style="color: #8C8CF5" | Keypad Address
|-
| align="center" | !KPE
| align="center" | 18
|-
|}

==Error message report==
Error message reports will be sent to the host when the command 'E' is sent to the AD2*. The list will contain 0 if no errors are recorded and a list of errors separated by commas if errors are recorded. Once an error is reported it will be cleared from the history. The errors from left to right are in order of occurrence. As many as 10 errors can be stored before the oldest is removed from the list.

===Format===
{| class="wikitable" border="1"
|+ !ERR Format
| colspan="4" align="center" style="background-color: #DEDEDE; font-weight: bold" | !ERR:4,4,4
|-
| colspan="4" |  
|-
! scope="col" width="80px" style="color: #F56464" | Header
! scope="col" width="100px" style="color: #8C8CF5" | Error list
|-
| align="center" | !ERR
| align="center" | 4,4,4
|-
|}

===Error Codes===
{| class="wikitable" border="1"
|+ Error Codes
|-
| colspan="4" |  
|-
! scope="col" width="80px" | Error number
! scope="col" width="100px" | Description
|-
| align="center" | 0
| align="center" | No issues to report
|-
| align="center" | 4
| align="center" | Keypress send failure
|-
|}

==CRC==
The CRC Message container is a wrapper around all of the standard !XXX event messages above with the checksum value at the end. The checksum is a CRC-CCITT-16 with a polynomial of 0x1021 of all of the Event Data bytes.

===Format===
{| class="wikitable" border="1"
|+ !CRC Format
| colspan="4" align="center" style="background-color: #DEDEDE; font-weight: bold" | !CRC:!LRR:000,1,CID_1121,ff,282d
|-
| colspan="4" |  
|-
! scope="col" width="80px" style="color: #F56464" | Header
! scope="col" width="100px" style="color: #8C8CF5" | Event Data
! scope="col" width="80px" style="color: #70BA66" | CRC
|-
| align="center" | !CRC
| align="center" | !LRR:000,1,CID_1121,ff
| align="center" | 282d
|-
|}

==Version Message==
This message indicates the serial number of the unit, version, and the firmware capabilities.

===Format===
{| class="wikitable" border="1"
|+ !VER Format
| colspan="4" align="center" style="background-color: #DEDEDE; font-weight: bold" | !VER:ffffffff,V2.2a.8.2,TX;RX;SM;VZ;RF;ZX;RE;AU;3X;CG;DD;MF;LR;KE;MK;CB;DS;ER
|-
| colspan="4" |  
|-
! scope="col" width="80px" style="color: #F56464" | Header
! scope="col" width="100px" style="color: #8C8CF5" | Serial number
! scope="col" width="100px" style="color: #70BA66" | Firmware version
! scope="col" width="100px" style="color: #804580" | Firmware capabilities
|-
| align="center" | !VER
| align="center" | ffffffff
| align="center" | V2.2a.8.2
| align="center" | TX;RX;SM;VZ;RF;ZX;RE;AU;3X;CG;DD;MF;LR;KE;MK;CB;DS;ER
|-
|}

====Serial Number====
This is the serial number of the device. If unset this defaults to ffffffff.

====Firmware Version====
This is the revision of the firmware that is currently loaded on the device.

====Firmware Capabilities====
This field indicates which capabilities are built in to the firmware. See the below table for reference.

{| class="wikitable" border="1"
|+ !VER Format
| colspan="4" align="center" style="background-color: #DEDEDE; font-weight: bold" | Firmware Capabilities
|-
| colspan="4" |  
|-
! scope="col" width="80px" | Flag
! scope="col" width="100px" | Description
|-
| align="center" | TX
| align="center" | Ability to transmit to the panel
|-
|-
| align="center" | RX
| align="center" | Ability to receive from the panel
|-
| align="center" | SM
| align="center" | Supports sending multiple keypresses
|-
| align="center" | VZ
| align="center" | Virtual zone expanders
|-
| align="center" | RF
| align="center" | Supports receiving of RF messages from the 5800 series wireless devices (!RFX)
|-
| align="center" | ZX
| align="center" | Supports receiving of messages from zone expanders (!EXP)
|-
| align="center" | RE
| align="center" | Supports receiving of messages from relay (!REL)
|-
| align="center" | AU
| align="center" | AUI support (!AUI)
|-
| align="center" | 3X
| align="center" | Special Keys (S1-S4) must be sent 3 times to trigger
|-
| align="center" | CG
| align="center" | Serialized configuration string
|-
| align="center" | DD
| align="center" | Message deduplication
|-
| align="center" | MF
| align="center" | Address mask filter
|-
| align="center" | LR
| align="center" | Long range radio messages (!LRR) deprecated see L2
|-
| align="center" | L2
| align="center" | Long range radio messages (!LRR) with CID reporting format
|-
| align="center" | KE
| align="center" | Keypad event messages (!KPM)
|-
| align="center" | MK
| align="center" | Multiple keypad emulation (See 'K' command for more information)
|-
| align="center" | CB
| align="center" | Config bits
|-
| align="center" | DS
| align="center" | DSC support
|-
| align="center" | ER
| align="center" | Error tracking
|-
| align="center" | CR
| align="center" | CRC Wrapper around EXP,LRR and other event type messages
|-
|}

=Device Feedback LED=
* Boot flash mode
** During boot the AD2* will rapid flash during the boot loader.
* Operating mode
** The normal operating mode is a steady of approx 2.5 flashes per second.
** Sending to panel mode 3 flashes.
* Error mode
** If an error is recorded the AD2* will flash the error message as steady slow flashes to be counted with a long period of the LED off between flashes. after a few minutes the led will return to normal idle flash mode if no further errors happen.

AlarmDecoder Modem

2016-02-04T21:14:21Z

204.10.16.29: /* Is your panel supported? */

=Introduction=

Programming your alarm system tends to be a tedious endeavour so our goal with the AlarmDecoder Modem is to make it less intimidating and less time consuming by letting the Compass® software do most of the work without having to deal with ancient modems.

Please read through the FAQ to determine if your panel is compatible.

=FAQ=

==Is your panel supported?==

[[File:Panel_model.png|thumb|Vista 20P]]
[[File:Panel_revision.png|thumb|Revision 7.0]]

The first thing you need to check is the model of the panel. If you don't know the model off-hand it's usually found on the panel circuit board, either as a sticker or printed directly on the board, and is normally a part of a larger identifier.

Next, you need to confirm that the panel software revision meets the level required to support internet downloading. You can determine the revision of your panel by again checking the panel circuit board for a chip & socket with a sticker on it.

See the pictures to the right for examples.

{| class="wikitable"
|+ Panel Compatibility
! Manufacturer
! Model
! Revision
|-
| Vista || 10P || style="text-align:center;" | 2.0+
|-
| Vista || 10PSIA || style="text-align:center;" | 3.0+
|-
| Vista || 15P || style="text-align:center;" | 5.2+
|-
| Vista || 20P / 20PSIA || style="text-align:center;" | 5.2+
|-
| Vista || 21IP || style="text-align:center;" | -
|-
| First Alert || FA130CP || style="text-align:center;" | 2.0+
|-
| First Alert || FA130CPSIA || style="text-align:center;" | 3.0+
|-
| First Alert || FA148CP / FA148CPSIA || style="text-align:center;" | 5.2+
|-
| First Alert || FA168CPS / FA168CPSSIA || style="text-align:center;" | 5.2+
|}

==Do I need to know my installer code?==

While it's possible you could make things work without knowing the installer code for your panel, there are a number of things that may need to be changed in the panel programming.

If your panel is currently or was previously monitored you'll likely need to either obtain the CSID and Account number for your panel or reset the dialer settings to factory default. This can typically be done by executing *96 while in programming mode.

==Can I use this while monitored by an alarm company?==

This is technically possible, but you'll need to obtain the proper CSID and Account number for your panel.

Please note that if you reset your dialer settings it will keep your alarm company from monitoring your home.

==Where can I get Compass®?==

Compass® is available on the internet, though we cannot provide any direct links.

=Setup & Configuration=

# Download the AlarmDecoder Modem software using the link provided in your order email or from [[https://www.alarmdecoder.com/modem.php Here]].
# Run the installer. This will install the modem and any necessary prerequisites.
#* Enter your product key when prompted.
# Make sure that all keypad applications, terminal clients or other software accessing the AlarmDecoder is closed. One connection is allowed at a time unless you're using the network interface.
# Configure the AlarmDecoder Modem
## Run the '''AlarmDecoder Modem Setup''' from your Start Menu.
### Choose your AlarmDecoder Modem COM port from the first dropdown box.
###* You should make a note of this for later.
### Select USB, Serial or Network to indicate the type and location of your AlarmDecoder device.
###* If USB or Serial: Select the correct AlarmDecoder COM port.
###* If Network: Fill in the name or IP address of the computer (or AD2PI) that's running the ser2sock service.
###** Note: This service is preinstalled on our pre-configured Raspbian disk images.
### Click ''Save''
# Configure Compass®
## Create a new modem
##* Compass® 1.x:
##*# Select the AlarmDecoder Modem COM port (from the first dropdown) as your COM port.
##* Compass® 2.x:
##*# Click Configure COM ports
##*# Choose your AlarmDecoder Modem COM port from the list and click ''Add''.
##*# Close the window and select the port in the list.
## Configure the modem
##* Compass® 1.x:
##*# Select ''Ademco'' for the Company
##*# Select ''Accura 336'' as your modem type.
##* Compass® 2.x:
##*# Select ''Ademco/First Alert'' for the Company.
##*# Select ''Ademco CIA 2400'' as your modem type.
## Open (or create) a Customer
## Open the Communications screen
## Test your modem connection
### Set the panel phone number to whatever you prefer. It is required but ignored.
### Uncheck the ''Answering Machine Defeat'' checkbox.
### Select the proper CSID setting for your install.
###* ''First Time Communication'': Select this if your panel has a default CSID.
###** ''Acct # in Panel'': Select this option if the Account number has been programmed on your panel. The Account number in Compass® much match.
### Click ''Connect''

=Using The Modem=

Using Compass® is beyond the scope of this document, but one thing that should be noted is the definition of '''UPLOAD''' and '''DOWNLOAD'''.

These are opposite from traditional logic since they are defined as if from Compass®' point of view at a alarm company. '''UPLOAD''' retrieves the configuration from your panel and puts it into Compass®. '''DOWNLOAD''' does the opposite and writes the configuration to your panel.

=Troubleshooting=

==Connection to panel failed==

There are a few things that can cause the connection to the panel to fail. The following issues should be checked in the order they're presented, though the incorrect CSID is probably the most common issue.

===AlarmDecoder Firmware Revision===

This features requires version 2.2a.8.2+ on your AlarmDecoder. You can download that from [http://www.alarmdecoder.com/wiki/index.php/Firmware here].

===Panel too old===

Check the revision of your panel by following the instructions [[#Is_your_panel_supported?|here]].

It's a fairly simple process to swap the chip on your panel if the revision doesn't meet the minimum requirement. You can find replacement chips with newer firmware for a reasonable price on Ebay. After you get the chip it's as simple as popping the old one out and putting the new one in. No reprogramming should be required.

===Incorrect CSID===

The CSID (Central Station ID) is the identifier that alarm companies use to authenticate with your panel. There are two different states that this can be in:

Factory state - default CSID:

In a factory state the CSID is uninitialized and the panel can be connected to by using the First Time Communication option with the default CSID.

CSID set:

If your CSID has been changed by an alarm company then Compass® cannot access your panel unless it's been specified correctly inside Compass®. You'll either need to obtain that ID from them or reset the dialer settings. The dialer settings may be reset by using *96 in programming mode typically, but please consult your programming manual before doing so.

Warning: If your alarm system is currently monitored you should note that changing your dialer settings (with *96 or otherwise) will potentially keep your alarm company from doing their job.

==No COM port available in the AlarmDecoder Configuration tool==

Please email us at [mailto:alarmdecoder@support.nutech.com alarmdecoder@support.nutech.com] and we'll help you figure out what's going on.

=Getting Help=

If you have issues with the software please feel free to email us at [mailto:alarmdecoder@support.nutech.com alarmdecoder@support.nutech.com] or post in our [http://www.alarmdecoder.com/forums/index.php forums].

Please include the following details with your request:
* Operating system
* Panel model
* Panel revision

• All trademarks are the property of their respective owners.

AlarmDecoder Modem

2016-01-18T20:15:33Z

204.10.16.29: /* Setup & Configuration */

=Introduction=

Programming your alarm system tends to be a tedious endeavour so our goal with the AlarmDecoder Modem is to make it less intimidating and less time consuming by letting the Compass® software do most of the work without having to deal with ancient modems.

Please read through the FAQ to determine if your panel is compatible.

=FAQ=

==Is your panel supported?==

[[File:Panel_model.png|thumb|Vista 20P]]
[[File:Panel_revision.png|thumb|Revision 7.0]]

The first thing you need to check is the model of the panel. If you don't know the model off-hand it's usually found on the panel circuit board, either as a sticker or printed directly on the board, and is normally a part of a larger identifier.

Next, you need to confirm that the panel software revision meets the level required to support internet downloading. You can determine the revision of your panel by again checking the panel circuit board for a chip & socket with a sticker on it.

See the pictures to the right for examples.

{| class="wikitable"
|+ Panel Compatibility
! Manufacturer
! Model
! Revision
|-
| Vista || 10P || style="text-align:center;" | 2.0+
|-
| Vista || 10PSIA || style="text-align:center;" | 3.0+
|-
| Vista || 15P || style="text-align:center;" | 5.2+
|-
| Vista || 20P / 20PSIA || style="text-align:center;" | 5.2+
|-
| First Alert || FA130CP || style="text-align:center;" | 2.0+
|-
| First Alert || FA130CPSIA || style="text-align:center;" | 3.0+
|-
| First Alert || FA148CP / FA148CPSIA || style="text-align:center;" | 5.2+
|-
| First Alert || FA168CPS / FA168CPSSIA || style="text-align:center;" | 5.2+
|}

==Do I need to know my installer code?==

While it's possible you could make things work without knowing the installer code for your panel, there are a number of things that may need to be changed in the panel programming.

If your panel is currently or was previously monitored you'll likely need to either obtain the CSID and Account number for your panel or reset the dialer settings to factory default. This can typically be done by executing *96 while in programming mode.

==Can I use this while monitored by an alarm company?==

This is technically possible, but you'll need to obtain the proper CSID and Account number for your panel.

Please note that if you reset your dialer settings it will keep your alarm company from monitoring your home.

==Where can I get Compass®?==

Compass® is available on the internet, though we cannot provide any direct links.

=Setup & Configuration=

# Download the AlarmDecoder Modem software using the link provided in your order email.
# Run the installer. This will install the modem and any necessary prerequisites.
#* Enter your product key when prompted.
# Make sure that all keypad applications, terminal clients or other software accessing the AlarmDecoder is closed. One connection is allowed at a time unless you're using the network interface.
# Configure the AlarmDecoder Modem
## Run the '''AlarmDecoder Modem Setup''' from your Start Menu.
### Choose your AlarmDecoder Modem COM port from the first dropdown box.
###* You should make a note of this for later.
### Select USB, Serial or Network to indicate the type and location of your AlarmDecoder device.
###* If USB or Serial: Select the correct AlarmDecoder COM port.
###* If Network: Fill in the name or IP address of the computer (or AD2PI) that's running the ser2sock service.
###** Note: This service is preinstalled on our pre-configured Raspbian disk images.
### Click ''Save''
# Configure Compass®
## Create a new modem
##* Compass® 1.x:
##*# Select the AlarmDecoder Modem COM port (from the first dropdown) as your COM port.
##* Compass® 2.x:
##*# Click Configure COM ports
##*# Choose your AlarmDecoder Modem COM port from the list and click ''Add''.
##*# Close the window and select the port in the list.
## Configure the modem
##* Compass® 1.x:
##*# Select ''Ademco'' for the Company
##*# Select ''Accura 336'' as your modem type.
##* Compass® 2.x:
##*# Select ''Ademco/First Alert'' for the Company.
##*# Select ''Ademco CIA 2400'' as your modem type.
## Open (or create) a Customer
## Open the Communications screen
## Test your modem connection
### Set the panel phone number to whatever you prefer. It is required but ignored.
### Uncheck the ''Answering Machine Defeat'' checkbox.
### Select the proper CSID setting for your install.
###* ''First Time Communication'': Select this if your panel has a default CSID.
###** ''Acct # in Panel'': Select this option if the Account number has been programmed on your panel. The Account number in Compass® much match.
### Click ''Connect''

=Using The Modem=

Using Compass® is beyond the scope of this document, but one thing that should be noted is the definition of '''UPLOAD''' and '''DOWNLOAD'''.

These are opposite from traditional logic since they are defined as if from Compass®' point of view at a alarm company. '''UPLOAD''' retrieves the configuration from your panel and puts it into Compass®. '''DOWNLOAD''' does the opposite and writes the configuration to your panel.

=Troubleshooting=

==Connection to panel failed==

There are a few things that can cause the connection to the panel to fail. The following issues should be checked in the order they're presented, though the incorrect CSID is probably the most common issue.

===AlarmDecoder Firmware Revision===

This features requires version 2.2a.8.2+ on your AlarmDecoder. You can download that from [http://www.alarmdecoder.com/wiki/index.php/Firmware here].

===Panel too old===

Check the revision of your panel by following the instructions [[#Is_your_panel_supported?|here]].

It's a fairly simple process to swap the chip on your panel if the revision doesn't meet the minimum requirement. You can find replacement chips with newer firmware for a reasonable price on Ebay. After you get the chip it's as simple as popping the old one out and putting the new one in. No reprogramming should be required.

===Incorrect CSID===

The CSID (Central Station ID) is the identifier that alarm companies use to authenticate with your panel. There are two different states that this can be in:

Factory state - default CSID:

In a factory state the CSID is uninitialized and the panel can be connected to by using the First Time Communication option with the default CSID.

CSID set:

If your CSID has been changed by an alarm company then Compass® cannot access your panel unless it's been specified correctly inside Compass®. You'll either need to obtain that ID from them or reset the dialer settings. The dialer settings may be reset by using *96 in programming mode typically, but please consult your programming manual before doing so.

Warning: If your alarm system is currently monitored you should note that changing your dialer settings (with *96 or otherwise) will potentially keep your alarm company from doing their job.

==No COM port available in the AlarmDecoder Configuration tool==

Please email us at [mailto:alarmdecoder@support.nutech.com alarmdecoder@support.nutech.com] and we'll help you figure out what's going on.

=Getting Help=

If you have issues with the software please feel free to email us at [mailto:alarmdecoder@support.nutech.com alarmdecoder@support.nutech.com] or post in our [http://www.alarmdecoder.com/forums/index.php forums].

Please include the following details with your request:
* Operating system
* Panel model
* Panel revision

• All trademarks are the property of their respective owners.

AlarmDecoder Modem

2016-01-16T01:21:45Z

204.10.16.29:

=Introduction=

Programming your alarm system tends to be a tedious endeavour so our goal with the AlarmDecoder Modem is to make it less intimidating and less time consuming by letting the Compass® software do most of the work without having to deal with ancient modems.

Please read through the FAQ to determine if your panel is compatible.

=FAQ=

==Is your panel supported?==

[[File:Panel_model.png|thumb|Vista 20P]]
[[File:Panel_revision.png|thumb|Revision 7.0]]

The first thing you need to check is the model of the panel. If you don't know the model off-hand it's usually found on the panel circuit board, either as a sticker or printed directly on the board, and is normally a part of a larger identifier.

Next, you need to confirm that the panel software revision meets the level required to support internet downloading. You can determine the revision of your panel by again checking the panel circuit board for a chip & socket with a sticker on it.

See the pictures to the right for examples.

{| class="wikitable"
|+ Panel Compatibility
! Manufacturer
! Model
! Revision
|-
| Vista || 10P || style="text-align:center;" | 2.0+
|-
| Vista || 10PSIA || style="text-align:center;" | 3.0+
|-
| Vista || 15P || style="text-align:center;" | 5.2+
|-
| Vista || 20P / 20PSIA || style="text-align:center;" | 5.2+
|-
| First Alert || FA130CP || style="text-align:center;" | 2.0+
|-
| First Alert || FA130CPSIA || style="text-align:center;" | 3.0+
|-
| First Alert || FA148CP / FA148CPSIA || style="text-align:center;" | 5.2+
|-
| First Alert || FA168CPS / FA168CPSSIA || style="text-align:center;" | 5.2+
|}

==Do I need to know my installer code?==

While it's possible you could make things work without knowing the installer code for your panel, there are a number of things that may need to be changed in the panel programming.

If your panel is currently or was previously monitored you'll likely need to either obtain the CSID and Account number for your panel or reset the dialer settings to factory default. This can typically be done by executing *96 while in programming mode.

==Can I use this while monitored by an alarm company?==

This is technically possible, but you'll need to obtain the proper CSID and Account number for your panel.

Please note that if you reset your dialer settings it will keep your alarm company from monitoring your home.

==Where can I get Compass®?==

Compass® is available on the internet, though we cannot provide any direct links.

=Setup & Configuration=

# Download the AlarmDecoder Modem software using the link provided in your order email.
# Run the installer. This will install the modem and any necessary prerequisites.
#* Enter your product key when prompted.
# Make sure that all keypad applications, terminal clients or other software accessing the AlarmDecoder is closed. One connection is allowed at a time unless you're using the network interface.
# Configure the AlarmDecoder Modem
## Run the '''AlarmDecoder Modem Setup''' from your Start Menu.
### Choose your AlarmDecoder Modem COM port from the first dropdown box.
###* You should make a note of this for later.
### Select USB, Serial or Network to indicate the type and location of your AlarmDecoder device.
###* If USB or Serial: Select the correct AlarmDecoder COM port.
###* If Network: Fill in the name or IP address of the computer (or AD2PI) that's running the ser2sock service.
###** Note: This service is preinstalled on our pre-configured Raspbian disk images.
### Click ''Save''
# Configure Compass®
## Create a new modem
##* Compass® 1.x:
##*# Select the AlarmDecoder Modem COM port (from the first dropdown) as your COM port.
##* Compass® 2.x:
##*# Click Configure COM ports
##*# Choose your AlarmDecoder Modem COM port from the list and click ''Add''.
##*# Close the window and select the port in the list.
## Configure the modem
##* Compass® 1.x:
##*# Select ''Ademco'' for the Company
##*# Select ''Accura 336'' as your modem type.
##* Compass® 2.x:
##*# Select ''Ademco/First Alert'' for the Company.
##*# Select ''Ademco CIA 2400'' as your modem type.
## Open (or create) a Customer
## Open the Communications screen
## Test your modem connection
### Set the panel phone number to whatever you prefer. It is required but ignored.
### Uncheck the ''Answering Machine Defeat'' checkbox.
### Select the proper CSID setting for your install.
###* ''First Time Communication'': Select this if your panel has a default CSID. (Field 36)
###** ''Acct # in Panel'': Select this option if the Account number has been programmed on your panel. (Field 32) The Account number in Compass® much match.
### Click ''Connect''

=Using The Modem=

Using Compass® is beyond the scope of this document, but one thing that should be noted is the definition of '''UPLOAD''' and '''DOWNLOAD'''.

These are opposite from traditional logic since they are defined as if from Compass®' point of view at a alarm company. '''UPLOAD''' retrieves the configuration from your panel and puts it into Compass®. '''DOWNLOAD''' does the opposite and writes the configuration to your panel.

=Troubleshooting=

==Connection to panel failed==

There are a few things that can cause the connection to the panel to fail. The following issues should be checked in the order they're presented, though the incorrect CSID is probably the most common issue.

===AlarmDecoder Firmware Revision===

This features requires version 2.2a.8.2+ on your AlarmDecoder. You can download that from [http://www.alarmdecoder.com/wiki/index.php/Firmware here].

===Panel too old===

Check the revision of your panel by following the instructions [[#Is_your_panel_supported?|here]].

It's a fairly simple process to swap the chip on your panel if the revision doesn't meet the minimum requirement. You can find replacement chips with newer firmware for a reasonable price on Ebay. After you get the chip it's as simple as popping the old one out and putting the new one in. No reprogramming should be required.

===Incorrect CSID===

The CSID (Central Station ID) is the identifier that alarm companies use to authenticate with your panel. There are two different states that this can be in:

Factory state - default CSID:

In a factory state the CSID is uninitialized and the panel can be connected to by using the First Time Communication option with the default CSID.

CSID set:

If your CSID has been changed by an alarm company then Compass® cannot access your panel unless it's been specified correctly inside Compass®. You'll either need to obtain that ID from them or reset the dialer settings. The dialer settings may be reset by using *96 in programming mode typically, but please consult your programming manual before doing so.

Warning: If your alarm system is currently monitored you should note that changing your dialer settings (with *96 or otherwise) will potentially keep your alarm company from doing their job.

==No COM port available in the AlarmDecoder Configuration tool==

Please email us at [mailto:alarmdecoder@support.nutech.com alarmdecoder@support.nutech.com] and we'll help you figure out what's going on.

=Getting Help=

If you have issues with the software please feel free to email us at [mailto:alarmdecoder@support.nutech.com alarmdecoder@support.nutech.com] or post in our [http://www.alarmdecoder.com/forums/index.php forums].

Please include the following details with your request:
* Operating system
* Panel model
* Panel revision

• All trademarks are the property of their respective owners.

AlarmDecoder Modem

2016-01-16T00:41:15Z

204.10.16.29:

=Introduction=

Programming your alarm system tends to be a tedious endeavour so our goal with the AlarmDecoder Modem is to make it less intimidating and less time consuming by letting the Compass® software do most of the work without having to deal with ancient modems.

Please read through the FAQ to determine if your panel is compatible.

=FAQ=

==Is your panel supported?==

[[File:Panel_model.png|thumb|Vista 20P]]
[[File:Panel_revision.png|thumb|Revision 7.0]]

The first thing you need to check is the model of the panel. If you don't know the model off-hand it's usually found on the panel circuit board, either as a sticker or printed directly on the board, and is normally a part of a larger identifier.

Next, you need to confirm that the panel software revision meets the level required to support internet downloading. You can determine the revision of your panel by again checking the panel circuit board for a chip & socket with a sticker on it.

See the pictures to the right for examples.

{| class="wikitable"
|+ Panel Compatibility
! Manufacturer
! Model
! Revision
|-
| Vista || 10P || style="text-align:center;" | 2.0+
|-
| Vista || 10PSIA || style="text-align:center;" | 3.0+
|-
| Vista || 15P || style="text-align:center;" | 5.2+
|-
| Vista || 20P / 20PSIA || style="text-align:center;" | 5.2+
|-
| First Alert || FA130CP || style="text-align:center;" | 2.0+
|-
| First Alert || FA130CPSIA || style="text-align:center;" | 3.0+
|-
| First Alert || FA148CP / FA148CPSIA || style="text-align:center;" | 5.2+
|-
| First Alert || FA168CPS / FA168CPSSIA || style="text-align:center;" | 5.2+
|}

==Do I need to know my installer code?==

While it's possible you could make things work without knowing the installer code for your panel, there are a number of things that may need to be changed in the panel programming.

If your panel is currently or was previously monitored you'll likely need to either obtain the CSID and Account number for your panel or reset the dialer settings to factory default. This can typically be done by executing *96 while in programming mode.

==Can I use this while monitored by an alarm company?==

This is technically possible, but you'll need to obtain the proper CSID and Account number for your panel.

Please note that if you reset your dialer settings it will keep your alarm company from monitoring your home.

==Where can I get Compass®?==

Compass® is available on the internet, though we cannot provide any direct links.

=Setup & Configuration=

# Download the AlarmDecoder Modem software using the link provided in your order email.
# Run the installer. This will install the modem and any necessary prerequisites.
#* Enter your product key when prompted.
# Make sure that all keypad applications, terminal clients or other software accessing the AlarmDecoder is closed. One connection is allowed at a time unless you're using the network interface.
# Configure the AlarmDecoder Modem
## Run the '''AlarmDecoder Modem Setup''' from your Start Menu.
### Choose your AlarmDecoder Modem COM port from the first dropdown box.
###* You should make a note of this for later.
### Select USB, Serial or Network to indicate the type and location of your AlarmDecoder device.
###* If USB or Serial: Select the correct AlarmDecoder COM port.
###* If Network: Fill in the name or IP address of the computer (or AD2PI) that's running the ser2sock service.
###** Note: This service is preinstalled on our pre-configured Raspbian disk images.
### Click ''Save''
# Configure Compass®
## Create a new modem
##* Compass® 1.x:
##*# Select the AlarmDecoder Modem COM port (from the first dropdown) as your COM port.
##* Compass® 2.x:
##*# Click Configure COM ports
##*# Choose your AlarmDecoder Modem COM port from the list and click ''Add''.
##*# Close the window and select the port in the list.
## Configure the modem
##* Compass® 1.x:
##*# Select ''Ademco'' for the Company
##*# Select ''Accura 336'' as your modem type.
##* Compass® 2.x:
##*# Select ''Ademco/First Alert'' for the Company.
##*# Select ''Ademco CIA 2400'' as your modem type.
## Open (or create) a Customer
## Open the Communications screen
## Test your modem connection
### Set the panel phone number to whatever you prefer. It is required but ignored.
### Uncheck the ''Answering Machine Defeat'' checkbox.
### Select the proper CSID setting for your install.
###* ''First Time Communication'': Select this if your panel has a default CSID. (Field 36)
###** ''Acct # in Panel'': Select this option if the Account number has been programmed on your panel. (Field 32) The Account number in Compass® much match.
### Click ''Connect''

=Using The Modem=

Using Compass® is beyond the scope of this document, but one thing that should be noted is the definition of '''UPLOAD''' and '''DOWNLOAD'''.

These are opposite from traditional logic since they are defined as if from Compass®' point of view at a alarm company. '''UPLOAD''' retrieves the configuration from your panel and puts it into Compass®. '''DOWNLOAD''' does the opposite and writes the configuration to your panel.

=Troubleshooting=

==Connection to panel failed==

There are a few things that can cause the connection to the panel to fail. The following issues should be checked in the order they're presented, though the incorrect CSID is probably the most common issue.

===Panel too old===

Check the revision of your panel by following the instructions [[#Is_your_panel_supported?|here]].

It's a fairly simple process to swap the chip on your panel if the revision doesn't meet the minimum requirement. You can find replacement chips with newer firmware for a reasonable price on Ebay. After you get the chip it's as simple as popping the old one out and putting the new one in. No reprogramming should be required.

===Incorrect CSID===

The CSID (Central Station ID) is the identifier that alarm companies use to authenticate with your panel. There are two different states that this can be in:

Factory state - default CSID:

In a factory state the CSID is uninitialized and the panel can be connected to by using the First Time Communication option with the default CSID.

CSID set:

If your CSID has been changed by an alarm company then Compass® cannot access your panel unless it's been specified correctly inside Compass®. You'll either need to obtain that ID from them or reset the dialer settings. The dialer settings may be reset by using *96 in programming mode typically, but please consult your programming manual before doing so.

Warning: If your alarm system is currently monitored you should note that changing your dialer settings (with *96 or otherwise) will potentially keep your alarm company from doing their job.

==No COM port available in the AlarmDecoder Configuration tool==

Please email us at [mailto:alarmdecoder@support.nutech.com alarmdecoder@support.nutech.com] and we'll help you figure out what's going on.

=Getting Help=

If you have issues with the software please feel free to email us at [mailto:alarmdecoder@support.nutech.com alarmdecoder@support.nutech.com] or post in our [http://www.alarmdecoder.com/forums/index.php forums].

Please include the following details with your request:
* Operating system
* Panel model
* Panel revision

• All trademarks are the property of their respective owners.

AlarmDecoder Modem

2016-01-15T23:29:27Z

204.10.16.29:

=Introduction=

Programming your alarm system tends to be a tedious endeavour so our goal with the AlarmDecoder Modem is to make it less intimidating and less time consuming by letting the Compass® software do most of the work without having to deal with ancient modems.

Please read through the FAQ to determine if your panel is compatible.

=FAQ=

==Is your panel supported?==

===Confirming your panel model and revision===

[[File:Panel_model.png|thumb|Vista 20P]]
[[File:Panel_revision.png|thumb|Revision 7.0]]

The first thing you need to check is the model of the panel. If you don't know the model off-hand it's usually found on the panel circuit board, either as a sticker or printed directly on the board, and is normally a part of a larger identifier.

Next, you need to confirm that the panel software revision meets the level required to support internet downloading. You can determine the revision of your panel by again checking the panel circuit board for a chip & socket with a sticker on it.

===List of supported panels===
{| class="wikitable"
|+ Panel Compatibility
! Manufacturer
! Model
! Revision
|-
| Vista || 10P || style="text-align:center;" | 2.0+
|-
| Vista || 10PSIA || style="text-align:center;" | 3.0+
|-
| Vista || 15P || style="text-align:center;" | 5.2+
|-
| Vista || 20P / 20PSIA || style="text-align:center;" | 5.2+
|-
| First Alert || FA130CP || style="text-align:center;" | 2.0+
|-
| First Alert || FA130CPSIA || style="text-align:center;" | 3.0+
|-
| First Alert || FA148CP / FA148CPSIA || style="text-align:center;" | 5.2+
|-
| First Alert || FA168CPS / FA168CPSSIA || style="text-align:center;" | 5.2+
|}

==Do I need to know my installer code?==

While it's technically possible you could make things work without knowing the installer code for your panel, there are a number of things that may need to be changed in the panel programming.

If your panel is currently or was previously monitored you'll likely need to either obtain the CSID and Account # from your alarm company or reset the dialer settings to factory default. This can typically be done by executing *96 while in programming mode.

==Can I use this while monitored by an alarm company?==

Again, this is technically possible, but you'd need to convince your alarm company to provide you with the CSID and Account # on your panel.

Please note that if you reset your dialer settings it will keep your alarm company from monitoring your home.

==Does this support ADT branded panels?==

Unfortunately ADT utilizes a custom default CSID so it can't be used without knowing what this is. To our knowledge this is undocumented. In theory you may be able to swap the PROM, but this is untested.

==Where can I get Compass®?==

Compass is available for download on the internet, though we cannot provide any direct links.

=Setup & Configuration=

# Download the AlarmDecoder Modem software using the link provided in your order email.
# Run the installer. This will install the modem and any necessary prerequisites.
#* Enter your product key when prompted.
# Make sure that all keypad applications, terminal clients or other software accessing the AlarmDecoder is closed. One connection is allowed at a time.
# Configure the AlarmDecoder Modem
## Run the '''AlarmDecoder Modem Setup''' from your Start Menu.
### Choose your AlarmDecoder Modem COM port from the first dropdown box.
###* You should make a note of this for later.
### Select USB, Serial or Network to indicate the type and location of your AlarmDecoder device.
###* If USB or Serial: Select the correct AlarmDecoder COM port.
###* If Network: Fill in the name or IP address of the computer (or AD2PI) that's running the ser2sock service.
###** Note: This service is preinstalled on our pre-configured Raspbian disk images.
### Click ''Save''
# Configure Compass®
## Create a new modem
##* Compass® 1.x:
##*# Select the AlarmDecoder Modem Comm port (from the first dropdown) as your COM port.
##* Compass® 2.x:
##*# Click Configure COM ports
##*# Choose your AlarmDecoder Modem COM port from the list and click ''Add''.
##*# Close the window and select the port in the list.
## Configure the modem
##* Compass® 1.x:
##*# Select ''Ademco'' for the Company
##*# Select ''Accura 336'' as your modem type.
##* Compass® 2.x:
##*# Select ''Ademco/First Alert'' for the Company.
##*# Select ''Ademco CIA 2400'' as your modem type.
## Open (or create) a Customer
## Open the Communications screen
## Test your modem connection
### Set the panel phone number to whatever you prefer. It is required but ignored.
### Uncheck the ''Answering Machine Defeat'' checkbox.
### Select the proper CSID setting for your install.
###* ''First Time Communication'': Select this if your panel has a default CSID. (Field 36)
###** ''Acct # in Panel'': Select this option if the Acct # has been programmed on your panel. (Field 32) The Account number in Compass® much match.
### Click ''Connect''

=Using The Modem=

Using Compass® is beyond the scope of this document, but one thing that should be noted is the definition of UPLOAD and DOWNLOAD.

These are opposite from traditional logic since they are defined as if from Compass®' point of view at a alarm company. UPLOAD retrieves the configuration from your panel and puts it into Compass®. DOWNLOAD does the opposite and writes the configuration to your panel.

=Troubleshooting=

==Connection to panel failed==

There are a few things that can cause the connection to the panel to fail. The following issues should be checked in the order they're presented, though the incorrect CSID is probably the most common issue.

==Panel too old==

Check the revision of your panel by following the instructions <here>.

It's a fairly simple process to swap the chip on your panel if the revision doesn't meet the minimum requirement. You can find replacement chips with newer firmware for a reasonable price on Ebay. After you get the chip it's as simple as popping the old one out and putting the new one in. No reprogramming should be required.

==Incorrect CSID==

The CSID (Central Station ID) is the identifier that alarm companies use to authenticate with your panel. There are two different states that this can be in:

Factory state - default CSID:

In a factory state the CSID is uninitialized and the panel can be connected to by using the First Time Communication option with the default CSID.

CSID set:

If your CSID has been changed by an alarm company then Compass® cannot access your panel unless it's been specified correctly inside Compass®. You'll either need to obtain that ID from them or reset the dialer settings. The dialer settings may be reset by using *96 in programming mode typically, but please consult your programming manual before doing so.

Warning: If your alarm system is currently monitored you should note that changing your dialer settings (with *96 or otherwise) will potentially keep your alarm company from doing their job.

==No COM port available in the AlarmDecoder Configuration tool==

Please contact support at alarmdecoder@support.nutech.com and we'll help you figure out what's going on.

=Getting Help=

If you have issues with the software please feel free to contact us at alarmdecoder@support.nutech.com or post in our forums.

Please include the following details with your request:
* Operating system
* Panel model
* Panel revision

• All trademarks are the property of their respective owners.

AlarmDecoder Modem

2016-01-15T23:18:26Z

204.10.16.29:

=Introduction=

Programming your alarm system tends to be a tedious endeavour so our goal with the AlarmDecoder Modem is to make it less intimidating and less time consuming by letting the Compass® software do most of the work without having to deal with ancient modems.

Please read through the FAQ to determine if your panel is compatible.

=FAQ=

==Is your panel supported?==

===Confirming your panel model and revision===

[[File:Panel_model.png|thumb|Vista 20P]]
[[File:Panel_revision.png|thumb|Revision 7.0]]

The first thing you need to check is the model of the panel. If you don't know the model off-hand it's usually found on the panel circuit board, either as a sticker or printed directly on the board, and is normally a part of a larger identifier.

Next, you need to confirm that the panel software revision meets the level required to support internet downloading. You can determine the revision of your panel by again checking the panel circuit board for a chip & socket with a sticker on it.

===List of supported panels===
{| class="wikitable"
|+ Panel Compatibility
! Manufacturer
! Model
! Revision
|-
| Vista || 10P || style="text-align:center;" | 2.0+
|-
| Vista || 10PSIA || style="text-align:center;" | 3.0+
|-
| Vista || 15P || style="text-align:center;" | 5.2+
|-
| Vista || 20P / 20PSIA || style="text-align:center;" | 5.2+
|-
| First Alert || FA130CP || style="text-align:center;" | 2.0+
|-
| First Alert || FA130CPSIA || style="text-align:center;" | 3.0+
|-
| First Alert || FA148CP / FA148CPSIA || style="text-align:center;" | 5.2+
|-
| First Alert || FA168CPS / FA168CPSSIA || style="text-align:center;" | 5.2+
|}

==Do I need to know my installer code?==

While it's technically possible you could make things work without knowing the installer code for your panel, there are a number of things that may need to be changed in the panel programming.

If your panel is currently or was previously monitored you'll likely need to either obtain the CSID and Account # from your alarm company or reset the dialer settings to factory default. This can typically be done by executing *96 while in programming mode.

==Can I use this while monitored by an alarm company?==

Again, this is technically possible, but you'd need to convince your alarm company to provide you with the CSID and Account # on your panel.

Please note that if you reset your dialer settings it will keep your alarm company from monitoring your home.

==Does this support ADT branded panels?==

Unfortunately ADT utilizes a custom default CSID so it can't be used without knowing what this is. To our knowledge this is undocumented. In theory you may be able to swap the PROM, but this is untested.

==Where can I get Compass®?==

Compass is available for download on the internet, though we cannot provide any direct links.

=Setup & Configuration=

# Download the AlarmDecoder Modem software using the link provided in your order email.
# Run the installer. This will install the modem and any necessary prerequisites.
#* Enter your product key when prompted.
# Make sure that all keypad applications, terminal clients or other software accessing the AlarmDecoder is closed. One connection is allowed at a time.
# Configure the AlarmDecoder Modem
## Run the AlarmDecoder Modem Setup from your Start Menu.
### Choose your AlarmDecoder Modem COM port from the first dropdown box.
###* You should make a note of this for later.
### Select USB, Serial or Network to indicate the type and location of your AlarmDecoder device.
###* If USB or Serial: Select the correct AlarmDecoder COM port.
###* If Network: Fill in the name or IP address of the computer (or AD2PI) that's running the ser2sock service.
###** Note: This service is preinstalled on our pre-configured Raspbian disk images.
### Click Save
# Configure Compass®
## Create a new modem
##* Compass® 1.x:
##*# Select the AlarmDecoder Modem Comm port (from the first dropdown) as your COM port.
##* Compass® 2.x:
##*# Click Configure COM ports
##*# Choose your AlarmDecoder Modem COM port from the list and click Add.
##*# Close the window and select the port in the list.
## Configure the modem
##* Compass® 1.x:
##*# Select Ademco for the Company
##*# Select Accura 336 as your modem type.
##* Compass® 2.x:
##*# Select Ademco/First Alert for the Company.
##*# Select Ademco CIA 2400 as your modem type.
## Open (or create) as Customer
## Open the Communications screen
## Test your modem connection
### Set the panel phone number to whatever you prefer. It is required but ignored.
### Uncheck the Answering Machine Defeat checkbox.
### Select the proper CSID setting for your install.
###* First Time Communication: Select this if your panel has a default CSID. (Field 36)
###** Acct # in Panel: Select this option if the Acct # has been programmed on your panel. (Field 32) The Account number in Compass® much match.
### Click Connect

=Using The Modem=

Using Compass® is beyond the scope of this document, but one thing that should be noted is the definition of UPLOAD and DOWNLOAD.

These are opposite from traditional logic since they are defined as if from Compass®' point of view at a alarm company. UPLOAD retrieves the configuration from your panel and puts it into Compass®. DOWNLOAD does the opposite and writes the configuration to your panel.

=Troubleshooting=

==Connection to panel failed==

There are a few things that can cause the connection to the panel to fail. The following issues should be checked in the order they're presented, though the incorrect CSID is probably the most common issue.

==Panel too old==

Check the revision of your panel by following the instructions <here>.

It's a fairly simple process to swap the chip on your panel if the revision doesn't meet the minimum requirement. You can find replacement chips with newer firmware for a reasonable price on Ebay. After you get the chip it's as simple as popping the old one out and putting the new one in. No reprogramming should be required.

==Incorrect CSID==

The CSID (Central Station ID) is the identifier that alarm companies use to authenticate with your panel. There are two different states that this can be in:

Factory state - default CSID:

In a factory state the CSID is uninitialized and the panel can be connected to by using the First Time Communication option with the default CSID.

CSID set:

If your CSID has been changed by an alarm company then Compass® cannot access your panel unless it's been specified correctly inside Compass®. You'll either need to obtain that ID from them or reset the dialer settings. The dialer settings may be reset by using *96 in programming mode typically, but please consult your programming manual before doing so.

Warning: If your alarm system is currently monitored you should note that changing your dialer settings (with *96 or otherwise) will potentially keep your alarm company from doing their job.

==No COM port available in the AlarmDecoder Configuration tool==

Please contact support at alarmdecoder@support.nutech.com and we'll help you figure out what's going on.

=Getting Help=

If you have issues with the software please feel free to contact us at alarmdecoder@support.nutech.com or post in our forums.

Please include the following details with your request:
* Operating system
* Panel model
* Panel revision

• All trademarks are the property of their respective owners.

AlarmDecoder Modem

2016-01-15T23:09:00Z

204.10.16.29: Blanked the page

AlarmDecoder Modem

2016-01-15T23:08:48Z

204.10.16.29: Created page with "=Introduction= Programming your alarm system tends to be a tedious endeavour so our goal with the AlarmDecoder Modem is to make it less intimidating and less time consuming b..."

=Introduction=

Programming your alarm system tends to be a tedious endeavour so our goal with the AlarmDecoder Modem is to make it less intimidating and less time consuming by letting the Compass® software do most of the work without having to deal with ancient modems.

Please read through the FAQ to determine if your panel is compatible.

=FAQ=

==Is your panel supported?==

===Confirming your panel model and revision===

[[File:Panel_model.png|thumb|Vista 20P]]
[[File:Panel_revision.png|thumb|Revision 7.0]]

The first thing you need to check is the model of the panel. If you don't know the model off-hand it's usually found on the panel circuit board, either as a sticker or printed directly on the board, and is normally a part of a larger identifier.

Next, you need to confirm that the panel software revision meets the level required to support internet downloading. You can determine the revision of your panel by again checking the panel circuit board for a chip & socket with a sticker on it.

===List of supported panels===
{| class="wikitable"
|+ Panel Compatibility
! Manufacturer
! Model
! Revision
|-
| Vista || 10P || style="text-align:center;" | 2.0+
|-
| Vista || 10PSIA || style="text-align:center;" | 3.0+
|-
| Vista || 15P || style="text-align:center;" | 5.2+
|-
| Vista || 20P / 20PSIA || style="text-align:center;" | 5.2+
|-
| First Alert || FA130CP || style="text-align:center;" | 2.0+
|-
| First Alert || FA130CPSIA || style="text-align:center;" | 3.0+
|-
| First Alert || FA148CP / FA148CPSIA || style="text-align:center;" | 5.2+
|-
| First Alert || FA168CPS / FA168CPSSIA || style="text-align:center;" | 5.2+
|}

==Do I need to know my installer code?==

While it's technically possible you could make things work without knowing the installer code for your panel, there are a number of things that may need to be changed in the panel programming.

If your panel is currently or was previously monitored you'll likely need to either obtain the CSID and Account # from your alarm company or reset the dialer settings to factory default. This can typically be done by executing *96 while in programming mode.

==Can I use this while monitored by an alarm company?==

Again, this is technically possible, but you'd need to convince your alarm company to provide you with the CSID and Account # on your panel.

Please note that if you reset your dialer settings it will keep your alarm company from monitoring your home.

==Does this support ADT branded panels?==

Unfortunately ADT utilizes a custom default CSID so it can't be used without knowing what this is. To our knowledge this is undocumented. In theory you may be able to swap the PROM, but this is untested.

==Where can I get Compass®?==

Compass is available for download on the internet, though we cannot provide any direct links.

=Setup & Configuration=

# Download the AlarmDecoder Modem software using the link provided in your order email.
# Run the installer. This will install the modem and any necessary prerequisites.
#* Enter your product key when prompted.
# Make sure that all keypad applications, terminal clients or other software accessing the AlarmDecoder is closed. One connection is allowed at a time.
# Configure the AlarmDecoder Modem
## Run the AlarmDecoder Modem Setup from your Start Menu.
### Choose your AlarmDecoder Modem COM port from the first dropdown box.
###* You should make a note of this for later.
### Select USB, Serial or Network to indicate the type and location of your AlarmDecoder device.
###* If USB or Serial: Select the correct AlarmDecoder COM port.
###* If Network: Fill in the name or IP address of the computer (or AD2PI) that's running the ser2sock service.
###** Note: This service is preinstalled on our pre-configured Raspbian disk images.
### Click Save
# Configure Compass®
## Create a new modem
##* Compass® 1.x:
##*# Select the AlarmDecoder Modem Comm port (from the first dropdown) as your COM port.
##* Compass® 2.x:
##*# Click Configure COM ports
##*# Choose your AlarmDecoder Modem COM port from the list and click Add.
##*# Close the window and select the port in the list.
## Configure the modem
##* Compass® 1.x:
##*# Select Ademco for the Company
##*# Select Accura 336 as your modem type.
##* Compass® 2.x:
##*# Select Ademco/First Alert for the Company.
##*# Select Ademco CIA 2400 as your modem type.
## Open (or create) as Customer
## Open the Communications screen
## Test your modem connection
### Set the panel phone number to whatever you prefer. It is required but ignored.
### Uncheck the Answering Machine Defeat checkbox.
### Select the proper CSID setting for your install.
###* First Time Communication: Select this if your panel has a default CSID. (Field 36)
###** Acct # in Panel: Select this option if the Acct # has been programmed on your panel. (Field 32) The Account number in Compass® much match.
### Click Connect

=Using The Modem=

Using Compass® is beyond the scope of this document, but one thing that should be noted is the definition of UPLOAD and DOWNLOAD.

These are opposite from traditional logic since they are defined as if from Compass®' point of view at a alarm company. UPLOAD retrieves the configuration from your panel and puts it into Compass®. DOWNLOAD does the opposite and writes the configuration to your panel.

=Troubleshooting=

==Connection to panel failed==

There are a few things that can cause the connection to the panel to fail. The following issues should be checked in the order they're presented, though the incorrect CSID is probably the most common issue.

==Panel too old==

Check the revision of your panel by following the instructions <here>.

It's a fairly simple process to swap the chip on your panel if the revision doesn't meet the minimum requirement. You can find replacement chips with newer firmware for a reasonable price on Ebay. After you get the chip it's as simple as popping the old one out and putting the new one in. No reprogramming should be required.

==Incorrect CSID==

The CSID (Central Station ID) is the identifier that alarm companies use to authenticate with your panel. There are two different states that this can be in:

Factory state - default CSID:

In a factory state the CSID is uninitialized and the panel can be connected to by using the First Time Communication option with the default CSID.

CSID set:

If your CSID has been changed by an alarm company then Compass® cannot access your panel unless it's been specified correctly inside Compass®. You'll either need to obtain that ID from them or reset the dialer settings. The dialer settings may be reset by using *96 in programming mode typically, but please consult your programming manual before doing so.

Warning: If your alarm system is currently monitored you should note that changing your dialer settings (with *96 or otherwise) will potentially keep your alarm company from doing their job.

==No COM port available in the AlarmDecoder Configuration tool==

Please contact support at alarmdecoder@support.nutech.com and we'll help you figure out what's going on.

=Getting Help=

If you have issues with the software please feel free to contact us at alarmdecoder@support.nutech.com or post in our forums.

Please include the following details with your request:
* Operating system
* Panel model
* Panel revision

• All trademarks are the property of their respective owners.

File:Panel revision.png

2016-01-15T21:33:43Z

204.10.16.29:

File:Panel model.png

2016-01-15T21:33:12Z

204.10.16.29:

Supported Home Automation Systems

2016-01-11T23:20:39Z

204.10.16.29:

__NOTOC__
[[Category:FAQ]]
[[Category:Documentation]]
[[Category:Specifications]]
[[Category:Features]]
When Sean Mathews first started putting solder and code into the first prototypes back in 2007 one of the primary design goals of the '''AlarmDecoder''' was to make sure it would be easy to integrate with his own home automation system
To further his goals we have consistently provided support to anyone wanting to add support for an existing system. If you don't see your favorite product here then talk to the developers of that product and let them know about the AlarmDecoder and encourage them to add support.

<center>'''Here is a list of some of the systems that have support for the AlarmDecoder'''</center>
----

{| align="center" class="wikitable" border="1"
|-
! scope="col" width="180px" | Product Name
! scope="col" width="100px" | Driver License
! scope="col" width="300px" | Product URL
! scope="col" width="300px" | Solution Details
|-
| style="background:#F5FFF5" align="center" | Control4
| align="center" | commercial
| http://www.houselogix.com
| [http://www.houselogix.com/ Phone & Email]
|-
| style="background:#F5FFF5" align="center" | HomeSeer
| align="center" | commercial
| http://www.homeseer.com
| [http://board.homeseer.com/forumdisplay.php?f=992 Forum Thread]
|-
| style="background:#F5FFF5" align="center" | mControl v2 & v3
| align="center" | commercial
| http://www.embeddedautomation.com
| [http://www.embeddedautomation.com/downloads/mcontrol/mControl%20v3%20-%20Feature%20Summary%20Document.pdf Page 24]
|-
| style="background:#F5FFF5" align="center" | Vera2
| align="center" | open source
| http://www.micasaverde.com
| [http://wiki.micasaverde.com/index.php/Supported_Hardware Wiki]
|-
| style="background:#F5FFF5" align="center" | Misterhouse
| align="center" | open source
| http://misterhouse.sourceforge.net
| [https://sourceforge.net/mailarchive/message.php?msg_id=31468020 Email Thread]
|-
| style="background:#F5FFF5" align="center" | Girder 5
| align="center" | open source
| http://www.promixis.com
| [http://www.promixis.com/forums/showthread.php?21535-Nutech-AD2USB-Alarm-Panel-Integration/page2 Forum Thread]
|-
| style="background:#F5FFF5" align="center" | Indigo
| align="center" | open source
| http://www.perceptiveautomation.com
| [http://www.perceptiveautomation.com/userforum/viewtopic.php?f=22&t=7584&start=0 Forum Thread]
|-
| style="background:#F5FFF5" align="center" | Premise Home Control
| align="center" | open source
| [http://cocoontech.com/forums/page/home-automation-software/_/premise-r3 Info Page]
| [http://cocoontech.com/forums/topic/25698-ad2usb-for-vista-security-panels/ Forum Thread]
|-
| style="background:#F5FFF5" align="center" | ISY-99
| align="center" | open source
| [https://www.universal-devices.com/residential/isy994i-series/ Info Page]
| [http://forum.universal-devices.com/topic/7648-ad2usb-nslu2-isy-99/#p61925 Forum Thread]
|-
| style="background:#F5FFF5" align="center" | openHAB
| align="center" | open source
| [http://www.openhab.org/ http://www.openhab.org]
| [https://github.com/openhab/openhab/wiki/AlarmDecoder-binding openhab official], [https://github.com/N5QM/ad2openhab ad2openhab]
|-
| style="background:#F5FFF5" align="center" | MACHomeAutomation XTension
| align="center" | commercial
| [http://machomeautomation.com/ http://machomeautomation.com/]
| [http://machomeautomation.com/doku.php/supported_hardware/ad2usb MACHomeAutomation XTension]
|-
| style="background:#F5FFF5" align="center" | SmartThings
| align="center" | open source
| [http://www.smartthings.com/ http://www.smartthings.com/]
| [http://community.smartthings.com/t/vista-alarm-integration-using-nutech-ad2usb-and-mac/7039 HowTo]
|-
| style="background:#F5FFF5" align="center" | OpenRemote
| align="center" | open source
| [http://www.openremote.org/ http://www.openremote.org/]
| [http://www.openremote.org/display/forums/Support+for+communicating+with+Ademco+Security+Panel Info]

|-
| style="background:#F5FFF5" align="center" | Write your own!
| align="center" |  
| [[Developers|Developer Wiki]]
|  
|}

----
:As with all open source projects they by their very nature are in constant need for more contributors. Please contact us at [mailto:ad2usb@support.nutech.com ad2usb@support.nutech.com] if you are interested in supporting these or others and we will do our best to support your efforts.

:* MisterHouse
:* LinuxMCE
:* Don't see your project here? Drop us an email at [mailto:ad2usb@support.nutech.com ad2usb@support.nutech.com] and tell us about your project.

FirmwareRevisionHistory

2015-10-13T22:58:01Z

204.10.16.29: /* 2.2a.8.3b */

=Beta Releases=

==2.2a.8.3b==
* Initial VPLEX support
** Connect V+ to 12V V- to GND and V+ to DI and make sure config mode is Ademco.
*** NOTE: only possible to connect to one BUS at a time for now so an additional AD2* is needed to monitor the VPLEX bus.
* improved re-transmit handling with Ademco/Vista

=Stable Releases=

==2.2a.8.2==
* Bugfixes
** Settings allocation bug
* Notes
** Shipping in all units built after October 2015

==2.2a.8.1==
* New Features
** Missing DSC message
** First dotted quad revision

==2.2a.8==
* New Features
** DSC panel support
** Compass download/upload support
** Blinking LED now displays error codes.
** New message type '!ERR' which can be retrieved by sending an 'e' to the AlarmDecoder

==2.2a.6==

==2.2a.4==
* New Features
** Keypad Address Mask
** Long Range Radio (LRR) Emulation
** Message deduplication

FirmwareRevisionHistory

2015-10-13T20:23:55Z

204.10.16.29: /* 2.2a.8.3b */

=Beta Releases=

==2.2a.8.3b==
* Initial VPLEX support
** Connect V+ to 12V V- to GND and V+ to DI and enable VPLEX support in config.
*** NOTE: only possible to connect to one BUS at a time for now so an additional AD2* is needed to monitor the VPLEX bus.
* improved re-transmit handling with Ademco/Vista

=Stable Releases=

==2.2a.8.2==
* Bugfixes
** Settings allocation bug
* Notes
** Shipping in all units built after October 2015

==2.2a.8.1==
* New Features
** Missing DSC message
** First dotted quad revision

==2.2a.8==
* New Features
** DSC panel support
** Compass download/upload support
** Blinking LED now displays error codes.
** New message type '!ERR' which can be retrieved by sending an 'e' to the AlarmDecoder

==2.2a.6==

==2.2a.4==
* New Features
** Keypad Address Mask
** Long Range Radio (LRR) Emulation
** Message deduplication

FirmwareRevisionHistory

2015-10-13T20:23:00Z

204.10.16.29: /* 2.2a.8.3b */

=Beta Releases=

==2.2a.8.3b==
* Initial VPLEX support
** Connect V+ to 12V V- to GND and V+ to DI and enable VPlex support in config
* improved re-transmit handling with Ademco/Vista

=Stable Releases=

==2.2a.8.2==
* Bugfixes
** Settings allocation bug
* Notes
** Shipping in all units built after October 2015

==2.2a.8.1==
* New Features
** Missing DSC message
** First dotted quad revision

==2.2a.8==
* New Features
** DSC panel support
** Compass download/upload support
** Blinking LED now displays error codes.
** New message type '!ERR' which can be retrieved by sending an 'e' to the AlarmDecoder

==2.2a.6==

==2.2a.4==
* New Features
** Keypad Address Mask
** Long Range Radio (LRR) Emulation
** Message deduplication

Firmware

2015-10-13T20:13:45Z

204.10.16.29: /* Download */

[http://www.alarmdecoder.com/downloads/firmware/2.2/ademcoemu_V2_2a_8_3b.zip 2.2a.8.3b]

__NOTOC__
[[Category:Documentation]]
[[Category:Downloads]]
{{PageHeading|
The current stable firmware is '''V2.2a.8'''. It is not possible to brick the AlarmDecoder but it can get into some states that make firmware updates difficult so be patient when updating the firmware in your AlarmDecoder.
}}

==Identifying your Board Revision==
Use the images below to identify what revision of AlarmDecoder you have.

{| summary="AlarmDecoder Devices and Revisions"
|[[File:2_2_board.jpg|thumb|2.2 (AD2USB)]]
|[[File:2_2_serial.jpg|thumb|2.2 (AD2SERIAL)]]
|[[File:Ad2pi.png|thumb|2.2 (AD2PI)]]
|[[File:2_0_board.jpg|thumb|2.0 (AD2USB)]]
|}

==Checking your Firmware Version==
You can retrieve the version information by connecting to your device with a terminal program (PuTTY, screen, etc.) and sending the V command.

A response will be returned with your current version information:
!VER:ffffffff,'''V2.2a.8a8''',TX;RX;SM;VZ;RF;ZX;RE;AU;3X;CG;DD;MF;LR;KE;MK;CB;DS

==Download==
{| class="wikitable" border="1"
! scope="col" width="120px" | Board Revision
! scope="col" width="140px" | Firmware Version
! scope="col" width="60px" | Revision History
|-
| colspan="3" align="center" style="background-color: #70BA66; font-weight: bold" | Stable
|-
| align="center" style="font-weight: bold" | 2.2+
| align="center" | [http://www.alarmdecoder.com/downloads/firmware/2.2/ademcoemu_V2_2a_8_2.zip 2.2a.8.2]
| align="center" | [[FirmwareRevisionHistory#2.2a.8.2|link]]
|-
| align="center" style="font-weight: bold" | 2.2+
| align="center" | [http://www.alarmdecoder.com/downloads/firmware/2.2/ademcoemu_V2_2a_6.zip 2.2a.6]
| align="center" | [[FirmwareRevisionHistory#2.2a.6|link]]
|-
| align="center" | 2.0
| align="center" | [http://www.alarmdecoder.com/downloads/firmware/2.0/ademcoemu_V2_1f_10.zip 2.1f.10]
| align="center" | -
|-
| colspan="3" align="center" style="background-color: #F56464; font-weight: bold" | Beta
|-
| align="center" style="font-weight: bold" | 2.2+
| align="center" | [http://www.alarmdecoder.com/downloads/firmware/2.2/ademcoemu_V2_2a_8_3b.zip 2.2a.8.3b]
| align="center" | [[FirmwareRevisionHistory#2.2a.8.3b|link]]
|-
| colspan="3" align="center" style="background-color: #FAFA70; font-weight: bold" | Legacy
|-
| align="center" style="font-weight: bold" | 2.2+
| align="center" | [http://www.alarmdecoder.com/downloads/firmware/2.2/ademcoemu_V2_2a_3_beta.zip 2.2a.3]
| align="center" | -
|-
| align="center" style="font-weight: bold" | 2.2+
| align="center" | [http://www.alarmdecoder.com/downloads/firmware/2.2/ademcoemu_V2_2a_2.zip 2.2a.2]
| align="center" | -
|-
| align="center" | 2.0
| align="center" | [http://www.alarmdecoder.com/downloads/firmware/2.0/ademcoemu_V2_1f_0e.zip 2.1f.0e]
| align="center" | -
|-
| align="center" | 2.0
| align="center" | [http://www.alarmdecoder.com/downloads/firmware/2.0/ademcoemu_V2_1f_0d.zip 2.1f.0d]
| align="center" | -
|-
| align="center" | 2.0
| align="center" | [http://www.alarmdecoder.com/downloads/firmware/2.0/ademcoemu_V1_0f_26.zip 1.0f.26]
| align="center" | -
|}

==Instructions==
; There are a few different ways to go about flashing your device.

# Make sure that you have completed the installation and can communicate with your device through a terminal program. (PuTTY, screen, etc.)
# Download one of the available programs.
#* [[AlarmDecoder_Keypad|AlarmDecoder Keypad]] - .NET/Mono and Gtk#
#* [http://www.alarmdecoder.com/downloads/firmwareupload.zip Console firmware uploader] - .NET/Mono
#* [http://github.com/nutechsoftware/alarmdecoder ad2-firmwareupload] - from the official Python library
# Download your desired firmware from the choices above.
# Flash the firmware
#* AlarmDecoder Keypad
#*# Navigate to <tt>System -> Firmware Upload</tt>
#*# Select the firmware file to upload.
#*# The program will start uploading automatically.
#* Console firmware uploader
#*# <tt>firmwareupload COM6 115200 firmware.hex</tt>
#* ad2-firmwareupload
#*# <tt>ad2-firmwareupload firmware.hex /dev/ttyUSB0 115200</tt>
# Confirm communication with your device.
# Reset your device's configuration by sending ! and going through the prompts.

Firmware

2015-10-13T20:11:09Z

204.10.16.29: /* Download */

[http://www.alarmdecoder.com/downloads/firmware/2.2/ademcoemu_V2_2a_8_3b.zip 2.2a.8.3b]

__NOTOC__
[[Category:Documentation]]
[[Category:Downloads]]
{{PageHeading|
The current stable firmware is '''V2.2a.8'''. It is not possible to brick the AlarmDecoder but it can get into some states that make firmware updates difficult so be patient when updating the firmware in your AlarmDecoder.
}}

==Identifying your Board Revision==
Use the images below to identify what revision of AlarmDecoder you have.

{| summary="AlarmDecoder Devices and Revisions"
|[[File:2_2_board.jpg|thumb|2.2 (AD2USB)]]
|[[File:2_2_serial.jpg|thumb|2.2 (AD2SERIAL)]]
|[[File:Ad2pi.png|thumb|2.2 (AD2PI)]]
|[[File:2_0_board.jpg|thumb|2.0 (AD2USB)]]
|}

==Checking your Firmware Version==
You can retrieve the version information by connecting to your device with a terminal program (PuTTY, screen, etc.) and sending the V command.

A response will be returned with your current version information:
!VER:ffffffff,'''V2.2a.8a8''',TX;RX;SM;VZ;RF;ZX;RE;AU;3X;CG;DD;MF;LR;KE;MK;CB;DS

==Download==
{| class="wikitable" border="1"
! scope="col" width="120px" | Board Revision
! scope="col" width="140px" | Firmware Version
! scope="col" width="60px" | Revision History
|-
| colspan="3" align="center" style="background-color: #70BA66; font-weight: bold" | Stable
|-
| align="center" style="font-weight: bold" | 2.2+
| align="center" | [http://www.alarmdecoder.com/downloads/firmware/2.2/ademcoemu_V2_2a_8.zip 2.2a.8.2]
| align="center" | [[FirmwareRevisionHistory#2.2a.8.2|link]]
|-
| align="center" style="font-weight: bold" | 2.2+
| align="center" | [http://www.alarmdecoder.com/downloads/firmware/2.2/ademcoemu_V2_2a_6.zip 2.2a.6]
| align="center" | [[FirmwareRevisionHistory#2.2a.6|link]]
|-
| align="center" | 2.0
| align="center" | [http://www.alarmdecoder.com/downloads/firmware/2.0/ademcoemu_V2_1f_10.zip 2.1f.10]
| align="center" | -
|-
| colspan="3" align="center" style="background-color: #F56464; font-weight: bold" | Beta
|-
| align="center" style="font-weight: bold" | 2.2+
| align="center" | [http://www.alarmdecoder.com/downloads/firmware/2.2/ademcoemu_V2_2a_8_3b.zip 2.2a.8.3b]
| align="center" | [[FirmwareRevisionHistory#2.2a.8.3b|link]]
|-
| colspan="3" align="center" style="background-color: #FAFA70; font-weight: bold" | Legacy
|-
| align="center" style="font-weight: bold" | 2.2+
| align="center" | [http://www.alarmdecoder.com/downloads/firmware/2.2/ademcoemu_V2_2a_3_beta.zip 2.2a.3]
| align="center" | -
|-
| align="center" style="font-weight: bold" | 2.2+
| align="center" | [http://www.alarmdecoder.com/downloads/firmware/2.2/ademcoemu_V2_2a_2.zip 2.2a.2]
| align="center" | -
|-
| align="center" | 2.0
| align="center" | [http://www.alarmdecoder.com/downloads/firmware/2.0/ademcoemu_V2_1f_0e.zip 2.1f.0e]
| align="center" | -
|-
| align="center" | 2.0
| align="center" | [http://www.alarmdecoder.com/downloads/firmware/2.0/ademcoemu_V2_1f_0d.zip 2.1f.0d]
| align="center" | -
|-
| align="center" | 2.0
| align="center" | [http://www.alarmdecoder.com/downloads/firmware/2.0/ademcoemu_V1_0f_26.zip 1.0f.26]
| align="center" | -
|}

==Instructions==
; There are a few different ways to go about flashing your device.

# Make sure that you have completed the installation and can communicate with your device through a terminal program. (PuTTY, screen, etc.)
# Download one of the available programs.
#* [[AlarmDecoder_Keypad|AlarmDecoder Keypad]] - .NET/Mono and Gtk#
#* [http://www.alarmdecoder.com/downloads/firmwareupload.zip Console firmware uploader] - .NET/Mono
#* [http://github.com/nutechsoftware/alarmdecoder ad2-firmwareupload] - from the official Python library
# Download your desired firmware from the choices above.
# Flash the firmware
#* AlarmDecoder Keypad
#*# Navigate to <tt>System -> Firmware Upload</tt>
#*# Select the firmware file to upload.
#*# The program will start uploading automatically.
#* Console firmware uploader
#*# <tt>firmwareupload COM6 115200 firmware.hex</tt>
#* ad2-firmwareupload
#*# <tt>ad2-firmwareupload firmware.hex /dev/ttyUSB0 115200</tt>
# Confirm communication with your device.
# Reset your device's configuration by sending ! and going through the prompts.

FirmwareRevisionHistory

2015-10-13T20:10:43Z

204.10.16.29: /* Beta Releases */

=Beta Releases=

==2.2a.8.3b==
* Something
* Something else
* Something else else

=Stable Releases=

==2.2a.8.2==
* Bugfixes
** Settings allocation bug
* Notes
** Shipping in all units built after October 2015

==2.2a.8.1==
* New Features
** Missing DSC message
** First dotted quad revision

==2.2a.8==
* New Features
** DSC panel support
** Compass download/upload support
** Blinking LED now displays error codes.
** New message type '!ERR' which can be retrieved by sending an 'e' to the AlarmDecoder

==2.2a.6==

==2.2a.4==
* New Features
** Keypad Address Mask
** Long Range Radio (LRR) Emulation
** Message deduplication

Firmware

2015-10-13T20:10:22Z

204.10.16.29: /* Download */

[http://www.alarmdecoder.com/downloads/firmware/2.2/ademcoemu_V2_2a_8_3b.zip 2.2a.8.3b]

__NOTOC__
[[Category:Documentation]]
[[Category:Downloads]]
{{PageHeading|
The current stable firmware is '''V2.2a.8'''. It is not possible to brick the AlarmDecoder but it can get into some states that make firmware updates difficult so be patient when updating the firmware in your AlarmDecoder.
}}

==Identifying your Board Revision==
Use the images below to identify what revision of AlarmDecoder you have.

{| summary="AlarmDecoder Devices and Revisions"
|[[File:2_2_board.jpg|thumb|2.2 (AD2USB)]]
|[[File:2_2_serial.jpg|thumb|2.2 (AD2SERIAL)]]
|[[File:Ad2pi.png|thumb|2.2 (AD2PI)]]
|[[File:2_0_board.jpg|thumb|2.0 (AD2USB)]]
|}

==Checking your Firmware Version==
You can retrieve the version information by connecting to your device with a terminal program (PuTTY, screen, etc.) and sending the V command.

A response will be returned with your current version information:
!VER:ffffffff,'''V2.2a.8a8''',TX;RX;SM;VZ;RF;ZX;RE;AU;3X;CG;DD;MF;LR;KE;MK;CB;DS

==Download==
{| class="wikitable" border="1"
! scope="col" width="120px" | Board Revision
! scope="col" width="140px" | Firmware Version
! scope="col" width="60px" | Revision History
|-
| colspan="3" align="center" style="background-color: #70BA66; font-weight: bold" | Stable
|-
| align="center" style="font-weight: bold" | 2.2+
| align="center" | [http://www.alarmdecoder.com/downloads/firmware/2.2/ademcoemu_V2_2a_8.zip 2.2a.8]
| align="center" | [[FirmwareRevisionHistory#2.2a.8.2|link]]
|-
| align="center" style="font-weight: bold" | 2.2+
| align="center" | [http://www.alarmdecoder.com/downloads/firmware/2.2/ademcoemu_V2_2a_6.zip 2.2a.6]
| align="center" | [[FirmwareRevisionHistory#2.2a.6|link]]
|-
| align="center" | 2.0
| align="center" | [http://www.alarmdecoder.com/downloads/firmware/2.0/ademcoemu_V2_1f_10.zip 2.1f.10]
| align="center" | -
|-
| colspan="3" align="center" style="background-color: #F56464; font-weight: bold" | Beta
|-
| align="center" style="font-weight: bold" | 2.2+
| align="center" | [http://www.alarmdecoder.com/downloads/firmware/2.2/ademcoemu_V2_2a_8_3b.zip 2.2a.8.3b]
| align="center" | [[FirmwareRevisionHistory#2.2a.8.3b|link]]
|-
| colspan="3" align="center" style="background-color: #FAFA70; font-weight: bold" | Legacy
|-
| align="center" style="font-weight: bold" | 2.2+
| align="center" | [http://www.alarmdecoder.com/downloads/firmware/2.2/ademcoemu_V2_2a_3_beta.zip 2.2a.3]
| align="center" | -
|-
| align="center" style="font-weight: bold" | 2.2+
| align="center" | [http://www.alarmdecoder.com/downloads/firmware/2.2/ademcoemu_V2_2a_2.zip 2.2a.2]
| align="center" | -
|-
| align="center" | 2.0
| align="center" | [http://www.alarmdecoder.com/downloads/firmware/2.0/ademcoemu_V2_1f_0e.zip 2.1f.0e]
| align="center" | -
|-
| align="center" | 2.0
| align="center" | [http://www.alarmdecoder.com/downloads/firmware/2.0/ademcoemu_V2_1f_0d.zip 2.1f.0d]
| align="center" | -
|-
| align="center" | 2.0
| align="center" | [http://www.alarmdecoder.com/downloads/firmware/2.0/ademcoemu_V1_0f_26.zip 1.0f.26]
| align="center" | -
|}

==Instructions==
; There are a few different ways to go about flashing your device.

# Make sure that you have completed the installation and can communicate with your device through a terminal program. (PuTTY, screen, etc.)
# Download one of the available programs.
#* [[AlarmDecoder_Keypad|AlarmDecoder Keypad]] - .NET/Mono and Gtk#
#* [http://www.alarmdecoder.com/downloads/firmwareupload.zip Console firmware uploader] - .NET/Mono
#* [http://github.com/nutechsoftware/alarmdecoder ad2-firmwareupload] - from the official Python library
# Download your desired firmware from the choices above.
# Flash the firmware
#* AlarmDecoder Keypad
#*# Navigate to <tt>System -> Firmware Upload</tt>
#*# Select the firmware file to upload.
#*# The program will start uploading automatically.
#* Console firmware uploader
#*# <tt>firmwareupload COM6 115200 firmware.hex</tt>
#* ad2-firmwareupload
#*# <tt>ad2-firmwareupload firmware.hex /dev/ttyUSB0 115200</tt>
# Confirm communication with your device.
# Reset your device's configuration by sending ! and going through the prompts.

FirmwareRevisionHistory

2015-10-13T20:06:24Z

204.10.16.29: /* Stable Releases */

=Beta Releases=

==2.2a.8.3a==
* Something
* Something else
* Something else else

=Stable Releases=

==2.2a.8.2==
* Bugfixes
** Settings allocation bug
* Notes
** Shipping in all units built after October 2015

==2.2a.8.1==
* New Features
** Missing DSC message
** First dotted quad revision

==2.2a.8==
* New Features
** DSC panel support
** Compass download/upload support
** Blinking LED now displays error codes.
** New message type '!ERR' which can be retrieved by sending an 'e' to the AlarmDecoder

==2.2a.6==

==2.2a.4==
* New Features
** Keypad Address Mask
** Long Range Radio (LRR) Emulation
** Message deduplication

Firmware

2015-10-13T20:05:18Z

204.10.16.29: /* Download */

__NOTOC__
[[Category:Documentation]]
[[Category:Downloads]]
{{PageHeading|
The current stable firmware is '''V2.2a.8'''. It is not possible to brick the AlarmDecoder but it can get into some states that make firmware updates difficult so be patient when updating the firmware in your AlarmDecoder.
}}

==Identifying your Board Revision==
Use the images below to identify what revision of AlarmDecoder you have.

{| summary="AlarmDecoder Devices and Revisions"
|[[File:2_2_board.jpg|thumb|2.2 (AD2USB)]]
|[[File:2_2_serial.jpg|thumb|2.2 (AD2SERIAL)]]
|[[File:Ad2pi.png|thumb|2.2 (AD2PI)]]
|[[File:2_0_board.jpg|thumb|2.0 (AD2USB)]]
|}

==Checking your Firmware Version==
You can retrieve the version information by connecting to your device with a terminal program (PuTTY, screen, etc.) and sending the V command.

A response will be returned with your current version information:
!VER:ffffffff,'''V2.2a.8a8''',TX;RX;SM;VZ;RF;ZX;RE;AU;3X;CG;DD;MF;LR;KE;MK;CB;DS

==Download==
{| class="wikitable" border="1"
! scope="col" width="120px" | Board Revision
! scope="col" with="140px" | Firmware Version
! scope="col" with="140px" | Revision Details
|-
| colspan="3" align="center" style="background-color: #70BA66; font-weight: bold" | Stable
|-
| align="center" style="font-weight: bold" | 2.2+
| align="center" | [http://www.alarmdecoder.com/downloads/firmware/2.2/ademcoemu_V2_2a_8.zip 2.2a.8.2]
|
|-
| align="center" style="font-weight: bold" | 2.2+
| align="center" | [http://www.alarmdecoder.com/downloads/firmware/2.2/ademcoemu_V2_2a_6.zip 2.2a.6]
|
|-
| align="center" | 2.0
| align="center" | [http://www.alarmdecoder.com/downloads/firmware/2.0/ademcoemu_V2_1f_10.zip 2.1f.10]
|
|-
| colspan="3" align="center" style="background-color: #F56464; font-weight: bold" | Beta
|-
| align="center" style="font-weight: bold" | 2.2+
| align="center" |
[http://www.alarmdecoder.com/downloads/firmware/2.2/ademcoemu_V2_2a_8_3b.zip 2.2a.8.3b]
|
|-
| colspan="3" align="center" style="background-color: #FAFA70; font-weight: bold" | Legacy
|-
| align="center" style="font-weight: bold" | 2.2+
| align="center" | [http://www.alarmdecoder.com/downloads/firmware/2.2/ademcoemu_V2_2a_3_beta.zip 2.2a.3]
|
|-
| align="center" style="font-weight: bold" | 2.2+
| align="center" | [http://www.alarmdecoder.com/downloads/firmware/2.2/ademcoemu_V2_2a_2.zip 2.2a.2]
|
|-
| align="center" | 2.0
| align="center" | [http://www.alarmdecoder.com/downloads/firmware/2.0/ademcoemu_V2_1f_0e.zip 2.1f.0e]
|
|-
| align="center" | 2.0
| align="center" | [http://www.alarmdecoder.com/downloads/firmware/2.0/ademcoemu_V2_1f_0d.zip 2.1f.0d]
|
|-
| align="center" | 2.0
| align="center" | [http://www.alarmdecoder.com/downloads/firmware/2.0/ademcoemu_V1_0f_26.zip 1.0f.26]
|
|}

==Instructions==
; There are a few different ways to go about flashing your device.

# Make sure that you have completed the installation and can communicate with your device through a terminal program. (PuTTY, screen, etc.)
# Download one of the available programs.
#* [[AlarmDecoder_Keypad|AlarmDecoder Keypad]] - .NET/Mono and Gtk#
#* [http://www.alarmdecoder.com/downloads/firmwareupload.zip Console firmware uploader] - .NET/Mono
#* [http://github.com/nutechsoftware/alarmdecoder ad2-firmwareupload] - from the official Python library
# Download your desired firmware from the choices above.
# Flash the firmware
#* AlarmDecoder Keypad
#*# Navigate to <tt>System -> Firmware Upload</tt>
#*# Select the firmware file to upload.
#*# The program will start uploading automatically.
#* Console firmware uploader
#*# <tt>firmwareupload COM6 115200 firmware.hex</tt>
#* ad2-firmwareupload
#*# <tt>ad2-firmwareupload firmware.hex /dev/ttyUSB0 115200</tt>
# Confirm communication with your device.
# Reset your device's configuration by sending ! and going through the prompts.

Firmware

2015-10-13T19:59:36Z

204.10.16.29: /* Download */

__NOTOC__
[[Category:Documentation]]
[[Category:Downloads]]
{{PageHeading|
The current stable firmware is '''V2.2a.8'''. It is not possible to brick the AlarmDecoder but it can get into some states that make firmware updates difficult so be patient when updating the firmware in your AlarmDecoder.
}}

==Identifying your Board Revision==
Use the images below to identify what revision of AlarmDecoder you have.

{| summary="AlarmDecoder Devices and Revisions"
|[[File:2_2_board.jpg|thumb|2.2 (AD2USB)]]
|[[File:2_2_serial.jpg|thumb|2.2 (AD2SERIAL)]]
|[[File:Ad2pi.png|thumb|2.2 (AD2PI)]]
|[[File:2_0_board.jpg|thumb|2.0 (AD2USB)]]
|}

==Checking your Firmware Version==
You can retrieve the version information by connecting to your device with a terminal program (PuTTY, screen, etc.) and sending the V command.

A response will be returned with your current version information:
!VER:ffffffff,'''V2.2a.8a8''',TX;RX;SM;VZ;RF;ZX;RE;AU;3X;CG;DD;MF;LR;KE;MK;CB;DS

==Download==
{| class="wikitable" border="1"
! scope="col" width="120px" | Board Revision
! scope="col" with="140px" | Firmware Version
! scope="col" with="140px" | Revision Details
|-
| colspan="3" align="center" style="background-color: #70BA66; font-weight: bold" | Stable
|-
| align="center" style="font-weight: bold" | 2.2+
| align="center" | [http://www.alarmdecoder.com/downloads/firmware/2.2/ademcoemu_V2_2a_8.zip 2.2a.8.2]
|
|-
| align="center" style="font-weight: bold" | 2.2+
| align="center" | [http://www.alarmdecoder.com/downloads/firmware/2.2/ademcoemu_V2_2a_6.zip 2.2a.6]
|
|-
| align="center" | 2.0
| align="center" | [http://www.alarmdecoder.com/downloads/firmware/2.0/ademcoemu_V2_1f_10.zip 2.1f.10]
|
|-
| colspan="3" align="center" style="background-color: #F56464; font-weight: bold" | Beta
|-
| align="center" style="font-weight: bold" | 2.2+
| align="center" |
[http://www.alarmdecoder.com/downloads/firmware/2.2/ademcoemu_V2_2a_8_3b.zip 2.2a.8.3b]
|
|-
| colspan="3" align="center" style="background-color: #FAFA70; font-weight: bold" | Legacy
|-
| align="center" style="font-weight: bold" | 2.2+
| align="center" | [http://www.alarmdecoder.com/downloads/firmware/2.2/ademcoemu_V2_2a_8_3_beta.zip 2.2a.8.3]
|
|-
| align="center" style="font-weight: bold" | 2.2+
| align="center" | [http://www.alarmdecoder.com/downloads/firmware/2.2/ademcoemu_V2_2a_2.zip 2.2a.2]
|
|-
| align="center" | 2.0
| align="center" | [http://www.alarmdecoder.com/downloads/firmware/2.0/ademcoemu_V2_1f_0e.zip 2.1f.0e]
|
|-
| align="center" | 2.0
| align="center" | [http://www.alarmdecoder.com/downloads/firmware/2.0/ademcoemu_V2_1f_0d.zip 2.1f.0d]
|
|-
| align="center" | 2.0
| align="center" | [http://www.alarmdecoder.com/downloads/firmware/2.0/ademcoemu_V1_0f_26.zip 1.0f.26]
|
|}

==Instructions==
; There are a few different ways to go about flashing your device.

# Make sure that you have completed the installation and can communicate with your device through a terminal program. (PuTTY, screen, etc.)
# Download one of the available programs.
#* [[AlarmDecoder_Keypad|AlarmDecoder Keypad]] - .NET/Mono and Gtk#
#* [http://www.alarmdecoder.com/downloads/firmwareupload.zip Console firmware uploader] - .NET/Mono
#* [http://github.com/nutechsoftware/alarmdecoder ad2-firmwareupload] - from the official Python library
# Download your desired firmware from the choices above.
# Flash the firmware
#* AlarmDecoder Keypad
#*# Navigate to <tt>System -> Firmware Upload</tt>
#*# Select the firmware file to upload.
#*# The program will start uploading automatically.
#* Console firmware uploader
#*# <tt>firmwareupload COM6 115200 firmware.hex</tt>
#* ad2-firmwareupload
#*# <tt>ad2-firmwareupload firmware.hex /dev/ttyUSB0 115200</tt>
# Confirm communication with your device.
# Reset your device's configuration by sending ! and going through the prompts.

Firmware

2015-10-13T19:58:24Z

204.10.16.29: /* Download */

__NOTOC__
[[Category:Documentation]]
[[Category:Downloads]]
{{PageHeading|
The current stable firmware is '''V2.2a.8'''. It is not possible to brick the AlarmDecoder but it can get into some states that make firmware updates difficult so be patient when updating the firmware in your AlarmDecoder.
}}

==Identifying your Board Revision==
Use the images below to identify what revision of AlarmDecoder you have.

{| summary="AlarmDecoder Devices and Revisions"
|[[File:2_2_board.jpg|thumb|2.2 (AD2USB)]]
|[[File:2_2_serial.jpg|thumb|2.2 (AD2SERIAL)]]
|[[File:Ad2pi.png|thumb|2.2 (AD2PI)]]
|[[File:2_0_board.jpg|thumb|2.0 (AD2USB)]]
|}

==Checking your Firmware Version==
You can retrieve the version information by connecting to your device with a terminal program (PuTTY, screen, etc.) and sending the V command.

A response will be returned with your current version information:
!VER:ffffffff,'''V2.2a.8a8''',TX;RX;SM;VZ;RF;ZX;RE;AU;3X;CG;DD;MF;LR;KE;MK;CB;DS

==Download==
{| class="wikitable" border="1"
! scope="col" width="120px" | Board Revision
! scope="col" with="140px" | Firmware Version
! scope="col" with="140px" | Revision Details
|-
| colspan="3" align="center" style="background-color: #70BA66; font-weight: bold" | Stable
|-
| align="center" style="font-weight: bold" | 2.2+
| align="center" | [http://www.alarmdecoder.com/downloads/firmware/2.2/ademcoemu_V2_2a_8.zip 2.2a.8.2]
|-
| align="center" style="font-weight: bold" | 2.2+
| align="center" | [http://www.alarmdecoder.com/downloads/firmware/2.2/ademcoemu_V2_2a_6.zip 2.2a.6]
|-
| align="center" | 2.0
| align="center" | [http://www.alarmdecoder.com/downloads/firmware/2.0/ademcoemu_V2_1f_10.zip 2.1f.10]
|
|-
| colspan="3" align="center" style="background-color: #F56464; font-weight: bold" | Beta
|-
| align="center" style="font-weight: bold" | 2.2+
| align="center" |
[http://www.alarmdecoder.com/downloads/firmware/2.2/ademcoemu_V2_2a_8_3b.zip 2.2a.8.3b]
|
|-
| colspan="3" align="center" style="background-color: #FAFA70; font-weight: bold" | Legacy
|-
| align="center" style="font-weight: bold" | 2.2+
| align="center" | [http://www.alarmdecoder.com/downloads/firmware/2.2/ademcoemu_V2_2a_8_3_beta.zip 2.2a.8.3]
|
|-
| align="center" style="font-weight: bold" | 2.2+
| align="center" | [http://www.alarmdecoder.com/downloads/firmware/2.2/ademcoemu_V2_2a_2.zip 2.2a.2]
|
|-
| align="center" | 2.0
| align="center" | [http://www.alarmdecoder.com/downloads/firmware/2.0/ademcoemu_V2_1f_0e.zip 2.1f.0e]
|
|-
| align="center" | 2.0
| align="center" | [http://www.alarmdecoder.com/downloads/firmware/2.0/ademcoemu_V2_1f_0d.zip 2.1f.0d]
|
|-
| align="center" | 2.0
| align="center" | [http://www.alarmdecoder.com/downloads/firmware/2.0/ademcoemu_V1_0f_26.zip 1.0f.26]
|
|}

==Instructions==
; There are a few different ways to go about flashing your device.

# Make sure that you have completed the installation and can communicate with your device through a terminal program. (PuTTY, screen, etc.)
# Download one of the available programs.
#* [[AlarmDecoder_Keypad|AlarmDecoder Keypad]] - .NET/Mono and Gtk#
#* [http://www.alarmdecoder.com/downloads/firmwareupload.zip Console firmware uploader] - .NET/Mono
#* [http://github.com/nutechsoftware/alarmdecoder ad2-firmwareupload] - from the official Python library
# Download your desired firmware from the choices above.
# Flash the firmware
#* AlarmDecoder Keypad
#*# Navigate to <tt>System -> Firmware Upload</tt>
#*# Select the firmware file to upload.
#*# The program will start uploading automatically.
#* Console firmware uploader
#*# <tt>firmwareupload COM6 115200 firmware.hex</tt>
#* ad2-firmwareupload
#*# <tt>ad2-firmwareupload firmware.hex /dev/ttyUSB0 115200</tt>
# Confirm communication with your device.
# Reset your device's configuration by sending ! and going through the prompts.

FirmwareRevisionHistory

2015-10-13T19:57:38Z

204.10.16.29: Created page with "=Beta Releases= ==2.2a.8.3a== * Something * Something else * Something else else =Stable Releases= ==2..."

=Beta Releases=

==2.2a.8.3a==
* Something
* Something else
* Something else else

=Stable Releases=

==2.2a.8.2==
* Bugfixes
** Settings allocation bug
* Notes
** Shipping in all units built after October 2015

==2.2a.8.1==
* New Features
** Missing DSC message
** First dotted quad revision

==2.2a.8==
* New Features
** DSC panel support
** Compass download/upload support
** Blinking LED now displays error codes.
** New message type '!ERR' which can be retrieved by sending an 'e' to the AlarmDecoder

==2.2a.4==
* New Features
** Keypad Address Mask
** Long Range Radio (LRR) Emulation
** Message deduplication

Raspberry Pi

2015-09-24T21:59:49Z

204.10.16.29: /* Download */

__NOTOC__
[[Category:Documentation]]
[[Category:Downloads]]
[[Category:Advanced_Topics]]

[[File:Ad2pi.png|thumb|AD2PI]]

There are several ways to start using your AlarmDecoder with the Raspberry Pi. While you can use all of the AlarmDecoder products with the Raspberry Pi, the AD2PI was specifically designed to interface with it directly. If you're attempting to connect an AD2USB or an AD2SERIAL please follow the standard Linux instructions [[Getting_Started|here]].

There are a couple of steps involved with getting your AD2PI and Raspberry Pi talking to each other. We've done all the initial footwork and highly recommend downloading the modified Raspbian image below and flashing it as described [http://www.elinux.org/Rpi_easy_sd_card_setup here]. If you intend to go with another distribution, or just want to do it yourself, then follow the instructions [[#Manual Configuration|here]] to start using your device.

[[File:pibplus.png|thumb|AD2PI Bundle]]
==Official Raspbian Image==
===Changes from Raspbian===
* Disabled serial console so that the device can use it.
* Installed [http://github.com/nutechsoftware/ser2sock ser2sock] to expose the AlarmDecoder on your network.
* Installed the [http://github.com/nutechsoftware/alarmdecoder AlarmDecoder Python library].
* Installed and configured the [http://github.com/nutechsoftware/alarmdecoder-webapp AlarmDecoder Webapp] [[AlarmDecoder_WebApp|Instructions]].

===Download===
{| class="wikitable" border="1"
! scope="col" width="50px" | Status
! scope="col" width="100px" | Link
! scope="col" width="120px" | Version
! scope="col" width="220px" | MD5
! scope="col" width="250px" | Includes
|-
| align="center" style="background-color: #70BA66;" | Stable
| align="center" | [http://www.alarmdecoder.com/downloads/pi/alarmdecoder-raspbian-2015-09-24.zip Download]
| align="center" | 2015-09-24
| align="center" | 2526bc85a7d2dc0842f5fae6801daeec
| align="left" | Pre-configured with webapp. Supports the Raspberry Pi Model B, B+ and B2.
|}

==Manual Configuration==
# Flash the SD card with your choice of OS as described [http://www.elinux.org/Rpi_easy_sd_card_setup here].
# Boot up the Raspberry Pi.
# Remove the following entries from <tt>/boot/cmdline.txt</tt>:
#* <tt>console=ttyAMA0,115200</tt>
#* <tt>kgdboc=ttyAMA0,115200</tt>
# Remove the following line from <tt>/etc/inittab</tt>:
#* <tt>T0:23:respawn:/sbin/getty -L ttyAMA0 115200 vt100</tt>
# Sync and halt your Raspberry Pi.
# Attach the AD2PI.
# Boot it up again.
#* At this point you should be able to communicate with the device at <tt>/dev/ttyAMA0</tt>.
# Install any optional software ([http://github.com/nutechsoftware/ser2sock ser2sock], [http://github.com/nutechsoftware/alarmdecoder Python library], etc.)
#* Add dev package needed for compiling ser2sock
#** sudo apt-get install openssl-dev
#* The AlarmDecoder WEB App install instructions are here
#** https://github.com/nutechsoftware/alarmdecoder-webapp

==Default Passwords==
;Passwords should be changed once you get your device!
===SSH/Shell===
;Login: pi
;Password: raspberry
===AlarmDecoder WebApp===
;Login: admin
;Password: alarmdecoder
==AD2PI case assembly==
;[[File:case assembly doc.pdf|Case assembly]]

Supported Home Automation Systems

2015-09-15T18:23:37Z

204.10.16.29:

__NOTOC__
[[Category:FAQ]]
[[Category:Documentation]]
[[Category:Specifications]]
[[Category:Features]]
When Sean Mathews first started putting solder and code into the first prototypes back in 2007 one of the primary design goals of the '''AlarmDecoder''' was to make sure it would be easy to integrate with his own home automation system
To further his goals we have consistently provided support to anyone wanting to add support for an existing system. If you don't see your favorite product here then talk to the developers of that product and let them know about the AlarmDecoder and encourage them to add support.

<center>'''Here is a list of some of the systems that have support for the AlarmDecoder'''</center>
----

{| align="center" class="wikitable" border="1"
|-
! scope="col" width="180px" | Product Name
! scope="col" width="100px" | Driver License
! scope="col" width="300px" | Product URL
! scope="col" width="300px" | Solution Details
|-
| style="background:#F5FFF5" align="center" | Control4
| align="center" | commercial
| http://www.houselogix.com
| [http://www.houselogix.com/ Phone & Email]
|-
| style="background:#F5FFF5" align="center" | HomeSeer
| align="center" | commercial
| http://www.homeseer.com
| [http://board.homeseer.com/forumdisplay.php?f=992 Forum Thread]
|-
| style="background:#F5FFF5" align="center" | mControl v2 & v3
| align="center" | commercial
| http://www.embeddedautomation.com
| [http://www.embeddedautomation.com/downloads/mcontrol/mControl%20v3%20-%20Feature%20Summary%20Document.pdf Page 24]
|-
| style="background:#F5FFF5" align="center" | Vera2
| align="center" | open source
| http://www.micasaverde.com
| [http://wiki.micasaverde.com/index.php/Supported_Hardware Wiki]
|-
| style="background:#F5FFF5" align="center" | Misterhouse
| align="center" | open source
| http://misterhouse.sourceforge.net
| [https://sourceforge.net/mailarchive/message.php?msg_id=31468020 Email Thread]
|-
| style="background:#F5FFF5" align="center" | Girder 5
| align="center" | open source
| http://www.promixis.com
| [http://www.promixis.com/forums/showthread.php?21535-Nutech-AD2USB-Alarm-Panel-Integration/page2 Forum Thread]
|-
| style="background:#F5FFF5" align="center" | Indigo
| align="center" | open source
| http://www.perceptiveautomation.com
| [http://www.perceptiveautomation.com/userforum/viewtopic.php?f=22&t=7584&start=0 Forum Thread]
|-
| style="background:#F5FFF5" align="center" | Premise Home Control
| align="center" | open source
| [http://cocoontech.com/forums/page/home-automation-software/_/premise-r3 Info Page]
| [http://cocoontech.com/forums/topic/25698-ad2usb-for-vista-security-panels/ Forum Thread]
|-
| style="background:#F5FFF5" align="center" | ISY-99
| align="center" | open source
| [https://www.universal-devices.com/residential/isy994i-series/ Info Page]
| [http://forum.universal-devices.com/viewtopic.php?f=27&t=8133&sid=46a015b366f0d6a7d96a76b9f061bcb4&start=15#p61925 Forum Thread]
|-
| style="background:#F5FFF5" align="center" | openHAB
| align="center" | open source
| [http://www.openhab.org/ http://www.openhab.org]
| [https://github.com/openhab/openhab/wiki/AlarmDecoder-binding openhab official], [https://github.com/N5QM/ad2openhab ad2openhab]
|-
| style="background:#F5FFF5" align="center" | MACHomeAutomation XTension
| align="center" | commercial
| [http://machomeautomation.com/ http://machomeautomation.com/]
| [http://machomeautomation.com/doku.php/supported_hardware/ad2usb MACHomeAutomation XTension]
|-
| style="background:#F5FFF5" align="center" | SmartThings
| align="center" | open source
| [http://www.smartthings.com/ http://www.smartthings.com/]
| [http://community.smartthings.com/t/vista-alarm-integration-using-nutech-ad2usb-and-mac/7039 HowTo]
|-
| style="background:#F5FFF5" align="center" | OpenRemote
| align="center" | open source
| [http://www.openremote.org/ http://www.openremote.org/]
| [http://www.openremote.org/display/forums/Support+for+communicating+with+Ademco+Security+Panel Info]

|-
| style="background:#F5FFF5" align="center" | Write your own!
| align="center" |  
| [[Developers|Developer Wiki]]
|  
|}

----
:As with all open source projects they by their very nature are in constant need for more contributors. Please contact us at [mailto:ad2usb@support.nutech.com ad2usb@support.nutech.com] if you are interested in supporting these or others and we will do our best to support your efforts.

:* MisterHouse
:* LinuxMCE
:* Don't see your project here? Drop us an email at [mailto:ad2usb@support.nutech.com ad2usb@support.nutech.com] and tell us about your project.

Protocol

2015-09-08T19:48:42Z

204.10.16.29: /* Device Feedback LED */

[[Category:FAQ]]
[[Category:Documentation]]
[[Category:Specifications]]
[[Category:Features]]

=Commands=
{| 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" | E
| align="center" | Dump error report and clear error history. [[#Error_message_report|Error report]]
|-
| align="center" | V
| align="center" | Dump the version, serial number and flags used in the firmware.
|-
| align="center" | K
| align="center" | Send message from specific partition or keypad address. [[#Addressed Message|Addressed Message]]
|-
| 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
|}

==Reboot==
Rebooting the device is as simple as sending = to it.

During the boot process you can trigger a firmware upload by sending a second = to the device after the !boot message is received. At this point you'll receive a !load and can begin uploading.

==Zone Emulation==
Zone Expander Emulation allows the AlarmDecoder to act in place of a physical expander board and make use of virtual zones with your panel. After enabling it on both the panel and the AlarmDecoder you can begin opening and closing zones, which will be relayed back to the panel.

The L command can be used to open or close zones. There are two parameters: the zone and the state. The zone is a zero-padded two-digit number and the state is either 0 or 1.

Example - open zone 12:
* L121\r

Example - close zone 12:
* L120\r

==Addressed Message==
* It is possible to send a message from a specific keypad on Ademco/Vista or to a specific partition on DSC.
The K command can be used to send a message to the panel from a specific keypad address or keypad partition for DSC. There are two parameters: The address or partition a zero padded 2 digit address or partition and the message to send. The AD2* will stay fixed on this new address until a new K message is received or the AD2* is reset.

Example - Send keypad string 1234 to DSC partition 01:
* K011234\r

Example - Send keypad string 12343 from keypad address 19:
* K1912343\r

==Function Keys==
The specialty function keys are identified by ASCII character codes 1 through 4. In order to prevent false positives these must be sent three times in a row.

{| class="wikitable" border="1"
|+ Function Key Codes
! scope="col" | Code
! scope="col" | Description
|-
| \x01\x01\x01
| Function Key #1
|-
| \x02\x02\x02
| Function Key #2
|-
| \x03\x03\x03
| Function Key #3
|-
| \x04\x04\x04
| Function Key #4
|}

----

=Device Configuration=
The AlarmDecoder configuration can be viewed or modified in one of two ways: [[#Prompted|prompted]] or [[#Programatic|programmatically]].

==Prompted==
If you send ! followed by a carriage return you will be prompted to configure 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 provide a new one.

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>

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

Retrieving 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

===Configuration Parameters===
{| class="wikitable" border="1"
! scope="col" | Name
! scope="col" | Default Value
! scope="col" | Valid Values (Regex)
! scope="col" | Description
|-
| align="left" | ADDRESS
| align="left" | 18
| align="left" | [0-9]{2}
| align="left" | Keypad address assigned to the AlarmDecoder.
|-
| align="left" | CONFIGBITS
| align="left" | FF00
| align="left" | [0-9a-f]{4}
| align="left" | Special settings for the device. See [[#CONFIGBITS|CONFIGBITS]] for more information.
|-
| align="left" | MASK
| align="left" | FFFFFFFF
| align="left" | [0-9a-f]{8}
| align="left" | Address mask used to filter for keypad alphanumeric messages.
|-
| align="left" | EXP
| align="left" | NNNNN
| align="left" | [YN]{5}
| align="left" | Emulation of zone expanders 1-5
|-
| align="left" | REL
| align="left" | NNNN
| align="left" | [YN]{4}
| align="left" | Emulation of relay expanders 1-4
|-
| align="left" | LRR
| align="left" | N
| align="left" | [YN]
| align="left" | Emulation of Long Range Radio expander
|-
| align="left" | DEDUPLICATE
| align="left" | N
| align="left" | [YN]
| align="left" | If enabled, removes duplicate alphanumeric keypad messages.
|-
|}

====CONFIGBITS====
CONFIGBITS is a setting that's used to enable special functionality on the AlarmDecoder. You can enable these by masking the correct bits.

{| class="wikitable" border="1"
|+ CONFIGBITS Definition
! scope="col" | Mask
! scope="col" | Description
|-
| align="left" | 0x0001
| align="left" | Enable reporting of [[#AUI|AUI]] messages.
|-
| align="left" | 0x0002
| align="left" | Enable reporting of [[#Keypress Events|keypress events]].
|-
| align="left" | 0x0004
| align="left" | Disable prompts for L and | commands.
|-
| align="left" | 0x0008
| align="left" | Enable the prefixing of panel messages with !KMP.
|-
| align="left" | 0x0100
| align="left" | Enable reporting of [[#RFX|RFX]] messages.
|}

----

=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]].

* All lines starting with ! are informational.
* Lines that start with !> are prompts.
* All other lines are panel data in the form of a [[#Keypad|Keypad message]].

==Keypad==
Keypad messages are by far the most common message type produced by the AlarmDecoder. These messages also have an optional header that can be enabled in the [[#CONFIGBITS|CONFIGBITS]]. This setting prefixes all keypad messages with !KPM:.

===Format===
{| class="wikitable" border="1"
|+ Keypad Format
| colspan="4" align="center" style="background-color: #DEDEDE; font-weight: bold" | [00110011000000003A--],010,[f70700000010808c18020000000000],"ARMED ***STAY** ZONE BYPASSED "
|-
| colspan="4" |  
|-
! scope="col" width="160px" style="color: #F56464" | Bit field
! scope="col" width="100px" style="color: #8C8CF5" | Numeric code
! scope="col" width="200px" style="color: #70BA66" | Raw data
! scope="col" width="220px" style="color: #804580" | Alphanumeric Keypad Message
|-
| align="center" | [00110011000000003A--]
| align="center" | 010
| align="center" | [f70700000010808c18020000000000]
| align="center" | "ARMED ***STAY** ZONE BYPASSED "
|-
|}

====Bit field====
The bit field present on the keypad messages is where you're going to get most of the information on your alarm system's current state. These are all represented by a zero or one aside from the one exception. (beep)

{| class="wikitable" border="1"
! scope="col" | Position
! scope="col" | Description
|-
| 1
| Indicates if the panel is READY
|-
| 2
| Indicates if the panel is ARMED AWAY
|-
| 3
| Indicates if the panel is ARMED HOME
|-
| 4
| Indicates if the keypad backlight is on
|-
| 5
| Indicates if the keypad is in programming mode
|-
| 6
| Number (1-7) indicating how many beeps are associated with the message
|-
| 7
| Indicates that a zone has been bypassed
|-
| 8
| Indicates if the panel is on AC power
|-
| 9
| Indicates if the chime is enabled
|-
| 10
| Indicates that an alarm has occurred. This is sticky and will be cleared after a second disarm.
|-
| 11
| Indicates that an alarm is currently sounding. This is cleared after the first disarm.
|-
| 12
| Indicates that the battery is low
|-
| 13
| Indicates that entry delay is off (ARMED INSTANT/MAX)
|-
| 14
| Indicates that there is a fire
|-
| 15
| Indicates a system issue
|-
| 16
| Indicates that the panel is only watching the perimeter (ARMED STAY/NIGHT)
|-
| 17
| System specific error report
|-
| 18
| Ademco or DSC Mode A or D
|-
| 19
| Unused
|-
| 20
| Unused
|-
|}

====Numeric Code====
This number specifies which zone is affected by the message. For example, if this message is for CHECK ZONE 22 then the numeric code would be 022. Most of the time this is zero-padded base10, but there are rare occurrences where this may be base16, such as ECP bus failures.

====Raw data====
This is the binary data associated with the message. It includes all of the bit field entries that were separated out for you in the first field, as well as the rest of the message for debugging and exploratory purposes.

There is one important piece of data included only in this field: the keypad address mask. The four bytes starting at position 2 (zero-indexed) indicate which keypads this message is intended for.

Inside this mask each bit represents a specific keypad. Each byte represents a group of eight keypad addresses, which the least-significant-bit being the start of the range.

{| class="wikitable" border="1"
! scope="col" | Byte
! scope="col" | Addresses
|-
| 1
| 0-7
|-
| 2
| 8-15
|-
| 3
| 16-23
|-
| 4
| 24-31
|}

For example:
* f70700060010808c08020000 - our keypad address mask is 07000600.

Using the above mask example of 07000600 we find that this message was destined for keypads 0, 1, 2, 17 and 18.

There is one special case: system messages will have no address mask bits set and are intended for common keypads or monitoring multiple zones.

For the most part the address mask details only become really important when you're working with a setup that has multiple partitions since the AlarmDecoder will see all messages by default.

====Alphanumeric Keypad Message====
This section is the data that would be displayed on your keypad's screen.

==Zone Expander==
If you have one or more zone expanders connected to the alarm panel you will be able to see messages from the expanders as zones are faulted and restored. On DSC panels all zones are expressed as EXP messages.
===Examples===
Example of zone expander at address 7, channel 1 faulting and then restoring:
<pre>
!EXP:07,01,01
!EXP:07,01,00
</pre>

===Format===
{| class="wikitable" border="1"
|+ !EXP Format
| colspan="4" align="center" style="background-color: #DEDEDE; font-weight: bold" | !EXP:07,01,01
|-
| colspan="4" |  
|-
! scope="col" width="80px" style="color: #F56464" | Header
! scope="col" width="160px" style="color: #8C8CF5" | Zone Expander Address
! scope="col" width="140px" style="color: #70BA66" | Expander Channel
! scope="col" width="100px" style="color: #804580" | Data
|-
| align="center" | !EXP
| align="center" | 07
| align="center" | 01
| align="center" | 01
|-
|}

====Zone Expander Address====
This is the address that the zone expander occupies.

====Expander Channel====
This is the channel generating the message.

====Data====
00 and 01 indicate that the zone is restored and faulted, respectively.

==Relay Expander==
If you have one or more relay expanders connected to your alarm panel you will be able to see messages when the relays are opened or closed.

===Examples===
Examples of a relay expander at address 12, relay #1 closing and then opening:
<pre>
!REL:12,01,01
!REL:12,01,00
</pre>

===Format===
{| class="wikitable" border="1"
|+ !REL Format
| colspan="4" align="center" style="background-color: #DEDEDE; font-weight: bold" | !REL:12,01,01
|-
| colspan="4" |  
|-
! scope="col" width="80px" style="color: #F56464" | Header
! scope="col" width="160px" style="color: #8C8CF5" | Relay Expander Address
! scope="col" width="140px" style="color: #70BA66" | Expander Channel
! scope="col" width="100px" style="color: #804580" | Data
|-
| align="center" | !REL
| align="center" | 12
| align="center" | 01
| align="center" | 01
|-
|}

====Relay Expander Address====
This is the address that the relay expander occupies.

====Expander Channel====
This is the channel generating the message.

====Data====
00 and 01 indicate that the relay is opened and closed, respectively.

==RFX==
If you have an RF receiver attached to your panel you will see messages from any 5800 RF device in range of the receiver, regardless of whether or not the panel was configured to listen to it.

This also functions when the system is ARMED STAY. Normally you won't see fault messages for interior zones when armed this way so you lose visibility of interior motion sensors. One option is to put the interior sensors on a separate partition so you still see the inside zones and the outside sensors are on their own. The other option is to listen to the !RFX messages directly which could then be used to tell your home automation system that the zones are faulted.

===Examples===
Example of a 5800Micra sensor faulting and restoring:
<pre>
!RFX:0180036,80
!RFX:0180036,00
</pre>

Example of a 5804 keyfob pressing the loop #2 button and having a low battery:
<pre>
!RFX:0307854,22
</pre>

===Format===
{| class="wikitable" border="1"
|+ !RFX Format
| colspan="4" align="center" style="background-color: #DEDEDE; font-weight: bold" | !RFX:0180036,80
|-
| colspan="4" |  
|-
! scope="col" width="80px" style="color: #F56464" | Header
! scope="col" width="100px" style="color: #8C8CF5" | Serial Number
! scope="col" width="100px" style="color: #70BA66" | Data
|-
| align="center" | !RFX
| align="center" | 0180036
| align="center" | 80
|-
|}

====Serial Number====
This is the 7-digit serial number of the device the message originated from.

====Data====
The data is an 8-bit hex message with several indicators. Please refer to the '''5800 SERIES TRANSMITTER INPUT LOOP IDENTIFICATION''' section of your programming manual for what the loops relate to for your specific device.

{| class="wikitable" border="1"
|+ RFX Data Format
|-
! scope="col" | Bit
! scope="col" | Description
|-
| align="center" | 1
| Unknown - Seems that the loop indicators should be ignored if set.
|-
| align="center" | 2
| Low battery indication
|-
| align="center" | 3
| Supervision required indication
|-
| align="center" | 4
| Unknown
|-
| align="center" | 5
| Loop #3 indication
|-
| align="center" | 6
| Loop #2 indication
|-
| align="center" | 7
| Loop #4 indication
|-
| align="center" | 8
| Loop #1 indication
|}

==LRR==
If you have a Long Range Radio device attached or have emulation enabled the AlarmDecoder will report LRR messages from the panel to the radio.

===Examples===
This example shows User 12 arming and disarming the system:
<pre>
!LRR:012,1,ARM_STAY
!LRR:012,1,ARM_AWAY
!LRR:012,1,OPEN
!LRR:003,1,BYPASS
</pre>

===Format===
{| class="wikitable" border="1"
|+ !LRR Format
| colspan="4" align="center" style="background-color: #DEDEDE; font-weight: bold" | !LRR:012,1,ARM_STAY
|-
| colspan="4" |  
|-
! scope="col" width="80px" style="color: #F56464" | Header
! scope="col" width="100px" style="color: #8C8CF5" | Event Data
! scope="col" width="80px" style="color: #70BA66" | Partition
! scope="col" width="100px" style="color: #804580" | Event Type
|-
| align="center" | !LRR
| align="center" | 012
| align="center" | 1
| align="center" | ARM_STAY
|-
|}

====Event Data====
This is either the user number of the person performing the action or the zone that was bypassed.

====Partition====
The panel partition the event applies to. Partition 0 indicates that it's destined for all partitions.

====Event Type====
This is the type of the LRR event. See below for a description and what (if any) programming fields are required for activation.

{| class="wikitable" border="1"
|+ LRR Event Types
! scope="col" | Name
! scope="col" | Program Fields
! scope="col" | Description
|-
| ALARM_EXIT_ERROR
| *59
| Indicates an error when a zone is not closed during arming
|-
| TROUBLE
| *60
| Indicates that a zone is reporting a tamper or failure
|-
| BYPASS
| *61
| Indicates that a zone has been bypassed
|-
| ACLOSS
| *62
| Indicates that AC power was lost
|-
| LOWBAT
| *63
| Low battery indication
|-
| TEST_CALL
| *64
| Indicates a phone test when in testing mode
|-
| OPEN
| *65, requires *66
| Indicates that the alarm is disarmed
|-
| ARM_AWAY
| *66
| Indicates that the system was armed AWAY
|-
| ARM_STAY
| *66
| Indicates that the system was armed STAY
|-
| RFLOWBAT
| *67
| Low battery indication for the RF transmitter
|-
| CANCEL
| *68
| Indicates that the alarm was canceled after second disarm
|-
| RESTORE
| *70
| Indicates that the alarm was restored
|-
| TROUBLE_RESTORE
| *71
| Indicates that the trouble event was restored
|-
| BYPASS_RESTORE
| *72
| Indicates that the bypassed zonew as restored
|-
| AC_RESTORE
| *73
| Indicates that AC power was restored
|-
| LOWBAT_RESTORE
| *74
| Indicates that the low battery has been restored
|-
| RFLOWBAT_RESTORE
| *75
| Indicates that the low battery on the RF transmitter has been restored.
|-
| TEST_RESTORE
| *76
| Indicates that a zone was restored in testing mode
|-
| ALARM_PANIC
|
| Indicates that there is a panic
|-
| ALARM_FIRE
|
| Indicates that there is a fire
|-
| ALARM_ENTRY
|
| Indicates that there was an entry alarm
|-
| ALARM_AUX
|
| Indicates that an auxiliary alarm type was triggered
|-
| ALARM_AUDIBLE
|
| Indicates that an audible alarm is in progress
|-
| ALARM_SILENT
|
| Indicates that there was a silent alarm
|-
| ALARM_PERIMETER
|
| Indicates that there was a perimeter alarm
|}

==AUI==
AUI messages are generated for "Advanced User Interface" keypads. These include a lot of extra data than what's destined for regular keypads.

===Format===
{| class="wikitable" border="1"
|+ !AUI Format
| colspan="4" align="center" style="background-color: #DEDEDE; font-weight: bold" | !AUI:126600000000656c02456cf5ec01017f0002
|-
| colspan="4" |  
|-
! scope="col" width="80px" style="color: #F56464" | Header
! scope="col" width="100px" style="color: #8C8CF5" | AUI Data
|-
| align="center" | !AUI
| align="center" | 126600000000656c02456cf5ec01017f0002
|-
|}

====AUI Data====
This is a large binary blob that's destined for a graphical panel. This data has not been fully decoded. Please see the [[AUI|AUI]] page for information on what has been discovered so far.

==Keypress Events==
Keypress events are generated when keys are pressed on a keypad and can be enabled inside [[#CONFIGBITS|CONFIGBITS]].

===Format===
{| class="wikitable" border="1"
|+ !KPE Format
| colspan="4" align="center" style="background-color: #DEDEDE; font-weight: bold" | !KPE:18
|-
| colspan="4" |  
|-
! scope="col" width="80px" style="color: #F56464" | Header
! scope="col" width="100px" style="color: #8C8CF5" | Keypad Address
|-
| align="center" | !KPE
| align="center" | 18
|-
|}

==Error message report==
Error message reports will be sent to the host when the command 'E' is sent to the AD2*. The list will contain 0 if no errors are recorded and a list of errors separated by commas if errors are recorded. Once an error is reported it will be cleared from the history. The errors from left to right are in order of occurrence. As many as 10 errors can be stored before the oldest is removed from the list.

===Format===
{| class="wikitable" border="1"
|+ !ERR Format
| colspan="4" align="center" style="background-color: #DEDEDE; font-weight: bold" | !ERR:0
|-
| colspan="4" |  
|-
! scope="col" width="80px" style="color: #F56464" | Header
! scope="col" width="100px" style="color: #8C8CF5" | Error list
|-
| align="center" | !ERR
| align="center" | 1,1,1
|-
|}

====Keypad Address====
This is the address of the keypad that generated the event.

=Device Feedback LED=
* Boot flash mode
** During boot the AD2* will rapid flash during the boot loader.
* Operating mode
** The normal operating mode is a steady of approx 2.5 flashes per second.
** Sending to panel mode 3 flashes.
* Error mode
** If an error is recorded the AD2* will flash the error message as steady slow flashes to be counted with a long period of the LED off between flashes. after a few minutes the led will return to normal idle flash mode if no further errors happen.

Protocol

2015-09-08T19:45:00Z

204.10.16.29: /* Format */

[[Category:FAQ]]
[[Category:Documentation]]
[[Category:Specifications]]
[[Category:Features]]

=Commands=
{| 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" | E
| align="center" | Dump error report and clear error history. [[#Error_message_report|Error report]]
|-
| align="center" | V
| align="center" | Dump the version, serial number and flags used in the firmware.
|-
| align="center" | K
| align="center" | Send message from specific partition or keypad address. [[#Addressed Message|Addressed Message]]
|-
| 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
|}

==Reboot==
Rebooting the device is as simple as sending = to it.

During the boot process you can trigger a firmware upload by sending a second = to the device after the !boot message is received. At this point you'll receive a !load and can begin uploading.

==Zone Emulation==
Zone Expander Emulation allows the AlarmDecoder to act in place of a physical expander board and make use of virtual zones with your panel. After enabling it on both the panel and the AlarmDecoder you can begin opening and closing zones, which will be relayed back to the panel.

The L command can be used to open or close zones. There are two parameters: the zone and the state. The zone is a zero-padded two-digit number and the state is either 0 or 1.

Example - open zone 12:
* L121\r

Example - close zone 12:
* L120\r

==Addressed Message==
* It is possible to send a message from a specific keypad on Ademco/Vista or to a specific partition on DSC.
The K command can be used to send a message to the panel from a specific keypad address or keypad partition for DSC. There are two parameters: The address or partition a zero padded 2 digit address or partition and the message to send. The AD2* will stay fixed on this new address until a new K message is received or the AD2* is reset.

Example - Send keypad string 1234 to DSC partition 01:
* K011234\r

Example - Send keypad string 12343 from keypad address 19:
* K1912343\r

==Function Keys==
The specialty function keys are identified by ASCII character codes 1 through 4. In order to prevent false positives these must be sent three times in a row.

{| class="wikitable" border="1"
|+ Function Key Codes
! scope="col" | Code
! scope="col" | Description
|-
| \x01\x01\x01
| Function Key #1
|-
| \x02\x02\x02
| Function Key #2
|-
| \x03\x03\x03
| Function Key #3
|-
| \x04\x04\x04
| Function Key #4
|}

----

=Device Configuration=
The AlarmDecoder configuration can be viewed or modified in one of two ways: [[#Prompted|prompted]] or [[#Programatic|programmatically]].

==Prompted==
If you send ! followed by a carriage return you will be prompted to configure 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 provide a new one.

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>

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

Retrieving 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

===Configuration Parameters===
{| class="wikitable" border="1"
! scope="col" | Name
! scope="col" | Default Value
! scope="col" | Valid Values (Regex)
! scope="col" | Description
|-
| align="left" | ADDRESS
| align="left" | 18
| align="left" | [0-9]{2}
| align="left" | Keypad address assigned to the AlarmDecoder.
|-
| align="left" | CONFIGBITS
| align="left" | FF00
| align="left" | [0-9a-f]{4}
| align="left" | Special settings for the device. See [[#CONFIGBITS|CONFIGBITS]] for more information.
|-
| align="left" | MASK
| align="left" | FFFFFFFF
| align="left" | [0-9a-f]{8}
| align="left" | Address mask used to filter for keypad alphanumeric messages.
|-
| align="left" | EXP
| align="left" | NNNNN
| align="left" | [YN]{5}
| align="left" | Emulation of zone expanders 1-5
|-
| align="left" | REL
| align="left" | NNNN
| align="left" | [YN]{4}
| align="left" | Emulation of relay expanders 1-4
|-
| align="left" | LRR
| align="left" | N
| align="left" | [YN]
| align="left" | Emulation of Long Range Radio expander
|-
| align="left" | DEDUPLICATE
| align="left" | N
| align="left" | [YN]
| align="left" | If enabled, removes duplicate alphanumeric keypad messages.
|-
|}

====CONFIGBITS====
CONFIGBITS is a setting that's used to enable special functionality on the AlarmDecoder. You can enable these by masking the correct bits.

{| class="wikitable" border="1"
|+ CONFIGBITS Definition
! scope="col" | Mask
! scope="col" | Description
|-
| align="left" | 0x0001
| align="left" | Enable reporting of [[#AUI|AUI]] messages.
|-
| align="left" | 0x0002
| align="left" | Enable reporting of [[#Keypress Events|keypress events]].
|-
| align="left" | 0x0004
| align="left" | Disable prompts for L and | commands.
|-
| align="left" | 0x0008
| align="left" | Enable the prefixing of panel messages with !KMP.
|-
| align="left" | 0x0100
| align="left" | Enable reporting of [[#RFX|RFX]] messages.
|}

----

=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]].

* All lines starting with ! are informational.
* Lines that start with !> are prompts.
* All other lines are panel data in the form of a [[#Keypad|Keypad message]].

==Keypad==
Keypad messages are by far the most common message type produced by the AlarmDecoder. These messages also have an optional header that can be enabled in the [[#CONFIGBITS|CONFIGBITS]]. This setting prefixes all keypad messages with !KPM:.

===Format===
{| class="wikitable" border="1"
|+ Keypad Format
| colspan="4" align="center" style="background-color: #DEDEDE; font-weight: bold" | [00110011000000003A--],010,[f70700000010808c18020000000000],"ARMED ***STAY** ZONE BYPASSED "
|-
| colspan="4" |  
|-
! scope="col" width="160px" style="color: #F56464" | Bit field
! scope="col" width="100px" style="color: #8C8CF5" | Numeric code
! scope="col" width="200px" style="color: #70BA66" | Raw data
! scope="col" width="220px" style="color: #804580" | Alphanumeric Keypad Message
|-
| align="center" | [00110011000000003A--]
| align="center" | 010
| align="center" | [f70700000010808c18020000000000]
| align="center" | "ARMED ***STAY** ZONE BYPASSED "
|-
|}

====Bit field====
The bit field present on the keypad messages is where you're going to get most of the information on your alarm system's current state. These are all represented by a zero or one aside from the one exception. (beep)

{| class="wikitable" border="1"
! scope="col" | Position
! scope="col" | Description
|-
| 1
| Indicates if the panel is READY
|-
| 2
| Indicates if the panel is ARMED AWAY
|-
| 3
| Indicates if the panel is ARMED HOME
|-
| 4
| Indicates if the keypad backlight is on
|-
| 5
| Indicates if the keypad is in programming mode
|-
| 6
| Number (1-7) indicating how many beeps are associated with the message
|-
| 7
| Indicates that a zone has been bypassed
|-
| 8
| Indicates if the panel is on AC power
|-
| 9
| Indicates if the chime is enabled
|-
| 10
| Indicates that an alarm has occurred. This is sticky and will be cleared after a second disarm.
|-
| 11
| Indicates that an alarm is currently sounding. This is cleared after the first disarm.
|-
| 12
| Indicates that the battery is low
|-
| 13
| Indicates that entry delay is off (ARMED INSTANT/MAX)
|-
| 14
| Indicates that there is a fire
|-
| 15
| Indicates a system issue
|-
| 16
| Indicates that the panel is only watching the perimeter (ARMED STAY/NIGHT)
|-
| 17
| System specific error report
|-
| 18
| Ademco or DSC Mode A or D
|-
| 19
| Unused
|-
| 20
| Unused
|-
|}

====Numeric Code====
This number specifies which zone is affected by the message. For example, if this message is for CHECK ZONE 22 then the numeric code would be 022. Most of the time this is zero-padded base10, but there are rare occurrences where this may be base16, such as ECP bus failures.

====Raw data====
This is the binary data associated with the message. It includes all of the bit field entries that were separated out for you in the first field, as well as the rest of the message for debugging and exploratory purposes.

There is one important piece of data included only in this field: the keypad address mask. The four bytes starting at position 2 (zero-indexed) indicate which keypads this message is intended for.

Inside this mask each bit represents a specific keypad. Each byte represents a group of eight keypad addresses, which the least-significant-bit being the start of the range.

{| class="wikitable" border="1"
! scope="col" | Byte
! scope="col" | Addresses
|-
| 1
| 0-7
|-
| 2
| 8-15
|-
| 3
| 16-23
|-
| 4
| 24-31
|}

For example:
* f70700060010808c08020000 - our keypad address mask is 07000600.

Using the above mask example of 07000600 we find that this message was destined for keypads 0, 1, 2, 17 and 18.

There is one special case: system messages will have no address mask bits set and are intended for common keypads or monitoring multiple zones.

For the most part the address mask details only become really important when you're working with a setup that has multiple partitions since the AlarmDecoder will see all messages by default.

====Alphanumeric Keypad Message====
This section is the data that would be displayed on your keypad's screen.

==Zone Expander==
If you have one or more zone expanders connected to the alarm panel you will be able to see messages from the expanders as zones are faulted and restored. On DSC panels all zones are expressed as EXP messages.
===Examples===
Example of zone expander at address 7, channel 1 faulting and then restoring:
<pre>
!EXP:07,01,01
!EXP:07,01,00
</pre>

===Format===
{| class="wikitable" border="1"
|+ !EXP Format
| colspan="4" align="center" style="background-color: #DEDEDE; font-weight: bold" | !EXP:07,01,01
|-
| colspan="4" |  
|-
! scope="col" width="80px" style="color: #F56464" | Header
! scope="col" width="160px" style="color: #8C8CF5" | Zone Expander Address
! scope="col" width="140px" style="color: #70BA66" | Expander Channel
! scope="col" width="100px" style="color: #804580" | Data
|-
| align="center" | !EXP
| align="center" | 07
| align="center" | 01
| align="center" | 01
|-
|}

====Zone Expander Address====
This is the address that the zone expander occupies.

====Expander Channel====
This is the channel generating the message.

====Data====
00 and 01 indicate that the zone is restored and faulted, respectively.

==Relay Expander==
If you have one or more relay expanders connected to your alarm panel you will be able to see messages when the relays are opened or closed.

===Examples===
Examples of a relay expander at address 12, relay #1 closing and then opening:
<pre>
!REL:12,01,01
!REL:12,01,00
</pre>

===Format===
{| class="wikitable" border="1"
|+ !REL Format
| colspan="4" align="center" style="background-color: #DEDEDE; font-weight: bold" | !REL:12,01,01
|-
| colspan="4" |  
|-
! scope="col" width="80px" style="color: #F56464" | Header
! scope="col" width="160px" style="color: #8C8CF5" | Relay Expander Address
! scope="col" width="140px" style="color: #70BA66" | Expander Channel
! scope="col" width="100px" style="color: #804580" | Data
|-
| align="center" | !REL
| align="center" | 12
| align="center" | 01
| align="center" | 01
|-
|}

====Relay Expander Address====
This is the address that the relay expander occupies.

====Expander Channel====
This is the channel generating the message.

====Data====
00 and 01 indicate that the relay is opened and closed, respectively.

==RFX==
If you have an RF receiver attached to your panel you will see messages from any 5800 RF device in range of the receiver, regardless of whether or not the panel was configured to listen to it.

This also functions when the system is ARMED STAY. Normally you won't see fault messages for interior zones when armed this way so you lose visibility of interior motion sensors. One option is to put the interior sensors on a separate partition so you still see the inside zones and the outside sensors are on their own. The other option is to listen to the !RFX messages directly which could then be used to tell your home automation system that the zones are faulted.

===Examples===
Example of a 5800Micra sensor faulting and restoring:
<pre>
!RFX:0180036,80
!RFX:0180036,00
</pre>

Example of a 5804 keyfob pressing the loop #2 button and having a low battery:
<pre>
!RFX:0307854,22
</pre>

===Format===
{| class="wikitable" border="1"
|+ !RFX Format
| colspan="4" align="center" style="background-color: #DEDEDE; font-weight: bold" | !RFX:0180036,80
|-
| colspan="4" |  
|-
! scope="col" width="80px" style="color: #F56464" | Header
! scope="col" width="100px" style="color: #8C8CF5" | Serial Number
! scope="col" width="100px" style="color: #70BA66" | Data
|-
| align="center" | !RFX
| align="center" | 0180036
| align="center" | 80
|-
|}

====Serial Number====
This is the 7-digit serial number of the device the message originated from.

====Data====
The data is an 8-bit hex message with several indicators. Please refer to the '''5800 SERIES TRANSMITTER INPUT LOOP IDENTIFICATION''' section of your programming manual for what the loops relate to for your specific device.

{| class="wikitable" border="1"
|+ RFX Data Format
|-
! scope="col" | Bit
! scope="col" | Description
|-
| align="center" | 1
| Unknown - Seems that the loop indicators should be ignored if set.
|-
| align="center" | 2
| Low battery indication
|-
| align="center" | 3
| Supervision required indication
|-
| align="center" | 4
| Unknown
|-
| align="center" | 5
| Loop #3 indication
|-
| align="center" | 6
| Loop #2 indication
|-
| align="center" | 7
| Loop #4 indication
|-
| align="center" | 8
| Loop #1 indication
|}

==LRR==
If you have a Long Range Radio device attached or have emulation enabled the AlarmDecoder will report LRR messages from the panel to the radio.

===Examples===
This example shows User 12 arming and disarming the system:
<pre>
!LRR:012,1,ARM_STAY
!LRR:012,1,ARM_AWAY
!LRR:012,1,OPEN
!LRR:003,1,BYPASS
</pre>

===Format===
{| class="wikitable" border="1"
|+ !LRR Format
| colspan="4" align="center" style="background-color: #DEDEDE; font-weight: bold" | !LRR:012,1,ARM_STAY
|-
| colspan="4" |  
|-
! scope="col" width="80px" style="color: #F56464" | Header
! scope="col" width="100px" style="color: #8C8CF5" | Event Data
! scope="col" width="80px" style="color: #70BA66" | Partition
! scope="col" width="100px" style="color: #804580" | Event Type
|-
| align="center" | !LRR
| align="center" | 012
| align="center" | 1
| align="center" | ARM_STAY
|-
|}

====Event Data====
This is either the user number of the person performing the action or the zone that was bypassed.

====Partition====
The panel partition the event applies to. Partition 0 indicates that it's destined for all partitions.

====Event Type====
This is the type of the LRR event. See below for a description and what (if any) programming fields are required for activation.

{| class="wikitable" border="1"
|+ LRR Event Types
! scope="col" | Name
! scope="col" | Program Fields
! scope="col" | Description
|-
| ALARM_EXIT_ERROR
| *59
| Indicates an error when a zone is not closed during arming
|-
| TROUBLE
| *60
| Indicates that a zone is reporting a tamper or failure
|-
| BYPASS
| *61
| Indicates that a zone has been bypassed
|-
| ACLOSS
| *62
| Indicates that AC power was lost
|-
| LOWBAT
| *63
| Low battery indication
|-
| TEST_CALL
| *64
| Indicates a phone test when in testing mode
|-
| OPEN
| *65, requires *66
| Indicates that the alarm is disarmed
|-
| ARM_AWAY
| *66
| Indicates that the system was armed AWAY
|-
| ARM_STAY
| *66
| Indicates that the system was armed STAY
|-
| RFLOWBAT
| *67
| Low battery indication for the RF transmitter
|-
| CANCEL
| *68
| Indicates that the alarm was canceled after second disarm
|-
| RESTORE
| *70
| Indicates that the alarm was restored
|-
| TROUBLE_RESTORE
| *71
| Indicates that the trouble event was restored
|-
| BYPASS_RESTORE
| *72
| Indicates that the bypassed zonew as restored
|-
| AC_RESTORE
| *73
| Indicates that AC power was restored
|-
| LOWBAT_RESTORE
| *74
| Indicates that the low battery has been restored
|-
| RFLOWBAT_RESTORE
| *75
| Indicates that the low battery on the RF transmitter has been restored.
|-
| TEST_RESTORE
| *76
| Indicates that a zone was restored in testing mode
|-
| ALARM_PANIC
|
| Indicates that there is a panic
|-
| ALARM_FIRE
|
| Indicates that there is a fire
|-
| ALARM_ENTRY
|
| Indicates that there was an entry alarm
|-
| ALARM_AUX
|
| Indicates that an auxiliary alarm type was triggered
|-
| ALARM_AUDIBLE
|
| Indicates that an audible alarm is in progress
|-
| ALARM_SILENT
|
| Indicates that there was a silent alarm
|-
| ALARM_PERIMETER
|
| Indicates that there was a perimeter alarm
|}

==AUI==
AUI messages are generated for "Advanced User Interface" keypads. These include a lot of extra data than what's destined for regular keypads.

===Format===
{| class="wikitable" border="1"
|+ !AUI Format
| colspan="4" align="center" style="background-color: #DEDEDE; font-weight: bold" | !AUI:126600000000656c02456cf5ec01017f0002
|-
| colspan="4" |  
|-
! scope="col" width="80px" style="color: #F56464" | Header
! scope="col" width="100px" style="color: #8C8CF5" | AUI Data
|-
| align="center" | !AUI
| align="center" | 126600000000656c02456cf5ec01017f0002
|-
|}

====AUI Data====
This is a large binary blob that's destined for a graphical panel. This data has not been fully decoded. Please see the [[AUI|AUI]] page for information on what has been discovered so far.

==Keypress Events==
Keypress events are generated when keys are pressed on a keypad and can be enabled inside [[#CONFIGBITS|CONFIGBITS]].

===Format===
{| class="wikitable" border="1"
|+ !KPE Format
| colspan="4" align="center" style="background-color: #DEDEDE; font-weight: bold" | !KPE:18
|-
| colspan="4" |  
|-
! scope="col" width="80px" style="color: #F56464" | Header
! scope="col" width="100px" style="color: #8C8CF5" | Keypad Address
|-
| align="center" | !KPE
| align="center" | 18
|-
|}

==Error message report==
Error message reports will be sent to the host when the command 'E' is sent to the AD2*. The list will contain 0 if no errors are recorded and a list of errors separated by commas if errors are recorded. Once an error is reported it will be cleared from the history. The errors from left to right are in order of occurrence. As many as 10 errors can be stored before the oldest is removed from the list.

===Format===
{| class="wikitable" border="1"
|+ !ERR Format
| colspan="4" align="center" style="background-color: #DEDEDE; font-weight: bold" | !ERR:0
|-
| colspan="4" |  
|-
! scope="col" width="80px" style="color: #F56464" | Header
! scope="col" width="100px" style="color: #8C8CF5" | Error list
|-
| align="center" | !ERR
| align="center" | 1,1,1
|-
|}

====Keypad Address====
This is the address of the keypad that generated the event.

=Device Feedback LED=
* Boot flash mode
** During boot the AD2* will rapid flash during the boot loader.
* Operating mode
** The normal operating mode is a steady of approx 2.5 flashes per second.
* Error mode
** If an error is recorded the AD2* will flash the error message as steady slow flashes to be counted with a long period of the LED off between flashes. after a few minutes the led will return to normal idle flash mode if no further errors happen.

Protocol

2015-09-08T19:39:53Z

204.10.16.29: /* Bit field */

[[Category:FAQ]]
[[Category:Documentation]]
[[Category:Specifications]]
[[Category:Features]]

=Commands=
{| 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" | E
| align="center" | Dump error report and clear error history. [[#Error_message_report|Error report]]
|-
| align="center" | V
| align="center" | Dump the version, serial number and flags used in the firmware.
|-
| align="center" | K
| align="center" | Send message from specific partition or keypad address. [[#Addressed Message|Addressed Message]]
|-
| 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
|}

==Reboot==
Rebooting the device is as simple as sending = to it.

During the boot process you can trigger a firmware upload by sending a second = to the device after the !boot message is received. At this point you'll receive a !load and can begin uploading.

==Zone Emulation==
Zone Expander Emulation allows the AlarmDecoder to act in place of a physical expander board and make use of virtual zones with your panel. After enabling it on both the panel and the AlarmDecoder you can begin opening and closing zones, which will be relayed back to the panel.

The L command can be used to open or close zones. There are two parameters: the zone and the state. The zone is a zero-padded two-digit number and the state is either 0 or 1.

Example - open zone 12:
* L121\r

Example - close zone 12:
* L120\r

==Addressed Message==
* It is possible to send a message from a specific keypad on Ademco/Vista or to a specific partition on DSC.
The K command can be used to send a message to the panel from a specific keypad address or keypad partition for DSC. There are two parameters: The address or partition a zero padded 2 digit address or partition and the message to send. The AD2* will stay fixed on this new address until a new K message is received or the AD2* is reset.

Example - Send keypad string 1234 to DSC partition 01:
* K011234\r

Example - Send keypad string 12343 from keypad address 19:
* K1912343\r

==Function Keys==
The specialty function keys are identified by ASCII character codes 1 through 4. In order to prevent false positives these must be sent three times in a row.

{| class="wikitable" border="1"
|+ Function Key Codes
! scope="col" | Code
! scope="col" | Description
|-
| \x01\x01\x01
| Function Key #1
|-
| \x02\x02\x02
| Function Key #2
|-
| \x03\x03\x03
| Function Key #3
|-
| \x04\x04\x04
| Function Key #4
|}

----

=Device Configuration=
The AlarmDecoder configuration can be viewed or modified in one of two ways: [[#Prompted|prompted]] or [[#Programatic|programmatically]].

==Prompted==
If you send ! followed by a carriage return you will be prompted to configure 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 provide a new one.

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>

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

Retrieving 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

===Configuration Parameters===
{| class="wikitable" border="1"
! scope="col" | Name
! scope="col" | Default Value
! scope="col" | Valid Values (Regex)
! scope="col" | Description
|-
| align="left" | ADDRESS
| align="left" | 18
| align="left" | [0-9]{2}
| align="left" | Keypad address assigned to the AlarmDecoder.
|-
| align="left" | CONFIGBITS
| align="left" | FF00
| align="left" | [0-9a-f]{4}
| align="left" | Special settings for the device. See [[#CONFIGBITS|CONFIGBITS]] for more information.
|-
| align="left" | MASK
| align="left" | FFFFFFFF
| align="left" | [0-9a-f]{8}
| align="left" | Address mask used to filter for keypad alphanumeric messages.
|-
| align="left" | EXP
| align="left" | NNNNN
| align="left" | [YN]{5}
| align="left" | Emulation of zone expanders 1-5
|-
| align="left" | REL
| align="left" | NNNN
| align="left" | [YN]{4}
| align="left" | Emulation of relay expanders 1-4
|-
| align="left" | LRR
| align="left" | N
| align="left" | [YN]
| align="left" | Emulation of Long Range Radio expander
|-
| align="left" | DEDUPLICATE
| align="left" | N
| align="left" | [YN]
| align="left" | If enabled, removes duplicate alphanumeric keypad messages.
|-
|}

====CONFIGBITS====
CONFIGBITS is a setting that's used to enable special functionality on the AlarmDecoder. You can enable these by masking the correct bits.

{| class="wikitable" border="1"
|+ CONFIGBITS Definition
! scope="col" | Mask
! scope="col" | Description
|-
| align="left" | 0x0001
| align="left" | Enable reporting of [[#AUI|AUI]] messages.
|-
| align="left" | 0x0002
| align="left" | Enable reporting of [[#Keypress Events|keypress events]].
|-
| align="left" | 0x0004
| align="left" | Disable prompts for L and | commands.
|-
| align="left" | 0x0008
| align="left" | Enable the prefixing of panel messages with !KMP.
|-
| align="left" | 0x0100
| align="left" | Enable reporting of [[#RFX|RFX]] messages.
|}

----

=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]].

* All lines starting with ! are informational.
* Lines that start with !> are prompts.
* All other lines are panel data in the form of a [[#Keypad|Keypad message]].

==Keypad==
Keypad messages are by far the most common message type produced by the AlarmDecoder. These messages also have an optional header that can be enabled in the [[#CONFIGBITS|CONFIGBITS]]. This setting prefixes all keypad messages with !KPM:.

===Format===
{| class="wikitable" border="1"
|+ Keypad Format
| colspan="4" align="center" style="background-color: #DEDEDE; font-weight: bold" | [001000010000--------],010,[f70700060010808c08020000],"ARMED ***STAY** ZONE BYPASSED "
|-
| colspan="4" |  
|-
! scope="col" width="160px" style="color: #F56464" | Bit field
! scope="col" width="100px" style="color: #8C8CF5" | Numeric code
! scope="col" width="200px" style="color: #70BA66" | Raw data
! scope="col" width="220px" style="color: #804580" | Alphanumeric Keypad Message
|-
| align="center" | [001000010000--------]
| align="center" | 010
| align="center" | [f70700060010808c08020000]
| align="center" | "ARMED ***STAY** ZONE BYPASSED "
|-
|}

====Bit field====
The bit field present on the keypad messages is where you're going to get most of the information on your alarm system's current state. These are all represented by a zero or one aside from the one exception. (beep)

{| class="wikitable" border="1"
! scope="col" | Position
! scope="col" | Description
|-
| 1
| Indicates if the panel is READY
|-
| 2
| Indicates if the panel is ARMED AWAY
|-
| 3
| Indicates if the panel is ARMED HOME
|-
| 4
| Indicates if the keypad backlight is on
|-
| 5
| Indicates if the keypad is in programming mode
|-
| 6
| Number (1-7) indicating how many beeps are associated with the message
|-
| 7
| Indicates that a zone has been bypassed
|-
| 8
| Indicates if the panel is on AC power
|-
| 9
| Indicates if the chime is enabled
|-
| 10
| Indicates that an alarm has occurred. This is sticky and will be cleared after a second disarm.
|-
| 11
| Indicates that an alarm is currently sounding. This is cleared after the first disarm.
|-
| 12
| Indicates that the battery is low
|-
| 13
| Indicates that entry delay is off (ARMED INSTANT/MAX)
|-
| 14
| Indicates that there is a fire
|-
| 15
| Indicates a system issue
|-
| 16
| Indicates that the panel is only watching the perimeter (ARMED STAY/NIGHT)
|-
| 17
| System specific error report
|-
| 18
| Ademco or DSC Mode A or D
|-
| 19
| Unused
|-
| 20
| Unused
|-
|}

====Numeric Code====
This number specifies which zone is affected by the message. For example, if this message is for CHECK ZONE 22 then the numeric code would be 022. Most of the time this is zero-padded base10, but there are rare occurrences where this may be base16, such as ECP bus failures.

====Raw data====
This is the binary data associated with the message. It includes all of the bit field entries that were separated out for you in the first field, as well as the rest of the message for debugging and exploratory purposes.

There is one important piece of data included only in this field: the keypad address mask. The four bytes starting at position 2 (zero-indexed) indicate which keypads this message is intended for.

Inside this mask each bit represents a specific keypad. Each byte represents a group of eight keypad addresses, which the least-significant-bit being the start of the range.

{| class="wikitable" border="1"
! scope="col" | Byte
! scope="col" | Addresses
|-
| 1
| 0-7
|-
| 2
| 8-15
|-
| 3
| 16-23
|-
| 4
| 24-31
|}

For example:
* f70700060010808c08020000 - our keypad address mask is 07000600.

Using the above mask example of 07000600 we find that this message was destined for keypads 0, 1, 2, 17 and 18.

There is one special case: system messages will have no address mask bits set and are intended for common keypads or monitoring multiple zones.

For the most part the address mask details only become really important when you're working with a setup that has multiple partitions since the AlarmDecoder will see all messages by default.

====Alphanumeric Keypad Message====
This section is the data that would be displayed on your keypad's screen.

==Zone Expander==
If you have one or more zone expanders connected to the alarm panel you will be able to see messages from the expanders as zones are faulted and restored. On DSC panels all zones are expressed as EXP messages.
===Examples===
Example of zone expander at address 7, channel 1 faulting and then restoring:
<pre>
!EXP:07,01,01
!EXP:07,01,00
</pre>

===Format===
{| class="wikitable" border="1"
|+ !EXP Format
| colspan="4" align="center" style="background-color: #DEDEDE; font-weight: bold" | !EXP:07,01,01
|-
| colspan="4" |  
|-
! scope="col" width="80px" style="color: #F56464" | Header
! scope="col" width="160px" style="color: #8C8CF5" | Zone Expander Address
! scope="col" width="140px" style="color: #70BA66" | Expander Channel
! scope="col" width="100px" style="color: #804580" | Data
|-
| align="center" | !EXP
| align="center" | 07
| align="center" | 01
| align="center" | 01
|-
|}

====Zone Expander Address====
This is the address that the zone expander occupies.

====Expander Channel====
This is the channel generating the message.

====Data====
00 and 01 indicate that the zone is restored and faulted, respectively.

==Relay Expander==
If you have one or more relay expanders connected to your alarm panel you will be able to see messages when the relays are opened or closed.

===Examples===
Examples of a relay expander at address 12, relay #1 closing and then opening:
<pre>
!REL:12,01,01
!REL:12,01,00
</pre>

===Format===
{| class="wikitable" border="1"
|+ !REL Format
| colspan="4" align="center" style="background-color: #DEDEDE; font-weight: bold" | !REL:12,01,01
|-
| colspan="4" |  
|-
! scope="col" width="80px" style="color: #F56464" | Header
! scope="col" width="160px" style="color: #8C8CF5" | Relay Expander Address
! scope="col" width="140px" style="color: #70BA66" | Expander Channel
! scope="col" width="100px" style="color: #804580" | Data
|-
| align="center" | !REL
| align="center" | 12
| align="center" | 01
| align="center" | 01
|-
|}

====Relay Expander Address====
This is the address that the relay expander occupies.

====Expander Channel====
This is the channel generating the message.

====Data====
00 and 01 indicate that the relay is opened and closed, respectively.

==RFX==
If you have an RF receiver attached to your panel you will see messages from any 5800 RF device in range of the receiver, regardless of whether or not the panel was configured to listen to it.

This also functions when the system is ARMED STAY. Normally you won't see fault messages for interior zones when armed this way so you lose visibility of interior motion sensors. One option is to put the interior sensors on a separate partition so you still see the inside zones and the outside sensors are on their own. The other option is to listen to the !RFX messages directly which could then be used to tell your home automation system that the zones are faulted.

===Examples===
Example of a 5800Micra sensor faulting and restoring:
<pre>
!RFX:0180036,80
!RFX:0180036,00
</pre>

Example of a 5804 keyfob pressing the loop #2 button and having a low battery:
<pre>
!RFX:0307854,22
</pre>

===Format===
{| class="wikitable" border="1"
|+ !RFX Format
| colspan="4" align="center" style="background-color: #DEDEDE; font-weight: bold" | !RFX:0180036,80
|-
| colspan="4" |  
|-
! scope="col" width="80px" style="color: #F56464" | Header
! scope="col" width="100px" style="color: #8C8CF5" | Serial Number
! scope="col" width="100px" style="color: #70BA66" | Data
|-
| align="center" | !RFX
| align="center" | 0180036
| align="center" | 80
|-
|}

====Serial Number====
This is the 7-digit serial number of the device the message originated from.

====Data====
The data is an 8-bit hex message with several indicators. Please refer to the '''5800 SERIES TRANSMITTER INPUT LOOP IDENTIFICATION''' section of your programming manual for what the loops relate to for your specific device.

{| class="wikitable" border="1"
|+ RFX Data Format
|-
! scope="col" | Bit
! scope="col" | Description
|-
| align="center" | 1
| Unknown - Seems that the loop indicators should be ignored if set.
|-
| align="center" | 2
| Low battery indication
|-
| align="center" | 3
| Supervision required indication
|-
| align="center" | 4
| Unknown
|-
| align="center" | 5
| Loop #3 indication
|-
| align="center" | 6
| Loop #2 indication
|-
| align="center" | 7
| Loop #4 indication
|-
| align="center" | 8
| Loop #1 indication
|}

==LRR==
If you have a Long Range Radio device attached or have emulation enabled the AlarmDecoder will report LRR messages from the panel to the radio.

===Examples===
This example shows User 12 arming and disarming the system:
<pre>
!LRR:012,1,ARM_STAY
!LRR:012,1,ARM_AWAY
!LRR:012,1,OPEN
!LRR:003,1,BYPASS
</pre>

===Format===
{| class="wikitable" border="1"
|+ !LRR Format
| colspan="4" align="center" style="background-color: #DEDEDE; font-weight: bold" | !LRR:012,1,ARM_STAY
|-
| colspan="4" |  
|-
! scope="col" width="80px" style="color: #F56464" | Header
! scope="col" width="100px" style="color: #8C8CF5" | Event Data
! scope="col" width="80px" style="color: #70BA66" | Partition
! scope="col" width="100px" style="color: #804580" | Event Type
|-
| align="center" | !LRR
| align="center" | 012
| align="center" | 1
| align="center" | ARM_STAY
|-
|}

====Event Data====
This is either the user number of the person performing the action or the zone that was bypassed.

====Partition====
The panel partition the event applies to. Partition 0 indicates that it's destined for all partitions.

====Event Type====
This is the type of the LRR event. See below for a description and what (if any) programming fields are required for activation.

{| class="wikitable" border="1"
|+ LRR Event Types
! scope="col" | Name
! scope="col" | Program Fields
! scope="col" | Description
|-
| ALARM_EXIT_ERROR
| *59
| Indicates an error when a zone is not closed during arming
|-
| TROUBLE
| *60
| Indicates that a zone is reporting a tamper or failure
|-
| BYPASS
| *61
| Indicates that a zone has been bypassed
|-
| ACLOSS
| *62
| Indicates that AC power was lost
|-
| LOWBAT
| *63
| Low battery indication
|-
| TEST_CALL
| *64
| Indicates a phone test when in testing mode
|-
| OPEN
| *65, requires *66
| Indicates that the alarm is disarmed
|-
| ARM_AWAY
| *66
| Indicates that the system was armed AWAY
|-
| ARM_STAY
| *66
| Indicates that the system was armed STAY
|-
| RFLOWBAT
| *67
| Low battery indication for the RF transmitter
|-
| CANCEL
| *68
| Indicates that the alarm was canceled after second disarm
|-
| RESTORE
| *70
| Indicates that the alarm was restored
|-
| TROUBLE_RESTORE
| *71
| Indicates that the trouble event was restored
|-
| BYPASS_RESTORE
| *72
| Indicates that the bypassed zonew as restored
|-
| AC_RESTORE
| *73
| Indicates that AC power was restored
|-
| LOWBAT_RESTORE
| *74
| Indicates that the low battery has been restored
|-
| RFLOWBAT_RESTORE
| *75
| Indicates that the low battery on the RF transmitter has been restored.
|-
| TEST_RESTORE
| *76
| Indicates that a zone was restored in testing mode
|-
| ALARM_PANIC
|
| Indicates that there is a panic
|-
| ALARM_FIRE
|
| Indicates that there is a fire
|-
| ALARM_ENTRY
|
| Indicates that there was an entry alarm
|-
| ALARM_AUX
|
| Indicates that an auxiliary alarm type was triggered
|-
| ALARM_AUDIBLE
|
| Indicates that an audible alarm is in progress
|-
| ALARM_SILENT
|
| Indicates that there was a silent alarm
|-
| ALARM_PERIMETER
|
| Indicates that there was a perimeter alarm
|}

==AUI==
AUI messages are generated for "Advanced User Interface" keypads. These include a lot of extra data than what's destined for regular keypads.

===Format===
{| class="wikitable" border="1"
|+ !AUI Format
| colspan="4" align="center" style="background-color: #DEDEDE; font-weight: bold" | !AUI:126600000000656c02456cf5ec01017f0002
|-
| colspan="4" |  
|-
! scope="col" width="80px" style="color: #F56464" | Header
! scope="col" width="100px" style="color: #8C8CF5" | AUI Data
|-
| align="center" | !AUI
| align="center" | 126600000000656c02456cf5ec01017f0002
|-
|}

====AUI Data====
This is a large binary blob that's destined for a graphical panel. This data has not been fully decoded. Please see the [[AUI|AUI]] page for information on what has been discovered so far.

==Keypress Events==
Keypress events are generated when keys are pressed on a keypad and can be enabled inside [[#CONFIGBITS|CONFIGBITS]].

===Format===
{| class="wikitable" border="1"
|+ !KPE Format
| colspan="4" align="center" style="background-color: #DEDEDE; font-weight: bold" | !KPE:18
|-
| colspan="4" |  
|-
! scope="col" width="80px" style="color: #F56464" | Header
! scope="col" width="100px" style="color: #8C8CF5" | Keypad Address
|-
| align="center" | !KPE
| align="center" | 18
|-
|}

==Error message report==
Error message reports will be sent to the host when the command 'E' is sent to the AD2*. The list will contain 0 if no errors are recorded and a list of errors separated by commas if errors are recorded. Once an error is reported it will be cleared from the history. The errors from left to right are in order of occurrence. As many as 10 errors can be stored before the oldest is removed from the list.

===Format===
{| class="wikitable" border="1"
|+ !ERR Format
| colspan="4" align="center" style="background-color: #DEDEDE; font-weight: bold" | !ERR:0
|-
| colspan="4" |  
|-
! scope="col" width="80px" style="color: #F56464" | Header
! scope="col" width="100px" style="color: #8C8CF5" | Error list
|-
| align="center" | !ERR
| align="center" | 1,1,1
|-
|}

====Keypad Address====
This is the address of the keypad that generated the event.

=Device Feedback LED=
* Boot flash mode
** During boot the AD2* will rapid flash during the boot loader.
* Operating mode
** The normal operating mode is a steady of approx 2.5 flashes per second.
* Error mode
** If an error is recorded the AD2* will flash the error message as steady slow flashes to be counted with a long period of the LED off between flashes. after a few minutes the led will return to normal idle flash mode if no further errors happen.

Protocol

2015-09-08T19:34:21Z

204.10.16.29: /* Addressed Message */

[[Category:FAQ]]
[[Category:Documentation]]
[[Category:Specifications]]
[[Category:Features]]

=Commands=
{| 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" | E
| align="center" | Dump error report and clear error history. [[#Error_message_report|Error report]]
|-
| align="center" | V
| align="center" | Dump the version, serial number and flags used in the firmware.
|-
| align="center" | K
| align="center" | Send message from specific partition or keypad address. [[#Addressed Message|Addressed Message]]
|-
| 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
|}

==Reboot==
Rebooting the device is as simple as sending = to it.

During the boot process you can trigger a firmware upload by sending a second = to the device after the !boot message is received. At this point you'll receive a !load and can begin uploading.

==Zone Emulation==
Zone Expander Emulation allows the AlarmDecoder to act in place of a physical expander board and make use of virtual zones with your panel. After enabling it on both the panel and the AlarmDecoder you can begin opening and closing zones, which will be relayed back to the panel.

The L command can be used to open or close zones. There are two parameters: the zone and the state. The zone is a zero-padded two-digit number and the state is either 0 or 1.

Example - open zone 12:
* L121\r

Example - close zone 12:
* L120\r

==Addressed Message==
* It is possible to send a message from a specific keypad on Ademco/Vista or to a specific partition on DSC.
The K command can be used to send a message to the panel from a specific keypad address or keypad partition for DSC. There are two parameters: The address or partition a zero padded 2 digit address or partition and the message to send. The AD2* will stay fixed on this new address until a new K message is received or the AD2* is reset.

Example - Send keypad string 1234 to DSC partition 01:
* K011234\r

Example - Send keypad string 12343 from keypad address 19:
* K1912343\r

==Function Keys==
The specialty function keys are identified by ASCII character codes 1 through 4. In order to prevent false positives these must be sent three times in a row.

{| class="wikitable" border="1"
|+ Function Key Codes
! scope="col" | Code
! scope="col" | Description
|-
| \x01\x01\x01
| Function Key #1
|-
| \x02\x02\x02
| Function Key #2
|-
| \x03\x03\x03
| Function Key #3
|-
| \x04\x04\x04
| Function Key #4
|}

----

=Device Configuration=
The AlarmDecoder configuration can be viewed or modified in one of two ways: [[#Prompted|prompted]] or [[#Programatic|programmatically]].

==Prompted==
If you send ! followed by a carriage return you will be prompted to configure 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 provide a new one.

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>

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

Retrieving 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

===Configuration Parameters===
{| class="wikitable" border="1"
! scope="col" | Name
! scope="col" | Default Value
! scope="col" | Valid Values (Regex)
! scope="col" | Description
|-
| align="left" | ADDRESS
| align="left" | 18
| align="left" | [0-9]{2}
| align="left" | Keypad address assigned to the AlarmDecoder.
|-
| align="left" | CONFIGBITS
| align="left" | FF00
| align="left" | [0-9a-f]{4}
| align="left" | Special settings for the device. See [[#CONFIGBITS|CONFIGBITS]] for more information.
|-
| align="left" | MASK
| align="left" | FFFFFFFF
| align="left" | [0-9a-f]{8}
| align="left" | Address mask used to filter for keypad alphanumeric messages.
|-
| align="left" | EXP
| align="left" | NNNNN
| align="left" | [YN]{5}
| align="left" | Emulation of zone expanders 1-5
|-
| align="left" | REL
| align="left" | NNNN
| align="left" | [YN]{4}
| align="left" | Emulation of relay expanders 1-4
|-
| align="left" | LRR
| align="left" | N
| align="left" | [YN]
| align="left" | Emulation of Long Range Radio expander
|-
| align="left" | DEDUPLICATE
| align="left" | N
| align="left" | [YN]
| align="left" | If enabled, removes duplicate alphanumeric keypad messages.
|-
|}

====CONFIGBITS====
CONFIGBITS is a setting that's used to enable special functionality on the AlarmDecoder. You can enable these by masking the correct bits.

{| class="wikitable" border="1"
|+ CONFIGBITS Definition
! scope="col" | Mask
! scope="col" | Description
|-
| align="left" | 0x0001
| align="left" | Enable reporting of [[#AUI|AUI]] messages.
|-
| align="left" | 0x0002
| align="left" | Enable reporting of [[#Keypress Events|keypress events]].
|-
| align="left" | 0x0004
| align="left" | Disable prompts for L and | commands.
|-
| align="left" | 0x0008
| align="left" | Enable the prefixing of panel messages with !KMP.
|-
| align="left" | 0x0100
| align="left" | Enable reporting of [[#RFX|RFX]] messages.
|}

----

=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]].

* All lines starting with ! are informational.
* Lines that start with !> are prompts.
* All other lines are panel data in the form of a [[#Keypad|Keypad message]].

==Keypad==
Keypad messages are by far the most common message type produced by the AlarmDecoder. These messages also have an optional header that can be enabled in the [[#CONFIGBITS|CONFIGBITS]]. This setting prefixes all keypad messages with !KPM:.

===Format===
{| class="wikitable" border="1"
|+ Keypad Format
| colspan="4" align="center" style="background-color: #DEDEDE; font-weight: bold" | [001000010000--------],010,[f70700060010808c08020000],"ARMED ***STAY** ZONE BYPASSED "
|-
| colspan="4" |  
|-
! scope="col" width="160px" style="color: #F56464" | Bit field
! scope="col" width="100px" style="color: #8C8CF5" | Numeric code
! scope="col" width="200px" style="color: #70BA66" | Raw data
! scope="col" width="220px" style="color: #804580" | Alphanumeric Keypad Message
|-
| align="center" | [001000010000--------]
| align="center" | 010
| align="center" | [f70700060010808c08020000]
| align="center" | "ARMED ***STAY** ZONE BYPASSED "
|-
|}

====Bit field====
The bit field present on the keypad messages is where you're going to get most of the information on your alarm system's current state. These are all represented by a zero or one aside from the one exception. (beep)

{| class="wikitable" border="1"
! scope="col" | Position
! scope="col" | Description
|-
| 1
| Indicates if the panel is READY
|-
| 2
| Indicates if the panel is ARMED AWAY
|-
| 3
| Indicates if the panel is ARMED HOME
|-
| 4
| Indicates if the keypad backlight is on
|-
| 5
| Indicates if the keypad is in programming mode
|-
| 6
| Number (1-7) indicating how many beeps are associated with the message
|-
| 7
| Indicates that a zone has been bypassed
|-
| 8
| Indicates if the panel is on AC power
|-
| 9
| Indicates if the chime is enabled
|-
| 10
| Indicates that an alarm has occurred. This is sticky and will be cleared after a second disarm.
|-
| 11
| Indicates that an alarm is currently sounding. This is cleared after the first disarm.
|-
| 12
| Indicates that the battery is low
|-
| 13
| Indicates that entry delay is off (ARMED INSTANT/MAX)
|-
| 14
| Indicates that there is a fire
|-
| 15
| Indicates a system issue
|-
| 16
| Indicates that the panel is only watching the perimeter (ARMED STAY/NIGHT)
|-
| 17
| Unused
|-
| 18
| Unused
|-
| 19
| Unused
|-
| 20
| Unused
|-
|}

====Numeric Code====
This number specifies which zone is affected by the message. For example, if this message is for CHECK ZONE 22 then the numeric code would be 022. Most of the time this is zero-padded base10, but there are rare occurrences where this may be base16, such as ECP bus failures.

====Raw data====
This is the binary data associated with the message. It includes all of the bit field entries that were separated out for you in the first field, as well as the rest of the message for debugging and exploratory purposes.

There is one important piece of data included only in this field: the keypad address mask. The four bytes starting at position 2 (zero-indexed) indicate which keypads this message is intended for.

Inside this mask each bit represents a specific keypad. Each byte represents a group of eight keypad addresses, which the least-significant-bit being the start of the range.

{| class="wikitable" border="1"
! scope="col" | Byte
! scope="col" | Addresses
|-
| 1
| 0-7
|-
| 2
| 8-15
|-
| 3
| 16-23
|-
| 4
| 24-31
|}

For example:
* f70700060010808c08020000 - our keypad address mask is 07000600.

Using the above mask example of 07000600 we find that this message was destined for keypads 0, 1, 2, 17 and 18.

There is one special case: system messages will have no address mask bits set and are intended for common keypads or monitoring multiple zones.

For the most part the address mask details only become really important when you're working with a setup that has multiple partitions since the AlarmDecoder will see all messages by default.

====Alphanumeric Keypad Message====
This section is the data that would be displayed on your keypad's screen.

==Zone Expander==
If you have one or more zone expanders connected to the alarm panel you will be able to see messages from the expanders as zones are faulted and restored. On DSC panels all zones are expressed as EXP messages.
===Examples===
Example of zone expander at address 7, channel 1 faulting and then restoring:
<pre>
!EXP:07,01,01
!EXP:07,01,00
</pre>

===Format===
{| class="wikitable" border="1"
|+ !EXP Format
| colspan="4" align="center" style="background-color: #DEDEDE; font-weight: bold" | !EXP:07,01,01
|-
| colspan="4" |  
|-
! scope="col" width="80px" style="color: #F56464" | Header
! scope="col" width="160px" style="color: #8C8CF5" | Zone Expander Address
! scope="col" width="140px" style="color: #70BA66" | Expander Channel
! scope="col" width="100px" style="color: #804580" | Data
|-
| align="center" | !EXP
| align="center" | 07
| align="center" | 01
| align="center" | 01
|-
|}

====Zone Expander Address====
This is the address that the zone expander occupies.

====Expander Channel====
This is the channel generating the message.

====Data====
00 and 01 indicate that the zone is restored and faulted, respectively.

==Relay Expander==
If you have one or more relay expanders connected to your alarm panel you will be able to see messages when the relays are opened or closed.

===Examples===
Examples of a relay expander at address 12, relay #1 closing and then opening:
<pre>
!REL:12,01,01
!REL:12,01,00
</pre>

===Format===
{| class="wikitable" border="1"
|+ !REL Format
| colspan="4" align="center" style="background-color: #DEDEDE; font-weight: bold" | !REL:12,01,01
|-
| colspan="4" |  
|-
! scope="col" width="80px" style="color: #F56464" | Header
! scope="col" width="160px" style="color: #8C8CF5" | Relay Expander Address
! scope="col" width="140px" style="color: #70BA66" | Expander Channel
! scope="col" width="100px" style="color: #804580" | Data
|-
| align="center" | !REL
| align="center" | 12
| align="center" | 01
| align="center" | 01
|-
|}

====Relay Expander Address====
This is the address that the relay expander occupies.

====Expander Channel====
This is the channel generating the message.

====Data====
00 and 01 indicate that the relay is opened and closed, respectively.

==RFX==
If you have an RF receiver attached to your panel you will see messages from any 5800 RF device in range of the receiver, regardless of whether or not the panel was configured to listen to it.

This also functions when the system is ARMED STAY. Normally you won't see fault messages for interior zones when armed this way so you lose visibility of interior motion sensors. One option is to put the interior sensors on a separate partition so you still see the inside zones and the outside sensors are on their own. The other option is to listen to the !RFX messages directly which could then be used to tell your home automation system that the zones are faulted.

===Examples===
Example of a 5800Micra sensor faulting and restoring:
<pre>
!RFX:0180036,80
!RFX:0180036,00
</pre>

Example of a 5804 keyfob pressing the loop #2 button and having a low battery:
<pre>
!RFX:0307854,22
</pre>

===Format===
{| class="wikitable" border="1"
|+ !RFX Format
| colspan="4" align="center" style="background-color: #DEDEDE; font-weight: bold" | !RFX:0180036,80
|-
| colspan="4" |  
|-
! scope="col" width="80px" style="color: #F56464" | Header
! scope="col" width="100px" style="color: #8C8CF5" | Serial Number
! scope="col" width="100px" style="color: #70BA66" | Data
|-
| align="center" | !RFX
| align="center" | 0180036
| align="center" | 80
|-
|}

====Serial Number====
This is the 7-digit serial number of the device the message originated from.

====Data====
The data is an 8-bit hex message with several indicators. Please refer to the '''5800 SERIES TRANSMITTER INPUT LOOP IDENTIFICATION''' section of your programming manual for what the loops relate to for your specific device.

{| class="wikitable" border="1"
|+ RFX Data Format
|-
! scope="col" | Bit
! scope="col" | Description
|-
| align="center" | 1
| Unknown - Seems that the loop indicators should be ignored if set.
|-
| align="center" | 2
| Low battery indication
|-
| align="center" | 3
| Supervision required indication
|-
| align="center" | 4
| Unknown
|-
| align="center" | 5
| Loop #3 indication
|-
| align="center" | 6
| Loop #2 indication
|-
| align="center" | 7
| Loop #4 indication
|-
| align="center" | 8
| Loop #1 indication
|}

==LRR==
If you have a Long Range Radio device attached or have emulation enabled the AlarmDecoder will report LRR messages from the panel to the radio.

===Examples===
This example shows User 12 arming and disarming the system:
<pre>
!LRR:012,1,ARM_STAY
!LRR:012,1,ARM_AWAY
!LRR:012,1,OPEN
!LRR:003,1,BYPASS
</pre>

===Format===
{| class="wikitable" border="1"
|+ !LRR Format
| colspan="4" align="center" style="background-color: #DEDEDE; font-weight: bold" | !LRR:012,1,ARM_STAY
|-
| colspan="4" |  
|-
! scope="col" width="80px" style="color: #F56464" | Header
! scope="col" width="100px" style="color: #8C8CF5" | Event Data
! scope="col" width="80px" style="color: #70BA66" | Partition
! scope="col" width="100px" style="color: #804580" | Event Type
|-
| align="center" | !LRR
| align="center" | 012
| align="center" | 1
| align="center" | ARM_STAY
|-
|}

====Event Data====
This is either the user number of the person performing the action or the zone that was bypassed.

====Partition====
The panel partition the event applies to. Partition 0 indicates that it's destined for all partitions.

====Event Type====
This is the type of the LRR event. See below for a description and what (if any) programming fields are required for activation.

{| class="wikitable" border="1"
|+ LRR Event Types
! scope="col" | Name
! scope="col" | Program Fields
! scope="col" | Description
|-
| ALARM_EXIT_ERROR
| *59
| Indicates an error when a zone is not closed during arming
|-
| TROUBLE
| *60
| Indicates that a zone is reporting a tamper or failure
|-
| BYPASS
| *61
| Indicates that a zone has been bypassed
|-
| ACLOSS
| *62
| Indicates that AC power was lost
|-
| LOWBAT
| *63
| Low battery indication
|-
| TEST_CALL
| *64
| Indicates a phone test when in testing mode
|-
| OPEN
| *65, requires *66
| Indicates that the alarm is disarmed
|-
| ARM_AWAY
| *66
| Indicates that the system was armed AWAY
|-
| ARM_STAY
| *66
| Indicates that the system was armed STAY
|-
| RFLOWBAT
| *67
| Low battery indication for the RF transmitter
|-
| CANCEL
| *68
| Indicates that the alarm was canceled after second disarm
|-
| RESTORE
| *70
| Indicates that the alarm was restored
|-
| TROUBLE_RESTORE
| *71
| Indicates that the trouble event was restored
|-
| BYPASS_RESTORE
| *72
| Indicates that the bypassed zonew as restored
|-
| AC_RESTORE
| *73
| Indicates that AC power was restored
|-
| LOWBAT_RESTORE
| *74
| Indicates that the low battery has been restored
|-
| RFLOWBAT_RESTORE
| *75
| Indicates that the low battery on the RF transmitter has been restored.
|-
| TEST_RESTORE
| *76
| Indicates that a zone was restored in testing mode
|-
| ALARM_PANIC
|
| Indicates that there is a panic
|-
| ALARM_FIRE
|
| Indicates that there is a fire
|-
| ALARM_ENTRY
|
| Indicates that there was an entry alarm
|-
| ALARM_AUX
|
| Indicates that an auxiliary alarm type was triggered
|-
| ALARM_AUDIBLE
|
| Indicates that an audible alarm is in progress
|-
| ALARM_SILENT
|
| Indicates that there was a silent alarm
|-
| ALARM_PERIMETER
|
| Indicates that there was a perimeter alarm
|}

==AUI==
AUI messages are generated for "Advanced User Interface" keypads. These include a lot of extra data than what's destined for regular keypads.

===Format===
{| class="wikitable" border="1"
|+ !AUI Format
| colspan="4" align="center" style="background-color: #DEDEDE; font-weight: bold" | !AUI:126600000000656c02456cf5ec01017f0002
|-
| colspan="4" |  
|-
! scope="col" width="80px" style="color: #F56464" | Header
! scope="col" width="100px" style="color: #8C8CF5" | AUI Data
|-
| align="center" | !AUI
| align="center" | 126600000000656c02456cf5ec01017f0002
|-
|}

====AUI Data====
This is a large binary blob that's destined for a graphical panel. This data has not been fully decoded. Please see the [[AUI|AUI]] page for information on what has been discovered so far.

==Keypress Events==
Keypress events are generated when keys are pressed on a keypad and can be enabled inside [[#CONFIGBITS|CONFIGBITS]].

===Format===
{| class="wikitable" border="1"
|+ !KPE Format
| colspan="4" align="center" style="background-color: #DEDEDE; font-weight: bold" | !KPE:18
|-
| colspan="4" |  
|-
! scope="col" width="80px" style="color: #F56464" | Header
! scope="col" width="100px" style="color: #8C8CF5" | Keypad Address
|-
| align="center" | !KPE
| align="center" | 18
|-
|}

==Error message report==
Error message reports will be sent to the host when the command 'E' is sent to the AD2*. The list will contain 0 if no errors are recorded and a list of errors separated by commas if errors are recorded. Once an error is reported it will be cleared from the history. The errors from left to right are in order of occurrence. As many as 10 errors can be stored before the oldest is removed from the list.

===Format===
{| class="wikitable" border="1"
|+ !ERR Format
| colspan="4" align="center" style="background-color: #DEDEDE; font-weight: bold" | !ERR:0
|-
| colspan="4" |  
|-
! scope="col" width="80px" style="color: #F56464" | Header
! scope="col" width="100px" style="color: #8C8CF5" | Error list
|-
| align="center" | !ERR
| align="center" | 1,1,1
|-
|}

====Keypad Address====
This is the address of the keypad that generated the event.

=Device Feedback LED=
* Boot flash mode
** During boot the AD2* will rapid flash during the boot loader.
* Operating mode
** The normal operating mode is a steady of approx 2.5 flashes per second.
* Error mode
** If an error is recorded the AD2* will flash the error message as steady slow flashes to be counted with a long period of the LED off between flashes. after a few minutes the led will return to normal idle flash mode if no further errors happen.

Protocol

2015-09-08T19:30:20Z

204.10.16.29: /* Commands */

[[Category:FAQ]]
[[Category:Documentation]]
[[Category:Specifications]]
[[Category:Features]]

=Commands=
{| 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" | E
| align="center" | Dump error report and clear error history. [[#Error_message_report|Error report]]
|-
| align="center" | V
| align="center" | Dump the version, serial number and flags used in the firmware.
|-
| align="center" | K
| align="center" | Send message from specific partition or keypad address. [[#Addressed Message|Addressed Message]]
|-
| 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
|}

==Reboot==
Rebooting the device is as simple as sending = to it.

During the boot process you can trigger a firmware upload by sending a second = to the device after the !boot message is received. At this point you'll receive a !load and can begin uploading.

==Zone Emulation==
Zone Expander Emulation allows the AlarmDecoder to act in place of a physical expander board and make use of virtual zones with your panel. After enabling it on both the panel and the AlarmDecoder you can begin opening and closing zones, which will be relayed back to the panel.

The L command can be used to open or close zones. There are two parameters: the zone and the state. The zone is a zero-padded two-digit number and the state is either 0 or 1.

Example - open zone 12:
* L121\r

Example - close zone 12:
* L120\r

==Addressed Message==
* It is possible to send a message from a specific keypad on Ademco/Vista or to a specific partition on DSC.

==Function Keys==
The specialty function keys are identified by ASCII character codes 1 through 4. In order to prevent false positives these must be sent three times in a row.

{| class="wikitable" border="1"
|+ Function Key Codes
! scope="col" | Code
! scope="col" | Description
|-
| \x01\x01\x01
| Function Key #1
|-
| \x02\x02\x02
| Function Key #2
|-
| \x03\x03\x03
| Function Key #3
|-
| \x04\x04\x04
| Function Key #4
|}

----

=Device Configuration=
The AlarmDecoder configuration can be viewed or modified in one of two ways: [[#Prompted|prompted]] or [[#Programatic|programmatically]].

==Prompted==
If you send ! followed by a carriage return you will be prompted to configure 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 provide a new one.

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>

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

Retrieving 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

===Configuration Parameters===
{| class="wikitable" border="1"
! scope="col" | Name
! scope="col" | Default Value
! scope="col" | Valid Values (Regex)
! scope="col" | Description
|-
| align="left" | ADDRESS
| align="left" | 18
| align="left" | [0-9]{2}
| align="left" | Keypad address assigned to the AlarmDecoder.
|-
| align="left" | CONFIGBITS
| align="left" | FF00
| align="left" | [0-9a-f]{4}
| align="left" | Special settings for the device. See [[#CONFIGBITS|CONFIGBITS]] for more information.
|-
| align="left" | MASK
| align="left" | FFFFFFFF
| align="left" | [0-9a-f]{8}
| align="left" | Address mask used to filter for keypad alphanumeric messages.
|-
| align="left" | EXP
| align="left" | NNNNN
| align="left" | [YN]{5}
| align="left" | Emulation of zone expanders 1-5
|-
| align="left" | REL
| align="left" | NNNN
| align="left" | [YN]{4}
| align="left" | Emulation of relay expanders 1-4
|-
| align="left" | LRR
| align="left" | N
| align="left" | [YN]
| align="left" | Emulation of Long Range Radio expander
|-
| align="left" | DEDUPLICATE
| align="left" | N
| align="left" | [YN]
| align="left" | If enabled, removes duplicate alphanumeric keypad messages.
|-
|}

====CONFIGBITS====
CONFIGBITS is a setting that's used to enable special functionality on the AlarmDecoder. You can enable these by masking the correct bits.

{| class="wikitable" border="1"
|+ CONFIGBITS Definition
! scope="col" | Mask
! scope="col" | Description
|-
| align="left" | 0x0001
| align="left" | Enable reporting of [[#AUI|AUI]] messages.
|-
| align="left" | 0x0002
| align="left" | Enable reporting of [[#Keypress Events|keypress events]].
|-
| align="left" | 0x0004
| align="left" | Disable prompts for L and | commands.
|-
| align="left" | 0x0008
| align="left" | Enable the prefixing of panel messages with !KMP.
|-
| align="left" | 0x0100
| align="left" | Enable reporting of [[#RFX|RFX]] messages.
|}

----

=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]].

* All lines starting with ! are informational.
* Lines that start with !> are prompts.
* All other lines are panel data in the form of a [[#Keypad|Keypad message]].

==Keypad==
Keypad messages are by far the most common message type produced by the AlarmDecoder. These messages also have an optional header that can be enabled in the [[#CONFIGBITS|CONFIGBITS]]. This setting prefixes all keypad messages with !KPM:.

===Format===
{| class="wikitable" border="1"
|+ Keypad Format
| colspan="4" align="center" style="background-color: #DEDEDE; font-weight: bold" | [001000010000--------],010,[f70700060010808c08020000],"ARMED ***STAY** ZONE BYPASSED "
|-
| colspan="4" |  
|-
! scope="col" width="160px" style="color: #F56464" | Bit field
! scope="col" width="100px" style="color: #8C8CF5" | Numeric code
! scope="col" width="200px" style="color: #70BA66" | Raw data
! scope="col" width="220px" style="color: #804580" | Alphanumeric Keypad Message
|-
| align="center" | [001000010000--------]
| align="center" | 010
| align="center" | [f70700060010808c08020000]
| align="center" | "ARMED ***STAY** ZONE BYPASSED "
|-
|}

====Bit field====
The bit field present on the keypad messages is where you're going to get most of the information on your alarm system's current state. These are all represented by a zero or one aside from the one exception. (beep)

{| class="wikitable" border="1"
! scope="col" | Position
! scope="col" | Description
|-
| 1
| Indicates if the panel is READY
|-
| 2
| Indicates if the panel is ARMED AWAY
|-
| 3
| Indicates if the panel is ARMED HOME
|-
| 4
| Indicates if the keypad backlight is on
|-
| 5
| Indicates if the keypad is in programming mode
|-
| 6
| Number (1-7) indicating how many beeps are associated with the message
|-
| 7
| Indicates that a zone has been bypassed
|-
| 8
| Indicates if the panel is on AC power
|-
| 9
| Indicates if the chime is enabled
|-
| 10
| Indicates that an alarm has occurred. This is sticky and will be cleared after a second disarm.
|-
| 11
| Indicates that an alarm is currently sounding. This is cleared after the first disarm.
|-
| 12
| Indicates that the battery is low
|-
| 13
| Indicates that entry delay is off (ARMED INSTANT/MAX)
|-
| 14
| Indicates that there is a fire
|-
| 15
| Indicates a system issue
|-
| 16
| Indicates that the panel is only watching the perimeter (ARMED STAY/NIGHT)
|-
| 17
| Unused
|-
| 18
| Unused
|-
| 19
| Unused
|-
| 20
| Unused
|-
|}

====Numeric Code====
This number specifies which zone is affected by the message. For example, if this message is for CHECK ZONE 22 then the numeric code would be 022. Most of the time this is zero-padded base10, but there are rare occurrences where this may be base16, such as ECP bus failures.

====Raw data====
This is the binary data associated with the message. It includes all of the bit field entries that were separated out for you in the first field, as well as the rest of the message for debugging and exploratory purposes.

There is one important piece of data included only in this field: the keypad address mask. The four bytes starting at position 2 (zero-indexed) indicate which keypads this message is intended for.

Inside this mask each bit represents a specific keypad. Each byte represents a group of eight keypad addresses, which the least-significant-bit being the start of the range.

{| class="wikitable" border="1"
! scope="col" | Byte
! scope="col" | Addresses
|-
| 1
| 0-7
|-
| 2
| 8-15
|-
| 3
| 16-23
|-
| 4
| 24-31
|}

For example:
* f70700060010808c08020000 - our keypad address mask is 07000600.

Using the above mask example of 07000600 we find that this message was destined for keypads 0, 1, 2, 17 and 18.

There is one special case: system messages will have no address mask bits set and are intended for common keypads or monitoring multiple zones.

For the most part the address mask details only become really important when you're working with a setup that has multiple partitions since the AlarmDecoder will see all messages by default.

====Alphanumeric Keypad Message====
This section is the data that would be displayed on your keypad's screen.

==Zone Expander==
If you have one or more zone expanders connected to the alarm panel you will be able to see messages from the expanders as zones are faulted and restored. On DSC panels all zones are expressed as EXP messages.
===Examples===
Example of zone expander at address 7, channel 1 faulting and then restoring:
<pre>
!EXP:07,01,01
!EXP:07,01,00
</pre>

===Format===
{| class="wikitable" border="1"
|+ !EXP Format
| colspan="4" align="center" style="background-color: #DEDEDE; font-weight: bold" | !EXP:07,01,01
|-
| colspan="4" |  
|-
! scope="col" width="80px" style="color: #F56464" | Header
! scope="col" width="160px" style="color: #8C8CF5" | Zone Expander Address
! scope="col" width="140px" style="color: #70BA66" | Expander Channel
! scope="col" width="100px" style="color: #804580" | Data
|-
| align="center" | !EXP
| align="center" | 07
| align="center" | 01
| align="center" | 01
|-
|}

====Zone Expander Address====
This is the address that the zone expander occupies.

====Expander Channel====
This is the channel generating the message.

====Data====
00 and 01 indicate that the zone is restored and faulted, respectively.

==Relay Expander==
If you have one or more relay expanders connected to your alarm panel you will be able to see messages when the relays are opened or closed.

===Examples===
Examples of a relay expander at address 12, relay #1 closing and then opening:
<pre>
!REL:12,01,01
!REL:12,01,00
</pre>

===Format===
{| class="wikitable" border="1"
|+ !REL Format
| colspan="4" align="center" style="background-color: #DEDEDE; font-weight: bold" | !REL:12,01,01
|-
| colspan="4" |  
|-
! scope="col" width="80px" style="color: #F56464" | Header
! scope="col" width="160px" style="color: #8C8CF5" | Relay Expander Address
! scope="col" width="140px" style="color: #70BA66" | Expander Channel
! scope="col" width="100px" style="color: #804580" | Data
|-
| align="center" | !REL
| align="center" | 12
| align="center" | 01
| align="center" | 01
|-
|}

====Relay Expander Address====
This is the address that the relay expander occupies.

====Expander Channel====
This is the channel generating the message.

====Data====
00 and 01 indicate that the relay is opened and closed, respectively.

==RFX==
If you have an RF receiver attached to your panel you will see messages from any 5800 RF device in range of the receiver, regardless of whether or not the panel was configured to listen to it.

This also functions when the system is ARMED STAY. Normally you won't see fault messages for interior zones when armed this way so you lose visibility of interior motion sensors. One option is to put the interior sensors on a separate partition so you still see the inside zones and the outside sensors are on their own. The other option is to listen to the !RFX messages directly which could then be used to tell your home automation system that the zones are faulted.

===Examples===
Example of a 5800Micra sensor faulting and restoring:
<pre>
!RFX:0180036,80
!RFX:0180036,00
</pre>

Example of a 5804 keyfob pressing the loop #2 button and having a low battery:
<pre>
!RFX:0307854,22
</pre>

===Format===
{| class="wikitable" border="1"
|+ !RFX Format
| colspan="4" align="center" style="background-color: #DEDEDE; font-weight: bold" | !RFX:0180036,80
|-
| colspan="4" |  
|-
! scope="col" width="80px" style="color: #F56464" | Header
! scope="col" width="100px" style="color: #8C8CF5" | Serial Number
! scope="col" width="100px" style="color: #70BA66" | Data
|-
| align="center" | !RFX
| align="center" | 0180036
| align="center" | 80
|-
|}

====Serial Number====
This is the 7-digit serial number of the device the message originated from.

====Data====
The data is an 8-bit hex message with several indicators. Please refer to the '''5800 SERIES TRANSMITTER INPUT LOOP IDENTIFICATION''' section of your programming manual for what the loops relate to for your specific device.

{| class="wikitable" border="1"
|+ RFX Data Format
|-
! scope="col" | Bit
! scope="col" | Description
|-
| align="center" | 1
| Unknown - Seems that the loop indicators should be ignored if set.
|-
| align="center" | 2
| Low battery indication
|-
| align="center" | 3
| Supervision required indication
|-
| align="center" | 4
| Unknown
|-
| align="center" | 5
| Loop #3 indication
|-
| align="center" | 6
| Loop #2 indication
|-
| align="center" | 7
| Loop #4 indication
|-
| align="center" | 8
| Loop #1 indication
|}

==LRR==
If you have a Long Range Radio device attached or have emulation enabled the AlarmDecoder will report LRR messages from the panel to the radio.

===Examples===
This example shows User 12 arming and disarming the system:
<pre>
!LRR:012,1,ARM_STAY
!LRR:012,1,ARM_AWAY
!LRR:012,1,OPEN
!LRR:003,1,BYPASS
</pre>

===Format===
{| class="wikitable" border="1"
|+ !LRR Format
| colspan="4" align="center" style="background-color: #DEDEDE; font-weight: bold" | !LRR:012,1,ARM_STAY
|-
| colspan="4" |  
|-
! scope="col" width="80px" style="color: #F56464" | Header
! scope="col" width="100px" style="color: #8C8CF5" | Event Data
! scope="col" width="80px" style="color: #70BA66" | Partition
! scope="col" width="100px" style="color: #804580" | Event Type
|-
| align="center" | !LRR
| align="center" | 012
| align="center" | 1
| align="center" | ARM_STAY
|-
|}

====Event Data====
This is either the user number of the person performing the action or the zone that was bypassed.

====Partition====
The panel partition the event applies to. Partition 0 indicates that it's destined for all partitions.

====Event Type====
This is the type of the LRR event. See below for a description and what (if any) programming fields are required for activation.

{| class="wikitable" border="1"
|+ LRR Event Types
! scope="col" | Name
! scope="col" | Program Fields
! scope="col" | Description
|-
| ALARM_EXIT_ERROR
| *59
| Indicates an error when a zone is not closed during arming
|-
| TROUBLE
| *60
| Indicates that a zone is reporting a tamper or failure
|-
| BYPASS
| *61
| Indicates that a zone has been bypassed
|-
| ACLOSS
| *62
| Indicates that AC power was lost
|-
| LOWBAT
| *63
| Low battery indication
|-
| TEST_CALL
| *64
| Indicates a phone test when in testing mode
|-
| OPEN
| *65, requires *66
| Indicates that the alarm is disarmed
|-
| ARM_AWAY
| *66
| Indicates that the system was armed AWAY
|-
| ARM_STAY
| *66
| Indicates that the system was armed STAY
|-
| RFLOWBAT
| *67
| Low battery indication for the RF transmitter
|-
| CANCEL
| *68
| Indicates that the alarm was canceled after second disarm
|-
| RESTORE
| *70
| Indicates that the alarm was restored
|-
| TROUBLE_RESTORE
| *71
| Indicates that the trouble event was restored
|-
| BYPASS_RESTORE
| *72
| Indicates that the bypassed zonew as restored
|-
| AC_RESTORE
| *73
| Indicates that AC power was restored
|-
| LOWBAT_RESTORE
| *74
| Indicates that the low battery has been restored
|-
| RFLOWBAT_RESTORE
| *75
| Indicates that the low battery on the RF transmitter has been restored.
|-
| TEST_RESTORE
| *76
| Indicates that a zone was restored in testing mode
|-
| ALARM_PANIC
|
| Indicates that there is a panic
|-
| ALARM_FIRE
|
| Indicates that there is a fire
|-
| ALARM_ENTRY
|
| Indicates that there was an entry alarm
|-
| ALARM_AUX
|
| Indicates that an auxiliary alarm type was triggered
|-
| ALARM_AUDIBLE
|
| Indicates that an audible alarm is in progress
|-
| ALARM_SILENT
|
| Indicates that there was a silent alarm
|-
| ALARM_PERIMETER
|
| Indicates that there was a perimeter alarm
|}

==AUI==
AUI messages are generated for "Advanced User Interface" keypads. These include a lot of extra data than what's destined for regular keypads.

===Format===
{| class="wikitable" border="1"
|+ !AUI Format
| colspan="4" align="center" style="background-color: #DEDEDE; font-weight: bold" | !AUI:126600000000656c02456cf5ec01017f0002
|-
| colspan="4" |  
|-
! scope="col" width="80px" style="color: #F56464" | Header
! scope="col" width="100px" style="color: #8C8CF5" | AUI Data
|-
| align="center" | !AUI
| align="center" | 126600000000656c02456cf5ec01017f0002
|-
|}

====AUI Data====
This is a large binary blob that's destined for a graphical panel. This data has not been fully decoded. Please see the [[AUI|AUI]] page for information on what has been discovered so far.

==Keypress Events==
Keypress events are generated when keys are pressed on a keypad and can be enabled inside [[#CONFIGBITS|CONFIGBITS]].

===Format===
{| class="wikitable" border="1"
|+ !KPE Format
| colspan="4" align="center" style="background-color: #DEDEDE; font-weight: bold" | !KPE:18
|-
| colspan="4" |  
|-
! scope="col" width="80px" style="color: #F56464" | Header
! scope="col" width="100px" style="color: #8C8CF5" | Keypad Address
|-
| align="center" | !KPE
| align="center" | 18
|-
|}

==Error message report==
Error message reports will be sent to the host when the command 'E' is sent to the AD2*. The list will contain 0 if no errors are recorded and a list of errors separated by commas if errors are recorded. Once an error is reported it will be cleared from the history. The errors from left to right are in order of occurrence. As many as 10 errors can be stored before the oldest is removed from the list.

===Format===
{| class="wikitable" border="1"
|+ !ERR Format
| colspan="4" align="center" style="background-color: #DEDEDE; font-weight: bold" | !ERR:0
|-
| colspan="4" |  
|-
! scope="col" width="80px" style="color: #F56464" | Header
! scope="col" width="100px" style="color: #8C8CF5" | Error list
|-
| align="center" | !ERR
| align="center" | 1,1,1
|-
|}

====Keypad Address====
This is the address of the keypad that generated the event.

=Device Feedback LED=
* Boot flash mode
** During boot the AD2* will rapid flash during the boot loader.
* Operating mode
** The normal operating mode is a steady of approx 2.5 flashes per second.
* Error mode
** If an error is recorded the AD2* will flash the error message as steady slow flashes to be counted with a long period of the LED off between flashes. after a few minutes the led will return to normal idle flash mode if no further errors happen.

Protocol

2015-09-08T19:29:41Z

204.10.16.29: /* Commands */

[[Category:FAQ]]
[[Category:Documentation]]
[[Category:Specifications]]
[[Category:Features]]

=Commands=
{| 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" | E
| align="center" | Dump error report and clear error history. [[#Error_message_report|Error report]]
|-
| align="center" | V
| align="center" | Dump the version, serial number and flags used in the firmware.
|-
| align="center" | K
| align="center" | Send message from specific partition or keypad address. [[#Addressed message|Addressed message]]
|-
| 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
|}

==Reboot==
Rebooting the device is as simple as sending = to it.

During the boot process you can trigger a firmware upload by sending a second = to the device after the !boot message is received. At this point you'll receive a !load and can begin uploading.

==Zone Emulation==
Zone Expander Emulation allows the AlarmDecoder to act in place of a physical expander board and make use of virtual zones with your panel. After enabling it on both the panel and the AlarmDecoder you can begin opening and closing zones, which will be relayed back to the panel.

The L command can be used to open or close zones. There are two parameters: the zone and the state. The zone is a zero-padded two-digit number and the state is either 0 or 1.

Example - open zone 12:
* L121\r

Example - close zone 12:
* L120\r

==Addressed Message==
* It is possible to send a message from a specific keypad on Ademco/Vista or to a specific partition on DSC.

==Function Keys==
The specialty function keys are identified by ASCII character codes 1 through 4. In order to prevent false positives these must be sent three times in a row.

{| class="wikitable" border="1"
|+ Function Key Codes
! scope="col" | Code
! scope="col" | Description
|-
| \x01\x01\x01
| Function Key #1
|-
| \x02\x02\x02
| Function Key #2
|-
| \x03\x03\x03
| Function Key #3
|-
| \x04\x04\x04
| Function Key #4
|}

----

=Device Configuration=
The AlarmDecoder configuration can be viewed or modified in one of two ways: [[#Prompted|prompted]] or [[#Programatic|programmatically]].

==Prompted==
If you send ! followed by a carriage return you will be prompted to configure 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 provide a new one.

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>

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

Retrieving 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

===Configuration Parameters===
{| class="wikitable" border="1"
! scope="col" | Name
! scope="col" | Default Value
! scope="col" | Valid Values (Regex)
! scope="col" | Description
|-
| align="left" | ADDRESS
| align="left" | 18
| align="left" | [0-9]{2}
| align="left" | Keypad address assigned to the AlarmDecoder.
|-
| align="left" | CONFIGBITS
| align="left" | FF00
| align="left" | [0-9a-f]{4}
| align="left" | Special settings for the device. See [[#CONFIGBITS|CONFIGBITS]] for more information.
|-
| align="left" | MASK
| align="left" | FFFFFFFF
| align="left" | [0-9a-f]{8}
| align="left" | Address mask used to filter for keypad alphanumeric messages.
|-
| align="left" | EXP
| align="left" | NNNNN
| align="left" | [YN]{5}
| align="left" | Emulation of zone expanders 1-5
|-
| align="left" | REL
| align="left" | NNNN
| align="left" | [YN]{4}
| align="left" | Emulation of relay expanders 1-4
|-
| align="left" | LRR
| align="left" | N
| align="left" | [YN]
| align="left" | Emulation of Long Range Radio expander
|-
| align="left" | DEDUPLICATE
| align="left" | N
| align="left" | [YN]
| align="left" | If enabled, removes duplicate alphanumeric keypad messages.
|-
|}

====CONFIGBITS====
CONFIGBITS is a setting that's used to enable special functionality on the AlarmDecoder. You can enable these by masking the correct bits.

{| class="wikitable" border="1"
|+ CONFIGBITS Definition
! scope="col" | Mask
! scope="col" | Description
|-
| align="left" | 0x0001
| align="left" | Enable reporting of [[#AUI|AUI]] messages.
|-
| align="left" | 0x0002
| align="left" | Enable reporting of [[#Keypress Events|keypress events]].
|-
| align="left" | 0x0004
| align="left" | Disable prompts for L and | commands.
|-
| align="left" | 0x0008
| align="left" | Enable the prefixing of panel messages with !KMP.
|-
| align="left" | 0x0100
| align="left" | Enable reporting of [[#RFX|RFX]] messages.
|}

----

=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]].

* All lines starting with ! are informational.
* Lines that start with !> are prompts.
* All other lines are panel data in the form of a [[#Keypad|Keypad message]].

==Keypad==
Keypad messages are by far the most common message type produced by the AlarmDecoder. These messages also have an optional header that can be enabled in the [[#CONFIGBITS|CONFIGBITS]]. This setting prefixes all keypad messages with !KPM:.

===Format===
{| class="wikitable" border="1"
|+ Keypad Format
| colspan="4" align="center" style="background-color: #DEDEDE; font-weight: bold" | [001000010000--------],010,[f70700060010808c08020000],"ARMED ***STAY** ZONE BYPASSED "
|-
| colspan="4" |  
|-
! scope="col" width="160px" style="color: #F56464" | Bit field
! scope="col" width="100px" style="color: #8C8CF5" | Numeric code
! scope="col" width="200px" style="color: #70BA66" | Raw data
! scope="col" width="220px" style="color: #804580" | Alphanumeric Keypad Message
|-
| align="center" | [001000010000--------]
| align="center" | 010
| align="center" | [f70700060010808c08020000]
| align="center" | "ARMED ***STAY** ZONE BYPASSED "
|-
|}

====Bit field====
The bit field present on the keypad messages is where you're going to get most of the information on your alarm system's current state. These are all represented by a zero or one aside from the one exception. (beep)

{| class="wikitable" border="1"
! scope="col" | Position
! scope="col" | Description
|-
| 1
| Indicates if the panel is READY
|-
| 2
| Indicates if the panel is ARMED AWAY
|-
| 3
| Indicates if the panel is ARMED HOME
|-
| 4
| Indicates if the keypad backlight is on
|-
| 5
| Indicates if the keypad is in programming mode
|-
| 6
| Number (1-7) indicating how many beeps are associated with the message
|-
| 7
| Indicates that a zone has been bypassed
|-
| 8
| Indicates if the panel is on AC power
|-
| 9
| Indicates if the chime is enabled
|-
| 10
| Indicates that an alarm has occurred. This is sticky and will be cleared after a second disarm.
|-
| 11
| Indicates that an alarm is currently sounding. This is cleared after the first disarm.
|-
| 12
| Indicates that the battery is low
|-
| 13
| Indicates that entry delay is off (ARMED INSTANT/MAX)
|-
| 14
| Indicates that there is a fire
|-
| 15
| Indicates a system issue
|-
| 16
| Indicates that the panel is only watching the perimeter (ARMED STAY/NIGHT)
|-
| 17
| Unused
|-
| 18
| Unused
|-
| 19
| Unused
|-
| 20
| Unused
|-
|}

====Numeric Code====
This number specifies which zone is affected by the message. For example, if this message is for CHECK ZONE 22 then the numeric code would be 022. Most of the time this is zero-padded base10, but there are rare occurrences where this may be base16, such as ECP bus failures.

====Raw data====
This is the binary data associated with the message. It includes all of the bit field entries that were separated out for you in the first field, as well as the rest of the message for debugging and exploratory purposes.

There is one important piece of data included only in this field: the keypad address mask. The four bytes starting at position 2 (zero-indexed) indicate which keypads this message is intended for.

Inside this mask each bit represents a specific keypad. Each byte represents a group of eight keypad addresses, which the least-significant-bit being the start of the range.

{| class="wikitable" border="1"
! scope="col" | Byte
! scope="col" | Addresses
|-
| 1
| 0-7
|-
| 2
| 8-15
|-
| 3
| 16-23
|-
| 4
| 24-31
|}

For example:
* f70700060010808c08020000 - our keypad address mask is 07000600.

Using the above mask example of 07000600 we find that this message was destined for keypads 0, 1, 2, 17 and 18.

There is one special case: system messages will have no address mask bits set and are intended for common keypads or monitoring multiple zones.

For the most part the address mask details only become really important when you're working with a setup that has multiple partitions since the AlarmDecoder will see all messages by default.

====Alphanumeric Keypad Message====
This section is the data that would be displayed on your keypad's screen.

==Zone Expander==
If you have one or more zone expanders connected to the alarm panel you will be able to see messages from the expanders as zones are faulted and restored. On DSC panels all zones are expressed as EXP messages.
===Examples===
Example of zone expander at address 7, channel 1 faulting and then restoring:
<pre>
!EXP:07,01,01
!EXP:07,01,00
</pre>

===Format===
{| class="wikitable" border="1"
|+ !EXP Format
| colspan="4" align="center" style="background-color: #DEDEDE; font-weight: bold" | !EXP:07,01,01
|-
| colspan="4" |  
|-
! scope="col" width="80px" style="color: #F56464" | Header
! scope="col" width="160px" style="color: #8C8CF5" | Zone Expander Address
! scope="col" width="140px" style="color: #70BA66" | Expander Channel
! scope="col" width="100px" style="color: #804580" | Data
|-
| align="center" | !EXP
| align="center" | 07
| align="center" | 01
| align="center" | 01
|-
|}

====Zone Expander Address====
This is the address that the zone expander occupies.

====Expander Channel====
This is the channel generating the message.

====Data====
00 and 01 indicate that the zone is restored and faulted, respectively.

==Relay Expander==
If you have one or more relay expanders connected to your alarm panel you will be able to see messages when the relays are opened or closed.

===Examples===
Examples of a relay expander at address 12, relay #1 closing and then opening:
<pre>
!REL:12,01,01
!REL:12,01,00
</pre>

===Format===
{| class="wikitable" border="1"
|+ !REL Format
| colspan="4" align="center" style="background-color: #DEDEDE; font-weight: bold" | !REL:12,01,01
|-
| colspan="4" |  
|-
! scope="col" width="80px" style="color: #F56464" | Header
! scope="col" width="160px" style="color: #8C8CF5" | Relay Expander Address
! scope="col" width="140px" style="color: #70BA66" | Expander Channel
! scope="col" width="100px" style="color: #804580" | Data
|-
| align="center" | !REL
| align="center" | 12
| align="center" | 01
| align="center" | 01
|-
|}

====Relay Expander Address====
This is the address that the relay expander occupies.

====Expander Channel====
This is the channel generating the message.

====Data====
00 and 01 indicate that the relay is opened and closed, respectively.

==RFX==
If you have an RF receiver attached to your panel you will see messages from any 5800 RF device in range of the receiver, regardless of whether or not the panel was configured to listen to it.

This also functions when the system is ARMED STAY. Normally you won't see fault messages for interior zones when armed this way so you lose visibility of interior motion sensors. One option is to put the interior sensors on a separate partition so you still see the inside zones and the outside sensors are on their own. The other option is to listen to the !RFX messages directly which could then be used to tell your home automation system that the zones are faulted.

===Examples===
Example of a 5800Micra sensor faulting and restoring:
<pre>
!RFX:0180036,80
!RFX:0180036,00
</pre>

Example of a 5804 keyfob pressing the loop #2 button and having a low battery:
<pre>
!RFX:0307854,22
</pre>

===Format===
{| class="wikitable" border="1"
|+ !RFX Format
| colspan="4" align="center" style="background-color: #DEDEDE; font-weight: bold" | !RFX:0180036,80
|-
| colspan="4" |  
|-
! scope="col" width="80px" style="color: #F56464" | Header
! scope="col" width="100px" style="color: #8C8CF5" | Serial Number
! scope="col" width="100px" style="color: #70BA66" | Data
|-
| align="center" | !RFX
| align="center" | 0180036
| align="center" | 80
|-
|}

====Serial Number====
This is the 7-digit serial number of the device the message originated from.

====Data====
The data is an 8-bit hex message with several indicators. Please refer to the '''5800 SERIES TRANSMITTER INPUT LOOP IDENTIFICATION''' section of your programming manual for what the loops relate to for your specific device.

{| class="wikitable" border="1"
|+ RFX Data Format
|-
! scope="col" | Bit
! scope="col" | Description
|-
| align="center" | 1
| Unknown - Seems that the loop indicators should be ignored if set.
|-
| align="center" | 2
| Low battery indication
|-
| align="center" | 3
| Supervision required indication
|-
| align="center" | 4
| Unknown
|-
| align="center" | 5
| Loop #3 indication
|-
| align="center" | 6
| Loop #2 indication
|-
| align="center" | 7
| Loop #4 indication
|-
| align="center" | 8
| Loop #1 indication
|}

==LRR==
If you have a Long Range Radio device attached or have emulation enabled the AlarmDecoder will report LRR messages from the panel to the radio.

===Examples===
This example shows User 12 arming and disarming the system:
<pre>
!LRR:012,1,ARM_STAY
!LRR:012,1,ARM_AWAY
!LRR:012,1,OPEN
!LRR:003,1,BYPASS
</pre>

===Format===
{| class="wikitable" border="1"
|+ !LRR Format
| colspan="4" align="center" style="background-color: #DEDEDE; font-weight: bold" | !LRR:012,1,ARM_STAY
|-
| colspan="4" |  
|-
! scope="col" width="80px" style="color: #F56464" | Header
! scope="col" width="100px" style="color: #8C8CF5" | Event Data
! scope="col" width="80px" style="color: #70BA66" | Partition
! scope="col" width="100px" style="color: #804580" | Event Type
|-
| align="center" | !LRR
| align="center" | 012
| align="center" | 1
| align="center" | ARM_STAY
|-
|}

====Event Data====
This is either the user number of the person performing the action or the zone that was bypassed.

====Partition====
The panel partition the event applies to. Partition 0 indicates that it's destined for all partitions.

====Event Type====
This is the type of the LRR event. See below for a description and what (if any) programming fields are required for activation.

{| class="wikitable" border="1"
|+ LRR Event Types
! scope="col" | Name
! scope="col" | Program Fields
! scope="col" | Description
|-
| ALARM_EXIT_ERROR
| *59
| Indicates an error when a zone is not closed during arming
|-
| TROUBLE
| *60
| Indicates that a zone is reporting a tamper or failure
|-
| BYPASS
| *61
| Indicates that a zone has been bypassed
|-
| ACLOSS
| *62
| Indicates that AC power was lost
|-
| LOWBAT
| *63
| Low battery indication
|-
| TEST_CALL
| *64
| Indicates a phone test when in testing mode
|-
| OPEN
| *65, requires *66
| Indicates that the alarm is disarmed
|-
| ARM_AWAY
| *66
| Indicates that the system was armed AWAY
|-
| ARM_STAY
| *66
| Indicates that the system was armed STAY
|-
| RFLOWBAT
| *67
| Low battery indication for the RF transmitter
|-
| CANCEL
| *68
| Indicates that the alarm was canceled after second disarm
|-
| RESTORE
| *70
| Indicates that the alarm was restored
|-
| TROUBLE_RESTORE
| *71
| Indicates that the trouble event was restored
|-
| BYPASS_RESTORE
| *72
| Indicates that the bypassed zonew as restored
|-
| AC_RESTORE
| *73
| Indicates that AC power was restored
|-
| LOWBAT_RESTORE
| *74
| Indicates that the low battery has been restored
|-
| RFLOWBAT_RESTORE
| *75
| Indicates that the low battery on the RF transmitter has been restored.
|-
| TEST_RESTORE
| *76
| Indicates that a zone was restored in testing mode
|-
| ALARM_PANIC
|
| Indicates that there is a panic
|-
| ALARM_FIRE
|
| Indicates that there is a fire
|-
| ALARM_ENTRY
|
| Indicates that there was an entry alarm
|-
| ALARM_AUX
|
| Indicates that an auxiliary alarm type was triggered
|-
| ALARM_AUDIBLE
|
| Indicates that an audible alarm is in progress
|-
| ALARM_SILENT
|
| Indicates that there was a silent alarm
|-
| ALARM_PERIMETER
|
| Indicates that there was a perimeter alarm
|}

==AUI==
AUI messages are generated for "Advanced User Interface" keypads. These include a lot of extra data than what's destined for regular keypads.

===Format===
{| class="wikitable" border="1"
|+ !AUI Format
| colspan="4" align="center" style="background-color: #DEDEDE; font-weight: bold" | !AUI:126600000000656c02456cf5ec01017f0002
|-
| colspan="4" |  
|-
! scope="col" width="80px" style="color: #F56464" | Header
! scope="col" width="100px" style="color: #8C8CF5" | AUI Data
|-
| align="center" | !AUI
| align="center" | 126600000000656c02456cf5ec01017f0002
|-
|}

====AUI Data====
This is a large binary blob that's destined for a graphical panel. This data has not been fully decoded. Please see the [[AUI|AUI]] page for information on what has been discovered so far.

==Keypress Events==
Keypress events are generated when keys are pressed on a keypad and can be enabled inside [[#CONFIGBITS|CONFIGBITS]].

===Format===
{| class="wikitable" border="1"
|+ !KPE Format
| colspan="4" align="center" style="background-color: #DEDEDE; font-weight: bold" | !KPE:18
|-
| colspan="4" |  
|-
! scope="col" width="80px" style="color: #F56464" | Header
! scope="col" width="100px" style="color: #8C8CF5" | Keypad Address
|-
| align="center" | !KPE
| align="center" | 18
|-
|}

==Error message report==
Error message reports will be sent to the host when the command 'E' is sent to the AD2*. The list will contain 0 if no errors are recorded and a list of errors separated by commas if errors are recorded. Once an error is reported it will be cleared from the history. The errors from left to right are in order of occurrence. As many as 10 errors can be stored before the oldest is removed from the list.

===Format===
{| class="wikitable" border="1"
|+ !ERR Format
| colspan="4" align="center" style="background-color: #DEDEDE; font-weight: bold" | !ERR:0
|-
| colspan="4" |  
|-
! scope="col" width="80px" style="color: #F56464" | Header
! scope="col" width="100px" style="color: #8C8CF5" | Error list
|-
| align="center" | !ERR
| align="center" | 1,1,1
|-
|}

====Keypad Address====
This is the address of the keypad that generated the event.

=Device Feedback LED=
* Boot flash mode
** During boot the AD2* will rapid flash during the boot loader.
* Operating mode
** The normal operating mode is a steady of approx 2.5 flashes per second.
* Error mode
** If an error is recorded the AD2* will flash the error message as steady slow flashes to be counted with a long period of the LED off between flashes. after a few minutes the led will return to normal idle flash mode if no further errors happen.

Protocol

2015-09-08T19:28:20Z

204.10.16.29: /* Commands */

[[Category:FAQ]]
[[Category:Documentation]]
[[Category:Specifications]]
[[Category:Features]]

=Commands=
{| 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" | E
| align="center" | Dump error report and clear error history. [[#Error_message_report|Error report]]
|-
| align="center" | V
| align="center" | Dump the version, serial number and flags used in the firmware.
|-
| align="center" | K
| align="center" | Send message from specific partition or keypad address. [[#Addressed message|Addressed message]]
|-
| 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
|}

==Reboot==
Rebooting the device is as simple as sending = to it.

During the boot process you can trigger a firmware upload by sending a second = to the device after the !boot message is received. At this point you'll receive a !load and can begin uploading.

==Zone Emulation==
Zone Expander Emulation allows the AlarmDecoder to act in place of a physical expander board and make use of virtual zones with your panel. After enabling it on both the panel and the AlarmDecoder you can begin opening and closing zones, which will be relayed back to the panel.

The L command can be used to open or close zones. There are two parameters: the zone and the state. The zone is a zero-padded two-digit number and the state is either 0 or 1.

Example - open zone 12:
* L121\r

Example - close zone 12:
* L120\r

==Function Keys==
The specialty function keys are identified by ASCII character codes 1 through 4. In order to prevent false positives these must be sent three times in a row.

{| class="wikitable" border="1"
|+ Function Key Codes
! scope="col" | Code
! scope="col" | Description
|-
| \x01\x01\x01
| Function Key #1
|-
| \x02\x02\x02
| Function Key #2
|-
| \x03\x03\x03
| Function Key #3
|-
| \x04\x04\x04
| Function Key #4
|}

----

=Device Configuration=
The AlarmDecoder configuration can be viewed or modified in one of two ways: [[#Prompted|prompted]] or [[#Programatic|programmatically]].

==Prompted==
If you send ! followed by a carriage return you will be prompted to configure 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 provide a new one.

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>

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

Retrieving 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

===Configuration Parameters===
{| class="wikitable" border="1"
! scope="col" | Name
! scope="col" | Default Value
! scope="col" | Valid Values (Regex)
! scope="col" | Description
|-
| align="left" | ADDRESS
| align="left" | 18
| align="left" | [0-9]{2}
| align="left" | Keypad address assigned to the AlarmDecoder.
|-
| align="left" | CONFIGBITS
| align="left" | FF00
| align="left" | [0-9a-f]{4}
| align="left" | Special settings for the device. See [[#CONFIGBITS|CONFIGBITS]] for more information.
|-
| align="left" | MASK
| align="left" | FFFFFFFF
| align="left" | [0-9a-f]{8}
| align="left" | Address mask used to filter for keypad alphanumeric messages.
|-
| align="left" | EXP
| align="left" | NNNNN
| align="left" | [YN]{5}
| align="left" | Emulation of zone expanders 1-5
|-
| align="left" | REL
| align="left" | NNNN
| align="left" | [YN]{4}
| align="left" | Emulation of relay expanders 1-4
|-
| align="left" | LRR
| align="left" | N
| align="left" | [YN]
| align="left" | Emulation of Long Range Radio expander
|-
| align="left" | DEDUPLICATE
| align="left" | N
| align="left" | [YN]
| align="left" | If enabled, removes duplicate alphanumeric keypad messages.
|-
|}

====CONFIGBITS====
CONFIGBITS is a setting that's used to enable special functionality on the AlarmDecoder. You can enable these by masking the correct bits.

{| class="wikitable" border="1"
|+ CONFIGBITS Definition
! scope="col" | Mask
! scope="col" | Description
|-
| align="left" | 0x0001
| align="left" | Enable reporting of [[#AUI|AUI]] messages.
|-
| align="left" | 0x0002
| align="left" | Enable reporting of [[#Keypress Events|keypress events]].
|-
| align="left" | 0x0004
| align="left" | Disable prompts for L and | commands.
|-
| align="left" | 0x0008
| align="left" | Enable the prefixing of panel messages with !KMP.
|-
| align="left" | 0x0100
| align="left" | Enable reporting of [[#RFX|RFX]] messages.
|}

----

=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]].

* All lines starting with ! are informational.
* Lines that start with !> are prompts.
* All other lines are panel data in the form of a [[#Keypad|Keypad message]].

==Keypad==
Keypad messages are by far the most common message type produced by the AlarmDecoder. These messages also have an optional header that can be enabled in the [[#CONFIGBITS|CONFIGBITS]]. This setting prefixes all keypad messages with !KPM:.

===Format===
{| class="wikitable" border="1"
|+ Keypad Format
| colspan="4" align="center" style="background-color: #DEDEDE; font-weight: bold" | [001000010000--------],010,[f70700060010808c08020000],"ARMED ***STAY** ZONE BYPASSED "
|-
| colspan="4" |  
|-
! scope="col" width="160px" style="color: #F56464" | Bit field
! scope="col" width="100px" style="color: #8C8CF5" | Numeric code
! scope="col" width="200px" style="color: #70BA66" | Raw data
! scope="col" width="220px" style="color: #804580" | Alphanumeric Keypad Message
|-
| align="center" | [001000010000--------]
| align="center" | 010
| align="center" | [f70700060010808c08020000]
| align="center" | "ARMED ***STAY** ZONE BYPASSED "
|-
|}

====Bit field====
The bit field present on the keypad messages is where you're going to get most of the information on your alarm system's current state. These are all represented by a zero or one aside from the one exception. (beep)

{| class="wikitable" border="1"
! scope="col" | Position
! scope="col" | Description
|-
| 1
| Indicates if the panel is READY
|-
| 2
| Indicates if the panel is ARMED AWAY
|-
| 3
| Indicates if the panel is ARMED HOME
|-
| 4
| Indicates if the keypad backlight is on
|-
| 5
| Indicates if the keypad is in programming mode
|-
| 6
| Number (1-7) indicating how many beeps are associated with the message
|-
| 7
| Indicates that a zone has been bypassed
|-
| 8
| Indicates if the panel is on AC power
|-
| 9
| Indicates if the chime is enabled
|-
| 10
| Indicates that an alarm has occurred. This is sticky and will be cleared after a second disarm.
|-
| 11
| Indicates that an alarm is currently sounding. This is cleared after the first disarm.
|-
| 12
| Indicates that the battery is low
|-
| 13
| Indicates that entry delay is off (ARMED INSTANT/MAX)
|-
| 14
| Indicates that there is a fire
|-
| 15
| Indicates a system issue
|-
| 16
| Indicates that the panel is only watching the perimeter (ARMED STAY/NIGHT)
|-
| 17
| Unused
|-
| 18
| Unused
|-
| 19
| Unused
|-
| 20
| Unused
|-
|}

====Numeric Code====
This number specifies which zone is affected by the message. For example, if this message is for CHECK ZONE 22 then the numeric code would be 022. Most of the time this is zero-padded base10, but there are rare occurrences where this may be base16, such as ECP bus failures.

====Raw data====
This is the binary data associated with the message. It includes all of the bit field entries that were separated out for you in the first field, as well as the rest of the message for debugging and exploratory purposes.

There is one important piece of data included only in this field: the keypad address mask. The four bytes starting at position 2 (zero-indexed) indicate which keypads this message is intended for.

Inside this mask each bit represents a specific keypad. Each byte represents a group of eight keypad addresses, which the least-significant-bit being the start of the range.

{| class="wikitable" border="1"
! scope="col" | Byte
! scope="col" | Addresses
|-
| 1
| 0-7
|-
| 2
| 8-15
|-
| 3
| 16-23
|-
| 4
| 24-31
|}

For example:
* f70700060010808c08020000 - our keypad address mask is 07000600.

Using the above mask example of 07000600 we find that this message was destined for keypads 0, 1, 2, 17 and 18.

There is one special case: system messages will have no address mask bits set and are intended for common keypads or monitoring multiple zones.

For the most part the address mask details only become really important when you're working with a setup that has multiple partitions since the AlarmDecoder will see all messages by default.

====Alphanumeric Keypad Message====
This section is the data that would be displayed on your keypad's screen.

==Zone Expander==
If you have one or more zone expanders connected to the alarm panel you will be able to see messages from the expanders as zones are faulted and restored. On DSC panels all zones are expressed as EXP messages.
===Examples===
Example of zone expander at address 7, channel 1 faulting and then restoring:
<pre>
!EXP:07,01,01
!EXP:07,01,00
</pre>

===Format===
{| class="wikitable" border="1"
|+ !EXP Format
| colspan="4" align="center" style="background-color: #DEDEDE; font-weight: bold" | !EXP:07,01,01
|-
| colspan="4" |  
|-
! scope="col" width="80px" style="color: #F56464" | Header
! scope="col" width="160px" style="color: #8C8CF5" | Zone Expander Address
! scope="col" width="140px" style="color: #70BA66" | Expander Channel
! scope="col" width="100px" style="color: #804580" | Data
|-
| align="center" | !EXP
| align="center" | 07
| align="center" | 01
| align="center" | 01
|-
|}

====Zone Expander Address====
This is the address that the zone expander occupies.

====Expander Channel====
This is the channel generating the message.

====Data====
00 and 01 indicate that the zone is restored and faulted, respectively.

==Relay Expander==
If you have one or more relay expanders connected to your alarm panel you will be able to see messages when the relays are opened or closed.

===Examples===
Examples of a relay expander at address 12, relay #1 closing and then opening:
<pre>
!REL:12,01,01
!REL:12,01,00
</pre>

===Format===
{| class="wikitable" border="1"
|+ !REL Format
| colspan="4" align="center" style="background-color: #DEDEDE; font-weight: bold" | !REL:12,01,01
|-
| colspan="4" |  
|-
! scope="col" width="80px" style="color: #F56464" | Header
! scope="col" width="160px" style="color: #8C8CF5" | Relay Expander Address
! scope="col" width="140px" style="color: #70BA66" | Expander Channel
! scope="col" width="100px" style="color: #804580" | Data
|-
| align="center" | !REL
| align="center" | 12
| align="center" | 01
| align="center" | 01
|-
|}

====Relay Expander Address====
This is the address that the relay expander occupies.

====Expander Channel====
This is the channel generating the message.

====Data====
00 and 01 indicate that the relay is opened and closed, respectively.

==RFX==
If you have an RF receiver attached to your panel you will see messages from any 5800 RF device in range of the receiver, regardless of whether or not the panel was configured to listen to it.

This also functions when the system is ARMED STAY. Normally you won't see fault messages for interior zones when armed this way so you lose visibility of interior motion sensors. One option is to put the interior sensors on a separate partition so you still see the inside zones and the outside sensors are on their own. The other option is to listen to the !RFX messages directly which could then be used to tell your home automation system that the zones are faulted.

===Examples===
Example of a 5800Micra sensor faulting and restoring:
<pre>
!RFX:0180036,80
!RFX:0180036,00
</pre>

Example of a 5804 keyfob pressing the loop #2 button and having a low battery:
<pre>
!RFX:0307854,22
</pre>

===Format===
{| class="wikitable" border="1"
|+ !RFX Format
| colspan="4" align="center" style="background-color: #DEDEDE; font-weight: bold" | !RFX:0180036,80
|-
| colspan="4" |  
|-
! scope="col" width="80px" style="color: #F56464" | Header
! scope="col" width="100px" style="color: #8C8CF5" | Serial Number
! scope="col" width="100px" style="color: #70BA66" | Data
|-
| align="center" | !RFX
| align="center" | 0180036
| align="center" | 80
|-
|}

====Serial Number====
This is the 7-digit serial number of the device the message originated from.

====Data====
The data is an 8-bit hex message with several indicators. Please refer to the '''5800 SERIES TRANSMITTER INPUT LOOP IDENTIFICATION''' section of your programming manual for what the loops relate to for your specific device.

{| class="wikitable" border="1"
|+ RFX Data Format
|-
! scope="col" | Bit
! scope="col" | Description
|-
| align="center" | 1
| Unknown - Seems that the loop indicators should be ignored if set.
|-
| align="center" | 2
| Low battery indication
|-
| align="center" | 3
| Supervision required indication
|-
| align="center" | 4
| Unknown
|-
| align="center" | 5
| Loop #3 indication
|-
| align="center" | 6
| Loop #2 indication
|-
| align="center" | 7
| Loop #4 indication
|-
| align="center" | 8
| Loop #1 indication
|}

==LRR==
If you have a Long Range Radio device attached or have emulation enabled the AlarmDecoder will report LRR messages from the panel to the radio.

===Examples===
This example shows User 12 arming and disarming the system:
<pre>
!LRR:012,1,ARM_STAY
!LRR:012,1,ARM_AWAY
!LRR:012,1,OPEN
!LRR:003,1,BYPASS
</pre>

===Format===
{| class="wikitable" border="1"
|+ !LRR Format
| colspan="4" align="center" style="background-color: #DEDEDE; font-weight: bold" | !LRR:012,1,ARM_STAY
|-
| colspan="4" |  
|-
! scope="col" width="80px" style="color: #F56464" | Header
! scope="col" width="100px" style="color: #8C8CF5" | Event Data
! scope="col" width="80px" style="color: #70BA66" | Partition
! scope="col" width="100px" style="color: #804580" | Event Type
|-
| align="center" | !LRR
| align="center" | 012
| align="center" | 1
| align="center" | ARM_STAY
|-
|}

====Event Data====
This is either the user number of the person performing the action or the zone that was bypassed.

====Partition====
The panel partition the event applies to. Partition 0 indicates that it's destined for all partitions.

====Event Type====
This is the type of the LRR event. See below for a description and what (if any) programming fields are required for activation.

{| class="wikitable" border="1"
|+ LRR Event Types
! scope="col" | Name
! scope="col" | Program Fields
! scope="col" | Description
|-
| ALARM_EXIT_ERROR
| *59
| Indicates an error when a zone is not closed during arming
|-
| TROUBLE
| *60
| Indicates that a zone is reporting a tamper or failure
|-
| BYPASS
| *61
| Indicates that a zone has been bypassed
|-
| ACLOSS
| *62
| Indicates that AC power was lost
|-
| LOWBAT
| *63
| Low battery indication
|-
| TEST_CALL
| *64
| Indicates a phone test when in testing mode
|-
| OPEN
| *65, requires *66
| Indicates that the alarm is disarmed
|-
| ARM_AWAY
| *66
| Indicates that the system was armed AWAY
|-
| ARM_STAY
| *66
| Indicates that the system was armed STAY
|-
| RFLOWBAT
| *67
| Low battery indication for the RF transmitter
|-
| CANCEL
| *68
| Indicates that the alarm was canceled after second disarm
|-
| RESTORE
| *70
| Indicates that the alarm was restored
|-
| TROUBLE_RESTORE
| *71
| Indicates that the trouble event was restored
|-
| BYPASS_RESTORE
| *72
| Indicates that the bypassed zonew as restored
|-
| AC_RESTORE
| *73
| Indicates that AC power was restored
|-
| LOWBAT_RESTORE
| *74
| Indicates that the low battery has been restored
|-
| RFLOWBAT_RESTORE
| *75
| Indicates that the low battery on the RF transmitter has been restored.
|-
| TEST_RESTORE
| *76
| Indicates that a zone was restored in testing mode
|-
| ALARM_PANIC
|
| Indicates that there is a panic
|-
| ALARM_FIRE
|
| Indicates that there is a fire
|-
| ALARM_ENTRY
|
| Indicates that there was an entry alarm
|-
| ALARM_AUX
|
| Indicates that an auxiliary alarm type was triggered
|-
| ALARM_AUDIBLE
|
| Indicates that an audible alarm is in progress
|-
| ALARM_SILENT
|
| Indicates that there was a silent alarm
|-
| ALARM_PERIMETER
|
| Indicates that there was a perimeter alarm
|}

==AUI==
AUI messages are generated for "Advanced User Interface" keypads. These include a lot of extra data than what's destined for regular keypads.

===Format===
{| class="wikitable" border="1"
|+ !AUI Format
| colspan="4" align="center" style="background-color: #DEDEDE; font-weight: bold" | !AUI:126600000000656c02456cf5ec01017f0002
|-
| colspan="4" |  
|-
! scope="col" width="80px" style="color: #F56464" | Header
! scope="col" width="100px" style="color: #8C8CF5" | AUI Data
|-
| align="center" | !AUI
| align="center" | 126600000000656c02456cf5ec01017f0002
|-
|}

====AUI Data====
This is a large binary blob that's destined for a graphical panel. This data has not been fully decoded. Please see the [[AUI|AUI]] page for information on what has been discovered so far.

==Keypress Events==
Keypress events are generated when keys are pressed on a keypad and can be enabled inside [[#CONFIGBITS|CONFIGBITS]].

===Format===
{| class="wikitable" border="1"
|+ !KPE Format
| colspan="4" align="center" style="background-color: #DEDEDE; font-weight: bold" | !KPE:18
|-
| colspan="4" |  
|-
! scope="col" width="80px" style="color: #F56464" | Header
! scope="col" width="100px" style="color: #8C8CF5" | Keypad Address
|-
| align="center" | !KPE
| align="center" | 18
|-
|}

==Error message report==
Error message reports will be sent to the host when the command 'E' is sent to the AD2*. The list will contain 0 if no errors are recorded and a list of errors separated by commas if errors are recorded. Once an error is reported it will be cleared from the history. The errors from left to right are in order of occurrence. As many as 10 errors can be stored before the oldest is removed from the list.

===Format===
{| class="wikitable" border="1"
|+ !ERR Format
| colspan="4" align="center" style="background-color: #DEDEDE; font-weight: bold" | !ERR:0
|-
| colspan="4" |  
|-
! scope="col" width="80px" style="color: #F56464" | Header
! scope="col" width="100px" style="color: #8C8CF5" | Error list
|-
| align="center" | !ERR
| align="center" | 1,1,1
|-
|}

====Keypad Address====
This is the address of the keypad that generated the event.

=Device Feedback LED=
* Boot flash mode
** During boot the AD2* will rapid flash during the boot loader.
* Operating mode
** The normal operating mode is a steady of approx 2.5 flashes per second.
* Error mode
** If an error is recorded the AD2* will flash the error message as steady slow flashes to be counted with a long period of the LED off between flashes. after a few minutes the led will return to normal idle flash mode if no further errors happen.

Protocol

2015-09-08T19:24:33Z

204.10.16.29: /* Commands */

[[Category:FAQ]]
[[Category:Documentation]]
[[Category:Specifications]]
[[Category:Features]]

=Commands=
{| 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" | E
| align="center" | Dump error report and clear error history. [[#Error_message_report|Error report]]
|-
| align="center" | V
| align="center" | Dump the version, serial number and flags used in the firmware.
|-
| 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
|}

==Reboot==
Rebooting the device is as simple as sending = to it.

During the boot process you can trigger a firmware upload by sending a second = to the device after the !boot message is received. At this point you'll receive a !load and can begin uploading.

==Zone Emulation==
Zone Expander Emulation allows the AlarmDecoder to act in place of a physical expander board and make use of virtual zones with your panel. After enabling it on both the panel and the AlarmDecoder you can begin opening and closing zones, which will be relayed back to the panel.

The L command can be used to open or close zones. There are two parameters: the zone and the state. The zone is a zero-padded two-digit number and the state is either 0 or 1.

Example - open zone 12:
* L121\r

Example - close zone 12:
* L120\r

==Function Keys==
The specialty function keys are identified by ASCII character codes 1 through 4. In order to prevent false positives these must be sent three times in a row.

{| class="wikitable" border="1"
|+ Function Key Codes
! scope="col" | Code
! scope="col" | Description
|-
| \x01\x01\x01
| Function Key #1
|-
| \x02\x02\x02
| Function Key #2
|-
| \x03\x03\x03
| Function Key #3
|-
| \x04\x04\x04
| Function Key #4
|}

----

=Device Configuration=
The AlarmDecoder configuration can be viewed or modified in one of two ways: [[#Prompted|prompted]] or [[#Programatic|programmatically]].

==Prompted==
If you send ! followed by a carriage return you will be prompted to configure 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 provide a new one.

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>

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

Retrieving 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

===Configuration Parameters===
{| class="wikitable" border="1"
! scope="col" | Name
! scope="col" | Default Value
! scope="col" | Valid Values (Regex)
! scope="col" | Description
|-
| align="left" | ADDRESS
| align="left" | 18
| align="left" | [0-9]{2}
| align="left" | Keypad address assigned to the AlarmDecoder.
|-
| align="left" | CONFIGBITS
| align="left" | FF00
| align="left" | [0-9a-f]{4}
| align="left" | Special settings for the device. See [[#CONFIGBITS|CONFIGBITS]] for more information.
|-
| align="left" | MASK
| align="left" | FFFFFFFF
| align="left" | [0-9a-f]{8}
| align="left" | Address mask used to filter for keypad alphanumeric messages.
|-
| align="left" | EXP
| align="left" | NNNNN
| align="left" | [YN]{5}
| align="left" | Emulation of zone expanders 1-5
|-
| align="left" | REL
| align="left" | NNNN
| align="left" | [YN]{4}
| align="left" | Emulation of relay expanders 1-4
|-
| align="left" | LRR
| align="left" | N
| align="left" | [YN]
| align="left" | Emulation of Long Range Radio expander
|-
| align="left" | DEDUPLICATE
| align="left" | N
| align="left" | [YN]
| align="left" | If enabled, removes duplicate alphanumeric keypad messages.
|-
|}

====CONFIGBITS====
CONFIGBITS is a setting that's used to enable special functionality on the AlarmDecoder. You can enable these by masking the correct bits.

{| class="wikitable" border="1"
|+ CONFIGBITS Definition
! scope="col" | Mask
! scope="col" | Description
|-
| align="left" | 0x0001
| align="left" | Enable reporting of [[#AUI|AUI]] messages.
|-
| align="left" | 0x0002
| align="left" | Enable reporting of [[#Keypress Events|keypress events]].
|-
| align="left" | 0x0004
| align="left" | Disable prompts for L and | commands.
|-
| align="left" | 0x0008
| align="left" | Enable the prefixing of panel messages with !KMP.
|-
| align="left" | 0x0100
| align="left" | Enable reporting of [[#RFX|RFX]] messages.
|}

----

=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]].

* All lines starting with ! are informational.
* Lines that start with !> are prompts.
* All other lines are panel data in the form of a [[#Keypad|Keypad message]].

==Keypad==
Keypad messages are by far the most common message type produced by the AlarmDecoder. These messages also have an optional header that can be enabled in the [[#CONFIGBITS|CONFIGBITS]]. This setting prefixes all keypad messages with !KPM:.

===Format===
{| class="wikitable" border="1"
|+ Keypad Format
| colspan="4" align="center" style="background-color: #DEDEDE; font-weight: bold" | [001000010000--------],010,[f70700060010808c08020000],"ARMED ***STAY** ZONE BYPASSED "
|-
| colspan="4" |  
|-
! scope="col" width="160px" style="color: #F56464" | Bit field
! scope="col" width="100px" style="color: #8C8CF5" | Numeric code
! scope="col" width="200px" style="color: #70BA66" | Raw data
! scope="col" width="220px" style="color: #804580" | Alphanumeric Keypad Message
|-
| align="center" | [001000010000--------]
| align="center" | 010
| align="center" | [f70700060010808c08020000]
| align="center" | "ARMED ***STAY** ZONE BYPASSED "
|-
|}

====Bit field====
The bit field present on the keypad messages is where you're going to get most of the information on your alarm system's current state. These are all represented by a zero or one aside from the one exception. (beep)

{| class="wikitable" border="1"
! scope="col" | Position
! scope="col" | Description
|-
| 1
| Indicates if the panel is READY
|-
| 2
| Indicates if the panel is ARMED AWAY
|-
| 3
| Indicates if the panel is ARMED HOME
|-
| 4
| Indicates if the keypad backlight is on
|-
| 5
| Indicates if the keypad is in programming mode
|-
| 6
| Number (1-7) indicating how many beeps are associated with the message
|-
| 7
| Indicates that a zone has been bypassed
|-
| 8
| Indicates if the panel is on AC power
|-
| 9
| Indicates if the chime is enabled
|-
| 10
| Indicates that an alarm has occurred. This is sticky and will be cleared after a second disarm.
|-
| 11
| Indicates that an alarm is currently sounding. This is cleared after the first disarm.
|-
| 12
| Indicates that the battery is low
|-
| 13
| Indicates that entry delay is off (ARMED INSTANT/MAX)
|-
| 14
| Indicates that there is a fire
|-
| 15
| Indicates a system issue
|-
| 16
| Indicates that the panel is only watching the perimeter (ARMED STAY/NIGHT)
|-
| 17
| Unused
|-
| 18
| Unused
|-
| 19
| Unused
|-
| 20
| Unused
|-
|}

====Numeric Code====
This number specifies which zone is affected by the message. For example, if this message is for CHECK ZONE 22 then the numeric code would be 022. Most of the time this is zero-padded base10, but there are rare occurrences where this may be base16, such as ECP bus failures.

====Raw data====
This is the binary data associated with the message. It includes all of the bit field entries that were separated out for you in the first field, as well as the rest of the message for debugging and exploratory purposes.

There is one important piece of data included only in this field: the keypad address mask. The four bytes starting at position 2 (zero-indexed) indicate which keypads this message is intended for.

Inside this mask each bit represents a specific keypad. Each byte represents a group of eight keypad addresses, which the least-significant-bit being the start of the range.

{| class="wikitable" border="1"
! scope="col" | Byte
! scope="col" | Addresses
|-
| 1
| 0-7
|-
| 2
| 8-15
|-
| 3
| 16-23
|-
| 4
| 24-31
|}

For example:
* f70700060010808c08020000 - our keypad address mask is 07000600.

Using the above mask example of 07000600 we find that this message was destined for keypads 0, 1, 2, 17 and 18.

There is one special case: system messages will have no address mask bits set and are intended for common keypads or monitoring multiple zones.

For the most part the address mask details only become really important when you're working with a setup that has multiple partitions since the AlarmDecoder will see all messages by default.

====Alphanumeric Keypad Message====
This section is the data that would be displayed on your keypad's screen.

==Zone Expander==
If you have one or more zone expanders connected to the alarm panel you will be able to see messages from the expanders as zones are faulted and restored. On DSC panels all zones are expressed as EXP messages.
===Examples===
Example of zone expander at address 7, channel 1 faulting and then restoring:
<pre>
!EXP:07,01,01
!EXP:07,01,00
</pre>

===Format===
{| class="wikitable" border="1"
|+ !EXP Format
| colspan="4" align="center" style="background-color: #DEDEDE; font-weight: bold" | !EXP:07,01,01
|-
| colspan="4" |  
|-
! scope="col" width="80px" style="color: #F56464" | Header
! scope="col" width="160px" style="color: #8C8CF5" | Zone Expander Address
! scope="col" width="140px" style="color: #70BA66" | Expander Channel
! scope="col" width="100px" style="color: #804580" | Data
|-
| align="center" | !EXP
| align="center" | 07
| align="center" | 01
| align="center" | 01
|-
|}

====Zone Expander Address====
This is the address that the zone expander occupies.

====Expander Channel====
This is the channel generating the message.

====Data====
00 and 01 indicate that the zone is restored and faulted, respectively.

==Relay Expander==
If you have one or more relay expanders connected to your alarm panel you will be able to see messages when the relays are opened or closed.

===Examples===
Examples of a relay expander at address 12, relay #1 closing and then opening:
<pre>
!REL:12,01,01
!REL:12,01,00
</pre>

===Format===
{| class="wikitable" border="1"
|+ !REL Format
| colspan="4" align="center" style="background-color: #DEDEDE; font-weight: bold" | !REL:12,01,01
|-
| colspan="4" |  
|-
! scope="col" width="80px" style="color: #F56464" | Header
! scope="col" width="160px" style="color: #8C8CF5" | Relay Expander Address
! scope="col" width="140px" style="color: #70BA66" | Expander Channel
! scope="col" width="100px" style="color: #804580" | Data
|-
| align="center" | !REL
| align="center" | 12
| align="center" | 01
| align="center" | 01
|-
|}

====Relay Expander Address====
This is the address that the relay expander occupies.

====Expander Channel====
This is the channel generating the message.

====Data====
00 and 01 indicate that the relay is opened and closed, respectively.

==RFX==
If you have an RF receiver attached to your panel you will see messages from any 5800 RF device in range of the receiver, regardless of whether or not the panel was configured to listen to it.

This also functions when the system is ARMED STAY. Normally you won't see fault messages for interior zones when armed this way so you lose visibility of interior motion sensors. One option is to put the interior sensors on a separate partition so you still see the inside zones and the outside sensors are on their own. The other option is to listen to the !RFX messages directly which could then be used to tell your home automation system that the zones are faulted.

===Examples===
Example of a 5800Micra sensor faulting and restoring:
<pre>
!RFX:0180036,80
!RFX:0180036,00
</pre>

Example of a 5804 keyfob pressing the loop #2 button and having a low battery:
<pre>
!RFX:0307854,22
</pre>

===Format===
{| class="wikitable" border="1"
|+ !RFX Format
| colspan="4" align="center" style="background-color: #DEDEDE; font-weight: bold" | !RFX:0180036,80
|-
| colspan="4" |  
|-
! scope="col" width="80px" style="color: #F56464" | Header
! scope="col" width="100px" style="color: #8C8CF5" | Serial Number
! scope="col" width="100px" style="color: #70BA66" | Data
|-
| align="center" | !RFX
| align="center" | 0180036
| align="center" | 80
|-
|}

====Serial Number====
This is the 7-digit serial number of the device the message originated from.

====Data====
The data is an 8-bit hex message with several indicators. Please refer to the '''5800 SERIES TRANSMITTER INPUT LOOP IDENTIFICATION''' section of your programming manual for what the loops relate to for your specific device.

{| class="wikitable" border="1"
|+ RFX Data Format
|-
! scope="col" | Bit
! scope="col" | Description
|-
| align="center" | 1
| Unknown - Seems that the loop indicators should be ignored if set.
|-
| align="center" | 2
| Low battery indication
|-
| align="center" | 3
| Supervision required indication
|-
| align="center" | 4
| Unknown
|-
| align="center" | 5
| Loop #3 indication
|-
| align="center" | 6
| Loop #2 indication
|-
| align="center" | 7
| Loop #4 indication
|-
| align="center" | 8
| Loop #1 indication
|}

==LRR==
If you have a Long Range Radio device attached or have emulation enabled the AlarmDecoder will report LRR messages from the panel to the radio.

===Examples===
This example shows User 12 arming and disarming the system:
<pre>
!LRR:012,1,ARM_STAY
!LRR:012,1,ARM_AWAY
!LRR:012,1,OPEN
!LRR:003,1,BYPASS
</pre>

===Format===
{| class="wikitable" border="1"
|+ !LRR Format
| colspan="4" align="center" style="background-color: #DEDEDE; font-weight: bold" | !LRR:012,1,ARM_STAY
|-
| colspan="4" |  
|-
! scope="col" width="80px" style="color: #F56464" | Header
! scope="col" width="100px" style="color: #8C8CF5" | Event Data
! scope="col" width="80px" style="color: #70BA66" | Partition
! scope="col" width="100px" style="color: #804580" | Event Type
|-
| align="center" | !LRR
| align="center" | 012
| align="center" | 1
| align="center" | ARM_STAY
|-
|}

====Event Data====
This is either the user number of the person performing the action or the zone that was bypassed.

====Partition====
The panel partition the event applies to. Partition 0 indicates that it's destined for all partitions.

====Event Type====
This is the type of the LRR event. See below for a description and what (if any) programming fields are required for activation.

{| class="wikitable" border="1"
|+ LRR Event Types
! scope="col" | Name
! scope="col" | Program Fields
! scope="col" | Description
|-
| ALARM_EXIT_ERROR
| *59
| Indicates an error when a zone is not closed during arming
|-
| TROUBLE
| *60
| Indicates that a zone is reporting a tamper or failure
|-
| BYPASS
| *61
| Indicates that a zone has been bypassed
|-
| ACLOSS
| *62
| Indicates that AC power was lost
|-
| LOWBAT
| *63
| Low battery indication
|-
| TEST_CALL
| *64
| Indicates a phone test when in testing mode
|-
| OPEN
| *65, requires *66
| Indicates that the alarm is disarmed
|-
| ARM_AWAY
| *66
| Indicates that the system was armed AWAY
|-
| ARM_STAY
| *66
| Indicates that the system was armed STAY
|-
| RFLOWBAT
| *67
| Low battery indication for the RF transmitter
|-
| CANCEL
| *68
| Indicates that the alarm was canceled after second disarm
|-
| RESTORE
| *70
| Indicates that the alarm was restored
|-
| TROUBLE_RESTORE
| *71
| Indicates that the trouble event was restored
|-
| BYPASS_RESTORE
| *72
| Indicates that the bypassed zonew as restored
|-
| AC_RESTORE
| *73
| Indicates that AC power was restored
|-
| LOWBAT_RESTORE
| *74
| Indicates that the low battery has been restored
|-
| RFLOWBAT_RESTORE
| *75
| Indicates that the low battery on the RF transmitter has been restored.
|-
| TEST_RESTORE
| *76
| Indicates that a zone was restored in testing mode
|-
| ALARM_PANIC
|
| Indicates that there is a panic
|-
| ALARM_FIRE
|
| Indicates that there is a fire
|-
| ALARM_ENTRY
|
| Indicates that there was an entry alarm
|-
| ALARM_AUX
|
| Indicates that an auxiliary alarm type was triggered
|-
| ALARM_AUDIBLE
|
| Indicates that an audible alarm is in progress
|-
| ALARM_SILENT
|
| Indicates that there was a silent alarm
|-
| ALARM_PERIMETER
|
| Indicates that there was a perimeter alarm
|}

==AUI==
AUI messages are generated for "Advanced User Interface" keypads. These include a lot of extra data than what's destined for regular keypads.

===Format===
{| class="wikitable" border="1"
|+ !AUI Format
| colspan="4" align="center" style="background-color: #DEDEDE; font-weight: bold" | !AUI:126600000000656c02456cf5ec01017f0002
|-
| colspan="4" |  
|-
! scope="col" width="80px" style="color: #F56464" | Header
! scope="col" width="100px" style="color: #8C8CF5" | AUI Data
|-
| align="center" | !AUI
| align="center" | 126600000000656c02456cf5ec01017f0002
|-
|}

====AUI Data====
This is a large binary blob that's destined for a graphical panel. This data has not been fully decoded. Please see the [[AUI|AUI]] page for information on what has been discovered so far.

==Keypress Events==
Keypress events are generated when keys are pressed on a keypad and can be enabled inside [[#CONFIGBITS|CONFIGBITS]].

===Format===
{| class="wikitable" border="1"
|+ !KPE Format
| colspan="4" align="center" style="background-color: #DEDEDE; font-weight: bold" | !KPE:18
|-
| colspan="4" |  
|-
! scope="col" width="80px" style="color: #F56464" | Header
! scope="col" width="100px" style="color: #8C8CF5" | Keypad Address
|-
| align="center" | !KPE
| align="center" | 18
|-
|}

==Error message report==
Error message reports will be sent to the host when the command 'E' is sent to the AD2*. The list will contain 0 if no errors are recorded and a list of errors separated by commas if errors are recorded. Once an error is reported it will be cleared from the history. The errors from left to right are in order of occurrence. As many as 10 errors can be stored before the oldest is removed from the list.

===Format===
{| class="wikitable" border="1"
|+ !ERR Format
| colspan="4" align="center" style="background-color: #DEDEDE; font-weight: bold" | !ERR:0
|-
| colspan="4" |  
|-
! scope="col" width="80px" style="color: #F56464" | Header
! scope="col" width="100px" style="color: #8C8CF5" | Error list
|-
| align="center" | !ERR
| align="center" | 1,1,1
|-
|}

====Keypad Address====
This is the address of the keypad that generated the event.

=Device Feedback LED=
* Boot flash mode
** During boot the AD2* will rapid flash during the boot loader.
* Operating mode
** The normal operating mode is a steady of approx 2.5 flashes per second.
* Error mode
** If an error is recorded the AD2* will flash the error message as steady slow flashes to be counted with a long period of the LED off between flashes. after a few minutes the led will return to normal idle flash mode if no further errors happen.

Protocol

2015-09-08T19:22:15Z

204.10.16.29: /* Commands */

[[Category:FAQ]]
[[Category:Documentation]]
[[Category:Specifications]]
[[Category:Features]]

=Commands=
{| 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" | E
| align="center" | Dump error report and clear error history.
|-
| align="center" | V
| align="center" | Dump the version, serial number and flags used in the firmware.
|-
| 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
|}

==Reboot==
Rebooting the device is as simple as sending = to it.

During the boot process you can trigger a firmware upload by sending a second = to the device after the !boot message is received. At this point you'll receive a !load and can begin uploading.

==Zone Emulation==
Zone Expander Emulation allows the AlarmDecoder to act in place of a physical expander board and make use of virtual zones with your panel. After enabling it on both the panel and the AlarmDecoder you can begin opening and closing zones, which will be relayed back to the panel.

The L command can be used to open or close zones. There are two parameters: the zone and the state. The zone is a zero-padded two-digit number and the state is either 0 or 1.

Example - open zone 12:
* L121\r

Example - close zone 12:
* L120\r

==Function Keys==
The specialty function keys are identified by ASCII character codes 1 through 4. In order to prevent false positives these must be sent three times in a row.

{| class="wikitable" border="1"
|+ Function Key Codes
! scope="col" | Code
! scope="col" | Description
|-
| \x01\x01\x01
| Function Key #1
|-
| \x02\x02\x02
| Function Key #2
|-
| \x03\x03\x03
| Function Key #3
|-
| \x04\x04\x04
| Function Key #4
|}

----

=Device Configuration=
The AlarmDecoder configuration can be viewed or modified in one of two ways: [[#Prompted|prompted]] or [[#Programatic|programmatically]].

==Prompted==
If you send ! followed by a carriage return you will be prompted to configure 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 provide a new one.

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>

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

Retrieving 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

===Configuration Parameters===
{| class="wikitable" border="1"
! scope="col" | Name
! scope="col" | Default Value
! scope="col" | Valid Values (Regex)
! scope="col" | Description
|-
| align="left" | ADDRESS
| align="left" | 18
| align="left" | [0-9]{2}
| align="left" | Keypad address assigned to the AlarmDecoder.
|-
| align="left" | CONFIGBITS
| align="left" | FF00
| align="left" | [0-9a-f]{4}
| align="left" | Special settings for the device. See [[#CONFIGBITS|CONFIGBITS]] for more information.
|-
| align="left" | MASK
| align="left" | FFFFFFFF
| align="left" | [0-9a-f]{8}
| align="left" | Address mask used to filter for keypad alphanumeric messages.
|-
| align="left" | EXP
| align="left" | NNNNN
| align="left" | [YN]{5}
| align="left" | Emulation of zone expanders 1-5
|-
| align="left" | REL
| align="left" | NNNN
| align="left" | [YN]{4}
| align="left" | Emulation of relay expanders 1-4
|-
| align="left" | LRR
| align="left" | N
| align="left" | [YN]
| align="left" | Emulation of Long Range Radio expander
|-
| align="left" | DEDUPLICATE
| align="left" | N
| align="left" | [YN]
| align="left" | If enabled, removes duplicate alphanumeric keypad messages.
|-
|}

====CONFIGBITS====
CONFIGBITS is a setting that's used to enable special functionality on the AlarmDecoder. You can enable these by masking the correct bits.

{| class="wikitable" border="1"
|+ CONFIGBITS Definition
! scope="col" | Mask
! scope="col" | Description
|-
| align="left" | 0x0001
| align="left" | Enable reporting of [[#AUI|AUI]] messages.
|-
| align="left" | 0x0002
| align="left" | Enable reporting of [[#Keypress Events|keypress events]].
|-
| align="left" | 0x0004
| align="left" | Disable prompts for L and | commands.
|-
| align="left" | 0x0008
| align="left" | Enable the prefixing of panel messages with !KMP.
|-
| align="left" | 0x0100
| align="left" | Enable reporting of [[#RFX|RFX]] messages.
|}

----

=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]].

* All lines starting with ! are informational.
* Lines that start with !> are prompts.
* All other lines are panel data in the form of a [[#Keypad|Keypad message]].

==Keypad==
Keypad messages are by far the most common message type produced by the AlarmDecoder. These messages also have an optional header that can be enabled in the [[#CONFIGBITS|CONFIGBITS]]. This setting prefixes all keypad messages with !KPM:.

===Format===
{| class="wikitable" border="1"
|+ Keypad Format
| colspan="4" align="center" style="background-color: #DEDEDE; font-weight: bold" | [001000010000--------],010,[f70700060010808c08020000],"ARMED ***STAY** ZONE BYPASSED "
|-
| colspan="4" |  
|-
! scope="col" width="160px" style="color: #F56464" | Bit field
! scope="col" width="100px" style="color: #8C8CF5" | Numeric code
! scope="col" width="200px" style="color: #70BA66" | Raw data
! scope="col" width="220px" style="color: #804580" | Alphanumeric Keypad Message
|-
| align="center" | [001000010000--------]
| align="center" | 010
| align="center" | [f70700060010808c08020000]
| align="center" | "ARMED ***STAY** ZONE BYPASSED "
|-
|}

====Bit field====
The bit field present on the keypad messages is where you're going to get most of the information on your alarm system's current state. These are all represented by a zero or one aside from the one exception. (beep)

{| class="wikitable" border="1"
! scope="col" | Position
! scope="col" | Description
|-
| 1
| Indicates if the panel is READY
|-
| 2
| Indicates if the panel is ARMED AWAY
|-
| 3
| Indicates if the panel is ARMED HOME
|-
| 4
| Indicates if the keypad backlight is on
|-
| 5
| Indicates if the keypad is in programming mode
|-
| 6
| Number (1-7) indicating how many beeps are associated with the message
|-
| 7
| Indicates that a zone has been bypassed
|-
| 8
| Indicates if the panel is on AC power
|-
| 9
| Indicates if the chime is enabled
|-
| 10
| Indicates that an alarm has occurred. This is sticky and will be cleared after a second disarm.
|-
| 11
| Indicates that an alarm is currently sounding. This is cleared after the first disarm.
|-
| 12
| Indicates that the battery is low
|-
| 13
| Indicates that entry delay is off (ARMED INSTANT/MAX)
|-
| 14
| Indicates that there is a fire
|-
| 15
| Indicates a system issue
|-
| 16
| Indicates that the panel is only watching the perimeter (ARMED STAY/NIGHT)
|-
| 17
| Unused
|-
| 18
| Unused
|-
| 19
| Unused
|-
| 20
| Unused
|-
|}

====Numeric Code====
This number specifies which zone is affected by the message. For example, if this message is for CHECK ZONE 22 then the numeric code would be 022. Most of the time this is zero-padded base10, but there are rare occurrences where this may be base16, such as ECP bus failures.

====Raw data====
This is the binary data associated with the message. It includes all of the bit field entries that were separated out for you in the first field, as well as the rest of the message for debugging and exploratory purposes.

There is one important piece of data included only in this field: the keypad address mask. The four bytes starting at position 2 (zero-indexed) indicate which keypads this message is intended for.

Inside this mask each bit represents a specific keypad. Each byte represents a group of eight keypad addresses, which the least-significant-bit being the start of the range.

{| class="wikitable" border="1"
! scope="col" | Byte
! scope="col" | Addresses
|-
| 1
| 0-7
|-
| 2
| 8-15
|-
| 3
| 16-23
|-
| 4
| 24-31
|}

For example:
* f70700060010808c08020000 - our keypad address mask is 07000600.

Using the above mask example of 07000600 we find that this message was destined for keypads 0, 1, 2, 17 and 18.

There is one special case: system messages will have no address mask bits set and are intended for common keypads or monitoring multiple zones.

For the most part the address mask details only become really important when you're working with a setup that has multiple partitions since the AlarmDecoder will see all messages by default.

====Alphanumeric Keypad Message====
This section is the data that would be displayed on your keypad's screen.

==Zone Expander==
If you have one or more zone expanders connected to the alarm panel you will be able to see messages from the expanders as zones are faulted and restored. On DSC panels all zones are expressed as EXP messages.
===Examples===
Example of zone expander at address 7, channel 1 faulting and then restoring:
<pre>
!EXP:07,01,01
!EXP:07,01,00
</pre>

===Format===
{| class="wikitable" border="1"
|+ !EXP Format
| colspan="4" align="center" style="background-color: #DEDEDE; font-weight: bold" | !EXP:07,01,01
|-
| colspan="4" |  
|-
! scope="col" width="80px" style="color: #F56464" | Header
! scope="col" width="160px" style="color: #8C8CF5" | Zone Expander Address
! scope="col" width="140px" style="color: #70BA66" | Expander Channel
! scope="col" width="100px" style="color: #804580" | Data
|-
| align="center" | !EXP
| align="center" | 07
| align="center" | 01
| align="center" | 01
|-
|}

====Zone Expander Address====
This is the address that the zone expander occupies.

====Expander Channel====
This is the channel generating the message.

====Data====
00 and 01 indicate that the zone is restored and faulted, respectively.

==Relay Expander==
If you have one or more relay expanders connected to your alarm panel you will be able to see messages when the relays are opened or closed.

===Examples===
Examples of a relay expander at address 12, relay #1 closing and then opening:
<pre>
!REL:12,01,01
!REL:12,01,00
</pre>

===Format===
{| class="wikitable" border="1"
|+ !REL Format
| colspan="4" align="center" style="background-color: #DEDEDE; font-weight: bold" | !REL:12,01,01
|-
| colspan="4" |  
|-
! scope="col" width="80px" style="color: #F56464" | Header
! scope="col" width="160px" style="color: #8C8CF5" | Relay Expander Address
! scope="col" width="140px" style="color: #70BA66" | Expander Channel
! scope="col" width="100px" style="color: #804580" | Data
|-
| align="center" | !REL
| align="center" | 12
| align="center" | 01
| align="center" | 01
|-
|}

====Relay Expander Address====
This is the address that the relay expander occupies.

====Expander Channel====
This is the channel generating the message.

====Data====
00 and 01 indicate that the relay is opened and closed, respectively.

==RFX==
If you have an RF receiver attached to your panel you will see messages from any 5800 RF device in range of the receiver, regardless of whether or not the panel was configured to listen to it.

This also functions when the system is ARMED STAY. Normally you won't see fault messages for interior zones when armed this way so you lose visibility of interior motion sensors. One option is to put the interior sensors on a separate partition so you still see the inside zones and the outside sensors are on their own. The other option is to listen to the !RFX messages directly which could then be used to tell your home automation system that the zones are faulted.

===Examples===
Example of a 5800Micra sensor faulting and restoring:
<pre>
!RFX:0180036,80
!RFX:0180036,00
</pre>

Example of a 5804 keyfob pressing the loop #2 button and having a low battery:
<pre>
!RFX:0307854,22
</pre>

===Format===
{| class="wikitable" border="1"
|+ !RFX Format
| colspan="4" align="center" style="background-color: #DEDEDE; font-weight: bold" | !RFX:0180036,80
|-
| colspan="4" |  
|-
! scope="col" width="80px" style="color: #F56464" | Header
! scope="col" width="100px" style="color: #8C8CF5" | Serial Number
! scope="col" width="100px" style="color: #70BA66" | Data
|-
| align="center" | !RFX
| align="center" | 0180036
| align="center" | 80
|-
|}

====Serial Number====
This is the 7-digit serial number of the device the message originated from.

====Data====
The data is an 8-bit hex message with several indicators. Please refer to the '''5800 SERIES TRANSMITTER INPUT LOOP IDENTIFICATION''' section of your programming manual for what the loops relate to for your specific device.

{| class="wikitable" border="1"
|+ RFX Data Format
|-
! scope="col" | Bit
! scope="col" | Description
|-
| align="center" | 1
| Unknown - Seems that the loop indicators should be ignored if set.
|-
| align="center" | 2
| Low battery indication
|-
| align="center" | 3
| Supervision required indication
|-
| align="center" | 4
| Unknown
|-
| align="center" | 5
| Loop #3 indication
|-
| align="center" | 6
| Loop #2 indication
|-
| align="center" | 7
| Loop #4 indication
|-
| align="center" | 8
| Loop #1 indication
|}

==LRR==
If you have a Long Range Radio device attached or have emulation enabled the AlarmDecoder will report LRR messages from the panel to the radio.

===Examples===
This example shows User 12 arming and disarming the system:
<pre>
!LRR:012,1,ARM_STAY
!LRR:012,1,ARM_AWAY
!LRR:012,1,OPEN
!LRR:003,1,BYPASS
</pre>

===Format===
{| class="wikitable" border="1"
|+ !LRR Format
| colspan="4" align="center" style="background-color: #DEDEDE; font-weight: bold" | !LRR:012,1,ARM_STAY
|-
| colspan="4" |  
|-
! scope="col" width="80px" style="color: #F56464" | Header
! scope="col" width="100px" style="color: #8C8CF5" | Event Data
! scope="col" width="80px" style="color: #70BA66" | Partition
! scope="col" width="100px" style="color: #804580" | Event Type
|-
| align="center" | !LRR
| align="center" | 012
| align="center" | 1
| align="center" | ARM_STAY
|-
|}

====Event Data====
This is either the user number of the person performing the action or the zone that was bypassed.

====Partition====
The panel partition the event applies to. Partition 0 indicates that it's destined for all partitions.

====Event Type====
This is the type of the LRR event. See below for a description and what (if any) programming fields are required for activation.

{| class="wikitable" border="1"
|+ LRR Event Types
! scope="col" | Name
! scope="col" | Program Fields
! scope="col" | Description
|-
| ALARM_EXIT_ERROR
| *59
| Indicates an error when a zone is not closed during arming
|-
| TROUBLE
| *60
| Indicates that a zone is reporting a tamper or failure
|-
| BYPASS
| *61
| Indicates that a zone has been bypassed
|-
| ACLOSS
| *62
| Indicates that AC power was lost
|-
| LOWBAT
| *63
| Low battery indication
|-
| TEST_CALL
| *64
| Indicates a phone test when in testing mode
|-
| OPEN
| *65, requires *66
| Indicates that the alarm is disarmed
|-
| ARM_AWAY
| *66
| Indicates that the system was armed AWAY
|-
| ARM_STAY
| *66
| Indicates that the system was armed STAY
|-
| RFLOWBAT
| *67
| Low battery indication for the RF transmitter
|-
| CANCEL
| *68
| Indicates that the alarm was canceled after second disarm
|-
| RESTORE
| *70
| Indicates that the alarm was restored
|-
| TROUBLE_RESTORE
| *71
| Indicates that the trouble event was restored
|-
| BYPASS_RESTORE
| *72
| Indicates that the bypassed zonew as restored
|-
| AC_RESTORE
| *73
| Indicates that AC power was restored
|-
| LOWBAT_RESTORE
| *74
| Indicates that the low battery has been restored
|-
| RFLOWBAT_RESTORE
| *75
| Indicates that the low battery on the RF transmitter has been restored.
|-
| TEST_RESTORE
| *76
| Indicates that a zone was restored in testing mode
|-
| ALARM_PANIC
|
| Indicates that there is a panic
|-
| ALARM_FIRE
|
| Indicates that there is a fire
|-
| ALARM_ENTRY
|
| Indicates that there was an entry alarm
|-
| ALARM_AUX
|
| Indicates that an auxiliary alarm type was triggered
|-
| ALARM_AUDIBLE
|
| Indicates that an audible alarm is in progress
|-
| ALARM_SILENT
|
| Indicates that there was a silent alarm
|-
| ALARM_PERIMETER
|
| Indicates that there was a perimeter alarm
|}

==AUI==
AUI messages are generated for "Advanced User Interface" keypads. These include a lot of extra data than what's destined for regular keypads.

===Format===
{| class="wikitable" border="1"
|+ !AUI Format
| colspan="4" align="center" style="background-color: #DEDEDE; font-weight: bold" | !AUI:126600000000656c02456cf5ec01017f0002
|-
| colspan="4" |  
|-
! scope="col" width="80px" style="color: #F56464" | Header
! scope="col" width="100px" style="color: #8C8CF5" | AUI Data
|-
| align="center" | !AUI
| align="center" | 126600000000656c02456cf5ec01017f0002
|-
|}

====AUI Data====
This is a large binary blob that's destined for a graphical panel. This data has not been fully decoded. Please see the [[AUI|AUI]] page for information on what has been discovered so far.

==Keypress Events==
Keypress events are generated when keys are pressed on a keypad and can be enabled inside [[#CONFIGBITS|CONFIGBITS]].

===Format===
{| class="wikitable" border="1"
|+ !KPE Format
| colspan="4" align="center" style="background-color: #DEDEDE; font-weight: bold" | !KPE:18
|-
| colspan="4" |  
|-
! scope="col" width="80px" style="color: #F56464" | Header
! scope="col" width="100px" style="color: #8C8CF5" | Keypad Address
|-
| align="center" | !KPE
| align="center" | 18
|-
|}

==Error message report==
Error message reports will be sent to the host when the command 'E' is sent to the AD2*. The list will contain 0 if no errors are recorded and a list of errors separated by commas if errors are recorded. Once an error is reported it will be cleared from the history. The errors from left to right are in order of occurrence. As many as 10 errors can be stored before the oldest is removed from the list.

===Format===
{| class="wikitable" border="1"
|+ !ERR Format
| colspan="4" align="center" style="background-color: #DEDEDE; font-weight: bold" | !ERR:0
|-
| colspan="4" |  
|-
! scope="col" width="80px" style="color: #F56464" | Header
! scope="col" width="100px" style="color: #8C8CF5" | Error list
|-
| align="center" | !ERR
| align="center" | 1,1,1
|-
|}

====Keypad Address====
This is the address of the keypad that generated the event.

=Device Feedback LED=
* Boot flash mode
** During boot the AD2* will rapid flash during the boot loader.
* Operating mode
** The normal operating mode is a steady of approx 2.5 flashes per second.
* Error mode
** If an error is recorded the AD2* will flash the error message as steady slow flashes to be counted with a long period of the LED off between flashes. after a few minutes the led will return to normal idle flash mode if no further errors happen.

Protocol

2015-09-08T19:21:01Z

204.10.16.29: /* Commands */

[[Category:FAQ]]
[[Category:Documentation]]
[[Category:Specifications]]
[[Category:Features]]

=Commands=
{| 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" | E
| align="center" | Dump error report and clear error history.
|-
| 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
|}

==Reboot==
Rebooting the device is as simple as sending = to it.

During the boot process you can trigger a firmware upload by sending a second = to the device after the !boot message is received. At this point you'll receive a !load and can begin uploading.

==Zone Emulation==
Zone Expander Emulation allows the AlarmDecoder to act in place of a physical expander board and make use of virtual zones with your panel. After enabling it on both the panel and the AlarmDecoder you can begin opening and closing zones, which will be relayed back to the panel.

The L command can be used to open or close zones. There are two parameters: the zone and the state. The zone is a zero-padded two-digit number and the state is either 0 or 1.

Example - open zone 12:
* L121\r

Example - close zone 12:
* L120\r

==Function Keys==
The specialty function keys are identified by ASCII character codes 1 through 4. In order to prevent false positives these must be sent three times in a row.

{| class="wikitable" border="1"
|+ Function Key Codes
! scope="col" | Code
! scope="col" | Description
|-
| \x01\x01\x01
| Function Key #1
|-
| \x02\x02\x02
| Function Key #2
|-
| \x03\x03\x03
| Function Key #3
|-
| \x04\x04\x04
| Function Key #4
|}

----

=Device Configuration=
The AlarmDecoder configuration can be viewed or modified in one of two ways: [[#Prompted|prompted]] or [[#Programatic|programmatically]].

==Prompted==
If you send ! followed by a carriage return you will be prompted to configure 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 provide a new one.

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>

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

Retrieving 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

===Configuration Parameters===
{| class="wikitable" border="1"
! scope="col" | Name
! scope="col" | Default Value
! scope="col" | Valid Values (Regex)
! scope="col" | Description
|-
| align="left" | ADDRESS
| align="left" | 18
| align="left" | [0-9]{2}
| align="left" | Keypad address assigned to the AlarmDecoder.
|-
| align="left" | CONFIGBITS
| align="left" | FF00
| align="left" | [0-9a-f]{4}
| align="left" | Special settings for the device. See [[#CONFIGBITS|CONFIGBITS]] for more information.
|-
| align="left" | MASK
| align="left" | FFFFFFFF
| align="left" | [0-9a-f]{8}
| align="left" | Address mask used to filter for keypad alphanumeric messages.
|-
| align="left" | EXP
| align="left" | NNNNN
| align="left" | [YN]{5}
| align="left" | Emulation of zone expanders 1-5
|-
| align="left" | REL
| align="left" | NNNN
| align="left" | [YN]{4}
| align="left" | Emulation of relay expanders 1-4
|-
| align="left" | LRR
| align="left" | N
| align="left" | [YN]
| align="left" | Emulation of Long Range Radio expander
|-
| align="left" | DEDUPLICATE
| align="left" | N
| align="left" | [YN]
| align="left" | If enabled, removes duplicate alphanumeric keypad messages.
|-
|}

====CONFIGBITS====
CONFIGBITS is a setting that's used to enable special functionality on the AlarmDecoder. You can enable these by masking the correct bits.

{| class="wikitable" border="1"
|+ CONFIGBITS Definition
! scope="col" | Mask
! scope="col" | Description
|-
| align="left" | 0x0001
| align="left" | Enable reporting of [[#AUI|AUI]] messages.
|-
| align="left" | 0x0002
| align="left" | Enable reporting of [[#Keypress Events|keypress events]].
|-
| align="left" | 0x0004
| align="left" | Disable prompts for L and | commands.
|-
| align="left" | 0x0008
| align="left" | Enable the prefixing of panel messages with !KMP.
|-
| align="left" | 0x0100
| align="left" | Enable reporting of [[#RFX|RFX]] messages.
|}

----

=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]].

* All lines starting with ! are informational.
* Lines that start with !> are prompts.
* All other lines are panel data in the form of a [[#Keypad|Keypad message]].

==Keypad==
Keypad messages are by far the most common message type produced by the AlarmDecoder. These messages also have an optional header that can be enabled in the [[#CONFIGBITS|CONFIGBITS]]. This setting prefixes all keypad messages with !KPM:.

===Format===
{| class="wikitable" border="1"
|+ Keypad Format
| colspan="4" align="center" style="background-color: #DEDEDE; font-weight: bold" | [001000010000--------],010,[f70700060010808c08020000],"ARMED ***STAY** ZONE BYPASSED "
|-
| colspan="4" |  
|-
! scope="col" width="160px" style="color: #F56464" | Bit field
! scope="col" width="100px" style="color: #8C8CF5" | Numeric code
! scope="col" width="200px" style="color: #70BA66" | Raw data
! scope="col" width="220px" style="color: #804580" | Alphanumeric Keypad Message
|-
| align="center" | [001000010000--------]
| align="center" | 010
| align="center" | [f70700060010808c08020000]
| align="center" | "ARMED ***STAY** ZONE BYPASSED "
|-
|}

====Bit field====
The bit field present on the keypad messages is where you're going to get most of the information on your alarm system's current state. These are all represented by a zero or one aside from the one exception. (beep)

{| class="wikitable" border="1"
! scope="col" | Position
! scope="col" | Description
|-
| 1
| Indicates if the panel is READY
|-
| 2
| Indicates if the panel is ARMED AWAY
|-
| 3
| Indicates if the panel is ARMED HOME
|-
| 4
| Indicates if the keypad backlight is on
|-
| 5
| Indicates if the keypad is in programming mode
|-
| 6
| Number (1-7) indicating how many beeps are associated with the message
|-
| 7
| Indicates that a zone has been bypassed
|-
| 8
| Indicates if the panel is on AC power
|-
| 9
| Indicates if the chime is enabled
|-
| 10
| Indicates that an alarm has occurred. This is sticky and will be cleared after a second disarm.
|-
| 11
| Indicates that an alarm is currently sounding. This is cleared after the first disarm.
|-
| 12
| Indicates that the battery is low
|-
| 13
| Indicates that entry delay is off (ARMED INSTANT/MAX)
|-
| 14
| Indicates that there is a fire
|-
| 15
| Indicates a system issue
|-
| 16
| Indicates that the panel is only watching the perimeter (ARMED STAY/NIGHT)
|-
| 17
| Unused
|-
| 18
| Unused
|-
| 19
| Unused
|-
| 20
| Unused
|-
|}

====Numeric Code====
This number specifies which zone is affected by the message. For example, if this message is for CHECK ZONE 22 then the numeric code would be 022. Most of the time this is zero-padded base10, but there are rare occurrences where this may be base16, such as ECP bus failures.

====Raw data====
This is the binary data associated with the message. It includes all of the bit field entries that were separated out for you in the first field, as well as the rest of the message for debugging and exploratory purposes.

There is one important piece of data included only in this field: the keypad address mask. The four bytes starting at position 2 (zero-indexed) indicate which keypads this message is intended for.

Inside this mask each bit represents a specific keypad. Each byte represents a group of eight keypad addresses, which the least-significant-bit being the start of the range.

{| class="wikitable" border="1"
! scope="col" | Byte
! scope="col" | Addresses
|-
| 1
| 0-7
|-
| 2
| 8-15
|-
| 3
| 16-23
|-
| 4
| 24-31
|}

For example:
* f70700060010808c08020000 - our keypad address mask is 07000600.

Using the above mask example of 07000600 we find that this message was destined for keypads 0, 1, 2, 17 and 18.

There is one special case: system messages will have no address mask bits set and are intended for common keypads or monitoring multiple zones.

For the most part the address mask details only become really important when you're working with a setup that has multiple partitions since the AlarmDecoder will see all messages by default.

====Alphanumeric Keypad Message====
This section is the data that would be displayed on your keypad's screen.

==Zone Expander==
If you have one or more zone expanders connected to the alarm panel you will be able to see messages from the expanders as zones are faulted and restored. On DSC panels all zones are expressed as EXP messages.
===Examples===
Example of zone expander at address 7, channel 1 faulting and then restoring:
<pre>
!EXP:07,01,01
!EXP:07,01,00
</pre>

===Format===
{| class="wikitable" border="1"
|+ !EXP Format
| colspan="4" align="center" style="background-color: #DEDEDE; font-weight: bold" | !EXP:07,01,01
|-
| colspan="4" |  
|-
! scope="col" width="80px" style="color: #F56464" | Header
! scope="col" width="160px" style="color: #8C8CF5" | Zone Expander Address
! scope="col" width="140px" style="color: #70BA66" | Expander Channel
! scope="col" width="100px" style="color: #804580" | Data
|-
| align="center" | !EXP
| align="center" | 07
| align="center" | 01
| align="center" | 01
|-
|}

====Zone Expander Address====
This is the address that the zone expander occupies.

====Expander Channel====
This is the channel generating the message.

====Data====
00 and 01 indicate that the zone is restored and faulted, respectively.

==Relay Expander==
If you have one or more relay expanders connected to your alarm panel you will be able to see messages when the relays are opened or closed.

===Examples===
Examples of a relay expander at address 12, relay #1 closing and then opening:
<pre>
!REL:12,01,01
!REL:12,01,00
</pre>

===Format===
{| class="wikitable" border="1"
|+ !REL Format
| colspan="4" align="center" style="background-color: #DEDEDE; font-weight: bold" | !REL:12,01,01
|-
| colspan="4" |  
|-
! scope="col" width="80px" style="color: #F56464" | Header
! scope="col" width="160px" style="color: #8C8CF5" | Relay Expander Address
! scope="col" width="140px" style="color: #70BA66" | Expander Channel
! scope="col" width="100px" style="color: #804580" | Data
|-
| align="center" | !REL
| align="center" | 12
| align="center" | 01
| align="center" | 01
|-
|}

====Relay Expander Address====
This is the address that the relay expander occupies.

====Expander Channel====
This is the channel generating the message.

====Data====
00 and 01 indicate that the relay is opened and closed, respectively.

==RFX==
If you have an RF receiver attached to your panel you will see messages from any 5800 RF device in range of the receiver, regardless of whether or not the panel was configured to listen to it.

This also functions when the system is ARMED STAY. Normally you won't see fault messages for interior zones when armed this way so you lose visibility of interior motion sensors. One option is to put the interior sensors on a separate partition so you still see the inside zones and the outside sensors are on their own. The other option is to listen to the !RFX messages directly which could then be used to tell your home automation system that the zones are faulted.

===Examples===
Example of a 5800Micra sensor faulting and restoring:
<pre>
!RFX:0180036,80
!RFX:0180036,00
</pre>

Example of a 5804 keyfob pressing the loop #2 button and having a low battery:
<pre>
!RFX:0307854,22
</pre>

===Format===
{| class="wikitable" border="1"
|+ !RFX Format
| colspan="4" align="center" style="background-color: #DEDEDE; font-weight: bold" | !RFX:0180036,80
|-
| colspan="4" |  
|-
! scope="col" width="80px" style="color: #F56464" | Header
! scope="col" width="100px" style="color: #8C8CF5" | Serial Number
! scope="col" width="100px" style="color: #70BA66" | Data
|-
| align="center" | !RFX
| align="center" | 0180036
| align="center" | 80
|-
|}

====Serial Number====
This is the 7-digit serial number of the device the message originated from.

====Data====
The data is an 8-bit hex message with several indicators. Please refer to the '''5800 SERIES TRANSMITTER INPUT LOOP IDENTIFICATION''' section of your programming manual for what the loops relate to for your specific device.

{| class="wikitable" border="1"
|+ RFX Data Format
|-
! scope="col" | Bit
! scope="col" | Description
|-
| align="center" | 1
| Unknown - Seems that the loop indicators should be ignored if set.
|-
| align="center" | 2
| Low battery indication
|-
| align="center" | 3
| Supervision required indication
|-
| align="center" | 4
| Unknown
|-
| align="center" | 5
| Loop #3 indication
|-
| align="center" | 6
| Loop #2 indication
|-
| align="center" | 7
| Loop #4 indication
|-
| align="center" | 8
| Loop #1 indication
|}

==LRR==
If you have a Long Range Radio device attached or have emulation enabled the AlarmDecoder will report LRR messages from the panel to the radio.

===Examples===
This example shows User 12 arming and disarming the system:
<pre>
!LRR:012,1,ARM_STAY
!LRR:012,1,ARM_AWAY
!LRR:012,1,OPEN
!LRR:003,1,BYPASS
</pre>

===Format===
{| class="wikitable" border="1"
|+ !LRR Format
| colspan="4" align="center" style="background-color: #DEDEDE; font-weight: bold" | !LRR:012,1,ARM_STAY
|-
| colspan="4" |  
|-
! scope="col" width="80px" style="color: #F56464" | Header
! scope="col" width="100px" style="color: #8C8CF5" | Event Data
! scope="col" width="80px" style="color: #70BA66" | Partition
! scope="col" width="100px" style="color: #804580" | Event Type
|-
| align="center" | !LRR
| align="center" | 012
| align="center" | 1
| align="center" | ARM_STAY
|-
|}

====Event Data====
This is either the user number of the person performing the action or the zone that was bypassed.

====Partition====
The panel partition the event applies to. Partition 0 indicates that it's destined for all partitions.

====Event Type====
This is the type of the LRR event. See below for a description and what (if any) programming fields are required for activation.

{| class="wikitable" border="1"
|+ LRR Event Types
! scope="col" | Name
! scope="col" | Program Fields
! scope="col" | Description
|-
| ALARM_EXIT_ERROR
| *59
| Indicates an error when a zone is not closed during arming
|-
| TROUBLE
| *60
| Indicates that a zone is reporting a tamper or failure
|-
| BYPASS
| *61
| Indicates that a zone has been bypassed
|-
| ACLOSS
| *62
| Indicates that AC power was lost
|-
| LOWBAT
| *63
| Low battery indication
|-
| TEST_CALL
| *64
| Indicates a phone test when in testing mode
|-
| OPEN
| *65, requires *66
| Indicates that the alarm is disarmed
|-
| ARM_AWAY
| *66
| Indicates that the system was armed AWAY
|-
| ARM_STAY
| *66
| Indicates that the system was armed STAY
|-
| RFLOWBAT
| *67
| Low battery indication for the RF transmitter
|-
| CANCEL
| *68
| Indicates that the alarm was canceled after second disarm
|-
| RESTORE
| *70
| Indicates that the alarm was restored
|-
| TROUBLE_RESTORE
| *71
| Indicates that the trouble event was restored
|-
| BYPASS_RESTORE
| *72
| Indicates that the bypassed zonew as restored
|-
| AC_RESTORE
| *73
| Indicates that AC power was restored
|-
| LOWBAT_RESTORE
| *74
| Indicates that the low battery has been restored
|-
| RFLOWBAT_RESTORE
| *75
| Indicates that the low battery on the RF transmitter has been restored.
|-
| TEST_RESTORE
| *76
| Indicates that a zone was restored in testing mode
|-
| ALARM_PANIC
|
| Indicates that there is a panic
|-
| ALARM_FIRE
|
| Indicates that there is a fire
|-
| ALARM_ENTRY
|
| Indicates that there was an entry alarm
|-
| ALARM_AUX
|
| Indicates that an auxiliary alarm type was triggered
|-
| ALARM_AUDIBLE
|
| Indicates that an audible alarm is in progress
|-
| ALARM_SILENT
|
| Indicates that there was a silent alarm
|-
| ALARM_PERIMETER
|
| Indicates that there was a perimeter alarm
|}

==AUI==
AUI messages are generated for "Advanced User Interface" keypads. These include a lot of extra data than what's destined for regular keypads.

===Format===
{| class="wikitable" border="1"
|+ !AUI Format
| colspan="4" align="center" style="background-color: #DEDEDE; font-weight: bold" | !AUI:126600000000656c02456cf5ec01017f0002
|-
| colspan="4" |  
|-
! scope="col" width="80px" style="color: #F56464" | Header
! scope="col" width="100px" style="color: #8C8CF5" | AUI Data
|-
| align="center" | !AUI
| align="center" | 126600000000656c02456cf5ec01017f0002
|-
|}

====AUI Data====
This is a large binary blob that's destined for a graphical panel. This data has not been fully decoded. Please see the [[AUI|AUI]] page for information on what has been discovered so far.

==Keypress Events==
Keypress events are generated when keys are pressed on a keypad and can be enabled inside [[#CONFIGBITS|CONFIGBITS]].

===Format===
{| class="wikitable" border="1"
|+ !KPE Format
| colspan="4" align="center" style="background-color: #DEDEDE; font-weight: bold" | !KPE:18
|-
| colspan="4" |  
|-
! scope="col" width="80px" style="color: #F56464" | Header
! scope="col" width="100px" style="color: #8C8CF5" | Keypad Address
|-
| align="center" | !KPE
| align="center" | 18
|-
|}

==Error message report==
Error message reports will be sent to the host when the command 'E' is sent to the AD2*. The list will contain 0 if no errors are recorded and a list of errors separated by commas if errors are recorded. Once an error is reported it will be cleared from the history. The errors from left to right are in order of occurrence. As many as 10 errors can be stored before the oldest is removed from the list.

===Format===
{| class="wikitable" border="1"
|+ !ERR Format
| colspan="4" align="center" style="background-color: #DEDEDE; font-weight: bold" | !ERR:0
|-
| colspan="4" |  
|-
! scope="col" width="80px" style="color: #F56464" | Header
! scope="col" width="100px" style="color: #8C8CF5" | Error list
|-
| align="center" | !ERR
| align="center" | 1,1,1
|-
|}

====Keypad Address====
This is the address of the keypad that generated the event.

=Device Feedback LED=
* Boot flash mode
** During boot the AD2* will rapid flash during the boot loader.
* Operating mode
** The normal operating mode is a steady of approx 2.5 flashes per second.
* Error mode
** If an error is recorded the AD2* will flash the error message as steady slow flashes to be counted with a long period of the LED off between flashes. after a few minutes the led will return to normal idle flash mode if no further errors happen.

Protocol

2015-09-08T19:19:55Z

204.10.16.29: /* Message Types */

[[Category:FAQ]]
[[Category:Documentation]]
[[Category:Specifications]]
[[Category:Features]]

=Commands=
{| 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
|}

==Reboot==
Rebooting the device is as simple as sending = to it.

During the boot process you can trigger a firmware upload by sending a second = to the device after the !boot message is received. At this point you'll receive a !load and can begin uploading.

==Zone Emulation==
Zone Expander Emulation allows the AlarmDecoder to act in place of a physical expander board and make use of virtual zones with your panel. After enabling it on both the panel and the AlarmDecoder you can begin opening and closing zones, which will be relayed back to the panel.

The L command can be used to open or close zones. There are two parameters: the zone and the state. The zone is a zero-padded two-digit number and the state is either 0 or 1.

Example - open zone 12:
* L121\r

Example - close zone 12:
* L120\r

==Function Keys==
The specialty function keys are identified by ASCII character codes 1 through 4. In order to prevent false positives these must be sent three times in a row.

{| class="wikitable" border="1"
|+ Function Key Codes
! scope="col" | Code
! scope="col" | Description
|-
| \x01\x01\x01
| Function Key #1
|-
| \x02\x02\x02
| Function Key #2
|-
| \x03\x03\x03
| Function Key #3
|-
| \x04\x04\x04
| Function Key #4
|}

----

=Device Configuration=
The AlarmDecoder configuration can be viewed or modified in one of two ways: [[#Prompted|prompted]] or [[#Programatic|programmatically]].

==Prompted==
If you send ! followed by a carriage return you will be prompted to configure 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 provide a new one.

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>

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

Retrieving 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

===Configuration Parameters===
{| class="wikitable" border="1"
! scope="col" | Name
! scope="col" | Default Value
! scope="col" | Valid Values (Regex)
! scope="col" | Description
|-
| align="left" | ADDRESS
| align="left" | 18
| align="left" | [0-9]{2}
| align="left" | Keypad address assigned to the AlarmDecoder.
|-
| align="left" | CONFIGBITS
| align="left" | FF00
| align="left" | [0-9a-f]{4}
| align="left" | Special settings for the device. See [[#CONFIGBITS|CONFIGBITS]] for more information.
|-
| align="left" | MASK
| align="left" | FFFFFFFF
| align="left" | [0-9a-f]{8}
| align="left" | Address mask used to filter for keypad alphanumeric messages.
|-
| align="left" | EXP
| align="left" | NNNNN
| align="left" | [YN]{5}
| align="left" | Emulation of zone expanders 1-5
|-
| align="left" | REL
| align="left" | NNNN
| align="left" | [YN]{4}
| align="left" | Emulation of relay expanders 1-4
|-
| align="left" | LRR
| align="left" | N
| align="left" | [YN]
| align="left" | Emulation of Long Range Radio expander
|-
| align="left" | DEDUPLICATE
| align="left" | N
| align="left" | [YN]
| align="left" | If enabled, removes duplicate alphanumeric keypad messages.
|-
|}

====CONFIGBITS====
CONFIGBITS is a setting that's used to enable special functionality on the AlarmDecoder. You can enable these by masking the correct bits.

{| class="wikitable" border="1"
|+ CONFIGBITS Definition
! scope="col" | Mask
! scope="col" | Description
|-
| align="left" | 0x0001
| align="left" | Enable reporting of [[#AUI|AUI]] messages.
|-
| align="left" | 0x0002
| align="left" | Enable reporting of [[#Keypress Events|keypress events]].
|-
| align="left" | 0x0004
| align="left" | Disable prompts for L and | commands.
|-
| align="left" | 0x0008
| align="left" | Enable the prefixing of panel messages with !KMP.
|-
| align="left" | 0x0100
| align="left" | Enable reporting of [[#RFX|RFX]] messages.
|}

----

=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]].

* All lines starting with ! are informational.
* Lines that start with !> are prompts.
* All other lines are panel data in the form of a [[#Keypad|Keypad message]].

==Keypad==
Keypad messages are by far the most common message type produced by the AlarmDecoder. These messages also have an optional header that can be enabled in the [[#CONFIGBITS|CONFIGBITS]]. This setting prefixes all keypad messages with !KPM:.

===Format===
{| class="wikitable" border="1"
|+ Keypad Format
| colspan="4" align="center" style="background-color: #DEDEDE; font-weight: bold" | [001000010000--------],010,[f70700060010808c08020000],"ARMED ***STAY** ZONE BYPASSED "
|-
| colspan="4" |  
|-
! scope="col" width="160px" style="color: #F56464" | Bit field
! scope="col" width="100px" style="color: #8C8CF5" | Numeric code
! scope="col" width="200px" style="color: #70BA66" | Raw data
! scope="col" width="220px" style="color: #804580" | Alphanumeric Keypad Message
|-
| align="center" | [001000010000--------]
| align="center" | 010
| align="center" | [f70700060010808c08020000]
| align="center" | "ARMED ***STAY** ZONE BYPASSED "
|-
|}

====Bit field====
The bit field present on the keypad messages is where you're going to get most of the information on your alarm system's current state. These are all represented by a zero or one aside from the one exception. (beep)

{| class="wikitable" border="1"
! scope="col" | Position
! scope="col" | Description
|-
| 1
| Indicates if the panel is READY
|-
| 2
| Indicates if the panel is ARMED AWAY
|-
| 3
| Indicates if the panel is ARMED HOME
|-
| 4
| Indicates if the keypad backlight is on
|-
| 5
| Indicates if the keypad is in programming mode
|-
| 6
| Number (1-7) indicating how many beeps are associated with the message
|-
| 7
| Indicates that a zone has been bypassed
|-
| 8
| Indicates if the panel is on AC power
|-
| 9
| Indicates if the chime is enabled
|-
| 10
| Indicates that an alarm has occurred. This is sticky and will be cleared after a second disarm.
|-
| 11
| Indicates that an alarm is currently sounding. This is cleared after the first disarm.
|-
| 12
| Indicates that the battery is low
|-
| 13
| Indicates that entry delay is off (ARMED INSTANT/MAX)
|-
| 14
| Indicates that there is a fire
|-
| 15
| Indicates a system issue
|-
| 16
| Indicates that the panel is only watching the perimeter (ARMED STAY/NIGHT)
|-
| 17
| Unused
|-
| 18
| Unused
|-
| 19
| Unused
|-
| 20
| Unused
|-
|}

====Numeric Code====
This number specifies which zone is affected by the message. For example, if this message is for CHECK ZONE 22 then the numeric code would be 022. Most of the time this is zero-padded base10, but there are rare occurrences where this may be base16, such as ECP bus failures.

====Raw data====
This is the binary data associated with the message. It includes all of the bit field entries that were separated out for you in the first field, as well as the rest of the message for debugging and exploratory purposes.

There is one important piece of data included only in this field: the keypad address mask. The four bytes starting at position 2 (zero-indexed) indicate which keypads this message is intended for.

Inside this mask each bit represents a specific keypad. Each byte represents a group of eight keypad addresses, which the least-significant-bit being the start of the range.

{| class="wikitable" border="1"
! scope="col" | Byte
! scope="col" | Addresses
|-
| 1
| 0-7
|-
| 2
| 8-15
|-
| 3
| 16-23
|-
| 4
| 24-31
|}

For example:
* f70700060010808c08020000 - our keypad address mask is 07000600.

Using the above mask example of 07000600 we find that this message was destined for keypads 0, 1, 2, 17 and 18.

There is one special case: system messages will have no address mask bits set and are intended for common keypads or monitoring multiple zones.

For the most part the address mask details only become really important when you're working with a setup that has multiple partitions since the AlarmDecoder will see all messages by default.

====Alphanumeric Keypad Message====
This section is the data that would be displayed on your keypad's screen.

==Zone Expander==
If you have one or more zone expanders connected to the alarm panel you will be able to see messages from the expanders as zones are faulted and restored. On DSC panels all zones are expressed as EXP messages.
===Examples===
Example of zone expander at address 7, channel 1 faulting and then restoring:
<pre>
!EXP:07,01,01
!EXP:07,01,00
</pre>

===Format===
{| class="wikitable" border="1"
|+ !EXP Format
| colspan="4" align="center" style="background-color: #DEDEDE; font-weight: bold" | !EXP:07,01,01
|-
| colspan="4" |  
|-
! scope="col" width="80px" style="color: #F56464" | Header
! scope="col" width="160px" style="color: #8C8CF5" | Zone Expander Address
! scope="col" width="140px" style="color: #70BA66" | Expander Channel
! scope="col" width="100px" style="color: #804580" | Data
|-
| align="center" | !EXP
| align="center" | 07
| align="center" | 01
| align="center" | 01
|-
|}

====Zone Expander Address====
This is the address that the zone expander occupies.

====Expander Channel====
This is the channel generating the message.

====Data====
00 and 01 indicate that the zone is restored and faulted, respectively.

==Relay Expander==
If you have one or more relay expanders connected to your alarm panel you will be able to see messages when the relays are opened or closed.

===Examples===
Examples of a relay expander at address 12, relay #1 closing and then opening:
<pre>
!REL:12,01,01
!REL:12,01,00
</pre>

===Format===
{| class="wikitable" border="1"
|+ !REL Format
| colspan="4" align="center" style="background-color: #DEDEDE; font-weight: bold" | !REL:12,01,01
|-
| colspan="4" |  
|-
! scope="col" width="80px" style="color: #F56464" | Header
! scope="col" width="160px" style="color: #8C8CF5" | Relay Expander Address
! scope="col" width="140px" style="color: #70BA66" | Expander Channel
! scope="col" width="100px" style="color: #804580" | Data
|-
| align="center" | !REL
| align="center" | 12
| align="center" | 01
| align="center" | 01
|-
|}

====Relay Expander Address====
This is the address that the relay expander occupies.

====Expander Channel====
This is the channel generating the message.

====Data====
00 and 01 indicate that the relay is opened and closed, respectively.

==RFX==
If you have an RF receiver attached to your panel you will see messages from any 5800 RF device in range of the receiver, regardless of whether or not the panel was configured to listen to it.

This also functions when the system is ARMED STAY. Normally you won't see fault messages for interior zones when armed this way so you lose visibility of interior motion sensors. One option is to put the interior sensors on a separate partition so you still see the inside zones and the outside sensors are on their own. The other option is to listen to the !RFX messages directly which could then be used to tell your home automation system that the zones are faulted.

===Examples===
Example of a 5800Micra sensor faulting and restoring:
<pre>
!RFX:0180036,80
!RFX:0180036,00
</pre>

Example of a 5804 keyfob pressing the loop #2 button and having a low battery:
<pre>
!RFX:0307854,22
</pre>

===Format===
{| class="wikitable" border="1"
|+ !RFX Format
| colspan="4" align="center" style="background-color: #DEDEDE; font-weight: bold" | !RFX:0180036,80
|-
| colspan="4" |  
|-
! scope="col" width="80px" style="color: #F56464" | Header
! scope="col" width="100px" style="color: #8C8CF5" | Serial Number
! scope="col" width="100px" style="color: #70BA66" | Data
|-
| align="center" | !RFX
| align="center" | 0180036
| align="center" | 80
|-
|}

====Serial Number====
This is the 7-digit serial number of the device the message originated from.

====Data====
The data is an 8-bit hex message with several indicators. Please refer to the '''5800 SERIES TRANSMITTER INPUT LOOP IDENTIFICATION''' section of your programming manual for what the loops relate to for your specific device.

{| class="wikitable" border="1"
|+ RFX Data Format
|-
! scope="col" | Bit
! scope="col" | Description
|-
| align="center" | 1
| Unknown - Seems that the loop indicators should be ignored if set.
|-
| align="center" | 2
| Low battery indication
|-
| align="center" | 3
| Supervision required indication
|-
| align="center" | 4
| Unknown
|-
| align="center" | 5
| Loop #3 indication
|-
| align="center" | 6
| Loop #2 indication
|-
| align="center" | 7
| Loop #4 indication
|-
| align="center" | 8
| Loop #1 indication
|}

==LRR==
If you have a Long Range Radio device attached or have emulation enabled the AlarmDecoder will report LRR messages from the panel to the radio.

===Examples===
This example shows User 12 arming and disarming the system:
<pre>
!LRR:012,1,ARM_STAY
!LRR:012,1,ARM_AWAY
!LRR:012,1,OPEN
!LRR:003,1,BYPASS
</pre>

===Format===
{| class="wikitable" border="1"
|+ !LRR Format
| colspan="4" align="center" style="background-color: #DEDEDE; font-weight: bold" | !LRR:012,1,ARM_STAY
|-
| colspan="4" |  
|-
! scope="col" width="80px" style="color: #F56464" | Header
! scope="col" width="100px" style="color: #8C8CF5" | Event Data
! scope="col" width="80px" style="color: #70BA66" | Partition
! scope="col" width="100px" style="color: #804580" | Event Type
|-
| align="center" | !LRR
| align="center" | 012
| align="center" | 1
| align="center" | ARM_STAY
|-
|}

====Event Data====
This is either the user number of the person performing the action or the zone that was bypassed.

====Partition====
The panel partition the event applies to. Partition 0 indicates that it's destined for all partitions.

====Event Type====
This is the type of the LRR event. See below for a description and what (if any) programming fields are required for activation.

{| class="wikitable" border="1"
|+ LRR Event Types
! scope="col" | Name
! scope="col" | Program Fields
! scope="col" | Description
|-
| ALARM_EXIT_ERROR
| *59
| Indicates an error when a zone is not closed during arming
|-
| TROUBLE
| *60
| Indicates that a zone is reporting a tamper or failure
|-
| BYPASS
| *61
| Indicates that a zone has been bypassed
|-
| ACLOSS
| *62
| Indicates that AC power was lost
|-
| LOWBAT
| *63
| Low battery indication
|-
| TEST_CALL
| *64
| Indicates a phone test when in testing mode
|-
| OPEN
| *65, requires *66
| Indicates that the alarm is disarmed
|-
| ARM_AWAY
| *66
| Indicates that the system was armed AWAY
|-
| ARM_STAY
| *66
| Indicates that the system was armed STAY
|-
| RFLOWBAT
| *67
| Low battery indication for the RF transmitter
|-
| CANCEL
| *68
| Indicates that the alarm was canceled after second disarm
|-
| RESTORE
| *70
| Indicates that the alarm was restored
|-
| TROUBLE_RESTORE
| *71
| Indicates that the trouble event was restored
|-
| BYPASS_RESTORE
| *72
| Indicates that the bypassed zonew as restored
|-
| AC_RESTORE
| *73
| Indicates that AC power was restored
|-
| LOWBAT_RESTORE
| *74
| Indicates that the low battery has been restored
|-
| RFLOWBAT_RESTORE
| *75
| Indicates that the low battery on the RF transmitter has been restored.
|-
| TEST_RESTORE
| *76
| Indicates that a zone was restored in testing mode
|-
| ALARM_PANIC
|
| Indicates that there is a panic
|-
| ALARM_FIRE
|
| Indicates that there is a fire
|-
| ALARM_ENTRY
|
| Indicates that there was an entry alarm
|-
| ALARM_AUX
|
| Indicates that an auxiliary alarm type was triggered
|-
| ALARM_AUDIBLE
|
| Indicates that an audible alarm is in progress
|-
| ALARM_SILENT
|
| Indicates that there was a silent alarm
|-
| ALARM_PERIMETER
|
| Indicates that there was a perimeter alarm
|}

==AUI==
AUI messages are generated for "Advanced User Interface" keypads. These include a lot of extra data than what's destined for regular keypads.

===Format===
{| class="wikitable" border="1"
|+ !AUI Format
| colspan="4" align="center" style="background-color: #DEDEDE; font-weight: bold" | !AUI:126600000000656c02456cf5ec01017f0002
|-
| colspan="4" |  
|-
! scope="col" width="80px" style="color: #F56464" | Header
! scope="col" width="100px" style="color: #8C8CF5" | AUI Data
|-
| align="center" | !AUI
| align="center" | 126600000000656c02456cf5ec01017f0002
|-
|}

====AUI Data====
This is a large binary blob that's destined for a graphical panel. This data has not been fully decoded. Please see the [[AUI|AUI]] page for information on what has been discovered so far.

==Keypress Events==
Keypress events are generated when keys are pressed on a keypad and can be enabled inside [[#CONFIGBITS|CONFIGBITS]].

===Format===
{| class="wikitable" border="1"
|+ !KPE Format
| colspan="4" align="center" style="background-color: #DEDEDE; font-weight: bold" | !KPE:18
|-
| colspan="4" |  
|-
! scope="col" width="80px" style="color: #F56464" | Header
! scope="col" width="100px" style="color: #8C8CF5" | Keypad Address
|-
| align="center" | !KPE
| align="center" | 18
|-
|}

==Error message report==
Error message reports will be sent to the host when the command 'E' is sent to the AD2*. The list will contain 0 if no errors are recorded and a list of errors separated by commas if errors are recorded. Once an error is reported it will be cleared from the history. The errors from left to right are in order of occurrence. As many as 10 errors can be stored before the oldest is removed from the list.

===Format===
{| class="wikitable" border="1"
|+ !ERR Format
| colspan="4" align="center" style="background-color: #DEDEDE; font-weight: bold" | !ERR:0
|-
| colspan="4" |  
|-
! scope="col" width="80px" style="color: #F56464" | Header
! scope="col" width="100px" style="color: #8C8CF5" | Error list
|-
| align="center" | !ERR
| align="center" | 1,1,1
|-
|}

====Keypad Address====
This is the address of the keypad that generated the event.

=Device Feedback LED=
* Boot flash mode
** During boot the AD2* will rapid flash during the boot loader.
* Operating mode
** The normal operating mode is a steady of approx 2.5 flashes per second.
* Error mode
** If an error is recorded the AD2* will flash the error message as steady slow flashes to be counted with a long period of the LED off between flashes. after a few minutes the led will return to normal idle flash mode if no further errors happen.

Protocol

2015-09-08T19:12:29Z

204.10.16.29: /* Message Types */

[[Category:FAQ]]
[[Category:Documentation]]
[[Category:Specifications]]
[[Category:Features]]

=Commands=
{| 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
|}

==Reboot==
Rebooting the device is as simple as sending = to it.

During the boot process you can trigger a firmware upload by sending a second = to the device after the !boot message is received. At this point you'll receive a !load and can begin uploading.

==Zone Emulation==
Zone Expander Emulation allows the AlarmDecoder to act in place of a physical expander board and make use of virtual zones with your panel. After enabling it on both the panel and the AlarmDecoder you can begin opening and closing zones, which will be relayed back to the panel.

The L command can be used to open or close zones. There are two parameters: the zone and the state. The zone is a zero-padded two-digit number and the state is either 0 or 1.

Example - open zone 12:
* L121\r

Example - close zone 12:
* L120\r

==Function Keys==
The specialty function keys are identified by ASCII character codes 1 through 4. In order to prevent false positives these must be sent three times in a row.

{| class="wikitable" border="1"
|+ Function Key Codes
! scope="col" | Code
! scope="col" | Description
|-
| \x01\x01\x01
| Function Key #1
|-
| \x02\x02\x02
| Function Key #2
|-
| \x03\x03\x03
| Function Key #3
|-
| \x04\x04\x04
| Function Key #4
|}

----

=Device Configuration=
The AlarmDecoder configuration can be viewed or modified in one of two ways: [[#Prompted|prompted]] or [[#Programatic|programmatically]].

==Prompted==
If you send ! followed by a carriage return you will be prompted to configure 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 provide a new one.

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>

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

Retrieving 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

===Configuration Parameters===
{| class="wikitable" border="1"
! scope="col" | Name
! scope="col" | Default Value
! scope="col" | Valid Values (Regex)
! scope="col" | Description
|-
| align="left" | ADDRESS
| align="left" | 18
| align="left" | [0-9]{2}
| align="left" | Keypad address assigned to the AlarmDecoder.
|-
| align="left" | CONFIGBITS
| align="left" | FF00
| align="left" | [0-9a-f]{4}
| align="left" | Special settings for the device. See [[#CONFIGBITS|CONFIGBITS]] for more information.
|-
| align="left" | MASK
| align="left" | FFFFFFFF
| align="left" | [0-9a-f]{8}
| align="left" | Address mask used to filter for keypad alphanumeric messages.
|-
| align="left" | EXP
| align="left" | NNNNN
| align="left" | [YN]{5}
| align="left" | Emulation of zone expanders 1-5
|-
| align="left" | REL
| align="left" | NNNN
| align="left" | [YN]{4}
| align="left" | Emulation of relay expanders 1-4
|-
| align="left" | LRR
| align="left" | N
| align="left" | [YN]
| align="left" | Emulation of Long Range Radio expander
|-
| align="left" | DEDUPLICATE
| align="left" | N
| align="left" | [YN]
| align="left" | If enabled, removes duplicate alphanumeric keypad messages.
|-
|}

====CONFIGBITS====
CONFIGBITS is a setting that's used to enable special functionality on the AlarmDecoder. You can enable these by masking the correct bits.

{| class="wikitable" border="1"
|+ CONFIGBITS Definition
! scope="col" | Mask
! scope="col" | Description
|-
| align="left" | 0x0001
| align="left" | Enable reporting of [[#AUI|AUI]] messages.
|-
| align="left" | 0x0002
| align="left" | Enable reporting of [[#Keypress Events|keypress events]].
|-
| align="left" | 0x0004
| align="left" | Disable prompts for L and | commands.
|-
| align="left" | 0x0008
| align="left" | Enable the prefixing of panel messages with !KMP.
|-
| align="left" | 0x0100
| align="left" | Enable reporting of [[#RFX|RFX]] messages.
|}

----

=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]].

* All lines starting with ! are informational.
* Lines that start with !> are prompts.
* All other lines are panel data in the form of a [[#Keypad|Keypad message]].

==Keypad==
Keypad messages are by far the most common message type produced by the AlarmDecoder. These messages also have an optional header that can be enabled in the [[#CONFIGBITS|CONFIGBITS]]. This setting prefixes all keypad messages with !KPM:.

===Format===
{| class="wikitable" border="1"
|+ Keypad Format
| colspan="4" align="center" style="background-color: #DEDEDE; font-weight: bold" | [001000010000--------],010,[f70700060010808c08020000],"ARMED ***STAY** ZONE BYPASSED "
|-
| colspan="4" |  
|-
! scope="col" width="160px" style="color: #F56464" | Bit field
! scope="col" width="100px" style="color: #8C8CF5" | Numeric code
! scope="col" width="200px" style="color: #70BA66" | Raw data
! scope="col" width="220px" style="color: #804580" | Alphanumeric Keypad Message
|-
| align="center" | [001000010000--------]
| align="center" | 010
| align="center" | [f70700060010808c08020000]
| align="center" | "ARMED ***STAY** ZONE BYPASSED "
|-
|}

====Bit field====
The bit field present on the keypad messages is where you're going to get most of the information on your alarm system's current state. These are all represented by a zero or one aside from the one exception. (beep)

{| class="wikitable" border="1"
! scope="col" | Position
! scope="col" | Description
|-
| 1
| Indicates if the panel is READY
|-
| 2
| Indicates if the panel is ARMED AWAY
|-
| 3
| Indicates if the panel is ARMED HOME
|-
| 4
| Indicates if the keypad backlight is on
|-
| 5
| Indicates if the keypad is in programming mode
|-
| 6
| Number (1-7) indicating how many beeps are associated with the message
|-
| 7
| Indicates that a zone has been bypassed
|-
| 8
| Indicates if the panel is on AC power
|-
| 9
| Indicates if the chime is enabled
|-
| 10
| Indicates that an alarm has occurred. This is sticky and will be cleared after a second disarm.
|-
| 11
| Indicates that an alarm is currently sounding. This is cleared after the first disarm.
|-
| 12
| Indicates that the battery is low
|-
| 13
| Indicates that entry delay is off (ARMED INSTANT/MAX)
|-
| 14
| Indicates that there is a fire
|-
| 15
| Indicates a system issue
|-
| 16
| Indicates that the panel is only watching the perimeter (ARMED STAY/NIGHT)
|-
| 17
| Unused
|-
| 18
| Unused
|-
| 19
| Unused
|-
| 20
| Unused
|-
|}

====Numeric Code====
This number specifies which zone is affected by the message. For example, if this message is for CHECK ZONE 22 then the numeric code would be 022. Most of the time this is zero-padded base10, but there are rare occurrences where this may be base16, such as ECP bus failures.

====Raw data====
This is the binary data associated with the message. It includes all of the bit field entries that were separated out for you in the first field, as well as the rest of the message for debugging and exploratory purposes.

There is one important piece of data included only in this field: the keypad address mask. The four bytes starting at position 2 (zero-indexed) indicate which keypads this message is intended for.

Inside this mask each bit represents a specific keypad. Each byte represents a group of eight keypad addresses, which the least-significant-bit being the start of the range.

{| class="wikitable" border="1"
! scope="col" | Byte
! scope="col" | Addresses
|-
| 1
| 0-7
|-
| 2
| 8-15
|-
| 3
| 16-23
|-
| 4
| 24-31
|}

For example:
* f70700060010808c08020000 - our keypad address mask is 07000600.

Using the above mask example of 07000600 we find that this message was destined for keypads 0, 1, 2, 17 and 18.

There is one special case: system messages will have no address mask bits set and are intended for common keypads or monitoring multiple zones.

For the most part the address mask details only become really important when you're working with a setup that has multiple partitions since the AlarmDecoder will see all messages by default.

====Alphanumeric Keypad Message====
This section is the data that would be displayed on your keypad's screen.

==Zone Expander==
If you have one or more zone expanders connected to the alarm panel you will be able to see messages from the expanders as zones are faulted and restored. On DSC panels all zones are expressed as EXP messages.
===Examples===
Example of zone expander at address 7, channel 1 faulting and then restoring:
<pre>
!EXP:07,01,01
!EXP:07,01,00
</pre>

===Format===
{| class="wikitable" border="1"
|+ !EXP Format
| colspan="4" align="center" style="background-color: #DEDEDE; font-weight: bold" | !EXP:07,01,01
|-
| colspan="4" |  
|-
! scope="col" width="80px" style="color: #F56464" | Header
! scope="col" width="160px" style="color: #8C8CF5" | Zone Expander Address
! scope="col" width="140px" style="color: #70BA66" | Expander Channel
! scope="col" width="100px" style="color: #804580" | Data
|-
| align="center" | !EXP
| align="center" | 07
| align="center" | 01
| align="center" | 01
|-
|}

====Zone Expander Address====
This is the address that the zone expander occupies.

====Expander Channel====
This is the channel generating the message.

====Data====
00 and 01 indicate that the zone is restored and faulted, respectively.

==Relay Expander==
If you have one or more relay expanders connected to your alarm panel you will be able to see messages when the relays are opened or closed.

===Examples===
Examples of a relay expander at address 12, relay #1 closing and then opening:
<pre>
!REL:12,01,01
!REL:12,01,00
</pre>

===Format===
{| class="wikitable" border="1"
|+ !REL Format
| colspan="4" align="center" style="background-color: #DEDEDE; font-weight: bold" | !REL:12,01,01
|-
| colspan="4" |  
|-
! scope="col" width="80px" style="color: #F56464" | Header
! scope="col" width="160px" style="color: #8C8CF5" | Relay Expander Address
! scope="col" width="140px" style="color: #70BA66" | Expander Channel
! scope="col" width="100px" style="color: #804580" | Data
|-
| align="center" | !REL
| align="center" | 12
| align="center" | 01
| align="center" | 01
|-
|}

====Relay Expander Address====
This is the address that the relay expander occupies.

====Expander Channel====
This is the channel generating the message.

====Data====
00 and 01 indicate that the relay is opened and closed, respectively.

==RFX==
If you have an RF receiver attached to your panel you will see messages from any 5800 RF device in range of the receiver, regardless of whether or not the panel was configured to listen to it.

This also functions when the system is ARMED STAY. Normally you won't see fault messages for interior zones when armed this way so you lose visibility of interior motion sensors. One option is to put the interior sensors on a separate partition so you still see the inside zones and the outside sensors are on their own. The other option is to listen to the !RFX messages directly which could then be used to tell your home automation system that the zones are faulted.

===Examples===
Example of a 5800Micra sensor faulting and restoring:
<pre>
!RFX:0180036,80
!RFX:0180036,00
</pre>

Example of a 5804 keyfob pressing the loop #2 button and having a low battery:
<pre>
!RFX:0307854,22
</pre>

===Format===
{| class="wikitable" border="1"
|+ !RFX Format
| colspan="4" align="center" style="background-color: #DEDEDE; font-weight: bold" | !RFX:0180036,80
|-
| colspan="4" |  
|-
! scope="col" width="80px" style="color: #F56464" | Header
! scope="col" width="100px" style="color: #8C8CF5" | Serial Number
! scope="col" width="100px" style="color: #70BA66" | Data
|-
| align="center" | !RFX
| align="center" | 0180036
| align="center" | 80
|-
|}

====Serial Number====
This is the 7-digit serial number of the device the message originated from.

====Data====
The data is an 8-bit hex message with several indicators. Please refer to the '''5800 SERIES TRANSMITTER INPUT LOOP IDENTIFICATION''' section of your programming manual for what the loops relate to for your specific device.

{| class="wikitable" border="1"
|+ RFX Data Format
|-
! scope="col" | Bit
! scope="col" | Description
|-
| align="center" | 1
| Unknown - Seems that the loop indicators should be ignored if set.
|-
| align="center" | 2
| Low battery indication
|-
| align="center" | 3
| Supervision required indication
|-
| align="center" | 4
| Unknown
|-
| align="center" | 5
| Loop #3 indication
|-
| align="center" | 6
| Loop #2 indication
|-
| align="center" | 7
| Loop #4 indication
|-
| align="center" | 8
| Loop #1 indication
|}

==LRR==
If you have a Long Range Radio device attached or have emulation enabled the AlarmDecoder will report LRR messages from the panel to the radio.

===Examples===
This example shows User 12 arming and disarming the system:
<pre>
!LRR:012,1,ARM_STAY
!LRR:012,1,ARM_AWAY
!LRR:012,1,OPEN
!LRR:003,1,BYPASS
</pre>

===Format===
{| class="wikitable" border="1"
|+ !LRR Format
| colspan="4" align="center" style="background-color: #DEDEDE; font-weight: bold" | !LRR:012,1,ARM_STAY
|-
| colspan="4" |  
|-
! scope="col" width="80px" style="color: #F56464" | Header
! scope="col" width="100px" style="color: #8C8CF5" | Event Data
! scope="col" width="80px" style="color: #70BA66" | Partition
! scope="col" width="100px" style="color: #804580" | Event Type
|-
| align="center" | !LRR
| align="center" | 012
| align="center" | 1
| align="center" | ARM_STAY
|-
|}

====Event Data====
This is either the user number of the person performing the action or the zone that was bypassed.

====Partition====
The panel partition the event applies to. Partition 0 indicates that it's destined for all partitions.

====Event Type====
This is the type of the LRR event. See below for a description and what (if any) programming fields are required for activation.

{| class="wikitable" border="1"
|+ LRR Event Types
! scope="col" | Name
! scope="col" | Program Fields
! scope="col" | Description
|-
| ALARM_EXIT_ERROR
| *59
| Indicates an error when a zone is not closed during arming
|-
| TROUBLE
| *60
| Indicates that a zone is reporting a tamper or failure
|-
| BYPASS
| *61
| Indicates that a zone has been bypassed
|-
| ACLOSS
| *62
| Indicates that AC power was lost
|-
| LOWBAT
| *63
| Low battery indication
|-
| TEST_CALL
| *64
| Indicates a phone test when in testing mode
|-
| OPEN
| *65, requires *66
| Indicates that the alarm is disarmed
|-
| ARM_AWAY
| *66
| Indicates that the system was armed AWAY
|-
| ARM_STAY
| *66
| Indicates that the system was armed STAY
|-
| RFLOWBAT
| *67
| Low battery indication for the RF transmitter
|-
| CANCEL
| *68
| Indicates that the alarm was canceled after second disarm
|-
| RESTORE
| *70
| Indicates that the alarm was restored
|-
| TROUBLE_RESTORE
| *71
| Indicates that the trouble event was restored
|-
| BYPASS_RESTORE
| *72
| Indicates that the bypassed zonew as restored
|-
| AC_RESTORE
| *73
| Indicates that AC power was restored
|-
| LOWBAT_RESTORE
| *74
| Indicates that the low battery has been restored
|-
| RFLOWBAT_RESTORE
| *75
| Indicates that the low battery on the RF transmitter has been restored.
|-
| TEST_RESTORE
| *76
| Indicates that a zone was restored in testing mode
|-
| ALARM_PANIC
|
| Indicates that there is a panic
|-
| ALARM_FIRE
|
| Indicates that there is a fire
|-
| ALARM_ENTRY
|
| Indicates that there was an entry alarm
|-
| ALARM_AUX
|
| Indicates that an auxiliary alarm type was triggered
|-
| ALARM_AUDIBLE
|
| Indicates that an audible alarm is in progress
|-
| ALARM_SILENT
|
| Indicates that there was a silent alarm
|-
| ALARM_PERIMETER
|
| Indicates that there was a perimeter alarm
|}

==AUI==
AUI messages are generated for "Advanced User Interface" keypads. These include a lot of extra data than what's destined for regular keypads.

===Format===
{| class="wikitable" border="1"
|+ !AUI Format
| colspan="4" align="center" style="background-color: #DEDEDE; font-weight: bold" | !AUI:126600000000656c02456cf5ec01017f0002
|-
| colspan="4" |  
|-
! scope="col" width="80px" style="color: #F56464" | Header
! scope="col" width="100px" style="color: #8C8CF5" | AUI Data
|-
| align="center" | !AUI
| align="center" | 126600000000656c02456cf5ec01017f0002
|-
|}

====AUI Data====
This is a large binary blob that's destined for a graphical panel. This data has not been fully decoded. Please see the [[AUI|AUI]] page for information on what has been discovered so far.

==Keypress Events==
Keypress events are generated when keys are pressed on a keypad and can be enabled inside [[#CONFIGBITS|CONFIGBITS]].

===Format===
{| class="wikitable" border="1"
|+ !KPE Format
| colspan="4" align="center" style="background-color: #DEDEDE; font-weight: bold" | !KPE:18
|-
| colspan="4" |  
|-
! scope="col" width="80px" style="color: #F56464" | Header
! scope="col" width="100px" style="color: #8C8CF5" | Keypad Address
|-
| align="center" | !KPE
| align="center" | 18
|-
|}

====Keypad Address====
This is the address of the keypad that generated the event.

=Device Feedback LED=
* Boot flash mode
** During boot the AD2* will rapid flash during the boot loader.
* Operating mode
** The normal operating mode is a steady of approx 2.5 flashes per second.
* Error mode
** If an error is recorded the AD2* will flash the error message as steady slow flashes to be counted with a long period of the LED off between flashes. after a few minutes the led will return to normal idle flash mode if no further errors happen.

Protocol

2015-09-08T19:04:18Z

204.10.16.29: /* Zone Expander */

[[Category:FAQ]]
[[Category:Documentation]]
[[Category:Specifications]]
[[Category:Features]]

=Commands=
{| 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
|}

==Reboot==
Rebooting the device is as simple as sending = to it.

During the boot process you can trigger a firmware upload by sending a second = to the device after the !boot message is received. At this point you'll receive a !load and can begin uploading.

==Zone Emulation==
Zone Expander Emulation allows the AlarmDecoder to act in place of a physical expander board and make use of virtual zones with your panel. After enabling it on both the panel and the AlarmDecoder you can begin opening and closing zones, which will be relayed back to the panel.

The L command can be used to open or close zones. There are two parameters: the zone and the state. The zone is a zero-padded two-digit number and the state is either 0 or 1.

Example - open zone 12:
* L121\r

Example - close zone 12:
* L120\r

==Function Keys==
The specialty function keys are identified by ASCII character codes 1 through 4. In order to prevent false positives these must be sent three times in a row.

{| class="wikitable" border="1"
|+ Function Key Codes
! scope="col" | Code
! scope="col" | Description
|-
| \x01\x01\x01
| Function Key #1
|-
| \x02\x02\x02
| Function Key #2
|-
| \x03\x03\x03
| Function Key #3
|-
| \x04\x04\x04
| Function Key #4
|}

----

=Device Configuration=
The AlarmDecoder configuration can be viewed or modified in one of two ways: [[#Prompted|prompted]] or [[#Programatic|programmatically]].

==Prompted==
If you send ! followed by a carriage return you will be prompted to configure 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 provide a new one.

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>

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

Retrieving 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

===Configuration Parameters===
{| class="wikitable" border="1"
! scope="col" | Name
! scope="col" | Default Value
! scope="col" | Valid Values (Regex)
! scope="col" | Description
|-
| align="left" | ADDRESS
| align="left" | 18
| align="left" | [0-9]{2}
| align="left" | Keypad address assigned to the AlarmDecoder.
|-
| align="left" | CONFIGBITS
| align="left" | FF00
| align="left" | [0-9a-f]{4}
| align="left" | Special settings for the device. See [[#CONFIGBITS|CONFIGBITS]] for more information.
|-
| align="left" | MASK
| align="left" | FFFFFFFF
| align="left" | [0-9a-f]{8}
| align="left" | Address mask used to filter for keypad alphanumeric messages.
|-
| align="left" | EXP
| align="left" | NNNNN
| align="left" | [YN]{5}
| align="left" | Emulation of zone expanders 1-5
|-
| align="left" | REL
| align="left" | NNNN
| align="left" | [YN]{4}
| align="left" | Emulation of relay expanders 1-4
|-
| align="left" | LRR
| align="left" | N
| align="left" | [YN]
| align="left" | Emulation of Long Range Radio expander
|-
| align="left" | DEDUPLICATE
| align="left" | N
| align="left" | [YN]
| align="left" | If enabled, removes duplicate alphanumeric keypad messages.
|-
|}

====CONFIGBITS====
CONFIGBITS is a setting that's used to enable special functionality on the AlarmDecoder. You can enable these by masking the correct bits.

{| class="wikitable" border="1"
|+ CONFIGBITS Definition
! scope="col" | Mask
! scope="col" | Description
|-
| align="left" | 0x0001
| align="left" | Enable reporting of [[#AUI|AUI]] messages.
|-
| align="left" | 0x0002
| align="left" | Enable reporting of [[#Keypress Events|keypress events]].
|-
| align="left" | 0x0004
| align="left" | Disable prompts for L and | commands.
|-
| align="left" | 0x0008
| align="left" | Enable the prefixing of panel messages with !KMP.
|-
| align="left" | 0x0100
| align="left" | Enable reporting of [[#RFX|RFX]] messages.
|}

----

=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]].

* All lines starting with ! are informational.
* Lines that start with !> are prompts.
* All other lines are panel data in the form of a [[#Keypad|Keypad message]].

==Keypad==
Keypad messages are by far the most common message type produced by the AlarmDecoder. These messages also have an optional header that can be enabled in the [[#CONFIGBITS|CONFIGBITS]]. This setting prefixes all keypad messages with !KPM:.

===Format===
{| class="wikitable" border="1"
|+ Keypad Format
| colspan="4" align="center" style="background-color: #DEDEDE; font-weight: bold" | [001000010000--------],010,[f70700060010808c08020000],"ARMED ***STAY** ZONE BYPASSED "
|-
| colspan="4" |  
|-
! scope="col" width="160px" style="color: #F56464" | Bit field
! scope="col" width="100px" style="color: #8C8CF5" | Numeric code
! scope="col" width="200px" style="color: #70BA66" | Raw data
! scope="col" width="220px" style="color: #804580" | Alphanumeric Keypad Message
|-
| align="center" | [001000010000--------]
| align="center" | 010
| align="center" | [f70700060010808c08020000]
| align="center" | "ARMED ***STAY** ZONE BYPASSED "
|-
|}

====Bit field====
The bit field present on the keypad messages is where you're going to get most of the information on your alarm system's current state. These are all represented by a zero or one aside from the one exception. (beep)

{| class="wikitable" border="1"
! scope="col" | Position
! scope="col" | Description
|-
| 1
| Indicates if the panel is READY
|-
| 2
| Indicates if the panel is ARMED AWAY
|-
| 3
| Indicates if the panel is ARMED HOME
|-
| 4
| Indicates if the keypad backlight is on
|-
| 5
| Indicates if the keypad is in programming mode
|-
| 6
| Number (1-7) indicating how many beeps are associated with the message
|-
| 7
| Indicates that a zone has been bypassed
|-
| 8
| Indicates if the panel is on AC power
|-
| 9
| Indicates if the chime is enabled
|-
| 10
| Indicates that an alarm has occurred. This is sticky and will be cleared after a second disarm.
|-
| 11
| Indicates that an alarm is currently sounding. This is cleared after the first disarm.
|-
| 12
| Indicates that the battery is low
|-
| 13
| Indicates that entry delay is off (ARMED INSTANT/MAX)
|-
| 14
| Indicates that there is a fire
|-
| 15
| Indicates a system issue
|-
| 16
| Indicates that the panel is only watching the perimeter (ARMED STAY/NIGHT)
|-
| 17
| Unused
|-
| 18
| Unused
|-
| 19
| Unused
|-
| 20
| Unused
|-
|}

====Numeric Code====
This number specifies which zone is affected by the message. For example, if this message is for CHECK ZONE 22 then the numeric code would be 022. Most of the time this is zero-padded base10, but there are rare occurrences where this may be base16, such as ECP bus failures.

====Raw data====
This is the binary data associated with the message. It includes all of the bit field entries that were separated out for you in the first field, as well as the rest of the message for debugging and exploratory purposes.

There is one important piece of data included only in this field: the keypad address mask. The four bytes starting at position 2 (zero-indexed) indicate which keypads this message is intended for.

Inside this mask each bit represents a specific keypad. Each byte represents a group of eight keypad addresses, which the least-significant-bit being the start of the range.

{| class="wikitable" border="1"
! scope="col" | Byte
! scope="col" | Addresses
|-
| 1
| 0-7
|-
| 2
| 8-15
|-
| 3
| 16-23
|-
| 4
| 24-31
|}

For example:
* f70700060010808c08020000 - our keypad address mask is 07000600.

Using the above mask example of 07000600 we find that this message was destined for keypads 0, 1, 2, 17 and 18.

There is one special case: system messages will have no address mask bits set and are intended for common keypads or monitoring multiple zones.

For the most part the address mask details only become really important when you're working with a setup that has multiple partitions since the AlarmDecoder will see all messages by default.

====Alphanumeric Keypad Message====
This section is the data that would be displayed on your keypad's screen.

==Zone Expander==
If you have one or more zone expanders connected to the alarm panel you will be able to see messages from the expanders as zones are faulted and restored. On DSC panels all zones are expressed as EXP messages.
===Examples===
Example of zone expander at address 7, channel 1 faulting and then restoring:
<pre>
!EXP:07,01,01
!EXP:07,01,00
</pre>

===Format===
{| class="wikitable" border="1"
|+ !EXP Format
| colspan="4" align="center" style="background-color: #DEDEDE; font-weight: bold" | !EXP:07,01,01
|-
| colspan="4" |  
|-
! scope="col" width="80px" style="color: #F56464" | Header
! scope="col" width="160px" style="color: #8C8CF5" | Zone Expander Address
! scope="col" width="140px" style="color: #70BA66" | Expander Channel
! scope="col" width="100px" style="color: #804580" | Data
|-
| align="center" | !EXP
| align="center" | 07
| align="center" | 01
| align="center" | 01
|-
|}

====Zone Expander Address====
This is the address that the zone expander occupies.

====Expander Channel====
This is the channel generating the message.

====Data====
00 and 01 indicate that the zone is restored and faulted, respectively.

==Relay Expander==
If you have one or more relay expanders connected to your alarm panel you will be able to see messages when the relays are opened or closed.

===Examples===
Examples of a relay expander at address 12, relay #1 closing and then opening:
<pre>
!REL:12,01,01
!REL:12,01,00
</pre>

===Format===
{| class="wikitable" border="1"
|+ !REL Format
| colspan="4" align="center" style="background-color: #DEDEDE; font-weight: bold" | !REL:12,01,01
|-
| colspan="4" |  
|-
! scope="col" width="80px" style="color: #F56464" | Header
! scope="col" width="160px" style="color: #8C8CF5" | Relay Expander Address
! scope="col" width="140px" style="color: #70BA66" | Expander Channel
! scope="col" width="100px" style="color: #804580" | Data
|-
| align="center" | !REL
| align="center" | 12
| align="center" | 01
| align="center" | 01
|-
|}

====Relay Expander Address====
This is the address that the relay expander occupies.

====Expander Channel====
This is the channel generating the message.

====Data====
00 and 01 indicate that the relay is opened and closed, respectively.

==RFX==
If you have an RF receiver attached to your panel you will see messages from any 5800 RF device in range of the receiver, regardless of whether or not the panel was configured to listen to it.

This also functions when the system is ARMED STAY. Normally you won't see fault messages for interior zones when armed this way so you lose visibility of interior motion sensors. One option is to put the interior sensors on a separate partition so you still see the inside zones and the outside sensors are on their own. The other option is to listen to the !RFX messages directly which could then be used to tell your home automation system that the zones are faulted.

===Examples===
Example of a 5800Micra sensor faulting and restoring:
<pre>
!RFX:0180036,80
!RFX:0180036,00
</pre>

Example of a 5804 keyfob pressing the loop #2 button and having a low battery:
<pre>
!RFX:0307854,22
</pre>

===Format===
{| class="wikitable" border="1"
|+ !RFX Format
| colspan="4" align="center" style="background-color: #DEDEDE; font-weight: bold" | !RFX:0180036,80
|-
| colspan="4" |  
|-
! scope="col" width="80px" style="color: #F56464" | Header
! scope="col" width="100px" style="color: #8C8CF5" | Serial Number
! scope="col" width="100px" style="color: #70BA66" | Data
|-
| align="center" | !RFX
| align="center" | 0180036
| align="center" | 80
|-
|}

====Serial Number====
This is the 7-digit serial number of the device the message originated from.

====Data====
The data is an 8-bit hex message with several indicators. Please refer to the '''5800 SERIES TRANSMITTER INPUT LOOP IDENTIFICATION''' section of your programming manual for what the loops relate to for your specific device.

{| class="wikitable" border="1"
|+ RFX Data Format
|-
! scope="col" | Bit
! scope="col" | Description
|-
| align="center" | 1
| Unknown - Seems that the loop indicators should be ignored if set.
|-
| align="center" | 2
| Low battery indication
|-
| align="center" | 3
| Supervision required indication
|-
| align="center" | 4
| Unknown
|-
| align="center" | 5
| Loop #3 indication
|-
| align="center" | 6
| Loop #2 indication
|-
| align="center" | 7
| Loop #4 indication
|-
| align="center" | 8
| Loop #1 indication
|}

==LRR==
If you have a Long Range Radio device attached or have emulation enabled the AlarmDecoder will report LRR messages from the panel to the radio.

===Examples===
This example shows User 12 arming and disarming the system:
<pre>
!LRR:012,1,ARM_STAY
!LRR:012,1,ARM_AWAY
!LRR:012,1,OPEN
!LRR:003,1,BYPASS
</pre>

===Format===
{| class="wikitable" border="1"
|+ !LRR Format
| colspan="4" align="center" style="background-color: #DEDEDE; font-weight: bold" | !LRR:012,1,ARM_STAY
|-
| colspan="4" |  
|-
! scope="col" width="80px" style="color: #F56464" | Header
! scope="col" width="100px" style="color: #8C8CF5" | Event Data
! scope="col" width="80px" style="color: #70BA66" | Partition
! scope="col" width="100px" style="color: #804580" | Event Type
|-
| align="center" | !LRR
| align="center" | 012
| align="center" | 1
| align="center" | ARM_STAY
|-
|}

====Event Data====
This is either the user number of the person performing the action or the zone that was bypassed.

====Partition====
The panel partition the event applies to. Partition 0 indicates that it's destined for all partitions.

====Event Type====
This is the type of the LRR event. See below for a description and what (if any) programming fields are required for activation.

{| class="wikitable" border="1"
|+ LRR Event Types
! scope="col" | Name
! scope="col" | Program Fields
! scope="col" | Description
|-
| ALARM_EXIT_ERROR
| *59
| Indicates an error when a zone is not closed during arming
|-
| TROUBLE
| *60
| Indicates that a zone is reporting a tamper or failure
|-
| BYPASS
| *61
| Indicates that a zone has been bypassed
|-
| ACLOSS
| *62
| Indicates that AC power was lost
|-
| LOWBAT
| *63
| Low battery indication
|-
| TEST_CALL
| *64
| Indicates a phone test when in testing mode
|-
| OPEN
| *65, requires *66
| Indicates that the alarm is disarmed
|-
| ARM_AWAY
| *66
| Indicates that the system was armed AWAY
|-
| ARM_STAY
| *66
| Indicates that the system was armed STAY
|-
| RFLOWBAT
| *67
| Low battery indication for the RF transmitter
|-
| CANCEL
| *68
| Indicates that the alarm was canceled after second disarm
|-
| RESTORE
| *70
| Indicates that the alarm was restored
|-
| TROUBLE_RESTORE
| *71
| Indicates that the trouble event was restored
|-
| BYPASS_RESTORE
| *72
| Indicates that the bypassed zonew as restored
|-
| AC_RESTORE
| *73
| Indicates that AC power was restored
|-
| LOWBAT_RESTORE
| *74
| Indicates that the low battery has been restored
|-
| RFLOWBAT_RESTORE
| *75
| Indicates that the low battery on the RF transmitter has been restored.
|-
| TEST_RESTORE
| *76
| Indicates that a zone was restored in testing mode
|-
| ALARM_PANIC
|
| Indicates that there is a panic
|-
| ALARM_FIRE
|
| Indicates that there is a fire
|-
| ALARM_ENTRY
|
| Indicates that there was an entry alarm
|-
| ALARM_AUX
|
| Indicates that an auxiliary alarm type was triggered
|-
| ALARM_AUDIBLE
|
| Indicates that an audible alarm is in progress
|-
| ALARM_SILENT
|
| Indicates that there was a silent alarm
|-
| ALARM_PERIMETER
|
| Indicates that there was a perimeter alarm
|}

==AUI==
AUI messages are generated for "Advanced User Interface" keypads. These include a lot of extra data than what's destined for regular keypads.

===Format===
{| class="wikitable" border="1"
|+ !AUI Format
| colspan="4" align="center" style="background-color: #DEDEDE; font-weight: bold" | !AUI:126600000000656c02456cf5ec01017f0002
|-
| colspan="4" |  
|-
! scope="col" width="80px" style="color: #F56464" | Header
! scope="col" width="100px" style="color: #8C8CF5" | AUI Data
|-
| align="center" | !AUI
| align="center" | 126600000000656c02456cf5ec01017f0002
|-
|}

====AUI Data====
This is a large binary blob that's destined for a graphical panel. This data has not been fully decoded. Please see the [[AUI|AUI]] page for information on what has been discovered so far.

==Keypress Events==
Keypress events are generated when keys are pressed on a keypad and can be enabled inside [[#CONFIGBITS|CONFIGBITS]].

===Format===
{| class="wikitable" border="1"
|+ !KPE Format
| colspan="4" align="center" style="background-color: #DEDEDE; font-weight: bold" | !KPE:18
|-
| colspan="4" |  
|-
! scope="col" width="80px" style="color: #F56464" | Header
! scope="col" width="100px" style="color: #8C8CF5" | Keypad Address
|-
| align="center" | !KPE
| align="center" | 18
|-
|}

====Keypad Address====
This is the address of the keypad that generated the event.

Supported Panels

2015-09-03T01:23:24Z

204.10.16.29: /* Panels */

__TOC__
[[Category:FAQ]]
[[Category:Documentation]]
[[Category:Specifications]]
[[Category:Features]]
== Ademco / Honeywell Systems ==
; The AlarmDecoder was designed to work with any alarm from the Ademco/Honeywell Vista series from the 90's right up to the latest 2013 Honeywell Vista 21IP and more recently DSC Power series alarms. This document will help identify if a given panel is compatible with the AlarmDecoder. Many of these alarm panels were sold under different names branded by the alarm monitoring company for example '''Safewatch Pro 3000/3000CN''' which is actually a '''Vista 20P'''.

* Note: The Ademco LYNX Systems are NOT compatible as they do not support the 4 wire expansion bus the AlarmDecoder connects to.

; If '''after''' reading this you still are not sure if your panel is supported and are interested in the AlarmDecoder then send us an email with a picture of your alarm panel filling the full frame of your camera and we will check it out. (Please provide a general statement of release for the photo as we may use them on the website to help others.)

===Keypads===
; The AlarmDecoder is compatible with any alarm that is also compatible with one of these Ademco/Honeywell keypads.
{| summary="Examples of supported keypads"
|[[File:5839.jpg|thumb|5839]]
|[[File:6128.jpg|thumb|6127 & 6129]]
|[[File:6138.jpg|thumb|6138]]
|[[File:6139.jpg|thumb|>6139]]
|-
|[[File:6148.jpg|thumb|6148]]
|[[File:6150.jpg|thumb|6150]]
|[[File:6150rf.jpg|thumb|6150RF]]
|[[File:6160CR.jpg|thumb|6160CR]]
|-
|[[File:6160.jpg|thumb|6160]]
|[[File:6160V.jpg|thumb|6160V]]
|[[File:6164.jpg|thumb|6164]]
|[[File:6270_pr.jpg|thumb|6270]]
|-
|[[File:6271v.jpg|thumb|6271V]]
|[[File:blankimage.png|thumb|6128]]
|[[File:blankimage.png|thumb|6128RF]]
|[[File:LynxPlus_pr.jpg|thumb|LYNX Touch(L5100)]]
|}

===Panels===
; This is a partial list. Many supported panels were sold under different names and model numbers so here are some tips for seeing if your panel will be compatible.

* Look for a large wiring sticker inside the panel enclosure that shows the word(s): Vista, Ademco, Honeywell, etc.
* Look on the panel for words like SAVS and a series of letters and numbers like SAVS'''20P'''5 or SAVS'''10SE'''CE. The model number is embedded inside this string of characters as demonstrated here.

{| summary="Examples of supported keypads"
|[[File:10se.jpg|thumb|Vista 10SE]]
|[[File:20P.jpg|thumb|Vista 20P]]
|[[File:30se.jpg|thumb|Vista 30SE]]
|[[File:21IP.jpg|thumb|Vista 21IP]]
|-
|[[File:128BP.jpg|thumb|Vista 128BP]]
|[[File:blankimage.png|thumb|Vista 10P]]
|[[File:blankimage.png|thumb|Vista 15P]]
|[[File:blankimage.png|thumb|Vista 20SE]]
|}

==DSC Systems==
; We now support the DSC Power series alarm panels. This requires beta [[Firmware|firmware 2.2a.8]] or later. This is still in beta and new features are being added every month.
===Panels===
{| summary="Examples of supported DSC panels"
|[[File:pcb-580.gif|thumb|DSC Power 432/ PC-580]]
|[[File:Pcb-1555.gif |thumb|DSC Power 632 / PC-1555]]
|[[File:Pcb-5010.gif|thumb|DSC Power 832 / PC-5010]]
|[[File:Pcb-5020.gif|thumb|DSC Power 864 / PC-5020]]
|-
|[[File:PC1864.jpg|thumb|DSC PowerSeries Control Panel PC1616]]
|[[File:PC1864.jpg|thumb|DSC PowerSeries Control Panel PC1832]]
|[[File:PC1864.jpg|thumb|DSC PowerSeries Control Panel PC1864]]
|}

File:PC1864.jpg

2015-09-03T01:22:52Z

204.10.16.29: Same general design as 1843 and 1616.

Same general design as 1843 and 1616.

Supported Panels

2015-09-03T01:21:47Z

204.10.16.29: /* Panels */

AlarmDecoder WebApp

2015-08-24T19:29:51Z

204.10.16.29: /* Configure IP Cameras */

__TOC__
[[Category:Documentation]]
[[Category:FAQ]]
[[Category:Downloads]]
[[Category:Features]]

=AlarmDecoder WebApp=
==Overview==
; The official AlarmDecoder WebApp. Control your alarm system from your web browser on nearly any device. Supports all of the AlarmDecoder devices including the AD2USB, AD2SERIAL, and AD2PI.

===Features===
* Multiple User Accounts
* Web-based keypad for your alarm system
* Notifications on alarm events
* Per-user notifications
* IP Camera integration
* Supports all functionality of AlarmDecoder devices
* Configure your AlarmDecoder device
* Configure network sharing of your AlarmDecoder device
* Support for PC/Mac/Linux as well as Mobile and Tablet browsers

[[File:webappkeypad.png|border|Keypad Interface]]
; The AlarmDecoder WebApp Keypad Interface

==Installation==
; The easiest way to install the WebApp is by downloading our pre-built Raspbian image [http://www.alarmdecoder.com/wiki/index.php/Raspberry_Pi here]. However, you can follow the manual installation instructions provided on our github repository [https://github.com/nutechsoftware/alarmdecoder-webapp here]

==Initial Setup==
; Once the AlarmDecoder WebApp is started (it can take some time to initially start) you may connect to the Application via a web browser and pointing the URL to http://alarmdecoder.local - if this name resolution fails and you are on a Windows System, please download [https://support.apple.com/kb/DL999?locale=en_US Bonjour For Windows] and try again. This will take you to our first setup screens which will be detailed below. The device is initially configured for DHCP.

'''IF YOU BOUGHT A BUNDLE FROM US, IT IS ALREADY SET UP. YOU ONLY NEED TO GO THROUGH SETUP IF YOU NEED TO CHANGE DEFAULT ADDRESS OF DEVICE OTHERWISE CHECK [[Raspberry_Pi|HERE]] FOR DEFAULT PASSWORDS AND CHANGE THEM ACCORDINGLY'''

===Setup Process Detail===
; This is your first setup screen when you first visit via your browser
[[File:01_initial_setup.png|800px|border|First Setup Screen]]
; Click "Start!" to continue

; Next we will be taken to the device selection screen
[[File:02_device_type_settings.png|800px|border|Device Type Screen]]
; Here you are able to select what type of device (AD2USB, AD2SERIAL, AD2PI) as well as the device's location.
* [[#Local Device]] means the device is connected to the same computer running the WebApp
* [[#Network Device]] means you have already exposed an AlarmDecoder via ser2sock

====Local Device====
; If you choose Local Device, this next screen is what you are presented with
[[File:03_local_device_settings.png|800px|border|Local Device Settings]]
; Here you will choose your device path and baud rate, usually defaults are fine for the device you chose
; If you choose "Share AlarmDecoder on your network?" you will be taken to configure ser2sock shown below
[[File:04_ser2sock_configuration.png|800px|border|Setup Ser2sock]]
; On this screen you are able to specify the path to your ser2sock configuration file, your hostname or IP address to listen on, as well as the ser2sock port to listen on. Defaults will work fine. SSL will force ser2sock into SSL mode - this is typically not needed for your internal network.
* ser2sock Port is different from the HTTP/WSGI ports - do not choose 80, 443, or 5000.

Skip to [[#Configure Device]]

====Network Device====
; If you chose network device instead of local device, you are presented with this screen instead
[[File:05_network_device_settings.png|800px|border|Network Device Setup]]
; If you have an AlarmDecoder device shared on your network already via ser2sock, here you can specify the hostname and port for the WebApp to connect to the shared device.

====Configure Device====
; Once you have told the WebApp what kind of device you have and where it is, you will be presented with a page to configure the AlarmDecoder device itself
[[File:06_alarmdecoder_settings.png|800px|border|AlarmDecoder Device Settings]]
; Make sure to set your address correctly! 31 for SE Panels, and for 20P Panels you will have to program an address spot into your panel and assign the AlarmDecoder the newly enabled address. See [[http://www.alarmdecoder.com/wiki/index.php/Panel_Configuration Panel Configuration]]

; After you have completed all of the above steps, you will be taken to a Device Testing screen
[[File:07_device_testing.png|800px|border|Device Testing]]
; If any of these tests fail, please make sure your device is configured properly and installed properly.
;Here is an example of a successful device test
[[File:Success_device_testing.png|800px|border|Device Testing Success]]

; Once the device is communicating properly, you will be redirected to a page to create an initial user to log in to the WebApp
[[File:08_create_initial_account.png|800px|border|Initial User Creation]]
; After you have created your user, feel free to login and use the WebApp!

==Configure Notifications==
; Once you are logged in, go to Settings and click on Notifications. From there, you can edit already configured notifications or click "New Notification" to create a new notification.

[[File:Notifications_main.png|800px|border|Main Notification Interface]]
; This is the main interface for creating and listing notifications. Here you can choose to create new or edit existing notifications.

[[File:Notification_types.png|400px|border|List of Notification Types]]
; Here is a list of all current supported notification types.

[[File:Notification_common_settings.png|800px|border|List of Items to be Notified On]]
; Here is a list of all of the events that can trigger a notification. You are able to select which ones you would like to see. You can also have different notification types alert you for different kinds of notifications. This interface is common to all notification types.

===Email===
[[File:Notification_email_example.png|800px|border|Email Notification Example using gmail settings]]
; Here is an example email notification form using gmail settings for example
* Source Address - Emails appear "From" this address
* Destination Address - Emails will go "To" this address
* Email Subject - Emails will contain this subject line
* Email Server - The server to connect to when sending emails
* Server Port - The port of the email server to connect to
* Use TLS? - Enable Transport Layer Security for the session
* Authenticate with email server? - If a username and password is required by the email server to send, supply them
* Username - Your email username
* Password - Your email password

===SMS via Twilio===
[[File:Twilio_example.png|800px|border|Example of Twilio Notification Configuration]]
; Here is an example of a Twilio Notification configuration
* Account SID - Your Twilio Account SID
* Auth Token - Your Twilio User Auth Token
* To - Number to Send SMS to
* From - Your valid Twilio Phone Number

===Google Talk===
[[File:Googletalk_example.png|800px|border|Example of Google Talk Notification Configuration]]
; Here is an example of a Google Talk Notification configuration
* Source Address - Messages will come FROM this address
* Password - The password for the SOURCE account
* Destination Address - Messages will go to this address

===Pushover.net===
[[File:Pushover_example.png|800px|border|Example of Pushover.net Notification Configuration]]
; Here is the configuration for a Pushover.net notification
* API Token - The API Token provided by Pushover for your User
* User/Group Key - The User or Group Key for your account at Pushover
* Message Priority - In what priority do you want alarm panel notifications
* Title of Message - Messages sent to Pushover are titled with this text

===Prowl===
[[File:Prowl_example.png|800px|border|Example of Prowl Notification Configuration]]
; Here is an example of a Prowl notification configuration
* API Key - Your Prowl API Key
* Application Name - Application to Show in Notifications
* Message Priority - What priority do you want alarm panel notifications to come through as

===NotifyMyAndroid===
[[File:Notifymyandroid_example.png|800px|border|Example of NotifyMyAndroid configuration]]
; Here is an example of a NotifyMyAndroid notification configuration
* API Key - Your NotifyMyAndroid API Key
* Application Name - Application Name to show in notifications
* Message Priority - What priority do you want Alarm Panel notifications to come through?

===Growl===
[[File:Growl_example.png|800px|border|Example of a Growl Notification]]
; An example of a Growl Notification configuration
* Hostname - The Growl server to send notification to
* Port - The Growl Server Port
* Password - The password for the Growl server
* Title - Notification Title
* Message Priority - What priority do you want these messages to come through as?

===Custom URL POST===
[[File:Custom_example.png|800px|border|Example of a Custom POST notification]]
; Here is an example configuration for a Custom POST notification
* POST URL - URL of server to POST data to
* POST Path - Location on server from URL to post to
* SSL? - Is the URL SSL or Not
* POST Type - urlencoded, JSON, or XML POST types supported
* Custom Values - Here you are able to create your own key/value pairs to send with your notification

==Custom Buttons==
; Under settings->Keypad you can define a set of custom buttons which when defined will appear on your keypad as well as your camera view pages.
; Each user can define their own custom buttons
[[File:Custom_button_list.png|border|800px|Custom Button List]]
; These buttons send exactly the set of keypresses defined by the user to the alarm
; Example - Define a Quick Arm button - press it to instantly arm the alarm
[[File:Create_custom_button.png|border|800px|Create Custom Button]]
[[File:Custom_button_on_keypad.png|border|800px|Custom Button on Keypad Page]]

==Configure IP Cameras==
; '''If you are not using our image, or an older version of the image, you must perform a few steps to enable Camera Support'''
* in the contrib directory of the webapp there is an opencv directory
* in the opencv directory execute
**sudo sh opencv.sh

* Once this is done and installed, you can then configure and view a camera.

[[File:Camera_list.png|800px|border|Example of Camera Listings]]
; Here you see the interface where it lists current cameras as well as a button for creating a new camera.

[[File:Create_camera.png|800px|border|Example of Creating Camera]]
; Here we are creating a camera for view in the system
* Name - The name of the camera for display purposes
* Snapshot URL - The full URL of the motion jpeg stream for your IP camera
* Username - The username for authenticating to the camera
* Password - The password for authenticating to the camera

==Host Settings==
; Found under settings->Host
[[File:Host_settings.png|800px|border|Example of Host Settings Page]]
; Here you are able to configure your device's hostname, networking, as well as reboot and shutdown the device.
===Reboot Device===
; Found under settings->Host
; Click Reboot button
===Shutdown Device===
; Found under settings->Host
; Click Shutdown button

==Add Users==
;Under Settings, click on Users - you will be presented with this screen:
[[File:User_list.png|800px|border|User List]]
;Here you are able to edit current users, or create new users.

;By clicking New User, you are then taken to this screen:
[[File:Create_user.png|800px|border|New User Screen]]
;Here you fill out the user's details and save. The user can now login to the webapp.

==Configuring SSL==
'''This is now enabled by default as of the 05-22-2015 software release.'''

;SSH into your raspberry pi
;First you must create your SSL certificates and put them in the correct location
<code>
sudo openssl req -x509 -nodes -days 365 -newkey rsa:2048 -keyout /etc/nginx/ssl/alarmdecoder.key -out /etc/nginx/ssl/alarmdecoder.crt
</code>
;Just make sure to fill in the values correctly for your certificate when prompted.

;Next you must edit your nginx alarmdecoder config under /etc/nginx/sites-enabled/alarmdecoder
<code>
server {
listen 80;
return 301 https://$host$request_uri;
}

server {
error_page 502 /502.html;

listen 443 default_server ssl;

ssl_certificate /etc/nginx/ssl/alarmdecoder.crt;
ssl_certificate_key /etc/nginx/ssl/alarmdecoder.key;

#ssl on;
ssl_session_cache builtin:1000 shared:SSL:10m;
ssl_protocols TLSv1 TLSv1.1 TLSv1.2;
#ssl_ciphers HIGH:MEDIUM:!aNULL:!eNULL:!EXPORT:!CAMELLIA:!DES:!MD5:!PSK:!RC4;
ssl_ciphers "ECDHE-RSA-AES256-GCM-SHA384:ECDHE-RSA-AES128-GCM-SHA256:DHE-RSA-AES256-GCM-SHA384:DHE-RSA-AES128-GCM-SHA256:ECDHE-RSA-AES256-SHA384:ECDHE-RSA-AES128-SHA256:ECDHE-RSA-AES256-SHA:ECDHE-RSA-AES128-SHA:DHE-RSA-AES256-SHA256:DHE-RSA-AES128-SHA256:DHE-RSA-AES256-SHA:DHE-RSA-AES128-SHA:ECDHE-RSA-DES-CBC3-SHA:EDH-RSA-DES-CBC3-SHA:AES256-GCM-SHA384:AES128-GCM-SHA256:AES256-SHA256:AES128-SHA256:AES256-SHA:AES128-SHA:DES-CBC3-SHA:HIGH:!aNULL:!eNULL:!EXPORT:!DES:!MD5:!PSK:!RC4";
ssl_prefer_server_ciphers on;

#error_page 497 https://$host:$server_port$request_uri;

gzip on;
gzip_disable "msie6";
gzip_vary on;
gzip_proxied any;
gzip_comp_level 6;
gzip_buffers 16 4k;
gzip_http_version 1.1;
gzip_types text/plain text/css application/json application/x-javascript text/xml application/xml application/xml+rss text/javascript;

location / {
try_files $uri @alarmdecoder;
}

location @alarmdecoder {
proxy_pass http://127.0.0.1:5000;
include uwsgi_params;
uwsgi_param UWSGI_SCHEME $scheme;
uwsgi_param SERVER_SOFTWARE nginx/$nginx_version;

proxy_redirect off;
proxy_http_version 1.1;
proxy_set_header Upgrade $http_upgrade;
proxy_set_header Connection "upgrade";
proxy_set_header Host $http_host;
proxy_set_header X-Real-IP $remote_addr;
proxy_set_header X-Forwarded-Proto $scheme;
proxy_set_header X-Forwarded-For $proxy_add_x_forwarded_for;
proxy_set_header X-Forwarded-Host $server_name;
proxy_set_header X-Scheme $scheme;
proxy_redirect http://localhost:5000 https://$host;
}

location /502.html {
root /opt/alarmdecoder-webapp/ad2web/static;
}

location ~ \.(jpg|jpeg|png|css|js)$ {
root /opt/alarmdecoder-webapp/ad2web;
}
}
</code>
;After this, restart the nginx service and you will have forced SSL.

==Port Forwarding==
;To access your WebApplication outside of your network, first you must do a "port forwarding" operation on your networking router/firewall - a NAT.
;Some ISPs filter standard server ports, so sometimes you will have to choose an external port that is not filtered. (Not 80, 25, 443).
;As an example, you may want to forward port 4443 on the outside network to port 443 of your Network Appliance. You then would hit your external IP Address on port 4443 from your web browser. https://public_ip_address:4443 which would then forward to port 443 of the network appliance - in SSL mode for security.
==Diagnostics==
; A Diagnostics Screen is provided under settings->Diagnostics
; This screen will allow you to test the functionality of the AlarmDecoder device as well as showing information about required modules.
[[File:Diagnostics_screen.png|border|800px|Diagnostics Screen]]

==Disclaimers==
; All other trademarks are the property of their respective owners.

File:Custom button on keypad.png

2015-08-24T19:27:43Z

204.10.16.29: Screen showing the custom button interface open on the Keypad page

Screen showing the custom button interface open on the Keypad page

File:Custom button list.png

2015-08-24T19:27:04Z

204.10.16.29: Screen showing a list of defined custom buttons for the user

Screen showing a list of defined custom buttons for the user

File:Create custom button.png

2015-08-24T19:26:28Z

204.10.16.29: Screen showing the creation of a custom button

Screen showing the creation of a custom button

AlarmDecoder WebApp

2015-08-24T19:22:05Z

204.10.16.29: /* Diagnostics */

__TOC__
[[Category:Documentation]]
[[Category:FAQ]]
[[Category:Downloads]]
[[Category:Features]]

=AlarmDecoder WebApp=
==Overview==
; The official AlarmDecoder WebApp. Control your alarm system from your web browser on nearly any device. Supports all of the AlarmDecoder devices including the AD2USB, AD2SERIAL, and AD2PI.

===Features===
* Multiple User Accounts
* Web-based keypad for your alarm system
* Notifications on alarm events
* Per-user notifications
* IP Camera integration
* Supports all functionality of AlarmDecoder devices
* Configure your AlarmDecoder device
* Configure network sharing of your AlarmDecoder device
* Support for PC/Mac/Linux as well as Mobile and Tablet browsers

[[File:webappkeypad.png|border|Keypad Interface]]
; The AlarmDecoder WebApp Keypad Interface

==Installation==
; The easiest way to install the WebApp is by downloading our pre-built Raspbian image [http://www.alarmdecoder.com/wiki/index.php/Raspberry_Pi here]. However, you can follow the manual installation instructions provided on our github repository [https://github.com/nutechsoftware/alarmdecoder-webapp here]

==Initial Setup==
; Once the AlarmDecoder WebApp is started (it can take some time to initially start) you may connect to the Application via a web browser and pointing the URL to http://alarmdecoder.local - if this name resolution fails and you are on a Windows System, please download [https://support.apple.com/kb/DL999?locale=en_US Bonjour For Windows] and try again. This will take you to our first setup screens which will be detailed below. The device is initially configured for DHCP.

'''IF YOU BOUGHT A BUNDLE FROM US, IT IS ALREADY SET UP. YOU ONLY NEED TO GO THROUGH SETUP IF YOU NEED TO CHANGE DEFAULT ADDRESS OF DEVICE OTHERWISE CHECK [[Raspberry_Pi|HERE]] FOR DEFAULT PASSWORDS AND CHANGE THEM ACCORDINGLY'''

===Setup Process Detail===
; This is your first setup screen when you first visit via your browser
[[File:01_initial_setup.png|800px|border|First Setup Screen]]
; Click "Start!" to continue

; Next we will be taken to the device selection screen
[[File:02_device_type_settings.png|800px|border|Device Type Screen]]
; Here you are able to select what type of device (AD2USB, AD2SERIAL, AD2PI) as well as the device's location.
* [[#Local Device]] means the device is connected to the same computer running the WebApp
* [[#Network Device]] means you have already exposed an AlarmDecoder via ser2sock

====Local Device====
; If you choose Local Device, this next screen is what you are presented with
[[File:03_local_device_settings.png|800px|border|Local Device Settings]]
; Here you will choose your device path and baud rate, usually defaults are fine for the device you chose
; If you choose "Share AlarmDecoder on your network?" you will be taken to configure ser2sock shown below
[[File:04_ser2sock_configuration.png|800px|border|Setup Ser2sock]]
; On this screen you are able to specify the path to your ser2sock configuration file, your hostname or IP address to listen on, as well as the ser2sock port to listen on. Defaults will work fine. SSL will force ser2sock into SSL mode - this is typically not needed for your internal network.
* ser2sock Port is different from the HTTP/WSGI ports - do not choose 80, 443, or 5000.

Skip to [[#Configure Device]]

====Network Device====
; If you chose network device instead of local device, you are presented with this screen instead
[[File:05_network_device_settings.png|800px|border|Network Device Setup]]
; If you have an AlarmDecoder device shared on your network already via ser2sock, here you can specify the hostname and port for the WebApp to connect to the shared device.

====Configure Device====
; Once you have told the WebApp what kind of device you have and where it is, you will be presented with a page to configure the AlarmDecoder device itself
[[File:06_alarmdecoder_settings.png|800px|border|AlarmDecoder Device Settings]]
; Make sure to set your address correctly! 31 for SE Panels, and for 20P Panels you will have to program an address spot into your panel and assign the AlarmDecoder the newly enabled address. See [[http://www.alarmdecoder.com/wiki/index.php/Panel_Configuration Panel Configuration]]

; After you have completed all of the above steps, you will be taken to a Device Testing screen
[[File:07_device_testing.png|800px|border|Device Testing]]
; If any of these tests fail, please make sure your device is configured properly and installed properly.
;Here is an example of a successful device test
[[File:Success_device_testing.png|800px|border|Device Testing Success]]

; Once the device is communicating properly, you will be redirected to a page to create an initial user to log in to the WebApp
[[File:08_create_initial_account.png|800px|border|Initial User Creation]]
; After you have created your user, feel free to login and use the WebApp!

==Configure Notifications==
; Once you are logged in, go to Settings and click on Notifications. From there, you can edit already configured notifications or click "New Notification" to create a new notification.

[[File:Notifications_main.png|800px|border|Main Notification Interface]]
; This is the main interface for creating and listing notifications. Here you can choose to create new or edit existing notifications.

[[File:Notification_types.png|400px|border|List of Notification Types]]
; Here is a list of all current supported notification types.

[[File:Notification_common_settings.png|800px|border|List of Items to be Notified On]]
; Here is a list of all of the events that can trigger a notification. You are able to select which ones you would like to see. You can also have different notification types alert you for different kinds of notifications. This interface is common to all notification types.

===Email===
[[File:Notification_email_example.png|800px|border|Email Notification Example using gmail settings]]
; Here is an example email notification form using gmail settings for example
* Source Address - Emails appear "From" this address
* Destination Address - Emails will go "To" this address
* Email Subject - Emails will contain this subject line
* Email Server - The server to connect to when sending emails
* Server Port - The port of the email server to connect to
* Use TLS? - Enable Transport Layer Security for the session
* Authenticate with email server? - If a username and password is required by the email server to send, supply them
* Username - Your email username
* Password - Your email password

===SMS via Twilio===
[[File:Twilio_example.png|800px|border|Example of Twilio Notification Configuration]]
; Here is an example of a Twilio Notification configuration
* Account SID - Your Twilio Account SID
* Auth Token - Your Twilio User Auth Token
* To - Number to Send SMS to
* From - Your valid Twilio Phone Number

===Google Talk===
[[File:Googletalk_example.png|800px|border|Example of Google Talk Notification Configuration]]
; Here is an example of a Google Talk Notification configuration
* Source Address - Messages will come FROM this address
* Password - The password for the SOURCE account
* Destination Address - Messages will go to this address

===Pushover.net===
[[File:Pushover_example.png|800px|border|Example of Pushover.net Notification Configuration]]
; Here is the configuration for a Pushover.net notification
* API Token - The API Token provided by Pushover for your User
* User/Group Key - The User or Group Key for your account at Pushover
* Message Priority - In what priority do you want alarm panel notifications
* Title of Message - Messages sent to Pushover are titled with this text

===Prowl===
[[File:Prowl_example.png|800px|border|Example of Prowl Notification Configuration]]
; Here is an example of a Prowl notification configuration
* API Key - Your Prowl API Key
* Application Name - Application to Show in Notifications
* Message Priority - What priority do you want alarm panel notifications to come through as

===NotifyMyAndroid===
[[File:Notifymyandroid_example.png|800px|border|Example of NotifyMyAndroid configuration]]
; Here is an example of a NotifyMyAndroid notification configuration
* API Key - Your NotifyMyAndroid API Key
* Application Name - Application Name to show in notifications
* Message Priority - What priority do you want Alarm Panel notifications to come through?

===Growl===
[[File:Growl_example.png|800px|border|Example of a Growl Notification]]
; An example of a Growl Notification configuration
* Hostname - The Growl server to send notification to
* Port - The Growl Server Port
* Password - The password for the Growl server
* Title - Notification Title
* Message Priority - What priority do you want these messages to come through as?

===Custom URL POST===
[[File:Custom_example.png|800px|border|Example of a Custom POST notification]]
; Here is an example configuration for a Custom POST notification
* POST URL - URL of server to POST data to
* POST Path - Location on server from URL to post to
* SSL? - Is the URL SSL or Not
* POST Type - urlencoded, JSON, or XML POST types supported
* Custom Values - Here you are able to create your own key/value pairs to send with your notification

==Configure IP Cameras==
; '''If you are not using our image, or an older version of the image, you must perform a few steps to enable Camera Support'''
* in the contrib directory of the webapp there is an opencv directory
* in the opencv directory execute
**sudo sh opencv.sh

* Once this is done and installed, you can then configure and view a camera.

[[File:Camera_list.png|800px|border|Example of Camera Listings]]
; Here you see the interface where it lists current cameras as well as a button for creating a new camera.

[[File:Create_camera.png|800px|border|Example of Creating Camera]]
; Here we are creating a camera for view in the system
* Name - The name of the camera for display purposes
* Snapshot URL - The full URL of the motion jpeg stream for your IP camera
* Username - The username for authenticating to the camera
* Password - The password for authenticating to the camera

==Host Settings==
; Found under settings->Host
[[File:Host_settings.png|800px|border|Example of Host Settings Page]]
; Here you are able to configure your device's hostname, networking, as well as reboot and shutdown the device.
===Reboot Device===
; Found under settings->Host
; Click Reboot button
===Shutdown Device===
; Found under settings->Host
; Click Shutdown button

==Add Users==
;Under Settings, click on Users - you will be presented with this screen:
[[File:User_list.png|800px|border|User List]]
;Here you are able to edit current users, or create new users.

;By clicking New User, you are then taken to this screen:
[[File:Create_user.png|800px|border|New User Screen]]
;Here you fill out the user's details and save. The user can now login to the webapp.

==Configuring SSL==
'''This is now enabled by default as of the 05-22-2015 software release.'''

;SSH into your raspberry pi
;First you must create your SSL certificates and put them in the correct location
<code>
sudo openssl req -x509 -nodes -days 365 -newkey rsa:2048 -keyout /etc/nginx/ssl/alarmdecoder.key -out /etc/nginx/ssl/alarmdecoder.crt
</code>
;Just make sure to fill in the values correctly for your certificate when prompted.

;Next you must edit your nginx alarmdecoder config under /etc/nginx/sites-enabled/alarmdecoder
<code>
server {
listen 80;
return 301 https://$host$request_uri;
}

server {
error_page 502 /502.html;

listen 443 default_server ssl;

ssl_certificate /etc/nginx/ssl/alarmdecoder.crt;
ssl_certificate_key /etc/nginx/ssl/alarmdecoder.key;

#ssl on;
ssl_session_cache builtin:1000 shared:SSL:10m;
ssl_protocols TLSv1 TLSv1.1 TLSv1.2;
#ssl_ciphers HIGH:MEDIUM:!aNULL:!eNULL:!EXPORT:!CAMELLIA:!DES:!MD5:!PSK:!RC4;
ssl_ciphers "ECDHE-RSA-AES256-GCM-SHA384:ECDHE-RSA-AES128-GCM-SHA256:DHE-RSA-AES256-GCM-SHA384:DHE-RSA-AES128-GCM-SHA256:ECDHE-RSA-AES256-SHA384:ECDHE-RSA-AES128-SHA256:ECDHE-RSA-AES256-SHA:ECDHE-RSA-AES128-SHA:DHE-RSA-AES256-SHA256:DHE-RSA-AES128-SHA256:DHE-RSA-AES256-SHA:DHE-RSA-AES128-SHA:ECDHE-RSA-DES-CBC3-SHA:EDH-RSA-DES-CBC3-SHA:AES256-GCM-SHA384:AES128-GCM-SHA256:AES256-SHA256:AES128-SHA256:AES256-SHA:AES128-SHA:DES-CBC3-SHA:HIGH:!aNULL:!eNULL:!EXPORT:!DES:!MD5:!PSK:!RC4";
ssl_prefer_server_ciphers on;

#error_page 497 https://$host:$server_port$request_uri;

gzip on;
gzip_disable "msie6";
gzip_vary on;
gzip_proxied any;
gzip_comp_level 6;
gzip_buffers 16 4k;
gzip_http_version 1.1;
gzip_types text/plain text/css application/json application/x-javascript text/xml application/xml application/xml+rss text/javascript;

location / {
try_files $uri @alarmdecoder;
}

location @alarmdecoder {
proxy_pass http://127.0.0.1:5000;
include uwsgi_params;
uwsgi_param UWSGI_SCHEME $scheme;
uwsgi_param SERVER_SOFTWARE nginx/$nginx_version;

proxy_redirect off;
proxy_http_version 1.1;
proxy_set_header Upgrade $http_upgrade;
proxy_set_header Connection "upgrade";
proxy_set_header Host $http_host;
proxy_set_header X-Real-IP $remote_addr;
proxy_set_header X-Forwarded-Proto $scheme;
proxy_set_header X-Forwarded-For $proxy_add_x_forwarded_for;
proxy_set_header X-Forwarded-Host $server_name;
proxy_set_header X-Scheme $scheme;
proxy_redirect http://localhost:5000 https://$host;
}

location /502.html {
root /opt/alarmdecoder-webapp/ad2web/static;
}

location ~ \.(jpg|jpeg|png|css|js)$ {
root /opt/alarmdecoder-webapp/ad2web;
}
}
</code>
;After this, restart the nginx service and you will have forced SSL.

==Port Forwarding==
;To access your WebApplication outside of your network, first you must do a "port forwarding" operation on your networking router/firewall - a NAT.
;Some ISPs filter standard server ports, so sometimes you will have to choose an external port that is not filtered. (Not 80, 25, 443).
;As an example, you may want to forward port 4443 on the outside network to port 443 of your Network Appliance. You then would hit your external IP Address on port 4443 from your web browser. https://public_ip_address:4443 which would then forward to port 443 of the network appliance - in SSL mode for security.
==Diagnostics==
; A Diagnostics Screen is provided under settings->Diagnostics
; This screen will allow you to test the functionality of the AlarmDecoder device as well as showing information about required modules.
[[File:Diagnostics_screen.png|border|800px|Diagnostics Screen]]

==Disclaimers==
; All other trademarks are the property of their respective owners.

AlarmDecoder WebApp

2015-08-24T19:21:37Z

204.10.16.29: /* Port Forwarding */

__TOC__
[[Category:Documentation]]
[[Category:FAQ]]
[[Category:Downloads]]
[[Category:Features]]

=AlarmDecoder WebApp=
==Overview==
; The official AlarmDecoder WebApp. Control your alarm system from your web browser on nearly any device. Supports all of the AlarmDecoder devices including the AD2USB, AD2SERIAL, and AD2PI.

===Features===
* Multiple User Accounts
* Web-based keypad for your alarm system
* Notifications on alarm events
* Per-user notifications
* IP Camera integration
* Supports all functionality of AlarmDecoder devices
* Configure your AlarmDecoder device
* Configure network sharing of your AlarmDecoder device
* Support for PC/Mac/Linux as well as Mobile and Tablet browsers

[[File:webappkeypad.png|border|Keypad Interface]]
; The AlarmDecoder WebApp Keypad Interface

==Installation==
; The easiest way to install the WebApp is by downloading our pre-built Raspbian image [http://www.alarmdecoder.com/wiki/index.php/Raspberry_Pi here]. However, you can follow the manual installation instructions provided on our github repository [https://github.com/nutechsoftware/alarmdecoder-webapp here]

==Initial Setup==
; Once the AlarmDecoder WebApp is started (it can take some time to initially start) you may connect to the Application via a web browser and pointing the URL to http://alarmdecoder.local - if this name resolution fails and you are on a Windows System, please download [https://support.apple.com/kb/DL999?locale=en_US Bonjour For Windows] and try again. This will take you to our first setup screens which will be detailed below. The device is initially configured for DHCP.

'''IF YOU BOUGHT A BUNDLE FROM US, IT IS ALREADY SET UP. YOU ONLY NEED TO GO THROUGH SETUP IF YOU NEED TO CHANGE DEFAULT ADDRESS OF DEVICE OTHERWISE CHECK [[Raspberry_Pi|HERE]] FOR DEFAULT PASSWORDS AND CHANGE THEM ACCORDINGLY'''

===Setup Process Detail===
; This is your first setup screen when you first visit via your browser
[[File:01_initial_setup.png|800px|border|First Setup Screen]]
; Click "Start!" to continue

; Next we will be taken to the device selection screen
[[File:02_device_type_settings.png|800px|border|Device Type Screen]]
; Here you are able to select what type of device (AD2USB, AD2SERIAL, AD2PI) as well as the device's location.
* [[#Local Device]] means the device is connected to the same computer running the WebApp
* [[#Network Device]] means you have already exposed an AlarmDecoder via ser2sock

====Local Device====
; If you choose Local Device, this next screen is what you are presented with
[[File:03_local_device_settings.png|800px|border|Local Device Settings]]
; Here you will choose your device path and baud rate, usually defaults are fine for the device you chose
; If you choose "Share AlarmDecoder on your network?" you will be taken to configure ser2sock shown below
[[File:04_ser2sock_configuration.png|800px|border|Setup Ser2sock]]
; On this screen you are able to specify the path to your ser2sock configuration file, your hostname or IP address to listen on, as well as the ser2sock port to listen on. Defaults will work fine. SSL will force ser2sock into SSL mode - this is typically not needed for your internal network.
* ser2sock Port is different from the HTTP/WSGI ports - do not choose 80, 443, or 5000.

Skip to [[#Configure Device]]

====Network Device====
; If you chose network device instead of local device, you are presented with this screen instead
[[File:05_network_device_settings.png|800px|border|Network Device Setup]]
; If you have an AlarmDecoder device shared on your network already via ser2sock, here you can specify the hostname and port for the WebApp to connect to the shared device.

====Configure Device====
; Once you have told the WebApp what kind of device you have and where it is, you will be presented with a page to configure the AlarmDecoder device itself
[[File:06_alarmdecoder_settings.png|800px|border|AlarmDecoder Device Settings]]
; Make sure to set your address correctly! 31 for SE Panels, and for 20P Panels you will have to program an address spot into your panel and assign the AlarmDecoder the newly enabled address. See [[http://www.alarmdecoder.com/wiki/index.php/Panel_Configuration Panel Configuration]]

; After you have completed all of the above steps, you will be taken to a Device Testing screen
[[File:07_device_testing.png|800px|border|Device Testing]]
; If any of these tests fail, please make sure your device is configured properly and installed properly.
;Here is an example of a successful device test
[[File:Success_device_testing.png|800px|border|Device Testing Success]]

; Once the device is communicating properly, you will be redirected to a page to create an initial user to log in to the WebApp
[[File:08_create_initial_account.png|800px|border|Initial User Creation]]
; After you have created your user, feel free to login and use the WebApp!

==Configure Notifications==
; Once you are logged in, go to Settings and click on Notifications. From there, you can edit already configured notifications or click "New Notification" to create a new notification.

[[File:Notifications_main.png|800px|border|Main Notification Interface]]
; This is the main interface for creating and listing notifications. Here you can choose to create new or edit existing notifications.

[[File:Notification_types.png|400px|border|List of Notification Types]]
; Here is a list of all current supported notification types.

[[File:Notification_common_settings.png|800px|border|List of Items to be Notified On]]
; Here is a list of all of the events that can trigger a notification. You are able to select which ones you would like to see. You can also have different notification types alert you for different kinds of notifications. This interface is common to all notification types.

===Email===
[[File:Notification_email_example.png|800px|border|Email Notification Example using gmail settings]]
; Here is an example email notification form using gmail settings for example
* Source Address - Emails appear "From" this address
* Destination Address - Emails will go "To" this address
* Email Subject - Emails will contain this subject line
* Email Server - The server to connect to when sending emails
* Server Port - The port of the email server to connect to
* Use TLS? - Enable Transport Layer Security for the session
* Authenticate with email server? - If a username and password is required by the email server to send, supply them
* Username - Your email username
* Password - Your email password

===SMS via Twilio===
[[File:Twilio_example.png|800px|border|Example of Twilio Notification Configuration]]
; Here is an example of a Twilio Notification configuration
* Account SID - Your Twilio Account SID
* Auth Token - Your Twilio User Auth Token
* To - Number to Send SMS to
* From - Your valid Twilio Phone Number

===Google Talk===
[[File:Googletalk_example.png|800px|border|Example of Google Talk Notification Configuration]]
; Here is an example of a Google Talk Notification configuration
* Source Address - Messages will come FROM this address
* Password - The password for the SOURCE account
* Destination Address - Messages will go to this address

===Pushover.net===
[[File:Pushover_example.png|800px|border|Example of Pushover.net Notification Configuration]]
; Here is the configuration for a Pushover.net notification
* API Token - The API Token provided by Pushover for your User
* User/Group Key - The User or Group Key for your account at Pushover
* Message Priority - In what priority do you want alarm panel notifications
* Title of Message - Messages sent to Pushover are titled with this text

===Prowl===
[[File:Prowl_example.png|800px|border|Example of Prowl Notification Configuration]]
; Here is an example of a Prowl notification configuration
* API Key - Your Prowl API Key
* Application Name - Application to Show in Notifications
* Message Priority - What priority do you want alarm panel notifications to come through as

===NotifyMyAndroid===
[[File:Notifymyandroid_example.png|800px|border|Example of NotifyMyAndroid configuration]]
; Here is an example of a NotifyMyAndroid notification configuration
* API Key - Your NotifyMyAndroid API Key
* Application Name - Application Name to show in notifications
* Message Priority - What priority do you want Alarm Panel notifications to come through?

===Growl===
[[File:Growl_example.png|800px|border|Example of a Growl Notification]]
; An example of a Growl Notification configuration
* Hostname - The Growl server to send notification to
* Port - The Growl Server Port
* Password - The password for the Growl server
* Title - Notification Title
* Message Priority - What priority do you want these messages to come through as?

===Custom URL POST===
[[File:Custom_example.png|800px|border|Example of a Custom POST notification]]
; Here is an example configuration for a Custom POST notification
* POST URL - URL of server to POST data to
* POST Path - Location on server from URL to post to
* SSL? - Is the URL SSL or Not
* POST Type - urlencoded, JSON, or XML POST types supported
* Custom Values - Here you are able to create your own key/value pairs to send with your notification

==Configure IP Cameras==
; '''If you are not using our image, or an older version of the image, you must perform a few steps to enable Camera Support'''
* in the contrib directory of the webapp there is an opencv directory
* in the opencv directory execute
**sudo sh opencv.sh

* Once this is done and installed, you can then configure and view a camera.

[[File:Camera_list.png|800px|border|Example of Camera Listings]]
; Here you see the interface where it lists current cameras as well as a button for creating a new camera.

[[File:Create_camera.png|800px|border|Example of Creating Camera]]
; Here we are creating a camera for view in the system
* Name - The name of the camera for display purposes
* Snapshot URL - The full URL of the motion jpeg stream for your IP camera
* Username - The username for authenticating to the camera
* Password - The password for authenticating to the camera

==Host Settings==
; Found under settings->Host
[[File:Host_settings.png|800px|border|Example of Host Settings Page]]
; Here you are able to configure your device's hostname, networking, as well as reboot and shutdown the device.
===Reboot Device===
; Found under settings->Host
; Click Reboot button
===Shutdown Device===
; Found under settings->Host
; Click Shutdown button

==Add Users==
;Under Settings, click on Users - you will be presented with this screen:
[[File:User_list.png|800px|border|User List]]
;Here you are able to edit current users, or create new users.

;By clicking New User, you are then taken to this screen:
[[File:Create_user.png|800px|border|New User Screen]]
;Here you fill out the user's details and save. The user can now login to the webapp.

==Configuring SSL==
'''This is now enabled by default as of the 05-22-2015 software release.'''

;SSH into your raspberry pi
;First you must create your SSL certificates and put them in the correct location
<code>
sudo openssl req -x509 -nodes -days 365 -newkey rsa:2048 -keyout /etc/nginx/ssl/alarmdecoder.key -out /etc/nginx/ssl/alarmdecoder.crt
</code>
;Just make sure to fill in the values correctly for your certificate when prompted.

;Next you must edit your nginx alarmdecoder config under /etc/nginx/sites-enabled/alarmdecoder
<code>
server {
listen 80;
return 301 https://$host$request_uri;
}

server {
error_page 502 /502.html;

listen 443 default_server ssl;

ssl_certificate /etc/nginx/ssl/alarmdecoder.crt;
ssl_certificate_key /etc/nginx/ssl/alarmdecoder.key;

#ssl on;
ssl_session_cache builtin:1000 shared:SSL:10m;
ssl_protocols TLSv1 TLSv1.1 TLSv1.2;
#ssl_ciphers HIGH:MEDIUM:!aNULL:!eNULL:!EXPORT:!CAMELLIA:!DES:!MD5:!PSK:!RC4;
ssl_ciphers "ECDHE-RSA-AES256-GCM-SHA384:ECDHE-RSA-AES128-GCM-SHA256:DHE-RSA-AES256-GCM-SHA384:DHE-RSA-AES128-GCM-SHA256:ECDHE-RSA-AES256-SHA384:ECDHE-RSA-AES128-SHA256:ECDHE-RSA-AES256-SHA:ECDHE-RSA-AES128-SHA:DHE-RSA-AES256-SHA256:DHE-RSA-AES128-SHA256:DHE-RSA-AES256-SHA:DHE-RSA-AES128-SHA:ECDHE-RSA-DES-CBC3-SHA:EDH-RSA-DES-CBC3-SHA:AES256-GCM-SHA384:AES128-GCM-SHA256:AES256-SHA256:AES128-SHA256:AES256-SHA:AES128-SHA:DES-CBC3-SHA:HIGH:!aNULL:!eNULL:!EXPORT:!DES:!MD5:!PSK:!RC4";
ssl_prefer_server_ciphers on;

#error_page 497 https://$host:$server_port$request_uri;

gzip on;
gzip_disable "msie6";
gzip_vary on;
gzip_proxied any;
gzip_comp_level 6;
gzip_buffers 16 4k;
gzip_http_version 1.1;
gzip_types text/plain text/css application/json application/x-javascript text/xml application/xml application/xml+rss text/javascript;

location / {
try_files $uri @alarmdecoder;
}

location @alarmdecoder {
proxy_pass http://127.0.0.1:5000;
include uwsgi_params;
uwsgi_param UWSGI_SCHEME $scheme;
uwsgi_param SERVER_SOFTWARE nginx/$nginx_version;

proxy_redirect off;
proxy_http_version 1.1;
proxy_set_header Upgrade $http_upgrade;
proxy_set_header Connection "upgrade";
proxy_set_header Host $http_host;
proxy_set_header X-Real-IP $remote_addr;
proxy_set_header X-Forwarded-Proto $scheme;
proxy_set_header X-Forwarded-For $proxy_add_x_forwarded_for;
proxy_set_header X-Forwarded-Host $server_name;
proxy_set_header X-Scheme $scheme;
proxy_redirect http://localhost:5000 https://$host;
}

location /502.html {
root /opt/alarmdecoder-webapp/ad2web/static;
}

location ~ \.(jpg|jpeg|png|css|js)$ {
root /opt/alarmdecoder-webapp/ad2web;
}
}
</code>
;After this, restart the nginx service and you will have forced SSL.

==Port Forwarding==
;To access your WebApplication outside of your network, first you must do a "port forwarding" operation on your networking router/firewall - a NAT.
;Some ISPs filter standard server ports, so sometimes you will have to choose an external port that is not filtered. (Not 80, 25, 443).
;As an example, you may want to forward port 4443 on the outside network to port 443 of your Network Appliance. You then would hit your external IP Address on port 4443 from your web browser. https://public_ip_address:4443 which would then forward to port 443 of the network appliance - in SSL mode for security.
==Diagnostics==
; A Diagnostics Screen is provided under settings->Diagnostics
; This screen will allow you to test the functionality of the AlarmDecoder device as well as showing information about required modules.
[[File:Diagnostics_screen.png|border|800px]]

==Disclaimers==
; All other trademarks are the property of their respective owners.

File:Diagnostics screen.png

2015-08-24T19:19:15Z

204.10.16.29: The AlarmDecoder WebApp Diagnostics Screen - Here you can test your device as well as show information about required modules.

The AlarmDecoder WebApp Diagnostics Screen - Here you can test your device as well as show information about required modules.

AlarmDecoder WebApp

2015-08-24T19:17:10Z

204.10.16.29: /* Host Settings */

__TOC__
[[Category:Documentation]]
[[Category:FAQ]]
[[Category:Downloads]]
[[Category:Features]]

=AlarmDecoder WebApp=
==Overview==
; The official AlarmDecoder WebApp. Control your alarm system from your web browser on nearly any device. Supports all of the AlarmDecoder devices including the AD2USB, AD2SERIAL, and AD2PI.

===Features===
* Multiple User Accounts
* Web-based keypad for your alarm system
* Notifications on alarm events
* Per-user notifications
* IP Camera integration
* Supports all functionality of AlarmDecoder devices
* Configure your AlarmDecoder device
* Configure network sharing of your AlarmDecoder device
* Support for PC/Mac/Linux as well as Mobile and Tablet browsers

[[File:webappkeypad.png|border|Keypad Interface]]
; The AlarmDecoder WebApp Keypad Interface

==Installation==
; The easiest way to install the WebApp is by downloading our pre-built Raspbian image [http://www.alarmdecoder.com/wiki/index.php/Raspberry_Pi here]. However, you can follow the manual installation instructions provided on our github repository [https://github.com/nutechsoftware/alarmdecoder-webapp here]

==Initial Setup==
; Once the AlarmDecoder WebApp is started (it can take some time to initially start) you may connect to the Application via a web browser and pointing the URL to http://alarmdecoder.local - if this name resolution fails and you are on a Windows System, please download [https://support.apple.com/kb/DL999?locale=en_US Bonjour For Windows] and try again. This will take you to our first setup screens which will be detailed below. The device is initially configured for DHCP.

'''IF YOU BOUGHT A BUNDLE FROM US, IT IS ALREADY SET UP. YOU ONLY NEED TO GO THROUGH SETUP IF YOU NEED TO CHANGE DEFAULT ADDRESS OF DEVICE OTHERWISE CHECK [[Raspberry_Pi|HERE]] FOR DEFAULT PASSWORDS AND CHANGE THEM ACCORDINGLY'''

===Setup Process Detail===
; This is your first setup screen when you first visit via your browser
[[File:01_initial_setup.png|800px|border|First Setup Screen]]
; Click "Start!" to continue

; Next we will be taken to the device selection screen
[[File:02_device_type_settings.png|800px|border|Device Type Screen]]
; Here you are able to select what type of device (AD2USB, AD2SERIAL, AD2PI) as well as the device's location.
* [[#Local Device]] means the device is connected to the same computer running the WebApp
* [[#Network Device]] means you have already exposed an AlarmDecoder via ser2sock

====Local Device====
; If you choose Local Device, this next screen is what you are presented with
[[File:03_local_device_settings.png|800px|border|Local Device Settings]]
; Here you will choose your device path and baud rate, usually defaults are fine for the device you chose
; If you choose "Share AlarmDecoder on your network?" you will be taken to configure ser2sock shown below
[[File:04_ser2sock_configuration.png|800px|border|Setup Ser2sock]]
; On this screen you are able to specify the path to your ser2sock configuration file, your hostname or IP address to listen on, as well as the ser2sock port to listen on. Defaults will work fine. SSL will force ser2sock into SSL mode - this is typically not needed for your internal network.
* ser2sock Port is different from the HTTP/WSGI ports - do not choose 80, 443, or 5000.

Skip to [[#Configure Device]]

====Network Device====
; If you chose network device instead of local device, you are presented with this screen instead
[[File:05_network_device_settings.png|800px|border|Network Device Setup]]
; If you have an AlarmDecoder device shared on your network already via ser2sock, here you can specify the hostname and port for the WebApp to connect to the shared device.

====Configure Device====
; Once you have told the WebApp what kind of device you have and where it is, you will be presented with a page to configure the AlarmDecoder device itself
[[File:06_alarmdecoder_settings.png|800px|border|AlarmDecoder Device Settings]]
; Make sure to set your address correctly! 31 for SE Panels, and for 20P Panels you will have to program an address spot into your panel and assign the AlarmDecoder the newly enabled address. See [[http://www.alarmdecoder.com/wiki/index.php/Panel_Configuration Panel Configuration]]

; After you have completed all of the above steps, you will be taken to a Device Testing screen
[[File:07_device_testing.png|800px|border|Device Testing]]
; If any of these tests fail, please make sure your device is configured properly and installed properly.
;Here is an example of a successful device test
[[File:Success_device_testing.png|800px|border|Device Testing Success]]

; Once the device is communicating properly, you will be redirected to a page to create an initial user to log in to the WebApp
[[File:08_create_initial_account.png|800px|border|Initial User Creation]]
; After you have created your user, feel free to login and use the WebApp!

==Configure Notifications==
; Once you are logged in, go to Settings and click on Notifications. From there, you can edit already configured notifications or click "New Notification" to create a new notification.

[[File:Notifications_main.png|800px|border|Main Notification Interface]]
; This is the main interface for creating and listing notifications. Here you can choose to create new or edit existing notifications.

[[File:Notification_types.png|400px|border|List of Notification Types]]
; Here is a list of all current supported notification types.

[[File:Notification_common_settings.png|800px|border|List of Items to be Notified On]]
; Here is a list of all of the events that can trigger a notification. You are able to select which ones you would like to see. You can also have different notification types alert you for different kinds of notifications. This interface is common to all notification types.

===Email===
[[File:Notification_email_example.png|800px|border|Email Notification Example using gmail settings]]
; Here is an example email notification form using gmail settings for example
* Source Address - Emails appear "From" this address
* Destination Address - Emails will go "To" this address
* Email Subject - Emails will contain this subject line
* Email Server - The server to connect to when sending emails
* Server Port - The port of the email server to connect to
* Use TLS? - Enable Transport Layer Security for the session
* Authenticate with email server? - If a username and password is required by the email server to send, supply them
* Username - Your email username
* Password - Your email password

===SMS via Twilio===
[[File:Twilio_example.png|800px|border|Example of Twilio Notification Configuration]]
; Here is an example of a Twilio Notification configuration
* Account SID - Your Twilio Account SID
* Auth Token - Your Twilio User Auth Token
* To - Number to Send SMS to
* From - Your valid Twilio Phone Number

===Google Talk===
[[File:Googletalk_example.png|800px|border|Example of Google Talk Notification Configuration]]
; Here is an example of a Google Talk Notification configuration
* Source Address - Messages will come FROM this address
* Password - The password for the SOURCE account
* Destination Address - Messages will go to this address

===Pushover.net===
[[File:Pushover_example.png|800px|border|Example of Pushover.net Notification Configuration]]
; Here is the configuration for a Pushover.net notification
* API Token - The API Token provided by Pushover for your User
* User/Group Key - The User or Group Key for your account at Pushover
* Message Priority - In what priority do you want alarm panel notifications
* Title of Message - Messages sent to Pushover are titled with this text

===Prowl===
[[File:Prowl_example.png|800px|border|Example of Prowl Notification Configuration]]
; Here is an example of a Prowl notification configuration
* API Key - Your Prowl API Key
* Application Name - Application to Show in Notifications
* Message Priority - What priority do you want alarm panel notifications to come through as

===NotifyMyAndroid===
[[File:Notifymyandroid_example.png|800px|border|Example of NotifyMyAndroid configuration]]
; Here is an example of a NotifyMyAndroid notification configuration
* API Key - Your NotifyMyAndroid API Key
* Application Name - Application Name to show in notifications
* Message Priority - What priority do you want Alarm Panel notifications to come through?

===Growl===
[[File:Growl_example.png|800px|border|Example of a Growl Notification]]
; An example of a Growl Notification configuration
* Hostname - The Growl server to send notification to
* Port - The Growl Server Port
* Password - The password for the Growl server
* Title - Notification Title
* Message Priority - What priority do you want these messages to come through as?

===Custom URL POST===
[[File:Custom_example.png|800px|border|Example of a Custom POST notification]]
; Here is an example configuration for a Custom POST notification
* POST URL - URL of server to POST data to
* POST Path - Location on server from URL to post to
* SSL? - Is the URL SSL or Not
* POST Type - urlencoded, JSON, or XML POST types supported
* Custom Values - Here you are able to create your own key/value pairs to send with your notification

==Configure IP Cameras==
; '''If you are not using our image, or an older version of the image, you must perform a few steps to enable Camera Support'''
* in the contrib directory of the webapp there is an opencv directory
* in the opencv directory execute
**sudo sh opencv.sh

* Once this is done and installed, you can then configure and view a camera.

[[File:Camera_list.png|800px|border|Example of Camera Listings]]
; Here you see the interface where it lists current cameras as well as a button for creating a new camera.

[[File:Create_camera.png|800px|border|Example of Creating Camera]]
; Here we are creating a camera for view in the system
* Name - The name of the camera for display purposes
* Snapshot URL - The full URL of the motion jpeg stream for your IP camera
* Username - The username for authenticating to the camera
* Password - The password for authenticating to the camera

==Host Settings==
; Found under settings->Host
[[File:Host_settings.png|800px|border|Example of Host Settings Page]]
; Here you are able to configure your device's hostname, networking, as well as reboot and shutdown the device.
===Reboot Device===
; Found under settings->Host
; Click Reboot button
===Shutdown Device===
; Found under settings->Host
; Click Shutdown button

==Add Users==
;Under Settings, click on Users - you will be presented with this screen:
[[File:User_list.png|800px|border|User List]]
;Here you are able to edit current users, or create new users.

;By clicking New User, you are then taken to this screen:
[[File:Create_user.png|800px|border|New User Screen]]
;Here you fill out the user's details and save. The user can now login to the webapp.

==Configuring SSL==
'''This is now enabled by default as of the 05-22-2015 software release.'''

;SSH into your raspberry pi
;First you must create your SSL certificates and put them in the correct location
<code>
sudo openssl req -x509 -nodes -days 365 -newkey rsa:2048 -keyout /etc/nginx/ssl/alarmdecoder.key -out /etc/nginx/ssl/alarmdecoder.crt
</code>
;Just make sure to fill in the values correctly for your certificate when prompted.

;Next you must edit your nginx alarmdecoder config under /etc/nginx/sites-enabled/alarmdecoder
<code>
server {
listen 80;
return 301 https://$host$request_uri;
}

server {
error_page 502 /502.html;

listen 443 default_server ssl;

ssl_certificate /etc/nginx/ssl/alarmdecoder.crt;
ssl_certificate_key /etc/nginx/ssl/alarmdecoder.key;

#ssl on;
ssl_session_cache builtin:1000 shared:SSL:10m;
ssl_protocols TLSv1 TLSv1.1 TLSv1.2;
#ssl_ciphers HIGH:MEDIUM:!aNULL:!eNULL:!EXPORT:!CAMELLIA:!DES:!MD5:!PSK:!RC4;
ssl_ciphers "ECDHE-RSA-AES256-GCM-SHA384:ECDHE-RSA-AES128-GCM-SHA256:DHE-RSA-AES256-GCM-SHA384:DHE-RSA-AES128-GCM-SHA256:ECDHE-RSA-AES256-SHA384:ECDHE-RSA-AES128-SHA256:ECDHE-RSA-AES256-SHA:ECDHE-RSA-AES128-SHA:DHE-RSA-AES256-SHA256:DHE-RSA-AES128-SHA256:DHE-RSA-AES256-SHA:DHE-RSA-AES128-SHA:ECDHE-RSA-DES-CBC3-SHA:EDH-RSA-DES-CBC3-SHA:AES256-GCM-SHA384:AES128-GCM-SHA256:AES256-SHA256:AES128-SHA256:AES256-SHA:AES128-SHA:DES-CBC3-SHA:HIGH:!aNULL:!eNULL:!EXPORT:!DES:!MD5:!PSK:!RC4";
ssl_prefer_server_ciphers on;

#error_page 497 https://$host:$server_port$request_uri;

gzip on;
gzip_disable "msie6";
gzip_vary on;
gzip_proxied any;
gzip_comp_level 6;
gzip_buffers 16 4k;
gzip_http_version 1.1;
gzip_types text/plain text/css application/json application/x-javascript text/xml application/xml application/xml+rss text/javascript;

location / {
try_files $uri @alarmdecoder;
}

location @alarmdecoder {
proxy_pass http://127.0.0.1:5000;
include uwsgi_params;
uwsgi_param UWSGI_SCHEME $scheme;
uwsgi_param SERVER_SOFTWARE nginx/$nginx_version;

proxy_redirect off;
proxy_http_version 1.1;
proxy_set_header Upgrade $http_upgrade;
proxy_set_header Connection "upgrade";
proxy_set_header Host $http_host;
proxy_set_header X-Real-IP $remote_addr;
proxy_set_header X-Forwarded-Proto $scheme;
proxy_set_header X-Forwarded-For $proxy_add_x_forwarded_for;
proxy_set_header X-Forwarded-Host $server_name;
proxy_set_header X-Scheme $scheme;
proxy_redirect http://localhost:5000 https://$host;
}

location /502.html {
root /opt/alarmdecoder-webapp/ad2web/static;
}

location ~ \.(jpg|jpeg|png|css|js)$ {
root /opt/alarmdecoder-webapp/ad2web;
}
}
</code>
;After this, restart the nginx service and you will have forced SSL.

==Port Forwarding==
;To access your WebApplication outside of your network, first you must do a "port forwarding" operation on your networking router/firewall - a NAT.
;Some ISPs filter standard server ports, so sometimes you will have to choose an external port that is not filtered. (Not 80, 25, 443).
;As an example, you may want to forward port 4443 on the outside network to port 443 of your Network Appliance. You then would hit your external IP Address on port 4443 from your web browser. https://public_ip_address:4443 which would then forward to port 443 of the network appliance - in SSL mode for security.

==Disclaimers==
; All other trademarks are the property of their respective owners.

AlarmDecoder WebApp

2015-08-10T19:12:30Z

204.10.16.29: /* Configuring SSL */

__TOC__
[[Category:Documentation]]
[[Category:FAQ]]
[[Category:Downloads]]
[[Category:Features]]

=AlarmDecoder WebApp=
==Overview==
; The official AlarmDecoder WebApp. Control your alarm system from your web browser on nearly any device. Supports all of the AlarmDecoder devices including the AD2USB, AD2SERIAL, and AD2PI.

===Features===
* Multiple User Accounts
* Web-based keypad for your alarm system
* Notifications on alarm events
* Per-user notifications
* IP Camera integration
* Supports all functionality of AlarmDecoder devices
* Configure your AlarmDecoder device
* Configure network sharing of your AlarmDecoder device
* Support for PC/Mac/Linux as well as Mobile and Tablet browsers

[[File:webappkeypad.png|border|Keypad Interface]]
; The AlarmDecoder WebApp Keypad Interface

==Installation==
; The easiest way to install the WebApp is by downloading our pre-built Raspbian image [http://www.alarmdecoder.com/wiki/index.php/Raspberry_Pi here]. However, you can follow the manual installation instructions provided on our github repository [https://github.com/nutechsoftware/alarmdecoder-webapp here]

==Initial Setup==
; Once the AlarmDecoder WebApp is started (it can take some time to initially start) you may connect to the Application via a web browser and pointing the URL to http://alarmdecoder.local - if this name resolution fails and you are on a Windows System, please download [https://support.apple.com/kb/DL999?locale=en_US Bonjour For Windows] and try again. This will take you to our first setup screens which will be detailed below. The device is initially configured for DHCP.

'''IF YOU BOUGHT A BUNDLE FROM US, IT IS ALREADY SET UP. YOU ONLY NEED TO GO THROUGH SETUP IF YOU NEED TO CHANGE DEFAULT ADDRESS OF DEVICE OTHERWISE CHECK [[Raspberry_Pi|HERE]] FOR DEFAULT PASSWORDS AND CHANGE THEM ACCORDINGLY'''

===Setup Process Detail===
; This is your first setup screen when you first visit via your browser
[[File:01_initial_setup.png|800px|border|First Setup Screen]]
; Click "Start!" to continue

; Next we will be taken to the device selection screen
[[File:02_device_type_settings.png|800px|border|Device Type Screen]]
; Here you are able to select what type of device (AD2USB, AD2SERIAL, AD2PI) as well as the device's location.
* [[#Local Device]] means the device is connected to the same computer running the WebApp
* [[#Network Device]] means you have already exposed an AlarmDecoder via ser2sock

====Local Device====
; If you choose Local Device, this next screen is what you are presented with
[[File:03_local_device_settings.png|800px|border|Local Device Settings]]
; Here you will choose your device path and baud rate, usually defaults are fine for the device you chose
; If you choose "Share AlarmDecoder on your network?" you will be taken to configure ser2sock shown below
[[File:04_ser2sock_configuration.png|800px|border|Setup Ser2sock]]
; On this screen you are able to specify the path to your ser2sock configuration file, your hostname or IP address to listen on, as well as the ser2sock port to listen on. Defaults will work fine. SSL will force ser2sock into SSL mode - this is typically not needed for your internal network.
* ser2sock Port is different from the HTTP/WSGI ports - do not choose 80, 443, or 5000.

Skip to [[#Configure Device]]

====Network Device====
; If you chose network device instead of local device, you are presented with this screen instead
[[File:05_network_device_settings.png|800px|border|Network Device Setup]]
; If you have an AlarmDecoder device shared on your network already via ser2sock, here you can specify the hostname and port for the WebApp to connect to the shared device.

====Configure Device====
; Once you have told the WebApp what kind of device you have and where it is, you will be presented with a page to configure the AlarmDecoder device itself
[[File:06_alarmdecoder_settings.png|800px|border|AlarmDecoder Device Settings]]
; Make sure to set your address correctly! 31 for SE Panels, and for 20P Panels you will have to program an address spot into your panel and assign the AlarmDecoder the newly enabled address. See [[http://www.alarmdecoder.com/wiki/index.php/Panel_Configuration Panel Configuration]]

; After you have completed all of the above steps, you will be taken to a Device Testing screen
[[File:07_device_testing.png|800px|border|Device Testing]]
; If any of these tests fail, please make sure your device is configured properly and installed properly.
;Here is an example of a successful device test
[[File:Success_device_testing.png|800px|border|Device Testing Success]]

; Once the device is communicating properly, you will be redirected to a page to create an initial user to log in to the WebApp
[[File:08_create_initial_account.png|800px|border|Initial User Creation]]
; After you have created your user, feel free to login and use the WebApp!

==Configure Notifications==
; Once you are logged in, go to Settings and click on Notifications. From there, you can edit already configured notifications or click "New Notification" to create a new notification.

[[File:Notifications_main.png|800px|border|Main Notification Interface]]
; This is the main interface for creating and listing notifications. Here you can choose to create new or edit existing notifications.

[[File:Notification_types.png|400px|border|List of Notification Types]]
; Here is a list of all current supported notification types.

[[File:Notification_common_settings.png|800px|border|List of Items to be Notified On]]
; Here is a list of all of the events that can trigger a notification. You are able to select which ones you would like to see. You can also have different notification types alert you for different kinds of notifications. This interface is common to all notification types.

===Email===
[[File:Notification_email_example.png|800px|border|Email Notification Example using gmail settings]]
; Here is an example email notification form using gmail settings for example
* Source Address - Emails appear "From" this address
* Destination Address - Emails will go "To" this address
* Email Subject - Emails will contain this subject line
* Email Server - The server to connect to when sending emails
* Server Port - The port of the email server to connect to
* Use TLS? - Enable Transport Layer Security for the session
* Authenticate with email server? - If a username and password is required by the email server to send, supply them
* Username - Your email username
* Password - Your email password

===SMS via Twilio===
[[File:Twilio_example.png|800px|border|Example of Twilio Notification Configuration]]
; Here is an example of a Twilio Notification configuration
* Account SID - Your Twilio Account SID
* Auth Token - Your Twilio User Auth Token
* To - Number to Send SMS to
* From - Your valid Twilio Phone Number

===Google Talk===
[[File:Googletalk_example.png|800px|border|Example of Google Talk Notification Configuration]]
; Here is an example of a Google Talk Notification configuration
* Source Address - Messages will come FROM this address
* Password - The password for the SOURCE account
* Destination Address - Messages will go to this address

===Pushover.net===
[[File:Pushover_example.png|800px|border|Example of Pushover.net Notification Configuration]]
; Here is the configuration for a Pushover.net notification
* API Token - The API Token provided by Pushover for your User
* User/Group Key - The User or Group Key for your account at Pushover
* Message Priority - In what priority do you want alarm panel notifications
* Title of Message - Messages sent to Pushover are titled with this text

===Prowl===
[[File:Prowl_example.png|800px|border|Example of Prowl Notification Configuration]]
; Here is an example of a Prowl notification configuration
* API Key - Your Prowl API Key
* Application Name - Application to Show in Notifications
* Message Priority - What priority do you want alarm panel notifications to come through as

===NotifyMyAndroid===
[[File:Notifymyandroid_example.png|800px|border|Example of NotifyMyAndroid configuration]]
; Here is an example of a NotifyMyAndroid notification configuration
* API Key - Your NotifyMyAndroid API Key
* Application Name - Application Name to show in notifications
* Message Priority - What priority do you want Alarm Panel notifications to come through?

===Growl===
[[File:Growl_example.png|800px|border|Example of a Growl Notification]]
; An example of a Growl Notification configuration
* Hostname - The Growl server to send notification to
* Port - The Growl Server Port
* Password - The password for the Growl server
* Title - Notification Title
* Message Priority - What priority do you want these messages to come through as?

===Custom URL POST===
[[File:Custom_example.png|800px|border|Example of a Custom POST notification]]
; Here is an example configuration for a Custom POST notification
* POST URL - URL of server to POST data to
* POST Path - Location on server from URL to post to
* SSL? - Is the URL SSL or Not
* POST Type - urlencoded, JSON, or XML POST types supported
* Custom Values - Here you are able to create your own key/value pairs to send with your notification

==Configure IP Cameras==
; '''If you are not using our image, or an older version of the image, you must perform a few steps to enable Camera Support'''
* in the contrib directory of the webapp there is an opencv directory
* in the opencv directory execute
**sudo sh opencv.sh

* Once this is done and installed, you can then configure and view a camera.

[[File:Camera_list.png|800px|border|Example of Camera Listings]]
; Here you see the interface where it lists current cameras as well as a button for creating a new camera.

[[File:Create_camera.png|800px|border|Example of Creating Camera]]
; Here we are creating a camera for view in the system
* Name - The name of the camera for display purposes
* Snapshot URL - The full URL of the motion jpeg stream for your IP camera
* Username - The username for authenticating to the camera
* Password - The password for authenticating to the camera

==Host Settings==
; Found under settings->Host
[[File:Host_settings.png|800px|border|Example of Host Settings Page]]
; Here you are able to configure your device's hostname, networking, as well as reboot and shutdown the device.

==Add Users==
;Under Settings, click on Users - you will be presented with this screen:
[[File:User_list.png|800px|border|User List]]
;Here you are able to edit current users, or create new users.

;By clicking New User, you are then taken to this screen:
[[File:Create_user.png|800px|border|New User Screen]]
;Here you fill out the user's details and save. The user can now login to the webapp.

==Configuring SSL==
'''This is now enabled by default as of the 05-22-2015 software release.'''

;SSH into your raspberry pi
;First you must create your SSL certificates and put them in the correct location
<code>
sudo openssl req -x509 -nodes -days 365 -newkey rsa:2048 -keyout /etc/nginx/ssl/alarmdecoder.key -out /etc/nginx/ssl/alarmdecoder.crt
</code>
;Just make sure to fill in the values correctly for your certificate when prompted.

;Next you must edit your nginx alarmdecoder config under /etc/nginx/sites-enabled/alarmdecoder
<code>
server {
listen 80;
return 301 https://$host$request_uri;
}

server {
error_page 502 /502.html;

listen 443 default_server ssl;

ssl_certificate /etc/nginx/ssl/alarmdecoder.crt;
ssl_certificate_key /etc/nginx/ssl/alarmdecoder.key;

#ssl on;
ssl_session_cache builtin:1000 shared:SSL:10m;
ssl_protocols TLSv1 TLSv1.1 TLSv1.2;
#ssl_ciphers HIGH:MEDIUM:!aNULL:!eNULL:!EXPORT:!CAMELLIA:!DES:!MD5:!PSK:!RC4;
ssl_ciphers "ECDHE-RSA-AES256-GCM-SHA384:ECDHE-RSA-AES128-GCM-SHA256:DHE-RSA-AES256-GCM-SHA384:DHE-RSA-AES128-GCM-SHA256:ECDHE-RSA-AES256-SHA384:ECDHE-RSA-AES128-SHA256:ECDHE-RSA-AES256-SHA:ECDHE-RSA-AES128-SHA:DHE-RSA-AES256-SHA256:DHE-RSA-AES128-SHA256:DHE-RSA-AES256-SHA:DHE-RSA-AES128-SHA:ECDHE-RSA-DES-CBC3-SHA:EDH-RSA-DES-CBC3-SHA:AES256-GCM-SHA384:AES128-GCM-SHA256:AES256-SHA256:AES128-SHA256:AES256-SHA:AES128-SHA:DES-CBC3-SHA:HIGH:!aNULL:!eNULL:!EXPORT:!DES:!MD5:!PSK:!RC4";
ssl_prefer_server_ciphers on;

#error_page 497 https://$host:$server_port$request_uri;

gzip on;
gzip_disable "msie6";
gzip_vary on;
gzip_proxied any;
gzip_comp_level 6;
gzip_buffers 16 4k;
gzip_http_version 1.1;
gzip_types text/plain text/css application/json application/x-javascript text/xml application/xml application/xml+rss text/javascript;

location / {
try_files $uri @alarmdecoder;
}

location @alarmdecoder {
proxy_pass http://127.0.0.1:5000;
include uwsgi_params;
uwsgi_param UWSGI_SCHEME $scheme;
uwsgi_param SERVER_SOFTWARE nginx/$nginx_version;

proxy_redirect off;
proxy_http_version 1.1;
proxy_set_header Upgrade $http_upgrade;
proxy_set_header Connection "upgrade";
proxy_set_header Host $http_host;
proxy_set_header X-Real-IP $remote_addr;
proxy_set_header X-Forwarded-Proto $scheme;
proxy_set_header X-Forwarded-For $proxy_add_x_forwarded_for;
proxy_set_header X-Forwarded-Host $server_name;
proxy_set_header X-Scheme $scheme;
proxy_redirect http://localhost:5000 https://$host;
}

location /502.html {
root /opt/alarmdecoder-webapp/ad2web/static;
}

location ~ \.(jpg|jpeg|png|css|js)$ {
root /opt/alarmdecoder-webapp/ad2web;
}
}
</code>
;After this, restart the nginx service and you will have forced SSL.

==Port Forwarding==
;To access your WebApplication outside of your network, first you must do a "port forwarding" operation on your networking router/firewall - a NAT.
;Some ISPs filter standard server ports, so sometimes you will have to choose an external port that is not filtered. (Not 80, 25, 443).
;As an example, you may want to forward port 4443 on the outside network to port 443 of your Network Appliance. You then would hit your external IP Address on port 4443 from your web browser. https://public_ip_address:4443 which would then forward to port 443 of the network appliance - in SSL mode for security.

==Disclaimers==
; All other trademarks are the property of their respective owners.