~ruther/qmk_firmware

d354b1f0a432deea8b7a713279cc64572542bce0 — sithlord121 4 years ago 95022bc
[Keyboard] New keyboard SLZ40 (#11088)

* New SLZ40 keyboard

new keyboard added

* Update readme.md

* Update info.json

* Delete slz40_default.hex

* Update keyboards/slz40/keymaps/default/keymap.c

Co-authored-by: Joel Challis <git@zvecr.com>

* Update keyboards/slz40/keymaps/default/keymap.c

Co-authored-by: Joel Challis <git@zvecr.com>

* Update readme.md

* Update readme.md

Co-authored-by: Joel Challis <git@zvecr.com>
A keyboards/slz40/config.h => keyboards/slz40/config.h +146 -0
@@ 0,0 1,146 @@
/*
Copyright 2020 SithLord

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 SithLord
#define PRODUCT      slz40

/* key matrix size */
#define MATRIX_ROWS 5
#define MATRIX_COLS 12

/*
 * 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 { B4, B5, B3, B2, B6 }
#define MATRIX_COL_PINS { F4, D2, F5, D1, F6, D0, F7, D4, B1, C6, E6, D7 }
#define UNUSED_PINS

/* COL2ROW, ROW2COL */
#define DIODE_DIRECTION COL2ROW

/*
 * Split Keyboard specific options, make sure you have 'SPLIT_KEYBOARD = yes' in your rules.mk, and define SOFT_SERIAL_PIN.
 */
#define SOFT_SERIAL_PIN D0  // or D1, D2, D3, E6

//#define BACKLIGHT_PIN B7
//#define BACKLIGHT_LEVELS 3
//#define BACKLIGHT_BREATHING

//#define RGB_DI_PIN E2
//#ifdef RGB_DI_PIN
//#    define RGBLED_NUM 16
//#    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
/*== or choose animations ==*/
//#    define RGBLIGHT_EFFECT_BREATHING
//#    define RGBLIGHT_EFFECT_RAINBOW_MOOD
//#    define RGBLIGHT_EFFECT_RAINBOW_SWIRL
//#    define RGBLIGHT_EFFECT_SNAKE
//#    define RGBLIGHT_EFFECT_KNIGHT
//#    define RGBLIGHT_EFFECT_CHRISTMAS
//#    define RGBLIGHT_EFFECT_STATIC_GRADIENT
//#    define RGBLIGHT_EFFECT_RGB_TEST
//#    define RGBLIGHT_EFFECT_ALTERNATING
/*== customize breathing effect ==*/
/*==== (DEFAULT) use fixed table instead of exp() and sin() ====*/
//#    define RGBLIGHT_BREATHE_TABLE_SIZE 256      // 256(default) or 128 or 64
/*==== use exp() and sin() ====*/
//#    define RGBLIGHT_EFFECT_BREATHE_CENTER 1.85  // 1 to 2.7
//#    define RGBLIGHT_EFFECT_BREATHE_MAX    255   // 0 to 255
//#endif

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

/* If defined, GRAVE_ESC will always act as ESC when CTRL is held.
 * This is useful 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

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

/* disable these deprecated features by default */
#define NO_ACTION_MACRO
#define NO_ACTION_FUNCTION

/* Bootmagic Lite key configuration */
//#define BOOTMAGIC_LITE_ROW 0
//#define BOOTMAGIC_LITE_COLUMN 0

A keyboards/slz40/info.json => keyboards/slz40/info.json +76 -0
@@ 0,0 1,76 @@
{
    "keyboard_name": "slz40",
    "url": "https://github.com/sithlord121/slz40",
    "maintainer": "SithLord",
    "width": 13,
    "height": 5,
    "layouts": {
        "LAYOUT": {
            "layout": [
                {"label": "1", "x": 0.5, "y": 0},
                {"label": "2", "x": 1.5, "y": 0},
                {"label": "3", "x": 2.5, "y": 0},
                {"label": "4", "x": 3.5, "y": 0},
                {"label": "5", "x": 4.5, "y": 0},
                {"label": "6", "x": 5.5, "y": 0},
                {"label": "7", "x": 6.5, "y": 0},
                {"label": "8", "x": 7.5, "y": 0},
                {"label": "9", "x": 8.5, "y": 0},
                {"label": "0", "x": 9.5, "y": 0},
                {"label": "-", "x": 10.5, "y": 0},

                {"label": "esc", "x": 0, "y": 1},
                {"label": "q", "x": 1, "y": 1},
                {"label": "w", "x": 2, "y": 1},
                {"label": "e", "x": 3, "y": 1},
                {"label": "r", "x": 4, "y": 1},
                {"label": "t", "x": 5, "y": 1},
                {"label": "y", "x": 6, "y": 1},
                {"label": "u", "x": 7, "y": 1},
                {"label": "i", "x": 8, "y": 1},
                {"label": "o", "x": 9, "y": 1},
                {"label": "p", "x": 10, "y": 1},
                {"label": "/", "x": 11, "y": 1},
                {"label": "bs", "x": 12, "y": 1},
                
                {"label": "tab", "x": 0, "y": 2, "w": 1.25},
                {"label": "a", "x": 1.25, "y": 2},
                {"label": "s", "x": 2.25, "y": 2},
                {"label": "d", "x": 3.25, "y": 2}, 
                {"label": "f", "x": 4.25, "y": 2},
                {"label": "g", "x": 5.25, "y": 2},
                {"label": "h", "x": 6.25, "y": 2},
                {"label": "j", "x": 7.25, "y": 2},
                {"label": "k", "x": 8.25, "y": 2}, 
                {"label": "l", "x": 9.25, "y": 2},
                {"label": ";", "x": 10.25, "y": 2},
                {"label": "enter", "x": 11.25, "y": 2, "w": 1.75},
                
                {"label": "lshift", "x": 0, "y": 3, "w": 1.75},
                {"label": "z", "x": 1.75, "y": 3}, 
                {"label": "x", "x": 2.75, "y": 3},
                {"label": "c", "x": 3.75, "y": 3},
                {"label": "v", "x": 4.75, "y": 3}, 
                {"label": "b", "x": 5.75, "y": 3},
                {"label": "n", "x": 6.75, "y": 3},
                {"label": "m", "x": 7.75, "y": 3}, 
                {"label": ",", "x": 8.75, "y": 3},
                {"label": ".", "x": 9.75, "y": 3},
                {"label": "up", "x": 10.75, "y": 3}, 
                {"label": "rshift", "x": 11.75, "y": 3, "w": 1.25},
                
                {"label": "ctrl", "x": 0, "y": 4, "w": 1.25},
                {"label": "qui", "x": 1.25, "y": 4, "w": 1.25},
                {"label": "alt", "x": 2.50, "y": 4, "w": 1.25},
                {"label": "del", "x": 3.75, "y": 4, "w": 1.25},
                {"label": "enter", "x": 5, "y": 4, "w": 1.75},
                {"label": "space", "x": 6.75, "y": 4, "w": 1.75},
                {"label": "'", "x": 8.50, "y": 4, "w": 1.5},
                {"label": "left", "x": 10, "y": 4},
                {"label": "down", "x": 11, "y": 4},
                {"label": "right", "x": 12, "y": 4}
                
            ]
        }
    }
}

A keyboards/slz40/keymaps/default/keymap.c => keyboards/slz40/keymaps/default/keymap.c +48 -0
@@ 0,0 1,48 @@
/* Copyright 2020 SithLord
 *
 * 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 names for use in layer keycodes and the keymap
enum layer_names {
    _BASE,
    _FN,
	_FN2
};

const uint16_t PROGMEM keymaps[][MATRIX_ROWS][MATRIX_COLS] = {
    /* Base */
    [_BASE] = LAYOUT(
        KC_1, KC_2, KC_3, KC_4, KC_5, KC_6, KC_7, KC_8, KC_9, KC_0, KC_MINS,
		KC_GESC, KC_Q, KC_W, KC_E, KC_R, KC_T, KC_Y, KC_U, KC_I, KC_O, KC_P, KC_SLSH, KC_BSPC,
		LT(_FN, KC_TAB),  KC_A,  KC_S,  KC_D,  KC_F,  KC_G,  KC_H,  KC_J,  KC_K,  KC_L,  KC_SCLN,  LT(_FN,KC_ENT),
		KC_LSPO, KC_Z, KC_X, KC_C, KC_V, KC_B, KC_N, KC_M, KC_COMM, KC_DOT, KC_UP, KC_RSPC, 
		KC_LCTL, KC_LGUI, KC_LALT,  LT(_FN2, KC_DEL), LT(_FN2, KC_ENTER),   KC_SPACE,   KC_QUOT,  KC_LEFT, KC_DOWN, KC_RIGHT
    ),
    [_FN] = LAYOUT(
		KC_F1, KC_F2, KC_F3, KC_F4, KC_F5, KC_F6, KC_F7, KC_F8, KC_F9, KC_F10, KC_F11,
		KC_ESC, KC_1, KC_2, KC_3, KC_4, KC_5, KC_6, KC_7, KC_8, KC_9, KC_0,  KC_SLSH, KC_BSPC,
		KC_TRNS,  KC_F1,  KC_F2,  KC_F3,  KC_F4,  KC_F5,  KC_PIPE,  KC_MINS,  KC_EQL,  KC_NO,  KC_BSLS,  KC_TRNS,
		KC_LSFT,   KC_F6,  KC_F7,  KC_F8,  KC_F9, KC_F10,  KC_LBRC, KC_RBRC, KC_COMM, KC_DOT, KC_PGUP, KC_RSFT, 
		KC_LCTL, KC_LGUI, KC_LALT,  KC_TRNS, KC_TRNS,   KC_SPACE,   KC_QUOT,  KC_HOME, KC_PGDN, KC_END
    ),
    [_FN2] = LAYOUT(
		KC_EXLM, KC_AT, KC_HASH, KC_DLR, KC_PERC, KC_CIRC, KC_AMPR, KC_ASTR, KC_LPRN, KC_RPRN, RESET,
		KC_ESC, KC_EXLM, KC_AT, KC_HASH, KC_DLR, KC_PERC, KC_CIRC, KC_AMPR, KC_ASTR, KC_LPRN, KC_RPRN, KC_PIPE, KC_BSPC,
		KC_TAB,  KC_NO,  KC_NO,  KC_NO,  KC_NO,  KC_NO,  KC_BSLS,  KC_UNDS,  KC_PLUS,  KC_NO,  KC_NO,  KC_ENT,
		KC_LSFT,   KC_NO,  KC_NO,  KC_NO,  KC_NO, KC_NO,  KC_LCBR, KC_RCBR, KC_COMM, KC_DOT, KC_VOLU, KC_RSFT, 
		KC_LCTL, KC_LGUI, KC_LALT,  KC_TRNS, KC_TRNS,   KC_SPACE,   KC_QUOT,  KC_HOME, KC_VOLD, KC_END
    )
};

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

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

![SLZ40](https://imgur.com/kgXfEBR.jpg)

PCB and keymap files for the SLZ40, a 40s style keyboard with numbers for Zhuyin input.

* Keyboard Maintainer: [SithLord](https://github.com/sithlord121/slz40)
* Hardware Supported: ProMicro or similar controller is required.
* Hardware Availability: PCB files can be found at https://github.com/sithlord121/slz40

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

    make slz40:default

Flashing example for this keyboard:

    make slz40: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/slz40/rules.mk => keyboards/slz40/rules.mk +22 -0
@@ 0,0 1,22 @@
# MCU name
MCU = atmega32u4

# Bootloader selection
BOOTLOADER = atmel-dfu

# Build Options
#   change yes to no to disable
#
BOOTMAGIC_ENABLE = lite     # 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
BLUETOOTH_ENABLE = no       # Enable Bluetooth
AUDIO_ENABLE = no           # Audio output

A keyboards/slz40/slz40.c => keyboards/slz40/slz40.c +17 -0
@@ 0,0 1,17 @@
/* Copyright 2020 SithLord
 *
 * 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 "slz40.h"

A keyboards/slz40/slz40.h => keyboards/slz40/slz40.h +41 -0
@@ 0,0 1,41 @@
/* Copyright 2020 SithLord
 *
 * 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"

/* This is a shortcut to help you visually see your layout.
 *
 * The first section contains all of the arguments representing the physical
 * layout of the board and position of the keys.
 *
 * The second converts the arguments into a two-dimensional array which
 * represents the switch matrix.
 */
#define LAYOUT( \
    k00, k01, k02, k03, k04, k05, k06, k07, k08, k09, k0a,	\
    k10, k11, k12, k13, k14, k15, k16, k17, k18, k19, k1a, k0b, k1b,    \
	k20, k21, k22, k23, k24, k25, k26, k27, k28, k29, k2a, k2b,	\
	k30, k31, k32, k33, k34, k35, k36, k37, k38, k39, k3a, k3b,	\
	k40, k41, k42, k43, k44,      k46,      k48, k49, k4a, k4b \
) { \
    { k00, k01, k02, k03,  k04, k05,   k06,  k07,  k08, k09, k0a, k0b }, \
    { k10, k11, k12, k13,  k14, k15,   k16,  k17,  k18, k19, k1a, k1b },  \
	{ k20, k21, k22, k23,  k24, k25,   k26,  k27,  k28, k29, k2a, k2b },  \
	{ k30, k31, k32, k33,  k34, k35,   k36,  k37,  k38, k39, k3a, k3b },  \
	{ k40, k41, k42, k43,  k44, KC_NO, k46, KC_NO, k48, k49, k4a, k4b }  \
}