Developer's Corner

X-keys Jog & Shuttle Pro (SE+MWII Firmware) Data Reports

General Information

X-keys Jog & Shuttle Pro Input Report

Figure 1: X-keys Jog & Shuttle Pro key reference

Endpoint: 1, consumer usage page

MWII Report Length: 32 bytes.
SE Report Length: 15 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.

Shuttle:  This is the outside ring.  0=at rest, 1 to 7=clockwise to full right, 255 to 249=counter clockwise to full left.  If assign the output to signed type variable then –7 to 7 would be the resulting range.
Jog:  This is the inner knob.  A value 0 to 255 with rollover.
D1: For all bits 0 if key is up, 1 if key is down.  Bits 1 to 7 correspond to Keys 0 to 6, respectively.  Bit 8=0 always. 
For example Byte 5 gives the state of Keys 0, 1, 2, 3, 4, 5 and 6.  A value of 67 in this byte would indicate that Keys 0, 1 and 6 are pressed.
D2: For all bits 0 if key is up, 1 if key is down.  Bits 1 to 7 correspond to Keys 16 to 22, respectively.  Bit 8=0 always.
D3: For all bits 0 if key is up, 1 if key is down.  Bits 1 to 4 correspond to Keys 32 to 35, respectively.  Bits 5 to 8=0 always. 
D4: For all bits 0 if key is up, 1 if key is down.  Bits 1 to 4 correspond to Keys 48 to 51, respectively.  Bits 5 to 8=0 always.
D5: For all bits 0 if key is up, 1 if key is down.  Bits 1 to 4 correspond to Keys 64 to 67, respectively.  Bits 5 to 8=0 always.
D6: For all bits 0 if key is up, 1 if key is down.  Bits 1 to 4 correspond to Keys 80 to 83, respectively.  Bits 5 to 8=0 always.
D7: For all bits 0 if key is up, 1 if key is down.  Bits 1 to 7 correspond to Keys 96 to 102, respectively.  Bit 8=0 always.
D8: For all bits 0 if key is up, 1 if key is down.  Bits 1 to 7 correspond to Keys 112 to 118, respectively.  Bit 8=0 always.
D9: For all bits 0 if key is up, 1 if key is down.  Bits 1 and 2 correspond to Keys 128 and 129, respectively.  Bits 3 to 8=0 always.
Swpos:   Bits 1-3=0, bit 4=1, bit 5=0 if program switch is down or 1 if program switch is up, bits 6-8=0.

X-keys Jog & Shuttle Pro Output Report

The following types of output reports are available; Set LEDs, Set Unit ID, Set Key (MWII only), Check Key (MWII only) and Backlighting.  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 please contact P. I. Engineering for further details.

Endpoint: 2, vendor defined usage page

MWII Report Length: 8 bytes.
SE Report Length: 9 bytes.

1. Set LEDs

LED: Bits 1-5=0, bit 6 = 1 to turn on the backlighting or 0 to turn off (SE only), bit 7=1 to turn on green LED or 0 to turn off green LED (both devices), bit 8=1 to turn on red LED or 0 to turn off red LED (both devices).

2. Set Unit ID*

*On MWII devices make sure the programming switch is set before sending the WriteData() command in order to write the Unit ID to the eeprom.