Kramer KDS-USB2 User Manual
Hide thumbs
Also See for KDS-USB2:
- Quick start manual (2 pages) ,
- Quick start manual (2 pages) ,
- User manual (27 pages)
Related Manuals for Kramer KDS-USB2
Summary of Contents for Kramer KDS-USB2
- Page 1 USER MANUAL MODEL: SwitchableUSB Device Configuration Network Protocol P/N: 2900-301454 Rev 1 www.kramerAV.com...
-
Page 2: Table Of Contents
Kramer Electronics Ltd. Contents Introduction Overview General Information 2.1 Generic Packet Structure 2.2 Network Broadcast Notes Supported Messages 3.1 Request Device Information 3.2 Reply Device Information 3.3 Ping 3.4 Acknowledge 3.5 Request Extended Device Information 3.6 Reply Extended Device Information 3.7 Pair To Device... -
Page 3: Introduction
Kramer Electronics Ltd. Introduction Welcome to Kramer Electronics! Since 1981, Kramer Electronics has been providing a world of unique, creative, and affordable solutions to the vast range of problems that confront the video, audio, presentation, and broadcasting professional on a daily basis. In recent years, we have redesigned and upgraded most of our line, making the best even better! SwitchableUSB –... -
Page 4: Overview
Kramer Electronics Ltd. 1 Overview ™ SwitchableUSB Device Configuration Network Protocol provides the ability to discover and ® configure ExtremeUSB extenders on a local ethernet network. The protocol works on top of UDP, so it should be possible to write a configuration client for almost any platform. The devices will listen on UDP port 6137 for incoming messages and replies will be sent back to the port that the request originated from. -
Page 5: General Information
Kramer Electronics Ltd. 2 General Information SwitchableUSB – 2 General Information... -
Page 6: Generic Packet Structure
Kramer Electronics Ltd. 2.1 Generic Packet Structure All packets contain the following: Magic Number A value (0x2F03F4A2) which gives some confidence that the data which follows is a configuration message. Message ID When the client sends a request, it chooses any value to insert in this field. -
Page 7: Network Broadcast Notes
Kramer Electronics Ltd. 2.2 Network Broadcast Notes Further information about Network Broadcast Notes can be found at the references section. 2.2.1 Subnet Broadcast To broadcast a packet to a subnet you only have to use the broadcast IP of the subnet. For example to broadcast to a network configured as an IP range of 192.168.5.xxx, and a netmask of 255.255.255.0,... -
Page 8: Supported Messages
Kramer Electronics Ltd. 3 Supported Messages SwitchableUSB – 3 Supported Messages... -
Page 9: Request Device Information
Kramer Electronics Ltd. 3.1 Request Device Information This message is sent from the client to a device in order to solicit a Reply Device Information message. This message can be sent in a broadcast UDP message in order to discover all the configurable USB extenders on the local network. -
Page 10: Reply Device Information
Kramer Electronics Ltd. 3.2 Reply Device Information This message is sent from a device to a client in response to a Request Device Information message. 3.2.1 Field Descriptions MAC Address The device's MAC address. IP Address The device's current IP address. -
Page 11: Ping
Kramer Electronics Ltd. 3.3 Ping This message is sent from a client to a device. It is used to check if a device is active. An Acknowledge message will be sent by the device in response. Byte Offset +-----------------------------------------+-----------------------------------------+ 0 | Magic Number... -
Page 12: Acknowledge
Kramer Electronics Ltd. 3.4 Acknowledge This message is a generic ACK message that will be sent in response to all requests made by clients that do not require returning an additional data payload in the response. The Message ID field should be sufficient to determine which message is being ACKed. -
Page 13: Request Extended Device Information
Kramer Electronics Ltd. 3.5 Request Extended Device Information Sent by a client to a device in order to obtain additional information about the device that is not included in the Reply Device Information message from protocol 0. Byte Offset +-----------------------------------------+-----------------------------------------+... -
Page 14: Reply Extended Device Information
Kramer Electronics Ltd. 3.6 Reply Extended Device Information Sent by a device to a client in response to a Request Extended Device Information message. 3.6.1 Field Descriptions ENCODER/DECODER 0=Device is a ENCODER, 1=Device is a DECODER Paired With MAC Address MAC address of a device that this device is paired with. -
Page 15: Pair To Device
Kramer Electronics Ltd. 3.7 Pair To Device Sent by a client to a device to instruct a device to try to pair with a different device specified in this message. A client must send this message to a ENCODER and a DECODER to instruct them to pair together, but the order of the two messages does not matter. -
Page 16: Remove Device Pairing
Kramer Electronics Ltd. 3.8 Remove Device Pairing Sent by a client to a device to instruct a device to discard any existing pairing it has. This will effectively disconnect any USB devices that were downstream of the remote extender. The client must send a Remove Device Pairing message to each of the devices in the pairing. -
Page 17: Request Device Topology
Kramer Electronics Ltd. 3.9 Request Device Topology Sent by a client to a ENCODER device in order to obtain the set of USB devices in the system. A DECODER device will send a Negative Acknowledge message in response to this message. -
Page 18: Reply Device Topology
Kramer Electronics Ltd. 3.10 Reply Device Topology Sent by a ENCODER device in response to a Request Device Topology message. This message is of variable length depending on the number of devices that are in the system. The combination of the information is enough for a client to build and display a device tree. -
Page 19: Use Dhcp
Kramer Electronics Ltd. 3.11 Use DHCP Sent by a client to a device to tell a device that it should use DHCP to obtain an IP. This message may be sent as either as a UDP broadcast packet or a packet directed to a specific IP in the case that the device has a valid, known static IP address already. -
Page 20: Use Static Ip
Kramer Electronics Ltd. 3.12 Use Static IP Sent by a client to a device to tell a device that it should use the static network configuration contained within this message. The IP, subnet mask and default gateway as well as the network configuration are stored in permanent storage, so the device will keep the same network configuration after being power cycled. -
Page 21: Negative Acknowledge
Kramer Electronics Ltd. 3.13 Negative Acknowledge This message is a generic NAK message that may be sent in response to a Pair To Device, Remove Device Pairing or Request Device Topology message. It indicates to the client that their request was received, but that no action will be taken as a result of that message. -
Page 22: Use Filtering Strategy
Kramer Electronics Ltd. 3.14 Use Filtering Strategy Sent by a client to a device to tell the device that it should use a certain type of filtering strategy contained within this message. The filtering strategy denotes which type of devices will be filtered out by the extenders. -
Page 23: Led Locator On
Kramer Electronics Ltd. 3.15 LED Locator On This message is sent from a client to a device. Upon receiving this message, the led pattern is started on the device. It is used to locate a specific device. Byte Offset +-----------------------------------------+-----------------------------------------+... -
Page 24: Led Locator Off
Kramer Electronics Ltd. 3.16 Led Locator Off This message is sent from a client to a device. Upon receiving this message, the led pattern is stopped on the device. It only works when the led pattern is active on the device. -
Page 25: Reset Device
Kramer Electronics Ltd. 3.17 Reset Device This message is sent from a client to a device. Upon receiving this message, the device resets. Byte Offset +-----------------------------------------+-----------------------------------------+ 0 | Magic Number +-----------------------------------------+-----------------------------------------+ 4 | Message ID +-----------------------------------------+-----------------------------------------+ 8 | Protocol Version = 3... -
Page 26: Request Configuration Response Data
Kramer Electronics Ltd. 3.18 Request Configuration Response Data This message is sent from the client to a device in order to solicit a Reply Configuration Response Data message. Byte Offset +-----------------------------------------+-----------------------------------------+ 0 | Magic Number +-----------------------------------------+-----------------------------------------+ 4 | Message ID... -
Page 27: Reply Configuration Response Data
Kramer Electronics Ltd. 3.19 Reply Configuration Response Data This message is sent from a device to a client in response to a Request Configuration Response Data. 3.19.1 Field Descriptions High Speed 0=Disabled, 1=Enabled 0=Disabled, 1=Enabled Vhub 0=Disabled, 1=Enabled Current Filter Status... - Page 28 Kramer Electronics Ltd. +-----------------------------------------+-----------------------------------------+ 22 | Reserved +-----------------------------------------+-----------------------------------------+ 24 | Paired with MAC Address 64 | +-----------------------------------------+-----------------------------------------+ 66 | Port Number +-----------------------------------------+-----------------------------------------+ 68 | IP Address 70 | +-----------------------------------------+-----------------------------------------+ 72 | SubNet Mask 74 | +-----------------------------------------+-----------------------------------------+ 76 | Default Gateway...
-
Page 29: Request Link Status
Kramer Electronics Ltd. 3.20 Request Link Status This message is sent from the client to a device in order to obtain the link status of the paired units. Byte Offset +-----------------------------------------+-----------------------------------------+ 0 | Magic Number +-----------------------------------------+-----------------------------------------+ 4 | Message ID... -
Page 30: Reply Link Status
Kramer Electronics Ltd. 3.21 Reply Link Status This message is sent from the device to a client in response to a Request Link Status Information message. The message will contain information for all 7 devices that could be paired. If the number of paired devices is less than 7, the unpaired fields are set to 0. - Page 31 Kramer Electronics Ltd. 42 | MAC Address of device 5 44 | 46 | +-----------------------------------------+-----------------------------------------+ 48 | MAC Address of device 6 50 | 52 | +-----------------------------------------+-----------------------------------------+ 54 | MAC Address of device 7 56 | 58 | +-----------------------------------------+-----------------------------------------+ SwitchableUSB – 3...
-
Page 32: Remove All Pairings
Kramer Electronics Ltd. 3.22 Remove All Pairings This command is sent by a client to a device to instruct the device to clear all of its pairings. This message may be sent to a device that currently has no pairings, but will have no effect. -
Page 33: Force Pair To Device
Kramer Electronics Ltd. 3.23 Force Pair To Device This command is sent by a client to a device to instruct the device to clear all of its existing pairings and then try to pair with a different device specified in this message. A client must send this message to a ENCODER and a DECODER to instruct them to pair together, but the order of the two messages does not matter. - Page 34 Kramer Electronics Ltd. 4 Appendix A SwitchableUSB – 4 Appendix A...
-
Page 35: Abbreviations
Kramer Electronics Ltd. 4.1 Abbreviations ENCODER – Local Extender DECODER – Remote Extender UDP – User Data Protocol USB – Universal Serial Bus DHCP – Dynamic Host Configuration Protocol IP – Internet Protocol IPv4 – Internet Protocol version 4 TBD – To Be Determined ACK –... -
Page 36: References
Kramer Electronics Ltd. 4.3 References https://en.wikipedia.org/wiki/IPv4_subnetting_reference SwitchableUSB – 4 Appendix A... - Page 37 This limited warranty gives you specific legal rights, and you may have other rights which vary from country to country or state to state. This limited warranty is void if (i) the label bearing the serial number of this product has been removed or defaced, (ii) the product is not distributed by Kramer Electronics or (iii) this product is not purchased from an authorized Kramer Electronics reseller.
- Page 38 Your rights under this limited warranty are not diminished if you do not complete and return the product registration form or complete and submit the online product registration form. Kramer Electronics thanks you for purchasing a Kramer Electronics product. We hope it will give you years of satisfaction.
- Page 39 SAFETY WARNING Disconnect the unit from the power supply before opening and servicing For the latest information on our products and a list of Kramer distributors, visit our website where updates to this user manual may be found. We welcome your questions, comments, and feedback.
Need help?
Do you have a question about the KDS-USB2 and is the answer not in the manual?
Questions and answers