~ruther/qmk_firmware

6cfc3cd940370d80fd44554eb9f669950495e1f9 — Josh Hinnebusch 5 years ago e84e9a2
[Keyboard] add hineybush/h10 pcb (#9036)

* initial h10 commit

* update h10

* update files, add via keymap

* edit h10 readme

* update per PR requests

* add copyright (i think this is what fauxpark wants)

* fix comment

* remove config.h files

* update per PR requests

* Update keyboards/hineybush/h10/info.json

* Update keyboards/hineybush/h10/info.json
A keyboards/hineybush/h10/config.h => keyboards/hineybush/h10/config.h +126 -0
@@ 0,0 1,126 @@
/*
Copyright 2020 hineybush

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 0x04D8
#define PRODUCT_ID 0xEBD8
#define DEVICE_VER 0x0001
#define MANUFACTURER hineybush
#define PRODUCT h10
#define DESCRIPTION Custom numpad PCB

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

/*
 * 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, C6, B6, B5, B4, D7 }
#define MATRIX_COL_PINS { F0, C7, B1, B2 }
#define UNUSED_PINS

/* COL2ROW, ROW2COL*/
#define DIODE_DIRECTION COL2ROW

#define BACKLIGHT_PIN B7
#define BACKLIGHT_BREATHING
#define BACKLIGHT_LEVELS 3

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

/* 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/hineybush/h10/h10.c => keyboards/hineybush/h10/h10.c +29 -0
@@ 0,0 1,29 @@
/* Copyright 2020 hineybush
 *
 * 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 "h10.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.

/*
bool led_update_kb(led_t led_state) {
    // placeholder for LED indicator added to next revision

    return led_update_user(led_state);
}
*/

A keyboards/hineybush/h10/h10.h => keyboards/hineybush/h10/h10.h +146 -0
@@ 0,0 1,146 @@
/* Copyright 2020 hineybush
 *
 * 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_ortho_6x4(    \
    k00, k01, k02, k03, \
    k10, k11, k12, k13, \
    k20, k21, k22, k23, \
    k30, k31, k32, k33, \
    k40, k41, k42, k43, \
    k50, k51, k52, k53  \
) \
{ \
    {k00, k01, k02, k03}, \
    {k10, k11, k12, k13}, \
    {k20, k21, k22, k23}, \
    {k30, k31, k32, k33}, \
    {k40, k41, k42, k43}, \
    {k50, k51, k52, k53}  \
}

#define LAYOUT_numpad_6x4(  \
    k00, k01, k02, k03, \
    k10, k11, k12, k13, \
    k20, k21, k22,      \
    k30, k31, k32, k33, \
    k40, k41, k42,      \
         k51, k52, k53  \
) \
{ \
    {k00, k01, k02, k03}, \
    {k10, k11, k12, k13}, \
    {k20, k21, k22, KC_NO}, \
    {k30, k31, k32, k33}, \
    {k40, k41, k42, KC_NO}, \
    {KC_NO, k51, k52, k53}  \
}

#define LAYOUT_split_plus(  \
    k00, k01, k02, k03, \
    k10, k11, k12, k13, \
    k20, k21, k22, k23, \
    k30, k31, k32, k33, \
    k40, k41, k42,      \
         k51, k52, k53  \
) \
{ \
    {k00, k01, k02, k03}, \
    {k10, k11, k12, k13}, \
    {k20, k21, k22, k23}, \
    {k30, k31, k32, k33}, \
    {k40, k41, k42, KC_NO}, \
    {KC_NO, k51, k52, k53}  \
}

#define LAYOUT_split_zero(  \
    k00, k01, k02, k03, \
    k10, k11, k12, k13, \
    k20, k21, k22,      \
    k30, k31, k32, k33, \
    k40, k41, k42,      \
    k50, k51, k52, k53  \
) \
{ \
    {k00, k01, k02, k03}, \
    {k10, k11, k12, k13}, \
    {k20, k21, k22, KC_NO}, \
    {k30, k31, k32, k33}, \
    {k40, k41, k42, KC_NO}, \
    {k50, k51, k52, k53}  \
}

#define LAYOUT_split_enter(  \
    k00, k01, k02, k03, \
    k10, k11, k12, k13, \
    k20, k21, k22,      \
    k30, k31, k32, k33, \
    k40, k41, k42, k43, \
         k51, k52, k53  \
) \
{ \
    {k00, k01, k02, k03}, \
    {k10, k11, k12, k13}, \
    {k20, k21, k22, KC_NO}, \
    {k30, k31, k32, k33}, \
    {k40, k41, k42, k43}, \
    {KC_NO, k51, k52, k53}  \
}

#define LAYOUT_split_enter_plus(  \
    k00, k01, k02, k03, \
    k10, k11, k12, k13, \
    k20, k21, k22, k23, \
    k30, k31, k32, k33, \
    k40, k41, k42, k43, \
         k51, k52, k53  \
) \
{ \
    {k00, k01, k02, k03}, \
    {k10, k11, k12, k13}, \
    {k20, k21, k22, k23}, \
    {k30, k31, k32, k33}, \
    {k40, k41, k42, k43}, \
    {KC_NO, k51, k52, k53}  \
}

#define LAYOUT_split_zero_plus(  \
    k00, k01, k02, k03, \
    k10, k11, k12, k13, \
    k20, k21, k22, k23, \
    k30, k31, k32, k33, \
    k40, k41, k42,      \
    k50, k51, k52, k53  \
) \
{ \
    {k00, k01, k02, k03}, \
    {k10, k11, k12, k13}, \
    {k20, k21, k22, k23}, \
    {k30, k31, k32, k33}, \
    {k40, k41, k42, KC_NO}, \
    {k50, k51, k52, k53}  \
}

A keyboards/hineybush/h10/info.json => keyboards/hineybush/h10/info.json +12 -0
@@ 0,0 1,12 @@
{
    "keyboard_name": "h10",
    "url": "",
    "maintainer": "hineybush",
    "width": 5.25,
    "height": 7.5,
    "layouts": {
        "LAYOUT_ortho_6x4": {
            "layout": [{"label":"0,0", "x":0, "y":0}, {"label":"0,1", "x":1, "y":0}, {"label":"0,2", "x":2, "y":0}, {"label":"0,3", "x":3, "y":0}, {"label":"1,0", "x":0, "y":1.25}, {"label":"1,1", "x":1, "y":1.25}, {"label":"1,2", "x":2, "y":1.25}, {"label":"1,3", "x":3, "y":1.25}, {"label":"2,0", "x":0, "y":2.25}, {"label":"2,1", "x":1, "y":2.25}, {"label":"2,2", "x":2, "y":2.25}, {"label":"2,3", "x":3, "y":2.25}, {"label":"3,0", "x":0, "y":3.25}, {"label":"3,1", "x":1, "y":3.25}, {"label":"3,2", "x":2, "y":3.25}, {"label":"3,3", "x":3, "y":3.25}, {"label":"4,0", "x":0, "y":4.25}, {"label":"4,1", "x":1, "y":4.25}, {"label":"4,2", "x":2, "y":4.25}, {"label":"4,3", "x":3, "y":4.25}, {"label":"5,0", "x":0, "y":5.25}, {"label":"5,1", "x":1, "y":5.25}, {"label":"5,2", "x":2, "y":5.25}, {"label":"5,3", "x":3, "y":5.25}]
        }
    }
}

A keyboards/hineybush/h10/keymaps/default/keymap.c => keyboards/hineybush/h10/keymaps/default/keymap.c +40 -0
@@ 0,0 1,40 @@
/* Copyright 2020 hineybush
 *
 * 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


const uint16_t PROGMEM keymaps[][MATRIX_ROWS][MATRIX_COLS] = {
    /* Base */
    [0] = LAYOUT_numpad_6x4(
        KC_ESC,   KC_PEQL,   KC_BSPC,  MO(1),
        KC_NLCK,  KC_PSLS,   KC_PAST,  KC_PMNS,
        KC_P7,    KC_P8,     KC_P9,
        KC_P4,    KC_P5,     KC_P6,    KC_PPLS,
        KC_P1,    KC_P2,     KC_P3,
                  KC_P0,     KC_PDOT,  KC_PENT
    ),
    [1] = LAYOUT_numpad_6x4(
        KC_VOLU,   KC_MPLY,   KC_MNXT,   KC_TRNS,
        KC_VOLD,   KC_TRNS,   KC_TRNS,   KC_TRNS,
        KC_TRNS,   KC_TRNS,   KC_TRNS,
        KC_TRNS,   KC_TRNS,   KC_TRNS,   KC_TRNS,
        KC_TRNS,   KC_TRNS,   KC_TRNS,
                   KC_TRNS,   KC_TRNS,   RESET
    ),
};




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

A keyboards/hineybush/h10/keymaps/via/keymap.c => keyboards/hineybush/h10/keymaps/via/keymap.c +56 -0
@@ 0,0 1,56 @@
/* Copyright 2020 hineybush
 *
 * 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


const uint16_t PROGMEM keymaps[][MATRIX_ROWS][MATRIX_COLS] = {
    /* Base */
    [0] = LAYOUT_numpad_6x4(
        KC_ESC,   KC_PEQL,   KC_BSPC,  MO(1),
        KC_NLCK,  KC_PSLS,   KC_PAST,  KC_PMNS,
        KC_P7,    KC_P8,     KC_P9,
        KC_P4,    KC_P5,     KC_P6,    KC_PPLS,
        KC_P1,    KC_P2,     KC_P3,
                  KC_P0,     KC_PDOT,  KC_PENT
    ),
    [1] = LAYOUT_numpad_6x4(
        KC_VOLU,   KC_MPLY,   KC_MNXT,   KC_TRNS,
        KC_VOLD,   KC_TRNS,   KC_TRNS,   KC_TRNS,
        KC_TRNS,   KC_TRNS,   KC_TRNS,
        KC_TRNS,   KC_TRNS,   KC_TRNS,   KC_TRNS,
        KC_TRNS,   KC_TRNS,   KC_TRNS,
                   KC_TRNS,   KC_TRNS,   RESET
    ),
    [2] = LAYOUT_numpad_6x4(
        KC_VOLU,   KC_MPLY,   KC_MNXT,   KC_TRNS,
        KC_VOLD,   KC_TRNS,   KC_TRNS,   KC_TRNS,
        KC_TRNS,   KC_TRNS,   KC_TRNS,
        KC_TRNS,   KC_TRNS,   KC_TRNS,   KC_TRNS,
        KC_TRNS,   KC_TRNS,   KC_TRNS,
                   KC_TRNS,   KC_TRNS,   KC_TRNS
    ),
    [3] = LAYOUT_numpad_6x4(
        KC_VOLU,   KC_MPLY,   KC_MNXT,   KC_TRNS,
        KC_VOLD,   KC_TRNS,   KC_TRNS,   KC_TRNS,
        KC_TRNS,   KC_TRNS,   KC_TRNS,
        KC_TRNS,   KC_TRNS,   KC_TRNS,   KC_TRNS,
        KC_TRNS,   KC_TRNS,   KC_TRNS,
                   KC_TRNS,   KC_TRNS,   KC_TRNS
    ),
};




A keyboards/hineybush/h10/keymaps/via/readme.md => keyboards/hineybush/h10/keymaps/via/readme.md +1 -0
@@ 0,0 1,1 @@
# The via keymap for h10

A keyboards/hineybush/h10/keymaps/via/rules.mk => keyboards/hineybush/h10/keymaps/via/rules.mk +2 -0
@@ 0,0 1,2 @@
# Copyright hineybush 2020
VIA_ENABLE = yes

A keyboards/hineybush/h10/readme.md => keyboards/hineybush/h10/readme.md +15 -0
@@ 0,0 1,15 @@
# h10

![h10](https://i.imgur.com/PeMuPZir.jpg)

A custom numpad PCB.

* Keyboard Maintainer: [hineybush](https://github.com/hineybush)
* Hardware Supported: h10 proto 1
* Hardware Availability: hiney.cc

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

    make hineybush/h10: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).

A keyboards/hineybush/h10/rules.mk => keyboards/hineybush/h10/rules.mk +26 -0
@@ 0,0 1,26 @@
# 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 = no       # 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 = yes       # 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
AUDIO_ENABLE = no           # Audio output
FAUXCLICKY_ENABLE = no      # Use buzzer to emulate clicky switches

LAYOUTS = ortho_6x4 numpad_6x4