~ruther/qmk_firmware

78693dfa31a1b63f2e88817a64fb96d14b198dc9 — David Dejaeghere 4 years ago d6701b3
[Keyboard] adding support for new keyboard Dawn (#11564)

* initial commit Dawn keyboard

* fixing some matrix

* final tweaks to keymaps and info.json layout

* fix info.json missing delimiter

* missing elements in info.json layout, resolved through lint

* fixed missing link image in readme

* Update keyboards/mechstudio/dawn/readme.md

Co-authored-by: Ryan <fauxpark@gmail.com>

Co-authored-by: David <david@tarpit.be>
Co-authored-by: Ryan <fauxpark@gmail.com>
A keyboards/mechstudio/dawn/config.h => keyboards/mechstudio/dawn/config.h +48 -0
@@ 0,0 1,48 @@
/* Copyright 2020 David Dejaeghere
 *
 * 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       0x4D53
#define PRODUCT_ID      0x0004
#define DEVICE_VER      0x0004
#define MANUFACTURER    Mech Studio
#define PRODUCT         Dawn

/* key matrix size */
#define MATRIX_ROWS 6
#define MATRIX_COLS 15

// ROWS: Top to bottom, COLS: Left to right

#define MATRIX_ROW_PINS {B1,B2,B3,D1,D6,D4}
#define MATRIX_COL_PINS {F0,F1,F4,F5,F6,F7,C7,C6,B6,B5,B4,D7,D5,D3,D2}
#define UNUSED_PINS {B0,B7,D0,E6}

/* COL2ROW, ROW2COL*/
#define DIODE_DIRECTION COL2ROW

/* set 0 if debouncing is not needed */
#define DEBOUNCE 5

/* define if matrix has ghost (lacks anti-ghosting diodes) */
//#define MATRIX_HAS_GHOST

#define QMK_ESC_OUTPUT F0 // usually COL
#define QMK_ESC_INPUT B1 // usually ROW

A keyboards/mechstudio/dawn/dawn.c => keyboards/mechstudio/dawn/dawn.c +16 -0
@@ 0,0 1,16 @@
/* Copyright 2020 David Dejaeghere
 *
 * 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/>.
 */
#include "dawn.h"

A keyboards/mechstudio/dawn/dawn.h => keyboards/mechstudio/dawn/dawn.h +36 -0
@@ 0,0 1,36 @@
/* Copyright 2020 David "NecromanX" Dejaeghere  <david.dejaeghere@tarpit.be>
 *
 * 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 "quantum.h"

#define ___ KC_NO

#define LAYOUT( \
	K00, K01, K02, K03, K04, K05, K06, K07, K08,      K0A, K0B, K0C, K0D, K0E, \
	K10, K11, K12, K13, K14, K15, K16, K17, K18, K19, K1A, K1B, K1C, K1D, K1E, \
	K20, K21, K22, K23, K24, K25, K26, K27, K28, K29, K2A, K2B, K2C, K2D, K2E, \
	K30, K31, K32, K33, K34, K35, K36, K37, K38, K39, K3A, K3B, K3C, K3D, K3E, \
	K40, K41, K42, K43, K44, K45, K46, K47, K48, K49, K4A, K4B, K4C, K4D, K4E, \
	K50, K51, K52,                K56,                K5A, K5B, K5C, K5D, K5E \
) { \
    { K00, K01, K02, K03, K04, K05, K06, K07, K08, ___, K0A, K0B, K0C, K0D, K0E}, \
    { K10, K11, K12, K13, K14, K15, K16, K17, K18, K19, K1A, K1B, K1C, K1D, K1E}, \
    { K20, K21, K22, K23, K24, K25, K26, K27, K28, K29, K2A, K2B, K2C, K2D, K2E}, \
    { K30, K31, K32, K33, K34, K35, K36, K37, K38, K39, K3A, K3B, K3C, K3D, K3E}, \
    { K40, K41, K42, K43, K44, K45, K46, K47, K48, K49, K4A, K4B, K4C, K4D, K4E}, \
    { K50, K51, K52, ___, ___, ___, K56, ___, ___, ___, K5A, K5B, K5C, K5D, K5E} \
}

A keyboards/mechstudio/dawn/info.json => keyboards/mechstudio/dawn/info.json +99 -0
@@ 0,0 1,99 @@
{
  "keyboard_name": "Dawn", 
  "url": "https://mech.studio/projects/dawn/", 
  "maintainer": "dejaeghered", 
  "width": 15, 
  "height": 6, 
  "layouts": {
    "LAYOUT": {
      "layout": [
        {"label":"Esc", "x":0, "y":0},
        {"label":"F1", "x":1.5, "y":0},
        {"label":"F2", "x":2.5, "y":0},
        {"label":"F3", "x":3.5, "y":0},
        {"label":"F4", "x":4.5, "y":0},
        {"label":"F5", "x":6, "y":0},
        {"label":"F6", "x":7, "y":0},
        {"label":"F7", "x":8, "y":0},
        {"label":"F8", "x":9, "y":0},
        {"label":"F9", "x":10.5, "y":0},
        {"label":"F10", "x":11.5, "y":0},
        {"label":"F11", "x":12.5, "y":0},
        {"label":"F12", "x":13.5, "y":0},
        {"label":"Home", "x":15, "y":0},

        {"label":"`", "x":0, "y":1.25},
        {"label":"1", "x":1, "y":1.25},
        {"label":"2", "x":2, "y":1.25},
        {"label":"3", "x":3, "y":1.25},
        {"label":"4", "x":4, "y":1.25},
        {"label":"5", "x":5, "y":1.25},
        {"label":"6", "x":6, "y":1.25},
        {"label":"7", "x":7, "y":1.25},
        {"label":"8", "x":8, "y":1.25},
        {"label":"9", "x":9, "y":1.25},
        {"label":"0", "x":10, "y":1.25},
        {"label":"-", "x":11, "y":1.25},
        {"label":"=", "x":12, "y":1.25},
        {"label":"\\", "x":13, "y":1.25},
        {"label":"Backspace", "x":13, "y":1.25},
        {"label":"Page Up", "x":15, "y":1.25},

        {"label":"Tab", "x":0, "y":2.25, "w":1.5},
        {"label":"Q", "x":1.5, "y":2.25},
        {"label":"W", "x":2.5, "y":2.25},
        {"label":"E", "x":3.5, "y":2.25},
        {"label":"R", "x":4.5, "y":2.25},
        {"label":"T", "x":5.5, "y":2.25},
        {"label":"Y", "x":6.5, "y":2.25},
        {"label":"U", "x":7.5, "y":2.25},
        {"label":"I", "x":8.5, "y":2.25},
        {"label":"O", "x":9.5, "y":2.25},
        {"label":"P", "x":10.5, "y":2.25},
        {"label":"[", "x":11.5, "y":2.25},
        {"label":"]", "x":12.5, "y":2.25},
        {"label":"\\", "x":13.5, "y":2.25, "w":1.5},
        {"label":"Page Down", "x":15, "y":2.25},
        {"label":"Caps Lock", "x":0, "y":3.25, "w":1.75},
        {"label":"A", "x":1.75, "y":3.25},
        {"label":"S", "x":2.75, "y":3.25},
        {"label":"D", "x":3.75, "y":3.25},
        {"label":"F", "x":4.75, "y":3.25},
        {"label":"G", "x":5.75, "y":3.25},
        {"label":"H", "x":6.75, "y":3.25},
        {"label":"J", "x":7.75, "y":3.25},
        {"label":"K", "x":8.75, "y":3.25},
        {"label":"L", "x":9.75, "y":3.25},
        {"label":";", "x":10.75, "y":3.25},
        {"label":"'", "x":11.75, "y":3.25},
        {"label":"Enter", "x":12.75, "y":3.25, "w":2.25},
        {"label":"End", "x":15, "y":3.25},

        {"label":"Left Shift", "x":0, "y":4.25, "w":1.25},
        {"label":"\\", "x":0, "y":4.25},
        {"label":"Z", "x":2.25, "y":4.25},
        {"label":"X", "x":3.25, "y":4.25},
        {"label":"C", "x":4.25, "y":4.25},
        {"label":"V", "x":5.25, "y":4.25},
        {"label":"B", "x":6.25, "y":4.25},
        {"label":"N", "x":7.25, "y":4.25},
        {"label":"M", "x":8.25, "y":4.25},
        {"label":"<", "x":9.25, "y":4.25},
        {"label":">", "x":10.25, "y":4.25},
        {"label":"?", "x":11.25, "y":4.25},
        {"label":"Right Shift", "x":12.25, "y":4.25, "w":1.75},
        {"label":"Up", "x":14, "y":4.25},
        {"label":"Del", "x":15, "y":4.25},
        
        {"label":"Left Ctrl", "x":0, "y":5.25, "w":1.5},
        {"label":"Win", "x":1.5, "y":5.25},
        {"label":"Left Alt", "x":2.5, "y":5.25, "w":1.25},
        {"label":"Space", "x":3.75, "y":5.25, "w":6.25},
        {"label":"Right Alt", "x":10, "y":5.25, "w":1.25},
        {"label":"Right Ctrl", "x":11.25, "y":5.25, "w":1.25},
        {"label":"Left", "x":13, "y":5.25},
        {"label":"Down", "x":14, "y":5.25},
        {"label":"Right", "x":15, "y":5.25}]
    }
  }
}
\ No newline at end of file

A keyboards/mechstudio/dawn/keymaps/default/keymap.c => keyboards/mechstudio/dawn/keymaps/default/keymap.c +38 -0
@@ 0,0 1,38 @@
/* Copyright 2020 David Dejaeghere
 *
 * 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/>.
 */
#include QMK_KEYBOARD_H

// Defines names for use in layer keycodes and the keymap


const uint16_t PROGMEM keymaps[][MATRIX_ROWS][MATRIX_COLS] = {
  [0] = LAYOUT(
        KC_ESC , 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_HOME ,
        KC_GRV , KC_1   , KC_2   , KC_3   , KC_4   , KC_5   , KC_6   , KC_7   , KC_8   , KC_9   , KC_0   , KC_MINS, KC_EQL , KC_BSPC, KC_PGUP, 
        KC_TAB , KC_Q   , KC_W   , KC_E   , KC_R   , KC_T   , KC_Y   , KC_U   , KC_I   , KC_O   , KC_P   , KC_LBRC, KC_RBRC, KC_BSLS, KC_PGDN,
        KC_CAPS, KC_A   , KC_S   , KC_D   , KC_F   , KC_G   , KC_H   , KC_J   , KC_K   , KC_L   , KC_SCLN, KC_QUOT, KC_BSLS, KC_ENT , KC_END,
        KC_LSFT, KC_LSFT, KC_Z   , KC_X   , KC_C   , KC_V   , KC_B   , KC_N   , KC_M   , KC_COMM, KC_DOT , KC_SLSH, KC_RSFT, KC_UP  , MO(1) , 
        KC_LCTL, KC_LGUI, KC_LALT,                            KC_SPC ,                            KC_RALT, KC_RCTL, KC_LEFT, KC_DOWN, KC_RGHT),

  [1] = LAYOUT(
        RESET   , _______ , _______ , _______ , _______ , _______ , _______ , _______ ,           _______ , _______ , _______ , _______ , _______ , _______ ,
        _______ , _______ , _______ , _______ , _______ , _______ , _______ , _______ , _______ , _______ , _______ , _______ , _______ , _______ , _______ ,  
        _______ , _______ , _______ , _______ , _______ , _______ , _______ , _______ , _______ , _______ , _______ , _______ , _______ , _______ , _______ ,
        _______ , _______ , _______ , _______ , _______ , _______ , _______ , _______ , _______ , _______ , _______ , _______ , _______ , _______ , _______ ,
        _______ , _______ , _______ , _______ , _______ , _______ , _______ , _______ , _______ , _______ , _______ , _______ , _______ , _______ , _______ , 
        _______ , _______ , _______ ,                               _______ ,                               _______ , _______ , _______ , _______ , _______),
};


A keyboards/mechstudio/dawn/keymaps/via/keymap.c => keyboards/mechstudio/dawn/keymaps/via/keymap.c +52 -0
@@ 0,0 1,52 @@
/* Copyright 2020 David Dejaeghere
 *
 * 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/>.
 */
#include QMK_KEYBOARD_H

// Defines names for use in layer keycodes and the keymap

const uint16_t PROGMEM keymaps[][MATRIX_ROWS][MATRIX_COLS] = {
  [0] = LAYOUT(
        KC_ESC , 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_HOME ,
        KC_GRV , KC_1   , KC_2   , KC_3   , KC_4   , KC_5   , KC_6   , KC_7   , KC_8   , KC_9   , KC_0   , KC_MINS, KC_EQL , KC_BSPC, KC_PGUP, 
        KC_TAB , KC_Q   , KC_W   , KC_E   , KC_R   , KC_T   , KC_Y   , KC_U   , KC_I   , KC_O   , KC_P   , KC_LBRC, KC_RBRC, KC_BSLS, KC_PGDN,
        KC_CAPS, KC_A   , KC_S   , KC_D   , KC_F   , KC_G   , KC_H   , KC_J   , KC_K   , KC_L   , KC_SCLN, KC_QUOT, KC_BSLS, KC_ENT , KC_END,
        KC_LSFT, KC_LSFT, KC_Z   , KC_X   , KC_C   , KC_V   , KC_B   , KC_N   , KC_M   , KC_COMM, KC_DOT , KC_SLSH, KC_RSFT, KC_UP  , MO(1) , 
        KC_LCTL, KC_LGUI, KC_LALT,                            KC_SPC ,                            KC_RALT, KC_RCTL, KC_LEFT, KC_DOWN, KC_RGHT),

  [1] = LAYOUT(
        RESET   , _______ , _______ , _______ , _______ , _______ , _______ , _______ ,           _______ , _______ , _______ , _______ , _______ , _______ ,
        _______ , _______ , _______ , _______ , _______ , _______ , _______ , _______ , _______ , _______ , _______ , _______ , _______ , _______ , _______ ,  
        _______ , _______ , _______ , _______ , _______ , _______ , _______ , _______ , _______ , _______ , _______ , _______ , _______ , _______ , _______ ,
        _______ , _______ , _______ , _______ , _______ , _______ , _______ , _______ , _______ , _______ , _______ , _______ , _______ , _______ , _______ ,
        _______ , _______ , _______ , _______ , _______ , _______ , _______ , _______ , _______ , _______ , _______ , _______ , _______ , _______ , _______ , 
        _______ , _______ , _______ ,                               _______ ,                               _______ , _______ , _______ , _______ , _______),

  [2] = LAYOUT(
        _______ , _______ , _______ , _______ , _______ , _______ , _______ , _______ ,           _______ , _______ , _______ , _______ , _______ , _______ ,
        _______ , _______ , _______ , _______ , _______ , _______ , _______ , _______ , _______ , _______ , _______ , _______ , _______ , _______ , _______ ,  
        _______ , _______ , _______ , _______ , _______ , _______ , _______ , _______ , _______ , _______ , _______ , _______ , _______ , _______ , _______ ,
        _______ , _______ , _______ , _______ , _______ , _______ , _______ , _______ , _______ , _______ , _______ , _______ , _______ , _______ , _______ ,
        _______ , _______ , _______ , _______ , _______ , _______ , _______ , _______ , _______ , _______ , _______ , _______ , _______ , _______ , _______ , 
        _______ , _______ , _______ ,                               _______ ,                               _______ , _______ , _______ , _______ , _______),

  [3] = LAYOUT(
        _______ , _______ , _______ , _______ , _______ , _______ , _______ , _______ ,           _______ , _______ , _______ , _______ , _______ , _______ ,
        _______ , _______ , _______ , _______ , _______ , _______ , _______ , _______ , _______ , _______ , _______ , _______ , _______ , _______ , _______ ,  
        _______ , _______ , _______ , _______ , _______ , _______ , _______ , _______ , _______ , _______ , _______ , _______ , _______ , _______ , _______ ,
        _______ , _______ , _______ , _______ , _______ , _______ , _______ , _______ , _______ , _______ , _______ , _______ , _______ , _______ , _______ ,
        _______ , _______ , _______ , _______ , _______ , _______ , _______ , _______ , _______ , _______ , _______ , _______ , _______ , _______ , _______ , 
        _______ , _______ , _______ ,                               _______ ,                               _______ , _______ , _______ , _______ , _______),
};
\ No newline at end of file

A keyboards/mechstudio/dawn/keymaps/via/rules.mk => keyboards/mechstudio/dawn/keymaps/via/rules.mk +1 -0
@@ 0,0 1,1 @@
VIA_ENABLE = yes

A keyboards/mechstudio/dawn/readme.md => keyboards/mechstudio/dawn/readme.md +20 -0
@@ 0,0 1,20 @@
# Dawn

![Dawn](https://i.imgur.com/OD1OTU4h.jpg)

## Support
* Keyboard Maintainer: [NecromanX](https://github.com/dejaeghered)
* Hardware Supported: Dawn
* Hardware Availability: [mech.studio](https://mech.studio/projects/dawn/)

## Features
- QMK Firmware
- USB-C Connector
- no in switch LEDs

## Build
Make example for this keyboard (after setting up your build environment):

    make mechstudio/dawn: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](https://docs.qmk.fm/#/newbs).

A keyboards/mechstudio/dawn/rules.mk => keyboards/mechstudio/dawn/rules.mk +22 -0
@@ 0,0 1,22 @@
# MCU name
MCU = atmega32u4

# Bootloader selection
BOOTLOADER = qmk-dfu

# Build Options
#   change yes to no to disable
#
BOOTMAGIC_ENABLE = lite     # Virtual DIP switch configuration
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
# Do not enable SLEEP_LED_ENABLE. it uses the same timer as BACKLIGHT_ENABLE
SLEEP_LED_ENABLE = no       # Breathing sleep LED during USB suspend
# if this doesn't work, see here: https://github.com/tmk/tmk_keyboard/wiki/FAQ#nkro-doesnt-work
NKRO_ENABLE = no            # USB Nkey Rollover
BACKLIGHT_ENABLE = no       # Enable keyboard backlight functionality
RGBLIGHT_ENABLE = no       # Enable keyboard RGB underglow
BLUETOOTH_ENABLE = no       # Enable Bluetooth
AUDIO_ENABLE = no           # Audio output
\ No newline at end of file