Add Support for USB programmable buttons (#12950)
Thomas Weißschuh
4 years ago
committed by
GitHub
parent
1a68feb842
commit
83988597f4
@ -0,0 +1,74 @@ |
||||
## Programmable Button |
||||
|
||||
Programmable button is a feature that can be used to send keys that have no |
||||
predefined meaning. |
||||
This means they can be processed on the host side by custom software without |
||||
colliding without the operating system trying to interpret these keys. |
||||
|
||||
The keycodes are emitted according to the HID usage |
||||
"Telephony Device Page" (0x0B), "Programmable button usage" (0x07). |
||||
On Linux (> 5.14) they are handled automatically and translated to `KEY_MACRO#` |
||||
keycodes. |
||||
(Up to `KEY_MACRO30`) |
||||
|
||||
### Enabling Programmable Button support |
||||
|
||||
To enable Programmable Button, add the following line to your keymap’s `rules.mk`: |
||||
|
||||
```c |
||||
PROGRAMMABLE_BUTTON_ENABLE = yes |
||||
``` |
||||
|
||||
### Mapping |
||||
|
||||
In your keymap you can use the following keycodes to map key presses to Programmable Buttons: |
||||
|
||||
|Key |Description | |
||||
|------------------------|----------------------| |
||||
|`PROGRAMMABLE_BUTTON_1` |Programmable button 1 | |
||||
|`PROGRAMMABLE_BUTTON_2` |Programmable button 2 | |
||||
|`PROGRAMMABLE_BUTTON_3` |Programmable button 3 | |
||||
|`PROGRAMMABLE_BUTTON_4` |Programmable button 4 | |
||||
|`PROGRAMMABLE_BUTTON_5` |Programmable button 5 | |
||||
|`PROGRAMMABLE_BUTTON_6` |Programmable button 6 | |
||||
|`PROGRAMMABLE_BUTTON_7` |Programmable button 7 | |
||||
|`PROGRAMMABLE_BUTTON_8` |Programmable button 8 | |
||||
|`PROGRAMMABLE_BUTTON_9` |Programmable button 9 | |
||||
|`PROGRAMMABLE_BUTTON_10`|Programmable button 10| |
||||
|`PROGRAMMABLE_BUTTON_11`|Programmable button 11| |
||||
|`PROGRAMMABLE_BUTTON_12`|Programmable button 12| |
||||
|`PROGRAMMABLE_BUTTON_13`|Programmable button 13| |
||||
|`PROGRAMMABLE_BUTTON_14`|Programmable button 14| |
||||
|`PROGRAMMABLE_BUTTON_15`|Programmable button 15| |
||||
|`PROGRAMMABLE_BUTTON_16`|Programmable button 16| |
||||
|`PROGRAMMABLE_BUTTON_17`|Programmable button 17| |
||||
|`PROGRAMMABLE_BUTTON_18`|Programmable button 18| |
||||
|`PROGRAMMABLE_BUTTON_19`|Programmable button 19| |
||||
|`PROGRAMMABLE_BUTTON_20`|Programmable button 20| |
||||
|`PROGRAMMABLE_BUTTON_21`|Programmable button 21| |
||||
|`PROGRAMMABLE_BUTTON_22`|Programmable button 22| |
||||
|`PROGRAMMABLE_BUTTON_23`|Programmable button 23| |
||||
|`PROGRAMMABLE_BUTTON_24`|Programmable button 24| |
||||
|`PROGRAMMABLE_BUTTON_25`|Programmable button 25| |
||||
|`PROGRAMMABLE_BUTTON_26`|Programmable button 26| |
||||
|`PROGRAMMABLE_BUTTON_27`|Programmable button 27| |
||||
|`PROGRAMMABLE_BUTTON_28`|Programmable button 28| |
||||
|`PROGRAMMABLE_BUTTON_29`|Programmable button 29| |
||||
|`PROGRAMMABLE_BUTTON_30`|Programmable button 30| |
||||
|`PROGRAMMABLE_BUTTON_31`|Programmable button 31| |
||||
|`PROGRAMMABLE_BUTTON_32`|Programmable button 32| |
||||
|`PB_1` to `PB_32` |Aliases for keymaps | |
||||
|
||||
### API |
||||
|
||||
You can also use a dedicated API defined in `programmable_button.h` to interact with this feature: |
||||
|
||||
``` |
||||
void programmable_button_clear(void); |
||||
void programmable_button_send(void); |
||||
void programmable_button_on(uint8_t code); |
||||
void programmable_button_off(uint8_t code); |
||||
bool programmable_button_is_on(uint8_t code); |
||||
uint32_t programmable_button_get_report(void); |
||||
void programmable_button_set_report(uint32_t report); |
||||
``` |
||||
@ -0,0 +1,31 @@ |
||||
/*
|
||||
Copyright 2021 Thomas Weißschuh <thomas@t-8ch.de> |
||||
|
||||
This program is free software: you can redistribute it and/or modify |
||||
it under the terms of the GNU General Public License as published by |
||||
the Free Software Foundation, either version 2 of the License, or |
||||
(at your option) any later version. |
||||
|
||||
This program is distributed in the hope that it will be useful, |
||||
but WITHOUT ANY WARRANTY; without even the implied warranty of |
||||
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the |
||||
GNU General Public License for more details. |
||||
|
||||
You should have received a copy of the GNU General Public License |
||||
along with this program. If not, see <http://www.gnu.org/licenses/>.
|
||||
*/ |
||||
|
||||
#include "process_programmable_button.h" |
||||
#include "programmable_button.h" |
||||
|
||||
bool process_programmable_button(uint16_t keycode, keyrecord_t *record) { |
||||
if (keycode >= PROGRAMMABLE_BUTTON_MIN && keycode <= PROGRAMMABLE_BUTTON_MAX) { |
||||
uint8_t button = keycode - PROGRAMMABLE_BUTTON_MIN + 1; |
||||
if (record->event.pressed) { |
||||
programmable_button_on(button); |
||||
} else { |
||||
programmable_button_off(button); |
||||
} |
||||
} |
||||
return true; |
||||
} |
||||
@ -0,0 +1,23 @@ |
||||
/*
|
||||
Copyright 2021 Thomas Weißschuh <thomas@t-8ch.de> |
||||
|
||||
This program is free software: you can redistribute it and/or modify |
||||
it under the terms of the GNU General Public License as published by |
||||
the Free Software Foundation, either version 2 of the License, or |
||||
(at your option) any later version. |
||||
|
||||
This program is distributed in the hope that it will be useful, |
||||
but WITHOUT ANY WARRANTY; without even the implied warranty of |
||||
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the |
||||
GNU General Public License for more details. |
||||
|
||||
You should have received a copy of the GNU General Public License |
||||
along with this program. If not, see <http://www.gnu.org/licenses/>.
|
||||
*/ |
||||
|
||||
#pragma once |
||||
|
||||
#include <stdint.h> |
||||
#include "quantum.h" |
||||
|
||||
bool process_programmable_button(uint16_t keycode, keyrecord_t *record); |
||||
@ -0,0 +1,37 @@ |
||||
/*
|
||||
Copyright 2021 Thomas Weißschuh <thomas@t-8ch.de> |
||||
|
||||
This program is free software: you can redistribute it and/or modify |
||||
it under the terms of the GNU General Public License as published by |
||||
the Free Software Foundation, either version 2 of the License, or |
||||
(at your option) any later version. |
||||
|
||||
This program is distributed in the hope that it will be useful, |
||||
but WITHOUT ANY WARRANTY; without even the implied warranty of |
||||
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the |
||||
GNU General Public License for more details. |
||||
|
||||
You should have received a copy of the GNU General Public License |
||||
along with this program. If not, see <http://www.gnu.org/licenses/>.
|
||||
*/ |
||||
|
||||
#include "programmable_button.h" |
||||
#include "host.h" |
||||
|
||||
#define REPORT_BIT(index) (((uint32_t)1) << (index - 1)) |
||||
|
||||
static uint32_t programmable_button_report = 0; |
||||
|
||||
void programmable_button_clear(void) { programmable_button_report = 0; } |
||||
|
||||
void programmable_button_send(void) { host_programmable_button_send(programmable_button_report); } |
||||
|
||||
void programmable_button_on(uint8_t index) { programmable_button_report |= REPORT_BIT(index); } |
||||
|
||||
void programmable_button_off(uint8_t index) { programmable_button_report &= ~REPORT_BIT(index); } |
||||
|
||||
bool programmable_button_is_on(uint8_t index) { return !!(programmable_button_report & REPORT_BIT(index)); }; |
||||
|
||||
uint32_t programmable_button_get_report(void) { return programmable_button_report; }; |
||||
|
||||
void programmable_button_set_report(uint32_t report) { programmable_button_report = report; } |
||||
@ -0,0 +1,30 @@ |
||||
/*
|
||||
Copyright 2021 Thomas Weißschuh <thomas@t-8ch.de> |
||||
|
||||
This program is free software: you can redistribute it and/or modify |
||||
it under the terms of the GNU General Public License as published by |
||||
the Free Software Foundation, either version 2 of the License, or |
||||
(at your option) any later version. |
||||
|
||||
This program is distributed in the hope that it will be useful, |
||||
but WITHOUT ANY WARRANTY; without even the implied warranty of |
||||
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the |
||||
GNU General Public License for more details. |
||||
|
||||
You should have received a copy of the GNU General Public License |
||||
along with this program. If not, see <http://www.gnu.org/licenses/>.
|
||||
*/ |
||||
|
||||
#pragma once |
||||
|
||||
#include <stdint.h> |
||||
#include <stdbool.h> |
||||
#include "report.h" |
||||
|
||||
void programmable_button_clear(void); |
||||
void programmable_button_send(void); |
||||
void programmable_button_on(uint8_t index); |
||||
void programmable_button_off(uint8_t index); |
||||
bool programmable_button_is_on(uint8_t index); |
||||
uint32_t programmable_button_get_report(void); |
||||
void programmable_button_set_report(uint32_t report); |
||||
Loading…
Reference in new issue