Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/OpenVoiceOS/ovos_ww_plugin_hotkeys
map key presses to OVOS bus events
https://github.com/OpenVoiceOS/ovos_ww_plugin_hotkeys
Last synced: about 2 months ago
JSON representation
map key presses to OVOS bus events
- Host: GitHub
- URL: https://github.com/OpenVoiceOS/ovos_ww_plugin_hotkeys
- Owner: OpenVoiceOS
- License: apache-2.0
- Created: 2021-08-02T12:16:59.000Z (about 3 years ago)
- Default Branch: master
- Last Pushed: 2024-04-27T13:33:48.000Z (5 months ago)
- Last Synced: 2024-05-19T04:40:51.333Z (4 months ago)
- Language: Python
- Homepage:
- Size: 85 KB
- Stars: 0
- Watchers: 5
- Forks: 3
- Open Issues: 3
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
- awesome-ovos-plugins - ovos-ww-plugin-hotkeys
README
## Hotkeys PHAL plugin
plugin for Keyboard hotkeys, define key combos to trigger bus events
## Install
you need to add your user to the `tty` and `input` groups
`sudo usermod -a -G tty,input $USER`
more info in [this issue](https://github.com/boppreh/keyboard/issues/312)
Then install the plugin
`pip install ovos-PHAL-plugin-hotkeys`
## Configuration
Add any bus message + key combo under `"key_down"` and `"key_up"`
You may want to react when a key is pressed, or when a key is released
A complete example based on events from a generic G20 USB remote
```json
"PHAL": {
"ovos-PHAL-plugin-hotkeys": {
"debug": false,
"key_down": {
"mycroft.mic.listen": 582,
"mycroft.mic.mute.toggle": 190,
"mycroft.mic.mute": "shift+m",
"mycroft.mic.unmute": "shift+u",
"mycroft.volume.increase": 115,
"mycroft.volume.decrease": 114,
"mycroft.volume.mute.toggle": 113,
"mycroft.volume.mute": "ctrl+shift+m",
"mycroft.volume.unmute": "ctrl+shift+u",
"homescreen.manager.show_active": 144,
"ovos.common_play.play_pause": 164
}
}
}
```
For the Mark2 drivers you can find the emitted key events in the [sj201-buttons-overlay.dts](https://github.com/OpenVoiceOS/VocalFusionDriver/blob/main/sj201-buttons-overlay.dts#L18) file
```json
"PHAL": {
"ovos-PHAL-plugin-hotkeys": {
"key_down": {
"mycroft.mic.listen": 582,
"mycroft.mic.mute": 248,
"mycroft.volume.increase": 115,
"mycroft.volume.decrease": 114
},
"key_up": {
"mycroft.mic.unmute": 248
}
}
}
```
> gpios 22-24 are the momentary switches; 25 is MuteMic SW connected to 3.3v or GND
## Finding keys
A list of valid key scancodes can be found [here](http://wiki.linuxcnc.org/cgi-bin/wiki.pl?Scancodes)
Some key presses might not be correctly detected and show up as "unknown", some devices might also emit the wrong keycodes
In this case you can enable the `debug` flag in the config, then check the logs
```commandline
DEBUG {"event_type": "down", "scan_code": 57, "name": "space", "time": 1711050758.24674, "device": "/dev/input/event4", "is_keypad": false, "modifiers": []}
DEBUG {"event_type": "down", "scan_code": 24, "name": "o", "time": 1711050758.510758, "device": "/dev/input/event4", "is_keypad": false, "modifiers": []}
DEBUG {"event_type": "down", "scan_code": 115, "name": "unknown", "time": 1711050858.940323, "device": "/dev/input/event3", "is_keypad": false, "modifiers": []}
DEBUG {"event_type": "down", "scan_code": 114, "name": "unknown", "time": 1711050864.262953, "device": "/dev/input/event3", "is_keypad": false, "modifiers": []}
```
You can then use the `scan_code` integer in your config instead of `name` string
## Credits
- keyboard handling taken from [boppreh/keyboard](https://github.com/boppreh/keyboard) package