Integration test: User-to-PC event propagation

Purpose and summary

To test that system events are propagated to the the PC side as joystick/gamepad input events.

Hardware setup

Use this test circuit:

For later reference:

• "ALT" is the built-in push button into the rotary encoder.
• "CLUTCH1" and "CLUTCH2" are the potentiometers as shown in the protoboard.
• "BTNN" is the button numbered "N" in the button matrix as shown in the protoboard.
• "RCW" means rotary's clockwise rotation.
• "RCCW" means rotary's counter-clockwise rotation.

Software setup (computer)

• Windows 10 or later
• Bluetooth 4.2 or later
• Joystick testing software able to display 128 buttons. Note that Window's device property page is not suitable for this.
• SimpleHIDWrite.exe: available at http://janaxelson.com/hidpage.htm. There is a modern clone at https://github.com/Robmaister/SimplerHidWrite.

Procedure and expected output

Part 1

1. Ensure the system is paired and connected to the computer.
2. Press and release these buttons quickly, one by one. Test event registration at the joystick testing software:
   1. "CLUTCH1": Axis Rz should move from zero to some point near the middle.
   2. "CLUTCH2": Same as "CLUTCH1".
   3. "ALT": No event should be registered.
   4. "BTN2": should be registered as #3.
   5. "BTN3": should be registered as D-PAD up.
   6. "BTN4": should be registered as D-PAD down.
   7. "BTN5": should be registered as D-PAD left.
   8. "BTN6": should be registered as D-PAD right.
   9. "BTN7": should be registered as #8.
3. Press and hold "ALT", then press and release "BTN2", then release "ALT". Button #67 should be registered.
4. Rotate "RCCW". Button #13 should be registered.
5. Rotate "RCW". Button #14 should be registered.
6. Press and hold "BTN2", then press and hold "BTN7", then release both. Buttons #3 and #8 should be registered at the same time.
7. Press and hold "BTN2", then press and hold "BTN3", then release both.
8. Press and release "ALT". Button #11 should be registered.
9. Press and hold "BTN2", then press and hold "BTN4", then release both.
10. Axis Rz should go to zero.
11. Move "CLUTCH1". Axis Rx must reflect the movement.
12. Move "CLUTCH2". Axis Ry must reflect the movement.
13. Press and hold "BTN2", then press and hold "BTN5", then release both.
14. Press and release "BTN3". Button #4 should be registered.

Part 2 (buttons map)

1. Open "SimpleHidWriter.exe". Locate Device VID=1D50 in the top area, and click on it.
2. You could see continuous report lines starting with RD 01. Ignore them. Click on Clear from time to time.
3. Enter 04 at field ReportID.
4. Enter 07 09 0A at fields below ReportID. Click on Set Feature.
5. Enter 03 at field ReportID.
6. Enter FF 01 FF FF 01 at fields below ReportID. Click on Set Feature.
7. Now return to the joystick testing software.
8. Press and release "BTN7". Should be registered as button #10.
9. Press and hold "ALT", then press and release "BTN7", then release "ALT". Button #11 should be registered.
10. Press and release "BTN3". Should be registered as as D-PAD up.

Part 3 (security lock)

1. Press and hold "BTN2", then press "BTN6", then release both.
2. Enter 03 at field ReportID.
3. Click on Get Feature.
4. Byte in 6th position (after RD 03) must show FF.
5. Enter 04 at field ReportID.
6. Enter 07 20 20 at fields below ReportID. Click on Set Feature.
7. Press and release "BTN7". Should be registered as button #10.
8. Press and hold "BTN2", then press "BTN6", then release both.
9. Enter 07 13 13 at fields below ReportID. Click on Set Feature.
10. Press and release "BTN7". Should be registered as button #20.
11. Enter 03 at field ReportID.
12. Click on Get Feature.
13. Byte in 6th position (after RD 03) must show 00.

Part 4 (axis polarity)

1. Enter 03 at field ReportID.
2. Enter 01 FF FF FF FF FF FF at fields below ReportID. Click on Set Feature.
3. Move "CLUTCH1" or "CLUTCH2" from left to right. Note if axis "RX" or "RY" goes up or down.
4. Enter FF FF FF 05 FF FF FF at fields below ReportID. Click on Set Feature.
5. Enter FF FF FF 06 FF FF FF at fields below ReportID. Click on Set Feature.
6. Move "CLUTCH1" or "CLUTCH2" from left to right, again. Axis "RX" or "RY" must go in the opposite way it did before.
7. Enter FF FF FF 05 FF FF FF at fields below ReportID. Click on Set Feature.
8. Enter FF FF FF 06 FF FF FF at fields below ReportID. Click on Set Feature.

Part 5 (pulse width of rotary encoders)

Subjectivity can not be avoided in this test. SimpleHIDWrite is a better tool to check the "pulse width" of input events. Be conscious of the delay between RD 01 ... lines.

1. Enter 03 at field ReportID.
2. Enter FF FF FF FF FF FF 06 at fields below ReportID. Click on Set Feature.
3. Rotate "RCW". A button press should be registered for a longer time than before.
4. Enter FF FF FF FF FF FF 01 at fields below ReportID. Click on Set Feature.
5. Rotate "RCW". A button press should be registered for a shorter time than before.