Black Box DKM FX Interface Manual Download Page 1 | Manualshive

Page: 1 / 84

background image

BLACK BOX

®

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: [email protected]

Customer

Support

Information

ACX048

ACXC8

ACXC64

ACX080

ACXC16

ACXC80

ACX160

ACXC32

ACXC48F16

ACX288

ACXC48

ACXC48F32

1
2
3
...
»

Summary of Contents for DKM FX

Page 1: ...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 c...

Page 2: ...d 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...

Page 3: ...r 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...

Page 4: ...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 si...

Page 5: ...quidos 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 c...

Page 6: ...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 Sta...

Page 7: ...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...

Page 8: ...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 Assig...

Page 9: ...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...

Page 10: ...re 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 telecommunicati...

Page 11: ...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 mat...

Page 12: ...le 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 Extern...

Page 13: ...ugh 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 F...

Page 14: ...24 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 connec...

Page 15: ...X 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...

Page 16: ...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 Ta...

Page 17: ...6 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 c...

Page 18: ...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...

Page 19: ...g 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 t...

Page 20: ...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...

Page 21: ...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 DK...

Page 22: ...SD 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...

Page 23: ...er 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 acces...

Page 24: ...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 p...

Page 25: ...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 S...

Page 26: ...twork 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 Input...

Page 27: ...solicited by a command and thus the new switching status of the matrix The echo can be used to update user applications and to operate several matrices in parallel See Chapter 4 4 1 System Data in the...

Page 28: ...itch commands and assignments 6 1 System Requests Get System Time Request Telegram ESC S Description Get system time Example Get system time 0x1B 0x28 0x53 Response Telegram ESC S Size Seconds Minutes...

Page 29: ...or NAK Optional elements 6 2 2 Get CPU Device Connected to CON Device Request Telegram ESC H Size ConId Description Get CPU device input connected to CON device output ConId ID of CON device Example G...

Page 30: ...ut Input data of CPU device Video USB Audio will be transmitted to CON device ConId ID of CON device CpuId ID of CPU device Example Set CPU device CpuId 1012 connection to CON device ConId 3017 0x1B 0...

Page 31: ...pairs of ConId CpuId ConCnt Number of CON devices ConId CpuId List of IDs ConID CpuID Example Get CPU devices connected to CON devices CpuId 1 1012 ConId 1 3017 CpuId 2 1013 ConId 2 3028 CpuId 3 1020...

Page 32: ...x0B 0xF4 0x03 0xD4 0x0B 0xF5 0x03 0x0E 0x0B 0xFC 0x03 Response ACK ECHO or NAK Optional elements 6 2 6 Get CON Device Connected to CPU Device Request Telegram ESC L Size CpuId Description Get CON devi...

Page 33: ...tput Input data of CON device USB Audio will be transmitted to CPU device CpuId ID of CPU device ConId ID of CON device Example Set CON device ConId 3017 connection to CPU device CpuId 1012 0x1B 0x5B...

Page 34: ...ber of CPU devices CpuId ConId List of IDs CpuID ConID Example Return CON devices connected to CPU devices CpuId 1 1012 ConId 1 3017 CpuId 2 1013 ConId 2 3028 CpuId 3 1020 ConId 3 3040 0x1B 0x5D 0x4E...

Page 35: ...nnection to CPU Device Single Bidirectional Connection KVM Full Access Request Telegram ESC P Size CpuId ConId Description Set CON device input connection to CPU device output and CPU device input con...

Page 36: ...device USB audio will be transmitted to CPU device Data of CPU device video USB audio will be transmitted to CON device Cnt Size of list CpuId ConId List of IDs CpuID ConID Example Set connection of C...

Page 37: ...device is disconnected For each defined CON device the CpuId of the connected CPU device will be added or 0 if the CON device is disconnected CpuCnt Number of CPU devices ConCnt Number of CON devices...

Page 38: ...or each defined CON device add the CpuId or 0 if the CON device is disconnected CpuCnt Number of CPU devices ConCnt Number of CON devices CpuId ConId List of IDs CpuID ConID CpuId ConId List of IDs Co...

Page 39: ...d to a CON device CpuId ID of CPU device ConId ID of CON device Mode Connection Mode 0 full access 1 video only 2 private mode Example Set CON device connection to CPU device and CPU device connection...

Page 40: ...rtual CON device VConId 4034 of a real CON device RConId 3017 0x1B 0x5B 0x54 0x09 0x00 0xC9 0x0B 0xC2 0x0F or NAK 6 3 2 Set Virtual CON Device to a Real CON Device Request Telegram ESC U Size RConId V...

Page 41: ...xE2 0x07 Response Telegram ESC V Size VCpuId RCpuId Description Return real CPU device of a virtual CPU device VCpuId ID of virtual CPU device RCpuId ID of real CPU device Example Return real CPU devi...

Page 42: ...For ConCnt 0 all real CON devices with assignments to virtual CON devices will be returned ConCnt Number of CON devices RConId List of IDs of real CON devices Example Get virtual CON devices of a real...

Page 43: ...nt RConId VConId 1 RConId VConId ConCnt Description Set virtual CON devices to real CON devices ConCnt Number of CON devices RConId VConId List of Pairs of RConId and VConId Example Set virtual CON de...

Page 44: ...0x00 0xE2 0x07 0xEE 0x07 0xF3 0x07 Response Telegram ESC Z Size CpuCnt VCpuId RCpuId 1 VCpuId RCpuId CpuCnt Description Return real CPU devices of virtual CPU devices as pairs CpuCnt Number of CPU dev...

Page 45: ...K ECHO or NAK Optional elements 6 4 Best Practice This chapter provides an overview of the most commonly used switching commands and how they can be operated by using proven code examples of the exter...

Page 46: ...two steps 1 Set CPU device CpuId 1012 connection to CON device ConId 3017 0x1B 0x5B 0x49 0x09 0x00 0xC9 0x0B 0xF4 0x03 2 Set CON device ConId 3017 connection to CPU device CpuId 1012 0x1B 0x5B 0x4D 0...

Page 47: ...and 1 A special command Size 2 Optional if telegram size is greater than 3 Data n Optional n bytes of data Byte Order Little Endian Special characters ACK 0x06 NAK 0x15 Request ESC Server identificati...

Page 48: ...ata a Repeat telegram b Next command c Receive and process the reply telegram NOTE The serial interface can be blocked while the OSD is open 7 1 System Requests Get System Time Request Telegram ESC S...

Page 49: ...y 1 7 Monday 1 0x01 0x07 Date 1 Date 1 31 0x01 0x31 Month 1 Month 1 12 0x01 0x12 Year 1 Year 2000 e g 2012 0x12 Example Return system time Saturday 15 27 48 28 01 2012 0x1B 0x29 0x53 0x0C 0x00 0x48 0x...

Page 50: ...n Device e g 3017 0xC9 0x08 Example Get CPU device connected to CON device ConId 3017 0x1B 0x5B 0x48 0x07 0x00 0xC9 0x0B Response Telegram ESC H Size ConId CpuId General description Return CPU device...

Page 51: ...be transmitted to CON device Table 7 8 Set CPU device connection to CON device Type Bytes Description Hex Coding ESC 1 Control character 0x1B 1 Server identification 0X5B 1 Command 0x49 Size 2 Total l...

Page 52: ...n Hex Coding ESC 1 Control character 0x1B J 1 Server identification 0X5B 1 Command 0x4A Size 2 Total length of telegram 7 Bytes data e g for ConCnt 3 0x0D 0x00 ConCnt 2 Number of CON devices e g 3 0x0...

Page 53: ...mmand 0x4A Size 2 Total length of telegram 7 Bytes data e g for ConCnt 3 0x13 0x00 ConCnt 2 Number of CON devices e g 3 0x03 0x00 ConId 2 ID of CON device e g 3017 0xC9 0x0B CpuId 2 ID of CPU device e...

Page 54: ...ices Type Bytes Description Hex Coding ESC 1 Control character 0x1B 1 Server identification 0X5D K 1 Command 0x4A Size 2 Total length of telegram 7 Bytes data e g for ConCnt 3 0x13 0x00 ConCnt 2 Numbe...

Page 55: ...ength of telegram 7 bytes 0x07 0x00 CpuId 2 ID of CPU device e g 1012 0xF4 0x03 Example Get CON device connected to CPU device CpuId 1012 0x1B 0x5B 0x4C 0x07 0x00 0xF4 0x03 Response Telegram ESC L Siz...

Page 56: ...vice output Input data of CON device USB audio will be transmitted to CPU device Table 7 14 Set CON device input connected to CPU device output Type Bytes Description Hex Coding ESC 1 Control characte...

Page 57: ...Description Hex Coding ESC 1 Control character 0x1B 1 Server identification 0X5B N 1 Command 0x4E Size 2 Total length of telegram 7 Bytes data e g for CpuCnt 3 0x0D 0x00 CpuCnt 2 ID of CPU device e g...

Page 58: ...0 CpuId 2 ID of CPU device e g 1012 0xF4 0x03 ConId 2 ID of CON device e g 3017 0xC9 0x0B Example Return CON devices connected to CPU devices CpuId 1 1012 ConId 1 3017 CpuId 2 1013 ConId 2 3028 CpuId...

Page 59: ...3017 0xC9 0x0B Example Set connection of CON devices to CPU devices CpuId 1 1012 ConId 1 3017 CpuId 2 1013 ConId 2 3028 CpuId 3 1020 ConId 3 3040 0x1B 0x5B 0x4F 0x13 0x00 0x03 0x00 0xF4 0x03 0xC9 0x0...

Page 60: ...4 0x03 ConId 2 ID of CON device e g 3017 0xC9 0x0B Example Set CON device ConID 3017 connection to CPU device CpuId 1012 0x1B 0x5B 0x50 0x09 0x00 0xF4 0x03 0xC9 0x0B Response ACK ECHO or NAK Optional...

Page 61: ...4 0x03 ConId 2 ID of CON device e g 3017 0xC9 0x0B Example Connect CONs with CPUs and CPUs with CONs CpuId 1 1012 ConId 1 3017 CpuId 2 1013 ConId 2 3028 CpuId 3 1020 ConId 3 3040 0x1B 0x5B 0x51 0x13 0...

Page 62: ...added or 0 if the CPU device is disconnected For each defined CON device the CpuId of the connected CPU device will be added or 0 if the CON device is disconnected Table 7 21 Return all CPU device CON...

Page 63: ...0xF4 0x03 0xC9 0x0B 0xF5 0x03 0xD4 0x0B 0xFC 0x03 0x0E 0x0B 0xC9 0x0B 0xF4 0x03 0xD4 0x0B 0x00 0x00 7 2 13 Set Connection for All CON Devices and CPU Devices Request Telegram ESC S Size CpuCnt ConCnt...

Page 64: ...2 Number of CPUs e g 3 0x03 0x00 ConCnt 2 Number of CONs e g 2 0x02 0x00 CpuId 2 ID of CPU device e g 1012 0xF4 0x03 ConId 2 ID of CON device e g 3017 0xC9 0x0B Example Set a connection for all defin...

Page 65: ...connection for all defined CON devices and CPU devices Type Bytes Description Hex Coding ESC 1 Control character 0x1B 1 Server identification 0X5B b 1 Command 0x62 Size 2 Total length of telegram 0x0...

Page 66: ...telegram 7 bytes 0x07 0x00 RConId 2 ID of real CON device e g 3017 0xC9 0x0B Example Get virtual CON device of a real CON device RConId 3017 0x1B 0x5B 0x54 0x07 0x00 0xC9 0x0B Response Telegram ESC T...

Page 67: ...t virtual CON device to a real CON device Table 7 26 Set virtual CON device to a real CON device Type Bytes Description Hex Coding ESC 1 Control character 0x1B 1 Server identification 0X5B U 1 Command...

Page 68: ...7 bytes 0x07 0x00 VCpuId 2 ID of virtual CPU device e g 2018 0xE2 0x07 Example Get real CPU device of a virtual CPU device VCpuId 2018 0x1B 0x5B 0x56 0x07 0x00 0xE2 0x07 Response Telegram ESC V Size...

Page 69: ...CPU device to a virtual CPU device Table 7 29 Set real CPU device to a virtual CPU device Type Bytes Description Hex Coding ESC 1 Control character 0x1B 1 Server identification 0X5B W 1 Command 0x57 S...

Page 70: ...ype Bytes Description Hex Coding ESC 1 Control character 0x1B 1 Server identification 0X5B X 1 Command 0x58 Size 2 Total length of telegram 7 bytes data e g for ConCnt 3 0x0D 0x00 ConId 2 Number of CO...

Page 71: ...d 0x58 Size 2 Total length of telegram 7 bytes data e g for ConCnt 3 0x13 0x00 ConId 2 Number of CON device e g 3 0x03 0x00 RConId 2 ID of real CON device e g 3017 0xC9 0x0B VConId 2 ID of virtual CON...

Page 72: ...1 Control character 0x1B 1 Server identification 0X5B Y 1 Command 0x59 Size 2 Total length of telegram 7 bytes data e g for ConCnt 3 0x13 0x00 ConCnt 2 Number of CON device e g 3 0x03 0x00 RConId 2 ID...

Page 73: ...s Type Bytes Description Hex Coding ESC 1 Control character 0x1B 1 Server identification 0X5B Z 1 Command 0x5A Size 2 Total length of telegram 7 bytes data e g for ConCnt 3 0x0D 0x00 CpuCnt 2 Number o...

Page 74: ...Total length of telegram 7 bytes data e g for CpuCnt 3 0x13 0x00 CpuCnt 2 Number of CPU devices e g 3 0x03 0x00 VCpuId 2 ID of virtual CPU device e g 2018 0xE2 0x07 RCpuId 2 ID of real CPU device e g...

Page 75: ...ter 0x1B 1 Server identification 0X5B a 1 Command 0x61 Size 2 Total length of telegram 7 bytes data e g for CpuCnt 3 0x13 0x00 CpuCnt 2 Number of CPU device e g 3 0x03 0x00 VCpuId 2 ID of virtual CPU...

Page 76: ...olor Signal 1 Not connected 6 DTR 2 CTS 7 TxD 3 RTS 8 RxD 4 DSR 9 Not connected 5 GND Table 7 37 RJ 45 connector Picture Pin Signal Color Signal 1 D1 5 Not connected 2 D1 6 D2 3 D2 7 Not connected 4 N...

Page 77: ...anuals 8 1 Network Error Diagnosis Network settings are not accepted after editing Possible Reason Restart of the matrix not yet completed Measure Do a restart 8 2 Failure at the Matrix Diagnosis Seri...

Page 78: ...essary to provide us with complete information for support and problem cases Keep the following information available before you call Company name phone number and e mail Type and serial number of the...

Page 79: ...KM FX or Media Extender to connect to the con sole monitor s keyboard and mouse optionally also with USB 2 0 devices Console Keyboard mouse and monitor CPU Unit Component of a DKM FX or Media Extender...

Page 80: ...d plug connection for transmission of electrical audio and video signals especially with coaxial cables SFP SFPs Small Form Factor Pluggable are pluggable interface modules for Gigabit connections SFP...

Page 81: ...mission is used to guarantee reliability of packet transfers API An application programming interface API is a specification intended to be used as an interface by software components to communicate w...

Page 82: ...Page 82 724 746 5500 blackbox com ACX048 API manual NOTES...

Page 83: ...Page 83 724 746 5500 blackbox com ACX048 API manual NOTES...

Page 84: ...48 API manual version 1 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 pr...

Reviews:

No comments

Related manuals for DKM FX

Brand: FAAC Pages: 2

Infinity IES-1881

Brand: LevelOne Pages: 2

Brand: Ruby Tech Pages: 2

Xbox One Media Hub

Brand: Collective Minds Pages: 19

Brand: Conrad Pages: 8

Brand: ATEN Pages: 2

Brand: KinAn Pages: 4

SmartSwitch SBU128

Brand: Cabletron Systems Pages: 76

IPES-5208T-X Series

Brand: Lantech Pages: 39

Brand: N-Tron Pages: 157

Brand: ALFAtron Pages: 44

Brand: Black Box Pages: 20

Brand: DSPPA Pages: 31

S5130-EI Series

Brand: H3C Pages: 32

Brand: YOKOGAWA Pages: 74

Brand: IOGear Pages: 40

Brand: NVision Pages: 92

Brand: TRENDnet Pages: 32

Brands by name

0 1 2 3 4 5 6 7 8 9 A B C D E F G H I J K L M N O P Q R S T U V W X Y Z

Popular brands

Load more brands