http://www.alarmdecoder.com/wiki/api.php?action=feedcontributions&user=204.10.16.14&feedformat=atom Alarm Decoder Wiki - User contributions [en] 2024-03-28T15:26:43Z User contributions MediaWiki 1.21.1 http://www.alarmdecoder.com/wiki/index.php/Protocol Protocol 2021-05-04T05:12:37Z <p>204.10.16.14: </p> <hr /> <div>[[Category:FAQ]]<br /> [[Category:Documentation]]<br /> [[Category:Specifications]]<br /> [[Category:Features]]<br /> <br /> =Commands=<br /> {| class=&quot;wikitable&quot; border=&quot;1&quot;<br /> ! scope=&quot;col&quot; | Command<br /> ! scope=&quot;col&quot; | Description<br /> |-<br /> | align=&quot;center&quot; | =<br /> | align=&quot;center&quot; | [[#Reboot|Reboot]] the device.<br /> |-<br /> | align=&quot;center&quot; | !<br /> | align=&quot;center&quot; | [[#Device Configuration|Configure]] the device via prompts.<br /> |-<br /> | align=&quot;center&quot; | C<br /> | align=&quot;center&quot; | Sets or retrieves [[#Device Configuration|configuration parameters]].<br /> |-<br /> | align=&quot;center&quot; | L<br /> | align=&quot;center&quot; | [[#Zone Emulation|Emulate]] virtual zone opens and closes.<br /> |-<br /> | align=&quot;center&quot; | E<br /> | align=&quot;center&quot; | Dump error report and clear error history. [[#Error_message_report|Error report]]<br /> |-<br /> | align=&quot;center&quot; | V<br /> | align=&quot;center&quot; | Dump the version, serial number and flags used in the firmware.<br /> |-<br /> | align=&quot;center&quot; | K<br /> | align=&quot;center&quot; | Send message from specific partition or keypad address. [[#Addressed Message|Addressed Message]]<br /> |-<br /> | align=&quot;center&quot; | R<br /> | align=&quot;center&quot; | &lt;b&gt;Host Ack&lt;/b&gt;nowledge the [[#CRC|CRC]] message was valid.<br /> |-<br /> | align=&quot;center&quot; | \x01\x01\x01<br /> | align=&quot;center&quot; | Send [[#Special Keys|Special Key]] #1<br /> |-<br /> | align=&quot;center&quot; | \x02\x02\x02<br /> | align=&quot;center&quot; | Send [[#Special Keys|Special Key]] #2<br /> |-<br /> | align=&quot;center&quot; | \x03\x03\x03<br /> | align=&quot;center&quot; | Send [[#Special Keys|Special Key]] #3<br /> |-<br /> | align=&quot;center&quot; | \x04\x04\x04<br /> | align=&quot;center&quot; | Send [[#Special Keys|Special Key]] #4<br /> |-<br /> | align=&quot;center&quot; | \x05\x05\x05<br /> | align=&quot;center&quot; | Send [[#Special Keys|Special Key]] #5<br /> |-<br /> | align=&quot;center&quot; | \x06\x06\x06<br /> | align=&quot;center&quot; | Send [[#Special Keys|Special Key]] #6<br /> |-<br /> | align=&quot;center&quot; | \x07\x07\x07<br /> | align=&quot;center&quot; | Send [[#Special Keys|Special Key]] #7<br /> |-<br /> | align=&quot;center&quot; | \x08\x08\x08<br /> | align=&quot;center&quot; | Send [[#Special Keys|Special Key]] #8<br /> |-<br /> | align=&quot;center&quot; | a<br /> | align=&quot;center&quot; | DSC ONLY(deprecated use Special Keys): Arm Away<br /> |-<br /> | align=&quot;center&quot; | s<br /> | align=&quot;center&quot; | DSC ONLY(deprecated use Special Keys): Arm Stay<br /> |-<br /> | align=&quot;center&quot; | c<br /> | align=&quot;center&quot; | DSC ONLY(deprecated use Special Keys): Toggle Chime<br /> |-<br /> | align=&quot;center&quot; | 0123456789*#&lt;&gt;<br /> | align=&quot;center&quot; | Send key to panel<br /> |}<br /> <br /> ==Arming==<br /> The standard keypad keys when received by the AD2 will be treated as keypad press commands and sent to the alarm panel from the current address. If using the [[#Addressed Message|K command]] the keys will continue to be sent from the specified address until the AD2 receives a \r or \n at that point the AD2 will revert back to the configured address.<br /> <br /> ==Reboot==<br /> Rebooting the device is as simple as sending &lt;b&gt;=&lt;/b&gt; to it.<br /> <br /> During the boot process you can trigger a firmware upload by sending a second &lt;b&gt;=&lt;/b&gt; to the device after the &lt;i&gt;!boot&lt;/i&gt; message is received. At this point you'll receive a &lt;i&gt;!load&lt;/i&gt; and can begin uploading.<br /> <br /> ==Zone Emulation==<br /> 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.<br /> <br /> The &lt;b&gt;L&lt;/b&gt; 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.<br /> <br /> Example - open zone 12:<br /> * &lt;b&gt;L121\r&lt;/b&gt;<br /> <br /> Example - close zone 12:<br /> * &lt;b&gt;L120\r&lt;/b&gt;<br /> <br /> ==Addressed Message==<br /> * It is possible to send a message from a specific keypad on Ademco/Vista or to a specific partition on DSC.<br /> The &lt;b&gt;K&lt;/b&gt; 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 or a \r or \n character is received.<br /> <br /> Example - Send keypad string 1234 to DSC partition 01:<br /> * &lt;b&gt;K011234\r&lt;/b&gt;<br /> <br /> Example - Send keypad string 12343 from keypad address 19:<br /> * &lt;b&gt;K1912343\r&lt;/b&gt;<br /> <br /> ==Special Keys==<br /> 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.<br /> <br /> {| class=&quot;wikitable&quot; border=&quot;1&quot;<br /> |+ Special Key Codes<br /> ! scope=&quot;col&quot; | Code<br /> ! scope=&quot;col&quot; | Description <br /> ! scope=&quot;col&quot; | Ademco<br /> ! scope=&quot;col&quot; | DSC<br /> |-<br /> | \x01\x01\x01<br /> | Special Key #1<br /> | Fire/Prog.<br /> | Fire<br /> |-<br /> | \x02\x02\x02<br /> | Special Key #2<br /> | Police/Prog.<br /> | Police<br /> |-<br /> | \x03\x03\x03<br /> | Special Key #3<br /> | Medical/AUX/Prog.<br /> | Medical/AUX<br /> |-<br /> | \x04\x04\x04<br /> | Special Key #4<br /> | Programmable<br /> | Stay<br /> |-<br /> | \x05\x05\x05<br /> | Special Key #5<br /> | N/A<br /> | Away<br /> |-<br /> | \x06\x06\x06<br /> | Special Key #6<br /> | N/A<br /> | Chime<br /> |-<br /> | \x07\x07\x07<br /> | Special Key #7<br /> | N/A<br /> | Reset<br /> |-<br /> | \x08\x08\x08<br /> | Special Key #8<br /> | N/A<br /> | Exit<br /> |}<br /> <br /> ----<br /> <br /> =Device Configuration=<br /> The AlarmDecoder configuration can be viewed or modified in one of two ways: [[#Prompted|prompted]] or [[#Programatic|programmatically]].<br /> <br /> ==Prompted==<br /> If you send &lt;b&gt;!&lt;/b&gt; 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.<br /> <br /> &lt;b&gt;You may hit enter to keep the current value or provide a new one.&lt;/b&gt;<br /> <br /> Example:<br /> &lt;pre&gt;<br /> !&gt;Ademco/DSC Mode A/D (A) :&gt;<br /> !&gt;Keypad Address (18) :&gt;<br /> !WARNING. Do not enable a module if the physical module exists on the system.<br /> !Zone Expanders Y/N Max allowed: 02<br /> !&gt;expander module #01 ZN 09-16 (N) :&gt;<br /> !&gt;expander module #02 ZN 17-24 (N) :&gt;<br /> !&gt;expander module #03 ZN 25-32 (N) :&gt;<br /> !&gt;expander module #04 ZN 33-40 (N) :&gt;<br /> !&gt;expander module #05 ZN 41-48 (Y) :&gt;<br /> !Relay Modules Y/N Max allowed: 04<br /> !&gt;relay module #01 (Y) :&gt;<br /> !&gt;relay module #02 (N) :&gt;<br /> !&gt;relay module #03 (N) :&gt;<br /> !&gt;relay module #04 (N) :&gt;<br /> !&gt;Emulate Long Range Radio Y/N: (Y) :&gt;<br /> !&gt;Address Filter Mask (ffffffff) :&gt;<br /> !&gt;Deduplicate (N) :&gt;<br /> !&gt;Config Bits (ff04) :&gt;<br /> &lt;/pre&gt;<br /> <br /> ==Programmatic==<br /> You may retrieve all of the current device settings by sending &lt;b&gt;C&lt;/b&gt; to the panel followed by a carriage return (\r).<br /> <br /> Retrieving settings:<br /> * Send: &lt;b&gt;C\r&lt;/b&gt;<br /> * Response: &lt;b&gt;!CONFIG&gt;ADDRESS=18&amp;CONFIGBITS=ff00&amp;LRR=N&amp;EXP=NNNNN&amp;REL=NNNN&amp;MASK=ffffffff&amp;DEDUPLICATE=N&lt;/b&gt;<br /> <br /> It can also be used to set values:<br /> * Send: &lt;b&gt;CADDRESS=20\r&lt;/b&gt;<br /> * Response: &lt;b&gt;!&gt;ADDRESS=20&lt;/b&gt;<br /> <br /> The same command may be used to set multiple values:<br /> * Send: &lt;b&gt;CADDRESS=20&amp;DEDUPLICATE=Y\r&lt;/b&gt;<br /> * Response: &lt;b&gt;!&gt;ADDRESS=20&amp;DEDUPLICATE=Y&lt;/b&gt;<br /> <br /> ===Configuration Parameters===<br /> {| class=&quot;wikitable&quot; border=&quot;1&quot;<br /> ! scope=&quot;col&quot; | Name<br /> ! scope=&quot;col&quot; | Default Value<br /> ! scope=&quot;col&quot; | Valid Values (Regex)<br /> ! scope=&quot;col&quot; | Description<br /> |-<br /> | align=&quot;left&quot; | MODE<br /> | align=&quot;left&quot; | A<br /> | align=&quot;left&quot; | [A,D]{1}<br /> | align=&quot;left&quot; | Decoder panel mode Ademco or DSC.<br /> |-<br /> | align=&quot;left&quot; | ADDRESS<br /> | align=&quot;left&quot; | 18<br /> | align=&quot;left&quot; | [0-9]{2}<br /> | align=&quot;left&quot; | Keypad address assigned to the AlarmDecoder for Ademco and Partition# for DSC.<br /> |-<br /> | align=&quot;left&quot; | CONFIGBITS<br /> | align=&quot;left&quot; | FF04<br /> | align=&quot;left&quot; | [0-9a-f]{4}<br /> | align=&quot;left&quot; | Special settings for the device. See [[#CONFIGBITS|CONFIGBITS]] for more information.<br /> |-<br /> | align=&quot;left&quot; | MASK<br /> | align=&quot;left&quot; | FFFFFFFF<br /> | align=&quot;left&quot; | [0-9a-f]{8}<br /> | align=&quot;left&quot; | Address mask used to filter for keypad alphanumeric messages.<br /> |-<br /> | align=&quot;left&quot; | EXP<br /> | align=&quot;left&quot; | NNNNN<br /> | align=&quot;left&quot; | [YN]{5}<br /> | align=&quot;left&quot; | Emulation of zone expanders 1-5<br /> |-<br /> | align=&quot;left&quot; | REL<br /> | align=&quot;left&quot; | NNNN<br /> | align=&quot;left&quot; | [YN]{4}<br /> | align=&quot;left&quot; | Emulation of relay expanders 1-4<br /> |-<br /> | align=&quot;left&quot; | LRR<br /> | align=&quot;left&quot; | N<br /> | align=&quot;left&quot; | [YN]<br /> | align=&quot;left&quot; | Emulation of Long Range Radio expander<br /> |-<br /> | align=&quot;left&quot; | DEDUPLICATE<br /> | align=&quot;left&quot; | N<br /> | align=&quot;left&quot; | [YN]<br /> | align=&quot;left&quot; | If enabled, removes duplicate alphanumeric keypad messages.<br /> |-<br /> | align=&quot;left&quot; | RESET<br /> | align=&quot;left&quot; | Y<br /> | align=&quot;left&quot; | [YN]<br /> | align=&quot;left&quot; | Factory reset settings.<br /> |-<br /> |}<br /> <br /> ====CONFIGBITS====<br /> CONFIGBITS is a setting that's used to enable special functionality on the AlarmDecoder. You can enable these by masking the correct bits.<br /> <br /> {| class=&quot;wikitable&quot; border=&quot;1&quot;<br /> |+ CONFIGBITS Definition<br /> ! scope=&quot;col&quot; | Mask<br /> ! scope=&quot;col&quot; | Description<br /> |-<br /> | align=&quot;left&quot; | 0x0001<br /> | align=&quot;left&quot; | Enable reporting of [[#AUI|AUI]] messages.<br /> |-<br /> | align=&quot;left&quot; | 0x0002<br /> | align=&quot;left&quot; | Enable reporting of [[#Keypress Events|keypress events]].<br /> |-<br /> | align=&quot;left&quot; | 0x0004<br /> | align=&quot;left&quot; | Disable prompts for &lt;b&gt;L&lt;/b&gt; and &lt;b&gt;|&lt;/b&gt; commands.<br /> |-<br /> | align=&quot;left&quot; | 0x0008<br /> | align=&quot;left&quot; | Enable the prefixing of panel messages with !KPM.<br /> |-<br /> | align=&quot;left&quot; | 0x0010<br /> | align=&quot;left&quot; | Disable DSC locking (experimental).<br /> |-<br /> | align=&quot;left&quot; | 0x0080<br /> | align=&quot;left&quot; | enable CRC Delivery confirmation for LRR,EXP,REL etc.<br /> |-<br /> | align=&quot;left&quot; | 0x0100<br /> | align=&quot;left&quot; | Enable reporting of [[#RFX|RFX]] messages.<br /> |}<br /> <br /> ----<br /> <br /> =Message Types=<br /> 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]].<br /> <br /> * All lines starting with &lt;b&gt;!&lt;/b&gt; are informational.<br /> * Lines that start with &lt;b&gt;!&gt;&lt;/b&gt; are prompts.<br /> * All other lines are panel data in the form of a [[#Keypad|Keypad message]].<br /> <br /> ==Keypad==<br /> 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 &lt;b&gt;!KPM:&lt;/b&gt;.<br /> <br /> ===Format===<br /> {| class=&quot;wikitable&quot; border=&quot;1&quot;<br /> |+ Keypad Format<br /> | colspan=&quot;4&quot; align=&quot;center&quot; style=&quot;background-color: #DEDEDE; font-weight: bold&quot; | &lt;span style=&quot;color: #F56464&quot;&gt;[00110011000000003A--]&lt;/span&gt;,&lt;span style=&quot;color: #8C8CF5&quot;&gt;010&lt;/span&gt;,&lt;span style=&quot;color: #70BA66&quot;&gt;[f70700000010808c18020000000000]&lt;/span&gt;,&lt;span style=&quot;color: #804580&quot;&gt;&quot;ARMED ***STAY** ZONE BYPASSED &quot;&lt;/span&gt;<br /> |- <br /> | colspan=&quot;4&quot; | &amp;nbsp;<br /> |- <br /> ! scope=&quot;col&quot; width=&quot;160px&quot; style=&quot;color: #F56464&quot; | Bit field<br /> ! scope=&quot;col&quot; width=&quot;100px&quot; style=&quot;color: #8C8CF5&quot; | Numeric code<br /> ! scope=&quot;col&quot; width=&quot;200px&quot; style=&quot;color: #70BA66&quot; | Raw data<br /> ! scope=&quot;col&quot; width=&quot;220px&quot; style=&quot;color: #804580&quot; | Alphanumeric Keypad Message<br /> |-<br /> | align=&quot;center&quot; | [00110011000000003A--]<br /> | align=&quot;center&quot; | 010<br /> | align=&quot;center&quot; | [f70700000010808c18020000000000]<br /> | align=&quot;center&quot; | &quot;ARMED ***STAY** ZONE BYPASSED &quot;<br /> |-<br /> |}<br /> <br /> ====&lt;span style=&quot;color: #F56464&quot;&gt;Bit field&lt;/span&gt;====<br /> 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)<br /> <br /> {| class=&quot;wikitable&quot; border=&quot;1&quot;<br /> ! scope=&quot;col&quot; | Position<br /> ! scope=&quot;col&quot; | Description<br /> |-<br /> | 1<br /> | Indicates if the panel is READY<br /> |-<br /> | 2<br /> | Indicates if the panel is ARMED AWAY<br /> |-<br /> | 3<br /> | Indicates if the panel is ARMED HOME<br /> |-<br /> | 4<br /> | Indicates if the keypad backlight is on<br /> |-<br /> | 5<br /> | Indicates if the keypad is in programming mode<br /> |-<br /> | 6<br /> | Number (1-7) indicating how many beeps are associated with the message<br /> |-<br /> | 7<br /> | Indicates that a zone has been bypassed<br /> |-<br /> | 8<br /> | Indicates if the panel is on AC power<br /> |-<br /> | 9<br /> | Indicates if the chime is enabled<br /> |-<br /> | 10 <br /> | Indicates that an alarm has occurred. This is sticky and will be cleared after a second disarm.<br /> |-<br /> | 11<br /> | Indicates that an alarm is currently sounding. This is cleared after the first disarm.<br /> |-<br /> | 12<br /> | Indicates that the battery is low<br /> |-<br /> | 13<br /> | Indicates that entry delay is off (ARMED INSTANT/MAX)<br /> |-<br /> | 14<br /> | Indicates that there is a fire<br /> |-<br /> | 15<br /> | Indicates a system issue<br /> |-<br /> | 16<br /> | Indicates that the panel is only watching the perimeter (ARMED STAY/NIGHT)<br /> |-<br /> | 17<br /> | System specific bits. 4 bits packed into a HEX Nibble [0-9,A-F]<br /> |-<br /> | 18<br /> | Ademco or DSC Mode A or D<br /> |-<br /> | 19<br /> | Unused<br /> |-<br /> | 20<br /> | Unused<br /> |-<br /> |}<br /> <br /> ====&lt;span style=&quot;color: #8C8CF5&quot;&gt;Numeric Code&lt;/span&gt;====<br /> 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 &lt;b&gt;022&lt;/b&gt;. Most of the time this is zero-padded base10, but there are rare occurrences where this may be base16, such as ECP bus failures.<br /> <br /> ====&lt;span style=&quot;color: #70BA66&quot;&gt;Raw data&lt;/span&gt;====<br /> 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.<br /> <br /> 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.<br /> <br /> 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.<br /> <br /> {| class=&quot;wikitable&quot; border=&quot;1&quot;<br /> ! scope=&quot;col&quot; | Byte<br /> ! scope=&quot;col&quot; | Addresses<br /> |-<br /> | 1<br /> | 0-7<br /> |-<br /> | 2<br /> | 8-15<br /> |-<br /> | 3<br /> | 16-23<br /> |-<br /> | 4<br /> | 24-31<br /> |}<br /> <br /> For example:<br /> * f7&lt;span style=&quot;color: #70BA66&quot;&gt;07000600&lt;/span&gt;10808c08020000 - our keypad address mask is &lt;span style=&quot;color: #70BA66&quot;&gt;07000600&lt;/span&gt;.<br /> <br /> Using the above mask example of &lt;span style=&quot;color: #70BA66&quot;&gt;07000600&lt;/span&gt; we find that this message was destined for keypads 0, 1, 2, 17 and 18.<br /> <br /> There is one special case: system messages will have no address mask bits set and are intended for common keypads or monitoring multiple zones.<br /> <br /> 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.<br /> <br /> ====&lt;span style=&quot;color: #804580&quot;&gt;Alphanumeric Keypad Message&lt;/span&gt;====<br /> This section is the data that would be displayed on your keypad's screen.<br /> <br /> ==Zone Expander==<br /> 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.<br /> ===Examples===<br /> Example of zone expander at address 7, channel 1 faulting and then restoring:<br /> &lt;pre&gt;<br /> !EXP:07,01,01<br /> !EXP:07,01,00<br /> &lt;/pre&gt;<br /> <br /> ===Format===<br /> {| class=&quot;wikitable&quot; border=&quot;1&quot;<br /> |+ !EXP Format<br /> | colspan=&quot;4&quot; align=&quot;center&quot; style=&quot;background-color: #DEDEDE; font-weight: bold&quot; | &lt;span style=&quot;color: #F56464&quot;&gt;!EXP&lt;/span&gt;:&lt;span style=&quot;color: #8C8CF5&quot;&gt;07&lt;/span&gt;,&lt;span style=&quot;color: #70BA66&quot;&gt;01&lt;/span&gt;,&lt;span style=&quot;color: #804580&quot;&gt;01&lt;/span&gt;<br /> |- <br /> | colspan=&quot;4&quot; | &amp;nbsp;<br /> |- <br /> ! scope=&quot;col&quot; width=&quot;80px&quot; style=&quot;color: #F56464&quot; | Header<br /> ! scope=&quot;col&quot; width=&quot;160px&quot; style=&quot;color: #8C8CF5&quot; | Zone Expander Address<br /> ! scope=&quot;col&quot; width=&quot;140px&quot; style=&quot;color: #70BA66&quot; | Expander Channel<br /> ! scope=&quot;col&quot; width=&quot;100px&quot; style=&quot;color: #804580&quot; | Data<br /> |-<br /> | align=&quot;center&quot; | !EXP<br /> | align=&quot;center&quot; | 07<br /> | align=&quot;center&quot; | 01<br /> | align=&quot;center&quot; | 01<br /> |-<br /> |}<br /> <br /> ====&lt;span style=&quot;color: #8C8CF5&quot;&gt;Zone Expander Address&lt;/span&gt;====<br /> This is the address that the zone expander occupies.<br /> <br /> ====&lt;span style=&quot;color: #70BA66&quot;&gt;Expander Channel&lt;/span&gt;====<br /> This is the channel generating the message.<br /> <br /> ====&lt;span style=&quot;color: #804580&quot;&gt;Data&lt;/span&gt;====<br /> 00 and 01 indicate that the zone is restored and faulted, respectively.<br /> <br /> ==Relay Expander==<br /> 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.<br /> <br /> ===Examples===<br /> Examples of a relay expander at address 12, relay #1 closing and then opening:<br /> &lt;pre&gt;<br /> !REL:12,01,01<br /> !REL:12,01,00<br /> &lt;/pre&gt;<br /> <br /> ===Format===<br /> {| class=&quot;wikitable&quot; border=&quot;1&quot;<br /> |+ !REL Format<br /> | colspan=&quot;4&quot; align=&quot;center&quot; style=&quot;background-color: #DEDEDE; font-weight: bold&quot; | &lt;span style=&quot;color: #F56464&quot;&gt;!REL&lt;/span&gt;:&lt;span style=&quot;color: #8C8CF5&quot;&gt;12&lt;/span&gt;,&lt;span style=&quot;color: #70BA66&quot;&gt;01&lt;/span&gt;,&lt;span style=&quot;color: #804580&quot;&gt;01&lt;/span&gt;<br /> |- <br /> | colspan=&quot;4&quot; | &amp;nbsp;<br /> |- <br /> ! scope=&quot;col&quot; width=&quot;80px&quot; style=&quot;color: #F56464&quot; | Header<br /> ! scope=&quot;col&quot; width=&quot;160px&quot; style=&quot;color: #8C8CF5&quot; | Relay Expander Address<br /> ! scope=&quot;col&quot; width=&quot;140px&quot; style=&quot;color: #70BA66&quot; | Expander Channel<br /> ! scope=&quot;col&quot; width=&quot;100px&quot; style=&quot;color: #804580&quot; | Data<br /> |-<br /> | align=&quot;center&quot; | !REL<br /> | align=&quot;center&quot; | 12<br /> | align=&quot;center&quot; | 01<br /> | align=&quot;center&quot; | 01<br /> |-<br /> |}<br /> <br /> ====&lt;span style=&quot;color: #8C8CF5&quot;&gt;Relay Expander Address&lt;/span&gt;====<br /> This is the address that the relay expander occupies.<br /> <br /> ====&lt;span style=&quot;color: #70BA66&quot;&gt;Expander Channel&lt;/span&gt;====<br /> This is the channel generating the message.<br /> <br /> ====&lt;span style=&quot;color: #804580&quot;&gt;Data&lt;/span&gt;====<br /> 00 and 01 indicate that the relay is opened and closed, respectively.<br /> <br /> ==RFX==<br /> 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.<br /> <br /> 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. <br /> <br /> ===Examples===<br /> Example of a 5800Micra sensor faulting and restoring:<br /> &lt;pre&gt;<br /> !RFX:0180036,80<br /> !RFX:0180036,00<br /> &lt;/pre&gt;<br /> <br /> <br /> Example of a 5804 keyfob pressing the loop #2 button and having a low battery:<br /> &lt;pre&gt;<br /> !RFX:0307854,22<br /> &lt;/pre&gt;<br /> <br /> ===Format===<br /> {| class=&quot;wikitable&quot; border=&quot;1&quot;<br /> |+ !RFX Format<br /> | colspan=&quot;4&quot; align=&quot;center&quot; style=&quot;background-color: #DEDEDE; font-weight: bold&quot; | &lt;span style=&quot;color: #F56464&quot;&gt;!RFX&lt;/span&gt;:&lt;span style=&quot;color: #8C8CF5&quot;&gt;0180036&lt;/span&gt;,&lt;span style=&quot;color: #70BA66&quot;&gt;80&lt;/span&gt;<br /> |- <br /> | colspan=&quot;4&quot; | &amp;nbsp;<br /> |- <br /> ! scope=&quot;col&quot; width=&quot;80px&quot; style=&quot;color: #F56464&quot; | Header<br /> ! scope=&quot;col&quot; width=&quot;100px&quot; style=&quot;color: #8C8CF5&quot; | Serial Number<br /> ! scope=&quot;col&quot; width=&quot;100px&quot; style=&quot;color: #70BA66&quot; | Data<br /> |-<br /> | align=&quot;center&quot; | !RFX<br /> | align=&quot;center&quot; | 0180036<br /> | align=&quot;center&quot; | 80<br /> |-<br /> |}<br /> <br /> ====&lt;span style=&quot;color: #8C8CF5&quot;&gt;Serial Number&lt;/span&gt;====<br /> This is the 7-digit serial number of the device the message originated from.<br /> <br /> ====&lt;span style=&quot;color: #70BA66&quot;&gt;Data&lt;/span&gt;====<br /> 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.<br /> <br /> {| class=&quot;wikitable&quot; border=&quot;1&quot;<br /> |+ RFX Data Format<br /> |-<br /> ! scope=&quot;col&quot; | Bit<br /> ! scope=&quot;col&quot; | Description<br /> |-<br /> | align=&quot;center&quot; | 1<br /> | Unknown - Seems that the loop indicators should be ignored if set.<br /> |-<br /> | align=&quot;center&quot; | 2<br /> | Low battery indication<br /> |-<br /> | align=&quot;center&quot; | 3<br /> | Supervision required indication<br /> |-<br /> | align=&quot;center&quot; | 4<br /> | Unknown<br /> |-<br /> | align=&quot;center&quot; | 5<br /> | Loop #3 indication<br /> |-<br /> | align=&quot;center&quot; | 6<br /> | Loop #2 indication<br /> |-<br /> | align=&quot;center&quot; | 7<br /> | Loop #4 indication<br /> |-<br /> | align=&quot;center&quot; | 8<br /> | Loop #1 indication<br /> |}<br /> <br /> ==LRR==<br /> 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. The format of the data encapsulates the [[:File:SIA-ContactIDCodes_Protocol.pdf|SIA DC-05-1999.09]] standard for Contact ID reporting.<br /> <br /> ===Examples===<br /> * ARM STAY USER 002 partition 1<br /> ** !LRR:002,1,CID_3441,ff<br /> <br /> * DAY/NIGHT ALARM ZONE 9 partition 1<br /> ** !LRR:009,1,CID_1135,ff <br /> <br /> * ALARM CANCEL USER 002 partition 1<br /> ** !LRR:002,1,CID_1406,ff <br /> <br /> * ARM STAY OPENING user 002 partition 1<br /> ** !LRR:002,1,CID_1441,ff<br /> <br /> ===Format===<br /> {| class=&quot;wikitable&quot; border=&quot;1&quot;<br /> |+ !LRR Format<br /> | colspan=&quot;4&quot; align=&quot;center&quot; style=&quot;background-color: #DEDEDE; font-weight: bold&quot; | &lt;span style=&quot;color: #F56464&quot;&gt;!LRR&lt;/span&gt;:&lt;span style=&quot;color: #8C8CF5&quot;&gt;012&lt;/span&gt;,&lt;span style=&quot;color: #70BA66&quot;&gt;1&lt;/span&gt;,&lt;span style=&quot;color: #804580&quot;&gt;CID_1441&lt;/span&gt;,&lt;span style=&quot;color: #D7DF01&quot;&gt;ff&lt;/span&gt;<br /> |- <br /> | colspan=&quot;4&quot; | &amp;nbsp;<br /> |- <br /> ! scope=&quot;col&quot; width=&quot;80px&quot; style=&quot;color: #F56464&quot; | Header<br /> ! scope=&quot;col&quot; width=&quot;100px&quot; style=&quot;color: #8C8CF5&quot; | Event Data<br /> ! scope=&quot;col&quot; width=&quot;80px&quot; style=&quot;color: #70BA66&quot; | Partition<br /> ! scope=&quot;col&quot; width=&quot;100px&quot; style=&quot;color: #804580&quot; | CID MESSAGE<br /> ! scope=&quot;col&quot; width=&quot;100px&quot; style=&quot;color: #D7DF01&quot; | Report CODE<br /> |-<br /> | align=&quot;center&quot; | !LRR<br /> | align=&quot;center&quot; | 012<br /> | align=&quot;center&quot; | 1<br /> | align=&quot;center&quot; | CID_1441<br /> | align=&quot;center&quot; | ff<br /> |-<br /> |}<br /> <br /> ====&lt;span style=&quot;color: #8C8CF5&quot;&gt;Event Data&lt;/span&gt;====<br /> This is either the user number of the person performing the action or the zone that was bypassed.<br /> <br /> ====&lt;span style=&quot;color: #70BA66&quot;&gt;Partition&lt;/span&gt;====<br /> The panel partition the event applies to. Partition 0 indicates that it's destined for all partitions.<br /> <br /> ====&lt;span style=&quot;color: #804580&quot;&gt;CID Message&lt;/span&gt;====<br /> This is CID message for the event. See below for a description and what (if any) programming fields are required for activation. It is prefixed with &quot;CID_&quot; and then 4 digits that are described in section 5.1.2.2 of the [[:File:SIA-ContactIDCodes_Protocol.pdf|SIA DC-05-1999.09]] standard.<br /> <br /> {| class=&quot;wikitable&quot; border=&quot;1&quot;<br /> |+ Report Code Format<br /> | colspan=&quot;3&quot; align=&quot;center&quot; style=&quot;background-color: #DEDEDE; font-weight: bold&quot; | &lt;span style=&quot;color: #F56464&quot;&gt;CID_&lt;/span&gt;&lt;span style=&quot;color: #8C8CF5&quot;&gt;Q&lt;/span&gt;&lt;span style=&quot;color: #70BA66&quot;&gt;XYZ&lt;/span&gt;<br /> |- <br /> | colspan=&quot;3&quot; | &amp;nbsp;<br /> |- <br /> ! scope=&quot;col&quot; width=&quot;80px&quot; style=&quot;color: #F56464&quot; | Header<br /> ! scope=&quot;col&quot; width=&quot;100px&quot; style=&quot;color: #8C8CF5&quot; | Event qualifier<br /> ! scope=&quot;col&quot; width=&quot;80px&quot; style=&quot;color: #70BA66&quot; | Event code<br /> |-<br /> | align=&quot;center&quot; | CID_<br /> | align=&quot;center&quot; | 1<br /> | align=&quot;center&quot; | 441<br /> |-<br /> |}<br /> <br /> ====&lt;span style=&quot;color: #F56464&quot;&gt;Header&lt;/span&gt;====<br /> Static string &quot;CID_&quot;<br /> ====&lt;span style=&quot;color: #8C8CF5&quot;&gt;Event qualifier&lt;/span&gt;====<br /> 1 = New Event or Opening <br /> 3 = New Restore or Closing <br /> 6 = Previously reported condition still present (Status report)<br /> ====&lt;span style=&quot;color: #70BA66&quot;&gt;Event code&lt;/span&gt;====<br /> (3 Hex digits 0-9,B-F)<br /> Event codes are 3 hex digits and are broken down in classes by the first digit.<br /> 100 Alarms<br /> 200 Supervisory<br /> 300 Troubles<br /> 400 Open/Close REMOTE ACCESS<br /> 500 Bypass/Disables<br /> 600 TEST/MISC<br /> For more detail on specific report codes see the list see '''Appendix C''' in the [[:File:SIA-ContactIDCodes_Protocol.pdf|SIA DC-05-1999.09]] standard.<br /> <br /> ==AUI==<br /> AUI messages are generated for &quot;Advanced User Interface&quot; keypads. These include a lot of extra data than what's destined for regular keypads.<br /> <br /> ===Format===<br /> {| class=&quot;wikitable&quot; border=&quot;1&quot;<br /> |+ !AUI Format<br /> | colspan=&quot;4&quot; align=&quot;center&quot; style=&quot;background-color: #DEDEDE; font-weight: bold&quot; | &lt;span style=&quot;color: #F56464&quot;&gt;!AUI&lt;/span&gt;:&lt;span style=&quot;color: #8C8CF5&quot;&gt;126600000000656c02456cf5ec01017f0002&lt;/span&gt;<br /> |- <br /> | colspan=&quot;4&quot; | &amp;nbsp;<br /> |- <br /> ! scope=&quot;col&quot; width=&quot;80px&quot; style=&quot;color: #F56464&quot; | Header<br /> ! scope=&quot;col&quot; width=&quot;100px&quot; style=&quot;color: #8C8CF5&quot; | AUI Data<br /> |-<br /> | align=&quot;center&quot; | !AUI<br /> | align=&quot;center&quot; | 126600000000656c02456cf5ec01017f0002<br /> |-<br /> |}<br /> <br /> ====&lt;span style=&quot;color: #8C8CF5&quot;&gt;AUI Data&lt;/span&gt;====<br /> 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.<br /> <br /> ==Keypress Events==<br /> Keypress events are generated when keys are pressed on a keypad and can be enabled inside [[#CONFIGBITS|CONFIGBITS]].<br /> <br /> ===Format===<br /> {| class=&quot;wikitable&quot; border=&quot;1&quot;<br /> |+ !KPE Format<br /> | colspan=&quot;4&quot; align=&quot;center&quot; style=&quot;background-color: #DEDEDE; font-weight: bold&quot; | &lt;span style=&quot;color: #F56464&quot;&gt;!KPE&lt;/span&gt;:&lt;span style=&quot;color: #8C8CF5&quot;&gt;18&lt;/span&gt;<br /> |- <br /> | colspan=&quot;4&quot; | &amp;nbsp;<br /> |- <br /> ! scope=&quot;col&quot; width=&quot;80px&quot; style=&quot;color: #F56464&quot; | Header<br /> ! scope=&quot;col&quot; width=&quot;100px&quot; style=&quot;color: #8C8CF5&quot; | Keypad Address<br /> |-<br /> | align=&quot;center&quot; | !KPE<br /> | align=&quot;center&quot; | 18<br /> |-<br /> |}<br /> <br /> ==Error message report==<br /> 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. <br /> <br /> ===Format===<br /> {| class=&quot;wikitable&quot; border=&quot;1&quot;<br /> |+ !ERR Format<br /> | colspan=&quot;4&quot; align=&quot;center&quot; style=&quot;background-color: #DEDEDE; font-weight: bold&quot; | &lt;span style=&quot;color: #F56464&quot;&gt;!ERR&lt;/span&gt;:&lt;span style=&quot;color: #8C8CF5&quot;&gt;4,4,4&lt;/span&gt;<br /> |- <br /> | colspan=&quot;4&quot; | &amp;nbsp;<br /> |- <br /> ! scope=&quot;col&quot; width=&quot;80px&quot; style=&quot;color: #F56464&quot; | Header<br /> ! scope=&quot;col&quot; width=&quot;100px&quot; style=&quot;color: #8C8CF5&quot; | Error list<br /> |-<br /> | align=&quot;center&quot; | !ERR<br /> | align=&quot;center&quot; | 4,4,4<br /> |-<br /> |}<br /> <br /> ===Error Codes===<br /> {| class=&quot;wikitable&quot; border=&quot;1&quot;<br /> |+ Error Codes<br /> |- <br /> | colspan=&quot;4&quot; | &amp;nbsp;<br /> |- <br /> ! scope=&quot;col&quot; width=&quot;80px&quot; | Error number<br /> ! scope=&quot;col&quot; width=&quot;100px&quot; | Description<br /> |-<br /> | align=&quot;center&quot; | 0<br /> | align=&quot;center&quot; | No issues to report<br /> |-<br /> | align=&quot;center&quot; | 4<br /> | align=&quot;center&quot; | Keypress send failure<br /> |-<br /> |}<br /> <br /> <br /> ==CRC==<br /> 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. Enable via [[#CONFIGBITS|CONFIGBITS]]<br /> <br /> ===Format===<br /> {| class=&quot;wikitable&quot; border=&quot;1&quot;<br /> |+ !CRC Format<br /> | colspan=&quot;4&quot; align=&quot;center&quot; style=&quot;background-color: #DEDEDE; font-weight: bold&quot; | &lt;span style=&quot;color: #F56464&quot;&gt;!CRC&lt;/span&gt;:&lt;span style=&quot;color: #8C8CF5&quot;&gt;!LRR:000,1,CID_1121,ff&lt;/span&gt;,&lt;span style=&quot;color: #70BA66&quot;&gt;282d&lt;/span&gt;<br /> |- <br /> | colspan=&quot;4&quot; | &amp;nbsp;<br /> |- <br /> ! scope=&quot;col&quot; width=&quot;80px&quot; style=&quot;color: #F56464&quot; | Header<br /> ! scope=&quot;col&quot; width=&quot;100px&quot; style=&quot;color: #8C8CF5&quot; | Event Data<br /> ! scope=&quot;col&quot; width=&quot;80px&quot; style=&quot;color: #70BA66&quot; | CRC<br /> |-<br /> | align=&quot;center&quot; | !CRC<br /> | align=&quot;center&quot; | !LRR:000,1,CID_1121,ff<br /> | align=&quot;center&quot; | 282d<br /> |-<br /> |}<br /> <br /> ==Version Message==<br /> This message indicates the serial number of the unit, version, and the firmware capabilities.<br /> <br /> ===Format===<br /> {| class=&quot;wikitable&quot; border=&quot;1&quot;<br /> |+ !VER Format<br /> | colspan=&quot;4&quot; align=&quot;center&quot; style=&quot;background-color: #DEDEDE; font-weight: bold&quot; | &lt;span style=&quot;color: #F56464&quot;&gt;!VER&lt;/span&gt;:&lt;span style=&quot;color: #8C8CF5&quot;&gt;ffffffff&lt;/span&gt;,&lt;span style=&quot;color: #70BA66&quot;&gt;V2.2a.8.2&lt;/span&gt;,&lt;span style=&quot;color: #804580&quot;&gt;TX;RX;SM;VZ;RF;ZX;RE;AU;3X;CG;DD;MF;LR;KE;MK;CB;DS;ER&lt;/span&gt;<br /> |- <br /> | colspan=&quot;4&quot; | &amp;nbsp;<br /> |- <br /> ! scope=&quot;col&quot; width=&quot;80px&quot; style=&quot;color: #F56464&quot; | Header<br /> ! scope=&quot;col&quot; width=&quot;100px&quot; style=&quot;color: #8C8CF5&quot; | Serial number<br /> ! scope=&quot;col&quot; width=&quot;100px&quot; style=&quot;color: #70BA66&quot; | Firmware version<br /> ! scope=&quot;col&quot; width=&quot;100px&quot; style=&quot;color: #804580&quot; | Firmware capabilities<br /> |-<br /> | align=&quot;center&quot; | !VER<br /> | align=&quot;center&quot; | ffffffff<br /> | align=&quot;center&quot; | V2.2a.8.2<br /> | align=&quot;center&quot; | TX;RX;SM;VZ;RF;ZX;RE;AU;3X;CG;DD;MF;LR;KE;MK;CB;DS;ER<br /> |-<br /> |}<br /> <br /> ====&lt;span style=&quot;color: #8C8CF5&quot;&gt;Serial Number&lt;/span&gt;====<br /> This is the serial number of the device. If unset this defaults to ffffffff.<br /> <br /> ====&lt;span style=&quot;color: #70BA66&quot;&gt;Firmware Version&lt;/span&gt;====<br /> This is the revision of the firmware that is currently loaded on the device.<br /> <br /> ====&lt;span style=&quot;color: #804580&quot;&gt;Firmware Capabilities&lt;/span&gt;====<br /> This field indicates which capabilities are built in to the firmware. See the below table for reference.<br /> <br /> {| class=&quot;wikitable&quot; border=&quot;1&quot;<br /> |+ !VER Format<br /> | colspan=&quot;4&quot; align=&quot;center&quot; style=&quot;background-color: #DEDEDE; font-weight: bold&quot; | Firmware Capabilities<br /> |- <br /> | colspan=&quot;4&quot; | &amp;nbsp;<br /> |- <br /> ! scope=&quot;col&quot; width=&quot;80px&quot; | Flag<br /> ! scope=&quot;col&quot; width=&quot;400px&quot; | Description<br /> |-<br /> | align=&quot;center&quot; | TX<br /> | align=&quot;left&quot; | Ability to transmit to the panel<br /> |-<br /> |-<br /> | align=&quot;center&quot; | RX<br /> | align=&quot;left&quot; | Ability to receive from the panel<br /> |-<br /> | align=&quot;center&quot; | SM<br /> | align=&quot;left&quot; | Supports sending multiple keypresses<br /> |-<br /> | align=&quot;center&quot; | VZ<br /> | align=&quot;left&quot; | Virtual zone expanders<br /> |-<br /> | align=&quot;center&quot; | RF<br /> | align=&quot;left&quot; | Supports receiving of RF messages from the 5800 series wireless devices (!RFX)<br /> |-<br /> | align=&quot;center&quot; | ZX<br /> | align=&quot;left&quot; | Supports receiving of messages from zone expanders (!EXP)<br /> |-<br /> | align=&quot;center&quot; | RE<br /> | align=&quot;left&quot; | Supports receiving of messages from relay (!REL)<br /> |-<br /> | align=&quot;center&quot; | AU<br /> | align=&quot;left&quot; | AUI support (!AUI)<br /> |-<br /> | align=&quot;center&quot; | 3X<br /> | align=&quot;left&quot; | Special Keys (S1-S4) must be sent 3 times to trigger<br /> |-<br /> | align=&quot;center&quot; | CG<br /> | align=&quot;left&quot; | Serialized configuration string<br /> |-<br /> | align=&quot;center&quot; | DD<br /> | align=&quot;left&quot; | Message deduplication<br /> |-<br /> | align=&quot;center&quot; | MF<br /> | align=&quot;left&quot; | Address mask filter<br /> |-<br /> | align=&quot;center&quot; | LR<br /> | align=&quot;left&quot; | Long range radio messages (!LRR) deprecated see L2<br /> |-<br /> | align=&quot;center&quot; | L2<br /> | align=&quot;left&quot; | Long range radio messages (!LRR) with CID reporting format<br /> |-<br /> | align=&quot;center&quot; | KE<br /> | align=&quot;left&quot; | Keypad event messages (!KPM)<br /> |-<br /> | align=&quot;center&quot; | MK<br /> | align=&quot;left&quot; | Multiple keypad emulation (See 'K' command for more information)<br /> |-<br /> | align=&quot;center&quot; | CB<br /> | align=&quot;left&quot; | Config bits<br /> |-<br /> | align=&quot;center&quot; | DS<br /> | align=&quot;left&quot; | DSC support<br /> |-<br /> | align=&quot;center&quot; | ER<br /> | align=&quot;left&quot; | Error tracking<br /> |-<br /> | align=&quot;center&quot; | CR<br /> | align=&quot;left&quot; | CRC Wrapper around EXP,LRR and other event type messages<br /> |-<br /> |}<br /> <br /> =Device Feedback LED=<br /> * Boot flash mode<br /> ** During boot the AD2* will rapid flash during the boot loader.<br /> * Operating mode<br /> ** The normal operating mode is a steady of approx 2.5 flashes per second.<br /> ** Sending to panel mode 3 flashes.<br /> * Error mode<br /> ** 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.</div> 204.10.16.14 http://www.alarmdecoder.com/wiki/index.php/FirmwareRevisionHistory FirmwareRevisionHistory 2021-04-11T18:18:32Z <p>204.10.16.14: /* 2.2a.8. */</p> <hr /> <div>=&lt;span style=&quot;color:#F56464&quot;&gt;Beta Releases&lt;/span&gt;=<br /> ==2.2a.8.9b-306==<br /> * Temporary filter for numeric section of protocol. Max zone number on this firmware is 99.<br /> <br /> ==2.2a.8.9b-305==<br /> * FIX RFX timing issue.<br /> ==2.2a.8.9-303==<br /> * Fix another bug in 'K' command. Reverting back to primary address on # or * keys in Ademco mode.<br /> ==2.2a.8.8==<br /> * Release as current stable<br /> <br /> ==2.2a.8.7-299==<br /> * Fix another bug in 'K' command. Not reverting back to correct address after sending a blank line. Spec is sending a blank link \r\n will reset to configured keypad address.<br /> ==2.2a.8.7-298==<br /> * enable debuging<br /> ==2.2a.8.7-296==<br /> * Fixed K command not reverting back to original config address after \r\n<br /> * small change in debug output when debug flags enabled.<br /> <br /> ==2.2a.8.7-295==<br /> * AUI protocol limited to sending 20 characters. Now can send 72.<br /> <br /> ==2.2a.8.7-294==<br /> * Changed from letter beta codes to git commit number.<br /> ** The last revision using letters was 2.2a.8.7e<br /> * Fixed section #1 Chime bit state not tracked when real keypad changes chime mode.<br /> ** The screen was also hidden from the host and showed &quot;UNAVAILABLE&quot;.<br /> ** It now shows &quot;CHIME&quot; when another keypad changes the chime state.<br /> * Improve K command<br /> ** K command was not returning to the &quot;configured&quot; keypad address<br /> *** This caused erroneous address show in &quot;C&quot; command or ! config.<br /> <br /> ==2.2a.8.7e==<br /> * DSC prog. mode section screen cursor now disabled to match real keypad<br /> ==2.2a.8.7d==<br /> * UNKNOWN messages for *1, *5 and *6 mapped to DSC_ message<br /> ** *1 DSC_1801 <br /> *** No code configured [015]:5 will have a user id of 0.<br /> ** *5 DSC_1805<br /> ** *6 DSC_1806<br /> * bit #7(Bypass) loosing state when armed and entering * screen<br /> * bit #15(System issue) loosing state when entering * screens<br /> * bit #14(Fire) loosing state when entering * screens<br /> <br /> ==2.2a.8.7c==<br /> * Change CID for Trouble from 109 to 383 in DSC mode.<br /> ==2.2a.8.7b==<br /> * Arm bits in section #1 where loosing state when entering * screens in DSC mode.<br /> * Panel Busy messages in DSC mode when not needed.<br /> ==2.2a.8.7a==<br /> * Improve AC indicator response time in DSC mode.<br /> <br /> ==2.2a.8.6==<br /> * Final stable release with full feature programming of DSC panels and LRR changes to now support full '''Contact ID''' reporting.<br /> ==2.2a.8.5s==<br /> * Removed VPLEX support<br /> * Change in LRR protocol. Now supporting full Contact ID for Ademco and DSC.<br /> ** Added report code but it is only valid on DSC and is blank or FF on Ademco.<br /> * DSC Support now supports full emulation of all DSC keypad screens and programming modes.<br /> ** Requires update to Keypad App for reverse HEX entry on DSC.<br /> * DSC Support for LRR Contact ID with no panel programming required.<br /> ** CID report codes can be set in programming if needed.<br /> * DSC Keypad address is now two digit the first is partition second is slot. Default is 11 partition 1 slot 1 for DSC mode.<br /> * Ademco/DSC new support for putting custom configuration screens on real keypads or virtual controlled by host computer.<br /> * New CRC verified delivery wrapper for !XXX messages such as !LRR or !EXP<br /> * Minor fixes on EXP for Ademco<br /> * Minor changes in Config command removing verbose output<br /> * Fixed extra random character between boot message and start banner.<br /> <br /> ==2.2a.8.3c==<br /> * fixed missing AUI message output<br /> * Improved VPLEX support. RFX output LOOP1 or 4 and supervisory bit if EOL is wrong<br /> * small timing adjustment for circa 1991 SE panel SA4142AD<br /> <br /> ==2.2a.8.3b==<br /> * Initial VPLEX support<br /> ** Connect V+ to 12V V- to GND and V+ to DI and make sure config mode is Ademco.<br /> *** NOTE: only possible to connect to one BUS at a time for now so an additional AD2* is needed to monitor the VPLEX bus.<br /> * improved re-transmit handling with Ademco/Vista<br /> <br /> =&lt;span style=&quot;color:#70BA66&quot;&gt;Stable Releases&lt;/span&gt;=<br /> ==2.2a.8.8==<br /> * Major changes.<br /> ** DSC. <br /> *** The virtual keypad emulation is now identical to a real DSC alpha keypad including programming mode fields.<br /> ** DSC/Ademco<br /> *** Replaced LRR formate messages with new CID format standardizing alarm reporting across panel types using Contact ID. <br /> *** Small changes in section #1<br /> ==2.2a.8.2==<br /> * Bugfixes<br /> ** Settings allocation bug<br /> * Notes<br /> ** Shipping in all units built after October 2015<br /> <br /> ==2.2a.8.1==<br /> * New Features<br /> ** Missing DSC message<br /> ** First dotted quad revision<br /> <br /> ==2.2a.8==<br /> * New Features<br /> ** DSC panel support<br /> ** Compass download/upload support<br /> ** Blinking LED now displays error codes.<br /> ** New message type '!ERR' which can be retrieved by sending an 'e' to the AlarmDecoder<br /> <br /> ==2.2a.6==<br /> <br /> ==2.2a.4==<br /> * New Features<br /> ** Keypad Address Mask<br /> ** Long Range Radio (LRR) Emulation<br /> ** Message deduplication</div> 204.10.16.14 http://www.alarmdecoder.com/wiki/index.php/FirmwareRevisionHistory FirmwareRevisionHistory 2021-04-11T18:18:18Z <p>204.10.16.14: /* 2.2a.8.9-303 */</p> <hr /> <div>=&lt;span style=&quot;color:#F56464&quot;&gt;Beta Releases&lt;/span&gt;=<br /> ==2.2a.8.9b-306==<br /> * Temporary filter for numeric section of protocol. Max zone number on this firmware is 99.<br /> <br /> ==2.2a.8.9b-305==<br /> * FIX RFX timing issue.<br /> ==2.2a.8.9-303==<br /> * Fix another bug in 'K' command. Reverting back to primary address on # or * keys in Ademco mode.<br /> ==2.2a.8.==<br /> * Release as current stable<br /> <br /> ==2.2a.8.7-299==<br /> * Fix another bug in 'K' command. Not reverting back to correct address after sending a blank line. Spec is sending a blank link \r\n will reset to configured keypad address.<br /> ==2.2a.8.7-298==<br /> * enable debuging<br /> ==2.2a.8.7-296==<br /> * Fixed K command not reverting back to original config address after \r\n<br /> * small change in debug output when debug flags enabled.<br /> <br /> ==2.2a.8.7-295==<br /> * AUI protocol limited to sending 20 characters. Now can send 72.<br /> <br /> ==2.2a.8.7-294==<br /> * Changed from letter beta codes to git commit number.<br /> ** The last revision using letters was 2.2a.8.7e<br /> * Fixed section #1 Chime bit state not tracked when real keypad changes chime mode.<br /> ** The screen was also hidden from the host and showed &quot;UNAVAILABLE&quot;.<br /> ** It now shows &quot;CHIME&quot; when another keypad changes the chime state.<br /> * Improve K command<br /> ** K command was not returning to the &quot;configured&quot; keypad address<br /> *** This caused erroneous address show in &quot;C&quot; command or ! config.<br /> <br /> ==2.2a.8.7e==<br /> * DSC prog. mode section screen cursor now disabled to match real keypad<br /> ==2.2a.8.7d==<br /> * UNKNOWN messages for *1, *5 and *6 mapped to DSC_ message<br /> ** *1 DSC_1801 <br /> *** No code configured [015]:5 will have a user id of 0.<br /> ** *5 DSC_1805<br /> ** *6 DSC_1806<br /> * bit #7(Bypass) loosing state when armed and entering * screen<br /> * bit #15(System issue) loosing state when entering * screens<br /> * bit #14(Fire) loosing state when entering * screens<br /> <br /> ==2.2a.8.7c==<br /> * Change CID for Trouble from 109 to 383 in DSC mode.<br /> ==2.2a.8.7b==<br /> * Arm bits in section #1 where loosing state when entering * screens in DSC mode.<br /> * Panel Busy messages in DSC mode when not needed.<br /> ==2.2a.8.7a==<br /> * Improve AC indicator response time in DSC mode.<br /> <br /> ==2.2a.8.6==<br /> * Final stable release with full feature programming of DSC panels and LRR changes to now support full '''Contact ID''' reporting.<br /> ==2.2a.8.5s==<br /> * Removed VPLEX support<br /> * Change in LRR protocol. Now supporting full Contact ID for Ademco and DSC.<br /> ** Added report code but it is only valid on DSC and is blank or FF on Ademco.<br /> * DSC Support now supports full emulation of all DSC keypad screens and programming modes.<br /> ** Requires update to Keypad App for reverse HEX entry on DSC.<br /> * DSC Support for LRR Contact ID with no panel programming required.<br /> ** CID report codes can be set in programming if needed.<br /> * DSC Keypad address is now two digit the first is partition second is slot. Default is 11 partition 1 slot 1 for DSC mode.<br /> * Ademco/DSC new support for putting custom configuration screens on real keypads or virtual controlled by host computer.<br /> * New CRC verified delivery wrapper for !XXX messages such as !LRR or !EXP<br /> * Minor fixes on EXP for Ademco<br /> * Minor changes in Config command removing verbose output<br /> * Fixed extra random character between boot message and start banner.<br /> <br /> ==2.2a.8.3c==<br /> * fixed missing AUI message output<br /> * Improved VPLEX support. RFX output LOOP1 or 4 and supervisory bit if EOL is wrong<br /> * small timing adjustment for circa 1991 SE panel SA4142AD<br /> <br /> ==2.2a.8.3b==<br /> * Initial VPLEX support<br /> ** Connect V+ to 12V V- to GND and V+ to DI and make sure config mode is Ademco.<br /> *** NOTE: only possible to connect to one BUS at a time for now so an additional AD2* is needed to monitor the VPLEX bus.<br /> * improved re-transmit handling with Ademco/Vista<br /> <br /> =&lt;span style=&quot;color:#70BA66&quot;&gt;Stable Releases&lt;/span&gt;=<br /> ==2.2a.8.8==<br /> * Major changes.<br /> ** DSC. <br /> *** The virtual keypad emulation is now identical to a real DSC alpha keypad including programming mode fields.<br /> ** DSC/Ademco<br /> *** Replaced LRR formate messages with new CID format standardizing alarm reporting across panel types using Contact ID. <br /> *** Small changes in section #1<br /> ==2.2a.8.2==<br /> * Bugfixes<br /> ** Settings allocation bug<br /> * Notes<br /> ** Shipping in all units built after October 2015<br /> <br /> ==2.2a.8.1==<br /> * New Features<br /> ** Missing DSC message<br /> ** First dotted quad revision<br /> <br /> ==2.2a.8==<br /> * New Features<br /> ** DSC panel support<br /> ** Compass download/upload support<br /> ** Blinking LED now displays error codes.<br /> ** New message type '!ERR' which can be retrieved by sending an 'e' to the AlarmDecoder<br /> <br /> ==2.2a.6==<br /> <br /> ==2.2a.4==<br /> * New Features<br /> ** Keypad Address Mask<br /> ** Long Range Radio (LRR) Emulation<br /> ** Message deduplication</div> 204.10.16.14 http://www.alarmdecoder.com/wiki/index.php/Supported_Home_Automation_Systems Supported Home Automation Systems 2021-02-16T01:11:36Z <p>204.10.16.14: Update from authors of new driver for OpenHab</p> <hr /> <div>__NOTOC__ <br /> [[Category:FAQ]]<br /> [[Category:Documentation]]<br /> [[Category:Specifications]]<br /> [[Category:Features]]<br /> 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<br /> 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.<br /> <br /> <br /> &lt;center&gt;'''Here is a list of some of the systems that have support for the AlarmDecoder'''&lt;/center&gt;<br /> ----<br /> <br /> {| align=&quot;center&quot; class=&quot;wikitable&quot; border=&quot;1&quot;<br /> |-<br /> ! scope=&quot;col&quot; width=&quot;180px&quot; | Product Name<br /> ! scope=&quot;col&quot; width=&quot;100px&quot; | Driver License<br /> ! scope=&quot;col&quot; width=&quot;300px&quot; | Product URL<br /> ! scope=&quot;col&quot; width=&quot;300px&quot; | Solution Details<br /> |-<br /> | style=&quot;background:#F5FFF5&quot; align=&quot;center&quot; | Control4 <br /> | align=&quot;center&quot; | commercial <br /> | http://www.houselogix.com<br /> | [http://www.houselogix.com/ Phone &amp; Email]<br /> |-<br /> | style=&quot;background:#F5FFF5&quot; align=&quot;center&quot; | HomeSeer <br /> | align=&quot;center&quot; | commercial <br /> | http://www.homeseer.com<br /> | [http://board.homeseer.com/forumdisplay.php?f=992 Forum Thread]<br /> |-<br /> | style=&quot;background:#F5FFF5&quot; align=&quot;center&quot; | mControl v2 &amp; v3 <br /> | align=&quot;center&quot; | commercial <br /> | http://www.embeddedautomation.com<br /> | [http://www.embeddedautomation.com/downloads/mcontrol/mControl%20v3%20-%20Feature%20Summary%20Document.pdf Page 24]<br /> |-<br /> | style=&quot;background:#F5FFF5&quot; align=&quot;center&quot; | Vera2 <br /> | align=&quot;center&quot; | open source<br /> | http://www.micasaverde.com<br /> | [http://wiki.micasaverde.com/index.php/Supported_Hardware Wiki]<br /> |-<br /> | style=&quot;background:#F5FFF5&quot; align=&quot;center&quot; | Misterhouse <br /> | align=&quot;center&quot; | open source <br /> | http://misterhouse.sourceforge.net<br /> | [https://sourceforge.net/mailarchive/message.php?msg_id=31468020 Email Thread]<br /> |-<br /> | style=&quot;background:#F5FFF5&quot; align=&quot;center&quot; | Girder 5 <br /> | align=&quot;center&quot; | open source <br /> | http://www.promixis.com<br /> | [http://www.promixis.com/forums/showthread.php?21535-Nutech-AD2USB-Alarm-Panel-Integration/page2 Forum Thread]<br /> |-<br /> | style=&quot;background:#F5FFF5&quot; align=&quot;center&quot; | Indigo <br /> | align=&quot;center&quot; | open source <br /> | http://www.perceptiveautomation.com<br /> | [http://www.perceptiveautomation.com/userforum/viewtopic.php?f=22&amp;t=7584&amp;start=0 Forum Thread]<br /> |-<br /> | style=&quot;background:#F5FFF5&quot; align=&quot;center&quot; | Premise Home Control <br /> | align=&quot;center&quot; | open source <br /> | [http://cocoontech.com/forums/page/home-automation-software/_/premise-r3 Info Page]<br /> | [http://cocoontech.com/forums/topic/25698-ad2usb-for-vista-security-panels/ Forum Thread]<br /> |-<br /> | style=&quot;background:#F5FFF5&quot; align=&quot;center&quot; | ISY-99<br /> | align=&quot;center&quot; | open source <br /> | [https://www.universal-devices.com/residential/isy994i-series/ Info Page]<br /> | [http://forum.universal-devices.com/topic/7648-ad2usb-nslu2-isy-99/#p61925 Forum Thread]<br /> |-<br /> | style=&quot;background:#F5FFF5&quot; align=&quot;center&quot; | openHAB<br /> | align=&quot;center&quot; | open source<br /> | [http://www.openhab.org/ http://www.openhab.org]<br /> | [https://www.openhab.org/addons/bindings/alarmdecoder/ openhab official]<br /> |-<br /> | style=&quot;background:#F5FFF5&quot; align=&quot;center&quot; | MACHomeAutomation XTension<br /> | align=&quot;center&quot; | commercial<br /> | [http://machomeautomation.com/ http://machomeautomation.com/]<br /> | [http://machomeautomation.com/doku.php/supported_hardware/ad2usb MACHomeAutomation XTension]<br /> |-<br /> | style=&quot;background:#F5FFF5&quot; align=&quot;center&quot; | SmartThings<br /> | align=&quot;center&quot; | open source<br /> | [http://www.smartthings.com/ http://www.smartthings.com/]<br /> | [https://github.com/nutechsoftware/alarmdecoder-smartthings alarmdecoder official], [http://community.smartthings.com/t/vista-alarm-integration-using-nutech-ad2usb-and-mac/7039 AD2USB/Mac]<br /> |-<br /> | style=&quot;background:#F5FFF5&quot; align=&quot;center&quot; | OpenRemote<br /> | align=&quot;center&quot; | open source<br /> | [http://www.openremote.org/ http://www.openremote.org/]<br /> | [http://www.openremote.org/display/forums/Support+for+communicating+with+Ademco+Security+Panel Info]<br /> |-<br /> | style=&quot;background:#F5FFF5&quot; align=&quot;center&quot; | Home Assistant<br /> | align=&quot;center&quot; | open source<br /> | [https://home-assistant.io https://home-assistant.io/]<br /> | [https://home-assistant.io/components/alarmdecoder Component]<br /> |-<br /> | style=&quot;background:#F5FFF5&quot; align=&quot;center&quot; | Write your own!<br /> | align=&quot;center&quot; | &amp;nbsp;<br /> | [[Developers|Developer Wiki]]<br /> | &amp;nbsp;<br /> |}<br /> <br /> ----<br /> :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.<br /> <br /> :* MisterHouse<br /> :* LinuxMCE<br /> :* Don't see your project here? &lt;br&gt;Drop us an email at [mailto:ad2usb@support.nutech.com ad2usb@support.nutech.com] and tell us about your project.</div> 204.10.16.14 http://www.alarmdecoder.com/wiki/index.php/Protocol Protocol 2020-12-08T17:32:27Z <p>204.10.16.14: /* Configuration Parameters */</p> <hr /> <div>[[Category:FAQ]]<br /> [[Category:Documentation]]<br /> [[Category:Specifications]]<br /> [[Category:Features]]<br /> <br /> =Commands=<br /> {| class=&quot;wikitable&quot; border=&quot;1&quot;<br /> ! scope=&quot;col&quot; | Command<br /> ! scope=&quot;col&quot; | Description<br /> |-<br /> | align=&quot;center&quot; | =<br /> | align=&quot;center&quot; | [[#Reboot|Reboot]] the device.<br /> |-<br /> | align=&quot;center&quot; | !<br /> | align=&quot;center&quot; | [[#Device Configuration|Configure]] the device via prompts.<br /> |-<br /> | align=&quot;center&quot; | C<br /> | align=&quot;center&quot; | Sets or retrieves [[#Device Configuration|configuration parameters]].<br /> |-<br /> | align=&quot;center&quot; | L<br /> | align=&quot;center&quot; | [[#Zone Emulation|Emulate]] virtual zone opens and closes.<br /> |-<br /> | align=&quot;center&quot; | E<br /> | align=&quot;center&quot; | Dump error report and clear error history. [[#Error_message_report|Error report]]<br /> |-<br /> | align=&quot;center&quot; | V<br /> | align=&quot;center&quot; | Dump the version, serial number and flags used in the firmware.<br /> |-<br /> | align=&quot;center&quot; | K<br /> | align=&quot;center&quot; | Send message from specific partition or keypad address. [[#Addressed Message|Addressed Message]]<br /> |-<br /> | align=&quot;center&quot; | R<br /> | align=&quot;center&quot; | &lt;b&gt;Host Ack&lt;/b&gt;nowledge the [[#CRC|CRC]] message was valid.<br /> |-<br /> | align=&quot;center&quot; | \x01\x01\x01<br /> | align=&quot;center&quot; | Send [[#Special Keys|Special Key]] #1<br /> |-<br /> | align=&quot;center&quot; | \x02\x02\x02<br /> | align=&quot;center&quot; | Send [[#Special Keys|Special Key]] #2<br /> |-<br /> | align=&quot;center&quot; | \x03\x03\x03<br /> | align=&quot;center&quot; | Send [[#Special Keys|Special Key]] #3<br /> |-<br /> | align=&quot;center&quot; | \x04\x04\x04<br /> | align=&quot;center&quot; | Send [[#Special Keys|Special Key]] #4<br /> |-<br /> | align=&quot;center&quot; | \x05\x05\x05<br /> | align=&quot;center&quot; | Send [[#Special Keys|Special Key]] #5<br /> |-<br /> | align=&quot;center&quot; | \x06\x06\x06<br /> | align=&quot;center&quot; | Send [[#Special Keys|Special Key]] #6<br /> |-<br /> | align=&quot;center&quot; | \x07\x07\x07<br /> | align=&quot;center&quot; | Send [[#Special Keys|Special Key]] #7<br /> |-<br /> | align=&quot;center&quot; | \x08\x08\x08<br /> | align=&quot;center&quot; | Send [[#Special Keys|Special Key]] #8<br /> |-<br /> | align=&quot;center&quot; | a<br /> | align=&quot;center&quot; | DSC ONLY(deprecated use Special Keys): Arm Away<br /> |-<br /> | align=&quot;center&quot; | s<br /> | align=&quot;center&quot; | DSC ONLY(deprecated use Special Keys): Arm Stay<br /> |-<br /> | align=&quot;center&quot; | c<br /> | align=&quot;center&quot; | DSC ONLY(deprecated use Special Keys): Toggle Chime<br /> |-<br /> | align=&quot;center&quot; | 0123456789*#&lt;&gt;<br /> | align=&quot;center&quot; | Send key to panel<br /> |}<br /> <br /> ==Arming==<br /> The standard keypad keys when received by the AD2 will be treated as keypad press commands and sent to the alarm panel from the current address. If using the [[#Addressed Message|K command]] the keys will continue to be sent from the specified address until the AD2 receives a \r or \n at that point the AD2 will revert back to the configured address.<br /> <br /> ==Reboot==<br /> Rebooting the device is as simple as sending &lt;b&gt;=&lt;/b&gt; to it.<br /> <br /> During the boot process you can trigger a firmware upload by sending a second &lt;b&gt;=&lt;/b&gt; to the device after the &lt;i&gt;!boot&lt;/i&gt; message is received. At this point you'll receive a &lt;i&gt;!load&lt;/i&gt; and can begin uploading.<br /> <br /> ==Zone Emulation==<br /> 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.<br /> <br /> The &lt;b&gt;L&lt;/b&gt; 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.<br /> <br /> Example - open zone 12:<br /> * &lt;b&gt;L121\r&lt;/b&gt;<br /> <br /> Example - close zone 12:<br /> * &lt;b&gt;L120\r&lt;/b&gt;<br /> <br /> ==Addressed Message==<br /> * It is possible to send a message from a specific keypad on Ademco/Vista or to a specific partition on DSC.<br /> The &lt;b&gt;K&lt;/b&gt; 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 or a \r or \n character is received.<br /> <br /> Example - Send keypad string 1234 to DSC partition 01:<br /> * &lt;b&gt;K011234\r&lt;/b&gt;<br /> <br /> Example - Send keypad string 12343 from keypad address 19:<br /> * &lt;b&gt;K1912343\r&lt;/b&gt;<br /> <br /> ==Special Keys==<br /> 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.<br /> <br /> {| class=&quot;wikitable&quot; border=&quot;1&quot;<br /> |+ Special Key Codes<br /> ! scope=&quot;col&quot; | Code<br /> ! scope=&quot;col&quot; | Description <br /> ! scope=&quot;col&quot; | Ademco<br /> ! scope=&quot;col&quot; | DSC<br /> |-<br /> | \x01\x01\x01<br /> | Special Key #1<br /> | Fire/Prog.<br /> | Fire<br /> |-<br /> | \x02\x02\x02<br /> | Special Key #2<br /> | Police/Prog.<br /> | Police<br /> |-<br /> | \x03\x03\x03<br /> | Special Key #3<br /> | Medical/AUX/Prog.<br /> | Medical/AUX<br /> |-<br /> | \x04\x04\x04<br /> | Special Key #4<br /> | Programmable<br /> | Stay<br /> |-<br /> | \x05\x05\x05<br /> | Special Key #5<br /> | N/A<br /> | Away<br /> |-<br /> | \x06\x06\x06<br /> | Special Key #6<br /> | N/A<br /> | Chime<br /> |-<br /> | \x07\x07\x07<br /> | Special Key #7<br /> | N/A<br /> | Reset<br /> |-<br /> | \x08\x08\x08<br /> | Special Key #8<br /> | N/A<br /> | Exit<br /> |}<br /> <br /> ----<br /> <br /> =Device Configuration=<br /> The AlarmDecoder configuration can be viewed or modified in one of two ways: [[#Prompted|prompted]] or [[#Programatic|programmatically]].<br /> <br /> ==Prompted==<br /> If you send &lt;b&gt;!&lt;/b&gt; 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.<br /> <br /> &lt;b&gt;You may hit enter to keep the current value or provide a new one.&lt;/b&gt;<br /> <br /> Example:<br /> &lt;pre&gt;<br /> !&gt;Ademco/DSC Mode A/D (A) :&gt;<br /> !&gt;Keypad Address (18) :&gt;<br /> !WARNING. Do not enable a module if the physical module exists on the system.<br /> !Zone Expanders Y/N Max allowed: 02<br /> !&gt;expander module #01 ZN 09-16 (N) :&gt;<br /> !&gt;expander module #02 ZN 17-24 (N) :&gt;<br /> !&gt;expander module #03 ZN 25-32 (N) :&gt;<br /> !&gt;expander module #04 ZN 33-40 (N) :&gt;<br /> !&gt;expander module #05 ZN 41-48 (Y) :&gt;<br /> !Relay Modules Y/N Max allowed: 04<br /> !&gt;relay module #01 (Y) :&gt;<br /> !&gt;relay module #02 (N) :&gt;<br /> !&gt;relay module #03 (N) :&gt;<br /> !&gt;relay module #04 (N) :&gt;<br /> !&gt;Emulate Long Range Radio Y/N: (Y) :&gt;<br /> !&gt;Address Filter Mask (ffffffff) :&gt;<br /> !&gt;Deduplicate (N) :&gt;<br /> !&gt;Config Bits (ff04) :&gt;<br /> &lt;/pre&gt;<br /> <br /> ==Programmatic==<br /> You may retrieve all of the current device settings by sending &lt;b&gt;C&lt;/b&gt; to the panel followed by a carriage return (\r).<br /> <br /> Retrieving settings:<br /> * Send: &lt;b&gt;C\r&lt;/b&gt;<br /> * Response: &lt;b&gt;!CONFIG&gt;ADDRESS=18&amp;CONFIGBITS=ff00&amp;LRR=N&amp;EXP=NNNNN&amp;REL=NNNN&amp;MASK=ffffffff&amp;DEDUPLICATE=N&lt;/b&gt;<br /> <br /> It can also be used to set values:<br /> * Send: &lt;b&gt;CADDRESS=20\r&lt;/b&gt;<br /> * Response: &lt;b&gt;!&gt;ADDRESS=20&lt;/b&gt;<br /> <br /> The same command may be used to set multiple values:<br /> * Send: &lt;b&gt;CADDRESS=20&amp;DEDUPLICATE=Y\r&lt;/b&gt;<br /> * Response: &lt;b&gt;!&gt;ADDRESS=20&amp;DEDUPLICATE=Y&lt;/b&gt;<br /> <br /> ===Configuration Parameters===<br /> {| class=&quot;wikitable&quot; border=&quot;1&quot;<br /> ! scope=&quot;col&quot; | Name<br /> ! scope=&quot;col&quot; | Default Value<br /> ! scope=&quot;col&quot; | Valid Values (Regex)<br /> ! scope=&quot;col&quot; | Description<br /> |-<br /> | align=&quot;left&quot; | MODE<br /> | align=&quot;left&quot; | A<br /> | align=&quot;left&quot; | [A,D]{1}<br /> | align=&quot;left&quot; | Decoder panel mode Ademco or DSC.<br /> |-<br /> | align=&quot;left&quot; | ADDRESS<br /> | align=&quot;left&quot; | 18<br /> | align=&quot;left&quot; | [0-9]{2}<br /> | align=&quot;left&quot; | Keypad address assigned to the AlarmDecoder for Ademco and Partition# for DSC.<br /> |-<br /> | align=&quot;left&quot; | CONFIGBITS<br /> | align=&quot;left&quot; | FF04<br /> | align=&quot;left&quot; | [0-9a-f]{4}<br /> | align=&quot;left&quot; | Special settings for the device. See [[#CONFIGBITS|CONFIGBITS]] for more information.<br /> |-<br /> | align=&quot;left&quot; | MASK<br /> | align=&quot;left&quot; | FFFFFFFF<br /> | align=&quot;left&quot; | [0-9a-f]{8}<br /> | align=&quot;left&quot; | Address mask used to filter for keypad alphanumeric messages.<br /> |-<br /> | align=&quot;left&quot; | EXP<br /> | align=&quot;left&quot; | NNNNN<br /> | align=&quot;left&quot; | [YN]{5}<br /> | align=&quot;left&quot; | Emulation of zone expanders 1-5<br /> |-<br /> | align=&quot;left&quot; | REL<br /> | align=&quot;left&quot; | NNNN<br /> | align=&quot;left&quot; | [YN]{4}<br /> | align=&quot;left&quot; | Emulation of relay expanders 1-4<br /> |-<br /> | align=&quot;left&quot; | LRR<br /> | align=&quot;left&quot; | N<br /> | align=&quot;left&quot; | [YN]<br /> | align=&quot;left&quot; | Emulation of Long Range Radio expander<br /> |-<br /> | align=&quot;left&quot; | DEDUPLICATE<br /> | align=&quot;left&quot; | N<br /> | align=&quot;left&quot; | [YN]<br /> | align=&quot;left&quot; | If enabled, removes duplicate alphanumeric keypad messages.<br /> |-<br /> | align=&quot;left&quot; | RESET<br /> | align=&quot;left&quot; | Y<br /> | align=&quot;left&quot; | [YN]<br /> | align=&quot;left&quot; | Factory reset settings.<br /> |-<br /> |}<br /> <br /> ====CONFIGBITS====<br /> CONFIGBITS is a setting that's used to enable special functionality on the AlarmDecoder. You can enable these by masking the correct bits.<br /> <br /> {| class=&quot;wikitable&quot; border=&quot;1&quot;<br /> |+ CONFIGBITS Definition<br /> ! scope=&quot;col&quot; | Mask<br /> ! scope=&quot;col&quot; | Description<br /> |-<br /> | align=&quot;left&quot; | 0x0001<br /> | align=&quot;left&quot; | Enable reporting of [[#AUI|AUI]] messages.<br /> |-<br /> | align=&quot;left&quot; | 0x0002<br /> | align=&quot;left&quot; | Enable reporting of [[#Keypress Events|keypress events]].<br /> |-<br /> | align=&quot;left&quot; | 0x0004<br /> | align=&quot;left&quot; | Disable prompts for &lt;b&gt;L&lt;/b&gt; and &lt;b&gt;|&lt;/b&gt; commands.<br /> |-<br /> | align=&quot;left&quot; | 0x0008<br /> | align=&quot;left&quot; | Enable the prefixing of panel messages with !KPM.<br /> |-<br /> | align=&quot;left&quot; | 0x0010<br /> | align=&quot;left&quot; | Disable DSC locking (experimental).<br /> |-<br /> | align=&quot;left&quot; | 0x0080<br /> | align=&quot;left&quot; | enable CRC Delivery confirmation for LRR,EXP,REL etc.<br /> |-<br /> | align=&quot;left&quot; | 0x0100<br /> | align=&quot;left&quot; | Enable reporting of [[#RFX|RFX]] messages.<br /> |}<br /> <br /> ----<br /> <br /> =Message Types=<br /> 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]].<br /> <br /> * All lines starting with &lt;b&gt;!&lt;/b&gt; are informational.<br /> * Lines that start with &lt;b&gt;!&gt;&lt;/b&gt; are prompts.<br /> * All other lines are panel data in the form of a [[#Keypad|Keypad message]].<br /> <br /> ==Keypad==<br /> 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 &lt;b&gt;!KPM:&lt;/b&gt;.<br /> <br /> ===Format===<br /> {| class=&quot;wikitable&quot; border=&quot;1&quot;<br /> |+ Keypad Format<br /> | colspan=&quot;4&quot; align=&quot;center&quot; style=&quot;background-color: #DEDEDE; font-weight: bold&quot; | &lt;span style=&quot;color: #F56464&quot;&gt;[00110011000000003A--]&lt;/span&gt;,&lt;span style=&quot;color: #8C8CF5&quot;&gt;010&lt;/span&gt;,&lt;span style=&quot;color: #70BA66&quot;&gt;[f70700000010808c18020000000000]&lt;/span&gt;,&lt;span style=&quot;color: #804580&quot;&gt;&quot;ARMED ***STAY** ZONE BYPASSED &quot;&lt;/span&gt;<br /> |- <br /> | colspan=&quot;4&quot; | &amp;nbsp;<br /> |- <br /> ! scope=&quot;col&quot; width=&quot;160px&quot; style=&quot;color: #F56464&quot; | Bit field<br /> ! scope=&quot;col&quot; width=&quot;100px&quot; style=&quot;color: #8C8CF5&quot; | Numeric code<br /> ! scope=&quot;col&quot; width=&quot;200px&quot; style=&quot;color: #70BA66&quot; | Raw data<br /> ! scope=&quot;col&quot; width=&quot;220px&quot; style=&quot;color: #804580&quot; | Alphanumeric Keypad Message<br /> |-<br /> | align=&quot;center&quot; | [00110011000000003A--]<br /> | align=&quot;center&quot; | 010<br /> | align=&quot;center&quot; | [f70700000010808c18020000000000]<br /> | align=&quot;center&quot; | &quot;ARMED ***STAY** ZONE BYPASSED &quot;<br /> |-<br /> |}<br /> <br /> ====&lt;span style=&quot;color: #F56464&quot;&gt;Bit field&lt;/span&gt;====<br /> 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)<br /> <br /> {| class=&quot;wikitable&quot; border=&quot;1&quot;<br /> ! scope=&quot;col&quot; | Position<br /> ! scope=&quot;col&quot; | Description<br /> |-<br /> | 1<br /> | Indicates if the panel is READY<br /> |-<br /> | 2<br /> | Indicates if the panel is ARMED AWAY<br /> |-<br /> | 3<br /> | Indicates if the panel is ARMED HOME<br /> |-<br /> | 4<br /> | Indicates if the keypad backlight is on<br /> |-<br /> | 5<br /> | Indicates if the keypad is in programming mode<br /> |-<br /> | 6<br /> | Number (1-7) indicating how many beeps are associated with the message<br /> |-<br /> | 7<br /> | Indicates that a zone has been bypassed<br /> |-<br /> | 8<br /> | Indicates if the panel is on AC power<br /> |-<br /> | 9<br /> | Indicates if the chime is enabled<br /> |-<br /> | 10 <br /> | Indicates that an alarm has occurred. This is sticky and will be cleared after a second disarm.<br /> |-<br /> | 11<br /> | Indicates that an alarm is currently sounding. This is cleared after the first disarm.<br /> |-<br /> | 12<br /> | Indicates that the battery is low<br /> |-<br /> | 13<br /> | Indicates that entry delay is off (ARMED INSTANT/MAX)<br /> |-<br /> | 14<br /> | Indicates that there is a fire<br /> |-<br /> | 15<br /> | Indicates a system issue<br /> |-<br /> | 16<br /> | Indicates that the panel is only watching the perimeter (ARMED STAY/NIGHT)<br /> |-<br /> | 17<br /> | System specific bits. 4 bits packed into a HEX Nibble [0-9,A-F]<br /> |-<br /> | 18<br /> | Ademco or DSC Mode A or D<br /> |-<br /> | 19<br /> | Unused<br /> |-<br /> | 20<br /> | Unused<br /> |-<br /> |}<br /> <br /> ====&lt;span style=&quot;color: #8C8CF5&quot;&gt;Numeric Code&lt;/span&gt;====<br /> 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 &lt;b&gt;022&lt;/b&gt;. Most of the time this is zero-padded base10, but there are rare occurrences where this may be base16, such as ECP bus failures.<br /> <br /> ====&lt;span style=&quot;color: #70BA66&quot;&gt;Raw data&lt;/span&gt;====<br /> 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.<br /> <br /> 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.<br /> <br /> 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.<br /> <br /> {| class=&quot;wikitable&quot; border=&quot;1&quot;<br /> ! scope=&quot;col&quot; | Byte<br /> ! scope=&quot;col&quot; | Addresses<br /> |-<br /> | 1<br /> | 0-7<br /> |-<br /> | 2<br /> | 8-15<br /> |-<br /> | 3<br /> | 16-23<br /> |-<br /> | 4<br /> | 24-31<br /> |}<br /> <br /> For example:<br /> * f7&lt;span style=&quot;color: #70BA66&quot;&gt;07000600&lt;/span&gt;10808c08020000 - our keypad address mask is &lt;span style=&quot;color: #70BA66&quot;&gt;07000600&lt;/span&gt;.<br /> <br /> Using the above mask example of &lt;span style=&quot;color: #70BA66&quot;&gt;07000600&lt;/span&gt; we find that this message was destined for keypads 0, 1, 2, 17 and 18.<br /> <br /> There is one special case: system messages will have no address mask bits set and are intended for common keypads or monitoring multiple zones.<br /> <br /> 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.<br /> <br /> ====&lt;span style=&quot;color: #804580&quot;&gt;Alphanumeric Keypad Message&lt;/span&gt;====<br /> This section is the data that would be displayed on your keypad's screen.<br /> <br /> ==Zone Expander==<br /> 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.<br /> ===Examples===<br /> Example of zone expander at address 7, channel 1 faulting and then restoring:<br /> &lt;pre&gt;<br /> !EXP:07,01,01<br /> !EXP:07,01,00<br /> &lt;/pre&gt;<br /> <br /> ===Format===<br /> {| class=&quot;wikitable&quot; border=&quot;1&quot;<br /> |+ !EXP Format<br /> | colspan=&quot;4&quot; align=&quot;center&quot; style=&quot;background-color: #DEDEDE; font-weight: bold&quot; | &lt;span style=&quot;color: #F56464&quot;&gt;!EXP&lt;/span&gt;:&lt;span style=&quot;color: #8C8CF5&quot;&gt;07&lt;/span&gt;,&lt;span style=&quot;color: #70BA66&quot;&gt;01&lt;/span&gt;,&lt;span style=&quot;color: #804580&quot;&gt;01&lt;/span&gt;<br /> |- <br /> | colspan=&quot;4&quot; | &amp;nbsp;<br /> |- <br /> ! scope=&quot;col&quot; width=&quot;80px&quot; style=&quot;color: #F56464&quot; | Header<br /> ! scope=&quot;col&quot; width=&quot;160px&quot; style=&quot;color: #8C8CF5&quot; | Zone Expander Address<br /> ! scope=&quot;col&quot; width=&quot;140px&quot; style=&quot;color: #70BA66&quot; | Expander Channel<br /> ! scope=&quot;col&quot; width=&quot;100px&quot; style=&quot;color: #804580&quot; | Data<br /> |-<br /> | align=&quot;center&quot; | !EXP<br /> | align=&quot;center&quot; | 07<br /> | align=&quot;center&quot; | 01<br /> | align=&quot;center&quot; | 01<br /> |-<br /> |}<br /> <br /> ====&lt;span style=&quot;color: #8C8CF5&quot;&gt;Zone Expander Address&lt;/span&gt;====<br /> This is the address that the zone expander occupies.<br /> <br /> ====&lt;span style=&quot;color: #70BA66&quot;&gt;Expander Channel&lt;/span&gt;====<br /> This is the channel generating the message.<br /> <br /> ====&lt;span style=&quot;color: #804580&quot;&gt;Data&lt;/span&gt;====<br /> 00 and 01 indicate that the zone is restored and faulted, respectively.<br /> <br /> ==Relay Expander==<br /> 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.<br /> <br /> ===Examples===<br /> Examples of a relay expander at address 12, relay #1 closing and then opening:<br /> &lt;pre&gt;<br /> !REL:12,01,01<br /> !REL:12,01,00<br /> &lt;/pre&gt;<br /> <br /> ===Format===<br /> {| class=&quot;wikitable&quot; border=&quot;1&quot;<br /> |+ !REL Format<br /> | colspan=&quot;4&quot; align=&quot;center&quot; style=&quot;background-color: #DEDEDE; font-weight: bold&quot; | &lt;span style=&quot;color: #F56464&quot;&gt;!REL&lt;/span&gt;:&lt;span style=&quot;color: #8C8CF5&quot;&gt;12&lt;/span&gt;,&lt;span style=&quot;color: #70BA66&quot;&gt;01&lt;/span&gt;,&lt;span style=&quot;color: #804580&quot;&gt;01&lt;/span&gt;<br /> |- <br /> | colspan=&quot;4&quot; | &amp;nbsp;<br /> |- <br /> ! scope=&quot;col&quot; width=&quot;80px&quot; style=&quot;color: #F56464&quot; | Header<br /> ! scope=&quot;col&quot; width=&quot;160px&quot; style=&quot;color: #8C8CF5&quot; | Relay Expander Address<br /> ! scope=&quot;col&quot; width=&quot;140px&quot; style=&quot;color: #70BA66&quot; | Expander Channel<br /> ! scope=&quot;col&quot; width=&quot;100px&quot; style=&quot;color: #804580&quot; | Data<br /> |-<br /> | align=&quot;center&quot; | !REL<br /> | align=&quot;center&quot; | 12<br /> | align=&quot;center&quot; | 01<br /> | align=&quot;center&quot; | 01<br /> |-<br /> |}<br /> <br /> ====&lt;span style=&quot;color: #8C8CF5&quot;&gt;Relay Expander Address&lt;/span&gt;====<br /> This is the address that the relay expander occupies.<br /> <br /> ====&lt;span style=&quot;color: #70BA66&quot;&gt;Expander Channel&lt;/span&gt;====<br /> This is the channel generating the message.<br /> <br /> ====&lt;span style=&quot;color: #804580&quot;&gt;Data&lt;/span&gt;====<br /> 00 and 01 indicate that the relay is opened and closed, respectively.<br /> <br /> ==RFX==<br /> 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.<br /> <br /> 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. <br /> <br /> ===Examples===<br /> Example of a 5800Micra sensor faulting and restoring:<br /> &lt;pre&gt;<br /> !RFX:0180036,80<br /> !RFX:0180036,00<br /> &lt;/pre&gt;<br /> <br /> <br /> Example of a 5804 keyfob pressing the loop #2 button and having a low battery:<br /> &lt;pre&gt;<br /> !RFX:0307854,22<br /> &lt;/pre&gt;<br /> <br /> ===Format===<br /> {| class=&quot;wikitable&quot; border=&quot;1&quot;<br /> |+ !RFX Format<br /> | colspan=&quot;4&quot; align=&quot;center&quot; style=&quot;background-color: #DEDEDE; font-weight: bold&quot; | &lt;span style=&quot;color: #F56464&quot;&gt;!RFX&lt;/span&gt;:&lt;span style=&quot;color: #8C8CF5&quot;&gt;0180036&lt;/span&gt;,&lt;span style=&quot;color: #70BA66&quot;&gt;80&lt;/span&gt;<br /> |- <br /> | colspan=&quot;4&quot; | &amp;nbsp;<br /> |- <br /> ! scope=&quot;col&quot; width=&quot;80px&quot; style=&quot;color: #F56464&quot; | Header<br /> ! scope=&quot;col&quot; width=&quot;100px&quot; style=&quot;color: #8C8CF5&quot; | Serial Number<br /> ! scope=&quot;col&quot; width=&quot;100px&quot; style=&quot;color: #70BA66&quot; | Data<br /> |-<br /> | align=&quot;center&quot; | !RFX<br /> | align=&quot;center&quot; | 0180036<br /> | align=&quot;center&quot; | 80<br /> |-<br /> |}<br /> <br /> ====&lt;span style=&quot;color: #8C8CF5&quot;&gt;Serial Number&lt;/span&gt;====<br /> This is the 7-digit serial number of the device the message originated from.<br /> <br /> ====&lt;span style=&quot;color: #70BA66&quot;&gt;Data&lt;/span&gt;====<br /> 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.<br /> <br /> {| class=&quot;wikitable&quot; border=&quot;1&quot;<br /> |+ RFX Data Format<br /> |-<br /> ! scope=&quot;col&quot; | Bit<br /> ! scope=&quot;col&quot; | Description<br /> |-<br /> | align=&quot;center&quot; | 1<br /> | Unknown - Seems that the loop indicators should be ignored if set.<br /> |-<br /> | align=&quot;center&quot; | 2<br /> | Low battery indication<br /> |-<br /> | align=&quot;center&quot; | 3<br /> | Supervision required indication<br /> |-<br /> | align=&quot;center&quot; | 4<br /> | Unknown<br /> |-<br /> | align=&quot;center&quot; | 5<br /> | Loop #3 indication<br /> |-<br /> | align=&quot;center&quot; | 6<br /> | Loop #2 indication<br /> |-<br /> | align=&quot;center&quot; | 7<br /> | Loop #4 indication<br /> |-<br /> | align=&quot;center&quot; | 8<br /> | Loop #1 indication<br /> |}<br /> <br /> ==LRR==<br /> 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. The format of the data encapsulates the [[:File:SIA-ContactIDCodes_Protocol.pdf|SIA DC-05-1999.09]] standard for Contact ID reporting.<br /> <br /> ===Examples===<br /> * ARM STAY USER 002 partition 1<br /> ** !LRR:002,1,CID_3441,ff<br /> <br /> * DAY/NIGHT ALARM ZONE 9 partition 1<br /> ** !LRR:009,1,CID_1135,ff <br /> <br /> * ALARM CANCEL USER 002 partition 1<br /> ** !LRR:002,1,CID_1406,ff <br /> <br /> * ARM STAY OPENING user 002 partition 1<br /> ** !LRR:002,1,CID_1441,ff<br /> <br /> ===Format===<br /> {| class=&quot;wikitable&quot; border=&quot;1&quot;<br /> |+ !LRR Format<br /> | colspan=&quot;4&quot; align=&quot;center&quot; style=&quot;background-color: #DEDEDE; font-weight: bold&quot; | &lt;span style=&quot;color: #F56464&quot;&gt;!LRR&lt;/span&gt;:&lt;span style=&quot;color: #8C8CF5&quot;&gt;012&lt;/span&gt;,&lt;span style=&quot;color: #70BA66&quot;&gt;1&lt;/span&gt;,&lt;span style=&quot;color: #804580&quot;&gt;CID_1441&lt;/span&gt;,&lt;span style=&quot;color: #D7DF01&quot;&gt;ff&lt;/span&gt;<br /> |- <br /> | colspan=&quot;4&quot; | &amp;nbsp;<br /> |- <br /> ! scope=&quot;col&quot; width=&quot;80px&quot; style=&quot;color: #F56464&quot; | Header<br /> ! scope=&quot;col&quot; width=&quot;100px&quot; style=&quot;color: #8C8CF5&quot; | Event Data<br /> ! scope=&quot;col&quot; width=&quot;80px&quot; style=&quot;color: #70BA66&quot; | Partition<br /> ! scope=&quot;col&quot; width=&quot;100px&quot; style=&quot;color: #804580&quot; | CID MESSAGE<br /> ! scope=&quot;col&quot; width=&quot;100px&quot; style=&quot;color: #D7DF01&quot; | Report CODE<br /> |-<br /> | align=&quot;center&quot; | !LRR<br /> | align=&quot;center&quot; | 012<br /> | align=&quot;center&quot; | 1<br /> | align=&quot;center&quot; | CID_1441<br /> | align=&quot;center&quot; | ff<br /> |-<br /> |}<br /> <br /> ====&lt;span style=&quot;color: #8C8CF5&quot;&gt;Event Data&lt;/span&gt;====<br /> This is either the user number of the person performing the action or the zone that was bypassed.<br /> <br /> ====&lt;span style=&quot;color: #70BA66&quot;&gt;Partition&lt;/span&gt;====<br /> The panel partition the event applies to. Partition 0 indicates that it's destined for all partitions.<br /> <br /> ====&lt;span style=&quot;color: #804580&quot;&gt;CID Message&lt;/span&gt;====<br /> This is CID message for the event. See below for a description and what (if any) programming fields are required for activation. It is prefixed with &quot;CID_&quot; and then 4 digits that are described in section 5.1.2.2 of the [[:File:SIA-ContactIDCodes_Protocol.pdf|SIA DC-05-1999.09]] standard.<br /> <br /> {| class=&quot;wikitable&quot; border=&quot;1&quot;<br /> |+ Report Code Format<br /> | colspan=&quot;3&quot; align=&quot;center&quot; style=&quot;background-color: #DEDEDE; font-weight: bold&quot; | &lt;span style=&quot;color: #F56464&quot;&gt;CID_&lt;/span&gt;&lt;span style=&quot;color: #8C8CF5&quot;&gt;Q&lt;/span&gt;&lt;span style=&quot;color: #70BA66&quot;&gt;XYZ&lt;/span&gt;<br /> |- <br /> | colspan=&quot;3&quot; | &amp;nbsp;<br /> |- <br /> ! scope=&quot;col&quot; width=&quot;80px&quot; style=&quot;color: #F56464&quot; | Header<br /> ! scope=&quot;col&quot; width=&quot;100px&quot; style=&quot;color: #8C8CF5&quot; | Event qualifier<br /> ! scope=&quot;col&quot; width=&quot;80px&quot; style=&quot;color: #70BA66&quot; | Event code<br /> |-<br /> | align=&quot;center&quot; | CID_<br /> | align=&quot;center&quot; | 1<br /> | align=&quot;center&quot; | 441<br /> |-<br /> |}<br /> <br /> ====&lt;span style=&quot;color: #F56464&quot;&gt;Header&lt;/span&gt;====<br /> Static string &quot;CID_&quot;<br /> ====&lt;span style=&quot;color: #8C8CF5&quot;&gt;Event qualifier&lt;/span&gt;====<br /> 1 = New Event or Opening <br /> 3 = New Restore or Closing <br /> 6 = Previously reported condition still present (Status report)<br /> ====&lt;span style=&quot;color: #70BA66&quot;&gt;Event code&lt;/span&gt;====<br /> (3 Hex digits 0-9,B-F)<br /> Event codes are 3 hex digits and are broken down in classes by the first digit.<br /> 100 Alarms<br /> 200 Supervisory<br /> 300 Troubles<br /> 400 Open/Close REMOTE ACCESS<br /> 500 Bypass/Disables<br /> 600 TEST/MISC<br /> For more detail on specific report codes see the list see '''Appendix C''' in the [[:File:SIA-ContactIDCodes_Protocol.pdf|SIA DC-05-1999.09]] standard.<br /> <br /> ==AUI==<br /> AUI messages are generated for &quot;Advanced User Interface&quot; keypads. These include a lot of extra data than what's destined for regular keypads.<br /> <br /> ===Format===<br /> {| class=&quot;wikitable&quot; border=&quot;1&quot;<br /> |+ !AUI Format<br /> | colspan=&quot;4&quot; align=&quot;center&quot; style=&quot;background-color: #DEDEDE; font-weight: bold&quot; | &lt;span style=&quot;color: #F56464&quot;&gt;!AUI&lt;/span&gt;:&lt;span style=&quot;color: #8C8CF5&quot;&gt;126600000000656c02456cf5ec01017f0002&lt;/span&gt;<br /> |- <br /> | colspan=&quot;4&quot; | &amp;nbsp;<br /> |- <br /> ! scope=&quot;col&quot; width=&quot;80px&quot; style=&quot;color: #F56464&quot; | Header<br /> ! scope=&quot;col&quot; width=&quot;100px&quot; style=&quot;color: #8C8CF5&quot; | AUI Data<br /> |-<br /> | align=&quot;center&quot; | !AUI<br /> | align=&quot;center&quot; | 126600000000656c02456cf5ec01017f0002<br /> |-<br /> |}<br /> <br /> ====&lt;span style=&quot;color: #8C8CF5&quot;&gt;AUI Data&lt;/span&gt;====<br /> 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.<br /> <br /> ==Keypress Events==<br /> Keypress events are generated when keys are pressed on a keypad and can be enabled inside [[#CONFIGBITS|CONFIGBITS]].<br /> <br /> ===Format===<br /> {| class=&quot;wikitable&quot; border=&quot;1&quot;<br /> |+ !KPE Format<br /> | colspan=&quot;4&quot; align=&quot;center&quot; style=&quot;background-color: #DEDEDE; font-weight: bold&quot; | &lt;span style=&quot;color: #F56464&quot;&gt;!KPE&lt;/span&gt;:&lt;span style=&quot;color: #8C8CF5&quot;&gt;18&lt;/span&gt;<br /> |- <br /> | colspan=&quot;4&quot; | &amp;nbsp;<br /> |- <br /> ! scope=&quot;col&quot; width=&quot;80px&quot; style=&quot;color: #F56464&quot; | Header<br /> ! scope=&quot;col&quot; width=&quot;100px&quot; style=&quot;color: #8C8CF5&quot; | Keypad Address<br /> |-<br /> | align=&quot;center&quot; | !KPE<br /> | align=&quot;center&quot; | 18<br /> |-<br /> |}<br /> <br /> ==Error message report==<br /> 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. <br /> <br /> ===Format===<br /> {| class=&quot;wikitable&quot; border=&quot;1&quot;<br /> |+ !ERR Format<br /> | colspan=&quot;4&quot; align=&quot;center&quot; style=&quot;background-color: #DEDEDE; font-weight: bold&quot; | &lt;span style=&quot;color: #F56464&quot;&gt;!ERR&lt;/span&gt;:&lt;span style=&quot;color: #8C8CF5&quot;&gt;4,4,4&lt;/span&gt;<br /> |- <br /> | colspan=&quot;4&quot; | &amp;nbsp;<br /> |- <br /> ! scope=&quot;col&quot; width=&quot;80px&quot; style=&quot;color: #F56464&quot; | Header<br /> ! scope=&quot;col&quot; width=&quot;100px&quot; style=&quot;color: #8C8CF5&quot; | Error list<br /> |-<br /> | align=&quot;center&quot; | !ERR<br /> | align=&quot;center&quot; | 4,4,4<br /> |-<br /> |}<br /> <br /> ===Error Codes===<br /> {| class=&quot;wikitable&quot; border=&quot;1&quot;<br /> |+ Error Codes<br /> |- <br /> | colspan=&quot;4&quot; | &amp;nbsp;<br /> |- <br /> ! scope=&quot;col&quot; width=&quot;80px&quot; | Error number<br /> ! scope=&quot;col&quot; width=&quot;100px&quot; | Description<br /> |-<br /> | align=&quot;center&quot; | 0<br /> | align=&quot;center&quot; | No issues to report<br /> |-<br /> | align=&quot;center&quot; | 4<br /> | align=&quot;center&quot; | Keypress send failure<br /> |-<br /> |}<br /> <br /> <br /> ==CRC==<br /> 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. Enable via [[#CONFIGBITS|CONFIGBITS]]<br /> <br /> ===Format===<br /> {| class=&quot;wikitable&quot; border=&quot;1&quot;<br /> |+ !CRC Format<br /> | colspan=&quot;4&quot; align=&quot;center&quot; style=&quot;background-color: #DEDEDE; font-weight: bold&quot; | &lt;span style=&quot;color: #F56464&quot;&gt;!CRC&lt;/span&gt;:&lt;span style=&quot;color: #8C8CF5&quot;&gt;!LRR:000,1,CID_1121,ff&lt;/span&gt;,&lt;span style=&quot;color: #70BA66&quot;&gt;282d&lt;/span&gt;<br /> |- <br /> | colspan=&quot;4&quot; | &amp;nbsp;<br /> |- <br /> ! scope=&quot;col&quot; width=&quot;80px&quot; style=&quot;color: #F56464&quot; | Header<br /> ! scope=&quot;col&quot; width=&quot;100px&quot; style=&quot;color: #8C8CF5&quot; | Event Data<br /> ! scope=&quot;col&quot; width=&quot;80px&quot; style=&quot;color: #70BA66&quot; | CRC<br /> |-<br /> | align=&quot;center&quot; | !CRC<br /> | align=&quot;center&quot; | !LRR:000,1,CID_1121,ff<br /> | align=&quot;center&quot; | 282d<br /> |-<br /> |}<br /> <br /> ==Version Message==<br /> This message indicates the serial number of the unit, version, and the firmware capabilities.<br /> <br /> ===Format===<br /> {| class=&quot;wikitable&quot; border=&quot;1&quot;<br /> |+ !VER Format<br /> | colspan=&quot;4&quot; align=&quot;center&quot; style=&quot;background-color: #DEDEDE; font-weight: bold&quot; | &lt;span style=&quot;color: #F56464&quot;&gt;!VER&lt;/span&gt;:&lt;span style=&quot;color: #8C8CF5&quot;&gt;ffffffff&lt;/span&gt;,&lt;span style=&quot;color: #70BA66&quot;&gt;V2.2a.8.2&lt;/span&gt;,&lt;span style=&quot;color: #804580&quot;&gt;TX;RX;SM;VZ;RF;ZX;RE;AU;3X;CG;DD;MF;LR;KE;MK;CB;DS;ER&lt;/span&gt;<br /> |- <br /> | colspan=&quot;4&quot; | &amp;nbsp;<br /> |- <br /> ! scope=&quot;col&quot; width=&quot;80px&quot; style=&quot;color: #F56464&quot; | Header<br /> ! scope=&quot;col&quot; width=&quot;100px&quot; style=&quot;color: #8C8CF5&quot; | Serial number<br /> ! scope=&quot;col&quot; width=&quot;100px&quot; style=&quot;color: #70BA66&quot; | Firmware version<br /> ! scope=&quot;col&quot; width=&quot;100px&quot; style=&quot;color: #804580&quot; | Firmware capabilities<br /> |-<br /> | align=&quot;center&quot; | !VER<br /> | align=&quot;center&quot; | ffffffff<br /> | align=&quot;center&quot; | V2.2a.8.2<br /> | align=&quot;center&quot; | TX;RX;SM;VZ;RF;ZX;RE;AU;3X;CG;DD;MF;LR;KE;MK;CB;DS;ER<br /> |-<br /> |}<br /> <br /> ====&lt;span style=&quot;color: #8C8CF5&quot;&gt;Serial Number&lt;/span&gt;====<br /> This is the serial number of the device. If unset this defaults to ffffffff.<br /> <br /> ====&lt;span style=&quot;color: #70BA66&quot;&gt;Firmware Version&lt;/span&gt;====<br /> This is the revision of the firmware that is currently loaded on the device.<br /> <br /> ====&lt;span style=&quot;color: #804580&quot;&gt;Firmware Capabilities&lt;/span&gt;====<br /> This field indicates which capabilities are built in to the firmware. See the below table for reference.<br /> <br /> {| class=&quot;wikitable&quot; border=&quot;1&quot;<br /> |+ !VER Format<br /> | colspan=&quot;4&quot; align=&quot;center&quot; style=&quot;background-color: #DEDEDE; font-weight: bold&quot; | Firmware Capabilities<br /> |- <br /> | colspan=&quot;4&quot; | &amp;nbsp;<br /> |- <br /> ! scope=&quot;col&quot; width=&quot;80px&quot; | Flag<br /> ! scope=&quot;col&quot; width=&quot;100px&quot; | Description<br /> |-<br /> | align=&quot;center&quot; | TX<br /> | align=&quot;center&quot; | Ability to transmit to the panel<br /> |-<br /> |-<br /> | align=&quot;center&quot; | RX<br /> | align=&quot;center&quot; | Ability to receive from the panel<br /> |-<br /> | align=&quot;center&quot; | SM<br /> | align=&quot;center&quot; | Supports sending multiple keypresses<br /> |-<br /> | align=&quot;center&quot; | VZ<br /> | align=&quot;center&quot; | Virtual zone expanders<br /> |-<br /> | align=&quot;center&quot; | RF<br /> | align=&quot;center&quot; | Supports receiving of RF messages from the 5800 series wireless devices (!RFX)<br /> |-<br /> | align=&quot;center&quot; | ZX<br /> | align=&quot;center&quot; | Supports receiving of messages from zone expanders (!EXP)<br /> |-<br /> | align=&quot;center&quot; | RE<br /> | align=&quot;center&quot; | Supports receiving of messages from relay (!REL)<br /> |-<br /> | align=&quot;center&quot; | AU<br /> | align=&quot;center&quot; | AUI support (!AUI)<br /> |-<br /> | align=&quot;center&quot; | 3X<br /> | align=&quot;center&quot; | Special Keys (S1-S4) must be sent 3 times to trigger<br /> |-<br /> | align=&quot;center&quot; | CG<br /> | align=&quot;center&quot; | Serialized configuration string<br /> |-<br /> | align=&quot;center&quot; | DD<br /> | align=&quot;center&quot; | Message deduplication<br /> |-<br /> | align=&quot;center&quot; | MF<br /> | align=&quot;center&quot; | Address mask filter<br /> |-<br /> | align=&quot;center&quot; | LR<br /> | align=&quot;center&quot; | Long range radio messages (!LRR) deprecated see L2<br /> |-<br /> | align=&quot;center&quot; | L2<br /> | align=&quot;center&quot; | Long range radio messages (!LRR) with CID reporting format<br /> |-<br /> | align=&quot;center&quot; | KE<br /> | align=&quot;center&quot; | Keypad event messages (!KPM)<br /> |-<br /> | align=&quot;center&quot; | MK<br /> | align=&quot;center&quot; | Multiple keypad emulation (See 'K' command for more information)<br /> |-<br /> | align=&quot;center&quot; | CB<br /> | align=&quot;center&quot; | Config bits<br /> |-<br /> | align=&quot;center&quot; | DS<br /> | align=&quot;center&quot; | DSC support<br /> |-<br /> | align=&quot;center&quot; | ER<br /> | align=&quot;center&quot; | Error tracking<br /> |-<br /> | align=&quot;center&quot; | CR<br /> | align=&quot;center&quot; | CRC Wrapper around EXP,LRR and other event type messages<br /> |-<br /> |}<br /> <br /> =Device Feedback LED=<br /> * Boot flash mode<br /> ** During boot the AD2* will rapid flash during the boot loader.<br /> * Operating mode<br /> ** The normal operating mode is a steady of approx 2.5 flashes per second.<br /> ** Sending to panel mode 3 flashes.<br /> * Error mode<br /> ** 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.</div> 204.10.16.14 http://www.alarmdecoder.com/wiki/index.php/Protocol Protocol 2020-12-08T17:31:06Z <p>204.10.16.14: /* Configuration Parameters */</p> <hr /> <div>[[Category:FAQ]]<br /> [[Category:Documentation]]<br /> [[Category:Specifications]]<br /> [[Category:Features]]<br /> <br /> =Commands=<br /> {| class=&quot;wikitable&quot; border=&quot;1&quot;<br /> ! scope=&quot;col&quot; | Command<br /> ! scope=&quot;col&quot; | Description<br /> |-<br /> | align=&quot;center&quot; | =<br /> | align=&quot;center&quot; | [[#Reboot|Reboot]] the device.<br /> |-<br /> | align=&quot;center&quot; | !<br /> | align=&quot;center&quot; | [[#Device Configuration|Configure]] the device via prompts.<br /> |-<br /> | align=&quot;center&quot; | C<br /> | align=&quot;center&quot; | Sets or retrieves [[#Device Configuration|configuration parameters]].<br /> |-<br /> | align=&quot;center&quot; | L<br /> | align=&quot;center&quot; | [[#Zone Emulation|Emulate]] virtual zone opens and closes.<br /> |-<br /> | align=&quot;center&quot; | E<br /> | align=&quot;center&quot; | Dump error report and clear error history. [[#Error_message_report|Error report]]<br /> |-<br /> | align=&quot;center&quot; | V<br /> | align=&quot;center&quot; | Dump the version, serial number and flags used in the firmware.<br /> |-<br /> | align=&quot;center&quot; | K<br /> | align=&quot;center&quot; | Send message from specific partition or keypad address. [[#Addressed Message|Addressed Message]]<br /> |-<br /> | align=&quot;center&quot; | R<br /> | align=&quot;center&quot; | &lt;b&gt;Host Ack&lt;/b&gt;nowledge the [[#CRC|CRC]] message was valid.<br /> |-<br /> | align=&quot;center&quot; | \x01\x01\x01<br /> | align=&quot;center&quot; | Send [[#Special Keys|Special Key]] #1<br /> |-<br /> | align=&quot;center&quot; | \x02\x02\x02<br /> | align=&quot;center&quot; | Send [[#Special Keys|Special Key]] #2<br /> |-<br /> | align=&quot;center&quot; | \x03\x03\x03<br /> | align=&quot;center&quot; | Send [[#Special Keys|Special Key]] #3<br /> |-<br /> | align=&quot;center&quot; | \x04\x04\x04<br /> | align=&quot;center&quot; | Send [[#Special Keys|Special Key]] #4<br /> |-<br /> | align=&quot;center&quot; | \x05\x05\x05<br /> | align=&quot;center&quot; | Send [[#Special Keys|Special Key]] #5<br /> |-<br /> | align=&quot;center&quot; | \x06\x06\x06<br /> | align=&quot;center&quot; | Send [[#Special Keys|Special Key]] #6<br /> |-<br /> | align=&quot;center&quot; | \x07\x07\x07<br /> | align=&quot;center&quot; | Send [[#Special Keys|Special Key]] #7<br /> |-<br /> | align=&quot;center&quot; | \x08\x08\x08<br /> | align=&quot;center&quot; | Send [[#Special Keys|Special Key]] #8<br /> |-<br /> | align=&quot;center&quot; | a<br /> | align=&quot;center&quot; | DSC ONLY(deprecated use Special Keys): Arm Away<br /> |-<br /> | align=&quot;center&quot; | s<br /> | align=&quot;center&quot; | DSC ONLY(deprecated use Special Keys): Arm Stay<br /> |-<br /> | align=&quot;center&quot; | c<br /> | align=&quot;center&quot; | DSC ONLY(deprecated use Special Keys): Toggle Chime<br /> |-<br /> | align=&quot;center&quot; | 0123456789*#&lt;&gt;<br /> | align=&quot;center&quot; | Send key to panel<br /> |}<br /> <br /> ==Arming==<br /> The standard keypad keys when received by the AD2 will be treated as keypad press commands and sent to the alarm panel from the current address. If using the [[#Addressed Message|K command]] the keys will continue to be sent from the specified address until the AD2 receives a \r or \n at that point the AD2 will revert back to the configured address.<br /> <br /> ==Reboot==<br /> Rebooting the device is as simple as sending &lt;b&gt;=&lt;/b&gt; to it.<br /> <br /> During the boot process you can trigger a firmware upload by sending a second &lt;b&gt;=&lt;/b&gt; to the device after the &lt;i&gt;!boot&lt;/i&gt; message is received. At this point you'll receive a &lt;i&gt;!load&lt;/i&gt; and can begin uploading.<br /> <br /> ==Zone Emulation==<br /> 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.<br /> <br /> The &lt;b&gt;L&lt;/b&gt; 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.<br /> <br /> Example - open zone 12:<br /> * &lt;b&gt;L121\r&lt;/b&gt;<br /> <br /> Example - close zone 12:<br /> * &lt;b&gt;L120\r&lt;/b&gt;<br /> <br /> ==Addressed Message==<br /> * It is possible to send a message from a specific keypad on Ademco/Vista or to a specific partition on DSC.<br /> The &lt;b&gt;K&lt;/b&gt; 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 or a \r or \n character is received.<br /> <br /> Example - Send keypad string 1234 to DSC partition 01:<br /> * &lt;b&gt;K011234\r&lt;/b&gt;<br /> <br /> Example - Send keypad string 12343 from keypad address 19:<br /> * &lt;b&gt;K1912343\r&lt;/b&gt;<br /> <br /> ==Special Keys==<br /> 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.<br /> <br /> {| class=&quot;wikitable&quot; border=&quot;1&quot;<br /> |+ Special Key Codes<br /> ! scope=&quot;col&quot; | Code<br /> ! scope=&quot;col&quot; | Description <br /> ! scope=&quot;col&quot; | Ademco<br /> ! scope=&quot;col&quot; | DSC<br /> |-<br /> | \x01\x01\x01<br /> | Special Key #1<br /> | Fire/Prog.<br /> | Fire<br /> |-<br /> | \x02\x02\x02<br /> | Special Key #2<br /> | Police/Prog.<br /> | Police<br /> |-<br /> | \x03\x03\x03<br /> | Special Key #3<br /> | Medical/AUX/Prog.<br /> | Medical/AUX<br /> |-<br /> | \x04\x04\x04<br /> | Special Key #4<br /> | Programmable<br /> | Stay<br /> |-<br /> | \x05\x05\x05<br /> | Special Key #5<br /> | N/A<br /> | Away<br /> |-<br /> | \x06\x06\x06<br /> | Special Key #6<br /> | N/A<br /> | Chime<br /> |-<br /> | \x07\x07\x07<br /> | Special Key #7<br /> | N/A<br /> | Reset<br /> |-<br /> | \x08\x08\x08<br /> | Special Key #8<br /> | N/A<br /> | Exit<br /> |}<br /> <br /> ----<br /> <br /> =Device Configuration=<br /> The AlarmDecoder configuration can be viewed or modified in one of two ways: [[#Prompted|prompted]] or [[#Programatic|programmatically]].<br /> <br /> ==Prompted==<br /> If you send &lt;b&gt;!&lt;/b&gt; 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.<br /> <br /> &lt;b&gt;You may hit enter to keep the current value or provide a new one.&lt;/b&gt;<br /> <br /> Example:<br /> &lt;pre&gt;<br /> !&gt;Ademco/DSC Mode A/D (A) :&gt;<br /> !&gt;Keypad Address (18) :&gt;<br /> !WARNING. Do not enable a module if the physical module exists on the system.<br /> !Zone Expanders Y/N Max allowed: 02<br /> !&gt;expander module #01 ZN 09-16 (N) :&gt;<br /> !&gt;expander module #02 ZN 17-24 (N) :&gt;<br /> !&gt;expander module #03 ZN 25-32 (N) :&gt;<br /> !&gt;expander module #04 ZN 33-40 (N) :&gt;<br /> !&gt;expander module #05 ZN 41-48 (Y) :&gt;<br /> !Relay Modules Y/N Max allowed: 04<br /> !&gt;relay module #01 (Y) :&gt;<br /> !&gt;relay module #02 (N) :&gt;<br /> !&gt;relay module #03 (N) :&gt;<br /> !&gt;relay module #04 (N) :&gt;<br /> !&gt;Emulate Long Range Radio Y/N: (Y) :&gt;<br /> !&gt;Address Filter Mask (ffffffff) :&gt;<br /> !&gt;Deduplicate (N) :&gt;<br /> !&gt;Config Bits (ff04) :&gt;<br /> &lt;/pre&gt;<br /> <br /> ==Programmatic==<br /> You may retrieve all of the current device settings by sending &lt;b&gt;C&lt;/b&gt; to the panel followed by a carriage return (\r).<br /> <br /> Retrieving settings:<br /> * Send: &lt;b&gt;C\r&lt;/b&gt;<br /> * Response: &lt;b&gt;!CONFIG&gt;ADDRESS=18&amp;CONFIGBITS=ff00&amp;LRR=N&amp;EXP=NNNNN&amp;REL=NNNN&amp;MASK=ffffffff&amp;DEDUPLICATE=N&lt;/b&gt;<br /> <br /> It can also be used to set values:<br /> * Send: &lt;b&gt;CADDRESS=20\r&lt;/b&gt;<br /> * Response: &lt;b&gt;!&gt;ADDRESS=20&lt;/b&gt;<br /> <br /> The same command may be used to set multiple values:<br /> * Send: &lt;b&gt;CADDRESS=20&amp;DEDUPLICATE=Y\r&lt;/b&gt;<br /> * Response: &lt;b&gt;!&gt;ADDRESS=20&amp;DEDUPLICATE=Y&lt;/b&gt;<br /> <br /> ===Configuration Parameters===<br /> {| class=&quot;wikitable&quot; border=&quot;1&quot;<br /> ! scope=&quot;col&quot; | Name<br /> ! scope=&quot;col&quot; | Default Value<br /> ! scope=&quot;col&quot; | Valid Values (Regex)<br /> ! scope=&quot;col&quot; | Description<br /> |-<br /> | align=&quot;left&quot; | MODE<br /> | align=&quot;left&quot; | A<br /> | align=&quot;left&quot; | [A,D]{1}<br /> | align=&quot;left&quot; | Decoder panel mode Ademco or DSC.<br /> |-<br /> | align=&quot;left&quot; | ADDRESS<br /> | align=&quot;left&quot; | 18<br /> | align=&quot;left&quot; | [0-9]{2}<br /> | align=&quot;left&quot; | Keypad address assigned to the AlarmDecoder for Ademco and Partition# for DSC.<br /> |-<br /> | align=&quot;left&quot; | CONFIGBITS<br /> | align=&quot;left&quot; | FF04<br /> | align=&quot;left&quot; | [0-9a-f]{4}<br /> | align=&quot;left&quot; | Special settings for the device. See [[#CONFIGBITS|CONFIGBITS]] for more information.<br /> |-<br /> | align=&quot;left&quot; | MASK<br /> | align=&quot;left&quot; | FFFFFFFF<br /> | align=&quot;left&quot; | [0-9a-f]{8}<br /> | align=&quot;left&quot; | Address mask used to filter for keypad alphanumeric messages.<br /> |-<br /> | align=&quot;left&quot; | EXP<br /> | align=&quot;left&quot; | NNNNN<br /> | align=&quot;left&quot; | [YN]{5}<br /> | align=&quot;left&quot; | Emulation of zone expanders 1-5<br /> |-<br /> | align=&quot;left&quot; | REL<br /> | align=&quot;left&quot; | NNNN<br /> | align=&quot;left&quot; | [YN]{4}<br /> | align=&quot;left&quot; | Emulation of relay expanders 1-4<br /> |-<br /> | align=&quot;left&quot; | LRR<br /> | align=&quot;left&quot; | N<br /> | align=&quot;left&quot; | [YN]<br /> | align=&quot;left&quot; | Emulation of Long Range Radio expander<br /> |-<br /> | align=&quot;left&quot; | DEDUPLICATE<br /> | align=&quot;left&quot; | N<br /> | align=&quot;left&quot; | [YN]<br /> | align=&quot;left&quot; | If enabled, removes duplicate alphanumeric keypad messages.<br /> |-<br /> |}<br /> <br /> ====CONFIGBITS====<br /> CONFIGBITS is a setting that's used to enable special functionality on the AlarmDecoder. You can enable these by masking the correct bits.<br /> <br /> {| class=&quot;wikitable&quot; border=&quot;1&quot;<br /> |+ CONFIGBITS Definition<br /> ! scope=&quot;col&quot; | Mask<br /> ! scope=&quot;col&quot; | Description<br /> |-<br /> | align=&quot;left&quot; | 0x0001<br /> | align=&quot;left&quot; | Enable reporting of [[#AUI|AUI]] messages.<br /> |-<br /> | align=&quot;left&quot; | 0x0002<br /> | align=&quot;left&quot; | Enable reporting of [[#Keypress Events|keypress events]].<br /> |-<br /> | align=&quot;left&quot; | 0x0004<br /> | align=&quot;left&quot; | Disable prompts for &lt;b&gt;L&lt;/b&gt; and &lt;b&gt;|&lt;/b&gt; commands.<br /> |-<br /> | align=&quot;left&quot; | 0x0008<br /> | align=&quot;left&quot; | Enable the prefixing of panel messages with !KPM.<br /> |-<br /> | align=&quot;left&quot; | 0x0010<br /> | align=&quot;left&quot; | Disable DSC locking (experimental).<br /> |-<br /> | align=&quot;left&quot; | 0x0080<br /> | align=&quot;left&quot; | enable CRC Delivery confirmation for LRR,EXP,REL etc.<br /> |-<br /> | align=&quot;left&quot; | 0x0100<br /> | align=&quot;left&quot; | Enable reporting of [[#RFX|RFX]] messages.<br /> |}<br /> <br /> ----<br /> <br /> =Message Types=<br /> 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]].<br /> <br /> * All lines starting with &lt;b&gt;!&lt;/b&gt; are informational.<br /> * Lines that start with &lt;b&gt;!&gt;&lt;/b&gt; are prompts.<br /> * All other lines are panel data in the form of a [[#Keypad|Keypad message]].<br /> <br /> ==Keypad==<br /> 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 &lt;b&gt;!KPM:&lt;/b&gt;.<br /> <br /> ===Format===<br /> {| class=&quot;wikitable&quot; border=&quot;1&quot;<br /> |+ Keypad Format<br /> | colspan=&quot;4&quot; align=&quot;center&quot; style=&quot;background-color: #DEDEDE; font-weight: bold&quot; | &lt;span style=&quot;color: #F56464&quot;&gt;[00110011000000003A--]&lt;/span&gt;,&lt;span style=&quot;color: #8C8CF5&quot;&gt;010&lt;/span&gt;,&lt;span style=&quot;color: #70BA66&quot;&gt;[f70700000010808c18020000000000]&lt;/span&gt;,&lt;span style=&quot;color: #804580&quot;&gt;&quot;ARMED ***STAY** ZONE BYPASSED &quot;&lt;/span&gt;<br /> |- <br /> | colspan=&quot;4&quot; | &amp;nbsp;<br /> |- <br /> ! scope=&quot;col&quot; width=&quot;160px&quot; style=&quot;color: #F56464&quot; | Bit field<br /> ! scope=&quot;col&quot; width=&quot;100px&quot; style=&quot;color: #8C8CF5&quot; | Numeric code<br /> ! scope=&quot;col&quot; width=&quot;200px&quot; style=&quot;color: #70BA66&quot; | Raw data<br /> ! scope=&quot;col&quot; width=&quot;220px&quot; style=&quot;color: #804580&quot; | Alphanumeric Keypad Message<br /> |-<br /> | align=&quot;center&quot; | [00110011000000003A--]<br /> | align=&quot;center&quot; | 010<br /> | align=&quot;center&quot; | [f70700000010808c18020000000000]<br /> | align=&quot;center&quot; | &quot;ARMED ***STAY** ZONE BYPASSED &quot;<br /> |-<br /> |}<br /> <br /> ====&lt;span style=&quot;color: #F56464&quot;&gt;Bit field&lt;/span&gt;====<br /> 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)<br /> <br /> {| class=&quot;wikitable&quot; border=&quot;1&quot;<br /> ! scope=&quot;col&quot; | Position<br /> ! scope=&quot;col&quot; | Description<br /> |-<br /> | 1<br /> | Indicates if the panel is READY<br /> |-<br /> | 2<br /> | Indicates if the panel is ARMED AWAY<br /> |-<br /> | 3<br /> | Indicates if the panel is ARMED HOME<br /> |-<br /> | 4<br /> | Indicates if the keypad backlight is on<br /> |-<br /> | 5<br /> | Indicates if the keypad is in programming mode<br /> |-<br /> | 6<br /> | Number (1-7) indicating how many beeps are associated with the message<br /> |-<br /> | 7<br /> | Indicates that a zone has been bypassed<br /> |-<br /> | 8<br /> | Indicates if the panel is on AC power<br /> |-<br /> | 9<br /> | Indicates if the chime is enabled<br /> |-<br /> | 10 <br /> | Indicates that an alarm has occurred. This is sticky and will be cleared after a second disarm.<br /> |-<br /> | 11<br /> | Indicates that an alarm is currently sounding. This is cleared after the first disarm.<br /> |-<br /> | 12<br /> | Indicates that the battery is low<br /> |-<br /> | 13<br /> | Indicates that entry delay is off (ARMED INSTANT/MAX)<br /> |-<br /> | 14<br /> | Indicates that there is a fire<br /> |-<br /> | 15<br /> | Indicates a system issue<br /> |-<br /> | 16<br /> | Indicates that the panel is only watching the perimeter (ARMED STAY/NIGHT)<br /> |-<br /> | 17<br /> | System specific bits. 4 bits packed into a HEX Nibble [0-9,A-F]<br /> |-<br /> | 18<br /> | Ademco or DSC Mode A or D<br /> |-<br /> | 19<br /> | Unused<br /> |-<br /> | 20<br /> | Unused<br /> |-<br /> |}<br /> <br /> ====&lt;span style=&quot;color: #8C8CF5&quot;&gt;Numeric Code&lt;/span&gt;====<br /> 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 &lt;b&gt;022&lt;/b&gt;. Most of the time this is zero-padded base10, but there are rare occurrences where this may be base16, such as ECP bus failures.<br /> <br /> ====&lt;span style=&quot;color: #70BA66&quot;&gt;Raw data&lt;/span&gt;====<br /> 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.<br /> <br /> 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.<br /> <br /> 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.<br /> <br /> {| class=&quot;wikitable&quot; border=&quot;1&quot;<br /> ! scope=&quot;col&quot; | Byte<br /> ! scope=&quot;col&quot; | Addresses<br /> |-<br /> | 1<br /> | 0-7<br /> |-<br /> | 2<br /> | 8-15<br /> |-<br /> | 3<br /> | 16-23<br /> |-<br /> | 4<br /> | 24-31<br /> |}<br /> <br /> For example:<br /> * f7&lt;span style=&quot;color: #70BA66&quot;&gt;07000600&lt;/span&gt;10808c08020000 - our keypad address mask is &lt;span style=&quot;color: #70BA66&quot;&gt;07000600&lt;/span&gt;.<br /> <br /> Using the above mask example of &lt;span style=&quot;color: #70BA66&quot;&gt;07000600&lt;/span&gt; we find that this message was destined for keypads 0, 1, 2, 17 and 18.<br /> <br /> There is one special case: system messages will have no address mask bits set and are intended for common keypads or monitoring multiple zones.<br /> <br /> 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.<br /> <br /> ====&lt;span style=&quot;color: #804580&quot;&gt;Alphanumeric Keypad Message&lt;/span&gt;====<br /> This section is the data that would be displayed on your keypad's screen.<br /> <br /> ==Zone Expander==<br /> 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.<br /> ===Examples===<br /> Example of zone expander at address 7, channel 1 faulting and then restoring:<br /> &lt;pre&gt;<br /> !EXP:07,01,01<br /> !EXP:07,01,00<br /> &lt;/pre&gt;<br /> <br /> ===Format===<br /> {| class=&quot;wikitable&quot; border=&quot;1&quot;<br /> |+ !EXP Format<br /> | colspan=&quot;4&quot; align=&quot;center&quot; style=&quot;background-color: #DEDEDE; font-weight: bold&quot; | &lt;span style=&quot;color: #F56464&quot;&gt;!EXP&lt;/span&gt;:&lt;span style=&quot;color: #8C8CF5&quot;&gt;07&lt;/span&gt;,&lt;span style=&quot;color: #70BA66&quot;&gt;01&lt;/span&gt;,&lt;span style=&quot;color: #804580&quot;&gt;01&lt;/span&gt;<br /> |- <br /> | colspan=&quot;4&quot; | &amp;nbsp;<br /> |- <br /> ! scope=&quot;col&quot; width=&quot;80px&quot; style=&quot;color: #F56464&quot; | Header<br /> ! scope=&quot;col&quot; width=&quot;160px&quot; style=&quot;color: #8C8CF5&quot; | Zone Expander Address<br /> ! scope=&quot;col&quot; width=&quot;140px&quot; style=&quot;color: #70BA66&quot; | Expander Channel<br /> ! scope=&quot;col&quot; width=&quot;100px&quot; style=&quot;color: #804580&quot; | Data<br /> |-<br /> | align=&quot;center&quot; | !EXP<br /> | align=&quot;center&quot; | 07<br /> | align=&quot;center&quot; | 01<br /> | align=&quot;center&quot; | 01<br /> |-<br /> |}<br /> <br /> ====&lt;span style=&quot;color: #8C8CF5&quot;&gt;Zone Expander Address&lt;/span&gt;====<br /> This is the address that the zone expander occupies.<br /> <br /> ====&lt;span style=&quot;color: #70BA66&quot;&gt;Expander Channel&lt;/span&gt;====<br /> This is the channel generating the message.<br /> <br /> ====&lt;span style=&quot;color: #804580&quot;&gt;Data&lt;/span&gt;====<br /> 00 and 01 indicate that the zone is restored and faulted, respectively.<br /> <br /> ==Relay Expander==<br /> 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.<br /> <br /> ===Examples===<br /> Examples of a relay expander at address 12, relay #1 closing and then opening:<br /> &lt;pre&gt;<br /> !REL:12,01,01<br /> !REL:12,01,00<br /> &lt;/pre&gt;<br /> <br /> ===Format===<br /> {| class=&quot;wikitable&quot; border=&quot;1&quot;<br /> |+ !REL Format<br /> | colspan=&quot;4&quot; align=&quot;center&quot; style=&quot;background-color: #DEDEDE; font-weight: bold&quot; | &lt;span style=&quot;color: #F56464&quot;&gt;!REL&lt;/span&gt;:&lt;span style=&quot;color: #8C8CF5&quot;&gt;12&lt;/span&gt;,&lt;span style=&quot;color: #70BA66&quot;&gt;01&lt;/span&gt;,&lt;span style=&quot;color: #804580&quot;&gt;01&lt;/span&gt;<br /> |- <br /> | colspan=&quot;4&quot; | &amp;nbsp;<br /> |- <br /> ! scope=&quot;col&quot; width=&quot;80px&quot; style=&quot;color: #F56464&quot; | Header<br /> ! scope=&quot;col&quot; width=&quot;160px&quot; style=&quot;color: #8C8CF5&quot; | Relay Expander Address<br /> ! scope=&quot;col&quot; width=&quot;140px&quot; style=&quot;color: #70BA66&quot; | Expander Channel<br /> ! scope=&quot;col&quot; width=&quot;100px&quot; style=&quot;color: #804580&quot; | Data<br /> |-<br /> | align=&quot;center&quot; | !REL<br /> | align=&quot;center&quot; | 12<br /> | align=&quot;center&quot; | 01<br /> | align=&quot;center&quot; | 01<br /> |-<br /> |}<br /> <br /> ====&lt;span style=&quot;color: #8C8CF5&quot;&gt;Relay Expander Address&lt;/span&gt;====<br /> This is the address that the relay expander occupies.<br /> <br /> ====&lt;span style=&quot;color: #70BA66&quot;&gt;Expander Channel&lt;/span&gt;====<br /> This is the channel generating the message.<br /> <br /> ====&lt;span style=&quot;color: #804580&quot;&gt;Data&lt;/span&gt;====<br /> 00 and 01 indicate that the relay is opened and closed, respectively.<br /> <br /> ==RFX==<br /> 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.<br /> <br /> 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. <br /> <br /> ===Examples===<br /> Example of a 5800Micra sensor faulting and restoring:<br /> &lt;pre&gt;<br /> !RFX:0180036,80<br /> !RFX:0180036,00<br /> &lt;/pre&gt;<br /> <br /> <br /> Example of a 5804 keyfob pressing the loop #2 button and having a low battery:<br /> &lt;pre&gt;<br /> !RFX:0307854,22<br /> &lt;/pre&gt;<br /> <br /> ===Format===<br /> {| class=&quot;wikitable&quot; border=&quot;1&quot;<br /> |+ !RFX Format<br /> | colspan=&quot;4&quot; align=&quot;center&quot; style=&quot;background-color: #DEDEDE; font-weight: bold&quot; | &lt;span style=&quot;color: #F56464&quot;&gt;!RFX&lt;/span&gt;:&lt;span style=&quot;color: #8C8CF5&quot;&gt;0180036&lt;/span&gt;,&lt;span style=&quot;color: #70BA66&quot;&gt;80&lt;/span&gt;<br /> |- <br /> | colspan=&quot;4&quot; | &amp;nbsp;<br /> |- <br /> ! scope=&quot;col&quot; width=&quot;80px&quot; style=&quot;color: #F56464&quot; | Header<br /> ! scope=&quot;col&quot; width=&quot;100px&quot; style=&quot;color: #8C8CF5&quot; | Serial Number<br /> ! scope=&quot;col&quot; width=&quot;100px&quot; style=&quot;color: #70BA66&quot; | Data<br /> |-<br /> | align=&quot;center&quot; | !RFX<br /> | align=&quot;center&quot; | 0180036<br /> | align=&quot;center&quot; | 80<br /> |-<br /> |}<br /> <br /> ====&lt;span style=&quot;color: #8C8CF5&quot;&gt;Serial Number&lt;/span&gt;====<br /> This is the 7-digit serial number of the device the message originated from.<br /> <br /> ====&lt;span style=&quot;color: #70BA66&quot;&gt;Data&lt;/span&gt;====<br /> 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.<br /> <br /> {| class=&quot;wikitable&quot; border=&quot;1&quot;<br /> |+ RFX Data Format<br /> |-<br /> ! scope=&quot;col&quot; | Bit<br /> ! scope=&quot;col&quot; | Description<br /> |-<br /> | align=&quot;center&quot; | 1<br /> | Unknown - Seems that the loop indicators should be ignored if set.<br /> |-<br /> | align=&quot;center&quot; | 2<br /> | Low battery indication<br /> |-<br /> | align=&quot;center&quot; | 3<br /> | Supervision required indication<br /> |-<br /> | align=&quot;center&quot; | 4<br /> | Unknown<br /> |-<br /> | align=&quot;center&quot; | 5<br /> | Loop #3 indication<br /> |-<br /> | align=&quot;center&quot; | 6<br /> | Loop #2 indication<br /> |-<br /> | align=&quot;center&quot; | 7<br /> | Loop #4 indication<br /> |-<br /> | align=&quot;center&quot; | 8<br /> | Loop #1 indication<br /> |}<br /> <br /> ==LRR==<br /> 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. The format of the data encapsulates the [[:File:SIA-ContactIDCodes_Protocol.pdf|SIA DC-05-1999.09]] standard for Contact ID reporting.<br /> <br /> ===Examples===<br /> * ARM STAY USER 002 partition 1<br /> ** !LRR:002,1,CID_3441,ff<br /> <br /> * DAY/NIGHT ALARM ZONE 9 partition 1<br /> ** !LRR:009,1,CID_1135,ff <br /> <br /> * ALARM CANCEL USER 002 partition 1<br /> ** !LRR:002,1,CID_1406,ff <br /> <br /> * ARM STAY OPENING user 002 partition 1<br /> ** !LRR:002,1,CID_1441,ff<br /> <br /> ===Format===<br /> {| class=&quot;wikitable&quot; border=&quot;1&quot;<br /> |+ !LRR Format<br /> | colspan=&quot;4&quot; align=&quot;center&quot; style=&quot;background-color: #DEDEDE; font-weight: bold&quot; | &lt;span style=&quot;color: #F56464&quot;&gt;!LRR&lt;/span&gt;:&lt;span style=&quot;color: #8C8CF5&quot;&gt;012&lt;/span&gt;,&lt;span style=&quot;color: #70BA66&quot;&gt;1&lt;/span&gt;,&lt;span style=&quot;color: #804580&quot;&gt;CID_1441&lt;/span&gt;,&lt;span style=&quot;color: #D7DF01&quot;&gt;ff&lt;/span&gt;<br /> |- <br /> | colspan=&quot;4&quot; | &amp;nbsp;<br /> |- <br /> ! scope=&quot;col&quot; width=&quot;80px&quot; style=&quot;color: #F56464&quot; | Header<br /> ! scope=&quot;col&quot; width=&quot;100px&quot; style=&quot;color: #8C8CF5&quot; | Event Data<br /> ! scope=&quot;col&quot; width=&quot;80px&quot; style=&quot;color: #70BA66&quot; | Partition<br /> ! scope=&quot;col&quot; width=&quot;100px&quot; style=&quot;color: #804580&quot; | CID MESSAGE<br /> ! scope=&quot;col&quot; width=&quot;100px&quot; style=&quot;color: #D7DF01&quot; | Report CODE<br /> |-<br /> | align=&quot;center&quot; | !LRR<br /> | align=&quot;center&quot; | 012<br /> | align=&quot;center&quot; | 1<br /> | align=&quot;center&quot; | CID_1441<br /> | align=&quot;center&quot; | ff<br /> |-<br /> |}<br /> <br /> ====&lt;span style=&quot;color: #8C8CF5&quot;&gt;Event Data&lt;/span&gt;====<br /> This is either the user number of the person performing the action or the zone that was bypassed.<br /> <br /> ====&lt;span style=&quot;color: #70BA66&quot;&gt;Partition&lt;/span&gt;====<br /> The panel partition the event applies to. Partition 0 indicates that it's destined for all partitions.<br /> <br /> ====&lt;span style=&quot;color: #804580&quot;&gt;CID Message&lt;/span&gt;====<br /> This is CID message for the event. See below for a description and what (if any) programming fields are required for activation. It is prefixed with &quot;CID_&quot; and then 4 digits that are described in section 5.1.2.2 of the [[:File:SIA-ContactIDCodes_Protocol.pdf|SIA DC-05-1999.09]] standard.<br /> <br /> {| class=&quot;wikitable&quot; border=&quot;1&quot;<br /> |+ Report Code Format<br /> | colspan=&quot;3&quot; align=&quot;center&quot; style=&quot;background-color: #DEDEDE; font-weight: bold&quot; | &lt;span style=&quot;color: #F56464&quot;&gt;CID_&lt;/span&gt;&lt;span style=&quot;color: #8C8CF5&quot;&gt;Q&lt;/span&gt;&lt;span style=&quot;color: #70BA66&quot;&gt;XYZ&lt;/span&gt;<br /> |- <br /> | colspan=&quot;3&quot; | &amp;nbsp;<br /> |- <br /> ! scope=&quot;col&quot; width=&quot;80px&quot; style=&quot;color: #F56464&quot; | Header<br /> ! scope=&quot;col&quot; width=&quot;100px&quot; style=&quot;color: #8C8CF5&quot; | Event qualifier<br /> ! scope=&quot;col&quot; width=&quot;80px&quot; style=&quot;color: #70BA66&quot; | Event code<br /> |-<br /> | align=&quot;center&quot; | CID_<br /> | align=&quot;center&quot; | 1<br /> | align=&quot;center&quot; | 441<br /> |-<br /> |}<br /> <br /> ====&lt;span style=&quot;color: #F56464&quot;&gt;Header&lt;/span&gt;====<br /> Static string &quot;CID_&quot;<br /> ====&lt;span style=&quot;color: #8C8CF5&quot;&gt;Event qualifier&lt;/span&gt;====<br /> 1 = New Event or Opening <br /> 3 = New Restore or Closing <br /> 6 = Previously reported condition still present (Status report)<br /> ====&lt;span style=&quot;color: #70BA66&quot;&gt;Event code&lt;/span&gt;====<br /> (3 Hex digits 0-9,B-F)<br /> Event codes are 3 hex digits and are broken down in classes by the first digit.<br /> 100 Alarms<br /> 200 Supervisory<br /> 300 Troubles<br /> 400 Open/Close REMOTE ACCESS<br /> 500 Bypass/Disables<br /> 600 TEST/MISC<br /> For more detail on specific report codes see the list see '''Appendix C''' in the [[:File:SIA-ContactIDCodes_Protocol.pdf|SIA DC-05-1999.09]] standard.<br /> <br /> ==AUI==<br /> AUI messages are generated for &quot;Advanced User Interface&quot; keypads. These include a lot of extra data than what's destined for regular keypads.<br /> <br /> ===Format===<br /> {| class=&quot;wikitable&quot; border=&quot;1&quot;<br /> |+ !AUI Format<br /> | colspan=&quot;4&quot; align=&quot;center&quot; style=&quot;background-color: #DEDEDE; font-weight: bold&quot; | &lt;span style=&quot;color: #F56464&quot;&gt;!AUI&lt;/span&gt;:&lt;span style=&quot;color: #8C8CF5&quot;&gt;126600000000656c02456cf5ec01017f0002&lt;/span&gt;<br /> |- <br /> | colspan=&quot;4&quot; | &amp;nbsp;<br /> |- <br /> ! scope=&quot;col&quot; width=&quot;80px&quot; style=&quot;color: #F56464&quot; | Header<br /> ! scope=&quot;col&quot; width=&quot;100px&quot; style=&quot;color: #8C8CF5&quot; | AUI Data<br /> |-<br /> | align=&quot;center&quot; | !AUI<br /> | align=&quot;center&quot; | 126600000000656c02456cf5ec01017f0002<br /> |-<br /> |}<br /> <br /> ====&lt;span style=&quot;color: #8C8CF5&quot;&gt;AUI Data&lt;/span&gt;====<br /> 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.<br /> <br /> ==Keypress Events==<br /> Keypress events are generated when keys are pressed on a keypad and can be enabled inside [[#CONFIGBITS|CONFIGBITS]].<br /> <br /> ===Format===<br /> {| class=&quot;wikitable&quot; border=&quot;1&quot;<br /> |+ !KPE Format<br /> | colspan=&quot;4&quot; align=&quot;center&quot; style=&quot;background-color: #DEDEDE; font-weight: bold&quot; | &lt;span style=&quot;color: #F56464&quot;&gt;!KPE&lt;/span&gt;:&lt;span style=&quot;color: #8C8CF5&quot;&gt;18&lt;/span&gt;<br /> |- <br /> | colspan=&quot;4&quot; | &amp;nbsp;<br /> |- <br /> ! scope=&quot;col&quot; width=&quot;80px&quot; style=&quot;color: #F56464&quot; | Header<br /> ! scope=&quot;col&quot; width=&quot;100px&quot; style=&quot;color: #8C8CF5&quot; | Keypad Address<br /> |-<br /> | align=&quot;center&quot; | !KPE<br /> | align=&quot;center&quot; | 18<br /> |-<br /> |}<br /> <br /> ==Error message report==<br /> 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. <br /> <br /> ===Format===<br /> {| class=&quot;wikitable&quot; border=&quot;1&quot;<br /> |+ !ERR Format<br /> | colspan=&quot;4&quot; align=&quot;center&quot; style=&quot;background-color: #DEDEDE; font-weight: bold&quot; | &lt;span style=&quot;color: #F56464&quot;&gt;!ERR&lt;/span&gt;:&lt;span style=&quot;color: #8C8CF5&quot;&gt;4,4,4&lt;/span&gt;<br /> |- <br /> | colspan=&quot;4&quot; | &amp;nbsp;<br /> |- <br /> ! scope=&quot;col&quot; width=&quot;80px&quot; style=&quot;color: #F56464&quot; | Header<br /> ! scope=&quot;col&quot; width=&quot;100px&quot; style=&quot;color: #8C8CF5&quot; | Error list<br /> |-<br /> | align=&quot;center&quot; | !ERR<br /> | align=&quot;center&quot; | 4,4,4<br /> |-<br /> |}<br /> <br /> ===Error Codes===<br /> {| class=&quot;wikitable&quot; border=&quot;1&quot;<br /> |+ Error Codes<br /> |- <br /> | colspan=&quot;4&quot; | &amp;nbsp;<br /> |- <br /> ! scope=&quot;col&quot; width=&quot;80px&quot; | Error number<br /> ! scope=&quot;col&quot; width=&quot;100px&quot; | Description<br /> |-<br /> | align=&quot;center&quot; | 0<br /> | align=&quot;center&quot; | No issues to report<br /> |-<br /> | align=&quot;center&quot; | 4<br /> | align=&quot;center&quot; | Keypress send failure<br /> |-<br /> |}<br /> <br /> <br /> ==CRC==<br /> 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. Enable via [[#CONFIGBITS|CONFIGBITS]]<br /> <br /> ===Format===<br /> {| class=&quot;wikitable&quot; border=&quot;1&quot;<br /> |+ !CRC Format<br /> | colspan=&quot;4&quot; align=&quot;center&quot; style=&quot;background-color: #DEDEDE; font-weight: bold&quot; | &lt;span style=&quot;color: #F56464&quot;&gt;!CRC&lt;/span&gt;:&lt;span style=&quot;color: #8C8CF5&quot;&gt;!LRR:000,1,CID_1121,ff&lt;/span&gt;,&lt;span style=&quot;color: #70BA66&quot;&gt;282d&lt;/span&gt;<br /> |- <br /> | colspan=&quot;4&quot; | &amp;nbsp;<br /> |- <br /> ! scope=&quot;col&quot; width=&quot;80px&quot; style=&quot;color: #F56464&quot; | Header<br /> ! scope=&quot;col&quot; width=&quot;100px&quot; style=&quot;color: #8C8CF5&quot; | Event Data<br /> ! scope=&quot;col&quot; width=&quot;80px&quot; style=&quot;color: #70BA66&quot; | CRC<br /> |-<br /> | align=&quot;center&quot; | !CRC<br /> | align=&quot;center&quot; | !LRR:000,1,CID_1121,ff<br /> | align=&quot;center&quot; | 282d<br /> |-<br /> |}<br /> <br /> ==Version Message==<br /> This message indicates the serial number of the unit, version, and the firmware capabilities.<br /> <br /> ===Format===<br /> {| class=&quot;wikitable&quot; border=&quot;1&quot;<br /> |+ !VER Format<br /> | colspan=&quot;4&quot; align=&quot;center&quot; style=&quot;background-color: #DEDEDE; font-weight: bold&quot; | &lt;span style=&quot;color: #F56464&quot;&gt;!VER&lt;/span&gt;:&lt;span style=&quot;color: #8C8CF5&quot;&gt;ffffffff&lt;/span&gt;,&lt;span style=&quot;color: #70BA66&quot;&gt;V2.2a.8.2&lt;/span&gt;,&lt;span style=&quot;color: #804580&quot;&gt;TX;RX;SM;VZ;RF;ZX;RE;AU;3X;CG;DD;MF;LR;KE;MK;CB;DS;ER&lt;/span&gt;<br /> |- <br /> | colspan=&quot;4&quot; | &amp;nbsp;<br /> |- <br /> ! scope=&quot;col&quot; width=&quot;80px&quot; style=&quot;color: #F56464&quot; | Header<br /> ! scope=&quot;col&quot; width=&quot;100px&quot; style=&quot;color: #8C8CF5&quot; | Serial number<br /> ! scope=&quot;col&quot; width=&quot;100px&quot; style=&quot;color: #70BA66&quot; | Firmware version<br /> ! scope=&quot;col&quot; width=&quot;100px&quot; style=&quot;color: #804580&quot; | Firmware capabilities<br /> |-<br /> | align=&quot;center&quot; | !VER<br /> | align=&quot;center&quot; | ffffffff<br /> | align=&quot;center&quot; | V2.2a.8.2<br /> | align=&quot;center&quot; | TX;RX;SM;VZ;RF;ZX;RE;AU;3X;CG;DD;MF;LR;KE;MK;CB;DS;ER<br /> |-<br /> |}<br /> <br /> ====&lt;span style=&quot;color: #8C8CF5&quot;&gt;Serial Number&lt;/span&gt;====<br /> This is the serial number of the device. If unset this defaults to ffffffff.<br /> <br /> ====&lt;span style=&quot;color: #70BA66&quot;&gt;Firmware Version&lt;/span&gt;====<br /> This is the revision of the firmware that is currently loaded on the device.<br /> <br /> ====&lt;span style=&quot;color: #804580&quot;&gt;Firmware Capabilities&lt;/span&gt;====<br /> This field indicates which capabilities are built in to the firmware. See the below table for reference.<br /> <br /> {| class=&quot;wikitable&quot; border=&quot;1&quot;<br /> |+ !VER Format<br /> | colspan=&quot;4&quot; align=&quot;center&quot; style=&quot;background-color: #DEDEDE; font-weight: bold&quot; | Firmware Capabilities<br /> |- <br /> | colspan=&quot;4&quot; | &amp;nbsp;<br /> |- <br /> ! scope=&quot;col&quot; width=&quot;80px&quot; | Flag<br /> ! scope=&quot;col&quot; width=&quot;100px&quot; | Description<br /> |-<br /> | align=&quot;center&quot; | TX<br /> | align=&quot;center&quot; | Ability to transmit to the panel<br /> |-<br /> |-<br /> | align=&quot;center&quot; | RX<br /> | align=&quot;center&quot; | Ability to receive from the panel<br /> |-<br /> | align=&quot;center&quot; | SM<br /> | align=&quot;center&quot; | Supports sending multiple keypresses<br /> |-<br /> | align=&quot;center&quot; | VZ<br /> | align=&quot;center&quot; | Virtual zone expanders<br /> |-<br /> | align=&quot;center&quot; | RF<br /> | align=&quot;center&quot; | Supports receiving of RF messages from the 5800 series wireless devices (!RFX)<br /> |-<br /> | align=&quot;center&quot; | ZX<br /> | align=&quot;center&quot; | Supports receiving of messages from zone expanders (!EXP)<br /> |-<br /> | align=&quot;center&quot; | RE<br /> | align=&quot;center&quot; | Supports receiving of messages from relay (!REL)<br /> |-<br /> | align=&quot;center&quot; | AU<br /> | align=&quot;center&quot; | AUI support (!AUI)<br /> |-<br /> | align=&quot;center&quot; | 3X<br /> | align=&quot;center&quot; | Special Keys (S1-S4) must be sent 3 times to trigger<br /> |-<br /> | align=&quot;center&quot; | CG<br /> | align=&quot;center&quot; | Serialized configuration string<br /> |-<br /> | align=&quot;center&quot; | DD<br /> | align=&quot;center&quot; | Message deduplication<br /> |-<br /> | align=&quot;center&quot; | MF<br /> | align=&quot;center&quot; | Address mask filter<br /> |-<br /> | align=&quot;center&quot; | LR<br /> | align=&quot;center&quot; | Long range radio messages (!LRR) deprecated see L2<br /> |-<br /> | align=&quot;center&quot; | L2<br /> | align=&quot;center&quot; | Long range radio messages (!LRR) with CID reporting format<br /> |-<br /> | align=&quot;center&quot; | KE<br /> | align=&quot;center&quot; | Keypad event messages (!KPM)<br /> |-<br /> | align=&quot;center&quot; | MK<br /> | align=&quot;center&quot; | Multiple keypad emulation (See 'K' command for more information)<br /> |-<br /> | align=&quot;center&quot; | CB<br /> | align=&quot;center&quot; | Config bits<br /> |-<br /> | align=&quot;center&quot; | DS<br /> | align=&quot;center&quot; | DSC support<br /> |-<br /> | align=&quot;center&quot; | ER<br /> | align=&quot;center&quot; | Error tracking<br /> |-<br /> | align=&quot;center&quot; | CR<br /> | align=&quot;center&quot; | CRC Wrapper around EXP,LRR and other event type messages<br /> |-<br /> |}<br /> <br /> =Device Feedback LED=<br /> * Boot flash mode<br /> ** During boot the AD2* will rapid flash during the boot loader.<br /> * Operating mode<br /> ** The normal operating mode is a steady of approx 2.5 flashes per second.<br /> ** Sending to panel mode 3 flashes.<br /> * Error mode<br /> ** 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.</div> 204.10.16.14 http://www.alarmdecoder.com/wiki/index.php/Protocol Protocol 2020-10-28T18:21:21Z <p>204.10.16.14: /* CONFIGBITS */</p> <hr /> <div>[[Category:FAQ]]<br /> [[Category:Documentation]]<br /> [[Category:Specifications]]<br /> [[Category:Features]]<br /> <br /> =Commands=<br /> {| class=&quot;wikitable&quot; border=&quot;1&quot;<br /> ! scope=&quot;col&quot; | Command<br /> ! scope=&quot;col&quot; | Description<br /> |-<br /> | align=&quot;center&quot; | =<br /> | align=&quot;center&quot; | [[#Reboot|Reboot]] the device.<br /> |-<br /> | align=&quot;center&quot; | !<br /> | align=&quot;center&quot; | [[#Device Configuration|Configure]] the device via prompts.<br /> |-<br /> | align=&quot;center&quot; | C<br /> | align=&quot;center&quot; | Sets or retrieves [[#Device Configuration|configuration parameters]].<br /> |-<br /> | align=&quot;center&quot; | L<br /> | align=&quot;center&quot; | [[#Zone Emulation|Emulate]] virtual zone opens and closes.<br /> |-<br /> | align=&quot;center&quot; | E<br /> | align=&quot;center&quot; | Dump error report and clear error history. [[#Error_message_report|Error report]]<br /> |-<br /> | align=&quot;center&quot; | V<br /> | align=&quot;center&quot; | Dump the version, serial number and flags used in the firmware.<br /> |-<br /> | align=&quot;center&quot; | K<br /> | align=&quot;center&quot; | Send message from specific partition or keypad address. [[#Addressed Message|Addressed Message]]<br /> |-<br /> | align=&quot;center&quot; | R<br /> | align=&quot;center&quot; | &lt;b&gt;Host Ack&lt;/b&gt;nowledge the [[#CRC|CRC]] message was valid.<br /> |-<br /> | align=&quot;center&quot; | \x01\x01\x01<br /> | align=&quot;center&quot; | Send [[#Special Keys|Special Key]] #1<br /> |-<br /> | align=&quot;center&quot; | \x02\x02\x02<br /> | align=&quot;center&quot; | Send [[#Special Keys|Special Key]] #2<br /> |-<br /> | align=&quot;center&quot; | \x03\x03\x03<br /> | align=&quot;center&quot; | Send [[#Special Keys|Special Key]] #3<br /> |-<br /> | align=&quot;center&quot; | \x04\x04\x04<br /> | align=&quot;center&quot; | Send [[#Special Keys|Special Key]] #4<br /> |-<br /> | align=&quot;center&quot; | \x05\x05\x05<br /> | align=&quot;center&quot; | Send [[#Special Keys|Special Key]] #5<br /> |-<br /> | align=&quot;center&quot; | \x06\x06\x06<br /> | align=&quot;center&quot; | Send [[#Special Keys|Special Key]] #6<br /> |-<br /> | align=&quot;center&quot; | \x07\x07\x07<br /> | align=&quot;center&quot; | Send [[#Special Keys|Special Key]] #7<br /> |-<br /> | align=&quot;center&quot; | \x08\x08\x08<br /> | align=&quot;center&quot; | Send [[#Special Keys|Special Key]] #8<br /> |-<br /> | align=&quot;center&quot; | a<br /> | align=&quot;center&quot; | DSC ONLY(deprecated use Special Keys): Arm Away<br /> |-<br /> | align=&quot;center&quot; | s<br /> | align=&quot;center&quot; | DSC ONLY(deprecated use Special Keys): Arm Stay<br /> |-<br /> | align=&quot;center&quot; | c<br /> | align=&quot;center&quot; | DSC ONLY(deprecated use Special Keys): Toggle Chime<br /> |-<br /> | align=&quot;center&quot; | 0123456789*#&lt;&gt;<br /> | align=&quot;center&quot; | Send key to panel<br /> |}<br /> <br /> ==Arming==<br /> The standard keypad keys when received by the AD2 will be treated as keypad press commands and sent to the alarm panel from the current address. If using the [[#Addressed Message|K command]] the keys will continue to be sent from the specified address until the AD2 receives a \r or \n at that point the AD2 will revert back to the configured address.<br /> <br /> ==Reboot==<br /> Rebooting the device is as simple as sending &lt;b&gt;=&lt;/b&gt; to it.<br /> <br /> During the boot process you can trigger a firmware upload by sending a second &lt;b&gt;=&lt;/b&gt; to the device after the &lt;i&gt;!boot&lt;/i&gt; message is received. At this point you'll receive a &lt;i&gt;!load&lt;/i&gt; and can begin uploading.<br /> <br /> ==Zone Emulation==<br /> 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.<br /> <br /> The &lt;b&gt;L&lt;/b&gt; 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.<br /> <br /> Example - open zone 12:<br /> * &lt;b&gt;L121\r&lt;/b&gt;<br /> <br /> Example - close zone 12:<br /> * &lt;b&gt;L120\r&lt;/b&gt;<br /> <br /> ==Addressed Message==<br /> * It is possible to send a message from a specific keypad on Ademco/Vista or to a specific partition on DSC.<br /> The &lt;b&gt;K&lt;/b&gt; 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 or a \r or \n character is received.<br /> <br /> Example - Send keypad string 1234 to DSC partition 01:<br /> * &lt;b&gt;K011234\r&lt;/b&gt;<br /> <br /> Example - Send keypad string 12343 from keypad address 19:<br /> * &lt;b&gt;K1912343\r&lt;/b&gt;<br /> <br /> ==Special Keys==<br /> 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.<br /> <br /> {| class=&quot;wikitable&quot; border=&quot;1&quot;<br /> |+ Special Key Codes<br /> ! scope=&quot;col&quot; | Code<br /> ! scope=&quot;col&quot; | Description <br /> ! scope=&quot;col&quot; | Ademco<br /> ! scope=&quot;col&quot; | DSC<br /> |-<br /> | \x01\x01\x01<br /> | Special Key #1<br /> | Fire/Prog.<br /> | Fire<br /> |-<br /> | \x02\x02\x02<br /> | Special Key #2<br /> | Police/Prog.<br /> | Police<br /> |-<br /> | \x03\x03\x03<br /> | Special Key #3<br /> | Medical/AUX/Prog.<br /> | Medical/AUX<br /> |-<br /> | \x04\x04\x04<br /> | Special Key #4<br /> | Programmable<br /> | Stay<br /> |-<br /> | \x05\x05\x05<br /> | Special Key #5<br /> | N/A<br /> | Away<br /> |-<br /> | \x06\x06\x06<br /> | Special Key #6<br /> | N/A<br /> | Chime<br /> |-<br /> | \x07\x07\x07<br /> | Special Key #7<br /> | N/A<br /> | Reset<br /> |-<br /> | \x08\x08\x08<br /> | Special Key #8<br /> | N/A<br /> | Exit<br /> |}<br /> <br /> ----<br /> <br /> =Device Configuration=<br /> The AlarmDecoder configuration can be viewed or modified in one of two ways: [[#Prompted|prompted]] or [[#Programatic|programmatically]].<br /> <br /> ==Prompted==<br /> If you send &lt;b&gt;!&lt;/b&gt; 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.<br /> <br /> &lt;b&gt;You may hit enter to keep the current value or provide a new one.&lt;/b&gt;<br /> <br /> Example:<br /> &lt;pre&gt;<br /> !&gt;Ademco/DSC Mode A/D (A) :&gt;<br /> !&gt;Keypad Address (18) :&gt;<br /> !WARNING. Do not enable a module if the physical module exists on the system.<br /> !Zone Expanders Y/N Max allowed: 02<br /> !&gt;expander module #01 ZN 09-16 (N) :&gt;<br /> !&gt;expander module #02 ZN 17-24 (N) :&gt;<br /> !&gt;expander module #03 ZN 25-32 (N) :&gt;<br /> !&gt;expander module #04 ZN 33-40 (N) :&gt;<br /> !&gt;expander module #05 ZN 41-48 (Y) :&gt;<br /> !Relay Modules Y/N Max allowed: 04<br /> !&gt;relay module #01 (Y) :&gt;<br /> !&gt;relay module #02 (N) :&gt;<br /> !&gt;relay module #03 (N) :&gt;<br /> !&gt;relay module #04 (N) :&gt;<br /> !&gt;Emulate Long Range Radio Y/N: (Y) :&gt;<br /> !&gt;Address Filter Mask (ffffffff) :&gt;<br /> !&gt;Deduplicate (N) :&gt;<br /> !&gt;Config Bits (ff04) :&gt;<br /> &lt;/pre&gt;<br /> <br /> ==Programmatic==<br /> You may retrieve all of the current device settings by sending &lt;b&gt;C&lt;/b&gt; to the panel followed by a carriage return (\r).<br /> <br /> Retrieving settings:<br /> * Send: &lt;b&gt;C\r&lt;/b&gt;<br /> * Response: &lt;b&gt;!CONFIG&gt;ADDRESS=18&amp;CONFIGBITS=ff00&amp;LRR=N&amp;EXP=NNNNN&amp;REL=NNNN&amp;MASK=ffffffff&amp;DEDUPLICATE=N&lt;/b&gt;<br /> <br /> It can also be used to set values:<br /> * Send: &lt;b&gt;CADDRESS=20\r&lt;/b&gt;<br /> * Response: &lt;b&gt;!&gt;ADDRESS=20&lt;/b&gt;<br /> <br /> The same command may be used to set multiple values:<br /> * Send: &lt;b&gt;CADDRESS=20&amp;DEDUPLICATE=Y\r&lt;/b&gt;<br /> * Response: &lt;b&gt;!&gt;ADDRESS=20&amp;DEDUPLICATE=Y&lt;/b&gt;<br /> <br /> ===Configuration Parameters===<br /> {| class=&quot;wikitable&quot; border=&quot;1&quot;<br /> ! scope=&quot;col&quot; | Name<br /> ! scope=&quot;col&quot; | Default Value<br /> ! scope=&quot;col&quot; | Valid Values (Regex)<br /> ! scope=&quot;col&quot; | Description<br /> |-<br /> | align=&quot;left&quot; | ADDRESS<br /> | align=&quot;left&quot; | 18<br /> | align=&quot;left&quot; | [0-9]{2}<br /> | align=&quot;left&quot; | Keypad address assigned to the AlarmDecoder.<br /> |-<br /> | align=&quot;left&quot; | CONFIGBITS<br /> | align=&quot;left&quot; | FF00<br /> | align=&quot;left&quot; | [0-9a-f]{4}<br /> | align=&quot;left&quot; | Special settings for the device. See [[#CONFIGBITS|CONFIGBITS]] for more information.<br /> |-<br /> | align=&quot;left&quot; | MASK<br /> | align=&quot;left&quot; | FFFFFFFF<br /> | align=&quot;left&quot; | [0-9a-f]{8}<br /> | align=&quot;left&quot; | Address mask used to filter for keypad alphanumeric messages.<br /> |-<br /> | align=&quot;left&quot; | EXP<br /> | align=&quot;left&quot; | NNNNN<br /> | align=&quot;left&quot; | [YN]{5}<br /> | align=&quot;left&quot; | Emulation of zone expanders 1-5<br /> |-<br /> | align=&quot;left&quot; | REL<br /> | align=&quot;left&quot; | NNNN<br /> | align=&quot;left&quot; | [YN]{4}<br /> | align=&quot;left&quot; | Emulation of relay expanders 1-4<br /> |-<br /> | align=&quot;left&quot; | LRR<br /> | align=&quot;left&quot; | N<br /> | align=&quot;left&quot; | [YN]<br /> | align=&quot;left&quot; | Emulation of Long Range Radio expander<br /> |-<br /> | align=&quot;left&quot; | DEDUPLICATE<br /> | align=&quot;left&quot; | N<br /> | align=&quot;left&quot; | [YN]<br /> | align=&quot;left&quot; | If enabled, removes duplicate alphanumeric keypad messages.<br /> |-<br /> |}<br /> <br /> ====CONFIGBITS====<br /> CONFIGBITS is a setting that's used to enable special functionality on the AlarmDecoder. You can enable these by masking the correct bits.<br /> <br /> {| class=&quot;wikitable&quot; border=&quot;1&quot;<br /> |+ CONFIGBITS Definition<br /> ! scope=&quot;col&quot; | Mask<br /> ! scope=&quot;col&quot; | Description<br /> |-<br /> | align=&quot;left&quot; | 0x0001<br /> | align=&quot;left&quot; | Enable reporting of [[#AUI|AUI]] messages.<br /> |-<br /> | align=&quot;left&quot; | 0x0002<br /> | align=&quot;left&quot; | Enable reporting of [[#Keypress Events|keypress events]].<br /> |-<br /> | align=&quot;left&quot; | 0x0004<br /> | align=&quot;left&quot; | Disable prompts for &lt;b&gt;L&lt;/b&gt; and &lt;b&gt;|&lt;/b&gt; commands.<br /> |-<br /> | align=&quot;left&quot; | 0x0008<br /> | align=&quot;left&quot; | Enable the prefixing of panel messages with !KPM.<br /> |-<br /> | align=&quot;left&quot; | 0x0010<br /> | align=&quot;left&quot; | Disable DSC locking (experimental).<br /> |-<br /> | align=&quot;left&quot; | 0x0080<br /> | align=&quot;left&quot; | enable CRC Delivery confirmation for LRR,EXP,REL etc.<br /> |-<br /> | align=&quot;left&quot; | 0x0100<br /> | align=&quot;left&quot; | Enable reporting of [[#RFX|RFX]] messages.<br /> |}<br /> <br /> ----<br /> <br /> =Message Types=<br /> 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]].<br /> <br /> * All lines starting with &lt;b&gt;!&lt;/b&gt; are informational.<br /> * Lines that start with &lt;b&gt;!&gt;&lt;/b&gt; are prompts.<br /> * All other lines are panel data in the form of a [[#Keypad|Keypad message]].<br /> <br /> ==Keypad==<br /> 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 &lt;b&gt;!KPM:&lt;/b&gt;.<br /> <br /> ===Format===<br /> {| class=&quot;wikitable&quot; border=&quot;1&quot;<br /> |+ Keypad Format<br /> | colspan=&quot;4&quot; align=&quot;center&quot; style=&quot;background-color: #DEDEDE; font-weight: bold&quot; | &lt;span style=&quot;color: #F56464&quot;&gt;[00110011000000003A--]&lt;/span&gt;,&lt;span style=&quot;color: #8C8CF5&quot;&gt;010&lt;/span&gt;,&lt;span style=&quot;color: #70BA66&quot;&gt;[f70700000010808c18020000000000]&lt;/span&gt;,&lt;span style=&quot;color: #804580&quot;&gt;&quot;ARMED ***STAY** ZONE BYPASSED &quot;&lt;/span&gt;<br /> |- <br /> | colspan=&quot;4&quot; | &amp;nbsp;<br /> |- <br /> ! scope=&quot;col&quot; width=&quot;160px&quot; style=&quot;color: #F56464&quot; | Bit field<br /> ! scope=&quot;col&quot; width=&quot;100px&quot; style=&quot;color: #8C8CF5&quot; | Numeric code<br /> ! scope=&quot;col&quot; width=&quot;200px&quot; style=&quot;color: #70BA66&quot; | Raw data<br /> ! scope=&quot;col&quot; width=&quot;220px&quot; style=&quot;color: #804580&quot; | Alphanumeric Keypad Message<br /> |-<br /> | align=&quot;center&quot; | [00110011000000003A--]<br /> | align=&quot;center&quot; | 010<br /> | align=&quot;center&quot; | [f70700000010808c18020000000000]<br /> | align=&quot;center&quot; | &quot;ARMED ***STAY** ZONE BYPASSED &quot;<br /> |-<br /> |}<br /> <br /> ====&lt;span style=&quot;color: #F56464&quot;&gt;Bit field&lt;/span&gt;====<br /> 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)<br /> <br /> {| class=&quot;wikitable&quot; border=&quot;1&quot;<br /> ! scope=&quot;col&quot; | Position<br /> ! scope=&quot;col&quot; | Description<br /> |-<br /> | 1<br /> | Indicates if the panel is READY<br /> |-<br /> | 2<br /> | Indicates if the panel is ARMED AWAY<br /> |-<br /> | 3<br /> | Indicates if the panel is ARMED HOME<br /> |-<br /> | 4<br /> | Indicates if the keypad backlight is on<br /> |-<br /> | 5<br /> | Indicates if the keypad is in programming mode<br /> |-<br /> | 6<br /> | Number (1-7) indicating how many beeps are associated with the message<br /> |-<br /> | 7<br /> | Indicates that a zone has been bypassed<br /> |-<br /> | 8<br /> | Indicates if the panel is on AC power<br /> |-<br /> | 9<br /> | Indicates if the chime is enabled<br /> |-<br /> | 10 <br /> | Indicates that an alarm has occurred. This is sticky and will be cleared after a second disarm.<br /> |-<br /> | 11<br /> | Indicates that an alarm is currently sounding. This is cleared after the first disarm.<br /> |-<br /> | 12<br /> | Indicates that the battery is low<br /> |-<br /> | 13<br /> | Indicates that entry delay is off (ARMED INSTANT/MAX)<br /> |-<br /> | 14<br /> | Indicates that there is a fire<br /> |-<br /> | 15<br /> | Indicates a system issue<br /> |-<br /> | 16<br /> | Indicates that the panel is only watching the perimeter (ARMED STAY/NIGHT)<br /> |-<br /> | 17<br /> | System specific bits. 4 bits packed into a HEX Nibble [0-9,A-F]<br /> |-<br /> | 18<br /> | Ademco or DSC Mode A or D<br /> |-<br /> | 19<br /> | Unused<br /> |-<br /> | 20<br /> | Unused<br /> |-<br /> |}<br /> <br /> ====&lt;span style=&quot;color: #8C8CF5&quot;&gt;Numeric Code&lt;/span&gt;====<br /> 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 &lt;b&gt;022&lt;/b&gt;. Most of the time this is zero-padded base10, but there are rare occurrences where this may be base16, such as ECP bus failures.<br /> <br /> ====&lt;span style=&quot;color: #70BA66&quot;&gt;Raw data&lt;/span&gt;====<br /> 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.<br /> <br /> 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.<br /> <br /> 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.<br /> <br /> {| class=&quot;wikitable&quot; border=&quot;1&quot;<br /> ! scope=&quot;col&quot; | Byte<br /> ! scope=&quot;col&quot; | Addresses<br /> |-<br /> | 1<br /> | 0-7<br /> |-<br /> | 2<br /> | 8-15<br /> |-<br /> | 3<br /> | 16-23<br /> |-<br /> | 4<br /> | 24-31<br /> |}<br /> <br /> For example:<br /> * f7&lt;span style=&quot;color: #70BA66&quot;&gt;07000600&lt;/span&gt;10808c08020000 - our keypad address mask is &lt;span style=&quot;color: #70BA66&quot;&gt;07000600&lt;/span&gt;.<br /> <br /> Using the above mask example of &lt;span style=&quot;color: #70BA66&quot;&gt;07000600&lt;/span&gt; we find that this message was destined for keypads 0, 1, 2, 17 and 18.<br /> <br /> There is one special case: system messages will have no address mask bits set and are intended for common keypads or monitoring multiple zones.<br /> <br /> 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.<br /> <br /> ====&lt;span style=&quot;color: #804580&quot;&gt;Alphanumeric Keypad Message&lt;/span&gt;====<br /> This section is the data that would be displayed on your keypad's screen.<br /> <br /> ==Zone Expander==<br /> 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.<br /> ===Examples===<br /> Example of zone expander at address 7, channel 1 faulting and then restoring:<br /> &lt;pre&gt;<br /> !EXP:07,01,01<br /> !EXP:07,01,00<br /> &lt;/pre&gt;<br /> <br /> ===Format===<br /> {| class=&quot;wikitable&quot; border=&quot;1&quot;<br /> |+ !EXP Format<br /> | colspan=&quot;4&quot; align=&quot;center&quot; style=&quot;background-color: #DEDEDE; font-weight: bold&quot; | &lt;span style=&quot;color: #F56464&quot;&gt;!EXP&lt;/span&gt;:&lt;span style=&quot;color: #8C8CF5&quot;&gt;07&lt;/span&gt;,&lt;span style=&quot;color: #70BA66&quot;&gt;01&lt;/span&gt;,&lt;span style=&quot;color: #804580&quot;&gt;01&lt;/span&gt;<br /> |- <br /> | colspan=&quot;4&quot; | &amp;nbsp;<br /> |- <br /> ! scope=&quot;col&quot; width=&quot;80px&quot; style=&quot;color: #F56464&quot; | Header<br /> ! scope=&quot;col&quot; width=&quot;160px&quot; style=&quot;color: #8C8CF5&quot; | Zone Expander Address<br /> ! scope=&quot;col&quot; width=&quot;140px&quot; style=&quot;color: #70BA66&quot; | Expander Channel<br /> ! scope=&quot;col&quot; width=&quot;100px&quot; style=&quot;color: #804580&quot; | Data<br /> |-<br /> | align=&quot;center&quot; | !EXP<br /> | align=&quot;center&quot; | 07<br /> | align=&quot;center&quot; | 01<br /> | align=&quot;center&quot; | 01<br /> |-<br /> |}<br /> <br /> ====&lt;span style=&quot;color: #8C8CF5&quot;&gt;Zone Expander Address&lt;/span&gt;====<br /> This is the address that the zone expander occupies.<br /> <br /> ====&lt;span style=&quot;color: #70BA66&quot;&gt;Expander Channel&lt;/span&gt;====<br /> This is the channel generating the message.<br /> <br /> ====&lt;span style=&quot;color: #804580&quot;&gt;Data&lt;/span&gt;====<br /> 00 and 01 indicate that the zone is restored and faulted, respectively.<br /> <br /> ==Relay Expander==<br /> 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.<br /> <br /> ===Examples===<br /> Examples of a relay expander at address 12, relay #1 closing and then opening:<br /> &lt;pre&gt;<br /> !REL:12,01,01<br /> !REL:12,01,00<br /> &lt;/pre&gt;<br /> <br /> ===Format===<br /> {| class=&quot;wikitable&quot; border=&quot;1&quot;<br /> |+ !REL Format<br /> | colspan=&quot;4&quot; align=&quot;center&quot; style=&quot;background-color: #DEDEDE; font-weight: bold&quot; | &lt;span style=&quot;color: #F56464&quot;&gt;!REL&lt;/span&gt;:&lt;span style=&quot;color: #8C8CF5&quot;&gt;12&lt;/span&gt;,&lt;span style=&quot;color: #70BA66&quot;&gt;01&lt;/span&gt;,&lt;span style=&quot;color: #804580&quot;&gt;01&lt;/span&gt;<br /> |- <br /> | colspan=&quot;4&quot; | &amp;nbsp;<br /> |- <br /> ! scope=&quot;col&quot; width=&quot;80px&quot; style=&quot;color: #F56464&quot; | Header<br /> ! scope=&quot;col&quot; width=&quot;160px&quot; style=&quot;color: #8C8CF5&quot; | Relay Expander Address<br /> ! scope=&quot;col&quot; width=&quot;140px&quot; style=&quot;color: #70BA66&quot; | Expander Channel<br /> ! scope=&quot;col&quot; width=&quot;100px&quot; style=&quot;color: #804580&quot; | Data<br /> |-<br /> | align=&quot;center&quot; | !REL<br /> | align=&quot;center&quot; | 12<br /> | align=&quot;center&quot; | 01<br /> | align=&quot;center&quot; | 01<br /> |-<br /> |}<br /> <br /> ====&lt;span style=&quot;color: #8C8CF5&quot;&gt;Relay Expander Address&lt;/span&gt;====<br /> This is the address that the relay expander occupies.<br /> <br /> ====&lt;span style=&quot;color: #70BA66&quot;&gt;Expander Channel&lt;/span&gt;====<br /> This is the channel generating the message.<br /> <br /> ====&lt;span style=&quot;color: #804580&quot;&gt;Data&lt;/span&gt;====<br /> 00 and 01 indicate that the relay is opened and closed, respectively.<br /> <br /> ==RFX==<br /> 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.<br /> <br /> 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. <br /> <br /> ===Examples===<br /> Example of a 5800Micra sensor faulting and restoring:<br /> &lt;pre&gt;<br /> !RFX:0180036,80<br /> !RFX:0180036,00<br /> &lt;/pre&gt;<br /> <br /> <br /> Example of a 5804 keyfob pressing the loop #2 button and having a low battery:<br /> &lt;pre&gt;<br /> !RFX:0307854,22<br /> &lt;/pre&gt;<br /> <br /> ===Format===<br /> {| class=&quot;wikitable&quot; border=&quot;1&quot;<br /> |+ !RFX Format<br /> | colspan=&quot;4&quot; align=&quot;center&quot; style=&quot;background-color: #DEDEDE; font-weight: bold&quot; | &lt;span style=&quot;color: #F56464&quot;&gt;!RFX&lt;/span&gt;:&lt;span style=&quot;color: #8C8CF5&quot;&gt;0180036&lt;/span&gt;,&lt;span style=&quot;color: #70BA66&quot;&gt;80&lt;/span&gt;<br /> |- <br /> | colspan=&quot;4&quot; | &amp;nbsp;<br /> |- <br /> ! scope=&quot;col&quot; width=&quot;80px&quot; style=&quot;color: #F56464&quot; | Header<br /> ! scope=&quot;col&quot; width=&quot;100px&quot; style=&quot;color: #8C8CF5&quot; | Serial Number<br /> ! scope=&quot;col&quot; width=&quot;100px&quot; style=&quot;color: #70BA66&quot; | Data<br /> |-<br /> | align=&quot;center&quot; | !RFX<br /> | align=&quot;center&quot; | 0180036<br /> | align=&quot;center&quot; | 80<br /> |-<br /> |}<br /> <br /> ====&lt;span style=&quot;color: #8C8CF5&quot;&gt;Serial Number&lt;/span&gt;====<br /> This is the 7-digit serial number of the device the message originated from.<br /> <br /> ====&lt;span style=&quot;color: #70BA66&quot;&gt;Data&lt;/span&gt;====<br /> 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.<br /> <br /> {| class=&quot;wikitable&quot; border=&quot;1&quot;<br /> |+ RFX Data Format<br /> |-<br /> ! scope=&quot;col&quot; | Bit<br /> ! scope=&quot;col&quot; | Description<br /> |-<br /> | align=&quot;center&quot; | 1<br /> | Unknown - Seems that the loop indicators should be ignored if set.<br /> |-<br /> | align=&quot;center&quot; | 2<br /> | Low battery indication<br /> |-<br /> | align=&quot;center&quot; | 3<br /> | Supervision required indication<br /> |-<br /> | align=&quot;center&quot; | 4<br /> | Unknown<br /> |-<br /> | align=&quot;center&quot; | 5<br /> | Loop #3 indication<br /> |-<br /> | align=&quot;center&quot; | 6<br /> | Loop #2 indication<br /> |-<br /> | align=&quot;center&quot; | 7<br /> | Loop #4 indication<br /> |-<br /> | align=&quot;center&quot; | 8<br /> | Loop #1 indication<br /> |}<br /> <br /> ==LRR==<br /> 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. The format of the data encapsulates the [[:File:SIA-ContactIDCodes_Protocol.pdf|SIA DC-05-1999.09]] standard for Contact ID reporting.<br /> <br /> ===Examples===<br /> * ARM STAY USER 002 partition 1<br /> ** !LRR:002,1,CID_3441,ff<br /> <br /> * DAY/NIGHT ALARM ZONE 9 partition 1<br /> ** !LRR:009,1,CID_1135,ff <br /> <br /> * ALARM CANCEL USER 002 partition 1<br /> ** !LRR:002,1,CID_1406,ff <br /> <br /> * ARM STAY OPENING user 002 partition 1<br /> ** !LRR:002,1,CID_1441,ff<br /> <br /> ===Format===<br /> {| class=&quot;wikitable&quot; border=&quot;1&quot;<br /> |+ !LRR Format<br /> | colspan=&quot;4&quot; align=&quot;center&quot; style=&quot;background-color: #DEDEDE; font-weight: bold&quot; | &lt;span style=&quot;color: #F56464&quot;&gt;!LRR&lt;/span&gt;:&lt;span style=&quot;color: #8C8CF5&quot;&gt;012&lt;/span&gt;,&lt;span style=&quot;color: #70BA66&quot;&gt;1&lt;/span&gt;,&lt;span style=&quot;color: #804580&quot;&gt;CID_1441&lt;/span&gt;,&lt;span style=&quot;color: #D7DF01&quot;&gt;ff&lt;/span&gt;<br /> |- <br /> | colspan=&quot;4&quot; | &amp;nbsp;<br /> |- <br /> ! scope=&quot;col&quot; width=&quot;80px&quot; style=&quot;color: #F56464&quot; | Header<br /> ! scope=&quot;col&quot; width=&quot;100px&quot; style=&quot;color: #8C8CF5&quot; | Event Data<br /> ! scope=&quot;col&quot; width=&quot;80px&quot; style=&quot;color: #70BA66&quot; | Partition<br /> ! scope=&quot;col&quot; width=&quot;100px&quot; style=&quot;color: #804580&quot; | CID MESSAGE<br /> ! scope=&quot;col&quot; width=&quot;100px&quot; style=&quot;color: #D7DF01&quot; | Report CODE<br /> |-<br /> | align=&quot;center&quot; | !LRR<br /> | align=&quot;center&quot; | 012<br /> | align=&quot;center&quot; | 1<br /> | align=&quot;center&quot; | CID_1441<br /> | align=&quot;center&quot; | ff<br /> |-<br /> |}<br /> <br /> ====&lt;span style=&quot;color: #8C8CF5&quot;&gt;Event Data&lt;/span&gt;====<br /> This is either the user number of the person performing the action or the zone that was bypassed.<br /> <br /> ====&lt;span style=&quot;color: #70BA66&quot;&gt;Partition&lt;/span&gt;====<br /> The panel partition the event applies to. Partition 0 indicates that it's destined for all partitions.<br /> <br /> ====&lt;span style=&quot;color: #804580&quot;&gt;CID Message&lt;/span&gt;====<br /> This is CID message for the event. See below for a description and what (if any) programming fields are required for activation. It is prefixed with &quot;CID_&quot; and then 4 digits that are described in section 5.1.2.2 of the [[:File:SIA-ContactIDCodes_Protocol.pdf|SIA DC-05-1999.09]] standard.<br /> <br /> {| class=&quot;wikitable&quot; border=&quot;1&quot;<br /> |+ Report Code Format<br /> | colspan=&quot;3&quot; align=&quot;center&quot; style=&quot;background-color: #DEDEDE; font-weight: bold&quot; | &lt;span style=&quot;color: #F56464&quot;&gt;CID_&lt;/span&gt;&lt;span style=&quot;color: #8C8CF5&quot;&gt;Q&lt;/span&gt;&lt;span style=&quot;color: #70BA66&quot;&gt;XYZ&lt;/span&gt;<br /> |- <br /> | colspan=&quot;3&quot; | &amp;nbsp;<br /> |- <br /> ! scope=&quot;col&quot; width=&quot;80px&quot; style=&quot;color: #F56464&quot; | Header<br /> ! scope=&quot;col&quot; width=&quot;100px&quot; style=&quot;color: #8C8CF5&quot; | Event qualifier<br /> ! scope=&quot;col&quot; width=&quot;80px&quot; style=&quot;color: #70BA66&quot; | Event code<br /> |-<br /> | align=&quot;center&quot; | CID_<br /> | align=&quot;center&quot; | 1<br /> | align=&quot;center&quot; | 441<br /> |-<br /> |}<br /> <br /> ====&lt;span style=&quot;color: #F56464&quot;&gt;Header&lt;/span&gt;====<br /> Static string &quot;CID_&quot;<br /> ====&lt;span style=&quot;color: #8C8CF5&quot;&gt;Event qualifier&lt;/span&gt;====<br /> 1 = New Event or Opening <br /> 3 = New Restore or Closing <br /> 6 = Previously reported condition still present (Status report)<br /> ====&lt;span style=&quot;color: #70BA66&quot;&gt;Event code&lt;/span&gt;====<br /> (3 Hex digits 0-9,B-F)<br /> Event codes are 3 hex digits and are broken down in classes by the first digit.<br /> 100 Alarms<br /> 200 Supervisory<br /> 300 Troubles<br /> 400 Open/Close REMOTE ACCESS<br /> 500 Bypass/Disables<br /> 600 TEST/MISC<br /> For more detail on specific report codes see the list see '''Appendix C''' in the [[:File:SIA-ContactIDCodes_Protocol.pdf|SIA DC-05-1999.09]] standard.<br /> <br /> ==AUI==<br /> AUI messages are generated for &quot;Advanced User Interface&quot; keypads. These include a lot of extra data than what's destined for regular keypads.<br /> <br /> ===Format===<br /> {| class=&quot;wikitable&quot; border=&quot;1&quot;<br /> |+ !AUI Format<br /> | colspan=&quot;4&quot; align=&quot;center&quot; style=&quot;background-color: #DEDEDE; font-weight: bold&quot; | &lt;span style=&quot;color: #F56464&quot;&gt;!AUI&lt;/span&gt;:&lt;span style=&quot;color: #8C8CF5&quot;&gt;126600000000656c02456cf5ec01017f0002&lt;/span&gt;<br /> |- <br /> | colspan=&quot;4&quot; | &amp;nbsp;<br /> |- <br /> ! scope=&quot;col&quot; width=&quot;80px&quot; style=&quot;color: #F56464&quot; | Header<br /> ! scope=&quot;col&quot; width=&quot;100px&quot; style=&quot;color: #8C8CF5&quot; | AUI Data<br /> |-<br /> | align=&quot;center&quot; | !AUI<br /> | align=&quot;center&quot; | 126600000000656c02456cf5ec01017f0002<br /> |-<br /> |}<br /> <br /> ====&lt;span style=&quot;color: #8C8CF5&quot;&gt;AUI Data&lt;/span&gt;====<br /> 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.<br /> <br /> ==Keypress Events==<br /> Keypress events are generated when keys are pressed on a keypad and can be enabled inside [[#CONFIGBITS|CONFIGBITS]].<br /> <br /> ===Format===<br /> {| class=&quot;wikitable&quot; border=&quot;1&quot;<br /> |+ !KPE Format<br /> | colspan=&quot;4&quot; align=&quot;center&quot; style=&quot;background-color: #DEDEDE; font-weight: bold&quot; | &lt;span style=&quot;color: #F56464&quot;&gt;!KPE&lt;/span&gt;:&lt;span style=&quot;color: #8C8CF5&quot;&gt;18&lt;/span&gt;<br /> |- <br /> | colspan=&quot;4&quot; | &amp;nbsp;<br /> |- <br /> ! scope=&quot;col&quot; width=&quot;80px&quot; style=&quot;color: #F56464&quot; | Header<br /> ! scope=&quot;col&quot; width=&quot;100px&quot; style=&quot;color: #8C8CF5&quot; | Keypad Address<br /> |-<br /> | align=&quot;center&quot; | !KPE<br /> | align=&quot;center&quot; | 18<br /> |-<br /> |}<br /> <br /> ==Error message report==<br /> 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. <br /> <br /> ===Format===<br /> {| class=&quot;wikitable&quot; border=&quot;1&quot;<br /> |+ !ERR Format<br /> | colspan=&quot;4&quot; align=&quot;center&quot; style=&quot;background-color: #DEDEDE; font-weight: bold&quot; | &lt;span style=&quot;color: #F56464&quot;&gt;!ERR&lt;/span&gt;:&lt;span style=&quot;color: #8C8CF5&quot;&gt;4,4,4&lt;/span&gt;<br /> |- <br /> | colspan=&quot;4&quot; | &amp;nbsp;<br /> |- <br /> ! scope=&quot;col&quot; width=&quot;80px&quot; style=&quot;color: #F56464&quot; | Header<br /> ! scope=&quot;col&quot; width=&quot;100px&quot; style=&quot;color: #8C8CF5&quot; | Error list<br /> |-<br /> | align=&quot;center&quot; | !ERR<br /> | align=&quot;center&quot; | 4,4,4<br /> |-<br /> |}<br /> <br /> ===Error Codes===<br /> {| class=&quot;wikitable&quot; border=&quot;1&quot;<br /> |+ Error Codes<br /> |- <br /> | colspan=&quot;4&quot; | &amp;nbsp;<br /> |- <br /> ! scope=&quot;col&quot; width=&quot;80px&quot; | Error number<br /> ! scope=&quot;col&quot; width=&quot;100px&quot; | Description<br /> |-<br /> | align=&quot;center&quot; | 0<br /> | align=&quot;center&quot; | No issues to report<br /> |-<br /> | align=&quot;center&quot; | 4<br /> | align=&quot;center&quot; | Keypress send failure<br /> |-<br /> |}<br /> <br /> <br /> ==CRC==<br /> 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. Enable via [[#CONFIGBITS|CONFIGBITS]]<br /> <br /> ===Format===<br /> {| class=&quot;wikitable&quot; border=&quot;1&quot;<br /> |+ !CRC Format<br /> | colspan=&quot;4&quot; align=&quot;center&quot; style=&quot;background-color: #DEDEDE; font-weight: bold&quot; | &lt;span style=&quot;color: #F56464&quot;&gt;!CRC&lt;/span&gt;:&lt;span style=&quot;color: #8C8CF5&quot;&gt;!LRR:000,1,CID_1121,ff&lt;/span&gt;,&lt;span style=&quot;color: #70BA66&quot;&gt;282d&lt;/span&gt;<br /> |- <br /> | colspan=&quot;4&quot; | &amp;nbsp;<br /> |- <br /> ! scope=&quot;col&quot; width=&quot;80px&quot; style=&quot;color: #F56464&quot; | Header<br /> ! scope=&quot;col&quot; width=&quot;100px&quot; style=&quot;color: #8C8CF5&quot; | Event Data<br /> ! scope=&quot;col&quot; width=&quot;80px&quot; style=&quot;color: #70BA66&quot; | CRC<br /> |-<br /> | align=&quot;center&quot; | !CRC<br /> | align=&quot;center&quot; | !LRR:000,1,CID_1121,ff<br /> | align=&quot;center&quot; | 282d<br /> |-<br /> |}<br /> <br /> ==Version Message==<br /> This message indicates the serial number of the unit, version, and the firmware capabilities.<br /> <br /> ===Format===<br /> {| class=&quot;wikitable&quot; border=&quot;1&quot;<br /> |+ !VER Format<br /> | colspan=&quot;4&quot; align=&quot;center&quot; style=&quot;background-color: #DEDEDE; font-weight: bold&quot; | &lt;span style=&quot;color: #F56464&quot;&gt;!VER&lt;/span&gt;:&lt;span style=&quot;color: #8C8CF5&quot;&gt;ffffffff&lt;/span&gt;,&lt;span style=&quot;color: #70BA66&quot;&gt;V2.2a.8.2&lt;/span&gt;,&lt;span style=&quot;color: #804580&quot;&gt;TX;RX;SM;VZ;RF;ZX;RE;AU;3X;CG;DD;MF;LR;KE;MK;CB;DS;ER&lt;/span&gt;<br /> |- <br /> | colspan=&quot;4&quot; | &amp;nbsp;<br /> |- <br /> ! scope=&quot;col&quot; width=&quot;80px&quot; style=&quot;color: #F56464&quot; | Header<br /> ! scope=&quot;col&quot; width=&quot;100px&quot; style=&quot;color: #8C8CF5&quot; | Serial number<br /> ! scope=&quot;col&quot; width=&quot;100px&quot; style=&quot;color: #70BA66&quot; | Firmware version<br /> ! scope=&quot;col&quot; width=&quot;100px&quot; style=&quot;color: #804580&quot; | Firmware capabilities<br /> |-<br /> | align=&quot;center&quot; | !VER<br /> | align=&quot;center&quot; | ffffffff<br /> | align=&quot;center&quot; | V2.2a.8.2<br /> | align=&quot;center&quot; | TX;RX;SM;VZ;RF;ZX;RE;AU;3X;CG;DD;MF;LR;KE;MK;CB;DS;ER<br /> |-<br /> |}<br /> <br /> ====&lt;span style=&quot;color: #8C8CF5&quot;&gt;Serial Number&lt;/span&gt;====<br /> This is the serial number of the device. If unset this defaults to ffffffff.<br /> <br /> ====&lt;span style=&quot;color: #70BA66&quot;&gt;Firmware Version&lt;/span&gt;====<br /> This is the revision of the firmware that is currently loaded on the device.<br /> <br /> ====&lt;span style=&quot;color: #804580&quot;&gt;Firmware Capabilities&lt;/span&gt;====<br /> This field indicates which capabilities are built in to the firmware. See the below table for reference.<br /> <br /> {| class=&quot;wikitable&quot; border=&quot;1&quot;<br /> |+ !VER Format<br /> | colspan=&quot;4&quot; align=&quot;center&quot; style=&quot;background-color: #DEDEDE; font-weight: bold&quot; | Firmware Capabilities<br /> |- <br /> | colspan=&quot;4&quot; | &amp;nbsp;<br /> |- <br /> ! scope=&quot;col&quot; width=&quot;80px&quot; | Flag<br /> ! scope=&quot;col&quot; width=&quot;100px&quot; | Description<br /> |-<br /> | align=&quot;center&quot; | TX<br /> | align=&quot;center&quot; | Ability to transmit to the panel<br /> |-<br /> |-<br /> | align=&quot;center&quot; | RX<br /> | align=&quot;center&quot; | Ability to receive from the panel<br /> |-<br /> | align=&quot;center&quot; | SM<br /> | align=&quot;center&quot; | Supports sending multiple keypresses<br /> |-<br /> | align=&quot;center&quot; | VZ<br /> | align=&quot;center&quot; | Virtual zone expanders<br /> |-<br /> | align=&quot;center&quot; | RF<br /> | align=&quot;center&quot; | Supports receiving of RF messages from the 5800 series wireless devices (!RFX)<br /> |-<br /> | align=&quot;center&quot; | ZX<br /> | align=&quot;center&quot; | Supports receiving of messages from zone expanders (!EXP)<br /> |-<br /> | align=&quot;center&quot; | RE<br /> | align=&quot;center&quot; | Supports receiving of messages from relay (!REL)<br /> |-<br /> | align=&quot;center&quot; | AU<br /> | align=&quot;center&quot; | AUI support (!AUI)<br /> |-<br /> | align=&quot;center&quot; | 3X<br /> | align=&quot;center&quot; | Special Keys (S1-S4) must be sent 3 times to trigger<br /> |-<br /> | align=&quot;center&quot; | CG<br /> | align=&quot;center&quot; | Serialized configuration string<br /> |-<br /> | align=&quot;center&quot; | DD<br /> | align=&quot;center&quot; | Message deduplication<br /> |-<br /> | align=&quot;center&quot; | MF<br /> | align=&quot;center&quot; | Address mask filter<br /> |-<br /> | align=&quot;center&quot; | LR<br /> | align=&quot;center&quot; | Long range radio messages (!LRR) deprecated see L2<br /> |-<br /> | align=&quot;center&quot; | L2<br /> | align=&quot;center&quot; | Long range radio messages (!LRR) with CID reporting format<br /> |-<br /> | align=&quot;center&quot; | KE<br /> | align=&quot;center&quot; | Keypad event messages (!KPM)<br /> |-<br /> | align=&quot;center&quot; | MK<br /> | align=&quot;center&quot; | Multiple keypad emulation (See 'K' command for more information)<br /> |-<br /> | align=&quot;center&quot; | CB<br /> | align=&quot;center&quot; | Config bits<br /> |-<br /> | align=&quot;center&quot; | DS<br /> | align=&quot;center&quot; | DSC support<br /> |-<br /> | align=&quot;center&quot; | ER<br /> | align=&quot;center&quot; | Error tracking<br /> |-<br /> | align=&quot;center&quot; | CR<br /> | align=&quot;center&quot; | CRC Wrapper around EXP,LRR and other event type messages<br /> |-<br /> |}<br /> <br /> =Device Feedback LED=<br /> * Boot flash mode<br /> ** During boot the AD2* will rapid flash during the boot loader.<br /> * Operating mode<br /> ** The normal operating mode is a steady of approx 2.5 flashes per second.<br /> ** Sending to panel mode 3 flashes.<br /> * Error mode<br /> ** 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.</div> 204.10.16.14 http://www.alarmdecoder.com/wiki/index.php/Firmware Firmware 2020-08-24T22:53:22Z <p>204.10.16.14: /* Download */</p> <hr /> <div><br /> <br /> <br /> <br /> __NOTOC__<br /> [[Category:Documentation]]<br /> [[Category:Downloads]]<br /> {{PageHeading|<br /> 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. Flashing your device will not retain configuration settings.<br /> }}<br /> <br /> ==Identifying your Board Revision==<br /> Use the images below to identify what revision of AlarmDecoder you have.<br /> <br /> {| summary=&quot;AlarmDecoder Devices and Revisions&quot;<br /> |[[File:2_2_board.jpg|thumb|2.2 (AD2USB)]]<br /> |[[File:2_2_serial.jpg|thumb|2.2 (AD2SERIAL)]]<br /> |[[File:Ad2pi.png|thumb|2.2 (AD2PI)]]<br /> |[[File:2_0_board.jpg|thumb|2.0 (AD2USB)]]<br /> |}<br /> <br /> ==Checking your Firmware Version==<br /> You can retrieve the version information by connecting to your device with a terminal program (PuTTY, screen, etc.) and sending the &lt;b&gt;V&lt;/b&gt; command.<br /> <br /> A response will be returned with your current version information:<br /> !VER:ffffffff,'''V2.2a.8a8''',TX;RX;SM;VZ;RF;ZX;RE;AU;3X;CG;DD;MF;LR;KE;MK;CB;DS<br /> <br /> ==Download==<br /> {| class=&quot;wikitable&quot; border=&quot;1&quot;<br /> ! scope=&quot;col&quot; width=&quot;120px&quot; | Board Revision<br /> ! scope=&quot;col&quot; width=&quot;140px&quot; | Firmware Version<br /> ! scope=&quot;col&quot; width=&quot;60px&quot; | Revision History<br /> ! scope=&quot;col&quot; width=&quot;140px&quot; | Panel Support<br /> |-<br /> | colspan=&quot;4&quot; align=&quot;center&quot; style=&quot;background-color: #70BA66; font-weight: bold&quot; | Stable<br /> |-<br /> | align=&quot;center&quot; style=&quot;font-weight: bold&quot; | 2.2+<br /> | align=&quot;center&quot; | [http://www.alarmdecoder.com/downloads/firmware/2.2/ademcoemu_V2-2a-8-8.zip 2.2a.8.8] <br /> | align=&quot;center&quot; | [[FirmwareRevisionHistory#2.2a.8.8|link]]<br /> | DSC, Ademco Vista<br /> |-<br /> | colspan=&quot;4&quot; align=&quot;center&quot; style=&quot;background-color: #F56464; font-weight: bold&quot; | Beta<br /> |-<br /> | align=&quot;center&quot; style=&quot;font-weight: bold&quot; | 2.2+<br /> | align=&quot;center&quot; | [http://www.alarmdecoder.com/downloads/firmware/2.2/ademcoemu_V2-2a-8-9b-306.zip 2.2a.8.9b-306]<br /> | align=&quot;center&quot; | [[FirmwareRevisionHistory#2.2a.8.9b-306|link]]<br /> | DSC, Ademco Vista<br /> |-<br /> | align=&quot;center&quot; style=&quot;font-weight: bold&quot; | 2.2+<br /> | align=&quot;center&quot; | [http://www.alarmdecoder.com/downloads/firmware/2.2/ademcoemu_V2-2a-8-9-303.zip 2.2a.8.9-303]<br /> | align=&quot;center&quot; | [[FirmwareRevisionHistory#2.2a.8.9-303|link]]<br /> | DSC, Ademco Vista<br /> |-<br /> | align=&quot;center&quot; style=&quot;font-weight: bold&quot; | 2.2+<br /> | align=&quot;center&quot; | [http://www.alarmdecoder.com/downloads/firmware/2.2/ademcoemu_V2-2a-8-7-297.zip 2.2a.8.7-297]<br /> | align=&quot;center&quot; | [[FirmwareRevisionHistory#2.2a.8.7-297|link]]<br /> | DSC, Ademco Vista<br /> |-<br /> | align=&quot;center&quot; style=&quot;font-weight: bold&quot; | 2.2+<br /> | align=&quot;center&quot; | [http://www.alarmdecoder.com/downloads/firmware/2.2/ademcoemu_V2_2a_8_7a.zip 2.2a.8.7a]<br /> | align=&quot;center&quot; | [[FirmwareRevisionHistory#2.2a.8.7a|link]]<br /> | DSC, Ademco Vista<br /> |-<br /> | align=&quot;center&quot; style=&quot;font-weight: bold&quot; | 2.2+<br /> | align=&quot;center&quot; | [http://www.alarmdecoder.com/downloads/firmware/2.2/ademcoemu_V2_2a_8_5s.zip 2.2a.8.5s]<br /> | align=&quot;center&quot; | [[FirmwareRevisionHistory#2.2a.8.5s|link]]<br /> | DSC, Ademco Vista<br /> |-<br /> | align=&quot;center&quot; style=&quot;font-weight: bold&quot; | 2.2+<br /> | align=&quot;center&quot; | [http://www.alarmdecoder.com/downloads/firmware/2.2/ademcoemu_V2_2a_8_3c.zip 2.2a.8.3c]<br /> | align=&quot;center&quot; | [[FirmwareRevisionHistory#2.2a.8.3c|link]]<br /> | VPLEX BETA<br /> |-<br /> | align=&quot;center&quot; style=&quot;font-weight: bold&quot; | 2.2+<br /> | align=&quot;center&quot; | [http://www.alarmdecoder.com/downloads/firmware/2.2/ademcoemu_V2_2a_8_3b.zip 2.2a.8.3b]<br /> | align=&quot;center&quot; | [[FirmwareRevisionHistory#2.2a.8.3b|link]]<br /> | DSC, Ademco Vista<br /> |-<br /> | colspan=&quot;4&quot; align=&quot;center&quot; style=&quot;background-color: #FAFA70; font-weight: bold&quot; | Legacy<br /> |-<br /> | align=&quot;center&quot; style=&quot;font-weight: bold&quot; | 2.2+<br /> | align=&quot;center&quot; | [http://www.alarmdecoder.com/downloads/firmware/2.2/ademcoemu_V2_2a_8_6.zip 2.2a.8.6] <br /> | align=&quot;center&quot; | [[FirmwareRevisionHistory#2.2a.8.6|link]]<br /> | *DSC(limited), Ademco Vista<br /> |-<br /> | align=&quot;center&quot; style=&quot;font-weight: bold&quot; | 2.2+<br /> | align=&quot;center&quot; | [http://www.alarmdecoder.com/downloads/firmware/2.2/ademcoemu_V2_2a_6.zip 2.2a.6] <br /> | align=&quot;center&quot; | [[FirmwareRevisionHistory#2.2a.6|link]]<br /> | Ademco Vista<br /> |-<br /> | align=&quot;center&quot; | 2.0<br /> | align=&quot;center&quot; | [http://www.alarmdecoder.com/downloads/firmware/2.0/ademcoemu_V2_1f_10.zip 2.1f.10] <br /> | align=&quot;center&quot; | -<br /> | Ademco Vista<br /> |-<br /> | align=&quot;center&quot; style=&quot;font-weight: bold&quot; | 2.2+<br /> | align=&quot;center&quot; | [http://www.alarmdecoder.com/downloads/firmware/2.2/ademcoemu_V2_2a_8_2.zip 2.2a.8.2] <br /> | align=&quot;center&quot; | [[FirmwareRevisionHistory#2.2a.8.2|link]]<br /> | Ademco Vista<br /> |-<br /> | align=&quot;center&quot; style=&quot;font-weight: bold&quot; | 2.2+<br /> | align=&quot;center&quot; | [http://www.alarmdecoder.com/downloads/firmware/2.2/ademcoemu_V2_2a_3_beta.zip 2.2a.3] <br /> | align=&quot;center&quot; | -<br /> | Ademco Vista<br /> |-<br /> | align=&quot;center&quot; style=&quot;font-weight: bold&quot; | 2.2+<br /> | align=&quot;center&quot; | [http://www.alarmdecoder.com/downloads/firmware/2.2/ademcoemu_V2_2a_2.zip 2.2a.2] <br /> | align=&quot;center&quot; | -<br /> | Ademco Vista<br /> |-<br /> | align=&quot;center&quot; | 2.0<br /> | align=&quot;center&quot; | [http://www.alarmdecoder.com/downloads/firmware/2.0/ademcoemu_V2_1f_0e.zip 2.1f.0e] <br /> | align=&quot;center&quot; | -<br /> | Ademco Vista<br /> |-<br /> | align=&quot;center&quot; | 2.0<br /> | align=&quot;center&quot; | [http://www.alarmdecoder.com/downloads/firmware/2.0/ademcoemu_V2_1f_0d.zip 2.1f.0d] <br /> | align=&quot;center&quot; | -<br /> | Ademco Vista<br /> |-<br /> | align=&quot;center&quot; | 2.0<br /> | align=&quot;center&quot; | [http://www.alarmdecoder.com/downloads/firmware/2.0/ademcoemu_V1_0f_26.zip 1.0f.26] <br /> | align=&quot;center&quot; | -<br /> | Ademco Vista<br /> |}<br /> <br /> ==Instructions==<br /> ; '''Flashing new firmware will not retain device configuration settings'''<br /> ; There are a few different ways to go about flashing your device.<br /> <br /> # Make sure that you have completed the installation and can communicate with your device through a terminal program. (PuTTY, screen, etc.)<br /> # Download one of the available programs or use the built in firmware uploader in the [[AlarmDecoder_WebApp|AlarmDecoder WebApp]]<br /> #* [[AlarmDecoder_Keypad|AlarmDecoder Keypad]] - .NET/Mono and Gtk#<br /> #* [http://www.alarmdecoder.com/downloads/firmwareupload.zip Console firmware uploader] - .NET/Mono<br /> #* [http://github.com/nutechsoftware/alarmdecoder ad2-firmwareupload] - from the official Python library<br /> # Download your desired firmware from the choices above.<br /> # Flash the firmware<br /> #* [[AlarmDecoder_WebApp|AlarmDecoder WebApp]]<br /> #** &lt;tt&gt;Settings -&gt; Advanced -&gt; Firmware Upload&lt;/tt&gt;<br /> #* AlarmDecoder Keypad<br /> #*# Navigate to &lt;tt&gt;System -&gt; Firmware Upload&lt;/tt&gt;<br /> #*# Select the firmware file to upload.<br /> #*# The program will start uploading automatically.<br /> #* Console firmware uploader<br /> #*# &lt;tt&gt;firmwareupload COM6 115200 firmware.hex&lt;/tt&gt;<br /> #* ad2-firmwareupload<br /> #*# &lt;tt&gt;ad2-firmwareupload firmware.hex /dev/ttyUSB0 115200&lt;/tt&gt;<br /> # Confirm communication with your device.<br /> # Reset your device's configuration by sending &lt;b&gt;!&lt;/b&gt; and going through the prompts.</div> 204.10.16.14 http://www.alarmdecoder.com/wiki/index.php/FirmwareRevisionHistory FirmwareRevisionHistory 2020-08-24T22:52:04Z <p>204.10.16.14: /* 2.2a.8.9c-306 */</p> <hr /> <div>=&lt;span style=&quot;color:#F56464&quot;&gt;Beta Releases&lt;/span&gt;=<br /> ==2.2a.8.9b-306==<br /> * Temporary filter for numeric section of protocol. Max zone number on this firmware is 99.<br /> <br /> ==2.2a.8.9b-305==<br /> * FIX RFX timing issue.<br /> ==2.2a.8.9-303==<br /> * Fix another bug in 'K' command. Reverting back to primary address on # or * keys in Ademco mode.<br /> <br /> ==2.2a.8.7-299==<br /> * Fix another bug in 'K' command. Not reverting back to correct address after sending a blank line. Spec is sending a blank link \r\n will reset to configured keypad address.<br /> ==2.2a.8.7-298==<br /> * enable debuging<br /> ==2.2a.8.7-296==<br /> * Fixed K command not reverting back to original config address after \r\n<br /> * small change in debug output when debug flags enabled.<br /> <br /> ==2.2a.8.7-295==<br /> * AUI protocol limited to sending 20 characters. Now can send 72.<br /> <br /> ==2.2a.8.7-294==<br /> * Changed from letter beta codes to git commit number.<br /> ** The last revision using letters was 2.2a.8.7e<br /> * Fixed section #1 Chime bit state not tracked when real keypad changes chime mode.<br /> ** The screen was also hidden from the host and showed &quot;UNAVAILABLE&quot;.<br /> ** It now shows &quot;CHIME&quot; when another keypad changes the chime state.<br /> * Improve K command<br /> ** K command was not returning to the &quot;configured&quot; keypad address<br /> *** This caused erroneous address show in &quot;C&quot; command or ! config.<br /> <br /> ==2.2a.8.7e==<br /> * DSC prog. mode section screen cursor now disabled to match real keypad<br /> ==2.2a.8.7d==<br /> * UNKNOWN messages for *1, *5 and *6 mapped to DSC_ message<br /> ** *1 DSC_1801 <br /> *** No code configured [015]:5 will have a user id of 0.<br /> ** *5 DSC_1805<br /> ** *6 DSC_1806<br /> * bit #7(Bypass) loosing state when armed and entering * screen<br /> * bit #15(System issue) loosing state when entering * screens<br /> * bit #14(Fire) loosing state when entering * screens<br /> <br /> ==2.2a.8.7c==<br /> * Change CID for Trouble from 109 to 383 in DSC mode.<br /> ==2.2a.8.7b==<br /> * Arm bits in section #1 where loosing state when entering * screens in DSC mode.<br /> * Panel Busy messages in DSC mode when not needed.<br /> ==2.2a.8.7a==<br /> * Improve AC indicator response time in DSC mode.<br /> <br /> ==2.2a.8.6==<br /> * Final stable release with full feature programming of DSC panels and LRR changes to now support full '''Contact ID''' reporting.<br /> ==2.2a.8.5s==<br /> * Removed VPLEX support<br /> * Change in LRR protocol. Now supporting full Contact ID for Ademco and DSC.<br /> ** Added report code but it is only valid on DSC and is blank or FF on Ademco.<br /> * DSC Support now supports full emulation of all DSC keypad screens and programming modes.<br /> ** Requires update to Keypad App for reverse HEX entry on DSC.<br /> * DSC Support for LRR Contact ID with no panel programming required.<br /> ** CID report codes can be set in programming if needed.<br /> * DSC Keypad address is now two digit the first is partition second is slot. Default is 11 partition 1 slot 1 for DSC mode.<br /> * Ademco/DSC new support for putting custom configuration screens on real keypads or virtual controlled by host computer.<br /> * New CRC verified delivery wrapper for !XXX messages such as !LRR or !EXP<br /> * Minor fixes on EXP for Ademco<br /> * Minor changes in Config command removing verbose output<br /> * Fixed extra random character between boot message and start banner.<br /> <br /> ==2.2a.8.3c==<br /> * fixed missing AUI message output<br /> * Improved VPLEX support. RFX output LOOP1 or 4 and supervisory bit if EOL is wrong<br /> * small timing adjustment for circa 1991 SE panel SA4142AD<br /> <br /> ==2.2a.8.3b==<br /> * Initial VPLEX support<br /> ** Connect V+ to 12V V- to GND and V+ to DI and make sure config mode is Ademco.<br /> *** NOTE: only possible to connect to one BUS at a time for now so an additional AD2* is needed to monitor the VPLEX bus.<br /> * improved re-transmit handling with Ademco/Vista<br /> <br /> =&lt;span style=&quot;color:#70BA66&quot;&gt;Stable Releases&lt;/span&gt;=<br /> ==2.2a.8.8==<br /> * Major changes.<br /> ** DSC. <br /> *** The virtual keypad emulation is now identical to a real DSC alpha keypad including programming mode fields.<br /> ** DSC/Ademco<br /> *** Replaced LRR formate messages with new CID format standardizing alarm reporting across panel types using Contact ID. <br /> *** Small changes in section #1<br /> ==2.2a.8.2==<br /> * Bugfixes<br /> ** Settings allocation bug<br /> * Notes<br /> ** Shipping in all units built after October 2015<br /> <br /> ==2.2a.8.1==<br /> * New Features<br /> ** Missing DSC message<br /> ** First dotted quad revision<br /> <br /> ==2.2a.8==<br /> * New Features<br /> ** DSC panel support<br /> ** Compass download/upload support<br /> ** Blinking LED now displays error codes.<br /> ** New message type '!ERR' which can be retrieved by sending an 'e' to the AlarmDecoder<br /> <br /> ==2.2a.6==<br /> <br /> ==2.2a.4==<br /> * New Features<br /> ** Keypad Address Mask<br /> ** Long Range Radio (LRR) Emulation<br /> ** Message deduplication</div> 204.10.16.14 http://www.alarmdecoder.com/wiki/index.php/AlarmDecoder_Keypad AlarmDecoder Keypad 2020-05-06T19:56:26Z <p>204.10.16.14: /* Requirements */</p> <hr /> <div>__NOTOC__ <br /> [[Category:FAQ]]<br /> [[Category:Documentation]]<br /> [[Category:Downloads]]<br /> {{PageHeading|<br /> The AlarmDecoder keypad program creates a realistic advanced keypad on any computer running Windows, OSX or Linux. With the open source plugin API, and provided plugins, it is simple to configure '''free''' email alerts on alarm events as well as perform other automation tasks. The program will run on Linux, OSX, Windows and other operating systems that support C# and Gtk#.<br /> }}<br /> <br /> [[File:Ad2usbgui keypad.png|thumb|Keypad View]]<br /> [[File:Ad2usbgui layout.png|thumb|Layout View]]<br /> [[File:Ad2usbgui items.png|thumb|Items View]]<br /> <br /> ==Features==<br /> :* Open Source Plugin API<br /> :** C# examples included<br /> :* Network connectible<br /> :** Can act as a ser2sock server allowing access to the attached AlarmDecoder to network<br /> :** Can connect to each other or a central server using multiple instances or connecting to a [http://github.com/nutechsoftware/ser2sock ser2sock] server<br /> :* Works with touch screen, mouse or keyboard input<br /> :* Logging with date and time stamp<br /> :* AlarmDecoder firmware update utility built in<br /> <br /> == Extensions ==<br /> : Extensions can be loaded or unloaded using the about screen and install plugin menu.<br /> :* mystuff<br /> :** Example extension, emails events<br /> :* Program Downloader<br /> :** Download programming from 15/20p panels<br /> :* Zone Tracker<br /> :** Helps in detecting of zone closing on some zones<br /> :* HTML5 web browser tab<br /> :* Webcam viewer tab<br /> <br /> ==Download==<br /> {| align=&quot;center&quot; class=&quot;wikitable&quot; border=&quot;1&quot;<br /> |-<br /> ! scope=&quot;col&quot; width=&quot;140px&quot; | Operating System<br /> ! scope=&quot;col&quot; width=&quot;80px&quot; | Version<br /> ! scope=&quot;col&quot; width=&quot;280px&quot; | MD5<br /> |-<br /> | style=&quot;background:#F5FFF5&quot; align=&quot;center&quot; | [http://www.alarmdecoder.com/downloads/AlarmDecoderApp_windows_2_0_10.exe Windows] <br /> | align=&quot;center&quot; | 2.0.10<br /> | align=&quot;center&quot; | 052e0415e55e9ea71a506cf109931a11<br /> |-<br /> | style=&quot;background:#F5FFF5&quot; align=&quot;center&quot; | [http://www.alarmdecoder.com/downloads/AlarmDecoderApp_unix_2_0_10.sh Linux] <br /> | align=&quot;center&quot; | 2.0.10<br /> | align=&quot;center&quot; | e676236858f1cb11cbe122015b38450b<br /> |-<br /> | style=&quot;background:#F5FFF5&quot; align=&quot;center&quot; | [http://www.alarmdecoder.com/downloads/AlarmDecoderApp_OSX_2_0_10.zip Mac OSX] <br /> | align=&quot;center&quot; | 2.0.10<br /> | align=&quot;center&quot; | d1ae7f6a3ab49d93cedf399fbd3b98c7<br /> |-<br /> | style=&quot;background:#F5FFF5&quot; align=&quot;center&quot; | [http://www.alarmdecoder.com/downloads/AlarmDecoderApp_RAW_2_0_10.zip Raw files no install] <br /> | align=&quot;center&quot; | 2.0.10<br /> | align=&quot;center&quot; | 0014c98e3e1409cb49a5e10451b1a702<br /> |-<br /> | style=&quot;background:#F5FFF5&quot; align=&quot;center&quot; | [http://www.alarmdecoder.com/downloads/ad2guiupdate.zip Update DSC support] <br /> | align=&quot;center&quot; | 2.0.10<br /> | align=&quot;center&quot; | d38eb8114abf8e32219902a7eff5d50d<br /> |-<br /> |}<br /> <br /> ==Requirements==<br /> :; The Windows installer will add most or all of these requirements automatically. For Linux and OSX install the required components before running the app or attempting to install.<br /> :* .NET or Mono<br /> :** Windows: [http://www.microsoft.com/en-us/download/details.aspx?id=17718 Download .NET if not already installed ( most likely already installed )]<br /> :** Linux: [http://www.mono-project.com/Main_Page Download Mono or install the full Monodevelop package for your distribution]<br /> :** OSX: Mono MDK https://download.mono-project.com/archive/4.8.1/macos-10-universal/MonoFramework-MDK-4.8.1.0.macos10.xamarin.universal.pkg<br /> :* Gtk# [http://download.xamarin.com/GTKforWindows/Windows/gtk-sharp-2.12.22.msi Manual download Gtk#]<br /> :** Windows: Already included with installer. <br /> :** Linux: The easiest way is to install Monodevelop<br /> :** OSX: Included in MonoFramework MDK as part of the Mono package above.<br /> :* USB to Serial Drivers only needed with AD2USB [http://www.ftdichip.com/Drivers/VCP.htm Manual download FTDI drivers]<br /> :** Windows Already included with installer.<br /> :** Linux/OSX 10.9 Mavericks: On most distributions the FTDI driver will already be installed.<br /> :** OSX 10.8 Mountain Lion: Manual download and install FTDI drivers<br /> <br /> ==Notes==<br /> When you first run the program you will need to set the configuration to communicate with your AlarmDecoder device. You can do that from within the program in the &quot;System Menu&quot; or by directly editing the text config files: mysettings.conf or alarmdecodergui.exe.config. The application must be restarted in order for config file changes to take effect.</div> 204.10.16.14 http://www.alarmdecoder.com/wiki/index.php/AlarmDecoder_Keypad AlarmDecoder Keypad 2020-05-06T19:55:01Z <p>204.10.16.14: /* Requirements */</p> <hr /> <div>__NOTOC__ <br /> [[Category:FAQ]]<br /> [[Category:Documentation]]<br /> [[Category:Downloads]]<br /> {{PageHeading|<br /> The AlarmDecoder keypad program creates a realistic advanced keypad on any computer running Windows, OSX or Linux. With the open source plugin API, and provided plugins, it is simple to configure '''free''' email alerts on alarm events as well as perform other automation tasks. The program will run on Linux, OSX, Windows and other operating systems that support C# and Gtk#.<br /> }}<br /> <br /> [[File:Ad2usbgui keypad.png|thumb|Keypad View]]<br /> [[File:Ad2usbgui layout.png|thumb|Layout View]]<br /> [[File:Ad2usbgui items.png|thumb|Items View]]<br /> <br /> ==Features==<br /> :* Open Source Plugin API<br /> :** C# examples included<br /> :* Network connectible<br /> :** Can act as a ser2sock server allowing access to the attached AlarmDecoder to network<br /> :** Can connect to each other or a central server using multiple instances or connecting to a [http://github.com/nutechsoftware/ser2sock ser2sock] server<br /> :* Works with touch screen, mouse or keyboard input<br /> :* Logging with date and time stamp<br /> :* AlarmDecoder firmware update utility built in<br /> <br /> == Extensions ==<br /> : Extensions can be loaded or unloaded using the about screen and install plugin menu.<br /> :* mystuff<br /> :** Example extension, emails events<br /> :* Program Downloader<br /> :** Download programming from 15/20p panels<br /> :* Zone Tracker<br /> :** Helps in detecting of zone closing on some zones<br /> :* HTML5 web browser tab<br /> :* Webcam viewer tab<br /> <br /> ==Download==<br /> {| align=&quot;center&quot; class=&quot;wikitable&quot; border=&quot;1&quot;<br /> |-<br /> ! scope=&quot;col&quot; width=&quot;140px&quot; | Operating System<br /> ! scope=&quot;col&quot; width=&quot;80px&quot; | Version<br /> ! scope=&quot;col&quot; width=&quot;280px&quot; | MD5<br /> |-<br /> | style=&quot;background:#F5FFF5&quot; align=&quot;center&quot; | [http://www.alarmdecoder.com/downloads/AlarmDecoderApp_windows_2_0_10.exe Windows] <br /> | align=&quot;center&quot; | 2.0.10<br /> | align=&quot;center&quot; | 052e0415e55e9ea71a506cf109931a11<br /> |-<br /> | style=&quot;background:#F5FFF5&quot; align=&quot;center&quot; | [http://www.alarmdecoder.com/downloads/AlarmDecoderApp_unix_2_0_10.sh Linux] <br /> | align=&quot;center&quot; | 2.0.10<br /> | align=&quot;center&quot; | e676236858f1cb11cbe122015b38450b<br /> |-<br /> | style=&quot;background:#F5FFF5&quot; align=&quot;center&quot; | [http://www.alarmdecoder.com/downloads/AlarmDecoderApp_OSX_2_0_10.zip Mac OSX] <br /> | align=&quot;center&quot; | 2.0.10<br /> | align=&quot;center&quot; | d1ae7f6a3ab49d93cedf399fbd3b98c7<br /> |-<br /> | style=&quot;background:#F5FFF5&quot; align=&quot;center&quot; | [http://www.alarmdecoder.com/downloads/AlarmDecoderApp_RAW_2_0_10.zip Raw files no install] <br /> | align=&quot;center&quot; | 2.0.10<br /> | align=&quot;center&quot; | 0014c98e3e1409cb49a5e10451b1a702<br /> |-<br /> | style=&quot;background:#F5FFF5&quot; align=&quot;center&quot; | [http://www.alarmdecoder.com/downloads/ad2guiupdate.zip Update DSC support] <br /> | align=&quot;center&quot; | 2.0.10<br /> | align=&quot;center&quot; | d38eb8114abf8e32219902a7eff5d50d<br /> |-<br /> |}<br /> <br /> ==Requirements==<br /> :; The Windows will add most or all of these requirements automatically. For Linux and OSX install the required components first.<br /> :* .NET or Mono<br /> :** Windows: [http://www.microsoft.com/en-us/download/details.aspx?id=17718 Download .NET if not already installed ( most likely already installed )]<br /> :** Linux: [http://www.mono-project.com/Main_Page Download Mono or install the full Monodevelop package for your distribution]<br /> :** OSX: Mono MDK https://download.mono-project.com/archive/4.8.1/macos-10-universal/MonoFramework-MDK-4.8.1.0.macos10.xamarin.universal.pkg<br /> :* Gtk# [http://download.xamarin.com/GTKforWindows/Windows/gtk-sharp-2.12.22.msi Manual download Gtk#]<br /> :** Windows: Already included with installer. <br /> :** Linux: The easiest way is to install Monodevelop<br /> :** OSX: Included in MonoFramework MDK as part of the Mono package above.<br /> :* USB to Serial Drivers only needed with AD2USB [http://www.ftdichip.com/Drivers/VCP.htm Manual download FTDI drivers]<br /> :** Windows Already included with installer.<br /> :** Linux/OSX 10.9 Mavericks: On most distributions the FTDI driver will already be installed.<br /> :** OSX 10.8 Mountain Lion: Manual download and install FTDI drivers<br /> <br /> ==Notes==<br /> When you first run the program you will need to set the configuration to communicate with your AlarmDecoder device. You can do that from within the program in the &quot;System Menu&quot; or by directly editing the text config files: mysettings.conf or alarmdecodergui.exe.config. The application must be restarted in order for config file changes to take effect.</div> 204.10.16.14 http://www.alarmdecoder.com/wiki/index.php/FirmwareRevisionHistory FirmwareRevisionHistory 2019-09-29T01:03:22Z <p>204.10.16.14: /* 2.2a.8.9-303 */</p> <hr /> <div>=&lt;span style=&quot;color:#F56464&quot;&gt;Beta Releases&lt;/span&gt;=<br /> ==2.2a.8.9c-306==<br /> * Temporary filter for numeric section of protocol. Max zone number on this firmware is 99.<br /> ==2.2a.8.9b-305==<br /> * FIX RFX timing issue.<br /> ==2.2a.8.9-303==<br /> * Fix another bug in 'K' command. Reverting back to primary address on # or * keys in Ademco mode.<br /> <br /> ==2.2a.8.7-299==<br /> * Fix another bug in 'K' command. Not reverting back to correct address after sending a blank line. Spec is sending a blank link \r\n will reset to configured keypad address.<br /> ==2.2a.8.7-298==<br /> * enable debuging<br /> ==2.2a.8.7-296==<br /> * Fixed K command not reverting back to original config address after \r\n<br /> * small change in debug output when debug flags enabled.<br /> <br /> ==2.2a.8.7-295==<br /> * AUI protocol limited to sending 20 characters. Now can send 72.<br /> <br /> ==2.2a.8.7-294==<br /> * Changed from letter beta codes to git commit number.<br /> ** The last revision using letters was 2.2a.8.7e<br /> * Fixed section #1 Chime bit state not tracked when real keypad changes chime mode.<br /> ** The screen was also hidden from the host and showed &quot;UNAVAILABLE&quot;.<br /> ** It now shows &quot;CHIME&quot; when another keypad changes the chime state.<br /> * Improve K command<br /> ** K command was not returning to the &quot;configured&quot; keypad address<br /> *** This caused erroneous address show in &quot;C&quot; command or ! config.<br /> <br /> ==2.2a.8.7e==<br /> * DSC prog. mode section screen cursor now disabled to match real keypad<br /> ==2.2a.8.7d==<br /> * UNKNOWN messages for *1, *5 and *6 mapped to DSC_ message<br /> ** *1 DSC_1801 <br /> *** No code configured [015]:5 will have a user id of 0.<br /> ** *5 DSC_1805<br /> ** *6 DSC_1806<br /> * bit #7(Bypass) loosing state when armed and entering * screen<br /> * bit #15(System issue) loosing state when entering * screens<br /> * bit #14(Fire) loosing state when entering * screens<br /> <br /> ==2.2a.8.7c==<br /> * Change CID for Trouble from 109 to 383 in DSC mode.<br /> ==2.2a.8.7b==<br /> * Arm bits in section #1 where loosing state when entering * screens in DSC mode.<br /> * Panel Busy messages in DSC mode when not needed.<br /> ==2.2a.8.7a==<br /> * Improve AC indicator response time in DSC mode.<br /> <br /> ==2.2a.8.6==<br /> * Final stable release with full feature programming of DSC panels and LRR changes to now support full '''Contact ID''' reporting.<br /> ==2.2a.8.5s==<br /> * Removed VPLEX support<br /> * Change in LRR protocol. Now supporting full Contact ID for Ademco and DSC.<br /> ** Added report code but it is only valid on DSC and is blank or FF on Ademco.<br /> * DSC Support now supports full emulation of all DSC keypad screens and programming modes.<br /> ** Requires update to Keypad App for reverse HEX entry on DSC.<br /> * DSC Support for LRR Contact ID with no panel programming required.<br /> ** CID report codes can be set in programming if needed.<br /> * DSC Keypad address is now two digit the first is partition second is slot. Default is 11 partition 1 slot 1 for DSC mode.<br /> * Ademco/DSC new support for putting custom configuration screens on real keypads or virtual controlled by host computer.<br /> * New CRC verified delivery wrapper for !XXX messages such as !LRR or !EXP<br /> * Minor fixes on EXP for Ademco<br /> * Minor changes in Config command removing verbose output<br /> * Fixed extra random character between boot message and start banner.<br /> <br /> ==2.2a.8.3c==<br /> * fixed missing AUI message output<br /> * Improved VPLEX support. RFX output LOOP1 or 4 and supervisory bit if EOL is wrong<br /> * small timing adjustment for circa 1991 SE panel SA4142AD<br /> <br /> ==2.2a.8.3b==<br /> * Initial VPLEX support<br /> ** Connect V+ to 12V V- to GND and V+ to DI and make sure config mode is Ademco.<br /> *** NOTE: only possible to connect to one BUS at a time for now so an additional AD2* is needed to monitor the VPLEX bus.<br /> * improved re-transmit handling with Ademco/Vista<br /> <br /> =&lt;span style=&quot;color:#70BA66&quot;&gt;Stable Releases&lt;/span&gt;=<br /> ==2.2a.8.8==<br /> * Major changes.<br /> ** DSC. <br /> *** The virtual keypad emulation is now identical to a real DSC alpha keypad including programming mode fields.<br /> ** DSC/Ademco<br /> *** Replaced LRR formate messages with new CID format standardizing alarm reporting across panel types using Contact ID. <br /> *** Small changes in section #1<br /> ==2.2a.8.2==<br /> * Bugfixes<br /> ** Settings allocation bug<br /> * Notes<br /> ** Shipping in all units built after October 2015<br /> <br /> ==2.2a.8.1==<br /> * New Features<br /> ** Missing DSC message<br /> ** First dotted quad revision<br /> <br /> ==2.2a.8==<br /> * New Features<br /> ** DSC panel support<br /> ** Compass download/upload support<br /> ** Blinking LED now displays error codes.<br /> ** New message type '!ERR' which can be retrieved by sending an 'e' to the AlarmDecoder<br /> <br /> ==2.2a.6==<br /> <br /> ==2.2a.4==<br /> * New Features<br /> ** Keypad Address Mask<br /> ** Long Range Radio (LRR) Emulation<br /> ** Message deduplication</div> 204.10.16.14 http://www.alarmdecoder.com/wiki/index.php/Firmware Firmware 2019-09-29T00:47:16Z <p>204.10.16.14: /* Download */</p> <hr /> <div><br /> <br /> <br /> <br /> __NOTOC__<br /> [[Category:Documentation]]<br /> [[Category:Downloads]]<br /> {{PageHeading|<br /> 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. Flashing your device will not retain configuration settings.<br /> }}<br /> <br /> ==Identifying your Board Revision==<br /> Use the images below to identify what revision of AlarmDecoder you have.<br /> <br /> {| summary=&quot;AlarmDecoder Devices and Revisions&quot;<br /> |[[File:2_2_board.jpg|thumb|2.2 (AD2USB)]]<br /> |[[File:2_2_serial.jpg|thumb|2.2 (AD2SERIAL)]]<br /> |[[File:Ad2pi.png|thumb|2.2 (AD2PI)]]<br /> |[[File:2_0_board.jpg|thumb|2.0 (AD2USB)]]<br /> |}<br /> <br /> ==Checking your Firmware Version==<br /> You can retrieve the version information by connecting to your device with a terminal program (PuTTY, screen, etc.) and sending the &lt;b&gt;V&lt;/b&gt; command.<br /> <br /> A response will be returned with your current version information:<br /> !VER:ffffffff,'''V2.2a.8a8''',TX;RX;SM;VZ;RF;ZX;RE;AU;3X;CG;DD;MF;LR;KE;MK;CB;DS<br /> <br /> ==Download==<br /> {| class=&quot;wikitable&quot; border=&quot;1&quot;<br /> ! scope=&quot;col&quot; width=&quot;120px&quot; | Board Revision<br /> ! scope=&quot;col&quot; width=&quot;140px&quot; | Firmware Version<br /> ! scope=&quot;col&quot; width=&quot;60px&quot; | Revision History<br /> ! scope=&quot;col&quot; width=&quot;140px&quot; | Panel Support<br /> |-<br /> | colspan=&quot;4&quot; align=&quot;center&quot; style=&quot;background-color: #70BA66; font-weight: bold&quot; | Stable<br /> |-<br /> | align=&quot;center&quot; style=&quot;font-weight: bold&quot; | 2.2+<br /> | align=&quot;center&quot; | [http://www.alarmdecoder.com/downloads/firmware/2.2/ademcoemu_V2-2a-8-8.zip 2.2a.8.8] <br /> | align=&quot;center&quot; | [[FirmwareRevisionHistory#2.2a.8.8|link]]<br /> | DSC, Ademco Vista<br /> |-<br /> | colspan=&quot;4&quot; align=&quot;center&quot; style=&quot;background-color: #F56464; font-weight: bold&quot; | Beta<br /> |-<br /> | align=&quot;center&quot; style=&quot;font-weight: bold&quot; | 2.2+<br /> | align=&quot;center&quot; | [http://www.alarmdecoder.com/downloads/firmware/2.2/ademcoemu_V2-2a-8-9c-306.zip 2.2a.8.9c-306]<br /> | align=&quot;center&quot; | [[FirmwareRevisionHistory#2.2a.8.9c-306|link]]<br /> | DSC, Ademco Vista<br /> |-<br /> | align=&quot;center&quot; style=&quot;font-weight: bold&quot; | 2.2+<br /> | align=&quot;center&quot; | [http://www.alarmdecoder.com/downloads/firmware/2.2/ademcoemu_V2-2a-8-9-303.zip 2.2a.8.9-303]<br /> | align=&quot;center&quot; | [[FirmwareRevisionHistory#2.2a.8.9-303|link]]<br /> | DSC, Ademco Vista<br /> |-<br /> | align=&quot;center&quot; style=&quot;font-weight: bold&quot; | 2.2+<br /> | align=&quot;center&quot; | [http://www.alarmdecoder.com/downloads/firmware/2.2/ademcoemu_V2-2a-8-7-297.zip 2.2a.8.7-297]<br /> | align=&quot;center&quot; | [[FirmwareRevisionHistory#2.2a.8.7-297|link]]<br /> | DSC, Ademco Vista<br /> |-<br /> | align=&quot;center&quot; style=&quot;font-weight: bold&quot; | 2.2+<br /> | align=&quot;center&quot; | [http://www.alarmdecoder.com/downloads/firmware/2.2/ademcoemu_V2_2a_8_7a.zip 2.2a.8.7a]<br /> | align=&quot;center&quot; | [[FirmwareRevisionHistory#2.2a.8.7a|link]]<br /> | DSC, Ademco Vista<br /> |-<br /> | align=&quot;center&quot; style=&quot;font-weight: bold&quot; | 2.2+<br /> | align=&quot;center&quot; | [http://www.alarmdecoder.com/downloads/firmware/2.2/ademcoemu_V2_2a_8_5s.zip 2.2a.8.5s]<br /> | align=&quot;center&quot; | [[FirmwareRevisionHistory#2.2a.8.5s|link]]<br /> | DSC, Ademco Vista<br /> |-<br /> | align=&quot;center&quot; style=&quot;font-weight: bold&quot; | 2.2+<br /> | align=&quot;center&quot; | [http://www.alarmdecoder.com/downloads/firmware/2.2/ademcoemu_V2_2a_8_3c.zip 2.2a.8.3c]<br /> | align=&quot;center&quot; | [[FirmwareRevisionHistory#2.2a.8.3c|link]]<br /> | VPLEX BETA<br /> |-<br /> | align=&quot;center&quot; style=&quot;font-weight: bold&quot; | 2.2+<br /> | align=&quot;center&quot; | [http://www.alarmdecoder.com/downloads/firmware/2.2/ademcoemu_V2_2a_8_3b.zip 2.2a.8.3b]<br /> | align=&quot;center&quot; | [[FirmwareRevisionHistory#2.2a.8.3b|link]]<br /> | DSC, Ademco Vista<br /> |-<br /> | colspan=&quot;4&quot; align=&quot;center&quot; style=&quot;background-color: #FAFA70; font-weight: bold&quot; | Legacy<br /> |-<br /> | align=&quot;center&quot; style=&quot;font-weight: bold&quot; | 2.2+<br /> | align=&quot;center&quot; | [http://www.alarmdecoder.com/downloads/firmware/2.2/ademcoemu_V2_2a_8_6.zip 2.2a.8.6] <br /> | align=&quot;center&quot; | [[FirmwareRevisionHistory#2.2a.8.6|link]]<br /> | *DSC(limited), Ademco Vista<br /> |-<br /> | align=&quot;center&quot; style=&quot;font-weight: bold&quot; | 2.2+<br /> | align=&quot;center&quot; | [http://www.alarmdecoder.com/downloads/firmware/2.2/ademcoemu_V2_2a_6.zip 2.2a.6] <br /> | align=&quot;center&quot; | [[FirmwareRevisionHistory#2.2a.6|link]]<br /> | Ademco Vista<br /> |-<br /> | align=&quot;center&quot; | 2.0<br /> | align=&quot;center&quot; | [http://www.alarmdecoder.com/downloads/firmware/2.0/ademcoemu_V2_1f_10.zip 2.1f.10] <br /> | align=&quot;center&quot; | -<br /> | Ademco Vista<br /> |-<br /> | align=&quot;center&quot; style=&quot;font-weight: bold&quot; | 2.2+<br /> | align=&quot;center&quot; | [http://www.alarmdecoder.com/downloads/firmware/2.2/ademcoemu_V2_2a_8_2.zip 2.2a.8.2] <br /> | align=&quot;center&quot; | [[FirmwareRevisionHistory#2.2a.8.2|link]]<br /> | Ademco Vista<br /> |-<br /> | align=&quot;center&quot; style=&quot;font-weight: bold&quot; | 2.2+<br /> | align=&quot;center&quot; | [http://www.alarmdecoder.com/downloads/firmware/2.2/ademcoemu_V2_2a_3_beta.zip 2.2a.3] <br /> | align=&quot;center&quot; | -<br /> | Ademco Vista<br /> |-<br /> | align=&quot;center&quot; style=&quot;font-weight: bold&quot; | 2.2+<br /> | align=&quot;center&quot; | [http://www.alarmdecoder.com/downloads/firmware/2.2/ademcoemu_V2_2a_2.zip 2.2a.2] <br /> | align=&quot;center&quot; | -<br /> | Ademco Vista<br /> |-<br /> | align=&quot;center&quot; | 2.0<br /> | align=&quot;center&quot; | [http://www.alarmdecoder.com/downloads/firmware/2.0/ademcoemu_V2_1f_0e.zip 2.1f.0e] <br /> | align=&quot;center&quot; | -<br /> | Ademco Vista<br /> |-<br /> | align=&quot;center&quot; | 2.0<br /> | align=&quot;center&quot; | [http://www.alarmdecoder.com/downloads/firmware/2.0/ademcoemu_V2_1f_0d.zip 2.1f.0d] <br /> | align=&quot;center&quot; | -<br /> | Ademco Vista<br /> |-<br /> | align=&quot;center&quot; | 2.0<br /> | align=&quot;center&quot; | [http://www.alarmdecoder.com/downloads/firmware/2.0/ademcoemu_V1_0f_26.zip 1.0f.26] <br /> | align=&quot;center&quot; | -<br /> | Ademco Vista<br /> |}<br /> <br /> ==Instructions==<br /> ; '''Flashing new firmware will not retain device configuration settings'''<br /> ; There are a few different ways to go about flashing your device.<br /> <br /> # Make sure that you have completed the installation and can communicate with your device through a terminal program. (PuTTY, screen, etc.)<br /> # Download one of the available programs or use the built in firmware uploader in the [[AlarmDecoder_WebApp|AlarmDecoder WebApp]]<br /> #* [[AlarmDecoder_Keypad|AlarmDecoder Keypad]] - .NET/Mono and Gtk#<br /> #* [http://www.alarmdecoder.com/downloads/firmwareupload.zip Console firmware uploader] - .NET/Mono<br /> #* [http://github.com/nutechsoftware/alarmdecoder ad2-firmwareupload] - from the official Python library<br /> # Download your desired firmware from the choices above.<br /> # Flash the firmware<br /> #* [[AlarmDecoder_WebApp|AlarmDecoder WebApp]]<br /> #** &lt;tt&gt;Settings -&gt; Advanced -&gt; Firmware Upload&lt;/tt&gt;<br /> #* AlarmDecoder Keypad<br /> #*# Navigate to &lt;tt&gt;System -&gt; Firmware Upload&lt;/tt&gt;<br /> #*# Select the firmware file to upload.<br /> #*# The program will start uploading automatically.<br /> #* Console firmware uploader<br /> #*# &lt;tt&gt;firmwareupload COM6 115200 firmware.hex&lt;/tt&gt;<br /> #* ad2-firmwareupload<br /> #*# &lt;tt&gt;ad2-firmwareupload firmware.hex /dev/ttyUSB0 115200&lt;/tt&gt;<br /> # Confirm communication with your device.<br /> # Reset your device's configuration by sending &lt;b&gt;!&lt;/b&gt; and going through the prompts.</div> 204.10.16.14 http://www.alarmdecoder.com/wiki/index.php/AlarmDecoder_pHat AlarmDecoder pHat 2019-08-19T05:04:39Z <p>204.10.16.14: </p> <hr /> <div>__NOTOC__ <br /> [[Category:Documentation]]<br /> [[Category:Downloads]]<br /> [[Category:Advanced_Topics]]<br /> <br /> [[File:Ad2phat_top.png|thumb|100px|AD2pHAT Top]]<br /> [[File:Ad2phat_bottom.png|thumb|100px|AD2pHAT Bottom]]<br /> <br /> ;The new AD2pHAT is the latest revision of the AlarmDecoder embedded project. In 2019 it will be replacing the original AD2Pi that was introduced in 2013. The original AD2Pi was designed prior to any standards for add-on boards to the Raspberry Pi. Over the past few years the Pi HAT and pHAT form factor were introduced and many add-on designs have migrated to these layouts. The AD2pHAT is using the the pHAT form factor 30mm x 65mm. This more compact form factor works better with the Pi Zero and still works on the full sized Pi. It is also smaller and closer in size to other micro controllers such as the ESP32Thing that with an adapter&lt;ref&gt;AD2PiHAT Pin&lt;/ref&gt; can be used instead of a Pi as the host controller.<br /> <br /> <br /> ;This new design includes several new features.<br /> * The ability to monitor the AD2 Heartbeat signal via GPIO23.<br /> * The ability to physically reboot the AD2 embedded device via GPIO18.<br /> * i2c 32kbit Serial EEPROM [https://octopart.com/24aa32at-i%2Fot-microchip-17751700 24AA32AT-I/OT] accessible by the embedded host for device tree configuration via GPIO0(SDA0) and GPIO1(SCL0).<br /> * Flexible power options.<br /> ** Up to 94% high efficiency TRACO Power [https://octopart.com/tsr+1-2450-tracopower-10300099 TSR 1-2450] capable of power a Pi3b+.<br /> ** Linear regulators for lower power demands.<br /> *** [https://octopart.com/az1117cr-3.3trg1-diodes+inc.-30954805 AZ1117CR-3.3TRG1] for ~200ma continuous load.&lt;ref&gt;Estimate. Needs load testing.&lt;/ref&gt;<br /> *** [https://octopart.com/ld1117v50-stmicroelectronics-2221430 LD1117V50] for ~500ma continuous.&lt;ref&gt;Estimate. Needs load testing.&lt;/ref&gt;<br /> <br /> <br /> &lt;references&gt;<br /> &lt;/references&gt;</div> 204.10.16.14 http://www.alarmdecoder.com/wiki/index.php/File:Ad2phat_bottom.png File:Ad2phat bottom.png 2019-08-18T18:57:10Z <p>204.10.16.14: 204.10.16.14 uploaded a new version of &amp;quot;File:Ad2phat bottom.png&amp;quot;</p> <hr /> <div></div> 204.10.16.14 http://www.alarmdecoder.com/wiki/index.php/File:Ad2phat_top.png File:Ad2phat top.png 2019-08-18T18:56:46Z <p>204.10.16.14: 204.10.16.14 uploaded a new version of &amp;quot;File:Ad2phat top.png&amp;quot;</p> <hr /> <div></div> 204.10.16.14 http://www.alarmdecoder.com/wiki/index.php/Talk:AlarmDecoder_pHat Talk:AlarmDecoder pHat 2019-08-18T17:07:00Z <p>204.10.16.14: Created page with &quot;;SM20190818: I was able to power a Pi3B+ and a Pi Zero W with no issues using the TSR 1-2450 to supply 5v to the Pi and feed back 3v3 volts to power the AD2 circuit. No issues...&quot;</p> <hr /> <div>;SM20190818: I was able to power a Pi3B+ and a Pi Zero W with no issues using the TSR 1-2450 to supply 5v to the Pi and feed back 3v3 volts to power the AD2 circuit. No issues noted current consumption from the panel was as low as 100ma and as high as 350ma for a few seconds with the Pi connected to Ethernet and transmitting data over ser2sock. I preformed the same tests using LD1117V50 and it also worked but the current draw was higher and the heat was a bit high. That will need more testing to find the limits.</div> 204.10.16.14 http://www.alarmdecoder.com/wiki/index.php/AlarmDecoder_pHat AlarmDecoder pHat 2019-08-18T04:13:01Z <p>204.10.16.14: </p> <hr /> <div>__NOTOC__ <br /> [[Category:Documentation]]<br /> [[Category:Downloads]]<br /> [[Category:Advanced_Topics]]<br /> <br /> [[File:Ad2phat_top.png|thumb|100px|AD2pHAT Top]]<br /> [[File:Ad2phat_bottom.png|thumb|100px|AD2pHAT Bottom]]<br /> <br /> ;The new AD2pHAT is the latest revision of the AlarmDecoder embedded project. In 2019 it will be replacing the original AD2Pi that was introduced in 2013. The original AD2Pi was designed prior to any standards for add-on boards to the Raspberry Pi. Over the past few years the Pi HAT and pHAT form factor were introduced and many add-on designs have migrated to these layouts. The AD2pHAT is using the the pHAT form factor 30mm x 65mm. This more compact form factor works better with the Pi Zero and still works on the full sized Pi. It is also smaller and closer in size to other micro controllers such as the ESP32Thing that with an adapter&lt;ref&gt;AD2PiHAT Pin&lt;/ref&gt; can be used instead of a Pi as the host controller.<br /> <br /> <br /> ;This new design includes several new features.<br /> * The ability to monitor the AD2 Heartbeat signal via GPIO23.<br /> * The ability to physically reboot the AD2 embedded device via GPIO18.<br /> * i2c nvram accessible by the embedded host for device tree configuration.<br /> * Flexible power options.<br /> ** Up to 94% high efficiency TRACO Power [https://octopart.com/tsr+1-2450-tracopower-10300099 TSR 1-2450] capable of power a Pi3b+.<br /> ** Linear regulators for lower power demands.<br /> *** [https://octopart.com/az1117cr-3.3trg1-diodes+inc.-30954805 AZ1117CR-3.3TRG1] for ~200ma continuous load.&lt;ref&gt;Estimate. Needs load testing.&lt;/ref&gt;<br /> *** [https://octopart.com/ld1117v50-stmicroelectronics-2221430 LD1117V50] for ~500ma continuous.&lt;ref&gt;Estimate. Needs load testing.&lt;/ref&gt;<br /> <br /> <br /> &lt;references&gt;<br /> &lt;/references&gt;</div> 204.10.16.14 http://www.alarmdecoder.com/wiki/index.php/AlarmDecoder_pHat AlarmDecoder pHat 2019-08-18T03:17:30Z <p>204.10.16.14: </p> <hr /> <div>__NOTOC__ <br /> [[Category:Documentation]]<br /> [[Category:Downloads]]<br /> [[Category:Advanced_Topics]]<br /> <br /> [[File:Ad2phat_top.png|thumb|100px|AD2pHAT Top]]<br /> [[File:Ad2phat_bottom.png|thumb|100px|AD2pHAT Bottom]]<br /> <br /> ;The new AD2pHAT is the latest revision of the AlarmDecoder embedded project. In 2019 it will be replacing the original AD2Pi that was introduced in 2013. The original AD2Pi was designed prior to any standards for add-on boards to the Raspberry Pi. Over the past few years the Pi HAT and pHAT form factor were introduced and many add-on designs have migrated to these layouts. The AD2pHAT is using the the pHAT form factor 30mm x 65mm. This more compact form factor works better with the Pi Zero and still works on the full sized Pi. It is also smaller and closer in size to other micro controllers such as the ESP32Thing that with an adapter can be used instead of a Pi as the host controller.<br /> <br /> <br /> ;This new design includes several new features.<br /> * The ability to monitor the AD2 Heartbeat signal.<br /> * The ability to physically reboot the AD2 embedded device.<br /> * i2c nvram accessible by the embedded host for device tree configuration.<br /> * Flexible power options.<br /> ** Up to 94% high efficiency TRACO Power [https://octopart.com/tsr+1-2450-tracopower-10300099 TSR 1-2450] capable of power a Pi3b+.<br /> ** Linear regulators for lower power demands.<br /> *** [https://octopart.com/az1117cr-3.3trg1-diodes+inc.-30954805 AZ1117CR-3.3TRG1] for ~200ma continuous.<br /> *** [https://octopart.com/ld1117v50-stmicroelectronics-2221430 LD1117V50] for ~500ma continuous.</div> 204.10.16.14 http://www.alarmdecoder.com/wiki/index.php/File:Ad2phat_bottom.png File:Ad2phat bottom.png 2019-08-18T03:15:30Z <p>204.10.16.14: </p> <hr /> <div></div> 204.10.16.14 http://www.alarmdecoder.com/wiki/index.php/File:Ad2phat_top.png File:Ad2phat top.png 2019-08-18T03:15:08Z <p>204.10.16.14: </p> <hr /> <div></div> 204.10.16.14 http://www.alarmdecoder.com/wiki/index.php/AlarmDecoder_pHat AlarmDecoder pHat 2019-08-18T03:04:15Z <p>204.10.16.14: Created page with &quot;__NOTOC__ Category:Documentation Category:Downloads Category:Advanced_Topics AD2pHAT Top File:Ad2phat_bottom.png|thumb|AD2pHAT B...&quot;</p> <hr /> <div>__NOTOC__ <br /> [[Category:Documentation]]<br /> [[Category:Downloads]]<br /> [[Category:Advanced_Topics]]<br /> <br /> [[File:Ad2phat_top.png|thumb|AD2pHAT Top]]<br /> [[File:Ad2phat_bottom.png|thumb|AD2pHAT Bottom]]<br /> <br /> ;The new AD2pHAT is the latest revision of the AlarmDecoder embedded project. In 2019 it will be replacing the original AD2Pi that was introduced in 2013. The original AD2Pi was designed prior to any standards for add-on boards to the Raspberry Pi. Over the past few years the Pi HAT and pHAT form factor were introduced and many add-on designs have migrated to these layouts. The AD2pHAT is using the the pHAT form factor 30mm x 65mm. This more compact form factor works better with the Pi Zero and still works on the full sized Pi. It is also smaller and closer in size to other micro controllers such as the ESP32Thing that with an adapter can be used instead of a Pi as the host controller.<br /> <br /> <br /> ;This new design includes several new features.<br /> * The ability to monitor the AD2 Heartbeat signal.<br /> * The ability to physically reboot the AD2 embedded device.<br /> * i2c nvram accessible by the embedded host for device tree configuration.<br /> * Flexible power options.<br /> ** Up to 94% high efficiency TRACO Power [https://octopart.com/tsr+1-2450-tracopower-10300099 TSR 1-2450] capable of power a Pi3b+.<br /> ** Linear regulators for lower power demands.<br /> *** [https://octopart.com/az1117cr-3.3trg1-diodes+inc.-30954805 AZ1117CR-3.3TRG1] for ~200ma continuous.<br /> *** [https://octopart.com/ld1117v50-stmicroelectronics-2221430 LD1117V50] for ~500ma continuous.</div> 204.10.16.14 http://www.alarmdecoder.com/wiki/index.php/Raspberry_Pi Raspberry Pi 2019-08-16T19:52:42Z <p>204.10.16.14: </p> <hr /> <div>__NOTOC__ <br /> [[Category:Documentation]]<br /> [[Category:Downloads]]<br /> [[Category:Advanced_Topics]]<br /> <br /> [[File:Ad2pi.png|thumb|AD2PI]]<br /> <br /> 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]].<br /> <br /> 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 to a 8g uSD disk or larger using a simple too such as [https://www.balena.io/etcher/ Etcher] or [https://rufus.ie/ Rufus] or following the instructions 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.<br /> <br /> [[File:pibplus.png|thumb|AD2PI Bundle]]<br /> [[File:Ad2pi-iot-dia.png|thumb|API]]<br /> <br /> ==Official Raspbian Image==<br /> ===Changes from Raspbian===<br /> * Disabled serial console so that the device can use it.<br /> * Installed [http://github.com/nutechsoftware/ser2sock ser2sock] to expose the AlarmDecoder on your network.<br /> * Installed the [http://github.com/nutechsoftware/alarmdecoder AlarmDecoder Python library].<br /> * Installed and configured the [http://github.com/nutechsoftware/alarmdecoder-webapp AlarmDecoder Webapp] [[AlarmDecoder_WebApp|Instructions]].<br /> * And much much more. See the PiBakery recipe for more details.<br /> ===Download===<br /> {| class=&quot;wikitable&quot; border=&quot;1&quot;<br /> ! scope=&quot;col&quot; width=&quot;50px&quot; | Status<br /> ! scope=&quot;col&quot; width=&quot;100px&quot; | Link<br /> ! scope=&quot;col&quot; width=&quot;120px&quot; | Version<br /> ! scope=&quot;col&quot; width=&quot;220px&quot; | MD5<br /> ! scope=&quot;col&quot; width=&quot;250px&quot; | Includes<br /> |-<br /> | align=&quot;center&quot; style=&quot;background-color: #70BA66;&quot; | Stable<br /> | align=&quot;center&quot; | [http://www.alarmdecoder.com/downloads/pi/PIBAKERY-AD2PIBOOT-RASPBIAN-10-BUSTER-20190710B.ZIP Download]<br /> | align=&quot;center&quot; | Raspbian Buster 10 PiBakery build &lt;hr&gt;(Latest build 08/15/2019)<br /> | align=&quot;center&quot; | zip: e87cd27f18a5c07c1e2b75400a08c030 img: 5f3eb62b3862575f2604e41c9808672f<br /> | align=&quot;left&quot; | 2019-07-20 updated AlarmDecoder 1.13.8, AlarmDecoder-webapp 0.8.6, Added packages, Built using a [https://github.com/nutechsoftware/alarmdecoder-webapp/tree/master/contrib/PiBakery/ PiBakery recipe] See the AlarmDecoder [[PiBakery|PiBakery wiki page]].<br /> |-<br /> | align=&quot;center&quot; style=&quot;background-color: #d4ac0d;&quot; | Issues<br /> | align=&quot;center&quot; | [http://www.alarmdecoder.com/downloads/pi/PIBAKERY-AD2PIBOOT-RASPBIAN-10-BUSTER-20190710.ZIP Download]<br /> | align=&quot;center&quot; | Raspbian Buster 10 PiBakery build &lt;hr&gt;(Missing packages)<br /> | align=&quot;center&quot; | zip: e1190b702baf443ee73e6afb982e4fa7 img: 78e06d89dd41a13a288005dc000bee6c<br /> | align=&quot;left&quot; | 2019-07-20 updated AlarmDecoder 1.13.7, AlarmDecoder-webapp 0.8.4, Built using a [https://github.com/nutechsoftware/alarmdecoder-webapp/tree/master/contrib/PiBakery/ PiBakery recipe] See the AlarmDecoder [[PiBakery|PiBakery wiki page]].<br /> |-<br /> | align=&quot;center&quot; style=&quot;background-color: #70BA66;&quot; | Stable<br /> | align=&quot;center&quot; | [http://www.alarmdecoder.com/downloads/pi/PIBAKERY-AD2PIBOOT-RASPBIAN-9-STRETCH-20181015.ZIP Download]<br /> | align=&quot;center&quot; | Raspbian Stretch 9.0 PiBakery build<br /> | align=&quot;center&quot; | zip: cc7e267d2f3bd377a239b3ebc996f491 img: 275635f7ca7ad70e951bea1f68593c86<br /> | align=&quot;left&quot; | 2018-10-14 updated AlarmDecoder 1.13.4, AlarmDecoder-webapp 0.8.2, Built using a [https://github.com/nutechsoftware/alarmdecoder-webapp/tree/master/contrib/PiBakery/ PiBakery recipe] See the AlarmDecoder [[PiBakery|PiBakery wiki page]].<br /> |-<br /> | align=&quot;center&quot; style=&quot;background-color: #70BA66;&quot; | Stable<br /> | align=&quot;center&quot; | [http://www.alarmdecoder.com/downloads/pi/alarmdecoder-raspbian-2018-05-29.zip Download]<br /> | align=&quot;center&quot; | Raspbian Jessie 8.0<br /> | align=&quot;center&quot; | zip: 3a001426b1a3a2793bea589cfc93be39 img: c5e50da07e5d084ad76abd591ab605f2<br /> | align=&quot;left&quot; | 2018-05-29 updated AlarmDecoder 1.13.4, AlarmDecoder-webapp 0.8.2, Supports the Raspberry Pi Model B, B+ and B2, and B3. Wifi and Bluetooth are both functional on the Pi 3<br /> |}<br /> <br /> ==Manual Configuration==<br /> # Flash the SD card with your choice of OS as described [http://www.elinux.org/Rpi_easy_sd_card_setup here].<br /> #* Flashing tools quick pick<br /> #** Etcher https://www.balena.io/etcher/<br /> #** Rufus https://rufus.ie/<br /> # Boot up the Raspberry Pi.<br /> # Remove the following entries from &lt;tt&gt;/boot/cmdline.txt&lt;/tt&gt;:<br /> #* &lt;tt&gt;console=ttyAMA0,115200&lt;/tt&gt;<br /> #* &lt;tt&gt;kgdboc=ttyAMA0,115200&lt;/tt&gt;<br /> # Remove the following line from &lt;tt&gt;/etc/inittab&lt;/tt&gt;:<br /> #* &lt;tt&gt;T0:23:respawn:/sbin/getty -L ttyAMA0 115200 vt100&lt;/tt&gt;<br /> # Sync and halt your Raspberry Pi.<br /> # Attach the AD2PI.<br /> # Boot it up again.<br /> #* At this point you should be able to communicate with the device at &lt;tt&gt;/dev/ttyAMA0&lt;/tt&gt;.<br /> # Install any optional software ([http://github.com/nutechsoftware/ser2sock ser2sock], [http://github.com/nutechsoftware/alarmdecoder Python library], etc.)<br /> #* Add dev package needed for compiling ser2sock<br /> #** sudo apt-get install openssl-dev<br /> #* The AlarmDecoder WEB App install instructions are here<br /> #** https://github.com/nutechsoftware/alarmdecoder-webapp<br /> <br /> ==Default Passwords==<br /> ;Passwords should be changed once you get your device!<br /> ===SSH/Shell===<br /> ;Login: pi<br /> ;Password: raspberry<br /> ===AlarmDecoder WebApp===<br /> ;Login: admin<br /> ;Password: alarmdecoder<br /> ==AD2PI case assembly==<br /> ;[[File:case assembly doc.pdf|Case assembly]]</div> 204.10.16.14 http://www.alarmdecoder.com/wiki/index.php/Raspberry_Pi Raspberry Pi 2019-08-15T01:13:40Z <p>204.10.16.14: </p> <hr /> <div>__NOTOC__ <br /> [[Category:Documentation]]<br /> [[Category:Downloads]]<br /> [[Category:Advanced_Topics]]<br /> <br /> [[File:Ad2pi.png|thumb|AD2PI]]<br /> <br /> 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]].<br /> <br /> 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 to a 8g uSD disk or larger using a simple too such as [https://www.balena.io/etcher/ Etcher] or [https://rufus.ie/ Rufus] or following the instructions 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.<br /> <br /> [[File:pibplus.png|thumb|AD2PI Bundle]]<br /> [[File:Ad2pi-iot-dia.png|thumb|API]]<br /> <br /> ==Official Raspbian Image==<br /> ===Changes from Raspbian===<br /> * Disabled serial console so that the device can use it.<br /> * Installed [http://github.com/nutechsoftware/ser2sock ser2sock] to expose the AlarmDecoder on your network.<br /> * Installed the [http://github.com/nutechsoftware/alarmdecoder AlarmDecoder Python library].<br /> * Installed and configured the [http://github.com/nutechsoftware/alarmdecoder-webapp AlarmDecoder Webapp] [[AlarmDecoder_WebApp|Instructions]].<br /> <br /> ===Download===<br /> {| class=&quot;wikitable&quot; border=&quot;1&quot;<br /> ! scope=&quot;col&quot; width=&quot;50px&quot; | Status<br /> ! scope=&quot;col&quot; width=&quot;100px&quot; | Link<br /> ! scope=&quot;col&quot; width=&quot;120px&quot; | Version<br /> ! scope=&quot;col&quot; width=&quot;220px&quot; | MD5<br /> ! scope=&quot;col&quot; width=&quot;250px&quot; | Includes<br /> |-<br /> | align=&quot;center&quot; style=&quot;background-color: #70BA66;&quot; | Stable<br /> | align=&quot;center&quot; | [http://www.alarmdecoder.com/downloads/pi/PIBAKERY-AD2PIBOOT-RASPBIAN-10-BUSTER-20190710B.ZIP Download]<br /> | align=&quot;center&quot; | Raspbian Buster 10 PiBakery build &lt;hr&gt;(Latest build 08/15/2019)<br /> | align=&quot;center&quot; | zip: e87cd27f18a5c07c1e2b75400a08c030 img: 5f3eb62b3862575f2604e41c9808672f<br /> | align=&quot;left&quot; | 2019-07-20 updated AlarmDecoder 1.13.8, AlarmDecoder-webapp 0.8.6, Added packages, Built using a [https://github.com/nutechsoftware/alarmdecoder-webapp/tree/master/contrib/PiBakery/ PiBakery recipe] See the AlarmDecoder [[PiBakery|PiBakery wiki page]].<br /> |-<br /> | align=&quot;center&quot; style=&quot;background-color: #d4ac0d;&quot; | Issues<br /> | align=&quot;center&quot; | [http://www.alarmdecoder.com/downloads/pi/PIBAKERY-AD2PIBOOT-RASPBIAN-10-BUSTER-20190710.ZIP Download]<br /> | align=&quot;center&quot; | Raspbian Buster 10 PiBakery build &lt;hr&gt;(Missing packages)<br /> | align=&quot;center&quot; | zip: e1190b702baf443ee73e6afb982e4fa7 img: 78e06d89dd41a13a288005dc000bee6c<br /> | align=&quot;left&quot; | 2019-07-20 updated AlarmDecoder 1.13.7, AlarmDecoder-webapp 0.8.4, Built using a [https://github.com/nutechsoftware/alarmdecoder-webapp/tree/master/contrib/PiBakery/ PiBakery recipe] See the AlarmDecoder [[PiBakery|PiBakery wiki page]].<br /> |-<br /> | align=&quot;center&quot; style=&quot;background-color: #70BA66;&quot; | Stable<br /> | align=&quot;center&quot; | [http://www.alarmdecoder.com/downloads/pi/PIBAKERY-AD2PIBOOT-RASPBIAN-9-STRETCH-20181015.ZIP Download]<br /> | align=&quot;center&quot; | Raspbian Stretch 9.0 PiBakery build<br /> | align=&quot;center&quot; | zip: cc7e267d2f3bd377a239b3ebc996f491 img: 275635f7ca7ad70e951bea1f68593c86<br /> | align=&quot;left&quot; | 2018-10-14 updated AlarmDecoder 1.13.4, AlarmDecoder-webapp 0.8.2, Built using a [https://github.com/nutechsoftware/alarmdecoder-webapp/tree/master/contrib/PiBakery/ PiBakery recipe] See the AlarmDecoder [[PiBakery|PiBakery wiki page]].<br /> |-<br /> | align=&quot;center&quot; style=&quot;background-color: #70BA66;&quot; | Stable<br /> | align=&quot;center&quot; | [http://www.alarmdecoder.com/downloads/pi/alarmdecoder-raspbian-2018-05-29.zip Download]<br /> | align=&quot;center&quot; | Raspbian Jessie 8.0<br /> | align=&quot;center&quot; | zip: 3a001426b1a3a2793bea589cfc93be39 img: c5e50da07e5d084ad76abd591ab605f2<br /> | align=&quot;left&quot; | 2018-05-29 updated AlarmDecoder 1.13.4, AlarmDecoder-webapp 0.8.2, Supports the Raspberry Pi Model B, B+ and B2, and B3. Wifi and Bluetooth are both functional on the Pi 3<br /> |}<br /> <br /> ==Manual Configuration==<br /> # Flash the SD card with your choice of OS as described [http://www.elinux.org/Rpi_easy_sd_card_setup here].<br /> #* Flashing tools quick pick<br /> #** Etcher https://www.balena.io/etcher/<br /> #** Rufus https://rufus.ie/<br /> # Boot up the Raspberry Pi.<br /> # Remove the following entries from &lt;tt&gt;/boot/cmdline.txt&lt;/tt&gt;:<br /> #* &lt;tt&gt;console=ttyAMA0,115200&lt;/tt&gt;<br /> #* &lt;tt&gt;kgdboc=ttyAMA0,115200&lt;/tt&gt;<br /> # Remove the following line from &lt;tt&gt;/etc/inittab&lt;/tt&gt;:<br /> #* &lt;tt&gt;T0:23:respawn:/sbin/getty -L ttyAMA0 115200 vt100&lt;/tt&gt;<br /> # Sync and halt your Raspberry Pi.<br /> # Attach the AD2PI.<br /> # Boot it up again.<br /> #* At this point you should be able to communicate with the device at &lt;tt&gt;/dev/ttyAMA0&lt;/tt&gt;.<br /> # Install any optional software ([http://github.com/nutechsoftware/ser2sock ser2sock], [http://github.com/nutechsoftware/alarmdecoder Python library], etc.)<br /> #* Add dev package needed for compiling ser2sock<br /> #** sudo apt-get install openssl-dev<br /> #* The AlarmDecoder WEB App install instructions are here<br /> #** https://github.com/nutechsoftware/alarmdecoder-webapp<br /> <br /> ==Default Passwords==<br /> ;Passwords should be changed once you get your device!<br /> ===SSH/Shell===<br /> ;Login: pi<br /> ;Password: raspberry<br /> ===AlarmDecoder WebApp===<br /> ;Login: admin<br /> ;Password: alarmdecoder<br /> ==AD2PI case assembly==<br /> ;[[File:case assembly doc.pdf|Case assembly]]</div> 204.10.16.14 http://www.alarmdecoder.com/wiki/index.php/Raspberry_Pi Raspberry Pi 2019-06-19T01:26:04Z <p>204.10.16.14: </p> <hr /> <div>__NOTOC__ <br /> [[Category:Documentation]]<br /> [[Category:Downloads]]<br /> [[Category:Advanced_Topics]]<br /> <br /> [[File:Ad2pi.png|thumb|AD2PI]]<br /> <br /> 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]].<br /> <br /> 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 to a 8g uSD disk or larger using a simple too such as [https://www.balena.io/etcher/ Etcher] or [https://rufus.ie/ Rufus] or following the instructions 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.<br /> <br /> [[File:pibplus.png|thumb|AD2PI Bundle]]<br /> [[File:Ad2pi-iot-dia.png|thumb|API]]<br /> <br /> ==Official Raspbian Image==<br /> ===Changes from Raspbian===<br /> * Disabled serial console so that the device can use it.<br /> * Installed [http://github.com/nutechsoftware/ser2sock ser2sock] to expose the AlarmDecoder on your network.<br /> * Installed the [http://github.com/nutechsoftware/alarmdecoder AlarmDecoder Python library].<br /> * Installed and configured the [http://github.com/nutechsoftware/alarmdecoder-webapp AlarmDecoder Webapp] [[AlarmDecoder_WebApp|Instructions]].<br /> <br /> ===Download===<br /> {| class=&quot;wikitable&quot; border=&quot;1&quot;<br /> ! scope=&quot;col&quot; width=&quot;50px&quot; | Status<br /> ! scope=&quot;col&quot; width=&quot;100px&quot; | Link<br /> ! scope=&quot;col&quot; width=&quot;120px&quot; | Version<br /> ! scope=&quot;col&quot; width=&quot;220px&quot; | MD5<br /> ! scope=&quot;col&quot; width=&quot;250px&quot; | Includes<br /> |-<br /> | align=&quot;center&quot; style=&quot;background-color: #70BA66;&quot; | Stable<br /> | align=&quot;center&quot; | [http://www.alarmdecoder.com/downloads/pi/PIBAKERY-AD2PIBOOT-RASPBIAN-9-STRETCH-20181015.ZIP Download]<br /> | align=&quot;center&quot; | Raspbian Stretch 9.0 PiBakery build<br /> | align=&quot;center&quot; | zip: cc7e267d2f3bd377a239b3ebc996f491 img: 275635f7ca7ad70e951bea1f68593c86<br /> | align=&quot;left&quot; | 2018-10-14 updated AlarmDecoder 1.13.4, AlarmDecoder-webapp 0.8.2, Built using a [https://github.com/nutechsoftware/alarmdecoder-webapp/tree/master/contrib/PiBakery/ PiBakery recipe] See the AlarmDecoder [[PiBakery|PiBakery wiki page]].<br /> |-<br /> | align=&quot;center&quot; style=&quot;background-color: #70BA66;&quot; | Stable<br /> | align=&quot;center&quot; | [http://www.alarmdecoder.com/downloads/pi/alarmdecoder-raspbian-2018-05-29.zip Download]<br /> | align=&quot;center&quot; | Raspbian Jessie 8.0<br /> | align=&quot;center&quot; | zip: 3a001426b1a3a2793bea589cfc93be39 img: c5e50da07e5d084ad76abd591ab605f2<br /> | align=&quot;left&quot; | 2018-05-29 updated AlarmDecoder 1.13.4, AlarmDecoder-webapp 0.8.2, Supports the Raspberry Pi Model B, B+ and B2, and B3. Wifi and Bluetooth are both functional on the Pi 3<br /> |}<br /> <br /> ==Manual Configuration==<br /> # Flash the SD card with your choice of OS as described [http://www.elinux.org/Rpi_easy_sd_card_setup here].<br /> #* Flashing tools quick pick<br /> #** Etcher https://www.balena.io/etcher/<br /> #** Rufus https://rufus.ie/<br /> # Boot up the Raspberry Pi.<br /> # Remove the following entries from &lt;tt&gt;/boot/cmdline.txt&lt;/tt&gt;:<br /> #* &lt;tt&gt;console=ttyAMA0,115200&lt;/tt&gt;<br /> #* &lt;tt&gt;kgdboc=ttyAMA0,115200&lt;/tt&gt;<br /> # Remove the following line from &lt;tt&gt;/etc/inittab&lt;/tt&gt;:<br /> #* &lt;tt&gt;T0:23:respawn:/sbin/getty -L ttyAMA0 115200 vt100&lt;/tt&gt;<br /> # Sync and halt your Raspberry Pi.<br /> # Attach the AD2PI.<br /> # Boot it up again.<br /> #* At this point you should be able to communicate with the device at &lt;tt&gt;/dev/ttyAMA0&lt;/tt&gt;.<br /> # Install any optional software ([http://github.com/nutechsoftware/ser2sock ser2sock], [http://github.com/nutechsoftware/alarmdecoder Python library], etc.)<br /> #* Add dev package needed for compiling ser2sock<br /> #** sudo apt-get install openssl-dev<br /> #* The AlarmDecoder WEB App install instructions are here<br /> #** https://github.com/nutechsoftware/alarmdecoder-webapp<br /> <br /> ==Default Passwords==<br /> ;Passwords should be changed once you get your device!<br /> ===SSH/Shell===<br /> ;Login: pi<br /> ;Password: raspberry<br /> ===AlarmDecoder WebApp===<br /> ;Login: admin<br /> ;Password: alarmdecoder<br /> ==AD2PI case assembly==<br /> ;[[File:case assembly doc.pdf|Case assembly]]</div> 204.10.16.14