aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorT.Shinohara <takuma1201@gmail.com>2019-07-16 02:33:18 +0900
committerDrashna Jaelre <drashna@live.com>2019-07-15 10:33:18 -0700
commitb2fb0ceeef1a3f8ba96184fbeb21b2c89456c06a (patch)
treef9d880297985443d18d8591aea21fae0f8a997d2
parentff0cb0cf9dc81db11459e7e59c01adadca3ec2b8 (diff)
downloadqmk_firmware-b2fb0ceeef1a3f8ba96184fbeb21b2c89456c06a.tar.gz
qmk_firmware-b2fb0ceeef1a3f8ba96184fbeb21b2c89456c06a.zip
[Keyboard] add macro pad "Shiro" (#6338)
* add keyboard new macro pad "Kuro" * change main readme.md * remove not used code from default/keymap.c * Remove unnecessary code * Supports info.json * removed back slash and not used functions. * update at product link. add japanese messages.
-rw-r--r--keyboards/shiro/config.h251
-rw-r--r--keyboards/shiro/info.json114
-rw-r--r--keyboards/shiro/keymaps/check/config.h19
-rw-r--r--keyboards/shiro/keymaps/check/keymap.c66
-rw-r--r--keyboards/shiro/keymaps/check/readme.md1
-rw-r--r--keyboards/shiro/keymaps/default/config.h19
-rw-r--r--keyboards/shiro/keymaps/default/keymap.c50
-rw-r--r--keyboards/shiro/keymaps/default/readme.md1
-rw-r--r--keyboards/shiro/readme.md27
-rw-r--r--keyboards/shiro/rules.mk80
-rw-r--r--keyboards/shiro/shiro.c51
-rw-r--r--keyboards/shiro/shiro.h41
12 files changed, 720 insertions, 0 deletions
diff --git a/keyboards/shiro/config.h b/keyboards/shiro/config.h
new file mode 100644
index 000000000..d97be0cd2
--- /dev/null
+++ b/keyboards/shiro/config.h
@@ -0,0 +1,251 @@
1/*
2Copyright 2019 T.Shinohara
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 T.Shinohara
27#define PRODUCT Shiro
28#define DESCRIPTION A custom keyboard
29
30/* key matrix size */
31#define MATRIX_ROWS 5
32#define MATRIX_COLS 3
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 { D4, C6, D7, E6, B4 }
45#define MATRIX_COL_PINS { F4, F5, F6 }
46#define UNUSED_PINS
47
48/* COL2ROW, ROW2COL*/
49#define DIODE_DIRECTION COL2ROW
50
51/*
52 * Split Keyboard specific options, make sure you have 'SPLIT_KEYBOARD = yes' in your rules.mk, and define SOFT_SERIAL_PIN.
53 */
54#define SOFT_SERIAL_PIN D0 // or D1, D2, D3, E6
55
56// #define BACKLIGHT_PIN B7
57// #define BACKLIGHT_BREATHING
58// #define BACKLIGHT_LEVELS 3
59
60// #define RGB_DI_PIN E2
61// #ifdef RGB_DI_PIN
62// #define RGBLED_NUM 16
63// #define RGBLIGHT_HUE_STEP 8
64// #define RGBLIGHT_SAT_STEP 8
65// #define RGBLIGHT_VAL_STEP 8
66// #define RGBLIGHT_LIMIT_VAL 255 /* The maximum brightness level */
67// #define RGBLIGHT_SLEEP /* If defined, the RGB lighting will be switched off when the host goes to sleep */
68// /*== all animations enable ==*/
69// #define RGBLIGHT_ANIMATIONS
70// /*== or choose animations ==*/
71// #define RGBLIGHT_EFFECT_BREATHING
72// #define RGBLIGHT_EFFECT_RAINBOW_MOOD
73// #define RGBLIGHT_EFFECT_RAINBOW_SWIRL
74// #define RGBLIGHT_EFFECT_SNAKE
75// #define RGBLIGHT_EFFECT_KNIGHT
76// #define RGBLIGHT_EFFECT_CHRISTMAS
77// #define RGBLIGHT_EFFECT_STATIC_GRADIENT
78// #define RGBLIGHT_EFFECT_RGB_TEST
79// #define RGBLIGHT_EFFECT_ALTERNATING
80// /*== customize breathing effect ==*/
81// /*==== (DEFAULT) use fixed table instead of exp() and sin() ====*/
82// #define RGBLIGHT_BREATHE_TABLE_SIZE 256 // 256(default) or 128 or 64
83// /*==== use exp() and sin() ====*/
84// #define RGBLIGHT_EFFECT_BREATHE_CENTER 1.85 // 1 to 2.7
85// #define RGBLIGHT_EFFECT_BREATHE_MAX 255 // 0 to 255
86// #endif
87
88/* Debounce reduces chatter (unintended double-presses) - set 0 if debouncing is not needed */
89#define DEBOUNCING_DELAY 5
90
91/* define if matrix has ghost (lacks anti-ghosting diodes) */
92//#define MATRIX_HAS_GHOST
93
94/* number of backlight levels */
95
96/* Mechanical locking support. Use KC_LCAP, KC_LNUM or KC_LSCR instead in keymap */
97#define LOCKING_SUPPORT_ENABLE
98/* Locking resynchronize hack */
99#define LOCKING_RESYNC_ENABLE
100
101/* If defined, GRAVE_ESC will always act as ESC when CTRL is held.
102 * This is userful for the Windows task manager shortcut (ctrl+shift+esc).
103 */
104// #define GRAVE_ESC_CTRL_OVERRIDE
105
106/*
107 * Force NKRO
108 *
109 * Force NKRO (nKey Rollover) to be enabled by default, regardless of the saved
110 * state in the bootmagic EEPROM settings. (Note that NKRO must be enabled in the
111 * makefile for this to work.)
112 *
113 * If forced on, NKRO can be disabled via magic key (default = LShift+RShift+N)
114 * until the next keyboard reset.
115 *
116 * NKRO may prevent your keystrokes from being detected in the BIOS, but it is
117 * fully operational during normal computer usage.
118 *
119 * For a less heavy-handed approach, enable NKRO via magic key (LShift+RShift+N)
120 * or via bootmagic (hold SPACE+N while plugging in the keyboard). Once set by
121 * bootmagic, NKRO mode will always be enabled until it is toggled again during a
122 * power-up.
123 *
124 */
125//#define FORCE_NKRO
126
127/*
128 * Magic Key Options
129 *
130 * Magic keys are hotkey commands that allow control over firmware functions of
131 * the keyboard. They are best used in combination with the HID Listen program,
132 * found here: https://www.pjrc.com/teensy/hid_listen.html
133 *
134 * The options below allow the magic key functionality to be changed. This is
135 * useful if your keyboard/keypad is missing keys and you want magic key support.
136 *
137 */
138
139/* key combination for magic key command */
140/* defined by default; to change, uncomment and set to the combination you want */
141// #define IS_COMMAND() (get_mods() == (MOD_BIT(KC_LSHIFT) | MOD_BIT(KC_RSHIFT)))
142
143/* control how magic key switches layers */
144//#define MAGIC_KEY_SWITCH_LAYER_WITH_FKEYS true
145//#define MAGIC_KEY_SWITCH_LAYER_WITH_NKEYS true
146//#define MAGIC_KEY_SWITCH_LAYER_WITH_CUSTOM false
147
148/* override magic key keymap */
149//#define MAGIC_KEY_SWITCH_LAYER_WITH_FKEYS
150//#define MAGIC_KEY_SWITCH_LAYER_WITH_NKEYS
151//#define MAGIC_KEY_SWITCH_LAYER_WITH_CUSTOM
152//#define MAGIC_KEY_HELP H
153//#define MAGIC_KEY_HELP_ALT SLASH
154//#define MAGIC_KEY_DEBUG D
155//#define MAGIC_KEY_DEBUG_MATRIX X
156//#define MAGIC_KEY_DEBUG_KBD K
157//#define MAGIC_KEY_DEBUG_MOUSE M
158//#define MAGIC_KEY_VERSION V
159//#define MAGIC_KEY_STATUS S
160//#define MAGIC_KEY_CONSOLE C
161//#define MAGIC_KEY_LAYER0 0
162//#define MAGIC_KEY_LAYER0_ALT GRAVE
163//#define MAGIC_KEY_LAYER1 1
164//#define MAGIC_KEY_LAYER2 2
165//#define MAGIC_KEY_LAYER3 3
166//#define MAGIC_KEY_LAYER4 4
167//#define MAGIC_KEY_LAYER5 5
168//#define MAGIC_KEY_LAYER6 6
169//#define MAGIC_KEY_LAYER7 7
170//#define MAGIC_KEY_LAYER8 8
171//#define MAGIC_KEY_LAYER9 9
172//#define MAGIC_KEY_BOOTLOADER B
173//#define MAGIC_KEY_BOOTLOADER_ALT ESC
174//#define MAGIC_KEY_LOCK CAPS
175//#define MAGIC_KEY_EEPROM E
176//#define MAGIC_KEY_EEPROM_CLEAR BSPACE
177//#define MAGIC_KEY_NKRO N
178//#define MAGIC_KEY_SLEEP_LED Z
179
180/*
181 * Feature disable options
182 * These options are also useful to firmware size reduction.
183 */
184
185/* disable debug print */
186//#define NO_DEBUG
187
188/* disable print */
189//#define NO_PRINT
190
191/* disable action features */
192//#define NO_ACTION_LAYER
193//#define NO_ACTION_TAPPING
194//#define NO_ACTION_ONESHOT
195//#define NO_ACTION_MACRO
196//#define NO_ACTION_FUNCTION
197
198/*
199 * MIDI options
200 */
201
202/* Prevent use of disabled MIDI features in the keymap */
203//#define MIDI_ENABLE_STRICT 1
204
205/* enable basic MIDI features:
206 - MIDI notes can be sent when in Music mode is on
207*/
208//#define MIDI_BASIC
209
210/* enable advanced MIDI features:
211 - MIDI notes can be added to the keymap
212 - Octave shift and transpose
213 - Virtual sustain, portamento, and modulation wheel
214 - etc.
215*/
216//#define MIDI_ADVANCED
217
218/* override number of MIDI tone keycodes (each octave adds 12 keycodes and allocates 12 bytes) */
219//#define MIDI_TONE_KEYCODE_OCTAVES 1
220
221/*
222 * HD44780 LCD Display Configuration
223 */
224/*
225#define LCD_LINES 2 //< number of visible lines of the display
226#define LCD_DISP_LENGTH 16 //< visibles characters per line of the display
227
228#define LCD_IO_MODE 1 //< 0: memory mapped mode, 1: IO port mode
229
230#if LCD_IO_MODE
231#define LCD_PORT PORTB //< port for the LCD lines
232#define LCD_DATA0_PORT LCD_PORT //< port for 4bit data bit 0
233#define LCD_DATA1_PORT LCD_PORT //< port for 4bit data bit 1
234#define LCD_DATA2_PORT LCD_PORT //< port for 4bit data bit 2
235#define LCD_DATA3_PORT LCD_PORT //< port for 4bit data bit 3
236#define LCD_DATA0_PIN 4 //< pin for 4bit data bit 0
237#define LCD_DATA1_PIN 5 //< pin for 4bit data bit 1
238#define LCD_DATA2_PIN 6 //< pin for 4bit data bit 2
239#define LCD_DATA3_PIN 7 //< pin for 4bit data bit 3
240#define LCD_RS_PORT LCD_PORT //< port for RS line
241#define LCD_RS_PIN 3 //< pin for RS line
242#define LCD_RW_PORT LCD_PORT //< port for RW line
243#define LCD_RW_PIN 2 //< pin for RW line
244#define LCD_E_PORT LCD_PORT //< port for Enable line
245#define LCD_E_PIN 1 //< pin for Enable line
246#endif
247*/
248
249/* Bootmagic Lite key configuration */
250// #define BOOTMAGIC_LITE_ROW 0
251// #define BOOTMAGIC_LITE_COLUMN 0
diff --git a/keyboards/shiro/info.json b/keyboards/shiro/info.json
new file mode 100644
index 000000000..71d4bb551
--- /dev/null
+++ b/keyboards/shiro/info.json
@@ -0,0 +1,114 @@
1{
2 "keyboard_name": "Shiro",
3 "url": "https://github.com/ShinoharaTa/keyboards/blob/master/Shiro/manual/build_guide_ja.md",
4 "maintainer": "T.Shinohara",
5 "width": 3,
6 "height": 5,
7 "layouts": {
8 "LAYOUT": {
9 "key_count": 15,
10 "layout": [
11 {
12 "x": 0,
13 "y": 0
14 },
15 {
16 "x": 1,
17 "y": 0
18 },
19 {
20 "x": 2,
21 "y": 0
22 },
23 {
24 "x": 3,
25 "y": 0
26 },
27 {
28 "x": 4,
29 "y": 0
30 },
31 {
32 "x": 0,
33 "y": 1
34 },
35 {
36 "x": 1,
37 "y": 1
38 },
39 {
40 "x": 2,
41 "y": 1
42 },
43 {
44 "x": 3,
45 "y": 1
46 },
47 {
48 "x": 4,
49 "y": 1
50 },
51 {
52 "x": 0,
53 "y": 2
54 },
55 {
56 "x": 1,
57 "y": 2
58 },
59 {
60 "x": 2,
61 "y": 2
62 },
63 {
64 "x": 3,
65 "y": 2
66 },
67 {
68 "x": 4,
69 "y": 2
70 },
71 {
72 "x": 0,
73 "y": 3
74 },
75 {
76 "x": 1,
77 "y": 3
78 },
79 {
80 "x": 2,
81 "y": 3
82 },
83 {
84 "x": 3,
85 "y": 3
86 },
87 {
88 "x": 4,
89 "y": 3
90 },
91 {
92 "x": 0,
93 "y": 4
94 },
95 {
96 "x": 1,
97 "y": 4
98 },
99 {
100 "x": 2,
101 "y": 4
102 },
103 {
104 "x": 3,
105 "y": 4
106 },
107 {
108 "x": 4,
109 "y": 4
110 }
111 ]
112 }
113 }
114}
diff --git a/keyboards/shiro/keymaps/check/config.h b/keyboards/shiro/keymaps/check/config.h
new file mode 100644
index 000000000..369388ada
--- /dev/null
+++ b/keyboards/shiro/keymaps/check/config.h
@@ -0,0 +1,19 @@
1/* Copyright 2019 T.Shinohara
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/shiro/keymaps/check/keymap.c b/keyboards/shiro/keymaps/check/keymap.c
new file mode 100644
index 000000000..1f41f61dd
--- /dev/null
+++ b/keyboards/shiro/keymaps/check/keymap.c
@@ -0,0 +1,66 @@
1/* Copyright 2019 T.Shinohara
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 the keycodes used by our macros in process_record_user
19enum custom_keycodes {
20 TEST_A1 = SAFE_RANGE,
21 TEST_A2,
22 TEST_A3,
23 TEST_B1,
24 TEST_B2,
25 TEST_B3,
26 TEST_C1,
27 TEST_C2,
28 TEST_C3,
29 TEST_D1,
30 TEST_D2,
31 TEST_D3,
32 TEST_E1,
33 TEST_E2,
34 TEST_E3
35};
36
37const uint16_t PROGMEM keymaps[][MATRIX_ROWS][MATRIX_COLS] = {
38 [0] = LAYOUT( /* Base */
39 TEST_A1, TEST_A2, TEST_A3,
40 TEST_B1, TEST_B2, TEST_B3,
41 TEST_C1, TEST_C2, TEST_C3,
42 TEST_D1, TEST_D2, TEST_D3,
43 TEST_E1, TEST_E2, TEST_E3
44 )
45};
46
47bool process_record_user(uint16_t keycode, keyrecord_t *record) {
48 switch (keycode) {
49 case TEST_A1: if(record->event.pressed){ SEND_STRING("A1"); } break;
50 case TEST_A2: if(record->event.pressed){ SEND_STRING("A2"); } break;
51 case TEST_A3: if(record->event.pressed){ SEND_STRING("A3"); } break;
52 case TEST_B1: if(record->event.pressed){ SEND_STRING("B1"); } break;
53 case TEST_B2: if(record->event.pressed){ SEND_STRING("B2"); } break;
54 case TEST_B3: if(record->event.pressed){ SEND_STRING("B3"); } break;
55 case TEST_C1: if(record->event.pressed){ SEND_STRING("C1"); } break;
56 case TEST_C2: if(record->event.pressed){ SEND_STRING("C2"); } break;
57 case TEST_C3: if(record->event.pressed){ SEND_STRING("C3"); } break;
58 case TEST_D1: if(record->event.pressed){ SEND_STRING("D1"); } break;
59 case TEST_D2: if(record->event.pressed){ SEND_STRING("D2"); } break;
60 case TEST_D3: if(record->event.pressed){ SEND_STRING("D3"); } break;
61 case TEST_E1: if(record->event.pressed){ SEND_STRING("E1"); } break;
62 case TEST_E2: if(record->event.pressed){ SEND_STRING("E2"); } break;
63 case TEST_E3: if(record->event.pressed){ SEND_STRING("E3"); } break;
64 }
65 return true;
66}
diff --git a/keyboards/shiro/keymaps/check/readme.md b/keyboards/shiro/keymaps/check/readme.md
new file mode 100644
index 000000000..715ddd335
--- /dev/null
+++ b/keyboards/shiro/keymaps/check/readme.md
@@ -0,0 +1 @@
# The default keymap for Shiro \ No newline at end of file
diff --git a/keyboards/shiro/keymaps/default/config.h b/keyboards/shiro/keymaps/default/config.h
new file mode 100644
index 000000000..369388ada
--- /dev/null
+++ b/keyboards/shiro/keymaps/default/config.h
@@ -0,0 +1,19 @@
1/* Copyright 2019 T.Shinohara
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/shiro/keymaps/default/keymap.c b/keyboards/shiro/keymaps/default/keymap.c
new file mode 100644
index 000000000..b80c29452
--- /dev/null
+++ b/keyboards/shiro/keymaps/default/keymap.c
@@ -0,0 +1,50 @@
1/* Copyright 2019 T.Shinohara
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_number {
19 _NUMBER = 0,
20 _CURSOL,
21 _MOUSE
22};
23
24#define NUMBER TO(_NUMBER)
25#define CURSOL TO(_CURSOL)
26#define MOUSE TO(_MOUSE)
27
28const uint16_t PROGMEM keymaps[][MATRIX_ROWS][MATRIX_COLS] = {
29 [_NUMBER] = LAYOUT(
30 NUMBER, CURSOL, MOUSE,
31 KC_P7, KC_P8, KC_P9,
32 KC_P4, KC_P5, KC_P6,
33 KC_P1, KC_P2, KC_P3,
34 KC_P0, KC_BSPC, KC_ENT
35 ),
36 [_CURSOL] = LAYOUT(
37 NUMBER, CURSOL, MOUSE,
38 KC_HOME, KC_UP, KC_PGUP,
39 KC_LEFT, KC_ESC, KC_RIGHT,
40 KC_END, KC_DOWN, KC_PGDN,
41 KC_DEL, KC_BSPC, KC_ENT
42 ),
43 [_MOUSE] = LAYOUT(
44 NUMBER, CURSOL, MOUSE,
45 KC_CUT, KC_COPY, KC_PSTE,
46 KC_UNDO, KC_FIND, KC_AGIN,
47 XXXXXXX, XXXXXXX, XXXXXXX,
48 KC_DEL, KC_BSPC, KC_ENT
49 ),
50};
diff --git a/keyboards/shiro/keymaps/default/readme.md b/keyboards/shiro/keymaps/default/readme.md
new file mode 100644
index 000000000..715ddd335
--- /dev/null
+++ b/keyboards/shiro/keymaps/default/readme.md
@@ -0,0 +1 @@
# The default keymap for Shiro \ No newline at end of file
diff --git a/keyboards/shiro/readme.md b/keyboards/shiro/readme.md
new file mode 100644
index 000000000..7c4c024a6
--- /dev/null
+++ b/keyboards/shiro/readme.md
@@ -0,0 +1,27 @@
1# 素 - Shiro
2
3![Shiro](https://cdn.discordapp.com/attachments/536423734144401422/597447002288291861/P7070070_cp.jpg)
4
5これは日本の名刺(55mmx91mm)に、3x5の15キーを詰め込んだとても小さいキーパッドです。
6
7This product is a 3x5 very small keypad.
8It is made in 55mm x 91mm according to the Japanese business card.
9
10Keyboard Maintainer: [T.Shinohara](https://github.com/ShinoharaTa)
11Hardware Supported: The Shiro PCBs, ProMicro supported. Using only Kailh Low Profile Switches.
12Hardware Availability: [Booth (Japanese Site)](https://shino3.booth.pm/items/1444895)
13日本国内ではBoothで入手できます: [Booth (Japanese Site)](https://shino3.booth.pm/items/1444895)
14
15![Shiro-backside](https://cdn.discordapp.com/attachments/536423734144401422/597464086640328724/20190707_033520.jpg)
16
17Make for this keyboard default keymap (after setting up your build environment):
18
19 make shiro:default
20
21Make for this keyboard build check keymap (after setting up your build environment):
22
23 make shiro:check
24
25See 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).
26
27[Build guide - Japanese](https://github.com/ShinoharaTa/keyboards/blob/master/Shiro/manual/build_guide_ja.md) \ No newline at end of file
diff --git a/keyboards/shiro/rules.mk b/keyboards/shiro/rules.mk
new file mode 100644
index 000000000..3ea1516fc
--- /dev/null
+++ b/keyboards/shiro/rules.mk
@@ -0,0 +1,80 @@
1# MCU name
2MCU = atmega32u4
3
4# Processor frequency.
5# This will define a symbol, F_CPU, in all source code files equal to the
6# processor frequency in Hz. You can then use this symbol in your source code to
7# calculate timings. Do NOT tack on a 'UL' at the end, this will be done
8# automatically to create a 32-bit value in your source code.
9#
10# This will be an integer division of F_USB below, as it is sourced by
11# F_USB after it has run through any CPU prescalers. Note that this value
12# does not *change* the processor frequency - it should merely be updated to
13# reflect the processor speed set externally so that the code can use accurate
14# software delays.
15F_CPU = 16000000
16
17
18#
19# LUFA specific
20#
21# Target architecture (see library "Board Types" documentation).
22ARCH = AVR8
23
24# Input clock frequency.
25# This will define a symbol, F_USB, in all source code files equal to the
26# input clock frequency (before any prescaling is performed) in Hz. This value may
27# differ from F_CPU if prescaling is used on the latter, and is required as the
28# raw input clock is fed directly to the PLL sections of the AVR for high speed
29# clock generation for the USB and other AVR subsections. Do NOT tack on a 'UL'
30# at the end, this will be done automatically to create a 32-bit value in your
31# source code.
32#
33# If no clock division is performed on the input clock inside the AVR (via the
34# CPU clock adjust registers or the clock division fuses), this will be equal to F_CPU.
35F_USB = $(F_CPU)
36
37# Interrupt driven control endpoint task(+60)
38OPT_DEFS += -DINTERRUPT_CONTROL_ENDPOINT
39
40
41# Bootloader selection
42# Teensy halfkay
43# Pro Micro caterina
44# Atmel DFU atmel-dfu
45# LUFA DFU lufa-dfu
46# QMK DFU qmk-dfu
47# atmega32a bootloadHID
48BOOTLOADER = caterina
49
50
51# If you don't know the bootloader type, then you can specify the
52# Boot Section Size in *bytes* by uncommenting out the OPT_DEFS line
53# Teensy halfKay 512
54# Teensy++ halfKay 1024
55# Atmel DFU loader 4096
56# LUFA bootloader 4096
57# USBaspLoader 2048
58# OPT_DEFS += -DBOOTLOADER_SIZE=4096
59
60
61# Build Options
62# change yes to no to disable
63#
64BOOTMAGIC_ENABLE = no # Virtual DIP switch configuration(+1000)
65MOUSEKEY_ENABLE = yes # Mouse keys(+4700)
66EXTRAKEY_ENABLE = yes # Audio control and System control(+450)
67CONSOLE_ENABLE = yes # Console for debug(+400)
68COMMAND_ENABLE = yes # Commands for debug and configuration
69# Do not enable SLEEP_LED_ENABLE. it uses the same timer as BACKLIGHT_ENABLE
70SLEEP_LED_ENABLE = no # Breathing sleep LED during USB suspend
71# if this doesn't work, see here: https://github.com/tmk/tmk_keyboard/wiki/FAQ#nkro-doesnt-work
72NKRO_ENABLE = no # USB Nkey Rollover
73BACKLIGHT_ENABLE = no # Enable keyboard backlight functionality on B7 by default
74RGBLIGHT_ENABLE = no # Enable keyboard RGB underglow
75MIDI_ENABLE = no # MIDI support (+2400 to 4200, depending on config)
76UNICODE_ENABLE = no # Unicode
77BLUETOOTH_ENABLE = no # Enable Bluetooth with the Adafruit EZ-Key HID
78AUDIO_ENABLE = no # Audio output on port C6
79FAUXCLICKY_ENABLE = no # Use buzzer to emulate clicky switches
80HD44780_ENABLE = no # Enable support for HD44780 based LCDs (+400)
diff --git a/keyboards/shiro/shiro.c b/keyboards/shiro/shiro.c
new file mode 100644
index 000000000..b30329d33
--- /dev/null
+++ b/keyboards/shiro/shiro.c
@@ -0,0 +1,51 @@
1/* Copyright 2019 T.Shinohara
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 "shiro.h"
17
18// Optional override functions below.
19// You can leave any or all of these undefined.
20// These are only required if you want to perform custom actions.
21
22/*
23
24void matrix_init_kb(void) {
25 // put your keyboard start-up code here
26 // runs once when the firmware starts up
27
28 matrix_init_user();
29}
30
31void matrix_scan_kb(void) {
32 // put your looping keyboard code here
33 // runs every cycle (a lot)
34
35 matrix_scan_user();
36}
37
38bool process_record_kb(uint16_t keycode, keyrecord_t *record) {
39 // put your per-action keyboard code here
40 // runs for every action, just before processing by the firmware
41
42 return process_record_user(keycode, record);
43}
44
45void led_set_kb(uint8_t usb_led) {
46 // put your keyboard LED indicator (ex: Caps Lock LED) toggling code here
47
48 led_set_user(usb_led);
49}
50
51*/
diff --git a/keyboards/shiro/shiro.h b/keyboards/shiro/shiro.h
new file mode 100644
index 000000000..9e088ba55
--- /dev/null
+++ b/keyboards/shiro/shiro.h
@@ -0,0 +1,41 @@
1/* Copyright 2019 T.Shinohara
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#pragma once
17
18#include "quantum.h"
19
20/* This a shortcut to help you visually see your layout.
21 *
22 * The first section contains all of the arguments representing the physical
23 * layout of the board and position of the keys.
24 *
25 * The second converts the arguments into a two-dimensional array which
26 * represents the switch matrix.
27 */
28#define LAYOUT( \
29 k00, k01, k02, \
30 k10, k11, k12, \
31 k20, k21, k22, \
32 k30, k31, k32, \
33 k40, k41, k42 \
34) \
35{ \
36 { k00, k01, k02 }, \
37 { k10, k11, k12 }, \
38 { k20, k21, k22 }, \
39 { k30, k31, k32 }, \
40 { k40, k41, k42 } \
41}