diff options
| author | Zach White <skullydazed@gmail.com> | 2020-08-27 09:38:04 -0700 |
|---|---|---|
| committer | James Young <18669334+noroadsleft@users.noreply.github.com> | 2020-08-29 14:30:02 -0700 |
| commit | bdd8d2679ba74715b38f958b071fd57eaf092b9d (patch) | |
| tree | 734407eaf72d2f408a6c0ab7ffb539df0c62bdc3 /docs | |
| parent | 629cfc7f5ebd815231c9e3f969170995db1481c6 (diff) | |
| download | firmware-bdd8d2679ba74715b38f958b071fd57eaf092b9d.tar.gz firmware-bdd8d2679ba74715b38f958b071fd57eaf092b9d.tar.bz2 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.md | 16 |
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 @@ The keyboard can be made to be recognized as a joystick HID device by the operating system. -This is enabled by adding the following to `rules.mk`: - -```makefile -JOYSTICK_ENABLE = yes -``` +This is enabled by adding `JOYSTICK_ENABLE` to `rules.mk`. You can set this value to `analog`, `digital`, or `no`. !> Joystick support is not currently available on V-USB devices. @@ -19,6 +15,12 @@ or send gamepad reports based on values computed by the keyboard. ### Analog Input +To use analog input you must first enable it in `rules.mk`: + +```makefile +JOYSTICK_ENABLE = analog +``` + An 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). It 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, which 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 The following example writes two axes based on keypad presses, with `KC_P5` as a precision modifier: ```c -#ifdef JOYSTICK_ENABLE +#ifdef ANALOG_JOYSTICK_ENABLE static uint8_t precision_val = 70; static uint8_t axesFlags = 0; enum axes { @@ -89,7 +91,7 @@ enum axes { bool process_record_user(uint16_t keycode, keyrecord_t *record) { switch(keycode) { -#ifdef JOYSTICK_ENABLE +#ifdef ANALOG_JOYSTICK_ENABLE // virtual joystick # if JOYSTICK_AXES_COUNT > 1 case KC_P8: |