* added abacus keyboard * keymap updates * Update keyboards/abacus/config.h * Update keyboards/abacus/config.h * Update keyboards/abacus/keymaps/default/keymap.c * Update keyboards/abacus/keymaps/default/keymap.c * Update keyboards/abacus/keymaps/default/keymap.c * start cleaning up for merge * cleaned for merge * cleaned * cleaned * Update keyboards/abacus/abacus.h * Update keyboards/abacus/keymaps/default/keymap.c * Update keyboards/abacus/keymaps/default/readme.md * Update keyboards/abacus/readme.md * Update keyboards/abacus/readme.md * Update keyboards/abacus/rules.mk * Update keyboards/abacus/info.json * Update keyboards/abacus/info.json * Update keyboards/abacus/info.json * Update keyboards/abacus/readme.md * Update keyboards/abacus/info.json * Update keyboards/abacus/rules.mk * Update keyboards/abacus/rules.mkpull/8410/head
@ -0,0 +1,17 @@ | |||
/* Copyright 2020 nickolaij | |||
* | |||
* 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 "abacus.h" |
@ -0,0 +1,41 @@ | |||
/* Copyright 2020 nickolaij | |||
* | |||
* 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 XXX 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. | |||
*/ | |||
#define LAYOUT( \ | |||
k00, k01, k02, k03, k04, k05, k06, k07, k08, k09, k0a, k0b, \ | |||
k10, k11, k12, k13, k14, k15, k16, k17, k18, k19, k1a, k1b, \ | |||
k20, k21, k22, k23, k24, k25, k26, k27, k28, k29, k2a, k2b, \ | |||
k30, k31, k32, k33, k34, k35, k36, k37, k38 \ | |||
) \ | |||
{ \ | |||
{ k00, k01, k02, k03, k04, k05, k06, k07, k08, k09, k0a, k0b }, \ | |||
{ k10, k11, k12, k13, k14, k15, k16, k17, k18, k19, k1a, k1b }, \ | |||
{ k20, k21, k22, k23, k24, k25, k26, k27, k28, k29, k2a, k2b }, \ | |||
{ k30, k31, k32, k33, XXX, XXX, k34, XXX, k35, k36, k37, k38} \ | |||
} |
@ -0,0 +1,133 @@ | |||
/* | |||
Copyright 2020 nickolaij | |||
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 0x0000 | |||
#define DEVICE_VER 0x0001 | |||
#define MANUFACTURER nickolaij | |||
#define PRODUCT abacus | |||
#define DESCRIPTION A first attempt at a custom keyboard | |||
/* key matrix size */ | |||
#define MATRIX_ROWS 4 | |||
#define MATRIX_COLS 12 | |||
/* | |||
* 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 { D3, D2, D4, C6 } | |||
#define MATRIX_COL_PINS { F4, F5, F6, F7, B1, D7, B3, E6, B2, B4, B6, B5} | |||
#define UNUSED_PINS {B0} | |||
#define DIP_SWITCH_PINS { D0 } | |||
#define ENCODERS_PAD_A { F1 } | |||
#define ENCODERS_PAD_B { F0 } | |||
#define ENCODER_RESOLUTION 4 | |||
/* COL2ROW, ROW2COL*/ | |||
#define DIODE_DIRECTION COL2ROW | |||
#define RGB_DI_PIN D1 | |||
#ifdef RGB_DI_PIN | |||
# define RGBLED_NUM 17 | |||
# 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 */ | |||
/*== 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_STATIC_GRADIENT | |||
/*== 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 | |||
/* | |||
* 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 */ | |||
#ifndef LINK_TIME_OPTIMIZATION_ENABLE | |||
#define NO_ACTION_MACRO | |||
#define NO_ACTION_FUNCTION | |||
#endif | |||
/* | |||
* MIDI options | |||
*/ | |||
/* Prevent use of disabled MIDI features in the keymap */ | |||
//#define MIDI_ENABLE_STRICT 1 | |||
/* enable basic MIDI features: | |||
- MIDI notes can be sent when in Music mode is on | |||
*/ | |||
//#define MIDI_BASIC | |||
/* enable advanced MIDI features: | |||
- MIDI notes can be added to the keymap | |||
- Octave shift and transpose | |||
- Virtual sustain, portamento, and modulation wheel | |||
- etc. | |||
*/ | |||
//#define MIDI_ADVANCED | |||
/* override number of MIDI tone keycodes (each octave adds 12 keycodes and allocates 12 bytes) */ | |||
//#define MIDI_TONE_KEYCODE_OCTAVES 1 |
@ -0,0 +1,62 @@ | |||
{ | |||
"keyboard_name": "Abacus", | |||
"url": "https://www.github.com/nickolaij", | |||
"maintainer": "nickolaij", | |||
"width": 12.75, | |||
"height": 4, | |||
"layouts": { | |||
"LAYOUT": { | |||
"key_count": 45, | |||
"layout": [ | |||
{"label":"k00", "x":0, "y":0, "w":1}, | |||
{"label":"k01", "x":1, "y":0, "w":1}, | |||
{"label":"k02", "x":2, "y":0, "w":1}, | |||
{"label":"k03", "x":3, "y":0, "w":1}, | |||
{"label":"k04", "x":4, "y":0, "w":1}, | |||
{"label":"k05", "x":5, "y":0, "w":1}, | |||
{"label":"k06", "x":6, "y":0, "w":1}, | |||
{"label":"k07", "x":7, "y":0, "w":1}, | |||
{"label":"k08", "x":8, "y":0, "w":1}, | |||
{"label":"k09", "x":9, "y":0, "w":1}, | |||
{"label":"k0a", "x":10, "y":0, "w":1}, | |||
{"label":"k0b", "x":11, "y":0, "w":1.75}, | |||
{"label":"k10", "x":0, "y":1, "w":1.25}, | |||
{"label":"k11", "x":1.25, "y":1, "w":1}, | |||
{"label":"k12", "x":2.25, "y":1, "w":1}, | |||
{"label":"k13", "x":3.25, "y":1, "w":1}, | |||
{"label":"k14", "x":4.25, "y":1, "w":1}, | |||
{"label":"k15", "x":5.25, "y":1, "w":1}, | |||
{"label":"k16", "x":6.25, "y":1, "w":1}, | |||
{"label":"k17", "x":7.25, "y":1, "w":1}, | |||
{"label":"k18", "x":8.25, "y":1, "w":1}, | |||
{"label":"k19", "x":9.25, "y":1, "w":1}, | |||
{"label":"k1a", "x":10.25, "y":1, "w":1}, | |||
{"label":"k1b", "x":11.25, "y":1, "w":1.5}, | |||
{"label":"k20", "x":0, "y":2, "w":1.75}, | |||
{"label":"k21", "x":1.75, "y":2, "w":1}, | |||
{"label":"k22", "x":2.75, "y":2, "w":1}, | |||
{"label":"k23", "x":3.75, "y":2, "w":1}, | |||
{"label":"k24", "x":4.75, "y":2, "w":1}, | |||
{"label":"k25", "x":5.75, "y":2, "w":1}, | |||
{"label":"k26", "x":6.75, "y":2, "w":1}, | |||
{"label":"k27", "x":7.75, "y":2, "w":1}, | |||
{"label":"k28", "x":8.75, "y":2, "w":1}, | |||
{"label":"k29", "x":9.75, "y":2, "w":1}, | |||
{"label":"k2a", "x":10.75, "y":2, "w":1}, | |||
{"label":"k2b", "x":11.75, "y":2, "w":1}, | |||
{"label":"k30", "x":0, "y":3, "w":1.25}, | |||
{"label":"k31", "x":1.25, "y":3, "w":1}, | |||
{"label":"k32", "x":2.25, "y":3, "w":1}, | |||
{"label":"k33", "x":3.25, "y":3, "w":2.75}, | |||
{"label":"k34", "x":6, "y":3, "w":2.75}, | |||
{"label":"k35", "x":8.75, "y":3, "w":1}, | |||
{"label":"k36", "x":9.75, "y":3, "w":1}, | |||
{"label":"k37", "x":10.75, "y":3, "w":1}, | |||
{"label":"k38", "x":11.75, "y":3, "w":1} | |||
] | |||
} | |||
} | |||
} |
@ -0,0 +1,148 @@ | |||
/* Copyright 2020 nickolaij | |||
* | |||
* 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 | |||
// wait DELAY ms before unregistering media keys | |||
#define MEDIA_KEY_DELAY 10 | |||
// Defines names for use in layer keycodes and the keymap | |||
enum layer_names { | |||
_BASE, | |||
_UPPER, | |||
_LOWER | |||
}; | |||
// Defines the keycodes used by our macros in process_record_user | |||
enum custom_keycodes { | |||
NICKURL = SAFE_RANGE, | |||
ALTTAB | |||
}; | |||
enum unicode_names { | |||
LOVEEYES, | |||
THINK, | |||
UPSIDEDOWN, | |||
NOMOUTH, | |||
PARTY, | |||
HEART, | |||
EGGPLANT, | |||
PEACH, | |||
EMOJI100, | |||
EMOJIB | |||
}; | |||
const uint32_t PROGMEM unicode_map[] = { | |||
[LOVEEYES] = 0x1f60d, | |||
[THINK] = 0x1f914, | |||
[UPSIDEDOWN] = 0x1f643, | |||
[NOMOUTH] = 0x1f636, | |||
[PARTY] = 0x1f973, | |||
[HEART] = 0x1f495, | |||
[EMOJI100] = 0x1f4af, | |||
[PEACH] = 0x1f351, | |||
[EGGPLANT] = 0x1f346, | |||
[EMOJIB] = 0x1f171 | |||
}; | |||
const uint16_t PROGMEM keymaps[][MATRIX_ROWS][MATRIX_COLS] = { | |||
/* Base */ | |||
[_BASE] = LAYOUT( | |||
KC_ESCAPE, KC_Q, KC_W, KC_E, KC_R, KC_T, KC_Y, KC_U, KC_I, KC_O, KC_P, KC_BSPACE, | |||
KC_TAB, KC_A, KC_S, KC_D, KC_F, KC_G, KC_H, KC_J, KC_K, KC_L, KC_SCOLON, KC_BSLASH, | |||
KC_LSHIFT, KC_Z, KC_X, KC_C, KC_V, KC_B, KC_N, KC_M, KC_COMMA, KC_DOT, KC_UP, KC_DELETE, | |||
KC_LCTRL, KC_LGUI, MO(_UPPER), KC_SPACE, KC_ENTER, MO(_LOWER), KC_LEFT, KC_DOWN, KC_RIGHT | |||
), | |||
[_UPPER] = LAYOUT( | |||
KC_GRAVE, KC_1, KC_2, KC_3, KC_4, KC_5, KC_6, KC_7, KC_8, KC_9, KC_0, _______, | |||
ALTTAB, _______, _______, _______, _______, _______, _______, _______, KC_LBRACKET, KC_RBRACKET, KC_QUOTE, KC_SLASH, | |||
_______, _______, _______, _______, _______, _______, _______, _______, KC_MINUS, KC_EQUAL, _______, _______, | |||
KC_LALT, _______, _______, _______, _______, _______, KC_HOME, _______, KC_END | |||
), | |||
[_LOWER] = LAYOUT( | |||
NICKURL, 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_MODE_PLAIN, RGB_MODE_BREATHE, RGB_MODE_RAINBOW, RGB_MODE_SWIRL, RGB_MODE_SNAKE, RGB_MODE_KNIGHT, RGB_MODE_GRADIENT, XXXXXXX, RGB_TOG, | |||
_______, X(LOVEEYES), X(THINK), X(UPSIDEDOWN), X(NOMOUTH), X(PARTY), X(PEACH), X(HEART), X(EGGPLANT), X(EMOJI100), X(EMOJIB), RGB_HUI, | |||
KC_CAPS, _______, _______, _______, _______, _______, _______, _______, _______ | |||
) | |||
}; | |||
bool process_record_user(uint16_t keycode, keyrecord_t *record) { | |||
switch (keycode) { | |||
case NICKURL: | |||
if (record->event.pressed) { | |||
SEND_STRING("https://www.github.com/nickolaij"); | |||
} else { | |||
tap_code(KC_ENTER); | |||
} | |||
return true; | |||
break; | |||
case ALTTAB: | |||
if (record->event.pressed) { | |||
tap_code16(A(KC_TAB)); | |||
} | |||
return true; | |||
break; | |||
default: | |||
return true; | |||
} | |||
} | |||
void dip_switch_update_user(uint8_t index, bool active) { | |||
switch (index) { | |||
case 0: | |||
if(active) { | |||
switch(get_highest_layer(layer_state)) { | |||
case _BASE: | |||
tap_code16(LCTL(KC_F)); | |||
break; | |||
case _UPPER: | |||
tap_code(KC_MUTE); | |||
break; | |||
case _LOWER: | |||
tap_code(KC_MEDIA_PLAY_PAUSE); | |||
break; | |||
} | |||
} | |||
} | |||
} | |||
void matrix_init_user(void) { | |||
set_unicode_input_mode(UC_WINC); | |||
} | |||
void encoder_update_user(uint8_t index, bool clockwise) { | |||
switch(get_highest_layer(layer_state)) { | |||
case _BASE: | |||
clockwise ? tap_code(KC_PGDN) : tap_code(KC_PGUP); | |||
break; | |||
case _UPPER: | |||
clockwise ? tap_code(KC_VOLU) : tap_code(KC_VOLD); | |||
break; | |||
case _LOWER: | |||
clockwise ? tap_code(KC_MEDIA_NEXT_TRACK) : tap_code(KC_MEDIA_PREV_TRACK); | |||
break; | |||
} | |||
} |
@ -0,0 +1,4 @@ | |||
# The default keymap for Abacus | |||
This is made based on my first few days of playing with it and honing in on what feels right. | |||
I've repurposed the DIP switch function for the encoder switches and added some functionality for multiple layers also effecting the encoders output. |
@ -0,0 +1,15 @@ | |||
# Abacus | |||
![abacus](https://i.imgur.com/IFtuWaK.jpg) | |||
A first attempt at a PCB design for a mechanical keyboard. Includes rotary encoder and RGB underglow. | |||
* Keyboard Maintainer: [nickolaij](https://github.com/nickolaij) | |||
* Hardware Supported: Abacus PCB, [Elite C Microcontroller](https://keeb.io/products/elite-c-usb-c-pro-micro-replacement-arduino-compatible-atmega32u4) or Pro Micro Microcontroller (Elite C has additional pins for encoder) | |||
* Hardware Availability: [Abacus PCB Github](https://github.com/nickolaij/Abacus_Rev2) | |||
Make example for this keyboard (after setting up your build environment): | |||
make abacus: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). |
@ -0,0 +1,36 @@ | |||
# 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 = atmel-dfu | |||
# Build Options | |||
# change yes to no to disable | |||
# | |||
BOOTMAGIC_ENABLE = no # 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 = no # Enable keyboard backlight functionality | |||
RGBLIGHT_ENABLE = yes # 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 on port C6 | |||
FAUXCLICKY_ENABLE = no # Use buzzer to emulate clicky switches | |||
HD44780_ENABLE = no # Enable support for HD44780 based LCDs | |||
UNICODEMAP_ENABLE = yes | |||
ENCODER_ENABLE = yes | |||
DIP_SWITCH_ENABLE = yes | |||
LTO_ENABLE = yes |