From ac46378ac62c4365b5b67e306522df77027355ea Mon Sep 17 00:00:00 2001 From: Jack Humbert Date: Thu, 2 Aug 2018 23:07:33 -0400 Subject: [PATCH 01/17] Update ISP flashing guide with pre-compiled binary (#3217) * update flashing guide with pre-compiled binary * Add files via upload * Update isp_flashing_guide.md * update file and instructions * update instructions --- docs/isp_flashing_guide.md | 95 +++++---- util/pro_micro_ISP_B6_10.hex | 362 +++++++++++++++++++++++++++++++++++ 2 files changed, 420 insertions(+), 37 deletions(-) create mode 100644 util/pro_micro_ISP_B6_10.hex diff --git a/docs/isp_flashing_guide.md b/docs/isp_flashing_guide.md index 8abc4548685..008f944cc3a 100644 --- a/docs/isp_flashing_guide.md +++ b/docs/isp_flashing_guide.md @@ -19,58 +19,79 @@ If you're having trouble flashing/erasing your board, and running into cryptic e Memory write error, use debug for more info. commands.c:360: Error writing memory data. (err -4) -You're likely going to need to ISP flash your board/device to get it working again. Luckily, this process is pretty straight-forward, provided you have any extra programmable keyboard, Arduino, or Teensy 2.0/Teensy 2.0++. There are also dedicated ISP flashers available for this, but most cost >$15, and it's assumed that if you are googling this error, this is the first you've heard about ISP flashing, and don't have one readily available (whereas you might have some other AVR board). __We'll be using a Teensy 2.0 with Windows 10 in this guide__ - if you are comfortable doing this on another system, please consider editing this guide and contributing those instructions! +You're likely going to need to ISP flash your board/device to get it working again. Luckily, this process is pretty straight-forward, provided you have any extra programmable keyboard, Pro Micro, or Teensy 2.0/Teensy 2.0++. There are also dedicated ISP flashers available for this, but most cost >$15, and it's assumed that if you are googling this error, this is the first you've heard about ISP flashing, and don't have one readily available (whereas you might have some other AVR board). __We'll be using a Teensy 2.0 or Pro Micro with Windows 10 in this guide__ - if you are comfortable doing this on another system, please consider editing this guide and contributing those instructions! ## Software Needed -* [The Arduino IDE](https://www.arduino.cc/en/Main/Software) -* [Teensyduino](https://www.pjrc.com/teensy/td_download.html) (if you're using a Teensy) -* [WinAVR](http://www.ladyada.net/learn/avr/setup-win.html) (Windows) +* [Teensy Loader](https://www.pjrc.com/teensy/loader.html) (if using a Teensy) +* QMK Toolbox (flash as usual - be sure to select the correct MCU) or `avrdude` via [WinAVR](http://www.ladyada.net/learn/avr/setup-win.html) (for Teensy & Pro Micro) ## Wiring This is pretty straight-forward - we'll be connecting like-things to like-things in the following manner: - Flasher B0 <-> Keyboard RESET - Flasher B1 <-> Keyboard B1 (SCLK) - Flasher B2 <-> Keyboard B2 (MOSI) - Flasher B3 <-> Keyboard B3 (MISO) - Flasher VCC <-> Keyboard VCC - Flasher GND <-> Keyboard GND +### Teensy 2.0 -## The ISP Firmware + Teensy B0 <-> Keyboard RESET + Teensy B1 <-> Keyboard B1 (SCLK) + Teensy B2 <-> Keyboard B2 (MOSI) + Teensy B3 <-> Keyboard B3 (MISO) + Teensy VCC <-> Keyboard VCC + Teensy GND <-> Keyboard GND + +### Pro Micro + + Pro Micro 10 (B6) <-> Keyboard RESET + Pro Micro 15 (B1) <-> Keyboard B1 (SCLK) + Pro Micro 16 (B2) <-> Keyboard B2 (MOSI) + Pro Micro 14 (B3) <-> Keyboard B3 (MISO) + Pro Micro VCC <-> Keyboard VCC + Pro Micro GND <-> Keyboard GND + +## The ISP Firmware (now pre-compiled) + +The only difference between the .hex files below is which pin is connected to RESET. You can use them on other boards as well, as long as you're aware of the pins being used. If for some reason neither of these pins are available, [create an issue](https://github.com/qmk/qmk_firmware/issues/new), and we can generate one for you! + +* Teensy 2.0: [`util/teensy_2.0_ISP_B0.hex`](https://github.com/qmk/qmk_firmware/blob/master/util/teensy_2.0_ISP_B0.hex) (`B0`) +* Pro Micro: [`util/pro_micro_ISP_B6_10.hex`](https://github.com/qmk/qmk_firmware/blob/master/util/pro_mico_ISP_B6_10.hex) (`B6/10`) + +**Flash your Teenys/Pro Micro with one of these and continue - you won't need the file after flashing your ISP device.** + +## Just the Bootloader File + +If you just want to get things back to normal, you can flash only a bootloader from [`util/` folder](https://github.com/qmk/qmk_firmware/tree/master/util), and use your normal process to flash the firmware afterwards. Be sure to flash the correct bootloader for your chip: + +* [`atmega32u4`](https://github.com/qmk/qmk_firmware/blob/master/util/bootloader_atmega32u4_1_0_0.hex) - Most keyboards, Planck Rev 1-5, Preonic Rev 1-2 +* [`at90usb1286`](https://github.com/qmk/qmk_firmware/blob/master/util/bootloader_at90usb128x_1_0_1.hex) - Planck Light Rev 1 + +If you're not sure what your board uses, look in the `rules.mk` file for the keyboard in QMK. The `MCU =` line will have the value you need. It may differ between different versions of the board. + +### Advanced/Production Techniques + +If you'd like to flash both the bootloader **and** the regular firmware at the same time, you need to combine the files. + +1. Open the original firmware .hex file in a text editor +2. Remove the last line (which should be `:00000001FF` - this is an EOF message) +3. Copy the entire bootloader's contents onto a new line (with no empty lines between) and paste it at the end of the original file +4. Save it as a new file by naming it `__production.hex` + +It's possible to use other bootloaders here in the same way, but __you need a bootloader__, otherwise you'll have to use ISP again to write new firmware to your keyboard. + +## Flashing Your Bootloader/Production File Make sure your keyboard is unplugged from any device, and plug in your Teensy. -1. Run Arduino after you have everything installed -2. Select `Tools > Board * > Teensy 2.0` -3. Click `File > Examples > 11.ArduinoISP > ArduinoISP` +### QMK Toolbox -Then scroll down until you see something that looks like this block of code: +1. `AVRISP device connected` will show up in yellow +2. Select the correct bootloader/production .hex file with the `Open` dialog (spaces can't be in the path) +3. Be sure the correct `Microcontroller` option is selected +4. Hit `Flash` +5. Wait, as nothing will output for a while, especially with production files - // Configure which pins to use: +If the verification and fuse checks are ok, you're done! Your board may restart automatically, otherwise, unplug your Teensy and plug in your keyboard - you can leave your Teensy wired to your keyboard while testing things, but it's recommended that you desolder it/remove the wiring once you're sure everything works. - // The standard pin configuration. - #ifndef ARDUINO_HOODLOADER2 - - #define RESET 0 // Use 0 (B0) instead of 10 - #define LED_HB 11 // Use 11 (LED on the Teensy 2.0) - #define LED_ERR 8 // This won't be used unless you have an LED hooked-up to 8 (D3) - #define LED_PMODE 7 // This won't be used unless you have an LED hooked-up to 7 (D2) - -And make the changes in the last four lines. If you're using something besides the Teensy 2.0, you'll want to choose something else that makes sense for `LED_HB`. We define `RESET` as `0`/`B0` because that's what's close - if you want to use another pin for some reason, [you can use the pinouts to choose something else](https://www.pjrc.com/teensy/pinout.html). - -Once you've made your changes, you can click the Upload button (right arrow), which will open up the Teensy flasher app - you'll need to press the reset button on the Teensy the first time, but after that, it's automatic (you shouldn't be flashing this more than once, though). Once flashed, the orange LED on the Teensy will flash on and off, indicating it's ready for some action. - -## The `.hex` File - -Before flashing your firmware, you're going to need to and do a little preparation. We'll be appending [this bootloader (also a .hex file)](https://github.com/qmk/qmk_firmware/blob/master/util/bootloader_atmega32u4_1_0_0.hex) to the end of our firmware by opening the original .hex file in a text editor, and removing the last line, which should be `:00000001FF` (this is an EOF message). After that's been removed, copy the entire bootloader's contents and paste it at the end of the original file, and save it. - -It's possible to use other bootloaders here in the same way, but __you need a bootloader__, otherwise you'll have to ISP to write new firmware to your keyboard. - -## Flashing Your Firmware - -Make sure your keyboard is unplugged from any device, and plug in your Teensy. +### Command Line Open `cmd` and navigate to your where your modified .hex file is. We'll pretend this file is called `main.hex`, and that your Teensy 2.0 is on the `COM3` port - if you're unsure, you can open your Device Manager, and look for `Ports > USB Serial Device`. Use that COM port here. You can confirm it's the right port with: diff --git a/util/pro_micro_ISP_B6_10.hex b/util/pro_micro_ISP_B6_10.hex new file mode 100644 index 00000000000..cf61bebb94c --- /dev/null +++ b/util/pro_micro_ISP_B6_10.hex @@ -0,0 +1,362 @@ +:10000000BDC00000E3C00000E1C00000DFC0000090 +:10001000DDC00000DBC00000D9C00000D7C0000078 +:10002000D5C00000D3C000003AC70000B1C700002F +:10003000CDC00000CBC00000C9C00000C7C0000098 +:10004000C5C00000C3C00000C1C00000BFC00000A8 +:10005000BDC00000BBC00000B9C000007FC60000EA +:10006000B5C00000B3C00000B1C00000AFC00000C8 +:10007000ADC00000ABC00000A9C00000A7C00000D8 +:10008000A5C00000A3C00000A1C000009FC00000E8 +:100090009DC000009BC0000099C0000097C00000F8 +:1000A00095C0000093C0000091C000000001000056 +:1000B0005D0112000200001A014300030000160156 +:1000C0000401030904FC001802030904E4001603F8 +:1000D000030904D6000C0C03310032003300340055 +:1000E0003500000016035500530042002000530065 +:1000F00065007200690061006C0000001803540084 +:10010000650065006E007300790064007500690089 +:100110006E006F000000040309040902430002019D +:1001200000C0320904000001020201000524001091 +:10013000010524010001042402060524060001072C +:1001400005820308004009040100020A00000007BC +:100150000503024000000705840240000012010070 +:100160000202000020C01683040001010203010006 +:1001700001C10201803601813600110B11241FBE1E +:10018000CFEFDAE0DEBFCDBF11E0A0E0B1E0EAE5FD +:10019000F6E102C005900D92A232B107D9F722E034 +:1001A000A2E2B1E001C01D92A935B207E1F710E06B +:1001B000CEEBD0E004C02197FE010E94250BCD3B81 +:1001C000D107C9F70E942D090C942B0B19CFDC0124 +:1001D000ED91FC910190F081E02D09948EBD00001D +:1001E0000DB407FEFDCF8EB508950F931F930FB684 +:1001F000F8948091440290914502A0914602B091FA +:1002000047020FBE409122015091230160912401C9 +:10021000709125018C019D01041B150B260B370BDA +:100220000832110521053105F0F0809322019093E9 +:100230002301A0932401B09325012091010180EEB8 +:10024000820F813A28F090910001919590930001DE +:1002500080910001820F80930101529A803810F43E +:100260005A9801C05A9A1F910F91089590912601B2 +:10027000882319F0911103C004C0911102C02E9A75 +:1002800001C02E98809180008F7D8093800008951A +:100290000F931F93CF93DF938B01EC01DD27FE01BA +:1002A0009ED46EE170E080E090E098D5FE019DD490 +:1002B0006EE170E080E090E091D50150110978F78F +:1002C000DF91CF911F910F91089540E05BE460E0D2 +:1002D00070E08FE492E00E94AA0A509A62E070E017 +:1002E00085E090E0D5DF519A62E070E086E090E032 +:1002F000CFDF529A62E070E087E090E0C9CF8823B8 +:1003000011F0589A01C0589884B58F7D84BD089526 +:10031000CF93DF9300D01F92CDB7DEB72B834A83F4 +:1003200069835CDF6981862F59DF4A81842F56DF1C +:100330002B81822F0F900F900F90DF91CF914ECF96 +:1003400020913A012093270180913B01809328015D +:1003500080913C018093290180913D0180932A0185 +:1003600080913E0180932B0180913F0180932C016D +:100370008091400180932D018091410180932E0155 +:100380008091420180932F018091440190E0982F49 +:10039000882730914501830F911D909331018093FF +:1003A00030018091460190E0982F882730914701D5 +:1003B000830F911D90933301809332018091480106 +:1003C00090E0982F882730914901830F911D9093D9 +:1003D00035018093340180914A0190E0A0E0B0E0C3 +:1003E000BA2FA92F982F882730914B01830F911D89 +:1003F000A11DB11DDC019927882740914C0150E0D7 +:10040000542F4427052E000C660B770B840F951F85 +:10041000A61FB71F30914D01830F911DA11DB11D66 +:100420008093360190933701A0933801B09339013E +:1004300081E0203E08F480E080932601089581E069 +:1004400015DF269A6DD380914202882381F0813096 +:1004500051F48DB3809340029DB380914102809509 +:1004600089238DBB04C08FB7F8948093400283E545 +:100470008CBD1DBC299864E170E080E090E0AED4B2 +:1004800080E0F4DE80E991E00197F1F781E0EEDEB3 +:1004900062E370E080E090E0A1D420E040E063E51A +:1004A0008CEA36DF81E090E090933D0280933C023D +:1004B000089541D322982A982198299880E0D6DE81 +:1004C00026982E98EDE7F0E080818F7D8083109252 +:1004D0003D0210923C020895242F880F880F880F48 +:1004E000462F672F805C14CFCF93DF9300D0CDB71A +:1004F000DEB7482F692F80E090E049836A83FFDEF2 +:1005000020E049816A818CE403DF6EE170E080E0E5 +:1005100090E064D481E090E00F900F90DF91CF9154 +:10052000EECE209132013091330180913A029091C8 +:100530003B022032310511F4807F089520343105CB +:1005400011F4807E08952038310511F4807C0895DF +:100550002115314009F480780895CF92DF92EF920F +:10056000FF920F931F93CF93DF936C01DADF8C011F +:10057000C0E0D0E0CC15DD0554F5D3DF7C010817D1 +:10058000190721F0C801B0DFCCDF7C01FE01E65C79 +:10059000FE4F60913A0270913B02408180E09CDF07 +:1005A0002296FE01E75CFE4F60913A0270913B0299 +:1005B000408181E091DF20913A0230913B022F5F30 +:1005C0003F4F30933B0220933A028701D3CFC801BB +:1005D0008BDF80E1DF91CF911F910F91FF90EF9022 +:1005E000DF90CF900895462F880F880F880F20E066 +:1005F000672F805E8DCE0F931F93CF93DF938C0177 +:10060000C0E0D0E0C017D10704F560913A027091C4 +:100610003B0280E0E8DF682F8FE492E0D8DD609154 +:100620003A0270913B0281E0DEDF682F8FE492E0B6 +:10063000CEDD20913A0230913B022F5F3F4F309345 +:100640003B0220933A022296DDCF80E1DF91CF91E9 +:100650001F910F910895EF92FF920F931F93CF93E5 +:10066000DF937C0100913A0210913B02000F111FB1 +:10067000E801CE01801B910B8E159F055CF42FEFD6 +:100680004C2F6D2F80EA44DE682F8FE492E09FDDCF +:100690002196EFCF80E1DF91CF911F910F91FF90D5 +:1006A000EF9008958FE492E0F2D5892BD9F38FE48F +:1006B00092E026C608950F931F93CF93DF938C018A +:1006C000CAE3D1E0CE018A539140801791071CF410 +:1006D000E9DF8993F7CFDF91CF911F910F910895B3 +:1006E000EF92FF920F931F93CF93DF93EC018B0157 +:1006F000CB01E1DF80E090E002DE8AE3E82E81E0DA +:10070000F82E0C0F1D1FC017D10771F0F7012191B2 +:100710007F014C2F6D2F80ECFBDD6DE270E080E0FF +:1007200090E05CD32196EFCF81E090E0E8DD80E1BE +:10073000DF91CF911F910F91FF90EF9008950F934C +:100740001F93CF93DF938C01C0913A02D0913B026B +:1007500080913401909135018017910718F0CC0FEA +:10076000DD1F0BC080913E0290913F020196909355 +:100770003F0280933E0281E10FC00132110540F03B +:1007800060E270E0CE01ACDFA09600521109F5CF17 +:10079000B801CE01A5DF80E1DF91CF911F910F91CC +:1007A000089580DF803231F464E18FE492E00FDD60 +:1007B00060E10AC080913E0290913F0201969093C1 +:1007C0003F0280933E0265E18FE492E000CDCF933B +:1007D000C82F68DF803251F464E18FE492E0F7DCE7 +:1007E0006C2F8FE492E0F3DC60E10AC080913E025E +:1007F00090913F02019690933F0280933E0265E103 +:100800008FE492E0CF91E3CC813859F020F4803826 +:1008100061F482E00BC0823831F0833931F483E532 +:1008200005C081E003C082E101C080E0D0CF84E058 +:1008300090E041DFEAE3F1E0238142816181808140 +:1008400067DDC5CFCF93DF93EC0135DF2BDF80323F +:1008500041F464E18FE492E0BADCCE017EDE682FE1 +:100860000AC080913E0290913F02019690933F0210 +:1008700080933E0265E18FE492E0DF91CF91A7CCB7 +:10088000CF93DF930FDFC82FD0E0DC2FCC270ADF18 +:10089000C80FD11D07DF863421F4CE01DF91CF913F +:1008A000D1CF8534B9F4CE014ADFC82FFBDE8032C8 +:1008B00031F464E18FE492E08ADC6C2F0CC080910B +:1008C0003E0290913F02019690933F0280933E0238 +:1008D00065E101C061E18FE492E0DF91CF9177CCD7 +:1008E0000F931F93CF93DF93DDDEC82FDBDE082F3E +:1008F000D9DE182FD7DE803259F080913E029091D8 +:100900003F02019690933F0280933E0265E115C03D +:10091000D0E0DC2FCC27C00FD11D64E18FE492E042 +:1009200056DC163419F4CE0166DE06C0153419F40F +:10093000CE0191DE01C081E1682F8FE492E0DF916A +:10094000CF911F910F9143CCADDE803259F0809151 +:100950003E0290913F02019690933F0280933E02A7 +:1009600065E120C064E18FE492E031DC20E040E00A +:1009700060E080E3CDDC682F8FE492E028DC20E0AB +:1009800041E060E080E3C4DC682F8FE492E01FDC8C +:1009900020E042E060E080E3BBDC682F8FE492E07F +:1009A00016DC60E18FE492E012CC7CDE813509F444 +:1009B00077C0E0F4813409F460C050F4803309F466 +:1009C00040C0813309F442C0803209F07AC06FC060 +:1009D000853409F454C0803509F455C0823409F0D7 +:1009E00070C084E190E067DEABDC4CC0813609F476 +:1009F00053C0F0F4863509F452C0803609F44BC078 +:100A0000853509F05EC04EDE90E090933B02809306 +:100A10003A0248DE90E0982F882720913A023091E0 +:100A20003B02820F931F90933B0280933A022AC0AD +:100A30008437A1F1853709F439C0843609F041C003 +:100A40001FCF10923F0210923E021CC02BDE80325C +:100A500071F564E18FE492E0BADBE0914F02F0912E +:100A600050020280F381E02D47E050E069E071E040 +:100A70008FE492E0099560E133C014DEC5CE85E0D5 +:100A800090E019DE8ECE80913C0290913D02892B40 +:100A9000C9F7D5DCF7CF06DE05DEF4CF21CFC7CE10 +:100AA00010923F0210923E0204DDECCF4DCF8091B8 +:100AB0003E0290913F02019690933F0280933E0246 +:100AC0000EC080913E0290913F02019690933F02AA +:100AD00080933E02E7DD803211F462E101C065E1FE +:100AE0008FE492E074CB80913C0290913D02892B7F +:100AF00011F0589A01C0589884B58F7D84BD8091BB +:100B00003E0290913F02892B11F0599A01C05998E9 +:100B10006CDB8FE492E0BBD3892B09F046CF0895BC +:100B2000289A209A8CB580618CBD8CB580648CBD70 +:100B3000219A229A08958CB58F7B8CBD08951DBA99 +:100B4000109268001CBC10BE1FBA10927A0010925E +:100B50006E0010926F00109271001092720010924D +:100B6000C900ECEBF0E0108214B817B81AB81DB841 +:100B700010BA108215B818B81BB81EB811BA08956B +:100B8000F894E1E6F0E020E82083108283E084BD61 +:100B900085BDEEE6F0E080818160808381E0809316 +:100BA000800092E090938100809390009093910058 +:100BB0009093C00094E09093C1008093C200809312 +:100BC000C3001092C40086E880937A0020937B00D3 +:100BD00010927E0010927D0040D178940895E93102 +:100BE00050F4EE0FE450FA4F0994E93120F4EE0F7F +:100BF000E25DF94F09940895289A0895299A089575 +:100C00002A9A08952B9A08952F9A6AC0589A58C024 +:100C1000599A08955A9A08955B9A0895469A66C01B +:100C2000479A6AC05E9A08955F9A6CC02C9A08959C +:100C30002D9A4AC02E9A4EC08F9A08958E9A089582 +:100C40008D9A08958C9A0895899A0895889A08959E +:100C50005C9A08955D9A0895769A08952898089563 +:100C6000299808952A9808952B9808952F9838C0A8 +:100C7000589826C0599808955A9808955B980895F1 +:100C8000469834C0479838C05E9808955F983AC037 +:100C90002C9808952D9818C02E981CC08F980895F0 +:100CA0008E9808958D9808958C9808958998089540 +:100CB000889808955C9808955D98089576980895A9 +:100CC000E4B5EF7DE4BD0895E0918000EF77E09317 +:100CD00080000895E0918000EF7DE093800008950A +:100CE000E0918000E77FE09380000895E09190001C +:100CF000EF77E09390000895E091C000EF77E093E4 +:100D0000C0000895E091C200E77FE093C20008951B +:100D1000F89484B7877F84BF80916000806180935E +:100D200060001092600080E29EE40197F1F781E09C +:100D30008093E00080E28093D80080E69AEE0197ED +:100D4000F1F7FDDE0C94003FFFCFF894F8DE80E66B +:100D50009AEE0197F1F70C940000FFCF8F938FB7B5 +:100D60008F93809143028D5F8D37D0F4809343023F +:100D7000809144028F5F80934402D8F080914502B5 +:100D80008F4F80934502A8F0809146028F4F809349 +:100D9000460278F0809147028F4F8093470209C046 +:100DA0008D5780934302809144028E5F809344026A +:100DB00028F7809148028C5F8093480258F0809118 +:100DC00049028F4F8093490228F080914A028F4F49 +:100DD00080934A028F918FBF8F911895CF92DF92A7 +:100DE000EF92FF926B017C0119D09B01C114D104D9 +:100DF000E104F10471F012D0621B730B683E734082 +:100E0000A8F381E0C81AD108E108F10828513C4F45 +:100E1000EDCFFF90EF90DF90CF9008950FB6F8944C +:100E200066B515B2709148028091490290914A02CC +:100E30000FBE10FE05C06F3F19F07C5F8F4F9F4FB4 +:100E400011240024660F001C660F001C70290895F1 +:100E50008091E80080FFFCCF08958091D80087FF43 +:100E600002C085FF1BC081E08093D70080EA809399 +:100E7000D80082E189BD09B400FEFDCF80E98093EE +:100E8000D8001092E00010925B0210925A02109269 +:100E900059021092E1008DE08093E20008951F92C4 +:100EA0000F920FB60F9211242F933F934F935F939E +:100EB0006F937F938F939F93AF93BF93EF93FF9322 +:100EC0009091E1001092E10093FF11C01092E900AF +:100ED00081E08093EB001092EC0082E28093ED00C1 +:100EE00088E08093F00010925B021092590292FF0A +:100EF0001DC080915B028823C9F080914E02882337 +:100F000059F0815080934E02811106C084E0809395 +:100F1000E9008AE38093E80080914D02882331F054 +:100F2000815080934D02811101C0F2DE90FF0CC010 +:100F300080E18093E20010925B0281E080935A028C +:100F400080EA8093D80019BC80915A02882379F0F6 +:100F500094FF0DC082E189BD09B400FEFDCF80E998 +:100F60008093D8008DE08093E20010925A02FF91A6 +:100F7000EF91BF91AF919F918F917F916F915F9111 +:100F80004F913F912F910F900FBE0F901F9018958A +:100F90001F920F920FB60F921124EF92FF920F93B0 +:100FA0001F932F933F934F935F936F937F938F93F1 +:100FB0009F93AF93BF93CF93EF93FF931092E9006A +:100FC0008091E80083FF30C1C091F1008091F10071 +:100FD000E090F100F090F1000091F1001091F1002B +:100FE0002091F1003091F10092EF9093E80086306B +:100FF00009F03FC086E0ECEAF0E0459155914E15CE +:101000005F0511F0359615C0459155914017510770 +:1010100011F033960EC04591559184912F3F3105C3 +:1010200019F010F02FEF30E0281708F4822F3EEF70 +:1010300008C0815011F7F8C0891B3093E80088235D +:10104000A9F09091E800292F2570D9F392FDEFC007 +:10105000982F813208F090E2292F222369F3FA01B8 +:1010600045914093F100AF012150F7CF903249F301 +:10107000DEC0853049F48EEF8093E800E9DE8E2DE6 +:1010800080688093E300D3C0893001F5C111CCC0E2 +:10109000E0925B021092590210924E028EEF809302 +:1010A000E80081E0EFE6F1E08093E900959190930C +:1010B000EB00992331F095919093EC0095919093EA +:1010C000ED008F5F853081F78EE1A9C0883049F44B +:1010D000C03809F0A9C0BCDE80915B028093F100AA +:1010E0007DC0813279F4C13A09F09EC0B1DEE2E000 +:1010F000F1E087E08E0F90819093F10031968E138E +:10110000FACF6CC0803209F047C0C13209F08CC000 +:101110008091E80082FFFCCFE2E0F1E087E08E0FF3 +:101120009091F100908331968E13FACF8BEF8093DC +:10113000E8008EEF8093E8003091020140910301B6 +:10114000809104012091050190E0A0E0B0E0DC0175 +:1011500099278827942B832BB22B86389105A105DC +:10116000B10521F48FE080934D0261C0863991056D +:10117000A105B10509F05BC084E08093E9009FEF11 +:101180008091EE00837039F09093E8008091E80040 +:1011900082FDFCCFF5CFD9DD823231F4C13209F0C6 +:1011A00043C0E092590204C0833221F4C132E1F518 +:1011B0004FDE14C0811116C04BDEC23851F40093CB +:1011C000E9008091EB0085FB882780F91092E90007 +:1011D00001C080E08093F1001092F1008EEF8093C7 +:1011E000E80025C0982F9D7F9130F1F4C230E1F4E2 +:1011F000EF28D1F40F779FEF900F9630A8F49EEF71 +:101200009093E8000093E900833071F089E18093C6 +:10121000EB0081E090E001C0880F0A95EAF7809327 +:10122000EA001092EA0003C081E28093EB00FF9194 +:10123000EF91CF91BF91AF919F918F917F916F91DE +:101240005F914F913F912F911F910F91FF90EF90E0 +:101250000F900FBE0F901F90189592DC36D843DC8C +:10126000FECFCF93DF931F92CDB7DEB76983DC014A +:10127000ED91FC910280F381E02D41E050E0BE0150 +:101280006F5F7F4F09950F90DF91CF910895FC011B +:101290008FB7F89490915B02911102C090E010C05A +:1012A00093E09093E9009091F200911109C0209190 +:1012B000E80022FFF3CF25FDF1CF2BE62093E800D5 +:1012C0008FBF2085318537FD03C09F3F09F09F5FA9 +:1012D000892F90E00895CF93DF93EC01888599855D +:1012E00097FF09C0E881F9810680F781E02DCE01E2 +:1012F00009959987888788859985DF91CF91089589 +:10130000FC012085318537FD07C04FEF5FEF518726 +:101310004087C901992708959FB7F89480915B028F +:10132000882369F083E08093E9002BE68091E80050 +:1013300085FD09C082FF03C02093E800F7CF9FBF5F +:101340008FEF9FEF08958091F1002091E80025FD37 +:1013500003C02BE62093E8009FBF90E00895DF9242 +:10136000EF92FF920F931F93CF93DF938C01EB01CA +:1013700080915B02882371F07FB7F89484E08093BA +:10138000E90080914C02882369F08091E80085FD96 +:1013900007C07FBF81E0F801828320E030E0D1C048 +:1013A00010924C0220E030E064E080E4F82EA1EFDF +:1013B000B0E09AE3E92EE3E0DE2E4115510509F491 +:1013C000BFC08091E400815F9091E80095FD16C058 +:1013D0007FBF9091E400981304C081E080934C0299 +:1013E00005C090915B02911104C081E0F8018283F5 +:1013F000A8C07FB7F8946093E900E6CF8091F2002F +:101400009F2D981BE92FF0E04E175F0708F4942FEB +:10141000E92FF0E04E1B5F0B2E0F3F1FE0E4E91BAE +:10142000E03428F4EE0FFF27E85EF54F099480C002 +:1014300099919C9399919C9399919C9399919C9348 +:1014400099919C9399919C9399919C9399919C9338 +:1014500099919C9399919C9399919C9399919C9328 +:1014600099919C9399919C9399919C9399919C9318 +:1014700099919C9399919C9399919C9399919C9308 +:1014800099919C9399919C9399919C9399919C93F8 +:1014900099919C9399919C9399919C9399919C93E8 +:1014A00099919C9399919C9399919C9399919C93D8 +:1014B00099919C9399919C9399919C9399919C93C8 +:1014C00099919C9399919C9399919C9399919C93B8 +:1014D00099919C9399919C9399919C9399919C93A8 +:1014E00099919C9399919C9399919C9399919C9398 +:1014F00099919C9399919C9399919C9399919C9388 +:1015000099919C9399919C9399919C9399919C9377 +:1015100099919C9399919C9399919C9399919C9367 +:1015200099919C9399919C9399919C9399919C9357 +:101530008091E80085FFE092E800D0924E023DCF16 +:101540007FBFC901DF91CF911F910F91FF90EF9065 +:10155000DF9008952FEF3FEFFC01318720877DDC7E +:101560000FB6F8948091440290914502A0914602F2 +:10157000B09147020FBE9C0180915B02882329F045 +:1015800068EC70E080E090E029CC80915A028823DA +:1015900001F10FB6F8948091440290914502A09118 +:1015A0004602B09147020FBE40915A02442389F08F +:1015B0000FB6F89440914402509145026091460262 +:1015C000709147020FBE481B590B4B3F510560F30A +:1015D00011C00FB6F8948091440290914502A091F9 +:1015E0004602B09147020FBE821B930B853C994087 +:1015F00008F4C2CF08959FB7F89480915B028823C6 +:1016000021F080914E02811102C09FBF089584E0B5 +:101610008093E9008AE38093E80010924E02F5CFB0 +:10162000EACFEFE4F2E08AE0DF011D928A95E9F764 +:1016300088EE93E0A0E0B0E083839483A583B68333 +:1016400085E191E0918380830895EE0FFF1F05905F +:0A165000F491E02D0994F894FFCF07 +:10165A00088000E10000000008415652204953501A +:10166A0000000000003109AF09470980096B091021 +:02167A000B0063 +:00000001FF From ec26684491dc23cbc6ad186e0fe2003874febd36 Mon Sep 17 00:00:00 2001 From: MechMerlin <30334081+mechmerlin@users.noreply.github.com> Date: Fri, 3 Aug 2018 10:00:06 -0700 Subject: [PATCH 02/17] Update templates used for new_project.sh (#3558) --- quantum/template/avr/config.h | 8 ++++++++ quantum/template/avr/rules.mk | 1 + quantum/template/avr/template.h | 14 ++++++++------ 3 files changed, 17 insertions(+), 6 deletions(-) diff --git a/quantum/template/avr/config.h b/quantum/template/avr/config.h index 6715b22cbcd..caa72af0c2f 100644 --- a/quantum/template/avr/config.h +++ b/quantum/template/avr/config.h @@ -52,6 +52,14 @@ along with this program. If not, see . // #define BACKLIGHT_BREATHING // #define BACKLIGHT_LEVELS 3 +// #define RGB_DI_PIN E2 +// #ifdef RGB_DI_PIN +// #define RGBLIGHT_ANIMATIONS +// #define RGBLED_NUM 16 +// #define RGBLIGHT_HUE_STEP 8 +// #define RGBLIGHT_SAT_STEP 8 +// #define RGBLIGHT_VAL_STEP 8 +// #endif /* Debounce reduces chatter (unintended double-presses) - set 0 if debouncing is not needed */ #define DEBOUNCING_DELAY 5 diff --git a/quantum/template/avr/rules.mk b/quantum/template/avr/rules.mk index d567544c724..92f3a03a921 100644 --- a/quantum/template/avr/rules.mk +++ b/quantum/template/avr/rules.mk @@ -61,6 +61,7 @@ SLEEP_LED_ENABLE = no # Breathing sleep LED during USB suspend # if this doesn't work, see here: https://github.com/tmk/tmk_keyboard/wiki/FAQ#nkro-doesnt-work NKRO_ENABLE = no # USB Nkey Rollover BACKLIGHT_ENABLE = no # Enable keyboard backlight functionality on B7 by default +RGBLIGHT_ENABLE = no # Enable keyboard RGB underglow MIDI_ENABLE = no # MIDI support (+2400 to 4200, depending on config) UNICODE_ENABLE = no # Unicode BLUETOOTH_ENABLE = no # Enable Bluetooth with the Adafruit EZ-Key HID diff --git a/quantum/template/avr/template.h b/quantum/template/avr/template.h index c3924ee71f2..031efc95291 100644 --- a/quantum/template/avr/template.h +++ b/quantum/template/avr/template.h @@ -20,15 +20,17 @@ // This a shortcut to help you visually see your layout. // The following is an example using the Planck MIT layout -// The first section contains all of the arguments -// The second converts the arguments into a two-dimensional array +// The first section contains all of the arguments representing the physical +// layout of the board and position of the keys +// The second converts the arguments into a two-dimensional array which +// represents the switch matrix. #define LAYOUT( \ - k00, k01, k02, \ - k10, k11 \ + K00, K01, K02, \ + K10, K11 \ ) \ { \ - { k00, k01, k02 }, \ - { k10, KC_NO, k11 }, \ + { K00, K01, K02 }, \ + { K10, KC_NO, K11 }, \ } #endif From f8a915a2dbed01df73f14fc9baef60f4265d42e9 Mon Sep 17 00:00:00 2001 From: Olivier Poitrey Date: Sat, 4 Aug 2018 08:50:17 -0700 Subject: [PATCH 03/17] Keymap: dz60 macos arrow rev2 (#3561) * dz60/macos_arrow: move the eject key on esc to leave right cmd+bksp for move to trash * dz60/macos_arrow: move the reset key on the media layer This avoids accidental activation. * dz60/macos_arrow: disable LEDs --- keyboards/dz60/keymaps/macos_arrow/keymap.c | 12 ++++++------ keyboards/dz60/keymaps/macos_arrow/readme.md | 4 ++-- keyboards/dz60/keymaps/macos_arrow/rules.mk | 2 ++ 3 files changed, 10 insertions(+), 8 deletions(-) create mode 100644 keyboards/dz60/keymaps/macos_arrow/rules.mk diff --git a/keyboards/dz60/keymaps/macos_arrow/keymap.c b/keyboards/dz60/keymaps/macos_arrow/keymap.c index 5beaf6d8d72..f4b03ddc95c 100644 --- a/keyboards/dz60/keymaps/macos_arrow/keymap.c +++ b/keyboards/dz60/keymaps/macos_arrow/keymap.c @@ -33,7 +33,7 @@ const uint16_t PROGMEM keymaps[][MATRIX_ROWS][MATRIX_COLS] = { /* ,-----------------------------------------------------------------------------------------. * | ` | F1 | F2 | F3 | F4 | F5 | F6 | F7 | F8 | F9 | F10 | F11 | F12 | Del | * |-----------------------------------------------------------------------------------------+ - * | | | | | | | | | UP | | | | | Reset | + * | | | | | | | | | UP | | | | | | * |-----------------------------------------------------------------------------------------+ * | | | | | | | | Left| Down|Right| | | | * |-----------------------------------------------------------------------------------------+ @@ -44,15 +44,15 @@ const uint16_t PROGMEM keymaps[][MATRIX_ROWS][MATRIX_COLS] = { */ [_FL] = LAYOUT( KC_GRV, KC_F1, KC_F2, KC_F3, KC_F4, KC_F5, KC_F6, KC_F7, KC_F8, KC_F9, KC_F10, KC_F11, KC_F12, ______, KC_DEL, - ______, ______, ______, ______, ______, ______, ______, ______, KC_UP, ______, ______, ______, ______, RESET, + ______, ______, ______, ______, ______, ______, ______, ______, KC_UP, ______, ______, ______, ______, ______, ______, ______, ______, ______, ______, ______, ______, KC_LEFT, KC_DOWN, KC_RIGHT, ______, ______, ______, ______, ______, ______, ______, ______, ______, ______, ______, ______, ______, ______, ______, ______, ______, ______, ______, ______, ______, ______, ______, ______, ______, ______, ______, ______), /* ,-----------------------------------------------------------------------------------------. - * | | BR- | BR+ | F3 | F4 | | |PREV |PLAY |NEXT |MUTE | V- | V+ | Eject | + * |Eject| BR- | BR+ | F3 | F4 | | |PREV |PLAY |NEXT |MUTE | V- | V+ | | * |-----------------------------------------------------------------------------------------+ - * | | | | | | | | | | | | | | | + * | | | | | | | | | | | | | | Reset | * |-----------------------------------------------------------------------------------------+ * | | | | | | | | | | | | | | * |-----------------------------------------------------------------------------------------+ @@ -62,8 +62,8 @@ const uint16_t PROGMEM keymaps[][MATRIX_ROWS][MATRIX_COLS] = { * `-----------------------------------------------------------------------------------------' */ [_ML] = LAYOUT( - ______, BR_DOWN, BR_UP, ______, ______, KC_F5, KC_F6, KC_MEDIA_PREV_TRACK, KC_MEDIA_PLAY_PAUSE, KC_MEDIA_NEXT_TRACK, KC_AUDIO_MUTE, KC_AUDIO_VOL_DOWN, KC_AUDIO_VOL_UP, ______, KC_MEDIA_EJECT, - ______, ______, ______, ______, ______, ______, ______, ______, ______, ______, ______, ______, ______, ______, + KC_MEDIA_EJECT, BR_DOWN, BR_UP, ______, ______, KC_F5, KC_F6, KC_MEDIA_PREV_TRACK, KC_MEDIA_PLAY_PAUSE, KC_MEDIA_NEXT_TRACK, KC_AUDIO_MUTE, KC_AUDIO_VOL_DOWN, KC_AUDIO_VOL_UP, ______, ______, + ______, ______, ______, ______, ______, ______, ______, ______, ______, ______, ______, ______, ______, RESET, ______, ______, ______, ______, ______, ______, ______, ______, ______, ______, ______, ______, ______, ______, ______, ______, ______, ______, ______, ______, ______, ______, ______, ______, ______, ______, ______, ______, ______, ______, ______, ______, ______, ______, ______, ______, ______, ______), diff --git a/keyboards/dz60/keymaps/macos_arrow/readme.md b/keyboards/dz60/keymaps/macos_arrow/readme.md index bd8740bd415..bba8148ba5c 100644 --- a/keyboards/dz60/keymaps/macos_arrow/readme.md +++ b/keyboards/dz60/keymaps/macos_arrow/readme.md @@ -37,7 +37,7 @@ My build used the following components: ,-----------------------------------------------------------------------------------------. | ` | F1 | F2 | F3 | F4 | F5 | F6 | F7 | F8 | F9 | F10 | F11 | F12 | Del | |-----------------------------------------------------------------------------------------+ -| | | | | | | | | UP | | | | | Reset | +| | | | | | | | | UP | | | | | | |-----------------------------------------------------------------------------------------+ | | | | | | | | Left| Down|Right| | | | |-----------------------------------------------------------------------------------------+ @@ -55,7 +55,7 @@ The function layer is activated by the `Caps-Lock` (`Hyper`) key to access `F` k ,-----------------------------------------------------------------------------------------. | | BR- | BR+ | F3 | F4 | | |PREV |PLAY |NEXT |MUTE | V- | V+ | Eject | |-----------------------------------------------------------------------------------------+ -| | | | | | | | | | | | | | | +| | | | | | | | | | | | | | Reset | |-----------------------------------------------------------------------------------------+ | | | | | | | | | | | | | | |-----------------------------------------------------------------------------------------+ diff --git a/keyboards/dz60/keymaps/macos_arrow/rules.mk b/keyboards/dz60/keymaps/macos_arrow/rules.mk new file mode 100644 index 00000000000..e1cfb3e508c --- /dev/null +++ b/keyboards/dz60/keymaps/macos_arrow/rules.mk @@ -0,0 +1,2 @@ +BACKLIGHT_ENABLE = no +RGBLIGHT_ENABLE = no \ No newline at end of file From 3e8f2728732b20b5b6af63db73ad8b6f2be18823 Mon Sep 17 00:00:00 2001 From: Xyverz Date: Sat, 4 Aug 2018 09:01:26 -0700 Subject: [PATCH 04/17] Keyboard: LED fixes for Kinesis Stapelberg controller, and keymap changes (#3564) * Rules for vitamins_included Added a section to disable RGB underglow for the Let's Split Vitamins Included board. * fixing ortho_4x12 configs * Using upstream/master version instead * Additions and Corrections Corrected the Kinesis/Stapelberg's .c file to allow LEDs to work Removed excess cruft from my Kinesis keymap to reflect this change Other minor tweaks and adjustments to my ortho_4x12 and 5x12 layouts * Updated readme --- keyboards/kinesis/keymaps/xyverz/keymap.c | 52 ------------- keyboards/kinesis/keymaps/xyverz/readme.md | 4 +- keyboards/kinesis/stapelberg/stapelberg.c | 80 ++++++-------------- layouts/community/ortho_4x12/xyverz/config.h | 5 +- layouts/community/ortho_5x12/xyverz/keymap.c | 10 +++ layouts/community/ortho_5x12/xyverz/rules.mk | 12 ++- 6 files changed, 49 insertions(+), 114 deletions(-) diff --git a/keyboards/kinesis/keymaps/xyverz/keymap.c b/keyboards/kinesis/keymaps/xyverz/keymap.c index 533047b1568..1025df07699 100644 --- a/keyboards/kinesis/keymaps/xyverz/keymap.c +++ b/keyboards/kinesis/keymaps/xyverz/keymap.c @@ -299,58 +299,6 @@ bool process_record_user(uint16_t keycode, keyrecord_t *record) { return true; }; -// getting the LEDs working... -void led_set_user(uint8_t usb_led) { - - DDRF |= (1<<0); // Keypad LED - if (usb_led & (1< Date: Sun, 5 Aug 2018 02:09:22 +1000 Subject: [PATCH 05/17] More improvements to keycode docs (#3567) * Reorder keycode list docs according to HID usage * Add missing keycodes/descriptions/aliases --- docs/keycodes.md | 275 ++++++++++++++-------------- docs/keycodes_basic.md | 297 +++++++++++++++++-------------- docs/keycodes_us_ansi_shifted.md | 46 ++--- 3 files changed, 327 insertions(+), 291 deletions(-) diff --git a/docs/keycodes.md b/docs/keycodes.md index 778f6038f32..dbafecb8294 100644 --- a/docs/keycodes.md +++ b/docs/keycodes.md @@ -8,40 +8,8 @@ This is a reference only. Each group of keys links to the page documenting their |Key |Aliases |Description | |-----------------------|--------------------|-----------------------------------------------| -|`KC_1` | |`1` and `!` | -|`KC_2` | |`2` and `@` | -|`KC_3` | |`3` and `#` | -|`KC_4` | |`4` and `$` | -|`KC_5` | |`5` and `%` | -|`KC_6` | |`6` and `^` | -|`KC_7` | |`7` and `&` | -|`KC_8` | |`8` and `*` | -|`KC_9` | |`9` and `(` | -|`KC_0` | |`0` and `)` | -|`KC_F1` | | | -|`KC_F2` | | | -|`KC_F3` | | | -|`KC_F4` | | | -|`KC_F5` | | | -|`KC_F6` | | | -|`KC_F7` | | | -|`KC_F8` | | | -|`KC_F9` | | | -|`KC_F10` | | | -|`KC_F11` | | | -|`KC_F12` | | | -|`KC_F13` | | | -|`KC_F14` | | | -|`KC_F15` | | | -|`KC_F16` | | | -|`KC_F17` | | | -|`KC_F18` | | | -|`KC_F19` | | | -|`KC_F20` | | | -|`KC_F21` | | | -|`KC_F22` | | | -|`KC_F23` | | | -|`KC_F24` | | | +|`KC_NO` |`XXXXXXX` |Ignore this key (NOOP) | +|`KC_TRANSPARENT` |`KC_TRNS`, `_______`|Use the next lowest non-transparent key | |`KC_A` | |`a` and `A` | |`KC_B` | |`b` and `B` | |`KC_C` | |`c` and `C` | @@ -68,6 +36,16 @@ This is a reference only. Each group of keys links to the page documenting their |`KC_X` | |`x` and `X` | |`KC_Y` | |`y` and `Y` | |`KC_Z` | |`z` and `Z` | +|`KC_1` | |`1` and `!` | +|`KC_2` | |`2` and `@` | +|`KC_3` | |`3` and `#` | +|`KC_4` | |`4` and `$` | +|`KC_5` | |`5` and `%` | +|`KC_6` | |`6` and `^` | +|`KC_7` | |`7` and `&` | +|`KC_8` | |`8` and `*` | +|`KC_9` | |`9` and `(` | +|`KC_0` | |`0` and `)` | |`KC_ENTER` |`KC_ENT` |Return (Enter) | |`KC_ESCAPE` |`KC_ESC` |Escape | |`KC_BSPACE` |`KC_BSPC` |Delete (Backspace) | @@ -79,33 +57,28 @@ This is a reference only. Each group of keys links to the page documenting their |`KC_RBRACKET` |`KC_RBRC` |`]` and `}` | |`KC_BSLASH` |`KC_BSLS` |`\` and | | |`KC_NONUS_HASH` |`KC_NUHS` |Non-US `#` and `~` | -|`KC_NONUS_BSLASH` |`KC_NUBS` |Non-US `\` and | | -|`KC_INT1` |`KC_RO` |JIS `\` and | | -|`KC_INT2` |`KC_KANA` |JIS Katakana/Hiragana | -|`KC_INT3` |`KC_JYEN` |JIS `¥` | |`KC_SCOLON` |`KC_SCLN` |`;` and `:` | |`KC_QUOTE` |`KC_QUOT` |`'` and `"` | -|`KC_GRAVE` |`KC_GRV` |` and `~` | +|`KC_GRAVE` |`KC_GRV`, `KC_ZKHK` |` and `~`, JIS Zenkaku/Hankaku| |`KC_COMMA` |`KC_COMM` |`,` and `<` | |`KC_DOT` | |`.` and `>` | |`KC_SLASH` |`KC_SLSH` |`/` and `?` | -|`KC_CAPSLOCK` |`KC_CAPS` |Caps Lock | -|`KC_LCTRL` |`KC_LCTL` |Left Control | -|`KC_LSHIFT` |`KC_LSFT` |Left Shift | -|`KC_LALT` | |Left Alt | -|`KC_LGUI` |`KC_LCMD`, `KC_LWIN`|Left GUI (Windows/Command/Meta key) | -|`KC_RCTRL` |`KC_RCTL` |Right Control | -|`KC_RSHIFT` |`KC_RSFT` |Right Shift | -|`KC_RALT` | |Right Alt | -|`KC_RGUI` |`KC_RCMD`, `KC_RWIN`|Right GUI (Windows/Command/Meta key) | -|`KC_LOCKING_CAPS` |`KC_LCAP` |Locking Caps Lock | -|`KC_LOCKING_NUM` |`KC_LNUM` |Locking Num Lock | -|`KC_LOCKING_SCROLL` |`KC_LSCR` |Locking Scroll Lock | -|`KC_INT4` |`KC_HENK` |JIS Henkan | -|`KC_INT5` |`KC_MHEN` |JIS Muhenkan | +|`KC_CAPSLOCK` |`KC_CLCK`, `KC_CAPS`|Caps Lock | +|`KC_F1` | |F1 | +|`KC_F2` | |F2 | +|`KC_F3` | |F3 | +|`KC_F4` | |F4 | +|`KC_F5` | |F5 | +|`KC_F6` | |F6 | +|`KC_F7` | |F7 | +|`KC_F8` | |F8 | +|`KC_F9` | |F9 | +|`KC_F10` | |F10 | +|`KC_F11` | |F11 | +|`KC_F12` | |F12 | |`KC_PSCREEN` |`KC_PSCR` |Print Screen | |`KC_SCROLLLOCK` |`KC_SLCK` |Scroll Lock | -|`KC_PAUSE` |`KC_PAUS` |Pause | +|`KC_PAUSE` |`KC_PAUS`, `KC_BRK` |Pause | |`KC_INSERT` |`KC_INS` |Insert | |`KC_HOME` | |Home | |`KC_PGUP` | |Page Up | @@ -116,58 +89,6 @@ This is a reference only. Each group of keys links to the page documenting their |`KC_LEFT` | |Left Arrow | |`KC_DOWN` | |Down Arrow | |`KC_UP` | |Up Arrow | -|`KC_APPLICATION` |`KC_APP` |Application (Windows Menu Key) | -|`KC_POWER` | |Deprecated by MS in favor of `KC_SYSTEM_POWER`.| -|`KC_EXECUTE` | |Execute | -|`KC_HELP` | |Help | -|`KC_MENU` | |Menu | -|`KC_SELECT` | |Select | -|`KC_AGAIN` | |Again | -|`KC_UNDO` | |Undo | -|`KC_CUT` | |Cut | -|`KC_COPY` | |Copy | -|`KC_PASTE` | |Paste | -|`KC_FIND` | |Find | -|`KC_ALT_ERASE` | |Alternate Erase | -|`KC_SYSREQ` | |SysReq/Attention | -|`KC_CANCEL` | |Cancel | -|`KC_CLEAR` | |Clear | -|`KC_PRIOR` | |Prior | -|`KC_RETURN` | |Return | -|`KC_SEPARATOR` | |Separator | -|`KC_OUT` | |Out | -|`KC_OPER` | |Oper | -|`KC_CLEAR_AGAIN` | |Clear/Again | -|`KC_CRSEL` | |CrSel/Props | -|`KC_EXSEL` | |ExSel | -|`KC_SYSTEM_POWER` |`KC_PWR` |System Power Down. Recommended over `KC_POWER`.| -|`KC_SYSTEM_SLEEP` |`KC_SLEP` |System Sleep | -|`KC_SYSTEM_WAKE` |`KC_WAKE` |System Wake | -|`KC_MAIL` |`KC_MAIL` | | -|`KC_CALCULATOR` |`KC_CALC` | | -|`KC_MY_COMPUTER` |`KC_MYCM` | | -|`KC_WWW_SEARCH` |`KC_WSCH` | | -|`KC_WWW_HOME` |`KC_WHOM` | | -|`KC_WWW_BACK` |`KC_WBAK` | | -|`KC_WWW_FORWARD` |`KC_WFWD` | | -|`KC_WWW_STOP` |`KC_WSTP` | | -|`KC_WWW_REFRESH` |`KC_WREF` | | -|`KC_WWW_FAVORITES` |`KC_WFAV` | | -|`KC_STOP` | |Stop | -|`KC__MUTE` | |Mute (macOS) | -|`KC__VOLUP` | |Volume Up (macOS) | -|`KC__VOLDOWN` | |Volume Down (macOS) | -|`KC_AUDIO_MUTE` |`KC_MUTE` |Mute (Windows/macOS/Linux) | -|`KC_AUDIO_VOL_UP` |`KC_VOLU` |Volume Up (Windows/macOS/Linux) | -|`KC_AUDIO_VOL_DOWN` |`KC_VOLD` |Volume Down (Windows/macOS/Linux) | -|`KC_MEDIA_NEXT_TRACK` |`KC_MNXT` |Next Track (Windows) | -|`KC_MEDIA_PREV_TRACK` |`KC_MPRV` |Previous Track (Windows) | -|`KC_MEDIA_FAST_FORWARD`|`KC_MFFD` |Next Track (macOS) | -|`KC_MEDIA_REWIND` |`KC_MRWD` |Previous Track (macOS) | -|`KC_MEDIA_STOP` |`KC_MSTP` |Stop Track | -|`KC_MEDIA_PLAY_PAUSE` |`KC_MPLY` |Play/Pause Track | -|`KC_MEDIA_SELECT` |`KC_MSEL` | | -|`KC_MEDIA_EJECT` |`KC_EJCT` |Eject (macOS) | |`KC_NUMLOCK` |`KC_NLCK` |Keypad Num Lock and Clear | |`KC_KP_SLASH` |`KC_PSLS` |Keypad `/` | |`KC_KP_ASTERISK` |`KC_PAST` |Keypad `*` | @@ -185,11 +106,103 @@ This is a reference only. Each group of keys links to the page documenting their |`KC_KP_9` |`KC_P9` |Keypad `9` and Page Up | |`KC_KP_0` |`KC_P0` |Keypad `0` and Insert | |`KC_KP_DOT` |`KC_PDOT` |Keypad `.` and Delete | +|`KC_NONUS_BSLASH` |`KC_NUBS` |Non-US `\` and | | +|`KC_APPLICATION` |`KC_APP` |Application (Windows Menu Key) | +|`KC_POWER` | |System Power (macOS) | |`KC_KP_EQUAL` |`KC_PEQL` |Keypad `=` | +|`KC_F13` | |F13 | +|`KC_F14` | |F14 | +|`KC_F15` | |F15 | +|`KC_F16` | |F16 | +|`KC_F17` | |F17 | +|`KC_F18` | |F18 | +|`KC_F19` | |F19 | +|`KC_F20` | |F20 | +|`KC_F21` | |F21 | +|`KC_F22` | |F22 | +|`KC_F23` | |F23 | +|`KC_F24` | |F24 | +|`KC_EXECUTE` |`KC_EXEC` |Execute | +|`KC_HELP` | |Help | +|`KC_MENU` | |Menu | +|`KC_SELECT` |`KC_SLCT` |Select | +|`KC_STOP` | |Stop | +|`KC_AGAIN` |`KC_AGIN` |Again | +|`KC_UNDO` | |Undo | +|`KC_CUT` | |Cut | +|`KC_COPY` | |Copy | +|`KC_PASTE` |`KC_PSTE` |Paste | +|`KC_FIND` | |Find | +|`KC__MUTE` | |Mute (macOS) | +|`KC__VOLUP` | |Volume Up (macOS) | +|`KC__VOLDOWN` | |Volume Down (macOS) | +|`KC_LOCKING_CAPS` |`KC_LCAP` |Locking Caps Lock | +|`KC_LOCKING_NUM` |`KC_LNUM` |Locking Num Lock | +|`KC_LOCKING_SCROLL` |`KC_LSCR` |Locking Scroll Lock | |`KC_KP_COMMA` |`KC_PCMM` |Keypad `,` | |`KC_KP_EQUAL_AS400` | |Keypad `=` on AS/400 keyboards | -|`KC_NO` | |Ignore this key (NOOP) | -|`KC_TRANSPARENT` |`KC_TRNS` |Use the next lowest non-transparent key | +|`KC_INT1` |`KC_RO` |JIS `\` and | | +|`KC_INT2` |`KC_KANA` |JIS Katakana/Hiragana | +|`KC_INT3` |`KC_JYEN` |JIS `¥` | +|`KC_INT4` |`KC_HENK` |JIS Henkan | +|`KC_INT5` |`KC_MHEN` |JIS Muhenkan | +|`KC_INT6` | |JIS Numpad `,` | +|`KC_INT7` | |International 7 | +|`KC_INT8` | |International 8 | +|`KC_INT9` | |International 9 | +|`KC_LANG1` |`KC_HAEN` |Hangul/English | +|`KC_LANG2` |`KC_HANJ` |Hanja | +|`KC_LANG3` | |JIS Katakana | +|`KC_LANG4` | |JIS Hiragana | +|`KC_LANG5` | |JIS Zenkaku/Hankaku | +|`KC_LANG6` | |Language 6 | +|`KC_LANG7` | |Language 7 | +|`KC_LANG8` | |Language 8 | +|`KC_LANG9` | |Language 9 | +|`KC_ALT_ERASE` |`KC_ERAS` |Alternate Erase | +|`KC_SYSREQ` | |SysReq/Attention | +|`KC_CANCEL` | |Cancel | +|`KC_CLEAR` |`KC_CLR` |Clear | +|`KC_PRIOR` | |Prior | +|`KC_RETURN` | |Return | +|`KC_SEPARATOR` | |Separator | +|`KC_OUT` | |Out | +|`KC_OPER` | |Oper | +|`KC_CLEAR_AGAIN` | |Clear/Again | +|`KC_CRSEL` | |CrSel/Props | +|`KC_EXSEL` | |ExSel | +|`KC_LCTRL` |`KC_LCTL` |Left Control | +|`KC_LSHIFT` |`KC_LSFT` |Left Shift | +|`KC_LALT` | |Left Alt | +|`KC_LGUI` |`KC_LCMD`, `KC_LWIN`|Left GUI (Windows/Command/Meta key) | +|`KC_RCTRL` |`KC_RCTL` |Right Control | +|`KC_RSHIFT` |`KC_RSFT` |Right Shift | +|`KC_RALT` | |Right Alt | +|`KC_RGUI` |`KC_RCMD`, `KC_RWIN`|Right GUI (Windows/Command/Meta key) | +|`KC_SYSTEM_POWER` |`KC_PWR` |System Power Down | +|`KC_SYSTEM_SLEEP` |`KC_SLEP` |System Sleep | +|`KC_SYSTEM_WAKE` |`KC_WAKE` |System Wake | +|`KC_AUDIO_MUTE` |`KC_MUTE` |Mute | +|`KC_AUDIO_VOL_UP` |`KC_VOLU` |Volume Up | +|`KC_AUDIO_VOL_DOWN` |`KC_VOLD` |Volume Down | +|`KC_MEDIA_NEXT_TRACK` |`KC_MNXT` |Next Track (Windows) | +|`KC_MEDIA_PREV_TRACK` |`KC_MPRV` |Previous Track (Windows) | +|`KC_MEDIA_STOP` |`KC_MSTP` |Stop Track (Windows) | +|`KC_MEDIA_PLAY_PAUSE` |`KC_MPLY` |Play/Pause Track | +|`KC_MEDIA_SELECT` |`KC_MSEL` |Launch Media Player (Windows) | +|`KC_MEDIA_EJECT` |`KC_EJCT` |Eject (macOS) | +|`KC_MAIL` | |Launch Mail (Windows) | +|`KC_CALCULATOR` |`KC_CALC` |Launch Calculator (Windows) | +|`KC_MY_COMPUTER` |`KC_MYCM` |Launch My Computer (Windows) | +|`KC_WWW_SEARCH` |`KC_WSCH` |Browser Search (Windows) | +|`KC_WWW_HOME` |`KC_WHOM` |Browser Home (Windows) | +|`KC_WWW_BACK` |`KC_WBAK` |Browser Back (Windows) | +|`KC_WWW_FORWARD` |`KC_WFWD` |Browser Forward (Windows) | +|`KC_WWW_STOP` |`KC_WSTP` |Browser Stop (Windows) | +|`KC_WWW_REFRESH` |`KC_WREF` |Browser Refresh (Windows) | +|`KC_WWW_FAVORITES` |`KC_WFAV` |Browser Favorites (Windows) | +|`KC_MEDIA_FAST_FORWARD`|`KC_MFFD` |Next Track (macOS) | +|`KC_MEDIA_REWIND` |`KC_MRWD` |Previous Track (macOS) | ## [Quantum Keycodes](quantum_keycodes.md#qmk-keycodes) @@ -391,29 +404,29 @@ This is a reference only. Each group of keys links to the page documenting their ## [US ANSI Shifted Keys](keycodes_us_ansi_shifted.md) -|Key |Aliases |Description | -|------------------------|------------------|-------------------| -|`KC_TILDE` |`KC_TILD` |`~` | -|`KC_EXCLAIM` |`KC_EXLM` |`!` | -|`KC_AT` | |`@` | -|`KC_HASH` | |`#` | -|`KC_DOLLAR` |`KC_DLR` |`$` | -|`KC_PERCENT` |`KC_PERC` |`%` | -|`KC_CIRCUMFLEX` |`KC_CIRC` |`^` | -|`KC_AMPERSAND` |`KC_AMPR` |`&` | -|`KC_ASTERISK` |`KC_ASTR` |`*` | -|`KC_LEFT_PAREN` |`KC_LPRN` |`(` | -|`KC_RIGHT_PAREN` |`KC_RPRN` |`)` | -|`KC_UNDERSCORE` |`KC_UNDS` |`_` | -|`KC_PLUS` | |`+` | -|`KC_LEFT_CURLY_BRACE` |`KC_LCBR` |`{` | -|`KC_RIGHT_CURLY_BRACE` |`KC_RCBR` |`}` | -|`KC_PIPE` | ||| -|`KC_COLON` |`KC_COLN` |`:` | -|`KC_DOUBLE_QUOTE` |`KC_DQT`/`KC_DQUO`|`"` | -|`KC_LEFT_ANGLE_BRACKET` |`KC_LT`/`KC_LABK` |`<` | -|`KC_RIGHT_ANGLE_BRACKET`|`KC_GT`/`KC_RABK` |`>` | -|`KC_QUESTION` |`KC_QUES` |`?` | +|Key |Aliases |Description | +|------------------------|-------------------|-------------------| +|`KC_TILDE` |`KC_TILD` |`~` | +|`KC_EXCLAIM` |`KC_EXLM` |`!` | +|`KC_AT` | |`@` | +|`KC_HASH` | |`#` | +|`KC_DOLLAR` |`KC_DLR` |`$` | +|`KC_PERCENT` |`KC_PERC` |`%` | +|`KC_CIRCUMFLEX` |`KC_CIRC` |`^` | +|`KC_AMPERSAND` |`KC_AMPR` |`&` | +|`KC_ASTERISK` |`KC_ASTR` |`*` | +|`KC_LEFT_PAREN` |`KC_LPRN` |`(` | +|`KC_RIGHT_PAREN` |`KC_RPRN` |`)` | +|`KC_UNDERSCORE` |`KC_UNDS` |`_` | +|`KC_PLUS` | |`+` | +|`KC_LEFT_CURLY_BRACE` |`KC_LCBR` |`{` | +|`KC_RIGHT_CURLY_BRACE` |`KC_RCBR` |`}` | +|`KC_PIPE` | ||| +|`KC_COLON` |`KC_COLN` |`:` | +|`KC_DOUBLE_QUOTE` |`KC_DQUO`, `KC_DQT`|`"` | +|`KC_LEFT_ANGLE_BRACKET` |`KC_LABK`, `KC_LT` |`<` | +|`KC_RIGHT_ANGLE_BRACKET`|`KC_RABK`, `KC_GT` |`>` | +|`KC_QUESTION` |`KC_QUES` |`?` | ## [Switching and Toggling Layers](feature_advanced_keycodes.md#switching-and-toggling-layers) diff --git a/docs/keycodes_basic.md b/docs/keycodes_basic.md index c6ca4ad992e..8445b05ef34 100644 --- a/docs/keycodes_basic.md +++ b/docs/keycodes_basic.md @@ -47,117 +47,145 @@ The basic set of keycodes are based on the [HID Keyboard/Keypad Usage Page (0x07 |Key |Description| |--------|-----------| -|`KC_F1` | | -|`KC_F2` | | -|`KC_F3` | | -|`KC_F4` | | -|`KC_F5` | | -|`KC_F6` | | -|`KC_F7` | | -|`KC_F8` | | -|`KC_F9` | | -|`KC_F10`| | -|`KC_F11`| | -|`KC_F12`| | -|`KC_F13`| | -|`KC_F14`| | -|`KC_F15`| | -|`KC_F16`| | -|`KC_F17`| | -|`KC_F18`| | -|`KC_F19`| | -|`KC_F20`| | -|`KC_F21`| | -|`KC_F22`| | -|`KC_F23`| | -|`KC_F24`| | +|`KC_F1` |F1 | +|`KC_F2` |F2 | +|`KC_F3` |F3 | +|`KC_F4` |F4 | +|`KC_F5` |F5 | +|`KC_F6` |F6 | +|`KC_F7` |F7 | +|`KC_F8` |F8 | +|`KC_F9` |F9 | +|`KC_F10`|F10 | +|`KC_F11`|F11 | +|`KC_F12`|F12 | +|`KC_F13`|F13 | +|`KC_F14`|F14 | +|`KC_F15`|F15 | +|`KC_F16`|F16 | +|`KC_F17`|F17 | +|`KC_F18`|F18 | +|`KC_F19`|F19 | +|`KC_F20`|F20 | +|`KC_F21`|F21 | +|`KC_F22`|F22 | +|`KC_F23`|F23 | +|`KC_F24`|F24 | ## Punctuation -|Key |Aliases |Description | -|-----------------|---------|----------------------------------| -|`KC_ENTER` |`KC_ENT` |Return (Enter) | -|`KC_ESCAPE` |`KC_ESC` |Escape | -|`KC_BSPACE` |`KC_BSPC`|Delete (Backspace) | -|`KC_TAB` | |Tab | -|`KC_SPACE` |`KC_SPC` |Spacebar | -|`KC_MINUS` |`KC_MINS`|`-` and `_` | -|`KC_EQUAL` |`KC_EQL` |`=` and `+` | -|`KC_LBRACKET` |`KC_LBRC`|`[` and `{` | -|`KC_RBRACKET` |`KC_RBRC`|`]` and `}` | -|`KC_BSLASH` |`KC_BSLS`|`\` and | | -|`KC_NONUS_HASH` |`KC_NUHS`|Non-US `#` and `~` | -|`KC_NONUS_BSLASH`|`KC_NUBS`|Non-US `\` and || -|`KC_INT1` |`KC_RO` |JIS `\` and | | -|`KC_INT2` |`KC_KANA`|JIS Katakana/Hiragana | -|`KC_INT3` |`KC_JYEN`|JIS `¥` | -|`KC_SCOLON` |`KC_SCLN`|`;` and `:` | -|`KC_QUOTE` |`KC_QUOT`|`'` and `"` | -|`KC_GRAVE` |`KC_GRV` |` and `~` | -|`KC_COMMA` |`KC_COMM`|`,` and `<` | -|`KC_DOT` | |`.` and `>` | -|`KC_SLASH` |`KC_SLSH`|`/` and `?` | -|`KC_CAPSLOCK` |`KC_CAPS`|Caps Lock | +|Key |Aliases |Description | +|-----------------|-------------------|-----------------------------------------------| +|`KC_ENTER` |`KC_ENT` |Return (Enter) | +|`KC_ESCAPE` |`KC_ESC` |Escape | +|`KC_BSPACE` |`KC_BSPC` |Delete (Backspace) | +|`KC_TAB` | |Tab | +|`KC_SPACE` |`KC_SPC` |Spacebar | +|`KC_MINUS` |`KC_MINS` |`-` and `_` | +|`KC_EQUAL` |`KC_EQL` |`=` and `+` | +|`KC_LBRACKET` |`KC_LBRC` |`[` and `{` | +|`KC_RBRACKET` |`KC_RBRC` |`]` and `}` | +|`KC_BSLASH` |`KC_BSLS` |`\` and | | +|`KC_NONUS_HASH` |`KC_NUHS` |Non-US `#` and `~` | +|`KC_SCOLON` |`KC_SCLN` |`;` and `:` | +|`KC_QUOTE` |`KC_QUOT` |`'` and `"` | +|`KC_GRAVE` |`KC_GRV`, `KC_ZKHK`|` and `~`, JIS Zenkaku/Hankaku| +|`KC_COMMA` |`KC_COMM` |`,` and `<` | +|`KC_DOT` | |`.` and `>` | +|`KC_SLASH` |`KC_SLSH` |`/` and `?` | +|`KC_NONUS_BSLASH`|`KC_NUBS` |Non-US `\` and | | + +## Lock Keys + +|Key |Aliases |Description | +|-------------------|--------------------|-------------------------| +|`KC_CAPSLOCK` |`KC_CLCK`, `KC_CAPS`|Caps Lock | +|`KC_SCROLLLOCK` |`KC_SLCK` |Scroll Lock | +|`KC_NUMLOCK` |`KC_NLCK` |Keypad Num Lock and Clear| +|`KC_LOCKING_CAPS` |`KC_LCAP` |Locking Caps Lock | +|`KC_LOCKING_NUM` |`KC_LNUM` |Locking Num Lock | +|`KC_LOCKING_SCROLL`|`KC_LSCR` |Locking Scroll Lock | ## Modifiers -|Key |Aliases |Description | -|-------------------|--------------------|------------------------------------| -|`KC_LCTRL` |`KC_LCTL` |Left Control | -|`KC_LSHIFT` |`KC_LSFT` |Left Shift | -|`KC_LALT` | |Left Alt | -|`KC_LGUI` |`KC_LCMD`, `KC_LWIN`|Left GUI (Windows/Command/Meta key) | -|`KC_RCTRL` |`KC_RCTL` |Right Control | -|`KC_RSHIFT` |`KC_RSFT` |Right Shift | -|`KC_RALT` | |Right Alt | -|`KC_RGUI` |`KC_RCMD`, `KC_RWIN`|Right GUI (Windows/Command/Meta key)| -|`KC_LOCKING_CAPS` |`KC_LCAP` |Locking Caps Lock | -|`KC_LOCKING_NUM` |`KC_LNUM` |Locking Num Lock | -|`KC_LOCKING_SCROLL`|`KC_LSCR` |Locking Scroll Lock | -|`KC_INT4` |`KC_HENK` |JIS Henkan | -|`KC_INT5` |`KC_MHEN` |JIS Muhenkan | +|Key |Aliases |Description | +|-----------|--------------------|------------------------------------| +|`KC_LCTRL` |`KC_LCTL` |Left Control | +|`KC_LSHIFT`|`KC_LSFT` |Left Shift | +|`KC_LALT` | |Left Alt | +|`KC_LGUI` |`KC_LCMD`, `KC_LWIN`|Left GUI (Windows/Command/Meta key) | +|`KC_RCTRL` |`KC_RCTL` |Right Control | +|`KC_RSHIFT`|`KC_RSFT` |Right Shift | +|`KC_RALT` | |Right Alt | +|`KC_RGUI` |`KC_RCMD`, `KC_RWIN`|Right GUI (Windows/Command/Meta key)| + +## International + +|Key |Aliases |Description | +|----------|---------|-------------------------------| +|`KC_INT1` |`KC_RO` |JIS `\` and || +|`KC_INT2` |`KC_KANA`|JIS Katakana/Hiragana | +|`KC_INT3` |`KC_JYEN`|JIS `¥` | +|`KC_INT4` |`KC_HENK`|JIS Henkan | +|`KC_INT5` |`KC_MHEN`|JIS Muhenkan | +|`KC_INT6` | |JIS Numpad `,` | +|`KC_INT7` | |International 7 | +|`KC_INT8` | |International 8 | +|`KC_INT9` | |International 9 | +|`KC_LANG1`|`KC_HAEN`|Hangul/English | +|`KC_LANG2`|`KC_HANJ`|Hanja | +|`KC_LANG3`| |JIS Katakana | +|`KC_LANG4`| |JIS Hiragana | +|`KC_LANG5`| |JIS Zenkaku/Hankaku | +|`KC_LANG6`| |Language 6 | +|`KC_LANG7`| |Language 7 | +|`KC_LANG8`| |Language 8 | +|`KC_LANG9`| |Language 9 | ## Commands -|Key |Aliases |Description | -|------------------|---------|------------------------------| -|`KC_PSCREEN` |`KC_PSCR`|Print Screen | -|`KC_SCROLLLOCK` |`KC_SLCK`|Scroll Lock | -|`KC_PAUSE` |`KC_PAUS`|Pause | -|`KC_INSERT` |`KC_INS` |Insert | -|`KC_HOME` | |Home | -|`KC_PGUP` | |Page Up | -|`KC_DELETE` |`KC_DEL` |Forward Delete | -|`KC_END` | |End | -|`KC_PGDOWN` |`KC_PGDN`|Page Down | -|`KC_RIGHT` |`KC_RGHT`|Right Arrow | -|`KC_LEFT` | |Left Arrow | -|`KC_DOWN` | |Down Arrow | -|`KC_UP` | |Up Arrow | -|`KC_APPLICATION` |`KC_APP` |Application (Windows Menu Key)| -|`KC_POWER` | |Power | -|`KC_EXECUTE` | |Execute | -|`KC_HELP` | |Help | -|`KC_MENU` | |Menu | -|`KC_SELECT` | |Select | -|`KC_AGAIN` | |Again | -|`KC_UNDO` | |Undo | -|`KC_CUT` | |Cut | -|`KC_COPY` | |Copy | -|`KC_PASTE` | |Paste | -|`KC_FIND` | |Find | -|`KC_ALT_ERASE` | |Alternate Erase | -|`KC_SYSREQ` | |SysReq/Attention | -|`KC_CANCEL` | |Cancel | -|`KC_CLEAR` | |Clear | -|`KC_PRIOR` | |Prior | -|`KC_RETURN` | |Return | -|`KC_SEPARATOR` | |Separator | -|`KC_OUT` | |Out | -|`KC_OPER` | |Oper | -|`KC_CLEAR_AGAIN` | |Clear/Again | -|`KC_CRSEL` | |CrSel/Props | -|`KC_EXSEL` | |ExSel | +|Key |Aliases |Description | +|------------------|-------------------|------------------------------| +|`KC_PSCREEN` |`KC_PSCR` |Print Screen | +|`KC_PAUSE` |`KC_PAUS`, `KC_BRK`|Pause | +|`KC_INSERT` |`KC_INS` |Insert | +|`KC_HOME` | |Home | +|`KC_PGUP` | |Page Up | +|`KC_DELETE` |`KC_DEL` |Forward Delete | +|`KC_END` | |End | +|`KC_PGDOWN` |`KC_PGDN` |Page Down | +|`KC_RIGHT` |`KC_RGHT` |Right Arrow | +|`KC_LEFT` | |Left Arrow | +|`KC_DOWN` | |Down Arrow | +|`KC_UP` | |Up Arrow | +|`KC_APPLICATION` |`KC_APP` |Application (Windows Menu Key)| +|`KC_POWER` | |System Power (macOS/Linux) | +|`KC_EXECUTE` |`KC_EXEC` |Execute | +|`KC_HELP` | |Help | +|`KC_MENU` | |Menu | +|`KC_SELECT` |`KC_SLCT` |Select | +|`KC_STOP` | |Stop | +|`KC_AGAIN` |`KC_AGIN` |Again | +|`KC_UNDO` | |Undo | +|`KC_CUT` | |Cut | +|`KC_COPY` | |Copy | +|`KC_PASTE` |`KC_PSTE` |Paste | +|`KC_FIND` | |Find | +|`KC__MUTE` | |Mute (macOS) | +|`KC__VOLUP` | |Volume Up (macOS) | +|`KC__VOLDOWN` | |Volume Down (macOS) | +|`KC_ALT_ERASE` |`KC_ERAS` |Alternate Erase | +|`KC_SYSREQ` | |SysReq/Attention | +|`KC_CANCEL` | |Cancel | +|`KC_CLEAR` |`KC_CLR` |Clear | +|`KC_PRIOR` | |Prior | +|`KC_RETURN` | |Return | +|`KC_SEPARATOR` | |Separator | +|`KC_OUT` | |Out | +|`KC_OPER` | |Oper | +|`KC_CLEAR_AGAIN` | |Clear/Again | +|`KC_CRSEL` | |CrSel/Props | +|`KC_EXSEL` | |ExSel | ## Media Keys @@ -165,42 +193,37 @@ These keycodes are not part of the Keyboard/Keypad usage page. The `SYSTEM_` key Windows and macOS use different keycodes for "next track" and "previous track". Make sure you choose the keycode that corresponds to your OS. -|Key |Aliases |Description | -|-----------------------|---------|---------------------------------| -|`KC_SYSTEM_POWER` |`KC_PWR` |System Power Down | -|`KC_SYSTEM_SLEEP` |`KC_SLEP`|System Sleep | -|`KC_SYSTEM_WAKE` |`KC_WAKE`|System Wake | -|`KC_MAIL` |`KC_MAIL`| | -|`KC_CALCULATOR` |`KC_CALC`| | -|`KC_MY_COMPUTER` |`KC_MYCM`| | -|`KC_WWW_SEARCH` |`KC_WSCH`| | -|`KC_WWW_HOME` |`KC_WHOM`| | -|`KC_WWW_BACK` |`KC_WBAK`| | -|`KC_WWW_FORWARD` |`KC_WFWD`| | -|`KC_WWW_STOP` |`KC_WSTP`| | -|`KC_WWW_REFRESH` |`KC_WREF`| | -|`KC_STOP` | |Stop | -|`KC_WWW_FAVORITES` |`KC_WFAV`| | -|`KC__MUTE` | |Mute (macOS) | -|`KC__VOLUP` | |Volume Up (macOS) | -|`KC__VOLDOWN` | |Volume Down (macOS) | -|`KC_AUDIO_MUTE` |`KC_MUTE`|Mute (Windows/macOS/Linux) | -|`KC_AUDIO_VOL_UP` |`KC_VOLU`|Volume Up (Windows/macOS/Linux) | -|`KC_AUDIO_VOL_DOWN` |`KC_VOLD`|Volume Down (Windows/macOS/Linux)| -|`KC_MEDIA_NEXT_TRACK` |`KC_MNXT`|Next Track (Windows) | -|`KC_MEDIA_PREV_TRACK` |`KC_MPRV`|Previous Track (Windows) | -|`KC_MEDIA_FAST_FORWARD`|`KC_MFFD`|Next Track (macOS) | -|`KC_MEDIA_REWIND` |`KC_MRWD`|Previous Track (macOS) | -|`KC_MEDIA_STOP` |`KC_MSTP`|Stop Track | -|`KC_MEDIA_PLAY_PAUSE` |`KC_MPLY`|Play/Pause Track | -|`KC_MEDIA_SELECT` |`KC_MSEL`| | -|`KC_MEDIA_EJECT` |`KC_EJCT`|Eject (macOS) | +|Key |Aliases |Description | +|-----------------------|---------|-----------------------------| +|`KC_SYSTEM_POWER` |`KC_PWR` |System Power Down | +|`KC_SYSTEM_SLEEP` |`KC_SLEP`|System Sleep | +|`KC_SYSTEM_WAKE` |`KC_WAKE`|System Wake | +|`KC_AUDIO_MUTE` |`KC_MUTE`|Mute | +|`KC_AUDIO_VOL_UP` |`KC_VOLU`|Volume Up | +|`KC_AUDIO_VOL_DOWN` |`KC_VOLD`|Volume Down | +|`KC_MEDIA_NEXT_TRACK` |`KC_MNXT`|Next Track (Windows) | +|`KC_MEDIA_PREV_TRACK` |`KC_MPRV`|Previous Track (Windows) | +|`KC_MEDIA_STOP` |`KC_MSTP`|Stop Track (Windows) | +|`KC_MEDIA_PLAY_PAUSE` |`KC_MPLY`|Play/Pause Track | +|`KC_MEDIA_SELECT` |`KC_MSEL`|Launch Media Player (Windows)| +|`KC_MEDIA_EJECT` |`KC_EJCT`|Eject (macOS) | +|`KC_MAIL` | |Launch Mail (Windows) | +|`KC_CALCULATOR` |`KC_CALC`|Launch Calculator (Windows) | +|`KC_MY_COMPUTER` |`KC_MYCM`|Launch My Computer (Windows) | +|`KC_WWW_SEARCH` |`KC_WSCH`|Browser Search (Windows) | +|`KC_WWW_HOME` |`KC_WHOM`|Browser Home (Windows) | +|`KC_WWW_BACK` |`KC_WBAK`|Browser Back (Windows) | +|`KC_WWW_FORWARD` |`KC_WFWD`|Browser Forward (Windows) | +|`KC_WWW_STOP` |`KC_WSTP`|Browser Stop (Windows) | +|`KC_WWW_REFRESH` |`KC_WREF`|Browser Refresh (Windows) | +|`KC_WWW_FAVORITES` |`KC_WFAV`|Browser Favorites (Windows) | +|`KC_MEDIA_FAST_FORWARD`|`KC_MFFD`|Next Track (macOS) | +|`KC_MEDIA_REWIND` |`KC_MRWD`|Previous Track (macOS) | ## Number Pad |Key |Aliases |Description | |-------------------|---------|------------------------------| -|`KC_NUMLOCK` |`KC_NLCK`|Keypad Num Lock and Clear | |`KC_KP_SLASH` |`KC_PSLS`|Keypad `/` | |`KC_KP_ASTERISK` |`KC_PAST`|Keypad `*` | |`KC_KP_MINUS` |`KC_PMNS`|Keypad `-` | @@ -225,7 +248,7 @@ Windows and macOS use different keycodes for "next track" and "previous track". In addition to these, keycodes in the range of `0xA5-DF` are reserved for internal use by TMK. -|Key |Aliases |Description | -|----------------|---------|---------------------------------------| -|`KC_NO` | |Ignore this key (NOOP) | -|`KC_TRANSPARENT`|`KC_TRNS`|Use the next lowest non-transparent key| +|Key |Aliases |Description | +|----------------|--------------------|---------------------------------------| +|`KC_NO` |`XXXXXXX` |Ignore this key (NOOP) | +|`KC_TRANSPARENT`|`KC_TRNS`, `_______`|Use the next lowest non-transparent key| diff --git a/docs/keycodes_us_ansi_shifted.md b/docs/keycodes_us_ansi_shifted.md index 5163b3bf158..46e3f1248c2 100644 --- a/docs/keycodes_us_ansi_shifted.md +++ b/docs/keycodes_us_ansi_shifted.md @@ -6,26 +6,26 @@ It's important to remember that all of these keycodes send a left shift - this m ## US ANSI Shifted Keycodes -|Key |Aliases |Description | -|------------------------|------------------|-------------------| -|`KC_TILDE` |`KC_TILD` |`~` | -|`KC_EXCLAIM` |`KC_EXLM` |`!` | -|`KC_AT` | |`@` | -|`KC_HASH` | |`#` | -|`KC_DOLLAR` |`KC_DLR` |`$` | -|`KC_PERCENT` |`KC_PERC` |`%` | -|`KC_CIRCUMFLEX` |`KC_CIRC` |`^` | -|`KC_AMPERSAND` |`KC_AMPR` |`&` | -|`KC_ASTERISK` |`KC_ASTR` |`*` | -|`KC_LEFT_PAREN` |`KC_LPRN` |`(` | -|`KC_RIGHT_PAREN` |`KC_RPRN` |`)` | -|`KC_UNDERSCORE` |`KC_UNDS` |`_` | -|`KC_PLUS` | |`+` | -|`KC_LEFT_CURLY_BRACE` |`KC_LCBR` |`{` | -|`KC_RIGHT_CURLY_BRACE` |`KC_RCBR` |`}` | -|`KC_PIPE` | ||| -|`KC_COLON` |`KC_COLN` |`:` | -|`KC_DOUBLE_QUOTE` |`KC_DQT`/`KC_DQUO`|`"` | -|`KC_LEFT_ANGLE_BRACKET` |`KC_LT`/`KC_LABK` |`<` | -|`KC_RIGHT_ANGLE_BRACKET`|`KC_GT`/`KC_RABK` |`>` | -|`KC_QUESTION` |`KC_QUES` |`?` | +|Key |Aliases |Description | +|------------------------|-------------------|-------------------| +|`KC_TILDE` |`KC_TILD` |`~` | +|`KC_EXCLAIM` |`KC_EXLM` |`!` | +|`KC_AT` | |`@` | +|`KC_HASH` | |`#` | +|`KC_DOLLAR` |`KC_DLR` |`$` | +|`KC_PERCENT` |`KC_PERC` |`%` | +|`KC_CIRCUMFLEX` |`KC_CIRC` |`^` | +|`KC_AMPERSAND` |`KC_AMPR` |`&` | +|`KC_ASTERISK` |`KC_ASTR` |`*` | +|`KC_LEFT_PAREN` |`KC_LPRN` |`(` | +|`KC_RIGHT_PAREN` |`KC_RPRN` |`)` | +|`KC_UNDERSCORE` |`KC_UNDS` |`_` | +|`KC_PLUS` | |`+` | +|`KC_LEFT_CURLY_BRACE` |`KC_LCBR` |`{` | +|`KC_RIGHT_CURLY_BRACE` |`KC_RCBR` |`}` | +|`KC_PIPE` | ||| +|`KC_COLON` |`KC_COLN` |`:` | +|`KC_DOUBLE_QUOTE` |`KC_DQUO`, `KC_DQT`|`"` | +|`KC_LEFT_ANGLE_BRACKET` |`KC_LABK`, `KC_LT` |`<` | +|`KC_RIGHT_ANGLE_BRACKET`|`KC_RABK`, `KC_GT` |`>` | +|`KC_QUESTION` |`KC_QUES` |`?` | From 23d68d0ba12ced8b58b7e6225c3c1c5aa41a38d0 Mon Sep 17 00:00:00 2001 From: Drashna Jaelre Date: Sat, 4 Aug 2018 13:49:10 -0700 Subject: [PATCH 06/17] Make sure Planck light calls user suspend functions (#3568) * Make sure Planck light calls user suspend functions * Add suspend.h include to quantum.h for kb/user function compatibility --- keyboards/planck/light/light.c | 2 ++ quantum/quantum.h | 1 + 2 files changed, 3 insertions(+) diff --git a/keyboards/planck/light/light.c b/keyboards/planck/light/light.c index cef57c5e69f..f463090dd0b 100644 --- a/keyboards/planck/light/light.c +++ b/keyboards/planck/light/light.c @@ -159,10 +159,12 @@ void matrix_scan_kb(void) void suspend_power_down_kb(void) { rgb_matrix_set_suspend_state(true); + suspend_power_down_user(); } void suspend_wakeup_init_kb(void) { rgb_matrix_set_suspend_state(false); + suspend_wakeup_init_user(); } diff --git a/quantum/quantum.h b/quantum/quantum.h index 855a51c1b8f..1db9846f045 100644 --- a/quantum/quantum.h +++ b/quantum/quantum.h @@ -53,6 +53,7 @@ #include #include "print.h" #include "send_string_keycodes.h" +#include "suspend.h" extern uint32_t default_layer_state; From ef5b161bb5ebf137bd95e4462588bb20ffbe0f79 Mon Sep 17 00:00:00 2001 From: Drashna Jaelre Date: Sun, 29 Jul 2018 21:24:42 -0700 Subject: [PATCH 07/17] Fix Audio code when resetting keyboard I incorrectly disabled a bunch of code that shouldn't have been disabled. This should only disable music mode stuff, not general audio. --- quantum/quantum.c | 8 +++++--- 1 file changed, 5 insertions(+), 3 deletions(-) diff --git a/quantum/quantum.c b/quantum/quantum.c index 9c6ed3330e5..aad678e1ad4 100644 --- a/quantum/quantum.c +++ b/quantum/quantum.c @@ -147,8 +147,10 @@ void reset_keyboard(void) { #if defined(MIDI_ENABLE) && defined(MIDI_BASIC) process_midi_all_notes_off(); #endif -#if defined(AUDIO_ENABLE) && !defined(NO_MUSIC_MODE) - music_all_notes_off(); +#ifdef AUDIO_ENABLE + #ifndef NO_MUSIC_MODE + music_all_notes_off(); + #endif uint16_t timer_start = timer_read(); PLAY_SONG(goodbye_song); shutdown_user(); @@ -931,7 +933,7 @@ uint8_t rgb_matrix_task_counter = 0; #endif void matrix_scan_quantum() { - #if defined(AUDIO_ENABLE) + #if defined(AUDIO_ENABLE) && !defined(NO_MUSIC_MODE) matrix_scan_music(); #endif From a2b4178245166913118e614d0e4338b3154f70c4 Mon Sep 17 00:00:00 2001 From: Drashna Jaelre Date: Tue, 31 Jul 2018 20:20:29 -0700 Subject: [PATCH 08/17] Make sure 'shutdown_user' is called --- quantum/quantum.c | 1 + 1 file changed, 1 insertion(+) diff --git a/quantum/quantum.c b/quantum/quantum.c index aad678e1ad4..ab47fa48ff4 100644 --- a/quantum/quantum.c +++ b/quantum/quantum.c @@ -158,6 +158,7 @@ void reset_keyboard(void) { wait_ms(1); stop_all_notes(); #else + shutdown_user(); wait_ms(250); #endif // this is also done later in bootloader.c - not sure if it's neccesary here From a6e1cb08c657e5fe1d355a662b6cbd2e613d5f9b Mon Sep 17 00:00:00 2001 From: Dave Brown Date: Sat, 4 Aug 2018 17:02:03 -0400 Subject: [PATCH 09/17] Keymap: frogger keymap (#3570) * adding my keymap A bit of pok3r, and a bit of some other things. * Adding a readme * undoing changes to gitignore * adding a bit of commentary --- keyboards/dz60/keymaps/frogger/keymap.c | 92 ++++++++++++++++++++++++ keyboards/dz60/keymaps/frogger/readme.md | 6 ++ 2 files changed, 98 insertions(+) create mode 100644 keyboards/dz60/keymaps/frogger/keymap.c create mode 100644 keyboards/dz60/keymaps/frogger/readme.md diff --git a/keyboards/dz60/keymaps/frogger/keymap.c b/keyboards/dz60/keymaps/frogger/keymap.c new file mode 100644 index 00000000000..86a4687913e --- /dev/null +++ b/keyboards/dz60/keymaps/frogger/keymap.c @@ -0,0 +1,92 @@ +#include QMK_KEYBOARD_H + +#define MODS_CTRL_MASK (MOD_BIT(KC_LSHIFT)|MOD_BIT(KC_RSHIFT)) + +#define ______ KC_TRNS + +#define LAYER_1 1 +#define LAYER_2 2 +#define LAYER_3 3 + +const uint16_t PROGMEM keymaps[][MATRIX_ROWS][MATRIX_COLS] = { + + /* Base Layer + * ,-----------------------------------------------------------------------------------------. + * | ` ~ | 1 | 2 | 3 | 4 | 5 | 6 | 7 | 8 | 9 | 0 | - | = | Bkspc | + * |-----------------------------------------------------------------------------------------+ + * | Tab | Q | W | E | R | T | Y | U | I | O | P | [ | ] | \ | + * |-----------------------------------------------------------------------------------------+ + * | LAY1 | A | S | D | F | G | H | J | K | L | ; | ' | Enter | + * |-----------------------------------------------------------------------------------------+ + * | Shift | Z | X | C | V | B | N | M | , | . | / | RSh | U | LAY2| + * |-----------------------------------------------------------------------------------------+ + * | Ctrl | Cmd | Alt | LAY1 | LAY2 | SPACE | RAlt | LAY1 | L | D | R | + * `-----------------------------------------------------------------------------------------' + */ + + LAYOUT_2_shifts( + KC_GRAVE, KC_1, KC_2, KC_3, KC_4, KC_5, KC_6, KC_7, KC_8, KC_9, KC_0, KC_MINS, KC_EQL, ______, KC_BSPC, + + KC_TAB, KC_Q, KC_W, KC_E, KC_R, KC_T, KC_Y, KC_U, KC_I, KC_O, KC_P, KC_LBRC, KC_RBRC, KC_BSLS, + + MO(LAYER_1), KC_A, KC_S, KC_D, KC_F, KC_G, KC_H, KC_J, KC_K, KC_L, KC_SCLN, KC_QUOT, KC_ENT, + + KC_LSFT, ______, KC_Z, KC_X, KC_C, KC_V, KC_B, KC_N, KC_M, KC_COMM, KC_DOT, KC_SLSH, KC_RSFT, KC_UP, MO(LAYER_2), + + KC_LCTL, KC_LGUI, KC_LALT, MO(LAYER_1), MO(LAYER_1), KC_SPC, KC_RALT, MO(LAYER_1), KC_LEFT, KC_DOWN, KC_RIGHT + ), + + /* Layer 1 + * ,-----------------------------------------------------------------------------------------. + * | Esc | F1 | F2 | F3 | F4 | F5 | F6 | F7 | F8 | F9 | F10 | F11 | F12 | DEL | + * |-----------------------------------------------------------------------------------------+ + * | | PREV | PLAY | NEXT | | | | | Up | | | | | | + * |-----------------------------------------------------------------------------------------+ + * | | | | | | | | Home| Left | Down | Right | End | | | + * |-----------------------------------------------------------------------------------------+ + * | | | | | | | | | | | | |VOL+| | + * |-----------------------------------------------------------------------------------------+s + * | | | | | | | |VOL-| MUTE | + * `-----------------------------------------------------------------------------------------' + KC_VOLD, KC_VOLU, KC_MUTE, + KC_MPRV, KC_MPLY, KC_MNXT, + */ + + LAYOUT_2_shifts( + KC_ESC, KC_F1, KC_F2, KC_F3, KC_F4, KC_F5, KC_F6, KC_F7, KC_F8, KC_F9, KC_F10, KC_F11, KC_F12, ______, KC_DEL, + + ______, KC_MPRV, KC_MPLY, KC_MNXT, ______, ______, ______, ______, KC_UP, ______, ______, ______, ______, ______, + + ______, ______, ______, ______, ______, ______, KC_HOME, KC_LEFT, KC_DOWN, KC_RIGHT, KC_END, ______, ______, + + ______, ______, ______, ______, ______, ______, ______, ______, ______, ______, ______, ______, ______, KC_VOLU, ______, + + ______, ______, ______, ______, ______, ______, ______, ______, ______, KC_VOLD, KC_MUTE + ), + + /* Layer 2 + * ,-----------------------------------------------------------------------------------------. + * | RESET | F1 | F2 | F3 | F4 | F5 | F6 | F7 | F8 | F9 | F10 | F11 | F12 | RESET | + * |-----------------------------------------------------------------------------------------+ + * | |RBB T|RGB M| Hue+| Hue-| Sat+| Sat-| Val+| Val-| | | | | | + * |-----------------------------------------------------------------------------------------+ + * | | BL T| BL M| BL+ | BL- | | | | | | | | | + * |-----------------------------------------------------------------------------------------+ + * | | | | | | | | | | | | | | | + * |-----------------------------------------------------------------------------------------+ + * | | | | | | | | | | + * `-----------------------------------------------------------------------------------------' + */ + + LAYOUT_2_shifts( + RESET, KC_F1, KC_F2, KC_F3, KC_F4, KC_F5, KC_F6, KC_F7, KC_F8, KC_F9, KC_F10, KC_F11, KC_F12, ______, RESET, + + ______, RGB_TOG, RGB_MOD, RGB_HUI, RGB_HUD, RGB_SAI, RGB_SAD, RGB_VAI, RGB_VAD, ______, ______, ______, ______, ______, + + ______, BL_TOGG, BL_STEP, BL_INC, BL_DEC, ______, ______, ______, ______, ______, ______, ______, ______, + + ______, ______, ______, ______, ______, ______, ______, ______, ______, ______, ______, ______, ______, ______, ______, + + ______, ______, ______, ______, ______, ______, ______, ______, ______, ______, ______ + ), +}; diff --git a/keyboards/dz60/keymaps/frogger/readme.md b/keyboards/dz60/keymaps/frogger/readme.md new file mode 100644 index 00000000000..1704717155c --- /dev/null +++ b/keyboards/dz60/keymaps/frogger/readme.md @@ -0,0 +1,6 @@ +![DZ60 Layout Image](https://i.redd.it/aa4usjtk5j701.jpg) + +# Frogger's Keyboard Layout + +This layouts is for someone with a dedicated arrow keys, but still wants arrows on home row as well. I have one layer which is functionality, and another layer +which is really more around backlight stuff, because I rarely use it. Instead of a 2.25u shift as pictured, I have 2 1u keys. From 9a4db7a860ecb35ed6d1402955cc169512a8ba74 Mon Sep 17 00:00:00 2001 From: Fred Silberberg Date: Sun, 5 Aug 2018 08:42:16 -0700 Subject: [PATCH 10/17] Keymap: Adds zen layout for 333fred (#3563) * Initial commit of zen keymap * Added RGB control for my zen * Fixed ergodox layout. * Reduce brightness. * PR feedback. --- keyboards/nyquist/keymaps/333fred/config.h | 5 +- keyboards/nyquist/keymaps/333fred/keymap.c | 9 +- keyboards/nyquist/keymaps/333fred/rules.mk | 4 - keyboards/zen/config.h | 4 +- keyboards/zen/keymaps/333fred/config.h | 38 ++++++ keyboards/zen/keymaps/333fred/keymap.c | 129 +++++++++++++++++++++ keyboards/zen/keymaps/333fred/rules.mk | 7 ++ layouts/community/ergodox/333fred/config.h | 6 +- layouts/community/ergodox/333fred/keymap.c | 10 +- layouts/community/ergodox/333fred/rules.mk | 2 - users/333fred/333fred.c | 24 ++++ users/333fred/333fred.h | 5 +- users/333fred/333fred_config.h | 5 +- users/333fred/rgb.c | 28 +++++ users/333fred/rules.mk | 5 +- 15 files changed, 243 insertions(+), 38 deletions(-) create mode 100644 keyboards/zen/keymaps/333fred/config.h create mode 100644 keyboards/zen/keymaps/333fred/keymap.c create mode 100644 keyboards/zen/keymaps/333fred/rules.mk create mode 100644 users/333fred/rgb.c diff --git a/keyboards/nyquist/keymaps/333fred/config.h b/keyboards/nyquist/keymaps/333fred/config.h index 6335ce9b090..575ec9ac528 100644 --- a/keyboards/nyquist/keymaps/333fred/config.h +++ b/keyboards/nyquist/keymaps/333fred/config.h @@ -1,5 +1,4 @@ -#ifndef CONFIG_USER_H -#define CONFIG_USER_H +#pragma once #include "../../config.h" #include "333fred_config.h" @@ -9,5 +8,3 @@ #undef TAPPING_TERM #define TAPPING_TERM 150 - -#endif diff --git a/keyboards/nyquist/keymaps/333fred/keymap.c b/keyboards/nyquist/keymaps/333fred/keymap.c index fd1a7d47f7c..c25bf1c5ff6 100644 --- a/keyboards/nyquist/keymaps/333fred/keymap.c +++ b/keyboards/nyquist/keymaps/333fred/keymap.c @@ -94,13 +94,12 @@ const uint16_t PROGMEM keymaps[][MATRIX_ROWS][MATRIX_COLS] = { * `-----------------------------------------------------------------------------------' */ [GAME] = LAYOUT( \ - KC_ESC, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, \ - _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, \ - KC_LCTL, _______, _______, _______, KC_F, _______, _______, _______, _______, _______, _______, _______, \ - KC_LSFT, KC_Z, _______, _______, _______, _______, _______, _______, _______, _______, _______, KC_LGUI, \ + KC_ESC, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, \ + _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, \ + KC_LCTL, _______, _______, _______, KC_F, _______, _______, _______, _______, _______, _______, _______, \ + KC_LSFT, KC_Z, _______, _______, _______, _______, _______, _______, _______, _______, _______, KC_LGUI, \ KC_ENT, _______, KC_LOCK, KC_BSPC, KC_LALT, KC_SPC, OSL(SYMB), KC_LEFT, KC_DOWN, KC_UP, KC_RGHT, TO(BASE) \ ) - }; void persistent_default_layer_set(uint16_t default_layer) { diff --git a/keyboards/nyquist/keymaps/333fred/rules.mk b/keyboards/nyquist/keymaps/333fred/rules.mk index 5a3543a6f66..0cfb234665e 100644 --- a/keyboards/nyquist/keymaps/333fred/rules.mk +++ b/keyboards/nyquist/keymaps/333fred/rules.mk @@ -2,7 +2,3 @@ KEY_LOCK_ENABLE = yes NKRO_ENABLE = yes CONSOLE_ENABLE = no TAP_DANCE_ENABLE = yes - -ifndef QUANTUM_DIR - include ../../../../Makefile -endif diff --git a/keyboards/zen/config.h b/keyboards/zen/config.h index f8f8bbf3320..4478062eb0e 100644 --- a/keyboards/zen/config.h +++ b/keyboards/zen/config.h @@ -26,4 +26,6 @@ along with this program. If not, see . #define RGBLIGHT_ANIMATIONS #define RGBLED_NUM 16 -#define TAPPING_TERM 100 \ No newline at end of file +#ifndef TAPPING_TERM +#define TAPPING_TERM 100 +#endif diff --git a/keyboards/zen/keymaps/333fred/config.h b/keyboards/zen/keymaps/333fred/config.h new file mode 100644 index 00000000000..1634f368cc1 --- /dev/null +++ b/keyboards/zen/keymaps/333fred/config.h @@ -0,0 +1,38 @@ +/* +Copyright 2018 Fredric Silberberg + +This program is free software: you can redistribute it and/or modify +it under the terms of the GNU General Public License as published by +the Free Software Foundation, either version 2 of the License, or +(at your option) any later version. + +This program is distributed in the hope that it will be useful, +but WITHOUT ANY WARRANTY; without even the implied warranty of +MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the +GNU General Public License for more details. + +You should have received a copy of the GNU General Public License +along with this program. If not, see . +*/ + +#pragma once + +#include "config_common.h" + +/* Use I2C or Serial, not both */ + +#define USE_SERIAL + +/* Select hand configuration */ +//#define MASTER_LEFT +#define EE_HANDS + +#undef RGBLED_NUM +#define RGBLIGHT_ANIMATIONS +#define RGBLED_NUM 16 +#define RGBLIGHT_HUE_STEP 8 +#define RGBLIGHT_SAT_STEP 8 +#define RGBLIGHT_VAL_STEP 8 + +#undef TAPPING_TERM +#define TAPPING_TERM 150 diff --git a/keyboards/zen/keymaps/333fred/keymap.c b/keyboards/zen/keymaps/333fred/keymap.c new file mode 100644 index 00000000000..5332062e047 --- /dev/null +++ b/keyboards/zen/keymaps/333fred/keymap.c @@ -0,0 +1,129 @@ +#include QMK_KEYBOARD_H +#include "333fred.h" + +extern keymap_config_t keymap_config; + +enum custom_macros { + DLEFT, + DRIGHT, + PSCREEN_APP +}; + +const uint16_t PROGMEM keymaps[][MATRIX_ROWS][MATRIX_COLS] = { + +/* Qwerty + * ,-----------------------------------------. .-----------------------------------------. + * | ` | 1 | 2 | 3 | 4 | 5 | | 6 | 7 | 8 | 9 | 0 | - | + * |------+------+------+------+------+------| |------+------+------+------+------+------| + * | Tab | Q | W | E | R | T | | Y | U | I | O | P | \ | + * |------+------+------+------+------+------| |------+------+------+------+------+------| + * | Esc | A | S | D | F | G | | H | J | K | L | ; | " | + * |------+------+------+------+------+------| |------+------+------+------+------+------| + * | Shift| Z | X | C | V | B | | N | M | , | . | / |SHIFT | + * |------+------+------+------+------+------+------..-----+------+------+------+------+------+------| + * | Ctrl | F4 | F5 | GUI | Alt | Bksp |Lwr/VM||Enter|Space | NAV | - | = | Alt | Del | + * `------------------------------------------------''-----------------------------------------------' + */ +[BASE] = KEYMAP( \ + KC_GRV, KC_1, KC_2, KC_3, KC_4, KC_5, KC_6, KC_7, KC_8, KC_9, KC_0, KC_MINUS, \ + KC_TAB, KC_Q, KC_W, KC_E, KC_R, KC_T, KC_Y, KC_U, KC_I, KC_O, KC_P, KC_BSLS, \ + KC_ESC, KC_A, KC_S, KC_D, KC_F, KC_G, KC_H, KC_J, KC_K, KC_L, KC_SCLN, KC_QUOT, \ + OSM(MOD_LSFT), LCTL_T(KC_Z), KC_X, KC_C, KC_V, KC_B, KC_N, KC_M, KC_COMM, KC_DOT, KC_SLSH, OSM(MOD_RSFT) , \ + KC_LCTL, KC_F4, KC_F5, KC_LGUI, KC_LALT, KC_BSPC, TD(TD_SYM_VIM), KC_ENT, KC_SPACE, OSL(VIM), KC_MINS, KC_EQL, KC_RALT, KC_DEL \ +), + +/* Symbols + * ,-----------------------------------------. .-----------------------------------------. + * | Caps | F1 | F2 | F3 | F4 | F5 | | F6 | F7 | F8 | F9 | F10 | F11 | + * |------+------+------+------+------+------| |------+------+------+------+------+------| + * | | ! | @ | ( | ) | | | | 7 | 8 | 9 | * | ) | F12 | + * |------+------+------+------+------+------| |------+------+------+------+------+------| + * | | # | $ | { | } | ` | | 4 | 5 | 6 | + | } | | | + * |------+------+------+------+------+------| |------+------+------+------+------+------| + * | APscr| % | ^ | [ | ] | ~ | | 1 | 2 | 3 | \ | Vol- | Vol+ | + * |------+------+------+------+------+------+------..------+------+------+------+------+------+------| + * | Pscr | | RESET| | | GAME | || | 0 | . | = | Prev | Next | Play | + * `------------------------------------------------- -------------------------------------------------' + */ +[SYMB] = KEYMAP( \ + KC_CAPS, KC_F1, KC_F2, KC_F3, KC_F4, KC_F5, KC_F6, KC_F7, KC_F8, KC_F9, KC_F10, KC_F11, \ + _______, KC_EXLM, KC_AT, KC_LPRN, KC_RPRN, KC_PIPE, KC_7, KC_8, KC_9, KC_ASTR, KC_RPRN, KC_F12, \ + _______, KC_HASH, KC_DLR, KC_LCBR, KC_RCBR, KC_GRV, KC_4, KC_5, KC_6, KC_PLUS, KC_RCBR, KC_PIPE, \ + M(PSCREEN_APP), KC_PERC, KC_CIRC, KC_LBRC, KC_RBRC, KC_TILD, KC_1, KC_2, KC_3, KC_BSLS, KC_VOLD, KC_VOLU, \ + KC_PSCR, _______, RESET, _______, _______, TO(GAME), _______, _______, KC_0, KC_DOT, KC_EQL, KC_MPRV, KC_MNXT, KC_MPLY \ +), + +/* Vim Movement + * ,-----------------------------------------. .-----------------------------------------. + * | | | | | | | | | | | | RESET| | + * |------+------+------+------+------+------| |------+------+------+------+------+------| + * | |RGBSAI|RGBVAI|RGBSAD| LSFT | | | | | | | | | + * |------+------+------+------+------+------| |------+------+------+------+------+------| + * | | DLeft|DRight| LCTRL| LGUI | | | Left | Down | Up | Right| | | + * |------+------+------+------+------+------| |------+------+------+------+------+------| + * | |RGBHUD|RGBVAD|RGBHUI| | | | | | | | | | + * |------+------+------+------+------+------+------..------+------+------+------+------+------+------| + * | | | | | | | || | | | | | | | + * `------------------------------------------------..------------------------------------------------' + */ +[VIM] = KEYMAP( \ + _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, RESET, _______, \ + _______, RGB_SAI, RGB_VAI, RGB_SAD, KC_LSFT, _______, _______, _______, _______, _______, _______, _______, \ + _______, M(DLEFT), M(DRIGHT), KC_LCTL, KC_LGUI, _______, KC_LEFT, KC_DOWN, KC_UP, KC_RGHT, _______, _______, \ + _______, RGB_HUD, RGB_VAD, RGB_HUI, _______, _______, _______, _______, _______, _______, _______, _______, \ + _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______ \ +), + +/* Gaming mode (Raise) + * All one-shot mods are disabled on this layer + * ,-----------------------------------------. .-----------------------------------------. + * | ESC | | | | | | | | | | | | | + * |------+------+------+------+------+------| |------+------+------+------+------+------| + * | | | | | | | | | | | | | | + * |------+------+------+------+------+------| |------+------+------+------+------+------| + * | CTRL | | | | F | | | | | | | | | + * |------+------+------+------+------+------| |------+------+------+------+------+------| + * | Shift| Z | | | | | | | | | | | GUI | + * |------+------+------+------+------+------+------..------+------+------+------+------+------+------| + * | Enter| | Lock | Bksp | Alt | Spc | RESET|| | Lower| Left | Up | Down | Right|QWERTY| + * `------------------------------------------------..-----------------------------------------------' + */ +[GAME] = KEYMAP( \ + KC_ESC, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, \ + _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, \ + KC_LCTL, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, \ + KC_LSFT, KC_Z, _______, _______, _______, _______, _______, _______, _______, _______, _______, KC_LGUI, \ + KC_ENT, _______, KC_LOCK, KC_BSPC, KC_F5, KC_LALT, KC_SPC, OSL(SYMB), KC_F6, KC_LEFT, KC_DOWN, KC_UP, KC_RGHT, TO(BASE) \ +) +}; + +void persistant_default_layer_set(uint16_t default_layer) { + eeconfig_update_default_layer(default_layer); + default_layer_set(default_layer); +} + +const macro_t *action_get_macro(keyrecord_t *record, uint8_t id, uint8_t opt) { + switch(id) { + case DLEFT: + if (record->event.pressed) { // Windows move desktop left + return MACRO(D(LCTL), D(LGUI), T(LEFT), U(LGUI), U(LCTL), END); + } + break; + case DRIGHT: + if (record->event.pressed) { // Windows move desktop right + return MACRO(D(LCTL), D(LGUI), T(RIGHT), U(LGUI), U(LCTL), END); + } + break; + case PSCREEN_APP: + if (record->event.pressed) { + return MACRO(D(LALT), T(PSCR), U(LALT), END); + } + break; + } + return MACRO_NONE; +} + +bool process_record_user(uint16_t keycode, keyrecord_t *record) { + tap_dance_process_record(keycode); + return true; +} diff --git a/keyboards/zen/keymaps/333fred/rules.mk b/keyboards/zen/keymaps/333fred/rules.mk new file mode 100644 index 00000000000..38b71555042 --- /dev/null +++ b/keyboards/zen/keymaps/333fred/rules.mk @@ -0,0 +1,7 @@ +RGBLIGHT_ENABLE = yes +BACKLIGHT_ENABLE = no +NKRO_ENABLE = yes +KEY_LOCK_ENABLE = yes +TAP_DANCE_ENABLE = yes +CONSOLE_ENABLE = no +EXTRAFLAGS += -flto diff --git a/layouts/community/ergodox/333fred/config.h b/layouts/community/ergodox/333fred/config.h index d886bf8217a..82255e05ec7 100644 --- a/layouts/community/ergodox/333fred/config.h +++ b/layouts/community/ergodox/333fred/config.h @@ -1,11 +1,7 @@ -#ifndef CONFIG_H_ -#define CONFIG_H_ +#pragma once #include QMK_KEYBOARD_CONFIG_H #include "333fred_config.h" #undef TAPPING_TERM #define TAPPING_TERM 200 - - -#endif diff --git a/layouts/community/ergodox/333fred/keymap.c b/layouts/community/ergodox/333fred/keymap.c index 479e4702c27..d7728a5bd4a 100644 --- a/layouts/community/ergodox/333fred/keymap.c +++ b/layouts/community/ergodox/333fred/keymap.c @@ -363,15 +363,9 @@ bool process_record_user(uint16_t keycode, keyrecord_t *record) { return true; } -// Runs just one time when the keyboard initializes. -void matrix_init_user(void) { - -}; - - // Runs constantly in the background, in a loop. -void matrix_scan_user(void) { +void matrix_scan_user_keyboard(void) { ergodox_board_led_on(); ergodox_led_all_on(); -}; +} diff --git a/layouts/community/ergodox/333fred/rules.mk b/layouts/community/ergodox/333fred/rules.mk index 2a522112e5a..1549bcfc84d 100644 --- a/layouts/community/ergodox/333fred/rules.mk +++ b/layouts/community/ergodox/333fred/rules.mk @@ -5,5 +5,3 @@ NKRO_ENABLE = yes KEY_LOCK_ENABLE = yes TAP_DANCE_ENABLE = yes CONSOLE_ENABLE = no - - diff --git a/users/333fred/333fred.c b/users/333fred/333fred.c index ef2d741e5b3..12ee9e7d7d2 100644 --- a/users/333fred/333fred.c +++ b/users/333fred/333fred.c @@ -34,6 +34,7 @@ void tap_dance_layer_finished(qk_tap_dance_state_t *state, void *user_data) { break; case DOUBLE: layer_on(VIM); + break; } } @@ -61,3 +62,26 @@ void tap_dance_process_record(uint16_t keycode) { tap_dance_active = false; } } + +__attribute__ ((weak)) +void matrix_init_rgb(void) {} + +__attribute__ ((weak)) +void layer_state_set_rgb(uint32_t state) {} + +__attribute__ ((weak)) +void matrix_scan_user_keyboard(void) {} + +void matrix_scan_user() { + static bool first_run = true; + if (first_run) { + first_run = false; + matrix_init_rgb(); + } + matrix_scan_user_keyboard(); +} + +uint32_t layer_state_set_user(uint32_t state) { + layer_state_set_rgb(state); + return state; +} diff --git a/users/333fred/333fred.h b/users/333fred/333fred.h index 4a0462b7a2b..8599198a575 100644 --- a/users/333fred/333fred.h +++ b/users/333fred/333fred.h @@ -1,5 +1,4 @@ -#ifndef FRED_333 -#define FRED_333 +#pragma once #include "quantum.h" @@ -18,5 +17,3 @@ enum tap_dance_declarations { void tap_dance_layer_finished(qk_tap_dance_state_t*, void*); void tap_dance_layer_reset(qk_tap_dance_state_t*, void*); void tap_dance_process_record(uint16_t); - -#endif diff --git a/users/333fred/333fred_config.h b/users/333fred/333fred_config.h index f796abc0958..7c637d8d365 100644 --- a/users/333fred/333fred_config.h +++ b/users/333fred/333fred_config.h @@ -1,7 +1,4 @@ -#ifndef FRED333_CONFIG -#define FRED333_CONFIG +#pragma once #define PREVENT_STUCK_MODIFIERS #define PERMISSIVE_HOLD - -#endif diff --git a/users/333fred/rgb.c b/users/333fred/rgb.c new file mode 100644 index 00000000000..a3dfd905cce --- /dev/null +++ b/users/333fred/rgb.c @@ -0,0 +1,28 @@ +#include "quantum.h" +#include "333fred.h" + +void matrix_init_rgb(void) { + rgblight_enable_noeeprom(); + rgblight_sethsv_noeeprom(270, 255, 20); +} + +void layer_state_set_rgb(uint32_t state) { + switch (biton32(state)) { + case BASE: + // purple + rgblight_sethsv_noeeprom(270, 255, 20); + break; + case SYMB: + // blue + rgblight_sethsv_noeeprom(240, 255, 20); + break; + case VIM: + // green + rgblight_sethsv_noeeprom(120, 255, 20); + break; + case GAME: + // red + rgblight_sethsv_noeeprom(0, 255, 20); + break; + } +} diff --git a/users/333fred/rules.mk b/users/333fred/rules.mk index 3160ac2e698..0e2cc2588cc 100644 --- a/users/333fred/rules.mk +++ b/users/333fred/rules.mk @@ -1,2 +1,5 @@ - SRC += 333fred.c + +ifeq ($(strip $(RGBLIGHT_ENABLE)), yes) + SRC += rgb.c +endif From e818b29879924f902df1c58b14869b05c5deeb3e Mon Sep 17 00:00:00 2001 From: fauxpark Date: Mon, 6 Aug 2018 01:51:33 +1000 Subject: [PATCH 11/17] Update FAQ section on Apple Fn (#3574) --- docs/faq_keymap.md | 10 +++++----- 1 file changed, 5 insertions(+), 5 deletions(-) diff --git a/docs/faq_keymap.md b/docs/faq_keymap.md index 674d207aa95..447b8922621 100644 --- a/docs/faq_keymap.md +++ b/docs/faq_keymap.md @@ -87,14 +87,14 @@ On **Xorg** you can use `compose` key, instead. And see this for **Unicode** input. * http://en.wikipedia.org/wiki/Unicode_input +## `Fn` Key on macOS -## Apple/Mac Keyboard `Fn` -Not supported. +Unlike most Fn keys, the one on Apple keyboards actually has its own keycode... sort of. It takes the place of the sixth keycode in a basic 6KRO HID report -- so an Apple keyboard is in fact only 5KRO. -Apple/Mac keyboard sends keycode for Fn unlike most of other keyboards. -I think you can send Apple Fn key using Apple venter specific Page 0xff01 and usage 0x0003. But you have to change HID Report Descriptor for this, of course. +It is technically possible to get QMK to send this key. However, doing so requires modification of the report format to add the state of the Fn key. +Even worse, it is not recognized unless the keyboard's VID and PID match that of a real Apple keyboard. The legal issues that official QMK support for this feature may create mean it is unlikely to happen. -https://opensource.apple.com/source/IOHIDFamily/IOHIDFamily-606.1.7/IOHIDFamily/AppleHIDUsageTables.h +See [this issue](https://github.com/qmk/qmk_firmware/issues/2179) for detailed information. ## Media Control Keys in Mac OSX From 0346bc2c5b5dc18b54384b7a5bb1094337f7afe2 Mon Sep 17 00:00:00 2001 From: ArpinFidel <41154181+ArpinFidel@users.noreply.github.com> Date: Sun, 5 Aug 2018 22:55:17 +0700 Subject: [PATCH 12/17] Keymap: XD75 keymap (#3553) * cloned colinta as base * switched to default base. started customising * minor changes to layout * added mouse keys * minor tweaks to layout and mouse speed * updated readme * tweaked layout - added middle fn keys - moved rgb controls to fn layer middle - added special keys to fn layer right * moved scroll buttons as to not interfere with lshift * turned on backlight * fixed backlight * changed user keycodes to differentiate * changed folder name to lowercase * updated readme * stop processing after custom keycode * edits to suit new standards * added layer indicator using gp100 and gp103 --- keyboards/xd75/keymaps/arpinfidel/config.h | 27 +++++ keyboards/xd75/keymaps/arpinfidel/keymap.c | 114 ++++++++++++++++++++ keyboards/xd75/keymaps/arpinfidel/readme.md | 35 ++++++ keyboards/xd75/keymaps/arpinfidel/rules.mk | 16 +++ 4 files changed, 192 insertions(+) create mode 100644 keyboards/xd75/keymaps/arpinfidel/config.h create mode 100644 keyboards/xd75/keymaps/arpinfidel/keymap.c create mode 100644 keyboards/xd75/keymaps/arpinfidel/readme.md create mode 100644 keyboards/xd75/keymaps/arpinfidel/rules.mk diff --git a/keyboards/xd75/keymaps/arpinfidel/config.h b/keyboards/xd75/keymaps/arpinfidel/config.h new file mode 100644 index 00000000000..24caea21527 --- /dev/null +++ b/keyboards/xd75/keymaps/arpinfidel/config.h @@ -0,0 +1,27 @@ +/* Copyright 2017 Benjamin Kesselring + * + * This program is free software: you can redistribute it and/or modify + * it under the terms of the GNU General Public License as published by + * the Free Software Foundation, either version 2 of the License, or + * (at your option) any later version. + * + * This program is distributed in the hope that it will be useful, + * but WITHOUT ANY WARRANTY; without even the implied warranty of + * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the + * GNU General Public License for more details. + * + * You should have received a copy of the GNU General Public License + * along with this program. If not, see . + */ + +#pragma once + +// place overrides here +#define TAPPING_TOGGLE 2 + +#define MOUSEKEY_DELAY 0 +#define MOUSEKEY_MAX_SPEED 4 +#define MOUSEKEY_TIME_TO_MAX 5 + +#define MOUSEKEY_WHEEL_MAX_SPEED 1 +#define MOUSEKEY_WHEEL_TIME_TO_MAX 50 diff --git a/keyboards/xd75/keymaps/arpinfidel/keymap.c b/keyboards/xd75/keymaps/arpinfidel/keymap.c new file mode 100644 index 00000000000..d8890db51ae --- /dev/null +++ b/keyboards/xd75/keymaps/arpinfidel/keymap.c @@ -0,0 +1,114 @@ +/* Copyright 2017 Wunder + * + * This program is free software: you can redistribute it and/or modify + * it under the terms of the GNU General Public License as published by + * the Free Software Foundation, either version 2 of the License, or + * (at your option) any later version. + * + * This program is distributed in the hope that it will be useful, + * but WITHOUT ANY WARRANTY; without even the implied warranty of + * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the + * GNU General Public License for more details. + * + * You should have received a copy of the GNU General Public License + * along with this program. If not, see . + */ +#include QMK_KEYBOARD_H + +// Layer shorthand +#define _QW 0 +#define _FN 1 + +enum my_kc { + A_BL_TG = SAFE_RANGE + // , A_BL_Y + // , A_BL_N +}; + +const uint16_t PROGMEM keymaps[][MATRIX_ROWS][MATRIX_COLS] = { + +/* QWERTY + * .--------------------------------------------------------------------------------------------------------------------------------------. + * | ESC | 1 | 2 | 3 | 4 | 5 | - | ` | = | 6 | 7 | 8 | 9 | 0 | BSPC | + * |--------+--------+--------+--------+--------+--------+--------+--------+--------+--------+--------+--------+--------+-----------------| + * | TAB | Q | W | E | R | T | [ | ] | \ | Y | U | I | O | P | ' | + * |--------+--------+--------+--------+--------+--------+--------+--------+--------+--------+--------+--------+-----------------+--------| + * | CAP LK | A | S | D | F | G | UP | DEL | DOWN | H | J | K | L | ; | ENTER | + * |--------+--------+--------+--------+--------+--------+--------+--------+--------+--------+--------+--------------------------+--------| + * | LSHIFT | Z | X | C | V | B | HOME | PG UP | END | N | M | , | . | / | RSHIFT | + * |--------+--------+--------+--------+--------+-----------------+--------+--------+--------+--------+-----------------+--------+--------| + * | LCTRL | FN | LGUI | LALT | SPACE | SPACE | FN | PG DN | FN | BSPC | BSPC | RALT | RGUI | FN | RCTRL | + * '--------------------------------------------------------------------------------------------------------------------------------------' + */ + + [_QW] = { /* QWERTY */ + { KC_ESC , KC_1 , KC_2 , KC_3 , KC_4 , KC_5 , KC_MINS, KC_GRV , KC_EQL , KC_6 , KC_7 , KC_8 , KC_9 , KC_0 , KC_BSPC }, + { KC_TAB , KC_Q , KC_W , KC_E , KC_R , KC_T , KC_LBRC, KC_RBRC, KC_BSLS, KC_Y , KC_U , KC_I , KC_O , KC_P , KC_QUOT }, + { KC_CAPS, KC_A , KC_S , KC_D , KC_F , KC_G , KC_UP , KC_DEL , KC_DOWN, KC_H , KC_J , KC_K , KC_L , KC_SCLN, KC_ENT }, + { KC_LSFT, KC_Z , KC_X , KC_C , KC_V , KC_B , KC_HOME, KC_PGUP, KC_END , KC_N , KC_M , KC_COMM, KC_DOT , KC_SLSH, KC_RSFT }, + { KC_LCTL, TT(_FN), KC_LGUI, KC_LALT, KC_SPC , KC_SPC , TT(_FN), KC_PGDN, TT(_FN), KC_BSPC, KC_BSPC, KC_RALT, KC_RGUI, TT(_FN), KC_RCTL }, + }, + +/* FUNCTION + * .--------------------------------------------------------------------------------------------------------------------------------------. + * | F1 | F2 | F3 | F4 | F5 | F6 | | | | F7 | F8 | F9 | F10 | F11 | F12 | + * |--------+--------+--------+--------+--------+--------+--------+--------+--------+--------+--------+--------+--------+--------+--------| + * | MS W U | | MS 2 | MS UP | MS 1 | MS 3 | RGB HD | | RGB HI | [ | ] | UP | | = | \ | + * |--------+--------+--------+--------+--------+--------+--------+--------+--------+--------+--------+--------+--------+--------+--------| + * | MS W D | | MS L | MS DN | MS R | | RGB SD | | RGB SI | - | LEFT | DOWN | RIGHT | | | + * |--------+--------+--------+--------+--------+--------+--------+--------+--------+--------+--------+--------+--------+--------+--------| + * | | | | | | | RGB VD | BL TG | RGB VI | | | | | | | + * |--------+--------+--------+--------+--------+--------+--------+--------+--------+--------+--------+--------+--------+--------+--------| + * | | FN | RGB TG | | MS W L | MS W R | | RESET | | MS 1 | MS 2 | RGB RMD| RGB MD | FN | | + * '--------------------------------------------------------------------------------------------------------------------------------------' + */ + + [_FN] = { /* FUNCTION */ + { KC_F1, KC_F2, KC_F3, KC_F4, KC_F5, KC_F6, RGB_HUD, _______, RGB_HUI, KC_F7, KC_F8, KC_F9, KC_F10 , KC_F11 , KC_F12 }, + { KC_WH_U, _______, KC_BTN2, KC_MS_U, KC_BTN1, KC_BTN3, RGB_SAD, _______, RGB_SAI, KC_LBRC, KC_RBRC, KC_UP , _______ , KC_EQL , KC_BSLS }, + { KC_WH_D, _______, KC_MS_L, KC_MS_D, KC_MS_R, _______, RGB_VAD, _______, RGB_VAI, KC_MINS, KC_LEFT, KC_DOWN, KC_RIGHT, _______, _______ }, + { _______, _______, _______, _______, _______, _______, RGB_RMOD,A_BL_TG, RGB_MOD, _______, _______, _______, _______ , _______, _______ }, + { _______, TT(_FN), RGB_TOG, _______, KC_WH_L, KC_WH_R, TT(_FN), RESET , TT(_FN), KC_BTN1, KC_BTN2, _______, _______ , TT(_FN), _______ }, + } +}; + +bool process_record_user(uint16_t keycode, keyrecord_t *record) { + switch (keycode) { + case A_BL_TG: + if (record->event.pressed) { + // toggle keycaps leds (f5 pin) + PORTF ^= (1 << 5); + } + return false; + + // case A_BL_Y: + // if (record->event.pressed) { + // keycaps_led_on(); + // } + // return false; + + // case A_BL_N: + // if (record->event.pressed) { + // keycaps_led_off(); + // } + // return false; + + default: + return true; + } +} + +// Runs whenever there is a layer state change. +uint32_t layer_state_set_user(uint32_t state) { + uint8_t layer = biton32(state); + + gp100_led_off(); + gp103_led_off(); + + // turns on gp100 (top left led) for odd layers + if (layer & (1<<0)) gp100_led_on(); + // turns on gp103 (top mid led) for layers 2, 6, ... + if (layer & (1<<1)) gp103_led_on(); + + return state; +} \ No newline at end of file diff --git a/keyboards/xd75/keymaps/arpinfidel/readme.md b/keyboards/xd75/keymaps/arpinfidel/readme.md new file mode 100644 index 00000000000..033049dd911 --- /dev/null +++ b/keyboards/xd75/keymaps/arpinfidel/readme.md @@ -0,0 +1,35 @@ +# ArpinFidel's layout for xd75 + +``` +QWERTY +.--------------------------------------------------------------------------------------------------------------------------------------. +| ESC | 1 | 2 | 3 | 4 | 5 | - | ` | = | 6 | 7 | 8 | 9 | 0 | BSPC | +|--------+--------+--------+--------+--------+--------+--------+--------+--------+--------+--------+--------+--------+-----------------| +| TAB | Q | W | E | R | T | [ | ] | \ | Y | U | I | O | P | ' | +|--------+--------+--------+--------+--------+--------+--------+--------+--------+--------+--------+--------+-----------------+--------| +| CAP LK | A | S | D | F | G | UP | DEL | DOWN | H | J | K | L | ; | ENTER | +|--------+--------+--------+--------+--------+--------+--------+--------+--------+--------+--------+--------------------------+--------| +| LSHIFT | Z | X | C | V | B | HOME | PG UP | END | N | M | , | . | / | RSHIFT | +|--------+--------+--------+--------+--------+-----------------+--------+--------+--------+--------+-----------------+--------+--------| +| LCTRL | FN | LGUI | LALT | SPACE | SPACE | FN | PG DN | FN | BSPC | BSPC | RALT | RGUI | FN | RCTRL | +'--------------------------------------------------------------------------------------------------------------------------------------' + +FUNCTION +.--------------------------------------------------------------------------------------------------------------------------------------. +| F1 | F2 | F3 | F4 | F5 | F6 | | | | F7 | F8 | F9 | F10 | F11 | F12 | +|--------+--------+--------+--------+--------+--------+--------+--------+--------+--------+--------+--------+--------+--------+--------| +| MS W U | | MS 2 | MS UP | MS 1 | MS 3 | RGB HD | | RGB HI | [ | ] | UP | | = | \ | +|--------+--------+--------+--------+--------+--------+--------+--------+--------+--------+--------+--------+--------+--------+--------| +| MS W D | | MS L | MS DN | MS R | | RGB SD | | RGB SI | - | LEFT | DOWN | RIGHT | | | +|--------+--------+--------+--------+--------+--------+--------+--------+--------+--------+--------+--------+--------+--------+--------| +| | | | | | | RGB VD | BL TG | RGB VI | | | | | | | +|--------+--------+--------+--------+--------+--------+--------+--------+--------+--------+--------+--------+--------+--------+--------| +| | FN | RGB TG | | MS W L | MS W R | | RESET | | MS 1 | MS 2 | RGB RMD| RGB MD | FN | | +'--------------------------------------------------------------------------------------------------------------------------------------' +``` + +special keys in the middle. hold fn for momentary switch, double tap for toggle. mouse control, arrow keys, led control, and special keys on fn layer. + +TODO : +- backlight brightness +- dynamic macros \ No newline at end of file diff --git a/keyboards/xd75/keymaps/arpinfidel/rules.mk b/keyboards/xd75/keymaps/arpinfidel/rules.mk new file mode 100644 index 00000000000..a83220d5811 --- /dev/null +++ b/keyboards/xd75/keymaps/arpinfidel/rules.mk @@ -0,0 +1,16 @@ +# Copyright 2013 Jun Wako +# +# This program is free software: you can redistribute it and/or modify +# it under the terms of the GNU General Public License as published by +# the Free Software Foundation, either version 2 of the License, or +# (at your option) any later version. +# +# This program is distributed in the hope that it will be useful, +# but WITHOUT ANY WARRANTY; without even the implied warranty of +# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the +# GNU General Public License for more details. +# +# You should have received a copy of the GNU General Public License +# along with this program. If not, see . + +BOOTMAGIC_ENABLE = no From f6ec2ce2015203f99622b405f88e0b82ec080b65 Mon Sep 17 00:00:00 2001 From: fauxpark Date: Mon, 6 Aug 2018 01:55:53 +1000 Subject: [PATCH 13/17] Update Shifted keycodes docs (#3575) --- docs/keycodes_us_ansi_shifted.md | 8 +++++--- 1 file changed, 5 insertions(+), 3 deletions(-) diff --git a/docs/keycodes_us_ansi_shifted.md b/docs/keycodes_us_ansi_shifted.md index 46e3f1248c2..e7abaa7099e 100644 --- a/docs/keycodes_us_ansi_shifted.md +++ b/docs/keycodes_us_ansi_shifted.md @@ -1,10 +1,12 @@ # US ANSI Shifted Symbols -These keycodes correspond to characters that are "shifted" on a standard US ANSI keyboards. They do not have dedicated keycodes but are instead typed by holding down shift and then sending a keycode. +These keycodes correspond to characters that are "shifted" on a standard US ANSI keyboard. They do not have keycodes of their own but are simply shortcuts for `LSFT(kc)`, and as such send a Left Shift with the unshifted keycode, not the symbol itself. -It's important to remember that all of these keycodes send a left shift - this may cause unintended actions if unaccounted for. The short code is preferred in most situations. +## Caveats -## US ANSI Shifted Keycodes +Unfortunately, these keycodes cannot be used in Mod-Taps or Layer-Taps, since any modifiers specified in the keycode are ignored. + +## Keycodes |Key |Aliases |Description | |------------------------|-------------------|-------------------| From 0c4e0a20974c891b674899d7025a0bc1026a585c Mon Sep 17 00:00:00 2001 From: MechMerlin <30334081+mechmerlin@users.noreply.github.com> Date: Mon, 6 Aug 2018 08:20:19 -0700 Subject: [PATCH 14/17] Keyboard: KBD6x Support (#3560) * initial commit * get the matrix correct * make my name be known * add rgblight enable * add a default keymap * Add QMK Configurator support for the base layout * add name here too * fix up readme * remove set user from keymap * use led_set_kb as per drashna's comments on PR --- keyboards/kbd6x/config.h | 225 ++++++++++++++++++++++ keyboards/kbd6x/info.json | 12 ++ keyboards/kbd6x/kbd6x.c | 49 +++++ keyboards/kbd6x/kbd6x.h | 36 ++++ keyboards/kbd6x/keymaps/default/keymap.c | 67 +++++++ keyboards/kbd6x/keymaps/default/readme.md | 1 + keyboards/kbd6x/readme.md | 12 ++ keyboards/kbd6x/rules.mk | 70 +++++++ 8 files changed, 472 insertions(+) create mode 100644 keyboards/kbd6x/config.h create mode 100644 keyboards/kbd6x/info.json create mode 100644 keyboards/kbd6x/kbd6x.c create mode 100644 keyboards/kbd6x/kbd6x.h create mode 100644 keyboards/kbd6x/keymaps/default/keymap.c create mode 100644 keyboards/kbd6x/keymaps/default/readme.md create mode 100644 keyboards/kbd6x/readme.md create mode 100644 keyboards/kbd6x/rules.mk diff --git a/keyboards/kbd6x/config.h b/keyboards/kbd6x/config.h new file mode 100644 index 00000000000..6a5ebf06242 --- /dev/null +++ b/keyboards/kbd6x/config.h @@ -0,0 +1,225 @@ +/* +Copyright 2018 MechMerlin + +This program is free software: you can redistribute it and/or modify +it under the terms of the GNU General Public License as published by +the Free Software Foundation, either version 2 of the License, or +(at your option) any later version. + +This program is distributed in the hope that it will be useful, +but WITHOUT ANY WARRANTY; without even the implied warranty of +MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the +GNU General Public License for more details. + +You should have received a copy of the GNU General Public License +along with this program. If not, see . +*/ + +#pragma once + +#include "config_common.h" + +/* USB Device descriptor parameter */ +#define VENDOR_ID 0xFEED +#define PRODUCT_ID 0x0000 +#define DEVICE_VER 0x0001 +#define MANUFACTURER You +#define PRODUCT kbd6x +#define DESCRIPTION A custom keyboard + +/* key matrix size */ +#define MATRIX_ROWS 5 +#define MATRIX_COLS 14 + +/* + * Keyboard Matrix Assignments + * + * Change this to how you wired your keyboard + * COLS: AVR pins used for columns, left to right + * ROWS: AVR pins used for rows, top to bottom + * DIODE_DIRECTION: COL2ROW = COL = Anode (+), ROW = Cathode (-, marked on diode) + * ROW2COL = ROW = Anode (+), COL = Cathode (-, marked on diode) + * +*/ +#define MATRIX_ROW_PINS { B3, B2, B1, B0, D4 } +#define MATRIX_COL_PINS { F6, F5, F4, F1, E6, D0, D1, D2, D3, D5, D6, D7, B4, B5 } +#define UNUSED_PINS + +/* COL2ROW, ROW2COL, or CUSTOM_MATRIX */ +#define DIODE_DIRECTION COL2ROW + +#define BACKLIGHT_PIN B7 +#define BACKLIGHT_BREATHING +#define BACKLIGHT_LEVELS 3 + +#define RGB_DI_PIN F0 +#ifdef RGB_DI_PIN +#define RGBLIGHT_ANIMATIONS +#define RGBLED_NUM 14 +#define RGBLIGHT_HUE_STEP 12 +#define RGBLIGHT_SAT_STEP 12 +#define RGBLIGHT_VAL_STEP 12 +#endif + + +/* Debounce reduces chatter (unintended double-presses) - set 0 if debouncing is not needed */ +#define DEBOUNCING_DELAY 5 + +/* define if matrix has ghost (lacks anti-ghosting diodes) */ +//#define MATRIX_HAS_GHOST + +/* number of backlight levels */ + +/* Mechanical locking support. Use KC_LCAP, KC_LNUM or KC_LSCR instead in keymap */ +#define LOCKING_SUPPORT_ENABLE +/* Locking resynchronize hack */ +#define LOCKING_RESYNC_ENABLE + +/* If defined, GRAVE_ESC will always act as ESC when CTRL is held. + * This is userful for the Windows task manager shortcut (ctrl+shift+esc). + */ +// #define GRAVE_ESC_CTRL_OVERRIDE + +/* + * Force NKRO + * + * Force NKRO (nKey Rollover) to be enabled by default, regardless of the saved + * state in the bootmagic EEPROM settings. (Note that NKRO must be enabled in the + * makefile for this to work.) + * + * If forced on, NKRO can be disabled via magic key (default = LShift+RShift+N) + * until the next keyboard reset. + * + * NKRO may prevent your keystrokes from being detected in the BIOS, but it is + * fully operational during normal computer usage. + * + * For a less heavy-handed approach, enable NKRO via magic key (LShift+RShift+N) + * or via bootmagic (hold SPACE+N while plugging in the keyboard). Once set by + * bootmagic, NKRO mode will always be enabled until it is toggled again during a + * power-up. + * + */ +//#define FORCE_NKRO + +/* + * Magic Key Options + * + * Magic keys are hotkey commands that allow control over firmware functions of + * the keyboard. They are best used in combination with the HID Listen program, + * found here: https://www.pjrc.com/teensy/hid_listen.html + * + * The options below allow the magic key functionality to be changed. This is + * useful if your keyboard/keypad is missing keys and you want magic key support. + * + */ + +/* key combination for magic key command */ +#define IS_COMMAND() ( \ + keyboard_report->mods == (MOD_BIT(KC_LSHIFT) | MOD_BIT(KC_RSHIFT)) \ +) + +/* control how magic key switches layers */ +//#define MAGIC_KEY_SWITCH_LAYER_WITH_FKEYS true +//#define MAGIC_KEY_SWITCH_LAYER_WITH_NKEYS true +//#define MAGIC_KEY_SWITCH_LAYER_WITH_CUSTOM false + +/* override magic key keymap */ +//#define MAGIC_KEY_SWITCH_LAYER_WITH_FKEYS +//#define MAGIC_KEY_SWITCH_LAYER_WITH_NKEYS +//#define MAGIC_KEY_SWITCH_LAYER_WITH_CUSTOM +//#define MAGIC_KEY_HELP1 H +//#define MAGIC_KEY_HELP2 SLASH +//#define MAGIC_KEY_DEBUG D +//#define MAGIC_KEY_DEBUG_MATRIX X +//#define MAGIC_KEY_DEBUG_KBD K +//#define MAGIC_KEY_DEBUG_MOUSE M +//#define MAGIC_KEY_VERSION V +//#define MAGIC_KEY_STATUS S +//#define MAGIC_KEY_CONSOLE C +//#define MAGIC_KEY_LAYER0_ALT1 ESC +//#define MAGIC_KEY_LAYER0_ALT2 GRAVE +//#define MAGIC_KEY_LAYER0 0 +//#define MAGIC_KEY_LAYER1 1 +//#define MAGIC_KEY_LAYER2 2 +//#define MAGIC_KEY_LAYER3 3 +//#define MAGIC_KEY_LAYER4 4 +//#define MAGIC_KEY_LAYER5 5 +//#define MAGIC_KEY_LAYER6 6 +//#define MAGIC_KEY_LAYER7 7 +//#define MAGIC_KEY_LAYER8 8 +//#define MAGIC_KEY_LAYER9 9 +//#define MAGIC_KEY_BOOTLOADER PAUSE +//#define MAGIC_KEY_LOCK CAPS +//#define MAGIC_KEY_EEPROM E +//#define MAGIC_KEY_NKRO N +//#define MAGIC_KEY_SLEEP_LED Z + +/* + * Feature disable options + * These options are also useful to firmware size reduction. + */ + +/* disable debug print */ +//#define NO_DEBUG + +/* disable print */ +//#define NO_PRINT + +/* disable action features */ +//#define NO_ACTION_LAYER +//#define NO_ACTION_TAPPING +//#define NO_ACTION_ONESHOT +//#define NO_ACTION_MACRO +//#define NO_ACTION_FUNCTION + +/* + * MIDI options + */ + +/* Prevent use of disabled MIDI features in the keymap */ +//#define MIDI_ENABLE_STRICT 1 + +/* enable basic MIDI features: + - MIDI notes can be sent when in Music mode is on +*/ +//#define MIDI_BASIC + +/* enable advanced MIDI features: + - MIDI notes can be added to the keymap + - Octave shift and transpose + - Virtual sustain, portamento, and modulation wheel + - etc. +*/ +//#define MIDI_ADVANCED + +/* override number of MIDI tone keycodes (each octave adds 12 keycodes and allocates 12 bytes) */ +//#define MIDI_TONE_KEYCODE_OCTAVES 1 + +/* + * HD44780 LCD Display Configuration + */ +/* +#define LCD_LINES 2 //< number of visible lines of the display +#define LCD_DISP_LENGTH 16 //< visibles characters per line of the display + +#define LCD_IO_MODE 1 //< 0: memory mapped mode, 1: IO port mode + +#if LCD_IO_MODE +#define LCD_PORT PORTB //< port for the LCD lines +#define LCD_DATA0_PORT LCD_PORT //< port for 4bit data bit 0 +#define LCD_DATA1_PORT LCD_PORT //< port for 4bit data bit 1 +#define LCD_DATA2_PORT LCD_PORT //< port for 4bit data bit 2 +#define LCD_DATA3_PORT LCD_PORT //< port for 4bit data bit 3 +#define LCD_DATA0_PIN 4 //< pin for 4bit data bit 0 +#define LCD_DATA1_PIN 5 //< pin for 4bit data bit 1 +#define LCD_DATA2_PIN 6 //< pin for 4bit data bit 2 +#define LCD_DATA3_PIN 7 //< pin for 4bit data bit 3 +#define LCD_RS_PORT LCD_PORT //< port for RS line +#define LCD_RS_PIN 3 //< pin for RS line +#define LCD_RW_PORT LCD_PORT //< port for RW line +#define LCD_RW_PIN 2 //< pin for RW line +#define LCD_E_PORT LCD_PORT //< port for Enable line +#define LCD_E_PIN 1 //< pin for Enable line +#endif +*/ + diff --git a/keyboards/kbd6x/info.json b/keyboards/kbd6x/info.json new file mode 100644 index 00000000000..201c6bd3cf7 --- /dev/null +++ b/keyboards/kbd6x/info.json @@ -0,0 +1,12 @@ +{ + "keyboard_name": "kbd6x", + "url": "", + "maintainer": "qmk", + "width": 15, + "height": 5, + "layouts": { + "LAYOUT": { + "layout": [{"label":"~", "x":0, "y":0}, {"label":"!", "x":1, "y":0}, {"label":"@", "x":2, "y":0}, {"label":"#", "x":3, "y":0}, {"label":"$", "x":4, "y":0}, {"label":"%", "x":5, "y":0}, {"label":"^", "x":6, "y":0}, {"label":"&", "x":7, "y":0}, {"label":"*", "x":8, "y":0}, {"label":"(", "x":9, "y":0}, {"label":")", "x":10, "y":0}, {"label":"_", "x":11, "y":0}, {"label":"+", "x":12, "y":0}, {"x":13, "y":0}, {"x":14, "y":0}, {"label":"Tab", "x":0, "y":1, "w":1.5}, {"label":"Q", "x":1.5, "y":1}, {"label":"W", "x":2.5, "y":1}, {"label":"E", "x":3.5, "y":1}, {"label":"R", "x":4.5, "y":1}, {"label":"T", "x":5.5, "y":1}, {"label":"Y", "x":6.5, "y":1}, {"label":"U", "x":7.5, "y":1}, {"label":"I", "x":8.5, "y":1}, {"label":"O", "x":9.5, "y":1}, {"label":"P", "x":10.5, "y":1}, {"label":"{", "x":11.5, "y":1}, {"label":"}", "x":12.5, "y":1}, {"label":"|", "x":13.5, "y":1, "w":1.5}, {"label":"Caps Lock", "x":0, "y":2, "w":1.75}, {"label":"A", "x":1.75, "y":2}, {"label":"S", "x":2.75, "y":2}, {"label":"D", "x":3.75, "y":2}, {"label":"F", "x":4.75, "y":2}, {"label":"G", "x":5.75, "y":2}, {"label":"H", "x":6.75, "y":2}, {"label":"J", "x":7.75, "y":2}, {"label":"K", "x":8.75, "y":2}, {"label":"L", "x":9.75, "y":2}, {"label":":", "x":10.75, "y":2}, {"label":"\"", "x":11.75, "y":2}, {"label":"Enter", "x":12.75, "y":2, "w":2.25}, {"label":"Shift", "x":0, "y":3, "w":2.25}, {"label":"Z", "x":2.25, "y":3}, {"label":"X", "x":3.25, "y":3}, {"label":"C", "x":4.25, "y":3}, {"label":"V", "x":5.25, "y":3}, {"label":"B", "x":6.25, "y":3}, {"label":"N", "x":7.25, "y":3}, {"label":"M", "x":8.25, "y":3}, {"label":"<", "x":9.25, "y":3}, {"label":">", "x":10.25, "y":3}, {"label":"?", "x":11.25, "y":3}, {"label":"Shift", "x":12.25, "y":3, "w":1.75}, {"x":14, "y":3}, {"label":"Ctrl", "x":0, "y":4, "w":1.5}, {"label":"Win", "x":1.5, "y":4}, {"label":"Alt", "x":2.5, "y":4, "w":1.5}, {"x":4, "y":4, "w":7}, {"label":"Alt", "x":11, "y":4, "w":1.5}, {"label":"Win", "x":12.5, "y":4}, {"label":"Ctrl", "x":13.5, "y":4, "w":1.5}] + } + } +} \ No newline at end of file diff --git a/keyboards/kbd6x/kbd6x.c b/keyboards/kbd6x/kbd6x.c new file mode 100644 index 00000000000..f558af0304b --- /dev/null +++ b/keyboards/kbd6x/kbd6x.c @@ -0,0 +1,49 @@ +/* Copyright 2018 MechMerlin + * + * This program is free software: you can redistribute it and/or modify + * it under the terms of the GNU General Public License as published by + * the Free Software Foundation, either version 2 of the License, or + * (at your option) any later version. + * + * This program is distributed in the hope that it will be useful, + * but WITHOUT ANY WARRANTY; without even the implied warranty of + * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the + * GNU General Public License for more details. + * + * You should have received a copy of the GNU General Public License + * along with this program. If not, see . + */ +#include "kbd6x.h" + +void matrix_init_kb(void) { + // put your keyboard start-up code here + // runs once when the firmware starts up + + matrix_init_user(); +} + +void matrix_scan_kb(void) { + // put your looping keyboard code here + // runs every cycle (a lot) + + matrix_scan_user(); +} + +bool process_record_kb(uint16_t keycode, keyrecord_t *record) { + // put your per-action keyboard code here + // runs for every action, just before processing by the firmware + + return process_record_user(keycode, record); +} + +void led_set_kb(uint8_t usb_led) { + if (usb_led & (1 << USB_LED_CAPS_LOCK)) { + DDRB |= (1 << 6); + PORTB &= ~(1 << 6); + } else { + DDRB &= ~(1 << 6); + PORTB &= ~(1 << 6); + } + + led_set_user(usb_led); +} \ No newline at end of file diff --git a/keyboards/kbd6x/kbd6x.h b/keyboards/kbd6x/kbd6x.h new file mode 100644 index 00000000000..3d0c70f77ab --- /dev/null +++ b/keyboards/kbd6x/kbd6x.h @@ -0,0 +1,36 @@ +/* Copyright 2018 MechMerlin + * + * This program is free software: you can redistribute it and/or modify + * it under the terms of the GNU General Public License as published by + * the Free Software Foundation, either version 2 of the License, or + * (at your option) any later version. + * + * This program is distributed in the hope that it will be useful, + * but WITHOUT ANY WARRANTY; without even the implied warranty of + * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the + * GNU General Public License for more details. + * + * You should have received a copy of the GNU General Public License + * along with this program. If not, see . + */ +#ifndef KBD6X_H +#define KBD6X_H + +#include "quantum.h" + +#define LAYOUT( \ + K00, K01, K02, K03, K04, K05, K06, K07, K08, K09, K0A, K0B, K0C, K0D, K4D,\ + K10, K11, K12, K13, K14, K15, K16, K17, K18, K19, K1A, K1B, K1C, K1D, \ + K20, K21, K22, K23, K24, K25, K26, K27, K28, K29, K2A, K2B, K2C, \ + K30, K31, K32, K33, K34, K35, K36, K37, K38, K39, K3A, K3B, K3C, \ + K40, K41, K42, K46, K4A, K4B, K4C \ +) \ +{ \ + { K00, K01, K02, K03, K04, K05, K06, K07, K08, K09, K0A, K0B, K0C, K0D }, \ + { K10, K11, K12, K13, K14, K15, K16, K17, K18, K19, K1A, K1B, K1C, K1D }, \ + { K20, K21, K22, K23, K24, K25, K26, K27, K28, K29, K2A, K2B, K2C, KC_NO }, \ + { K30, K31, K32, K33, K34, K35, K36, K37, K38, K39, K3A, K3B, K3C, KC_NO }, \ + { K40, K41, K42, KC_NO, KC_NO, KC_NO, K46, KC_NO, KC_NO, KC_NO, K4A, K4B, K4C, K4D }, \ +} + +#endif diff --git a/keyboards/kbd6x/keymaps/default/keymap.c b/keyboards/kbd6x/keymaps/default/keymap.c new file mode 100644 index 00000000000..fd73b1445f0 --- /dev/null +++ b/keyboards/kbd6x/keymaps/default/keymap.c @@ -0,0 +1,67 @@ +/* Copyright 2018 MechMerlin + * + * This program is free software: you can redistribute it and/or modify + * it under the terms of the GNU General Public License as published by + * the Free Software Foundation, either version 2 of the License, or + * (at your option) any later version. + * + * This program is distributed in the hope that it will be useful, + * but WITHOUT ANY WARRANTY; without even the implied warranty of + * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the + * GNU General Public License for more details. + * + * You should have received a copy of the GNU General Public License + * along with this program. If not, see . + */ +#include QMK_KEYBOARD_H + +const uint16_t PROGMEM keymaps[][MATRIX_ROWS][MATRIX_COLS] = { + [0] = LAYOUT( + KC_ESC, KC_1, KC_2, KC_3, KC_4, KC_5, KC_6, KC_7, KC_8, KC_9, KC_0, KC_MINS, KC_EQL, KC_BSLS, KC_DEL, + KC_TAB, KC_Q, KC_W, KC_E, KC_R, KC_T, KC_Y, KC_U, KC_I, KC_O, KC_P, KC_LBRC, KC_RBRC, KC_BSPC, + KC_CAPS, KC_A, KC_S, KC_D, KC_F, KC_G, KC_H, KC_J, KC_K, KC_L, KC_SCLN, KC_QUOT, KC_ENT, + KC_LSFT, KC_Z, KC_X, KC_C, KC_V, KC_B, KC_N, KC_M, KC_COMM, KC_DOT, KC_SLSH, KC_RSFT, MO(1), + KC_LCTL, KC_LGUI, KC_LALT, KC_SPACE, KC_RALT, KC_RGUI, KC_RCTL + ), + + [1] = LAYOUT( + KC_ESC, KC_F1, KC_F2, KC_F3, KC_F4, KC_F5, KC_F6, KC_F7, KC_F8, KC_F9, KC_F10, KC_F11, KC_F12, KC_TRNS, KC_TRNS, + KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS, + KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS, + KC_TRNS, KC_TRNS, KC_TRNS, BL_DEC, BL_TOGG, BL_INC, BL_STEP, KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS, + KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS + ), +}; + +const uint16_t PROGMEM fn_actions[] = { + +}; + +const macro_t *action_get_macro(keyrecord_t *record, uint8_t id, uint8_t opt) +{ + // MACRODOWN only works in this function + switch(id) { + case 0: + if (record->event.pressed) { + register_code(KC_RSFT); + } else { + unregister_code(KC_RSFT); + } + break; + } + return MACRO_NONE; +}; + + +void matrix_init_user(void) { + +} + +void matrix_scan_user(void) { + +} + +bool process_record_user(uint16_t keycode, keyrecord_t *record) { + return true; +} + diff --git a/keyboards/kbd6x/keymaps/default/readme.md b/keyboards/kbd6x/keymaps/default/readme.md new file mode 100644 index 00000000000..c416cd8fa72 --- /dev/null +++ b/keyboards/kbd6x/keymaps/default/readme.md @@ -0,0 +1 @@ +# The default keymap for kbd6x diff --git a/keyboards/kbd6x/readme.md b/keyboards/kbd6x/readme.md new file mode 100644 index 00000000000..625ec8968b2 --- /dev/null +++ b/keyboards/kbd6x/readme.md @@ -0,0 +1,12 @@ +# KBD6x + +A WKL Hot Swap Double USB C 60% + +Keyboard Maintainer: [MechMerlin](https://github.com/mechmerlin) +Hardware Supported: KBD6x PCB +Hardware Availability: [KBDFans](https://kbdfans.cn/products/kbd6x-wkl-hot-swap-60-double-type-c-pcb) +Make example for this keyboard (after setting up your build environment): + + make kbd6x:default + +See [build environment setup](https://docs.qmk.fm/build_environment_setup.html) then the [make instructions](https://docs.qmk.fm/make_instructions.html) for more information. diff --git a/keyboards/kbd6x/rules.mk b/keyboards/kbd6x/rules.mk new file mode 100644 index 00000000000..8f2e7e2adb1 --- /dev/null +++ b/keyboards/kbd6x/rules.mk @@ -0,0 +1,70 @@ +# MCU name +#MCU = at90usb1286 +MCU = atmega32u4 + +# Processor frequency. +# This will define a symbol, F_CPU, in all source code files equal to the +# processor frequency in Hz. You can then use this symbol in your source code to +# calculate timings. Do NOT tack on a 'UL' at the end, this will be done +# automatically to create a 32-bit value in your source code. +# +# This will be an integer division of F_USB below, as it is sourced by +# F_USB after it has run through any CPU prescalers. Note that this value +# does not *change* the processor frequency - it should merely be updated to +# reflect the processor speed set externally so that the code can use accurate +# software delays. +F_CPU = 16000000 + + +# +# LUFA specific +# +# Target architecture (see library "Board Types" documentation). +ARCH = AVR8 + +# Input clock frequency. +# This will define a symbol, F_USB, in all source code files equal to the +# input clock frequency (before any prescaling is performed) in Hz. This value may +# differ from F_CPU if prescaling is used on the latter, and is required as the +# raw input clock is fed directly to the PLL sections of the AVR for high speed +# clock generation for the USB and other AVR subsections. Do NOT tack on a 'UL' +# at the end, this will be done automatically to create a 32-bit value in your +# source code. +# +# If no clock division is performed on the input clock inside the AVR (via the +# CPU clock adjust registers or the clock division fuses), this will be equal to F_CPU. +F_USB = $(F_CPU) + +# Interrupt driven control endpoint task(+60) +OPT_DEFS += -DINTERRUPT_CONTROL_ENDPOINT + + +# Boot Section Size in *bytes* +# Teensy halfKay 512 +# Teensy++ halfKay 1024 +# Atmel DFU loader 4096 +# LUFA bootloader 4096 +# USBaspLoader 2048 +OPT_DEFS += -DBOOTLOADER_SIZE=4096 + + +# Build Options +# change yes to no to disable +# +BOOTMAGIC_ENABLE = no # Virtual DIP switch configuration(+1000) +MOUSEKEY_ENABLE = yes # Mouse keys(+4700) +EXTRAKEY_ENABLE = yes # Audio control and System control(+450) +CONSOLE_ENABLE = yes # Console for debug(+400) +COMMAND_ENABLE = yes # Commands for debug and configuration +# Do not enable SLEEP_LED_ENABLE. it uses the same timer as BACKLIGHT_ENABLE +SLEEP_LED_ENABLE = no # Breathing sleep LED during USB suspend +# if this doesn't work, see here: https://github.com/tmk/tmk_keyboard/wiki/FAQ#nkro-doesnt-work +NKRO_ENABLE = no # USB Nkey Rollover +BACKLIGHT_ENABLE = yes # Enable keyboard backlight functionality on B7 by default +MIDI_ENABLE = no # MIDI support (+2400 to 4200, depending on config) +UNICODE_ENABLE = no # Unicode +BLUETOOTH_ENABLE = no # Enable Bluetooth with the Adafruit EZ-Key HID +RGBLIGHT_ENABLE = yes +AUDIO_ENABLE = no # Audio output on port C6 +FAUXCLICKY_ENABLE = no # Use buzzer to emulate clicky switches +HD44780_ENABLE = no # Enable support for HD44780 based LCDs (+400) From 2b0f5d3beaecf67848d4326add039190d99bba26 Mon Sep 17 00:00:00 2001 From: Greg Bowler Date: Mon, 6 Aug 2018 16:37:46 +0100 Subject: [PATCH 15/17] Keyboard: Remap layout to match the actual keys sent from the tada68 board. (#3483) * Remap layout to match the actual keys sent from board. Fixes #3480 * Remap layer 1 --- keyboards/tada68/keymaps/iso-uk/keymap.c | 8 ++++---- keyboards/tada68/tada68.h | 8 ++++---- 2 files changed, 8 insertions(+), 8 deletions(-) diff --git a/keyboards/tada68/keymaps/iso-uk/keymap.c b/keyboards/tada68/keymaps/iso-uk/keymap.c index c843595dc34..d59f610f7cf 100644 --- a/keyboards/tada68/keymaps/iso-uk/keymap.c +++ b/keyboards/tada68/keymaps/iso-uk/keymap.c @@ -21,8 +21,8 @@ const uint16_t PROGMEM keymaps[][MATRIX_ROWS][MATRIX_COLS] = { */ [_BL] = LAYOUT_iso( KC_ESC, KC_1, KC_2, KC_3, KC_4, KC_5, KC_6, KC_7, KC_8, KC_9, KC_0, KC_MINS, KC_EQL, KC_BSPC, KC_GRV, \ - KC_TAB, KC_Q, KC_W, KC_E, KC_R, KC_T, KC_Y, KC_U, KC_I, KC_O, KC_P, KC_LBRC, KC_RBRC, KC_DEL, \ - KC_CAPS, KC_A, KC_S, KC_D, KC_F, KC_G, KC_H, KC_J, KC_K, KC_L, KC_SCLN, KC_QUOT, KC_NUHS, KC_ENT, KC_PGUP, \ + KC_TAB, KC_Q, KC_W, KC_E, KC_R, KC_T, KC_Y, KC_U, KC_I, KC_O, KC_P, KC_LBRC, KC_RBRC, KC_NUHS, KC_DEL, \ + KC_CAPS, KC_A, KC_S, KC_D, KC_F, KC_G, KC_H, KC_J, KC_K, KC_L, KC_SCLN, KC_QUOT, KC_ENT, KC_PGUP, \ KC_LSFT, KC_NUBS, KC_Z, KC_X, KC_C, KC_V, KC_B, KC_N, KC_M, KC_COMM, KC_DOT, KC_SLSH, KC_RSFT, KC_UP, KC_PGDN, \ KC_LCTL, KC_LGUI, KC_LALT, KC_SPC, KC_RALT, MO(_FL), KC_RCTL, KC_LEFT, KC_DOWN, KC_RGHT ), @@ -42,8 +42,8 @@ const uint16_t PROGMEM keymaps[][MATRIX_ROWS][MATRIX_COLS] = { */ [_FL] = LAYOUT_iso( _______, KC_F1, KC_F2, KC_F3, KC_F4, KC_F5, KC_F6, KC_F7, KC_F8, KC_F9, KC_F10, KC_F11, KC_F12, KC_DEL, KC_INS, \ - _______, _______, KC_UP, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, KC_HOME, \ - _______, KC_LEFT, KC_DOWN, KC_RGHT, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, KC_END, \ + _______, _______, KC_UP, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, KC_HOME, \ + _______, KC_LEFT, KC_DOWN, KC_RGHT, _______, _______, _______, _______, _______, _______, _______, _______, _______, KC_END, \ _______, _______, _______, _______, BL_DEC, BL_TOGG, BL_INC, _______, KC_VOLU, KC_VOLD, KC_MUTE, _______, KC_BTN1, KC_MS_U, KC_BTN2, \ _______, _______, _______, _______, _______, _______, _______, KC_MS_L, KC_MS_D, KC_MS_R ), diff --git a/keyboards/tada68/tada68.h b/keyboards/tada68/tada68.h index fc1bea98bfd..608f52e44fa 100755 --- a/keyboards/tada68/tada68.h +++ b/keyboards/tada68/tada68.h @@ -55,15 +55,15 @@ #define LAYOUT_iso( \ k00, k01, k02, k03, k04, k05, k06, k07, k08, k09, k0a, k0b, k0c, k0d, k0e, \ - k10, k11, k12, k13, k14, k15, k16, k17, k18, k19, k1a, k1b, k1c, k1e, \ - k20, k21, k22, k23, k24, k25, k26, k27, k28, k29, k2a, k2b, k2c, k2d, k2e, \ + k10, k11, k12, k13, k14, k15, k16, k17, k18, k19, k1a, k1b, k1c, k2c, k1e, \ + k20, k21, k22, k23, k24, k25, k26, k27, k28, k29, k2a, k2b, k2d, k2e, \ k30, k31, k32, k33, k34, k35, k36, k37, k38, k39, k3a, k3b, k3c, k3d, k3e, \ k40, k41, k42, k45, k49, k4a, k4b, k4c, k4d, k4e \ ) \ { \ {k00, k01, k02, k03, k04, k05, k06, k07, k08, k09, k0a, k0b, k0c, k0d, k0e}, \ - {k10, k11, k12, k13, k14, k15, k16, k17, k18, k19, k1a, k1b, k1c, XXX, k1e}, \ - {k20, k21, k22, k23, k24, k25, k26, k27, k28, k29, k2a, k2b, k2c, k2d, k2e}, \ + {k10, k11, k12, k13, k14, k15, k16, k17, k18, k19, k1a, k1b, k1c, k2c, k1e}, \ + {k20, k21, k22, k23, k24, k25, k26, k27, k28, k29, k2a, k2b, XXX, k2d, k2e}, \ {k30, k31, k32, k33, k34, k35, k36, k37, k38, k39, k3a, k3b, k3c, k3d, k3e}, \ {k40, k41, k42, XXX, XXX, k45, XXX, XXX, XXX, k49, k4a, k4b, k4c, k4d, k4e} \ } From 16d6fd6e8ec8e6423b600459298797c2f14f9647 Mon Sep 17 00:00:00 2001 From: Yan-Fa Li Date: Mon, 6 Aug 2018 08:40:00 -0700 Subject: [PATCH 16/17] Keyboard: Add Catch 22 Hotswap Macropad to QMK (#3576) * Initial Commit of catch22 macropad by rockydbull * Add configurator info.json * Use macros * Use pragma once * Use CA22 as product id * Clean up readme * Use the layer define value * Feedback from @drashna --- keyboards/catch22/README.md | 17 ++++++ keyboards/catch22/catch22.c | 18 +++++++ keyboards/catch22/catch22.h | 33 ++++++++++++ keyboards/catch22/config.h | 56 ++++++++++++++++++++ keyboards/catch22/info.json | 10 ++++ keyboards/catch22/keymaps/default/keymap.c | 31 +++++++++++ keyboards/catch22/rules.mk | 60 ++++++++++++++++++++++ 7 files changed, 225 insertions(+) create mode 100644 keyboards/catch22/README.md create mode 100644 keyboards/catch22/catch22.c create mode 100644 keyboards/catch22/catch22.h create mode 100644 keyboards/catch22/config.h create mode 100644 keyboards/catch22/info.json create mode 100644 keyboards/catch22/keymaps/default/keymap.c create mode 100644 keyboards/catch22/rules.mk diff --git a/keyboards/catch22/README.md b/keyboards/catch22/README.md new file mode 100644 index 00000000000..8d4a22398f1 --- /dev/null +++ b/keyboards/catch22/README.md @@ -0,0 +1,17 @@ +# Catch 22 Budget Hotswap Macropad + +GB by /u/rockydbull run in July 2018, PCB designed with help from /u/Kilgarah. + +Designed to be a budget project board to enjoy hotswapping/switch testing/macro making fun. The board is controlled by a pro micro clone made famous by other projects like the lets split, iris, and nyquist and allows for full QMK implementation. Each Catch22 kit will contain: + + * 2 pcbs (one to solder to and one to be a base)(green color) + * 1 pcb material switch plate( green color) with cut out for pcb mount cherry stabilizers + * 40 throughhole diodes (22 for the pcb and the remaining as extras in case you lose one and to use to make the pro micro removeable without desoldering) + * 22 Kailh hotswap sockets + * 1 smd reset button + * 1 dip socket to mount between the pcb and pro micro if you choose to make it removeable without desoldering + * 5 (12mm) m2 standoffs + * 10 m2 screws + * Genuine Cherry pcb mount 2u stabilizer + * 4 rubber bumpons + * Pro Micro is included in kit diff --git a/keyboards/catch22/catch22.c b/keyboards/catch22/catch22.c new file mode 100644 index 00000000000..11a983936e0 --- /dev/null +++ b/keyboards/catch22/catch22.c @@ -0,0 +1,18 @@ +/* +Copyright 2018 QMK Community + +This program is free software: you can redistribute it and/or modify +it under the terms of the GNU General Public License as published by +the Free Software Foundation, either version 2 of the License, or +(at your option) any later version. + +This program is distributed in the hope that it will be useful, +but WITHOUT ANY WARRANTY; without even the implied warranty of +MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the +GNU General Public License for more details. + +You should have received a copy of the GNU General Public License +along with this program. If not, see . +*/ + +#include "catch22.h" diff --git a/keyboards/catch22/catch22.h b/keyboards/catch22/catch22.h new file mode 100644 index 00000000000..6eefb9cd516 --- /dev/null +++ b/keyboards/catch22/catch22.h @@ -0,0 +1,33 @@ +/* +Copyright 2018 QMK Community + +This program is free software: you can redistribute it and/or modify +it under the terms of the GNU General Public License as published by +the Free Software Foundation, either version 2 of the License, or +(at your option) any later version. + +This program is distributed in the hope that it will be useful, +but WITHOUT ANY WARRANTY; without even the implied warranty of +MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the +GNU General Public License for more details. + +You should have received a copy of the GNU General Public License +along with this program. If not, see . +*/ +#pragma once + +#include "quantum.h" + +#define LAYOUT( \ + K01, K02, K03, K04, \ + K11, K12, K13, K14, \ +K20, K21, K22, K23, K24, \ +K30, K31, K32, K33, K34, \ + K41, K42, K43, K44 \ +) { \ + { KC_NO, K01, K02, K03, K04 }, \ + { KC_NO, K11, K12, K13, K14 }, \ + { K20, K21, K22, K23, K24 }, \ + { K30, K31, K32, K33, K34 }, \ + { KC_NO, K41, K42, K43, K44 }, \ +} diff --git a/keyboards/catch22/config.h b/keyboards/catch22/config.h new file mode 100644 index 00000000000..cb7ca7d84c4 --- /dev/null +++ b/keyboards/catch22/config.h @@ -0,0 +1,56 @@ +/* +Copyright 2018 QMK Contributors + +This program is free software: you can redistribute it and/or modify +it under the terms of the GNU General Public License as published by +the Free Software Foundation, either version 2 of the License, or +(at your option) any later version. + +This program is distributed in the hope that it will be useful, +but WITHOUT ANY WARRANTY; without even the implied warranty of +MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the +GNU General Public License for more details. + +You should have received a copy of the GNU General Public License +along with this program. If not, see . +*/ +#pragma once + +#include "config_common.h" + +/* USB Device descriptor parameter */ +#define VENDOR_ID 0xFEED +#define PRODUCT_ID 0xCA22 +#define DEVICE_VER 0x0001 +#define MANUFACTURER rockydbull +#define PRODUCT Catch22 Hotswap Macropad +#define DESCRIPTION Budget 22 Key Hotswap Macropad + +/* key matrix size */ +#define MATRIX_ROWS 5 +#define MATRIX_COLS 5 + +/* key matrix pins */ +#define MATRIX_ROW_PINS { B6, B2, B3, B1, F7 } +#define MATRIX_COL_PINS { B5, B4, E6, D7, C6 } +#define UNUSED_PINS { } + +/* COL2ROW or ROW2COL */ +#define DIODE_DIRECTION COL2ROW + +/* Set 0 if debouncing isn't needed */ +#define DEBOUNCING_DELAY 50 + +/* key combination for command */ +#define IS_COMMAND() ( \ + false \ +) + +/* prevent stuck modifiers */ +#define PREVENT_STUCK_MODIFIERS + +#ifdef RGBLIGHT_ENABLE +#define RGB_DI_PIN F6 +#define RGBLIGHT_ANIMATIONS +#define RGBLED_NUM 6 +#endif diff --git a/keyboards/catch22/info.json b/keyboards/catch22/info.json new file mode 100644 index 00000000000..eb95b8561dd --- /dev/null +++ b/keyboards/catch22/info.json @@ -0,0 +1,10 @@ +{ + "keyboard_name": "catch22", + "width": 5, + "height": 5, + "layouts": { + "LAYOUT": { + "layout": [{"label":"A", "x":1, "y":0}, {"label":"B", "x":2, "y":0}, {"label":"C", "x":3, "y":0}, {"label":"D", "x":4, "y":0}, {"label":"E", "x":1, "y":1}, {"label":"F", "x":2, "y":1}, {"label":"G", "x":3, "y":1}, {"label":"H", "x":4, "y":1}, {"label":"I", "x":0, "y":2}, {"label":"J", "x":1, "y":2}, {"label":"K", "x":2, "y":2}, {"label":"L", "x":3, "y":2}, {"label":"M", "x":4, "y":2}, {"label":"1", "x":0, "y":3, "h":2}, {"label":"N", "x":1, "y":3}, {"label":"O", "x":2, "y":3}, {"label":"P", "x":3, "y":3}, {"label":"Q", "x":4, "y":3}, {"label":"R", "x":1, "y":4}, {"label":"S", "x":2, "y":4}, {"label":"T", "x":3, "y":4}, {"label":"U", "x":4, "y":4}] + } + } +} diff --git a/keyboards/catch22/keymaps/default/keymap.c b/keyboards/catch22/keymaps/default/keymap.c new file mode 100644 index 00000000000..f0300d27fe6 --- /dev/null +++ b/keyboards/catch22/keymaps/default/keymap.c @@ -0,0 +1,31 @@ +#include QMK_KEYBOARD_H + +#define _BASE 0 +#define _FN 1 + +#define _______ KC_TRNS + +const uint16_t PROGMEM keymaps[][MATRIX_ROWS][MATRIX_COLS] = { +[_BASE] = LAYOUT( /* Base */ + KC_A, KC_B, KC_C, KC_D, \ + KC_E, KC_F, KC_G, KC_H, \ + MO(_FN), KC_I, KC_J, KC_K, KC_L, \ + KC_1, KC_M, KC_N, KC_O, KC_P, \ + KC_Q, KC_R, KC_S, KC_T \ +), +[_FN] = LAYOUT( + RGB_TOG, RGB_MOD, RGB_HUI, RGB_HUI, \ + _______, _______, _______, _______, \ + _______, _______, _______, _______, _______, \ + KC_2, _______, _______, _______, _______, \ + _______, _______, _______, _______ \ +), +}; + +const uint16_t PROGMEM fn_actions[] = { +}; + +const macro_t *action_get_macro(keyrecord_t *record, uint8_t id, uint8_t opt) // MACRODOWN only works in this function +{ + return MACRO_NONE; +}; diff --git a/keyboards/catch22/rules.mk b/keyboards/catch22/rules.mk new file mode 100644 index 00000000000..2b76e465cfc --- /dev/null +++ b/keyboards/catch22/rules.mk @@ -0,0 +1,60 @@ +# MCU name +MCU = atmega32u4 + +# Processor frequency. +# This will define a symbol, F_CPU, in all source code files equal to the +# processor frequency in Hz. You can then use this symbol in your source code to +# calculate timings. Do NOT tack on a 'UL' at the end, this will be done +# automatically to create a 32-bit value in your source code. +# +# This will be an integer division of F_USB below, as it is sourced by +# F_USB after it has run through any CPU prescalers. Note that this value +# does not *change* the processor frequency - it should merely be updated to +# reflect the processor speed set externally so that the code can use accurate +# software delays. +F_CPU = 16000000 + +# +# LUFA specific +# +# Target architecture (see library "Board Types" documentation). +ARCH = AVR8 + +# Input clock frequency. +# This will define a symbol, F_USB, in all source code files equal to the +# input clock frequency (before any prescaling is performed) in Hz. This value may +# differ from F_CPU if prescaling is used on the latter, and is required as the +# raw input clock is fed directly to the PLL sections of the AVR for high speed +# clock generation for the USB and other AVR subsections. Do NOT tack on a 'UL' +# at the end, this will be done automatically to create a 32-bit value in your +# source code. +# +# If no clock division is performed on the input clock inside the AVR (via the +# CPU clock adjust registers or the clock division fuses), this will be equal to F_CPU. +F_USB = $(F_CPU) + +# Bootloader +BOOTLOADER = caterina + +# Interrupt driven control endpoint task(+60) +OPT_DEFS += -DINTERRUPT_CONTROL_ENDPOINT + + +# Boot Section Size in *bytes* +#OPT_DEFS += -DBOOTLOADER_SIZE=4096 + + +# Build Options +# comment out to disable the options. +# +BOOTMAGIC_ENABLE = no # Virtual DIP switch configuration(+1000) +MOUSEKEY_ENABLE = no # Mouse keys(+4700) +EXTRAKEY_ENABLE = no # Audio control and System control(+450) +CONSOLE_ENABLE = yes # Console for debug(+400) +COMMAND_ENABLE = yes # Commands for debug and configuration +SLEEP_LED_ENABLE = no # Breathing sleep LED during USB suspend +NKRO_ENABLE = no # USB Nkey Rollover - if this doesn't work, see here: https://github.com/tmk/tmk_keyboard/wiki/FAQ#nkro-doesnt-work +BACKLIGHT_ENABLE = no # Custom backlighting code is used, so this should not be enabled +AUDIO_ENABLE = no # This can be enabled if a speaker is connected to the expansion port. Not compatible with RGBLIGHT below +RGBLIGHT_ENABLE = yes # This can be enabled if a ws2812 strip is connected to the expansion port. + From d8e6ada5d70a4db9b7bffe591923f1368a0131f1 Mon Sep 17 00:00:00 2001 From: fauxpark Date: Wed, 8 Aug 2018 02:07:19 +1000 Subject: [PATCH 17/17] Improve RGB lighting documentation (#3580) --- docs/feature_rgblight.md | 241 ++++++++++++++++++--------------------- 1 file changed, 114 insertions(+), 127 deletions(-) diff --git a/docs/feature_rgblight.md b/docs/feature_rgblight.md index e0918d11bdd..d48941a04f2 100644 --- a/docs/feature_rgblight.md +++ b/docs/feature_rgblight.md @@ -1,131 +1,46 @@ # RGB Lighting -If you've installed addressable RGB lights on your keyboard you can control them with QMK. Currently we support the following addressable LEDs on Atmel AVR processors: +QMK has the ability to control RGB LEDs attached to your keyboard. This is commonly called *underglow*, due to the LEDs often being mounted on the bottom of the keyboard, producing a nice diffused effect when combined with a translucent case. -* WS2811 and variants (WS2812, WS2812B, WS2812C, etc) -* SK6812RGBW +![Planck with RGB Underglow](https://raw.githubusercontent.com/qmk/qmk_firmware/3774a7fcdab5544fc787f4c200be05fcd417e31f/keyboards/planck/keymaps/yang/planck-with-rgb-underglow.jpg) -Some keyboards come with RGB LEDs pre-installed. Others have to have LEDs installed after the fact. See below for information on modifying your keyboard. +Some keyboards come with RGB LEDs preinstalled. Others must have them installed after the fact. See the [Hardware Modification](#hardware-modification) section for information on adding RGB lighting to your keyboard. -## Selecting Colors +Currently QMK supports the following addressable LEDs on AVR microcontrollers (however, the white LED in RGBW variants is not supported): -QMK uses Hue, Saturation, and Value to set color rather than using RGB. You can use the color wheel below to see how this works. Changing the Hue will cycle around the circle. Saturation will affect the intensity of the color, which you can see as you move from the inner part to the outer part of the wheel. Value sets the overall brightness. + * WS2811, WS2812, WS2812B, WS2812C, etc. + * SK6812, SK6812MINI, SK6805 -HSV Color Wheel +These LEDs are called "addressable" because instead of using a wire per color, each LED contains a small microchip that understands a special protocol sent over a single wire. The chip passes on the remaining data to the next LED, allowing them to be chained together. In this way, you can easily control the color of the individual LEDs. -If you would like to learn more about HSV you can start with the [Wikipedia article](https://en.wikipedia.org/wiki/HSL_and_HSV). +## Usage -## Configuration +On keyboards with onboard RGB LEDs, it is usually enabled by default. If it is not working for you, check that your `rules.mk` includes the following: -Before RGB Lighting can be used you have to enable it in `rules.mk`: - - RGBLIGHT_ENABLE = yes - -You can configure the behavior of the RGB lighting by defining values inside `config.h`. - -### Required Configuration - -At minimum you have to define the pin your LED strip is connected to and the number of LEDs connected. - -```c -#define RGB_DI_PIN D7 // The pin the LED strip is connected to -#define RGBLED_NUM 14 // Number of LEDs in your strip +```make +RGBLIGHT_ENABLE = yes ``` -### Optional Configuration +At minimum you must define the data pin your LED strip is connected to, and the number of LEDs in the strip, in your `config.h`. If your keyboard has onboard RGB LEDs, and you are simply creating a keymap, you usually won't need to modify these. -You can change the behavior of the RGB Lighting by setting these configuration values. Use `#define