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