Add 6key to keyboards/handwired (#11226)
* Add 6key to keyboards/handwired * Add keyboards/handwired/6key folder * Add 6key.c * Add 6key.h * Add config.h * Add keymaps/default/keymap.c * Add readme.md * Add rules.mk * Add info.json * Apply suggestions from code review Co-authored-by: Drashna Jaelre <drashna@live.com> * Make changes based on pr comments * Apply formatting suggestions from code review Co-authored-by: Ryan <fauxpark@gmail.com> * Update keyboards/handwired/6key/rules.mk Co-authored-by: jyliang2 <jyliang2@illinois.edu> Co-authored-by: Drashna Jaelre <drashna@live.com> Co-authored-by: Ryan <fauxpark@gmail.com> Co-authored-by: Joel Challis <git@zvecr.com>
This commit is contained in:
		
							parent
							
								
									5d0c0e7c12
								
							
						
					
					
						commit
						0c4663a802
					
				
					 7 changed files with 179 additions and 0 deletions
				
			
		
							
								
								
									
										16
									
								
								keyboards/handwired/6key/6key.c
									
										
									
									
									
										Normal file
									
								
							
							
						
						
									
										16
									
								
								keyboards/handwired/6key/6key.c
									
										
									
									
									
										Normal file
									
								
							| 
						 | 
					@ -0,0 +1,16 @@
 | 
				
			||||||
 | 
					 /* Copyright 2020 Bratzworth 
 | 
				
			||||||
 | 
					  * 
 | 
				
			||||||
 | 
					  * 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 "6key.h"
 | 
				
			||||||
							
								
								
									
										27
									
								
								keyboards/handwired/6key/6key.h
									
										
									
									
									
										Normal file
									
								
							
							
						
						
									
										27
									
								
								keyboards/handwired/6key/6key.h
									
										
									
									
									
										Normal file
									
								
							| 
						 | 
					@ -0,0 +1,27 @@
 | 
				
			||||||
 | 
					 /* Copyright 2020 Bratzworth 
 | 
				
			||||||
 | 
					  * 
 | 
				
			||||||
 | 
					  * 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 "quantum.h"
 | 
				
			||||||
 | 
					
 | 
				
			||||||
 | 
					#define LAYOUT( \
 | 
				
			||||||
 | 
					      k00, k01, k02,    \
 | 
				
			||||||
 | 
					      k03, k04, k05     \
 | 
				
			||||||
 | 
					) \
 | 
				
			||||||
 | 
					{ \
 | 
				
			||||||
 | 
					    { k00, k01, k02 },  \
 | 
				
			||||||
 | 
					    { k03, k04, k05 }   \
 | 
				
			||||||
 | 
					} 
 | 
				
			||||||
							
								
								
									
										41
									
								
								keyboards/handwired/6key/config.h
									
										
									
									
									
										Normal file
									
								
							
							
						
						
									
										41
									
								
								keyboards/handwired/6key/config.h
									
										
									
									
									
										Normal file
									
								
							| 
						 | 
					@ -0,0 +1,41 @@
 | 
				
			||||||
 | 
					 /* Copyright 2020 Bratzworth 
 | 
				
			||||||
 | 
					  * 
 | 
				
			||||||
 | 
					  * 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"
 | 
				
			||||||
 | 
					
 | 
				
			||||||
 | 
					/* USB Device descriptor parameter */
 | 
				
			||||||
 | 
					#define VENDOR_ID       0xBEEF
 | 
				
			||||||
 | 
					#define PRODUCT_ID      0x0007
 | 
				
			||||||
 | 
					#define DEVICE_VER      0x0001
 | 
				
			||||||
 | 
					#define MANUFACTURER    Bratzworth
 | 
				
			||||||
 | 
					#define PRODUCT         6key
 | 
				
			||||||
 | 
					
 | 
				
			||||||
 | 
					/* key matrix size */
 | 
				
			||||||
 | 
					#define MATRIX_ROWS 2
 | 
				
			||||||
 | 
					#define MATRIX_COLS 3
 | 
				
			||||||
 | 
					
 | 
				
			||||||
 | 
					/* pin-out */
 | 
				
			||||||
 | 
					#define MATRIX_ROW_PINS { B4, D0 }
 | 
				
			||||||
 | 
					#define MATRIX_COL_PINS { D3, D2, D1 }
 | 
				
			||||||
 | 
					#define UNUSED_PINS
 | 
				
			||||||
 | 
					
 | 
				
			||||||
 | 
					/* dip switch */
 | 
				
			||||||
 | 
					#define DIP_SWITCH_PINS { C6 }
 | 
				
			||||||
 | 
					
 | 
				
			||||||
 | 
					/* COL2ROW or ROW2COL */
 | 
				
			||||||
 | 
					#define DIODE_DIRECTION COL2ROW
 | 
				
			||||||
							
								
								
									
										13
									
								
								keyboards/handwired/6key/info.json
									
										
									
									
									
										Normal file
									
								
							
							
						
						
									
										13
									
								
								keyboards/handwired/6key/info.json
									
										
									
									
									
										Normal file
									
								
							| 
						 | 
					@ -0,0 +1,13 @@
 | 
				
			||||||
 | 
					{
 | 
				
			||||||
 | 
					    "keyboard_name": "6key",
 | 
				
			||||||
 | 
					    "url": "https://github.com/Bratzworth/6key",
 | 
				
			||||||
 | 
					    "maintainer": "bratzworth",
 | 
				
			||||||
 | 
					    "width": 3,
 | 
				
			||||||
 | 
					    "height": 2,
 | 
				
			||||||
 | 
					    "layouts": {
 | 
				
			||||||
 | 
					      "LAYOUT": {
 | 
				
			||||||
 | 
					        "layout": [{"label":"k00", "x":0, "y":0}, {"label":"k01", "x":1, "y":0}, {"label":"k02", "x":2, "y":0}, {"label":"k10", "x":0, "y":1}, {"label":"k11", "x":1, "y":1}, {"label":"k12", "x":2, "y":1}]
 | 
				
			||||||
 | 
					      }
 | 
				
			||||||
 | 
					    }
 | 
				
			||||||
 | 
					  }
 | 
				
			||||||
 | 
					  
 | 
				
			||||||
							
								
								
									
										46
									
								
								keyboards/handwired/6key/keymaps/default/keymap.c
									
										
									
									
									
										Normal file
									
								
							
							
						
						
									
										46
									
								
								keyboards/handwired/6key/keymaps/default/keymap.c
									
										
									
									
									
										Normal file
									
								
							| 
						 | 
					@ -0,0 +1,46 @@
 | 
				
			||||||
 | 
					 /* Copyright 2020 Bratzworth 
 | 
				
			||||||
 | 
					  * 
 | 
				
			||||||
 | 
					  * 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
 | 
				
			||||||
 | 
					
 | 
				
			||||||
 | 
					#define _MAIN 0
 | 
				
			||||||
 | 
					#define _FN 1
 | 
				
			||||||
 | 
					
 | 
				
			||||||
 | 
					#define KC_UNDO LCTL(KC_Z)
 | 
				
			||||||
 | 
					#define KC_REDO LCTL(KC_Y)
 | 
				
			||||||
 | 
					
 | 
				
			||||||
 | 
					const uint16_t PROGMEM keymaps[][MATRIX_ROWS][MATRIX_COLS] = {
 | 
				
			||||||
 | 
					  [_MAIN] = LAYOUT(
 | 
				
			||||||
 | 
					    KC_UNDO,  KC_REDO,  KC_A,
 | 
				
			||||||
 | 
					    KC_C,     KC_D,     KC_S
 | 
				
			||||||
 | 
					  ),
 | 
				
			||||||
 | 
					
 | 
				
			||||||
 | 
					  [_FN] = LAYOUT(
 | 
				
			||||||
 | 
					    KC_F13, KC_F14, KC_F15,
 | 
				
			||||||
 | 
					    KC_F16, KC_F17, KC_F18
 | 
				
			||||||
 | 
					  )
 | 
				
			||||||
 | 
					};
 | 
				
			||||||
 | 
					
 | 
				
			||||||
 | 
					void dip_switch_update_user(uint8_t index, bool active) {
 | 
				
			||||||
 | 
					    switch (index) {
 | 
				
			||||||
 | 
					        case 0: {
 | 
				
			||||||
 | 
					            if (active) {
 | 
				
			||||||
 | 
					                set_single_persistent_default_layer(_FN);
 | 
				
			||||||
 | 
					            } else {
 | 
				
			||||||
 | 
					                set_single_persistent_default_layer(_MAIN);
 | 
				
			||||||
 | 
					            }
 | 
				
			||||||
 | 
					        }
 | 
				
			||||||
 | 
					    }
 | 
				
			||||||
 | 
					}
 | 
				
			||||||
							
								
								
									
										13
									
								
								keyboards/handwired/6key/readme.md
									
										
									
									
									
										Normal file
									
								
							
							
						
						
									
										13
									
								
								keyboards/handwired/6key/readme.md
									
										
									
									
									
										Normal file
									
								
							| 
						 | 
					@ -0,0 +1,13 @@
 | 
				
			||||||
 | 
					# 6key
 | 
				
			||||||
 | 
					
 | 
				
			||||||
 | 
					A 6-key macropad made by Bratzworth.
 | 
				
			||||||
 | 
					
 | 
				
			||||||
 | 
					* Keyboard Maintainer: [bratzworth](https://github.com/Bratzworth)
 | 
				
			||||||
 | 
					* Hardware Supported: Pro Micro ATmega32U4, Teensy 2.0
 | 
				
			||||||
 | 
					* Hardware Availability: [bratzworth](https://github.com/Bratzworth/6key)
 | 
				
			||||||
 | 
					
 | 
				
			||||||
 | 
					Make example for this keyboard (after setting up your build environment):
 | 
				
			||||||
 | 
					
 | 
				
			||||||
 | 
					    make handwired/6key:default
 | 
				
			||||||
 | 
					
 | 
				
			||||||
 | 
					See [build environment setup](https://docs.qmk.fm/#/getting_started_build_tools) then the [make instructions](https://docs.qmk.fm/#/getting_started_make_guide) for more information.
 | 
				
			||||||
							
								
								
									
										23
									
								
								keyboards/handwired/6key/rules.mk
									
										
									
									
									
										Normal file
									
								
							
							
						
						
									
										23
									
								
								keyboards/handwired/6key/rules.mk
									
										
									
									
									
										Normal file
									
								
							| 
						 | 
					@ -0,0 +1,23 @@
 | 
				
			||||||
 | 
					# MCU name
 | 
				
			||||||
 | 
					MCU = atmega32u4
 | 
				
			||||||
 | 
					
 | 
				
			||||||
 | 
					# Bootloader selection
 | 
				
			||||||
 | 
					BOOTLOADER = caterina
 | 
				
			||||||
 | 
					
 | 
				
			||||||
 | 
					# Build Options
 | 
				
			||||||
 | 
					#   change yes to no to disable
 | 
				
			||||||
 | 
					#
 | 
				
			||||||
 | 
					BOOTMAGIC_ENABLE = no       # 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 = no       # Enable keyboard backlight functionality
 | 
				
			||||||
 | 
					RGBLIGHT_ENABLE = no        # Enable keyboard RGB underglow
 | 
				
			||||||
 | 
					BLUETOOTH_ENABLE = no       # Enable Bluetooth
 | 
				
			||||||
 | 
					AUDIO_ENABLE = no           # Audio output
 | 
				
			||||||
 | 
					DIP_SWITCH_ENABLE = yes
 | 
				
			||||||
		Loading…
	
	Add table
		Add a link
		
	
		Reference in a new issue