~ruther/qmk_firmware

f36112e957e6ce815563766d86f8bbcc278b3f78 — cole smith 5 years ago 30cdf93
added keyboard 5x12 to boardsource folder (#9438)

* added keyboard 5x12 to boardsource folder

* Apply suggestions from code review

Co-authored-by: Ryan <fauxpark@gmail.com>

Co-authored-by: Ryan <fauxpark@gmail.com>
A keyboards/boardsource/5x12/5x12.c => keyboards/boardsource/5x12/5x12.c +1 -0
@@ 0,0 1,1 @@
#include "5x12.h"
\ No newline at end of file

A keyboards/boardsource/5x12/5x12.h => keyboards/boardsource/5x12/5x12.h +17 -0
@@ 0,0 1,17 @@
#pragma once
#include "quantum.h"

#define LAYOUT_ortho_5x12( \
    K00, K01, K02, K03, K04, K05, K06, K07, K08, K09, K10, K11, \
    K12, K13, K14, K15, K16, K17, K18, K19, K20, K21, K22, K23, \
    K24, K25, K26, K27, K28, K29, K30, K31, K32, K33, K34, K35, \
    K36, K37, K38, K39, K40, K41, K42, K43, K44, K45, K46, K47, \
    K48, K49, K50, K51, K52, K53, K54, K55, K56, K57, K58, K59 \
    ) { \
        {K00, K01, K02, K03, K04, K05, K06, K07, K08, K09, K10, K11}, \
        {K12, K13, K14, K15, K16, K17, K18, K19, K20, K21, K22, K23}, \
        {K24, K25, K26, K27, K28, K29, K30, K31, K32, K33, K34, K35}, \
        {K36, K37, K38, K39, K40, K41, K42, K43, K44, K45, K46, K47}, \
        {K48, K49, K50, K51, K52, K53, K54, K55, K56, K57, K58, K59} \
    }


A keyboards/boardsource/5x12/config.h => keyboards/boardsource/5x12/config.h +143 -0
@@ 0,0 1,143 @@
#pragma once

#include "config_common.h"

/* USB Device descriptor parameter */
#define VENDOR_ID       0xF7E0
#define PRODUCT_ID      0x0412
#define DEVICE_VER      0x0000
#define MANUFACTURER    Boardsource
#define PRODUCT         5x12
#define DESCRIPTION     50 percent ortho keyboard

/* key matrix size */
#define MATRIX_ROWS 5
#define MATRIX_COLS 12
#define MATRIX_ROW_PINS { D2, D3, D1, D0, D4 }
#define MATRIX_COL_PINS { F4, F5, F6, F7, B1, B3, B2, B6, B5, B4, E6, D7 }

/* COL2ROW, ROW2COL*/
#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

/* 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).
 */
// #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

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

/* 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_HELP1          H
//#define MAGIC_KEY_HELP2          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_ALT1    ESC
//#define MAGIC_KEY_LAYER0_ALT2    GRAVE
//#define MAGIC_KEY_LAYER0         0
//#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     PAUSE
//#define MAGIC_KEY_LOCK           CAPS
//#define MAGIC_KEY_EEPROM         E
//#define MAGIC_KEY_NKRO           N
//#define MAGIC_KEY_SLEEP_LED      Z

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

A keyboards/boardsource/5x12/info.json => keyboards/boardsource/5x12/info.json +77 -0
@@ 0,0 1,77 @@
{
    "keyboard_name": "boardsource 5x12",
    "url": "https://boardsource.xyz",
    "maintainer": "boardsource",
    "width": 12,
    "height": 5,
    "layouts": {
        "LAYOUT": {
            "layout": [
                { "label": "K01", "x": 0, "y": 0 },
                { "label": "K02", "x": 1, "y": 0 },
                { "label": "K03", "x": 2, "y": 0 },
                { "label": "K04", "x": 3, "y": 0 },
                { "label": "K05", "x": 4, "y": 0 },
                { "label": "K06", "x": 5, "y": 0 },
                { "label": "K07", "x": 6, "y": 0 },
                { "label": "K08", "x": 7, "y": 0 },
                { "label": "K09", "x": 8, "y": 0 },
                { "label": "K010", "x": 9, "y": 0 },
                { "label": "K011", "x": 10, "y": 0 },
                { "label": "K012", "x": 11, "y": 0 },

                { "label": "K11", "x": 0, "y": 1 },
                { "label": "K12", "x": 1, "y": 1 },
                { "label": "K13", "x": 2, "y": 1 },
                { "label": "K14", "x": 3, "y": 1 },
                { "label": "K15", "x": 4, "y": 1 },
                { "label": "K16", "x": 5, "y": 1 },
                { "label": "K17", "x": 6, "y": 1 },
                { "label": "K18", "x": 7, "y": 1 },
                { "label": "K19", "x": 8, "y": 1 },
                { "label": "K110", "x": 9, "y": 1 },
                { "label": "K111", "x": 10, "y": 1 },
                { "label": "K112", "x": 11, "y": 1 },

                { "label": "K21", "x": 0, "y": 2 },
                { "label": "K22", "x": 1, "y": 2 },
                { "label": "K23", "x": 2, "y": 2 },
                { "label": "K24", "x": 3, "y": 2 },
                { "label": "K25", "x": 4, "y": 2 },
                { "label": "K26", "x": 5, "y": 2 },
                { "label": "K27", "x": 6, "y": 2 },
                { "label": "K28", "x": 7, "y": 2 },
                { "label": "K29", "x": 8, "y": 2 },
                { "label": "K210", "x": 9, "y": 2 },
                { "label": "K211", "x": 10, "y": 2 },
                { "label": "K212", "x": 11, "y": 2 },

                { "label": "K31", "x": 0, "y": 3 },
                { "label": "K32", "x": 1, "y": 3 },
                { "label": "K33", "x": 2, "y": 3 },
                { "label": "K34", "x": 3, "y": 3 },
                { "label": "K35", "x": 4, "y": 3 },
                { "label": "K36", "x": 5, "y": 3 },
                { "label": "K37", "x": 6, "y": 3 },
                { "label": "K38", "x": 7, "y": 3 },
                { "label": "K39", "x": 8, "y": 3 },
                { "label": "K310", "x": 9, "y": 3 },
                { "label": "K311", "x": 10, "y": 3 },
                { "label": "K312", "x": 11, "y": 3 },

                { "label": "K41", "x": 0, "y": 4 },
                { "label": "K42", "x": 1, "y": 4 },
                { "label": "K43", "x": 2, "y": 4 },
                { "label": "K44", "x": 3, "y": 4 },
                { "label": "K45", "x": 4, "y": 4 },
                { "label": "K46", "x": 5, "y": 4 },
                { "label": "K47", "x": 6, "y": 4 },
                { "label": "K48", "x": 7, "y": 4 },
                { "label": "K49", "x": 8, "y": 4 },
                { "label": "K410", "x": 9, "y": 4 },
                { "label": "K411", "x": 10, "y": 4 },
                { "label": "K412", "x": 11, "y": 4 }
            ]
        }
    }
}

A keyboards/boardsource/5x12/keymaps/default/keymap.c => keyboards/boardsource/5x12/keymaps/default/keymap.c +39 -0
@@ 0,0 1,39 @@
#include QMK_KEYBOARD_H

enum layers {
    _MAIN,
    _RAISE,
    _LOWER,
};

// Readability keycodes
#define LOWER   MO(_LOWER)
#define RAISE   MO(_RAISE)

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

  [_MAIN] = LAYOUT_ortho_5x12(
  KC_GRV,  KC_1,    KC_2,    KC_3,    KC_4,    KC_5,    KC_6,    KC_7,    KC_8,    KC_9,    KC_0,    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_DEL,
  KC_ESC,  KC_A,    KC_S,    KC_D,    KC_F,    KC_G,    KC_H,    KC_J,    KC_K,    KC_L,    KC_SCLN, KC_QUOT,
  KC_LSFT, KC_Z,    KC_X,    KC_C,    KC_V,    KC_B,    KC_N,    KC_M,    KC_COMM, KC_DOT,  KC_SLSH, KC_ENT,
  KC_PIPE, KC_LCTL, KC_LALT, KC_LGUI, LOWER,   KC_SPC,  KC_SPC,  RAISE,   KC_LEFT, KC_DOWN, KC_UP,   KC_RGHT
  ),

  [_RAISE] = LAYOUT_ortho_5x12(
  KC_GRV,  KC_F1,   KC_F2,   KC_F3,   KC_F4,   KC_F5,   KC_F6,   KC_F7,   KC_F8,   KC_F9,   KC_F10,  KC_F11,
  KC_ESC,  KC_1,    KC_2,    KC_3,    KC_4,    KC_5,    KC_6,    KC_7,    KC_8,    KC_9,    KC_0,    KC_DEL,
  _______, KC_4,    KC_5,    KC_6,    KC_PLUS, KC_F5,   KC_F6,   KC_MINS, KC_EQL,  KC_LBRC, KC_RBRC, _______,
  KC_ENT,  KC_7,    KC_8,    KC_9,    KC_MINS, KC_F11,  KC_F12,  KC_NUHS, KC_NUBS, KC_MUTE, _______, KC_BSLS,
  RESET,   _______, _______, _______, _______, _______, _______, _______, KC_MNXT, KC_VOLD, KC_VOLU, KC_MPLY
  ),

  [_LOWER] = LAYOUT_ortho_5x12(
  KC_ESC,  KC_F1,   KC_F2,   KC_F3,   KC_F4,   KC_F5,   KC_F6,   KC_F7,   KC_F8,   KC_F9,   KC_F10,  KC_F11,
  _______, _______, _______, _______, _______, _______, _______, _______, KC_UP,   _______, _______, _______,
  _______, _______, _______, _______, _______, _______, _______, KC_LEFT, KC_DOWN, KC_RGHT, _______, _______,
  KC_CAPS, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______,
  RESET,   _______, _______, _______, _______, _______, _______, _______, KC_MNXT, KC_VOLD, KC_VOLU, KC_MPLY
  )

};

A keyboards/boardsource/5x12/readme.md => keyboards/boardsource/5x12/readme.md +13 -0
@@ 0,0 1,13 @@
# 5x12

![boardsource 5x12](https://i.imgur.com/xuNxpgh.jpg)

* Keyboard Maintainer: [Boardsource](https://github.com/daysgobye) 
* Hardware Supported: 5x12 v1
* Hardware Availability: this keyboard is available from the [Boardsource store](https://boardsource.xyz/store/5ecb822386879c9a0c22db84)

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

    make boardsource/5x12: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).
\ No newline at end of file

A keyboards/boardsource/5x12/rules.mk => keyboards/boardsource/5x12/rules.mk +33 -0
@@ 0,0 1,33 @@
# MCU name
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 = caterina

# Build Options
#   change yes to no to disable
#
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
# 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
MIDI_ENABLE = no            # MIDI support
UNICODE_ENABLE = no         # Unicode
BLUETOOTH_ENABLE = no       # Enable Bluetooth with the Adafruit EZ-Key HID
AUDIO_ENABLE = no           # Audio output on port C6
FAUXCLICKY_ENABLE = no      # Use buzzer to emulate clicky switches

LAYOUTS = ortho_5x12