EnvisaLink S5401D
DSC Compatible Serial Interface Module
Developer’s Guide Version 1.0
1
Table of Contents
1. Introduction .................................................................................................................3
2. Developing Applications .............................................................................................3
3. S5401D Module Serial Connection.............................................................................3
4. Communications Protocol ...........................................................................................4
5. Application Originated Commands.............................................................................5
6. S5401D Originated Commands...................................................................................7
7. Special USER/MASTER Code Requirements ............................................................9
8. Special Considerations For Some S5401D Commands ............................................10
9. S5401D Error Codes..................................................................................................11
NOTES ..........................................................................................................................12
2
1. Introduction
This manual describes the commands that are available to developers of third-party applications for DSC’s PowerSeries line of panels through the
S5401D Serial Interface Module.
For instructions on installing and setting up a S5401D module on a DSC PowerSeries panel, please see the S5401D Installation Instructions.
How to Use This Document
This document describes the commands available to developers of third-party applications through the
S5401D interface. For information on how to integrate these commands into your application, please refer to the documentation available for the
programming language you have used.
Please read through the introductory material on pages 1 and 2 for information about the S5401D interface, the command structure, and sample
transmissions. For information on each command, refer to the command tables on pages 3 to 7.
2. Developing Applications
You can incorporate S5401D API commands in any application that can send and receive hexadecimal ASCII codes.
When you are programming your application, you can use any of the API commands described in this Guide.
There are two types of commands available to you:
1. Commands which your application sends to the S5401D
2. Event-driven or State-Change commands which the S5401D sends to your application.
The S5401D API does not support handshaking. As a corollary to this the S5401D does not know if the application is active or not and the S5401D
does not buffer events, so if the application computer stops functioning any events occurring during that time will be overwritten.
3. S5401D Module Serial Connection
The S5401D module uses a serial cable to connect to the computer running your application. Refer to the S5401D Installation Instructions for more
information.
3
4. Communications Protocol
The module will communicate with the Application using the RS-232 interface (DB9 connector) on the board.
All data is sent as hex ASCII codes. The transmission from will consist of the following:
CCC DDD…DDD CKS CR/LF
CCC => 3 Digit Command
This tells the module or the application what to do. Commands are 3 characters long. For example, the Status Command (001) would
be sent as hex ASCII codes ‘30 30 31’. See the following tables for a list of supported commands.
DDD…DDD => Data Byte(s)
This is the data that may be needed for the command. For example, after the Partition Arm command (030), the application must
specify which partition should be armed (1-8). The following tables show what the data requirements are for each command. Some
commands, like the User Closing, have space holding zeros. In this case all 4 digits are sent even though this module ever uses only
two.
CKS => Checksum
The checksum is calculated by adding the hex value of all command and data digits, and truncating the result to 8 bits. The upper and
lower nibbles of the result are converted to ASCII characters before sending. For example, a Partition Alarm on partition 3 would be
sent like this:
The command and data fields contain: 6 5 4 3
The ASCII codes for this would be: 36 35 34 33
36 + 35 + 34 + 33 = D2. Since the result is already 8 bits we don’t have to worry about the length and simply send it.
Format Command Data Checksum CR/LF
Code 6 5 4 3 D 2 CR LF
ASCII 36 35 34 33 44 32 0D 0A
CR/LF => Carriage Return & Line Feed
Each transmission is followed with a carriage return (hex ASCII 0D) and a line feed (hex ASCII 0A) to indicate the end of a
transmission.
4
5. Application Originated Commands
Description Command
Poll
The S5401D will respond with a Command Acknowledge code.
Status Report
The S5401D will send updates for all general zone, partition, and trouble status
to the Application (Troubles will be limited to indicating the status of the
Trouble LED on a keypad). Only the partitions that have been detected, and
their trouble states, will be displayed. Please see section 6 for more
information. Note: When connected to a PC5020 the module will send the status
of all 64 zones, troubles and the status of enabled partitions only. For other
panels it will report the status of 32 zones, troubles and the status of enabled
partitions only.
Set Time & Date
The S5401D will change the time and date to that sent by the application.
Command Output Control
The S5401D will activate the selected Command Output
Partition Arm Control
The S5401D will attempt to arm the selected partition. The partition will be
armed in AWAY mode (no zones bypassed).
Partition Arm Control – Stay Arm
The S5401D will attempt to stay-arm the selected partition.
Partition Arm Control – Zero Entry Delay
The S5401D will attempt to arm the partition with zero entry delay.
Partition Arm Control – With Code
The S5401D will attempt to arm the selected partition by using a User Code.
This is equivalent to entering a User Code while the partition is in the Ready
mode.
Partition Disarm Control
The S5401D will attempt to disarm the selected partition.
This command can also be used to acknowledge alarms on a partition. Sending
the Partition Disarm command will silence any alarms as well as disarm the
partition.
Verbose Arming Control
Sending a ‘1’ (ON) will cause the S5401D to enter Verbose Arming mode
whereby the S5401D will append a mode character to the standard 652
(Partition Armed) command. For backwards compatibility the default state is
OFF.
Time Stamp Control
Sending a ‘1’ (ON) will cause the S5401D to prepend all S5401D commands
with an 8 digit timestamp followed by a single space (0x20). For backwards
compatibility the default state is OFF.
Time Broadcast Control
Sending a ‘1’ (ON) will cause the S5401D to periodically transmit system time
broadcasts (S5401D COMMAND 550). The default state is OFF.
Temperature Broadcast Control
Sending a ‘1’ (ON) will cause the S5401D to periodically transmit the interior
and exterior temperatures (S5401D COMMANDS 561,562). The default state is
OFF.
Trigger Panic Alarm
This command emulates the FAP (Fire, Ambulance, Police) panic keys on a
DSC keypad. Send this command, with 1, 2, or 3, will cause an immediate
alarm. This assumes the panel is properly programmed to allow such events to
5
# of Data
Bytes
000 0
001 0
010 10 hhmmMMDDYY
020 2
030 1 Partition (1-8)
031 1 Partition (1-8)
032 1 Partition (1-8)
033 7
040 7
050 1 On/Off (1,0)
055 1 On/Off (1,0)
056 1 On/Off (1,0)
057 1 On/Off (1,0)
060 1
Data Bytes
Partition (1-8)
Output (1-4)
Partition (1-8)
Code (4-6 digit)
Partition (1-8)
Code (4-6 digit)
1 = Fire
2 = Ambulance
3 = Police
occur.
Code Send
This command is used whenever there is a need to send a code. A command,
such as Command Output, will be sent to the module and the module will then
send command 900 to tell the user to enter an access code. The Code Send
command transfers this code.
NOTE: The code entered will be sent to the partition that sent the 900 request.
The S5401D remembers which partition the code request came from when
sending 200: Code Send.
200 4-6
Access Code
(4-6)
6
6. S5401D Originated Commands
Description Command
Command Acknowledge
A command has been received successfully
Command Error
A command has been received with a bad checksum
System Error
An error has been detected. See section 5.4 for a list of error codes
Time/Date Broadcast
Outputs the current security system time.
Ring Detected
The Panel has detected a ring on the telephone line. Note: This command will
only be issued if an ESCORT 5580 module is present.
Indoor Temperature Broadcast
If an ESCORT 5580TC is installed, and at least one ENERSTAT thermostat, this
command displays the interior temperature and the thermostat number.
NOTE: The three digit temperature is a decimal representation of a signed byte. (0
– 255) representing -127 to 127 degrees. MSB is sign bit.
Outdoor Temperature Broadcast
If an ESCORT 5580TC is installed, and at least one ENERSTAT thermostat with
an external temperature sensor, this command displays the exterior temperature
and the thermostat number.
NOTE: The three digit temperature is a decimal representation of a signed byte. (0
– 255) representing -127 to 127 degrees. MSB is sign bit.
Zone Alarm
A zone has gone into alarm
Zone Alarm Restore
A zone alarm has been restored
Zone Tamper
A zone has a tamper condition
Zone Tamper Restore
A zone tamper condition has been restored
Zone Fault
A zone has a fault condition
Zone Fault Restore
A zone fault condition has been restored
Zone Open
General status of the zone.
Zone Restored
General status of the zone.
Duress Alarm
A duress code has been entered on a system keypad
[F] Key Alarm
A Fire key alarm has been activated
[F] Key Restore
A Fire key alarm has been restored (sent automatically)
[A] Key Alarm
An Auxiliary key alarm has been activated
[A] Key Restoral
An Auxiliary key alarm has been restored (sent automatically)
[P] Key Alarm
A Panic key alarm has been activated
# of Data
Bytes
500 3
501 0
502 3
550 10
560 0
561 4
562 4
601 4
602 4
603 4
604 4
605 3 Zone (001-064)
606 3 Zone (001-064)
609 3 Zone (001-064)
610 3 Zone (001-064)
620 4
621 0
622 0
623 0
624 0
625 0
Data Bytes
Previous CMD
received
000-255
(error code)
HH:MM
MM/DD/YY
Thermostat (1-4)
Temperature
(XXX)
Thermostat (1-4)
Temperature
(XXX)
Partition(1-8)
Zone (001-064)
Partition(1-8)
Zone (001-064)
Partition(1-8)
Zone (001-064)
Partition(1-8)
Zone (001-064)
0000
cannot trace user
7
[P] Key Restore
A Panic key alarm has been restored (sent automatically)
2-Wire Smoke Alarm
A 2-wire smoke alarm has been activated
2-Wire Smoke Restore
A 2-wire smoke alarm has been restored
Partition Ready
Partition can now be armed (all zones restored, no troubles, etc). Also issued at
the end of Bell Timeout if the partition was READY when an alarm occurred.
Partition Not Ready
Partition cannot be armed (zones open, trouble present, etc)
Partition Armed
Partition has been armed – sent at the end of exit delay. Also issued at the end
of Bell Timeout if the partition was ARMED when an alarm occurred.
Partition Armed – Verbose Arming Enabled
Partition has been armed – sent at the end of exit delay
Also sent after an alarm if the Bell Cutoff Timer expires
Mode is appended to indicate whether the partition is armed AWAY, STAY,
ZERO-ENTRY-AWAY, or ZERO-ENTRY-STAY.
Partition In Alarm
A partition is in alarm
Partition Disarmed
A partition has been disarmed
Will not be displayed on PC5580 panels with an alarm in memory.
Exit Delay in Progress
A partition is in Exit Delay
Entry Delay in Progress
A partition is in Entry Delay
Keypad Lock-out
A partition is in Keypad Lockout due to too many failed user code attempts.
Invalid Access Code
An access code that was entered was invalid
Function Not Available
A function that was selected is not available
User Closing
A partition has been armed by a user – sent at the end of exit delay
Special Closing
A partition has been armed by one of the following methods:
Quick Arm, Auto Arm, Keyswitch, DLS software, Wireless Key
Partial Closing
A partition has been armed but one or more zones have been bypassed.
User Opening
A partition has been disarmed by a user
Special Opening
A partition has been disarmed by one of the following methods:
Keyswitch, DLS software, Wireless Key
Panel Battery Trouble
The panel has a low battery
Panel Battery Trouble Restore
The panel’s low battery has been restored
Panel AC Trouble
AC power to the panel has been removed
Panel AC Restore
AC power to the panel has been restored
System Bell Trouble
An open circuit has been detected across the bell terminals
626 0
631 0
632 0
650 1 Partition (1-8)
651 1 Partition (1-8)
652 1 Partition (1-8)
652 2
654 1 Partition (1-8)
655 1 Partition (1-8)
656 1 Partition (1-8)
657 1 Partition (1-8)
658 1 Partition (1-8)
670 1 Partition (1-8)
671 1 Partition (1-8)
700 5
701 1 Partition (1-8)
702 1 Partition (1-8)
750 5
751 1 Partition (1-8)
800 0
801 0
802 0
803 0
806 0
Partition (1-8)
Mode (0,1,2,3)
Partition (1-8)
User (0001-0042)
Partition (1-8)
User (0001-0042)
8
System Bell Trouble Restoral
The bell trouble has been restored
TLM Trouble
The phone line is a open or shorted condition
TLM Trouble Restore
The phone line trouble condition has been restored
FTC Trouble
The panel has failed to communicate successfully to the monitoring station
Buffer Near Full
Sent when the panel’s Event Buffer is 75% full from when it was last uploaded
to DLS
Device Low Battery
A wireless zone has a low battery
Device Low Battery Restore
The low battery condition on a wireless zone has been restored
General System Tamper
A tamper has occurred with one of the following modules:
Zone Expander, PC5132, PC5204, PC5208, PC5400, PC59XX, LINKS 2X50,
PC5108L, PC5100, PC5200.
General System Tamper Restore
A general system Tamper has been restored.
Trouble LED On
This command shows the general trouble status that the trouble LED on a
keypad normally shows. Sent when there is a trouble present on system
Trouble LED Off
This command shows the general trouble status that the trouble LED on a
keypad normally shows. Sent when there is no troubles on system
Fire Trouble Alarm
Fire Trouble Alarm Restore
Code Required
This command will tell the S5401D to enter an access code. Once entered, the
200 command will be sent to perform the required action. The code should be
entered within the window time of the panel.
NOTES:
1) It is possible that when using a PC5020 (Power 864) panel, the very first command after power-up of the S5401D will show incorrect
partition information if that command displays the partition. This is due to a limitation in the method the S5401D uses to detect which
type of panel it is connected to. If partition information is critical, the installer should open and close a zone to clear this condition prior
to leaving the installation.
2) For commands 621 through 626 the partition will always be zero.
807 0
810 0
811 0
814 0
816 0
821 3 Zone (001-064)
822 3 Zone (001-064)
829 0
830 0
840 1 Partition (1-8)
841 1 Partition (1-8)
842 0
843 0
900 0
7. Special USER/MASTER Code Requirements
Some S5401D commands will require a user code in order to execute. An example would be command output (CMD 020). The S5401D
does not know of the code requirement a priori. So if a code is required by the panel, the S5401D will issue a 900 command to indicate to
the application that a 4-6 digit code must be entered.
Arming, disarming and functions that require codes to execute should follow this simple protocol.
1. Select the function (arm, disarm, output) by sending the appropriate command.
2. If a code is required, the S5401D will send command 900.
3. The application must then respond with command 200 containing a valid user code.
If no code is required there will be no need for command 200. The application will have the panel’s time window for entering the
access code. If a command 200 is issued to the S5401D outside of the panel’s window, it is ignored. Maintenance codes are not
supported by the S5401D.
9
8. Special Considerations For Some S5401D Commands
While almost all the commands the S5401D issues are event driven, that is to say they are issued in response to either some API
command or some event within the scope of the security system, not all are. Some commands simply reflect the status of certain
systems and therefore are only issued when a change of state is encountered. For example, command 650 tells the API that that the
indicated partition is READY. Because this is really state information, it is only sent when the partition state transitions from another
state, i.e. PARTITION_IN_ALARM, to the READY state. This also applies to Zone states.
The specific commands are:
609, 610, 650, 651, 652, 654, 655, 656, 657, 670, and 671
Also it should be noted that it is very important for the Bell Timer Output to be programmed for longer duration than any other timer
(e.g. Entry Delay, Exit Delay, Keypad Lockout Timer etc.)
Some Loss-Of-Power Considerations
It must be noted that upon power-up, the S5401D is not immediately aware of state of all the partitions, nor the zones. It is only when
the S5401D detects a change in the state that it will know the true state and issue the appropriate change-of-state command listed above.
Particular attention must be paid to the output of the API Command 001 (STATUS) as the state information it presents may be
erroneous if the S5401D has recently been added to the security system bus. It is because the S5401D has not seen a state transition yet
and therefore must report the default state for both partitions, and zones; READY and CLOSED respectively. As well, partition
information may not be displayed if the S5401D has not detected a partition status change for that partition. Once again, these issues
are only relevant for a short period (< 5 minutes) after the S5401D has been added to the system bus.
It should also be noted that some commands are configuration commands for the S5401D module such as:
010, 050, 055, 056, 057
These options will be cleared if power is lost to the module and need to be reloaded by the application. It is recommended that the
application periodically reload these values to ensure consistent operation.
10
9. S5401D Error Codes
00 No Error
01 RS-232 Receive Buffer Overrun (a command is received while another is still being processed)
02 RS-232 Receive Buffer Overflow
10 Keybus Transmit Buffer Overrun
11 Keybus Transmit Time Timeout
12 Keybus Transmit Mode Timeout
13 Keybus Transmit Keystring Timeout
14 Keybus Not Functioning (the S5401D cannot communicate with the security system)
15 Keybus Busy (Attempting to Disarm or Arm with user code)
16 Keybus Busy – Lockout (The panel is currently in Keypad Lockout – too many disarm attempts)
17 Keybus Busy – Installers Mode (Panel is in installers mode, most functions are unavailable)
18 Keybus Busy – General Busy (The partition requested is busy)
20 API Command Syntax Error
21 API Command Partition Error (Requested Partition is out of bounds)
22 API Command Not Supported
23 API System Not Armed (sent in response to a disarm command)
24 API System Not Ready to Arm (system is either busy, or already armed)
25 API Command Invalid Length
26 API User Code not Required
27 API Invalid Characters in Command (no alpha characters are allowed except for checksum)
11
NOTES
12
Loading...