Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Revamp dactyl_manuform readme.md #20395

Merged
merged 14 commits into from
Jul 7, 2023
Merged

Revamp dactyl_manuform readme.md #20395

Changes from 7 commits
Commits
Show all changes
14 commits
Select commit Hold shift + click to select a range
d79c60a
Update readme.md
dunk2k Apr 9, 2023
b49e07d
Update readme.md
dunk2k Apr 11, 2023
fdc78e1
Update readme.md
dunk2k Apr 18, 2023
9a118ab
Update readme.md
dunk2k May 7, 2023
1420291
Update readme.md
dunk2k May 8, 2023
3c83566
Update readme.md
dunk2k May 8, 2023
5f5a6bb
Update readme.md
dunk2k May 20, 2023
f1f1307
update readme.md
dunk2k Jun 6, 2023
72ea01e
update readme.md
dunk2k Jun 6, 2023
ee830ce
update readme.md
dunk2k Jun 6, 2023
b2ec026
update readme.md
dunk2k Jun 6, 2023
902e087
update readme.md
dunk2k Jun 6, 2023
3aa7f5c
update readme.md
dunk2k Jun 6, 2023
f1acd85
Update readme.md
dunk2k Jun 19, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
225 changes: 110 additions & 115 deletions keyboards/handwired/dactyl_manuform/readme.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,188 +1,183 @@
# Dactyl Manuform (4x5, 5x6, 5x7, 6x6, 6x7)
# Dactyl ManuForm

the [Dactyl-Manuform](https://github.com/tshort/dactyl-keyboard) is a split curved keyboard based on the design of [adereth dactyl](https://github.com/adereth/dactyl-keyboard) and thumb cluster design of the [manuform](https://geekhack.org/index.php?topic=46015.0) keyboard, the hardware is similar to the let's split keyboard. all information needed for making one is in the first link.
![Imgur](https://i.imgur.com/7y0Vbyd.jpg)
![Imgur](https://i.imgur.com/7y0Vbydh.jpg)
*Pair of Dactyl Manuform 4x6*

## First Time Setup

Download or clone the `qmk_firmware` repo and navigate to its top level directory. Once your build environment is setup, you'll be able to generate the default .hex using:

Depending on your Layout chose one of the follwing commands:

```
$ make handwired/dactyl_manuform/YOUR_LAYOUT:YOUR_KEYMAP_NAME
```

example:

```
$ make handwired/dactyl_manuform/4x5:default
```

If everything worked correctly you will see a file:

```
dactyl_manuform_YOUR_LAYOUT_YOUR_KEYMAP_NAME.hex
```

For more information on customizing keymaps, take a look at the primary documentation for [Customizing Your Keymap](/docs/faq_keymap.md) in the main readme.md.

## Keymaps
Forked from the [Dactyl](/keyboards/handwired/dactyl), the [Dactyl-ManuForm](https://github.com/tshort/dactyl-keyboard) is a parameterized, handwired, split bodied, tented, concave key-well design that incorporates the thumb cluster from the [ManuForm](https://geekhack.org/index.php?topic=46015.0). Bill of Materials (BoM), case files, and wiring guide for making this keyboard is in the second link.

### [Keymaps 4x5](/keyboards/handwired/dactyl_manuform/4x5/keymaps/)
## Variants

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

Simple QWERTY layout with 3 Layers.
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

#### Dvorak
Variants are denoted as `RowCount`*x*`ColumnCount`*(_`Alteration`)*

### [Keymaps 5x6](/keyboards/handwired/dactyl_manuform/5x6/keymaps/)
### 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 |

#### Default
### 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`) |

Just a copy of the Impstyle keymap. Feel free to adjust it.
### Alteration
| Code | Description |
| :---: | :---: |
| 3 | Default thumb cluster replaced with three key thumb cluster of [Dactyl Manuform Tight](https://github.com/okke-formsma/dactyl-manuform-tight) |
| 5 | Default thumb cluster replaced with five key thumb cluster of [Dactyl Manuform Mini](https://github.com/l4u/dactyl-manuform-mini-keyboard) |
| 2_5 | Same as code *5* with two additional keys added to finger key-well bottom row |
| kinesis | Thumb cluster keys are arranged to resemble the Kinesis Advantage keyboard thumb cluster |

#### Impstyle

A simple QWERTY keymap with 3 Layers. Both sides are connected via serial and the Left ist the master.

### [Keymaps 5x6_5](/keyboards/handwired/dactyl_manuform/5x6_5/keymaps/)

Similar layout to 5x6 but with only 5 thumb keys per side instead of 6.

#### Default
QWERTY layout with 7 Layers.
## First Time Setup

#### Via
Similar to Default but adds support for the [Via](https://www.caniusevia.com/) keymap configurator. Reduces the number of layers to 4 to comply with Via defaults, and remaps
some keys to accomodate that constraint.
Download or clone the `qmk/qmk_firmware` repo and navigate to its top level directory. Once your build environment is setup, you'll be able to compile a firmware file.

### [Keymaps 5x7 aka almost Ergodox](/keyboards/handwired/dactyl_manuform/5x7/keymaps/)
`qmk compile -kb handwired/dactyl_manuform/`*variant*` -kb `*keymap*`

#### Default
Example:
```
qmk compile -kb handwired/dactyl_manuform/4x6 -km default
```
If everything worked correctly you will see a file named, in the case of the above example:
```
handwired_dactyl_manuform_4x6_default.hex
```

Keymap of Loligagger from geekhack.
## Keymaps

### [Keymaps 6x6](/keyboards/handwired/dactyl_manuform/6x6/keymaps/)
### Default

#### 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.

Simple QWERTY layout with 3 Layers.
### VIA
Similar to *Default* but adds support for the [VIA](https://usevia.app/) keymap configurator. Layer count set to 4 to comply with VIA defaults, and remaps keys to accommodate this constraint, if applicable.

### [Keymaps 6x7](/keyboards/handwired/dactyl_manuform/6x7/keymaps/)
Variants with VIA support:
- 4x6
- 5x6_5
- 5x7

#### Default
### Miryoku

Simple QWERTY layout with 3 Layers.
For more information on this layout schematic, please see the [Miryoku Reference Manual](https://github.com/manna-harbour/miryoku/tree/master/docs/reference).
For QMK specifics, please see [Miryoku QMK](https://github.com/manna-harbour/miryoku_qmk/tree/miryoku/users/manna-harbour_miryoku).

### [Keymaps 3x5_3](/keyboards/handwired/dactyl_manuform/3x5_3/keymaps/)
Variants with *Miryoku* support:
- 3x5_3
- 4x5
- 4x5_5
- 4x6
- 4x6_5
- 5x6

#### Dlford
### Custom Keymaps

QWERTY/Colemak layout with per key RGB and other features
For more information on customizing keymaps, take a look at the primary documentation for [Customizing Your Keymap](/docs/faq_keymap.md) in the main readme.md.

## Required Hardware

Apart from diodes and key switches for the keyboard matrix in each half, you
will need:

- 2 Arduino Pro Micros. You can find these on AliExpress for ≈3.50USD each.
- 2 TRRS sockets and 1 TRRS cable, or 2 TRS sockets and 1 TRS cable
Apart from diodes and key switches for the keyboard matrix in each half, you will need:
- 2 Arduino Pro Micro controllers. You can find these on AliExpress for ≈3.50USD each.
- 2 TRRS sockets and 1 TRRS cable (for 4 wire communication), or 2 TRS sockets and 1 TRS cable (for 3 wire communication)

Alternatively, you can use any sort of cable and socket that has at least 3
Alternatively, you can use any matching cable and socket type that has at least 3
wires. If you want to use I2C to communicate between halves, you will need a
cable with at least 4 wires and 2x 4.7kΩ pull-up resistors

## Optional Hardware

A speaker can be hooked-up to either side to the `5` (`C6`) pin and `GND`, and turned on via `AUDIO_ENABLE`.
cable with at least 4 wires and 2x 4.7kΩ pull-up resistors.

## Wiring

The 3 wires of the TRS/TRRS cable need to connect GND, VCC, and digital pin 3 (i.e.
PD0 on the ATmega32u4) between the two Pro Micros.

Next, wire your key matrix to any of the remaining 17 IO pins of the pro micro
and modify the `matrix.c` accordingly.

The wiring for serial:

![serial wiring](https://i.imgur.com/C3D1GAQ.png)
![serial wiring](https://i.imgur.com/C3D1GAQh.png)

The wiring for i2c:

![i2c wiring](https://i.imgur.com/Hbzhc6E.png)
![i2c wiring](https://i.imgur.com/Hbzhc6Eh.png)

The pull-up resistors may be placed on either half. It is also possible
to use 4 resistors and have the pull-ups in both halves, but this is
unnecessary in simple use cases.
The pull-up resistors may be placed on either half. It is also possible to use 4 resistors and have the pull-ups in both halves, but this is unnecessary in simple use cases.

You can change your configuration between serial and i2c by modifying your `config.h` file.
You can change your configuration between serial and i2c by modifying your `config.h` file. [Split Keyboard documentation](https://docs.qmk.fm/#/feature_split_keyboard).

## Notes on Software Configuration
Next, wire the switch matrix in sequence as specified by the chosen variant's column and row definitions.

the keymaps in here are for the 4x5 layout of the keyboard only.
## Optional Hardware

## Flashing
A speaker can be hooked-up to either side to the `5` (`C6`) pin and `GND`, and turned on via `AUDIO_ENABLE`.

## Non-Pro Micro Controller Compilation

To flash your firmware take a look at: [Flashing Instructions and Bootloader Information](https://docs.qmk.fm/#/flashing)
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](https://docs.qmk.fm/#/feature_converters?id=supported-converters) for list of controllers that are supported converting from `pro_micro` and how to implement conversion.

## Choosing which board to plug the USB cable into (choosing Master)
## Flashing

To flash your board with generated firmware file, please see [Flashing Instructions and Bootloader Information](https://docs.qmk.fm/#/flashing)

Because the two boards are identical, the firmware has logic to differentiate the left and right board.
## Choosing which half to plug host cable

It uses two strategies to figure things out: looking at the EEPROM (memory on the chip) or looking if the current board has the usb cable.
Because the two halves are identical, the firmware has logic to differentiate.
It uses two strategies to figure things out: Checking EEPROM or has defined which half the host cable should be plugged into.

The EEPROM approach requires additional setup (flashing the eeprom) but allows you to swap the usb cable to either side.
The EEPROM approach requires additional setup but allows you to swap the host cable to either half.

The USB cable approach is easier to setup and if you just want the usb cable on the left board, you do not need to do anything extra.
Half defined approach is easier to setup and if you just want the host cable on the left half, you do not need any additional configuration.

### Setting the left hand as master
### Setting left half as master

If you always plug the usb cable into the left board, nothing extra is needed as this is the default. Comment out `EE_HANDS` and comment out `I2C_MASTER_RIGHT` or `MASTER_RIGHT` if for some reason it was set.
If you always plug the host cable into the left half, nothing extra is needed as this is the default. Comment out in `config.h` file `EE_HANDS`, `I2C_MASTER_RIGHT`, and `MASTER_RIGHT` if for some reason they are defined.

### Setting the right hand as master
### Setting right half as master

If you always plug the usb cable into the right board, add an extra flag to your `config.h`
If you always plug the host cable into the right half, add the following into the respective variant's `config.h` file:

```
#define MASTER_RIGHT
```

### Setting EE_hands to use either hands as master
### Setting EE_hands to use either half as master

You will need to flash the EEPROM for the left and right halves.

If you define `EE_HANDS` in your `config.h`, you will need to set the
EEPROM for the left and right halves.
The EEPROM in each half is flashed to code, into controller, their half designation.
This requires a firmware file compiled and flashed for each half.

The EEPROM is used to store whether the
half is left handed or right handed. This makes it so that the same firmware
file will run on both hands instead of having to flash left and right handed
versions of the firmware to each half. To flash the EEPROM file for the left
half run:
To flash the EEPROM file for the **left** half, run:

```
make handwired/dactyl_promicro:default:dfu-split-left
```
For the **right** half, run:
```
make handwired/dactyl_promicro:default:dfu-split-right
```

After you have flashed the EEPROM, you then need to set `EE_HANDS` in your config.h, rebuild the hex files and reflash.

Note that you need to program both halves, but you have the option of using
different keymaps for each half. You could program the left half with a QWERTY
layout and the right half with a Colemak layout using bootmagic's default layout option.
Then if you connect the left half to a computer by USB the keyboard will use QWERTY and Colemak when the
right half is connected.
After you have flashed the EEPROM for both havles, you then need to set EE_HANDS in `config.h` file,
```
#define EE_HANDS
```
re-compile the firmware (.hex) file as normal, and flash board as normal.

## Notes on Using Pro Micro 3.3V
### Handedness configurations

Do update the `F_CPU` parameter in `rules.mk` to `8000000` which reflects
the frequency on the 3.3V board.
See [Handedness](https://docs.qmk.fm/#/config_options?id=setting-handedness) documentation for more information on configuring handedness.

Also, if the slave board is producing weird characters in certain columns,
update the following line in `matrix.c` to the following:
## VIA Configuration

Variants with a `via` keymap are VIA capable.
Compile firmware, for [enabled variant](#via), with it's `via` keymap and flash board with this firmware file.
```
// wait_us(30); // without this wait read unstable value.
wait_us(300); // without this wait read unstable value.
qmk compile -kb handwired/dactyl_manuform/4x6 -km via
```