add handwired/swiftrax/retropad (#10331)

* add retropad

* fix indicator leds

* fix bootmagic

* fix led indicators

* fix keymap

* fix keymap

* fix keymap

* fix keymap

* fix license headers

* Apply suggestions from code review

Co-authored-by: Drashna Jaelre <drashna@live.com>

* Apply suggestions from code review

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

Co-authored-by: Swiftrax <swiftrax@gmail.com>
Co-authored-by: Drashna Jaelre <drashna@live.com>
Co-authored-by: Ryan <fauxpark@gmail.com>
This commit is contained in:
Brandon Claveria 2020-09-22 15:39:09 -07:00 committed by GitHub
parent 4bf5f9424e
commit 5faf5383ad
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
9 changed files with 298 additions and 0 deletions

View file

@ -0,0 +1,64 @@
/*
Copyright 2020 Swiftrax <swiftrax@gmail.com>
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 0xEB0C
#define DEVICE_VER 0x0001
#define MANUFACTURER Swiftrax
#define PRODUCT Retropad
/* key matrix size */
#define MATRIX_ROWS 3
#define MATRIX_COLS 2
// ROWS: Top to bottom, COLS: Left to right
#define MATRIX_ROW_PINS { C7, C6, B5 }
#define MATRIX_COL_PINS { B4, D2 }
#define ENCODERS_PAD_A { D0 }
#define ENCODERS_PAD_B { D1 }
/* COL2ROW or ROW2COL */
#define DIODE_DIRECTION COL2ROW
#define RGB_DI_PIN B7
#ifdef RGB_DI_PIN
#define RGBLIGHT_ANIMATIONS
#define RGBLED_NUM 6
#define RGBLIGHT_HUE_STEP 8
#define RGBLIGHT_SAT_STEP 8
#define RGBLIGHT_VAL_STEP 8
#endif
/* define if matrix has ghost */
//#define MATRIX_HAS_GHOST
/* Set 0 if debouncing isn't needed */
#define DEBOUNCE 5
/*EEPROM for via*/
#define DYNAMIC_KEYMAP_LAYER_COUNT 3
/* bootmagic row col assignment */
#define BOOTMAGIC_LITE_ROW 1
#define BOOTMAGIC_LITE_COLUMN 0

View file

@ -0,0 +1,12 @@
{
"keyboard_name": "Retropad",
"url": "https://github.com/swiftrax",
"maintainer": "swiftrax",
"width": 2,
"height": 3.5,
"layouts": {
"LAYOUT": {
"layout": [{"label":"0,1", "x":0.5, "y":0}, {"label":"1,0", "x":0, "y":1.5}, {"label":"1,1", "x":1, "y":1.5}, {"label":"2,0", "x":0, "y":2.5}, {"label":"2,1", "x":1, "y":2.5}]
}
}
}

View file

@ -0,0 +1,69 @@
/* Copyright 2020 swiftrax
*
* 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] = {
[0] = LAYOUT(
TO(1), //windows
KC_MSTP, KC_MPLY,
KC_MPRV, KC_MNXT),
[1] = LAYOUT( //macOS
TO(2),
KC_MSTP, KC_MPLY,
KC_MRWD, KC_MFFD),
[2] = LAYOUT(
TO(0),
KC_HOME, KC_PGUP,
KC_END, KC_PGDN),
};
void encoder_update_user(uint8_t index, bool clockwise) {
if(IS_LAYER_ON(2)){
if (clockwise)
tap_code(KC_LEFT);
else
tap_code(KC_RGHT);
}
else{
if(clockwise)
tap_code(KC_VOLU);
else
tap_code(KC_VOLD);
}
}
void matrix_init_user(void) {
// set top LED to output and off (active low)
setPinOutput(D5);
writePinHigh(D5);
// set middle LED to output and off (active low)
setPinOutput(D4);
writePinHigh(D4);
// set bottom LED to output and off (active low)
setPinOutput(D3);
writePinHigh(D3);
}
// write to above indicators in a binary fashion based on current layer
layer_state_t layer_state_set_user(layer_state_t state) {
writePin(D5, get_highest_layer(state));
writePin(D4, !layer_state_cmp(state, 1));
writePin(D3, !layer_state_cmp(state, 2));
return state;
}

View file

@ -0,0 +1,69 @@
/* Copyright 2020 swiftrax
*
* 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] = {
[0] = LAYOUT(
TO(1), //windows
KC_MSTP, KC_MPLY,
KC_MPRV, KC_MNXT),
[1] = LAYOUT( //macOS
TO(2),
KC_MSTP, KC_MPLY,
KC_MRWD, KC_MFFD),
[2] = LAYOUT(
TO(0),
KC_HOME, KC_PGUP,
KC_END, KC_PGDN),
};
void encoder_update_user(uint8_t index, bool clockwise) {
if(IS_LAYER_ON(2)){
if (clockwise)
tap_code(KC_LEFT);
else
tap_code(KC_RGHT);
}
else{
if(clockwise)
tap_code(KC_VOLU);
else
tap_code(KC_VOLD);
}
}
void matrix_init_user(void) {
// set top LED to output and off (active low)
setPinOutput(D5);
writePinHigh(D5);
// set middle LED to output and off (active low)
setPinOutput(D4);
writePinHigh(D4);
// set bottom LED to output and off (active low)
setPinOutput(D3);
writePinHigh(D3);
}
// write to above indicators in a binary fashion based on current layer
layer_state_t layer_state_set_user(layer_state_t state) {
writePin(D5, get_highest_layer(state));
writePin(D4, !layer_state_cmp(state, 1));
writePin(D3, !layer_state_cmp(state, 2));
return state;
}

View file

@ -0,0 +1 @@
VIA_ENABLE = yes

View file

@ -0,0 +1,13 @@
# Retropad
2x2 macro pad with a rotary encoder
* Keyboard Maintainer: Swiftrax
* Hardware Supported: Retropad PCB
* Hardware Availability: https://github.com/swiftrax
Make example for this keyboard (after setting up your build environment):
make handwired/swiftrax/retropad: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).

View file

@ -0,0 +1,16 @@
/* Copyright 2020 swiftrax
*
* 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 "retropad.h"

View file

@ -0,0 +1,31 @@
/* Copyright 2020 swiftrax
*
* 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"
// readability
#define XXX KC_NO
#define LAYOUT( \
K001, \
K100, K101, \
K200, K201 \
) { \
{ XXX, K001, }, \
{ K100, K101, }, \
{ K200, K201, } \
}

View file

@ -0,0 +1,23 @@
# MCU name
MCU = atmega32u2
# 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 = 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 = yes # Enable keyboard RGB underglow
BLUETOOTH_ENABLE = no # Enable Bluetooth
AUDIO_ENABLE = no # Audio output
ENCODER_ENABLE = yes