keychron_qmk_firmware/keyboards
MakotoKurauchi 29830f306f Keyboard: Pr/helixpico add layout kc (#4686)
* add some comment about Helix customize and auto-setup RGBLIGHT_LIMIT_VAL

* add define USB_MAX_POWER_CONSUMPTION

* Helix keyboard OLED, RGBLIGHT enable/disable control integrate into rules.mk

rules.mk: add 4 Variables for compile control.

   # Helix keyboard customize
   # you can edit follows 4 Variables
   #  jp: 以下の4つの変数を必要に応じて編集します。
   OLED_ENABLE = no            # OLED_ENABLE
   LED_BACK_ENABLE = no        # LED backlight (Enable WS2812 RGB underlight.)
   LED_UNDERGLOW_ENABLE = no   # LED underglow (Enable WS2812 RGB underlight.)
   LED_ANIMATIONS = yes        # LED animations

config.h: auto set RGBLED_NUM by HELIX_ROWS and rules.mk's define

* HELIX_ROWS define move from config.h to rules.mk

* add readme.md

* rename readme.md to readme_jp.md

* add readme.md and modify readme_jp.md

* change helix/ssd1306.c for select glcdfont.c position

* add variable LOCAL_GLCDFONT into each keymaps rules.mk

* Add iPhone/iPad LED support to Helix default keymap

* renumber _ADJUST for shrink program size

* Fix Helix i2c wrong bit rate

* add helix serial debug code

* serial debug macro move from config.h to serial.h

* helix serial.c debugging...

* refine debug macros

* add some comments

* add SELECT_SERIAL_SPEED

* add comments

* debugging sync_send/sync_recv

* add very high speed

* fix sync_send/sync_recv

* fix com. start and switch send/recv

* debug mode off

* remove debug codes

* temporary change, compiling C, C++ and ASM without -g

* helix config.h refine

* Revert "temporary change, compiling C, C++ and ASM without -g"

This reverts commit e9730cbbfd94fbcf792d992e3a1a65ad279b24d6.

* add change_reciver2sender()/change_sender2reciver()

This is a change to improve readability.

* txled, rxled off in matrix_init()

* add serial_send_packet() / serial_recive_packet()

This is a change to reduce object size.

* add serial_low() at ISR() top

* add __attribute__((always_inline)) to some functions

* modify serial_send_packet()/serial_recive_packet()

A little, object size reduction.
A little, speedup.

* add debug code to helix/serial.c

* Adjust sampling timing of serial signal being received

* add split_scomm.c/split_scomm.h and change serial.c/serial.h

serial.c was divided into 2 layers, split_scom.c and serial.c.
The upper layer split_scomm.c is called from matrix.c.
The lower layer serial.c accesses the hardware.

* add split_scomm.c/split_scomm.h into helix/rev1

* reduce object size helix/rev2/matrix.c

* remove checksum check, add parity check

* force occur parity error for test

* parity test ok. remove test code

* change some comment & add skip code when buffer_size == 0

* serial.c: multiple types of transaction support

Add 4 bits transaction-type field at packet top.
Select Transaction Descriptor Table entry by transaction-type.

* helix serial master-slave transaction optimize

Using multi-type transaction feature of serial.c, communication contents between master slaves were optimized.

* add debug code for retry

* add comment into each config.h

* fix ISR status drop

* add a debug macro 'debug_retry_chg()'

* reduce led_test size

* remove debug code from helix/serial.c and etc.

* helix:five_rows change TAPPING_TERM value 140

* Improved compatibility with let's split of serial.c. Finish helix/serial.c improvement.

- The difference with the original let's split's serial.c
  - It's high-speed about 4 times.
  - Stable bi-directional data transfer. (Helix need master to slave transfer)
  - serial.h was divided 2 files, serial_config.h and sereial.h
  - With multiple types of transaction support, communication contents can be optimized. (NEW flexible API)

- USE OLD Simple APIs (compatible with let's split serial.c)
  - files :
    - serial_config.h -- hardware configuration (need include by config.h)
    - serial.c/serial.h -- serial communication

- USE NEW flexible APIs. (Support multi-type transaction function.)
  serial.c was divided into 2 layers, split_scom.c and serial.c.
  The upper layer split_scomm.c is called from matrix.c.
  The lower layer serial.c accesses the hardware.
  - files
    - split_scomm.c -- communication buffer is defined in here. call by matrix.c.
    - split_scomm.h -- buffer size is defined in here. include by matrix.c, split_util.c
    - serial_config.h -- hardware configuration (need include by config.h)
      To use the NEW API, specify #define SERIAL_USE_MULTI_TRANSACTION
    - serial.c/serial.h -- serial communication lower layer

- NEW APIs for serial.c / serial.h (The lower layer)
  // Soft Serial Transaction Descriptor
  typedef struct _SSTD_t  {
      uint8_t *status;
      uint8_t initiator2target_buffer_size;
      uint8_t *initiator2target_buffer;
      uint8_t target2initiator_buffer_size;
      uint8_t *target2initiator_buffer;
  } SSTD_t;

  // initiator is transaction start side
  void soft_serial_initiator_init(SSTD_t *sstd_table);
  // target is interrupt accept side
  void soft_serial_target_init(SSTD_t *sstd_table);
  int soft_serial_transaction(int sstd_index);
  int soft_serial_get_and_clean_target_status(int sstd_index);

- NEW APIs for split_scomm.c / split_scomm.h (The upper layer)
   move from old serial.c the following buffer and functions
     serial_slave_buffer[]
     serial_master_buffer[]
     void serial_master_init(void)
     void serial_slave_init(void)
     int serial_update_buffers(void)
   define SERIAL_xxxxx_BUFFER_LENGTH move from serial_config.h to split_scomm.h

* fix comment typo

* Fix the value of helix:five_rows variable HELIX_ROWS to 5.

* led_test rules.mk some change

* Separate common parts of helix/rev2/keymaps/*/rules.mk into helix/rev2/keymaps_common.mk

* helix/rev2/keymaps/edvorakjp/rules.mk use helix/rev2/keymaps_common.mk

* Separate common parts of helix/pico/keymaps/*/rules.mk into helix/pico/keymaps_common.mk

* Helix each keymap's using rgblight mode symbol instead magic number

No change in build result.

* Helix pico keymaps: make rgblight modes selectable.

No change in build result.

* Helix rev2 keymaps: make rgblight modes selectable.

No change in build result.

* fixed Helix froggy/keymap.c: invalid rgblight mode value 0 to 1 (=RGBLIGHT_MODE_STATIC_LIGHT)

* Deselect RGB_TEST and ALTERNATING in Helix rev2,pico keymaps config.h.

* Merge branch 'master' of https://github.com/qmk/qmk_firmware

* revert 955dcbc

* delete keymaps_common.mk

* add LAYOUT_kc() to keyboards/helix/pico/pico.h
2018-12-20 08:55:03 -08:00
..
1upkeyboards 1up60hse: Make Keymap Rows Match Keyboard Row Layout (#4564) 2018-12-07 07:56:38 -08:00
6ball
9key
30wer Keyboard: Add 30wer config and keymap (#4386) 2018-11-08 15:12:42 -08:00
40percentclub Make quantum/split_common/serial.[ch] configurable (#4419) 2018-12-14 11:00:10 -08:00
412_64 Keyboard: Add 412 64 Model 00 keyboard. (#4400) 2018-11-13 08:38:48 -08:00
acr60
al1
alf
alpha
alps64 crd alps64 updates (#4565) 2018-12-07 07:52:31 -08:00
alu84
amj40
amj60
amj96
amjpad
at101_blackheart AT101 Blackheart: readme update 2018-12-13 23:36:58 -08:00
atom47 Fix permanently on capslock led on Atom47 (#4452) 2018-11-19 12:15:16 -08:00
atomic
atreus
atreus62
baguette Baguette: Configurator update 2018-12-14 07:25:56 -08:00
bantam44
bface Remove RGB_SMOD alias and replace uses with RGB_MOD (#4319) 2018-11-27 15:34:06 -08:00
bfake
bfo9000
bigseries
bigswitch Fix keymap build to send over remote desktop correctly. (#4651) 2018-12-14 18:39:16 -08:00
blockey Fix Blockey compiler (and size) issues (#4390) 2018-11-26 08:09:37 -08:00
bmini Turn off Mousekeys for several ps2avrGB keyboards (#4502) 2018-11-27 16:54:43 -08:00
bminiex Keyboard: B.mini EX refactor and Configurator support (#4647) 2018-12-14 11:37:26 -08:00
bpiphany Keyboard: Bpiphany Pegasus Hoof Refactor, Configurator support (#4649) 2018-12-14 16:38:46 -08:00
canoe Turn off Mousekeys for several ps2avrGB keyboards (#4502) 2018-11-27 16:54:43 -08:00
catch22
chibios_test
chimera_ergo
chimera_ls
chimera_ortho Keyboard: Chimera Ortho refactor (#4652) 2018-12-14 21:36:03 -08:00
chocopad
christmas_tree
ckeys
clueboard Add PROGMEM keyword to Clueboard keymaps 2018-12-20 08:44:42 -08:00
cod67
comet46 Comet46: Configurator support 2018-12-14 20:04:08 -08:00
contra
converter converter/xt_usb: Configurator support (#4657) 2018-12-15 07:25:29 -08:00
cospad Cospad Configurator and readme update (#4663) 2018-12-15 13:39:34 -08:00
crawlpad
crkbd Keymap: Modified like-jis keymap for crkbd (#4577) 2018-12-08 09:43:57 -08:00
cu24
cu75
cyclops New Keyboard: Cyclops (#4512) 2018-11-29 07:57:06 -08:00
daisy Remove RGB_SMOD alias and replace uses with RGB_MOD (#4319) 2018-11-27 15:34:06 -08:00
dc01
deltasplit75
dichotomy update the alairock keymap for dichotomy (#4687) 2018-12-19 16:54:19 -08:00
dilly
diverge3 Make quantum/split_common/serial.[ch] configurable (#4419) 2018-12-14 11:00:10 -08:00
divergetm2 Make quantum/split_common/serial.[ch] configurable (#4419) 2018-12-14 11:00:10 -08:00
dk60
do60 Keyboard: Add HHKB layout support to the DO60 (#4526) 2018-12-01 17:19:33 -08:00
duck Configurator support for Octagon V2 75_ansi (#4426) 2018-11-14 18:37:53 -08:00
dz60 Keymap: Added Drewsky DZ60 keymap (#4607) 2018-12-11 14:24:17 -08:00
e6v2
eco
ep added ep/96 as a supported keyboard (#4476) 2018-11-26 07:58:53 -08:00
ergo42 Ergo42: Configurator patch (#4664) 2018-12-15 13:39:05 -08:00
ergodash
ergodone
ergodox_ez Keymap: Refactor Hacker Dvorak (#4688) 2018-12-19 16:49:56 -08:00
ergodox_infinity
ergoinu EKeyboard: ErgoInu Configurator fix (#4665) 2018-12-16 00:40:46 -08:00
ergotravel Keymap: A Planck style keymap with iris flair (#4677) 2018-12-18 09:14:56 -08:00
espectro Keyboard: Espectro refactor and Configurator support (#4666) 2018-12-18 09:16:06 -08:00
evil80
facew
fc660c
fc980c Fix fc980c.h update (#4682) 2018-12-19 08:23:28 -08:00
felix
fleuron
fortitude60 [fortitude60] match default keymap comment to the implementation. (#4508) 2018-11-28 07:33:08 -08:00
four_banger Four Banger: Clean Up Indentation (#4322) 2018-11-01 22:21:28 -07:00
fourier Keyboard: Refactor fourier to use split common code (#4582) 2018-12-14 14:25:32 -08:00
fractal
gh60
gh80_3000
gonnerd
gskt00 GSKT-00 Configurator update 2018-12-20 08:52:54 -08:00
h87a
hadron Keymap: update ishtobs hadron keymap (#4613) 2018-12-12 15:20:30 -08:00
handwired Keyboard: Adding ortho60 to handwired (#4672) 2018-12-18 08:26:43 -08:00
helix Keyboard: Pr/helixpico add layout kc (#4686) 2018-12-20 08:55:03 -08:00
hhkb
hid_liber
hs60 Allow HS60 to use Community Layouts (#3862) 2018-12-06 07:40:19 -08:00
idobo Keymap: Jtcarrasco (#4513) 2018-12-05 15:13:31 -08:00
infinity60
iris Make quantum/split_common/serial.[ch] configurable (#4419) 2018-12-14 11:00:10 -08:00
jc65 Turn off Mousekeys for several ps2avrGB keyboards (#4502) 2018-11-27 16:54:43 -08:00
jd40
jd45
jj40 Remove RGB_SMOD alias and replace uses with RGB_MOD (#4319) 2018-11-27 15:34:06 -08:00
jj50
jm60
k_type
katana60
kbd4x
kbd6x Reduce compile size of KBD6x (#4599) 2018-12-11 07:29:17 -08:00
kbd8x
kbd19x
kbd66
kbd67 KBDFans KBD67 Support (#4412) 2018-11-12 21:46:34 -08:00
kbd75
kc60
kc60se
kinesis
kira75 Keyboard: Enable Lights by Default for Kira 75 (#4527) 2018-12-01 17:28:35 -08:00
kmac
kmini
knops
kona_classic
laplace
launchpad
lets_split Refactor quantum/split_common/i2c.c, quantum/split_common/serial.c (#4522) 2018-12-14 21:31:56 -08:00
lets_split_eh Keyboard: Lets split eh default keymap - Fixes for superseded default layer functionality (#4581) 2018-12-14 13:29:30 -08:00
levinson Make quantum/split_common/serial.[ch] configurable (#4419) 2018-12-14 11:00:10 -08:00
lfkeyboards Fix the LFKeyboards so they work with the QMK Configurator (#4591) 2018-12-10 11:38:57 -08:00
lily58
m10a
massdrop Bringing Massdrop keyboard hardware configuration to keyboard level (#4593) 2018-12-10 11:28:06 -08:00
maxipad
mechmini
mehkee96
meira
melody96
meme
miniaxe Make quantum/split_common/serial.[ch] configurable (#4419) 2018-12-14 11:00:10 -08:00
minidox Document the correct path to the split keyboard EEPROM files (#4585) 2018-12-14 12:49:33 -08:00
mint60
mitosis
miuni32
model01 Keyboardio Model 01: Configurator support 2018-12-13 22:54:56 -08:00
mt40
mxss
namecard2x4
newgame40 Keyboard: add newgame (#4466) 2018-11-28 09:20:46 -08:00
niu_mini Update to my keymaps and userspace (#4447) 2018-11-18 07:52:14 -08:00
novelpad
noxary Port over Noxary 268.2 from Rosakiin's Noxary Firmware (#4354) 2018-11-06 12:35:08 -08:00
nyquist Make quantum/split_common/serial.[ch] configurable (#4419) 2018-12-14 11:00:10 -08:00
ok60
omnikey_blackheart
orange75
org60
orthodox Document the correct path to the split keyboard EEPROM files (#4585) 2018-12-14 12:49:33 -08:00
paladin64
panc60
pearl Turn off Mousekeys for several ps2avrGB keyboards (#4502) 2018-11-27 16:54:43 -08:00
phantom
planck Keymap: @mattly's planck layout (#4678) 2018-12-18 08:37:03 -08:00
playkbtw Remove RGB_SMOD alias and replace uses with RGB_MOD (#4319) 2018-11-27 15:34:06 -08:00
preonic Preonic Configurator update (#4598) 2018-12-11 18:58:10 -05:00
primekb Update to my keymaps and userspace (#4447) 2018-11-18 07:52:14 -08:00
proton_c Adds the Proton C base project (#4224) 2018-11-02 12:44:57 -04:00
ps2avrGB Turn off Mousekeys for several ps2avrGB keyboards (#4502) 2018-11-27 16:54:43 -08:00
puck Puck Refactor, Configurator support and readme cleanup (#4615) 2018-12-12 12:46:56 -08:00
quefrency Make quantum/split_common/serial.[ch] configurable (#4419) 2018-12-14 11:00:10 -08:00
qwertyydox Make quantum/split_common/serial.[ch] configurable (#4419) 2018-12-14 11:00:10 -08:00
rama Added Dynamic Keymaps to M10-B 2018-12-13 08:18:49 -08:00
redox Make quantum/split_common/serial.[ch] configurable (#4419) 2018-12-14 11:00:10 -08:00
redox_w
rorschach Make quantum/split_common/serial.[ch] configurable (#4419) 2018-12-14 11:00:10 -08:00
s7_elephant S7 Elephant Configurator fixes (#4614) 2018-12-12 12:46:12 -08:00
s60_x
s65_plus
s65_x
satan Satan: add LAYOUT_60_ansi_split_rshift to info.json (#4441) 2018-11-18 08:23:51 -08:00
scrabblepad Keymap for random key presses for the scrabblepad (#4356) 2018-11-10 08:22:36 -08:00
singa
sixkeyboard
sixshooter Keyboard: Updated sixshooter keyboard to move LED macros into the default keymap. (#4428) 2018-12-05 09:35:26 -08:00
sol Sol rev1 Configurator support (#4562) 2018-12-06 07:27:04 -08:00
speedo
staryu
subatomic
sx60
tada68 Keymap: Added abishalom keymaps (#4495) 2018-11-27 09:22:49 -08:00
tanuki
telophase
tetris Add some optimization to the Tetris keyboard (#4645) 2018-12-14 10:42:30 -08:00
the_ruler
thevankeyboards Keymap: Update keymap to match latest changes to Wilba's firmware. (#4432) 2018-11-21 13:18:18 -08:00
tkc1800
toad
tokyo60
tragicforce68 Add rules.mk to ortho_4x12/buswerks keymap (#4405) 2018-11-12 12:04:12 -08:00
treasure/type9
uk78
v60_type_r
vinta Update rules.mk for Vinta (#4317) 2018-11-01 17:28:01 -07:00
vision_division
vitamins_included
viterbi Update to drashna userspace and keymaps (#4459) 2018-11-26 16:45:24 -08:00
wavelet
whitefox Overhaul Unicode Common functionality (#4325) 2018-12-19 08:39:24 -08:00
wilba_tech Keyboard: Initial commit of WT8-A implementation (#4674) 2018-12-18 08:28:31 -08:00
xd60
xd75 Add standard definitions for ALGR and KC_ALGR (#4389) 2018-12-12 10:17:19 -08:00
xd87
xmmx
yd68
ymd75
ymd96
ymdk_np21
z150_blackheart
zeal60 Changing Zeal60/Zeal65 VID/PID to be unique (#4605) 2018-12-11 07:31:13 -08:00
zeal65 Changing Zeal60/Zeal65 VID/PID to be unique (#4605) 2018-12-11 07:31:13 -08:00
zen
zinc Zinc : Update to latest serial.c #4278 (#4361) 2018-11-06 12:00:02 -08:00
zlant Zlant: Configurator rendering bugfix (#4622) 2018-12-12 15:08:33 -08:00
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

These keyboards are manufactured by the maintainers of QMK.

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.

ErgoDox EZ - Erez Zukerman

Made in Taiwan using advanced robotic manufacturing, the ErgoDox EZ is a fully-assembled, premium ergonomic keyboard. Its split design allows you to place both halves shoulder width, and its custom-made wrist rests and tilt/tent kit make for incredibly comfortable typing. Available on ergodox-ez.com.

  • ErgoDox EZ — Our one and only product. Yes, it's that awesome. Comes with either printed or blank keycaps, and 7 different keyswitch types.

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.

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.
  • 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
  • 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.
  • XD75 — 15x5 ortholinear keyboard by XIUDI.
  • YMDK NP21 — ps2avrGB based number pad (numpad) sold by YMDK on Aliexpress.