[Keyboard] Aplx2 osu! keyboard (#8847)

* Create test.txt * aplx6 * Delete test.txt * fff * Delete ffff * test compile * Create README.md * edited * requests * Update keyboards/aplx6/README.md * Update keyboards/aplx6/README.md * Update keyboards/aplx6/README.md * Update keyboards/aplx6/README.md * Update keyboards/aplx6/README.md * Update keyboards/aplx6/README.md * Update keyboards/aplx6/README.md * Update keyboards/aplx6/rules.mk * Update keyboards/aplx6/rules.mk * Update keyboards/aplx6/README.md * Update keyboards/aplx6/README.md * Update keyboards/aplx6/README.md * pins update * update * update pins * Update keyboards/aplx6/README.md * Update keyboards/aplx6/README.md * initial commit * Update aplx2.h * Update keyboards/aplx2/README.md * Update keyboards/aplx6/README.md * Update keyboards/aplx6/README.md * Update keyboards/aplx2/README.md * folder change * Update keyboards/handwired/aplx2/README.md * Update keyboards/handwired/aplx2/README.md * latest suggestion * Update keyboards/handwired/aplx2/README.md
author: Aplyard <40563350+Aplyard@users.noreply.github.com> 2020-04-27 20:25:51 +0300
committer: GitHub <noreply@github.com> 2020-04-27 10:25:51 -0700
commit: cfdd105d9db4f7c4f30ce24096d2531cd1b9e899 (patch)
tree: 611751473a43f0ac712e38697052c86f7bf9d8bb
parent: 82ae6ee0079a71979680e47c69de55de5f53e73a (diff)
download: qmk_firmware-cfdd105d9db4f7c4f30ce24096d2531cd1b9e899.tar.gz
qmk_firmware-cfdd105d9db4f7c4f30ce24096d2531cd1b9e899.zip
6 files changed, 168 insertions, 0 deletions
diff --git a/keyboards/handwired/aplx2/README.md b/keyboards/handwired/aplx2/README.md
new file mode 100644
index 000000000..424d96481
--- /dev/null
+++ b/keyboards/handwired/aplx2/README.md
@@ -0,0 +1,34 @@
+# Aplx2
+![Front](https://i.imgur.com/cN4WfaQl.jpg)  
+   
+A simple 2% keyboard for osu!. Designed to be assembled as a sandwich with a Pro Micro, using M3 x 16mm screws, your choice of MX- or Alps-compatible switches, and 1N4148 diodes.   
+**Layout:**  
+The default layout is: Z , X .
+Used pins can be found in `config.h`. All ProMicro pins can be found [here](https://cdn.sparkfun.com/datasheets/Dev/Arduino/Boards/ProMicro16MHzv1.pdf).
+* Keyboard Maintainer: [Aplyard](https://github.com/Aplyard)
+* Hardware Supported: Pro Micro (ATmega32U4)
+* Hardware Availability: [GitHub](https://github.com/Aplyard/Aplx2), [Thingiverse](https://www.thingiverse.com/thing:4294608)
+Make example for this keyboard (after setting up your build environment):
+     make handwired/aplx2: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).
+---  
+**Designed in:**  
+Fusion360     
+[Keyboard Plate & Case Builder](http://builder.swillkb.com/)  
+ 
+**Usefull Links:**  
+[Qmk Online Configurator](https://config.qmk.fm/#)  
+**Alternatives of qmk that worked for me:**  
+[Keyboard Layout Editor](http://www.keyboard-layout-editor.com/#/)   
+[Firmware Builder](https://kbfirmware.com/)      
+---   
diff --git a/keyboards/handwired/aplx2/aplx2.c b/keyboards/handwired/aplx2/aplx2.c
new file mode 100644
index 000000000..e3dd17454
--- /dev/null
+++ b/keyboards/handwired/aplx2/aplx2.c
@@ -0,0 +1,19 @@
+/*
+Copyright 2020 April Aplyard <alex.fragiou@gmail.com>
+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 "aplx2.h"
diff --git a/keyboards/handwired/aplx2/aplx2.h b/keyboards/handwired/aplx2/aplx2.h
new file mode 100644
index 000000000..a47b064b9
--- /dev/null
+++ b/keyboards/handwired/aplx2/aplx2.h
@@ -0,0 +1,25 @@
+/*
+Copyright 2020 April Aplyard <alex.fragiou@gmail.com>
+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  \
+) { \
+  { K00 , K01 } \
+}
diff --git a/keyboards/handwired/aplx2/config.h b/keyboards/handwired/aplx2/config.h
new file mode 100644
index 000000000..041f956b8
--- /dev/null
+++ b/keyboards/handwired/aplx2/config.h
@@ -0,0 +1,41 @@
+/*
+Copyright 2020 April Aplyard <alex.fragiou@gmail.com>
+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       0xE0E0
+#define PRODUCT_ID      0x0030
+#define DEVICE_VER      0x0001
+#define MANUFACTURER    Aplyard
+#define PRODUCT         Aplx2
+#define DESCRIPTION     Aplx2% osu!
+/* key matrix size */
+#define MATRIX_ROWS 1
+#define MATRIX_COLS 2
+/* pin-out */
+#define MATRIX_ROW_PINS { D1 }
+#define MATRIX_COL_PINS { B5, D3 }
+#define UNUSED_PINS
+/* COL2ROW or ROW2COL */
+#define DIODE_DIRECTION COL2ROW
diff --git a/keyboards/handwired/aplx2/keymaps/default/keymap.c b/keyboards/handwired/aplx2/keymaps/default/keymap.c
new file mode 100644
index 000000000..b99a7df06
--- /dev/null
+++ b/keyboards/handwired/aplx2/keymaps/default/keymap.c
@@ -0,0 +1,16 @@
+#include QMK_KEYBOARD_H
+#define _MAIN 0
+const uint16_t PROGMEM keymaps[][MATRIX_ROWS][MATRIX_COLS] = {
+        /* Keymap __MAIN: Default Layer  
+        *  ,---------------.
+        *  | |-----|-----| |  
+        *  | |  Ζ  |  Χ  | |  
+        *  | |-----|-----| |
+        *  '---------------'
+        */
+  [_MAIN] = LAYOUT(
+    KC_Z,  KC_X
+  ),
+};
diff --git a/keyboards/handwired/aplx2/rules.mk b/keyboards/handwired/aplx2/rules.mk
new file mode 100644
index 000000000..af9df6087
--- /dev/null
+++ b/keyboards/handwired/aplx2/rules.mk
@@ -0,0 +1,33 @@
+# MCU name
+MCU = atmega32u4
+# Bootloader selection
+#   Teensy       halfkay
+#   Pro Micro    caterina
+#   Atmel DFU    atmel-dfu
+#   LUFA DFU     lufa-dfu
+#   QMK DFU      qmk-dfu
+#   ATmega32A    bootloadHID
+#   ATmega328P   USBasp
+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
+MIDI_ENABLE = no            # MIDI support
+BLUETOOTH_ENABLE = no       # Enable Bluetooth with the Adafruit EZ-Key HID
+AUDIO_ENABLE = no           # Audio output on port C6
+FAUXCLICKY_ENABLE = no      # Use buzzer to emulate clicky switches
+HD44780_ENABLE = no         # Enable support for HD44780 based LCDs
+UNICODE_ENABLE = no        # Unicode
author	Aplyard <40563350+Aplyard@users.noreply.github.com>	2020-04-27 20:25:51 +0300
committer	GitHub <noreply@github.com>	2020-04-27 10:25:51 -0700
commit	cfdd105d9db4f7c4f30ce24096d2531cd1b9e899 (patch)
tree	611751473a43f0ac712e38697052c86f7bf9d8bb
parent	82ae6ee0079a71979680e47c69de55de5f53e73a (diff)
download	qmk_firmware-cfdd105d9db4f7c4f30ce24096d2531cd1b9e899.tar.gz qmk_firmware-cfdd105d9db4f7c4f30ce24096d2531cd1b9e899.zip

diff --git a/keyboards/handwired/aplx2/README.md b/keyboards/handwired/aplx2/README.md new file mode 100644 index 000000000..424d96481 --- /dev/null +++ b/keyboards/handwired/aplx2/README.md
@@ -0,0 +1,34 @@
	1	# Aplx2
	2
	3	![Front](https://i.imgur.com/cN4WfaQl.jpg)
	4
	5	A simple 2% keyboard for osu!. Designed to be assembled as a sandwich with a Pro Micro, using M3 x 16mm screws, your choice of MX- or Alps-compatible switches, and 1N4148 diodes.
	6
	7	Layout:
	8	The default layout is: Z , X .
	9	Used pins can be found in `config.h`. All ProMicro pins can be found [here](https://cdn.sparkfun.com/datasheets/Dev/Arduino/Boards/ProMicro16MHzv1.pdf).
	10
	11	* Keyboard Maintainer: [Aplyard](https://github.com/Aplyard)
	12	* Hardware Supported: Pro Micro (ATmega32U4)
	13	* Hardware Availability: [GitHub](https://github.com/Aplyard/Aplx2), [Thingiverse](https://www.thingiverse.com/thing:4294608)
	14
	15	Make example for this keyboard (after setting up your build environment):
	16
	17	make handwired/aplx2:default
	18
	19	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).
	20
	21	---
	22	Designed in:
	23	Fusion360
	24	[Keyboard Plate & Case Builder](http://builder.swillkb.com/)
	25
	26
	27	Usefull Links:
	28	[Qmk Online Configurator](https://config.qmk.fm/#)
	29
	30	Alternatives of qmk that worked for me:
	31	[Keyboard Layout Editor](http://www.keyboard-layout-editor.com/#/)
	32	[Firmware Builder](https://kbfirmware.com/)
	33
	34	---


diff --git a/keyboards/handwired/aplx2/aplx2.c b/keyboards/handwired/aplx2/aplx2.c new file mode 100644 index 000000000..e3dd17454 --- /dev/null +++ b/keyboards/handwired/aplx2/aplx2.c
@@ -0,0 +1,19 @@
	1	/*
	2	Copyright 2020 April Aplyard <alex.fragiou@gmail.com>
	3
	4	This program is free software: you can redistribute it and/or modify
	5	it under the terms of the GNU General Public License as published by
	6	the Free Software Foundation, either version 2 of the License, or
	7	(at your option) any later version.
	8
	9	This program is distributed in the hope that it will be useful,
	10	but WITHOUT ANY WARRANTY; without even the implied warranty of
	11	MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
	12	GNU General Public License for more details.
	13
	14	You should have received a copy of the GNU General Public License
	15	along with this program. If not, see <http://www.gnu.org/licenses/>.
	16	*/
	17
	18	#include "aplx2.h"
	19


diff --git a/keyboards/handwired/aplx2/aplx2.h b/keyboards/handwired/aplx2/aplx2.h new file mode 100644 index 000000000..a47b064b9 --- /dev/null +++ b/keyboards/handwired/aplx2/aplx2.h
@@ -0,0 +1,25 @@
	1	/*
	2	Copyright 2020 April Aplyard <alex.fragiou@gmail.com>
	3
	4	This program is free software: you can redistribute it and/or modify
	5	it under the terms of the GNU General Public License as published by
	6	the Free Software Foundation, either version 2 of the License, or
	7	(at your option) any later version.
	8
	9	This program is distributed in the hope that it will be useful,
	10	but WITHOUT ANY WARRANTY; without even the implied warranty of
	11	MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
	12	GNU General Public License for more details.
	13
	14	You should have received a copy of the GNU General Public License
	15	along with this program. If not, see <http://www.gnu.org/licenses/>.
	16	*/
	17
	18	#pragma once
	19	#include "quantum.h"
	20
	21	#define LAYOUT( \
	22	K00, K01 \
	23	) { \
	24	{ K00 , K01 } \
	25	}


diff --git a/keyboards/handwired/aplx2/config.h b/keyboards/handwired/aplx2/config.h new file mode 100644 index 000000000..041f956b8 --- /dev/null +++ b/keyboards/handwired/aplx2/config.h
@@ -0,0 +1,41 @@
	1	/*
	2	Copyright 2020 April Aplyard <alex.fragiou@gmail.com>
	3
	4	This program is free software: you can redistribute it and/or modify
	5	it under the terms of the GNU General Public License as published by
	6	the Free Software Foundation, either version 2 of the License, or
	7	(at your option) any later version.
	8
	9	This program is distributed in the hope that it will be useful,
	10	but WITHOUT ANY WARRANTY; without even the implied warranty of
	11	MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
	12	GNU General Public License for more details.
	13
	14	You should have received a copy of the GNU General Public License
	15	along with this program. If not, see <http://www.gnu.org/licenses/>.
	16	*/
	17
	18	#pragma once
	19
	20	#include "config_common.h"
	21
	22	/* USB Device descriptor parameter */
	23	#define VENDOR_ID 0xE0E0
	24	#define PRODUCT_ID 0x0030
	25	#define DEVICE_VER 0x0001
	26	#define MANUFACTURER Aplyard
	27	#define PRODUCT Aplx2
	28	#define DESCRIPTION Aplx2% osu!
	29
	30	/* key matrix size */
	31	#define MATRIX_ROWS 1
	32	#define MATRIX_COLS 2
	33
	34	/* pin-out */
	35	#define MATRIX_ROW_PINS { D1 }
	36	#define MATRIX_COL_PINS { B5, D3 }
	37	#define UNUSED_PINS
	38
	39	/* COL2ROW or ROW2COL */
	40	#define DIODE_DIRECTION COL2ROW
	41


diff --git a/keyboards/handwired/aplx2/keymaps/default/keymap.c b/keyboards/handwired/aplx2/keymaps/default/keymap.c new file mode 100644 index 000000000..b99a7df06 --- /dev/null +++ b/keyboards/handwired/aplx2/keymaps/default/keymap.c
@@ -0,0 +1,16 @@
	1	#include QMK_KEYBOARD_H
	2
	3	#define _MAIN 0
	4
	5	const uint16_t PROGMEM keymaps[][MATRIX_ROWS][MATRIX_COLS] = {
	6	/* Keymap __MAIN: Default Layer
	7	* ,---------------.
	8	* \| \|-----\|-----\| \|
	9	* \| \| Ζ \| Χ \| \|
	10	* \| \|-----\|-----\| \|
	11	* '---------------'
	12	*/
	13	[_MAIN] = LAYOUT(
	14	KC_Z, KC_X
	15	),
	16	};


diff --git a/keyboards/handwired/aplx2/rules.mk b/keyboards/handwired/aplx2/rules.mk new file mode 100644 index 000000000..af9df6087 --- /dev/null +++ b/keyboards/handwired/aplx2/rules.mk
@@ -0,0 +1,33 @@
	1	# MCU name
	2	MCU = atmega32u4
	3
	4	# Bootloader selection
	5	# Teensy halfkay
	6	# Pro Micro caterina
	7	# Atmel DFU atmel-dfu
	8	# LUFA DFU lufa-dfu
	9	# QMK DFU qmk-dfu
	10	# ATmega32A bootloadHID
	11	# ATmega328P USBasp
	12	BOOTLOADER = caterina
	13
	14	# Build Options
	15	# change yes to no to disable
	16	#
	17	BOOTMAGIC_ENABLE = no # Virtual DIP switch configuration
	18	MOUSEKEY_ENABLE = yes # Mouse keys
	19	EXTRAKEY_ENABLE = yes # Audio control and System control
	20	CONSOLE_ENABLE = no # Console for debug
	21	COMMAND_ENABLE = no # Commands for debug and configuration
	22	# Do not enable SLEEP_LED_ENABLE. it uses the same timer as BACKLIGHT_ENABLE
	23	SLEEP_LED_ENABLE = no # Breathing sleep LED during USB suspend
	24	# if this doesn't work, see here: https://github.com/tmk/tmk_keyboard/wiki/FAQ#nkro-doesnt-work
	25	NKRO_ENABLE = yes # USB Nkey Rollover
	26	BACKLIGHT_ENABLE = no # Enable keyboard backlight functionality
	27	RGBLIGHT_ENABLE = no # Enable keyboard RGB underglow
	28	MIDI_ENABLE = no # MIDI support
	29	BLUETOOTH_ENABLE = no # Enable Bluetooth with the Adafruit EZ-Key HID
	30	AUDIO_ENABLE = no # Audio output on port C6
	31	FAUXCLICKY_ENABLE = no # Use buzzer to emulate clicky switches
	32	HD44780_ENABLE = no # Enable support for HD44780 based LCDs
	33	UNICODE_ENABLE = no # Unicode