[Keyboard] Add "Selene" to the handwired section (#9920)

* Added handwired/selene based on handwired/106_with_trackpoint

* now at least parially working

* Selene Firmware 1, ready

* Updated Readme to align more with Template

* Added URL to info.json

* Fix status Lights being wired incorrectly

* Update keyboards/handwired/selene/config.h

* Update keyboards/handwired/selene/keymaps/Bpendragon/keymap.c

* Update keyboards/handwired/selene/selene.c

* Update keyboards/handwired/selene/selene.h

* Changes for PR requested by fauxpark

* Adds `default` keymap
* Renames `Bpendragon` to `bpendragon`
* Removes uneeded descriptors and options
* Simplifies return statement in `keymap.c`
* Removes trailing slashes from layout in `keymap.c`
* Updates `readme.mk` to reflect default keymap
* Aligns comments in `rules.mk`

* Forced folder name update to lowercase

* Apply suggestions from code review

keyboards/handwired/selene/config.h

@@ -0,0 +1,43 @@
+/* Copyright 2020 Bpendragon
+ *
+ * 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"
+
+#define VENDOR_ID       0x4244 //-B-pen-D-ragon
+#define PRODUCT_ID      0x0001
+#define DEVICE_VER      0x0001
+#define MANUFACTURER    Bpendragon
+#define PRODUCT         Selene
+
+#define MATRIX_ROWS 6
+#define MATRIX_COLS 21
+
+#define MATRIX_ROW_PINS { B10, B9, B15, B14, B13, B8}
+#define MATRIX_COL_PINS { A9, A10, B11, B7, B6, B5, B4, B3, B2, B1, B0, C14, A4, A5, A6, A7, A8, A15, A13, A14, B12 }
+#define UNUSED_PINS
+#define RGB_DI_PIN A3
+#define RGBLED_NUM 50
+
+
+/* COL2ROW or ROW2COL */
+#define DIODE_DIRECTION COL2ROW
+
+#define DEBOUNCE 5
+
+#define LOCKING_SUPPORT_ENABLE
+#define LOCKING_RESYNC_ENABLE

keyboards/handwired/selene/info.json

@@ -0,0 +1,121 @@
+{
+  "keyboard_name": "Selene",
+  "url": "https://github.com/Bpendragon/Selene-Keyboard",
+  "maintainer": "Bpendragon",
+  "width": 22.5,
+  "height": 6.5,
+  "layouts": {
+      "LAYOUT": {
+          "layout": [
+                {"label":"Esc", "x":0, "y":0},
+				{"label":"F1", "x":2, "y":0},
+				{"label":"F2", "x":3, "y":0},
+				{"label":"F3", "x":4, "y":0},
+				{"label":"F4", "x":5, "y":0},
+				{"label":"F5", "x":6.5, "y":0},
+				{"label":"F6", "x":7.5, "y":0},
+				{"label":"F7", "x":8.5, "y":0},
+				{"label":"F8", "x":9.5, "y":0},
+				{"label":"F9", "x":11, "y":0},
+				{"label":"F10", "x":12, "y":0},
+				{"label":"F11", "x":13, "y":0},
+				{"label":"F12", "x":14, "y":0},
+				{"label":"Print", "x":15.25, "y":0},
+				{"label":"Scroll Lock", "x":16.25, "y":0},
+				{"label":"Pause", "x":17.25, "y":0},
+				{"label":"Out", "x":18.5, "y":0},
+				{"label":"+", "x":19.5, "y":0},
+				{"label":"-", "x":20.5, "y":0},
+				{"label":"~", "x":21.5, "y":0},
+				{"label":"~", "x":0, "y":1.5},
+				{"label":"!", "x":1, "y":1.5},
+				{"label":"@", "x":2, "y":1.5},
+				{"label":"#", "x":3, "y":1.5},
+				{"label":"$", "x":4, "y":1.5},
+				{"label":"%", "x":5, "y":1.5},
+				{"label":"^", "x":6, "y":1.5},
+				{"label":"&", "x":7, "y":1.5},
+				{"label":"*", "x":8, "y":1.5},
+				{"label":"(", "x":9, "y":1.5},
+				{"label":")", "x":10, "y":1.5},
+				{"label":"_", "x":11, "y":1.5},
+				{"label":"+", "x":12, "y":1.5},
+				{"label":"<i class=\"fa fa-long-arrow-left\"></i>", "x":13, "y":1.5, "w":2},
+				{"label":"Insert", "x":15.25, "y":1.5},
+				{"label":"Home", "x":16.25, "y":1.5},
+				{"label":"Pg Up", "x":17.25, "y":1.5},
+				{"label":"Num", "x":18.5, "y":1.5},
+				{"label":"\u00f7", "x":19.5, "y":1.5},
+				{"label":"\u00d7", "x":20.5, "y":1.5},
+				{"label":"-", "x":21.5, "y":1.5},
+				{"label":"<i class='kb kb-Line-Start-End'></i>", "x":0, "y":2.5, "w":1.5},
+				{"label":"Q", "x":1.5, "y":2.5},
+				{"label":"W", "x":2.5, "y":2.5},
+				{"label":"E", "x":3.5, "y":2.5},
+				{"label":"R", "x":4.5, "y":2.5},
+				{"label":"T", "x":5.5, "y":2.5},
+				{"label":"Y", "x":6.5, "y":2.5},
+				{"label":"U", "x":7.5, "y":2.5},
+				{"label":"I", "x":8.5, "y":2.5},
+				{"label":"O", "x":9.5, "y":2.5},
+				{"label":"P", "x":10.5, "y":2.5},
+				{"label":"{", "x":11.5, "y":2.5},
+				{"label":"}", "x":12.5, "y":2.5},
+				{"label":"|", "x":13.5, "y":2.5, "w":1.5},
+				{"label":"Delete", "x":15.25, "y":2.5},
+				{"label":"End", "x":16.25, "y":2.5},
+				{"label":"Pg Dn", "x":17.25, "y":2.5},
+				{"label":"7", "x":18.5, "y":2.5},
+				{"label":"8", "x":19.5, "y":2.5},
+				{"label":"9", "x":20.5, "y":2.5},
+				{"label":"+", "x":21.5, "y":2.5, "h":2},
+				{"label":"\u21e9", "x":0, "y":3.5, "w":1.25},
+				{"label":"A", "x":1.75, "y":3.5},
+				{"label":"S", "x":2.75, "y":3.5},
+				{"label":"D", "x":3.75, "y":3.5},
+				{"label":"F", "x":4.75, "y":3.5},
+				{"label":"G", "x":5.75, "y":3.5},
+				{"label":"H", "x":6.75, "y":3.5},
+				{"label":"J", "x":7.75, "y":3.5},
+				{"label":"K", "x":8.75, "y":3.5},
+				{"label":"L", "x":9.75, "y":3.5},
+				{"label":":", "x":10.75, "y":3.5},
+				{"label":"\"", "x":11.75, "y":3.5},
+				{"label":"<i class='kb kb-Return-2'></i>", "x":12.75, "y":3.5, "w":2.25},
+				{"label":"4", "x":18.5, "y":3.5},
+				{"label":"5", "x":19.5, "y":3.5},
+				{"label":"6", "x":20.5, "y":3.5},
+				{"label":"\u21e7", "x":0, "y":4.5, "w":2.25},
+				{"label":"Z", "x":2.25, "y":4.5},
+				{"label":"X", "x":3.25, "y":4.5},
+				{"label":"C", "x":4.25, "y":4.5},
+				{"label":"V", "x":5.25, "y":4.5},
+				{"label":"B", "x":6.25, "y":4.5},
+				{"label":"N", "x":7.25, "y":4.5},
+				{"label":"M", "x":8.25, "y":4.5},
+				{"label":"<", "x":9.25, "y":4.5},
+				{"label":">", "x":10.25, "y":4.5},
+				{"label":"?", "x":11.25, "y":4.5},
+				{"label":"\u21e7", "x":12.25, "y":4.5, "w":2.75},
+				{"label":"\u2191", "x":16.25, "y":4.5},
+				{"label":"1", "x":18.5, "y":4.5},
+				{"label":"2", "x":19.5, "y":4.5},
+				{"label":"3", "x":20.5, "y":4.5},
+				{"label":"<i class='kb kb-Return-2'></i>", "x":21.5, "y":4.5, "h":2},
+				{"label":"Control", "x":0, "y":5.5, "w":1.25},
+				{"label":"Super", "x":1.25, "y":5.5, "w":1.25},
+				{"label":"Alt", "x":2.5, "y":5.5, "w":1.25},
+				{"x":3.75, "y":5.5, "w":6.25},
+				{"label":"Alt", "x":10, "y":5.5, "w":1.25},
+				{"label":"Super", "x":11.25, "y":5.5, "w":1.25},
+				{"label":"Menu", "x":12.5, "y":5.5, "w":1.25},
+				{"label":"Control", "x":13.75, "y":5.5, "w":1.25},
+				{"label":"\u2190", "x":15.25, "y":5.5},
+				{"label":"\u2193", "x":16.25, "y":5.5},
+				{"label":"\u2192", "x":17.25, "y":5.5},
+				{"label":"0", "x":18.5, "y":5.5},
+				{"label":"00", "x":19.5, "y":5.5},
+				{"label":".", "x":20.5, "y":5.5}]
+      }
+  }
+}

keyboards/handwired/selene/keymaps/bpendragon/keymap.c

@@ -0,0 +1,43 @@
+/* Copyright 2020 Bpendragon
+ *
+ * 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
+
+enum custom_keycodes {
+    DBL_0 = SAFE_RANGE,
+};
+
+bool process_record_user(uint16_t keycode, keyrecord_t *record) {
+    switch (keycode) {
+        case DBL_0:
+            if(record->event.pressed) {
+                SEND_STRING("00");
+            }
+            break;
+    }
+    return true;
+};
+
+const uint16_t PROGMEM keymaps[][MATRIX_ROWS][MATRIX_COLS] = {
+  [0] = LAYOUT (
+    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_SLCK, KC_PAUS, KC_MUTE, KC_MPRV, KC_MNXT, KC_MPLY,
+    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_HOME, KC_PGUP, KC_NLCK, KC_PSLS, KC_PAST, KC_PMNS,
+    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_BSLS, KC_DEL, KC_END, KC_PGDN, KC_P7, KC_P8, KC_P9, KC_PPLS,
+    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_ENT, KC_P4, KC_P5, KC_P6,
+    KC_LSFT, 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_P1, KC_P2, KC_P3, KC_PENT,
+    KC_LCTL, KC_LGUI, KC_LALT, KC_SPC, KC_RALT, KC_RGUI, KC_APP, KC_RCTL, KC_LEFT, KC_DOWN, KC_RGHT, KC_P0, DBL_0, KC_PDOT
+  )
+};

keyboards/handwired/selene/keymaps/default/keymap.c

@@ -0,0 +1,43 @@
+/* Copyright 2020 Bpendragon
+ *
+ * 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
+
+enum custom_keycodes {
+    DBL_0 = SAFE_RANGE,
+};
+
+bool process_record_user(uint16_t keycode, keyrecord_t *record) {
+    switch (keycode) {
+        case DBL_0:
+            if(record->event.pressed) {
+                SEND_STRING("00");
+            }
+            break;
+    }
+    return true;
+};
+
+const uint16_t PROGMEM keymaps[][MATRIX_ROWS][MATRIX_COLS] = {
+  [0] = LAYOUT (
+    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_SLCK, KC_PAUS, KC_MUTE, KC_MPRV, KC_MNXT, KC_MPLY,
+    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_HOME, KC_PGUP, KC_NLCK, KC_PSLS, KC_PAST, KC_PMNS,
+    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_BSLS, KC_DEL, KC_END, KC_PGDN, KC_P7, KC_P8, KC_P9, KC_PPLS,
+    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_ENT, KC_P4, KC_P5, KC_P6,
+    KC_LSFT, 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_P1, KC_P2, KC_P3, KC_PENT,
+    KC_LCTL, KC_LGUI, KC_LALT, KC_SPC, KC_RALT, KC_RGUI, KC_APP, KC_RCTL, KC_LEFT, KC_DOWN, KC_RGHT, KC_P0, DBL_0, KC_PDOT
+  )
+};

keyboards/handwired/selene/readme.md

@@ -0,0 +1,17 @@
+# Selene
+
+![Selene](https://i.imgur.com/qLyaZtWl.jpg)
+
+A 109 key Full size with Media and 00 Keys
+
+[Layout](http://www.keyboard-layout-editor.com/#/gists/7abe0f9944f72517c9f9f7b989548eb5)
+
+* Keyboard Maintainer: [Bpendragon](https://github.com/Bpendragon)
+* Hardware Supported: Proton-C
+* Hardware Availability: DXF files for the plates may be downloded [From the Project Repo](https://github.com/Bpendragon/Selene-Keyboard/releases/tag/1.0). You'll have to source the plates yourself. (I used Ponoko for the Acrylic and Elevated Materials for the Carbon Fiber)
+
+Make example for this keyboard (after setting up your build environment):
+
+    make handwired/selene: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)

keyboards/handwired/selene/rules.mk

@@ -0,0 +1,20 @@
+# MCU name
+MCU = STM32F303
+
+# Build Options
+#   change yes to no to disable
+#
+BOOTMAGIC_ENABLE = lite     # Virtual DIP switch configuration
+MOUSEKEY_ENABLE = no        # Mouse keys
+EXTRAKEY_ENABLE = yes       # Audio control and System control
+CONSOLE_ENABLE = yes        # Console for debug
+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 = yes           # USB Nkey Rollover
+BACKLIGHT_ENABLE = no       # Enable keyboard backlight functionality
+RGBLIGHT_ENABLE = yes       # Enable keyboard RGB underglow
+WS2812_DRIVER = bitbang
+BLUETOOTH_ENABLE = no       # Enable Bluetooth
+AUDIO_ENABLE = no           # Audio output

keyboards/handwired/selene/selene.c

@@ -0,0 +1,38 @@
+/* Copyright 2020 Bpendragon
+ *
+ * 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 "selene.h"
+
+void matrix_init_kb(void){
+    setPinOutput(NUM_LOCK_PIN);
+    setPinOutput(CAPS_LOCK_PIN);
+    setPinOutput(SCROLL_LOCK_PIN);
+}
+
+void keyboard_post_init_user(void) {
+    rgblight_setrgb(0xff, 0xff, 0xff);
+}
+
+bool led_update_kb(led_t led_state) {
+    bool res = led_update_user(led_state);
+    if(res) {
+        writePin(NUM_LOCK_PIN, led_state.num_lock);
+        writePin(CAPS_LOCK_PIN, led_state.caps_lock);
+        writePin(SCROLL_LOCK_PIN, led_state.scroll_lock);
+    }
+    return res;
+}

keyboards/handwired/selene/selene.h

@@ -0,0 +1,39 @@
+/* Copyright 2020 Bpendragon
+ *
+ * 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 NUM_LOCK_PIN A0
+#define CAPS_LOCK_PIN A2
+#define SCROLL_LOCK_PIN A1
+
+#define LAYOUT( \
+	K000,       K002, K003, K004, K005, K006, K007, K008, K009, K010, K011, K012, K013, K014, K015, K016, K017, K018, K019, K020, \
+	K100, K101, K102, K103, K104, K105, K106, K107, K108, K109, K110, K111, K112, K113, K114, K115, K116, K117, K118, K119, K120, \
+	K200, K201, K202, K203, K204, K205, K206, K207, K208, K209, K210, K211, K212, K213, K214, K215, K216, K217, K218, K219, K220, \
+	K300, K301, K302, K303, K304, K305, K306, K307, K308, K309, K310, K311,       K313,                   K317, K318, K319,       \
+	K400, K401, K402, K403, K404, K405, K406, K407, K408, K409, K410,       K412,             K415,       K417, K418, K419, K420, \
+	K500, K501, K502,             K505,                   K509, K510, K511,       K513, K514, K515, K516, K517, K518, K519  \
+) { \
+	{ K000,  KC_NO, K002,  K003,  K004,  K005,  K006,  K007,  K008,  K009,  K010,  K011,  K012,  K013,  K014,  K015,  K016,  K017,  K018,  K019,  K020 }, \
+	{ K100,  K101,  K102,  K103,  K104,  K105,  K106,  K107,  K108,  K109,  K110,  K111,  K112,  K113,  K114,  K115,  K116,  K117,  K118,  K119,  K120 }, \
+	{ K200,  K201,  K202,  K203,  K204,  K205,  K206,  K207,  K208,  K209,  K210,  K211,  K212,  K213,  K214,  K215,  K216,  K217,  K218,  K219,  K220 }, \
+	{ K300,  K301,  K302,  K303,  K304,  K305,  K306,  K307,  K308,  K309,  K310,  K311,  KC_NO, K313,  KC_NO, KC_NO, KC_NO, K317,  K318,  K319,  KC_NO }, \
+	{ K400,  K401,  K402,  K403,  K404,  K405,  K406,  K407,  K408,  K409,  K410,  KC_NO, K412,  KC_NO, KC_NO, K415,  KC_NO, K417,  K418,  K419,  K420 }, \
+	{ K500,  K501,  K502,  KC_NO, KC_NO, K505,  KC_NO, KC_NO, KC_NO, K509,  K510,  K511,  KC_NO, K513,  K514,  K515,  K516,  K517,  K518,  K519,  KC_NO }  \
+}