~ruther/qmk_firmware

c1dc676d2819784f0e35bc2533f682ba564aeb37 — bbrfkr 4 years ago 138c3e7
[Keyboard] add scatter42 by bbrfkr (#10893)

* add new keyboard scatter42 by bbrfkr

* mod info.json to work

* mod info.json

* mod readme

* Update keyboards/scatter42/keymaps/default/keymap.c

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

* Update keyboards/scatter42/keymaps/default/keymap.c

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

* Update keyboards/scatter42/scatter42.h

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

* Update keyboards/scatter42/config.h

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

Co-authored-by: Ryan <fauxpark@gmail.com>
A keyboards/scatter42/config.h => keyboards/scatter42/config.h +147 -0
@@ 0,0 1,147 @@
/*
Copyright 2020 bbrfkr

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   0x3B47
#define DEVICE_VER   0x0001
#define MANUFACTURER bbrfkr
#define PRODUCT      scatter42

/* key matrix size */
#define MATRIX_ROWS 8
#define MATRIX_COLS 6

/*
 * 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 { D4, C6, D7, E6 }
#define MATRIX_COL_PINS { F4, F5, F6, F7, B1, B3 }
#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 D1, D2, D3, E6
#define USE_SERIAL

//#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/scatter42/info.json => keyboards/scatter42/info.json +223 -0
@@ 0,0 1,223 @@
{
    "keyboard_name": "scatter42",
    "url": "https://github.com/bbrfkr/keyboards/tree/master/scatter42",
    "maintainer": "bbrfkr",
    "width": 14,
    "height": 5.125,
    "layouts": {
        "LAYOUT": {
            "layout": [
                {
                    "label": "Q",
                    "x": 0,
                    "y": 0.5
                },
                {
                    "label": "W",
                    "x": 1,
                    "y": 0.25
                },
                {
                    "label": "E",
                    "x": 2,
                    "y": 0
                },
                {
                    "label": "R",
                    "x": 3,
                    "y": 0.25
                },
                {
                    "label": "T",
                    "x": 4,
                    "y": 0.5
                },
                {
                    "label": "Y",
                    "x": 9,
                    "y": 0.5
                },
                {
                    "label": "U",
                    "x": 10,
                    "y": 0.25
                },
                {
                    "label": "I",
                    "x": 11,
                    "y": 0
                },
                {
                    "label": "O",
                    "x": 12,
                    "y": 0.25
                },
                {
                    "label": "P",
                    "x": 13,
                    "y": 0.5
                },
                {
                    "label": "A",
                    "x": 0,
                    "y": 1.5
                },
                {
                    "label": "S",
                    "x": 1,
                    "y": 1.25
                },
                {
                    "label": "D",
                    "x": 2,
                    "y": 1
                },
                {
                    "label": "F",
                    "x": 3,
                    "y": 1.25
                },
                {
                    "label": "G",
                    "x": 4,
                    "y": 1.5
                },
                {
                    "label": "H",
                    "x": 9,
                    "y": 1.5
                },
                {
                    "label": "J",
                    "x": 10,
                    "y": 1.25
                },
                {
                    "label": "K",
                    "x": 11,
                    "y": 1
                },
                {
                    "label": "L",
                    "x": 12,
                    "y": 1.25
                },
                {
                    "label": ";",
                    "x": 13,
                    "y": 1.5
                },
                {
                    "label": "Z",
                    "x": 0,
                    "y": 2.5
                },
                {
                    "label": "X",
                    "x": 1,
                    "y": 2.25
                },
                {
                    "label": "C",
                    "x": 2,
                    "y": 2
                },
                {
                    "label": "V",
                    "x": 3,
                    "y": 2.25
                },
                {
                    "label": "B",
                    "x": 4,
                    "y": 2.5
                },
                {
                    "label": "N",
                    "x": 9,
                    "y": 2.5
                },
                {
                    "label": "M",
                    "x": 10,
                    "y": 2.25
                },
                {
                    "label": ",",
                    "x": 11,
                    "y": 2
                },
                {
                    "label": ".",
                    "x": 12,
                    "y": 2.25
                },
                {
                    "label": "/",
                    "x": 13,
                    "y": 2.5
                },
                {
                    "label": "Ctrl",
                    "x": 0,
                    "y": 3.5
                },
                {
                    "label": "Shift",
                    "x": 1,
                    "y": 3.25
                },
                {
                    "label": "Tab",
                    "x": 2,
                    "y": 3
                },
                {
                    "label": "Super",
                    "x": 3.5,
                    "y": 3.625
                },
                {
                    "label": "Lower",
                    "x": 4.5,
                    "y": 3.875
                },
                {
                    "label": "Space",
                    "x": 5.5,
                    "y": 4.125
                },
                {
                    "label": "Enter",
                    "x": 7.45,
                    "y": 4.125
                },
                {
                    "label": "Raise",
                    "x": 8.45,
                    "y": 3.875
                },
                {
                    "label": "Alt",
                    "x": 9.45,
                    "y": 3.625
                },
                {
                    "label": "Back",
                    "x": 11,
                    "y": 3
                },
                {
                    "label": "Shift",
                    "x": 12,
                    "y": 3.25
                },
                {
                    "label": "Ctrl",
                    "x": 13,
                    "y": 3.5
                }
            ]
        }
    }
}

A keyboards/scatter42/keymaps/default/keymap.c => keyboards/scatter42/keymaps/default/keymap.c +31 -0
@@ 0,0 1,31 @@
/* Copyright 2020 bbrfkr
 *
 * 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,
    _LOWER,
    _RAISE,
    _FN
};

const uint16_t PROGMEM keymaps[][MATRIX_ROWS][MATRIX_COLS] = {
        [0] = LAYOUT(KC_Q, KC_W, KC_E, KC_R, KC_T, KC_Y, KC_U, KC_I, KC_O, KC_P, KC_A, KC_S, KC_D, KC_F, KC_G, KC_H, KC_J, KC_K, KC_L, KC_SCLN, KC_Z, KC_X, KC_C, KC_V, KC_B, KC_N, KC_M, KC_COMM, KC_DOT, KC_SLSH, KC_LCTL, KC_LSFT, KC_TAB, KC_LGUI, MO(1), KC_SPC, KC_ENT, MO(2), KC_RALT, KC_BSPC, KC_RSFT, KC_RCTL),
        [1] = LAYOUT(KC_1, KC_2, KC_3, KC_4, KC_5, KC_6, KC_7, KC_8, KC_9, KC_0, KC_F11, KC_HOME, KC_PGDN, KC_PGUP, KC_END, KC_LEFT, KC_DOWN, KC_UP, KC_RGHT, KC_F12, KC_F1, KC_F2, KC_F3, KC_F4, KC_F5, KC_F6, KC_F7, KC_F8, KC_F9, KC_F10, KC_LCTL, KC_LSFT, KC_ESC, KC_LGUI, KC_TRNS, KC_SPC, KC_ENT, MO(3), KC_RALT, KC_DEL, KC_RSFT, KC_PSCR),
        [2] = LAYOUT(KC_EXLM, KC_AT, KC_HASH, KC_DLR, KC_PERC, KC_CIRC, KC_AMPR, KC_ASTR, KC_LPRN, KC_RPRN, KC_NO, KC_NO, KC_NO, KC_BSLS, KC_GRV, KC_MINS, KC_EQL, KC_QUOT, KC_LCBR, KC_RCBR, KC_NO, KC_NO, KC_NO, KC_PIPE, KC_TILD, KC_UNDS, KC_PLUS, KC_DQUO, KC_LBRC, KC_RBRC, KC_LCTL, KC_LSFT, KC_ESC, KC_LGUI, MO(3), KC_SPC, KC_ENT, KC_TRNS, KC_RALT, KC_DEL, KC_RSFT, KC_RCTL),
        [3] = LAYOUT(KC_VOLU, RESET, KC_NO, KC_NO, KC_NO, KC_NO, KC_NO, KC_NO, KC_NO, KC_BRIU, KC_VOLD, RGB_TOG, RGB_HUI, RGB_SAI, RGB_VAI, KC_NO, KC_NO, KC_NO, KC_NO, KC_BRID, KC_MUTE, RGB_MOD, RGB_HUD, RGB_SAD, RGB_VAD, KC_NO, KC_NO, KC_NO, KC_NO, KC_NO, KC_NO, KC_NO, KC_NO, KC_NO, KC_TRNS, KC_NO, KC_NO, KC_TRNS, KC_NO, KC_NO, KC_NO, KC_NO)
};

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

A keyboards/scatter42/readme.md => keyboards/scatter42/readme.md +19 -0
@@ 0,0 1,19 @@
# scatter42

[![scatter42](https://i.imgur.com/2MGMcip.jpg)](https://imgur.com/2MGMcip)

A split keyboard with 39 (4rows and 5columns) keys and 3 keys for thumbs.

* Keyboard Maintainer: [bbrfkr](https://github.com/bbrfkr) [@bbrfkr](https://twitter.com/bbrfkr)
* Hardware Supported: scatter42 PCB, Pro Micro
* Hardware Availability: https://bbrfkr.booth.pm/

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

    make scatter42:default

Flashing example for this keyboard:

    make scatter42: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).

A keyboards/scatter42/rules.mk => keyboards/scatter42/rules.mk +23 -0
@@ 0,0 1,23 @@
# 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 = 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
# 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
SPLIT_KEYBOARD = yes
\ No newline at end of file

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

A keyboards/scatter42/scatter42.h => keyboards/scatter42/scatter42.h +44 -0
@@ 0,0 1,44 @@
/* Copyright 2020 bbrfkr
 *
 * 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,           R00, R01, R02, R03, R04, \
  L10, L11, L12, L13, L14,           R10, R11, R12, R13, R14, \
  L20, L21, L22, L23, L24,           R20, R21, R22, R23, R24, \
  L30, L31, L32, L33, L34, L35, R30, R31, R32, R33, R34, R35 \
  ) \
  { \
    { L00, L01, L02, L03, L04, KC_NO }, \
    { L10, L11, L12, L13, L14, KC_NO }, \
    { L20, L21, L22, L23, L24, KC_NO }, \
    { L30, L31, L32, L33, L34, L35 }, \
    { R04, R03, R02, R01, R00, KC_NO }, \
    { R14, R13, R12, R11, R10, KC_NO }, \
    { R24, R23, R22, R21, R20, KC_NO }, \
    { R35, R34, R33, R32, R31, R30 } \
  }