~ruther/qmk_firmware

051bde9c63cbfa5c5fbebc53daa59ce30fb0cebd — Josh Johnson 3 years ago 7c2b2c8
[Keyboard] Add Chalice Support (#15106)

Co-authored-by: Drashna Jaelre <drashna@live.com>
Co-authored-by: Ryan <fauxpark@gmail.com>
A keyboards/chalice/chalice.c => keyboards/chalice/chalice.c +18 -0
@@ 0,0 1,18 @@
/* Copyright 2020 null-ll
 * Copyright 2021 Jels, Josh Johnson
 *
 * 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 "chalice.h"

A keyboards/chalice/chalice.h => keyboards/chalice/chalice.h +60 -0
@@ 0,0 1,60 @@
/* Copyright 2020 null-ll
 * Copyright 2021 Jels, Josh Johnson
 *
 * 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 ____ KC_NO

#include "quantum.h"

#define LAYOUT_default( \
	  K000,  K001,  K002,  K003,  K004,  K005,  K006,  K007,  K008,  K009,  K010,  K011,  K012,  K013,  K014,        \
	  K100,  K101,  K102,  K103,  K104,  K105,  K106,  K107,  K108,  K109,  K110,  K111,  K112,  K113,  K114, 		 \
	  K200,  K201,  K202,  K203,  K204,  K205,  K206,  K207,  K208,  K209,  K210,  K211,  K212,  K213,               \
	         K301,  K302,  K303,  K304,  K305,  K306,  K307,  K308,  K309,  K310,  K311,  K312,  K313,  K214,        \
	         K401,  K402,         K404,         K406,         K408,         K410,  K411,         K412,  K413,  K314  \
) { \
	{ K000,  K002,  K004,  K006,  K008,  K010,  K012 }, \
	{ K001,  K003,  K005,  K007,  K009,  K011,  K013 }, \
	{ K100,  K102,  K104,  K106,  K108,  K110,  K112 }, \
	{ K101,  K103,  K105,  K107,  K109,  K111,  K113 }, \
	{ K200,  K202,  K204,  K206,  K208,  K210,  K014 }, \
	{ K201,  K203,  K205,  K207,  K209,  K211,  K114 }, \
	{ K301,  K303,  K305,  K307,  K309,  K311,  K212 }, \
	{ K302,  K304,  K306,  K308,  K310,  K312,  K213 }, \
	{ K401,  ____,  K404,  K408,  K411,  K413,  K313 }, \
	{ ____,  K402,  K406,  K410,  K412,  K314,  K214 }  \
}

#define LAYOUT_split_bs( \
	  K000,  K001,  K002,  K003,  K004,  K005,  K006,  K007,  K008,  K009,  K010,  K011,  K012,  K013,  K014,  K403, \
	  K100,  K101,  K102,  K103,  K104,  K105,  K106,  K107,  K108,  K109,  K110,  K111,  K112,  K113,  K114, 		 \
	  K200,  K201,  K202,  K203,  K204,  K205,  K206,  K207,  K208,  K209,  K210,  K211,  K212,  K213,               \
	         K301,  K302,  K303,  K304,  K305,  K306,  K307,  K308,  K309,  K310,  K311,  K312,  K313,  K214,        \
	         K401,  K402,         K404,         K406,         K408,         K410,  K411,         K412,  K413,  K314  \
) { \
	{ K000,  K002,  K004,  K006,  K008,  K010,  K012 }, \
	{ K001,  K003,  K005,  K007,  K009,  K011,  K013 }, \
	{ K100,  K102,  K104,  K106,  K108,  K110,  K112 }, \
	{ K101,  K103,  K105,  K107,  K109,  K111,  K113 }, \
	{ K200,  K202,  K204,  K206,  K208,  K210,  K014 }, \
	{ K201,  K203,  K205,  K207,  K209,  K211,  K114 }, \
	{ K301,  K303,  K305,  K307,  K309,  K311,  K212 }, \
	{ K302,  K304,  K306,  K308,  K310,  K312,  K213 }, \
	{ K401,  K403,  K404,  K408,  K411,  K413,  K313 }, \
	{ ____,  K402,  K406,  K410,  K412,  K314,  K214 }  \
}

A keyboards/chalice/config.h => keyboards/chalice/config.h +66 -0
@@ 0,0 1,66 @@
/* Copyright 2020 null-ll
 * Copyright 2021 Jels, Josh Johnson
 *
 * 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 VENDOR_ID       0x6A6A
#define PRODUCT_ID      0x000C
#define DEVICE_VER      0x0001
#define MANUFACTURER    CustomKBD
#define PRODUCT         Chalice

/* key matrix size */
#define MATRIX_ROWS 10
#define MATRIX_COLS 7

#define MATRIX_ROW_PINS {F4, D1, D0, F5, D4, F6, B4, B5, B2, B6}
#define MATRIX_COL_PINS {F7, C6, B1, D2, E6, B3, D7}

/* COL2ROW, ROW2COL*/
#define DIODE_DIRECTION COL2ROW

#define RGB_DI_PIN D3

#ifdef RGBLIGHT_ENABLE
    #define RGBLED_NUM 14
    #define RGBLIGHT_SLEEP  
#define RGBLIGHT_EFFECT_BREATHING
#define RGBLIGHT_EFFECT_RAINBOW_MOOD
#define RGBLIGHT_EFFECT_RAINBOW_SWIRL
#define RGBLIGHT_EFFECT_SNAKE
#define RGBLIGHT_EFFECT_KNIGHT
#define RGBLIGHT_EFFECT_CHRISTMAS
#define RGBLIGHT_EFFECT_STATIC_GRADIENT
#define RGBLIGHT_EFFECT_RGB_TEST
#define RGBLIGHT_EFFECT_ALTERNATING
#define RGBLIGHT_EFFECT_TWINKLE
#endif

/* Debounce reduces chatter (unintended double-presses) - set 0 if debouncing is not needed */
#define DEBOUNCE 5

/* 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

/* Bootmagic Lite key configuration */
#define BOOTMAGIC_LITE_ROW 0
#define BOOTMAGIC_LITE_COLUMN 0


A keyboards/chalice/info.json => keyboards/chalice/info.json +79 -0
@@ 0,0 1,79 @@
{
    "keyboard_name": "Chalice",
    "url": "https://customkbd.com/products/chalice-pre-order",
    "maintainer": "CustomKBD",
    "layouts": {
        "LAYOUT_default": {
            "layout": [
                {"label":"Esc", "x":0, "y":0},
                {"label":"~", "x":1.5, "y":0},
                {"label":"!", "x":2.5, "y":0},
                {"label":"@", "x":3.5, "y":0},
                {"label":"#", "x":4.5, "y":0},
                {"label":"$", "x":5.5, "y":0},
                {"label":"%", "x":6.5, "y":0},
                {"label":"^", "x":7.5, "y":0},
                {"label":"&", "x":10.5, "y":0},
                {"label":"*", "x":11.5, "y":0},
                {"label":"(", "x":12.5, "y":0},
                {"label":")", "x":13.5, "y":0},
                {"label":"_", "x":14.5, "y":0},
                {"label":"+", "x":15.5, "y":0},
                {"label":"Backspace", "x":16.5, "y":0, "w":2},
                {"label":"Tab", "x":1.5, "y":1, "w":1.5},
                {"label":"Q", "x":3, "y":1},
                {"label":"W", "x":4, "y":1},
                {"label":"E", "x":5, "y":1},
                {"label":"R", "x":6, "y":1},
                {"label":"T", "x":7, "y":1},
                {"label":"Y", "x":10, "y":1},
                {"label":"U", "x":11, "y":1},
                {"label":"I", "x":12, "y":1},
                {"label":"O", "x":13, "y":1},
                {"label":"P", "x":14, "y":1},
                {"label":"{", "x":15, "y":1},
                {"label":"}", "x":16, "y":1},
                {"label":"|", "x":17, "y":1, "w":1.5},
                {"label":"Mute", "x":19, "y":0.5},
                {"label":"Delete", "x":0, "y":2},
                {"label":"Caps Lock", "x":1.5, "y":2, "w":1.75},
                {"label":"A", "x":3.25, "y":2},
                {"label":"S", "x":4.25, "y":2},
                {"label":"D", "x":5.25, "y":2},
                {"label":"F", "x":6.25, "y":2},
                {"label":"G", "x":7.25, "y":2},
                {"label":"H", "x":10.25, "y":2},
                {"label":"J", "x":11.25, "y":2},
                {"label":"K", "x":12.25, "y":2},
                {"label":"L", "x":13.25, "y":2},
                {"label":":", "x":14.25, "y":2},
                {"label":"\"", "x":15.25, "y":2},
                {"label":"Enter", "x":16.25, "y":2, "w":2.25},
                {"label":"Shift", "x":1.5, "y":3, "w":2.25},
                {"label":"Z", "x":3.75, "y":3},
                {"label":"X", "x":4.75, "y":3},
                {"label":"C", "x":5.75, "y":3},
                {"label":"V", "x":6.75, "y":3},
                {"label":"B", "x":7.75, "y":3},
                {"label":"B", "x":9.75, "y":3},
                {"label":"N", "x":10.75, "y":3},
                {"label":"M", "x":11.75, "y":3},
                {"label":"<", "x":12.75, "y":3},
                {"label":">", "x":13.75, "y":3},
                {"label":"?", "x":14.75, "y":3},
                {"label":"Shift", "x":15.75, "y":3, "w":1.75},
                {"label":"Up", "x":17.75, "y":3.25},
                {"label":"Ctrl", "x":1.5, "y":4, "w":1.5},
                {"label":"Alt", "x":4.5, "y":4, "w":1.5},
                {"label":"Space", "x":6, "y":4, "w":2},
                {"label":"Fn", "x":8, "y":4},
                {"label":"Space", "x":9.75, "y":4, "w":2.75},
                {"label":"Alt", "x":12.5, "y":4, "w":1.5},
                {"label":"Ctrl", "x":15, "y":4, "w":1.5},
                {"label":"Left", "x":16.75, "y":4.25},
                {"label":"Down", "x":17.75, "y":4.25},
                {"label":"Right", "x":18.75, "y":4.25}
            ]
        }
    }
}

A keyboards/chalice/keymaps/default/keymap.c => keyboards/chalice/keymaps/default/keymap.c +55 -0
@@ 0,0 1,55 @@
/* Copyright 2020 null-ll
 * Copyright 2021 Jels, Josh Johnson
 *
 * 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


const uint16_t PROGMEM keymaps[][MATRIX_ROWS][MATRIX_COLS] = {

  [0] = LAYOUT_default(
      KC_ESC,  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_INS,  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_DEL,  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_ENT,
               KC_LSFT, KC_Z,    KC_X,    KC_C,    KC_V,    KC_B,    KC_B,    KC_N,    KC_M,    KC_COMM, KC_DOT,  KC_SLSH, KC_RSFT, KC_UP,
               KC_LCTL, KC_LALT,          KC_SPC,           MO(1),            KC_SPC,           KC_RALT, KC_RCTL,          KC_LEFT, KC_DOWN, KC_RIGHT
    ),


  [1] = LAYOUT_default(
      RESET,   _______, KC_F1,   KC_F2,   KC_F3,   KC_F4,   KC_F5,   KC_F6,   KC_F7,   KC_F8,   KC_F9,   KC_F10,  KC_F11,  KC_F12,  _______,
      _______, _______, RGB_TOG, RGB_HUD, RGB_HUI, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______,
      _______, _______, RGB_MOD, RGB_SAD, RGB_SAI, _______, _______, _______, _______, _______, _______, _______, _______, _______,
               _______, RGB_RMOD,RGB_VAD, RGB_VAI, _______, _______, _______, _______, _______, _______, _______, _______, _______, KC_PGUP,
               _______, _______,          _______,          _______,          _______,          _______, _______,          KC_HOME, KC_PGDN, KC_END
    ),

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

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

A keyboards/chalice/keymaps/via/keymap.c => keyboards/chalice/keymaps/via/keymap.c +55 -0
@@ 0,0 1,55 @@
/* Copyright 2020 null-ll
 * Copyright 2021 Jels, Josh Johnson
 *
 * 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


const uint16_t PROGMEM keymaps[][MATRIX_ROWS][MATRIX_COLS] = {

  [0] = LAYOUT_default(
      KC_ESC,  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_INS,  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_DEL,  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_ENT,
               KC_LSFT, KC_Z,    KC_X,    KC_C,    KC_V,    KC_B,    KC_B,    KC_N,    KC_M,    KC_COMM, KC_DOT,  KC_SLSH, KC_RSFT, KC_UP,
               KC_LCTL, KC_LALT,          KC_SPC,           MO(1),            KC_SPC,           KC_RALT, KC_RCTL,          KC_LEFT, KC_DOWN, KC_RIGHT
    ),


  [1] = LAYOUT_default(
      RESET,   _______, KC_F1,   KC_F2,   KC_F3,   KC_F4,   KC_F5,   KC_F6,   KC_F7,   KC_F8,   KC_F9,   KC_F10,  KC_F11,  KC_F12,  _______,
      _______, _______, RGB_TOG, RGB_HUD, RGB_HUI, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______,
      _______, _______, RGB_MOD, RGB_SAD, RGB_SAI, _______, _______, _______, _______, _______, _______, _______, _______, _______,
               _______, RGB_RMOD,RGB_VAD, RGB_VAI, _______, _______, _______, _______, _______, _______, _______, _______, _______, KC_PGUP,
               _______, _______,          _______,          _______,          _______,          _______, _______,          KC_HOME, KC_PGDN, KC_END
    ),

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

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

A keyboards/chalice/keymaps/via/rules.mk => keyboards/chalice/keymaps/via/rules.mk +1 -0
@@ 0,0 1,1 @@
VIA_ENABLE = yes
\ No newline at end of file

A keyboards/chalice/readme.md => keyboards/chalice/readme.md +25 -0
@@ 0,0 1,25 @@
# Chalice

A Cheap Alice, powered by a Pro-Micro

* Keyboard Maintainer: [CustomKBD](https://github.com/customkbd/)
* Hardware Supported: Pro-Micro (or equivalent - Sea Micro, Elite-C etc.)
* Hardware Availability: [CustomKBD](https://customkbd.com/products/chalice-pre-order)

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

    make chalice:default

Flashing example for this keyboard:

    make chalice:default:flash
    
## Bootloader

Enter the bootloader in 3 ways:

* **Bootmagic reset**: Hold down Escape and plug in the keyboard.
* **Physical reset button**: Briefly press the reset button below the pro-micro.
* **Keycode in layout**: The `RESET` key can be found by holding `FUNC` in between the space bars and pressing `ESC`.

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/chalice/rules.mk => keyboards/chalice/rules.mk +21 -0
@@ 0,0 1,21 @@
# MCU name
MCU = atmega32u4

# Bootloader selection
BOOTLOADER = atmel-dfu

# Build Options
#   change yes to no to disable
#
BOOTMAGIC_ENABLE = yes      # Enable Bootmagic Lite
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 = yes           # USB Nkey Rollover
BACKLIGHT_ENABLE = no       # Enable keyboard backlight functionality
RGBLIGHT_ENABLE = yes       # Enable keyboard RGB underglow
AUDIO_ENABLE = no           # Audio output