diff --git a/keyboards/themadnoodle/ncc1701kb/v2/config.h b/keyboards/themadnoodle/ncc1701kb/v2/config.h new file mode 100644 index 0000000000..fbb498c408 --- /dev/null +++ b/keyboards/themadnoodle/ncc1701kb/v2/config.h @@ -0,0 +1,6 @@ +// Copyright 2023 Jesse Leventhal (@The=Mad-Noodle) +// SPDX-License-Identifier: GPL-2.0-or-later + +#pragma once + +#define RGBLIGHT_DEFAULT_MODE RGBLIGHT_MODE_RAINBOW_SWIRL + 5 diff --git a/keyboards/themadnoodle/ncc1701kb/v2/info.json b/keyboards/themadnoodle/ncc1701kb/v2/info.json index 3ea2515e64..c67262c562 100644 --- a/keyboards/themadnoodle/ncc1701kb/v2/info.json +++ b/keyboards/themadnoodle/ncc1701kb/v2/info.json @@ -1,59 +1,71 @@ { - "keyboard_name": "NCC-1701-KB v2", - "manufacturer": "The Mad Noodle", - "url": "instagram.com/the_mad_noodle", - "maintainer": "The-Mad-Noodle", - "usb": { - "vid": "0xFEED", - "pid": "0x1701", - "device_version": "0.0.2" - }, - "matrix_pins": { - "cols": ["B4", "B5", "B6"], - "rows": ["D4", "D6", "D7"] - }, - "diode_direction": "ROW2COL", - "encoder": { - "rotary": [ - {"pin_a": "D0", "pin_b": "D1"} - ] - }, - "rgblight": { - "led_count": 4, - "sleep": true, - "animations": { - "breathing": true, - "rainbow_mood": true, - "rainbow_swirl": true, - "snake": true, - "knight": true, - "christmas": true, - "static_gradient": true, - "rgb_test": true, - "alternating": true, - "twinkle": true - } - }, - "ws2812": { - "pin": "B7" - }, - "processor": "atmega32u4", - "bootloader": "atmel-dfu", - "layouts": { - "LAYOUT_ortho_3x3": { - "layout": [ - {"matrix": [0, 0], "x": 0, "y": 0}, - {"matrix": [0, 1], "x": 1, "y": 0}, - {"matrix": [0, 2], "x": 2, "y": 0}, + "manufacturer": "The Mad Noodle", + "keyboard_name": "NCC-1701-KB v2", + "maintainer": "The-Mad-Noodle", + "url": "https://www.madnoodleprototypes.com/", + "bootloader": "atmel-dfu", + "diode_direction": "ROW2COL", + "features": { + "bootmagic": true, + "command": false, + "console": false, + "extrakey": true, + "mousekey": true, + "nkro": true, + "rgblight": true, + "encoder": true + }, + "rgblight": { + "hue_steps": 10, + "led_count": 4, + "sleep": true, + "animations": { + "breathing": true, + "rainbow_mood": true, + "rainbow_swirl": true, + "snake": true, + "knight": true, + "christmas": true, + "static_gradient": true, + "rgb_test": true, + "alternating": true, + "twinkle": true + } + }, + "ws2812": { + "pin": "B7" + }, + "matrix_pins": { + "rows": ["D4", "D6", "D7"], + "cols": ["B4", "B5", "B6"] + }, + "processor": "atmega32u4", + "usb": { + "device_version": "2.0.0", + "pid": "0x0021", + "vid": "0x6A6C" + }, + "community_layouts": ["ortho_3x3"], + "layouts": { + "LAYOUT_ortho_3x3": { + "layout": [ + {"x":0, "y":0, "matrix": [0,0]}, + {"label":"Encoder", "x":1, "y":0, "matrix": [0,1]}, + {"x":2, "y":0, "matrix": [0,2]}, + {"x":0, "y":1, "matrix": [1,0]}, + {"x":1, "y":1, "matrix": [1,1]}, + {"x":2, "y":1, "matrix": [1,2]}, + {"x":0, "y":2, "matrix": [2,0]}, + {"x":1, "y":2, "matrix": [2,1]}, + {"x":2, "y":2, "matrix": [2,2]} + ] + } + }, - {"matrix": [1, 0], "x": 0, "y": 1}, - {"matrix": [1, 1], "x": 1, "y": 1}, - {"matrix": [1, 2], "x": 2, "y": 1}, - - {"matrix": [2, 0], "x": 0, "y": 2}, - {"matrix": [2, 1], "x": 1, "y": 2}, - {"matrix": [2, 2], "x": 2, "y": 2} - ] + "encoder": { + "rotary": [ + { "pin_a": "D0", "pin_b": "D1" } + ] + } - } -} +} \ No newline at end of file diff --git a/keyboards/themadnoodle/ncc1701kb/v2/keymaps/default/keymap.c b/keyboards/themadnoodle/ncc1701kb/v2/keymaps/default/keymap.c index 15b6df3b1a..52932a3baa 100644 --- a/keyboards/themadnoodle/ncc1701kb/v2/keymaps/default/keymap.c +++ b/keyboards/themadnoodle/ncc1701kb/v2/keymaps/default/keymap.c @@ -1,10 +1,13 @@ +// Copyright 2023 The Mad Noodle(@the_mad_noodle) +// SPDX-License-Identifier: GPL-2.0-or-later + #include QMK_KEYBOARD_H const uint16_t PROGMEM keymaps[][MATRIX_ROWS][MATRIX_COLS] = { - /* LAYER 0 - * ,-----------------------. - * | << | MUTE | >> | ENCODER - PRESS (MUTE) / HOLD (LAYER 2) / KNOB (VOLUME CONTROL) + /* LAYER 0 + * ,-------|ENCODER|-------. + * | << | MUTE | >> | * |-------+-------+-------| * | STOP | PLAY | MEDIA | * |-------+-------+-------| @@ -13,72 +16,70 @@ const uint16_t PROGMEM keymaps[][MATRIX_ROWS][MATRIX_COLS] = { */ [0] = LAYOUT_ortho_3x3( - KC_MPRV, LT(2, KC_MUTE), KC_MNXT, + KC_MPRV, LT(2, KC_MUTE), KC_MNXT, KC_MSTP, KC_MPLY, KC_MSEL, KC_CALC, KC_MAIL, LT(1, KC_MYCM) ), - /* LAYER 1 - * ,-----------------------. - * | MODE+ |RGB TOG| MODE- | ENCODER - PRESS (NA) / KNOB (Hue Control) + /* LAYER 1 + * ,-------|ENCODER|-------. + * | MODE+ |RGB TOG| MODE- | * |-------+-------+-------| - * | SPD- | SPD+ |Bright | + * |Bright-| PLAIN |Bright+| * |-------+-------+-------| - * | SAT+ | SAT- | | + * | SWIRL |BREATH | | * `-----------------------' */ - + [1] = LAYOUT_ortho_3x3( - RGB_MOD, RGB_TOG, RGB_RMOD, - RGB_SPI, RGB_SPD, RGB_VAI, - RGB_SAI, RGB_SAD, KC_TRNS + RGB_MOD, RGB_TOG, RGB_RMOD, + RGB_VAD, RGB_M_P, RGB_VAI, + LT(3,RGB_M_SW), RGB_M_B, KC_TRNS ), - - /* LAYER 2 (ENCODER) - * ,-----------------------. - * | | | | ENCODER - PRESS (NA) / KNOB (Arrow Left/Right) + + /* LAYER 2 + * ,-------|ENCODER|-------. + * | | | | * |-------+-------+-------| * | | | | * |-------+-------+-------| * | | | | * `-----------------------' */ - + [2] = LAYOUT_ortho_3x3( - KC_TRNS, KC_TRNS, KC_TRNS, - KC_TRNS, KC_TRNS, KC_TRNS, + KC_TRNS, KC_TRNS, KC_TRNS, + KC_TRNS, KC_TRNS, KC_TRNS, + KC_TRNS, KC_TRNS, KC_TRNS + ), + + + /* LAYER 3 + * ,-------|ENCODER|-------. + * | | | | + * |-------+-------+-------| + * | | | | + * |-------+-------+-------| + * | | | | + * `-----------------------' + */ + + [3] = LAYOUT_ortho_3x3( + KC_TRNS, KC_TRNS, KC_TRNS, + KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS ) }; -bool encoder_update_user(uint8_t index, bool clockwise) { - - switch (get_highest_layer(layer_state)) { - case 1: - if (clockwise) { - rgblight_increase_hue(); - } else { - rgblight_decrease_hue(); - } - break; - case 2: - if (clockwise) { - tap_code(KC_RGHT); - } else { - tap_code(KC_LEFT); - } - break; - default: - if (clockwise) { - tap_code(KC_VOLU); - } else { - tap_code(KC_VOLD); - } - break; - - } - return true; -} +/*Encoder Mapping*/ +#if defined(ENCODER_MAP_ENABLE) +const uint16_t PROGMEM encoder_map[][NUM_ENCODERS][NUM_DIRECTIONS] = { + [0] = { ENCODER_CCW_CW(KC_VOLD, KC_VOLU) }, + [1] = { ENCODER_CCW_CW(RGB_HUD, RGB_HUI) }, + [2] = { ENCODER_CCW_CW(KC_LEFT, KC_RGHT) }, + [3] = { ENCODER_CCW_CW(RGB_SAD, RGB_SAI) }, +}; +#endif diff --git a/keyboards/themadnoodle/ncc1701kb/v2/keymaps/default/rules.mk b/keyboards/themadnoodle/ncc1701kb/v2/keymaps/default/rules.mk new file mode 100644 index 0000000000..a40474b4d5 --- /dev/null +++ b/keyboards/themadnoodle/ncc1701kb/v2/keymaps/default/rules.mk @@ -0,0 +1 @@ +ENCODER_MAP_ENABLE = yes \ No newline at end of file diff --git a/keyboards/themadnoodle/ncc1701kb/v2/keymaps/via/keymap.c b/keyboards/themadnoodle/ncc1701kb/v2/keymaps/via/keymap.c new file mode 100644 index 0000000000..22ceb93c7e --- /dev/null +++ b/keyboards/themadnoodle/ncc1701kb/v2/keymaps/via/keymap.c @@ -0,0 +1,85 @@ +// Copyright 2023 The Mad Noodle(@the_mad_noodle) +// SPDX-License-Identifier: GPL-2.0-or-later + +#include QMK_KEYBOARD_H + +const uint16_t PROGMEM keymaps[][MATRIX_ROWS][MATRIX_COLS] = { + + /* LAYER 0 + * ,-------|ENCODER|-------. + * | << | MUTE | >> | + * |-------+-------+-------| + * | STOP | PLAY | MEDIA | + * |-------+-------+-------| + * | CALC | MY PC | TO(3) | + * `-----------------------' + */ + + [0] = LAYOUT_ortho_3x3( + KC_MPRV, KC_MUTE, KC_MNXT, + KC_MSTP, KC_MPLY, KC_MSEL, + KC_CALC, KC_MYCM, TO(3) + ), + + + /* LAYER 1 + * ,-------|ENCODER|-------. + * | MODE+ |RGB TOG| MODE- | + * |-------+-------+-------| + * |Bright-| PLAIN |Bright+| + * |-------+-------+-------| + * | SWIRL |BREATH | TO(0) | + * `-----------------------' + */ + + [1] = LAYOUT_ortho_3x3( + RGB_MOD, RGB_TOG, RGB_RMOD, + RGB_VAD, RGB_M_P, RGB_VAI, + RGB_M_SW, RGB_M_B, TO(0) + ), + + + /* LAYER 2 + * ,-------|ENCODER|-------. + * | | | | + * |-------+-------+-------| + * | | | | + * |-------+-------+-------| + * | | | TO(0) | + * `-----------------------' + */ + + [2] = LAYOUT_ortho_3x3( + KC_TRNS, KC_TRNS, KC_TRNS, + KC_TRNS, KC_TRNS, KC_TRNS, + KC_TRNS, KC_TRNS, TO(0) + ), + + + /* LAYER 3 + * ,-------|ENCODER|-------. + * | | | | + * |-------+-------+-------| + * | TO(1) | | TO(2) | + * |-------+-------+-------| + * | | | TO(0) | + * `-----------------------' + */ + + [3] = LAYOUT_ortho_3x3( + KC_TRNS, KC_TRNS, KC_TRNS, + TO(1), KC_TRNS, TO(2), + KC_TRNS, KC_TRNS, TO(0) + ) + +}; + +/*Encoder Mapping*/ +#if defined(ENCODER_MAP_ENABLE) +const uint16_t PROGMEM encoder_map[][NUM_ENCODERS][NUM_DIRECTIONS] = { + [0] = { ENCODER_CCW_CW(KC_VOLD, KC_VOLU)}, + [1] = { ENCODER_CCW_CW(RGB_HUD, RGB_HUI)}, + [2] = { ENCODER_CCW_CW(RGB_SAD, RGB_SAI)}, + [3] = { ENCODER_CCW_CW(KC_UP, KC_DOWN)}, +}; +#endif diff --git a/keyboards/themadnoodle/ncc1701kb/v2/keymaps/via/rules.mk b/keyboards/themadnoodle/ncc1701kb/v2/keymaps/via/rules.mk new file mode 100644 index 0000000000..6ccd6d9194 --- /dev/null +++ b/keyboards/themadnoodle/ncc1701kb/v2/keymaps/via/rules.mk @@ -0,0 +1,2 @@ +ENCODER_MAP_ENABLE = yes +VIA_ENABLE = yes \ No newline at end of file diff --git a/keyboards/themadnoodle/ncc1701kb/v2/readme.md b/keyboards/themadnoodle/ncc1701kb/v2/readme.md index 4e70dd3422..02639aeec3 100644 --- a/keyboards/themadnoodle/ncc1701kb/v2/readme.md +++ b/keyboards/themadnoodle/ncc1701kb/v2/readme.md @@ -1,17 +1,27 @@ -# NCC-1701-KB v2 Keypad with Encoder +# NCC-1701-KB v.2 -![NCC-1701-KB V2 TOP](https://static.wixstatic.com/media/59d0ff_e9812deb74a4408ca77599a19a8f93b6~mv2.jpg) -![NCC-1701-KB V2 RGB](https://static.wixstatic.com/media/59d0ff_7a8968b70ed849a591664332964cc936~mv2.jpg) +![NCC1701KBv2](https://i.imgur.com/Zq1SjBTh.jpg) -The NCC-1701-KB v2 by The Mad Noodle Prototypes is a custom Star Trek inspired 3x3 mechanical keypad with an encoder knob and full RGB Underglow. +*The NCC-1701-KB v.2 is a 8 key macro keypad with a push button encoder knob* -* Keyboard Maintainer: [The Mad Noodle Prototypes](https://github.com/The-Mad-Noodle) -* Hardware Supported: NCC-1701-KB v2 PCB, ATmega32U4 -* Hardware Availability: [MadNoodlePrototypes.com](https://www.madnoodleprototypes.com/shop) +* Keyboard Maintainer: [The Mad Noodle](https://github.com/The-Mad-Noodle) +* Hardware Supported: NCC-1701-KB v.2 PCB +* Hardware Availability: https://www.madnoodleprototypes.com/shop -Make example for this keyboard (after setting up your build environment): - make themadnoodle/ncc1701kb/v2:default +Compile example for this keyboard (after setting up your build environment): -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). + qmk compile -kb themadnoodle/ncc1701kb/v2 -km default + +Flashing example for this keyboard: + + qmk flash -kb themadnoodle/ncc1701kb/v2 -km default + +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 & Flashing + + +**Physical reset button**: + +* Press the physical button located on the top left of the back of the PCB (Labeled RST) to enter Bootloader Mode diff --git a/keyboards/themadnoodle/ncc1701kb/v2/rules.mk b/keyboards/themadnoodle/ncc1701kb/v2/rules.mk index dd5d8dbfe9..6e7633bfe0 100644 --- a/keyboards/themadnoodle/ncc1701kb/v2/rules.mk +++ b/keyboards/themadnoodle/ncc1701kb/v2/rules.mk @@ -1,14 +1 @@ -# Build Options -# change yes to no to disable -# -BOOTMAGIC_ENABLE = no # Enable Bootmagic Lite -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 -NKRO_ENABLE = yes # Enable N-Key Rollover -BACKLIGHT_ENABLE = no # Enable keyboard backlight functionality -RGBLIGHT_ENABLE = yes # Enable keyboard RGB underglow -AUDIO_ENABLE = no # Audio output -UNICODE_ENABLE = yes # Unicode -ENCODER_ENABLE = yes +# This file intentionally left blank