~ruther/qmk_firmware

812468abb466d48972d9b4054a216dbbc054e803 — Ramon Imbao 2 years ago 2792ee6
[Keyboard] Add the Gone Hacking Studio XLS (#19185)

Co-authored-by: Ryan <fauxpark@gmail.com>
A keyboards/ghs/xls/info.json => keyboards/ghs/xls/info.json +116 -0
@@ 0,0 1,116 @@
{
    "manufacturer": "Gone Hacking Studio",
    "keyboard_name": "GHS.XLS",
    "maintainer": "ramonimbao",
    "diode_direction": "COL2ROW",
    "features": {
        "bootmagic": true,
        "command": false,
        "console": false,
        "extrakey": true,
        "mousekey": true,
        "encoder": true,
        "nkro": true
    },
    "matrix_pins": {
        "cols": ["C15", "C14", "C13", "A3"],
        "rows": ["A4", "B12", "A6", "A10", "A5", "B2"]
    },
    "indicators": {
        "num_lock": "B0"
    },
    "url": "",
    "usb": {
        "device_version": "1.0.0",
        "pid": "0x0002",
        "vid": "0x0645"
    },
    "encoder": {
        "rotary": [
            { "pin_a": "B3", "pin_b": "A15" },
            { "pin_a": "B4", "pin_b": "B5" },
            { "pin_a": "B9", "pin_b": "B8" },
            { "pin_a": "F0", "pin_b": "F1" }
        ]
    },
    "layouts": {
        "LAYOUT_numpad_6x4": {
            "layout": [
                { "matrix": [0, 0], "x": 0, "y": 0 },
                { "matrix": [0, 1], "x": 1, "y": 0 },
                { "matrix": [0, 2], "x": 2, "y": 0 },
                { "matrix": [0, 3], "x": 3, "y": 0 },
                { "matrix": [1, 0], "x": 0, "y": 1.5 },
                { "matrix": [1, 1], "x": 1, "y": 1.5 },
                { "matrix": [1, 2], "x": 2, "y": 1.5 },
                { "matrix": [1, 3], "x": 3, "y": 1.5 },
                { "matrix": [2, 0], "x": 0, "y": 2.5 },
                { "matrix": [2, 1], "x": 1, "y": 2.5 },
                { "matrix": [2, 2], "x": 2, "y": 2.5 },
                { "matrix": [3, 0], "x": 0, "y": 3.5 },
                { "matrix": [3, 1], "x": 1, "y": 3.5 },
                { "matrix": [3, 2], "x": 2, "y": 3.5 },
                { "h": 2, "matrix": [2, 3], "x": 3, "y": 2.5 },
                { "matrix": [4, 0], "x": 0, "y": 4.5 },
                { "matrix": [4, 1], "x": 1, "y": 4.5 },
                { "matrix": [4, 2], "x": 2, "y": 4.5 },
                { "matrix": [5, 0], "w": 2, "x": 0, "y": 5.5 },
                { "matrix": [5, 2], "x": 2, "y": 5.5 },
                { "h": 2, "matrix": [4, 3], "x": 3, "y": 4.5 }
            ]
        },
        "LAYOUT_numpad_6x4_southpaw": {
            "layout": [
                { "matrix": [0, 0], "x": 0, "y": 0 },
                { "matrix": [0, 1], "x": 1, "y": 0 },
                { "matrix": [0, 2], "x": 2, "y": 0 },
                { "matrix": [0, 3], "x": 3, "y": 0 },
                { "matrix": [1, 0], "x": 0, "y": 1.5 },
                { "matrix": [1, 1], "x": 1, "y": 1.5 },
                { "matrix": [1, 2], "x": 2, "y": 1.5 },
                { "matrix": [1, 3], "x": 3, "y": 1.5 },
                { "matrix": [2, 0], "h": 2, "x": 0, "y": 2.5 },
                { "matrix": [2, 1], "x": 1, "y": 2.5 },
                { "matrix": [2, 2], "x": 2, "y": 2.5 },
                { "matrix": [2, 3], "x": 3, "y": 2.5 },
                { "matrix": [3, 1], "x": 1, "y": 3.5 },
                { "matrix": [3, 2], "x": 2, "y": 3.5 },
                { "matrix": [3, 3], "x": 3, "y": 3.5 },
                { "matrix": [5, 0], "h": 2, "x": 0, "y": 4.5 },
                { "matrix": [4, 1], "x": 1, "y": 4.5 },
                { "matrix": [4, 2], "x": 2, "y": 4.5 },
                { "matrix": [4, 3], "x": 3, "y": 4.5 },
                { "matrix": [5, 1], "x": 1, "y": 5.5 },
                { "matrix": [5, 2], "w": 2, "x": 2, "y": 5.5 }
            ]
        },
        "LAYOUT_all": {
            "layout": [
                { "matrix": [0, 0], "x": 0, "y": 0 },
                { "matrix": [0, 1], "x": 1, "y": 0 },
                { "matrix": [0, 2], "x": 2, "y": 0 },
                { "matrix": [0, 3], "x": 3, "y": 0 },
                { "matrix": [1, 0], "x": 0, "y": 1.5 },
                { "matrix": [1, 1], "x": 1, "y": 1.5 },
                { "matrix": [1, 2], "x": 2, "y": 1.5 },
                { "matrix": [1, 3], "x": 3, "y": 1.5 },
                { "matrix": [2, 0], "x": 0, "y": 2.5 },
                { "matrix": [2, 1], "x": 1, "y": 2.5 },
                { "matrix": [2, 2], "x": 2, "y": 2.5 },
                { "matrix": [2, 3], "x": 3, "y": 2.5 },
                { "matrix": [3, 0], "x": 0, "y": 3.5 },
                { "matrix": [3, 1], "x": 1, "y": 3.5 },
                { "matrix": [3, 2], "x": 2, "y": 3.5 },
                { "matrix": [3, 3], "x": 3, "y": 3.5 },
                { "matrix": [4, 0], "x": 0, "y": 4.5 },
                { "matrix": [4, 1], "x": 1, "y": 4.5 },
                { "matrix": [4, 2], "x": 2, "y": 4.5 },
                { "matrix": [4, 3], "x": 3, "y": 4.5 },
                { "matrix": [5, 0], "x": 0, "y": 5.5 },
                { "matrix": [5, 1], "x": 1, "y": 5.5 },
                { "matrix": [5, 2], "x": 2, "y": 5.5 },
                { "matrix": [5, 3], "x": 3, "y": 5.5 }
            ]
        }
    }
}

A keyboards/ghs/xls/keymaps/default/keymap.c => keyboards/ghs/xls/keymaps/default/keymap.c +73 -0
@@ 0,0 1,73 @@
/* Copyright 2022 Ramon Imbao
 *
 * 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] = {
    /*
     * ┌───┬───┬───┬───┐
     * │F13│F14│F15│F16│
     * ├───┼───┼───┼───┤
     * │Num│ / │ * │ - │
     * ├───┼───┼───┼───┤
     * │ 7 │ 8 │ 9 │   │
     * ├───┼───┼───┤ + │
     * │ 4 │ 5 │ 6 │   │
     * ├───┼───┼───┼───┤
     * │ 1 │ 2 │ 3 │   │
     * ├───┴───┼───┤Ent│
     * │ 0     │ . │   │
     * └───────┴───┴───┘
     */
    [0] = LAYOUT_numpad_6x4(
        KC_F13,  KC_F14,  KC_F15,  KC_F16,
        KC_NUM,  KC_PSLS, KC_PAST, KC_PMNS,
        KC_P7,   KC_P8,   KC_P9,
        KC_P4,   KC_P5,   KC_P6,   KC_PPLS,
        KC_P1,   KC_P2,   KC_P3,
        KC_P0,            KC_PDOT, KC_PENT
    )
};

bool encoder_update_user(uint8_t index, bool clockwise) {
    if (index == 0) {
        if (clockwise) {
            tap_code_delay(KC_VOLU, 10);
        } else {
            tap_code_delay(KC_VOLD, 10);
        }
    } else if (index == 1) {
        if (clockwise) {
            tap_code_delay(KC_BRIU, 10);
        } else {
            tap_code_delay(KC_BRID, 10);
        }
    } else if (index == 2) {
        if (clockwise) {
            tap_code(KC_RGHT);
        } else {
            tap_code(KC_LEFT);
        }
    } else {
        if (clockwise) {
            tap_code(KC_PGDN);
        } else {
            tap_code(KC_PGUP);
        }
    }

    return false;
}

A keyboards/ghs/xls/keymaps/southpaw/keymap.c => keyboards/ghs/xls/keymaps/southpaw/keymap.c +73 -0
@@ 0,0 1,73 @@
/* Copyright 2022 Ramon Imbao
 *
 * 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] = {
    /*
     * ┌───┬───┬───┬───┐
     * │F13│F14│F15│F16│
     * ├───┼───┼───┼───┤
     * │ - │ * │ / │Num│
     * ├───┼───┼───┼───┤
     * │   │ 7 │ 8 │ 9 │
     * │ + ├───┼───┤───│
     * │   │ 4 │ 5 │ 6 │
     * ├───┼───┼───┼───┤
     * │   │ 1 │ 2 │ 3 │
     * │Ent├───┼───┴───│
     * │   │ . │   0   │
     * └───┴───┴───────┘
     */
    [0] = LAYOUT_numpad_6x4_southpaw(
        KC_F13,  KC_F14,  KC_F15,  KC_F16,
        KC_PMNS, KC_PAST, KC_PSLS, KC_NUM,
        KC_PPLS, KC_P7,   KC_P8,   KC_P9,
                 KC_P4,   KC_P5,   KC_P6,
        KC_PENT, KC_P1,   KC_P2,   KC_P3,
                 KC_PDOT, KC_P0
    )
};

bool encoder_update_user(uint8_t index, bool clockwise) {
    if (index == 0) {
        if (clockwise) {
            tap_code_delay(KC_VOLU, 10);
        } else {
            tap_code_delay(KC_VOLD, 10);
        }
    } else if (index == 1) {
        if (clockwise) {
            tap_code_delay(KC_BRIU, 10);
        } else {
            tap_code_delay(KC_BRID, 10);
        }
    } else if (index == 2) {
        if (clockwise) {
            tap_code(KC_RGHT);
        } else {
            tap_code(KC_LEFT);
        }
    } else {
        if (clockwise) {
            tap_code(KC_PGDN);
        } else {
            tap_code(KC_PGUP);
        }
    }

    return false;
}

A keyboards/ghs/xls/keymaps/via/keymap.c => keyboards/ghs/xls/keymaps/via/keymap.c +76 -0
@@ 0,0 1,76 @@
/* Copyright 2022 Ramon Imbao
 *
 * 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] = {
    /*
     * ┌───┬───┬───┬───┐
     * │F13│F14│F15│F16│
     * ├───┼───┼───┼───┤
     * │Num│ / │ * │ - │
     * ├───┼───┼───┼───┤
     * │ 7 │ 8 │ 9 │   │
     * ├───┼───┼───┤ + │
     * │ 4 │ 5 │ 6 │   │
     * ├───┼───┼───┼───┤
     * │ 1 │ 2 │ 3 │   │
     * ├───┴───┼───┤Ent│
     * │ 0     │ . │   │
     * └───────┴───┴───┘
     */
    [0] = LAYOUT_all(
        KC_F13,  KC_F14,  KC_F15,  KC_F16,
        KC_NUM,  KC_PSLS, KC_PAST, KC_PMNS,
        KC_P7,   KC_P8,   KC_P9,   KC_PPLS,
        KC_P4,   KC_P5,   KC_P6,   KC_PPLS,
        KC_P1,   KC_P2,   KC_P3,   KC_PENT,
        KC_P0,   KC_P0,   KC_PDOT, KC_PENT
    ),
    [1] = LAYOUT_all(
        _______, _______, _______, _______,
        _______, _______, _______, _______,
        _______, _______, _______, _______,
        _______, _______, _______, _______,
        _______, _______, _______, _______,
        _______, _______, _______, _______
    ),
    [2] = LAYOUT_all(
        _______, _______, _______, _______,
        _______, _______, _______, _______,
        _______, _______, _______, _______,
        _______, _______, _______, _______,
        _______, _______, _______, _______,
        _______, _______, _______, _______
    ),
    [3] = LAYOUT_all(
        _______, _______, _______, _______,
        _______, _______, _______, _______,
        _______, _______, _______, _______,
        _______, _______, _______, _______,
        _______, _______, _______, _______,
        _______, _______, _______, _______
    ),
};

#if defined(ENCODER_MAP_ENABLE)
const uint16_t PROGMEM encoder_map[][NUM_ENCODERS][2] = {
    [0] = { ENCODER_CCW_CW(KC_VOLD, KC_VOLU), ENCODER_CCW_CW(KC_BRID, KC_BRIU), ENCODER_CCW_CW(KC_DOWN, KC_UP  ), ENCODER_CCW_CW(KC_PGDN, KC_PGUP) },
    [1] = { ENCODER_CCW_CW(_______, _______), ENCODER_CCW_CW(_______, _______), ENCODER_CCW_CW(_______, _______), ENCODER_CCW_CW(_______, _______) },
    [2] = { ENCODER_CCW_CW(_______, _______), ENCODER_CCW_CW(_______, _______), ENCODER_CCW_CW(_______, _______), ENCODER_CCW_CW(_______, _______) },
    [3] = { ENCODER_CCW_CW(_______, _______), ENCODER_CCW_CW(_______, _______), ENCODER_CCW_CW(_______, _______), ENCODER_CCW_CW(_______, _______) },
};
#endif

A keyboards/ghs/xls/keymaps/via/rules.mk => keyboards/ghs/xls/keymaps/via/rules.mk +2 -0
@@ 0,0 1,2 @@
VIA_ENABLE = yes
ENCODER_MAP_ENABLE = yes

A keyboards/ghs/xls/readme.md => keyboards/ghs/xls/readme.md +26 -0
@@ 0,0 1,26 @@
# GHS.XLS

![GHS.XLS](https://i.imgur.com/5g5kw2sl.jpg)

The perfect partner numpad with the GHS.RAR. Can do normal, southpaw, and macro layouts.

* Keyboard Maintainer: [Ramon Imbao](https://github.com/ramonimbao)
* Hardware Supported: STM32F072
* Hardware Availability: [Gone Hacking Studio](https://gonehacking.studio/)

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

    make ghs/xls:default

Flashing example for this keyboard:

    make ghs/xls: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).

## Bootloader

Enter the bootloader in 3 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

A keyboards/ghs/xls/rules.mk => keyboards/ghs/xls/rules.mk +8 -0
@@ 0,0 1,8 @@
# MCU name
MCU = STM32F072

# Bootloader selection
BOOTLOADER = stm32-dfu

# Enter lower-power sleep mode when on the ChibiOS idle thread
OPT_DEFS += -DCORTEX_ENABLE_WFI_IDLE=TRUE