add VN66 keyboard (qmk#6722)

* add VN66 keyboard

* update

* Update readme.md

* Update readme.md

* add hnah108 personal pcb

* delete hnah108

* Update vn66.c

keyboards/vn66/config.h

@@ -0,0 +1,87 @@
+/*
+Copyright 2019 HnahKB
+
+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 0xFEED
+#define PRODUCT_ID 0x0000
+#define DEVICE_VER 0x0001
+#define MANUFACTURER HnahKB
+#define PRODUCT VN66
+#define DESCRIPTION A compact keyboard for VNMK
+
+/* key matrix size */
+#define MATRIX_ROWS 5
+#define MATRIX_COLS 14
+
+/*
+ * 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 \
+    { B1, B2, B3, D2, F7 }
+#define MATRIX_COL_PINS \
+    { F6, F5, F4, F1, F0, C6, C7, B5, B4, D7, D6, D4, D5, D3 }
+#define UNUSED_PINS
+
+/* COL2ROW, ROW2COL*/
+#define DIODE_DIRECTION COL2ROW
+
+
+#define BACKLIGHT_PIN B6
+#define BACKLIGHT_BREATHING
+#define BACKLIGHT_LEVELS 4
+
+#define RGB_DI_PIN E2
+ #ifdef RGB_DI_PIN
+   #define RGBLED_NUM 20
+   #define RGBLIGHT_HUE_STEP 8
+   #define RGBLIGHT_SAT_STEP 8
+   #define RGBLIGHT_VAL_STEP 8
+   #define RGBLIGHT_LIMIT_VAL 255 /* The maximum brightness level */
+   #define RGBLIGHT_SLEEP  /* If defined, the RGB lighting will be switched off when the host goes to sleep */
+// /*== all animations enable ==*/
+   #define RGBLIGHT_ANIMATIONS
+ #endif 
+/* Debounce reduces chatter (unintended double-presses) - set 0 if debouncing is not needed */
+#define DEBOUNCE 3
+
+/* define if matrix has ghost (lacks anti-ghosting diodes) */
+//#define MATRIX_HAS_GHOST
+
+/* 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
+
+#define ENCODERS_PAD_A {B0}
+#define ENCODERS_PAD_B {B7}
+#define ENCODER_RESOLUTION 2

keyboards/vn66/info.json

@@ -0,0 +1,18 @@
+{
+    "keyboard_name": "vn66", 
+    "url": "fb.com/groups/VietNamMechKey/", 
+    "maintainer": "qmk", 
+    "width": 19.25, 
+    "height": 5.25, 
+    "layouts": {
+        "LAYOUT_all": {
+            "layout": [{"label":"ESC", "x":3, "y":0}, {"label":"!", "x":4, "y":0}, {"label":"@", "x":5, "y":0}, {"label":"#", "x":6, "y":0}, {"label":"$", "x":7, "y":0}, {"label":"%", "x":8, "y":0}, {"label":"^", "x":9, "y":0}, {"label":"&", "x":10, "y":0}, {"label":"*", "x":11, "y":0}, {"label":"(", "x":12, "y":0}, {"label":")", "x":13, "y":0}, {"label":"_", "x":14, "y":0}, {"label":"+", "x":15, "y":0}, {"x":16, "y":0}, {"x":17, "y":0}, {"label":"Insert", "x":18.25, "y":0}, {"label":"Tab", "x":3, "y":1, "w":1.5}, {"label":"Q", "x":4.5, "y":1}, {"label":"W", "x":5.5, "y":1}, {"label":"E", "x":6.5, "y":1}, {"label":"R", "x":7.5, "y":1}, {"label":"T", "x":8.5, "y":1}, {"label":"Y", "x":9.5, "y":1}, {"label":"U", "x":10.5, "y":1}, {"label":"I", "x":11.5, "y":1}, {"label":"O", "x":12.5, "y":1}, {"label":"P", "x":13.5, "y":1}, {"label":"{", "x":14.5, "y":1}, {"label":"}", "x":15.5, "y":1}, {"label":"Enter", "x":16.75, "y":1, "w":1.25, "h":2}, {"label":"Delete", "x":18.25, "y":1}, {"label":"Caps", "x":3, "y":2, "w":1.25}, {"label":"A", "x":4.75, "y":2}, {"label":"S", "x":5.75, "y":2}, {"label":"D", "x":6.75, "y":2}, {"label":"F", "x":7.75, "y":2}, {"label":"G", "x":8.75, "y":2}, {"label":"H", "x":9.75, "y":2}, {"label":"J", "x":10.75, "y":2}, {"label":"K", "x":11.75, "y":2}, {"label":"L", "x":12.75, "y":2}, {"label":":", "x":13.75, "y":2}, {"label":"\"", "x":14.75, "y":2}, {"x":15.75, "y":2}, {"x":3, "y":3, "w":1.25}, {"x":4.25, "y":3}, {"label":"Z", "x":5.25, "y":3}, {"label":"X", "x":6.25, "y":3}, {"label":"C", "x":7.25, "y":3}, {"label":"V", "x":8.25, "y":3}, {"label":"B", "x":9.25, "y":3}, {"label":"N", "x":10.25, "y":3}, {"label":"M", "x":11.25, "y":3}, {"label":"<", "x":12.25, "y":3}, {"label":">", "x":13.25, "y":3}, {"label":"?", "x":14.25, "y":3}, {"label":"Shift", "x":15.25, "y":3, "w":1.75}, {"label":"\u2191", "x":17.25, "y":3.25}, {"label":"Ctrl", "x":3, "y":4, "w":1.25}, {"label":"Win", "x":4.25, "y":4}, {"label":"Alt", "x":5.25, "y":4, "w":1.25}, {"x":6.5, "y":4, "w":6}, {"label":"Alt", "x":12.5, "y":4, "w":1.25}, {"label":"Ctrl", "x":13.75, "y":4}, {"label":"Menu", "x":14.75, "y":4, "w":1.25}, {"label":"\u2190", "x":16.25, "y":4.25}, {"label":"\u2193", "x":17.25, "y":4.25}, {"label":"\u2192", "x":18.25, "y":4.25}]
+        },
+        "LAYOUT_ansi": {
+            "layout": [{"label":"ESC", "x":3, "y":0}, {"label":"!", "x":4, "y":0}, {"label":"@", "x":5, "y":0}, {"label":"#", "x":6, "y":0}, {"label":"$", "x":7, "y":0}, {"label":"%", "x":8, "y":0}, {"label":"^", "x":9, "y":0}, {"label":"&", "x":10, "y":0}, {"label":"*", "x":11, "y":0}, {"label":"(", "x":12, "y":0}, {"label":")", "x":13, "y":0}, {"label":"_", "x":14, "y":0}, {"label":"+", "x":15, "y":0}, {"x":16, "y":0, "w":2}, {"label":"Insert", "x":18.25, "y":0}, {"label":"Tab", "x":3, "y":1, "w":1.5}, {"label":"Q", "x":4.5, "y":1}, {"label":"W", "x":5.5, "y":1}, {"label":"E", "x":6.5, "y":1}, {"label":"R", "x":7.5, "y":1}, {"label":"T", "x":8.5, "y":1}, {"label":"Y", "x":9.5, "y":1}, {"label":"U", "x":10.5, "y":1}, {"label":"I", "x":11.5, "y":1}, {"label":"O", "x":12.5, "y":1}, {"label":"P", "x":13.5, "y":1}, {"label":"{", "x":14.5, "y":1}, {"label":"}", "x":15.5, "y":1}, {"x":16.5, "y":1, "w":1.5}, {"label":"Delete", "x":18.25, "y":1}, {"label":"Caps", "x":3, "y":2, "w":1.25}, {"label":"A", "x":4.75, "y":2}, {"label":"S", "x":5.75, "y":2}, {"label":"D", "x":6.75, "y":2}, {"label":"F", "x":7.75, "y":2}, {"label":"G", "x":8.75, "y":2}, {"label":"H", "x":9.75, "y":2}, {"label":"J", "x":10.75, "y":2}, {"label":"K", "x":11.75, "y":2}, {"label":"L", "x":12.75, "y":2}, {"label":":", "x":13.75, "y":2}, {"label":"\"", "x":14.75, "y":2}, {"label":"Enter", "x":16, "y":2, "w":2}, {"label":"Shift", "x":3, "y":3, "w":2.25}, {"label":"Z", "x":5.25, "y":3}, {"label":"X", "x":6.25, "y":3}, {"label":"C", "x":7.25, "y":3}, {"label":"V", "x":8.25, "y":3}, {"label":"B", "x":9.25, "y":3}, {"label":"N", "x":10.25, "y":3}, {"label":"M", "x":11.25, "y":3}, {"label":"<", "x":12.25, "y":3}, {"label":">", "x":13.25, "y":3}, {"label":"Shift", "x":14.25, "y":3, "w":2.75}, {"label":"\u2191", "x":17.25, "y":3.25}, {"label":"Ctrl", "x":3, "y":4, "w":1.25}, {"label":"Win", "x":4.25, "y":4, "w":1.25}, {"label":"Alt", "x":5.5, "y":4, "w":1.25}, {"x":6.75, "y":4, "w":6.25}, {"label":"Alt", "x":13, "y":4, "w":1.5}, {"label":"Ctrl", "x":14.5, "y":4, "w":1.5}, {"label":"\u2190", "x":16.25, "y":4.25}, {"label":"\u2193", "x":17.25, "y":4.25}, {"label":"\u2192", "x":18.25, "y":4.25}]
+        },
+        "LAYOUT_iso": {
+            "layout": [{"label":"ESC", "x":3, "y":0}, {"label":"!", "x":4, "y":0}, {"label":"@", "x":5, "y":0}, {"label":"#", "x":6, "y":0}, {"label":"$", "x":7, "y":0}, {"label":"%", "x":8, "y":0}, {"label":"^", "x":9, "y":0}, {"label":"&", "x":10, "y":0}, {"label":"*", "x":11, "y":0}, {"label":"(", "x":12, "y":0}, {"label":")", "x":13, "y":0}, {"label":"_", "x":14, "y":0}, {"label":"+", "x":15, "y":0}, {"x":16, "y":0}, {"x":17, "y":0}, {"label":"Insert", "x":18.25, "y":0}, {"label":"Tab", "x":3, "y":1, "w":1.5}, {"label":"Q", "x":4.5, "y":1}, {"label":"W", "x":5.5, "y":1}, {"label":"E", "x":6.5, "y":1}, {"label":"R", "x":7.5, "y":1}, {"label":"T", "x":8.5, "y":1}, {"label":"Y", "x":9.5, "y":1}, {"label":"U", "x":10.5, "y":1}, {"label":"I", "x":11.5, "y":1}, {"label":"O", "x":12.5, "y":1}, {"label":"P", "x":13.5, "y":1}, {"label":"{", "x":14.5, "y":1}, {"label":"}", "x":15.5, "y":1}, {"label":"Enter", "x":16.75, "y":1, "w":1.25, "h":2}, {"label":"Delete", "x":18.25, "y":1}, {"label":"Caps", "x":3, "y":2, "w":1.25}, {"label":"A", "x":4.75, "y":2}, {"label":"S", "x":5.75, "y":2}, {"label":"D", "x":6.75, "y":2}, {"label":"F", "x":7.75, "y":2}, {"label":"G", "x":8.75, "y":2}, {"label":"H", "x":9.75, "y":2}, {"label":"J", "x":10.75, "y":2}, {"label":"K", "x":11.75, "y":2}, {"label":"L", "x":12.75, "y":2}, {"label":":", "x":13.75, "y":2}, {"label":"\"", "x":14.75, "y":2}, {"x":15.75, "y":2}, {"x":3, "y":3, "w":1.25}, {"x":4.25, "y":3}, {"label":"Z", "x":5.25, "y":3}, {"label":"X", "x":6.25, "y":3}, {"label":"C", "x":7.25, "y":3}, {"label":"V", "x":8.25, "y":3}, {"label":"B", "x":9.25, "y":3}, {"label":"N", "x":10.25, "y":3}, {"label":"M", "x":11.25, "y":3}, {"label":"<", "x":12.25, "y":3}, {"label":">", "x":13.25, "y":3}, {"label":"?", "x":14.25, "y":3}, {"label":"Shift", "x":15.25, "y":3, "w":1.75}, {"label":"\u2191", "x":17.25, "y":3.25}, {"label":"Ctrl", "x":3, "y":4, "w":1.25}, {"label":"Win", "x":4.25, "y":4}, {"label":"Alt", "x":5.25, "y":4, "w":1.25}, {"x":6.5, "y":4, "w":6}, {"label":"Alt", "x":12.5, "y":4, "w":1.25}, {"label":"Ctrl", "x":13.75, "y":4}, {"label":"Menu", "x":14.75, "y":4, "w":1.25}, {"label":"\u2190", "x":16.25, "y":4.25}, {"label":"\u2193", "x":17.25, "y":4.25}, {"label":"\u2192", "x":18.25, "y":4.25}]
+        }
+    }
+}

keyboards/vn66/keymaps/default/config.h

@@ -0,0 +1,19 @@
+/* Copyright 2019 HnahKB
+ *
+ * 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

keyboards/vn66/keymaps/default/keymap.c

@@ -0,0 +1,57 @@
+/* Copyright 2019 HnahKB
+ *
+ * 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 hnah_layers{
+  _QWERTY,
+  _LOWER
+};
+
+#define LOWER MO(_LOWER)
+
+
+const uint16_t PROGMEM keymaps[][MATRIX_ROWS][MATRIX_COLS] = {
+  [_QWERTY] = LAYOUT_all( /* Base */
+    GRAVE_ESC, 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_DEL,       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_BSLS,           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_NUHS, KC_ENT,
+     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_LCTL,   KC_LGUI,   KC_LALT,            KC_SPACE,             KC_RALT,        LOWER,  KC_RCTL,    KC_LEFT, KC_DOWN, KC_RGHT   
+  ),
+    [_LOWER] = LAYOUT_all( /* Base */
+    KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS,       KC_TRNS,
+     KC_TRNS,  BL_STEP, KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS,  KC_TRNS,           KC_TRNS,
+      KC_TRNS,  KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS, KC_TRNS,
+     KC_TRNS,  KC_TRNS, KC_TRNS, RGB_TOG, RGB_MOD, RGB_HUI, KC_TRNS, KC_TRNS, KC_TRNS, KC_COMM, KC_TRNS, KC_TRNS,  KC_TRNS,               KC_TRNS,
+     KC_TRNS,   KC_TRNS,   KC_TRNS,            KC_TRNS,             KC_TRNS,        KC_TRNS,  KC_TRNS,               KC_TRNS, KC_TRNS, KC_TRNS   
+  ),
+};
+
+void encoder_update_user(uint8_t index, bool clockwise) {
+    if (clockwise == 0) {
+      #ifdef MOUSEKEY_ENABLE
+        tap_code(KC_MS_WH_DOWN);
+      #else
+        tap_code(KC_VOLD);
+      #endif
+    } else {
+      #ifdef MOUSEKEY_ENABLE
+        tap_code(KC_MS_WH_UP);
+      #else
+        tap_code(KC_VOLU);
+      #endif
+    }
+  }

keyboards/vn66/keymaps/default/readme.md

@@ -0,0 +1 @@
+# The default keymap for vn66

keyboards/vn66/readme.md

@@ -0,0 +1,15 @@
+# vn66
+
+![vn66](https://i.imgur.com/Eo28suI.jpg)
+
+A compact 60% keyboard for VNMK
+
+Keyboard Maintainer: VNMK Community  
+Hardware Supported: VN66 PCB rev.2  
+Hardware Availability: [https://geekhack.org/index.php?topic=101754.0]
+
+Make example for this keyboard (after setting up your build environment):
+
+    make vn66: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/vn66/rules.mk

@@ -0,0 +1,45 @@
+# 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
+BOOTLOADER = atmel-dfu
+
+
+# If you don't know the bootloader type, then you can specify the
+# Boot Section Size in *bytes* by uncommenting out the OPT_DEFS line
+#   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 = lite      # Virtual DIP switch configuration(+1000)
+MOUSEKEY_ENABLE = no       # 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 = yes       # Enable keyboard backlight functionality
+RGBLIGHT_ENABLE = yes        # Enable keyboard RGB underglow
+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
+HD44780_ENABLE = no 		# Enable support for HD44780 based LCDs (+400)
+ENCODER_ENABLE = yes

keyboards/vn66/vn66.c

@@ -0,0 +1,36 @@
+/* Copyright 2019 HnahKB
+ *
+ * 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 "vn66.h"
+
+void matrix_init_kb(void) {
+  led_init_ports();
+  matrix_init_user(); 
+};
+
+void led_init_ports(void) {
+  setPinOutput(E6);
+}
+
+void led_set_kb(uint8_t usb_led) {
+  if (IS_LED_ON(usb_led, USB_LED_CAPS_LOCK)) {
+    // Turn Caps Lock LED on
+    writePinLow(E6);
+  } else {
+    // Turn Caps Lock LED off
+    writePinHigh(E6);
+  }
+    led_set_user(usb_led);
+}