mirror of
https://github.com/Keychron/qmk_firmware.git
synced 2024-12-24 18:25:01 +06:00
c80e5f9f88
* Redo Arm DAC implementation for additive, wavetable synthesis, sample playback
changes by Jack Humbert on an implementation for DAC audio on arm/chibios platforms
this commits bundles the changes from the arm-dac-work branch focused on audio/audio_arm.* into one commit (leaving out the test-keyboard)
f52faeb5d (origin/arm-dac-work) add sample and wavetable examples, parsers for both
-> only the changes on audio_arm_.*, the keyboard related parts are split off to a separate commit
bfe468ef1 start morphing wavetable
474d100b5 refined a bit
208bee10f play_notes working
3e6478b0b start in-place documentation of dac settings
3e1826a33 fixed blip (rounding error), other waves, added key selection (left/right)
73853d651 5 voices at 44.1khz
dfb401b95 limit voices to working number
9632b3379 configuration for the ez
6241f3f3b notes working in a new way
* Redo Arm DAC implementation for additive, wavetable synthesis, sample playback
changes by Jack Humbert on an implementation for DAC audio on arm/chibios platforms
this commit splits off the plank example keymap from commit
f52faeb5d (origin/arm-dac-work) add sample and wavetable examples, parsers for both
* refactoring: rename audio_ to reflect their supported hardware-platform and audio-generation method: avr vs arm, and pwm vs dac
* refactoring: deducplicate ISR code to update the pwm duty-cycle and period in the avr-pwm-implementation
pulls three copies of the same code into one function
which should improve readability and maintainability :-)
* refactoring: move common code of arm and avr implementation into a separate/new file
* refactoring: audio_avr_pwm, renaming defines to decouple them from actually used timers, registers and ISRs
* refactoring: audio_avr_pwm - replacing function defines with plain register defines
aligns better with other existing qmk code (and the new audio_arm_pwm) doing similar pwm thing
* add audio-arm-pwm
since not all STM32 have a DAC onboard (STM32F2xx and STM32F3xx), pwm-audio is an alternative (STM32F1xx)
this code works on a "BluePill" clone, with an STM32F103C8B
* clang-format changes on quantum/audio/* only
* audio_arm_dac: stopping the notes caused screeching when using the DAC audio paths
* audio_arm_pwm: use pushpull on the pin; so that a piezzo can be hooked up direclty without additional components (opendrain would require an external pullup)
* refactoring: remove unused file from/for atmel-avr chips
* refactoring: remove unused (avr) wavetable file
* audio_arm_dac: adapt dac_end callback to changed chibios DAC api
the previous chibios (17.6.0) passed along a pointer into the buffer plus a sample_count (which are/already where included in the DACDrivre object) - the current chibios (19.1.0) only passes the driver object.
this patch ports more or less exactly what the previous chibios ISR code did: either have the user-callback work the first or second half of the buffer (dacsample_t pointer, with half the DAC_BUFFER_SIZE samples) by adjusting the pointer and sample count
* audio-arm-dac: show a compile-warning on undefined audio-pins
Co-Authored-By: Drashna Jaelre <drashna@live.com>
* audio_arm_dac: switch from exemplary wavetable generation to sine only
sine+triangle+squrare is exemplary, and not realy fit for "production" use
'stairs' are usefull for debugging (hardware, with an oscilloscope)
* audio_arm_dac: enable output buffers in the STM32
to drive external loads without any additional ciruitry - external opamps and such
* audio: prevent out-of-bounds array access
* audio_arm_dac: add output-frequency correcting factor
* audio_arm_pwm: get both the alternate-function and pm-callback variants back into working condition
and do some code-cleanup, refine documentation, ...
* audio_arm_pwm: increase pwm frequency for "higher fidelity"
on the previous .frequency=100000 higher frequency musical notes came out wrong
(frequency measured on a Tektronix TDS2014B)
note | freq | arm-pwm
C2 | 65.4 | 65.491
C5 | 523.25 | 523.93
C6 | 1046.5 | 1053.38
C7 | 2093 | 2129
C8 | 4186 | 4350.91
with .frequency = 500000
C8 | 4186 | 4204.6
* audio refactoring: remove unused variables
* audio_arm_dac: calibrate note tempo: with a tempo of 60beats-per-second a whole-note should last for exactly one second
* audio: allow feature selection in rules.mk
so the user can switch the audio driver between DAC and PWM on STM32 boards which support both (STM32F2 and up)
or select the "pin alternate" pwm mode, for example on STM32F103
* audio-refactoring: move codeblocks in audio.[ch] into more coherent groups
and add some inline documentation
* audio-refactoring: cleanup and streamline common code between audio_arm_[dac|pwm]
untangeling the relation between audio.c and the two drivers
and adding more documenting comments :-)
* audio_avr_pwm: getting it back into working condition, and cleanup+refactor
* audio-refactoring: documentation and typo fixes
Co-Authored-By: Nick Brassel <nick@tzarc.org>
* audio-refactoring: cleanup defines, inludes and remove debug-prints
* audio_chibios_dac: define&use a minimal sampling rate, based on the available tone-range
to ease up on the cpu-load, while still rendering the higher notes/tones sufficiently
also reenable the lower tones, since with the new implementation there is no evidence of them still beeing 'bugged'
* audio-refactoring: one common AUDIO_MAX_VOICES define for all audio-drivers
* audio-chibios-pwm: pwm-pin-allternate: make the the timer, timer-channel and alternate function user-#definable
* audio_chibios_dac: math.h has fmod for this
* Redo Arm DAC implementation for additive, wavetable synthesis, sample playback
update Jack Humberts dac-example keymaps for the slight changes in the audio-dac interface
* audio-refactoring: use a common AUDIO_PIN configuration switch instead of defines
have the user select a pin by configuration in rules.mk instead of a define in config.h
has the advantage of beeing in a common form/pattern across all audio-driver implementations
* audio-refactoring: switch backlight_avr.c to the new AUDIO_PIN defines
* audio-common: have advance_note return a boolean if the note changed, to the next one in the melody beeing played
* audio-chibios-pwm: fix issue with ~130ms silence between note/frequency changes while playing a SONG
through trial,error and a scope/logic analyzer figured out Chibios-PWMDriver (at least in the current version) misbehaves if the initial period is set to zero (or one; two seems to work); when thats the case subsequent calls to 'pwmChhangePeriod' + pwmEnableChannel took ~135ms of silence, before the PWM continued with the new frequency...
* audio-refactoring: get 'play_note' working again
with a limited number of available voices (say AUDIO_VOICES_MAX=1) allow new frequencies to be played, by discarding the oldest one in the 'frequencies' queue
* audio: set the fallback driver to DAC for chibios and PWM for all others (==avr at the moment)
* audio-refactoring: moore documentation
and some cleanup
* audio-avr-pwm: no fallback on unset AUDIO_PIN
this seems to be the expected behaviour by some keyboards (looking at ckeys/handwire_101:default) which otherwise fail to build because the firmware-image ends up beeing too large for the atmega... so we fail silently instead to keep travis happy
* audio-refactoring: untangling terminology: voice->tone
the code actually was working on tones (combination of pitch/frequency, duration, timbre, intensity/volume) and not voices (characteristic sound of an instrument; think piano vs guitar, which can be played together, each having its own "track" = voice on a music sheet)
* audio-pwm: allow freq=0 aka a pause/rest in a SONG
continue processing, but do not enable pwm units, since freq=0 wouldn't produce any sound anyway (and lead to division by zero on that occasion)
* audio-refactoring: audio_advance_note -> audio_advance_state
since it does not only affect 'one note', but the internally kept state as a whole
* audio-refactoring: untangling terminology: polyphony
the feature om the "inherited" avr code has little to do with polyphony (see wikipedia), but is more a time-multiplexing feature, to work around hardware limitations - like only having one pwm channel, that could on its own only reproduce one voice/instrument at a time
* audio-chibios-dac: add zero-crossing feature
have tones only change/stop when the waveform approaches zero - to avoid audible clicks
note that this also requires the samples to start at zero, since the internally kept index into the samples is reset to zero too
* audio-refactoring: feature: time-multiplexing of tones on a single output channel
this feature was in the original avr-pwm implementation misnomed as "polyphony"
with polyphony_rate and so on; did the same thing though: time-multiplexing multiple active notes so that a single output channel could reproduce more than one note at a time (which is not the same as a polyphony - see wikipedia :-) )
* audio-avr-pwm: get music-mode working (again) on AVRs
with both pwm channels, or either one of the two :-)
play_notes worked already - but music_mode uses play_note
* audio-refactoring: split define MAX_SIMULTANEOUS_TONES -> TONE_STACKSIZE
since the two cases are independant from one another, the hardware might impose limitations on the number of simultaneously reproducable tones, but the audio state should be able to track an unrelated number of notes recently started by play_note
* audio-arm-dac: per define selectable sample-luts
plus generation script in ./util
* audio-refactoring: heh, avr has a MIN...
* audio-refactoring: add basic dac audio-driver based on the current/master implementation
whereas current=d96380e65496912e0f68e6531565f4b45efd1623
which is the state of things before this whole audio-refactoring branch
boiled down to interface with the refactored audio system = removing all
redundant state-managing and frequency calculation
* audio-refactoring: rename audio-drivers to driver_$PLATFORM_$DRIVER
* audio-arm-pwm: split the software/hardware implementations into separate files
which saves us partially from a 'define hell', with the tradeoff that now two somewhat similar chibios_pwm implementations have to be maintained
* audio-refactoring: update documentation
* audio-arm-dac: apply AUDIO_PIN defines to driver_chibios_dac_basic
* audio-arm-dac: dac_additive: stop the hardware when the last sample completed
the audio system calls for a driver_stop, which is delayed until the current sample conversion finishes
* audio-refactoring: make function-namespace consistent
- all (public) audio functions start with audio_
- also refactoring play*_notes/tones to play*_melody, to visually distance it a bit from play*_tone/_note
* audio-refactoring: consistent define namespace: DAC_ -> AUDIO_DAC_
* audio-arm-dac: update (inline) documentation regarding MAX for sample values
* audio-chibios-dac: remove zero-crossing feature
didn't quite work as intended anyway, and stopping the hardware on close-to-zero seems to be enought anyway
* audio-arm-dac: dac_basic: respect the configured sample-rate
* audio-arm-pwm: have 'note_timbre' influence the pwm-duty cycle
like it already does in the avr implementation
* audio-refactoring: get VIBRATO working (again)
with all drivers (verified with chibios_[dac|pwm])
* audio-arm-dac: zero-crossing feature (Mk II)
wait for the generated waveform to approach 'zero' before either turning off the output+timer or switching to the current set of active_tones
* audio-refactoring: re-add note-resting -> introduce short_rest inbetween
- introduce a short pause/rest between two notes of the same frequency, to separate them audibly
- also updating the refactoring comments
* audio-refactoring: cleanup refactoring remnants
remove the former avr-isr code block - since all its features are now refactored into the different parts of the current system
also updates the TODOS
* audio-refactoring: reserve negative numbers as unitialized frequencies
to allow the valid tone/frequency f=0Hz == rest/pause
* audio-refactoring: FIX: first note of melody was missing
the first note was missing because 'goto_next_note'=false overrode a state_change=true of the initial play_tone
and some code-indentations/cleanup of related parts
* audio-arm-dac: fix hardware init-click
due to wron .init= value
* audio-refactoring: new conveniance function: audio_play_click
which can be used to further refactor/remove fauxclicky (avr only) and/or the 'clicky' features
* audio-refactoring: clang-format on quantum/audio/*
* audio-avr-pwm: consecutive notes of the same frequency get a pause inserted inbetween by audio.c
* audio-refactoring: use milliseconds instead of seconds for 'click' parameters
clicks are supposed to be short, seconds make little sense
* audio-refactoring: use timer ticks instead of counters
local counters were used in the original (avr)ISR to advance an index into the lookup tables (for vibrato), and something similar was used for the tone-multiplexing feature
decoupling these from the (possibly irregular) calls to advance_state made sesne, since those counters/lookups need to be in relation to a wall-time anyway
* audio-refactoring: voices.c: drop 'envelope_index' counter in favour of timer ticks
* audio-refactoring: move vibrato and timbre related parts from audio.c to voices.c
also drops the now (globally) unused AUDIO_VIBRATO/AUDIO_ENABLE_VIBRATO defines
* audio.c: use system-ticks instead of counters the drivers have to take care of for the internal state posision
since there already is a system-tick with ms resolution, keeping count separatly with each driver implementation makes little sense; especially since they had to take special care to call audio_advance_state with the correct step/end parameters for the audio state to advance regularly and with the correct pace
* audio.c: stop notes after new ones have been started
avoids brief states of with no notes playing that would otherwise stop the hardware and might lead to clicks
* audio.c: bugfix: actually play a pause
instead of just idling/stopping which lead the pwm drivers to stop entirely...
* audio-arm-pwm: pwm-software: add inverted output
new define AUDIO_PIN_ALT_AS_NEGATIVE will generate an inverted signal on the alternate pin, which boosts the volume if a piezo is connected to both AUDIO_PIN and AUDIO_PIN_ALT
* audio-arm-dac: basic: handle piezo configured&wired to both audio pins
* audio-refactoring: docs: update for AUDIO_PIN_ALT_AS_NEGATIVE and piezo wiring
* audio.c: bugfix: use timer_elapsed32 instad of keeping timestamps
avoids running into issues when the uint32 of the timer overflows
* audio-refactoring: add 'pragma once' and remove deprecated NOTE_REST
* audio_arm_dac: basic: add missing bracket
* audio.c: fix delta calculation
was in the wrong place, needs to use the 'last_timestamp' before it was reset
* audio-refactoring: buildfix: wrong legacy macro for set_timbre
* audio.c: 16bit timerstamps suffice
* audio-refactoring: separate includes for AVR and chibios
* audio-refactoring: timbre: use uint8 instead of float
* audio-refactoring: duration: use uint16 for internal per-tone/note state
* audio-refactoring: tonemultiplexing: use uint16 instead of float
* audio-arm-dac: additive: set second pin output-low
used when a piezo is connected to AUDIO_PIN and AUDIO_PIN_ALT, with PIN_ALT_AS_NEGATIVE
* audio-refactoring: move AUDIO_PIN selection from rules.mk to config.h
to be consistent with how other features are handled in QMK
* audio-refactoring: buildfix: wrong legacy macro for set_tempo
* audio-arm-dac: additive: set second pin output-low -- FIXUP
* audio.c: do duration<>ms conversion in uint instead of float
on AVR, to save a couple of bytes in the firmware size
* audio-refactoring: cleanup eeprom defines/usage
for ARM, avr is handled automagically through the avr libc and common_features.mk
Co-Authored-By: Drashna Jaelre <drashna@live.com>
* audio.h: throw an error if OFF is larger than MAX
* audio-arm-dac: basic: actually stop the dac-conversion on a audio_driver_stop
to put the output pin in a known state == AUDIO_DAC_OFF_VALUE, instead of just leaving them where the last conversion was... with AUDIO_PIN_ALT_AS_NEGATIVE this meant one output was left HIGH while the other was left LOW
one CAVEAT: due to this change the opposing squarewave when using both A4 and A5 with AUDIO_PIN_ALT_AS_NEGATIVE
show extra pulses at the beginning/end on one of the outputs, the two waveforms are in sync otherwise.
the extra pusles probably matter little, since this is no high-fidelity sound generation :P
* audio-arm-dac: additive: move zero-crossing code out of dac_value_generate
which is/should be user-overridable == simple, and doing one thing: providing sample values
state-transitions necessary for the zero crossing are better handled in the surrounding loop in the dac_end callback
* audio-arm-dac: dac-additive: zero-crossing: ramping up or down
after a start trigger ramp up: generate values until zero=OFF_VALUE is reached, then continue normally
same in reverse for strop trigger: output values until zero is reached/crossed, then keep OFF_VALUE on the output
* audio-arm-dac: dac-additive: BUGFIX: return OFF_VALUE when a pause is playing
fixes a bug during SONG playback, which suddenly stopped when it encoutnered a pause
* audio-arm-dac: set a sensible default for AUDIO_DAC_VALUE_OFF
1/2 MAX was probably exemplary, can't think of a setup where that would make sense :-P
* audio-arm-dac: update synth_sample/_wavetable for new pin-defines
* audio-arm-dac: default for AUDIO_DAC_VALUE_OFF
turned out that zero or max are bad default choices:
when multiple tones are played (>>5) and released at the same time (!), due to the complex waveform never reaching 'zero' the output can take quite a while to reach zero, and hence the zero-crossing code only "releases" the output waaay to late
* audio-arm-dac: additive: use DAC for negative pin
instead of PAL, which only allows the pin to be configured as output; LOW or HIGH
* audio-arm-dac: more compile-time configuration checks
* audio-refactoring: typo fixed
* audio-refactoring: clang-format on quantum/audio/*
* audio-avr-pwm: add defines for B-pin as primary/only speaker
also updates documentation.
* audio-refactoring: update documentation with proton-c config.h example
* audio-refactoring: move glissando (TODO) to voices.c
refactored/saved from the original glissando implementation in then upstream-master:audio_avr.c
still needs some work though, as it is now the calculation *should* work, but the start-frequency needs to be tracked somewhere/somehow; not only during a SONG playback but also with user input?
* audio-refactoring: cleanup: one round of aspell -c
* audio-avr-pwm: back to AUDIO_PIN
since config_common.h expands them to plain integers, the AUDIO_PIN define can directly be compared to e.g. B5
so there is no need to deal with separate defines like AUDIO_PIN_B5
* audio-refactoring: add technical documentation audio_driver.md
which moves some in-code documentation there
* audio-arm-dac: move AUDIO_PIN checks into c-code
instead of doing everything with the preprocessor, since A4/A5 do not expand to simple integers, preprocessor int-comparison is not possible. but necessary to get a consistent configuration scheme going throughout the audio-code... solution: let c-code handle the different AUDIO_PIN configurations instead (and leave code/size optimizations to the compiler)
* audio-arm-dac: compile-fix: set AUDIO_PIN if unset
workaround to get the build going again, and be backwarts compatible to arm-keyboards which not yet set the AUDIO_PIN define. until the define is enforced through an '#error"
* audio-refactoring: document tone-multiplexing feature
* audio-refactoring: Apply suggestions from documentation review
Co-authored-by: James Young <18669334+noroadsleft@users.noreply.github.com>
* audio-refactoring: Update docs/audio_driver.md
* audio-refactoring: docs: fix markdown newlines
Terminating a line in Markdown with <space>-<space>-<linebreak> creates an HTML single-line break (<br>).
Co-authored-by: James Young <18669334+noroadsleft@users.noreply.github.com>
* audio-arm-dac: additive: fix AUDIO_PIN_ALT handling
* audio-arm-pwm: align define naming with other drivers
Co-authored-by: Joel Challis <git@zvecr.com>
* audio-refactoring: set detault tempo to 120
and add documentation for the override
* audio-refactoring: update backlight define checks to new AUDIO_PIN names
* audio-refactoring: reworking PWM related defines
to be more consistent with other QMK code
Co-authored-by: Joel Challis <git@zvecr.com>
* audio-arm: have the state-update-timer user configurable
defaulting to GPTD6 or GPTD8 for stm32f2+ (=proton-c)
stm32f1 might need to set this to GPTD4, since 6 and 8 are not available
* audio-refactoring: PLAY_NOTE_ARRAY was already removed in master
* Add prototype for startup
* Update chibiOS dac basic to disable pins on stop
* Add defaults for Proton C
* avoid hanging audio if note is completely missed
* Don't redefine pins if they're already defined
* Define A4 and A5 for CTPC support
* Add license headers to keymap files
* Remove figlet? comments
* Add DAC config to audio driver docs
* Apply suggestions from code review
Co-authored-by: Jack Humbert <jack.humb@gmail.com>
* Add license header to py files
* correct license header
* Add JohSchneider's name to modified files
AKA credit where credit's due
* Set executable permission and change interpeter
* Add 'wave' to pip requirements
* Improve documentation
* Add some settings I missed
* Strip AUDIO_DRIVER to parse the name correctly
* fix depreciated
* Update util/audio_generate_dac_lut.py
Co-authored-by: Jack Humbert <jack.humb@gmail.com>
* Fix type in clueboard config
* Apply suggestions from tzarc
Co-authored-by: Nick Brassel <nick@tzarc.org>
Co-authored-by: Johannes <you@example.com>
Co-authored-by: JohSchneider <JohSchneider@googlemail.com>
Co-authored-by: Nick Brassel <nick@tzarc.org>
Co-authored-by: James Young <18669334+noroadsleft@users.noreply.github.com>
Co-authored-by: Joel Challis <git@zvecr.com>
Co-authored-by: Joshua Diamond <josh@windowoffire.com>
Co-authored-by: Jack Humbert <jack.humb@gmail.com>
|
||
|---|---|---|
| .. | ||
| 0_sixty | ||
| 1upkeyboards | ||
| 2key2crawl | ||
| 4by3 | ||
| 4pplet | ||
| 6ball | ||
| 7skb | ||
| 7splus | ||
| 8pack | ||
| 9key | ||
| 10bleoledhub | ||
| 30wer | ||
| 40percentclub | ||
| 45_ats | ||
| abacus | ||
| absinthe | ||
| abstract/ellipse | ||
| acekeyboard/titan60 | ||
| acheron | ||
| acr60 | ||
| adelheid | ||
| adkb96 | ||
| aeboards | ||
| afternoonlabs | ||
| ai03 | ||
| ajisai74 | ||
| akb | ||
| akegata_denki/device_one | ||
| al1 | ||
| aleth42 | ||
| alf | ||
| allison | ||
| allison_numpad | ||
| alpha | ||
| alpine65 | ||
| alps64 | ||
| alu84 | ||
| amj40 | ||
| amj60 | ||
| amj96 | ||
| amjkeyboard/amj66 | ||
| amjpad | ||
| anavi/macropad8 | ||
| angel17 | ||
| angel64 | ||
| aos/tkl | ||
| aplyard/aplx6 | ||
| arabica37 | ||
| arch_36 | ||
| ares | ||
| arisu | ||
| arrayperipherals | ||
| ash1800 | ||
| ash_xiix | ||
| ashpil/modelm_usbc | ||
| at101_bh | ||
| at_at/660m | ||
| atomic | ||
| atreus | ||
| atreus62 | ||
| atxkb | ||
| aves65 | ||
| axolstudio | ||
| baguette | ||
| bakeneko60 | ||
| bakeneko65 | ||
| bakeneko80 | ||
| bantam44 | ||
| barleycorn | ||
| basekeys | ||
| basketweave | ||
| bastardkb/bastylmini | ||
| bat43 | ||
| bear_65 | ||
| bear_face | ||
| beatervan | ||
| bemeier/bmek | ||
| bfake | ||
| bigseries | ||
| binepad/bn003 | ||
| bioi | ||
| blackplum | ||
| blockey | ||
| bm16a | ||
| bm16s | ||
| bm40hsrgb | ||
| bm43a | ||
| bm60poker | ||
| bm60rgb | ||
| bm60rgb_iso | ||
| boardrun | ||
| boardsource | ||
| boardwalk | ||
| boston_meetup | ||
| botanicalkeyboards/fm2u | ||
| box75 | ||
| bpiphany | ||
| bt66tech/bt66tech60 | ||
| bthlabs/geekpad | ||
| business_card | ||
| butterstick | ||
| c39 | ||
| cannonkeys | ||
| capsunlocked | ||
| catch22 | ||
| centromere | ||
| chavdai40 | ||
| cheshire/curiosity | ||
| chidori | ||
| chili | ||
| chimera_ergo | ||
| chimera_ls | ||
| chimera_ortho | ||
| chimera_ortho_plus | ||
| choc_taro | ||
| choco60 | ||
| christmas_tree | ||
| ck60i | ||
| ckeys | ||
| claw44 | ||
| clawsome | ||
| clueboard | ||
| cmm_studio/saka68 | ||
| coarse/cordillera | ||
| cocoa40 | ||
| comet46 | ||
| contra | ||
| converter | ||
| cool836a | ||
| copenhagen_click/click_pad_v1 | ||
| coseyfannitutti | ||
| cospad | ||
| cozykeys/speedo | ||
| craftwalk | ||
| crawlpad | ||
| crazy_keyboard_68 | ||
| crbn | ||
| crkbd | ||
| cu24 | ||
| cu75 | ||
| cu80 | ||
| custommk/genesis | ||
| cutie_club | ||
| daisy | ||
| db/db63 | ||
| dc01 | ||
| dekunukem/duckypad | ||
| deltasplit75 | ||
| dichotomy | ||
| diverge3 | ||
| divergetm2 | ||
| dk60 | ||
| dm9records | ||
| dmqdesign/spin | ||
| do60 | ||
| donutcables | ||
| doodboard/duckboard | ||
| doppelganger | ||
| doro67 | ||
| dozen0 | ||
| dp60 | ||
| draytronics/scarlet | ||
| duck | ||
| dumbo | ||
| dumbpad | ||
| durgod/k320 | ||
| dz60 | ||
| dztech | ||
| e88 | ||
| earth_rover | ||
| ebastler | ||
| eco | ||
| edc40 | ||
| eek | ||
| efreet | ||
| emajesty/eiri | ||
| emptystring/NQG | ||
| eniigmakeyboards | ||
| ep | ||
| ergo42 | ||
| ergoarrows | ||
| ergodash | ||
| ergodone | ||
| ergodox_ez | ||
| ergodox_infinity | ||
| ergodox_stm32 | ||
| ergosaurus | ||
| ergoslab | ||
| ergotaco | ||
| ergotravel | ||
| ericrlau/numdiscipline | ||
| espectro | ||
| eve/meteor | ||
| evil80 | ||
| evolv | ||
| evyd13 | ||
| exclusive | ||
| exent | ||
| facew | ||
| fallacy | ||
| fc660c | ||
| fc980c | ||
| felix | ||
| ferris | ||
| fjlabs | ||
| flehrad | ||
| fleuron | ||
| fluorite | ||
| flx | ||
| for_science | ||
| fortitude60 | ||
| four_banger | ||
| foxlab | ||
| fractal | ||
| freyr | ||
| ft/mars80 | ||
| function96 | ||
| funky40 | ||
| gami_studio/lex60 | ||
| gboards | ||
| geekboards | ||
| geminate60 | ||
| generic_panda/panda65_01 | ||
| genone/eclipse_65 | ||
| georgi | ||
| gergo | ||
| getta25 | ||
| gh60 | ||
| gh80_3000 | ||
| ghs/rar | ||
| gingham | ||
| gkeyboard/gkb_m16 | ||
| gon | ||
| gowla | ||
| gray_studio | ||
| grid600 | ||
| gskt00 | ||
| hadron | ||
| halberd | ||
| handwired | ||
| hardlineworks/otd_plus | ||
| hecomi | ||
| heliar/wm1_hotswap | ||
| helix | ||
| hhkb | ||
| hhkb_lite_2 | ||
| hid_liber | ||
| hidtech/bastyl | ||
| hifumi | ||
| hineybush | ||
| holyswitch/southpaw75 | ||
| honeycomb | ||
| hotdox | ||
| hp69 | ||
| hs60 | ||
| hub16 | ||
| hub20 | ||
| id80 | ||
| id87 | ||
| idb/idb_60 | ||
| idobo | ||
| illuminati/is0 | ||
| ilumkb/primus75 | ||
| inett_studio/sqx | ||
| infinity60 | ||
| iron180 | ||
| ivy | ||
| j80 | ||
| jacky_studio | ||
| jae/j01 | ||
| jagdpietr/drakon | ||
| jc65 | ||
| jd40 | ||
| jd45 | ||
| jian | ||
| jiran | ||
| jisplit89 | ||
| jj4x4 | ||
| jj40 | ||
| jj50 | ||
| jm60 | ||
| jnao | ||
| jones | ||
| just60 | ||
| k_type | ||
| kabedon | ||
| kagamidget | ||
| kb_elmo | ||
| kbdclack/kaishi65 | ||
| kbdfans | ||
| kc60 | ||
| kc60se | ||
| keebio | ||
| keebsforall/freebird60 | ||
| keebwerk | ||
| keebzdotnet/wazowski | ||
| keybage/radpad | ||
| keyboardio | ||
| keycapsss | ||
| keyhive/maypad | ||
| keysofkings/twokey | ||
| kikoslab/kl90 | ||
| kinesis | ||
| kingly_keys | ||
| kira75 | ||
| kira80 | ||
| kiwikeebs | ||
| kiwikey/kawii9 | ||
| kmac | ||
| kmini | ||
| knobgoblin | ||
| knops | ||
| kona_classic | ||
| kudox | ||
| kudox_game | ||
| kv/revt | ||
| kyria | ||
| labyrinth75 | ||
| laptreus | ||
| latin17rgb | ||
| latin47ble | ||
| latin64ble | ||
| latinpad | ||
| lattice60 | ||
| launchpad | ||
| lazydesigners | ||
| lck75 | ||
| le_chiffre | ||
| leafcutterlabs/bigknob | ||
| leeku/finger65 | ||
| lets_split | ||
| lets_split_eh | ||
| lfkeyboards | ||
| lily58 | ||
| linworks/whale75 | ||
| littlealby | ||
| lizard_trick/tenkey_plusplus | ||
| longnald/corin | ||
| lucid | ||
| m10a | ||
| majistic | ||
| manta60 | ||
| marksard | ||
| massdrop | ||
| masterworks/classy_tkl | ||
| matrix | ||
| maxipad | ||
| maxr1998 | ||
| mc_76k | ||
| mechkeys/mk60 | ||
| mechllama/g35 | ||
| mechlovin | ||
| mechmini | ||
| mechstudio | ||
| mechwild | ||
| mehkee96 | ||
| meira | ||
| meishi | ||
| meishi2 | ||
| melgeek | ||
| melody96 | ||
| meme | ||
| merge/iso_macro | ||
| mesa/mesa_tkl | ||
| meson | ||
| metamechs/timberwolf | ||
| mexsistor/ludmila | ||
| miller/gm862 | ||
| miniaxe | ||
| minidox | ||
| minim | ||
| minimacro5 | ||
| mint60 | ||
| misonoworks/karina | ||
| misterknife | ||
| mitosis | ||
| miuni32 | ||
| mixi | ||
| mode/eighty | ||
| monstargear/xo87/rgb | ||
| montsinger | ||
| moon | ||
| moonlander | ||
| mountainblocks/mb17 | ||
| mschwingen/modelm | ||
| mt40 | ||
| mt64rgb | ||
| mt84 | ||
| mt980 | ||
| murcielago | ||
| mxss | ||
| mysticworks/wyvern | ||
| nack | ||
| nafuda | ||
| naked48 | ||
| naked60 | ||
| naked64 | ||
| namecard2x4 | ||
| navi10 | ||
| ncc1701kb | ||
| nckiibs | ||
| nebula12 | ||
| nebula68 | ||
| nek_type_a | ||
| nemui | ||
| newgame40 | ||
| nibiria/stream15 | ||
| nightingale_studios/hailey | ||
| nightly_boards | ||
| nightmare | ||
| nimrod | ||
| niu_mini | ||
| nk65 | ||
| nk87 | ||
| nknl7en | ||
| nknl7jp | ||
| nomu30 | ||
| nopunin10did/railroad | ||
| novelpad | ||
| noxary | ||
| nullbitsco | ||
| numatreus | ||
| oddball | ||
| odelia | ||
| ogre | ||
| ok60 | ||
| omnikey_bh | ||
| omnikeyish | ||
| opendeck | ||
| opus | ||
| orange75 | ||
| org60 | ||
| ortho5by12 | ||
| orthodox | ||
| otaku_split | ||
| pabile | ||
| paladin64 | ||
| palette1202 | ||
| panc40 | ||
| panc60 | ||
| pandora | ||
| pdxkbc | ||
| pearl | ||
| peiorisboards/ixora | ||
| percent | ||
| phantom | ||
| phoenix | ||
| pico | ||
| pimentoso/paddino02 | ||
| pinky | ||
| pistachio | ||
| pistachio_mp | ||
| planck | ||
| playkbtw | ||
| plexus75 | ||
| ploopyco | ||
| plume/plume65 | ||
| pohjolaworks/louhi | ||
| polilla | ||
| pom_keyboards/tnln95 | ||
| pos78 | ||
| preonic | ||
| primekb | ||
| program_yoink | ||
| projectkb | ||
| puck | ||
| punk75 | ||
| pursuit40 | ||
| qaz | ||
| quad_h/lb75 | ||
| quantrik/kyuu | ||
| quark | ||
| qvex | ||
| qwertyydox | ||
| rabbit/rabbit68 | ||
| rabbit_capture_plan | ||
| rainkeeb | ||
| ramonimbao | ||
| rart | ||
| rect44 | ||
| redox | ||
| redox_w | ||
| redscarf_i | ||
| redscarf_iiplus | ||
| retro_75 | ||
| reversestudio/decadepad | ||
| reviung33 | ||
| reviung34 | ||
| reviung39 | ||
| reviung41 | ||
| reviung61 | ||
| rgbkb | ||
| rocketboard_16 | ||
| rominronin/katana60 | ||
| rotr | ||
| rpiguy9907/southpaw66 | ||
| runner3680 | ||
| ryloo_studio/m0110 | ||
| s7_elephant | ||
| sam/sg81m | ||
| satt/vision | ||
| scarletbandana | ||
| scatter42 | ||
| sck | ||
| scythe | ||
| sendyyeah/pix | ||
| sentraq | ||
| setta21 | ||
| shambles | ||
| shiro | ||
| shk9 | ||
| sidderskb/majbritt | ||
| signum/3_0/elitec | ||
| silverbullet44 | ||
| singa | ||
| sirius | ||
| sixkeyboard | ||
| slz40 | ||
| smk60 | ||
| snampad | ||
| sneakbox/aliceclone | ||
| sofle | ||
| southpaw75 | ||
| southpole | ||
| sowbug | ||
| soy20 | ||
| space_space | ||
| spaceman | ||
| spacetime | ||
| sparrow62 | ||
| spiderisland/split78 | ||
| splitish | ||
| splitkb/zima | ||
| splitreus62 | ||
| splitty | ||
| squiggle | ||
| standaside | ||
| staryu | ||
| stella | ||
| subatomic | ||
| suihankey | ||
| swiftrax/retropad | ||
| switchplate | ||
| sx60 | ||
| tada68 | ||
| taleguers/taleguers75 | ||
| tanuki | ||
| technika | ||
| telophase | ||
| tenki | ||
| terrazzo | ||
| tetris | ||
| tg4x | ||
| tgr | ||
| the_royal | ||
| the_ruler | ||
| thedogkeyboard | ||
| themadnoodle | ||
| thevankeyboards | ||
| tkc | ||
| tkw/stoutgat | ||
| tmo50 | ||
| toad | ||
| tokyo60 | ||
| torn | ||
| touchpad | ||
| tr60w | ||
| treadstone32 | ||
| treadstone48 | ||
| treasure/type9 | ||
| tunks/ergo33 | ||
| ua62 | ||
| uk78 | ||
| underscore33 | ||
| ungodly | ||
| unikorn | ||
| uno | ||
| uranuma | ||
| ut472 | ||
| uzu42 | ||
| v60_type_r | ||
| vagrant_10 | ||
| viktus | ||
| vinta | ||
| vision_division | ||
| vitamins_included | ||
| vn66 | ||
| waldo | ||
| wallaby | ||
| walletburner | ||
| westfoxtrot | ||
| whale/sk | ||
| wheatfield | ||
| whitefox | ||
| wilba_tech | ||
| winkeyless | ||
| wolfmarkclub/wm1 | ||
| wsk | ||
| wuque/ikki68 | ||
| x16 | ||
| xbows | ||
| xd60 | ||
| xd68 | ||
| xd75 | ||
| xd84 | ||
| xd84pro | ||
| xd87 | ||
| xd96 | ||
| xd002 | ||
| xd004 | ||
| xelus | ||
| xiaomi/mk02 | ||
| xmmx | ||
| xw60 | ||
| yatara/drink_me | ||
| yd60mq | ||
| yd68 | ||
| ymd75 | ||
| ymd96 | ||
| ymdk | ||
| ymdk_np21 | ||
| yncognito/batpad | ||
| yoichiro/lunakey_mini | ||
| yosino58 | ||
| yugo_m | ||
| yurei | ||
| yushakobo/quick7 | ||
| z150_bh | ||
| zfrontier/big_switch | ||
| zinc | ||
| zj68 | ||
| zlant | ||
| zoo/wampus | ||
| ztboards | ||
| zvecr | ||
| readme.md | ||
Included Keyboards
QMK runs on a diverse range of keyboards. Some of these keyboards are officially supported and see constant community contributions, while others are part of the repository for historical reasons.
Official QMK Keyboards
Ortholinear Keyboards - Jack Humbert
What makes OLKB keyboards shine is a combo of lean aesthetics, compact size, and killer tactile feel. These are available through olkb.com as well as through Massdrop from time to time, as easy to assemble kits.
- Planck — A 40% DIY powerhouse of customizability and modification capability. It's a lean, mean, typing machine.
- Preonic — Like the Planck, but bigger. 50%.
- Atomic — Imagine the size of the Planck. Now imagine the size of the Preonic. Now imagine bigger. That is the Atomic. A 60% keyboard.
Clueboard - Zach White
Designed and built in Felton, CA, Clueboards keyboard emphasize quality and locally sourced components, available on clueboard.co
- Clueboard — The 66% custom keyboard.
- Cluecard — A small board to help you hack on QMK.
- Cluepad — A mechanical numpad with QMK superpowers.
ErgoDox EZ and Planck EZ - ZSA Technology Labs
ZSA Technology Labs maintains its own fork of QMK which feeds its configurator, for stability and legal purposes. The ZSA boards are:
- ErgoDox EZ — A powerful split mechanical keyboard.
- Planck EZ — A 40% DIY powerhouse of customizability and modification capability. It's a lean, mean, typing machine, which ships fully assembled with a two-year warranty.
Community-supported QMK Keyboards
These keyboards are part of the QMK repository, but their manufacturers are not official maintainers of the repository.
- 9key — A 9-key minipad sold by Bishop Keyboards.
- Alps64 — A 60% keyboard for Alps keyswitches.
- AMJ60 — DIY/Assembled compact 60% keyboard.
- Arrow Pad — A custom creation by IBNobody.
- Atreus — Made by Technomancy.
- Bantam44 — It is a 44-key 40% staggered keyboard.
- DataHand — DataHand keyboard converted to use a Teensy board.
- Ergodox Infinity - Ergonomic Split Keyboard by Input Club.
- GH60 — A 60% Geekhack community-driven project.
- GON NerD — Korean custom 60% PCB
- Happy Hacking Keyboard — The Happy Hacking keyboard can be hacked with a custom controller to run QMK.
- Infinity 60% - — Compact community keyboard by Input Club.
- JD45 — Another Geekhack community project, designed by jdcarpe.
- JJ40 — ps2avrGB based ortholinear sold by KPrepublic
- JJ50 — A compact 50% (5x12) ortholinear keyboard sold by KPrepublic.
- KBD75 — A 75% keyboard made by made by KBDFans.
- KC60 — A programmable Chinese-made keyboard, lost in the mists of time.
- Kinesis Advantage — Contoured ergonomic keyboard by Kinesis Computer Ergonomics.
- KMAC — Korean custom keyboard.
- The Kitten Paw — A replacement controller (2016 revision) for the Filco Majestouch by Bathroom Epiphanies.
- Lets Split - Split ortholinear 40% keyboard.
- Phantom — A tenkeyless kit by Teel, also from Geekhack.
- Retro Refit — Another creation by IBNobody.
- S60-x — DIY compact keyboard designed by VinnyCordeiro for Sentraq.
- Satan — A GH60 variant.
- SixKeyBoard — A 6-key keyboard made by TechKeys.
- TheVan 44 — A 44-key staggered keybard by Evangs.
- WhiteFox — A 65% keyboard designed as a partnership by matt3o, Massdrop and Input Club
- Vision Division — Full Size / Split Linear Keyboard by IBNobody.
- XD004 — 1x4 macro keyboard sold by KPrepublic.
- XD75 — 15x5 ortholinear keyboard by XIUDI.
- YMDK NP21 — ps2avrGB based number pad (numpad) sold by YMDK on Aliexpress.