qmk_firmware/keyboards/handwired/dactyl_manuform
Duncan Sutherland 29ffe804b8
Modernize `dactyl_manuform/dmote` keyboard (#20427)
Co-authored-by: Ryan <fauxpark@gmail.com>
2023-09-20 19:10:59 -07:00
..
4x5 Move `RGBLED_NUM` to data driven (#21278) 2023-06-18 14:39:07 +10:00
4x5_5 update layouts of `dactyl_manuform/4x5_5` (#21094) 2023-07-08 00:35:54 +10:00
4x6 Move `RGBLED_NUM` to data driven (#21278) 2023-06-18 14:39:07 +10:00
4x6_5 Move `RGBLED_NUM` to data driven (#21278) 2023-06-18 14:39:07 +10:00
5x6 RGB Matrix: driver naming cleanups (#21594) 2023-08-23 01:00:03 +01:00
5x6_2_5 Move miscellaneous layouts to data driven (#20516) 2023-04-25 02:38:35 +10:00
5x6_5 OLED: driver naming cleanups (#21710) 2023-08-15 10:30:34 +01:00
5x6_6 Move split layouts to data driven (#20290) 2023-04-01 13:09:53 +11:00
5x6_68 Modernize, correct, and uniform `dactyl_manuform` variant `5x6_68` (#21299) 2023-07-08 00:51:52 +10:00
5x7 Move `RGBLED_NUM` to data driven (#21278) 2023-06-18 14:39:07 +10:00
6x6 Move `RGBLED_NUM` to data driven (#21278) 2023-06-18 14:39:07 +10:00
6x6_4 Move `RGBLED_NUM` to data driven (#21278) 2023-06-18 14:39:07 +10:00
6x7 [Keyboard] `dactyl_manuform/6x7` pin correction (#21240) 2023-06-14 22:06:18 -06:00
config.h Move `SOFT_SERIAL_PIN` to data driven (#19863) 2023-02-17 16:40:49 +11:00
readme.md Revamp `dactyl_manuform` readme.md (#20395) 2023-07-08 00:25:32 +10:00

readme.md

Dactyl ManuForm

Imgur
Pair of Dactyl Manuform 4x6

Forked from the Dactyl, the Dactyl ManuForm is a parameterized, handwired, split bodied, tented, concave key-well design that incorporates the thumb cluster from the ManuForm.

  • Keyboard Maintainer: Tom Short
  • Hardware Supported: Pro Micro, or clone of
  • Hardware Availability: Github

Variants

Dactyl ManuForm's are built in variations that cater for different row and column counts, and thumb clusters.

As standard:

  • The finger keywell bottom row has 2 keys, 1 each in ring and middle columns
    • Exception to this rule is the 5x7 variant - that has two additional keys, per half, in this row
  • The thumb cluster has 6 keys, arranged in a staggered 2 columns by 3 rows

Variants are denoted as RowCountxColumnCount(_Alteration)

Row

Count Description
4 Three rows, typically for alphabet and some puncuation characters, with 2 key (finger keywell) bottom row
5 As 4 row with number row above
6 As 5 row with function row above

Column

Count Description
5 A column for each finger with additional column for first finger
6 As 5 column with additional pinky finger column
7 As 6 column with either an additional first finger column (5x7) or additional pinky column (6x7)

Alteration

Code Description
5 Thumb cluster replaced with five key thumb cluster of Dactyl Manuform Mini
2_5 Same as code 5 with two additional keys added to finger key-well bottom row

Case Files Generator

Dactyl Generator, created by rianadon, is a web based file generator that negates having to compose case files using programming languages, which was the matter when using the original Dactyl and Dactyl ManuForm GitHub repos, by instead compiling case files based on options and parameters configured in a web front end.

Compile

Make example for this keyboard (after setting up your build environment) in the 5x6 variant:

make handwired/dactyl_manuform/5x6:default

Flashing example for this keyboard:

make handwired/dactyl_manuform/5x6:default:flash

See the build environment setup and the make instructions for more information. Brand new to QMK? Start with our Complete Newbs Guide.

Keymaps

Default

The default functional layout, based on QWERTY, and every variant has this keymap; used as a starting point/template for custom keymaps and for debugging purposes when soldering key matrix to controller.

VIA

Similar to Default but adds support for the VIA keymap configurator. Layer count set to 4 to comply with VIA defaults, and remaps keys to accommodate this constraint, if applicable.

Variants with VIA support:

  • 4x6
  • 5x6_5
  • 5x7

Miryoku

For more information on this layout schematic, please see the Miryoku Reference Manual.
For QMK specifics, please see Miryoku QMK.

Variants with Miryoku support:

  • 4x5
  • 4x5_5
  • 4x6
  • 4x6_5
  • 5x6

Non-Pro Micro Controller Compilation

If building a Dactyl Manuform with controllers that aren't a pro micro, the Converter feature of QMK will allow compilation of firmware for the intended variant and supported controller without having to create a new QMK keyboard/keymap.
Please see Converters documentation for list of controllers that are supported converting from pro_micro and how to implement conversion.

Flashing

To flash your board with generated firmware file, please see Flashing Instructions and Bootloader Information

Handedness configurations

See Handedness documentation for more information on configuring handedness/master half.

VIA Configuration

Variants with a via keymap are VIA capable. Compile firmware, for enabled variant, with it's via keymap and flash board with this firmware file.

qmk compile -kb handwired/dactyl_manuform/4x6 -km via

Bootloader

Enter the bootloader in 3 ways:

  • Bootmagic reset: If enabled, hold down the key at (0,0) in the matrix (usually the top left key or Escape) and plug in the keyboard
  • Physical reset button: Briefly press the button on the back of the PCB or controller - some may have pads you must short instead
  • Keycode in layout: Press the key mapped to QK_BOOT if it is available