keychron_qmk_firmware/keyboards
Drashna Jaelre 9d235d4fc5
[Core] Change OLED task function to be boolean (#14864)
* [Core] Add kb level callbacks to OLED driver

* Update keyboards and keymaps

* Update docs

* Update userspace configs

* Add fix for my keymap ...

* update lefty
2021-11-02 09:42:50 +11:00
..
1upkeyboards
2key2crawl
3keyecosystem/2key2
3w6
4by3
4pplet
6ball
7c8/framework
7skb
7splus
8pack
9key
10bleoledhub [Core] Change OLED task function to be boolean (#14864) 2021-11-02 09:42:50 +11:00
30wer
40percentclub
45_ats
0_sixty
0xc7/61key
0xcb [Core] Change OLED task function to be boolean (#14864) 2021-11-02 09:42:50 +11:00
a_dux
abacus
absinthe
abstract/ellipse
acekeyboard/titan60
acheron
acr60
adelheid
adkb96
aeboards [Core] Change OLED task function to be boolean (#14864) 2021-11-02 09:42:50 +11:00
afternoonlabs
ai03
ajisai74
akb
akegata_denki/device_one
al1
aleblazer/zodiark [Core] Change OLED task function to be boolean (#14864) 2021-11-02 09:42:50 +11:00
aleth42
alf
alfredslab/swift65/solder
allison
allison_numpad
alpha
alpine65
alps64
alu84
amag23
amj40
amj60
amj96
amjkeyboard/amj66
amjpad
anavi/macropad8 [Core] Change OLED task function to be boolean (#14864) 2021-11-02 09:42:50 +11:00
angel17
angel64 [Core] Change OLED task function to be boolean (#14864) 2021-11-02 09:42:50 +11:00
anomalykb/a65i
aos/tkl
aozora/hotswap
aplyard/aplx6 [Core] Change OLED task function to be boolean (#14864) 2021-11-02 09:42:50 +11:00
arabica37 [Core] Change OLED task function to be boolean (#14864) 2021-11-02 09:42:50 +11:00
arch_36 [Core] Change OLED task function to be boolean (#14864) 2021-11-02 09:42:50 +11:00
ares
arisu
arrayperipherals
ash_xiix
ash1800
ashpil/modelm_usbc
at_at/660m
at101_bh
atomic
atreus
atreus62
atxkb
aves65
axolstudio
aya
baguette
bakeneko60
bakeneko65
bakeneko80
bandominedoni
bantam44
barleycorn
barleycorn_smd
barracuda
basekeys [Core] Change OLED task function to be boolean (#14864) 2021-11-02 09:42:50 +11:00
basketweave
bastardkb
bat43
bear_face
beatervan
bemeier/bmek
bfake
bigseries
binepad
bioi
bkf
blackplum
blank/blank01
blank_tehnologii/manibus
blockey
boardrun
boardsource [Core] Change OLED task function to be boolean (#14864) 2021-11-02 09:42:50 +11:00
boardwalk
bobpad
bop
boston
boston_meetup [Core] Change OLED task function to be boolean (#14864) 2021-11-02 09:42:50 +11:00
botanicalkeyboards/fm2u
box75
bpiphany
bt66tech/bt66tech60
bthlabs/geekpad
buildakb
business_card [Core] Change OLED task function to be boolean (#14864) 2021-11-02 09:42:50 +11:00
butterstick
c39
caffeinated/serpent65
canary/canary60rgb
cannonkeys [Core] Change OLED task function to be boolean (#14864) 2021-11-02 09:42:50 +11:00
capsunlocked
carbo65
cassette42 [Core] Change OLED task function to be boolean (#14864) 2021-11-02 09:42:50 +11:00
catch22
centromere
cest73/tkm
charue/sunsetter
chavdai40
checkerboards
cherrybstudio
cheshire/curiosity
chidori [Core] Change OLED task function to be boolean (#14864) 2021-11-02 09:42:50 +11:00
chili
chimera_ergo
chimera_ls
chimera_ortho
chimera_ortho_plus
chlx/merro60
choc_taro
choco60
christmas_tree
ck60i
ckeys [Core] Change OLED task function to be boolean (#14864) 2021-11-02 09:42:50 +11:00
claw44 [Core] Change OLED task function to be boolean (#14864) 2021-11-02 09:42:50 +11:00
clawsome
clueboard
cmm_studio/saka68
coarse
cocoa40
comet46
compound
contra
converter
cool836a
copenhagen_click/click_pad_v1
coseyfannitutti
cozykeys
cradio
craftwalk
crawlpad
crazy_keyboard_68
crbn
crin
crkbd [Core] Change OLED task function to be boolean (#14864) 2021-11-02 09:42:50 +11:00
cu24
cu75
cu80
custommk/genesis
cutie_club
cx60
cybergear/macro25
daji/seis_cinco
db/db63
dc01
dekunukem/duckypad [Core] Change OLED task function to be boolean (#14864) 2021-11-02 09:42:50 +11:00
delikeeb
delilah
deltasplit75
dichotomy
dinofizz/fnrow/v1
diverge3
divergetm2
dk60
dm9records
dmqdesign/spin [Core] Change OLED task function to be boolean (#14864) 2021-11-02 09:42:50 +11:00
do60
donutcables
doodboard [Core] Change OLED task function to be boolean (#14864) 2021-11-02 09:42:50 +11:00
doppelganger
doro67
dozen0
dp60
draculad [Core] Change OLED task function to be boolean (#14864) 2021-11-02 09:42:50 +11:00
draytronics
dtisaac
dubba175
duck
ducky/one2mini
dumbo [Core] Change OLED task function to be boolean (#14864) 2021-11-02 09:42:50 +11:00
dumbpad
durgod
dyz
dz60
dztech
e88
ealdin
earth_rover
ebastler
eco
edc40
edda
edi/hardlight/mk1
eek
efreet
eggman
ein_60 [Core] Change OLED task function to be boolean (#14864) 2021-11-02 09:42:50 +11:00
emajesty/eiri
emi20
emptystring/NQG
eniigmakeyboards
ep
epoch80
ergo42
ergoarrows
ergodash
ergodox_ez
ergodox_infinity
ergodox_stm32
ergosaurus
ergoslab
ergotaco
ergotravel
ericrlau/numdiscipline
esca
espectro
eve/meteor
evil80
evolv
evyd13
exclusive
exent
eyeohdesigns
ez_maker/directpins
facew
fallacy
fc660c
fc980c
feels/feels65
felix
ferris
ffkeebs/siris
fjlabs
flehrad
fleuron
fluorite
flx
flxlb/zplit
flygone60/rev3
foostan/cornelius
for_science
forever65
fortitude60
four_banger
foxlab
fr4
fractal
free_willy
freyr
friedrich
frooastboard
ft/mars80
function96
funky40
gami_studio/lex60
gboards
geekboards
geminate60
generic_panda/panda65_01
genone
gentleman65
georgi
gergo [Core] Change OLED task function to be boolean (#14864) 2021-11-02 09:42:50 +11:00
getta25 [Core] Change OLED task function to be boolean (#14864) 2021-11-02 09:42:50 +11:00
ggkeyboards/genesis
gh60
gh80_3000
ghs/rar
gingham
gkeyboard/gkb_m16
gmmk
gon
gorthage_truck
gowla
gray_studio
grid600
gvalchca
h0oni/hotduck
hadron [Core] Change OLED task function to be boolean (#14864) 2021-11-02 09:42:50 +11:00
halberd
halfcliff [Core] Change OLED task function to be boolean (#14864) 2021-11-02 09:42:50 +11:00
hand88
handwired [Core] Change OLED task function to be boolean (#14864) 2021-11-02 09:42:50 +11:00
hardlineworks/otd_plus
hecomi
heliar/wm1_hotswap
helix [Core] Change OLED task function to be boolean (#14864) 2021-11-02 09:42:50 +11:00
hhkb
hhkb_lite_2
hid_liber
hidtech/bastyl
hifumi
hineybush
holyswitch/southpaw75
honeycomb
horizon
hotdox
hp69
hs60
hub16
hub20
ianklug/grooveboard
ibm/model_m_4th_gen
id67
id80
id87
idb/idb_60
idobao/id96
idobo
illuminati/is0
illusion/rosa
ilumkb
inett_studio/sqx
infinity60
irene
iriskeyboards
iron180
ivy
j80
jacky_studio
jadookb/jkb65
jae/j01
jagdpietr/drakon [Core] Change OLED task function to be boolean (#14864) 2021-11-02 09:42:50 +11:00
jc65
jd40
jd45
jian
jiran
jisplit89
jkdlab/binary_monkey
jm60
jnao
jones
just60
k_type
kabedon
kagamidget
kapcave
kb_elmo
kbdclack/kaishi65
kbdfans
kbnordic/nordic60
kc60
kc60se
keebio
keebsforall
keebwerk
keebzdotnet
kelowna/rgb64
keybage/radpad [Core] Change OLED task function to be boolean (#14864) 2021-11-02 09:42:50 +11:00
keybee/keybee65
keyboardio
keycapsss [Core] Change OLED task function to be boolean (#14864) 2021-11-02 09:42:50 +11:00
keychron/q1
keyhive/maypad
keyprez
keysofkings/twokey
kikoslab/kl90 [Core] Change OLED task function to be boolean (#14864) 2021-11-02 09:42:50 +11:00
kindakeyboards/conone65
kinesis
kineticlabs/emu
kingly_keys [Core] Change OLED task function to be boolean (#14864) 2021-11-02 09:42:50 +11:00
kira75
kira80
kiwikeebs
kiwikey [Core] Change OLED task function to be boolean (#14864) 2021-11-02 09:42:50 +11:00
kmac
kmac_pad
kmini
knobgoblin [Core] Change OLED task function to be boolean (#14864) 2021-11-02 09:42:50 +11:00
knops
kona_classic
kopibeng
kprepublic
ktec
kudox
kudox_game
kv/revt
kwub/bloop
ky01
labyrinth75
laptreus
latin6rgb
latin17rgb
latin47ble
latin60rgb
latin64ble
latinpad [Core] Change OLED task function to be boolean (#14864) 2021-11-02 09:42:50 +11:00
latinpadble [Core] Change OLED task function to be boolean (#14864) 2021-11-02 09:42:50 +11:00
lattice60
launchpad
lazydesigners
lck75 [Core] Change OLED task function to be boolean (#14864) 2021-11-02 09:42:50 +11:00
le_chiffre [Core] Change OLED task function to be boolean (#14864) 2021-11-02 09:42:50 +11:00
leafcutterlabs/bigknob
leeku/finger65
lefishe
lefty [Core] Change OLED task function to be boolean (#14864) 2021-11-02 09:42:50 +11:00
lets_split
lets_split_eh
lfkeyboards
lily58 [Core] Change OLED task function to be boolean (#14864) 2021-11-02 09:42:50 +11:00
linworks
littlealby
lizard_trick/tenkey_plusplus
lm_keyboard/lm60n
longnald/corin
ls_60
lucid
lyra [Core] Change OLED task function to be boolean (#14864) 2021-11-02 09:42:50 +11:00
m3n3van
m10a
m65
machkeyboards
macro1
majistic
makrosu
manta60
manyboard/macro
marksard [Core] Change OLED task function to be boolean (#14864) 2021-11-02 09:42:50 +11:00
massdrop
masterworks/classy_tkl
matchstickworks/southpad
matrix
maxipad
maxr1998
mb44
mc_76k
mechanickeys/undead60m
mechkeys/mk60
mechllama/g35 [Core] Change OLED task function to be boolean (#14864) 2021-11-02 09:42:50 +11:00
mechlovin
mechmini
mechstudio
mechwild [Core] Change OLED task function to be boolean (#14864) 2021-11-02 09:42:50 +11:00
mehkee96
meira
meishi
meishi2
meletrix/zoom65
melgeek
melody96
meme
merge [Core] Change OLED task function to be boolean (#14864) 2021-11-02 09:42:50 +11:00
mesa/mesa_tkl
meson
metamechs/timberwolf
mexsistor/ludmila
miller/gm862
millipad
mini_elixivy
miniaxe
minidox
minim
minimacro5
minimon
mint60
mio
misonoworks [Core] Change OLED task function to be boolean (#14864) 2021-11-02 09:42:50 +11:00
misterknife
mitosis
miuni32
mixi
mnk50
mnk1800s
mode
model_v
mokey
molecule
momoka_ergo
monarch
monstargear/xo87
montex
montsinger [Core] Change OLED task function to be boolean (#14864) 2021-11-02 09:42:50 +11:00
moon
moonlander
mountainblocks/mb17
mschwingen/modelm
mt40
mt64rgb
mt84
mt980
murcielago
mwstudio
mxss
mysticworks/wyvern
nack
nafuda
naiping
naked48
naked60
naked64
namecard2x4
navi10
ncc1701kb
nebula12
nebula68
neito
nek_type_a
nemui
neokeys/g67
neopad
neson_design/n6
newgame40
nibiria/stream15
nightingale_studios/hailey
nightly_boards
nightmare
nimrod
niu_mini
nix_studio/oxalys80
nk1
nk65
nk87
nknl7en
nknl7jp
nomu30
nopunin10did
novelpad
noxary
np12
nullbitsco [Core] Change OLED task function to be boolean (#14864) 2021-11-02 09:42:50 +11:00
numatreus
ocean
oddball
oddforge/vea
odelia
ogre
ogurec
ok60
omnikey_bh
omnikeyish
onekeyco/dango40
opendeck
opus
orange75
org60
ortho5by12
orthocode
orthodox
otaku_split
owl8
owlab
pabile
palette1202 [Core] Change OLED task function to be boolean (#14864) 2021-11-02 09:42:50 +11:00
panc40
panc60
pandora
pdxkbc
pearl
pearlboards/pandora
peej
peranekofactory/tone
percent
phantom
phase_studio/titan65
phoenix
phrygian/ph100
pico
picolab/frusta_fundamental
pimentoso
pinky
pisces
pistachio
pistachio_mp
pistachio_pro [Core] Change OLED task function to be boolean (#14864) 2021-11-02 09:42:50 +11:00
pizzakeyboards/pizza65
pkb65
planck
playkbtw
plexus75
ploopyco
pluckey
plume/plume65
plut0nium [Core] Change OLED task function to be boolean (#14864) 2021-11-02 09:42:50 +11:00
plx
pohjolaworks/louhi
poker87c
poker87d
polilla
polycarbdiet
pom_keyboards/tnln95
portal_66
pos78
preonic
primekb
program_yoink
projectcain
projectkb
prototypist/j01
pteron36 [Core] Change OLED task function to be boolean (#14864) 2021-11-02 09:42:50 +11:00
puck
punk75
pursuit40
q4z
qaz
quad_h/lb75
quantrik/kyuu
quark
qvex
qwertyydox
rabbit/rabbit68
rabbit_capture_plan
rainkeeb [Core] Change OLED task function to be boolean (#14864) 2021-11-02 09:42:50 +11:00
ramonimbao [Core] Change OLED task function to be boolean (#14864) 2021-11-02 09:42:50 +11:00
rart [Core] Change OLED task function to be boolean (#14864) 2021-11-02 09:42:50 +11:00
rect44
redox
redox_media
redox_w
redscarf_i
redscarf_iiplus
retro_75
reversestudio/decadepad
reviung5
reviung33
reviung34
reviung39
reviung41
reviung61
rgbkb [Core] Change OLED task function to be boolean (#14864) 2021-11-02 09:42:50 +11:00
ristretto [Core] Change OLED task function to be boolean (#14864) 2021-11-02 09:42:50 +11:00
rocketboard_16 [Core] Change OLED task function to be boolean (#14864) 2021-11-02 09:42:50 +11:00
rominronin/katana60
roseslite
rotor
rotr
rpiguy9907/southpaw66
rubi [Core] Change OLED task function to be boolean (#14864) 2021-11-02 09:42:50 +11:00
runes/vaengr
runner3680
ryanbaekr/rb86
ryloo_studio/m0110
sam
sanctified/dystopia
satt/vision
sauce/mild
sawnsprojects/satxri6key [Core] Change OLED task function to be boolean (#14864) 2021-11-02 09:42:50 +11:00
scarletbandana
scatter42
sck
scythe
seigaiha
sekigon/grs_70ec
sendyyeah [Core] Change OLED task function to be boolean (#14864) 2021-11-02 09:42:50 +11:00
senselessclay
sentraq
sergiopoverony/creator_pro
sets3n/kk980
setta21 [Core] Change OLED task function to be boolean (#14864) 2021-11-02 09:42:50 +11:00
shambles
shiro
shk9
sidderskb/majbritt
signum/3_0
silverbullet44
singa
sirius
sixkeyboard
skeletn87
skergo
slz40
smallice
smallkeyboard
smk60
snampad
sneakbox
sofle [Core] Change OLED task function to be boolean (#14864) 2021-11-02 09:42:50 +11:00
soup10
southpole
sowbug
soy20
space_space
spaceman [Core] Change OLED task function to be boolean (#14864) 2021-11-02 09:42:50 +11:00
spacetime
spacey
sparrow62
specskeys
spiderisland
splitish
splitkb [Core] Change OLED task function to be boolean (#14864) 2021-11-02 09:42:50 +11:00
splitreus62
splitty
squiggle
standaside
steal_this_keyboard
stella
stratos
studiokestra
subatomic
suihankey [Core] Change OLED task function to be boolean (#14864) 2021-11-02 09:42:50 +11:00
superuser
swiftrax/retropad
switchplate
sx60
synapse
tada68
takashicompany [Core] Change OLED task function to be boolean (#14864) 2021-11-02 09:42:50 +11:00
taleguers/taleguers75
tanuki
tau4 [Core] Change OLED task function to be boolean (#14864) 2021-11-02 09:42:50 +11:00
team0110/p1800fl
technika
telophase
tempo_turtle/bradpad
tender/macrowo_pad [Core] Change OLED task function to be boolean (#14864) 2021-11-02 09:42:50 +11:00
tenki
terrazzo
tetris
tg4x
tgr
the_royal
the_ruler
the_uni
thedogkeyboard
themadnoodle
thevankeyboards
tiger910
tkc [Core] Change OLED task function to be boolean (#14864) 2021-11-02 09:42:50 +11:00
tkw [Core] Change OLED task function to be boolean (#14864) 2021-11-02 09:42:50 +11:00
tmo50
toad
tokyokeyboard
torn [Core] Change OLED task function to be boolean (#14864) 2021-11-02 09:42:50 +11:00
touchpad
tr60w
trashman
treadstone32
treadstone48 [Core] Change OLED task function to be boolean (#14864) 2021-11-02 09:42:50 +11:00
treasure
tronguylabs/m122_3270
tszaboo/ortho4exent
tunks/ergo33
tw40
txuu
ua62
uk78
underscore33
ungodly [Core] Change OLED task function to be boolean (#14864) 2021-11-02 09:42:50 +11:00
unicomp
unikorn
unison
uno
uranuma
ut472
utd80
uzu42 [Core] Change OLED task function to be boolean (#14864) 2021-11-02 09:42:50 +11:00
v4n4g0rth0n
v60_type_r
vagrant_10
viktus
vitamins_included
vn66
waldo
wallaby
walletburner
wanten
wekey
westfoxtrot
whale/sk
wheatfield
whitefox
wilba_tech
wings42
winkeyless
wolf/ts60
wolfmarkclub/wm1
work_louder [Core] Change OLED task function to be boolean (#14864) 2021-11-02 09:42:50 +11:00
wsk
wuque
x16
xbows
xelus
xiaomi/mk02
xiudi
xmmx
xw60
yampad [Core] Change OLED task function to be boolean (#14864) 2021-11-02 09:42:50 +11:00
yasui
yatara/drink_me
yd60mq
yd68
yeehaw
ymd75
ymd96
ymdk
ymdk_np21
yncognito/batpad
yoichiro
yosino58
yugo_m
yurei
yushakobo
yynmt/acperience12
z12 [Core] Change OLED task function to be boolean (#14864) 2021-11-02 09:42:50 +11:00
z34
z150_bh
zfrontier/big_switch
zinc
zj68
zlant
zoo/wampus [Core] Change OLED task function to be boolean (#14864) 2021-11-02 09:42:50 +11:00
ztboards
zvecr
readme.md

Included Keyboards

QMK runs on a diverse range of keyboards. Some of these keyboards are well maintained 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.