3cda9ffcd65cd8d08039e389e3888eb493bd69e2

Author
Christian C. Berclaz <christian.berclaz@mac.com>
Committer
GitHub <noreply@github.com>
Date

Message

Adding support for Windstudio's Wind X R1 keyboard (#24564)

* Added a default firmware and layout for the WindStudio Wind X R1
keyboard.

* Wind X R1: cleaned-up the folders to make clear that this firmware is
for the release 1 of this keyboard.

* Added rules.mk to the default layout

* Renamed the folder R1 into r1.

* Added readme.md files for the keyboard and default layout.

* Added a license header to keymap.c

* Update keyboards/windstudio/wind_x/r1/keyboard.json

Co-authored-by: jack <jack@pngu.org>

* Update keyboards/windstudio/wind_x/r1/keyboard.json

Co-authored-by: jack <jack@pngu.org>

* Update keyboards/windstudio/wind_x/r1/keymaps/default/keymap.c

Co-authored-by: jack <jack@pngu.org>

* Update keyboards/windstudio/wind_x/r1/readme.md

Co-authored-by: jack <jack@pngu.org>

* Added a proper link to the image (logo of windstudio)

* Wind X R1
- Corrected the default keymap with the QK_GESC key instead of the
  KC_ESC.
- Removed the unnecessary rules.mk in the default layout

* Wind X R1:
applied `qmk format-json -i` on keyboard.json to conform with the
project formatt standards.

* Added a picture of the keyboard.

* Added a caption to the image.

---------

Co-authored-by: jack <jack@pngu.org>

Diff

This diff is truncated to protect this page.

  1diff --git a/keyboards/windstudio/wind_x/r1/keyboard.json b/keyboards/windstudio/wind_x/r1/keyboard.json
  2new file mode 100644
  3index 0000000000000000000000000000000000000000..1b5f34fe3e80702250e2fc14718524f717de54e5
  4--- /dev/null
  5+++ b/keyboards/windstudio/wind_x/r1/keyboard.json
  6@@ -0,0 +1,205 @@
  7+{
  8+    "manufacturer": "Windstudio",
  9+    "keyboard_name": "Wind X R1",
 10+    "maintainer": "chrisgve",
 11+    "bootloader": "atmel-dfu",
 12+    "diode_direction": "COL2ROW",
 13+    "features": {
 14+        "bootmagic": true,
 15+        "extrakey": true,
 16+        "mousekey": true,
 17+        "nkro": true
 18+    },
 19+    "matrix_pins": {
 20+        "cols": ["C7", "C6", "B6", "E6", "F6", "D6", "D7", "B4", "B5", "F7", "B7", "F4", "F5", "D4", "B0", "B1", "B2", "B3"],
 21+        "rows": ["F0", "F1", "D2", "D1", "D0"]
 22+    },
 23+    "processor": "atmega32u4",
 24+    "url": "",
 25+    "usb": {
 26+        "device_version": "0.0.1",
 27+        "pid": "0x6801",
 28+        "vid": "0x6F75"
 29+    },
 30+    "layout_aliases": {
 31+        "LAYOUT_tsangan": "LAYOUT_7u_space_bar_split_bs"
 32+    },
 33+    "layouts": {
 34+        "LAYOUT": {
 35+            "layout": [
 36+                {"label": "Esc", "matrix": [0, 0], "x": 0, "y": 0},
 37+                {"label": "1", "matrix": [0, 1], "x": 1, "y": 0},
 38+                {"label": "2", "matrix": [0, 2], "x": 2, "y": 0},
 39+                {"label": "3", "matrix": [0, 3], "x": 3, "y": 0},
 40+                {"label": "4", "matrix": [0, 4], "x": 4, "y": 0},
 41+                {"label": "5", "matrix": [0, 5], "x": 5, "y": 0},
 42+                {"label": "6", "matrix": [0, 6], "x": 6, "y": 0},
 43+                {"label": "7", "matrix": [0, 7], "x": 7, "y": 0},
 44+                {"label": "8", "matrix": [0, 8], "x": 8, "y": 0},
 45+                {"label": "9", "matrix": [0, 9], "x": 9, "y": 0},
 46+                {"label": "0", "matrix": [0, 10], "x": 10, "y": 0},
 47+                {"label": "-", "matrix": [0, 11], "x": 11, "y": 0},
 48+                {"label": "=", "matrix": [0, 12], "x": 12, "y": 0},
 49+                {"label": "Backspace", "matrix": [0, 13], "x": 13, "y": 0, "w": 2},
 50+                {"label": "Del", "matrix": [4, 11], "x": 16, "y": 0},
 51+                {"label": "NumLock", "matrix": [0, 14], "x": 18, "y": 0},
 52+                {"label": "KP/", "matrix": [0, 15], "x": 19, "y": 0},
 53+                {"label": "KP*", "matrix": [0, 16], "x": 20, "y": 0},
 54+                {"label": "KP-", "matrix": [0, 17], "x": 21, "y": 0},
 55+                {"label": "Tab", "matrix": [1, 0], "x": 0, "y": 1, "w": 1.5},
 56+                {"label": "Q", "matrix": [1, 1], "x": 1.5, "y": 1},
 57+                {"label": "W", "matrix": [1, 2], "x": 2.5, "y": 1},
 58+                {"label": "E", "matrix": [1, 3], "x": 3.5, "y": 1},
 59+                {"label": "R", "matrix": [1, 4], "x": 4.5, "y": 1},
 60+                {"label": "T", "matrix": [1, 5], "x": 5.5, "y": 1},
 61+                {"label": "Y", "matrix": [1, 6], "x": 6.5, "y": 1},
 62+                {"label": "U", "matrix": [1, 7], "x": 7.5, "y": 1},
 63+                {"label": "I", "matrix": [1, 8], "x": 8.5, "y": 1},
 64+                {"label": "O", "matrix": [1, 9], "x": 9.5, "y": 1},
 65+                {"label": "P", "matrix": [1, 10], "x": 10.5, "y": 1},
 66+                {"label": "[", "matrix": [1, 11], "x": 11.5, "y": 1},
 67+                {"label": "]", "matrix": [1, 12], "x": 12.5, "y": 1},
 68+                {"label": "\\", "matrix": [2, 12], "x": 13.5, "y": 1, "w": 1.5},
 69+                {"label": "PgUp", "matrix": [4, 12], "x": 16, "y": 1},
 70+                {"label": "KP7", "matrix": [1, 14], "x": 18, "y": 1},
 71+                {"label": "KP8", "matrix": [1, 15], "x": 19, "y": 1},
 72+                {"label": "KP9", "matrix": [1, 16], "x": 20, "y": 1},
 73+                {"label": "KP+", "matrix": [1, 17], "x": 21, "y": 1},
 74+                {"label": "Caps", "matrix": [2, 0], "x": 0, "y": 2, "w": 1.75},
 75+                {"label": "A", "matrix": [2, 1], "x": 1.75, "y": 2},
 76+                {"label": "S", "matrix": [2, 2], "x": 2.75, "y": 2},
 77+                {"label": "D", "matrix": [2, 3], "x": 3.75, "y": 2},
 78+                {"label": "F", "matrix": [2, 4], "x": 4.75, "y": 2},
 79+                {"label": "G", "matrix": [2, 5], "x": 5.75, "y": 2},
 80+                {"label": "H", "matrix": [2, 6], "x": 6.75, "y": 2},
 81+                {"label": "J", "matrix": [2, 7], "x": 7.75, "y": 2},
 82+                {"label": "K", "matrix": [2, 8], "x": 8.75, "y": 2},
 83+                {"label": "L", "matrix": [2, 9], "x": 9.75, "y": 2},
 84+                {"label": ";", "matrix": [2, 10], "x": 10.75, "y": 2},
 85+                {"label": "'", "matrix": [2, 11], "x": 11.75, "y": 2},
 86+                {"label": "Return", "matrix": [2, 13], "x": 12.75, "y": 2, "w": 2.25},
 87+                {"label": "PgDn", "matrix": [4, 13], "x": 16, "y": 2},
 88+                {"label": "KP4", "matrix": [2, 14], "x": 18, "y": 2},
 89+                {"label": "KP5", "matrix": [2, 15], "x": 19, "y": 2},
 90+                {"label": "KP6", "matrix": [2, 16], "x": 20, "y": 2},
 91+                {"label": "KP+", "matrix": [2, 17], "x": 21, "y": 2},
 92+                {"label": "Shift", "matrix": [3, 0], "x": 0, "y": 3, "w": 2.25},
 93+                {"label": "Z", "matrix": [3, 2], "x": 2.25, "y": 3},
 94+                {"label": "X", "matrix": [3, 3], "x": 3.25, "y": 3},
 95+                {"label": "C", "matrix": [3, 4], "x": 4.25, "y": 3},
 96+                {"label": "V", "matrix": [3, 5], "x": 5.25, "y": 3},
 97+                {"label": "B", "matrix": [3, 6], "x": 6.25, "y": 3},
 98+                {"label": "N", "matrix": [3, 7], "x": 7.25, "y": 3},
 99+                {"label": "M", "matrix": [3, 8], "x": 8.25, "y": 3},
100+                {"label": ",", "matrix": [3, 9], "x": 9.25, "y": 3},
101+                {"label": ".", "matrix": [3, 10], "x": 10.25, "y": 3},
102+                {"label": "/", "matrix": [3, 11], "x": 11.25, "y": 3},
103+                {"label": "Shift", "matrix": [3, 12], "x": 12.25, "y": 3, "w": 1.75},
104+                {"label": "Up", "matrix": [3, 13], "x": 13, "y": 3},
105+                {"label": "KP1", "matrix": [3, 14], "x": 18, "y": 3},
106diff --git a/keyboards/windstudio/wind_x/r1/keymaps/default/keymap.c b/keyboards/windstudio/wind_x/r1/keymaps/default/keymap.c
107new file mode 100644
108index 0000000000000000000000000000000000000000..dd3134e2a0f6421f48c2e640de409f8656c07533
109--- /dev/null
110+++ b/keyboards/windstudio/wind_x/r1/keymaps/default/keymap.c
111@@ -0,0 +1,40 @@
112+/* Copyright 2024 chrisgve
113+ *
114+ * This program is free software: you can redistribute it and/or modify
115+ * it under the terms of the GNU General Public License as published by
116+ * the Free Software Foundation, either version 2 of the License, or
117+ * (at your option) any later version.
118+ *
119+ * This program is distributed in the hope that it will be useful,
120+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
121+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
122+ * GNU General Public License for more details.
123+ *
124+ * You should have received a copy of the GNU General Public License
125+ * along with this program.  If not, see <http://www.gnu.org/licenses/>.
126+ */
127+
128+#include QMK_KEYBOARD_H
129+
130+// clang-format off
131+const uint16_t PROGMEM keymaps[][MATRIX_ROWS][MATRIX_COLS] = {
132+
133+	[0] = LAYOUT(
134+        QK_GESC, KC_1,    KC_2,    KC_3,    KC_4,    KC_5,    KC_6,    KC_7,    KC_8,    KC_9,    KC_0,    KC_MINS, KC_EQL,  KC_BSPC,   KC_DEL,   KC_NUM,  KC_PSLS, KC_PAST, KC_PMNS,
135+        KC_TAB,  KC_Q,    KC_W,    KC_E,    KC_R,    KC_T,    KC_Y,    KC_U,    KC_I,    KC_O,    KC_P,    KC_LBRC, KC_RBRC, KC_BSLS,   KC_PGUP,  KC_P7,   KC_P8,   KC_P9,   KC_PPLS,
136+        KC_CAPS, KC_A,    KC_S,    KC_D,    KC_F,    KC_G,    KC_H,    KC_J,    KC_K,    KC_L,    KC_SCLN, KC_QUOT, KC_ENT,             KC_PGDN,  KC_P4,   KC_P5,   KC_P6,   KC_PPLS,
137+        KC_LSFT, KC_Z,    KC_X,    KC_C,    KC_V,    KC_B,    KC_N,    KC_M,    KC_COMM, KC_DOT,  KC_SLSH, KC_RSFT, KC_UP,                        KC_P1,   KC_P2,   KC_P3,   KC_PENT,
138+        KC_LCTL, KC_LGUI, KC_LALT,                   LT(1, KC_SPC),                      KC_RGUI, KC_RCTL, KC_LEFT, KC_DOWN, KC_RGHT,             KC_P0,   KC_PDOT
139+    ),
140+
141+	[1] = LAYOUT(
142+        _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______,   _______,   _______, _______, _______, _______,
143+        QK_BOOT, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______,   _______,   _______, _______, _______, _______,
144+        _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______,            _______,   _______, _______, _______, _______,
145+        _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______,                       _______, _______, _______, _______,
146+        _______, _______, _______,                   _______,                            _______, _______, _______, _______, _______,              _______, _______
147+    )
148+
149+};
150+
151+// clang-format on
152diff --git a/keyboards/windstudio/wind_x/r1/keymaps/default/readme.md b/keyboards/windstudio/wind_x/r1/keymaps/default/readme.md
153new file mode 100644
154index 0000000000000000000000000000000000000000..2fa0952a83028ec8ef0b68887417c777e0016e7d
155--- /dev/null
156+++ b/keyboards/windstudio/wind_x/r1/keymaps/default/readme.md
157@@ -0,0 +1,6 @@
158+# Default Wind X R1 Layout
159+
160+This is the default layout that comes flashed on every Wind X R1. For the most
161+part it's a straightforward and easy to follow layout. The only unusual key is
162+the key in the upper left, which sends Escape normally, but Grave when any of
163+the Ctrl, Alt, or GUI modifiers are held down.
164diff --git a/keyboards/windstudio/wind_x/r1/readme.md b/keyboards/windstudio/wind_x/r1/readme.md
165new file mode 100644
166index 0000000000000000000000000000000000000000..c501951e4222de2d6eb26bc0138094aadcbab86c
167--- /dev/null
168+++ b/keyboards/windstudio/wind_x/r1/readme.md
169@@ -0,0 +1,28 @@
170+# WindX R1 by Windstudio
171+
172+![WindX R1](https://i.imgur.com/FEVczwG.jpg)
173+_Compact, yet feature full working or gaming keyboard_
174+
175+A large layout keyboard without the function keys. [More info on geekhack.org](https://geekhack.org/index.php?topic=114767.0)
176+
177+-   Keyboard Maintainer: [Christian C. Berclaz](https://github.com/chrisgve)
178+-   Hardware Supported: Wind X R1 w/ ATmega32U4 microcontroller
179+-   Hardware Availability: [windstudio.store](https://windstudio.store/collections/wind-x)
180+
181+Make example for this keyboard (after setting up your build environment):
182+
183+    make windstudio/wind_x/r1:default
184+
185+Flashing example for this keyboard:
186+
187+    make windstudio/wind_x/r1:default:flash
188+
189+See the [build environment setup](getting_started_build_tools) and the [make instructions](getting_started_make_guide) for more information. Brand new to QMK? Start with our [Complete Newbs Guide](newbs).
190+
191+## Bootloader
192+
193+Enter the bootloader in 3 ways:
194+
195+-   **Bootmagic reset**: Hold down the key at (0,0) in the matrix (usually the top left key or Escape) and plug in the keyboard
196+-   **Physical reset button**: Briefly press the button on the back of the PCB - some may have pads you must short instead
197+-   **Keycode in layout**: Press the key mapped to `QK_BOOT` if it is available