* update "Hardware Availability" * add a section of "How to build" * update "Hardware Supported" * add SPLIT_HAND_MATRIX_GRID_LOW_IS_RIGHT for rev3_4rows/config.h Co-authored-by: keyaki-namiki <28521374+keyaki-namiki@users.noreply.github.com>
		
			
				
	
	
		
			247 lines
		
	
	
		
			8.2 KiB
		
	
	
	
		
			C
		
	
	
	
	
	
			
		
		
	
	
			247 lines
		
	
	
		
			8.2 KiB
		
	
	
	
		
			C
		
	
	
	
	
	
| /*
 | |
| Copyright 2020 yushakobo
 | |
| 
 | |
| 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 "config_common.h"
 | |
| #include <stdio.h>
 | |
| 
 | |
| /* USB Device descriptor parameter */
 | |
| #define VENDOR_ID 0x3265 //yushakobo
 | |
| #define PRODUCT_ID 0x0004 //Helix rev3 4rows
 | |
| #define DEVICE_VER 0x0001
 | |
| #define MANUFACTURER yushakobo
 | |
| #define PRODUCT Helix rev3 4rows
 | |
| 
 | |
| /* key matrix size */
 | |
| #define MATRIX_ROWS 8
 | |
| #define MATRIX_COLS 7
 | |
| 
 | |
| /*
 | |
|  * Keyboard Matrix Assignments
 | |
|  *
 | |
|  * Change this to how you wired your keyboard
 | |
|  * COLS: AVR pins used for columns, left to right
 | |
|  * ROWS: AVR pins used for rows, top to bottom
 | |
|  * DIODE_DIRECTION: COL2ROW = COL = Anode (+), ROW = Cathode (-, marked on diode)
 | |
|  *                  ROW2COL = ROW = Anode (+), COL = Cathode (-, marked on diode)
 | |
|  *
 | |
|  */
 | |
| #define MATRIX_ROW_PINS { D4, C6, D7, E6 }
 | |
| #define MATRIX_COL_PINS { F4, F5, F6, F7, B1, B3, B2 }
 | |
| #define UNUSED_PINS
 | |
| 
 | |
| /* COL2ROW, ROW2COL*/
 | |
| #define DIODE_DIRECTION COL2ROW
 | |
| 
 | |
| /* Split hand configration */
 | |
| #define SPLIT_HAND_MATRIX_GRID D7,B2
 | |
| #define SPLIT_HAND_MATRIX_GRID_LOW_IS_RIGHT
 | |
| 
 | |
| /* Dip switch on matrix grid */
 | |
| #define DIP_SWITCH_MATRIX_GRID { {0,6}, {1,6}, {5,6}, {6,6} }
 | |
| 
 | |
| /*
 | |
|  * Split Keyboard specific options, make sure you have 'SPLIT_KEYBOARD = yes' in your rules.mk, and define SOFT_SERIAL_PIN.
 | |
|  */
 | |
| #define SOFT_SERIAL_PIN D2  // or D1, D2, D3, E6
 | |
| 
 | |
| #define RGB_DI_PIN D3
 | |
| #define RGBLED_NUM 50 // Number of LEDs
 | |
| 
 | |
| #ifdef RGB_MATRIX_ENABLE
 | |
|   #define DRIVER_LED_TOTAL RGBLED_NUM
 | |
| #   define RGB_MATRIX_KEYPRESSES // reacts to keypresses
 | |
| // #   define RGB_MATRIX_KEYRELEASES // reacts to keyreleases (instead of keypresses)
 | |
| // #   define RGB_DISABLE_AFTER_TIMEOUT 0 // number of ticks to wait until disabling effects
 | |
| #   define RGB_DISABLE_WHEN_USB_SUSPENDED true // turn off effects when suspended
 | |
| #   define RGB_MATRIX_FRAMEBUFFER_EFFECTS
 | |
| // #   define RGB_MATRIX_LED_PROCESS_LIMIT (DRIVER_LED_TOTAL + 4) / 5 // limits the number of LEDs to process in an animation per task run (increases keyboard responsiveness)
 | |
| // #   define RGB_MATRIX_LED_FLUSH_LIMIT 16 // limits in milliseconds how frequently an animation will update the LEDs. 16 (16ms) is equivalent to limiting to 60fps (increases keyboard responsiveness)
 | |
| #    define RGB_MATRIX_MAXIMUM_BRIGHTNESS 150 // limits maximum brightness of LEDs to 150 out of 255. Higher may cause the controller to crash.
 | |
| #    define RGB_MATRIX_HUE_STEP 8
 | |
| #    define RGB_MATRIX_SAT_STEP 8
 | |
| #    define RGB_MATRIX_VAL_STEP 8
 | |
| #    define RGB_MATRIX_SPD_STEP 10
 | |
| #endif
 | |
| 
 | |
| #ifdef RGBLIGHT_ENABLE
 | |
|   #define RGBLIGHT_SPLIT
 | |
|   #define RGBLED_SPLIT { 25, 25 }
 | |
| //   #define RGBLIGHT_HUE_STEP 8
 | |
| //   #define RGBLIGHT_SAT_STEP 8
 | |
| //   #define RGBLIGHT_VAL_STEP 8
 | |
|    #define RGBLIGHT_LIMIT_VAL 120 /* The maximum brightness level */
 | |
| //   #define RGBLIGHT_SLEEP  /* If defined, the RGB lighting will be switched off when the host goes to sleep */
 | |
| // /*== all animations enable ==*/
 | |
| //   #define RGBLIGHT_ANIMATIONS
 | |
| // /*== or choose animations ==*/
 | |
| //   #define RGBLIGHT_EFFECT_BREATHING
 | |
|    #define RGBLIGHT_EFFECT_RAINBOW_MOOD
 | |
|    #define RGBLIGHT_EFFECT_RAINBOW_SWIRL
 | |
| //   #define RGBLIGHT_EFFECT_SNAKE
 | |
| //   #define RGBLIGHT_EFFECT_KNIGHT
 | |
| //   #define RGBLIGHT_EFFECT_CHRISTMAS
 | |
|    #define RGBLIGHT_EFFECT_STATIC_GRADIENT
 | |
|    #define RGBLIGHT_EFFECT_RGB_TEST
 | |
| //   #define RGBLIGHT_EFFECT_ALTERNATING
 | |
| #endif
 | |
| 
 | |
| /* Custom font */
 | |
| #define OLED_FONT_H "keyboards/helix/common/glcdfont.c"
 | |
| 
 | |
| /* Encorder */
 | |
| #define ENCODERS_PAD_A { B6 }
 | |
| #define ENCODERS_PAD_B { B5 }
 | |
| 
 | |
| /* Debounce reduces chatter (unintended double-presses) - set 0 if debouncing is not needed */
 | |
| #define DEBOUNCE 5
 | |
| 
 | |
| /* define if matrix has ghost (lacks anti-ghosting diodes) */
 | |
| //#define MATRIX_HAS_GHOST
 | |
| 
 | |
| /* Mechanical locking support. Use KC_LCAP, KC_LNUM or KC_LSCR instead in keymap */
 | |
| #define LOCKING_SUPPORT_ENABLE
 | |
| /* Locking resynchronize hack */
 | |
| #define LOCKING_RESYNC_ENABLE
 | |
| 
 | |
| /* If defined, GRAVE_ESC will always act as ESC when CTRL is held.
 | |
|  * This is userful for the Windows task manager shortcut (ctrl+shift+esc).
 | |
|  */
 | |
| // #define GRAVE_ESC_CTRL_OVERRIDE
 | |
| 
 | |
| /*
 | |
|  * Force NKRO
 | |
|  *
 | |
|  * Force NKRO (nKey Rollover) to be enabled by default, regardless of the saved
 | |
|  * state in the bootmagic EEPROM settings. (Note that NKRO must be enabled in the
 | |
|  * makefile for this to work.)
 | |
|  *
 | |
|  * If forced on, NKRO can be disabled via magic key (default = LShift+RShift+N)
 | |
|  * until the next keyboard reset.
 | |
|  *
 | |
|  * NKRO may prevent your keystrokes from being detected in the BIOS, but it is
 | |
|  * fully operational during normal computer usage.
 | |
|  *
 | |
|  * For a less heavy-handed approach, enable NKRO via magic key (LShift+RShift+N)
 | |
|  * or via bootmagic (hold SPACE+N while plugging in the keyboard). Once set by
 | |
|  * bootmagic, NKRO mode will always be enabled until it is toggled again during a
 | |
|  * power-up.
 | |
|  *
 | |
|  */
 | |
| //#define FORCE_NKRO
 | |
| 
 | |
| /*
 | |
|  * Magic Key Options
 | |
|  *
 | |
|  * Magic keys are hotkey commands that allow control over firmware functions of
 | |
|  * the keyboard. They are best used in combination with the HID Listen program,
 | |
|  * found here: https://www.pjrc.com/teensy/hid_listen.html
 | |
|  *
 | |
|  * The options below allow the magic key functionality to be changed. This is
 | |
|  * useful if your keyboard/keypad is missing keys and you want magic key support.
 | |
|  *
 | |
|  */
 | |
| 
 | |
| /* key combination for magic key command */
 | |
| /* defined by default; to change, uncomment and set to the combination you want */
 | |
| // #define IS_COMMAND() (get_mods() == MOD_MASK_SHIFT)
 | |
| 
 | |
| /* control how magic key switches layers */
 | |
| //#define MAGIC_KEY_SWITCH_LAYER_WITH_FKEYS  true
 | |
| //#define MAGIC_KEY_SWITCH_LAYER_WITH_NKEYS  true
 | |
| //#define MAGIC_KEY_SWITCH_LAYER_WITH_CUSTOM false
 | |
| 
 | |
| /* override magic key keymap */
 | |
| //#define MAGIC_KEY_SWITCH_LAYER_WITH_FKEYS
 | |
| //#define MAGIC_KEY_SWITCH_LAYER_WITH_NKEYS
 | |
| //#define MAGIC_KEY_SWITCH_LAYER_WITH_CUSTOM
 | |
| //#define MAGIC_KEY_HELP           H
 | |
| //#define MAGIC_KEY_HELP_ALT       SLASH
 | |
| //#define MAGIC_KEY_DEBUG          D
 | |
| //#define MAGIC_KEY_DEBUG_MATRIX   X
 | |
| //#define MAGIC_KEY_DEBUG_KBD      K
 | |
| //#define MAGIC_KEY_DEBUG_MOUSE    M
 | |
| //#define MAGIC_KEY_VERSION        V
 | |
| //#define MAGIC_KEY_STATUS         S
 | |
| //#define MAGIC_KEY_CONSOLE        C
 | |
| //#define MAGIC_KEY_LAYER0         0
 | |
| //#define MAGIC_KEY_LAYER0_ALT     GRAVE
 | |
| //#define MAGIC_KEY_LAYER1         1
 | |
| //#define MAGIC_KEY_LAYER2         2
 | |
| //#define MAGIC_KEY_LAYER3         3
 | |
| //#define MAGIC_KEY_LAYER4         4
 | |
| //#define MAGIC_KEY_LAYER5         5
 | |
| //#define MAGIC_KEY_LAYER6         6
 | |
| //#define MAGIC_KEY_LAYER7         7
 | |
| //#define MAGIC_KEY_LAYER8         8
 | |
| //#define MAGIC_KEY_LAYER9         9
 | |
| //#define MAGIC_KEY_BOOTLOADER     B
 | |
| //#define MAGIC_KEY_BOOTLOADER_ALT ESC
 | |
| //#define MAGIC_KEY_LOCK           CAPS
 | |
| //#define MAGIC_KEY_EEPROM         E
 | |
| //#define MAGIC_KEY_EEPROM_CLEAR   BSPACE
 | |
| //#define MAGIC_KEY_NKRO           N
 | |
| //#define MAGIC_KEY_SLEEP_LED      Z
 | |
| 
 | |
| /*
 | |
|  * Feature disable options
 | |
|  *  These options are also useful to firmware size reduction.
 | |
|  */
 | |
| 
 | |
| /* disable debug print */
 | |
| //#define NO_DEBUG
 | |
| 
 | |
| /* disable print */
 | |
| //#define NO_PRINT
 | |
| 
 | |
| /* disable action features */
 | |
| //#define NO_ACTION_LAYER
 | |
| //#define NO_ACTION_TAPPING
 | |
| //#define NO_ACTION_ONESHOT
 | |
| 
 | |
| /* disable these deprecated features by default */
 | |
| #define NO_ACTION_MACRO
 | |
| #define NO_ACTION_FUNCTION
 | |
| 
 | |
| /*
 | |
|  * MIDI options
 | |
|  */
 | |
| 
 | |
| /* Prevent use of disabled MIDI features in the keymap */
 | |
| //#define MIDI_ENABLE_STRICT 1
 | |
| 
 | |
| /* enable basic MIDI features:
 | |
|    - MIDI notes can be sent when in Music mode is on
 | |
| */
 | |
| //#define MIDI_BASIC
 | |
| 
 | |
| /* enable advanced MIDI features:
 | |
|    - MIDI notes can be added to the keymap
 | |
|    - Octave shift and transpose
 | |
|    - Virtual sustain, portamento, and modulation wheel
 | |
|    - etc.
 | |
| */
 | |
| //#define MIDI_ADVANCED
 | |
| 
 | |
| /* override number of MIDI tone keycodes (each octave adds 12 keycodes and allocates 12 bytes) */
 | |
| //#define MIDI_TONE_KEYCODE_OCTAVES 1
 | |
| 
 | |
| /* Bootmagic Lite key configuration */
 | |
| // #define BOOTMAGIC_LITE_ROW 0
 | |
| // #define BOOTMAGIC_LITE_COLUMN 0
 |