keyboard/planck/PCB_GUIDE.md

   1 # Planck Firmware Guide
   2
   3 ## Setting up the environment
   4
   5 ### Windows
   6 1. Install [WinAVR Tools](http://sourceforge.net/projects/winavr/) for AVR GCC compiler.
   7 2. Install [DFU-Programmer][dfu-prog] (the -win one).
   8 3. Start DFU bootloader on the chip first time you will see 'Found New Hardware Wizard' to install driver. If you install device driver properly you can find chip name like 'ATmega32U4' under 'LibUSB-Win32 Devices' tree on 'Device Manager'. If not you will need to update its driver on 'Device Manager' to the `dfu-programmer` driver.
   9
  10 ### Mac
  11
  12 If you're using homebrew, you can use the following commands:
  13
  14     brew tap osx-cross/avr
  15     brew install avr-libc
  16
  17 Otherwise, these instructions will work:
  18
  19 1. Install Xcode from the App Store.
  20 2. Install the Command Line Tools from `Xcode->Preferences->Downloads`.
  21 3. Install [DFU-Programmer][dfu-prog].
  22
  23 ### Linux
  24 1. Install AVR GCC with your favorite package manager.
  25 2. Install [DFU-Programmer][dfu-prog].
  26
  27 ## Verify Your Installation
  28 1. Clone the following repository: https://github.com/jackhumbert/qmk_firmware
  29 2. Open a Terminal and `cd` into `qmk_firmware/keyboard/planck`
  30 3. Run `make`. This should output a lot of information about the build process.
  31
  32 ## Using the built-in functions
  33
  34 Here is a list of some of the functions available from the command line:
  35
  36 * `make clean`: clean the environment - may be required in-between builds
  37 * `make`: compile the code
  38 * `make KEYMAP=<keymap>`: compile with the extended keymap file `extended_keymaps/extended_keymap_<keymap>.c`
  39 * `make dfu`: build and flash the layout to the PCB
  40 * `make dfu-force`: build and force-flash the layout to the PCB (may be require for first flash)
  41
  42 Generally, the instructions to flash the PCB are as follows:
  43
  44 1. Make changes to the appropriate keymap file
  45 2. Save the file
  46 3. `make clean`
  47 4. Press the reset button on the PCB/press the key with the `RESET` keycode
  48 5. `make <arguments> dfu` - use the necessary `KEYMAP=<keymap>` and/or `COMMON=true` arguments here.
  49
  50 ## Quantum MK Firmware
  51
  52 ### Keymap
  53
  54 Unlike the other keymaps, prefixing the keycodes with `KC_` is required. A full list of the keycodes is available [here](https://github.com/jackhumbert/qmk_firmware/blob/master/tmk_core/doc/keycode.txt). For the keycodes available only in the extended keymap, see this [header file](https://github.com/jackhumbert/qmk_firmware/blob/master/quantum/keymap_common.h).
  55
  56 You can use modifiers with keycodes like this:
  57
  58     LCTL(KC_C)
  59
  60 Which will generate Ctrl+c. These are daisy-chainable, meaning you can do things like:
  61
  62     LCTL(LALT(KC_C))
  63
  64 That will generate Ctrl+Alt+c. The entire list of these functions is here:
  65
  66 * `LCTL()`: Left control
  67 * `LSFT()` / `S()`: Left shift
  68 * `LALT()`: Left alt/opt
  69 * `LGUI()`: Left win/cmd
  70 * `RCTL()`: Right control
  71 * `RSFT()`: Right shift
  72 * `RALT()`: Right alt/opt
  73 * `RGUI()`: Right win/cmd
  74
  75 `S(KC_1)`-like entries are useful in writing keymaps for the Planck.
  76
  77 ### Other keycodes
  78
  79 A number of other keycodes have been added that you may find useful:
  80
  81 * `CM_<key>`: the Colemak equivalent of a key (in place of `KC_<key>`), when using Colemak in software (`CM_O` generates `KC_SCLN`)
  82 * `RESET`: jump to bootloader for flashing (same as press the reset button)
  83 * `BL_STEP`: step through the backlight brightnesses
  84 * `BL_<0-15>`: set backlight brightness to 0-15
  85 * `BL_DEC`: lower the backlight brightness
  86 * `BL_INC`: raise the backlight brightness
  87 * `BL_TOGG`: toggle the backlight on/off
  88
  89 ### Function layers
  90
  91 The extended keymap extends the number of function layers from 32 to the near-infinite value of 256. Rather than using `FN<num>` notation (still available, but limited to `FN0`-`FN31`), you can use the `FUNC(<num>)` notation. `F(<num>)` is a shortcut for this.
  92
  93 The function actions are unchanged, and you can see the full list of them [here](https://github.com/jackhumbert/tmk_keyboard/blob/master/common/action_code.h). They are explained in detail [here](https://github.com/jackhumbert/tmk_keyboard/blob/master/doc/keymap.md#2-action).
  94
  95 ### Macros
  96
  97 Macros have been setup in the `keymaps/keymap_default.c` file so that you can use `M(<num>)` to access a macro in the `action_get_macro` section on your keymap. The switch/case structure you see here is required, and is setup for `M(0)` - you'll need to copy and paste the code to look like this (e.g. to support `M(3)`):
  98
  99     switch(id) {
 100       case 0:
 101         return MACRODOWN(TYPE(KC_A), END);
 102         break;
 103       case 1:
 104         return MACRODOWN(TYPE(KC_B), END);
 105         break;
 106       case 2:
 107         return MACRODOWN(TYPE(KC_C), END);
 108         break;
 109       case 3:
 110         return MACRODOWN(TYPE(KC_D), END);
 111         break;
 112     }
 113     return MACRO_NONE;
 114
 115 `MACRODOWN()` is a shortcut for `(record->event.pressed ? MACRO(__VA_ARGS__) : MACRO_NONE)` which tells the macro to execute when the key is pressed. Without this, the macro will be executed on both the down and up stroke.
 116
 117 [cygwin]:       https://www.cygwin.com/
 118 [mingw]:        http://www.mingw.org/
 119 [mhv]:          https://infernoembedded.com/products/avr-tools
 120 [winavr]:       http://winavr.sourceforge.net/
 121 [crosspack]:    http://www.obdev.at/products/crosspack/index.html
 122 [dfu-prog]:     http://dfu-programmer.sourceforge.net/