~ruther/qmk_firmware

1e6ef5d42ebce6f8f2c1a73f7ac7a2728241ed32 — QMK Bot 3 years ago 46292f5 + 57466c4
Merge remote-tracking branch 'origin/master' into develop
A keyboards/rmkeebs/rm_numpad/config.h => keyboards/rmkeebs/rm_numpad/config.h +155 -0
@@ 0,0 1,155 @@
/*
Copyright 2021 RuckerMachine

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   0x524E  /* RN (RMKeebs Numpad) */
#define DEVICE_VER   0x0001
#define MANUFACTURER RMKeebs
#define PRODUCT      rm_numpad

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

/*
 * 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 { B4, F7, C7, C6, F1, F0  }
#define MATRIX_COL_PINS { F4, F5, F6, B5, B6 }

#define UNUSED_PINS

/* COL2ROW, ROW2COL */
#define DIODE_DIRECTION COL2ROW

/* define encoder pins */
#define ENCODERS_PAD_A { D7 }
#define ENCODERS_PAD_B { D4 }

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

/* Bootmagic Lite key configuration */
//#define BOOTMAGIC_LITE_ROW 0
//#define BOOTMAGIC_LITE_COLUMN 0

A keyboards/rmkeebs/rm_numpad/info.json => keyboards/rmkeebs/rm_numpad/info.json +102 -0
@@ 0,0 1,102 @@
{
    "keyboard_name": "rm_numpad",
    "url": "https://www.rmkeebs.com/product/rm-numpad/",
    "maintainer": "RuckerMachine",
    "layouts": {
        "LAYOUT_default": {
            "layout": [
                {"label": "Pause", "x": 0, "y": 0.25},
                {"label": "Prev", "x": 1, "y": 0.25},
                {"label": "Next", "x": 2, "y": 0.25},
                {"label": "Mute", "x": 3.5, "y": 0},
		
                {"label": "Num_Lock", "x": 0, "y": 1.25},
                {"label": "/", "x": 1, "y": 1.25},
                {"label": "*", "x": 2, "y": 1.25},
                {"label": "-", "x": 3, "y": 1.25},
		
                {"label": "7", "x": 0, "y": 2.25},
                {"label": "8", "x": 1, "y": 2.25},
                {"label": "9", "x": 2, "y": 2.25},
                {"label": "+", "x": 3, "y": 2.25, "h": 2},
		
                {"label": "4", "x": 0, "y": 3.25},
                {"label": "5", "x": 1, "y": 3.25},
                {"label": "6", "x": 2, "y": 3.25},
		
                {"label": "1", "x": 0, "y": 4.25},
                {"label": "2", "x": 1, "y": 4.25},
                {"label": "3", "x": 2, "y": 4.25},
                {"label": "Enter", "x": 3, "y": 4.25, "h": 2},
		
                {"label": "0", "x": 0, "y": 5.25, "w": 2},
                {"label": ".", "x": 2, "y": 5.25}
            ]
        },
        "LAYOUT_split_plus": {
            "layout": [
                {"label": "Pause", "x": 0, "y": 0.25},
                {"label": "Prev", "x": 1, "y": 0.25},
                {"label": "Next", "x": 2, "y": 0.25},
                {"label": "Mute", "x": 3.5, "y": 0},

                {"label": "Num_Lock", "x": 0, "y": 1.25},
                {"label": "/", "x": 1, "y": 1.25},
                {"label": "*", "x": 2, "y": 1.25},
                {"label": "-", "x": 3, "y": 1.25},

                {"label": "7", "x": 0, "y": 2.25},
                {"label": "8", "x": 1, "y": 2.25},
                {"label": "9", "x": 2, "y": 2.25},
                {"label": "=", "x": 3, "y": 2.25}, 

                {"label": "4", "x": 0, "y": 3.25},
                {"label": "5", "x": 1, "y": 3.25},
                {"label": "6", "x": 2, "y": 3.25},
                {"label": "+", "x": 3, "y": 3.25},

                {"label": "1", "x": 0, "y": 4.25},
                {"label": "2", "x": 1, "y": 4.25},
                {"label": "3", "x": 2, "y": 4.25},
                {"label": "Enter", "x": 3, "y": 4.25, "h": 2},

                {"label": "0", "x": 0, "y": 5.25, "w": 2},
                {"label": ".", "x": 2, "y": 5.25}
            ]
        },
        "LAYOUT_ortho": {
            "layout": [
                {"label": "Pause", "x": 0, "y": 0.25},
                {"label": "Prev", "x": 1, "y": 0.25},
                {"label": "Next", "x": 2, "y": 0.25},
                {"label": "Mute", "x": 3.5, "y": 0},

                {"label": "Num_Lock", "x": 0, "y": 1.25},
                {"label": "/", "x": 1, "y": 1.25},
                {"label": "*", "x": 2, "y": 1.25},
                {"label": "-", "x": 3, "y": 1.25},

                {"label": "7", "x": 0, "y": 2.25},
                {"label": "8", "x": 1, "y": 2.25},
                {"label": "9", "x": 2, "y": 2.25},
                {"label": "=", "x": 3, "y": 2.25},

                {"label": "4", "x": 0, "y": 3.25},
                {"label": "5", "x": 1, "y": 3.25},
                {"label": "6", "x": 2, "y": 3.25},
                {"label": "+", "x": 3, "y": 3.25},

                {"label": "1", "x": 0, "y": 4.25},
                {"label": "2", "x": 1, "y": 4.25},
                {"label": "3", "x": 2, "y": 4.25},
                {"label": "Enter", "x": 3, "y": 4.25},

                {"label": "0", "x": 0, "y": 5.25},
                {"label": "00", "x": 1, "y": 5.25},
                {"label": ".", "x": 2, "y": 5.25},
                {"label": "Delete", "x": 3, "y": 5.25}
            ]
        }

    }
}

A keyboards/rmkeebs/rm_numpad/keymaps/default/keymap.c => keyboards/rmkeebs/rm_numpad/keymaps/default/keymap.c +32 -0
@@ 0,0 1,32 @@
/* Copyright 2021 RuckerMachine
 *
 * 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 */
    LAYOUT_numpad_6x4(
        KC_MPLY, KC_MPRV, KC_MNXT, KC_MUTE,
        KC_NLCK, KC_PSLS, KC_PAST, KC_PMNS, 
        KC_P7,   KC_P8,   KC_P9,   KC_PPLS,
        KC_P4,   KC_P5,   KC_P6,    
        KC_P1,   KC_P2,   KC_P3,   KC_PENT,
           KC_P0,      KC_PDOT
    )

};


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


![Default Layout](https://i.imgur.com/APQGsvU.png)


A keyboards/rmkeebs/rm_numpad/keymaps/ortho/keymap.c => keyboards/rmkeebs/rm_numpad/keymaps/ortho/keymap.c +48 -0
@@ 0,0 1,48 @@
/* Copyright 2021 RuckerMachine
 *
 * 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

enum custom_keycodes {
  DBL_ZRO = SAFE_RANGE,
};

bool process_record_user(uint16_t keycode, keyrecord_t *record) {
  switch (keycode) {
    case DBL_ZRO:
      if (record->event.pressed) {
        // when keycode DBL_ZRO is pressed
        SEND_STRING("00");
      } else {
        // when keycode DBL_ZRO is released
      }
      break;

  }
  return true;
};

const uint16_t PROGMEM keymaps[][MATRIX_ROWS][MATRIX_COLS] = {
    /* Base */
    LAYOUT_ortho_6x4(
        KC_MPLY, KC_MPRV, KC_MNXT, KC_MUTE,
        KC_NLCK, KC_PSLS, KC_PAST, KC_PMNS, 
        KC_P7,   KC_P8,   KC_P9,   KC_EQL,
        KC_P4,   KC_P5,   KC_P6,   KC_PPLS, 
        KC_P1,   KC_P2,   KC_P3,   KC_PENT,
        KC_P0,   DBL_ZRO, KC_PDOT, KC_DEL
    )
};


A keyboards/rmkeebs/rm_numpad/keymaps/ortho/readme.md => keyboards/rmkeebs/rm_numpad/keymaps/ortho/readme.md +4 -0
@@ 0,0 1,4 @@
# The ortho keymap for rm_numpad


![ortho layout](https://i.imgur.com/z8Pt9R6.png)

A keyboards/rmkeebs/rm_numpad/keymaps/split_plus/keymap.c => keyboards/rmkeebs/rm_numpad/keymaps/split_plus/keymap.c +31 -0
@@ 0,0 1,31 @@
/* Copyright 2021 RuckerMachine
 *
 * 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 */
    LAYOUT_split_plus_6x4(
        KC_MPLY, KC_MPRV, KC_MNXT, KC_MUTE,
        KC_NLCK, KC_PSLS, KC_PAST, KC_PMNS, 
        KC_P7,   KC_P8,   KC_P9,   KC_EQL,
        KC_P4,   KC_P5,   KC_P6,   KC_PPLS, 
        KC_P1,   KC_P2,   KC_P3,   KC_PENT,
           KC_P0,      KC_PDOT
    )
};


A keyboards/rmkeebs/rm_numpad/keymaps/split_plus/readme.md => keyboards/rmkeebs/rm_numpad/keymaps/split_plus/readme.md +4 -0
@@ 0,0 1,4 @@
# The split plus keymap for rm_numpad


![Split Plus](https://i.imgur.com/jd2y6ih.png)

A keyboards/rmkeebs/rm_numpad/readme.md => keyboards/rmkeebs/rm_numpad/readme.md +26 -0
@@ 0,0 1,26 @@
# rm_numpad

![rm_numpad](https://www.rmkeebs.com/wp-content/uploads/2022/02/20220225_1953022-1024x879.jpg)

A simple numpad with the addition of a few features:
* A few additional buttons.  The default keymap has these set to "Pause", "Previous Track", and "Next Track"
* A knob.  The default keymap has this knob configured to change volume, and clicking the knob is set to "Mute"
* 1u or 2u key options.  The "0" key, "+" key, and "Enter" key can be built out using 2u keys, like a normal numpad, or they can be built out using 2x 1u keys.

* Keyboard Maintainer: [RuckerMachine](https://github.com/RuckerMachine)
* Hardware Supported: RM Keebs RM Numpad kits available at [RMKeebs](https://www.rmkeebs.com/product/rm-numpad/)

## Bootloader

Enter the bootloader by briefly pressing the reset button on the back of the PCB.  A hole in the back of the case gives you access to the button.


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

    make rmkeebs/rm_numpad:default

Flashing example for this keyboard:

    make rmkeebs/rm_numpad: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/rmkeebs/rm_numpad/rm_numpad.c => keyboards/rmkeebs/rm_numpad/rm_numpad.c +31 -0
@@ 0,0 1,31 @@
/* Copyright 2021 RuckerMachine
 *
 * 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 "rm_numpad.h"

#ifdef ENCODER_ENABLE
bool encoder_update_kb(uint8_t index, bool clockwise) {
    if (!encoder_update_user(index, clockwise)) { return false; }
    if (index == 0) {
        if (clockwise) {
            tap_code_delay(KC_VOLU, 10);
        } else {
            tap_code_delay(KC_VOLD, 10);
        }
    }
    return true;
}
#endif

A keyboards/rmkeebs/rm_numpad/rm_numpad.h => keyboards/rmkeebs/rm_numpad/rm_numpad.h +127 -0
@@ 0,0 1,127 @@
/* Copyright 2021 RuckerMachine
 *
 * 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"
#define ___ KC_NO

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

/* rm_numpad default layout
 * .-------------------.
 * |PAUS|PREV|NEXT|MUTE|
 * |-------------------|
 * |NLCK|   /|   *|   -|
 * |-------------------|
 * |   7|   8|   9|    |
 * |--------------|    |
 * |   4|   5|   6|   +|
 * |-------------------|
 * |   1|   2|   3|    |
 * |--------------|    |
 * |        0|   .| Ent|
 * '-------------------'
 */

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

/* rm_numpad ortho layout
 * .-------------------.
 * |PAUS|PREV|NEXT|MUTE|
 * |-------------------|
 * |NLCK|   /|   *|   -|
 * |-------------------|
 * |   7|   8|   9|   =|
 * |-------------------|
 * |   4|   5|   6|   +|
 * |-------------------|
 * |   1|   2|   3| Ent|
 * |-------------------|
 * |   0|  00|   .| Del|
 * '-------------------'
 */

#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, k52, k53, k54 \
) { \
    { k00, k01, k02, k03, ___ }, \
    { k10, k11, k12, k13, ___ }, \
    { k20, k21, k22, k23, ___ }, \
    { k30, k31, k32, k33, ___ }, \
    { k40, k41, k42, k43, ___ }, \
    { k50, ___, k52, k53, k54 } \
}


/* rm_numpad split plus layout
 * .-------------------.
 * |PAUS|PREV|NEXT|MUTE|
 * |-------------------|
 * |NLCK|   /|   *|   -|
 * |-------------------|
 * |   7|   8|   9|   =|
 * |-------------------|
 * |   4|   5|   6|   +|
 * |-------------------|
 * |   1|   2|   3| Ent|
 * |--------------|    |
 * |        0|   .|    |
 * '-------------------'
 */

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


A keyboards/rmkeebs/rm_numpad/rules.mk => keyboards/rmkeebs/rm_numpad/rules.mk +21 -0
@@ 0,0 1,21 @@
# 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 = no            # Enable N-key Rollover
BACKLIGHT_ENABLE = no       # Enable keyboard backlight functionality
RGBLIGHT_ENABLE = no        # Enable keyboard RGB underglow
AUDIO_ENABLE = no           # Audio output
ENCODER_ENABLE = yes

LAYOUTS = numpad_6x4 ortho_6x4