fern/qmk-firmware
1
0
Fork 0
mirror of https://github.com/firewalkwithm3/qmk_firmware.git synced 2024-11-22 19:40:29 +08:00
Code Issues Actions 2 Packages Projects Releases Wiki Activity

Quarkeys Z40 Community Layout Support and Touch-Up (#21329)

Browse source 
* [refactor] rename LAYOUT to LAYOUT_planck_mit

* [style] friendly-format info.json

* [style] refactor keymaps

- grid-align keycodes
- use four-space indent
- remove trailing whitespace

* [chore] tidy-up keyboard data in info.json

- spell-check `manufacturer` value
- use valid `url`
- reference GitHub username for `maintainer`

* [chore] tidy-up readme

- link to maintainer's GitHub account
- add Hardware Availability link
- break-out Hardware Specs into its own section

* [enhancement] enable Community Layout support

* [chore] replace product image in readme

Source repository for previous URL seems to have been deleted.
This commit is contained in:
James Young 2023-06-21 19:11:32 -07:00 committed by GitHub
parent b8a12db1a1
commit 33f76d79d4
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
4 changed files with 75 additions and 66 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

32
keyboards/quarkeys/z40/info.json
View file

@ -1,31 +1,37 @@
{ {
"keyboard_name": "Z40 Ortho", "keyboard_name": "Z40 Ortho",
"manufacturer": "Quarkeys Stuidio", "manufacturer": "Quarkeys Studio",
"url": "www.quarkeys.com", "url": "https://www.quarkeys.com/",
"maintainer": "TommyZ", "maintainer": "tommyamoszhao",
"usb": { "usb": {
"vid": "0x8490", "vid": "0x8490",
"pid": "0x2801", "pid": "0x2801",
"device_version": "0.0.1" "device_version": "0.0.1"
}, },
"rgb_matrix": { "rgb_matrix": {
"driver": "WS2812" "driver": "WS2812"
}, },
"rgblight": { "rgblight": {
"max_brightness": 130 "max_brightness": 130
}, },
"matrix_pins": { "matrix_pins": {
"cols": ["F4", "F5", "F6", "F7", "B6", "B5", "B4", "D7", "D6", "D0", "B1", "B0"], "cols": ["F4", "F5", "F6", "F7", "B6", "B5", "B4", "D7", "D6", "D0", "B1", "B0"],
"rows": ["E6", "B3", "C7", "C6"] "rows": ["E6", "B3", "C7", "C6"]
}, },
"ws2812": { "ws2812": {
"pin": "F1" "pin": "F1"
}, },
"diode_direction": "COL2ROW", "diode_direction": "COL2ROW",
"processor": "atmega32u4", "processor": "atmega32u4",
"bootloader": "atmel-dfu", "bootloader": "atmel-dfu",
"layout_aliases": {
"LAYOUT": "LAYOUT_planck_mit"
},
"community_layouts": [
"planck_mit"
],
"layouts": { "layouts": {
"LAYOUT": { "LAYOUT_planck_mit": {
"layout": [ "layout": [
{"matrix": [0, 0], "x": 0, "y": 0}, {"matrix": [0, 0], "x": 0, "y": 0},
{"matrix": [0, 1], "x": 1, "y": 0}, {"matrix": [0, 1], "x": 1, "y": 0},

47
keyboards/quarkeys/z40/keymaps/default/keymap.c
View file

@ -1,4 +1,4 @@
/* /*
/ Copyright 2022 quarkeys / Copyright 2022 quarkeys
/ This program is free software: you can redistribute it and/or modify / 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 / it under the terms of the GNU General Public License as published by
@ -26,11 +26,11 @@ const uint16_t PROGMEM keymaps[][MATRIX_ROWS][MATRIX_COLS] = {
* | Ctrl | Caps | ALT | OS | Ly1 | SPACE | Ly2 | M1 | M2 | M3 | Enter | * | Ctrl | Caps | ALT | OS | Ly1 | SPACE | Ly2 | M1 | M2 | M3 | Enter |
* `-------------------------------------------------------------------------------------' * `-------------------------------------------------------------------------------------'
*/ */
[0] = LAYOUT( [0] = LAYOUT_planck_mit(
KC_ESC, KC_Q, KC_W, KC_E, KC_R, KC_T, KC_Y, KC_U, KC_I, KC_O, KC_P, KC_BSPC, KC_ESC, KC_Q, KC_W, KC_E, KC_R, KC_T, KC_Y, KC_U, KC_I, KC_O, KC_P, KC_BSPC,
KC_TAB, KC_A, KC_S, KC_D, KC_F, KC_G, KC_H, KC_J, KC_K, KC_L, KC_SCLN, KC_QUOT, KC_TAB, KC_A, KC_S, KC_D, KC_F, KC_G, KC_H, KC_J, KC_K, KC_L, KC_SCLN, KC_QUOT,
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_LSFT, KC_Z, KC_X, KC_C, KC_V, KC_B, KC_N, KC_M, KC_COMM, KC_DOT, KC_SLSH, KC_RSFT,
KC_LCTL, KC_CAPS, KC_LALT, KC_LGUI, MO(1), KC_SPC, MO(2), MO(3), _______, _______, KC_ENT KC_LCTL, KC_CAPS, KC_LALT, KC_LGUI, MO(1), KC_SPC, MO(2), MO(3), _______, _______, KC_ENT
), ),
/* [1] /* [1]
@ -44,13 +44,12 @@ const uint16_t PROGMEM keymaps[][MATRIX_ROWS][MATRIX_COLS] = {
* | | | | | | 0 | | | . | | = | * | | | | | | 0 | | | . | | = |
* `-------+------+------+------+------+-------------+------+------+------+-------+------' * `-------+------+------+------+------+-------------+------+------+------+-------+------'
*/ */
[1] = LAYOUT_planck_mit(
[1] = LAYOUT( QK_BOOT, KC_PGUP, KC_HOME, KC_UP, KC_END, KC_DEL, KC_BSLS, KC_7, KC_8, KC_9, RGB_TOG, _______,
QK_BOOT, KC_PGUP, KC_HOME, KC_UP, KC_END, KC_DEL, KC_BSLS, KC_7, KC_8, KC_9, RGB_TOG, _______, _______, KC_PGDN, KC_LEFT, KC_DOWN, KC_RGHT, KC_PLUS, KC_MINS, KC_4, KC_5, KC_6, RGB_MOD, _______,
_______, KC_PGDN, KC_LEFT, KC_DOWN, KC_RGHT, KC_PLUS, KC_MINS, KC_4, KC_5, KC_6, RGB_MOD, _______, _______, KC_VOLD, KC_VOLU, _______, _______, KC_ASTR, KC_SLSH, KC_1, KC_2, KC_3, RGB_HUI, _______,
_______, KC_VOLD, KC_VOLU, _______, _______, KC_ASTR, KC_SLSH, KC_1, KC_2, KC_3, RGB_HUI, _______, RGB_SAI, RGB_SAD, RGB_VAI, RGB_VAD, _______, KC_0, _______, _______, KC_DOT, RGB_HUD, KC_EQL
RGB_SAI, RGB_SAD, RGB_VAI, RGB_VAD, _______, KC_0, _______, _______, KC_DOT, RGB_HUD, KC_EQL ),
),
/* [2] /* [2]
* ,-------------------------------------------------------------------------------------. * ,-------------------------------------------------------------------------------------.
@ -63,13 +62,13 @@ const uint16_t PROGMEM keymaps[][MATRIX_ROWS][MATRIX_COLS] = {
* | | | | | | | | | | | | * | | | | | | | | | | | |
* `-------------------------------------------------------------------------------------' * `-------------------------------------------------------------------------------------'
*/ */
[2] = LAYOUT( [2] = LAYOUT_planck_mit(
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_F1, KC_F2, KC_F3, KC_F4, KC_F5, KC_F6, KC_F7, KC_F8, KC_F9, KC_F10, KC_F11, KC_F12,
_______, KC_AMPR, KC_PIPE, KC_LPRN, KC_RPRN, KC_PLUS, KC_MINS, KC_LCBR, KC_RCBR, KC_LBRC, KC_RBRC, _______, _______, KC_AMPR, KC_PIPE, KC_LPRN, KC_RPRN, KC_PLUS, KC_MINS, KC_LCBR, KC_RCBR, KC_LBRC, KC_RBRC, _______,
_______, KC_EXLM, KC_AT, KC_HASH, KC_CIRC, KC_ASTR, KC_SLSH, KC_TILD, KC_LABK, KC_RABK, KC_QUES, _______, _______, KC_EXLM, KC_AT, KC_HASH, KC_CIRC, KC_ASTR, KC_SLSH, KC_TILD, KC_LABK, KC_RABK, KC_QUES, _______,
_______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______ _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______
) )
}; };
#ifdef RGBLIGHT_ENABLE #ifdef RGBLIGHT_ENABLE
const rgblight_segment_t PROGMEM my_capslock_layer[] = RGBLIGHT_LAYER_SEGMENTS({9, 1, HSV_RED}); const rgblight_segment_t PROGMEM my_capslock_layer[] = RGBLIGHT_LAYER_SEGMENTS({9, 1, HSV_RED});
@ -78,10 +77,10 @@ const rgblight_segment_t PROGMEM my_symbol_layer[] = RGBLIGHT_LAYER_SEGMENTS({28
const rgblight_segment_t PROGMEM my_other_layer[] = RGBLIGHT_LAYER_SEGMENTS({16, 2, HSV_WHITE}); const rgblight_segment_t PROGMEM my_other_layer[] = RGBLIGHT_LAYER_SEGMENTS({16, 2, HSV_WHITE});
const rgblight_segment_t* const PROGMEM my_rgb_layers[] = RGBLIGHT_LAYERS_LIST( const rgblight_segment_t* const PROGMEM my_rgb_layers[] = RGBLIGHT_LAYERS_LIST(
my_capslock_layer, // Caplock indicator my_capslock_layer, // Caplock indicator
my_ar_numpad_layer, // Arrow keys & Numpad, Operator keys, reset key, RGB control and media control my_ar_numpad_layer, // Arrow keys & Numpad, Operator keys, reset key, RGB control and media control
my_symbol_layer, // F1-F12 keys & Symbols my_symbol_layer, // F1-F12 keys & Symbols
my_other_layer // Self-Defined my_other_layer // Self-Defined
); );
void keyboard_post_init_user(void) { void keyboard_post_init_user(void) {

46
keyboards/quarkeys/z40/keymaps/via/keymap.c
View file

@ -1,4 +1,4 @@
/* /*
/ Copyright 2022 quarkeys / Copyright 2022 quarkeys
/ This program is free software: you can redistribute it and/or modify / 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 / it under the terms of the GNU General Public License as published by
@ -15,27 +15,27 @@
#include QMK_KEYBOARD_H #include QMK_KEYBOARD_H
const uint16_t PROGMEM keymaps[][MATRIX_ROWS][MATRIX_COLS] = { const uint16_t PROGMEM keymaps[][MATRIX_ROWS][MATRIX_COLS] = {
[0] = LAYOUT( [0] = LAYOUT_planck_mit(
KC_ESC, KC_Q, KC_W, KC_E, KC_R, KC_T, KC_Y, KC_U, KC_I, KC_O, KC_P, KC_BSPC, KC_ESC, KC_Q, KC_W, KC_E, KC_R, KC_T, KC_Y, KC_U, KC_I, KC_O, KC_P, KC_BSPC,
KC_TAB, KC_A, KC_S, KC_D, KC_F, KC_G, KC_H, KC_J, KC_K, KC_L, KC_SCLN, KC_QUOT, KC_TAB, KC_A, KC_S, KC_D, KC_F, KC_G, KC_H, KC_J, KC_K, KC_L, KC_SCLN, KC_QUOT,
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_LSFT, KC_Z, KC_X, KC_C, KC_V, KC_B, KC_N, KC_M, KC_COMM, KC_DOT, KC_SLSH, KC_RSFT,
KC_LCTL, KC_CAPS, KC_LALT, KC_LGUI, MO(1), KC_SPC, MO(2), MO(3), _______, _______, KC_ENT KC_LCTL, KC_CAPS, KC_LALT, KC_LGUI, MO(1), KC_SPC, MO(2), MO(3), _______, _______, KC_ENT
), ),
[1] = LAYOUT( [1] = LAYOUT_planck_mit(
QK_BOOT, KC_PGUP, KC_HOME, KC_UP, KC_END, KC_DEL, KC_BSLS, KC_7, KC_8, KC_9, RGB_TOG, _______, QK_BOOT, KC_PGUP, KC_HOME, KC_UP, KC_END, KC_DEL, KC_BSLS, KC_7, KC_8, KC_9, RGB_TOG, _______,
_______, KC_PGDN, KC_LEFT, KC_DOWN, KC_RGHT, KC_PLUS, KC_MINS, KC_4, KC_5, KC_6, RGB_MOD, _______, _______, KC_PGDN, KC_LEFT, KC_DOWN, KC_RGHT, KC_PLUS, KC_MINS, KC_4, KC_5, KC_6, RGB_MOD, _______,
_______, KC_VOLD, KC_VOLU, _______, _______, KC_ASTR, KC_SLSH, KC_1, KC_2, KC_3, RGB_HUI, _______, _______, KC_VOLD, KC_VOLU, _______, _______, KC_ASTR, KC_SLSH, KC_1, KC_2, KC_3, RGB_HUI, _______,
RGB_SAI, RGB_SAD, RGB_VAI, RGB_VAD, _______, KC_0, _______, _______, KC_DOT, RGB_HUD, KC_EQL RGB_SAI, RGB_SAD, RGB_VAI, RGB_VAD, _______, KC_0, _______, _______, KC_DOT, RGB_HUD, KC_EQL
), ),
[2] = LAYOUT( [2] = LAYOUT_planck_mit(
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_F1, KC_F2, KC_F3, KC_F4, KC_F5, KC_F6, KC_F7, KC_F8, KC_F9, KC_F10, KC_F11, KC_F12,
_______, KC_AMPR, KC_PIPE, KC_LPRN, KC_RPRN, KC_PLUS, KC_MINS, KC_LCBR, KC_RCBR, KC_LBRC, KC_RBRC, _______, _______, KC_AMPR, KC_PIPE, KC_LPRN, KC_RPRN, KC_PLUS, KC_MINS, KC_LCBR, KC_RCBR, KC_LBRC, KC_RBRC, _______,
_______, KC_EXLM, KC_AT, KC_HASH, KC_CIRC, KC_ASTR, KC_SLSH, KC_TILD, KC_LABK, KC_RABK, KC_QUES, _______, _______, KC_EXLM, KC_AT, KC_HASH, KC_CIRC, KC_ASTR, KC_SLSH, KC_TILD, KC_LABK, KC_RABK, KC_QUES, _______,
_______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______ _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______
) )
}; };
#ifdef RGBLIGHT_ENABLE #ifdef RGBLIGHT_ENABLE
const rgblight_segment_t PROGMEM my_capslock_layer[] = RGBLIGHT_LAYER_SEGMENTS({9, 1, HSV_RED}); const rgblight_segment_t PROGMEM my_capslock_layer[] = RGBLIGHT_LAYER_SEGMENTS({9, 1, HSV_RED});
@ -44,10 +44,10 @@ const rgblight_segment_t PROGMEM my_symbol_layer[] = RGBLIGHT_LAYER_SEGMENTS({28
const rgblight_segment_t PROGMEM my_other_layer[] = RGBLIGHT_LAYER_SEGMENTS({16, 2, HSV_WHITE}); const rgblight_segment_t PROGMEM my_other_layer[] = RGBLIGHT_LAYER_SEGMENTS({16, 2, HSV_WHITE});
const rgblight_segment_t* const PROGMEM my_rgb_layers[] = RGBLIGHT_LAYERS_LIST( const rgblight_segment_t* const PROGMEM my_rgb_layers[] = RGBLIGHT_LAYERS_LIST(
my_capslock_layer, // Caplock indicator my_capslock_layer, // Caplock indicator
my_ar_numpad_layer, // Arrow keys & Numpad, Operator keys, reset key, RGB control and media control my_ar_numpad_layer, // Arrow keys & Numpad, Operator keys, reset key, RGB control and media control
my_symbol_layer, // F1-F12 keys & Symbols my_symbol_layer, // F1-F12 keys & Symbols
my_other_layer // Self-Defined my_other_layer // Self-Defined
); );
void keyboard_post_init_user(void) { void keyboard_post_init_user(void) {

16
keyboards/quarkeys/z40/readme.md
View file

@ -1,14 +1,18 @@
# Quarkeys Z40 Low Profile Keyboard # Quarkeys Z40 Low Profile Keyboard
![Quarkeys Z40 Pastry](https://raw.githubusercontent.com/tommyamoszhao/keyboardimage/main/Z40/Z40_1024.png) ![Quarkeys Z40 Pastry](https://raw.githubusercontent.com/noroadsleft/qmk_images/master/keyboards/quarkeys/z40/72b918_ef3d9bc5f32e4b2ba224b0a25bc017f4~mv2.png "Quarkeys Z40 PCB render")
A 40% Bottom mount low-profile & MX switch compatible keyboard. A 40% Bottom mount low-profile & MX switch compatible keyboard.
* Keyboard Maintainer: [Quarkeys Studio](www.quarkeys.com) * Keyboard Maintainer: [TommyZ](https://github.com/tommyamoszhao)
* Hardware Supported: Z40-ACR, Z40-Pastry * Hardware Supported: Z40-ACR, Z40-Pastry
* Hardware Specs: Per-key RGBs, layer & Capslock indicators * Hardware Availability: [Quarkeys Studio](https://www.quarkeys.com/product-page/z40-extra-pcb)
* For [RGB Matrix feature](https://docs.qmk.fm/#/feature_rgb_matrix): `RGB_MATRIX_ENABLE = yes`, `RGBLIGHT_ENABLE = no`.
* For [RGB Light feature](https://docs.qmk.fm/#/feature_rgblight): `RGB_MATRIX_ENABLE = no`, `RGBLIGHT_ENABLE = yes`. ## Hardware Specs
* Per-key RGBs, layer & Capslock indicators
* For [RGB Matrix feature](https://docs.qmk.fm/#/feature_rgb_matrix): `RGB_MATRIX_ENABLE = yes`, `RGBLIGHT_ENABLE = no`.
* For [RGB Light feature](https://docs.qmk.fm/#/feature_rgblight): `RGB_MATRIX_ENABLE = no`, `RGBLIGHT_ENABLE = yes`.
Make example for this keyboard solder version keymap(after setting up your build environment): Make example for this keyboard solder version keymap(after setting up your build environment):
@ -20,4 +24,4 @@ Flashing example for this keyboard:
**Bootloader:** Press the `QK_BOOT` keycode at ESC position of layer 1. **Bootloader:** Press the `QK_BOOT` keycode at ESC position of layer 1.
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). 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).