Thinklogical TLX Series, TLX12, TLX48, TLX80, TLX160 Product Manual
...
®
TLX Matrix Switch ASCII API V5 ii Rev. I, January 2019
Copyright Notice
Copyright © 2019. All rights reserved. Printed in the U.S.A.
Thinklogical, A BELDEN BRAND
100 Washington Street
Milford, Connecticut 06460 U.S.A.
Telephone: 1-203-647-8700
All trademarks and service marks are property of their respective owners.
Subject: Product Manual: TLX Matrix Switch ASCII API V5
Revision: I, January 2019
®
®
TLX Matrix Switch ASCII API V5 iii Rev. I, January 2019
Table of Contents
PREFACE................................................................................................................................................ 1
About Thinklogical® ...................................................................................................................... 1
About This Manual ....................................................................................................................... 2
Note and Warning Symbols ...................................................................................................... 2
Font Conventions Used in this Manual ..................................................................................... 2
REGULATORY & SAFETY REQUIREMENTS ........................................................................................ 3
Symbols Found on Our Products .................................................................................................. 3
Regulatory Compliance ................................................................................................................ 3
North America .......................................................................................................................... 3
Australia & New Zealand .......................................................................................................... 4
European Union ....................................................................................................................... 4
Declaration of Conformity ..................................................................................................... 4
Standards with Which Our Products Comply ............................................................................................ 4
Supplementary Information .......................................................................................................... 4
OVERVIEW ............................................................................................................................................. 5
API Version 4 Commands That Were Modified in Version 5 ......................................................... 5
Uni-directional vs. Bi-directional ................................................................................................... 5
CONVENSIONS ................................................................................................................................ ...... 5
Port Numbers ............................................................................................................................... 5
Results ......................................................................................................................................... 6
COMMANDS ........................................................................................................................................... 6
CONNECTION COMMANDS ......................................................................................................... 6
Connect ........................................................................................................................................ 6
Disconnect ................................................................................................................................... 7
Macro ........................................................................................................................................... 7
XPUT ........................................................................................................................................... 8
STATUS COMMANDS ................................................................................................................... 8
STATUS ....................................................................................................................................... 8
XSTATUSIO and XSTATUSOI ..................................................................................................... 9
XGET ........................................................................................................................................... 9
SYSTEM INFORMATION COMMANDS ........................................................................................ 9
XVERSION ................................................................................................................................... 9
XINSTALLED ............................................................................................................................. 10
XMAXCARDS* ........................................................................................................................... 10
Table 1: XMAXCARDS Return Values .................................................................................. 10
XMAXPORTS ............................................................................................................................. 10
XCTIME...................................................................................................................................... 11
XTYPE**..................................................................................................................................... 11
XLASTEVENT ............................................................................................................................ 12
XPORTCONFIG ......................................................................................................................... 12
XRESET ..................................................................................................................................... 12
XALARM .................................................................................................................................... 12
XQUIT ........................................................................................................................................ 12
XCRON and XCROFF ................................................................................................................ 12
XOPTIONS ................................................................................................................................. 13
XHELP ................................................................ ....................................................................... 14
* Modified from Version 4
** New to Version 5
®
TLX Matrix Switch ASCII API V5 iv Rev. I, January 2019
DIAGNOSTIC COMMANDS......................................................................................................... 15
XTEST1...................................................................................................................................... 15
XTEST2...................................................................................................................................... 15
XTEST3...................................................................................................................................... 15
TLX MATRIX SWITCH PORT NUMBERING ......................................................................................... 16
The TLX12.....................................................................................................................................16
The TLX24…………………………………………………………………………………………………16
The TLX48 ................................................................................................................................. 16
The TLX80 ................................................................................................................................. 17
The TLX160 ............................................................................................................................... 17
The TLX320 ............................................................................................................................... 17
The TLX640 ............................................................................................................................... 18
The TLX1280 ............................................................................................................................. 19
Error and Status Codes.................................................................................................................20
Product Serial Number ........................................................................................................................... 20
Connection to the Product ...................................................................................................................... 20
THINKLOGICAL® SUPPORT ................................................................................................................ 21
CUSTOMER SUPPORT .................................................................................................................. 21
Website ...................................................................................................................................... 21
Email .......................................................................................................................................... 21
Telephone .................................................................................................................................. 21
Fax ................................................................................................ ............................................. 21
PRODUCT SUPPORT ..................................................................................................................... 22
Warranty..................................................................................................................................... 22
Return Authorization ................................................................................................................... 22
Our Addresses ........................................................................................................................... 22
APPENDIX A: Switch Status Broadcast ............................................................................................. 23
APPENDIX B: Sample Commands ...................................................................................................... 23
APPENDIX C: Connecting Extenders ................................................................................................. 24
APPENDIX D: Point-to-Point Connection Mode ................................................................................. 26
MADE IN USA
TLX Matrix Switch ASCII API V5 1 Rev. I, January 2019
Preface
About Thinklogical A BELDEN BRAND
Thinklogical, A BELDEN BRAND, is the leading manufacturer and provider of fiber-optic and CATx
video, KVM, audio, and peripheral extension and switching solutions used in video-rich, big-data
computing environments.
Thinklogical offers the only fiber-optic KVM matrix switches in the world that are
accredited to the Common Criteria EAL4, TEMPEST SDIP 24 Level B, and NATO NIAPC
Evaluation Scheme: GREEN and the U.S. DoD DISA JITC UCR 2013 APL information
assurance standards. And Thinklogical Velocity products are the first system with both
KVM and video matrix switching capabilities to be placed on the Unified Capabilities
Approved Product List (UC APL) under the Video Distribution System (VDS) category.
Thinklogical products are designed and manufactured in the USA and are certified to the
ISO 9001:2015 standard.
Thinklogical is headquartered in Milford, Connecticut and is owned by Belden, Inc., St. Louis, MO
(http://www.belden.com). For more information about Thinklogical products and services, please
visit www.thinklogical.com.
®
TLX Matrix Switch ASCII API V5 2 Rev. I, January 2019
About This Manual
This document describes the command set used to control Thinklogical's TLX series of Matrix
Switches. The TLX Matrix Switch API commands are based on the command set used by our VX
Matrix Switches and are detailed in the document: Matrix_Switch_ASCII_API.
• 5.00-A Initial release (created from the VX Matrix Switch version of this manual: V4.5-1 Rev E)
Note and Warning Symbols
Throughout this manual, you will notice certain symbols that bring your attention to important
information. These are Notes and Warnings. Examples are shown below.
Note: Important Notes appear in blue text preceded by a yellow exclamation point
symbol, as shown here.
A note is meant to call the reader’s attention to helpful or important information at a point in the text
that is relevant to the subject being discussed.
Warning! All Warnings appear in red text, followed by blue text, and preceded by a red
stop sign, as shown here.
A warning is meant to call the reader’s attention to critical information at a point in the text that is
relevant to the subject being discussed.
Font Conventions Used in this Manual
The following fonts and colors are used throughout this document to help differentiate between file
names, commands, outputs and document names (lower- & upper-case letter o and zero, shown
right):
Filenames Font: Courier New - 35-35-22 oO0
Linux Command Entered by the User Font: Consolas - 196-89-17 oO0
Output from a Command Font: Consolas – 0-128-128 oO0
Document_Name* Font: Georgia – 83-129-53 oO0
* These and other documents may be found on our ftp site:
ftp://ftp.thinklogical.com/TLxSwitch/Documentation/
or on our web site:
http://www.thinklogical.com/user_manuals
BEFORE STARTING ANY PROCEDURE, IT IS RECOMMENDED
THAT YOU READ THE INSTRUCTIONS THOROUGHLY!
®
TLX Matrix Switch ASCII API V5 3 Rev. I, January 2019
Regulatory & Safety Compliance
Class 1 Laser Information
TL
X Matrix Switches, like all Thinklogical® fiber-optic products, are designed and identified as
Class 1 LASER
products.
This means the maximum permissible exposure (MPE) cannot be exceeded when viewing the
laser with the naked eye or with the aid of typical magnifying optics (e.g. telescope or microscope).
Symbols Found on Our Products
Markings and labels on our products follow industry-standard conventions. Regulatory markings found on our
products comply with all required domestic and many international requirements.
Regulatory Compliance
Thinklogical’s® products are designed and made in the U.S.A. These products have been tested by a certified
testing laboratory and found compliant with the following standards for both domestic USA and many
international locations:
North America
Safety
UL 62368-1:2014Ed.2
CSA C22.2#62368-1:2014Ed.2
LASER Safety
CDRH 21 CFR 1040.10
Class 1 LASER Product
Canadian Radiation Emitting Devices Act, REDR C1370
IEC 60825:2001 Parts 1 and 2
Class 1 LASER Product
Electromagnetic Interference
FCC 47CFR Part 15 Subpart B: 2013 Class A
Industry Canada ICES-003: 2016 Ed. 6
SFP
Modules
Fiber-Optic
Cables
Class 1 Lasers
CLASS 1 LASERS do not require any special
precautions under conditions of normal use.
®
TLX Matrix Switch ASCII API V5 4 Rev. I, January 2019
Australia & New Zealand
This is a Class A product. In a domestic environment this product may cause radio interference, in which case
the user may be required to take corrective action.
European Union
Declaration of Conformity
Manufacturer’s Name & Address: Thinklogical, A BELDEN BRAND
100 Washington Street
Milford, Connecticut 06460 USA
Thinklogical’s products comply with the requirements of the Low Voltage Directive 2006/95/EC, the EMC
Directive 2004/108/EC, the RoHS Directive 2011/65/EU, the WEEE Directive 2012/19/EU and carry the
markings accordingly.
Standards with Which Our Products Comply
Safety
IEC 62368-1:2014Ed.2+C1
CB Scheme Certificate
Electromagnetic Emissions
CENELEC EN 55022:2010 +AC:2011
Electromagnetic Immunity
EN 55024:2011+A1
CENELEC EN 55032:2015
EN61000-3-2:2000 Harmonics
EN61000-3-3:2008 Flicker
EN 61000-4-2:2009 Electro-Static Discharge Test
EN 61000-4-3:2006 A1:2008, A2:2010 Radiated Immunity Field Test
EN 61000-4-4:2004 Electrical Fast Transient Test
EN 61000-4-5:2006 Power Supply Surge Test
EN 61000-4-6:2009 Conducted Immunity Test
EN61000-4-11:2004 Voltage Dips & Interrupts Test
Supplementary Information
The following statements may be appropriate for certain geographical regions and might not apply to your
location:
• This Class A digital apparatus meets all requirements of the Canadian Interference-Causing Equipment
Regulations. Cet appareil numérique de la classe A respecte toutes les exigencies du
Règlement sur le matérial brouilleur du Canada.
• This is a Class A product. In a domestic environment, this product may cause radio interference, in which
case the user may be required to take corrective action.
• This equipment has been tested and found compliant with the limits for a Class A digital device, pursuant to
part 15 of the FCC Rules. These limits are designed to provide reasonable protection against harmful
interference when the equipment is operated in a commercial environment. This equipment generates, uses
and can radiate radio frequency energy and, if not installed and used in accordance with the instruction
manual, may cause harmful interference to radio communications in which case the user may be required
to make adequate corrective measures at their own expense.
• This Class A digital apparatus complies with Canadian ICES-003 and has been verified as compliant within
the Class A limits of the FCC Radio Frequency Device Rules (FCC Title 47, Part 15, Subpart B CLASS A),
measured to CISPR 22: 1993 limits and methods of measurement of Radio Disturbance Characteristics of
Information Technology Equipment.
The user may notice degraded audio performance in the presence of electro-magnetic fields
.
®
TLX Matrix Switch ASCII API V5 5 Rev. I, January 2019
Overview
This document describes the command set used to control Thinklogical's TLX series of Matrix
Switches. The commands are all ASCII based and are terminated with either a linefeed character or
a carriage-return/linefeed pair. Port numbers are all 4 digits in length and filled with leading zeros
(Example: port 12 is encoded as 0012).
The TLX Matrix Switch API commands are based on the command set used by our VX Matrix Switch
product line and detailed in the document: Matrix_Switch_ASCII_API.
API Version 4 Commands That Were Modified in Version 5
The following commands were modified in Version 5 of the API.
• XDCSTYPE Renamed XTYPE
• XMAXCARDS Returns the maximum number of I/O cards, not half the maximum.
Uni-directional vs. Bi-directional
As used in this document, uni-directional is a connection that is made in only one direction,
from an input to an output. Note that an input may be directed to multiple outputs at one time. The
direction refers to data flow between a transmitter and a receiver or between a receiver and a
transmitter (a backchannel).
Some of our VX Matrix Switches have the capability to create two connections at one time, creating a
bi-directional connection. Bi-directional connections are still possible with TLX Series Matrix Switches
(and in most cases necessary for the correct operation of the switch) but must be created by issuing
two uni-directional commands. The TLX Series Matrix Switches are considered unidirectional devices.
Note: API commands shown in this manual are depicted in UPPER-CASE. This is for
clarity purposes only. The latest API allows commands to be in upper or lower case. Bit 2
(0x04) of the XOPTIONS status result is set to a 1 if the Switch requires upper-case
commands. This bit is there for the instances where a control system must interface with
different models and vintages of our Switches.
This manual reflects version V5.07.02 of the ASCII API.
Conventions
Port Numbers
▪ All port numbers are four places long, begin with 1 and have leading zeros. For example, port 15 is
encoded as 0015.
▪ A port number of 4 zeros is used in response to a status command to signify that no port is in use.
A “zero” port number is not valid in a command string.
▪ A port number of four 9s (9999) in used to signify ALL ports. It is not valid in a response.
For example, to encode all output ports, use: O9999
▪ In the following sections, xxxx is used as a generic input port place holder; yyyy is used as the
output port place holder.
Note: Do not use xxxx or yyyy in a command! Replace each with the appropriate input or
output port number.
Loading...