Added support for Knops Mini (3x2 macropad) keyboard. (#1953)

* Added support for Knops Mini (3x2 macropad) keyboard.

* Added better documentation, according to the QMK standards.

* Fixed typo.

* Changed names of files to comply with QMK standards.

* Ignored makefile in keymap.

* Removed makefiles and added my credentials in the copyrights.

9 files changed, 755 insertions, 0 deletions

diff --git a/keyboards/knops/mini/config.h b/keyboards/knops/mini/config.h
new file mode 100644
index 000000000..154fbf01f
--- /dev/null
+++ b/keyboards/knops/mini/config.h
@@ -0,0 +1,190 @@
+/*
+Copyright 2017 Pawnerd
+
+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/>.
+*/
+
+#ifndef CONFIG_H
+#define CONFIG_H
+
+#include "config_common.h"
+
+/* USB Device descriptor parameter */
+#define VENDOR_ID       0xFEFD
+#define PRODUCT_ID      0x9460
+#define DEVICE_VER      0x0001
+#define MANUFACTURER    Alltrons IT
+#define PRODUCT         Knops Mini
+#define DESCRIPTION     Advanced 3x2 macrokeyboard
+
+/* key matrix size */
+#define MATRIX_ROWS 1
+#define MATRIX_COLS 6
+
+/*
+ * 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 { D0 }
+#define MATRIX_COL_PINS { F7, F6, F5, F4, F1, F0 }
+#define UNUSED_PINS
+
+/* COL2ROW, ROW2COL, or CUSTOM_MATRIX */
+#define DIODE_DIRECTION COL2ROW
+ 
+// #define BACKLIGHT_PIN B7
+// #define BACKLIGHT_BREATHING
+// #define BACKLIGHT_LEVELS 3
+
+
+/* Debounce reduces chatter (unintended double-presses) - set 0 if debouncing is not needed */
+#define DEBOUNCING_DELAY 5
+
+/* define if matrix has ghost (lacks anti-ghosting diodes) */
+//#define MATRIX_HAS_GHOST
+
+/* number of backlight levels */
+
+/* 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 */
+#define IS_COMMAND() ( \
+    keyboard_report->mods == (MOD_BIT(KC_LSHIFT) | MOD_BIT(KC_RSHIFT)) \
+)
+
+/* 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_HELP1          H
+//#define MAGIC_KEY_HELP2          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_ALT1    ESC
+//#define MAGIC_KEY_LAYER0_ALT2    GRAVE
+//#define MAGIC_KEY_LAYER0         0
+//#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     PAUSE
+//#define MAGIC_KEY_LOCK           CAPS
+//#define MAGIC_KEY_EEPROM         E
+//#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
+//#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
+
+#endif
diff --git a/keyboards/knops/mini/keymaps/default/config.h b/keyboards/knops/mini/keymaps/default/config.h
new file mode 100644
index 000000000..999d8876c
--- /dev/null
+++ b/keyboards/knops/mini/keymaps/default/config.h
@@ -0,0 +1,24 @@
+/* Copyright 2017 Pawnerd
+ *
+ * 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/>.
+ */
+
+#ifndef CONFIG_USER_H
+#define CONFIG_USER_H
+
+#include "../../config.h"
+
+// place overrides here
+
+#endif
diff --git a/keyboards/knops/mini/keymaps/default/keymap.c b/keyboards/knops/mini/keymaps/default/keymap.c
new file mode 100644
index 000000000..e7773c0c0
--- /dev/null
+++ b/keyboards/knops/mini/keymaps/default/keymap.c
@@ -0,0 +1,361 @@
+#include "mini.h"
+
+const uint16_t PROGMEM keymaps[][MATRIX_ROWS][MATRIX_COLS] = {
+
+	KEYMAP(
+		LT(3, KC_MSTP), KC_VOLU, KC_MPLY, KC_MPRV, KC_VOLD, KC_MNXT),
+
+	KEYMAP(
+		LT(3, KC_ESC), M(3), M(4), M(5), M(6), M(7)),
+
+	KEYMAP(
+		LT(3, KC_1), KC_2, KC_3, KC_4, M(0), M(1)),
+
+	KEYMAP(
+		KC_TRNS, KC_TRNS, RESET, TO(0), TO(1), TO(2)),
+
+	KEYMAP(
+		KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS),
+
+	KEYMAP(
+		KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS),
+
+	KEYMAP(
+		KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS),
+
+	KEYMAP(
+		KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS),
+
+	KEYMAP(
+		KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS),
+
+	KEYMAP(
+		KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS),
+
+	KEYMAP(
+		KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS),
+
+	KEYMAP(
+		KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS),
+
+	KEYMAP(
+		KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS),
+
+	KEYMAP(
+		KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS),
+
+	KEYMAP(
+		KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS),
+
+	KEYMAP(
+		KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS)
+
+};
+
+const macro_t *action_get_macro(keyrecord_t *record, uint8_t id, uint8_t opt) {
+	//keyevent_t event = record->event;
+
+	switch (id) {
+		case 0:
+			if (record->event.pressed) {
+				return MACRO( T(T), T(G), T(L), T(H), T(F), T(ENT), END );
+			}
+			break;
+		case 1:
+			if (record->event.pressed) {
+				return MACRO( T(T), T(G), T(G), T(ENT), END );
+			}
+			break;
+		case 2:
+			if (record->event.pressed) {
+				return MACRO( D(NO), T(L), U(NO), END );
+			}
+			break;
+		case 3:
+			if (record->event.pressed) {
+				return MACRO( D(LCTL), T(Z), U(LCTL), END );
+			}
+			break;
+		case 4:
+			if (record->event.pressed) {
+				return MACRO( D(LCTL), D(LSFT), T(Z), U(LSFT), U(LCTL), END );
+			}
+			break;
+		case 5:
+			if (record->event.pressed) {
+				return MACRO( D(LCTL), T(X), U(LCTL), END );
+			}
+			break;
+		case 6:
+			if (record->event.pressed) {
+				return MACRO( D(LCTL), T(C), U(LCTL), END );
+			}
+			break;
+		case 7:
+			if (record->event.pressed) {
+				return MACRO( D(LCTL), T(V), U(LCTL), END );
+			}
+			break;
+	}
+	return MACRO_NONE;
+}
+
+void set_switch_led(int ledId, bool state) {
+	if(state) {
+		switch(ledId) {
+			case 1:
+				PORTD |= (1<<7);
+				break;
+			case 2:
+				PORTC |= (1<<6);
+				break;
+			case 3:
+				PORTD |= (1<<4);
+				break;
+			case 4:
+				PORTE |= (1<<6);
+				break;
+			case 5:
+				PORTB |= (1<<4);
+				break;
+			case 6:
+				PORTD |= (1<<6);
+				break;
+		}
+	} else {
+		switch(ledId) {
+			case 1:
+				PORTD &= ~(1<<7);
+				break;
+			case 2:
+				PORTC &= ~(1<<6);
+				break;
+			case 3:
+				PORTD &= ~(1<<4);
+				break;
+			case 4:
+				PORTE &= ~(1<<6);
+				break;
+			case 5:
+				PORTB &= ~(1<<4);
+				break;
+			case 6:
+				PORTD &= ~(1<<6);
+				break;
+		}
+	}
+}
+
+
+void set_layer_led(int layerId) {
+	PORTD |= (1<<5);
+	PORTB &= ~(1<<6);
+	PORTB |= (1<<0);
+	switch(layerId) {
+		case 0:
+			PORTD &= ~(1<<5);
+			break;
+		case 1:
+			PORTB |= (1<<6);
+			break;
+		case 2:
+			PORTB &= ~(1<<0);
+			break;
+	}
+}
+
+void matrix_init_user(void) {
+	led_init_ports();
+	
+	
+	PORTD |= (1<<7);
+	PORTC |= (1<<6);
+	PORTD |= (1<<4);
+	PORTE |= (1<<6);
+	PORTB |= (1<<4);
+	PORTD |= (1<<6);
+	
+	set_layer_led(0);
+}
+
+void matrix_scan_user(void) {
+}
+
+void led_init_ports() {
+  // led voor switch #1
+	DDRD |= (1<<7);
+	PORTD &= ~(1<<7);
+	
+  // led voor switch #2
+	DDRC |= (1<<6);
+	PORTC &= ~(1<<6);
+	
+  // led voor switch #3
+	DDRD |= (1<<4);
+	PORTD &= ~(1<<4);
+	
+  // led voor switch #4
+	DDRE |= (1<<6);
+	PORTE &= ~(1<<6);
+	
+  // led voor switch #5
+	DDRB |= (1<<4);
+	PORTB &= ~(1<<4);
+	
+  // led voor switch #6
+	DDRD |= (1<<6);
+	PORTD &= ~(1<<6);
+	
+	/*
+	DDRD |= (1<<7);
+	PORTD |= (1<<7);
+	
+	DDRC |= (1<<6);
+	PORTC |= (1<<6);
+	
+	DDRD |= (1<<4);
+	PORTD |= (1<<4);
+	
+	DDRE |= (1<<6);
+	PORTE |= (1<<6);
+	
+	DDRB |= (1<<4);
+	PORTB |= (1<<4);
+	
+	DDRD |= (1<<6);
+	PORTD |= (1<<6);
+	// */	
+
+	DDRD |= (1<<5);
+	DDRB |= (1<<6);
+	DDRB |= (1<<0);
+	//led_set_layer(0);
+}
+
+void led_set_user(uint8_t usb_led) {
+
+	if (usb_led & (1 << USB_LED_NUM_LOCK)) {
+		
+	} else {
+		
+	}
+
+	if (usb_led & (1 << USB_LED_CAPS_LOCK)) {
+		
+	} else {
+		
+	}
+
+	if (usb_led & (1 << USB_LED_SCROLL_LOCK)) {
+		
+	} else {
+		
+	}
+
+	if (usb_led & (1 << USB_LED_COMPOSE)) {
+		
+	} else {
+		
+	}
+
+	if (usb_led & (1 << USB_LED_KANA)) {
+		
+	} else {
+		
+	}
+
+}
+
+
+/*  
+*   NOTE:
+*
+*   In case you don't understand this coding stuff, please
+*   feel free to mail me or post something
+*   at the /r/knops subreddit and I will configure the code as
+*   you wish for your needs to make the LEDs do what you want :-).
+*
+*   Contact me at:    support@knops.io
+*
+*
+*	Knops Mini LED Numbers:
+*	 _____	 _____	 _____
+*	| 	  | | 	  | | 	  |
+*	|  1  | |  2  | |  3  |    <---
+*	|_____| |_____| |_____|       |      These LEDs are called 'Switch LEDs'
+*	 _____	 _____	 _____        |----- To turn on/off these leds, use:
+*	| 	  | | 	  | | 	  |       |	  set_switch_led( [1-6], [true/false]);
+*	|  4  | |  5  | |  6  |    <---
+*	|_____| |_____| |_____|
+*	
+*	 < 0 >   < 1 >   < 2 >     <---      These front-LEDs are called 'Layer LEDs'
+*							             To turn one of them on, use:
+*										 set_layer_led( [0-2] );
+*										 
+*/
+
+/*
+* This function led_set_layer gets called when you switch between layers.
+* It allows you to turn on and off leds for each different layer and do
+* other cool stuff. Currently the GUI does not have LED support. I am working
+* on that, but takes time.
+*/
+void led_set_layer(int layer) {
+	switch(layer) {
+			
+			/**
+			*   Here is an example to turn LEDs on and of. By default:
+			*   - the LEDs are turned on in layer 0
+			*   - the LEDs are turned off in layer 1
+			*   - the LEDs don't change from state for layer 2
+			*/			
+			
+		case 0:
+			set_layer_led(0); // Turn on only the first/left layer indicator
+			set_switch_led(1, true);
+			set_switch_led(2, true);
+			set_switch_led(3, true);
+			set_switch_led(4, true);
+			set_switch_led(5, true);
+			set_switch_led(6, true);
+			break;
+			
+		case 1:
+			set_layer_led(1); // Turn on only the second/middle layer indicator
+			set_switch_led(1, false);
+			set_switch_led(2, false);
+			set_switch_led(3, false);
+			set_switch_led(4, false);
+			set_switch_led(5, false);
+			set_switch_led(6, false);
+			break;
+			
+		case 2:
+			set_layer_led(2); // Turn on only the third/right layer indicator
+			
+			// Keep leds for layer two in their current state, since we don't use set_switch_led(SWITCH_ID, TRUE_OR_FALSE)
+			
+			break;
+	}
+}
+
+bool process_record_user (uint16_t keycode, keyrecord_t *record) {
+  switch(keycode) {
+  case TO(0):
+      if (record->event.pressed) {
+        led_set_layer(0);
+     }
+     break;
+  case TO(1):
+      if (record->event.pressed) {
+        led_set_layer(1);
+     }
+     break;
+  case TO(2):
+      if (record->event.pressed) {
+        led_set_layer(2);
+     }
+     break;
+  }
+  return true;
+}
\ No newline at end of file
diff --git a/keyboards/knops/mini/keymaps/default/readme.md b/keyboards/knops/mini/keymaps/default/readme.md
new file mode 100644
index 000000000..61479b486
--- /dev/null
+++ b/keyboards/knops/mini/keymaps/default/readme.md
@@ -0,0 +1,7 @@
+# Default Knops Mini Layout
+
+![Knops logo](http://knops.io/img/Knops_logo.jpg)
+
+![Knops Mini Layout Image](https://i.imgur.com/WQBQctm.png)
+
+This is the default layout that comes flashed on every Knops Mini. For your use, you probably want to change this. We suggest you to use [our configurator tool](http://knops.io/configurator.html) for this.
\ No newline at end of file
diff --git a/keyboards/knops/mini/mini.c b/keyboards/knops/mini/mini.c
new file mode 100644
index 000000000..ccfd4331b
--- /dev/null
+++ b/keyboards/knops/mini/mini.c
@@ -0,0 +1,44 @@
+/* Copyright 2017 Kayle Knops
+ *
+ * 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 "mini.h"
+/*
+void matrix_init_kb(void) {
+	// put your keyboard start-up code here
+	// runs once when the firmware starts up
+
+	matrix_init_user();
+}
+
+void matrix_scan_kb(void) {
+	// put your looping keyboard code here
+	// runs every cycle (a lot)
+
+	matrix_scan_user();
+}
+
+bool process_record_kb(uint16_t keycode, keyrecord_t *record) {
+	// put your per-action keyboard code here
+	// runs for every action, just before processing by the firmware
+
+	return process_record_user(keycode, record);
+}
+
+void led_set_kb(uint8_t usb_led) {
+	// put your keyboard LED indicator (ex: Caps Lock LED) toggling code here
+
+	led_set_user(usb_led);
+}
+*/
\ No newline at end of file
diff --git a/keyboards/knops/mini/mini.h b/keyboards/knops/mini/mini.h
new file mode 100644
index 000000000..c9f74711b
--- /dev/null
+++ b/keyboards/knops/mini/mini.h
@@ -0,0 +1,30 @@
+/* Copyright 2017 Pawnerd
+ *
+ * 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 "quantum.h"
+
+#ifndef KNOPS_MINI_H
+#define KNOPS_MINI_H
+
+// This a shortcut to help you visually see your layout.
+// The following is an example using the Planck MIT layout
+// The first section contains all of the arguments
+// The second converts the arguments into a two-dimensional array
+#define KEYMAP( \
+	K00, K01, K02, K03, K04, K05  \
+) { \
+	{ K00,   K01,   K02,   K03,   K04,   K05 },  \
+}
+#endif
\ No newline at end of file
diff --git a/keyboards/knops/mini/readme.md b/keyboards/knops/mini/readme.md
new file mode 100644
index 000000000..86cff4a61
--- /dev/null
+++ b/keyboards/knops/mini/readme.md
@@ -0,0 +1,21 @@
+# Knops Mini
+
+![Knops logo](http://knops.io/img/Knops_logo.jpg)
+
+![Knops mini keyboard](https://i.imgur.com/AMrXVi4.jpg)
+
+A fully customizable 3x2 macropad. An exploded view of the keyboard is [available here](https://i.imgur.com/H83l5H8.gif).
+
+*The best way to change settings on your keyboard*, is by using [our official configurator tool](http://knops.io/configurator.html).
+
+* Keyboard Maintainer: [Pawnerd](https://github.com/pawnerd)
+* Contact / Questions (by e-mail): kayle `at` knops `dot` io
+* Hardware Supported: Knops Mini
+  * rev1 (1.0) (Sold by CMStore EU/USA/CAD from 27th of august, 2017)
+* Hardware Availability: [knops.io](http://knops.io/knopsmini.html), [Direct EU](http://www.cmstore.eu/maker-made/knops-mini-macro-keyboard/), [Direct USA/CAN](http://www.cmstore-usa.com/knops-mini-macro-keyboard/)
+
+Make example for this keyboard (after setting up your build environment):
+
+    make knops/mini:default
+
+See [build environment setup](https://docs.qmk.fm/build_environment_setup.html) then the [make instructions](https://docs.qmk.fm/make_instructions.html) for more information.
\ No newline at end of file
diff --git a/keyboards/knops/mini/rules.mk b/keyboards/knops/mini/rules.mk
new file mode 100644
index 000000000..ca2a2a5f8
--- /dev/null
+++ b/keyboards/knops/mini/rules.mk
@@ -0,0 +1,68 @@
+# MCU name
+#MCU = at90usb1286
+MCU = atmega32u4
+
+# Processor frequency.
+#     This will define a symbol, F_CPU, in all source code files equal to the
+#     processor frequency in Hz. You can then use this symbol in your source code to
+#     calculate timings. Do NOT tack on a 'UL' at the end, this will be done
+#     automatically to create a 32-bit value in your source code.
+#
+#     This will be an integer division of F_USB below, as it is sourced by
+#     F_USB after it has run through any CPU prescalers. Note that this value
+#     does not *change* the processor frequency - it should merely be updated to
+#     reflect the processor speed set externally so that the code can use accurate
+#     software delays.
+F_CPU = 16000000
+
+
+#
+# LUFA specific
+#
+# Target architecture (see library "Board Types" documentation).
+ARCH = AVR8
+
+# Input clock frequency.
+#     This will define a symbol, F_USB, in all source code files equal to the
+#     input clock frequency (before any prescaling is performed) in Hz. This value may
+#     differ from F_CPU if prescaling is used on the latter, and is required as the
+#     raw input clock is fed directly to the PLL sections of the AVR for high speed
+#     clock generation for the USB and other AVR subsections. Do NOT tack on a 'UL'
+#     at the end, this will be done automatically to create a 32-bit value in your
+#     source code.
+#
+#     If no clock division is performed on the input clock inside the AVR (via the
+#     CPU clock adjust registers or the clock division fuses), this will be equal to F_CPU.
+F_USB = $(F_CPU)
+
+# Interrupt driven control endpoint task(+60)
+OPT_DEFS += -DINTERRUPT_CONTROL_ENDPOINT
+
+
+# Boot Section Size in *bytes*
+#   Teensy halfKay   512
+#   Teensy++ halfKay 1024
+#   Atmel DFU loader 4096
+#   LUFA bootloader  4096
+#   USBaspLoader     2048
+OPT_DEFS += -DBOOTLOADER_SIZE=4096
+
+
+# Build Options
+#   change yes to no to disable
+#
+BOOTMAGIC_ENABLE ?= no      # Virtual DIP switch configuration(+1000)
+MOUSEKEY_ENABLE ?= yes       # Mouse keys(+4700)
+EXTRAKEY_ENABLE ?= yes       # Audio control and System control(+450)
+CONSOLE_ENABLE ?= yes        # Console for debug(+400)
+COMMAND_ENABLE ?= yes        # 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 ?= no            # USB Nkey Rollover
+BACKLIGHT_ENABLE ?= no       # Enable keyboard backlight functionality on B7 by default
+MIDI_ENABLE ?= no            # MIDI support (+2400 to 4200, depending on config)
+UNICODE_ENABLE ?= no         # Unicode
+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
diff --git a/keyboards/knops/readme.md b/keyboards/knops/readme.md
new file mode 100644
index 000000000..563099b6d
--- /dev/null
+++ b/keyboards/knops/readme.md
@@ -0,0 +1,10 @@
+# Knops
+
+![Knops Mini Logo](http://knops.io/img/Knops_logo.jpg)
+
+[Knops](http://www.knops.io/) makes fully customizable custom keyboards in a variety of formfactors. So far the Knops Mini, a 3x2 macro keypad is the biggest success. Inside this directory you'll find support for the entire line of Knops products.
+
+* Maintainer: [Pawnerd](https://github.com/pawnerd)
+* Hardware Supported:
+  * [`Mini`](mini/): Knops Mini
+* Hardware Availability: [knops.io](https://www.knops.io/)
\ No newline at end of file