[Keyboard] Add cKeys' "The Dora" Board (#6469)

* Initial 4x5

* More board

* Update exboard

* Update

* Change name to thedora

* Update keyboards/ckeys/thedora/keymaps/default/keymap.c

Co-Authored-By: fauxpark <fauxpark@gmail.com>

* Update keyboards/ckeys/thedora/config.h

Co-Authored-By: fauxpark <fauxpark@gmail.com>

* Remove the slash

* Attempt at fixing moxygen line break issues

* Update keyboards/ckeys/thedora/config.h

Co-Authored-By: fauxpark <fauxpark@gmail.com>

* Add boilerplate

* Update keyboards/ckeys/thedora/config.h

Co-Authored-By: Drashna Jaelre <drashna@live.com>

keyboards/ckeys/readme.md

@@ -1,10 +1,11 @@
 # cKeys.org
 
-[cKeys](https://ckeys.org/) is a mechanical keyboard-based nonprofit organization located in Seattle, Washington.
+[cKeys](https://ckeys.org/) is an all volunteer run 501c3 nonprofit organization located in Seattle, Washington.
 
-In addition, to hosting the [Seattle Mechanical Keyboard Meetups](https://ckeys.org/events/), they have [soldering workshops](https://ckeys.org/workshops/) featuring hardware hosted in this repository.
+In addition to hosting the [Seattle Mechanical Keyboard Meetups](https://ckeys.org/events/), we teach [soldering workshops](https://ckeys.org/workshops/) featuring hardware hosted in this repository.
 
 * Supported Hardware
     * The Obelus   - 4x4 Macropad
     * naKey        - Through hole numpad
     * Handwire 101 - Handwired 4x4 (Proton C or Pro Micro)
+    * The Dora Board - 4x5 with rotary encoder and Proton C pinouts

keyboards/ckeys/thedora/config.h

@@ -0,0 +1,188 @@
+/* Copyright 2019 Branden Byers
+ *
+ * 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"
+
+/* USB Device descriptor parameter */
+#define VENDOR_ID 0xFEED
+#define PRODUCT_ID 0x6060
+#define DEVICE_VER 0x0001
+#define MANUFACTURER ckeys
+#define PRODUCT thedora
+#define DESCRIPTION A board for keyboard exploration.
+
+#define ENCODERS_PAD_A { B13 }
+#define ENCODERS_PAD_B { B15 }
+#define ENCODER_RESOLUTION 4
+
+/* key matrix size */
+#define MATRIX_ROWS 4
+#define MATRIX_COLS 6
+
+#define MATRIX_ROW_PINS { A2, A1, A0, B8 }
+#define MATRIX_COL_PINS { B5, B4, B3, B2, B1, B0 }
+
+// #define UNUSED_PINS { B14 }
+
+/* COL2ROW, ROW2COL, or CUSTOM_MATRIX */
+#define DIODE_DIRECTION COL2ROW
+
+//#define BACKLIGHT_PIN B7
+// #define BACKLIGHT_BREATHING
+//#define BACKLIGHT_LEVELS 3
+
+/* Debounce reduces chatter (unintended double-presses) - set 0 if debouncing is not needed */
+#define DEBOUNCE 5
+
+/* define if matrix has ghost (lacks anti-ghosting diodes) */
+//#define MATRIX_HAS_GHOST
+
+/* number of backlight levels */
+
+/* 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
+
+#define AUDIO_CLICKY
+
+#define DAC_SAMPLE_MAX 65535U
+
+/*
+ * MIDI options
+ */
+
+/* Prevent use of disabled MIDI features in the keymap */
+//#define MIDI_ENABLE_STRICT 1
+
+/* enable basic MIDI features:
+   - MIDI notes can be sent when in Music mode is on
+*/
+//#define MIDI_BASIC
+
+/* enable advanced MIDI features:
+   - MIDI notes can be added to the keymap
+   - Octave shift and transpose
+   - Virtual sustain, portamento, and modulation wheel
+   - etc.
+*/
+#define MIDI_ADVANCED
+
+/* override number of MIDI tone keycodes (each octave adds 12 keycodes and allocates 12 bytes) */
+//#define MIDI_TONE_KEYCODE_OCTAVES 1
+
+/*
+ * Force NKRO
+ *
+ * Force NKRO (nKey Rollover) to be enabled by default, regardless of the saved
+ * state in the bootmagic EEPROM settings. (Note that NKRO must be enabled in the
+ * makefile for this to work.)
+ *
+ * If forced on, NKRO can be disabled via magic key (default = LShift+RShift+N)
+ * until the next keyboard reset.
+ *
+ * NKRO may prevent your keystrokes from being detected in the BIOS, but it is
+ * fully operational during normal computer usage.
+ *
+ * For a less heavy-handed approach, enable NKRO via magic key (LShift+RShift+N)
+ * or via bootmagic (hold SPACE+N while plugging in the keyboard). Once set by
+ * bootmagic, NKRO mode will always be enabled until it is toggled again during a
+ * power-up.
+ *
+ */
+//#define FORCE_NKRO
+
+/*
+ * Magic Key Options
+ *
+ * Magic keys are hotkey commands that allow control over firmware functions of
+ * the keyboard. They are best used in combination with the HID Listen program,
+ * found here: https://www.pjrc.com/teensy/hid_listen.html
+ *
+ * The options below allow the magic key functionality to be changed. This is
+ * useful if your keyboard/keypad is missing keys and you want magic key support.
+ *
+ */
+
+/* control how magic key switches layers */
+//#define MAGIC_KEY_SWITCH_LAYER_WITH_FKEYS  true
+//#define MAGIC_KEY_SWITCH_LAYER_WITH_NKEYS  true
+//#define MAGIC_KEY_SWITCH_LAYER_WITH_CUSTOM false
+
+/* override magic key keymap */
+//#define MAGIC_KEY_SWITCH_LAYER_WITH_FKEYS
+//#define MAGIC_KEY_SWITCH_LAYER_WITH_NKEYS
+//#define MAGIC_KEY_SWITCH_LAYER_WITH_CUSTOM
+//#define MAGIC_KEY_HELP1          H
+//#define MAGIC_KEY_HELP2          SLASH
+//#define MAGIC_KEY_DEBUG          D
+//#define MAGIC_KEY_DEBUG_MATRIX   X
+//#define MAGIC_KEY_DEBUG_KBD      K
+//#define MAGIC_KEY_DEBUG_MOUSE    M
+//#define MAGIC_KEY_VERSION        V
+//#define MAGIC_KEY_STATUS         S
+//#define MAGIC_KEY_CONSOLE        C
+//#define MAGIC_KEY_LAYER0_ALT1    ESC
+//#define MAGIC_KEY_LAYER0_ALT2    GRAVE
+//#define MAGIC_KEY_LAYER0         0
+//#define MAGIC_KEY_LAYER1         1
+//#define MAGIC_KEY_LAYER2         2
+//#define MAGIC_KEY_LAYER3         3
+//#define MAGIC_KEY_LAYER4         4
+//#define MAGIC_KEY_LAYER5         5
+//#define MAGIC_KEY_LAYER6         6
+//#define MAGIC_KEY_LAYER7         7
+//#define MAGIC_KEY_LAYER8         8
+//#define MAGIC_KEY_LAYER9         9
+//#define MAGIC_KEY_BOOTLOADER     PAUSE
+//#define MAGIC_KEY_LOCK           CAPS
+//#define MAGIC_KEY_EEPROM         E
+//#define MAGIC_KEY_NKRO           N
+//#define MAGIC_KEY_SLEEP_LED      Z
+
+// Audio Click
+
+// Music Mode Polyphony
+// NOTE: Must change polyphony_rate to a number higher than 0 in voices.c
+#define AUDIO_VOICES
+#define PITCH_STANDARD_A 880.0f
+
+// Mouse keys
+#define MOUSEKEY_DELAY 0
+#define MOUSEKEY_INTERVAL 20
+#define MOUSEKEY_MAX_SPEED 2
+#define MOUSEKEY_TIME_TO_MAX 5
+#define MOUSEKEY_WHEEL_DELAY 0
+
+/*
+ * 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/ckeys/thedora/info.json

@@ -0,0 +1,16 @@
+{
+  "keyboard_name": "The Dora Board.",
+  "url": "https://ckeys.org/slides/exboard",
+  "maintainer": "brandenbyers",
+  "width": 4,
+  "height": 4,
+  "layouts": {
+    "LAYOUT_ortho_4x5": {
+      "key_count": 20,
+      "layout": [{"x":0, "y":0}, {"x":1, "y":0}, {"x":2, "y":0}, {"x":3, "y":0}, {"x": 4, "y":0},
+                 {"x":0, "y":1}, {"x":1, "y":1}, {"x":2, "y":1}, {"x":3, "y":1}, {"x":4, "y":1},
+                 {"x":0, "y":2}, {"x":1, "y":2}, {"x":2, "y":2}, {"x":3, "y":2}, {"x":4, "y":2},
+                 {"x":0, "y":3}, {"x":1, "y":3}, {"x":2, "y":3}, {"x":3, "y":3}, {"x":4, "y":3}]
+    }
+  }
+}

keyboards/ckeys/thedora/keymaps/default/config.h

@@ -0,0 +1,3 @@
+#pragma once
+
+// Add overrides here

keyboards/ckeys/thedora/keymaps/default/keymap.c

@@ -0,0 +1,155 @@
+#include QMK_KEYBOARD_H
+
+enum layers {
+  _BASE,                // base layer
+  _MUSIC,               // music mode
+  _MIDI,                // midi mode
+  _MOUSE,               // mouse keys
+  _ADMIN                // admin duties
+};
+
+const uint16_t PROGMEM keymaps[][MATRIX_ROWS][MATRIX_COLS] = {
+
+//           ┌─────────┬─────────┬─────────┬─────────┬─────────┐
+//           │         │         │         │         │         │
+//           │    7    │    8    │    9    │    /    │  ADMIN  │
+//  ROTORY   │         │         │         │         │         │
+//  RIGHT:   ├─────────┼─────────┼─────────┼─────────┼─────────┤
+//  VOL UP   │         │         │         │         │         │
+//           │    4    │    5    │    6    │    *    │  MOUSE  │
+//  ROTORY   │         │         │         │         │         │
+//  LEFT:    ├─────────┼─────────┼─────────┼─────────┼─────────┤
+//  VOL DOWN │         │         │         │         │         │
+//           │    1    │    2    │    3    │    -    │  MIDI   │
+//           │         │         │         │         │         │
+// ┌─────────┼─────────┼─────────┼─────────┼─────────┼─────────┤
+// │  TOGGLE │         │         │         │         │         │
+// │  MUSIC  │    0    │    .    │    =    │    +    │  MUSIC  │
+// │         │         │         │         │         │         │
+// └─────────┴─────────┴─────────┴─────────┴─────────┴─────────┘
+
+  [_BASE] = LAYOUT(
+    KC_KP_7, KC_KP_8,   KC_KP_9,     KC_PSLS, MO(_ADMIN), MU_TOG,
+    KC_KP_4, KC_KP_5,   KC_KP_6,     KC_PAST, TG(_MOUSE),
+    KC_KP_1, KC_KP_2,   KC_KP_3,     KC_PMNS, TG(_MIDI),
+    KC_KP_0, KC_KP_DOT, KC_KP_EQUAL, KC_PPLS, MO(_MUSIC)
+  ),
+
+// MUSIC LAYER
+ //          ┌─────────┬─────────┬─────────┬─────────┬─────────┐
+ //          │         │         │         │         │         │
+ //          │         │         │         │         │         │
+ // ROTORY   │         │         │         │         │         │
+ // RIGHT:   ├─────────┼─────────┼─────────┼─────────┼─────────┤
+ // PAGE UP  │         │         │         │         │         │
+ //          │         │         │         │         │         │
+ // ROTORY   │         │         │         │         │         │
+ // LEFT:    ├─────────┼─────────┼─────────┼─────────┼─────────┤
+ // PAGE DOWN│         │         │         │         │         │
+ //          │         │         │         │  MODE   │         │
+ //          │         │         │         │         │         │
+ //┌─────────┼─────────┼─────────┼─────────┼─────────┼─────────┤
+ //│         │         │         │         │         │         │
+ //│         │ RECORD  │  STOP   │         │  PLAY   │         │
+ //│         │         │         │         │         │         │
+ //└─────────┴─────────┴─────────┴─────────┴─────────┴─────────┘
+
+  [_MUSIC] = LAYOUT(
+    _______, _______, _______, _______, _______, _______,
+    _______, _______, _______, _______, _______,
+    _______, _______, _______, _______, MU_MOD,
+    KC_LCTL, KC_LALT, _______, KC_LGUI, _______
+  ),
+
+// MIDI LAYER
+//           ┌─────────┬─────────┬─────────┬─────────┬─────────┐
+//           │         │         │         │         │         │
+//           │   D♯    │    E    │    F    │   F♯    │    G    │
+//  ROTORY   │         │         │         │         │         │
+//  RIGHT:   ├─────────┼─────────┼─────────┼─────────┼─────────┤
+//  PAGE UP  │         │         │         │         │         │
+//           │   A♯    │    B    │    C    │   C♯    │    D    │
+//  ROTORY   │         │         │         │         │         │
+//  LEFT:    ├─────────┼─────────┼─────────┼─────────┼─────────┤
+//  PAGE DOWN│         │         │         │         │         │
+//           │    F    │   F♯    │    G    │   G♯    │    A    │
+//           │         │         │         │         │         │
+// ┌─────────┼─────────┼─────────┼─────────┼─────────┼─────────┤
+// │         │         │         │         │         │         │
+// │         │    C    │   C♯    │    D    │   D♯    │    E    │
+// │         │         │         │         │         │         │
+// └─────────┴─────────┴─────────┴─────────┴─────────┴─────────┘
+
+  [_MIDI] = LAYOUT(
+    MI_Ds_3, MI_E_3,  MI_F_3, MI_Fs_3, MI_G_3, _______,
+    MI_As_2, MI_B_2,  MI_C_3, MI_Cs_3, MI_D_3,
+    MI_F_2,  MI_Fs_2, MI_G_2, MI_Gs_2, TG(_MIDI),
+    MI_C_2,  MI_Cs_2, MI_D_2, MI_Ds_2, MI_E_2
+  ),
+
+// MOUSE LAYER
+//           ┌─────────┬─────────┬─────────┬─────────┬─────────┐
+//           │         │         │         │         │         │
+//           │  BTN 5  │         │  WHEEL  │         │         │
+//  ROTORY   │         │         │   UP    │         │         │
+//  RIGHT:   ├─────────┼─────────┼─────────┼─────────┼─────────┤
+//  PAGE DOWN│         │         │         │         │         │
+//           │         │  LEFT   │  MOUSE  │  RIGHT  │         │
+//  ROTORY   │         │  CLICK  │   UP    │  CLICK  │         │
+//  LEFT:    ├─────────┼─────────┼─────────┼─────────┼─────────┤
+//  PAGE UP  │         │         │         │         │         │
+//           │  BTN 4  │  MOUSE  │  MOUSE  │  MOUSE  │         │
+//           │         │  LEFT   │  DOWN   │  RIGHT  │         │
+// ┌─────────┼─────────┼─────────┼─────────┼─────────┼─────────┤
+// │         │         │         │         │         │         │
+// │         │  BTN 3  │  WHEEL  │  WHEEL  │  WHEEL  │         │
+// │         │         │  LEFT   │  DOWN   │  RIGHT  │         │
+// └─────────┴─────────┴─────────┴─────────┴─────────┴─────────┘
+
+  [_MOUSE] = LAYOUT(
+    KC_MS_BTN5, _______,       KC_MS_WH_UP,   _______,        _______,    _______,
+    _______,    KC_MS_BTN1,    KC_MS_UP,      KC_MS_BTN2,     TG(_MOUSE),
+    KC_MS_BTN4, KC_MS_LEFT,    KC_MS_DOWN,    KC_MS_RIGHT,    _______,
+    KC_MS_BTN3, KC_MS_WH_LEFT, KC_MS_WH_DOWN, KC_MS_WH_RIGHT, _______
+  ),
+
+// ADMIN LAYER
+//           ┌─────────┬─────────┬─────────┬─────────┬─────────┐
+//           │         │         │         │         │         │
+//           │  RESET  │         │         │         │         │
+//  ROTORY   │         │         │         │         │         │
+//  RIGHT:   ├─────────┼─────────┼─────────┼─────────┼─────────┤
+//  PAGE UP  │         │         │         │         │         │
+//           │    4    │    5    │    6    │    *    │         │
+//  ROTORY   │         │         │         │         │         │
+//  LEFT:    ├─────────┼─────────┼─────────┼─────────┼─────────┤
+//  PAGE DOWN│         │         │         │         │         │
+//           │    1    │    2    │    3    │         │         │
+//           │         │         │         │         │         │
+// ┌─────────┼─────────┼─────────┼─────────┼─────────┼─────────┤
+// │         │         │         │         │         │         │
+// │         │    0    │    .    │    =    │         │         │
+// │         │         │         │         │         │         │
+// └─────────┴─────────┴─────────┴─────────┴─────────┴─────────┘
+
+  [_ADMIN] = LAYOUT(
+    RESET,   _______, _______, _______, TG(_ADMIN), _______,
+    _______, _______, _______, _______, _______,
+    _______, _______, _______, _______, _______,
+    _______, _______, _______, _______, _______
+  ),
+};
+
+bool process_record_user(uint16_t keycode, keyrecord_t *record) {
+  return true;
+};
+
+void encoder_update_user(uint8_t index, bool clockwise) {
+  if (index == 0) { /* First encoder */
+    if (clockwise) {
+      tap_code(KC_PGDN);
+    } else {
+      tap_code(KC_PGUP);
+    }
+  }
+}

keyboards/ckeys/thedora/keymaps/default/readme.md

@@ -0,0 +1 @@
+# The default keymap for the cKeys Handwire 101 4x4 keyboard.

keyboards/ckeys/thedora/readme.md

@@ -0,0 +1,57 @@
+# theDora Board
+
+![Thedora Board](https://ckeys.org/images/exboard-3.jpg)
+
+A 4x5 keyboard with rotary encoder, QWIIC connector, and header pinouts for easy access to all pins on the Proton C. This keyboard was built for QMK exploration big and small. What will you discover next?
+
+Keyboard Maintainer: [brandenbyers](https://github.com/brandenbyers)  
+Hardware Supported: theDora  
+Hardware Availability: [cKeys.org](https://ckeys.org)
+
+Make example for this keyboard (after setting up your build environment):
+
+`make ckeys/thedora:default`
+
+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](Complete Newbs Guide).
+
+---
+
+## Slides
+
+Slides can be found at: https://ckeys.org/slides/exboard/
+
+## Case Design
+
+The acrylic laser cutter file is coming soon!
+
+## PCB Design
+
+All cKeys PCBs are open source. However, this one has not been posted yet because it needs to be cleaned up a bit! Coming soon!
+
+## Firmware
+
+If you want to reflash the pre-installed firmware, use the `.bin` file for Proton C. Flash with the QMK Toolbox or via the command line.
+
+Building for Proton C: `make ckeys/thedora:default`
+
+## Default Layout
+
+You can find the default layout in `thedora/keymaps/default/keymap.c`
+
+## Rotary Encoder
+
+This is the bit of code at the end of `keymap.c` that needs to changed if you want to change the behavior of the rotary encoder.
+
+```
+void encoder_update_user(uint8_t index, bool clockwise) {
+  if (index == 0) { /* First encoder */
+    if (clockwise) {
+      tap_code(KC_PGDN); // What the rotary encoder repeatedly does when turned right.
+    } else {
+      tap_code(KC_PGUP); // What it does when turned to the left.
+    }
+  }
+}
+```
+
+![The Dora Board](https://ckeys.org/images/exboard-1.jpg)

keyboards/ckeys/thedora/rules.mk

@@ -0,0 +1,19 @@
+MCU = STM32F303
+
+# Build Options
+#   comment out to disable the options.
+#
+BACKLIGHT_ENABLE = no
+BOOTMAGIC_ENABLE = yes  # Virtual DIP switch configuration
+## (Note that for BOOTMAGIC on Teensy LC you have to use a custom .ld script.)
+MOUSEKEY_ENABLE = yes # Mouse keys
+EXTRAKEY_ENABLE = yes # Audio control and System control
+CONSOLE_ENABLE = no  # Console for debug
+COMMAND_ENABLE = no    # Commands for debug and configuration
+#SLEEP_LED_ENABLE = yes  # Breathing sleep LED during USB suspend
+NKRO_ENABLE = yes     # USB Nkey Rollover
+AUDIO_ENABLE = yes
+MIDI_ENABLE = yes     # MIDI controls
+RGBLIGHT_ENABLE = no
+ENCODER_ENABLE = yes
+# SERIAL_LINK_ENABLE = yes

keyboards/ckeys/thedora/thedora.c

@@ -0,0 +1,28 @@
+#include "thedora.h"
+
+void matrix_init_kb(void) {
+  // put your keyboard start-up code here
+  // runs once when the firmware starts up
+  // Turn status LED on
+  //DDRD |= (1<<6);
+  //PORTD |= (1<<6);
+
+  matrix_init_user();
+}
+
+void matrix_scan_kb(void) {
+  // put your looping keyboard code here
+  // runs every cycle (a lot)
+  matrix_scan_user();
+}
+
+bool process_record_kb(uint16_t keycode, keyrecord_t *record) {
+  // put your per-action keyboard code here
+  // runs for every action, just before processing by the firmware
+  return process_record_user(keycode, record);
+}
+
+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);
+}

keyboards/ckeys/thedora/thedora.h

@@ -0,0 +1,21 @@
+#pragma once
+
+#include "quantum.h"
+
+// This a shortcut to help you visually see your layout.
+// The following is an example using the Planck MIT layout
+// The first section contains all of the arguements
+// The second converts the arguments into a two-dimensional array
+#define LAYOUT( \
+    k00, k01, k02, k03, k04, k05, \
+    k06, k07, k08, k09, k10, \
+    k11, k12, k13, k14, k15, \
+    k16, k17, k18, k19, k20 \
+) \
+{ \
+    { k00, k01, k02, k03, k04, k05, }, \
+    { k06, k07, k08, k09, k10 },       \
+    { k11, k12, k13, k14, k15 },       \
+    { k16, k17, k18, k19, k20 }        \
+}
+