rekahsoft/qmk-firmware
1
0
Fork 0
Code Issues Pull Requests Releases Wiki Activity

Implement data driven joysticks (#22947)

Browse Source
This commit is contained in:
Joel Challis 2024-06-18 03:44:22 +01:00 committed by GitHub
parent 938badc3b0
commit 53a0cdc446
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194
10 changed files with 97 additions and 31 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

5
data/mappings/info_config.hjson
View File

@ -72,6 +72,11 @@
"LED_KANA_PIN": {"info_key": "indicators.kana"},
"LED_PIN_ON_STATE": {"info_key": "indicators.on_state", "value_type": "int"},
// Joystick
"JOYSTICK_AXIS_COUNT": {"info_key": "joystick.axis_count", "value_type": "int"},
"JOYSTICK_AXIS_RESOLUTION": {"info_key": "joystick.axis_resolution", "value_type": "int"},
"JOYSTICK_BUTTON_COUNT": {"info_key": "joystick.button_count", "value_type": "int"},
// Leader Key
"LEADER_PER_KEY_TIMING": {"info_key": "leader_key.timing", "value_type": "flag"},
"LEADER_KEY_STRICT_KEY_PROCESSING": {"info_key": "leader_key.strict_processing", "value_type": "flag"},

2
data/mappings/info_rules.hjson
View File

@ -25,6 +25,8 @@
"ENCODER_DRIVER": {"info_key": "encoder.driver"},
"FIRMWARE_FORMAT": {"info_key": "build.firmware_format"},
"HAPTIC_DRIVER": {"info_key": "haptic.driver"},
"JOYSTICK_DRIVER": {"info_key": "joystick.driver"},
"JOYSTICK_ENABLE": {"info_key": "joystick.enabled", "value_type": "bool"},
"KEYBOARD_SHARED_EP": {"info_key": "usb.shared_endpoint.keyboard", "value_type": "bool"},
"LAYOUTS": {"info_key": "community_layouts", "value_type": "list"},
"LED_MATRIX_DRIVER": {"info_key": "led_matrix.driver"},

30
data/schemas/keyboard.jsonschema
View File

@ -342,6 +342,36 @@
"on_state": {"$ref": "qmk.definitions.v1#/bit"}
}
},
"joystick": {
"type": "object",
"properties": {
"enabled": {"type": "boolean"},
"driver": {"type": "string"},
"button_count": {"$ref": "qmk.definitions.v1#/unsigned_int"},
"axis_resolution": {"$ref": "qmk.definitions.v1#/unsigned_int"},
"axes": {
"type": "object",
"propertyNames": {"enum": ["x", "y", "z", "rx", "ry", "rz"]}
"additionalProperties": {
"oneOf": [
{
"type": "object",
"properties": {
"input_pin": {"$ref": "qmk.definitions.v1#/mcu_pin"},
"low": {"$ref": "qmk.definitions.v1#/unsigned_int"},
"rest": {"$ref": "qmk.definitions.v1#/unsigned_int"},
"high": {"$ref": "qmk.definitions.v1#/unsigned_int"}
}
},
{
"type": "string",
"enum": ["virtual"]
}
]
}
}
}
},
"keycodes": {"$ref": "qmk.definitions.v1#/keycode_decl_array"},
"layout_aliases": {
"type": "object",

6
keyboards/handwired/battleship_gamepad/battleship_gamepad.c
View File

@ -16,12 +16,6 @@
#include "quantum.h"
/* joystick config */
joystick_config_t joystick_axes[JOYSTICK_AXIS_COUNT] = {
[0] = JOYSTICK_AXIS_IN(F5, 1023, 512, 0),
[1] = JOYSTICK_AXIS_IN(F4, 0, 512, 1023)
};
/* joystick button code (thumbstick pressed) */
void keyboard_pre_init_kb(void) {
gpio_set_pin_input_high(F6);

21
keyboards/handwired/battleship_gamepad/config.h
View File

@ -1,21 +0,0 @@
/* Copyright 2021 Andrew Braini
*
* 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
/* joystick configuration */
#define JOYSTICK_BUTTON_COUNT 25
#define JOYSTICK_AXIS_RESOLUTION 10

8
keyboards/handwired/battleship_gamepad/keyboard.json
View File

@ -13,6 +13,14 @@
"rows": ["B6", "B2", "B3", "B1", "F7"]
},
"diode_direction": "COL2ROW",
"joystick": {
"button_count": 25,
"axis_resolution": 10,
"axes": {
"x": {"input_pin": "F5", "low": 1023, "rest": 512, "high": 0},
"y": {"input_pin": "F4", "low": 0, "rest": 512, "high": 1023}
}
},
"processor": "atmega32u4",
"bootloader": "caterina",
"features": {

1
keyboards/handwired/battleship_gamepad/rules.mk
View File

@ -1 +0,0 @@
JOYSTICK_DRIVER = analog

38
lib/python/qmk/cli/generate/keyboard_c.py
View File

@ -6,7 +6,7 @@ from qmk.info import info_json
from qmk.commands import dump_lines
from qmk.keyboard import keyboard_completer, keyboard_folder
from qmk.path import normpath
from qmk.constants import GPL2_HEADER_C_LIKE, GENERATED_HEADER_C_LIKE
from qmk.constants import GPL2_HEADER_C_LIKE, GENERATED_HEADER_C_LIKE, JOYSTICK_AXES
def _gen_led_configs(info_data):
@ -91,6 +91,41 @@ def _gen_matrix_mask(info_data):
return lines
def _gen_joystick_axes(info_data):
"""Convert info.json content to joystick_axes
"""
if 'axes' not in info_data.get('joystick', {}):
return []
axes = info_data['joystick']['axes']
axes_keys = list(axes.keys())
lines = []
lines.append('#ifdef JOYSTICK_ENABLE')
lines.append('joystick_config_t joystick_axes[JOYSTICK_AXIS_COUNT] = {')
# loop over all available axes - injecting virtual axis for those not specified
for index, cur in enumerate(JOYSTICK_AXES):
# bail out if we have generated all requested axis
if len(axes_keys) == 0:
break
axis = 'virtual'
if cur in axes:
axis = axes[cur]
axes_keys.remove(cur)
if axis == 'virtual':
lines.append(f" [{index}] = JOYSTICK_AXIS_VIRTUAL,")
else:
lines.append(f" [{index}] = JOYSTICK_AXIS_IN({axis['input_pin']}, {axis['low']}, {axis['rest']}, {axis['high']}),")
lines.append('};')
lines.append('#endif')
return lines
@cli.argument('-o', '--output', arg_only=True, type=normpath, help='File to write to')
@cli.argument('-q', '--quiet', arg_only=True, action='store_true', help="Quiet mode, only output error messages")
@cli.argument('-kb', '--keyboard', arg_only=True, type=keyboard_folder, completer=keyboard_completer, required=True, help='Keyboard to generate keyboard.c for.')
@ -105,6 +140,7 @@ def generate_keyboard_c(cli):
keyboard_h_lines.extend(_gen_led_configs(kb_info_json))
keyboard_h_lines.extend(_gen_matrix_mask(kb_info_json))
keyboard_h_lines.extend(_gen_joystick_axes(kb_info_json))
# Show the results
dump_lines(cli.args.output, keyboard_h_lines, cli.args.quiet)

2
lib/python/qmk/constants.py
View File

@ -320,3 +320,5 @@ LICENSE_TEXTS = [
you may not use this file except in compliance with the License.
"""]),
]
JOYSTICK_AXES = ['x', 'y', 'z', 'rx', 'ry', 'rz']

15
lib/python/qmk/info.py
View File

@ -7,7 +7,7 @@ from dotty_dict import dotty
from milc import cli
from qmk.constants import COL_LETTERS, ROW_LETTERS, CHIBIOS_PROCESSORS, LUFA_PROCESSORS, VUSB_PROCESSORS
from qmk.constants import COL_LETTERS, ROW_LETTERS, CHIBIOS_PROCESSORS, LUFA_PROCESSORS, VUSB_PROCESSORS, JOYSTICK_AXES
from qmk.c_parse import find_layouts, parse_config_h_file, find_led_config
from qmk.json_schema import deep_update, json_load, validate
from qmk.keyboard import config_h, rules_mk
@ -249,8 +249,9 @@ def info_json(keyboard):
info_data = _extract_rules_mk(info_data, rules_mk(str(keyboard)))
info_data = _extract_config_h(info_data, config_h(str(keyboard)))
# Ensure that we have matrix row and column counts
# Ensure that we have various calculated values
info_data = _matrix_size(info_data)
info_data = _joystick_axis_count(info_data)
# Merge in data from <keyboard.c>
info_data = _extract_led_config(info_data, str(keyboard))
@ -800,6 +801,16 @@ def _matrix_size(info_data):
return info_data
def _joystick_axis_count(info_data):
"""Add info_data['joystick.axis_count'] if required
"""
if 'axes' in info_data.get('joystick', {}):
axes_keys = info_data['joystick']['axes'].keys()
info_data['joystick']['axis_count'] = max(JOYSTICK_AXES.index(a) for a in axes_keys) + 1 if axes_keys else 0
return info_data
def _check_matrix(info_data):
"""Check the matrix to ensure that row/column count is consistent.
"""