Black Box ACX048, ACXC8, ACXC64, ACX080, ACXC16 Interface Manual
...
Application Programming Interface (API) Manual
DKM FX and DKM FX Compact
Order toll-free in the U.S.: Call 877-877-BBOX (outside U.S. call 724-746-5500)
FREE technical support 24 hours a day, 7 days a week: Call 724-746-5500 or fax
724-746-0746 • Mailing address: Black Box Corporation, 1000 Park Drive, Lawrence,
PA 15055-1018 • Web site: www.blackbox.com • E-mail: info @blackbox.com
Customer
Support
Information
ACX048 ACXC8 ACXC64
ACX080 ACXC16 ACXC80
ACX160 ACXC32 ACXC48F16
ACX288 ACXC48 ACXC48F32
Page 2
724-746-5500 | blackbox.com
ACX048 API manual
Trademarks Used in this Manual
Trademarks Used in this Manual
Black Box and the Double Diamond logo are registered trademarks of BB
Technologies, Inc.
TOSLINK is a registered trademark of Kabushiki Kaisha Toshiba dba Toshiba
Corporation.
Any other trademarks mentioned in this manual are acknowledged to be
the property of the trademark owners.
Page 3
724-746-5500 | blackbox.com
ACX048 API manual
FCC and IC RFI Statements and NOM Statement
FEDERAL COMMUNICATIONS COMMISSION AND
INDUSTRY CANADA RADIO FREQUENCY INTERFERENCE STATEMENTS
This equipment generates, uses, and can radiate radio-frequency energy,
and if not installed and used properly, that is, in strict accordance with the
manufacturer’s instructions, may cause inter ference to radio communication.
It has been tested and found to comply with the limits for a Class A computing
device in accordance with the specifications in Subpart B of Part 15 of FCC rules,
which are designed to provide reasonable protection against such interference
when the equipment is operated in a commercial environment. Operation of
this equipment in a residential area is likely to cause interference, in which case
the user at his own expense will be required to take whatever measures may be
necessary to correct the interference.
Changes or modifications not expressly approved by the party responsible
for compliance could void the user’s authority to operate the equipment.
This digital apparatus does not exceed the Class A limits for radio noise
emis sion from digital apparatus set out in the Radio Interference Regulation
of Industry Canada.
Le présent appareil numérique n’émet pas de bruits radioélectriques dépassant les
limites applicables aux appareils numériques de la classe A prescrites dans le
Règlement sur le brouillage radioélectrique publié par Industrie Canada.
Normas Oficiales Mexicanas (NOM)
Electrical Safety Statement
INSTRUCCIONES DE SEGURIDAD
1. Todas las instrucciones de seguridad y operación deberán ser leídas antes
de que el aparato eléctrico sea operado.
2. Las instrucciones de seguridad y operación deberán ser guardadas para
referencia futura.
3. Todas las advertencias en el aparato eléctrico y en sus instrucciones de
operación deben ser respetadas.
4. Todas las instrucciones de operación y uso deben ser seguidas.
Page 4
724-746-5500 | blackbox.com
ACX048 API manual
NOM Statement
4. Todas las instrucciones de operación y uso deben ser seguidas.
5. El aparato eléctrico no deberá ser usado cerca del agua—por ejemplo,
cerca de la tina de baño, lavabo, sótano mojado o cerca de una alberca,
etc.
6. El aparato eléctrico debe ser usado únicamente con carritos o pedestales
que sean recomendados por el fabricante.
7. El aparato eléctrico debe ser montado a la pared o al techo sólo como sea
recomendado por el fabricante.
8. Servicio—El usuario no debe intentar dar servicio al equipo eléctrico más allá
lo descrito en las instrucciones de operación. Todo otro servicio deberá ser
referido a personal de servicio calificado.
9. El aparato eléctrico debe ser situado de tal manera que su posición no
interfiera su uso. La colocación del aparato eléctrico sobre una cama, sofá,
alfombra o superficie similar puede bloquea la ventilación, no se debe
colocar en libreros o gabinetes que impidan el flujo de aire por los orificios
de ventilación.
10. El equipo eléctrico deber ser situado fuera del alcance de fuentes de calor
como radiadores, registros de calor, estufas u otros aparatos (incluyendo
amplificadores) que producen calor.
11. El aparato eléctrico deberá ser connectado a una fuente de poder sólo del
tipo descrito en el instructivo de operación, o como se indique en el
aparato.
12. Precaución debe ser tomada de tal manera que la tierra fisica y la
polarización del equipo no sea eliminada.
13. Los cables de la fuente de poder deben ser guiados de tal manera que no
sean pisados ni pellizcados por objetos colocados sobre o contra ellos,
poniendo particular atención a los contactos y receptáculos donde salen
del aparato.
14. El equipo eléctrico debe ser limpiado únicamente de acuerdo a las
recomendaciones del fabricante.
15. En caso de existir, una antena externa deberá ser localizada lejos de las
lineas de energia.
Page 5
724-746-5500 | blackbox.com
ACX048 API manual
NOM Statement
16. El cable de corriente deberá ser desconectado del cuando el equipo no sea
usado por un largo periodo de tiempo.
17. Cuidado debe ser tomado de tal manera que objectos liquidos no sean
derramados sobre la cubierta u orificios de ventilación.
18. Servicio por personal calificado deberá ser provisto cuando:
A: El cable de poder o el contacto ha sido dañado; u
B: Objectos han caído o líquido ha sido derramado dentro del aparato; o
C: El aparato ha sido expuesto a la lluvia; o
D: El aparato parece no operar normalmente o muestra un cambio en su
desempeño; o
E: El aparato ha sido tirado o su cubierta ha sido dañada.
Page 6
724-746-5500 | blackbox.com
ACX048 API manual
Table of Contents
Table of Contents
1. About this Manual .....................................................................................9
1.1 S cope .................................................................................................9
1.2 Validity ...............................................................................................9
1.3 Cautions and Notes ...........................................................................9
2. Safety Instructions ...................................................................................10
3. Overview .................................................................................................11
3.1 Description .......................................................................................11
3.2 Access Options ................................................................................11
3.3 System Overview .............................................................................11
3.4 Product Range .................................................................................12
3.5 Device Views ...................................................................................13
3.5.1 DKM FX 288-Port ..................................................................13
3.5.2 DKM FX 160-Port ..................................................................14
3.5.3 DKM FX 80-Port ....................................................................15
3.5.4 DKM FX 48-Port ....................................................................15
3.5.5 DKM FX Compact 48-Port ....................................................16
3.5.6 DKM FX Compact 32-Port .....................................................16
3.5.7 DKM FX Compact 16-Port .....................................................17
3.6 Status LEDs ........................................................................................18
4. Installation ...............................................................................................20
4.1 What’s Included ...............................................................................20
4.2 System Setup ...................................................................................20
5. Configuration ..........................................................................................21
5.1 General Remarks .............................................................................21
5.2 DKM FX or DKM FX Compact Configuration ..................................21
5.2.1 System Data ...........................................................................21
5.2.2 Network.................................................................................23
5.3 Communication Setup .....................................................................26
5.4 Telegram Structure ...........................................................................27
5.4.1 Request ..................................................................................27
5.4.2 Response ...............................................................................27
5.5 Constraints.......................................................................................27
Page 7
724-746-5500 | blackbox.com
ACX048 API manual
Table of Contents
6. Operation ............................................................................................28
6.1 System Requests ..............................................................................28
6.2 Switch Commands ...........................................................................29
6.2.1 Switch Off All Ports .............................................................29
6.2.2 Get CPU Device Connected to CON Device.........................29
6.2.3 Set CPU Device Connection to CON Device ........................30
6.2.4 Get CPU Devices Connected to CON Devices ......................30
6.2.5 Set Connections of CPU Devices to CON Devices ................31
6.2.6 Get CON Device Connected to CPU Device.........................32
6.2.7 Set CON Device Connection to CPU Device ........................33
6.2.8 Get CON Devices Connected to CPU Devices ......................33
6.2.9 Set Connection of CON Devices to CPU Devices .................34
6.2.10 Set CON Device Connection to CPU Device
(Single Bidirectional Connection—KVM Full Access) ...........35
6.2.11 Set Connection of CON Devices to CPU Devices
(Multiple Bidirectional Connections—Full Access) ...............36
6.2.12 Get All Connections ............................................................36
6.2.13 Set Connection for All CON Devices and CPU Devices ........38
6.2.14 Set Extended Connection ....................................................39
6.3 Assignments ....................................................................................39
6.3.1 Get Virtual CON Device .......................................................39
6.3.2 Set Virtual CON Device to a Real CON Device .................... 40
6.3.3 Get Real CPU Device ...........................................................41
6.3.4 Set Real CPU Devices to a Virtual CPU Device .....................41
6.3.5 Get Virtual CON Devices .....................................................42
6.3.6 Set Virtual CON Devices to Real CON Devices .....................43
6.3.7 Get Real CPU Devices ..........................................................43
6.3.8 Set Real CPU Devices .......................................................... 44
6.4 Best Practice ....................................................................................45
6.4.1 Full Access (Establishing a KVM Connection) ......................45
6.4.2 Video Access (Establishing a Video-Only Connection) .........45
6.4.3 Private Access (Establishing an Exclusive KVM Session) ...... 46
6.4.4 USB 2.0 Access (Establishing a USB 2.0 Data Connection) . 46
7. Specifications ...........................................................................................47
7.1 System Requests ............................................................................. 48
7.2 Switch Commands ...........................................................................49
7.2.1 Switch Off All Ports .............................................................49
7.2.2 Get CPU Device Connected to CON Device.........................50
7.2.3 Set CPU Device Connection to CON Device ........................51
Page 8
724-746-5500 | blackbox.com
ACX048 API manual
Table of Contents
7.2.4 Get CPU Devices Connected to CON Devices ......................52
7.2.5 Set Connections of CPU Devices to CON Devices ................54
7.2.6 Get CON Device Connected to CPU Device.........................55
7.2.7 Set CON Device Connection to CPU Device ........................56
7.2.8 Get CON Devices Connected to CPU Devices ......................57
7.2.9 Set Connection of CON Devices to CPU Devices .................58
7.2.10 Set CON Device Connection to CPU Device (Bidirectional) . . 59
7.2.11 Set Connection of CON Devices to CPU Devices
(Bidirectional) .......................................................................60
7.2.12 Get All Connections ............................................................61
7.2.13 Set Connection for All CON Devices and CPU Devices ........63
7.2.14 Set Extended Connection ....................................................65
7.3 Assignments ....................................................................................66
7.3.1 Get Virtual CON Device .......................................................66
7.3.2 Set Virtual CON Device to a Real CON Device .....................67
7.3.3 Get Real CPU Device ...........................................................68
7.3.4 Set Real CPU to a Virtual CPU .............................................69
7.3.5 Get Virtual CON Devices .....................................................70
7.3.6 Set Virtual CON Devices to Real CON Devices .....................72
7.3.7 Get Real CPU Device ...........................................................73
7.3.8 Set Real CPU Devices ...........................................................75
7.4 Connector Pinouts ...........................................................................76
8. Troubleshooting .......................................................................................77
8.1 Network Error ..................................................................................77
8.2 Failure at the Matrix .........................................................................77
9. Technical Support ....................................................................................78
10. Glossary .......................................................................................79
Page 9
724-746-5500 | blackbox.com
ACX048 API manual
Chapter 1: About this Manual
1. About This Manual
1.1 Scope
This manual describes how to install your DKM FX API, how to operate it, and
how to perform troubleshooting.
1.2 Validity
This manual is valid for all devices listed on the front page. The product code is
printed on the base of the devices.
1.3 Cautions and Notes
The following conventions are used in this manual:
WARNING or CAUTION: This indicates an important operating instruction that
should be followed to avoid any potential damage to hardware or property, loss
of data, or personal injury.
NOTE: This indicates important information to help you make the best use of this
product.
Page 10
724-746-5500 | blackbox.com
ACX048 API manual
Chapter 2: Safety Instructions
2. Safety Instructions
For reliable and safe long-term operation of your DKM FX, follow these guidelines:
Installation
• Only use in dry, indoor environments.
• The DKM FX and the power supply units can get warm. Don’t put them in an
enclosed space without any airflow.
• Do not obscure ventilation holes.
• Only use power supplies originally supplied with the product or
manufacturer-approved replacements. Do not use a power supply if it appears to
be defective or has a damaged case.
• Connect all power supplies to grounded outlets. In each case, make sure that the
ground connection is maintained from the outlet socket to the power supply’s AC
power input.
• Do not connect the link interface to any other equipment, particularly network or
telecommunications equipment.
• Only connect devices to the serial interface that are sufficiently secured against
short circuits and false voltages at the serial interface.
• To disconnect the switch from the power supply, remove the power cord cables
of all power supply units that are in use or set the power switch (if available)
to the OFF position.
• Take any required ESD precautions.
Repair
• Do not attempt to open or repair a power supply unit.
• Do not attempt to open or repair the DKM FX or DKM Compact. There are no
user-serviceable parts inside.
• Contact Black Box Technical Support at 724-746-5500 or info@blackbox.com
if there is a fault.
Page 11
724-746-5500 | blackbox.com
ACX048 API manual
Chapter 3: Overview
3. Overview
3.1 Description
The DKM FX API is used to control the matrix externally by serial commands via
serial (RS-232) or network (TCP/IP) connection.
The DKM FX API provides the full scope of switching functionality. It does not
support the configuration of a DKM FX system.
3.2 Access Options
You have the following options to access the DKM FX for
external serial control:
Table 3-1. Access options.
Access option Symbol
Serial interface
TCP/ IP Interface
NOTE: Both serial interface and TCP/IP interface use the same commands for the
operation of the DKM FX matrix.
3.3 System Overview
A DKM FX matrix can be connected to an external serial control via the CPU
board and its connectors.
The CPU board provides the possibility for both serial and TCP/IP connections.
The serial connection to an external serial control is established by using a serial
cable with DB9 connectors or a DB9-to-RJ-45 adapter cable (DKM FX Compact).
The TCP/IP connection is established by using a CATx network cable.
Page 12
724-746-5500 | blackbox.com
ACX048 API manual
Chapter 3: Overview
Figure 3-1 shows the system overview. Table 3-2 describes its components.
Figure 3-1. System overview (exemplary).
Table 3-2. System components.
Number Component
1 DKM FX matrix
2 Serial connection cable (DB9 or DB9-to-RJ- 45 adapter cable)
3 External serial control (RS-232, Option 1)
4 Network connection cable (CATx)
5 External serial control (TCP/ IP, Option 2)
3.4 Product Range
Table 3-3. Available products.
Number Description
DKM FX and DKM FXC-API
ACX-API DKM FX matrix application programming interface (API )
Page 13
724-746-5500 | blackbox.com
ACX048 API manual
Chapter 3: Overview
3.5 Device Views
In Sections 3.5.1 through 3.5.7, Figures 3-2 through 3-8 illustrate the DKM FX and
DKM FX Compact chassis serial and TCP/IP connectors. Tables 3-4 through 3-10
describe these components.
3.5.1 DKM FX 288-Port
2
1
Figure 3-2. Front view, ACX288.
Table 3-4. ACX288 components.
Number Component
1 Serial connector (DB9)
2 TCP/IP connector (RJ-45)
Page 14
724-746-5500 | blackbox.com
ACX048 API manual
Chapter 3: Overview
3.5.2 DKM FX 160-Port
2
1
Figure 3-3. Front view, ACX160.
Table 3-5. ACX160 components.
Number Component
1 Serial connector (DB9)
2 TCP/IP connector (RJ-45)
Page 15
724-746-5500 | blackbox.com
ACX048 API manual
Chapter 3: Overview
3.5.3 DKM FX 80-Port
1 2
Figure 3-4. Front view, ACX080.
Table 3-6. ACX080 components.
Number Component
1 Serial connector (DB9)
2 TCP/IP connector (RJ-45)
3.5.4 DKM FX 48-Port
1 2
Figure 3-5. Front view, ACX048.
Table 3-7. ACX048 components.
Number Component
1 Serial connector (DB9)
2 TCP/IP connector (RJ-45)
Page 16
724-746-5500 | blackbox.com
ACX048 API manual
Chapter 3: Overview
3.5.5 DKM FX Compact 48-Port
1 2
Figure 3-6. Front view, ACXC48.
Table 3-8. ACXC48 components.
Number Component
1 Serial connector (RJ-45)
2 TCP/IP connector (RJ-45)
3.5.6 DKM FX Compact 32-Port
1 2
Figure 3-7. Front view, ACXC32.
Table 3-9. ACXC32 components.
Number Component
1 Serial connector (RJ-45)
2 TCP/IP connector (RJ-45)
Page 17
724-746-5500 | blackbox.com
ACX048 API manual
Chapter 3: Overview
3.5.7 DKM FX Compact 16-Port
1 2
Figure 3-8. Front view, ACXC16.
Table 3-10. ACXC16 components.
Number Component
1 Serial connector (RJ-45)
2 TCP/IP connector (RJ-45)
Page 18
724-746-5500 | blackbox.com
ACX048 API manual
Chapter 3: Overview
3.6 Status LEDs
The DKM FX and DKM FX Compact Status LED indicators are shown in Figure 3-9
and described in Table 3-11.
Figure 3-9. CPU board, front view.
Page 19
724-746-5500 | blackbox.com
ACX048 API manual
Chapter 3: Overview
Table 3-11. Status LEDs on the CPU board.
Number LED Status Description
1 Status 1
White CPU board is in registration process
Blue flashing Registration at the matrix is started
Red flashing Registration is in progess
Green flashing Operating condition
Green CPU board de-registered
2
TCP/IP
Status 1
Red Operating condition
Off No connection
3
TCP/IP
Status 2
Green flashing Active data traffic
Off No active data traffic
4 Status 2
White CPU board is in registration process
Red flashing Registration at the matrix is started
Off Operating condition
NOTE: Because of variations in the LED type, “white” may also appear as light
purple or light blue.
Page 20
724-746-5500 | blackbox.com
ACX048 API manual
Chapter 4: Installation
4. Installation
4.1 What’s Included
Your package contains the following items. If anything is missing or damaged,
contact Black Box Technical Support at 724-746-5500 or info@blackbox.com.
4.2 System Setup
NOTE: If you are a first-time user, we recommend that you set up the system
in the same room as a test setup. This will allow you to identify and solve
any cabling problems, and experiment with your system more conveniently.
Setup of the external control
1. Install the CPU and I/O boards.
2. Connect the keyboard, mouse, and monitor to the CPU board of the DKM FX.
3. Connect the matrix to the power supply.
4. Open OSD via hotkey and log in with administrator rights in the main menu.
5. Configure initially as requested.
6. Connect the external control either via RS-232 or TCP/IP to the matrix.
Page 21
724-746-5500 | blackbox.com
ACX048 API manual
Chapter 5: Configuration
5. Configuration
5.1 General Remarks
The DKM FX API provides all commands that are necessary to switch the DKM FX
matrix.
5.2 DKM FX Configuration
To operate the DKM FX or DKM FX Compact matrix, it has to be configured
appropriately. In the following section, all relevant chapters from the DKM FX and
DKM FX Compact manual (main manual) are described. For a detailed
explanation, refer to the the main manual.
5.2.1 System Data
The DKM FX API relevant system configuration is set in this menu.
You can access the menu via OSD or Java:
Figure 5-1. OSD and Java icons.
You can select between the following DKM FX API relevant settings:
Table 5-1. API relevant settings.
Field Selection Description
Enable
COM
Echo
activated
Send all performed switching commands in the matrix as an echo via serial
interface.
deactivated Function not active (default).
Enable
LAN Echo
activated
Send all performed switching commands in the matrix as an echo via LAN
interface.
NOTE: This function should be enabled when using a media control via TCP/
IP connection.
deactivated Function not active (default).
Page 22
724-746-5500 | blackbox.com
ACX048 API manual
Chapter 5: Configuration
OSD
Select Configuration > System in the main menu.
NOTE: The serial interface can be blocked while the OSD is open.
Figure 5-2. Menu Configuration—System.
You can select between the following buttons:
Table 5-2. Button functions.
Number Component
Cancel Reject changes
Save Save changes
Page 23
724-746-5500 | blackbox.com
ACX048 API manual
Chapter 5: Configuration
Java Tool
Select System > System Data in the main menu.
Figure 5-3. Menu System—System Data.
5.2.2 Network
The DKM FX API relevant network configuration is set in this menu.
You can access the menu via OSD or Java:
Figure 5-4. OSD and Java icons.
Page 24
724-746-5500 | blackbox.com
ACX048 API manual
Chapter 5: Configuration
You can select between the following DKM FX API relevant settings:
Table 5-3. API relevant settings.
Field Selection Description
DHCP
activated The network settings are automatically supplied by a DNS server (default).
deactivated Function not active.
IP address Byte Input of the IP address in the form “192.168.1.1”, if DHCP is not active.
Subnet
mask
Byte Input of the subnet mask in the form “255.255.255.0”, if DHCP is not active.
Gateway Byte Input of the IP address in the form “192.168.1.1”, if DHCP is not active.
Tech
Support
activated
LAN interface at the DKM FX activated for access via Java tool (TCP/IP port
5555).
deactivated Function not active.
FTP server
activated FTP server for transmission of configuration files activated.
deactivated Function not active.
NOTE: To activate the modified network parameters, restart the API.
CAUTION: Consult your system administrator before modifying the network
parameters. Otherwise, unexpected network results and failures can
occur.
OSD
Select Configuration > Network in the main menu.
NOTE: The serial interface can be blocked while the OSD is open.
Page 25
724-746-5500 | blackbox.com
ACX048 API manual
Chapter 5: Configuration
Figure 5-5. Menu Configuration—Network.
You can select between the following buttons:
Table 5-4. Button functions.
Number Component
Cancel Reject changes
Save Save changes
Java Tool
Select System > Network in the task area.
Figure 5-6. Menu System – Network
Page 26
724-746-5500 | blackbox.com
ACX048 API manual
Chapter 5: Configuration
5.3 Communication Setup
TCP/IP socket connection
To control the DKM FX via TCP/IP socket connection, the Service has to be activated. See Chapter 2.6.4, Network Status and Chapter 4.4.5, Network in the DKM
FX and DKM FX Compact manual for more information.
Java code example
// Create socket connection
Socket socket = new Socket("192.168.100.108", 5555);
final InputStream is = socket.getInputStream();
// Switch off all ports, Command: ESC [ A
final OutputStream os = socket.getOutputStream();
os.write(0x1B); // ESC
os.write(0x5B); // [
os.write(0x41); // A
o s.f lu s h();
if (is.read() == 0x06) {
// acknowledged
}
is.c l ose();
os.close();
s o c k et.c l o se();
Loading...