~ruther/qmk_firmware

7aa74c227b03e882915b184d07a5e31c9d720710 — studiokestra 4 years ago 0fd95e5
[Keyboard] Add Studio Kestra Nue PCB (#12094)

A keyboards/studiokestra/nue/config.h => keyboards/studiokestra/nue/config.h +50 -0
@@ 0,0 1,50 @@
/*
Copyright 2021 Studio Kestra

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       0x7C10
#define PRODUCT_ID      0x0701
#define DEVICE_VER      0x0001
#define MANUFACTURER    Studio Kestra
#define PRODUCT         Nue

#define MATRIX_ROWS 5
#define MATRIX_COLS 14

#define MATRIX_COL_PINS { F0, F6, F7, D2, D3, D5, D4, D6, D7, B4, B5, B6, C6, C7 }
#define MATRIX_ROW_PINS { B0, B7, F1, F5, F4}
#define DIODE_DIRECTION COL2ROW

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

/* disable these deprecated features by default */
#define NO_ACTION_MACRO
#define NO_ACTION_FUNCTION

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

A keyboards/studiokestra/nue/info.json => keyboards/studiokestra/nue/info.json +80 -0
@@ 0,0 1,80 @@
{
    "keyboard_name": "Nue",
    "url": "https://studiokestra.ca/nue",
    "maintainer": "Studio Kestra",
    "width": 15,
    "height": 5,
    "layouts": {
        "LAYOUT":  {
            "layout": [
                {"x":0, "y":0}, 
                {"x":1, "y":0}, 
                {"x":2, "y":0}, 
                {"x":3, "y":0}, 
                {"x":4, "y":0}, 
                {"x":5, "y":0}, 
                {"x":6, "y":0}, 
                {"x":7, "y":0}, 
                {"x":8, "y":0}, 
                {"x":9, "y":0}, 
                {"x":10, "y":0}, 
                {"x":11, "y":0}, 
                {"x":12, "y":0}, 
                {"x":13, "y":0}, 
                {"x":14, "y":0}, 

                {"x":0, "y":1, "w":1.5}, 
                {"x":1.5, "y":1}, 
                {"x":2.5, "y":1}, 
                {"x":3.5, "y":1}, 
                {"x":4.5, "y":1}, 
                {"x":5.5, "y":1}, 
                {"x":6.5, "y":1}, 
                {"x":7.5, "y":1}, 
                {"x":8.5, "y":1}, 
                {"x":9.5, "y":1}, 
                {"x":10.5, "y":1}, 
                {"x":11.5, "y":1}, 
                {"x":12.5, "y":1}, 
                {"x":13.5, "y":1, "w":1.5}, 

                {"x":0, "y":2, "w":1.75}, 
                {"x":1.75, "y":2}, 
                {"x":2.75, "y":2}, 
                {"x":3.75, "y":2}, 
                {"x":4.75, "y":2}, 
                {"x":5.75, "y":2}, 
                {"x":6.75, "y":2}, 
                {"x":7.75, "y":2}, 
                {"x":8.75, "y":2}, 
                {"x":9.75, "y":2}, 
                {"x":10.75, "y":2}, 
                {"x":11.75, "y":2}, 
                {"x":12.75, "y":2, "w":2.25}, 

                {"x":0, "y":3, "w":1.25}, 
                {"x":1.25, "y":3}, 
                {"x":2.25, "y":3}, 
                {"x":3.25, "y":3}, 
                {"x":4.25, "y":3}, 
                {"x":5.25, "y":3}, 
                {"x":6.25, "y":3}, 
                {"x":7.25, "y":3}, 
                {"x":8.25, "y":3}, 
                {"x":9.25, "y":3}, 
                {"x":10.25, "y":3}, 
                {"x":11.25, "y":3}, 
                {"x":12.25, "y":3, "w":1.75}, 
                {"x":14, "y":3}, 

                {"x":0, "y":4, "w":1.25}, 
                {"x":1.25, "y":4, "w":1.25}, 
                {"x":2.5, "y":4, "w":1.25}, 
                {"x":3.75, "y":4, "w":6.25}, 
                {"x":10, "y":4, "w":1.25}, 
                {"x":11.25, "y":4, "w":1.25}, 
                {"x":12.5, "y":4, "w":1.25}, 
                {"x":13.75, "y":4, "w":1.25}]
        }
    }
}

A keyboards/studiokestra/nue/keymaps/default/keymap.c => keyboards/studiokestra/nue/keymaps/default/keymap.c +41 -0
@@ 0,0 1,41 @@
 /* Copyright 2021 Studio Kestra
  * 
  * 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
enum layer_names {
    _BASE,
    _FN
};

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


    [_BASE] = LAYOUT_all(
    KC_ESC,  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_BSPC,
    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_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_LSFT, KC_Z,    KC_X,    KC_C,    KC_V,    KC_B,    KC_N,    KC_M,    KC_COMM, KC_DOT,   KC_SLSH,    KC_RSFT,    MO(1),
    KC_LCTL, KC_LGUI, KC_LALT,                            KC_SPC,                    KC_RALT, KC_RGUI,  KC_MENU,    KC_RCTL),

    [_FN] = LAYOUT_all(
    KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS,
    KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS, RESET,   KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS,
    KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS,
    KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS,
    KC_TRNS, KC_TRNS, KC_TRNS,                            KC_MPLY,                   KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS),
};
\ No newline at end of file

A keyboards/studiokestra/nue/keymaps/default/readme.md => keyboards/studiokestra/nue/keymaps/default/readme.md +1 -0
@@ 0,0 1,1 @@
# The default keymap for Nue

A keyboards/studiokestra/nue/keymaps/via/keymap.c => keyboards/studiokestra/nue/keymaps/via/keymap.c +53 -0
@@ 0,0 1,53 @@
 /* Copyright 2021 Studio Kestra
  * 
  * 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
enum layer_names {
    _BASE,
    _FN1,
    _FN2,
    _FN3
};

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

    [_BASE] = LAYOUT_all(
    KC_ESC,  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_BSLS,
    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_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_LSFT, KC_Z,    KC_X,    KC_C,    KC_V,    KC_B,    KC_N,    KC_M,    KC_COMM, KC_DOT,   KC_SLSH,    KC_RSFT,    MO(1),
    KC_LCTL, KC_LGUI, KC_LALT,                            KC_SPC,                    KC_RALT, KC_RGUI,  KC_MENU,    KC_RCTL),
    [_FN1] = LAYOUT_all(
    KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS,
    KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS, RESET,   KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS,
    KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS,
    KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS,
    KC_TRNS, KC_TRNS, KC_TRNS,                            KC_MPLY,                   KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS),
    [_FN2] = LAYOUT_all(
    KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS,
    KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS,
    KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS,
    KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS,
    KC_TRNS, KC_TRNS, KC_TRNS,                            KC_TRNS,                   KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS),
    [_FN3] = LAYOUT_all(
    KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS,
    KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS,
    KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS,
    KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS,
    KC_TRNS, KC_TRNS, KC_TRNS,                            KC_TRNS,                   KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS),
};

A keyboards/studiokestra/nue/keymaps/via/readme.md => keyboards/studiokestra/nue/keymaps/via/readme.md +1 -0
@@ 0,0 1,1 @@
# Studio Kestra's Nue keymap for VIA

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

A keyboards/studiokestra/nue/nue.c => keyboards/studiokestra/nue/nue.c +17 -0
@@ 0,0 1,17 @@
/* Copyright 2021 Studio Kestra
 *
 * 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 "nue.h"

A keyboards/studiokestra/nue/nue.h => keyboards/studiokestra/nue/nue.h +41 -0
@@ 0,0 1,41 @@
/* Copyright 2021 Studio Kestra
 *
 * 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"

/* This is a shortcut to help you visually see your layout.
 *
 * The first section contains all of the arguments representing the physical
 * layout of the board and position of the keys.
 *
 * The second converts the arguments into a two-dimensional array which
 * represents the switch matrix.
 */
#define LAYOUT_all(\
    k000, k001, k002, k003, k004, k005, k006, k007, k008, k009, k010, k011, k012, k013, k113, \
    k100, k101, k102, k103, k104, k105, k106, k107, k108, k109, k110, k111, k112, k212,       \
    k200, k201, k202, k203, k204, k205, k206, k207, k208, k209, k210, k211, k213,             \
    k300, k301, k302, k303, k304, k305, k306, k307, k308, k309, k310, k311, k312, k313,       \
    k400, k401, k402,                   k406,             k409, k410, k411, k412              \
) { \
    { k000, k001, k002, k003,  k004, k005, k006, k007, k008,  k009, k010, k011, k012, k013 }, \
    { k100, k101, k102, k103,  k104, k105, k106, k107, k108,  k109, k110, k111, k112, k113 }, \
    { k200, k201, k202, k203,  k204, k205, k206, k207, k208,  k209, k210, k211, k212, k213 }, \
    { k300, k301, k302, k303,  k304, k305, k306, k307, k308,  k309, k310, k311, k312, k313 }, \
    { k400, k401, k402, KC_NO, KC_NO,KC_NO,k406, KC_NO,KC_NO, k409, k410, k411, k412, KC_NO}  \
}

A keyboards/studiokestra/nue/readme.md => keyboards/studiokestra/nue/readme.md +23 -0
@@ 0,0 1,23 @@
# Nue

60% PCB with gasket mounting tabs designed for the Nue keyboard.

* Keyboard Maintainer: [Studio Kestra](https://github.com/studiokestra/)
* Hardware Supported: [studiokestra.ca/nue](https://studiokestra.ca/nue/)
* Hardware Availability: Group-Buy (Q1 2021)

## Bootload Sequence

There are 3 ways to put the board in bootloader mode:

- Hold the top-left key (typically `Esc`) while plugging in the USB cable, OR
- While the PCB is plugged into the PC, press the physical `RESET` button on the back of the board, OR
- With the default layout, toggle Layer 1 and press the `R` key. 

## Compiling Firmware

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

    make studiokestra/nue: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/studiokestra/nue/rules.mk => keyboards/studiokestra/nue/rules.mk +22 -0
@@ 0,0 1,22 @@
# MCU name
MCU = atmega32u4

# Bootloader selection
BOOTLOADER = atmel-dfu

# Build Options
#   change yes to no to disable
#
BOOTMAGIC_ENABLE = lite       # Virtual DIP switch configuration
MOUSEKEY_ENABLE = no       # Mouse keys
EXTRAKEY_ENABLE = yes       # Audio control and System control
CONSOLE_ENABLE = yes        # Console for debug
COMMAND_ENABLE = yes        # 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