* Add PRKL30 default keymap * Modify readmes, fix info.json url * added layer pictures to readme.md * edited layer pictures * edited layer pictures * edited layer pictures * edited layout pictures * edited layout pictures * Modify default keymap * Add arrows to Raise layer * Add perkele macro and adjust symbols * Add PRKL macro and modify keymap comments * updated layout pictures * edited layut pictures * Add correct minus keycode * Configure Feather config * Update keyboards/handwired/prkl30/keymaps/default/keymap.c * Update keyboards/handwired/prkl30/feather/rules.mk * Update keyboards/handwired/prkl30/feather/config.h * Update keyboards/handwired/prkl30/feather/config.h * Update keyboards/handwired/prkl30/promicro/config.h * Update keyboards/handwired/prkl30/promicro/rules.mk * Update keyboards/handwired/prkl30/feather/config.h * Update keyboards/handwired/prkl30/feather/config.h * Update keyboards/handwired/prkl30/promicro/config.h * Update keyboards/handwired/prkl30/feather/rules.mk * Update keyboards/handwired/prkl30/keymaps/default/keymap.c * Update keyboards/handwired/prkl30/info.json * Update keyboards/handwired/prkl30/info.json * Update keyboards/handwired/prkl30/keymaps/default/keymap.c * Delete unused config * Apply suggestions from code review Commit code review changes * Remove false comments from rules.mk * Change layout to layout_all * Apply suggestions from code review Co-authored-by: Toni Johansson <toni.r.johansson@gmail.com>pull/8351/head
@ -0,0 +1,51 @@ | |||
/* Copyright 2020 Erkki Halinen & Toni Johansson | |||
* | |||
* 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 0xE0E0 | |||
#define PRODUCT_ID 0x0030 | |||
#define DEVICE_VER 0x0002 | |||
#define MANUFACTURER Ergorius & Tooni Skyy | |||
#define PRODUCT PRKL30 | |||
#define DESCRIPTION 30% Mechanical keyboard | |||
/* key matrix size */ | |||
#define MATRIX_ROWS 4 | |||
#define MATRIX_COLS 10 | |||
/* PRKL30 feather pinout */ | |||
#define MATRIX_ROW_PINS { F4, F1, F0, D2} | |||
#define MATRIX_COL_PINS { D3, D1, B7, D6, C7, B6, B5, D7, C6, D0} | |||
/* COL2ROW, ROW2COL*/ | |||
#define DIODE_DIRECTION COL2ROW | |||
#define ENCODERS_PAD_A { F7 } | |||
#define ENCODERS_PAD_B { F6 } | |||
#define ENCODER_RESOLUTION 4 | |||
#define AdafruitBleResetPin D4 | |||
#define AdafruitBleCSPin B4 | |||
#define AdafruitBleIRQPin E6 | |||
#define UNUSED_PINS | |||
/* RGB Light Configuration */ | |||
#define RGB_DI_PIN D1 | |||
#define RGBLIGHT_ANIMATIONS | |||
#define RGBLED_NUM 13 | |||
#define RGBLIGHT_HUE_STEP 8 | |||
#define RGBLIGHT_SAT_STEP 8 | |||
#define RGBLIGHT_VAL_STEP 8 |
@ -0,0 +1,31 @@ | |||
# MCU name | |||
MCU = atmega32u4 | |||
# Processor frequency | |||
F_CPU = 8000000 | |||
# 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 | |||
# | |||
BLUETOOTH = AdafruitBLE | |||
BOOTMAGIC_ENABLE = yes # Virtual DIP switch configuration | |||
ENCODER_ENABLE = yes | |||
MOUSEKEY_ENABLE = no # Mouse keys | |||
EXTRAKEY_ENABLE = no # Audio control and System control | |||
CONSOLE_ENABLE = yes # Console for debug | |||
COMMAND_ENABLE = yes # Commands for debug and configuration | |||
SLEEP_LED_ENABLE = no # Breathing sleep LED during USB suspend | |||
NKRO_ENABLE = yes # USB Nkey Rollover - if this doesn't work, see here: https://github.com/tmk/tmk_keyboard/wiki/FAQ#nkro-doesnt-work | |||
BACKLIGHT_ENABLE = no | |||
AUDIO_ENABLE = no # This can be enabled if a speaker is connected to the expansion port. Not compatible with RGBLIGHT below | |||
RGBLIGHT_ENABLE = no # This can be enabled if a ws2812 strip is connected to the expansion port. |
@ -0,0 +1,15 @@ | |||
{ | |||
"keyboard_name": "prkl30", | |||
"url": "https://github.com/ErkHal/prkl30", | |||
"maintainer": "ErkHal", | |||
"width": 13.5, | |||
"height": 3, | |||
"layouts": { | |||
"LAYOUT_all": { | |||
"layout": [{"x":0, "y":0}, {"x":1, "y":0}, {"x":2, "y":0}, {"x":3, "y":0}, {"x":4, "y":0}, {"x":5, "y":0}, {"x":6, "y":0}, {"x":7, "y":0}, {"x":8, "y":0}, {"x":9, "y":0}, {"x":10, "y":0}, {"x":11, "y":0}, {"x":12, "y":0, "w":1.5}, {"x":0, "y":1}, {"x":1, "y":1}, {"x":2, "y":1}, {"x":3, "y":1}, {"x":4, "y":1}, {"x":5, "y":1}, {"x":6, "y":1}, {"x":7, "y":1}, {"x":8, "y":1}, {"x":9, "y":1}, {"x":10, "y":1}, {"x":11, "y":1}, {"x":12.25, "y":1, "w":1.25, "h":2}, {"x":0, "y":2}, {"x":1, "y":2}, {"x":2, "y":2}, {"x":3, "y":2}, {"x":4, "y":2}, {"x":5, "y":2}, {"x":6, "y":2}, {"x":7, "y":2}, {"x":8, "y":2}, {"x":9, "y":2}, {"x":10, "y":2}, {"x":11, "y":2, "w":1.25}] | |||
}, | |||
"LAYOUT_2u_space": { | |||
"layout": [{"x":0, "y":0}, {"x":1, "y":0}, {"x":2, "y":0}, {"x":3, "y":0}, {"x":4, "y":0}, {"x":5, "y":0}, {"x":6, "y":0}, {"x":7, "y":0}, {"x":8, "y":0}, {"x":9, "y":0}, {"x":10, "y":0}, {"x":11, "y":0}, {"x":12, "y":0, "w":1.5}, {"x":0, "y":1}, {"x":1, "y":1}, {"x":2, "y":1}, {"x":3, "y":1}, {"x":4, "y":1}, {"x":5, "y":1}, {"x":6, "y":1}, {"x":7, "y":1}, {"x":8, "y":1}, {"x":9, "y":1}, {"x":10, "y":1}, {"x":11, "y":1}, {"x":12.25, "y":1, "w":1.25, "h":2}, {"x":0, "y":2}, {"x":1, "y":2}, {"x":2, "y":2}, {"x":3, "y":2}, {"x":4, "y":2}, {"x":5, "y":2, "w":2}, {"x":7, "y":2}, {"x":8, "y":2}, {"x":9, "y":2}, {"x":10, "y":2}, {"x":11, "y":2, "w":1.25}] | |||
} | |||
} | |||
} |
@ -0,0 +1,102 @@ | |||
#include QMK_KEYBOARD_H | |||
#include "keymap_nordic.h" | |||
enum layers { | |||
_DEFAULT, | |||
_LOWER, | |||
_RAISE, | |||
_FN | |||
}; | |||
enum custom_keycodes { | |||
PRKL = SAFE_RANGE, | |||
}; | |||
#define LOWER MO(_LOWER) | |||
#define RAISE MO(_RAISE) | |||
#define FN MO(_FN) | |||
const uint16_t PROGMEM keymaps[][MATRIX_ROWS][MATRIX_COLS] = { | |||
/* Default | |||
* ,-----------------------------------------------------------------------------------.------. | |||
* | Esc | Q | W | E | R | T | Y | U | I | O | P | ¨^ | Bksp | | |||
* |------+------+------+------+------+-------------+------+------+------+------+------|------| | |||
* | Tab | A | S | D | F | G | H | J | K | L | Ö | Ä | Entr | | |||
* |------+------+------+------+------+------|------+------+------+------+------+------|------' | |||
* | Shift| Z | X | C | V | Space | B | N | M | , | . | | |||
* |------+------+------+------+------+------+------+------+------+------+------+------' | |||
*/ | |||
[_DEFAULT] = LAYOUT_all( | |||
KC_ESC, KC_Q, KC_W, KC_E, KC_R, KC_T, KC_Y, KC_U, KC_I, KC_O, KC_P, NO_QUOT, KC_BSPC, | |||
KC_LCTL, KC_A, KC_S, KC_D, KC_F, KC_G, KC_H, KC_J, KC_K, KC_L, NO_AE, NO_OSLH, LT(_FN, KC_ENT), | |||
KC_LSFT, KC_Z, KC_X, KC_C, KC_V, LT(_LOWER, KC_SPC), _______, KC_B, KC_N, KC_M, KC_COMM, LT(_RAISE, KC_DOT) | |||
), | |||
/* Lower - Numbers and some symbols | |||
* ,------------------------------------------------------------------------------------------. | |||
* | ~ | 1 | 2 | 3 | 4 | 5 | 6 | 7 | 8 | 9 | 0 | + | DEL | | |||
* |------+------+------+------+------+------+------+------+------+------+------+------|------| | |||
* | | | | | | | | | | | | | | | |||
* |------+------+------+------+------+------+------+------+------+------+------+------|------' | |||
* | | | | | | | | | | - | | | |||
* `------+------+------+------+------+------+------+------+------+------+------+------' | |||
*/ | |||
[_LOWER] = LAYOUT_all( | |||
KC_TILD, KC_1, KC_2, KC_3, KC_4, KC_5, KC_6, KC_7, KC_8, KC_9, KC_0, NO_PLUS, KC_DEL, | |||
_______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, | |||
_______, _______, _______, _______, _______, _______, _______, _______, _______, _______, NO_MINS, _______ | |||
), | |||
/* Raise - AltGred Characters and more symbols | |||
* ,------------------------------------------------------------------------------------------. | |||
* | ~ | > | @ | £ | $ | % | & | | | [ | ] | ≈ | ? | { | | |||
* |------+------+------+------+------+------+------+------+------+------+------+------|------| | |||
* | | | | UP | | | | | | | | | } | | |||
* |------+------+------+------+------+------+------+------+------+------+------+------|------' | |||
* | | < | LEFT | DOWN | RIGHT| | | | | | | | |||
* `------+------+------+------+------+------+------+------+------+------+------+------' | |||
*/ | |||
[_RAISE] = LAYOUT_all( | |||
NO_TILD, NO_SECT, NO_AT, NO_PND, NO_DLR, KC_PERC, NO_AMPR, NO_LCBR, NO_LBRC, NO_RBRC, NO_RCBR, NO_QUES, LSFT(NO_LBRC), | |||
_______, _______, _______, KC_UP, _______, _______, _______, _______, _______, _______, _______, _______, LSFT(NO_RBRC), | |||
_______, NO_HALF, KC_LEFT, KC_DOWN, KC_RGHT, _______, _______, _______, _______, _______, _______, _______ | |||
), | |||
/* FN | |||
* ,------------------------------------------------------------------------------------------. | |||
* |RESET | F1 | F2 | F3 | F4 | F5 | F6 | F7 | F8 | F9 | F10 | F11 | F12 | | |||
* |------+------+------+------+------+------+------+------+------+------+------+------|------| | |||
* | |RGB_P |RGB_HD|RGB_HI| VOL- | PREV | NEXT | VOL+ | | | | PRKL | | | |||
* |------+------+------+------+------+------+------+------+------+------+------+------|------' | |||
* | RGB_M|RGB_VD|RGB_VI|RGB_TG| | PLAY/PAUSE | | | |LCA(DEL)| | | |||
* `------+------+------+------+------+------+------+------+------+------+------+------' | |||
*/ | |||
[_FN] = LAYOUT_all( | |||
RESET, KC_F1, KC_F2, KC_F3, KC_F4, KC_F5, KC_F6, KC_F7, KC_F8, KC_F9, KC_F10, KC_F11, KC_F12, | |||
_______, RGB_M_P, RGB_HUD, RGB_HUI, KC_VOLD, KC_MPRV, KC_MNXT, KC_VOLU, _______, _______, _______, PRKL, _______, | |||
RGB_MOD, RGB_VAD, RGB_VAI, RGB_TOG, _______, KC_MPLY, _______, _______, _______, _______, LCA(KC_DEL), _______ | |||
), | |||
}; | |||
void encoder_update_user(uint8_t index, bool clockwise) { | |||
if (clockwise) { | |||
tap_code(KC_TAB); | |||
} else { | |||
tap_code(KC_PGUP); | |||
} | |||
} | |||
bool process_record_user(uint16_t keycode, keyrecord_t *record) { | |||
switch (keycode) { | |||
case PRKL: | |||
if (record->event.pressed) { | |||
//When PRKL is pressed, print out the holy power word of our people | |||
SEND_STRING("PERKELE"); | |||
} | |||
break; | |||
} | |||
return true; | |||
}; |
@ -0,0 +1,26 @@ | |||
# The default keymap for PRKL30 | |||
## Note ! | |||
Due to the main target audience being a small Finnish community, | |||
this board's default layout uses nordic keycodes. | |||
----- | |||
![prkl30 default layout image](https://i.imgur.com/tekFaHW.png "default") | |||
default layout | |||
![prkl30 lower layout image](https://i.imgur.com/NzLcXrU.png "lower") | |||
lower layout | |||
![prkl30 raise layout image](https://i.imgur.com/BpC8T6p.png "raise") | |||
raise layout | |||
![prkl30 fn layout image](https://i.imgur.com/gwgIKqj.png "fn") | |||
fn layout |
@ -0,0 +1,17 @@ | |||
/* Copyright 2020 ErkHal | |||
* | |||
* 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 "prkl30.h" |
@ -0,0 +1,40 @@ | |||
/* Copyright 2020 Erkki Halinen & Toni Johansson | |||
* | |||
* 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 LAYOUT_all( \ | |||
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 \ | |||
) { \ | |||
{ k01, k02, k03, k04, k05, k06, k07, k08, k09, k10 }, \ | |||
{ k14, k15, k16, k17, k18, k19, k20, k21, k22, k23 }, \ | |||
{ k27, k28, k29, k30, k31, k32, k33, k34, k35, k36 }, \ | |||
{ k11, k12, k13, k24, k25, k26, k37, k38, KC_NO, KC_NO } \ | |||
} | |||
#define LAYOUT_2u_space( \ | |||
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, k34, k35, k36, k37, k38 \ | |||
) { \ | |||
{ k01, k02, k03, k04, k05, k06, k07, k08, k09, k10 }, \ | |||
{ k14, k15, k16, k17, k18, k19, k20, k21, k22, k23 }, \ | |||
{ k27, k28, k29, k30, k31, k32, KC_NO, k34, k35, k36 }, \ | |||
{ k11, k12, k13, k24, k25, k26, k37, k38, KC_NO, KC_NO } \ | |||
} |
@ -0,0 +1,48 @@ | |||
/* Copyright 2020 Erkki Halinen & Toni Johansson | |||
* | |||
* 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 0xE0E0 | |||
#define PRODUCT_ID 0x0030 | |||
#define DEVICE_VER 0x0002 | |||
#define MANUFACTURER Ergorius & Tooni Skyy | |||
#define PRODUCT PRKL30 | |||
#define DESCRIPTION 30% Mechanical keyboard | |||
/* key matrix size */ | |||
#define MATRIX_ROWS 4 | |||
#define MATRIX_COLS 10 | |||
/* prkl30 default pinout */ | |||
#define MATRIX_ROW_PINS { D4, C6, D7, E6 } | |||
#define MATRIX_COL_PINS { B4, B5, F6, F5, F4, F7, B1, B3, B2, B6} | |||
/* COL2ROW, ROW2COL*/ | |||
#define DIODE_DIRECTION COL2ROW | |||
#define ENCODERS_PAD_A { D3 } | |||
#define ENCODERS_PAD_B { D2 } | |||
#define ENCODER_RESOLUTION 4 | |||
#define UNUSED_PINS | |||
/* RGB Light Configuration */ | |||
#define RGB_DI_PIN D1 | |||
#define RGBLIGHT_ANIMATIONS | |||
#define RGBLED_NUM 13 | |||
#define RGBLIGHT_HUE_STEP 8 | |||
#define RGBLIGHT_SAT_STEP 8 | |||
#define RGBLIGHT_VAL_STEP 8 |
@ -0,0 +1,27 @@ | |||
# 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 = no # Virtual DIP switch configuration | |||
ENCODER_ENABLE = yes | |||
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 | |||
SLEEP_LED_ENABLE = no # Breathing sleep LED during USB suspend | |||
NKRO_ENABLE = yes # USB Nkey Rollover - if this doesn't work, see here: https://github.com/tmk/tmk_keyboard/wiki/FAQ#nkro-doesnt-work | |||
BACKLIGHT_ENABLE = no | |||
AUDIO_ENABLE = no # This can be enabled if a speaker is connected to the expansion port. Not compatible with RGBLIGHT below | |||
RGBLIGHT_ENABLE = yes # This can be enabled if a ws2812 strip is connected to the expansion port. |
@ -0,0 +1,19 @@ | |||
# PRKL30 | |||
![prkl30](https://camo.githubusercontent.com/9b39ee253a7cdcbfdbe80f7ef36ddd3ad5b17382/68747470733a2f2f692e696d6775722e636f6d2f4e6b67493339492e6a7067) | |||
30% Keyboard with ISO Enter, ortho layout and bluetooth support | |||
* Keyboard Maintainer: [ErkHal](https://github.com/erkhal) | |||
* Hardware Supported: PRKL30 PCB, Pro Micro/Adafruit Feather | |||
* Hardware Availability: [PRKL30 repo](https://github.com/erkhal/prkl30) | |||
Make example for this keyboard with Pro Micro controller (after setting up your build environment): | |||
make handwired/prkl30/promicro:default | |||
Make example for this keyboard with Feather controller (after setting up your build environment): | |||
make handwired/prkl30/feather: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). |