Allow joysticks to be used without analog pins (#10169)

* Allow joysticks to be used without analog pins

* change how analog/digital joysticks are specified
This commit is contained in:
Zach White 2020-08-27 09:38:04 -07:00 committed by James Young
parent 629cfc7f5e
commit bdd8d2679b
3 changed files with 20 additions and 9 deletions

View File

@ -536,9 +536,18 @@ ifeq ($(strip $(AUTO_SHIFT_ENABLE)), yes)
endif
endif
ifeq ($(strip $(JOYSTICK_ENABLE)), yes)
JOYSTICK_ENABLE ?= no
ifneq ($(strip $(JOYSTICK_ENABLE)), no)
OPT_DEFS += -DJOYSTICK_ENABLE
SRC += $(QUANTUM_DIR)/process_keycode/process_joystick.c
SRC += $(QUANTUM_DIR)/joystick.c
endif
ifeq ($(strip $(JOYSTICK_ENABLE)), analog)
OPT_DEFS += -DANALOG_JOYSTICK_ENABLE
SRC += analog.c
endif
ifeq ($(strip $(JOYSTICK_ENABLE)), digital)
OPT_DEFS += -DDIGITAL_JOYSTICK_ENABLE
endif

View File

@ -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:

View File

@ -1 +1 @@
JOYSTICK_ENABLE = yes
JOYSTICK_ENABLE = analog