Add VIA support to Noxary x268 (#9450)

* Update USB descriptors

* Update default keymap for readability

* Update readme description

* Update rules.mk build options, enable bootmagic and mousekey

* Add commented modern led code

* Add VIA keymap

* Update default keymap readme.md layout image

* Update keyboards/noxary/x268/rules.mk

remove incorrect comment

* Update keyboards/noxary/x268/x268.c

remove commented setPinOutput(B1)

* Update keyboards/noxary/x268/keymaps/default/readme.md

Flip order of layout image and title

* Update keyboards/noxary/x268/keymaps/via/readme.md

Flip order of layout image and title

* Update LED function to led_update_kb()
This commit is contained in:
Rozakiin 2020-06-23 07:08:36 +01:00 committed by GitHub
parent f0bde7906d
commit d353fcb99c
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
9 changed files with 226 additions and 97 deletions

View File

@ -20,12 +20,12 @@ along with this program. If not, see <http://www.gnu.org/licenses/>.
#include "config_common.h"
/* USB Device descriptor parameter */
#define VENDOR_ID 0x4E58
#define PRODUCT_ID 0x0044
#define DEVICE_VER 0x00F2
#define VENDOR_ID 0x4E58 //"NX"
#define PRODUCT_ID 0x010C //268
#define DEVICE_VER 0x0078 //"x"
#define MANUFACTURER Noxary
#define PRODUCT x268
#define DESCRIPTION QMK keyboard firmware for x268
#define DESCRIPTION A fully customizable RGB 65% keyboard.
/* key matrix size */
#define MATRIX_ROWS 5

View File

@ -1,83 +1,111 @@
/* Copyright 2020 Rozakiin
*
* 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
// Each layer gets a name for readability, which is then used in the keymap matrix below.
// The underscores don't mean anything - you can have a layer called STUFF or any other name.
// Layer names don't all need to be of the same length, obviously, and you can also skip them
// entirely and just use numbers.
#define _BL 0
#define _FL1 1
#define _FL2 2
enum layer_names {
_BL,
_FL1,
_FL2,
_FL3
};
const uint16_t PROGMEM keymaps[][MATRIX_ROWS][MATRIX_COLS] = {
/* _BL: Base Layer(Default) - For ISO enter use ANSI enter
* ,----------------------------------------------------------------.
* |Esc | 1| 2| 3| 4| 5| 6| 7| 8| 9| 0| -| =| \|BSpc| Grv|
* |----------------------------------------------------------------|
* |Tab | Q| W| E| R| T| Y| U| I| O| P| [| ]| \ | Del|
* |----------------------------------------------------------------|
* |CAPS | A| S| D| F| G| H| J| K| L| ;| '| #| Ent|PgUp|
* |----------------------------------------------------------------|
* |Shift| \| Z| X| C| V| B| N| M| ,| .| /|Shift | Up|PgDn|
* |----------------------------------------------------------------|
* |Ctrl|Win |Alt | Space |Alt|Mo(1)|Ctrl|Lef|Dow|Rght|
* `----------------------------------------------------------------'
/* Base Layer - For ISO enter use ANSI enter
*
* Esc 1 2 3 4 5 6 7 8 9 0 - = \ Bsp `
*
* Tab Q W E R T Y U I O P [ ] \ Del
*
* Caps A S D F G H J K L ; ' # Ent PgU
*
* Sft \ Z X C V B N M , . / Shift PgD
*
* CtrlWin Alt Space Alt M(1)Ctrl
*
*/
[_BL] = LAYOUT(
KC_ESC, 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_BSLS, KC_BSPC, KC_GRV,
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_DEL,
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_NUHS, KC_ENT, KC_PGUP,
KC_LSFT, KC_NUBS, 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_PGDN,
KC_LCTL, KC_LGUI, KC_LALT, KC_SPC, KC_LALT, MO(_FL1), KC_RCTL, KC_LEFT, KC_DOWN, KC_RGHT),
/* _FL1: Function Layer 1 - For ISO enter use ANSI enter
* ,----------------------------------------------------------------.
* | `|F1| F2| F3| F4| F5| F6| F7| F8| F9|F10|F11|F12| |PScr| |
* |----------------------------------------------------------------|
* | | | | |RST| | | | | | | | | | Ins|
* |----------------------------------------------------------------|
* | | | | | | | | | | | | | | |Home|
* |----------------------------------------------------------------|
* | | | | | | | | | |Bl-|Bl+| |Mute|Vol+| End|
* |----------------------------------------------------------------|
* | | | | BL_Toggle | | | | |Vol-| |
* `----------------------------------------------------------------'
KC_LCTL, KC_LGUI, KC_LALT, KC_SPC, KC_LALT, MO(_FL1), KC_RCTL, KC_LEFT, KC_DOWN, KC_RGHT
),
/* Function Layer 1 - For ISO enter use ANSI enter
*
* ` F1 F2 F3 F4 F5 F6 F7 F8 F9 F10F11F12 Psc
*
* RST Ins
*
* Hme
*
* Bl-Bl+ Mute Vl+End
*
* BL_Toggle Vl-
*
*/
[_FL1] = LAYOUT(
KC_GRV, 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, _______,
RGB_TOG, RGB_VAI, RGB_SAI, RGB_HUI, RESET, _______, _______, _______, _______, _______, _______, _______, _______, _______, KC_INS,
_______, RGB_VAD, RGB_SAD, RGB_HUD, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, KC_HOME,
_______, _______, _______, _______, _______, _______, _______, _______, _______, BL_DEC, BL_INC, _______, KC_MUTE, KC_VOLU, KC_END,
_______, _______, _______, BL_TOGG, _______, _______, _______, _______, KC_VOLD, _______),
/* _FL2: Function Layer 2 - For ISO enter use ANSI enter
* ,----------------------------------------------------------------.
* | | | | | | | | | | | | | | | | |
* |----------------------------------------------------------------|
* | | | | | | | | | | | | | | | |
* |----------------------------------------------------------------|
* | | | | | | | | | | | | | | | |
* |----------------------------------------------------------------|
* | | | | | | | | | | | | | | | |
* |----------------------------------------------------------------|
* | | | | | | | | | | |
* `----------------------------------------------------------------'
_______, _______, _______, BL_TOGG, _______, _______, _______, _______, KC_VOLD, _______
),
/* Function Layer 2 - For ISO enter use ANSI enter
*
*
*
*
*
*
*
*
*
*
*
*/
[_FL2] = LAYOUT(
_______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______,
_______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______,
_______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______,
_______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______,
_______, _______, _______, _______, _______, _______, _______, _______, _______, _______),
_______, _______, _______, _______, _______, _______, _______, _______, _______, _______
),
/* Function Layer 3 - For ISO enter use ANSI enter
*
*
*
*
*
*
*
*
*
*
*
*/
[_FL3] = LAYOUT(
_______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______,
_______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______,
_______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______,
_______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______,
_______, _______, _______, _______, _______, _______, _______, _______, _______, _______
),
};
void matrix_init_user(void) {
}
void matrix_scan_user(void) {
}
bool process_record_user(uint16_t keycode, keyrecord_t *record) {
return true;
}

View File

@ -1 +1,3 @@
# The default keymap for x268
![x268 Layout Image](https://i.imgur.com/D9jQz6g.png)

View File

@ -0,0 +1,111 @@
/* Copyright 2020 Rozakiin
*
* 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
// Each layer gets a name for readability, which is then used in the keymap matrix below.
// The underscores don't mean anything - you can have a layer called STUFF or any other name.
// Layer names don't all need to be of the same length, obviously, and you can also skip them
// entirely and just use numbers.
enum layer_names {
_BL,
_FL1,
_FL2,
_FL3
};
const uint16_t PROGMEM keymaps[][MATRIX_ROWS][MATRIX_COLS] = {
/* Base Layer - For ISO enter use ANSI enter
*
* Esc 1 2 3 4 5 6 7 8 9 0 - = \ Bsp `
*
* Tab Q W E R T Y U I O P [ ] \ Del
*
* Caps A S D F G H J K L ; ' # Ent PgU
*
* Sft \ Z X C V B N M , . / Shift PgD
*
* CtrlWin Alt Space Alt M(1)Ctrl
*
*/
[_BL] = LAYOUT(
KC_ESC, 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_BSLS, KC_BSPC, KC_GRV,
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_DEL,
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_NUHS, KC_ENT, KC_PGUP,
KC_LSFT, KC_NUBS, 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_PGDN,
KC_LCTL, KC_LGUI, KC_LALT, KC_SPC, KC_LALT, MO(_FL1), KC_RCTL, KC_LEFT, KC_DOWN, KC_RGHT
),
/* Function Layer 1 - For ISO enter use ANSI enter
*
* ` F1 F2 F3 F4 F5 F6 F7 F8 F9 F10F11F12 Psc
*
* RST Ins
*
* Hme
*
* Bl-Bl+ Mute Vl+End
*
* BL_Toggle Vl-
*
*/
[_FL1] = LAYOUT(
KC_GRV, 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, _______,
RGB_TOG, RGB_VAI, RGB_SAI, RGB_HUI, RESET, _______, _______, _______, _______, _______, _______, _______, _______, _______, KC_INS,
_______, RGB_VAD, RGB_SAD, RGB_HUD, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, KC_HOME,
_______, _______, _______, _______, _______, _______, _______, _______, _______, BL_DEC, BL_INC, _______, KC_MUTE, KC_VOLU, KC_END,
_______, _______, _______, BL_TOGG, _______, _______, _______, _______, KC_VOLD, _______
),
/* Function Layer 2 - For ISO enter use ANSI enter
*
*
*
*
*
*
*
*
*
*
*
*/
[_FL2] = LAYOUT(
_______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______,
_______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______,
_______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______,
_______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______,
_______, _______, _______, _______, _______, _______, _______, _______, _______, _______
),
/* Function Layer 3 - For ISO enter use ANSI enter
*
*
*
*
*
*
*
*
*
*
*
*/
[_FL3] = LAYOUT(
_______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______,
_______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______,
_______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______,
_______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______,
_______, _______, _______, _______, _______, _______, _______, _______, _______, _______
),
};

View File

@ -0,0 +1,3 @@
# The VIA keymap for x268
![x268 Layout Image](https://i.imgur.com/D9jQz6g.png)

View File

@ -0,0 +1,5 @@
VIA_ENABLE = yes
MOUSEKEY_ENABLE = no
CONSOLE_ENABLE = no # Console for debug
COMMAND_ENABLE = no # Commands for debug and configuration
LTO_ENABLE = yes

View File

@ -2,11 +2,10 @@
![x268](https://geekhack.org/index.php?action=dlattach;topic=96377.0;attach=198826;image)
A fully customizable 65% keyboard.
A fully customizable RGB 65% keyboard.
* Keyboard Maintainer: [Rozakiin](https://github.com/rozakiin)
* Hardware Supported: x268 PCB
* rev1
* Hardware Availability:
* [Noxary - 268](https://geekhack.org/index.php?topic=92066.0)
* [LZ - CLS ms](https://geekhack.org/index.php?topic=96377)

View File

@ -14,17 +14,17 @@ BOOTLOADER = atmel-dfu
# Build Options
# change yes to no to disable
#
BOOTMAGIC_ENABLE = no # Virtual DIP switch configuration
MOUSEKEY_ENABLE = no # Mouse keys
BOOTMAGIC_ENABLE = lite # Virtual DIP switch configuration
MOUSEKEY_ENABLE = yes # Mouse keys
EXTRAKEY_ENABLE = yes # Audio control and System control
CONSOLE_ENABLE = no # Console for debug
COMMAND_ENABLE = no # Commands for debug and configuration
# Do not enable SLEEP_LED_ENABLE. it uses the same timer as BACKLIGHT_ENABLE
SLEEP_LED_ENABLE = no # Breathing sleep LED during USB suspend
# if this doesn't work, see here: https://github.com/tmk/tmk_keyboard/wiki/FAQ#nkro-doesnt-work
NKRO_ENABLE = yes # USB Nkey Rollover
BACKLIGHT_ENABLE = yes # Enable keyboard backlight functionality on B7 by default
RGBLIGHT_ENABLE = yes # Enable keyboard RGB underglow
NKRO_ENABLE = yes # USB Nkey Rollover
BACKLIGHT_ENABLE = yes # Enable keyboard backlight functionality
RGBLIGHT_ENABLE = yes # Enable keyboard RGB underglow
MIDI_ENABLE = no # MIDI support
UNICODE_ENABLE = no # Unicode
BLUETOOTH_ENABLE = no # Enable Bluetooth with the Adafruit EZ-Key HID

View File

@ -1,4 +1,4 @@
/* Copyright 2018 Rozakiin
/* Copyright 2020 Rozakiin
*
* 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
@ -15,39 +15,20 @@
*/
#include "x268.h"
// Optional override functions below.
// You can leave any or all of these undefined.
// These are only required if you want to perform custom actions.
void matrix_init_kb(void) {
// put your keyboard start-up code here
// runs once when the firmware starts up
setPinOutput(B0);
matrix_init_user();
}
void matrix_scan_kb(void) {
// put your looping keyboard code here
// runs every cycle (a lot)
matrix_scan_user();
}
bool process_record_kb(uint16_t keycode, keyrecord_t *record) {
// put your per-action keyboard code here
// runs for every action, just before processing by the firmware
return process_record_user(keycode, record);
}
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);
}
void led_set_user(uint8_t usb_led) {
if (usb_led & (1 << USB_LED_CAPS_LOCK)) {
DDRB |= (1 << 0); PORTB |= (1 << 0);
}
else {
DDRB &= ~(1 << 0); PORTB &= ~(1 << 0);
bool led_update_kb(led_t led_state) {
if(led_update_user(led_state)) {
writePin(B0, led_state.caps_lock);
}
return true;
}