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 1. Install Xcode from the App Store.
  12 2. Install the Command Line Tools from `Xcode->Preferences->Downloads`.
  13 3. Install [DFU-Programmer][dfu-prog].
  14
  15 ### Linux
  16 1. Install AVR GCC with your favorite package manager.
  17 2. Install [DFU-Programmer][dfu-prog].
  18
  19 ## Verify Your Installation
  20 1. Clone the following repository: https://github.com/jackhumbert/qmk_firmware
  21 2. Open a Terminal and `cd` into `qmk_firmware/keyboard/planck`
  22 3. Run `make`. This should output a lot of information about the build process.
  23
  24 ## Using the built-in functions
  25
  26 Here is a list of some of the functions available from the command line:
  27
  28 * `make clean`: clean the environment - may be required in-between builds
  29 * `make`: compile the code
  30 * `make KEYMAP=<keymap>`: compile with the extended keymap file `extended_keymaps/extended_keymap_<keymap>.c`
  31 * `make dfu`: build and flash the layout to the PCB
  32 * `make dfu-force`: build and force-flash the layout to the PCB (may be require for first flash)
  33
  34 Generally, the instructions to flash the PCB are as follows:
  35
  36 1. Make changes to the appropriate keymap file
  37 2. Save the file
  38 3. `make clean`
  39 4. Press the reset button on the PCB/press the key with the `RESET` keycode
  40 5. `make <arguments> dfu` - use the necessary `KEYMAP=<keymap>` and/or `COMMON=true` arguments here.
  41
  42 ## Quantum MK Firmware
  43
  44 ### Keymap
  45
  46 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/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).
  47
  48 You can use modifiers with keycodes like this:
  49
  50     LCTL(KC_C)
  51
  52 Which will generate Ctrl+c. These are daisy-chainable, meaning you can do things like:
  53
  54     LCTL(LALT(KC_C))
  55
  56 That will generate Ctrl+Alt+c. The entire list of these functions is here:
  57
  58 * `LCTL()`: Left control
  59 * `LSFT()` / `S()`: Left shift
  60 * `LALT()`: Left alt/opt
  61 * `LGUI()`: Left win/cmd
  62 * `RCTL()`: Right control
  63 * `RSFT()`: Right shift
  64 * `RALT()`: Right alt/opt
  65 * `RGUI()`: Right win/cmd
  66
  67 `S(KC_1)`-like entries are useful in writing keymaps for the Planck.
  68
  69 ### Other keycodes
  70
  71 A number of other keycodes have been added that you may find useful:
  72
  73 * `CM_<key>`: the Colemak equivalent of a key (in place of `KC_<key>`), when using Colemak in software (`CM_O` generates `KC_SCLN`)
  74 * `RESET`: jump to bootloader for flashing (same as press the reset button)
  75 * `BL_STEP`: step through the backlight brightnesses
  76 * `BL_<0-15>`: set backlight brightness to 0-15
  77 * `BL_DEC`: lower the backlight brightness
  78 * `BL_INC`: raise the backlight brightness
  79 * `BL_TOGG`: toggle the backlight on/off
  80
  81 ### Function layers
  82
  83 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.
  84
  85 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).
  86
  87 ### Macros
  88
  89 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)`):
  90
  91     switch(id) {
  92       case 0:
  93         return MACRODOWN(TYPE(KC_A), END);
  94         break;
  95       case 1:
  96         return MACRODOWN(TYPE(KC_B), END);
  97         break;
  98       case 2:
  99         return MACRODOWN(TYPE(KC_C), END);
 100         break;
 101       case 3:
 102         return MACRODOWN(TYPE(KC_D), END);
 103         break;
 104     }
 105     return MACRO_NONE;
 106
 107 `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.
 108
 109 [cygwin]:       https://www.cygwin.com/
 110 [mingw]:        http://www.mingw.org/
 111 [mhv]:          https://infernoembedded.com/products/avr-tools
 112 [winavr]:       http://winavr.sourceforge.net/
 113 [crosspack]:    http://www.obdev.at/products/crosspack/index.html
 114 [dfu-prog]:     http://dfu-programmer.sourceforge.net/