d4be07dad3
* add support for hid gamepad interface
add documentation for HID joystick
Add joystick_task to read analog axes values even when no key is pressed or release. update doc
Update docs/feature_joystick.md
Manage pin setup and read to maintain matrix scan after analog read
* Incorporates patches and changes to HID reporting
There are some patches provided by @a-chol incorporated on this commit,
and also some changes I made to the HID Report structure.
The most interesting is the one dealing with number of buttons: Linux
doesn't seem to care, but Windows requires the HID structure to be byte
aligned (that's in the spec). So if one declares 8/16/32... buttons they
should not have any issues, but this is what happens when you have 9
buttons:
```
bits |0|1|2|3|4|5|6|7|
|*|*|*|*|*|*|*|*| axis 0 (report size 8)
|*|*|*|*|*|*|*|*| ...
|*|*|*|*|*|*|*|*|
|*|*|*|*|*|*|*|*|
|*|*|*|*|*|*|*|*|
|*|*|*|*|*|*|*|*|
|*|*|*|*|*|*|*|*| axis 6
|*|*|*|*|*|*|*|*| first 8 buttons (report size 1)
|*| | | | | | | | last of 9 buttons, not aligned
```
So for that I added a conditonal that will add a number of reports with
size 1 to make sure it aligns to the next multiple of 8. Those reports
send dummy inputs that don't do anything aside from aligning the data.
Tested on Linux, Windows 10 and Street Fighter (where the joystick is
recognized as direct-input)
* Add save and restore of each pin used in reading joystick (AVR).
Allow output pin to be JS_VIRTUAL_AXIS if the axis is connected to Vcc
instead of an output pin from the MCU.
Fix joystick report id
Fix broken v-usb hid joystick interface. Make it more resilient to unusual settings (none multiple of eight button count, 0 buttons or 0 axes)
Correct adc reading for multiple axes. Piecewise range conversion for uncentered raw value range. Input, output and ground pin configuration per axis.
Documentation fixes
* Fix port addressing for joystick analog read
* The other required set of changes
As per the PR, the changes still holding it up.
Add onekey for testing.
Fix ARM builds.
Fix device descriptor when either axes or buttons is zero.
Add compile-time check for at least one axis or button.
Move definition to try to fix conflict.
PR review comments.
qmk cformat
* avoid float functions to compute range mapping for axis adc reading
* Remove V-USB support for now. Updated docs accordingly.
* Update tmk_core/protocol/lufa/lufa.c
Co-Authored-By: Ryan <fauxpark@gmail.com>
* Update tmk_core/protocol/usb_descriptor.c
Co-Authored-By: Ryan <fauxpark@gmail.com>
* Update tmk_core/protocol/usb_descriptor.c
Co-Authored-By: Ryan <fauxpark@gmail.com>
* Update tmk_core/protocol/usb_descriptor.c
Co-Authored-By: Ryan <fauxpark@gmail.com>
* Add support for joystick adc reading for stm32 MCUs. Fix joystick hid report sending for chibios
* Fix HID joystick report sending for ChibiOS.
Add one analog axis to the onekey:joystick keymap.
Fix pin state save and restore during joystick analog read for STM32
MCUs.
* Update tmk_core/protocol/chibios/usb_main.c
Co-Authored-By: Ryan <fauxpark@gmail.com>
* Update tmk_core/protocol/lufa/lufa.c
Co-Authored-By: Ryan <fauxpark@gmail.com>
* Add missing mcuconf.h and halconf.h to onekey:joystick keymap.
Add suggested fixes from PR.
* Switch saveState and restoreState signature to use pin_t type.
onekey:joystick : add a second axis, virtual and programmatically animated.
* Update docs/feature_joystick.md
Co-Authored-By: Ryan <fauxpark@gmail.com>
* Update docs/feature_joystick.md
Co-Authored-By: Ryan <fauxpark@gmail.com>
* Add PR corrections
* Remove halconf.h and mcuconf.h from onekey keymaps
* Change ADC_PIN to A0
Co-authored-by: achol <allecooll@hotmail.com>
Co-authored-by: José Júnior <jose.junior@gmail.com>
Co-authored-by: a-chol <achol@notamail.com>
Co-authored-by: Nick Brassel <nick@tzarc.org>
Co-authored-by: Ryan <fauxpark@gmail.com>
|
||
|---|---|---|
| .. | ||
| 1upkeyboards | ||
| 2key2crawl | ||
| 4by3 | ||
| 4pplet | ||
| 6ball | ||
| 7skb | ||
| 8pack | ||
| 9key | ||
| 10bleoledhub | ||
| 30wer | ||
| 40percentclub | ||
| abacus | ||
| absinthe | ||
| abstract/ellipse | ||
| acheron | ||
| acr60 | ||
| adelheid | ||
| adkb96 | ||
| aeboards | ||
| ai03 | ||
| ajisai74 | ||
| akb | ||
| akegata_denki/device_one | ||
| al1 | ||
| alf | ||
| allison | ||
| allison_numpad | ||
| alpha | ||
| alps64 | ||
| alu84 | ||
| amj40 | ||
| amj60 | ||
| amj96 | ||
| amjkeyboard/amj66 | ||
| amjpad | ||
| anavi/macropad8 | ||
| angel17 | ||
| angel64 | ||
| aos/tkl | ||
| aplx6 | ||
| arabica37 | ||
| arch_36 | ||
| ares | ||
| arisu | ||
| ash1800 | ||
| ash_xiix | ||
| ashpil/modelm_usbc | ||
| at101_bh | ||
| at_at/660m | ||
| atomic | ||
| atreus | ||
| atreus62 | ||
| atxkb | ||
| aves65 | ||
| baguette | ||
| bakeneko80 | ||
| bantam44 | ||
| barleycorn | ||
| basekeys/slice | ||
| bat43 | ||
| bear_face | ||
| bfake | ||
| bigseries | ||
| bigswitch | ||
| bioi/g60ble | ||
| blackplum | ||
| blockey | ||
| bm16a | ||
| bm16s | ||
| bm40hsrgb | ||
| bm43a | ||
| bm60rgb | ||
| bm60rgb_iso | ||
| boardsource | ||
| boardwalk | ||
| boston_meetup | ||
| botanicalkeyboards/fm2u | ||
| bpiphany | ||
| bthlabs/geekpad | ||
| business_card | ||
| butterstick | ||
| c39 | ||
| candybar | ||
| cannonkeys | ||
| catch22 | ||
| centromere | ||
| chavdai40 | ||
| cheshire/curiosity | ||
| chidori | ||
| chili | ||
| chimera_ergo | ||
| chimera_ls | ||
| chimera_ortho | ||
| chimera_ortho_plus | ||
| choc_taro | ||
| choco60 | ||
| christmas_tree | ||
| ckeys | ||
| claw44 | ||
| clawsome | ||
| clueboard | ||
| cocoa40 | ||
| comet46 | ||
| contra | ||
| converter | ||
| copenhagen_click/click_pad_v1 | ||
| coseyfannitutti | ||
| cospad | ||
| craftwalk | ||
| crawlpad | ||
| crkbd | ||
| cu24 | ||
| cu75 | ||
| cu80 | ||
| cutie_club/wraith | ||
| daisy | ||
| db/db63 | ||
| dc01 | ||
| deltasplit75 | ||
| dichotomy | ||
| diverge3 | ||
| divergetm2 | ||
| dk60 | ||
| dm9records | ||
| dmqdesign/spin | ||
| do60 | ||
| donutcables | ||
| doppelganger | ||
| doro67 | ||
| dozen0 | ||
| dp60 | ||
| drakon | ||
| duck | ||
| dumbo | ||
| dumbpad | ||
| dz60 | ||
| dztech | ||
| e88 | ||
| eco | ||
| efreet | ||
| emptystring/NQG | ||
| eniigmakeyboards | ||
| ep | ||
| ergo42 | ||
| ergodash | ||
| ergodone | ||
| ergodox_ez | ||
| ergodox_infinity | ||
| ergodox_stm32 | ||
| ergosaurus | ||
| ergoslab | ||
| ergotaco | ||
| ergotravel | ||
| ericrlau/numdiscipline | ||
| espectro | ||
| eve/meteor | ||
| evil80 | ||
| exclusive | ||
| exent | ||
| facew | ||
| fallacy | ||
| fc660c | ||
| fc980c | ||
| felix | ||
| fleuron | ||
| fluorite | ||
| flx | ||
| for_science | ||
| fortitude60 | ||
| four_banger | ||
| foxlab | ||
| fractal | ||
| freyr | ||
| ft/mars80 | ||
| function96 | ||
| funky40 | ||
| gami_studio/lex60 | ||
| gboards | ||
| geekboards/tester | ||
| generic_panda/panda65_01 | ||
| georgi | ||
| gergo | ||
| getta25 | ||
| gh60 | ||
| gh80_3000 | ||
| ghs/rar | ||
| gingham | ||
| gon | ||
| gowla | ||
| gray_studio | ||
| grid600 | ||
| gskt00 | ||
| hadron | ||
| halberd | ||
| handwired | ||
| hardlineworks/otd_plus | ||
| hecomi | ||
| heliar/wm1_hotswap | ||
| helix | ||
| hhkb | ||
| hhkb_lite_2 | ||
| hid_liber | ||
| hifumi | ||
| hineybush | ||
| holyswitch/southpaw75 | ||
| honeycomb | ||
| hotdox | ||
| hs60 | ||
| hub16 | ||
| id80 | ||
| idb/idb_60 | ||
| idobo | ||
| illuminati/is0 | ||
| infinity60 | ||
| ivy | ||
| j80 | ||
| jae/j01 | ||
| jc65 | ||
| jd40 | ||
| jd45 | ||
| jian | ||
| jiran | ||
| jisplit89 | ||
| jj4x4 | ||
| jj40 | ||
| jj50 | ||
| jm60 | ||
| jnao | ||
| just60 | ||
| k_type | ||
| kabedon | ||
| kagamidget | ||
| katana60 | ||
| kb_elmo | ||
| kbdclack/kaishi65 | ||
| kbdfans | ||
| kc60 | ||
| kc60se | ||
| keebio | ||
| keebwerk/nano_slider | ||
| keebzdotnet/wazowski | ||
| keybage/radpad | ||
| keyboardio | ||
| keycapsss | ||
| keyhive/maypad | ||
| kinesis | ||
| kingly_keys | ||
| kira75 | ||
| kira80 | ||
| kiwikeebs | ||
| kmac | ||
| kmini | ||
| knops | ||
| kona_classic | ||
| kudox | ||
| kudox_game | ||
| kv/revt | ||
| kyria | ||
| laptreus | ||
| latinpad | ||
| lattice60 | ||
| launchpad | ||
| lazydesigners | ||
| le_chiffre | ||
| leeku/finger65 | ||
| lets_split | ||
| lets_split_eh | ||
| lfkeyboards | ||
| lily58 | ||
| m0lly | ||
| m10a | ||
| maartenwut | ||
| manta60 | ||
| massdrop | ||
| matrix | ||
| maxipad | ||
| maxr1998 | ||
| mc_76k | ||
| mechkeys/mk60 | ||
| mechllama/g35 | ||
| mechlovin | ||
| mechmini | ||
| mehkee96 | ||
| meira | ||
| meishi | ||
| meishi2 | ||
| melody96 | ||
| meme | ||
| meson | ||
| metamechs/timberwolf | ||
| miller/gm862 | ||
| miniaxe | ||
| minidox | ||
| mint60 | ||
| mitosis | ||
| miuni32 | ||
| mixi | ||
| montsinger | ||
| moon | ||
| moonlander | ||
| mountainblocks/mb17 | ||
| mschwingen/modelm | ||
| mt40 | ||
| mt980 | ||
| murcielago | ||
| mxss | ||
| nafuda | ||
| naked48 | ||
| naked60 | ||
| naked64 | ||
| namecard2x4 | ||
| navi10 | ||
| ncc1701kb | ||
| nckiibs | ||
| nebula12 | ||
| nebula65 | ||
| nek_type_a | ||
| nemui | ||
| newgame40 | ||
| nightly_boards | ||
| nightmare | ||
| niu_mini | ||
| nk65 | ||
| nk87 | ||
| nomu30 | ||
| novelpad | ||
| noxary | ||
| numatreus | ||
| oddball | ||
| ogre | ||
| ok60 | ||
| omnikey_bh | ||
| omnikeyish | ||
| orange75 | ||
| org60 | ||
| ortho5by12 | ||
| orthodox | ||
| otaku_split | ||
| pabile | ||
| paladin64 | ||
| palette1202 | ||
| panc40 | ||
| panc60 | ||
| pandora | ||
| pdxkbc | ||
| pearl | ||
| peiorisboards/ixora | ||
| percent | ||
| phantom | ||
| pico | ||
| pimentoso/paddino02 | ||
| pinky | ||
| pistachio | ||
| planck | ||
| playkbtw | ||
| pom_keyboards/tnln95 | ||
| preonic | ||
| primekb | ||
| projectkb | ||
| puck | ||
| punk75 | ||
| qaz | ||
| quad_h/lb75 | ||
| quantrik/kyuu | ||
| qwertyydox | ||
| rabbit/rabbit68 | ||
| rabbit_capture_plan | ||
| ramonimbao | ||
| rart | ||
| redox | ||
| redox_w | ||
| redscarf_i | ||
| redscarf_iiplus | ||
| retro_75 | ||
| reversestudio/decadepad | ||
| reviung34 | ||
| reviung39 | ||
| reviung41 | ||
| reviung61 | ||
| rgbkb | ||
| rotr | ||
| runner3680 | ||
| s7_elephant | ||
| satt/vision | ||
| scarletbandana | ||
| sck | ||
| scythe | ||
| sentraq | ||
| setta21 | ||
| shambles | ||
| shiro | ||
| sidderskb/majbritt | ||
| signum/3_0/elitec | ||
| silverbullet44 | ||
| singa | ||
| sirius | ||
| sixkeyboard | ||
| smk60 | ||
| snagpad | ||
| snampad | ||
| sofle | ||
| southpaw75 | ||
| southpole | ||
| spaceman | ||
| spacetime | ||
| speedo | ||
| splitish | ||
| splitreus62 | ||
| squiggle | ||
| standaside | ||
| staryu | ||
| stella | ||
| stoutgat | ||
| subatomic | ||
| suihankey | ||
| switchplate | ||
| sx60 | ||
| tada68 | ||
| tanuki | ||
| telophase | ||
| tenki | ||
| tetris | ||
| tg4x | ||
| tgr | ||
| the_royal | ||
| the_ruler | ||
| thedogkeyboard | ||
| themadnoodle | ||
| thevankeyboards | ||
| tkc | ||
| tkc1800 | ||
| tmo50 | ||
| toad | ||
| tokyo60 | ||
| touchpad | ||
| tr60w | ||
| treadstone32 | ||
| treadstone48 | ||
| treasure/type9 | ||
| ua62 | ||
| uk78 | ||
| underscore33 | ||
| unikorn | ||
| uranuma | ||
| ut472 | ||
| uzu42 | ||
| v60_type_r | ||
| vinta | ||
| vision_division | ||
| vitamins_included | ||
| vn66 | ||
| waldo | ||
| wallaby | ||
| walletburner/neuron | ||
| westfoxtrot | ||
| whale/sk | ||
| wheatfield | ||
| whitefox | ||
| wilba_tech | ||
| winkeyless | ||
| wolfmarkclub/wm1 | ||
| wsk | ||
| x16 | ||
| xbows | ||
| xd60 | ||
| xd68 | ||
| xd75 | ||
| xd84 | ||
| xd87 | ||
| xd96 | ||
| xd002 | ||
| xd004 | ||
| xelus | ||
| xiaomi/mk02 | ||
| xmmx | ||
| xw60 | ||
| yatara/drink_me | ||
| yd60mq | ||
| yd68 | ||
| ymd75 | ||
| ymd96 | ||
| ymdk | ||
| ymdk_np21 | ||
| yncognito/batpad | ||
| yosino58 | ||
| yurei | ||
| yushakobo/quick7 | ||
| z150_bh | ||
| zfrontier/big_switch | ||
| zinc | ||
| zj68 | ||
| zlant | ||
| 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.