~ruther/qmk_firmware

ea8822e26713753e694e51ede6e2a668d52b0173 — asdftemp 5 years ago aba9032
[Keyboard] Added slash keyboard (#7042)

* feat(slash): added slash keyboard

* fix(slash): fixed typo in readme

* Improvements after review

* disabled debug and print to reduce firmware size

* Fixes after review

* fixed hardware list in readme.md
A keyboards/handwired/slash/config.h => keyboards/handwired/slash/config.h +59 -0
@@ 0,0 1,59 @@
/*
Copyright 2019 4sdftemp

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 asdftemp
#define PRODUCT Slash
#define DESCRIPTION 60% keyboard with bluetooth

/* key matrix size */
#define MATRIX_ROWS 8
#define MATRIX_COLS 8

/*
 * 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 { C7, D6, B7, B6, B5, D7, C6, D0 }
#define MATRIX_COL_PINS { D2, F0, F1, F4, F5, F6, F7, D3 }
#define UNUSED_PINS
/* COL2ROW, ROW2COL*/
#define DIODE_DIRECTION COL2ROW

/* Debounce reduces chatter (unintended double-presses) - set 0 if debouncing is not needed */
#define DEBOUNCE 5

/* 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

A keyboards/handwired/slash/info.json => keyboards/handwired/slash/info.json +74 -0
@@ 0,0 1,74 @@
{
    "keyboard_name": "slash",
    "url": "",
    "maintainer": "qmk",
    "width": 16.75,
    "height": 5,
    "layouts": {
        "LAYOUT": {
            "layout": [
                {"label":"`", "x":1.75, "y":0},
                {"label":"1", "x":2.75, "y":0},
                {"label":"2", "x":3.75, "y":0},
                {"label":"3", "x":4.75, "y":0},
                {"label":"4", "x":5.75, "y":0},
                {"label":"5", "x":6.75, "y":0},
                {"label":"6", "x":7.75, "y":0},
                {"label":"7", "x":8.75, "y":0},
                {"label":"8", "x":9.75, "y":0},
                {"label":"9", "x":10.75, "y":0},
                {"label":"0", "x":11.75, "y":0},
                {"label":"-", "x":12.75, "y":0},
                {"label":"=", "x":13.75, "y":0},
                {"label":"Backspace", "x":14.75, "y":0, "w":2},
                {"label":"Tab", "x":1.25, "y":1, "w":1.5},
                {"label":"Q", "x":2.75, "y":1},
                {"label":"W", "x":3.75, "y":1},
                {"label":"E", "x":4.75, "y":1},
                {"label":"R", "x":5.75, "y":1},
                {"label":"T", "x":6.75, "y":1},
                {"label":"Y", "x":7.75, "y":1},
                {"label":"U", "x":8.75, "y":1},
                {"label":"I", "x":9.75, "y":1},
                {"label":"O", "x":10.75, "y":1},
                {"label":"P", "x":11.75, "y":1},
                {"label":"[", "x":12.75, "y":1},
                {"label":"]", "x":13.75, "y":1},
                {"label":"\\", "x":14.75, "y":1, "w":1.5},
                {"label":"Caps Lock", "x":1, "y":2, "w":1.75},
                {"label":"A", "x":2.75, "y":2},
                {"label":"S", "x":3.75, "y":2},
                {"label":"D", "x":4.75, "y":2},
                {"label":"F", "x":5.75, "y":2},
                {"label":"G", "x":6.75, "y":2},
                {"label":"H", "x":7.75, "y":2},
                {"label":"J", "x":8.75, "y":2},
                {"label":"K", "x":9.75, "y":2},
                {"label":"L", "x":10.75, "y":2},
                {"label":";", "x":11.75, "y":2},
                {"label":"'", "x":12.75, "y":2},
                {"label":"Enter", "x":13.75, "y":2, "w":2.25},
                {"label":"Shift", "x":0.5, "y":3, "w":2.25},
                {"label":"Z", "x":2.75, "y":3},
                {"label":"X", "x":3.75, "y":3},
                {"label":"C", "x":4.75, "y":3},
                {"label":"V", "x":5.75, "y":3},
                {"label":"B", "x":6.75, "y":3},
                {"label":"N", "x":7.75, "y":3},
                {"label":"M", "x":8.75, "y":3},
                {"label":",", "x":9.75, "y":3},
                {"label":".", "x":10.75, "y":3},
                {"label":"/", "x":11.75, "y":3},
                {"label":"Shift", "x":12.75, "y":3, "w":2.75},
                {"label":"Ctrl", "x":0, "y":4, "w":1.25},
                {"label":"GUI", "x":1.25, "y":4, "w":1.25},
                {"label":"Alt", "x":2.5, "y":4, "w":1.25},
                {"label":"Space", "x":3.75, "y":4, "w":6.25},
                {"label":"Alt", "x":10, "y":4, "w":1.25},
                {"label":"GUI", "x":11.25, "y":4, "w":1.25},
                {"label":"Menu", "x":12.5, "y":4, "w":1.25},
                {"label":"Ctrl", "x":13.75, "y":4, "w":1.25}
            ]
        }
    }
}

A keyboards/handwired/slash/keymaps/default/config.h => keyboards/handwired/slash/keymaps/default/config.h +19 -0
@@ 0,0 1,19 @@
/* Copyright 2019 4sdftemp
 *
 * 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

A keyboards/handwired/slash/keymaps/default/keymap.c => keyboards/handwired/slash/keymaps/default/keymap.c +11 -0
@@ 0,0 1,11 @@
#include QMK_KEYBOARD_H

const uint16_t PROGMEM keymaps[][MATRIX_ROWS][MATRIX_COLS] = {
  LAYOUT( /* Base */
    KC_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_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_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_LSFT,          KC_Z,    KC_X,    KC_C,    KC_V,    KC_B,    KC_N,    KC_M,    KC_COMM, KC_DOT,  KC_SLSH,          KC_RSFT,
    KC_LCTL,   KC_LGUI, KC_LALT,                            KC_SPC,                             KC_RALT, KC_RGUI, KC_APP,  KC_RCTL
  ),
};

A keyboards/handwired/slash/keymaps/default/readme.md => keyboards/handwired/slash/keymaps/default/readme.md +1 -0
@@ 0,0 1,1 @@
# The default keymap for slash

A keyboards/handwired/slash/readme.md => keyboards/handwired/slash/readme.md +19 -0
@@ 0,0 1,19 @@
# slash

![slash](https://i.imgur.com/MYEfSE0.jpg)

I found this project a while ago on [Reddit](https://www.reddit.com/r/MechanicalKeyboards/comments/6v3b6f/build_slash_keyboard_handwired_bluetooth/). This keyboard uses 61 keys in a 8x8 matrix. That bring the required pins to 16 which leaves 1 pin free. Unfortunately I couldn't get the firmware to compile on kbfirmware.com(the way [ND1BV](https://imgur.com/user/ND1BV) described it). So I decided to create the config myself and share it. I changed the wiring of the pins a little bit showed [here](https://i.imgur.com/WZ93xHx.png)

Keyboard Maintainer: [asdftemp](https://github.com/asdftemp)  
Hardware Supported: Adafruit Feather 32u4 Bluefruit LE  
Hardware Availability: [Adafruit shop](https://www.adafruit.com/product/2829)  

Make example for this keyboard (after setting up your build environment):

    make handwired/slash:default

Flashing should be done trough avrdude. Full make command is:

    make handwired/slash:default:flash

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).

A keyboards/handwired/slash/rules.mk => keyboards/handwired/slash/rules.mk +30 -0
@@ 0,0 1,30 @@
# MCU name
MCU = atmega32u4

# Processor frequency
F_CPU = 8000000

# Bootloader selection
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 = no            # USB Nkey Rollover
BACKLIGHT_ENABLE = no       # Enable keyboard backlight functionality
RGBLIGHT_ENABLE = no        # Enable keyboard RGB underglow
MIDI_ENABLE = no            # MIDI support
UNICODE_ENABLE = no         # Unicode
#BLUETOOTH_ENABLE = Yes # Enable Bluetooth with the Adafruit EZ-Key HID
BLUETOOTH = AdafruitBLE
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

A keyboards/handwired/slash/slash.c => keyboards/handwired/slash/slash.c +16 -0
@@ 0,0 1,16 @@
/* Copyright 2019 4sdftemp
 *
 * 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 "slash.h"

A keyboards/handwired/slash/slash.h => keyboards/handwired/slash/slash.h +36 -0
@@ 0,0 1,36 @@
/* Copyright 2019 asdftemp
 *
 * 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, k02, k03, k04, k05, k06, k07, k08, k09, k0A, k0B, k0C,    k0D, \
    k10,    k11, k12, k13, k14, k15, k16, k17, k18, k19, k1A, k1B, k1C, k1D, \
    k20,     k21, k22, k23, k24, k25, k26, k27, k28, k29, k2A, k2B,     k2C, \
    k30,      k31, k32, k33, k34, k35, k36, k37, k38, k39, k3A,         k3B, \
    k40,  k41,  k42,               k43,               k44,  k45,  k46,  k47  \
) \
{ \
    { k00, k02, k04, k06, k08, k0A, k0C, KC_NO }, \
    { k01, k03, k05, k07, k09, k0B, k0D, KC_NO }, \
    { k10, k12, k14, k16, k18, k1A, k1C, k45 }, \
    { k11, k13, k15, k17, k19, k1B, k1D, k44 }, \
    { k21, k23, k25, k27, k29, k2B, KC_NO, k42 }, \
    { k20, k22, k24, k26, k28, k2A, k2C, k43 }, \
    { k31, k33, k35, k37, k39, k3B, k47, k40 }, \
    { k30, k32, k34, k36, k38, k3A, k46, k41 } \
}