[Keyboard] Add Wraith keyboard (#6810)

* start wraith firmware

* completed initial setup

* added amber keymap to wraith

* fixed LEDs, wrote readme files

* reverted bootloader type after troubleshooting

* decapitalised files and directory as per qmk standards

* Update Wraith keyboard folder

- Add timer keymap with documentation
- Remove boilerplate in rules.mk, ready for pull request
- Update info.json with ISO and ANSI layouts, ready for QMK Configurator

* Add Wraith image to readme.md

* Fix Wraith keyboard's QMK Configurator support

- Update info.json
- Add layout macros in wraith.h
- Update keymap.c files to use LAYOUT_all
- Fix readme formatting

9 files changed, 303 insertions, 0 deletions

diff --git a/keyboards/cutie_club/wraith/keymaps/amber/config.h b/keyboards/cutie_club/wraith/keymaps/amber/config.h
new file mode 100644
index 000000000..b825835bb
--- /dev/null
+++ b/keyboards/cutie_club/wraith/keymaps/amber/config.h
@@ -0,0 +1,19 @@
+/* Copyright 2019 Amber Holly
+ *
+ * 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
+
+// place overrides here
diff --git a/keyboards/cutie_club/wraith/keymaps/amber/keymap.c b/keyboards/cutie_club/wraith/keymaps/amber/keymap.c
new file mode 100644
index 000000000..f953b5e19
--- /dev/null
+++ b/keyboards/cutie_club/wraith/keymaps/amber/keymap.c
@@ -0,0 +1,59 @@
+/* Copyright 2019 Amber Holly
+ *
+ * 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
+
+// Defines the keycodes used by our macros in process_record_user
+enum custom_keycodes {
+  QMKBEST = SAFE_RANGE,
+  QMKURL
+};
+
+const uint16_t PROGMEM keymaps[][MATRIX_ROWS][MATRIX_COLS] = {
+  [0] = LAYOUT_all(
+    KC_ESC,    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_PSCR,    KC_BRK,
+    KC_GRV,    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_INS,
+    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_DEL,
+    KC_LCTL,   KC_A,     KC_S,     KC_D,     KC_F,     KC_G,     KC_H,     KC_J,     KC_K,     KC_L,     KC_SCLN,   KC_QUOT,   KC_BSLS,   KC_ENT,     MO(1),
+    KC_LSFT,   KC_NUBS,  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_RGUI,
+    KC_CAPS,             KC_LALT,                                          KC_SPC,                                  KC_RALT,   KC_LEFT,   KC_DOWN,    KC_RGHT
+  ),
+  [1] = LAYOUT_all(
+    RESET,      KC_F13,     KC_F14,     KC_F15,     KC_F16,     KC_F17,     KC_F18,     KC_F19,     KC_F20,     KC_F21,     KC_F22,     KC_F23,     KC_F24,     _______,    _______,
+    _______,    _______,    _______,    _______,    _______,    _______,    _______,    _______,    _______,    _______,    _______,    _______,    _______,    _______,    _______,
+	  _______,    _______,    _______,    _______,    _______,    _______,    _______,    _______,    _______,    _______,    _______,    _______,    _______,                _______,
+	  _______,    _______,    _______,    _______,    _______,    _______,    _______,    _______,    _______,    _______,    _______,    _______,    _______,    _______,    KC_TRNS,
+    _______,    _______,    _______,    _______,    _______,    _______,    _______,    _______,    _______,    _______,    _______,    _______,    _______,    _______,    _______,
+    _______,                _______,                                        _______,                                                    _______,    KC_MPRV,    _______,    KC_MNXT
+  )
+};
+
+
+void matrix_init_user(void) {
+
+}
+
+void matrix_scan_user(void) {
+  // escape LED on layer 1
+  if (IS_LAYER_ON(1)) {
+    writePinLow(B0);
+  } else {
+    writePinHigh(B0);
+  }
+}
+
+void led_set_user(uint8_t usb_led) {
+
+}
diff --git a/keyboards/cutie_club/wraith/keymaps/amber/readme.md b/keyboards/cutie_club/wraith/keymaps/amber/readme.md
new file mode 100644
index 000000000..013ae7f10
--- /dev/null
+++ b/keyboards/cutie_club/wraith/keymaps/amber/readme.md
@@ -0,0 +1 @@
+# Amber's personal keymap
diff --git a/keyboards/cutie_club/wraith/keymaps/default/config.h b/keyboards/cutie_club/wraith/keymaps/default/config.h
new file mode 100644
index 000000000..6f4dc6741
--- /dev/null
+++ b/keyboards/cutie_club/wraith/keymaps/default/config.h
@@ -0,0 +1,19 @@
+/* Copyright 2019 Amber
+ *
+ * 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
+
+// place overrides here
diff --git a/keyboards/cutie_club/wraith/keymaps/default/keymap.c b/keyboards/cutie_club/wraith/keymaps/default/keymap.c
new file mode 100644
index 000000000..342a411ef
--- /dev/null
+++ b/keyboards/cutie_club/wraith/keymaps/default/keymap.c
@@ -0,0 +1,59 @@
+/* Copyright 2019 Amber Holly
+ *
+ * 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
+
+// Defines the keycodes used by our macros in process_record_user
+enum custom_keycodes {
+  QMKBEST = SAFE_RANGE,
+  QMKURL
+};
+
+const uint16_t PROGMEM keymaps[][MATRIX_ROWS][MATRIX_COLS] = {
+  [0] = LAYOUT_all(
+    KC_ESC,    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_PSCR,    MO(1),
+    KC_GRV,    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_INS,
+    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_DEL,
+    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_BSLS,   KC_ENT,     KC_PGUP,
+    KC_LSFT,   KC_NUBS,  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_LCTL,             KC_LALT,                                          KC_SPC,                                  KC_RALT,   KC_LEFT,   KC_DOWN,    KC_RGHT
+  ),
+  [1] = LAYOUT_all(
+    RESET,      KC_F13,     KC_F14,     KC_F15,     KC_F16,     KC_F17,     KC_F18,     KC_F19,     KC_F20,     KC_F21,     KC_F22,     KC_F23,     KC_F24,     _______,    KC_TRNS,
+    _______,    _______,    _______,    _______,    _______,    _______,    _______,    _______,    _______,    _______,    _______,    _______,    _______,    _______,    _______,
+	  _______,    _______,    _______,    _______,    _______,    _______,    _______,    _______,    _______,    _______,    _______,    _______,    _______,                _______,
+	  _______,    _______,    _______,    _______,    _______,    _______,    _______,    _______,    _______,    _______,    _______,    _______,    _______,    _______,    _______,
+    _______,    _______,    _______,    _______,    _______,    _______,    _______,    _______,    _______,    _______,    _______,    _______,    _______,    _______,    _______,
+    _______,                _______,                                        _______,                                                    _______,    _______,    _______,    _______
+  )
+};
+
+
+void matrix_init_user(void) {
+
+}
+
+void matrix_scan_user(void) {
+  // escape LED on layer 1
+  if (IS_LAYER_ON(1)) {
+    writePinLow(B0);
+  } else {
+    writePinHigh(B0);
+  }
+}
+
+void led_set_user(uint8_t usb_led) {
+
+}
diff --git a/keyboards/cutie_club/wraith/keymaps/default/readme.md b/keyboards/cutie_club/wraith/keymaps/default/readme.md
new file mode 100644
index 000000000..cdf6376c2
--- /dev/null
+++ b/keyboards/cutie_club/wraith/keymaps/default/readme.md
@@ -0,0 +1 @@
+# The default keymap for the Wraith
diff --git a/keyboards/cutie_club/wraith/keymaps/timer/config.h b/keyboards/cutie_club/wraith/keymaps/timer/config.h
new file mode 100644
index 000000000..f6f1af659
--- /dev/null
+++ b/keyboards/cutie_club/wraith/keymaps/timer/config.h
@@ -0,0 +1,25 @@
+/* Copyright 2019 Amber Holly
+ *
+ * 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
+
+#define LAYER_TIMEOUT 10000
+#define TIMEOUT_WARNING 3000
+#define FLASH_PERIOD 250
+#define SPEED_SCALE 2
+#define TIMEOUT_SCALE 4
+#define LAYER_SWITCH 1 // the layer to switch to
+#define GET_FLASH_PERIOD ((layer_time_remaining <= TIMEOUT_WARNING/TIMEOUT_SCALE) ? FLASH_PERIOD/SPEED_SCALE : FLASH_PERIOD)
diff --git a/keyboards/cutie_club/wraith/keymaps/timer/keymap.c b/keyboards/cutie_club/wraith/keymaps/timer/keymap.c
new file mode 100644
index 000000000..e57c62103
--- /dev/null
+++ b/keyboards/cutie_club/wraith/keymaps/timer/keymap.c
@@ -0,0 +1,90 @@
+/* Copyright 2019 Amber Holly
+ *
+ * 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
+
+int layer_time_remaining;
+uint16_t prev_loop_time;
+
+// Defines the keycodes used by our macros in process_record_user
+enum custom_keycodes {
+   TIME_TOGGLE = SAFE_RANGE
+};
+
+const uint16_t PROGMEM keymaps[][MATRIX_ROWS][MATRIX_COLS] = {
+  [0] = LAYOUT_all(
+    KC_ESC,    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_PSCR,    KC_BRK,
+    KC_GRV,    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_INS,
+    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_DEL,
+    KC_LCTL,   KC_A,     KC_S,     KC_D,     KC_F,     KC_G,     KC_H,     KC_J,     KC_K,     KC_L,     KC_SCLN,   KC_QUOT,   KC_BSLS,   KC_ENT,     TIME_TOGGLE,
+    KC_LSFT,   KC_NUBS,  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_RGUI,
+    KC_CAPS,             KC_LALT,                                          KC_SPC,                                  KC_RALT,   KC_LEFT,   KC_DOWN,    KC_RGHT
+  ),
+  [1] = LAYOUT_all(
+    RESET,      KC_F13,     KC_F14,     KC_F15,     KC_F16,     KC_F17,     KC_F18,     KC_F19,     KC_F20,     KC_F21,     KC_F22,     KC_F23,     KC_F24,     _______,    _______,
+    _______,    _______,    _______,    _______,    _______,    _______,    _______,    _______,    _______,    _______,    _______,    _______,    _______,    _______,    _______,
+    _______,    _______,    _______,    _______,    _______,    _______,    _______,    _______,    _______,    _______,    _______,    _______,    _______,                _______,
+    _______,    _______,    _______,    _______,    _______,    _______,    _______,    _______,    _______,    _______,    _______,    _______,    _______,    _______,    KC_TRNS,
+    _______,    _______,    _______,    _______,    _______,    _______,    _______,    _______,    _______,    _______,    _______,    _______,    _______,    _______,    _______,
+    _______,                _______,                                        _______,                                                    KC_MPLY,    KC_MPRV,    _______,    KC_MNXT
+  )
+};
+
+
+void matrix_init_user(void) {
+
+}
+
+void matrix_scan_user(void) {
+  layer_time_remaining -= timer_read()-prev_loop_time; //amount of time elapsed since the start of the previous loop
+  prev_loop_time = timer_read(); //start counting the time to check at the next iteration
+
+  if (layer_time_remaining <= 0) {
+  	// once timer run out
+  	layer_off(LAYER_SWITCH);
+  }
+
+  // escape LED on layer 1
+  if (IS_LAYER_ON(LAYER_SWITCH)) {
+    if (layer_time_remaining <= TIMEOUT_WARNING) {
+      if ((int)(layer_time_remaining/GET_FLASH_PERIOD % 2 == 0)) {
+		    // if even led on
+		    writePinLow(B0);
+		  } else {
+		    writePinHigh(B0);
+		  }
+    } else {
+      writePinLow(B0);
+    }
+  } else {
+    writePinHigh(B0);
+  }
+}
+
+bool process_record_user(uint16_t keycode, keyrecord_t *record) {
+  switch (keycode) {
+    case TIME_TOGGLE:
+			// get the time when time toggle pressed
+			layer_time_remaining = LAYER_TIMEOUT;
+			// set the layer
+			layer_on(LAYER_SWITCH);
+    break;
+  }
+  return true;
+};
+
+void led_set_user(uint8_t usb_led) {
+
+}
diff --git a/keyboards/cutie_club/wraith/keymaps/timer/readme.md b/keyboards/cutie_club/wraith/keymaps/timer/readme.md
new file mode 100644
index 000000000..1e812f3ae
--- /dev/null
+++ b/keyboards/cutie_club/wraith/keymaps/timer/readme.md
@@ -0,0 +1,30 @@
+# Timed function layer keymap
+
+Amber's personal keymap for the Wraith, but with a custom timed function layer keycode.  `config.h` contains defines that you can edit to control various aspects of this function.
+
+## How does it work?
+We are reading QMK's software timer in `matrix_scan_user()`.
+
+Once the `TIME_TOGGLE` key is pressed, `layer_time_remaining` is set equal to `LAYER_TIMEOUT`, the layer defined in `LAYER_SWITCH` becomes active, and the LED on the Escape key (pin B0) will light up.
+
+Each time the matrix is scanned, the software timer is read, and the value of `layer_time_remaining` is decreased by `prev_loop_time` - the amount of time elapsed since the last matrix scan.
+
+When there are `TIMEOUT_WARNING`ms left in `LAYER_TIMEOUT`, the LED will begin to flash at intervals of `FLASH_PERIOD`ms.
+
+When there are `TIMEOUT_WARNING/TIMEOUT_SCALE`ms left, the LED will begin to flash at intervals of `FLASH_PERIOD/SPEED_SCALE`ms.
+
+When `layer_time_remaining` is equal to or less than 0, the layer defined in `LAYER_SWITCH` is removed from the layer stack.
+
+
+## What are the defaults?
+`LAYER_TIMEOUT` controls how long the layer will stay active for. The default is 10 seconds.
+
+`TIMEOUT_WARNING` controls how long the warning (LED flash) will occur before the layer becomes inactive. The default is 3 seconds.
+
+`FLASH_PERIOD` controls how long each LED flash interval is in the warning time. The default flash period is 250ms.
+
+`SPEED_SCALE` controls how many times faster the LED will flash in the second flash period. The default scale is 2, twice as fast.
+
+`TIMEOUT_SCALE` controls the length of the second flash period, relative to `TIMEOUT_WARNING`. The default scale is 4; for 750ms of the secondary flash period.
+
+`LAYER_SWITCH` is the layer that will be activated by the key. The default is layer 1.