* mouse layer keys shifted * mouse layer keys shifted * manuform 5x6 added * mouse layer keys shifted * manuform 5x6 added * dactyl_manuform 5x6 keymap added * reorg. dactyl manuform folder * removed LAYOUTS = ortho_4x12 for 4x5 * Rows and Cols in config.h fixed * MASTER_LEFT * 5x6 matrix fixed * keymap updated * removed the i2c, serial, split_util and matrix files and inserted SPLIT_KEYBOARD * default keymap for dactyl_manuform 5x6 * Fixes for Dactyl Manuform * Add/update default keymap * readme dactyl_manuform updated * links to keymaps added * dactyl_manuform 6x6 added. README updated * dactyl_manuform README updated * cleanup * more cleanuppull/3668/head
@ -1,161 +0,0 @@ | |||
Dactyl Manuform 4x5 | |||
====== | |||
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) | |||
## 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: | |||
``` | |||
$ make handwired/dactyl_manuform/4x5:dvorak | |||
``` | |||
You will see a lot of output and if everything worked correctly you will see the built hex file: | |||
``` | |||
dactyl_manuform_4x5_dvorak.hex | |||
``` | |||
If you would like to use one of the alternative keymaps, or create your own, copy one of the existing [keymaps](keymaps/) and run make like so: | |||
``` | |||
$ make handwired/dactyl_manuform/4x5:YOUR_KEYMAP_NAME | |||
``` | |||
If everything worked correctly you will see a file: | |||
``` | |||
dactyl_manuform_4x5_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 | |||
Currently there are only two keymaps: Qwerty and Dvorak, feel free to make changes and contribute your keymap. | |||
### Qwerty and Dvorak | |||
Qwerty base layer: | |||
![Imgur](https://i.imgur.com/Yb5e7dS.png) | |||
Dvorak base layer: | |||
![Imgur](https://i.imgur.com/CpuZptB.png) | |||
Both keymaps have the same Raise and Lower layers: | |||
Raise Layer | |||
![Imgur](https://i.imgur.com/nOqePK5.png) | |||
Lower Layer | |||
![Imgur](https://i.imgur.com/WSshkYc.png) | |||
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 | |||
Alternatively, you can use any sort of cable and socket 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`. | |||
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) | |||
The wiring for i2c: | |||
![i2c wiring](https://i.imgur.com/Hbzhc6E.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. | |||
You can change your configuration between serial and i2c by modifying your `config.h` file. | |||
Notes on Software Configuration | |||
------------------------------- | |||
the keymaps in here are for the 4x5 layout of the keyboard only. | |||
Flashing | |||
------- | |||
From the top level `qmk_firmware` directory run `make KEYBOARD:KEYMAP:avrdude` for automatic serial port resolution and flashing. | |||
Example: `make lets_split/rev2:default:avrdude` | |||
Choosing which board to plug the USB cable into (choosing Master) | |||
-------- | |||
Because the two boards are identical, the firmware has logic to differentiate the left and right board. | |||
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. | |||
The EEPROM approach requires additional setup (flashing the eeprom) but allows you to swap the usb cable to either side. | |||
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. | |||
### Setting the left hand 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. | |||
### Setting the right hand as master | |||
If you always plug the usb cable into the right board, add an extra flag to your `config.h` | |||
``` | |||
#define MASTER_RIGHT | |||
``` | |||
### Setting EE_hands to use either hands as master | |||
If you define `EE_HANDS` in your `config.h`, you will need to set the | |||
EEPROM for the left and right halves. | |||
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: | |||
``` | |||
avrdude -p atmega32u4 -P $(COM_PORT) -c avr109 -U eeprom:w:eeprom-lefthand.eep | |||
// or the equivalent in dfu-programmer | |||
``` | |||
and similarly for right half | |||
``` | |||
avrdude -p atmega32u4 -P $(COM_PORT) -c avr109 -U eeprom:w:eeprom-righhand.eep | |||
// or the equivalent in dfu-programmer | |||
``` | |||
NOTE: replace `$(COM_PORT)` with the port of your device (e.g. `/dev/ttyACM0`) | |||
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. | |||
Notes on Using Pro Micro 3.3V | |||
----------------------------- | |||
Do update the `F_CPU` parameter in `rules.mk` to `8000000` which reflects | |||
the frequency on the 3.3V board. | |||
Also, if the slave board is producing weird characters in certain columns, | |||
update the following line in `matrix.c` to the following: | |||
``` | |||
// _delay_us(30); // without this wait read unstable value. | |||
_delay_us(300); // without this wait read unstable value. | |||
``` |
@ -1,142 +0,0 @@ | |||
Dactyl Manuform 5x6 | |||
====== | |||
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) | |||
## 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: | |||
``` | |||
$ make handwired/dactyl_manuform/5x6:YOUR_KEYMAP_NAME | |||
``` | |||
If everything worked correctly you will see a file: | |||
``` | |||
dactyl_manuform_5x6_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 | |||
Currently there are only two keymaps: Qwerty and Dvorak, feel free to make changes and contribute your keymap. | |||
### Impstyle | |||
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 | |||
Alternatively, you can use any sort of cable and socket 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`. | |||
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) | |||
The wiring for i2c: | |||
![i2c wiring](https://i.imgur.com/Hbzhc6E.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. | |||
You can change your configuration between serial and i2c by modifying your `config.h` file. | |||
Notes on Software Configuration | |||
------------------------------- | |||
the keymaps in here are for the 4x5 layout of the keyboard only. | |||
Flashing | |||
------- | |||
From the top level `qmk_firmware` directory run `make KEYBOARD:KEYMAP:avrdude` for automatic serial port resolution and flashing. | |||
Example: `make lets_split/rev2:default:avrdude` | |||
Choosing which board to plug the USB cable into (choosing Master) | |||
-------- | |||
Because the two boards are identical, the firmware has logic to differentiate the left and right board. | |||
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. | |||
The EEPROM approach requires additional setup (flashing the eeprom) but allows you to swap the usb cable to either side. | |||
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. | |||
### Setting the left hand 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. | |||
### Setting the right hand as master | |||
If you always plug the usb cable into the right board, add an extra flag to your `config.h` | |||
``` | |||
#define MASTER_RIGHT | |||
``` | |||
### Setting EE_hands to use either hands as master | |||
If you define `EE_HANDS` in your `config.h`, you will need to set the | |||
EEPROM for the left and right halves. | |||
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: | |||
``` | |||
avrdude -p atmega32u4 -P $(COM_PORT) -c avr109 -U eeprom:w:eeprom-lefthand.eep | |||
// or the equivalent in dfu-programmer | |||
``` | |||
and similarly for right half | |||
``` | |||
avrdude -p atmega32u4 -P $(COM_PORT) -c avr109 -U eeprom:w:eeprom-righhand.eep | |||
// or the equivalent in dfu-programmer | |||
``` | |||
NOTE: replace `$(COM_PORT)` with the port of your device (e.g. `/dev/ttyACM0`) | |||
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. | |||
Notes on Using Pro Micro 3.3V | |||
----------------------------- | |||
Do update the `F_CPU` parameter in `rules.mk` to `8000000` which reflects | |||
the frequency on the 3.3V board. | |||
Also, if the slave board is producing weird characters in certain columns, | |||
update the following line in `matrix.c` to the following: | |||
``` | |||
// _delay_us(30); // without this wait read unstable value. | |||
_delay_us(300); // without this wait read unstable value. | |||
``` |
@ -0,0 +1,23 @@ | |||
#include "6x6.h" | |||
#ifdef SSD1306OLED | |||
void led_set_kb(uint8_t usb_led) { | |||
// put your keyboard LED indicator (ex: Caps Lock LED) toggling code here | |||
led_set_user(usb_led); | |||
} | |||
#endif | |||
void matrix_init_kb(void) { | |||
// // green led on | |||
// DDRD |= (1<<5); | |||
// PORTD &= ~(1<<5); | |||
// // orange led on | |||
// DDRB |= (1<<0); | |||
// PORTB &= ~(1<<0); | |||
matrix_init_user(); | |||
}; | |||
@ -0,0 +1,44 @@ | |||
#pragma once | |||
#include "dactyl_manuform.h" | |||
#include "quantum.h" | |||
#ifdef USE_I2C | |||
#include <stddef.h> | |||
#ifdef __AVR__ | |||
#include <avr/io.h> | |||
#include <avr/interrupt.h> | |||
#endif | |||
#endif | |||
#define LAYOUT_6x6(\ | |||
L00, L01, L02, L03, L04, L05, R00, R01, R02, R03, R04, R05, \ | |||
L10, L11, L12, L13, L14, L15, R10, R11, R12, R13, R14, R15, \ | |||
L20, L21, L22, L23, L24, L25, R20, R21, R22, R23, R24, R25, \ | |||
L30, L31, L32, L33, L34, L35, R30, R31, R32, R33, R34, R35, \ | |||
L40, L41, L42, L43, L44, L45, R40, R41, R42, R43, R44, R45, \ | |||
L52, L53, R52, R53, \ | |||
L54, L55, R50, R51, \ | |||
L64, L65, R60, R61, \ | |||
L62, L63, R62, R63 \ | |||
) \ | |||
{ \ | |||
{ L00, L01, L02, L03, L04, L05 }, \ | |||
{ L10, L11, L12, L13, L14, L15 }, \ | |||
{ L20, L21, L22, L23, L24, L25 }, \ | |||
{ L30, L31, L32, L33, L34, L35 }, \ | |||
{ L40, L41, L42, L43, L44, L45 }, \ | |||
{ KC_NO, KC_NO, L52, L53, L54, L55 }, \ | |||
{ KC_NO, KC_NO, L62, L63, L64, L65 }, \ | |||
\ | |||
{ R00, R01, R02, R03, R04, R05 }, \ | |||
{ R10, R11, R12, R13, R14, R15 }, \ | |||
{ R20, R21, R22, R23, R24, R25 }, \ | |||
{ R30, R31, R32, R33, R34, R35 }, \ | |||
{ R40, R41, R42, R43, R44, R45 }, \ | |||
{ R50, R51, R52, R53, KC_NO, KC_NO },\ | |||
{ R60, R61, R62, R63, KC_NO, KC_NO }, \ | |||
} | |||
@ -0,0 +1,33 @@ | |||
/* | |||
Copyright 2012 Jun Wako <wakojun@gmail.com> | |||
Copyright 2015 Jack Humbert | |||
This program is free software: you can redistribute it and/or modify | |||
it under the terms of the GNU General Public License as published by | |||
the Free Software Foundation, either version 2 of the License, or | |||
(at your option) any later version. | |||
This program is distributed in the hope that it will be useful, | |||
but WITHOUT ANY WARRANTY; without even the implied warranty of | |||
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the | |||
GNU General Public License for more details. | |||
You should have received a copy of the GNU General Public License | |||
along with this program. If not, see <http://www.gnu.org/licenses/>. | |||
*/ | |||
#pragma once | |||
#include "config_common.h" | |||
#define PRODUCT Dactyl-Manuform (6x6) | |||
/* key matrix size */ | |||
// Rows are doubled-up | |||
#define MATRIX_ROWS 14 | |||
#define MATRIX_COLS 6 | |||
// wiring of each half | |||
#define MATRIX_COL_PINS { D4, C6, D7, E6, B4, B5 } | |||
#define MATRIX_ROW_PINS { F5, F6, F7, B1, B3, B2, B6 } |
@ -0,0 +1,27 @@ | |||
/* | |||
Copyright 2012 Jun Wako <wakojun@gmail.com> | |||
This program is free software: you can redistribute it and/or modify | |||
it under the terms of the GNU General Public License as published by | |||
the Free Software Foundation, either version 2 of the License, or | |||
(at your option) any later version. | |||
This program is distributed in the hope that it will be useful, | |||
but WITHOUT ANY WARRANTY; without even the implied warranty of | |||
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the | |||
GNU General Public License for more details. | |||
You should have received a copy of the GNU General Public License | |||
along with this program. If not, see <http://www.gnu.org/licenses/>. | |||
*/ | |||
#pragma once | |||
#define USE_SERIAL | |||
#define MASTER_LEFT | |||
// #define MASTER_RIGHT | |||
//#define EE_HANDS | |||
// Rows are doubled-up |
@ -0,0 +1,57 @@ | |||
#include QMK_KEYBOARD_H | |||
extern keymap_config_t keymap_config; | |||
#define _QWERTY 0 | |||
#define _LOWER 1 | |||
#define _RAISE 2 | |||
#define RAISE MO(_RAISE) | |||
#define LOWER MO(_LOWER) | |||
#define _______ KC_TRNS | |||
const uint16_t PROGMEM keymaps[][MATRIX_ROWS][MATRIX_COLS] = { | |||
[_QWERTY] = LAYOUT_6x6( | |||
KC_F1 , KC_F2 , KC_F3 , KC_F4 , KC_F5 , KC_F6 , KC_F7 , KC_F8 , KC_F9 ,KC_F10 ,KC_F11 ,KC_F12 , | |||
KC_ESC , KC_1 , KC_2 , KC_3 , KC_4 , KC_5 , KC_6 , KC_7 , KC_8 , KC_9 , KC_0 ,KC_BSPC, | |||
KC_TAB , KC_Q , KC_W , KC_E , KC_R , KC_T , KC_Y , KC_U , KC_I , KC_O , KC_P ,KC_MINS, | |||
KC_LSFT, KC_A , KC_S , KC_D , KC_F , KC_G , KC_H , KC_J , KC_K , KC_L ,KC_SCLN,KC_QUOT, | |||
KC_LCTL, KC_Z , KC_X , KC_C , KC_V , KC_B , KC_N , KC_M ,KC_COMM,KC_DOT ,KC_SLSH,KC_BSLASH, | |||
KC_LBRC,KC_RBRC, KC_PLUS, KC_EQL, | |||
RAISE,KC_SPC, KC_ENT, LOWER, | |||
KC_TAB,KC_HOME, KC_END, KC_DEL, | |||
KC_BSPC, KC_GRV, KC_LGUI, KC_LALT | |||
), | |||
[_LOWER] = LAYOUT_6x6( | |||
KC_F1 , KC_F2 , KC_F3 , KC_F4 , KC_F5 , KC_F6 , KC_F7 , KC_F8 , KC_F9 ,KC_F10 ,KC_F11 ,KC_F12 , | |||
KC_TILD,KC_EXLM, KC_AT ,KC_HASH,KC_DLR ,KC_PERC, KC_CIRC,KC_AMPR,KC_ASTR,KC_LPRN,KC_RPRN,KC_DEL, | |||
_______,_______,_______,_______,_______,KC_LBRC, KC_RBRC, KC_P7 , KC_P8 , KC_P9 ,_______,KC_PLUS, | |||
_______,KC_HOME,KC_PGUP,KC_PGDN,KC_END ,KC_LPRN, KC_RPRN, KC_P4 , KC_P5 , KC_P6 ,KC_MINS,KC_PIPE, | |||
_______,_______,_______,_______,_______,_______, _______, KC_P1 , KC_P2 , KC_P3 ,KC_EQL ,KC_UNDS, | |||
_______,KC_PSCR, _______, KC_P0, | |||
_______,_______, _______,_______, | |||
_______,_______, _______,_______, | |||
_______,_______, _______,_______ | |||
), | |||
[_RAISE] = LAYOUT_6x6( | |||
KC_F12 , KC_F1 , KC_F2 , KC_F3 , KC_F4 , KC_F5 , KC_F6 , KC_F7 , KC_F8 , KC_F9 ,KC_F10 ,KC_F11 , | |||
_______,_______,_______,_______,_______,KC_LBRC, KC_RBRC,_______,KC_NLCK,KC_INS ,KC_SLCK,KC_MUTE, | |||
_______,KC_LEFT,KC_UP ,KC_DOWN,KC_RGHT,KC_LPRN, KC_RPRN,KC_MPRV,KC_MPLY,KC_MNXT,_______,KC_VOLU, | |||
_______,_______,_______,_______,_______,_______, _______,_______,_______,_______,_______,KC_VOLD, | |||
_______,_______,_______,_______,_______,_______, _______,_______,_______,_______,_______,_______, | |||
_______,_______, KC_EQL ,_______, | |||
_______,_______, _______,_______, | |||
_______,_______, _______,_______, | |||
_______,_______, _______,_______ | |||
), | |||
}; | |||
@ -0,0 +1,21 @@ | |||
# Build Options | |||
# change to "no" to disable the options, or define them in the Makefile in | |||
# the appropriate keymap folder that will get included automatically | |||
# | |||
BOOTMAGIC_ENABLE = no # Virtual DIP switch configuration(+1000) | |||
MOUSEKEY_ENABLE = yes # Mouse keys(+4700) | |||
EXTRAKEY_ENABLE = yes # Audio control and System control(+450) | |||
CONSOLE_ENABLE = no # Console for debug(+400) | |||
COMMAND_ENABLE = yes # Commands for debug and configuration | |||
NKRO_ENABLE = no # Nkey Rollover - if this doesn't work, see here: https://github.com/tmk/tmk_keyboard/wiki/FAQ#nkro-doesnt-work | |||
BACKLIGHT_ENABLE = no # Enable keyboard backlight functionality | |||
MIDI_ENABLE = no # MIDI controls | |||
AUDIO_ENABLE = no # Audio output on port C6 | |||
UNICODE_ENABLE = no # Unicode | |||
BLUETOOTH_ENABLE = no # Enable Bluetooth with the Adafruit EZ-Key HID | |||
RGBLIGHT_ENABLE = no # Enable WS2812 RGB underlight. Do not enable this with audio at the same time. | |||
# Do not enable SLEEP_LED_ENABLE. it uses the same timer as BACKLIGHT_ENABLE | |||
SLEEP_LED_ENABLE = no # Breathing sleep LED during USB suspend | |||