keyman
keyman copied to clipboard
feat(linux): implement capslock handling with Wayland 🛤️
The Wayland support of ibus is currently non-working. AFAICT it only works with XWayland. Also there are still some APIs in Wayland missing that would allow us to toggle capslock etc, so we use XWayland if available. If XWayland is not available I guess things won't completely work, but there's currently not much we can do about that with ibus.
User Testing
Preparations
- The tests should be run on these Linux platforms:
- GROUP_JAMMY_WAYLAND: Ubuntu 22.04 Jammy with Gnome Shell and Wayland
NOTE: The capslock LED won't properly update if these tests are run in a VM. If possible test on hardware.
-
Reboot
-
Download and unzip these keyboards
-
Install the keyboards by running these commands (in the directory where you unzipped them):
km-package-install -f k_031___caps_lock.kmp km-package-install -f k_032___caps_control.kmp km-package-install -f k_033___caps_always_off.kmp
Tests
TEST_CAPSLOCK: Caps lock works
- switch to "031 - caps lock" keyboard
- verify the capslock LED is on
- press and release capslock key, then press and release the following keys
1
,Shift+2
,Shift+3
,A
andShift+B
- verify the output is
pass.pass.pass.pass.pass.
- verify the capslock LED is still on
- verify the output is
- press and release capslock key
- verify the capslock LED is off
TEST_CAPSCONTROL: Shift releases caps
- make sure capslock is off
- switch to "032 - caps control" keyboard
- verify the capslock LED is off
- press and release
1
key- verify the capslock LED is off
- press and release capslock key
- verify the capslock LED is on
- press and release
2
,Shift+3
,4
- verify the capslock LED is off
- press and release capslock key
- verify the capslock LED is on
- press and release
5
and capslock key- verify the capslock LED is still on
- press and release
6
,Shift
,7
(note: press and releaseShift
on it's own here!)- verify the capslock LED is off
- verify the output is
pass.pass.pass.pass.pass.pass.pass.
TEST_CAPSOFF: Caps always off
- make sure capslock is off
- switch to "033 - caps always off" keyboard
- press and release the following keys. After each key verify the capslock LED is still off.
1
,capslock
,2
,capslock
,3
- verify the output is
pass.pass.pass.
- verify the output is
User Test Results
Test specification and instructions
- ⬜ GROUP_JAMMY_WAYLAND: Ubuntu 22.04 Jammy with Gnome Shell and Wayland
- ⬜ TEST_CAPSLOCK (OPEN)
- ⬜ TEST_CAPSCONTROL (OPEN)
- ⬜ TEST_CAPSOFF (OPEN)
Results Template
# Test Results
### GROUP_JAMMY_WAYLAND: Ubuntu 22.04 Jammy with Gnome Shell and Wayland
* **TEST_CAPSLOCK (OPEN):** notes
* **TEST_CAPSCONTROL (OPEN):** notes
* **TEST_CAPSOFF (OPEN):** notes
Test Artifacts
- Linux
Abandoning for now