aboutsummaryrefslogtreecommitdiff
path: root/docs
diff options
context:
space:
mode:
authorZach White <skullydazed@gmail.com>2020-08-27 09:38:04 -0700
committerJames Young <18669334+noroadsleft@users.noreply.github.com>2020-08-29 14:30:02 -0700
commitbdd8d2679ba74715b38f958b071fd57eaf092b9d (patch)
tree734407eaf72d2f408a6c0ab7ffb539df0c62bdc3 /docs
parent629cfc7f5ebd815231c9e3f969170995db1481c6 (diff)
downloadqmk_firmware-bdd8d2679ba74715b38f958b071fd57eaf092b9d.tar.gz
qmk_firmware-bdd8d2679ba74715b38f958b071fd57eaf092b9d.zip
Allow joysticks to be used without analog pins (#10169)
* Allow joysticks to be used without analog pins * change how analog/digital joysticks are specified
Diffstat (limited to 'docs')
-rw-r--r--docs/feature_joystick.md16
1 files changed, 9 insertions, 7 deletions
diff --git a/docs/feature_joystick.md b/docs/feature_joystick.md
index 58dfc7b8d..be3c781f6 100644
--- a/docs/feature_joystick.md
+++ b/docs/feature_joystick.md
@@ -2,11 +2,7 @@
2 2
3The keyboard can be made to be recognized as a joystick HID device by the operating system. 3The keyboard can be made to be recognized as a joystick HID device by the operating system.
4 4
5This is enabled by adding the following to `rules.mk`: 5This is enabled by adding `JOYSTICK_ENABLE` to `rules.mk`. You can set this value to `analog`, `digital`, or `no`.
6
7```makefile
8JOYSTICK_ENABLE = yes
9```
10 6
11!> Joystick support is not currently available on V-USB devices. 7!> Joystick support is not currently available on V-USB devices.
12 8
@@ -19,6 +15,12 @@ or send gamepad reports based on values computed by the keyboard.
19 15
20### Analog Input 16### Analog Input
21 17
18To use analog input you must first enable it in `rules.mk`:
19
20```makefile
21JOYSTICK_ENABLE = analog
22```
23
22An analog device such as a potentiometer found on a gamepad's analog axes is based on a [voltage divider](https://en.wikipedia.org/wiki/Voltage_divider). 24An analog device such as a potentiometer found on a gamepad's analog axes is based on a [voltage divider](https://en.wikipedia.org/wiki/Voltage_divider).
23It is composed of three connectors linked to the ground, the power input and power output (usually the middle one). The power output holds the voltage that varies based on the position of the cursor, 25It is composed of three connectors linked to the ground, the power input and power output (usually the middle one). The power output holds the voltage that varies based on the position of the cursor,
24which value will be read using your MCU's [ADC](https://en.wikipedia.org/wiki/Analog-to-digital_converter). 26which value will be read using your MCU's [ADC](https://en.wikipedia.org/wiki/Analog-to-digital_converter).
@@ -75,7 +77,7 @@ You assign a value by writing to `joystick_status.axes[axis_index]` a signed 8-b
75The following example writes two axes based on keypad presses, with `KC_P5` as a precision modifier: 77The following example writes two axes based on keypad presses, with `KC_P5` as a precision modifier:
76 78
77```c 79```c
78#ifdef JOYSTICK_ENABLE 80#ifdef ANALOG_JOYSTICK_ENABLE
79static uint8_t precision_val = 70; 81static uint8_t precision_val = 70;
80static uint8_t axesFlags = 0; 82static uint8_t axesFlags = 0;
81enum axes { 83enum axes {
@@ -89,7 +91,7 @@ enum axes {
89 91
90bool process_record_user(uint16_t keycode, keyrecord_t *record) { 92bool process_record_user(uint16_t keycode, keyrecord_t *record) {
91 switch(keycode) { 93 switch(keycode) {
92#ifdef JOYSTICK_ENABLE 94#ifdef ANALOG_JOYSTICK_ENABLE
93 // virtual joystick 95 // virtual joystick
94# if JOYSTICK_AXES_COUNT > 1 96# if JOYSTICK_AXES_COUNT > 1
95 case KC_P8: 97 case KC_P8: