Developer's Corner
X-keys Switch Interface (SE+MWII Firmware) Data Report
General Information
MWII |
SE |
|
VID |
05f3h |
05f3h |
PID |
02B7h or 695 |
0269h or 617
|
Consumer Usage Page |
1 |
1 |
Usage Page |
000Ch or 12 |
000Ch or 12 |
X-keys Switch Interface Input Report
Figure 1: X-keys Switch Interface key reference
Endpoint: 1, consumer usage page.
MWII Report Length: 32 bytes.
SE Report Length: 19 bytes.
The following types of input reports are available; General Incoming Data and Check Key (MWII only).
1. General Incoming Data. This is received when switches are pressed, unit ID changes, Program Switch changes position.
|
Byte 1 |
Byte 2 |
Byte 3 |
Byte 4 |
Byte 5 |
Byte 6 |
Byte 7 |
Byte 8 |
Byte 9 |
Byte 10 |
|
|
MWII |
Constant |
Jack 12 |
Jack 11 |
Jack 10 |
Jack 9 |
Jack 8 |
Jack 7 |
Jack 6 |
Jack 5 |
Jack 4 |
|
MWII |
2 |
State |
State |
State |
State |
State |
State |
State |
State |
State |
|
SE |
Constant |
Jack 12 |
Jack 11 |
Jack 10 |
Jack 9 |
Jack 8 |
Jack 7 |
Jack 6 |
Jack 5 |
Jack 4 |
|
SE |
2 |
State |
State |
State |
State |
State |
State |
State |
State |
State |
|
Byte 11 |
Byte 12 |
Byte 13 |
Byte 14 |
Byte 15 |
Byte 16-17 |
Byte 18 |
Byte 19 |
Byte 20-32 |
|
|
MWII |
Jack 3 |
Jack 2 |
Jack 1 |
Unit ID (0-255) |
Program |
Reserved |
Reserved |
Reserved |
Reserved |
|
MWII |
State |
State |
State |
<data> |
Swpos |
value |
value |
value |
value |
|
SE |
Jack 3 |
Jack 2 |
Jack 1 |
Reserved |
Reserved |
Reserved |
Unit ID (0-255) |
Program Switch Position |
NA |
|
SE |
State |
State |
State |
value |
value |
value |
<data> |
Swpos |
NA |
State: 0 for key up, 1 for key down.
Swpos: Bits 1-3=0, bit 4=1, bit 5=0 if program switch is unset or 1 if program switch is set, bits 6-8=0.
X-keys Switch Interface Output Report
The following types of output reports are available; Set LEDs, Set Unit ID, Set Key (MWII only), Check Key (MWII only). The Unit ID is a value between 0 and 255 which can be set and read. This number stays permanently in the device independent of computer. It is useful if more than one device of the same PID will be connected to the same computer in order to distinguish the devices uniquely. The Set Key and Check Key reports are for the dongle feature, non PC users of this feature please contact P. I. Engineering for further details. Individual key backlighting control is available on the X-keys Stick.
Endpoint: 2, vendor defined usage page
MWII Report Length: 8 bytes.
SE Report Length: 9 bytes.
1. Set LEDs
|
Byte 1 |
Byte 2 |
Byte 3 |
Byte 4 |
Byte 5 |
Byte 6 |
Byte 7 |
Byte 8 |
Byte 9 |
|
|
MWII |
Constant |
LED Command |
Constant |
Constant |
Constant |
Constant |
Constant |
LED Control |
NA |
|
MWII |
2 |
186 |
0 |
0 |
0 |
0 |
0 |
LED |
NA |
|
SE |
Constant |
Constant |
Constant |
Constant |
Constant |
Constant |
Constant |
Constant |
LED Control |
|
SE |
0 |
0 |
0 |
0 |
0 |
0 |
0 |
0 |
LED |
LED: Bits 1-6=0, bit 7=1 to turn on green LED or 0 to turn off green LED, bit 8=1 to turn on red LED or 0 to turn off red LED.
2. Set Unit ID*
|
Byte 1 |
Byte 2 |
Byte 3 |
Byte 4 |
Byte 5 |
Byte 6 |
Byte 7 |
Byte 8 |
Byte 9 |
|
|
MWII |
Constant |
Unit ID Command |
Unit ID (0-255) |
Constant |
Constant |
Constant |
Constant |
Constant |
Constant |
|
MWII |
2 |
189 |
value |
0 |
0 |
0 |
0 |
0 |
0 |
|
SE |
Constant |
Unit ID Command |
Unit ID Command |
Constant |
Constant |
Constant |
Constant |
Unit ID (0-255) |
Constant |
|
SE |
0 |
137 |
137 |
0 |
0 |
0 |
0 |
value |
16 |
*On MWII devices make sure the programming switch is set before sending the command in order to write the Unit ID to the eeprom.
