Start of Normal Conversation ...............................................................................................................12
Normal Call Termination.......................................................................................................................12
APPENDIX A - LOG STATUS MESSAGES...............................................................................................14
APPENDIX B - ASCII CHARACTER CODES ............................................................................................16
2
TOA VS-900 Programmer’s Guide
Overview
Security system installations often require integration of the VS-900 Security Intercom systems with
touch-screen control systems, graphic annunciator panels, and camera controllers. TOA offers two
options for meeting this requirement:
1. The VS-900DI and VS-910DI interface products offer a hardware solution—they provide the call LED
outputs and select switch inputs required for graphic annunciator panels. They also provide relay outputs
for camera switcher integration. Using this off-the-shelf method requires no knowledge of computer
programming or serial communication.
2. The VS-900MF Mainframe has two integral serial ports for integration with a microprocessor-based
product (usually a PC or PLC) for remote control and monitoring of VS-900 activity. Serial communication
with the VS-900MF eliminates the need for installing VS-900DI and VS-910DI cards and elevates the
programmer's level of control.
This document targets programmers who need an understanding of how they can remote control and
monitor the VS-900 by communicating through its RS-232 ports.
Note: Descriptions of the protocol and all examples are written in hexadecimal (H). Appendix B includes a
chart for hex to decimal and ASCII conversion.
VS-900 Documentation
Please refer to the following VS-900 documents, shipped with the VS-900MF or available by request.
• VS-900 Installation Manual
• VS-900 Operating Instructions
• VS-900 Software Manual
Useful Software Tools
• MS Windows Calculator, usually located under Program Files\Accessories
• HyperTerminal Private Edition, available for download from http://www.hilgraeve.com
• ComLite32 Serial Com Port Monitor software available for download from http://www.rtcomm.com
3
TOA VS-900 Programmer’s Guide
Connecting to the VS-900MF Mainframe
The VS-900MF Mainframe includes two RS-232 serial communication connectors for operation,
monitoring, and programming of the system. Connect to either communication ports with the settings
described on page 5. You can control multiple exchanges from a single serial connection.
10HDelimiter
05HEnquiry
10HDelimiter
06HAcknowledge
10HDelimiter
02HStart of Text
VariesRemote Dial, Data Log
Request or Data Log
10HDelimiter
03HEnd of Text
VariesBlock Check Character
10HDelimiter
06HAcknowledge
10HDelimiter
04HEnd of Transmission
VS-900 to PC or
PC to VS-900
VS-900 to PC or
PC to VS-900
VS-900 to PC or
PC to VS-900
VS-900 to PC or
PC to VS-900
VS-900 to PC or
PC to VS-900
* See the Remote Dial, Log Data Request or Log Data sections for more information.
** To calculate BCC, take the XOR of the combined Message, DLE, and ETX. (Refer to the shaded area
below). MS Windows Calculator (Scientific mode) is a useful tool for this function.
DLESTX
MESSAGEDLEETXBCC
5
TOA VS-900 Programmer’s Guide
Remote Dial Command
With the protocol below, you can remote dial and perform functions of individual Master Stations in
specific exchanges. To terminate any current functions, precede remote dialing content with “CC” (Clear
function x2).
Field NameLength
(Bytes)
DLE
ENQ
DLE
ACK
DLE
STX
Command
"Remote Dial"
Exchange #
Master Station #
Dialing Contents*
DLE
ETX
BCC
DLE
ACK
DLE
EOT
110HDelimiter
105HEnquiry
110HDelimiter
106HAcknowledgement
110HDelimiter
102HStart Of Text
14EHRemote Dialing Command
2xxH, xxHAdd 30H to each digit of the exchange
1xxHMaster Station #2 = (32H)
32 Bytes
Total
110HDelimiter
103HEnd Of Text
1xxHBlock Check Character
110HDelimiter
106HAcknowledge
110HDelimiter
104HEnd of Transmission
ValueDescriptionDirection
PC to VS-900MF
VS-900MF to PC
number.
Example: Exchange #01 = (30H, 31H)
MS-900 Master Station Dialing
Functions:
30H0
31H1
32H2
33H3
34H4
35H5
36H6
37H7
38H8
39H9
2AH*
23H#
43HC (Clear)
57HOff-hook
51HOn-hook
45HPTT On
52HPTT Off
54HRegister Switch On
59HRegister Switch Off
58HTransfer
2DH3 Second dial pause (For C/O lines)
4FHDisable Master Station
50HEnable Master Station
Note: Add "20H" after the designated
dialing contents until the total is 32 bytes
PC to VS-900MF
VS-900MF to PC
PC to VS-900MF
6
TOA VS-900 Programmer’s Guide
Log Data Output Request
The VS-900 Log Data Output allows you to monitor most station and system activity. Send the string
below to initiate Log Data flow from individual or multiple exchanges simultaneously. Once the data
stream has been initiated, the VS-900MF will continue to send the log data without re-sending the
request.
Field NameLength
(Bytes)
DLE
ENQ
DLE
ACK
DLE
STX
Log Data
Request
Exchanges
ON/OFF Status
Exchange #01 –
16
DLE
ETX
BCC
DLE
ACK
DLE
EOT
After the initial Log Data Request, the VS-900MF will send an enquiry (DLE & ENQ, 10H & 05H) to the
PC when log data is available in the queue. The PC should then respond with an acknowledgement (DLE
& ACK, 10H & 06H) so the log data will be sent from the VS-900MF. This process will repeat until there is
no information left in log data queue.
110HDelimiter
105HEnquiry
110HDelimiter
106HAcknowledgement
110HDelimiter
102HStart Of Text
14FHLog Data Output Request command
230H 30H
1630H or 31H OFF = 30H ON = 31H
110HDelimiter
103HEnd Of Text
1xxHBlock Check Character
110HDelimiter
106HAcknowledge
110HDelimiter
104HEnd of Transmission
ValueDescriptionDirection
PC to VS-900MF
VS-900MF to PC
PC to VS-900MF
VS-900MF to PC
Field NameLength
(Bytes)
DLE
ENQ
DLE
ACK
DLE
STX
Log Data Sent
Exchange #
Time (HH:MM:SS)
Line #1
Line #2
Line #3
Line #4
*Status #
DLE
ETX
BCC
DLE
ACK
DLE
EOT
110HDelimiter
105HEnquiry
110HDelimiter
106HAcknowledge
110HDelimiter
102HStart Of Text
16FLog data
2xxH xxHExchange #01 – 16
6Hours, Minutes, and Seconds
6Varies, Refer to Appendix A
6Varies, Refer to Appendix A
6Varies, Refer to Appendix A
6Varies, Refer to Appendix A
2xxH xxHVaries, Refer to Appendix A
110HDelimiter
103HEnd Of Text
1xxHBlock Check Character
110HDelimiter
106HAcknowledge
110HDelimiter
104HEnd of Transmission
ValueDescriptionDirection
VS-900MF to PC
PC to VS-900MF
VS-90MF to PC
PC to VS-900MF
VS-900MF to PC
7
TOA VS-900 Programmer’s Guide
Examples
1. Remote Dialing
The data sequence below will remote dial Master Station #1 in Exchange #1 to dial Sub-Station #105 and
initiate communication. The “CC” (Clear) is included to terminate any current Master Station functions.
Note: The total Dialing Contents must be 32 bytes.
Field NameLength
(Bytes)
DLE
ENQ
DLE
ACK
DLE
STX
Remote Dial
Exchange #
Master Station #
Dialing Contents
DLE
ETX
BCC
DLE
ACK
DLE
EOT
110HDelimiter
105HEnquiry
110HDelimiter
106HAcknowledge
110HDelimiter
102HStart Of Text
14EHRemote Dialing
230H 31HEXCHANGE # "01"
131HMASTER # "1"
32 Bytes43H 43H 31H 30H 35H
110HDelimiter
103HEnd Of Text
179HBlock Check Character
110HDelimiter
106HAcknowledge
110HDelimiter
104HEnd of Transmission
The data sequence below will remote dial Master Station #2 in Exchange #3 to initiate All-Call Paging by
dialing *800#. Again, the “CC” (Clear) is included to terminate any current Master Station functions.
Note: The total Dialing Contents must be 32 bytes.
Field NameLength
(Bytes)
DLE
ENQ
DLE
ACK
DLE
STX
Remote Dial
Exchange #
Master Station #
Dialing Contents
DLE
ETX
BCC
DLE
ACK
DLE
EOT
110HDelimiter
105HEnquiry
110HDelimiter
106HAcknowledge
110HDelimiter
102HStart Of Text
14EHRemote Dialing Request
230H 33HEXCHANGE # "03"
132HMASTER # "2"
32 Bytes 43H 43H 2AH 38H 30H 30H
110HDelimiter
103HEnd Of Text
17DHBlock Check Character*
110HDelimiter
106HAcknowledge
110HDelimiter
104HEnd of Transmission
The data string below requests Log Data from Exchange #1 (only). After the Log Data Request has been
sent, the Log Data string will be sent to the PC in the format shown on the next page (Example 4. Log
Data Format).
Field NameLength
ValueDescriptionDirection
(Bytes)
DLE
ENQ
DLE
ACK
DLE
STX
Log Data
All Exchanges
ON/OFF Status
110HDelimiter
105HEnquiry
110HDelimiter
106HAcknowledge
110HDelimiter
102HStart Of Text
14FHLog Data Request
230H 30H
1631H 30H 30H 30H 30H 30H
30H 30H 30H 30H 30H 30H
Exchange #1 Log Data
31H = “On" 30H=”Off”
VS-900MF to PC
PC to VS-900MF
VS-900MF to PC
30H 30H 30H 30H
DLE
ETX
BCC
DLE
ACK
DLE
EOT
110HDelimiter
103HEnd Of Text
15DHBlock Check Character*
110HDelimiter
106HAcknowledge
110HDelimiter
104HEnd of Transmission
PC to VS-900MF
VS-900MF to PC
4. Log Data Format
This example illustrates five data strings that occur when “Normal” priority Sub-station #105 initiates a call
to Master Station #200 at 16:37:23.
Call From Normal Sub-station
Field NameLength
(Bytes)
DLE
ENQ
DLE
AC
DLE
STX
Log Data
Exchange #
Time (HH:MM:SS)
Line #1
Line #2
Line #3
Line #4
Status #
DLE
ETX
BCC
DLE
AC
DLE
EOT
110HDelimiter
105HEnquiry
110HDelimiter
106HAcknowledge
110HDelimiter
102HStart Of Text
16FHLog Data
230H 31HExchange # “01”
631H 36H 33H 37H 32H 33H Time: “16:37:23"
631H 30H 35H 20H 20H 20H Calling Station # “105”
632H 30H 30H 20H 20H 20H Called Station # “200”
620H 20H 20H 20H 20H 20H Not Used (Blank)
620H 20H 20H 20H 20H 20H Not Used (Blank)
230H 31H
110HDelimiter
103HEnd Of Text
178HBlock Check Character
110HDelimiter
106HAcknowledge
110HDelimiter
104HEnd of Transmission
ValueDescriptionDirection
VS-900 to PC
PC to VS-900
VS-900MF to PC
“01” (Call from Normal
Sub-station)
PC to VS-900
VS-900MF to PC
10
Station Call Reception
K
K
K
K
Field NameLength
(Bytes)
DLE
ENQ
DLE
AC
DLE
STX
Log Data
Exchange #
Time (HH:MM:SS)
Line #1
Line #2
Line #3
Line #4
Status #
DLE
ETX
BCC
DLE
AC
DLE
EOT
110HDelimiter
105HEnquiry
110HDelimiter
106HAcknowledge
110HDelimiter
102HStart Of Text
16FHLog Data
230H 31HExchange # “01”
631H 36H 33H 37H 32H 33H Time: “16:37:23"
632H 30H 30H 20H 20H 20H Master Station # “200”
620H 20H 20H 20H 20H 20H First Waiting station #
620H 20H 20H 20H 20H 20H Not Used (Blank)
620H 20H 20H 20H 20H 20H Not Used (Blank)
230H 35H
110HDelimiter
103HEnd Of Text
168HBlock Check Character
110HDelimiter
106HAcknowledge
110HDelimiter
104HEnd of Transmission
TOA VS-900 Programmer’s Guide
ValueDescriptionDirection
VS-900 to PC
PC to VS-900
(Blank)
“05” (Station call
reception)
VS-900MF to PC
PC to VS-900
VS-900MF to PC
Call Operation Completion
Field NameLength
(Bytes)
DLE
ENQ
DLE
AC
DLE
STX
Log Data
Exchange #
Time (HH:MM:SS)
Line #1
Line #2
Line #3
Line #4
Status #
DLE
ETX
BCC
DLE
AC
DLE
EOT
110HDelimiter
105HEnquiry
110HDelimiter
106HAcknowledge
110HDelimiter
102HStart Of Text
16FHLog Data
230H 31HExchange # “01”
631H 36H 33H 37H 32H 37H Time: “16:37:27"
632H 30H 30H 20H 20H 20H Master Station # “200”
631H 30H 35H 20H 20H 20H Called Station # “105”
620H 20H 20H 20H 20H 20H Not Used (Blank)
620H 20H 20H 20H 20H 20H Not Used (Blank)
230H 39H
110HDelimiter
103HEnd Of Text
174HBlock Check Character
110HDelimiter
106HAcknowledge
110HDelimiter
104HEnd of Transmission
ValueDescriptionDirection
VS-900 to PC
PC to VS-900
VS-900MF to PC
“09” (Call operation
completion)
PC to VS-900
VS-900MF to PC
11
Start of Normal Conversation
K
K
Field NameLength
(Bytes)
DLE
ENQ
DLE
ACK
DLE
STX
Log Data
Exchange #
Time
110HDelimiter
105HEnquiry
110HDelimiter
106HAcknowledge
110HDelimiter
102HStart Of Text
16FHLog Data
230H 31HExchange # “01”
631H 36H 33H 37H 32H
(HH:MM:SS)
Line #1
Line #2
Line #3
Line #4
Status #
DLE
ETX
BCC
DLE
ACK
DLE
EOT
632H 30H 30H 20H 20H
631H 30H 35H 20H 20H
620H 20H 20H 20H 20H
620H 20H 20H 20H 20H
231H 30H
110HDelimiter
103HEnd Of Text
174HBlock Check Character
110HDelimiter
106HAcknowledge
110HDelimiter
104HEnd of Transmission
TOA VS-900 Programmer’s Guide
ValueDescriptionDirection
VS-900 to PC
PC to VS-900
Time: “16:37:27"
37H
Calling Station # “200”
20H
Called Station # “105”
20H
VS-900MF to PC
Hold Station # (Blank)
20H
Not Used (Blank)
20H
“10” (Start of normal
conversation)
PC to VS-900
VS-900MF to PC
Normal Call Termination
Field NameLength
(Bytes)
DLE
ENQ
DLE
AC
DLE
STX
Log Data
Exchange #
Time (HH:MM:SS)
Line #1
Line #2
Line #3
Line #4
Status #
DLE
ETX
BCC
DLE
AC
DLE
EOT
110HDelimiter
105HEnquiry
110HDelimiter
106HAcknowledge
110HDelimiter
102HStart Of Text
16FHLog Data
230H 31HExchange # “01”
631H 36H 33H 37H 32H 38H Time: “16:37:28"
632H 30H 30H 20H 20H 20H Calling Station # “200”
631H 30H 35H 20H 20H 20H Called Station # “105”
620H 20H 20H 20H 20H 20H Not Used (Blank)
620H 20H 20H 20H 20H 20H Not Used (Blank)
233H 32H
110HDelimiter
103HEnd Of Text
173HBlock Check Character
110HDelimiter
106HAcknowledge
110HDelimiter
104HEnd of Transmission
ValueDescriptionDirection
VS-900 to PC
PC to VS-900
VS-900MF to PC
“32” (Normal call
termination)
PC to VS-900
VS-900MF to PC
12
Summarized version of the above Log Data Format example:
(Shaded areas represent responses required from the PC, all numbers are
in Hex)