Kramer KDS-USB2 Kit User manual

P/N: 2900-301454 Rev 1 www.kramerAV.com
USER MANUAL
MODEL:
SwitchableUSB
Device Configuration Network Protocol

Kramer Electronics Ltd.
SwitchableUSB –Contents
i
Contents
Introduction 1
1Overview 2
2General Information 3
2.1 Generic Packet Structure 4
2.2 Network Broadcast Notes 5
3Supported Messages 6
3.1 Request Device Information 7
3.2 Reply Device Information 8
3.3 Ping 9
3.4 Acknowledge 10
3.5 Request Extended Device Information 11
3.6 Reply Extended Device Information 12
3.7 Pair To Device 13
3.8 Remove Device Pairing 14
3.9 Request Device Topology 15
3.10 Reply Device Topology 16
3.11 Use DHCP 17
3.12 Use Static IP 18
3.13 Negative Acknowledge 19
3.14 Use Filtering Strategy 20
3.15 LED Locator On 21
3.16 Led Locator Off 22
3.17 Reset Device 23
3.18 Request Configuration Response Data 24
3.19 Reply Configuration Response Data 25
3.20 Request Link Status 27
3.21 Reply Link Status 28
3.22 Remove All Pairings 30
3.23 Force Pair To Device 31
4 Appendix A 32
4.1 Abbreviations 33
4.3 References 34

Kramer Electronics Ltd.
SwitchableUSB –Introduction
1
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!

Kramer Electronics Ltd.
SwitchableUSB –1 Overview
2
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. The USB extenders will include a DHCP client that will enable them to obtain an IP
address from a DHCP server on the network. The devices may alternatively be assigned a static
network configuration using UDP broadcast packets in the form of a Use Static IP message described
later in this document.
Figure 1: USB extenders on a local network

Kramer Electronics Ltd.
SwitchableUSB –2 General Information
3
2 General Information

Kramer Electronics Ltd.
SwitchableUSB –2 General Information
4
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. The device responding to the request will set this field in
the reply to the same value it received in the request.
Protocol Version
An integer from 0-255. All devices will support protocol 0 and one
other protocol version. The Reply Device Information message
will inform a client which version of the protocol it must speak in
order to communicate with the device.
Command
An integer from 0-255. This is the identifier of the command. The
combination of the protocol version and the command identify a
unique message type. In other words, command 5 in protocol 1 is
likely different from command 5 in protocol 3.
•All multi-byte fields are packed as big endian.
•Messages are at least 10 bytes and at most 136 bytes in length.
•Any string fields should be encoded using UTF-8.

Kramer Electronics Ltd.
SwitchableUSB –2 General Information
5
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,
the IP 192.168.5.255 is the broadcast IP address. For example to broadcast to a network
configured as an IP range of 10.xxx.xxx.xxx, and a netmask of 255.0.0.0, the IP
10.255.255.255 is the broadcast IP address.
Routers will drop broadcast IP packets, destined for an address outside of the source address
device’s network; which means that any broadcast packet must originate on the same
network as the target devices.
2.2.2 All Local Subnet Broadcast
By broadcasting to the IP address 255.255.255.255 a broadcast packet can be sent out,
without previously knowing what the local network is. Microsoft Windows will however only
send the packet out the first configured network interface, so on a computer with multiple
interfaces, each interface should sent a broadcast network packet separately.
2.2.3 Mismatched Network Configuration
When broadcasting to a subnet using the network broadcast address (for example
192.168.5.255), and the device is configured for a different network (for example
IP=10.0.9.23, netmask=255.0.0.0), then the device will not respond to the broadcast as it will
not recognize the IP address as a valid broadcast.
This shouldn’t happen with a proper DHCP server allocated addresses out of the same pool
for the network. It could potentially happen when assigning static IP addresses, and moving
units between networks. If this does happen the unit will need to be reset to DHCP by the
push button, as described in the user’s guide, and then the static IP address can be assigned
to the unit.

Kramer Electronics Ltd.
SwitchableUSB –3 Supported Messages
6
3 Supported Messages

Kramer Electronics Ltd.
SwitchableUSB –3 Supported Messages
7
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.
Byte Offset
+-----------------------------------------+-----------------------------------------+
0 | Magic Number |
+ +
2 | |
+-----------------------------------------+-----------------------------------------+
4 | Message ID |
+ +
6 | |
+-----------------------------------------+-----------------------------------------+
8 | Protocol Version = 0 | Command = 0 |
+-----------------------------------------+-----------------------------------------+

Kramer Electronics Ltd.
SwitchableUSB –3 Supported Messages
8
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.
Network Acquisition Mode
0=DHCP, 1=Static
Supported Protocol Version
All devices must support protocol 0 and one other protocol number. This
value specifies which protocol version that is.
Vendor
A 32-byte NUL terminated string containing the device's vendor name.
Product
A 32-byte NUL terminated string containing the device's product name.
Revision
A 12-byte NUL terminated string containing the device's revision
number.
Byte Offset
+-----------------------------------------+-----------------------------------------+
0 | Magic Number |
+ +
2 | |
+-----------------------------------------+-----------------------------------------+
4 | Message ID |
+ +
6 | |
+-----------------------------------------+-----------------------------------------+
8 | Protocol Version = 0 | Command = 1 |
+-----------------------------------------+-----------------------------------------+
10 | MAC Address |
+ +
12 | |
+ +
14 | |
+-----------------------------------------+-----------------------------------------+
16 | IP Address |
+ +
18 | |
+-----------------------------------------+-----------------------------------------+
20 | Network Acquisition Mode | Supported Protocol Version |
+-----------------------------------------+-----------------------------------------+
22 | Vendor |
+ +
. . .
. . .
. . .
+ +
52 | |
+-----------------------------------------+-----------------------------------------+
54 | Product |
+ +
. . .
. . .
. . .
+ +
84 | |
+-----------------------------------------+-----------------------------------------+
86 | Revision |
+ +
. . .
. . .
. . .
+ +
96 | |
+-----------------------------------------+-----------------------------------------+