~ruther/qmk_firmware

59502f930e44e64c931de6ab6f6ab801e582c707 — SandwichRising 3 years ago 002a1ad
[Keyboard] Added sandwich/keeb68 to keyboards (#15007)

Co-authored-by: Drashna Jaelre <drashna@live.com>
Co-authored-by: Ryan <fauxpark@gmail.com>
Co-authored-by: James Young <18669334+noroadsleft@users.noreply.github.com>
A keyboards/sandwich/keeb68/config.h => keyboards/sandwich/keeb68/config.h +152 -0
@@ 0,0 1,152 @@
/*
Copyright 2021 sandwich

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 sandwich
#define PRODUCT      Keeb68 (Patron Saint Edition)

/* key matrix size */
#define MATRIX_ROWS 5
#define MATRIX_COLS 14

/*
 * 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 { F0, F1, F4, F5, F6 }
#define MATRIX_COL_PINS { B6, C6, F7, E6, B7, D0, D1, D2, D3, D4, D6, D7, B4, B5 }
#define UNUSED_PINS { D5, B0 }

/* 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 D0  // or D1, D2, 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 C7
#define BACKLIGHT_LEVELS 5
#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/sandwich/keeb68/keeb68.c => keyboards/sandwich/keeb68/keeb68.c +17 -0
@@ 0,0 1,17 @@
/* Copyright 2021 sandwich
 *
 * 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 "keeb68.h"

A keyboards/sandwich/keeb68/keeb68.h => keyboards/sandwich/keeb68/keeb68.h +42 -0
@@ 0,0 1,42 @@
/* Copyright 2021 sandwich
 *
 * 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_65_ansi( \
    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,             K405, K406, K407, K408, K409, K410, K411, K412, K413 \
) { \
    { 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 , K405 , K406, K407, K408, K409, K410, K411, K412, K413 } \
}


A keyboards/sandwich/keeb68/keymaps/default/keymap.c => keyboards/sandwich/keeb68/keymaps/default/keymap.c +42 -0
@@ 0,0 1,42 @@
/* Copyright 2021 sandwich
 *
 * 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_65_ansi(
        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_BSPC,	KC_GRV,
		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_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_PGUP,
        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,   	KC_PGDN,
        KC_LCTL, 	KC_LGUI, KC_LALT,               	KC_SPC, KC_EQL,	KC_RBRC,KC_RALT,MO(_FN),KC_RCTL, KC_LEFT, 	KC_DOWN, 	KC_RGHT
		
    ),
    [_FN] = LAYOUT_65_ansi(
        _______, 	KC_F1,	 KC_F2, 	KC_F3, 	KC_F4, 	KC_F5, 	KC_F6, 	KC_F7, 	KC_F8,  KC_F9, 	KC_F10,  KC_F11, 	KC_DEL,		KC_PSCREEN,
		_______,	_______, BL_INC,	_______,_______,_______,_______,_______,_______,_______,_______,_______,	_______,	KC_PAUSE,
		_______,	BL_TOGG, BL_DEC,	BL_BRTG,_______,_______,_______,_______,_______,_______,_______,_______,	_______,	KC_HOME,
		_______,	_______, _______,	_______,_______,_______,_______,_______,_______,_______,_______,_______,	KC_VOLU,	KC_END,
		_______,	RESET, 	 _______,					_______,KC_F12, _______,_______,MO(_FN),_______,_______,	KC_VOLD,	_______
		
    )
};

A keyboards/sandwich/keeb68/keymaps/grv_esc/keymap.c => keyboards/sandwich/keeb68/keymaps/grv_esc/keymap.c +42 -0
@@ 0,0 1,42 @@
/* Copyright 2021 sandwich
 *
 * 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_65_ansi(
        KC_GESC,   	KC_1,    KC_2,		KC_3,	KC_4,	KC_5,	KC_6,	KC_7,	KC_8,	KC_9,	KC_0,	 KC_MINS,	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_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_PGUP,
        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,   	KC_PGDN,
        KC_LCTL, 	KC_LGUI, KC_LALT,               	KC_SPC, KC_EQL,	KC_RBRC,KC_RALT,MO(_FN),KC_RCTL, KC_LEFT, 	KC_DOWN, 	KC_RGHT
		
    ),
    [_FN] = LAYOUT_65_ansi(
        _______, 	KC_F1,	 KC_F2, 	KC_F3, 	KC_F4, 	KC_F5, 	KC_F6, 	KC_F7, 	KC_F8,  KC_F9, 	KC_F10,  KC_F11, 	KC_DEL,		KC_PSCREEN,
		_______,	_______, BL_INC,	_______,_______,_______,_______,_______,_______,_______,_______,_______,	_______,	KC_PAUSE,
		_______,	BL_TOGG, BL_DEC,	BL_BRTG,_______,_______,_______,_______,_______,_______,_______,_______,	_______,	KC_HOME,
		_______,	_______, _______,	_______,_______,_______,_______,_______,_______,_______,_______,_______,	KC_VOLU,	KC_END,
		_______,	RESET, 	 _______,					_______,KC_F12, _______,_______,MO(_FN),_______,_______,	KC_VOLD,	_______
		
    )
};

A keyboards/sandwich/keeb68/keymaps/grv_esc/readme.md => keyboards/sandwich/keeb68/keymaps/grv_esc/readme.md +1 -0
@@ 0,0 1,1 @@
# The default keymap for keeb68

A keyboards/sandwich/keeb68/readme.md => keyboards/sandwich/keeb68/readme.md +29 -0
@@ 0,0 1,29 @@
# keeb68

![keeb68](https://imgur.com/b3ftFIKh.jpg)

A small-batch run of 68 key goodness

* Keyboard Maintainer: [sandwich](https://github.com/SandwichRising)
* Hardware Supported: Sandwich's Keeb68 Patron Saint Edition
* Hardware Availability: Limited Run

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

    make sandwich/keeb68:default

Flashing example for this keyboard:

    make sandwich/keeb68:default:flash
    
Toggle NRKO on/off by holding space+n and then inserting the keyboard's USB cable. 
Some BIOSs may not detect keypresses properly while NRKO is enabled according to QMK documentation.
    
## Bootloader

Enter the bootloader in 2 ways (all keys assume default layout):

* **Keycode in layout**:  Hold Fn key and press the Windows(GUI) key (mapped to `RESET`)
* **Physical reset button**: Briefly press the button on the back of the PCB (labeled sw1)

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/sandwich/keeb68/rules.mk => keyboards/sandwich/keeb68/rules.mk +18 -0
@@ 0,0 1,18 @@
# 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
NKRO_ENABLE = yes            # Enable N-Key Rollover
BACKLIGHT_ENABLE = yes       # Enable keyboard backlight functionality
RGBLIGHT_ENABLE = no        # Enable keyboard RGB underglow
AUDIO_ENABLE = no           # Audio output