aboutsummaryrefslogtreecommitdiff
path: root/keyboards/ckeys
diff options
context:
space:
mode:
Diffstat (limited to 'keyboards/ckeys')
-rw-r--r--keyboards/ckeys/readme.md1
-rw-r--r--keyboards/ckeys/washington/config.h253
-rw-r--r--keyboards/ckeys/washington/info.json12
-rw-r--r--keyboards/ckeys/washington/keymaps/default/keymap.c82
-rw-r--r--keyboards/ckeys/washington/keymaps/default/readme.md1
-rw-r--r--keyboards/ckeys/washington/readme.md23
-rw-r--r--keyboards/ckeys/washington/rules.mk34
-rw-r--r--keyboards/ckeys/washington/washington.c17
-rw-r--r--keyboards/ckeys/washington/washington.h38
9 files changed, 461 insertions, 0 deletions
diff --git a/keyboards/ckeys/readme.md b/keyboards/ckeys/readme.md
index f04626cd3..1f55f058d 100644
--- a/keyboards/ckeys/readme.md
+++ b/keyboards/ckeys/readme.md
@@ -9,3 +9,4 @@ In addition to hosting the [Seattle Mechanical Keyboard Meetups](https://ckeys.o
9 * naKey - Through hole numpad 9 * naKey - Through hole numpad
10 * Handwire 101 - Handwired 4x4 (Proton C or Pro Micro) 10 * Handwire 101 - Handwired 4x4 (Proton C or Pro Micro)
11 * The Dora Board - 4x5 with rotary encoder and Proton C pinouts 11 * The Dora Board - 4x5 with rotary encoder and Proton C pinouts
12 * Washington Macropad - Macropad shaped like Washington State with rotary encoder and OLED
diff --git a/keyboards/ckeys/washington/config.h b/keyboards/ckeys/washington/config.h
new file mode 100644
index 000000000..419e35e3b
--- /dev/null
+++ b/keyboards/ckeys/washington/config.h
@@ -0,0 +1,253 @@
1/*
2This program is free software: you can redistribute it and/or modify
3it under the terms of the GNU General Public License as published by
4the Free Software Foundation, either version 2 of the License, or
5(at your option) any later version.
6
7This program is distributed in the hope that it will be useful,
8but WITHOUT ANY WARRANTY; without even the implied warranty of
9MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
10GNU General Public License for more details.
11
12You should have received a copy of the GNU General Public License
13along with this program. If not, see <http://www.gnu.org/licenses/>.
14*/
15
16#pragma once
17
18#include "config_common.h"
19
20/* USB Device descriptor parameter */
21#define VENDOR_ID 0xFEED
22#define PRODUCT_ID 0x002A
23#define DEVICE_VER 0x0001
24#define MANUFACTURER merlin04
25#define PRODUCT Washington Macropad
26#define DESCRIPTION Washington State shaped macropad
27
28/* key matrix size */
29#define MATRIX_ROWS 3
30#define MATRIX_COLS 3
31
32/*
33 * Keyboard Matrix Assignments
34 *
35 * Change this to how you wired your keyboard
36 * COLS: AVR pins used for columns, left to right
37 * ROWS: AVR pins used for rows, top to bottom
38 * DIODE_DIRECTION: COL2ROW = COL = Anode (+), ROW = Cathode (-, marked on diode)
39 * ROW2COL = ROW = Anode (+), COL = Cathode (-, marked on diode)
40 *
41 */
42#define MATRIX_ROW_PINS { F4, F5, F6 }
43#define MATRIX_COL_PINS { F7, B1, B3 }
44#define UNUSED_PINS
45
46/* COL2ROW, ROW2COL*/
47#define DIODE_DIRECTION COL2ROW
48
49#define ENCODERS_PAD_A { D4 }
50#define ENCODERS_PAD_B { C6 }
51
52/*
53 * Split Keyboard specific options, make sure you have 'SPLIT_KEYBOARD = yes' in your rules.mk, and define SOFT_SERIAL_PIN.
54 */
55// #define SOFT_SERIAL_PIN D0 // or D1, D2, D3, E6
56
57#define BACKLIGHT_PIN B6
58#define BACKLIGHT_BREATHING
59#define BACKLIGHT_LEVELS 3
60
61// #define RGB_DI_PIN E2
62// #ifdef RGB_DI_PIN
63// #define RGBLED_NUM 16
64// #define RGBLIGHT_HUE_STEP 8
65// #define RGBLIGHT_SAT_STEP 8
66// #define RGBLIGHT_VAL_STEP 8
67// #define RGBLIGHT_LIMIT_VAL 255 /* The maximum brightness level */
68// #define RGBLIGHT_SLEEP /* If defined, the RGB lighting will be switched off when the host goes to sleep */
69// /*== all animations enable ==*/
70// #define RGBLIGHT_ANIMATIONS
71// /*== or choose animations ==*/
72// #define RGBLIGHT_EFFECT_BREATHING
73// #define RGBLIGHT_EFFECT_RAINBOW_MOOD
74// #define RGBLIGHT_EFFECT_RAINBOW_SWIRL
75// #define RGBLIGHT_EFFECT_SNAKE
76// #define RGBLIGHT_EFFECT_KNIGHT
77// #define RGBLIGHT_EFFECT_CHRISTMAS
78// #define RGBLIGHT_EFFECT_STATIC_GRADIENT
79// #define RGBLIGHT_EFFECT_RGB_TEST
80// #define RGBLIGHT_EFFECT_ALTERNATING
81// /*== customize breathing effect ==*/
82// /*==== (DEFAULT) use fixed table instead of exp() and sin() ====*/
83// #define RGBLIGHT_BREATHE_TABLE_SIZE 256 // 256(default) or 128 or 64
84// /*==== use exp() and sin() ====*/
85// #define RGBLIGHT_EFFECT_BREATHE_CENTER 1.85 // 1 to 2.7
86// #define RGBLIGHT_EFFECT_BREATHE_MAX 255 // 0 to 255
87// #endif
88
89/* Debounce reduces chatter (unintended double-presses) - set 0 if debouncing is not needed */
90#define DEBOUNCE 5
91
92/* define if matrix has ghost (lacks anti-ghosting diodes) */
93//#define MATRIX_HAS_GHOST
94
95/* Mechanical locking support. Use KC_LCAP, KC_LNUM or KC_LSCR instead in keymap */
96#define LOCKING_SUPPORT_ENABLE
97/* Locking resynchronize hack */
98#define LOCKING_RESYNC_ENABLE
99
100/* If defined, GRAVE_ESC will always act as ESC when CTRL is held.
101 * This is userful for the Windows task manager shortcut (ctrl+shift+esc).
102 */
103// #define GRAVE_ESC_CTRL_OVERRIDE
104
105/*
106 * Force NKRO
107 *
108 * Force NKRO (nKey Rollover) to be enabled by default, regardless of the saved
109 * state in the bootmagic EEPROM settings. (Note that NKRO must be enabled in the
110 * makefile for this to work.)
111 *
112 * If forced on, NKRO can be disabled via magic key (default = LShift+RShift+N)
113 * until the next keyboard reset.
114 *
115 * NKRO may prevent your keystrokes from being detected in the BIOS, but it is
116 * fully operational during normal computer usage.
117 *
118 * For a less heavy-handed approach, enable NKRO via magic key (LShift+RShift+N)
119 * or via bootmagic (hold SPACE+N while plugging in the keyboard). Once set by
120 * bootmagic, NKRO mode will always be enabled until it is toggled again during a
121 * power-up.
122 *
123 */
124//#define FORCE_NKRO
125
126/*
127 * Magic Key Options
128 *
129 * Magic keys are hotkey commands that allow control over firmware functions of
130 * the keyboard. They are best used in combination with the HID Listen program,
131 * found here: https://www.pjrc.com/teensy/hid_listen.html
132 *
133 * The options below allow the magic key functionality to be changed. This is
134 * useful if your keyboard/keypad is missing keys and you want magic key support.
135 *
136 */
137
138/* key combination for magic key command */
139/* defined by default; to change, uncomment and set to the combination you want */
140// #define IS_COMMAND() (get_mods() == MOD_MASK_SHIFT)
141
142/* control how magic key switches layers */
143//#define MAGIC_KEY_SWITCH_LAYER_WITH_FKEYS true
144//#define MAGIC_KEY_SWITCH_LAYER_WITH_NKEYS true
145//#define MAGIC_KEY_SWITCH_LAYER_WITH_CUSTOM false
146
147/* override magic key keymap */
148//#define MAGIC_KEY_SWITCH_LAYER_WITH_FKEYS
149//#define MAGIC_KEY_SWITCH_LAYER_WITH_NKEYS
150//#define MAGIC_KEY_SWITCH_LAYER_WITH_CUSTOM
151//#define MAGIC_KEY_HELP H
152//#define MAGIC_KEY_HELP_ALT SLASH
153//#define MAGIC_KEY_DEBUG D
154//#define MAGIC_KEY_DEBUG_MATRIX X
155//#define MAGIC_KEY_DEBUG_KBD K
156//#define MAGIC_KEY_DEBUG_MOUSE M
157//#define MAGIC_KEY_VERSION V
158//#define MAGIC_KEY_STATUS S
159//#define MAGIC_KEY_CONSOLE C
160//#define MAGIC_KEY_LAYER0 0
161//#define MAGIC_KEY_LAYER0_ALT GRAVE
162//#define MAGIC_KEY_LAYER1 1
163//#define MAGIC_KEY_LAYER2 2
164//#define MAGIC_KEY_LAYER3 3
165//#define MAGIC_KEY_LAYER4 4
166//#define MAGIC_KEY_LAYER5 5
167//#define MAGIC_KEY_LAYER6 6
168//#define MAGIC_KEY_LAYER7 7
169//#define MAGIC_KEY_LAYER8 8
170//#define MAGIC_KEY_LAYER9 9
171//#define MAGIC_KEY_BOOTLOADER B
172//#define MAGIC_KEY_BOOTLOADER_ALT ESC
173//#define MAGIC_KEY_LOCK CAPS
174//#define MAGIC_KEY_EEPROM E
175//#define MAGIC_KEY_EEPROM_CLEAR BSPACE
176//#define MAGIC_KEY_NKRO N
177//#define MAGIC_KEY_SLEEP_LED Z
178
179/*
180 * Feature disable options
181 * These options are also useful to firmware size reduction.
182 */
183
184/* disable debug print */
185//#define NO_DEBUG
186
187/* disable print */
188//#define NO_PRINT
189
190/* disable action features */
191//#define NO_ACTION_LAYER
192//#define NO_ACTION_TAPPING
193//#define NO_ACTION_ONESHOT
194
195/* disable these deprecated features by default */
196#ifndef LINK_TIME_OPTIMIZATION_ENABLE
197 #define NO_ACTION_MACRO
198 #define NO_ACTION_FUNCTION
199#endif
200/*
201 * MIDI options
202 */
203
204/* Prevent use of disabled MIDI features in the keymap */
205//#define MIDI_ENABLE_STRICT 1
206
207/* enable basic MIDI features:
208 - MIDI notes can be sent when in Music mode is on
209*/
210//#define MIDI_BASIC
211
212/* enable advanced MIDI features:
213 - MIDI notes can be added to the keymap
214 - Octave shift and transpose
215 - Virtual sustain, portamento, and modulation wheel
216 - etc.
217*/
218//#define MIDI_ADVANCED
219
220/* override number of MIDI tone keycodes (each octave adds 12 keycodes and allocates 12 bytes) */
221//#define MIDI_TONE_KEYCODE_OCTAVES 1
222
223/*
224 * HD44780 LCD Display Configuration
225 */
226/*
227#define LCD_LINES 2 //< number of visible lines of the display
228#define LCD_DISP_LENGTH 16 //< visibles characters per line of the display
229
230#define LCD_IO_MODE 1 //< 0: memory mapped mode, 1: IO port mode
231
232#if LCD_IO_MODE
233#define LCD_PORT PORTB //< port for the LCD lines
234#define LCD_DATA0_PORT LCD_PORT //< port for 4bit data bit 0
235#define LCD_DATA1_PORT LCD_PORT //< port for 4bit data bit 1
236#define LCD_DATA2_PORT LCD_PORT //< port for 4bit data bit 2
237#define LCD_DATA3_PORT LCD_PORT //< port for 4bit data bit 3
238#define LCD_DATA0_PIN 4 //< pin for 4bit data bit 0
239#define LCD_DATA1_PIN 5 //< pin for 4bit data bit 1
240#define LCD_DATA2_PIN 6 //< pin for 4bit data bit 2
241#define LCD_DATA3_PIN 7 //< pin for 4bit data bit 3
242#define LCD_RS_PORT LCD_PORT //< port for RS line
243#define LCD_RS_PIN 3 //< pin for RS line
244#define LCD_RW_PORT LCD_PORT //< port for RW line
245#define LCD_RW_PIN 2 //< pin for RW line
246#define LCD_E_PORT LCD_PORT //< port for Enable line
247#define LCD_E_PIN 1 //< pin for Enable line
248#endif
249*/
250
251/* Bootmagic Lite key configuration */
252// #define BOOTMAGIC_LITE_ROW 0
253// #define BOOTMAGIC_LITE_COLUMN 0
diff --git a/keyboards/ckeys/washington/info.json b/keyboards/ckeys/washington/info.json
new file mode 100644
index 000000000..a956d957e
--- /dev/null
+++ b/keyboards/ckeys/washington/info.json
@@ -0,0 +1,12 @@
1{
2 "keyboard_name": "washington",
3 "url": "https://keypcb.xyz/ViewPage/Washington",
4 "maintainer": "merlin04",
5 "width": 4.5,
6 "height": 3,
7 "layouts": {
8 "LAYOUT": {
9 "layout": [{"x":1.5, "y":0}, {"x":2.5, "y":0}, {"x":3.5, "y":0}, {"x":1.5, "y":1}, {"x":2.5, "y":1}, {"x":3.5, "y":1}, {"x":0, "y":0.75}, {"x":0.5, "y":1.75}, {"x":1.5, "y":2}]
10 }
11 }
12}
diff --git a/keyboards/ckeys/washington/keymaps/default/keymap.c b/keyboards/ckeys/washington/keymaps/default/keymap.c
new file mode 100644
index 000000000..bfe296383
--- /dev/null
+++ b/keyboards/ckeys/washington/keymaps/default/keymap.c
@@ -0,0 +1,82 @@
1/* Copyright 2019 merlin04
2 *
3 * This program is free software: you can redistribute it and/or modify
4 * it under the terms of the GNU General Public License as published by
5 * the Free Software Foundation, either version 2 of the License, or
6 * (at your option) any later version.
7 *
8 * This program is distributed in the hope that it will be useful,
9 * but WITHOUT ANY WARRANTY; without even the implied warranty of
10 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
11 * GNU General Public License for more details.
12 *
13 * You should have received a copy of the GNU General Public License
14 * along with this program. If not, see <http://www.gnu.org/licenses/>.
15 */
16#include QMK_KEYBOARD_H
17
18// Defines names for use in layer keycodes and the keymap
19enum layer_names {
20 _BASE,
21 _FN
22};
23
24// Defines the keycodes used by our macros in process_record_user
25/*enum custom_keycodes {
26};*/
27
28const uint16_t PROGMEM keymaps[][MATRIX_ROWS][MATRIX_COLS] = {
29 /* Base */
30 [_BASE] = LAYOUT(
31 KC_PGUP, KC_UP, KC_PGDN,
32 KC_LEFT, KC_DOWN, KC_RIGHT,
33 MO(_FN), KC_MUTE, BL_TOGG
34 ),
35 [_FN] = LAYOUT(
36 KC_HOME, KC_CALC, KC_END,
37 BL_STEP, KC_ESC, KC_SLEP,
38 KC_TRNS, KC_MPLY, RESET
39 )
40};
41
42void encoder_update_user(uint8_t index, bool clockwise) {
43 switch (biton32(layer_state)) {
44 case _BASE:
45 if (clockwise) {
46 tap_code(KC_VOLU);
47 } else {
48 tap_code(KC_VOLD);
49 }
50 break;
51 case _FN:
52 if (clockwise) {
53 tap_code(KC_MNXT);
54 } else {
55 tap_code(KC_MPRV);
56 }
57 }
58}
59
60#ifdef OLED_DRIVER_ENABLE
61void oled_task_user(void) {
62 // Host Keyboard Layer Status
63 oled_write_P(PSTR("Layer: "), false);
64 switch (biton32(layer_state)) {
65 case _BASE:
66 oled_write_P(PSTR("Default\n"), false);
67 break;
68 case _FN:
69 oled_write_P(PSTR("FN\n"), false);
70 break;
71 default:
72 // Or use the write_ln shortcut over adding '\n' to the end of your string
73 oled_write_ln_P(PSTR("Undefined"), false);
74 }
75
76 // Host Keyboard LED Status
77 uint8_t usb_led = host_keyboard_leds();
78 oled_write_P(IS_LED_ON(usb_led, USB_LED_NUM_LOCK) ? PSTR("NUMLCK ") : PSTR(" "), false);
79 oled_write_P(IS_LED_ON(usb_led, USB_LED_CAPS_LOCK) ? PSTR("CAPLCK ") : PSTR(" "), false);
80 oled_write_P(IS_LED_ON(usb_led, USB_LED_SCROLL_LOCK) ? PSTR("SCRLCK ") : PSTR(" "), false);
81}
82#endif \ No newline at end of file
diff --git a/keyboards/ckeys/washington/keymaps/default/readme.md b/keyboards/ckeys/washington/keymaps/default/readme.md
new file mode 100644
index 000000000..bc0b52d23
--- /dev/null
+++ b/keyboards/ckeys/washington/keymaps/default/readme.md
@@ -0,0 +1 @@
# The default keymap for washington
diff --git a/keyboards/ckeys/washington/readme.md b/keyboards/ckeys/washington/readme.md
new file mode 100644
index 000000000..a74934b3c
--- /dev/null
+++ b/keyboards/ckeys/washington/readme.md
@@ -0,0 +1,23 @@
1# Washington Macropad
2
3![Washington board](https://keypcb.xyz/Content/resources/washington-done.png)
4
5A macropad shaped like Washington State that supports a rotary encoder and an OLED display.
6
7* Keyboard Maintainer: [merlin04/KeyPCB](https://github.com/merlin04)
8* Hardware Supported: Washington Macropad
9* Hardware Availability: [cKeys.org](https://ckeys.org)
10
11Make example for this keyboard (after setting up your build environment):
12
13 make ckeys/washington:default
14
15See 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).
16
17## PCB Design
18
19Download the files for the PCB [here.](https://keypcb.xyz/ViewPage/Washington#files)
20
21## Default Layout
22
23You can find the default layout in `washington/keymaps/default/keymap.c`
diff --git a/keyboards/ckeys/washington/rules.mk b/keyboards/ckeys/washington/rules.mk
new file mode 100644
index 000000000..9c5764b92
--- /dev/null
+++ b/keyboards/ckeys/washington/rules.mk
@@ -0,0 +1,34 @@
1# MCU name
2MCU = atmega32u4
3
4# Bootloader selection
5# Teensy halfkay
6# Pro Micro caterina
7# Atmel DFU atmel-dfu
8# LUFA DFU lufa-dfu
9# QMK DFU qmk-dfu
10# ATmega32A bootloadHID
11# ATmega328P USBasp
12BOOTLOADER = caterina
13
14# Build Options
15# change yes to no to disable
16#
17BOOTMAGIC_ENABLE = no # Virtual DIP switch configuration
18MOUSEKEY_ENABLE = yes # Mouse keys
19EXTRAKEY_ENABLE = yes # Audio control and System control
20CONSOLE_ENABLE = no # Console for debug
21COMMAND_ENABLE = no # Commands for debug and configuration
22# Do not enable SLEEP_LED_ENABLE. it uses the same timer as BACKLIGHT_ENABLE
23SLEEP_LED_ENABLE = no # Breathing sleep LED during USB suspend
24# if this doesn't work, see here: https://github.com/tmk/tmk_keyboard/wiki/FAQ#nkro-doesnt-work
25NKRO_ENABLE = no # USB Nkey Rollover
26BACKLIGHT_ENABLE = yes # Enable keyboard backlight functionality
27RGBLIGHT_ENABLE = no # Enable keyboard RGB underglow
28MIDI_ENABLE = no # MIDI support
29BLUETOOTH_ENABLE = no # Enable Bluetooth with the Adafruit EZ-Key HID
30AUDIO_ENABLE = no # Audio output on port C6
31FAUXCLICKY_ENABLE = no # Use buzzer to emulate clicky switches
32HD44780_ENABLE = no # Enable support for HD44780 based LCDs
33ENCODER_ENABLE = yes # Enable support for encoders
34OLED_DRIVER_ENABLE = yes # Enable support for OLED displays \ No newline at end of file
diff --git a/keyboards/ckeys/washington/washington.c b/keyboards/ckeys/washington/washington.c
new file mode 100644
index 000000000..58089caac
--- /dev/null
+++ b/keyboards/ckeys/washington/washington.c
@@ -0,0 +1,17 @@
1/* Copyright 2019 merlin04
2 *
3 * This program is free software: you can redistribute it and/or modify
4 * it under the terms of the GNU General Public License as published by
5 * the Free Software Foundation, either version 2 of the License, or
6 * (at your option) any later version.
7 *
8 * This program is distributed in the hope that it will be useful,
9 * but WITHOUT ANY WARRANTY; without even the implied warranty of
10 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
11 * GNU General Public License for more details.
12 *
13 * You should have received a copy of the GNU General Public License
14 * along with this program. If not, see <http://www.gnu.org/licenses/>.
15 */
16
17#include "washington.h"
diff --git a/keyboards/ckeys/washington/washington.h b/keyboards/ckeys/washington/washington.h
new file mode 100644
index 000000000..6fba7b328
--- /dev/null
+++ b/keyboards/ckeys/washington/washington.h
@@ -0,0 +1,38 @@
1/* Copyright 2019 merlin04
2 *
3 * This program is free software: you can redistribute it and/or modify
4 * it under the terms of the GNU General Public License as published by
5 * the Free Software Foundation, either version 2 of the License, or
6 * (at your option) any later version.
7 *
8 * This program is distributed in the hope that it will be useful,
9 * but WITHOUT ANY WARRANTY; without even the implied warranty of
10 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
11 * GNU General Public License for more details.
12 *
13 * You should have received a copy of the GNU General Public License
14 * along with this program. If not, see <http://www.gnu.org/licenses/>.
15 */
16
17#pragma once
18
19#include "quantum.h"
20
21/* This is a shortcut to help you visually see your layout.
22 *
23 * The first section contains all of the arguments representing the physical
24 * layout of the board and position of the keys.
25 *
26 * The second converts the arguments into a two-dimensional array which
27 * represents the switch matrix.
28 */
29#define LAYOUT( \
30 k00, k01, k02, \
31 k10, k11, k12, \
32 k20, k21, k22 \
33) \
34{ \
35 { k00, k01, k02 }, \
36 { k10, k11, k12 }, \
37 { k20, k21, k22 } \
38}