Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Allow joysticks to be used without analog pins #10169

Merged
merged 2 commits into from
Aug 27, 2020
Merged

Allow joysticks to be used without analog pins #10169

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
e048841
Allow joysticks to be used without analog pins
skullydazed Aug 25, 2020
7891e9f
change how analog/digital joysticks are specified
skullydazed Aug 25, 2020
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
11 changes: 10 additions & 1 deletion common_features.mk
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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
16 changes: 9 additions & 7 deletions docs/feature_joystick.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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.

Expand All @@ -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).
Expand Down Expand Up @@ -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 {
Expand All @@ -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:
Expand Down
2 changes: 1 addition & 1 deletion keyboards/handwired/onekey/keymaps/joystick/rules.mk
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1 +1 @@
JOYSTICK_ENABLE = yes
JOYSTICK_ENABLE = analog