3.4 KiB
3.4 KiB
Release testing
Before a new release of Kaleidoscope, the following test process should be run through on all supported operating systems.
(As of August 2017, this whole thing really applies to Model01-Firmware, but we hope to generalize it to Kaleidoscope)
Tested operating systems
- The latest stable Ubuntu Linux release running X11. (We should eventually be testing both X11 and Wayland)
- The latest stable release of macOS
- An older Mac OS X release TBD. (There were major USB stack changes in 10.9 or so)
- Windows 10
- Windows 7
- The current release of ChromeOS
- A currentish android tablet that supports USB Host
- an iOS device (once we fix the usb connection issue to limit power draw)
Test process
Basic testing
- Plug the keyboard in
- Make sure the host OS doesn't throw an error
- Make sure the LED in the top left doesn't glow red
- Make sure the LED in the top-right corner of the left side breathes blue for ~10s
- Bring up some sort of notepad app or text editor
Basic testing, part 2
- Test typing of shifted and unshifted letters and numbers with and without key repeat
- Test typing of fn-shifted characters: []{}|\ with and without key repeat
- Test that 'Any' key generates a random letter or number and that key repeat works
- Test fn-hjkl to move the cursor
- Test Fn-WASD to move the mouse
- Test Fn-RFV for the three mouse buttons
- Test Fn-BGTabEsc for mouse warp
- Test that LeftFn+RightFn + hjkl move the cursor
- Verify that leftfn+rightfn do not light up the numpad
NKRO
- Open the platform's native key event viewer (If not available, visit https://www.microsoft.com/appliedsciences/KeyboardGhostingDemo.mspx in a browser)
- Press as many keys as your fingers will let you
- Verify that the keymap reports all the keys you're pressing
Test media keys
- Fn-Any: previous track
- Fn-Y: next-track
- Fn-Enter: play/pause
- Fn-Butterfly: Windows 'menu' key
- Fn-n: mute
- Fn-m: volume down
- Fn-,: volume up
Test numlock
- Tap "Num"
- Verify that the numpad lights up red
- Verify that the num key is breathing blue
- Verify that numpad keys generate numbers
- Tap the Num key
- Verify that the numpad keys stop being lit up 1 Verify that 'jkl' don't generate numbers.
Test LED Effects
- Tap the LED key
- Verify that there is a rainbow effect
- Tap the LED key a few more times and verify that other LED effects show up
- Verify that you can still type.
Second connection
- Unplug the keyboard
- Plug the keyboard back in
- Make sure you can still type
Programming
- If the OS has a way to show serial port devices, verify that the keyboard's serial port shows up.
- If you can run stty, as you can on linux and macos, make sure you can tickle the serial port at 1200 bps. Linux: stty -F /dev/ttyACM0 1200 Mac:
- If you tickle the serial port without holding down the prog key, verify that the Prog key does not light up red
- If you hold down the prog key before tickling the serial port, verify that the Prog key's LED lights up red.
- Unplug the keyboard
- While holding down prog, plug the keyboard in
- Verify that the prog key is glowing red.
- Unplug the keyboard
- Plug the keyboard in
- Verify that the prog key is not glowing red.
If the current platform supports the Arduino IDE (Win/Lin/Mac)
- use the Arduino IDE to reflash the current version of the software.
- Verify that you can type a few keys
- Verify that the LED key toggles between LED effects