Update new keyboard templates (#9636)
* Update new keyboard templates * Switch on Bootmagic Lite by default * Remove MIDI_ENABLE and FAUXCLICKY_ENABLE
This commit is contained in:
		@@ -20,12 +20,12 @@ along with this program.  If not, see <http://www.gnu.org/licenses/>.
 | 
			
		||||
#include "config_common.h"
 | 
			
		||||
 | 
			
		||||
/* USB Device descriptor parameter */
 | 
			
		||||
#define VENDOR_ID 0xFEED
 | 
			
		||||
#define PRODUCT_ID 0x0000
 | 
			
		||||
#define DEVICE_VER 0x0001
 | 
			
		||||
#define VENDOR_ID    0xFEED
 | 
			
		||||
#define PRODUCT_ID   0x0000
 | 
			
		||||
#define DEVICE_VER   0x0001
 | 
			
		||||
#define MANUFACTURER %YOUR_NAME%
 | 
			
		||||
#define PRODUCT %KEYBOARD%
 | 
			
		||||
#define DESCRIPTION A custom keyboard
 | 
			
		||||
#define PRODUCT      %KEYBOARD%
 | 
			
		||||
#define DESCRIPTION  A custom keyboard
 | 
			
		||||
 | 
			
		||||
/* key matrix size */
 | 
			
		||||
#define MATRIX_ROWS 2
 | 
			
		||||
@@ -45,7 +45,7 @@ along with this program.  If not, see <http://www.gnu.org/licenses/>.
 | 
			
		||||
#define MATRIX_COL_PINS { F1, F0, B0 }
 | 
			
		||||
#define UNUSED_PINS
 | 
			
		||||
 | 
			
		||||
/* COL2ROW, ROW2COL*/
 | 
			
		||||
/* COL2ROW, ROW2COL */
 | 
			
		||||
#define DIODE_DIRECTION COL2ROW
 | 
			
		||||
 | 
			
		||||
/*
 | 
			
		||||
@@ -53,37 +53,37 @@ along with this program.  If not, see <http://www.gnu.org/licenses/>.
 | 
			
		||||
 */
 | 
			
		||||
#define SOFT_SERIAL_PIN D0  // or D1, D2, D3, E6
 | 
			
		||||
 | 
			
		||||
// #define BACKLIGHT_PIN B7
 | 
			
		||||
// #define BACKLIGHT_BREATHING
 | 
			
		||||
// #define BACKLIGHT_LEVELS 3
 | 
			
		||||
//#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
 | 
			
		||||
//#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
 | 
			
		||||
@@ -97,9 +97,9 @@ along with this program.  If not, see <http://www.gnu.org/licenses/>.
 | 
			
		||||
#define LOCKING_RESYNC_ENABLE
 | 
			
		||||
 | 
			
		||||
/* If defined, GRAVE_ESC will always act as ESC when CTRL is held.
 | 
			
		||||
 * This is userful for the Windows task manager shortcut (ctrl+shift+esc).
 | 
			
		||||
 * This is useful for the Windows task manager shortcut (ctrl+shift+esc).
 | 
			
		||||
 */
 | 
			
		||||
// #define GRAVE_ESC_CTRL_OVERRIDE
 | 
			
		||||
//#define GRAVE_ESC_CTRL_OVERRIDE
 | 
			
		||||
 | 
			
		||||
/*
 | 
			
		||||
 * Force NKRO
 | 
			
		||||
@@ -122,59 +122,6 @@ along with this program.  If not, see <http://www.gnu.org/licenses/>.
 | 
			
		||||
 */
 | 
			
		||||
//#define FORCE_NKRO
 | 
			
		||||
 | 
			
		||||
/*
 | 
			
		||||
 * Magic Key Options
 | 
			
		||||
 *
 | 
			
		||||
 * Magic keys are hotkey commands that allow control over firmware functions of
 | 
			
		||||
 * the keyboard. They are best used in combination with the HID Listen program,
 | 
			
		||||
 * found here: https://www.pjrc.com/teensy/hid_listen.html
 | 
			
		||||
 *
 | 
			
		||||
 * The options below allow the magic key functionality to be changed. This is
 | 
			
		||||
 * useful if your keyboard/keypad is missing keys and you want magic key support.
 | 
			
		||||
 *
 | 
			
		||||
 */
 | 
			
		||||
 | 
			
		||||
/* key combination for magic key command */
 | 
			
		||||
/* defined by default; to change, uncomment and set to the combination you want */
 | 
			
		||||
// #define IS_COMMAND() (get_mods() == MOD_MASK_SHIFT)
 | 
			
		||||
 | 
			
		||||
/* control how magic key switches layers */
 | 
			
		||||
//#define MAGIC_KEY_SWITCH_LAYER_WITH_FKEYS  true
 | 
			
		||||
//#define MAGIC_KEY_SWITCH_LAYER_WITH_NKEYS  true
 | 
			
		||||
//#define MAGIC_KEY_SWITCH_LAYER_WITH_CUSTOM false
 | 
			
		||||
 | 
			
		||||
/* override magic key keymap */
 | 
			
		||||
//#define MAGIC_KEY_SWITCH_LAYER_WITH_FKEYS
 | 
			
		||||
//#define MAGIC_KEY_SWITCH_LAYER_WITH_NKEYS
 | 
			
		||||
//#define MAGIC_KEY_SWITCH_LAYER_WITH_CUSTOM
 | 
			
		||||
//#define MAGIC_KEY_HELP           H
 | 
			
		||||
//#define MAGIC_KEY_HELP_ALT       SLASH
 | 
			
		||||
//#define MAGIC_KEY_DEBUG          D
 | 
			
		||||
//#define MAGIC_KEY_DEBUG_MATRIX   X
 | 
			
		||||
//#define MAGIC_KEY_DEBUG_KBD      K
 | 
			
		||||
//#define MAGIC_KEY_DEBUG_MOUSE    M
 | 
			
		||||
//#define MAGIC_KEY_VERSION        V
 | 
			
		||||
//#define MAGIC_KEY_STATUS         S
 | 
			
		||||
//#define MAGIC_KEY_CONSOLE        C
 | 
			
		||||
//#define MAGIC_KEY_LAYER0         0
 | 
			
		||||
//#define MAGIC_KEY_LAYER0_ALT     GRAVE
 | 
			
		||||
//#define MAGIC_KEY_LAYER1         1
 | 
			
		||||
//#define MAGIC_KEY_LAYER2         2
 | 
			
		||||
//#define MAGIC_KEY_LAYER3         3
 | 
			
		||||
//#define MAGIC_KEY_LAYER4         4
 | 
			
		||||
//#define MAGIC_KEY_LAYER5         5
 | 
			
		||||
//#define MAGIC_KEY_LAYER6         6
 | 
			
		||||
//#define MAGIC_KEY_LAYER7         7
 | 
			
		||||
//#define MAGIC_KEY_LAYER8         8
 | 
			
		||||
//#define MAGIC_KEY_LAYER9         9
 | 
			
		||||
//#define MAGIC_KEY_BOOTLOADER     B
 | 
			
		||||
//#define MAGIC_KEY_BOOTLOADER_ALT ESC
 | 
			
		||||
//#define MAGIC_KEY_LOCK           CAPS
 | 
			
		||||
//#define MAGIC_KEY_EEPROM         E
 | 
			
		||||
//#define MAGIC_KEY_EEPROM_CLEAR   BSPACE
 | 
			
		||||
//#define MAGIC_KEY_NKRO           N
 | 
			
		||||
//#define MAGIC_KEY_SLEEP_LED      Z
 | 
			
		||||
 | 
			
		||||
/*
 | 
			
		||||
 * Feature disable options
 | 
			
		||||
 *  These options are also useful to firmware size reduction.
 | 
			
		||||
@@ -195,57 +142,6 @@ along with this program.  If not, see <http://www.gnu.org/licenses/>.
 | 
			
		||||
#define NO_ACTION_MACRO
 | 
			
		||||
#define NO_ACTION_FUNCTION
 | 
			
		||||
 | 
			
		||||
/*
 | 
			
		||||
 * MIDI options
 | 
			
		||||
 */
 | 
			
		||||
 | 
			
		||||
/* Prevent use of disabled MIDI features in the keymap */
 | 
			
		||||
//#define MIDI_ENABLE_STRICT 1
 | 
			
		||||
 | 
			
		||||
/* enable basic MIDI features:
 | 
			
		||||
   - MIDI notes can be sent when in Music mode is on
 | 
			
		||||
*/
 | 
			
		||||
//#define MIDI_BASIC
 | 
			
		||||
 | 
			
		||||
/* enable advanced MIDI features:
 | 
			
		||||
   - MIDI notes can be added to the keymap
 | 
			
		||||
   - Octave shift and transpose
 | 
			
		||||
   - Virtual sustain, portamento, and modulation wheel
 | 
			
		||||
   - etc.
 | 
			
		||||
*/
 | 
			
		||||
//#define MIDI_ADVANCED
 | 
			
		||||
 | 
			
		||||
/* override number of MIDI tone keycodes (each octave adds 12 keycodes and allocates 12 bytes) */
 | 
			
		||||
//#define MIDI_TONE_KEYCODE_OCTAVES 1
 | 
			
		||||
 | 
			
		||||
/*
 | 
			
		||||
 * HD44780 LCD Display Configuration
 | 
			
		||||
 */
 | 
			
		||||
/*
 | 
			
		||||
#define LCD_LINES           2     //< number of visible lines of the display
 | 
			
		||||
#define LCD_DISP_LENGTH    16     //< visibles characters per line of the display
 | 
			
		||||
 | 
			
		||||
#define LCD_IO_MODE      1            //< 0: memory mapped mode, 1: IO port mode
 | 
			
		||||
 | 
			
		||||
#if LCD_IO_MODE
 | 
			
		||||
#define LCD_PORT         PORTB        //< port for the LCD lines
 | 
			
		||||
#define LCD_DATA0_PORT   LCD_PORT     //< port for 4bit data bit 0
 | 
			
		||||
#define LCD_DATA1_PORT   LCD_PORT     //< port for 4bit data bit 1
 | 
			
		||||
#define LCD_DATA2_PORT   LCD_PORT     //< port for 4bit data bit 2
 | 
			
		||||
#define LCD_DATA3_PORT   LCD_PORT     //< port for 4bit data bit 3
 | 
			
		||||
#define LCD_DATA0_PIN    4            //< pin for 4bit data bit 0
 | 
			
		||||
#define LCD_DATA1_PIN    5            //< pin for 4bit data bit 1
 | 
			
		||||
#define LCD_DATA2_PIN    6            //< pin for 4bit data bit 2
 | 
			
		||||
#define LCD_DATA3_PIN    7            //< pin for 4bit data bit 3
 | 
			
		||||
#define LCD_RS_PORT      LCD_PORT     //< port for RS line
 | 
			
		||||
#define LCD_RS_PIN       3            //< pin  for RS line
 | 
			
		||||
#define LCD_RW_PORT      LCD_PORT     //< port for RW line
 | 
			
		||||
#define LCD_RW_PIN       2            //< pin  for RW line
 | 
			
		||||
#define LCD_E_PORT       LCD_PORT     //< port for Enable line
 | 
			
		||||
#define LCD_E_PIN        1            //< pin  for Enable line
 | 
			
		||||
#endif
 | 
			
		||||
*/
 | 
			
		||||
 | 
			
		||||
/* Bootmagic Lite key configuration */
 | 
			
		||||
// #define BOOTMAGIC_LITE_ROW 0
 | 
			
		||||
// #define BOOTMAGIC_LITE_COLUMN 0
 | 
			
		||||
//#define BOOTMAGIC_LITE_ROW 0
 | 
			
		||||
//#define BOOTMAGIC_LITE_COLUMN 0
 | 
			
		||||
 
 | 
			
		||||
@@ -2,14 +2,18 @@
 | 
			
		||||
 | 
			
		||||

 | 
			
		||||
 | 
			
		||||
A short description of the keyboard/project
 | 
			
		||||
*A short description of the keyboard/project*
 | 
			
		||||
 | 
			
		||||
* Keyboard Maintainer: [%YOUR_NAME%](https://github.com/yourusername)
 | 
			
		||||
* Hardware Supported: The PCBs, controllers supported
 | 
			
		||||
* Hardware Availability: Links to where you can find this hardware
 | 
			
		||||
* Hardware Supported: *The PCBs, controllers supported*
 | 
			
		||||
* Hardware Availability: *Links to where you can find this hardware*
 | 
			
		||||
 | 
			
		||||
Make example for this keyboard (after setting up your build environment):
 | 
			
		||||
 | 
			
		||||
    make %KEYBOARD%:default
 | 
			
		||||
 | 
			
		||||
Flashing example for this keyboard:
 | 
			
		||||
 | 
			
		||||
    make %KEYBOARD%:default:flash
 | 
			
		||||
 | 
			
		||||
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).
 | 
			
		||||
 
 | 
			
		||||
@@ -2,31 +2,21 @@
 | 
			
		||||
MCU = atmega32u4
 | 
			
		||||
 | 
			
		||||
# Bootloader selection
 | 
			
		||||
#   Teensy       halfkay
 | 
			
		||||
#   Pro Micro    caterina
 | 
			
		||||
#   Atmel DFU    atmel-dfu
 | 
			
		||||
#   LUFA DFU     lufa-dfu
 | 
			
		||||
#   QMK DFU      qmk-dfu
 | 
			
		||||
#   ATmega32A    bootloadHID
 | 
			
		||||
#   ATmega328P   USBasp
 | 
			
		||||
BOOTLOADER = atmel-dfu
 | 
			
		||||
 | 
			
		||||
# Build Options
 | 
			
		||||
#   change yes to no to disable
 | 
			
		||||
#
 | 
			
		||||
BOOTMAGIC_ENABLE = no       # Virtual DIP switch configuration
 | 
			
		||||
BOOTMAGIC_ENABLE = lite     # Virtual DIP switch configuration
 | 
			
		||||
MOUSEKEY_ENABLE = yes       # Mouse keys
 | 
			
		||||
EXTRAKEY_ENABLE = yes       # Audio control and System control
 | 
			
		||||
CONSOLE_ENABLE = yes        # Console for debug
 | 
			
		||||
COMMAND_ENABLE = yes        # Commands for debug and configuration
 | 
			
		||||
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
 | 
			
		||||
MIDI_ENABLE = no            # MIDI support
 | 
			
		||||
BLUETOOTH_ENABLE = no       # Enable Bluetooth with the Adafruit EZ-Key HID
 | 
			
		||||
BLUETOOTH_ENABLE = no       # Enable Bluetooth
 | 
			
		||||
AUDIO_ENABLE = no           # Audio output
 | 
			
		||||
FAUXCLICKY_ENABLE = no      # Use buzzer to emulate clicky switches
 | 
			
		||||
HD44780_ENABLE = no         # Enable support for HD44780 based LCDs
 | 
			
		||||
 
 | 
			
		||||
@@ -7,11 +7,12 @@
 | 
			
		||||
    "layouts": {
 | 
			
		||||
        "LAYOUT": {
 | 
			
		||||
            "layout": [
 | 
			
		||||
                {"label":"k00", "x":0, "y":0},
 | 
			
		||||
                {"label":"k01", "x":1, "y":0},
 | 
			
		||||
                {"label":"k02", "x":2, "y":0},
 | 
			
		||||
                {"label":"k10", "x":0, "y":1, "w":1.5},
 | 
			
		||||
                {"label":"k12", "x":1.5, "y":1, "w":1.5}
 | 
			
		||||
                {"label": "k00", "x": 0, "y": 0},
 | 
			
		||||
                {"label": "k01", "x": 1, "y": 0},
 | 
			
		||||
                {"label": "k02", "x": 2, "y": 0},
 | 
			
		||||
 | 
			
		||||
                {"label": "k10", "x": 0, "y": 1, "w": 1.5},
 | 
			
		||||
                {"label": "k12", "x": 1.5, "y": 1, "w": 1.5}
 | 
			
		||||
            ]
 | 
			
		||||
        }
 | 
			
		||||
    }
 | 
			
		||||
 
 | 
			
		||||
@@ -15,36 +15,3 @@
 | 
			
		||||
 */
 | 
			
		||||
 | 
			
		||||
#include "%KEYBOARD%.h"
 | 
			
		||||
 | 
			
		||||
// Optional override functions below.
 | 
			
		||||
// You can leave any or all of these undefined.
 | 
			
		||||
// These are only required if you want to perform custom actions.
 | 
			
		||||
 | 
			
		||||
/*
 | 
			
		||||
void matrix_init_kb(void) {
 | 
			
		||||
    // put your keyboard start-up code here
 | 
			
		||||
    // runs once when the firmware starts up
 | 
			
		||||
 | 
			
		||||
    matrix_init_user();
 | 
			
		||||
}
 | 
			
		||||
 | 
			
		||||
void matrix_scan_kb(void) {
 | 
			
		||||
    // put your looping keyboard code here
 | 
			
		||||
    // runs every cycle (a lot)
 | 
			
		||||
 | 
			
		||||
    matrix_scan_user();
 | 
			
		||||
}
 | 
			
		||||
 | 
			
		||||
bool process_record_kb(uint16_t keycode, keyrecord_t *record) {
 | 
			
		||||
    // put your per-action keyboard code here
 | 
			
		||||
    // runs for every action, just before processing by the firmware
 | 
			
		||||
 | 
			
		||||
    return process_record_user(keycode, record);
 | 
			
		||||
}
 | 
			
		||||
 | 
			
		||||
bool led_update_kb(led_t led_state) {
 | 
			
		||||
    // put your keyboard LED indicator (ex: Caps Lock LED) toggling code here
 | 
			
		||||
 | 
			
		||||
    return led_update_user(led_state);
 | 
			
		||||
}
 | 
			
		||||
*/
 | 
			
		||||
 
 | 
			
		||||
@@ -29,8 +29,7 @@
 | 
			
		||||
#define LAYOUT( \
 | 
			
		||||
    k00, k01, k02, \
 | 
			
		||||
      k10,  k12    \
 | 
			
		||||
) \
 | 
			
		||||
{ \
 | 
			
		||||
) { \
 | 
			
		||||
    { k00, k01,   k02 }, \
 | 
			
		||||
    { k10, KC_NO, k12 }  \
 | 
			
		||||
}
 | 
			
		||||
 
 | 
			
		||||
@@ -1,19 +0,0 @@
 | 
			
		||||
/* Copyright %YEAR% %YOUR_NAME%
 | 
			
		||||
 *
 | 
			
		||||
 * 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
 | 
			
		||||
 | 
			
		||||
// place overrides here
 | 
			
		||||
@@ -60,17 +60,3 @@ bool process_record_user(uint16_t keycode, keyrecord_t *record) {
 | 
			
		||||
    }
 | 
			
		||||
    return true;
 | 
			
		||||
}
 | 
			
		||||
 | 
			
		||||
/*
 | 
			
		||||
void matrix_init_user(void) {
 | 
			
		||||
 | 
			
		||||
}
 | 
			
		||||
 | 
			
		||||
void matrix_scan_user(void) {
 | 
			
		||||
 | 
			
		||||
}
 | 
			
		||||
 | 
			
		||||
bool led_update_user(led_t led_state) {
 | 
			
		||||
    return true;
 | 
			
		||||
}
 | 
			
		||||
*/
 | 
			
		||||
 
 | 
			
		||||
@@ -19,37 +19,121 @@ along with this program.  If not, see <http://www.gnu.org/licenses/>.
 | 
			
		||||
 | 
			
		||||
#include "config_common.h"
 | 
			
		||||
 | 
			
		||||
#define VENDOR_ID 0x20A0
 | 
			
		||||
#define PRODUCT_ID 0x422D
 | 
			
		||||
#define DEVICE_VER 0x0001
 | 
			
		||||
/* USB Device descriptor parameter */
 | 
			
		||||
#define VENDOR_ID    0xFEED
 | 
			
		||||
#define PRODUCT_ID   0x0000
 | 
			
		||||
#define DEVICE_VER   0x0001
 | 
			
		||||
#define MANUFACTURER %YOUR_NAME%
 | 
			
		||||
#define PRODUCT %KEYBOARD%
 | 
			
		||||
#define DESCRIPTION A custom keyboard
 | 
			
		||||
#define PRODUCT      %KEYBOARD%
 | 
			
		||||
#define DESCRIPTION  A custom keyboard
 | 
			
		||||
 | 
			
		||||
/* key matrix size */
 | 
			
		||||
#define MATRIX_ROWS 8
 | 
			
		||||
#define MATRIX_COLS 15
 | 
			
		||||
 | 
			
		||||
/*
 | 
			
		||||
 * 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 { B0, B1, B2, B3, B4, B5, B6, B7 }
 | 
			
		||||
#define MATRIX_COL_PINS { A0, A1, A2, A3, A4, A5, A6, A7, C7, C6, C5, C4, C3, C2, D7 }
 | 
			
		||||
#define UNUSED_PINS
 | 
			
		||||
 | 
			
		||||
/* COL2ROW, ROW2COL */
 | 
			
		||||
#define DIODE_DIRECTION COL2ROW
 | 
			
		||||
 | 
			
		||||
#define BACKLIGHT_PIN D4
 | 
			
		||||
#define BACKLIGHT_LEVELS 3
 | 
			
		||||
//#define BACKLIGHT_BREATHING
 | 
			
		||||
 | 
			
		||||
#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
 | 
			
		||||
 | 
			
		||||
#define MATRIX_ROWS 8
 | 
			
		||||
#define MATRIX_COLS 11
 | 
			
		||||
 | 
			
		||||
#define MATRIX_ROW_PINS { B0, B1, B2, B3, B4, B5, B6, B7 }
 | 
			
		||||
#define MATRIX_COL_PINS { A0, A1, A2, A3, A4, A5, A6, A7, C7, C6, C5 }
 | 
			
		||||
// #define MATRIX_COL_PINS { A0, A1, A2, A3, A4, A5, A6, A7, C7, C6, C5, C4, C3, C2, C1, C0, D7 }
 | 
			
		||||
#define UNUSED_PINS {}
 | 
			
		||||
 | 
			
		||||
#define DIODE_DIRECTION COL2ROW
 | 
			
		||||
/* Debounce reduces chatter (unintended double-presses) - set 0 if debouncing is not needed */
 | 
			
		||||
#define DEBOUNCE 5
 | 
			
		||||
 | 
			
		||||
#define BACKLIGHT_LEVELS 1
 | 
			
		||||
#define RGBLIGHT_ANIMATIONS
 | 
			
		||||
/* 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
 | 
			
		||||
 | 
			
		||||
/* key combination for magic key command */
 | 
			
		||||
/* defined by default; to change, uncomment and set to the combination you want */
 | 
			
		||||
// #define IS_COMMAND() (get_mods() == MOD_MASK_SHIFT)
 | 
			
		||||
 | 
			
		||||
/* Bootmagic Lite key configuration */
 | 
			
		||||
// #define BOOTMAGIC_LITE_ROW 0
 | 
			
		||||
// #define BOOTMAGIC_LITE_COLUMN 0
 | 
			
		||||
//#define BOOTMAGIC_LITE_ROW 0
 | 
			
		||||
//#define BOOTMAGIC_LITE_COLUMN 0
 | 
			
		||||
 
 | 
			
		||||
@@ -2,11 +2,11 @@
 | 
			
		||||
 | 
			
		||||

 | 
			
		||||
 | 
			
		||||
A short description of the keyboard/project
 | 
			
		||||
*A short description of the keyboard/project*
 | 
			
		||||
 | 
			
		||||
* Keyboard Maintainer: [%YOUR_NAME%](https://github.com/yourusername)
 | 
			
		||||
* Hardware Supported: The PCBs, controllers supported
 | 
			
		||||
* Hardware Availability: links to where you can find this hardware
 | 
			
		||||
* Hardware Supported: *The PCBs, controllers supported*
 | 
			
		||||
* Hardware Availability: *Links to where you can find this hardware*
 | 
			
		||||
 | 
			
		||||
Make example for this keyboard (after setting up your build environment):
 | 
			
		||||
 | 
			
		||||
 
 | 
			
		||||
@@ -2,23 +2,18 @@
 | 
			
		||||
MCU = atmega32a
 | 
			
		||||
 | 
			
		||||
# Bootloader selection
 | 
			
		||||
#   Teensy       halfkay
 | 
			
		||||
#   Pro Micro    caterina
 | 
			
		||||
#   Atmel DFU    atmel-dfu
 | 
			
		||||
#   LUFA DFU     lufa-dfu
 | 
			
		||||
#   QMK DFU      qmk-dfu
 | 
			
		||||
#   ATmega32A    bootloadHID
 | 
			
		||||
#   ATmega328P   USBasp
 | 
			
		||||
BOOTLOADER = bootloadHID
 | 
			
		||||
 | 
			
		||||
# Build Options
 | 
			
		||||
#   change yes to no to disable
 | 
			
		||||
#
 | 
			
		||||
BOOTMAGIC_ENABLE = no       # Virtual DIP switch configuration
 | 
			
		||||
MOUSEKEY_ENABLE = no        # Mouse keys
 | 
			
		||||
BOOTMAGIC_ENABLE = lite     # Virtual DIP switch configuration
 | 
			
		||||
MOUSEKEY_ENABLE = yes       # Mouse keys
 | 
			
		||||
EXTRAKEY_ENABLE = yes       # Audio control and System control
 | 
			
		||||
CONSOLE_ENABLE = yes        # Console for debug
 | 
			
		||||
COMMAND_ENABLE = yes        # Commands for debug and configuration
 | 
			
		||||
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
 | 
			
		||||
BACKLIGHT_ENABLE = no       # Enable keyboard backlight functionality
 | 
			
		||||
RGBLIGHT_ENABLE = yes       # Enable keyboard RGB underglow
 | 
			
		||||
RGBLIGHT_ENABLE = no        # Enable keyboard RGB underglow
 | 
			
		||||
WS2812_DRIVER = i2c
 | 
			
		||||
 
 | 
			
		||||
@@ -78,7 +78,6 @@ replace_year_placeholders() {
 | 
			
		||||
        "${keyboard_dir}/config.h"
 | 
			
		||||
        "${keyboard_dir}/${keyboard_base_name}.c"
 | 
			
		||||
        "${keyboard_dir}/${keyboard_base_name}.h"
 | 
			
		||||
        "${keyboard_dir}/keymaps/default/config.h"
 | 
			
		||||
        "${keyboard_dir}/keymaps/default/keymap.c"
 | 
			
		||||
    )
 | 
			
		||||
    replace_placeholders "%YEAR%" "$(date +%Y)" "${replace_year_filenames[@]}"
 | 
			
		||||
@@ -104,7 +103,6 @@ replace_name_placeholders() {
 | 
			
		||||
        "${keyboard_dir}/readme.md"
 | 
			
		||||
        "${keyboard_dir}/${keyboard_base_name}.c"
 | 
			
		||||
        "${keyboard_dir}/${keyboard_base_name}.h"
 | 
			
		||||
        "${keyboard_dir}/keymaps/default/config.h"
 | 
			
		||||
        "${keyboard_dir}/keymaps/default/keymap.c"
 | 
			
		||||
    )
 | 
			
		||||
    replace_placeholders "%YOUR_NAME%" "$username" "${replace_name_filenames[@]}"
 | 
			
		||||
 
 | 
			
		||||
		Reference in New Issue
	
	Block a user