Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Added /handwired/ziyoulang_k3_mod #21965

Merged
merged 8 commits into from
Oct 4, 2023
Merged
Show file tree
Hide file tree
Changes from 3 commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
139 changes: 139 additions & 0 deletions keyboards/handwired/ziyoulang_k3_mod/info.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,139 @@
{
"keyboard_name": "ziyoulang k3 mod",
"development_board": "bluepill",
"usb": {
"device_version": "1.0.0",
"pid": "0xE002",
"vid": "0x5006"
},
"features": {
"bootmagic": true,
"command": false,
"console": false,
"extrakey": true,
"mousekey": true,
"nkro": false
},
"diode_direction": "COL2ROW",
coomstoolbox marked this conversation as resolved.
Show resolved Hide resolved
"matrix_pins": {
"cols": ["B9", "B8", "B7", "B6", "B5", "B4", "B3", "A15", "A10", "A9", "A8", "B15", "B14", "B13", "B12", "B1", "B0", "A7", "A6", "A5", "A4"],
"rows": ["C14", "C15", "A0", "A1", "A2", "A3"]
},
"community_layouts": ["96_ansi"],
"layouts": {
"LAYOUT_96_ansi": {
"layout": [
{"label":"Esc", "x":0, "y":0, "matrix": [0, 0]},
{"label":"F1", "x":1, "y":0, "matrix": [0, 2]},
{"label":"F2", "x":2, "y":0, "matrix": [0, 3]},
{"label":"F3", "x":3, "y":0, "matrix": [0, 4]},
{"label":"F4", "x":4, "y":0, "matrix": [0, 5]},
{"label":"F5", "x":5, "y":0, "matrix": [0, 6]},
{"label":"F6", "x":6, "y":0, "matrix": [0, 7]},
{"label":"F7", "x":7, "y":0, "matrix": [0, 8]},
{"label":"F8", "x":8, "y":0, "matrix": [0, 9]},
{"label":"F9", "x":9, "y":0, "matrix": [0, 10]},
{"label":"F10", "x":10, "y":0, "matrix": [0, 11]},
{"label":"F11", "x":11, "y":0, "matrix": [0, 12]},
{"label":"F12", "x":12, "y":0, "matrix": [0, 13]},
{"label":"PrtSc", "x":13, "y":0, "matrix": [0, 14]},
{"label":"Delete", "x":14, "y":0, "matrix": [0, 15]},
{"label":"Home", "x":15.5, "y":0, "matrix": [0, 16]},
{"label":"Insert", "x":16.5, "y":0, "matrix": [0, 17]},
{"label":"PgUp", "x":17.5, "y":0, "matrix": [0, 18]},
{"label":"PgDn", "x":18.5, "y":0, "matrix": [0, 19]},

{"label":"~", "x":0, "y":1.25, "matrix": [1, 0]},
{"label":"!", "x":1, "y":1.25, "matrix": [1, 1]},
{"label":"@", "x":2, "y":1.25, "matrix": [1, 2]},
{"label":"#", "x":3, "y":1.25, "matrix": [1, 3]},
{"label":"$", "x":4, "y":1.25, "matrix": [1, 4]},
{"label":"%", "x":5, "y":1.25, "matrix": [1, 5]},
{"label":"^", "x":6, "y":1.25, "matrix": [1, 6]},
{"label":"&", "x":7, "y":1.25, "matrix": [1, 7]},
{"label":"*", "x":8, "y":1.25, "matrix": [1, 8]},
{"label":"(", "x":9, "y":1.25, "matrix": [1, 9]},
{"label":")", "x":10, "y":1.25, "matrix": [1, 10]},
{"label":"_", "x":11, "y":1.25, "matrix": [1, 11]},
{"label":"+", "x":12, "y":1.25, "matrix": [1, 12]},
{"label":"Backspace", "x":13, "y":1.25, "w":2, "matrix": [1, 13]},
{"label":"Num Lock", "x":15.5, "y":1.25, "matrix": [1, 17]},
{"label":"/", "x":16.5, "y":1.25, "matrix": [1, 18]},
{"label":"*", "x":17.5, "y":1.25, "matrix": [1, 19]},
{"label":"-", "x":18.5, "y":1.25, "matrix": [1, 20]},

{"label":"Tab", "x":0, "y":2.25, "w":1.5, "matrix": [2, 0]},
{"label":"Q", "x":1.5, "y":2.25, "matrix": [2, 1]},
{"label":"W", "x":2.5, "y":2.25, "matrix": [2, 2]},
{"label":"E", "x":3.5, "y":2.25, "matrix": [2, 3]},
{"label":"R", "x":4.5, "y":2.25, "matrix": [2, 4]},
{"label":"T", "x":5.5, "y":2.25, "matrix": [2, 5]},
{"label":"Y", "x":6.5, "y":2.25, "matrix": [2, 6]},
{"label":"U", "x":7.5, "y":2.25, "matrix": [2, 7]},
{"label":"I", "x":8.5, "y":2.25, "matrix": [2, 8]},
{"label":"O", "x":9.5, "y":2.25, "matrix": [2, 9]},
{"label":"P", "x":10.5, "y":2.25, "matrix": [2, 10]},
{"label":"{", "x":11.5, "y":2.25, "matrix": [2, 11]},
{"label":"}", "x":12.5, "y":2.25, "matrix": [2, 12]},
{"label":"|", "x":13.5, "y":2.25, "w":1.5, "matrix": [2, 13]},
{"label":"7", "x":15.5, "y":2.25, "matrix": [2, 17]},
{"label":"8", "x":16.5, "y":2.25, "matrix": [2, 18]},
{"label":"9", "x":17.5, "y":2.25, "matrix": [2, 19]},
{"label":"+", "x":18.5, "y":2.25, "h":2, "matrix": [2, 20]},

{"label":"Caps Lock", "x":0, "y":3.25, "w":1.75, "matrix": [3, 0]},
{"label":"A", "x":1.75, "y":3.25, "matrix": [3, 2]},
{"label":"S", "x":2.75, "y":3.25, "matrix": [3, 3]},
{"label":"D", "x":3.75, "y":3.25, "matrix": [3, 4]},
{"label":"F", "x":4.75, "y":3.25, "matrix": [3, 5]},
{"label":"G", "x":5.75, "y":3.25, "matrix": [3, 6]},
{"label":"H", "x":6.75, "y":3.25, "matrix": [3, 7]},
{"label":"J", "x":7.75, "y":3.25, "matrix": [3, 8]},
{"label":"K", "x":8.75, "y":3.25, "matrix": [3, 9]},
{"label":"L", "x":9.75, "y":3.25, "matrix": [3, 10]},
{"label":":", "x":10.75, "y":3.25, "matrix": [3, 11]},
{"label":"\"", "x":11.75, "y":3.25, "matrix": [3, 12]},
{"label":"Enter", "x":12.75, "y":3.25, "w":2.25, "matrix": [3, 13]},
{"label":"4", "x":15.5, "y":3.25, "matrix": [3, 17]},
{"label":"5", "x":16.5, "y":3.25, "matrix": [3, 18]},
{"label":"6", "x":17.5, "y":3.25, "matrix": [3, 19]},

{"label":"Shift", "x":0, "y":4.25, "w":2.25, "matrix": [4, 0]},
{"label":"Z", "x":2.25, "y":4.25, "matrix": [4, 2]},
{"label":"X", "x":3.25, "y":4.25, "matrix": [4, 3]},
{"label":"C", "x":4.25, "y":4.25, "matrix": [4, 4]},
{"label":"V", "x":5.25, "y":4.25, "matrix": [4, 5]},
{"label":"B", "x":6.25, "y":4.25, "matrix": [4, 6]},
{"label":"N", "x":7.25, "y":4.25, "matrix": [4, 7]},
{"label":"M", "x":8.25, "y":4.25, "matrix": [4, 8]},
{"label":"<", "x":9.25, "y":4.25, "matrix": [4, 9]},
{"label":">", "x":10.25, "y":4.25, "matrix": [4, 10]},
{"label":"?", "x":11.25, "y":4.25, "matrix": [4, 11]},
{"label":"Shift", "x":12.25, "y":4.25, "w":1.75, "matrix": [4, 13]},
{"label":"1", "x":15.5, "y":4.25, "matrix": [4, 17]},
{"label":"2", "x":16.5, "y":4.25, "matrix": [4, 18]},
{"label":"3", "x":17.5, "y":4.25, "matrix": [4, 19]},
{"label":"Enter", "x":18.5, "y":4.25, "h":2, "matrix": [4, 20]},

{"label":"\u2191", "x":14.25, "y":4.5, "matrix": [4, 15]},

{"label":"Ctrl", "x":0, "y":5.25, "w":1.25, "matrix": [5, 0]},
{"label":"Win", "x":1.25, "y":5.25, "w":1.25, "matrix": [5, 2]},
{"label":"Alt", "x":2.5, "y":5.25, "w":1.25, "matrix": [5, 3]},
{"x":3.75, "y":5.25, "w":6.25, "matrix": [5, 6]},
{"label":"Alt", "x":10, "y":5.25, "matrix": [5, 10]},
{"label":"Fn", "x":11, "y":5.25, "matrix": [5, 11]},
{"label":"Ctrl", "x":12, "y":5.25, "matrix": [5, 13]},
{"label":"0", "x":16.5, "y":5.25, "matrix": [5, 17]},
{"label":".", "x":17.5, "y":5.25, "matrix": [5, 19]},

{"label":"\u2190", "x":13.25, "y":5.5, "matrix": [5, 14]},
{"label":"\u2193", "x":14.25, "y":5.5, "matrix": [5, 15]},
{"label":"\u2192", "x":15.25, "y":5.5, "matrix": [5, 16]}
]
}
},
"manufacturer": "Coom",
"maintainer": "coomstoolbox",
"url": ""
}
45 changes: 45 additions & 0 deletions keyboards/handwired/ziyoulang_k3_mod/keymaps/default/keymap.c
Original file line number Diff line number Diff line change
@@ -0,0 +1,45 @@
// Copyright 2023 QMK
// SPDX-License-Identifier: GPL-2.0-or-later

#include QMK_KEYBOARD_H

const uint16_t PROGMEM keymaps[][MATRIX_ROWS][MATRIX_COLS] = {
/*
* ┌───┬───┬───┬───┬───┬───┬───┬───┬───┬───┬───┬───┬───┬───┬───┐ ┌───┬───┬───┬───┐
* │Esc│F1 │F2 │F3 │F4 │F5 │F6 │F7 │F8 │F9 │F10│F11│F12│PSc│Del│ │Hom│Ins│PgU│PgD│
* └───┴───┴───┴───┴───┴───┴───┴───┴───┴───┴───┴───┴───┴───┴───┘ └───┴───┴───┴───┘
* ┌───┬───┬───┬───┬───┬───┬───┬───┬───┬───┬───┬───┬───┬───────┐ ┌───┬───┬───┬───┐
* │ ` │ 1 │ 2 │ 3 │ 4 │ 5 │ 6 │ 7 │ 8 │ 9 │ 0 │ - │ = │ Backsp│ │Num│ / │ * │ - │
* ├───┴─┬─┴─┬─┴─┬─┴─┬─┴─┬─┴─┬─┴─┬─┴─┬─┴─┬─┴─┬─┴─┬─┴─┬─┴─┬─────┤ ├───┼───┼───┼───┤
* │ Tab │ Q │ W │ E │ R │ T │ Y │ U │ I │ O │ P │ [ │ ] │ \ │ │ 7 │ 8 │ 9 │ │
* ├─────┴┬──┴┬──┴┬──┴┬──┴┬──┴┬──┴┬──┴┬──┴┬──┴┬──┴┬──┴┬──┴─────┤ ├───┼───┼───┤ + │
* │ Caps │ A │ S │ D │ F │ G │ H │ J │ K │ L │ ; │ ' │ Enter │ │ 4 │ 5 │ 6 │ │
* ├──────┴─┬─┴─┬─┴─┬─┴─┬─┴─┬─┴─┬─┴─┬─┴─┬─┴─┬─┴─┬─┴─┬─┴────┬┬──┴┐├───┼───┼───┼───┤
* │ Shift │ Z │ X │ C │ V │ B │ N │ M │ , │ . │ / │ Shift││ ↑ ││ 1 │ 2 │ 3 │ │
* ├────┬───┴┬──┴─┬─┴───┴───┴───┴───┴───┴──┬┴──┬┴──┬┴──┬┬──┴┼───┼┴──┬┼───┼───┤Ent│
* │Ctrl│GUI │Alt │ │Alt│ Fn│Ctr││ ← │ ↓ │ → ││ 0 │ . │ │
* └────┴────┴────┴────────────────────────┴───┴───┴───┘└───┴───┴───┘└───┴───┴───┘
*/
[0] = LAYOUT_96_ansi(
KC_ESC, KC_F1, KC_F2, KC_F3, KC_F4, KC_F5, KC_F6, KC_F7, KC_F8, KC_F9, KC_F10, KC_F11, KC_F12, KC_PSCR, KC_DEL, KC_HOME, KC_INS, KC_PGUP, KC_PGDN,

KC_GRV, 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_NUM, KC_PSLS, KC_PAST, KC_PMNS,
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_P7, KC_P8, KC_P9, KC_PPLS,
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_P4, KC_P5, KC_P6,
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_P1, KC_P2, KC_P3, KC_PENT,
KC_UP,
KC_LCTL, KC_LGUI, KC_LALT, KC_SPC, KC_RALT, MO(1), KC_RCTL, KC_P0, KC_PDOT,
KC_LEFT, KC_DOWN, KC_RGHT
),
[1] = LAYOUT_96_ansi(
QK_BOOT, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, KC_END, _______, KC_SCRL, KC_PAUS,

_______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______,
_______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______,
_______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______,
_______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______,
_______,
_______, _______, _______, _______, _______, _______, _______, _______, _______,
_______, _______, _______
)
};
6 changes: 6 additions & 0 deletions keyboards/handwired/ziyoulang_k3_mod/keymaps/via/config.h
drashna marked this conversation as resolved.
Show resolved Hide resolved
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
// Copyright 2023 Coom (@coomstoolbox)
// SPDX-License-Identifier: GPL-2.0-or-later

#pragma once

#define DYNAMIC_KEYMAP_LAYER_COUNT 3
34 changes: 34 additions & 0 deletions keyboards/handwired/ziyoulang_k3_mod/keymaps/via/keymap.c
Original file line number Diff line number Diff line change
@@ -0,0 +1,34 @@
// Copyright 2023 QMK
// SPDX-License-Identifier: GPL-2.0-or-later

#include QMK_KEYBOARD_H

const uint16_t PROGMEM keymaps[][MATRIX_ROWS][MATRIX_COLS] = {
/*
* ┌───┬───┬───┬───┬───┬───┬───┬───┬───┬───┬───┬───┬───┬───┬───┐ ┌───┬───┬───┬───┐
* │Esc│F1 │F2 │F3 │F4 │F5 │F6 │F7 │F8 │F9 │F10│F11│F12│PSc│Del│ │Hom│Ins│PgU│PgD│
* └───┴───┴───┴───┴───┴───┴───┴───┴───┴───┴───┴───┴───┴───┴───┘ └───┴───┴───┴───┘
* ┌───┬───┬───┬───┬───┬───┬───┬───┬───┬───┬───┬───┬───┬───────┐ ┌───┬───┬───┬───┐
* │ ` │ 1 │ 2 │ 3 │ 4 │ 5 │ 6 │ 7 │ 8 │ 9 │ 0 │ - │ = │ Backsp│ │Num│ / │ * │ - │
* ├───┴─┬─┴─┬─┴─┬─┴─┬─┴─┬─┴─┬─┴─┬─┴─┬─┴─┬─┴─┬─┴─┬─┴─┬─┴─┬─────┤ ├───┼───┼───┼───┤
* │ Tab │ Q │ W │ E │ R │ T │ Y │ U │ I │ O │ P │ [ │ ] │ \ │ │ 7 │ 8 │ 9 │ │
* ├─────┴┬──┴┬──┴┬──┴┬──┴┬──┴┬──┴┬──┴┬──┴┬──┴┬──┴┬──┴┬──┴─────┤ ├───┼───┼───┤ + │
* │ Caps │ A │ S │ D │ F │ G │ H │ J │ K │ L │ ; │ ' │ Enter │ │ 4 │ 5 │ 6 │ │
* ├──────┴─┬─┴─┬─┴─┬─┴─┬─┴─┬─┴─┬─┴─┬─┴─┬─┴─┬─┴─┬─┴─┬─┴────┬┬──┴┐├───┼───┼───┼───┤
* │ Shift │ Z │ X │ C │ V │ B │ N │ M │ , │ . │ / │ Shift││ ↑ ││ 1 │ 2 │ 3 │ │
* ├────┬───┴┬──┴─┬─┴───┴───┴───┴───┴───┴──┬┴──┬┴──┬┴──┬┬──┴┼───┼┴──┬┼───┼───┤Ent│
* │Ctrl│GUI │Alt │ │Alt│ Fn│Ctr││ ← │ ↓ │ → ││ 0 │ . │ │
* └────┴────┴────┴────────────────────────┴───┴───┴───┘└───┴───┴───┘└───┴───┴───┘
*/
[0] = LAYOUT_96_ansi(
KC_ESC, KC_F1, KC_F2, KC_F3, KC_F4, KC_F5, KC_F6, KC_F7, KC_F8, KC_F9, KC_F10, KC_F11, KC_F12, KC_PSCR, KC_DEL, KC_HOME, KC_INS, KC_PGUP, KC_PGDN,

KC_GRV, 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_NUM, KC_PSLS, KC_PAST, KC_PMNS,
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_P7, KC_P8, KC_P9, KC_PPLS,
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_P4, KC_P5, KC_P6,
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_P1, KC_P2, KC_P3, KC_PENT,
KC_UP,
KC_LCTL, KC_LGUI, KC_LALT, KC_SPC, KC_RALT, MO(1), KC_RCTL, KC_P0, KC_PDOT,
KC_LEFT, KC_DOWN, KC_RGHT
)
};
5 changes: 5 additions & 0 deletions keyboards/handwired/ziyoulang_k3_mod/keymaps/via/rules.mk
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
VIA_ENABLE = yes
# Blue Pill STM32F103C6T6 which only has 22KB of available space.
# In order to reduce the size of Firmware, disabling mousekey and via LTO were necessary.
MOUSEKEY_ENABLE = no
LTO_ENABLE = yes
coomstoolbox marked this conversation as resolved.
Show resolved Hide resolved
32 changes: 32 additions & 0 deletions keyboards/handwired/ziyoulang_k3_mod/readme.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,32 @@
# ziyoulang_k3_mod

![ziyoulang_k3_mod](https://i.imgur.com/z9mUvIoh.jpg)

*This is a modifier to replace the Ziyoulang K3 keyboard controller with QMK.*
coomstoolbox marked this conversation as resolved.
Show resolved Hide resolved

This base keyboard has SX83099 IC causes some problems. I needed QMK as an alternative, especially since the controller freezes when the backlight is off.

* Keyboard Maintainer: [Coom](https://github.com/coomstoolbox)
* Hardware Supported: Ziyoulang K3,Blue Pill
* Hardware Availability: [Base Keyboard](https://www.aliexpress.com/item/1005005458088199.html), [Blue Pill Board](https://www.aliexpress.com/item/32812837487.html)

Make example for this keyboard (after setting up your build environment):

make handwired/ziyoulang_k3_mod:default

Flashing example for this keyboard:

make handwired/ziyoulang_k3_mod:default:flash

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).

## Requires hand wired

![explanation](https://i.imgur.com/yvhvhoBh.png)

## Bootloader

Enter the bootloader in 2 ways:

* **Bootmagic reset**: Hold down the key at (0,0) in the matrix (usually the top left key or Escape) and plug in the keyboard
* **Keycode in layout**: Press the key mapped to `QK_BOOT` if it is available
1 change: 1 addition & 0 deletions keyboards/handwired/ziyoulang_k3_mod/rules.mk
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
# This file intentionally left blank