summaryrefslogtreecommitdiffstats
path: root/keyboards/xiudi/xd004
diff options
context:
space:
mode:
authorpeepeetee <43021794+peepeetee@users.noreply.github.com>2021-08-21 22:53:49 -0500
committerGitHub <noreply@github.com>2021-08-22 13:53:49 +1000
commit78ccd9c201199444bc06161b05ee8d7ba9c31613 (patch)
tree726d9e55d8cde510fe72bc1fb9bb2a7dabdbecc2 /keyboards/xiudi/xd004
parentc70abc8d047319830e369ae4e14cd43bae3bd3b8 (diff)
Organize KPrepublic, K.T.E.C, xiudi boards into directories (#12159)
* reset; redoing my steps; and recommit * include xd002/.noci
Diffstat (limited to 'keyboards/xiudi/xd004')
-rw-r--r--keyboards/xiudi/xd004/info.json11
-rw-r--r--keyboards/xiudi/xd004/keymaps/default/keymap.c13
-rw-r--r--keyboards/xiudi/xd004/keymaps/default/readme.md7
-rw-r--r--keyboards/xiudi/xd004/keymaps/narze/keymap.c24
-rw-r--r--keyboards/xiudi/xd004/keymaps/narze/readme.md13
-rw-r--r--keyboards/xiudi/xd004/keymaps/system_and_media/keymap.c59
-rw-r--r--keyboards/xiudi/xd004/keymaps/system_and_media/readme.md9
-rw-r--r--keyboards/xiudi/xd004/readme.md30
-rw-r--r--keyboards/xiudi/xd004/v1/config.h79
-rw-r--r--keyboards/xiudi/xd004/v1/rules.mk31
-rw-r--r--keyboards/xiudi/xd004/xd004.c7
-rw-r--r--keyboards/xiudi/xd004/xd004.h15
12 files changed, 298 insertions, 0 deletions
diff --git a/keyboards/xiudi/xd004/info.json b/keyboards/xiudi/xd004/info.json
new file mode 100644
index 0000000000..6f7082a14b
--- /dev/null
+++ b/keyboards/xiudi/xd004/info.json
@@ -0,0 +1,11 @@
+{
+ "keyboard_name": "XD004",
+ "maintainer": "qmk",
+ "width": 4,
+ "height": 1,
+ "layouts": {
+ "LAYOUT_all": {
+ "layout": [{"label":"L", "x":0, "y":0}, {"label":"O", "x":1, "y":0}, {"label":"V", "x":2, "y":0}, {"label":"E", "x":3, "y":0}]
+ }
+ }
+}
diff --git a/keyboards/xiudi/xd004/keymaps/default/keymap.c b/keyboards/xiudi/xd004/keymaps/default/keymap.c
new file mode 100644
index 0000000000..e82ce5e973
--- /dev/null
+++ b/keyboards/xiudi/xd004/keymaps/default/keymap.c
@@ -0,0 +1,13 @@
+#include QMK_KEYBOARD_H
+
+const uint16_t PROGMEM keymaps[][MATRIX_ROWS][MATRIX_COLS] = {
+
+ // 0: Base Layer
+ LAYOUT_all(KC_L, KC_O, KC_V, KC_E),
+
+};
+
+// Loop
+void matrix_scan_user(void){
+ // Empty
+};
diff --git a/keyboards/xiudi/xd004/keymaps/default/readme.md b/keyboards/xiudi/xd004/keymaps/default/readme.md
new file mode 100644
index 0000000000..fdf07cc877
--- /dev/null
+++ b/keyboards/xiudi/xd004/keymaps/default/readme.md
@@ -0,0 +1,7 @@
+# Default Keymap for XD004 PCB
+
+This keymap is not very useful, but it will validate that the board works.
+
+## Build
+
+To build the default keymap, simply run `make xd004:default`.
diff --git a/keyboards/xiudi/xd004/keymaps/narze/keymap.c b/keyboards/xiudi/xd004/keymaps/narze/keymap.c
new file mode 100644
index 0000000000..30ea48d683
--- /dev/null
+++ b/keyboards/xiudi/xd004/keymaps/narze/keymap.c
@@ -0,0 +1,24 @@
+/* Copyright 2021 narze
+ *
+ * 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: Base Layer
+ LAYOUT_all(HYPR(KC_F2), HYPR(KC_F1), LCTL(KC_B), LCTL(KC_X)),
+
+};
diff --git a/keyboards/xiudi/xd004/keymaps/narze/readme.md b/keyboards/xiudi/xd004/keymaps/narze/readme.md
new file mode 100644
index 0000000000..6f4bca9a90
--- /dev/null
+++ b/keyboards/xiudi/xd004/keymaps/narze/readme.md
@@ -0,0 +1,13 @@
+# narze Keymap for XD004 PCB
+
+(Key 1 is on the opposite of USB port side, so I flip the keys to make usb port be on the left)
+
+- Key 1 : Hyper + F2
+- Key 2 : Hyper + F1
+- Key 3 : Ctrl + B (Microphone : Toggle mute)
+- Key 4 : Ctrl + X (Microphone : Push to talk)
+
+## Build & Flash
+
+- Put this board in DFU : bridge the last two pins (#5 & 6) of the 6-pin "J2" header on the opposite edge of the board to the USB port.
+- `make xd004/v1:narze:flash` or `qmk flash -kb xd004/v1 -km narze`
diff --git a/keyboards/xiudi/xd004/keymaps/system_and_media/keymap.c b/keyboards/xiudi/xd004/keymaps/system_and_media/keymap.c
new file mode 100644
index 0000000000..60f0e15bbe
--- /dev/null
+++ b/keyboards/xiudi/xd004/keymaps/system_and_media/keymap.c
@@ -0,0 +1,59 @@
+#include QMK_KEYBOARD_H
+
+#define _BASE 0 // Base layer
+#define _SYSTEM 1 // System actions
+#define _VOLUME 2 // Volume actions
+
+#define SUPER_ALT_F4_TIMER 300 // Timeout on the super alt-f4 key
+
+/*
+ The idea of this is pretty simple: base layer has four action, two of which (the outermost)
+ are regular keystrokes on tap, and a momentary layer switch on hold, sending you to layers 1 and 2.
+
+ The other bit of customization here is the 'Super Alt F4' which does Alt-F4, and then Enter if tapped
+ again SUPER_ALT_F4_TIMER miliseconds after. This lets you Alt-F4 applications, and finally quickly
+ double-tap it to Alt-F4+Enter to shut down the PC.
+*/
+
+bool is_alt_f4_active = false;
+uint16_t alt_f4_timer = 0;
+
+enum custom_keycodes { // Make sure have the awesome keycode ready
+ SUPER_ALT_F4 = SAFE_RANGE,
+};
+
+const uint16_t PROGMEM keymaps[][MATRIX_ROWS][MATRIX_COLS] = {
+
+ // 0: Base Layer
+ [_BASE] = LAYOUT_all(LT(_SYSTEM, KC_F5), C(G(KC_LEFT)), C(G(KC_RIGHT)), LT(_VOLUME, KC_F7)),
+
+ // 1: System actions
+ [_SYSTEM] = LAYOUT_all(_______, SUPER_ALT_F4, G(KC_D), G(KC_L)),
+
+ // 2: Volume actions
+ [_VOLUME] = LAYOUT_all(KC_MEDIA_NEXT_TRACK, KC_AUDIO_VOL_DOWN, KC_AUDIO_VOL_UP, _______),
+
+};
+
+bool process_record_user(uint16_t keycode, keyrecord_t *record) {
+ switch (keycode) { // This will do most of the grunt work with the keycodes.
+ case SUPER_ALT_F4:
+ if (record->event.pressed) {
+ if (!is_alt_f4_active) {
+ is_alt_f4_active = true;
+ tap_code16(LALT(KC_F4)); // Alt-F4
+ } else {
+ tap_code(KC_ENTER); // Tap enter
+ }
+ }
+ alt_f4_timer = timer_read();
+ break;
+ }
+ return true;
+}
+
+void matrix_scan_user(void) {
+ if (is_alt_f4_active && timer_elapsed(alt_f4_timer) > SUPER_ALT_F4_TIMER) {
+ is_alt_f4_active = false;
+ }
+};
diff --git a/keyboards/xiudi/xd004/keymaps/system_and_media/readme.md b/keyboards/xiudi/xd004/keymaps/system_and_media/readme.md
new file mode 100644
index 0000000000..d684d463c6
--- /dev/null
+++ b/keyboards/xiudi/xd004/keymaps/system_and_media/readme.md
@@ -0,0 +1,9 @@
+# Slightly more advanced keymap for XD004 PCB
+
+A somehow more useful keymap, allowing one to move across virtual desktops on Windows, etc.
+
+It also has a 'Super Alt-F4' key for Windows that, when tapped does Alt-F4, unless two consecutive taps are less than 300ms apart, in which case the second tap becomes Enter. This allows you to close all apps doing taps, and then when the System shutdown window arrives you do a second quick tap and it will type enter, thus shutting down the computer.
+
+## Build
+
+To build the keymap, simply run `make xd004:system_and_media`.
diff --git a/keyboards/xiudi/xd004/readme.md b/keyboards/xiudi/xd004/readme.md
new file mode 100644
index 0000000000..8f858a8411
--- /dev/null
+++ b/keyboards/xiudi/xd004/readme.md
@@ -0,0 +1,30 @@
+XD004
+==
+
+4-keys board
+
+![Top View of a XD004 board](https://ae01.alicdn.com/kf/HTB1_G9IX21H3KVjSZFHq6zKppXa0/xd004-xiudi-4-Custom-Mechanical-Keyboard-4-keys-switch-leds-PCB-programmed-hot-swappable-macro-key.jpg)
+
+Keyboard Maintainer: QMK Community
+Hardware Supported: XD004 PCB v1.0
+Hardware Availability: [KPRepublic](https://kprepublic.com/products/xd004-xiudi-4-custom-mechanical-keyboard-4-keys-switch-leds-pcb-programmed-hot-swappable-macro-key-silver-case-micro-port)
+
+To put this board in DFU (firmware update) mode, bridge the last two pins (#5 & 6) of the 6-pin "J2" header on the opposite edge of the board to the USB port"
+```
+----+
+ J2 |
+[o] |
+(o) |
+(o) |
+(o) |
+(o)-+-\ (These
+(o)-+-/ two)
+ |
+----+
+```
+
+To build with a default keymap (not useful at all, have a look at other keymaps):
+
+```make xd004/v1: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).
diff --git a/keyboards/xiudi/xd004/v1/config.h b/keyboards/xiudi/xd004/v1/config.h
new file mode 100644
index 0000000000..30f837b8ce
--- /dev/null
+++ b/keyboards/xiudi/xd004/v1/config.h
@@ -0,0 +1,79 @@
+/*
+Copyright 2019 Sidney Bovet <sidney.bovet@gmail.com>
+
+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/>.
+*/
+
+/*
+Note: the following configuration uses 98% of the flash memory, be
+careful if you enable anything else. Also have a look at rules.mk
+where some things are disabled to save space as well.
+*/
+
+#pragma once
+
+#include "config_common.h"
+
+/* USB Device descriptor parameter */
+#define VENDOR_ID 0x7844 // "XD"
+#define PRODUCT_ID 0x0404
+#define DEVICE_VER 0x0001
+// Note: unsure about manufacturer
+#define MANUFACTURER XIUDI
+#define PRODUCT XD004 v1
+
+/* key matrix size */
+#define MATRIX_ROWS 1
+#define MATRIX_COLS 4
+
+/*
+ * Keyboard Matrix Assignments
+ *
+ * On this board we have direct connection: no diodes.
+ */
+#define DIRECT_PINS \
+ { \
+ { D3, D0, C4, B4 } \
+ }
+#define UNUSED_PINS
+
+/* Backlight Setup */
+// Looks like each backlight LED is connected to a single output, D5 is the one furtherst away from USB port
+#define BACKLIGHT_PIN D5
+#define BACKLIGHT_LEVELS 6
+
+/* COL2ROW or ROW2COL */
+#define DIODE_DIRECTION COL2ROW
+
+/* Debounce reduces chatter (unintended double-presses) - set 0 if debouncing is not needed */
+#define DEBOUNCE 5
+
+/* RGB Underglow
+This will not be used, as RGBLIGHT_ENABLE is set to 'no' in rules.mk
+We do not have enough space in the flash for this at the moment, maybe
+further optimizations can be done on that side.
+*/
+#define RGB_DI_PIN C6
+#define RGBLIGHT_EFFECT_STATIC_GRADIENT
+#define RGBLIGHT_EFFECT_RAINBOW_SWIRL
+#define RGBLED_NUM 2
+#define RGBLIGHT_HUE_STEP 10
+#define RGBLIGHT_SAT_STEP 17
+#define RGBLIGHT_VAL_STEP 17
+
+/* disable action features */
+// #define NO_ACTION_ONESHOT // 462 bytes <- this needs to be un-commented out if Link Time Optimization is disabled, otherwise file is too large
+// The two below are implicit since we use LTO_ENABLE (in rules.mk)
+// #define NO_ACTION_MACRO
+// #define NO_ACTION_FUNCTION
diff --git a/keyboards/xiudi/xd004/v1/rules.mk b/keyboards/xiudi/xd004/v1/rules.mk
new file mode 100644
index 0000000000..d5d270f3f7
--- /dev/null
+++ b/keyboards/xiudi/xd004/v1/rules.mk
@@ -0,0 +1,31 @@
+# MCU name
+MCU = atmega16u2
+
+# 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
+BOOTMAGIC_ENABLE = lite # Enable Bootmagic Lite
+MOUSEKEY_ENABLE = no # Mouse keys
+EXTRAKEY_ENABLE = yes # Audio control and System control
+CONSOLE_ENABLE = no # Console for debug
+COMMAND_ENABLE = no # Commands for debug and configuration
+NKRO_ENABLE = no # Nkey Rollover - if this doesn't work, see here: https://github.com/tmk/tmk_keyboard/wiki/FAQ#nkro-doesnt-work
+BACKLIGHT_ENABLE = no # Enable keyboard backlight functionality
+AUDIO_ENABLE = no # Audio output on port C6
+UNICODE_ENABLE = no # Unicode
+BLUETOOTH_ENABLE = no # Enable Bluetooth with the Adafruit EZ-Key HID
+RGBLIGHT_ENABLE = no # Enable WS2812 RGB underlight.
+SLEEP_LED_ENABLE = no # Breathing sleep LED during USB suspend
+SPACE_CADET_ENABLE = no
+# Saves about 5% of space:
+LTO_ENABLE = yes
+
+#LAYOUTS = ortho_1x4
diff --git a/keyboards/xiudi/xd004/xd004.c b/keyboards/xiudi/xd004/xd004.c
new file mode 100644
index 0000000000..37a1dca144
--- /dev/null
+++ b/keyboards/xiudi/xd004/xd004.c
@@ -0,0 +1,7 @@
+#include "xd004.h"
+
+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);
+}
diff --git a/keyboards/xiudi/xd004/xd004.h b/keyboards/xiudi/xd004/xd004.h
new file mode 100644
index 0000000000..a53ad537f7
--- /dev/null
+++ b/keyboards/xiudi/xd004/xd004.h
@@ -0,0 +1,15 @@
+#pragma once
+
+#include "quantum.h"
+//#include "led.h"
+
+/* XD60 Keymap Definition Macro */
+/*
+ +--------------------------------+
+ | K0 K1 K2 K3 [----- USB
+ +--------------------------------+
+*/
+#define LAYOUT_all(K00, K01, K02, K03) \
+ { \
+ { K00, K01, K02, K03 } \
+ }