[Keyboard] handwired dactyl with 2 pro micros added (#5113)

* handwired dactyl with 2 pro micros added

* dactyl_promicro README updated

* dactyl_promicro default layout fixed

* requested changes

* dactyl_promicro README updated

* qmk toolbox link fixed

* layout reflects phys. keys positions

keyboards/handwired/dactyl_manuform/readme.md

@@ -131,17 +131,9 @@ 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:"./quantum/split_common/eeprom-lefthand.eep"
-// or the equivalent in dfu-programmer
-
-```
-and similarly for right half
+make handwired/dactyl_promicro:default:dfu-split-left
+make handwired/dactyl_promicro:default:dfu-split-right
 ```
-avrdude -p atmega32u4 -P $(COM_PORT) -c avr109 -U eeprom:w:"./quantum/split_common/eeprom-righthand.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.
 
@@ -162,6 +154,6 @@ 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.
+// wait_us(30);  // without this wait read unstable value.
+wait_us(300);  // without this wait read unstable value.
 ```

keyboards/handwired/dactyl_promicro/config.h

@@ -0,0 +1,83 @@
+/*
+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 Ergo(6x6)
+
+/* key matrix size */
+// Rows are doubled-up
+#define MATRIX_ROWS 12
+#define MATRIX_COLS 6
+
+// wiring of each half
+#define MATRIX_COL_PINS { D4, C6, D7, E6, B4, B5 }
+#define MATRIX_ROW_PINS { F6, F7, B1, B3, B2, B6 }
+
+/* USB Device descriptor parameter */
+#define VENDOR_ID       0xFEED
+#define PRODUCT_ID      0x3060
+#define DEVICE_VER      0x0001
+//#define MANUFACTURER    tshort
+// defined in subfolder
+#define DESCRIPTION     A split keyboard
+
+/* mouse config */
+#define MOUSEKEY_INTERVAL       20
+#define MOUSEKEY_DELAY          0
+#define MOUSEKEY_TIME_TO_MAX    60
+#define MOUSEKEY_MAX_SPEED      7
+#define MOUSEKEY_WHEEL_DELAY 0
+
+/* Set 0 if debouncing isn't needed */
+#define DEBOUNCING_DELAY 5
+
+/* serial.c configuration for split keyboard */
+#define SOFT_SERIAL_PIN D0
+
+/* Mechanical locking support. Use KC_LCAP, KC_LNUM or KC_LSCR instead in keymap */
+#define LOCKING_SUPPORT_ENABLE
+/* Locking resynchronize hack */
+#define LOCKING_RESYNC_ENABLE
+
+/* Enables This makes it easier for fast typists to use dual-function keys */
+#define PERMISSIVE_HOLD
+
+/* ws2812 RGB LED */
+#define RGB_DI_PIN D3
+
+#define RGBLED_NUM 12    // Number of LEDs
+
+/*
+ * Feature disable options
+ *  These options are also useful to firmware size reduction.
+ */
+
+/* disable debug print */
+// #define NO_DEBUG
+
+/* disable print */
+// #define NO_PRINT
+
+/* disable action features */
+//#define NO_ACTION_LAYER
+//#define NO_ACTION_TAPPING
+//#define NO_ACTION_ONESHOT
+//#define NO_ACTION_MACRO
+//#define NO_ACTION_FUNCTION

keyboards/handwired/dactyl_promicro/dactyl_promicro.c

@@ -0,0 +1,12 @@
+#include "dactyl_promicro.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) {
+	matrix_init_user();
+};

keyboards/handwired/dactyl_promicro/dactyl_promicro.h

@@ -0,0 +1,39 @@
+#pragma once
+
+#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, \
+					         L55, L51, L52,  R53, R54, R50, 					     \
+					                   L53,  R52, 									 \
+					                   L54,  R51                                     \
+	)\
+	{ \
+		{ 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, L51, L52, L53, L54, L55 },  \
+\
+		{ 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, R54, KC_NO },  \
+}

keyboards/handwired/dactyl_promicro/keymaps/default/config.h

@@ -0,0 +1,25 @@
+/*
+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_RIGHT
+// #define MASTER_RIGHT
+//#define EE_HANDS
+// Rows are doubled-up

keyboards/handwired/dactyl_promicro/keymaps/default/keymap.c

@@ -0,0 +1,47 @@
+
+/* A QWERTY 3 Layer layout for the Dactyl Manuform 6x6 Keyboard */ 
+
+#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)
+
+const uint16_t PROGMEM keymaps[][MATRIX_ROWS][MATRIX_COLS] = {
+
+
+  [_QWERTY] = LAYOUT_6x6(
+     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_PLUS , KC_LEFT,KC_UP  ,KC_DOWN, KC_RGHT, RAISE ,      LOWER , KC_HOME, KC_PGUP, KC_PGDN,KC_END ,KC_EQL,
+               _______,KC_LALT,KC_PSCR, KC_LGUI, KC_SPC,      KC_ENT,KC_GRAVE, KC_AT  ,KC_PSCR ,_______
+                                                             
+  ),
+
+
+  [_LOWER] = LAYOUT_6x6(
+     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_PSCR,         KC_P0  , KC_P1 , KC_P2 , KC_P3 ,KC_EQL ,KC_UNDS,
+     _______,_______,_______,_______,_______,_______,         _______,_______,_______,_______,_______,_______,             
+             _______,_______,_______,_______,_______,         _______,_______,_______,_______,_______
+),
+
+  [_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,
+     _______,_______,_______,_______,_______,_______,         _______,_______,_______,_______,_______,_______,
+             _______,_______,_______,_______,_______,         _______,_______,_______,_______,_______
+  ),
+
+  };

keyboards/handwired/dactyl_promicro/keymaps/impstyle/config.h

@@ -0,0 +1,25 @@
+/*
+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_RIGHT
+// #define MASTER_RIGHT
+//#define EE_HANDS
+// Rows are doubled-up

keyboards/handwired/dactyl_promicro/keymaps/impstyle/keymap.c

@@ -0,0 +1,47 @@
+
+/* A QWERTY 3 Layer layout for the Dactyl Manuform 6x6 Keyboard */ 
+
+#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)
+
+const uint16_t PROGMEM keymaps[][MATRIX_ROWS][MATRIX_COLS] = {
+
+
+  [_QWERTY] = LAYOUT_6x6(
+     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_PLUS , KC_LEFT,KC_UP  ,KC_DOWN, KC_RGHT, RAISE ,      LOWER , KC_HOME, KC_PGUP, KC_PGDN,KC_END ,KC_EQL,
+               _______,KC_LALT,KC_PSCR, KC_LGUI, KC_SPC,      KC_ENT,KC_GRAVE, KC_AT  ,KC_PSCR ,_______
+                                                             
+  ),
+
+
+  [_LOWER] = LAYOUT_6x6(
+     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_PSCR,         KC_P0  , KC_P1 , KC_P2 , KC_P3 ,KC_EQL ,KC_UNDS,
+     _______,_______,_______,_______,_______,_______,         _______,_______,_______,_______,_______,_______,             
+             _______,_______,_______,_______,_______,         _______,_______,_______,_______,_______
+),
+
+  [_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,
+     _______,_______,_______,_______,_______,_______,         _______,_______,_______,_______,_______,_______,
+             _______,_______,_______,_______,_______,         _______,_______,_______,_______,_______
+  ),
+
+  };

keyboards/handwired/dactyl_promicro/readme.md

@@ -0,0 +1,93 @@
+# Dactyl with Arduino Pro Micro
+
+See https://github.com/adereth/dactyl-keyboard for the original Version.
+
+This Dactyl uses the Arduino Pro Mirco (2x).
+Wiring is a 6x6 Matrix like the [Dactyl Manuform](https://github.com/qmk/qmk_firmware/tree/master/keyboards/handwired/dactyl_manuform)
+
+
+## Build the Firmware:
+
+  - Build the firmware with `make handwired/dactyl_promicro:<keymapname>`, for example `make handwired/dactyl:default`
+  - This will result in a hex file called `handwired_dactyl_promicro_<keymapname>.hex`, e.g.
+    `handwired_dactyl_promicro_default.hex`
+
+How to setup your build enviroment can be found here: [Installing Build Tools](https://docs.qmk.fm/#/getting_started_build_tools)
+
+## 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
+
+To flash your firmware take a look at: [Flashing Instructions and Bootloader Information](https://docs.qmk.fm/#/flashing).
+
+Under Windows the most convenient way is installing the [QMK Drivers](https://github.com/qmk/qmk_driver_installer/releases) and use the [QMK Toolbox](https://github.com/qmk/qmk_toolbox/releases).
+
+
+## Choosing which board to plug the USB cable into (choosing Master)
+
+### Setting the right or left 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
+```
+
+OR
+
+```
+ #define MASTER_LEFT
+```
+
+
+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.
+```

keyboards/handwired/dactyl_promicro/rules.mk

@@ -0,0 +1,66 @@
+# MCU name
+#MCU = at90usb1287
+MCU = atmega32u4
+
+# Processor frequency.
+#     This will define a symbol, F_CPU, in all source code files equal to the
+#     processor frequency in Hz. You can then use this symbol in your source code to
+#     calculate timings. Do NOT tack on a 'UL' at the end, this will be done
+#     automatically to create a 32-bit value in your source code.
+#
+#     This will be an integer division of F_USB below, as it is sourced by
+#     F_USB after it has run through any CPU prescalers. Note that this value
+#     does not *change* the processor frequency - it should merely be updated to
+#     reflect the processor speed set externally so that the code can use accurate
+#     software delays.
+F_CPU = 16000000
+
+#
+# LUFA specific
+#
+# Target architecture (see library "Board Types" documentation).
+ARCH = AVR8
+
+# Input clock frequency.
+#     This will define a symbol, F_USB, in all source code files equal to the
+#     input clock frequency (before any prescaling is performed) in Hz. This value may
+#     differ from F_CPU if prescaling is used on the latter, and is required as the
+#     raw input clock is fed directly to the PLL sections of the AVR for high speed
+#     clock generation for the USB and other AVR subsections. Do NOT tack on a 'UL'
+#     at the end, this will be done automatically to create a 32-bit value in your
+#     source code.
+#
+#     If no clock division is performed on the input clock inside the AVR (via the
+#     CPU clock adjust registers or the clock division fuses), this will be equal to F_CPU.
+F_USB = $(F_CPU)
+
+# Bootloader
+#     This definition is optional, and if your keyboard supports multiple bootloaders of
+#     different sizes, comment this out, and the correct address will be loaded
+#     automatically (+60). See bootloader.mk for all options.
+BOOTLOADER = caterina
+
+# Interrupt driven control endpoint task(+60)
+OPT_DEFS += -DINTERRUPT_CONTROL_ENDPOINT
+
+# 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 SLEEP_LED_ENABLE. it uses the same timer as BACKLIGHT_ENABLE
+SLEEP_LED_ENABLE = no    # Breathing sleep LED during USB suspend
+
+SPLIT_KEYBOARD = yes