Developer's Corner

X-keys Stick (SE+MWII Firmware) Data Reports

General Information

X-keys Stick Input Report

Figure 1: X-keys Stick key reference

Endpoint: 1, consumer usage page

MWII Report Length: 32 bytes.
SE Report Length: 12 bytes.

The following types of input reports are available; General Incoming Data and Check Key.

1.  General Incoming Data.  This is received when switches are pressed, unit ID changes, Program Switch changes position.

D1: for all bits 0 for key up, 1 for key down.  Bit 1=Key 0, bit 2=Key 1, bit 3=Key 2, bit 4=Key 3, bits 5-8=0 always.
D2: for all bits 0 for key up, 1 for key down.  Bit 1=Key 16, bit 2=Key 17, bit 3=Key 18, bit 4=Key 19, bits 5-8=0 always.
D3: for all bits 0 for key up, 1 for key down.  Bit 1=Key 32, bit 2=Key 33, bit 3=Key 34, bit 4=Key 35, bits 5-8=0 always.
D4: for all bits 0 for key up, 1 for key down.  Bit 1=Key 48, bit 2=Key 49, bit 3=Key 50, bit 4=Key 51, bits 5-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 Stick 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 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

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.
LEDSet1: For all bits, 0 to turn LED off, 1 to turn LED on. Bit 1=key 0 LED, bit 2=key 16 LED, bit 3=key 32 LED, bit 4=key 48LED, bit 5=key 1 LED, bit 6=key 17 LED, bit 7=key 37 LED, bit 8=key 49 LED.
LEDSet2: For all bits, 0 to turn LED off, 1 to turn LED on. Bit 1=key 2 LED, bit 2=key 18 LED, bit 3=key 34 LED, bit 4=key 50 LED, bit 5=key 3 LED, bit 6=key 19 LED, bit 7=key 35 LED, bit 8=key 51 LED.

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.

3. Backlighting

BL1:  For all bits 0 for backlight off, 1 for backlight on.  Bit 1=Key 2, bit 2=Key 18, bit 3=Key 34, bit 4=Key 50, bit 5=Key 3, bit 6=Key 19, bit 7=Key 35, bit 8=Key 51.
BL2:  For all bits 0 for backlight off, 1 for backlight on.  Bit 1=Key 0, bit 2=Key 16, bit 3=Key 32, bit 4=Key 48, bit 5=Key 1, bit 6=Key 17, bit 7=Key 33, bit 8=Key 49.
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.
LEDSet1: For all bits, 0 to turn LED off, 1 to turn LED on. Bit 1=key 0 LED, bit 2=key 16 LED, bit 3=key 32 LED, bit 4=key 48 LED, bit 5=key 1 LED, bit 6=key 17 LED, bit 7=key 37 LED, bit 8=key 49 LED.
LEDSet2: For all bits, 0 to turn LED off, 1 to turn LED on. Bit 1=key 2 LED, bit 2=key 18 LED, bit 3=key 34 LED, bit 4=key 50 LED, bit 5=key 3 LED, bit 6=key 19 LED, bit 7=key 35 LED, bit 8=key 51 LED.