~ruther/qmk_firmware

b069002e6150e9735c86a93d68a6bb8fd708c09e — QMK Bot 3 years ago 280bea8 + 86966fc
Merge remote-tracking branch 'origin/master' into develop
A keyboards/kb58/config.h => keyboards/kb58/config.h +154 -0
@@ 0,0 1,154 @@
/*
Copyright 2021 beanaccle

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   0x0000
#define DEVICE_VER   0x0001
#define MANUFACTURER beanaccle
#define PRODUCT      kb58

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

/*
 * Keyboard Matrix Assignments
 *
 * Change this to how you wired your keyboard
 * COLS: AVR pins used for columns, left to right
 * ROWS: AVR pins used for rows, top to bottom
 * DIODE_DIRECTION: COL2ROW = COL = Anode (+), ROW = Cathode (-, marked on diode)
 *                  ROW2COL = ROW = Anode (+), COL = Cathode (-, marked on diode)
 *
 */
#define MATRIX_ROW_PINS { F4, B6, E6, B4, B5 }
#define MATRIX_COL_PINS { F5, F6, F7, B1, D7, D4, D0 }
#define MATRIX_ROW_PINS_RIGHT { F7, B5, B3, B2, B6 }
#define MATRIX_COL_PINS_RIGHT { F6, B1, E6, D7, C6, D4, D0 }
#define UNUSED_PINS

/* COL2ROW, ROW2COL */
#define DIODE_DIRECTION COL2ROW

/*
 * Split Keyboard specific options, make sure you have 'SPLIT_KEYBOARD = yes' in your rules.mk, and define SOFT_SERIAL_PIN.
 */
#define SOFT_SERIAL_PIN D2  // or D0, D1, D3, E6

//#define LED_NUM_LOCK_PIN B0
//#define LED_CAPS_LOCK_PIN B1
//#define LED_SCROLL_LOCK_PIN B2
//#define LED_COMPOSE_PIN B3
//#define LED_KANA_PIN B4

//#define BACKLIGHT_PIN B7
//#define BACKLIGHT_LEVELS 3
//#define BACKLIGHT_BREATHING

//#define RGB_DI_PIN E2
//#ifdef RGB_DI_PIN
//#    define RGBLED_NUM 16
//#    define RGBLIGHT_HUE_STEP 8
//#    define RGBLIGHT_SAT_STEP 8
//#    define RGBLIGHT_VAL_STEP 8
//#    define RGBLIGHT_LIMIT_VAL 255 /* The maximum brightness level */
//#    define RGBLIGHT_SLEEP  /* If defined, the RGB lighting will be switched off when the host goes to sleep */
/*== all animations enable ==*/
//#    define RGBLIGHT_ANIMATIONS
/*== or choose animations ==*/
//#    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
/*== customize breathing effect ==*/
/*==== (DEFAULT) use fixed table instead of exp() and sin() ====*/
//#    define RGBLIGHT_BREATHE_TABLE_SIZE 256      // 256(default) or 128 or 64
/*==== use exp() and sin() ====*/
//#    define RGBLIGHT_EFFECT_BREATHE_CENTER 1.85  // 1 to 2.7
//#    define RGBLIGHT_EFFECT_BREATHE_MAX    255   // 0 to 255
//#endif

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

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

/* If defined, GRAVE_ESC will always act as ESC when CTRL is held.
 * This is useful for the Windows task manager shortcut (ctrl+shift+esc).
 */
//#define GRAVE_ESC_CTRL_OVERRIDE

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

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

/* 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/kb58/info.json => keyboards/kb58/info.json +73 -0
@@ 0,0 1,73 @@
{
    "keyboard_name": "KB58",
    "url": "https://github.com/beanaccle/kb58_pico",
    "maintainer": "beanaccle",
    "layouts": {
        "LAYOUT": {
            "layout": [
                {"label":"Esc", "x":0, "y":0},
                {"label":"1", "x":1, "y":0},
                {"label":"2", "x":2, "y":0},
                {"label":"3", "x":3, "y":0},
                {"label":"4", "x":4, "y":0},
                {"label":"5", "x":5, "y":0},
                {"label":"6", "x":6, "y":0},
                {"label":"7", "x":7, "y":0},
                {"label":"8", "x":8, "y":0},
                {"label":"9", "x":9, "y":0},
                {"label":"0", "x":10, "y":0},
                {"label":"-", "x":11, "y":0},
                {"label":"=", "x":12, "y":0},

                {"label":"Tab", "x":0, "y":1},
                {"label":"Q", "x":1, "y":1},
                {"label":"W", "x":2, "y":1},
                {"label":"E", "x":3, "y":1},
                {"label":"R", "x":4, "y":1},
                {"label":"T", "x":5, "y":1},
                {"label":"Y", "x":6, "y":1},
                {"label":"U", "x":7, "y":1},
                {"label":"I", "x":8, "y":1},
                {"label":"O", "x":9, "y":1},
                {"label":"P", "x":10, "y":1},
                {"label":"[", "x":11, "y":1},
                {"label":"]", "x":12, "y":1},

                {"label":"Control", "x":0, "y":2},
                {"label":"A", "x":1, "y":2},
                {"label":"S", "x":2, "y":2},
                {"label":"D", "x":3, "y":2},
                {"label":"F", "x":4, "y":2},
                {"label":"G", "x":5, "y":2},
                {"label":"H", "x":6, "y":2},
                {"label":"J", "x":7, "y":2},
                {"label":"K", "x":8, "y":2},
                {"label":"L", "x":9, "y":2},
                {"label":";", "x":10, "y":2},
                {"label":"'", "x":11, "y":2},
                {"label":"Enter", "x":12, "y":2},

                {"label":"Shift", "x":0, "y":3},
                {"label":"Z", "x":1, "y":3},
                {"label":"X", "x":2, "y":3},
                {"label":"C", "x":3, "y":3},
                {"label":"Y", "x":4, "y":3},
                {"label":"B", "x":5, "y":3},
                {"label":"N", "x":6, "y":3},
                {"label":"M", "x":7, "y":3},
                {"label":",", "x":8, "y":3},
                {"label":".", "x":9, "y":3},
                {"label":"/", "x":10, "y":3},
                {"label":"\\", "x":11, "y":3},
                {"label":"Shift", "x":12, "y":3},

                {"label":"Alt", "x":3, "y":4},
                {"label":"GUI", "x":4, "y":4},
                {"x":5, "y":4},
                {"x":6, "y":4},
                {"label":"Fn", "x":7, "y":4},
                {"label":"Delete", "x":8, "y":4}
            ]
        }
    }
}

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

A keyboards/kb58/kb58.h => keyboards/kb58/kb58.h +46 -0
@@ 0,0 1,46 @@
/* Copyright 2021 beanaccle
 *
 * 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( \
    L00, L01, L02, L03, L04, L05,    R00, R01, R02, R03, R04, R05, R06, \
    L06, L07, L08, L09, L10, L11,    R07, R08, R09, R10, R11, R12, R13, \
    L12, L13, L14, L15, L16, L17,    R14, R15, R16, R17, R18, R19, R20, \
    L18, L19, L20, L21, L22, L23,    R21, R22, R23, R24, R25, R26, R27, \
                   L24, L25, L26,    R28, R29, R30 \
) { \
    {   L00,   L01,   L02,   L03,   L04,   L05 }, \
    {   L06,   L07,   L08,   L09,   L10,   L11 }, \
    {   L12,   L13,   L14,   L15,   L16,   L17 }, \
    {   L18,   L19,   L20,   L21,   L22,   L23 }, \
    { KC_NO, KC_NO, KC_NO,   L24,   L25,   L26 }, \
    {   R00,   R01,   R02,   R03,   R04,   R05,   R06 }, \
    {   R07,   R08,   R09,   R10,   R11,   R12,   R13 }, \
    {   R14,   R15,   R16,   R17,   R18,   R19,   R20 }, \
    {   R21,   R22,   R23,   R24,   R25,   R26,   R27 }, \
    {   R28,   R29,   R30, KC_NO, KC_NO, KC_NO, KC_NO } \
}

A keyboards/kb58/keymaps/default/keymap.c => keyboards/kb58/keymaps/default/keymap.c +40 -0
@@ 0,0 1,40 @@
/* Copyright 2021 beanaccle
 *
 * 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 */
    [_BASE] = LAYOUT(
        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_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_LCTL, 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_N,    KC_M,    KC_COMM, KC_DOT,  KC_SLSH, KC_BSLS, KC_RSFT,
                                   KC_LOPT, KC_LGUI, KC_SPC,  KC_SPC,  MO(_FN), KC_BSPC
    ),
    [_FN] = LAYOUT(
        _______, _______, _______, _______, _______, _______,  _______, _______, _______, _______, _______, _______, _______,
        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_LEFT, KC_DOWN, KC_UP,   KC_RGHT, _______, _______, _______,
        _______, 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_CAPS, _______, KC_ESC,  KC_ESC,  _______, KC_DEL
    )
};

A keyboards/kb58/readme.md => keyboards/kb58/readme.md +23 -0
@@ 0,0 1,23 @@
# KB58

![kb58_pico](https://user-images.githubusercontent.com/25994266/146207912-b725e22f-92dc-4a40-9157-c2fddff45ce2.jpg)

This is 58 keys keyboard.

* Keyboard Maintainer: [beanaccle](https://github.com/beanaccle)
* Hardware Supported: KB58
* Hardware Availability: [KB58 Pico](https://github.com/beanaccle/kb58_pico)

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

    make kb58:default

## Bootloader

Enter the bootloader in 3 ways:

* **Bootmagic reset**: Hold down the key at (0,0) in the matrix (usually the top left key or Escape) and plug in the keyboard
* **Physical reset button**: Briefly press the button on the back of the PCB - some may have pads you must short instead
* **Keycode in layout**: Press the key mapped to `RESET` if it is available

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

# Bootloader selection
BOOTLOADER = atmel-dfu

# Build Options
#   change yes to no to disable
#
BOOTMAGIC_ENABLE = no       # Enable Bootmagic Lite
MOUSEKEY_ENABLE = no        # Mouse keys
EXTRAKEY_ENABLE = no        # Audio control and System control
CONSOLE_ENABLE = no         # Console for debug
COMMAND_ENABLE = no         # Commands for debug and configuration
NKRO_ENABLE = no            # Enable N-key Rollover
BACKLIGHT_ENABLE = no       # Enable keyboard backlight functionality
RGBLIGHT_ENABLE = no        # Enable keyboard RGB underglow
AUDIO_ENABLE = no           # Audio output

SPLIT_KEYBOARD = yes        # Enables split keyboard support