diff options
author | Jay Greco <jayv.greco@gmail.com> | 2020-10-22 23:47:14 -0700 |
---|---|---|
committer | GitHub <noreply@github.com> | 2020-10-23 17:47:14 +1100 |
commit | 999326acc81687794e25ad7731f37da59881e0ca (patch) | |
tree | ceb786ae2dac25486a57c5ed004e921677c922b1 /keyboards/nullbitsco/nibble/keymaps/via | |
parent | 8cbaea9e8d00b959ccb1b474fa8a81417b651de2 (diff) |
Add nullbits nibble (#9250)
* Add NIBBLE keyboard
* Update VID for VIA compatibility
* Add QMK PR feedback
* Update matrix_init_remote_kb()
* Update with requested changes
Clean up config, makefile rules, and keymap files
* Update with changes for unified ANSI/ISO layout
* Add NO_USB_STARTUP_CHECK note in readme
* Add license info, update with PR changes
-Refactor encoder, via_extras code
-Refactor VIA specific code to live in keymap folder
-Remove non-inclusive naming in remote keyboard.c/h
-Add documentation to remote_keyboard.c
-Add compiler check for vusb_detect for non-avr micros
* Fix print formatter in encoder handler
Co-authored-by: Nick Brassel <nick@tzarc.org>
* Small PR updates
-Remove unneded matrix code from nibble.c
-Clean up include code in nibble_encoder.h
* Update Big LED headerfile
-Declare Big LED functions in header file (derp)
* Update keyboards/nullbitsco/nibble/nibble.c
-Update with drashna's suggested CAPS LED code change
Co-authored-by: Drashna Jaelre <drashna@live.com>
* Update keyboards/nullbitsco/nibble/rules.mk
-Update with drasha's suggested makefile formatting changes
Co-authored-by: Drashna Jaelre <drashna@live.com>
* Fix caps_lock typo
Co-authored-by: Nick Brassel <nick@tzarc.org>
Co-authored-by: Drashna Jaelre <drashna@live.com>
Diffstat (limited to 'keyboards/nullbitsco/nibble/keymaps/via')
-rw-r--r-- | keyboards/nullbitsco/nibble/keymaps/via/config.h | 21 | ||||
-rw-r--r-- | keyboards/nullbitsco/nibble/keymaps/via/keymap.c | 164 | ||||
-rw-r--r-- | keyboards/nullbitsco/nibble/keymaps/via/nibble_encoder.c | 133 | ||||
-rw-r--r-- | keyboards/nullbitsco/nibble/keymaps/via/nibble_encoder.h | 50 | ||||
-rw-r--r-- | keyboards/nullbitsco/nibble/keymaps/via/rules.mk | 4 | ||||
-rw-r--r-- | keyboards/nullbitsco/nibble/keymaps/via/via_extras.c | 129 | ||||
-rw-r--r-- | keyboards/nullbitsco/nibble/keymaps/via/via_extras.h | 39 |
7 files changed, 540 insertions, 0 deletions
diff --git a/keyboards/nullbitsco/nibble/keymaps/via/config.h b/keyboards/nullbitsco/nibble/keymaps/via/config.h new file mode 100644 index 0000000000..961e2aed1a --- /dev/null +++ b/keyboards/nullbitsco/nibble/keymaps/via/config.h @@ -0,0 +1,21 @@ +/* Copyright 2020 Jay Greco + * + * 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/>. + */ +// Custom config starts after VIA's EEPROM usage, +// dynamic keymaps start after this. +// Custom config Usage: +// 1 for enabled encoder modes (1 byte) +// 6 for 3x custom encoder settings, left, right, and press (18 bytes) +#define VIA_EEPROM_CUSTOM_CONFIG_SIZE 19
\ No newline at end of file diff --git a/keyboards/nullbitsco/nibble/keymaps/via/keymap.c b/keyboards/nullbitsco/nibble/keymaps/via/keymap.c new file mode 100644 index 0000000000..1e1b0c0369 --- /dev/null +++ b/keyboards/nullbitsco/nibble/keymaps/via/keymap.c @@ -0,0 +1,164 @@ +/* Copyright 2020 Jay Greco + * + * 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 +#include "via_extras.h" + +#define _BASE 0 +#define _VIA1 1 +#define _VIA2 2 +#define _VIA3 3 + +#define KC_DISC_MUTE KC_F23 +#define KC_DISC_DEAF KC_F24 +#define NUM_CUST_KEYCODES (_NUM_CUST_KCS - SAFE_RANGE) +#define VIA_KEYCODE_RANGE 0x5F80 + +enum custom_keycodes { + PROG = SAFE_RANGE, + DISC_MUTE, + DISC_DEAF, + SUPER_ALT_TAB, + _NUM_CUST_KCS, +}; + +// Macro variables +bool is_alt_tab_active = false; +uint16_t alt_tab_timer = 0; +bool muted = false; +bool deafened = false; + +const uint16_t PROGMEM keymaps[][MATRIX_ROWS][MATRIX_COLS] = { + [_BASE] = LAYOUT_all( + KC_NUBS, KC_GESC, 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_HOME, + KC_F13, 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_F14, 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_PGUP, + KC_F15, 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_UP, KC_PGDN, + KC_F16, KC_LCTL, KC_LGUI, KC_LALT, KC_SPC, MO(_VIA1), KC_RALT, KC_RCTL, KC_LEFT, KC_DOWN, KC_RGHT + ), + + [_VIA1] = LAYOUT_all( + _______, RESET, 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_HOME, KC_INS, + RGB_TOG, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, + _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, + _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, + _______, _______, _______, _______, _______, _______, _______, _______, KC_MPRV, KC_MPLY, KC_MNXT + ), + + [_VIA2] = LAYOUT_all( + _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, + _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, + _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, + _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, + _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______ + ), + + [_VIA3] = LAYOUT_all( + _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, + _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, + _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, + _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, + _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______ + ), + +}; + +void map_via_keycode(uint16_t * keycode) { + if (abs(*keycode - VIA_KEYCODE_RANGE) < NUM_CUST_KEYCODES) { //make into macro? + dprintf("VIA custom keycode found, mapping to QMK keycode.\n"); + uint16_t new_keycode = (*keycode - VIA_KEYCODE_RANGE) + SAFE_RANGE; + dprintf("VIA KC: %u QMK KC: %u\n", *keycode, new_keycode); + *keycode = new_keycode; + } +} + +bool process_record_user(uint16_t keycode, keyrecord_t *record) { + map_via_keycode(&keycode); + // Send keystrokes to host keyboard, if connected (see readme) + process_record_remote_kb(keycode, record); + switch(keycode) { + case PROG: + if (record->event.pressed) { + rgblight_disable_noeeprom(); + bootloader_jump(); + } + break; + + case DISC_MUTE: + if (record->event.pressed) { + tap_code(KC_DISC_MUTE); + if (!rgblight_is_enabled()) break; + + if (muted) { + rgblight_enable_noeeprom(); + } else { + rgblight_timer_disable(); + uint8_t val = rgblight_get_val(); + rgblight_sethsv_range(255, 255, val, 0, 1); + } + muted = !muted; + } + break; + + case DISC_DEAF: + if (record->event.pressed) { + tap_code(KC_DISC_DEAF); + if (!rgblight_is_enabled()) break; + + if (deafened) { + rgblight_enable_noeeprom(); + } else { + rgblight_timer_disable(); + uint8_t val = rgblight_get_val(); + rgblight_sethsv_range(255, 255, val, 0, RGBLED_NUM-1); + } + deafened = !deafened; + } + break; + + case SUPER_ALT_TAB: + if (record->event.pressed) { + if (!is_alt_tab_active) { + is_alt_tab_active = true; + register_code(KC_LALT); + } + alt_tab_timer = timer_read(); + register_code(KC_TAB); + } else { + unregister_code(KC_TAB); + } + break; + + default: + break; + } +return true; +} + +void matrix_init_user(void) { + // Initialize remote keyboard, if connected (see readme) + matrix_init_remote_kb(); +} + +void matrix_scan_user(void) { + // Scan and parse keystrokes from remote keyboard, if connected (see readme) + matrix_scan_remote_kb(); + if (is_alt_tab_active) { + if (timer_elapsed(alt_tab_timer) > 1000) { + unregister_code(KC_LALT); + is_alt_tab_active = false; + } + } +}
\ No newline at end of file diff --git a/keyboards/nullbitsco/nibble/keymaps/via/nibble_encoder.c b/keyboards/nullbitsco/nibble/keymaps/via/nibble_encoder.c new file mode 100644 index 0000000000..bdea1869c2 --- /dev/null +++ b/keyboards/nullbitsco/nibble/keymaps/via/nibble_encoder.c @@ -0,0 +1,133 @@ +/* Copyright 2020 Jay Greco + * + * 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 "nibble_encoder.h" + +uint8_t encoder_value = 0x20, + encoder_mode = ENC_MODE_VOLUME, + enabled_encoder_modes = 0x1F; + +uint16_t retrieve_custom_encoder_config(uint8_t encoder_idx, uint8_t behavior) { +#ifdef DYNAMIC_KEYMAP_ENABLE + void* addr = (void*)(EEPROM_CUSTOM_ENCODER + (encoder_idx * 6) + (behavior * 2)); + uint16_t keycode = eeprom_read_byte(addr) << 8; + keycode |= eeprom_read_byte(addr + 1); + return keycode; +#else + return 0; +#endif +} + +void set_custom_encoder_config(uint8_t encoder_idx, uint8_t behavior, uint16_t new_code) { +#ifdef DYNAMIC_KEYMAP_ENABLE + void* addr = (void*)(EEPROM_CUSTOM_ENCODER + (encoder_idx * 6) + (behavior * 2)); + eeprom_update_byte(addr, (uint8_t)(new_code >> 8)); + eeprom_update_byte(addr + 1, (uint8_t)(new_code & 0xFF)); +#endif +} + +void pre_encoder_mode_change(void) { + dprintf("Changing encoder mode: %u\n", encoder_mode); +} + +void post_encoder_mode_change(void) { + dprintf("Encoder mode: %u\n", encoder_mode); +} + +//??? +void change_encoder_mode(bool clockwise) { + pre_encoder_mode_change(); + if(enabled_encoder_modes == 0){ + enabled_encoder_modes = 0x1F; + } + do { + if(!clockwise){ + if (encoder_mode == 0){ + encoder_mode = _NUM_ENCODER_MODES - 1; + } else{ + encoder_mode = encoder_mode - 1; + } + } else { + encoder_mode = (encoder_mode + 1) % _NUM_ENCODER_MODES; + } + } while(((1 << encoder_mode) & enabled_encoder_modes) == 0); + post_encoder_mode_change(); +} + +uint16_t handle_encoder_cw(void) { + dprintf("Encoder mode: %u\n", encoder_mode); + uint16_t mapped_code = 0; + switch(encoder_mode){ + default: + break; + case ENC_MODE_VOLUME: + mapped_code = KC_VOLU; + break; + case ENC_MODE_MEDIA: + mapped_code = KC_MEDIA_NEXT_TRACK; + break; + case ENC_MODE_SCROLL: + mapped_code = KC_WH_D; + break; + case ENC_MODE_BACKLIGHT: + mapped_code = RGB_VAI; + break; +#ifdef DYNAMIC_KEYMAP_ENABLE + case ENC_MODE_CUSTOM0: + mapped_code = retrieve_custom_encoder_config(0, ENC_CUSTOM_CW); + break; + case ENC_MODE_CUSTOM1: + mapped_code = retrieve_custom_encoder_config(1, ENC_CUSTOM_CW); + break; + case ENC_MODE_CUSTOM2: + mapped_code = retrieve_custom_encoder_config(2, ENC_CUSTOM_CW); + break; +#endif + } + return mapped_code; +} + +uint16_t handle_encoder_ccw(void) { + dprintf("Encoder mode: %u\n", encoder_mode); + uint16_t mapped_code = 0; + switch(encoder_mode){ + default: + break; + case ENC_MODE_VOLUME: + mapped_code = KC_VOLD; + break; + case ENC_MODE_MEDIA: + mapped_code = KC_MEDIA_PREV_TRACK; + break; + case ENC_MODE_SCROLL: + mapped_code = KC_WH_U; + break; + case ENC_MODE_BACKLIGHT: + mapped_code = RGB_VAD; + break; +#ifdef DYNAMIC_KEYMAP_ENABLE + case ENC_MODE_CUSTOM0: + mapped_code = retrieve_custom_encoder_config(0, ENC_CUSTOM_CCW); + break; + case ENC_MODE_CUSTOM1: + mapped_code = retrieve_custom_encoder_config(1, ENC_CUSTOM_CCW); + break; + case ENC_MODE_CUSTOM2: + mapped_code = retrieve_custom_encoder_config(2, ENC_CUSTOM_CCW); + break; +#endif + } + return mapped_code; +} diff --git a/keyboards/nullbitsco/nibble/keymaps/via/nibble_encoder.h b/keyboards/nullbitsco/nibble/keymaps/via/nibble_encoder.h new file mode 100644 index 0000000000..fc1e61434b --- /dev/null +++ b/keyboards/nullbitsco/nibble/keymaps/via/nibble_encoder.h @@ -0,0 +1,50 @@ +/* Copyright 2020 Jay Greco + * + * 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/>. + */ +#pragma once + +#include QMK_KEYBOARD_H +#include "eeprom.h" + +#define EEPROM_ENABLED_ENCODER_MODES (VIA_EEPROM_CUSTOM_CONFIG_ADDR) +#define EEPROM_CUSTOM_ENCODER (VIA_EEPROM_CUSTOM_CONFIG_ADDR+1) + +enum encoder_modes { + ENC_MODE_VOLUME, + ENC_MODE_MEDIA, + ENC_MODE_SCROLL, + ENC_MODE_BRIGHTNESS, + ENC_MODE_BACKLIGHT, + ENC_MODE_CUSTOM0, + ENC_MODE_CUSTOM1, + ENC_MODE_CUSTOM2, + _NUM_ENCODER_MODES, +}; + +enum custom_encoder_behavior { + ENC_CUSTOM_CW = 0, + ENC_CUSTOM_CCW, + ENC_CUSTOM_PRESS +}; + +uint16_t + retrieve_custom_encoder_config(uint8_t encoder_idx, uint8_t behavior), + handle_encoder_cw(void), + handle_encoder_ccw(void); + +void set_custom_encoder_config(uint8_t encoder_idx, uint8_t behavior, uint16_t new_code), + pre_encoder_mode_change(void), + post_encoder_mode_change(void), + change_encoder_mode(bool clockwise);
\ No newline at end of file diff --git a/keyboards/nullbitsco/nibble/keymaps/via/rules.mk b/keyboards/nullbitsco/nibble/keymaps/via/rules.mk new file mode 100644 index 0000000000..ee197efc02 --- /dev/null +++ b/keyboards/nullbitsco/nibble/keymaps/via/rules.mk @@ -0,0 +1,4 @@ +VIA_ENABLE = yes + +SRC += keymaps/via/nibble_encoder.c +SRC += keymaps/via/via_extras.c
\ No newline at end of file diff --git a/keyboards/nullbitsco/nibble/keymaps/via/via_extras.c b/keyboards/nullbitsco/nibble/keymaps/via/via_extras.c new file mode 100644 index 0000000000..067296b76b --- /dev/null +++ b/keyboards/nullbitsco/nibble/keymaps/via/via_extras.c @@ -0,0 +1,129 @@ +/* Copyright 2020 Jay Greco + * + * 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 "via_extras.h" + +// Encoder Behavior +extern uint8_t encoder_value; +extern uint8_t encoder_mode; +extern uint8_t enabled_encoder_modes; + +void raw_hid_receive_kb( uint8_t *data, uint8_t length ) +{ + uint8_t *command_id = &(data[0]); + uint8_t *command_data = &(data[1]); + dprintf("raw hid recv! command_id: %u\n",*command_id); + switch ( *command_id ) + { + case id_get_keyboard_value: + { + switch( command_data[0]) + { + case id_encoder_modes: + { + command_data[1] = enabled_encoder_modes; + dprintf("[read] enabled_encoder_modes: %u\n", enabled_encoder_modes); + } + break; + + case id_encoder_custom: + { + uint8_t custom_encoder_idx = command_data[1]; + uint16_t keycode = retrieve_custom_encoder_config(custom_encoder_idx, ENC_CUSTOM_CW); + command_data[2] = keycode >> 8; + command_data[3] = keycode & 0xFF; + keycode = retrieve_custom_encoder_config(custom_encoder_idx, ENC_CUSTOM_CCW); + command_data[4] = keycode >> 8; + command_data[5] = keycode & 0xFF; + keycode = retrieve_custom_encoder_config(custom_encoder_idx, ENC_CUSTOM_PRESS); + command_data[6] = keycode >> 8; + command_data[7] = keycode & 0xFF; + } + break; + + default: + { + *command_id = id_unhandled; + } + break; + } + } + break; + case id_set_keyboard_value: + { + switch(command_data[0]){ + case id_encoder_modes: + { + enabled_encoder_modes = command_data[1]; + dprintf("[write] enabled_encoder_modes: %u\n", enabled_encoder_modes); + eeprom_update_byte((uint8_t*)EEPROM_ENABLED_ENCODER_MODES, enabled_encoder_modes); + } + break; + + case id_encoder_custom: + { + uint8_t custom_encoder_idx = command_data[1]; + uint8_t encoder_behavior = command_data[2]; + uint16_t keycode = (command_data[3] << 8) | command_data[4]; + set_custom_encoder_config(custom_encoder_idx, encoder_behavior, keycode); + } + break; + + default: + { + *command_id = id_unhandled; + } + break; + } + } + break; + + default: + { + // Unhandled message. + *command_id = id_unhandled; + } + break; + } +} + +void encoder_update_kb(uint8_t index, bool clockwise) { + if (layer_state_is(1)) { + change_encoder_mode(clockwise); + return; + } + uint16_t mapped_code = 0; + if (clockwise) { + mapped_code = handle_encoder_cw(); + } else { + mapped_code = handle_encoder_ccw(); + } + if(mapped_code != 0){ + tap_code16(mapped_code); + } +} + +void custom_config_load(void){ +#ifdef DYNAMIC_KEYMAP_ENABLE + enabled_encoder_modes = eeprom_read_byte((uint8_t*)EEPROM_ENABLED_ENCODER_MODES); +#endif +} + +void via_init_kb(void) +{ + dprintf("VIA is enabled.\n"); + custom_config_load(); +} diff --git a/keyboards/nullbitsco/nibble/keymaps/via/via_extras.h b/keyboards/nullbitsco/nibble/keymaps/via/via_extras.h new file mode 100644 index 0000000000..83c3c13128 --- /dev/null +++ b/keyboards/nullbitsco/nibble/keymaps/via/via_extras.h @@ -0,0 +1,39 @@ +/* Copyright 2020 Jay Greco + * + * 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/>. + */ +#pragma once + +#include "nibble_encoder.h" +#include "via.h" +#include "raw_hid.h" +#include "dynamic_keymap.h" +#include "tmk_core/common/eeprom.h" + +enum nibble_keyboard_value_id { + id_encoder_modes = 0x80, + id_unused_mode_1, + id_encoder_custom, + id_unused_mode_2 +}; + +// Encoder Behavior +extern uint8_t encoder_value, + encoder_mode, + enabled_encoder_modes; + +void raw_hid_receive_kb(uint8_t *data, uint8_t length), + encoder_update_kb(uint8_t index, bool clockwise), + custom_config_load(void), + via_init_kb(void);
\ No newline at end of file |