aboutsummaryrefslogtreecommitdiff
path: root/keyboards
diff options
context:
space:
mode:
authortakashiski <takashiskibb@gmail.com>2018-10-04 00:34:43 +0900
committerDrashna Jaelre <drashna@live.com>2018-10-03 08:34:43 -0700
commit5368235f223d0537c7456cd8d36d5430f4b58312 (patch)
treedbf974a96fb422cd96bf325cbc55fce85abfbebc /keyboards
parent404db1d06fa9c0dd25fff3bfa1b2ebed7273a8fc (diff)
downloadqmk_firmware-5368235f223d0537c7456cd8d36d5430f4b58312.tar.gz
qmk_firmware-5368235f223d0537c7456cd8d36d5430f4b58312.zip
Keyboard: Add namecard keyboard (#4044)
* create namecard2x4 * create default keymaps * Update README * fixed typo and func remove dont need. * update infomation on readme * update missed point * remove explicit initialize * update default keymap's readme * add my name to copyright * change keymap style to LAYOUT macro and fixed typo LAYOUT macro
Diffstat (limited to 'keyboards')
-rw-r--r--keyboards/namecard2x4/config.h223
-rw-r--r--keyboards/namecard2x4/info.json0
-rw-r--r--keyboards/namecard2x4/keymaps/default/config.h19
-rw-r--r--keyboards/namecard2x4/keymaps/default/keymap.c60
-rw-r--r--keyboards/namecard2x4/keymaps/default/readme.md9
-rw-r--r--keyboards/namecard2x4/namecard2x4.c43
-rw-r--r--keyboards/namecard2x4/namecard2x4.h33
-rw-r--r--keyboards/namecard2x4/readme.md24
-rw-r--r--keyboards/namecard2x4/rules.mk81
9 files changed, 492 insertions, 0 deletions
diff --git a/keyboards/namecard2x4/config.h b/keyboards/namecard2x4/config.h
new file mode 100644
index 000000000..d0c26193c
--- /dev/null
+++ b/keyboards/namecard2x4/config.h
@@ -0,0 +1,223 @@
1/*
2Copyright 2018 takashiski
3
4This program is free software: you can redistribute it and/or modify
5it under the terms of the GNU General Public License as published by
6the Free Software Foundation, either version 2 of the License, or
7(at your option) any later version.
8
9This program is distributed in the hope that it will be useful,
10but WITHOUT ANY WARRANTY; without even the implied warranty of
11MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
12GNU General Public License for more details.
13
14You should have received a copy of the GNU General Public License
15along with this program. If not, see <http://www.gnu.org/licenses/>.
16*/
17
18#pragma once
19
20#include "config_common.h"
21
22/* USB Device descriptor parameter */
23#define VENDOR_ID 0xFEED
24#define PRODUCT_ID 0x0000
25#define DEVICE_VER 0x0001
26#define MANUFACTURER takashiski
27#define PRODUCT namecard2x4
28#define DESCRIPTION A custom keyboard
29
30/* key matrix size */
31#define MATRIX_ROWS 2
32#define MATRIX_COLS 4
33
34/*
35 * Keyboard Matrix Assignments
36 *
37 * Change this to how you wired your keyboard
38 * COLS: AVR pins used for columns, left to right
39 * ROWS: AVR pins used for rows, top to bottom
40 * DIODE_DIRECTION: COL2ROW = COL = Anode (+), ROW = Cathode (-, marked on diode)
41 * ROW2COL = ROW = Anode (+), COL = Cathode (-, marked on diode)
42 *
43*/
44#define MATRIX_ROW_PINS { B4,B5 }
45#define MATRIX_COL_PINS { E6,D7,C6,D4 }
46#define UNUSED_PINS
47
48/* COL2ROW, ROW2COL, or CUSTOM_MATRIX */
49#define DIODE_DIRECTION COL2ROW
50
51#define RGB_DI_PIN F4
52#define RGBLED_NUM 4
53#define RGBLIGHT_ANIMATIONS
54#define RGBLIGHT_HUE_STEP 10
55#define RGBLIGHT_SAT_STEP 10
56#define RGBLIGHT_VAL_STEP 10
57
58//#define BACKLIGHT_PIN F4
59//#define BACKLIGHT_BREATHING
60//#define BACKLIGHT_LEVELS 1
61
62
63/* Debounce reduces chatter (unintended double-presses) - set 0 if debouncing is not needed */
64#define DEBOUNCING_DELAY 5
65
66/* define if matrix has ghost (lacks anti-ghosting diodes) */
67//#define MATRIX_HAS_GHOST
68
69/* number of backlight levels */
70
71/* Mechanical locking support. Use KC_LCAP, KC_LNUM or KC_LSCR instead in keymap */
72#define LOCKING_SUPPORT_ENABLE
73/* Locking resynchronize hack */
74#define LOCKING_RESYNC_ENABLE
75
76/* If defined, GRAVE_ESC will always act as ESC when CTRL is held.
77 * This is userful for the Windows task manager shortcut (ctrl+shift+esc).
78 */
79// #define GRAVE_ESC_CTRL_OVERRIDE
80
81/*
82 * Force NKRO
83 *
84 * Force NKRO (nKey Rollover) to be enabled by default, regardless of the saved
85 * state in the bootmagic EEPROM settings. (Note that NKRO must be enabled in the
86 * makefile for this to work.)
87 *
88 * If forced on, NKRO can be disabled via magic key (default = LShift+RShift+N)
89 * until the next keyboard reset.
90 *
91 * NKRO may prevent your keystrokes from being detected in the BIOS, but it is
92 * fully operational during normal computer usage.
93 *
94 * For a less heavy-handed approach, enable NKRO via magic key (LShift+RShift+N)
95 * or via bootmagic (hold SPACE+N while plugging in the keyboard). Once set by
96 * bootmagic, NKRO mode will always be enabled until it is toggled again during a
97 * power-up.
98 *
99 */
100//#define FORCE_NKRO
101
102/*
103 * Magic Key Options
104 *
105 * Magic keys are hotkey commands that allow control over firmware functions of
106 * the keyboard. They are best used in combination with the HID Listen program,
107 * found here: https://www.pjrc.com/teensy/hid_listen.html
108 *
109 * The options below allow the magic key functionality to be changed. This is
110 * useful if your keyboard/keypad is missing keys and you want magic key support.
111 *
112 */
113
114/* key combination for magic key command */
115#define IS_COMMAND() ( \
116 keyboard_report->mods == (MOD_BIT(KC_LSHIFT) | MOD_BIT(KC_RSHIFT)) \
117)
118
119/* control how magic key switches layers */
120//#define MAGIC_KEY_SWITCH_LAYER_WITH_FKEYS true
121//#define MAGIC_KEY_SWITCH_LAYER_WITH_NKEYS true
122//#define MAGIC_KEY_SWITCH_LAYER_WITH_CUSTOM false
123
124/* override magic key keymap */
125//#define MAGIC_KEY_SWITCH_LAYER_WITH_FKEYS
126//#define MAGIC_KEY_SWITCH_LAYER_WITH_NKEYS
127//#define MAGIC_KEY_SWITCH_LAYER_WITH_CUSTOM
128//#define MAGIC_KEY_HELP1 H
129//#define MAGIC_KEY_HELP2 SLASH
130//#define MAGIC_KEY_DEBUG D
131//#define MAGIC_KEY_DEBUG_MATRIX X
132//#define MAGIC_KEY_DEBUG_KBD K
133//#define MAGIC_KEY_DEBUG_MOUSE M
134//#define MAGIC_KEY_VERSION V
135//#define MAGIC_KEY_STATUS S
136//#define MAGIC_KEY_CONSOLE C
137//#define MAGIC_KEY_LAYER0_ALT1 ESC
138//#define MAGIC_KEY_LAYER0_ALT2 GRAVE
139//#define MAGIC_KEY_LAYER0 0
140//#define MAGIC_KEY_LAYER1 1
141//#define MAGIC_KEY_LAYER2 2
142//#define MAGIC_KEY_LAYER3 3
143//#define MAGIC_KEY_LAYER4 4
144//#define MAGIC_KEY_LAYER5 5
145//#define MAGIC_KEY_LAYER6 6
146//#define MAGIC_KEY_LAYER7 7
147//#define MAGIC_KEY_LAYER8 8
148//#define MAGIC_KEY_LAYER9 9
149//#define MAGIC_KEY_BOOTLOADER PAUSE
150//#define MAGIC_KEY_LOCK CAPS
151//#define MAGIC_KEY_EEPROM E
152//#define MAGIC_KEY_NKRO N
153//#define MAGIC_KEY_SLEEP_LED Z
154
155/*
156 * Feature disable options
157 * These options are also useful to firmware size reduction.
158 */
159
160/* disable debug print */
161//#define NO_DEBUG
162
163/* disable print */
164//#define NO_PRINT
165
166/* disable action features */
167//#define NO_ACTION_LAYER
168//#define NO_ACTION_TAPPING
169//#define NO_ACTION_ONESHOT
170//#define NO_ACTION_MACRO
171//#define NO_ACTION_FUNCTION
172
173/*
174 * MIDI options
175 */
176
177/* Prevent use of disabled MIDI features in the keymap */
178//#define MIDI_ENABLE_STRICT 1
179
180/* enable basic MIDI features:
181 - MIDI notes can be sent when in Music mode is on
182*/
183//#define MIDI_BASIC
184
185/* enable advanced MIDI features:
186 - MIDI notes can be added to the keymap
187 - Octave shift and transpose
188 - Virtual sustain, portamento, and modulation wheel
189 - etc.
190*/
191//#define MIDI_ADVANCED
192
193/* override number of MIDI tone keycodes (each octave adds 12 keycodes and allocates 12 bytes) */
194//#define MIDI_TONE_KEYCODE_OCTAVES 1
195
196/*
197 * HD44780 LCD Display Configuration
198 */
199/*
200#define LCD_LINES 2 //< number of visible lines of the display
201#define LCD_DISP_LENGTH 16 //< visibles characters per line of the display
202
203#define LCD_IO_MODE 1 //< 0: memory mapped mode, 1: IO port mode
204
205#if LCD_IO_MODE
206#define LCD_PORT PORTB //< port for the LCD lines
207#define LCD_DATA0_PORT LCD_PORT //< port for 4bit data bit 0
208#define LCD_DATA1_PORT LCD_PORT //< port for 4bit data bit 1
209#define LCD_DATA2_PORT LCD_PORT //< port for 4bit data bit 2
210#define LCD_DATA3_PORT LCD_PORT //< port for 4bit data bit 3
211#define LCD_DATA0_PIN 4 //< pin for 4bit data bit 0
212#define LCD_DATA1_PIN 5 //< pin for 4bit data bit 1
213#define LCD_DATA2_PIN 6 //< pin for 4bit data bit 2
214#define LCD_DATA3_PIN 7 //< pin for 4bit data bit 3
215#define LCD_RS_PORT LCD_PORT //< port for RS line
216#define LCD_RS_PIN 3 //< pin for RS line
217#define LCD_RW_PORT LCD_PORT //< port for RW line
218#define LCD_RW_PIN 2 //< pin for RW line
219#define LCD_E_PORT LCD_PORT //< port for Enable line
220#define LCD_E_PIN 1 //< pin for Enable line
221#endif
222*/
223
diff --git a/keyboards/namecard2x4/info.json b/keyboards/namecard2x4/info.json
new file mode 100644
index 000000000..e69de29bb
--- /dev/null
+++ b/keyboards/namecard2x4/info.json
diff --git a/keyboards/namecard2x4/keymaps/default/config.h b/keyboards/namecard2x4/keymaps/default/config.h
new file mode 100644
index 000000000..dbacdcce5
--- /dev/null
+++ b/keyboards/namecard2x4/keymaps/default/config.h
@@ -0,0 +1,19 @@
1/* Copyright 2018 takashiski
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// place overrides here
diff --git a/keyboards/namecard2x4/keymaps/default/keymap.c b/keyboards/namecard2x4/keymaps/default/keymap.c
new file mode 100644
index 000000000..1a0a727fc
--- /dev/null
+++ b/keyboards/namecard2x4/keymaps/default/keymap.c
@@ -0,0 +1,60 @@
1/* Copyright 2018 takashiski
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
18enum Layer
19{
20 DF,
21 LW,
22 RS
23};
24
25
26
27const uint16_t PROGMEM keymaps[][MATRIX_ROWS][MATRIX_COLS] = {
28[DF] = LAYOUT(
29 KC_1,KC_2,KC_3,LT(LW,KC_4),
30 KC_5,KC_6,KC_7,LT(RS,KC_8)
31 ),
32[LW]= LAYOUT(
33
34 RGB_VAD,RGB_VAI,RGB_HUI,RGB_HUD,
35 KC_TRNS,RGB_MOD,RGB_RMOD,KC_TRNS
36 ),
37[RS]= LAYOUT(
38
39 KC_MYCM,KC_MAIL,KC_VOLU,KC_MUTE,
40 KC_WSCH,KC_CALC,KC_VOLD,KC_TRNS
41 )
42
43};
44
45
46void matrix_init_user(void) {
47
48}
49
50void matrix_scan_user(void) {
51
52}
53
54bool process_record_user(uint16_t keycode, keyrecord_t *record) {
55 return true;
56}
57
58void led_set_user(uint8_t usb_led) {
59
60}
diff --git a/keyboards/namecard2x4/keymaps/default/readme.md b/keyboards/namecard2x4/keymaps/default/readme.md
new file mode 100644
index 000000000..83601c9cf
--- /dev/null
+++ b/keyboards/namecard2x4/keymaps/default/readme.md
@@ -0,0 +1,9 @@
1# The default keymap for namecard2x4
2
3this is test keymap.
4
5| 1 | 2 | 3 | 4 |
6| 5 | 6 | 7 | 8 |
7
8if hold 4, change to Backlight settings Layer.
9if hold 8, change to Windows action Layer(Open my computer, Open calculater and others).
diff --git a/keyboards/namecard2x4/namecard2x4.c b/keyboards/namecard2x4/namecard2x4.c
new file mode 100644
index 000000000..349923daf
--- /dev/null
+++ b/keyboards/namecard2x4/namecard2x4.c
@@ -0,0 +1,43 @@
1/* Copyright 2018 takashiski
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 "namecard2x4.h"
17
18void matrix_init_kb(void) {
19 // put your keyboard start-up code here
20 // runs once when the firmware starts up
21
22 matrix_init_user();
23}
24
25void matrix_scan_kb(void) {
26 // put your looping keyboard code here
27 // runs every cycle (a lot)
28
29 matrix_scan_user();
30}
31
32bool process_record_kb(uint16_t keycode, keyrecord_t *record) {
33 // put your per-action keyboard code here
34 // runs for every action, just before processing by the firmware
35
36 return process_record_user(keycode, record);
37}
38
39void led_set_kb(uint8_t usb_led) {
40 // put your keyboard LED indicator (ex: Caps Lock LED) toggling code here
41
42 led_set_user(usb_led);
43}
diff --git a/keyboards/namecard2x4/namecard2x4.h b/keyboards/namecard2x4/namecard2x4.h
new file mode 100644
index 000000000..f2e27a010
--- /dev/null
+++ b/keyboards/namecard2x4/namecard2x4.h
@@ -0,0 +1,33 @@
1/* Copyright 2018 takashiski
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#ifndef NAMECARD2X4_H
17#define NAMECARD2X4_H
18
19#include "quantum.h"
20
21// This a shortcut to help you visually see your layout.
22// The following is an example using the Planck MIT layout
23// The first section contains all of the arguments
24// The second converts the arguments into a two-dimensional array
25#define LAYOUT( \
26 k00, k01, k02, k03, \
27 k10, k11, k12, k13 \
28) { \
29 { k00, k01, k02, k03 }, \
30 { k10, k11, k12, k13 }, \
31}
32
33#endif
diff --git a/keyboards/namecard2x4/readme.md b/keyboards/namecard2x4/readme.md
new file mode 100644
index 000000000..ec98bc673
--- /dev/null
+++ b/keyboards/namecard2x4/readme.md
@@ -0,0 +1,24 @@
1# namecard2x4
2
3日本式名刺サイズのキーボードです(55x91mm)。
4Kailh PCB SocketとWS2812/SK6812に対応しています。
5
6This keyboard is Japanese namecard size(55x91mm) keyboard.
7
8namecard2x4 has 8 switch and kailh PCB socket.
9
10![namecard2x4](https://i.imgur.com/Bi9SV9A.jpg)
11
12![namecard2x4 with case](https://i.imgur.com/yTv1vSz.jpg)
13
14
15
16Keyboard Maintainer: [takashiski](https://github.com/takashiski)
17
18
19Make example for this keyboard (after setting up your build environment):
20
21 make namecard2x4:default
22
23See 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).
24
diff --git a/keyboards/namecard2x4/rules.mk b/keyboards/namecard2x4/rules.mk
new file mode 100644
index 000000000..51d2cbcb2
--- /dev/null
+++ b/keyboards/namecard2x4/rules.mk
@@ -0,0 +1,81 @@
1# MCU name
2#MCU = at90usb1286
3MCU = atmega32u4
4
5# Processor frequency.
6# This will define a symbol, F_CPU, in all source code files equal to the
7# processor frequency in Hz. You can then use this symbol in your source code to
8# calculate timings. Do NOT tack on a 'UL' at the end, this will be done
9# automatically to create a 32-bit value in your source code.
10#
11# This will be an integer division of F_USB below, as it is sourced by
12# F_USB after it has run through any CPU prescalers. Note that this value
13# does not *change* the processor frequency - it should merely be updated to
14# reflect the processor speed set externally so that the code can use accurate
15# software delays.
16F_CPU = 16000000
17
18
19#
20# LUFA specific
21#
22# Target architecture (see library "Board Types" documentation).
23ARCH = AVR8
24
25# Input clock frequency.
26# This will define a symbol, F_USB, in all source code files equal to the
27# input clock frequency (before any prescaling is performed) in Hz. This value may
28# differ from F_CPU if prescaling is used on the latter, and is required as the
29# raw input clock is fed directly to the PLL sections of the AVR for high speed
30# clock generation for the USB and other AVR subsections. Do NOT tack on a 'UL'
31# at the end, this will be done automatically to create a 32-bit value in your
32# source code.
33#
34# If no clock division is performed on the input clock inside the AVR (via the
35# CPU clock adjust registers or the clock division fuses), this will be equal to F_CPU.
36F_USB = $(F_CPU)
37
38# Interrupt driven control endpoint task(+60)
39OPT_DEFS += -DINTERRUPT_CONTROL_ENDPOINT
40
41
42# Boot Section Size in *bytes*
43# Teensy halfKay 512
44# Teensy++ halfKay 1024
45# Atmel DFU loader 4096
46# LUFA bootloader 4096
47# USBaspLoader 2048
48# OPT_DEFS += -DBOOTLOADER_SIZE=4096
49
50# Bootloader selection
51# Teensy halfkay
52# Pro Micro caterina
53# Atmel DFU atmel-dfu
54# LUFA DFU lufa-dfu
55# QMK DFU qmk-dfu
56# atmega32a bootloadHID
57BOOTLOADER = atmel-dfu
58
59
60# Build Options
61# change yes to no to disable
62#
63BOOTMAGIC_ENABLE = no # Virtual DIP switch configuration(+1000)
64MOUSEKEY_ENABLE = yes # Mouse keys(+4700)
65EXTRAKEY_ENABLE = yes # Audio control and System control(+450)
66CONSOLE_ENABLE = yes # Console for debug(+400)
67COMMAND_ENABLE = yes # Commands for debug and configuration
68# Do not enable SLEEP_LED_ENABLE. it uses the same timer as BACKLIGHT_ENABLE
69SLEEP_LED_ENABLE = no # Breathing sleep LED during USB suspend
70# if this doesn't work, see here: https://github.com/tmk/tmk_keyboard/wiki/FAQ#nkro-doesnt-work
71NKRO_ENABLE = no # USB Nkey Rollover
72BACKLIGHT_ENABLE = no # Enable keyboard backlight functionality on B7 by default
73MIDI_ENABLE = no # MIDI support (+2400 to 4200, depending on config)
74UNICODE_ENABLE = no # Unicode
75BLUETOOTH_ENABLE = no # Enable Bluetooth with the Adafruit EZ-Key HID
76AUDIO_ENABLE = no # Audio output on port C6
77FAUXCLICKY_ENABLE = no # Use buzzer to emulate clicky switches
78HD44780_ENABLE = no # Enable support for HD44780 based LCDs (+400)
79
80#UNICODEMAP_ENABLE = yes # for emoji user
81#RGBLIGHT_ENABLE = yes # uncomment if you want addressable led strips