qmk/qmk_firmware

[Bug] audio.pins in keyboard.json is not converted to C defines during build

Open

#26106 opened on Mar 27, 2026

View on GitHub
 (2 comments) (0 reactions) (0 assignees)C (20,368 stars) (43,867 forks)batch import
bughelp wanted

Description

Bug Description

The audio.pins property defined in keyboard.json is not converted to AUDIO_PIN / AUDIO_PIN_ALT C defines during the build process, even though it is a valid property in the keyboard JSON schema.

Expected Behavior

When audio.pins is specified in keyboard.json, the build system should generate the corresponding AUDIO_PIN and AUDIO_PIN_ALT defines in info_config.h, similar to how other audio.* properties are handled.

Actual Behavior

The audio.pins value is silently ignored during build. Users must still manually define AUDIO_PIN / AUDIO_PIN_ALT in config.h for audio to work.

Details

  • The JSON schema (data/schemas/keyboard.jsonschema) defines audio.pins as a valid mcu_pin_array.
  • All other audio.* properties have mappings in data/mappings/info_config.hjson and are correctly converted to C defines via generate_config_items() in lib/python/qmk/cli/generate/config_h.py.
  • The reverse direction (config.h → keyboard.json) works correctly: _extract_audio() in lib/python/qmk/info.py reads legacy B5_AUDIO, B6_AUDIO, etc. and populates audio.pins.
  • However, audio.pins has no entry in info_config.hjson, so the forward direction (keyboard.json → C defines) is missing.

Affected Properties

Property keyboard.json → C config.h → keyboard.json
audio.default.on ✅ ✅
audio.default.clicky ✅ ✅
audio.driver ✅ (rules.mk) ✅
audio.power_control.pin ✅ ✅
audio.power_control.on_state ✅ ✅
audio.voices ✅ ✅
audio.macro_beep ✅ ✅
audio.pins ❌ Missing ✅

Contributor guide

Tech stack
cpython
Domain
build system
Issue type
bug
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
3
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
1-3 hours
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
fresh
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
clear
Prerequisites
C programmingQMK firmwareJSON schemaPython
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
45
Research direction
The issue is that `audio.pins` in `keyboard.json` is not converted to C defines. The fix likely involves adding a mapping in `data/mappings/info config.hjson` for `audio.pins` to generate `AUDIO PIN` and `AUDIO PIN ALT` defines, similar to other audio properties. Also check `lib/python/qmk/cli/generate/config h.py` for the `generate config items()` function to ensure the new mapping is processed.