* Hello, GeekPad! * Fixed formatting in `README.md`.pull/4850/head
@ -0,0 +1,227 @@ | |||||
/* | |||||
Copyright 2019-present Tomek Wójcik <contact@bthlabs.pl> | |||||
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 0x4257 | |||||
#define DEVICE_VER 0x0001 | |||||
#define MANUFACTURER BTHLabs | |||||
#define PRODUCT GeekPad | |||||
#define DESCRIPTION 3x3 custom macro pad | |||||
/* key matrix size */ | |||||
#define MATRIX_ROWS 3 | |||||
#define MATRIX_COLS 3 | |||||
/* | |||||
* 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 { F4, F5, F6 } | |||||
#define MATRIX_COL_PINS { D4, D0, D1 } | |||||
#define UNUSED_PINS | |||||
/* COL2ROW, ROW2COL, or CUSTOM_MATRIX */ | |||||
#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 RGBLIGHT_ANIMATIONS | |||||
// #define RGBLED_NUM 16 | |||||
// #define RGBLIGHT_HUE_STEP 8 | |||||
// #define RGBLIGHT_SAT_STEP 8 | |||||
// #define RGBLIGHT_VAL_STEP 8 | |||||
// #endif | |||||
/* Debounce reduces chatter (unintended double-presses) - set 0 if debouncing is not needed */ | |||||
#define DEBOUNCING_DELAY 5 | |||||
/* define if matrix has ghost (lacks anti-ghosting diodes) */ | |||||
//#define MATRIX_HAS_GHOST | |||||
/* number of backlight levels */ | |||||
/* 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 | |||||
/* | |||||
* Magic Key Options | |||||
* | |||||
* Magic keys are hotkey commands that allow control over firmware functions of | |||||
* the keyboard. They are best used in combination with the HID Listen program, | |||||
* found here: https://www.pjrc.com/teensy/hid_listen.html | |||||
* | |||||
* The options below allow the magic key functionality to be changed. This is | |||||
* useful if your keyboard/keypad is missing keys and you want magic key support. | |||||
* | |||||
*/ | |||||
/* key combination for magic key command */ | |||||
#define IS_COMMAND() ( \ | |||||
keyboard_report->mods == (MOD_BIT(KC_LSHIFT) | MOD_BIT(KC_RSHIFT)) \ | |||||
) | |||||
/* control how magic key switches layers */ | |||||
//#define MAGIC_KEY_SWITCH_LAYER_WITH_FKEYS true | |||||
//#define MAGIC_KEY_SWITCH_LAYER_WITH_NKEYS true | |||||
//#define MAGIC_KEY_SWITCH_LAYER_WITH_CUSTOM false | |||||
/* override magic key keymap */ | |||||
//#define MAGIC_KEY_SWITCH_LAYER_WITH_FKEYS | |||||
//#define MAGIC_KEY_SWITCH_LAYER_WITH_NKEYS | |||||
//#define MAGIC_KEY_SWITCH_LAYER_WITH_CUSTOM | |||||
//#define MAGIC_KEY_HELP1 H | |||||
//#define MAGIC_KEY_HELP2 SLASH | |||||
//#define MAGIC_KEY_DEBUG D | |||||
//#define MAGIC_KEY_DEBUG_MATRIX X | |||||
//#define MAGIC_KEY_DEBUG_KBD K | |||||
//#define MAGIC_KEY_DEBUG_MOUSE M | |||||
//#define MAGIC_KEY_VERSION V | |||||
//#define MAGIC_KEY_STATUS S | |||||
//#define MAGIC_KEY_CONSOLE C | |||||
//#define MAGIC_KEY_LAYER0_ALT1 ESC | |||||
//#define MAGIC_KEY_LAYER0_ALT2 GRAVE | |||||
//#define MAGIC_KEY_LAYER0 0 | |||||
//#define MAGIC_KEY_LAYER1 1 | |||||
//#define MAGIC_KEY_LAYER2 2 | |||||
//#define MAGIC_KEY_LAYER3 3 | |||||
//#define MAGIC_KEY_LAYER4 4 | |||||
//#define MAGIC_KEY_LAYER5 5 | |||||
//#define MAGIC_KEY_LAYER6 6 | |||||
//#define MAGIC_KEY_LAYER7 7 | |||||
//#define MAGIC_KEY_LAYER8 8 | |||||
//#define MAGIC_KEY_LAYER9 9 | |||||
//#define MAGIC_KEY_BOOTLOADER PAUSE | |||||
//#define MAGIC_KEY_LOCK CAPS | |||||
//#define MAGIC_KEY_EEPROM E | |||||
//#define MAGIC_KEY_NKRO N | |||||
//#define MAGIC_KEY_SLEEP_LED Z | |||||
/* | |||||
* 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 | |||||
//#define NO_ACTION_MACRO | |||||
//#define NO_ACTION_FUNCTION | |||||
/* | |||||
* 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 | |||||
/* | |||||
* HD44780 LCD Display Configuration | |||||
*/ | |||||
/* | |||||
#define LCD_LINES 2 //< number of visible lines of the display | |||||
#define LCD_DISP_LENGTH 16 //< visibles characters per line of the display | |||||
#define LCD_IO_MODE 1 //< 0: memory mapped mode, 1: IO port mode | |||||
#if LCD_IO_MODE | |||||
#define LCD_PORT PORTB //< port for the LCD lines | |||||
#define LCD_DATA0_PORT LCD_PORT //< port for 4bit data bit 0 | |||||
#define LCD_DATA1_PORT LCD_PORT //< port for 4bit data bit 1 | |||||
#define LCD_DATA2_PORT LCD_PORT //< port for 4bit data bit 2 | |||||
#define LCD_DATA3_PORT LCD_PORT //< port for 4bit data bit 3 | |||||
#define LCD_DATA0_PIN 4 //< pin for 4bit data bit 0 | |||||
#define LCD_DATA1_PIN 5 //< pin for 4bit data bit 1 | |||||
#define LCD_DATA2_PIN 6 //< pin for 4bit data bit 2 | |||||
#define LCD_DATA3_PIN 7 //< pin for 4bit data bit 3 | |||||
#define LCD_RS_PORT LCD_PORT //< port for RS line | |||||
#define LCD_RS_PIN 3 //< pin for RS line | |||||
#define LCD_RW_PORT LCD_PORT //< port for RW line | |||||
#define LCD_RW_PIN 2 //< pin for RW line | |||||
#define LCD_E_PORT LCD_PORT //< port for Enable line | |||||
#define LCD_E_PIN 1 //< pin for Enable line | |||||
#endif | |||||
*/ | |||||
/* Bootmagic Lite key configuration */ | |||||
// #define BOOTMAGIC_LITE_ROW 0 | |||||
// #define BOOTMAGIC_LITE_COLUMN 0 |
@ -0,0 +1,43 @@ | |||||
/* Copyright 2019-present Tomek Wójcik <contact@bthlabs.pl> | |||||
* | |||||
* 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 "geekpad.h" | |||||
void matrix_init_kb(void) { | |||||
// put your keyboard start-up code here | |||||
// runs once when the firmware starts up | |||||
matrix_init_user(); | |||||
} | |||||
void matrix_scan_kb(void) { | |||||
// put your looping keyboard code here | |||||
// runs every cycle (a lot) | |||||
matrix_scan_user(); | |||||
} | |||||
bool process_record_kb(uint16_t keycode, keyrecord_t *record) { | |||||
// put your per-action keyboard code here | |||||
// runs for every action, just before processing by the firmware | |||||
return process_record_user(keycode, record); | |||||
} | |||||
void led_set_kb(uint8_t usb_led) { | |||||
// put your keyboard LED indicator (ex: Caps Lock LED) toggling code here | |||||
led_set_user(usb_led); | |||||
} |
@ -0,0 +1,40 @@ | |||||
/* Copyright 2019-present Tomek Wójcik <contact@bthlabs.pl> | |||||
* | |||||
* 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/>. | |||||
*/ | |||||
#ifndef GEEKPAD_H | |||||
#define GEEKPAD_H | |||||
#include "quantum.h" | |||||
/* This 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, \ | |||||
K10, K11, K12, \ | |||||
K20, K21, K22 \ | |||||
) \ | |||||
{ \ | |||||
{ K00, K01, K02 }, \ | |||||
{ K10, K11, K12 }, \ | |||||
{ K20, K21, K22 } \ | |||||
} | |||||
#endif |
@ -0,0 +1,22 @@ | |||||
{ | |||||
"keyboard_name": "BTHLabs GeekPad", | |||||
"url": "https://git.bthlabs.pl/tomekwojcik/geekpad", | |||||
"maintainer": "Tomek Wójcik <contact@bthlabs.pl>", | |||||
"width": 3, | |||||
"height": 3, | |||||
"layouts": { | |||||
"LAYOUT": { | |||||
"layout": [ | |||||
{"x": 0, "y": 0}, | |||||
{"x": 1, "y": 0}, | |||||
{"x": 2,"y": 0}, | |||||
{"x": 0, "y": 1}, | |||||
{"x": 1, "y": 1}, | |||||
{"x": 2,"y": 1}, | |||||
{"x": 0, "y": 2}, | |||||
{"x": 1, "y": 2}, | |||||
{"x": 2,"y": 2} | |||||
] | |||||
} | |||||
} | |||||
} |
@ -0,0 +1,19 @@ | |||||
/* Copyright 2019-present Tomek Wójcik <contact@bthlabs.pl> | |||||
* | |||||
* 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 | |||||
// place overrides here |
@ -0,0 +1,24 @@ | |||||
/* Copyright 2019-present Tomek Wójcik <contact@bthlabs.pl> | |||||
* | |||||
* 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( /* Base */ | |||||
KC_F1, KC_F2, KC_F3, | |||||
KC_MEDIA_REWIND, KC_MEDIA_PLAY_PAUSE, KC_MEDIA_FAST_FORWARD, | |||||
KC_AUDIO_MUTE, KC_AUDIO_VOL_DOWN, KC_AUDIO_VOL_UP | |||||
), | |||||
}; |
@ -0,0 +1,15 @@ | |||||
# BTHLabs GeekPad | |||||
![GeekPad](https://i.imgur.com/FEzO81l.jpg) | |||||
A 3x3 custom macro pad designed and developed by Tomek Wójcik. | |||||
Keyboard Maintainer: [Tomek Wójcik](https://www.bthlabs.pl/) | |||||
Hardware Supported: GeekPad Custom PCB | |||||
Hardware Availability: [Project Repository](https://git.bthlabs.pl/tomekwojcik/geekpad) | |||||
Make example for this keyboard (after setting up your build environment): | |||||
make bthlabs/geekpad: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,81 @@ | |||||
# MCU name | |||||
#MCU = at90usb1286 | |||||
MCU = atmega32u4 | |||||
# Processor frequency. | |||||
# This will define a symbol, F_CPU, in all source code files equal to the | |||||
# processor frequency in Hz. You can then use this symbol in your source code to | |||||
# calculate timings. Do NOT tack on a 'UL' at the end, this will be done | |||||
# automatically to create a 32-bit value in your source code. | |||||
# | |||||
# This will be an integer division of F_USB below, as it is sourced by | |||||
# F_USB after it has run through any CPU prescalers. Note that this value | |||||
# does not *change* the processor frequency - it should merely be updated to | |||||
# reflect the processor speed set externally so that the code can use accurate | |||||
# software delays. | |||||
F_CPU = 16000000 | |||||
# | |||||
# LUFA specific | |||||
# | |||||
# Target architecture (see library "Board Types" documentation). | |||||
ARCH = AVR8 | |||||
# Input clock frequency. | |||||
# This will define a symbol, F_USB, in all source code files equal to the | |||||
# input clock frequency (before any prescaling is performed) in Hz. This value may | |||||
# differ from F_CPU if prescaling is used on the latter, and is required as the | |||||
# raw input clock is fed directly to the PLL sections of the AVR for high speed | |||||
# clock generation for the USB and other AVR subsections. Do NOT tack on a 'UL' | |||||
# at the end, this will be done automatically to create a 32-bit value in your | |||||
# source code. | |||||
# | |||||
# If no clock division is performed on the input clock inside the AVR (via the | |||||
# CPU clock adjust registers or the clock division fuses), this will be equal to F_CPU. | |||||
F_USB = $(F_CPU) | |||||
# Interrupt driven control endpoint task(+60) | |||||
OPT_DEFS += -DINTERRUPT_CONTROL_ENDPOINT | |||||
# Bootloader selection | |||||
# Teensy halfkay | |||||
# Pro Micro caterina | |||||
# Atmel DFU atmel-dfu | |||||
# LUFA DFU lufa-dfu | |||||
# QMK DFU qmk-dfu | |||||
# atmega32a bootloadHID | |||||
BOOTLOADER = caterina | |||||
# If you don't know the bootloader type, then you can specify the | |||||
# Boot Section Size in *bytes* by uncommenting out the OPT_DEFS line | |||||
# Teensy halfKay 512 | |||||
# Teensy++ halfKay 1024 | |||||
# Atmel DFU loader 4096 | |||||
# LUFA bootloader 4096 | |||||
# USBaspLoader 2048 | |||||
# OPT_DEFS += -DBOOTLOADER_SIZE=4096 | |||||
# Build Options | |||||
# change yes to no to disable | |||||
# | |||||
BOOTMAGIC_ENABLE = no # Virtual DIP switch configuration(+1000) | |||||
MOUSEKEY_ENABLE = no # Mouse keys(+4700) | |||||
EXTRAKEY_ENABLE = yes # Audio control and System control(+450) | |||||
CONSOLE_ENABLE = no # Console for debug(+400) | |||||
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 on B7 by default | |||||
RGBLIGHT_ENABLE = no # Enable keyboard RGB underglow | |||||
MIDI_ENABLE = no # MIDI support (+2400 to 4200, depending on config) | |||||
UNICODE_ENABLE = no # Unicode | |||||
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 (+400) |