Page 1
Order toll-free in the U.S.: Call 877-877-BBOX (outside U.S. call 724-746-5500) Customer FREE technical support 24 hours a day, 7 days a week: Call 724-746-5500 or fax Support 724-746-0746 • Mailing address: Black Box Corporation, 1000 Park Drive, Lawrence, Information PA 15055-1018 • Web site: www.blackbox.com • E-mail: info@blackbox.com...
Page 2
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
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.
Page 4
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.
Page 5
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.
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...
Page 7
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...
Page 8
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...
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.
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.
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.
Network connection cable (CATx) 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 12 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 Figure 3-2. Front view, ACX288.
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 18 724-746-5500 | blackbox.com ACX048 API manual...
Page 19
Chapter 3: Overview Table 3-11. Status LEDs on the CPU board. Number Status Description White CPU board is in registration process Blue flashing Registration at the matrix is started Status 1 Red flashing Registration is in progess Green flashing Operating condition Green CPU board de-registered Operating condition...
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.
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.
Page 22
Chapter 5: Configuration 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...
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
Input of the subnet mask in the form “255.255.255.0”, if DHCP is not active. mask Gateway Byte Input of the IP address in the form “192.168.1.1”, if DHCP is not active. LAN interface at the DKM FX activated for access via Java tool (TCP/IP port activated Tech 5555). Support deactivated Function not active.
Page 25
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 25 724-746-5500 | blackbox.com ACX048 API manual...
5.3 Communication Setup TCP/IP socket connection To control the DKM FX via TCP/IP socket connection, the Service has to be activat- ed. 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.
Chapter 5: Configuration Serial connection To establish the serial communication to the DKM FX, set the format for serial data transmission to the following parameters:. 115.2K, 8, 1, NO (115.2 KBAUD, 8 data bits, 1 stop bit, no parity) 5.4 Telegram Structure 5.4.1 Request...
Chapter 6: Operation 6. Operation The DKM FX API can be addressed in two different ways: 1. Telegrams via serial connection. 2. Telegrams via TCP/IP socket connection. Both connections accept the same telegrams. Available telegrams support system requests, switch commands, and assignments.
Chapter 6: Operation 6.2 Switch Commands 6.2.1 Switch Off All Ports Request Telegram: ESC [ A Description: Switch off all ports. Example: Switch off all ports 0x1B 0x5B 0x41 Response <ACK> [<ECHO>] or <NAK> [ ] = Optional elements 6.2.2 Get CPU Device Connected to CON Device Request Telegram ESC [ H Size ConId...
Chapter 6: Operation Example: Return CPU device (CpuId = 1012) connected to CON device (ConId = 3017). 0x1B 0x5D 0x48 0x09 0x00 0xC9 0x0B 0xF3 0x03 or <NAK> 6.2.3 Set CPU Device Connection to CON Device Request Telegram ESC [ I Size ConId CpuId Description Set CPU device connection (input) to CON device (output).
Chapter 6: Operation Example Return CON device (ConId = 3017) connected to CPU device (CpuId = 1012). 0x1B 0x5D 0x4C 0x09 0x00 0xF4 0x03 0xC9 0x0B or <NAK> 6.2.7 Set CON Device Connection to CPU Device Request Telegram ESC [ M Size CpuId ConId Description Set CON device (input) connection to CPU device (output).
Chapter 6: Operation 6.2.11 Set Connection of CON Devices to CPU Devices (Multiple Bidirectional Connections—Full Access) Request Telegram ESC [ Q Size Cnt <CpuId, ConId>[1] … <CpuId, ConId>[Cnt] Description Set connection of CON devices (input) to CPU devices (output) and CPU devices (input) to CON devices (output).
Page 37
Chapter 6: Operation Example Get all CPU device – CON device connections. 0x1B 0x5B 0x52 Response Telegram ESC ] R Size CpuCnt ConCnt <CpuId, ConId>[1] … <CpuId, ConId>[ CpuCnt] <ConId, CpuId>[1] … <ConId, CpuId>[ ConCnt] Description Return all CPU device–CON device connections in pairs. For each defined CPU device, the ConId of the connected CON device will be added, or 0 if the CPU device is disconnected.
Chapter 6: Operation 6.2.13 Set Connection for All CON Devices and CPU Devices Request Telegram ESC [ S Size CpuCnt ConCnt <CpuId, ConId>[1] … <CpuId, ConId>[ CpuCnt] <ConId, CpuId>[1] … <ConId, CpuId>[ ConCnt] Description Set a connection for all defined CON devices and CPU devices. For each defined CPU device, add the ConId, or 0 if the CPU device is disconnected.
Chapter 6: Operation 6.2.14 Set Extended Connection Request Telegram ESC [ b Size CpuId ConId Mode Description Set CON device (input) connection to CPU device (output) and CPU device (input) connection to CON device (output). Data of CON device (USB, audio, …) is transmitted to a CPU device. Data of CPU device (video, USB, audio, …) is transmitted to a CON device.
Chapter 6: Operation 0x1B 0x5B 0x54 0x07 0x00 0xC9 0x0B Response Telegram ESC ] T Size RConId VConId Description Return virtual CON device of a real CON device. RConId ID of real CON device VConId ID of virtual CON device Example Return virtual CON device (VConId = 4034) of a real CON device (RConId = 3017).
Chapter 6: Operation 6.3.3 Get Real CPU Device Request Telegram ESC [ V Size VcpuId Description Get real CPU device of a virtual CPU device. VCpuId ID of virtual CPU device Example Get real CPU device of a virtual CPU device (VCpuId = 2018). 0x1B 0x5B 0x56 0x07 0x00 0xE2 0x07 Response Telegram...
Chapter 6: Operation Example Set real CPU device (RCpuId = 1012) to a virtual CPU device (VCpuId = 2018). 0x1B 0x5B 0x57 0x09 0x00 0xE2 0x07 0xF4 0x03 Response <ACK> [<ECHO>] or <NAK> [ ] = Optional elements 6.3.5 Get Virtual CON Devices Request Telegram ESC [ X Size ConCnt RConId[1] …...
Chapter 6: Operation Description Get real CPU devices of virtual CPU devices. For CpuCnt = 0, all virtual CPU devices with assignments to virtual CPU devices will be returned. CpuCnt Number of CPU device VCpuId[ ] List of IDs of virtual CPU devices Example Get real CPU devices of virtual CPU devices (VCpuId = 2018, 2030, 2035).
Chapter 6: Operation Description Set real CPU devices to virtual CPU devices. CpuCnt Number of CPU devices <VCpuId, RCpuId>[ ] List of Pairs of VCpuId and RCpuId Example Set real CPU devices to virtual CPU devices. VCpuId[1] = 2018, RCpuId[1] = 1012; VCpuId[2] = 2030, RCpuId[2] = 1013;...
Chapter 6: Operation 6.4.3 Private Access (Establishing an Exclusive KVM Session) Set CON device connection to CPU device and CPU device connection to CON device, CpuId = 1012 and ConId = 3017: 0x1B 0x5B 0x62 0x0B 0x00 0xF4 0x03 0xC9 0x0B 0x02 0x00 Disconnect: 0x1B 0x5B 0x62 0x0B 0x00 0xF4 0x03 0x00 0x00 0x02 0x00 6.4.4 USB 2.0 Access (Establishing a USB 2.0 Data Connection)
Chapter 7: Specifications 7. Specifications The DKM FX can be controlled via RS-232 serial interface or TCP/IP socket (Port 5555). Table 7-1. Telegram structure. Type Bytes Description Control character Always: ESC (0x1B) Server identification Identification of service Command A special command...
Chapter 7: Specifications Table 7-2. Sequence of a data communication. DKM FX Matrix Control CPU — Sending a command Acquiring a command, processing — a command, blocking of further commands a) Errors occurred: <NAK> b) No errors <ACK> — c) Optional: <ECHO>...
Chapter 7: Specifications 7.2.2 Get CPU Device Connected to CON Device Request: Telegram ESC [ H Size ConId General description: Get CPU device (input) connected to CON device (output). Table 7-6. Get system time. Type Bytes Description Hex Coding Control character 0x1B Server identification 0x28...
Chapter 7: Specifications 7.2.3 Set CPU Device Connection to CON Device Request: Telegram ESC [ I Size ConId CpuId General description: Set CPU device connection (input) to CON device (output). Input data of CPU device (video, USB, audio, …) will be transmitted to CON device.
Chapter 7: Specifications 7.2.4 Get CPU Devices Connected to CON Devices Request: Telegram ESC [ J Size ConCnt ConId[1] … ConId[ConCnt] General description: Get CPU devices (input) connected to CON device (output). For ConCnt = 0, all CON devices will be returned. Table 7-9.
Page 53
Chapter 7: Specifications Table 7-10. Get CPU devices (input) connected to CON devices (output). Type Bytes Description Hex Coding Control character 0x1B Server identification 0X5D Command 0x4A e.g. for ConCnt = 3 Size Total length of telegram (7 Bytes + data) 0x13 0x00 ConCnt Number of CON devices...
Chapter 7: Specifications 7.2.5 Set Connections of CPU Devices to CON Devices Request: Telegram ESC [ K Size ConCnt <ConId, CpuId>[1] … <ConId, CpuId>[ConCnt] General description: Set connections of CPU devices (input) to CON devices (output). Data of CPU (video, USB, audio, …) will be transmitted to CON device. Table 7-11.
Chapter 7: Specifications 7.2.6 Get CON Device Connected to CPU Device Request: Telegram ESC [ L Size CpuId General description: Get CON device (input) connected to CPU device (output). Table 7-12. Get CON device connected to CPU device. Type Bytes Description Hex Coding Control character...
Chapter 7: Specifications Example: Return CON device (ConId = 3017) connected to CPU device (CpuId = 1012). 0x1B 0x5D 0x4C 0x09 0x00 0xF4 0x03 0xC9 0x0B or <NAK> 7.2.7 Set CON Device Connection to CPU Device Request: Telegram ESC [ M Size CpuId ConId General description: Set CON device (input) connection to CPU device (output).
Chapter 7: Specifications 7.2.8 Get CON Devices Connected to CPU Devices Request: Telegram ESC [ N Size CpuCnt CpuId[1] … CpuId[CpuCnt] General description: Get CON devices (input) connected to CPU devices (output). For CpuCnt = 0, all CPU devices will be returned. Table 7-15.
Chapter 7: Specifications Table 7-16. Return CON devices (input) connected to CPU devices (output). Type Bytes Description Hex Coding Control character 0x1B Server identification 0X5B Command 0x4E e.g. for CpuCnt = 3 Size Total length of telegram (7 Bytes + data) 0x13 0x00 CpuCnt Number of CPU devices...
Chapter 7: Specifications Table 7-17. Set connection CON devices (input) to CPU devices (output). Type Bytes Description Hex Coding Control character 0x1B Server identification 0X5B Command 0x4F e.g. for CpuCnt = 3 Size Total length of telegram (7 Bytes + data) 0x13 0x00 CpuCnt Number of CPU devices...
Chapter 7: Specifications Table 7-18. Set CON device (input) connection to CPU device (output) and CPU device (input) connection to CON device (output). Type Bytes Description Hex Coding Control character 0x1B Server identification 0X5B Command 0x50 Size Total length of telegram (9 bytes) 0x09 0x00 CpuId ID of CPU device...
Chapter 7: Specifications Table 7-19. Set connection of CON devices to CPU devices (bidirectional). Type Bytes Description Hex Coding Control character 0x1B Server identification 0X5B Command 0x51 Size Total length of telegram (7 bytes + data) 0x09 0x00 e.g. for Cnt = 3 Size of list 0x13 0x00 CpuId...
Page 62
Chapter 7: Specifications Example: Get all CPU device–CON device connections 0x1B 0x5B 0x52 Response: Telegram ESC ] R Size CpuCnt ConCnt <CpuId, ConId>[1] … <CpuId, ConId>[ CpuCnt] <ConId, CpuId>[1] … <ConId, CpuId>[ ConCnt] General description: Return all CPU device–CON device connections in pairs. For each defined CPU device, the ConId of the connected CON device will be added, or 0 if the CPU device is disconnected.
Page 64
Chapter 7: Specifications Table 7-22. Set a connection for all defined CON devices and CPU devices. Type Bytes Description Hex Coding Control character 0x1B Server identification 0X5B Command 0x53 e.g. for CpuCnt = 3 Size Total length of telegram (9 bytes + data) ConCnt = 2 0x15 0x00 e.g.
Chapter 7: Specifications 7.2.14 Set Extended Connection Request: Telegram ESC [ b Size CpuId ConId Mode General description: Set CON device (input) connection to CPU device (output) and CPU device (input) connection to CON device (output). Data of CON device (USB, audio, …) is transmitted to a CPU device. Data of CPU device (video, USB, audio, …) is transmitted to a CON device.
Chapter 7: Specifications 7.3 Assignments 7.3.1 Get Virtual CON Device Request: Telegram ESC [ T Size RConId General description: Get virtual CON device of a real CON device. Table 7-24. Get virtual CON device of a real CON device. Type Bytes Description Hex Coding...
Chapter 7: Specifications Example: Return virtual CON device (VConId = 4034) of a real CON device (RConId = 3017). 0x1B 0x5B 0x54 0x09 0x00 0xC9 0x0B 0xC2 0x0F or <NAK> 7.3.2 Set Virtual CON Device to a Real CON Device Request: Telegram ESC [ U Size RConId VConId General description:...
Chapter 7: Specifications 7.3.3 Get Real CPU Device Request: Telegram ESC [ V Size VCpuId General description: Get real CPU device of a virtual CPU device. Table 7-27. Get real CPU device of a virtual CPU device. Type Bytes Description Hex Coding Control character 0x1B...
Chapter 7: Specifications Example: Return real CPU device (RCpuId = 1012) of a virtual CPU device (VCpuId = 2018). 0x1B 0x5D 0x56 0x09 0x00 0xE2 0x07 0xF4 0x03 or <NAK> 7.3.4 Set Real CPU to a Virtual CPU Request: Telegram ESC [ W Size VCpuId RCpuId General description: Set real CPU device to a virtual CPU device.
Chapter 7: Specifications 7.3.5 Get Virtual CON Devices Request: Telegram ESC [ X Size ConCnt RConId[1] … RConId[ConCnt] General description: Get virtual CON devices of a real CON device. For ConCnt = 0, all real CON devices with assignments to virtual CON devices will be returned.
Page 71
Chapter 7: Specifications Table 7-31. Return virtual CON devices of a real CON device as pairs. Type Bytes Description Hex Coding Control character 0x1B Server identification 0X5D Command 0x58 e.g. for ConCnt = 3 Size Total length of telegram (7 bytes) + data 0x13 0x00 ConId Number of CON device...
Chapter 7: Specifications 7.3.6 Set Virtual CON Devices to Real CON Devices Request: Telegram ESC [ Y Size ConCnt <RConId, VConId>[1] … <RConId, VConId>[ConCnt] General description: Set virtual CON devices to real CON devices. Table 7-32. Set virtual CON devices to real CON devices. Type Bytes Description...
Chapter 7: Specifications 7.3.7 Get Real CPU Device Request: Telegram ESC [ Z Size CpuCnt VCpuId[1] … VCpuId[CpuCnt] General description: Get real CPU devices of virtual CPU devices. For CpuCnt = 0, all virtual CPU devices with assignments to virtual CPU devices will be returned.
Page 74
Chapter 7: Specifications Table 7-34. Return real CPU devices of virtual CPU devices as pairs. Type Bytes Description Hex Coding Control character 0x1B Server identification 0X5D Command 0x5A e.g. for CpuCnt = 3 Size Total length of telegram (7 bytes + data) 0x13 0x00 CpuCnt Number of CPU devices...
Chapter 7: Specifications 7.3.8 Set Real CPU Devices Request: Telegram ESC [ a Size CpuCnt <VCpuId, RCpuId>[1] … <VCpuId, RCpuId>[CpuCnt] General description: Set real CPU devices to virtual CPU devices. Table 7-35. Set real CPU devices to virtual CPU devices. Type Bytes Description...
Chapter 7: Specifications 7.4 Connector Pinouts Table 7-36. DB9 connector. Picture Signal Color Signal Not connected Not connected — — Table 7-37. RJ-45 connector. Picture Signal Color Signal Not connected Not connected Not connected Not connected Table 7-38. RJ-45 connector (serial). Picture Signal Color...
Chapter 8: Troubleshooting 8. Troubleshooting In Chapters 8–9, support for problems with the DKM FX API is provided. If you have problems with the involved devices, especially the DKM matrix, refer to the respective device manuals. 8.1 Network Error Diagnosis: Network settings are not accepted after editing.
Chapter 9: Technical Support 9. Technical Support Before contacting technical support, please ensure you have read this manual, and then installed and set up your DKM FX as recommended. Contact Black Box Technical Support at 724-746-5500 or info@blackbox.com. Support Checklist To efficiently handle your request it is necessary to provide us with complete information for support and problem cases.
Composite Video: The Composite Video is also called CVBS and it is part of the PAL TV standard. CON Unit: Component of a DKM FX or Media Extender to connect to the con- sole (monitor(s), keyboard and mouse; optionally also with USB 2.0 devices).
Page 80
Chapter 10: Glossary DVI-I: A combined signal (digital and analog) that allows running a VGA monitor at a DVI-I port – in contrast to DVI-D (see DVI). EGA: The Enhanced Graphics Adapter (EGA) is an old analog graphic standard, introduced by IBM in 1984. A D-Sub 9 connector is used for connection. Fiber: Single-mode or multimode fiber cables.
Page 81
An API may include specifications for routines, data structures, object classes, and variables. Echo: The response of the DKM FX matrix to an external command (optional). NACK: A transmission control character sent by a station as a negative response to the station with which the connection has been set up.
Page 84
724-746-5500 or blackbox.com. About Black Box Black Box provides an extensive range of networking and infrastructure products. You’ll find everything from cabinets and racks and power and surge protection products to media converters and Ethernet switches all supported by free, live 24/7 Tech support available in 30 seconds or less.
Need help?
Do you have a question about the DKM FX and is the answer not in the manual?
Questions and answers