qmk_firmware

QMK firmware for my keyboards (Corne, Sweep Ferris) and trackball (Ploopy Adept)
Log | Files | Refs | Submodules | LICENSE

readme.md (8653B)


      1 # Dactyl Kinesis
      2 
      3 Essentially a Dactyl CC physical key layout with an additional top row, further emulating the Kinesis Advantage (*1|2*) physical key layout.
      4 
      5 * Keyboard Maintainer: [dmik](https://github.com/dmik)
      6 * Hardware Supported: Pro Micro controller, or clone of
      7 
      8 Make example for this keyboard (after setting up your build environment):
      9 
     10     make handwired/dactyl_kinesis:default
     11 
     12 Flashing example for this keyboard:
     13 
     14     make handwired/dactyl_kinesis:default:flash
     15 
     16 See the [build environment setup](https://docs.qmk.fm/#/getting_started_build_tools) and the [make instructions](https://docs.qmk.fm/#/getting_started_make_guide) for more information. Brand new to QMK? Start with our [Complete Newbs Guide](https://docs.qmk.fm/#/newbs).
     17 
     18 ## Kinesis Advantage Keymap
     19 
     20 ### About
     21 
     22 This keymap is designed after Kinesis Advantage's QWERTY layout with the following key differences:
     23  - There are only 10 F-keys in the main layer, F1 and F2 are moved to additional LOWER layer.
     24  - The INS key acts like a LOWER layer activation key and Del in LOWER layer ats like INS.
     25  - LCtl is placed where CAPS should be and CAPS is moved to a free key after F10.
     26  - Brigtness and volume control keys are added to LOWER layer.
     27 
     28  The keymap file also contains RAISE layer but it is currently equivalent to LOWER layer and does
     29  not have an activation key mapped. It is intended for possible extensions.
     30 
     31 ### Keymap
     32 
     33        Main QUERTY layer:
     34        ,-------------------------------------------.                           ,-------------------------------------------.
     35        | ESC    |  F1  |  F2  |  F3  |  F4  |  F5  |                           |  F6  |  F7  |  F8  |  F9  |  F10 | CAPS   |
     36        |--------+------+------+------+------+------|                           |------+------+------+------+------+--------|
     37        | =      |   1  |   2  |   3  |   4  |   5  |                           |   6  |   7  |   8  |   9  |   0  |   -    |
     38        |--------+------+------+------+------+------|                           |------+------+------+------+------+--------|
     39        | Tab    |   Q  |   W  |   E  |   R  |   T  |                           |   Y  |   U  |   I  |   O  |   P  |   \    |
     40        |--------+------+------+------+------+------|                           |------+------+------+------+------+--------|
     41        | LCtl   |   A  |   S  |   D  |   F  |   G  |                           |   H  |   J  |   K  |   L  |   ;  |   '    |
     42        |--------+------+------+------+------+------|                           |------+------+------+------+------+--------|
     43        | LShift |   Z  |   X  |   C  |   V  |   B  |                           |   N  |   M  |   ,  |   .  |   /  | RShift |
     44        `--------+------+------+------+------+------'                           `------+------+------+------+------+--------'
     45                 |   `  | LOWER| Left | Rght |                                         |  Up  |  Dn  |   [  |   ]  |
     46                 `---------------------------'                                         `---------------------------'
     47                                                ,-------------.      ,-------------.
     48                                                | LGui | LAlt |      | RCtl | RGui |
     49                                         ,------|------|------|      |------+------+------.
     50                                         |      |      | Home |      | PgUp |      |      |
     51                                         | BkSp | Del  |------|      |------|Enter |Space |
     52                                         |      |      | End  |      | PgDn |      |      |
     53                                         `--------------------'      `--------------------'
     54 
     55        LOWER layer:
     56        ,-------------------------------------------.                           ,-------------------------------------------.
     57        |        |  F11 |  F12 |      |      |      |                           |BriDn |BriUp |VMute |VolDn |VolUp |        |
     58        |--------+------+------+------+------+------|                           |------+------+------+------+------+--------|
     59        |        |      |      |      |      |      |                           |      |      |      |      |      |        |
     60        |--------+------+------+------+------+------|                           |------+------+------+------+------+--------|
     61        |        |      |      |      |      |      |                           |      |      |      |      |      |        |
     62        |--------+------+------+------+------+------|                           |------+------+------+------+------+--------|
     63        |        |      |      |      |      |      |                           |      |      |      |      |      |        |
     64        |--------+------+------+------+------+------|                           |------+------+------+------+------+--------|
     65        |        |      |      |      |      |      |                           |      |      |      |      |      |        |
     66        `--------+------+------+------+------+------'                           `------+------+------+------+------+--------'
     67                 |      |      |      |      |                                         |      |      |      |      |
     68                 `---------------------------'                                         `---------------------------'
     69                                                ,-------------.      ,-------------.
     70                                                |      |      |      |      |      |
     71                                         ,------|------|------|      |------+------+------.
     72                                         |      |      |      |      |      |      |      |
     73                                         |      | INS  |------|      |------|      |      |
     74                                         |      |      |      |      |      |      |      |
     75                                         `--------------------'      `--------------------'
     76 
     77 ### Key Matrix Wiring
     78 
     79 The below picture shows correspondence between the keys and the row/column wires of the left and
     80 right halves:
     81 
     82        ,-------------------------------------------.                           ,-------------------------------------------.
     83        |  L00   | L01  | L02  | L03  | L04  | L05  |                           | R00  | R01  | R02  | R03  | R04  |  R05   |
     84        |--------+------+------+------+------+------|                           |------+------+------+------+------+--------|
     85        |  L10   | L11  | L12  | L13  | L14  | L15  |                           | R10  | R11  | R12  | R13  | R14  |  R15   |
     86        |--------+------+------+------+------+------|                           |------+------+------+------+------+--------|
     87        |  L20   | L21  | L22  | L23  | L24  | L25  |                           | R20  | R21  | R22  | R23  | R24  |  R25   |
     88        |--------+------+------+------+------+------|                           |------+------+------+------+------+--------|
     89        |  L30   | L31  | L32  | L33  | L34  | L35  |                           | R30  | R31  | R32  | R33  | R34  |  R35   |
     90        |--------+------+------+------+------+------|                           |------+------+------+------+------+--------|
     91        |  L40   | L41  | L42  | L43  | L44  | L45  |                           | R40  | R41  | R42  | R43  | R44  |  R45   |
     92        `--------+------+------+------+------+------'                           `------+------+------+------+------+--------'
     93                 | L50  | L51  | L52  | L53  |                                         | R52  | R53  | R54  | R55  |
     94                 `---------------------------'                                         `---------------------------'
     95                                                ,-------------.      ,-------------.
     96                                                | L64  | L65  |      | R60  | R61  |
     97                                         ,------|------|------|      |------+------+------.
     98                                         |      |      | L63  |      | R62  |      |      |
     99                                         | L54  | L55  |------|      |------| R50  | R51  |
    100                                         |      |      | L62  |      | R63  |      |      |
    101                                         `--------------------'      `--------------------'
    102 
    103 ## Bootloader
    104 
    105 Enter the bootloader in 3 ways:
    106 
    107 * **Bootmagic reset**: Hold down the key at (0,0) in the matrix (usually the top left key or Escape) and plug in the keyboard
    108 * **Physical reset button**: Briefly press the button on the back of the PCB - some may have pads you must short instead
    109 * **Keycode in layout**: Press the key mapped to `QK_BOOT` if it is available