~ruther/qmk_firmware

17ff9cf554d64fd3e036f3d6e06cff952d8802bf — Collin Diekvoss 6 years ago d3ebf90
New Keyboard: ZJ68 (#6378)

* added zj68 keyboard

* Suggested changes

* Suggested changes

* Suggested changes

* Requested changes

* Update keyboards/zj68/rules.mk

Co-Authored-By: noroadsleft <18669334+noroadsleft@users.noreply.github.com>
A keyboards/zj68/config.h => keyboards/zj68/config.h +64 -0
@@ 0,0 1,64 @@
/*
Copyright 2019 Collin Diekvoss <cdiekvoss@gmail.com>

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      0x6060
#define DEVICE_VER      0x0001
#define MANUFACTURER    Drop
#define PRODUCT         ZJ68
#define DESCRIPTION     QMK ZJ68

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

/* key matrix pins */
#define MATRIX_ROW_PINS { B0, B1, B2, B3, B7 }
#define MATRIX_COL_PINS { D0, D1, D2, D3, D5, D4, D6, D7, B4, F7, F6, F5, F4, F1, F0 }
#define UNUSED_PINS

/* COL2ROW or ROW2COL */
#define DIODE_DIRECTION ROW2COL

/* number of backlight levels */
#define BACKLIGHT_PIN B6
#ifdef BACKLIGHT_PIN
#define BACKLIGHT_LEVELS 5
#endif

/* Set 0 if debouncing isn't needed */
#define DEBOUNCE 5

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

#define RGB_DI_PIN E2
#ifdef RGB_DI_PIN
#define RGBLIGHT_ANIMATIONS
#define RGBLED_NUM 14
#define RGBLIGHT_HUE_STEP 8
#define RGBLIGHT_SAT_STEP 8
#define RGBLIGHT_VAL_STEP 8
#endif

A keyboards/zj68/info.json => keyboards/zj68/info.json +86 -0
@@ 0,0 1,86 @@
{
    "keyboard_name": "ZJ68",
    "maintainer": "qmk",
    "width": 16,
    "height": 5,
    "layouts": {
        "LAYOUT_all": {
            "layout": [
                { "label": "~", "x": 0, "y": 0 },
                { "label": "!", "x": 1, "y": 0 },
                { "label": "@", "x": 2, "y": 0 },
                { "label": "#", "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 },
                { "x": 13, "y": 0 },
                { "x": 14, "y": 0 },
                { "x": 15, "y": 0 },

                { "label": "Tab", "x": 0, "y": 1, "w": 1.5 },
                { "label": "Q", "x": 1.5, "y": 1 },
                { "label": "W", "x": 2.5, "y": 1 },
                { "label": "E", "x": 3.5, "y": 1 },
                { "label": "R", "x": 4.5, "y": 1 },
                { "label": "T", "x": 5.5, "y": 1 },
                { "label": "Y", "x": 6.5, "y": 1 },
                { "label": "U", "x": 7.5, "y": 1 },
                { "label": "I", "x": 8.5, "y": 1 },
                { "label": "O", "x": 9.5, "y": 1 },
                { "label": "P", "x": 10.5, "y": 1 },
                { "label": "{", "x": 11.5, "y": 1 },
                { "label": "}", "x": 12.5, "y": 1 },
                { "label": "|", "x": 13.5, "y": 1, "w": 1.5 },
                { "x": 15, "y": 1 },

                { "label": "Caps Lock", "x": 0, "y": 2, "w": 1.75 },
                { "label": "A", "x": 1.75, "y": 2 },
                { "label": "S", "x": 2.75, "y": 2 },
                { "label": "D", "x": 3.75, "y": 2 },
                { "label": "F", "x": 4.75, "y": 2 },
                { "label": "G", "x": 5.75, "y": 2 },
                { "label": "H", "x": 6.75, "y": 2 },
                { "label": "J", "x": 7.75, "y": 2 },
                { "label": "K", "x": 8.75, "y": 2 },
                { "label": "L", "x": 9.75, "y": 2 },
                { "label": ":", "x": 10.75, "y": 2 },
                { "label": "\"", "x": 11.75, "y": 2 },
                { "label": "Enter", "x": 12.75, "y": 2, "w": 2.25 },
                { "x": 15, "y": 2 },

                { "label": "Shift", "x": 0, "y": 3, "w": 1.25 },
                { "x": 1.25, "y": 3 },
                { "label": "Z", "x": 2.25, "y": 3 },
                { "label": "X", "x": 3.25, "y": 3 },
                { "label": "C", "x": 4.25, "y": 3 },
                { "label": "V", "x": 5.25, "y": 3 },
                { "label": "B", "x": 6.25, "y": 3 },
                { "label": "N", "x": 7.25, "y": 3 },
                { "label": "M", "x": 8.25, "y": 3 },
                { "label": "<", "x": 9.25, "y": 3 },
                { "label": ">", "x": 10.25, "y": 3 },
                { "label": "?", "x": 11.25, "y": 3 },
                { "label": "Shift", "x": 12.25, "y": 3, "w": 1.75 },
                { "x": 14, "y": 3 },
                { "x": 15, "y": 3 },

                { "label": "Ctrl", "x": 0, "y": 4, "w": 1.25 },
                { "label": "Win", "x": 1.25, "y": 4, "w": 1.25 },
                { "label": "Alt", "x": 2.5, "y": 4, "w": 1.25 },
                { "x": 3.75, "y": 4, "w": 6.25 },
                { "label": "Alt", "x": 10, "y": 4 },
                { "label": "Win", "x": 11, "y": 4 },
                { "x": 12, "y": 4 },
                { "x": 13, "y": 4 },
                { "x": 14, "y": 4 },
                { "x": 15, "y": 4 }
            ]
        }
    }
}

A keyboards/zj68/keymaps/default/keymap.c => keyboards/zj68/keymaps/default/keymap.c +35 -0
@@ 0,0 1,35 @@
/* Copyright 2019 Collin Diekvoss <cdiekvoss@gmail.com>
 *
 * 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

const uint16_t PROGMEM keymaps[][MATRIX_ROWS][MATRIX_COLS] = {

    LAYOUT_all(
        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_NO,   KC_BSPC, KC_DEL,
        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_PGUP,
        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_PGDN,
        KC_LSFT, KC_NO,   KC_Z,    KC_X,    KC_C,    KC_V,    KC_B,    KC_N,    KC_M,    KC_COMM, KC_DOT,  KC_SLSH, KC_RSFT, KC_UP,   MO(1),
        KC_LCTL, KC_LGUI, KC_LALT, KC_SPC,  KC_RALT, KC_APP,  KC_RCTL, KC_LEFT, KC_DOWN, KC_RGHT
    ),

    LAYOUT_all(
        KC_GRV,  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_NO,   RESET,   KC_PSCR,
        RGB_TOG, _______, KC_UP,   _______, RGB_MOD, _______, _______, _______, _______, _______, _______, _______, _______, _______, KC_HOME,
        BL_TOGG, KC_LEFT, KC_DOWN, KC_RGHT, _______, _______, _______, RGB_HUI, RGB_SAI, RGB_VAI, _______, _______, _______, KC_END,
        _______, _______, _______, BL_DEC,  BL_INC,  BL_STEP, _______, _______, RGB_HUD, RGB_SAD, RGB_VAD, _______, _______, _______, _______,
        _______, _______, _______, _______, _______, _______, _______, _______, _______, _______
    ),
};

A keyboards/zj68/keymaps/default/readme.md => keyboards/zj68/keymaps/default/readme.md +3 -0
@@ 0,0 1,3 @@
# ZJ68 Default layout

This is the default layout from the json file provided on Drop, that was intended to be used on kbdfirmware, with an added soft reset on fn(backspace).
\ No newline at end of file

A keyboards/zj68/keymaps/splitbs/keymap.c => keyboards/zj68/keymaps/splitbs/keymap.c +34 -0
@@ 0,0 1,34 @@
/* Copyright 2019 Collin Diekvoss <cdiekvoss@gmail.com>
 *
 * 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

const uint16_t PROGMEM keymaps[][MATRIX_ROWS][MATRIX_COLS] = {

    LAYOUT_65_ansi_split_bs(
        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_BSLS, KC_GRV, 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_BSPC, 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_ENT,  KC_PGUP,
        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_PGDN,
        MO(1),   KC_LGUI, KC_LALT, KC_SPC,  KC_RALT, MO(1),   KC_RCTL, KC_LEFT, KC_DOWN, KC_RGHT
    ),
    LAYOUT_65_ansi_split_bs(
        RESET,   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_CAPS, KC_MPRV, KC_MPLY, KC_MNXT, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______,
        _______, KC_VOLD, KC_VOLU, KC_MUTE, _______, _______, _______, _______, _______, _______, _______, _______, _______, KC_HOME,
        _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, KC_END,
        _______, _______, _______, _______, _______, _______, _______, _______, _______, _______
    ),
};

A keyboards/zj68/keymaps/splitbs/readme.md => keyboards/zj68/keymaps/splitbs/readme.md +3 -0
@@ 0,0 1,3 @@
# ZJ68 W/ Split Backspace

The plate that comes with the kit from Drop only allows one layout, but the pcb supports having a split backspace, so by widening the plate where the stabilizers are meant to go, you can fit the two switches in, if you want to go back to a single backspace later, you can still use pcb mount stabilizers.
\ No newline at end of file

A keyboards/zj68/readme.md => keyboards/zj68/readme.md +15 -0
@@ 0,0 1,15 @@
# ZJ68

![JZ68](https://i.imgur.com/bcsfQyt.jpg)

A 65% keyboard kit sold through Drop.

Keyboard Maintainer: QMK Community  
Hardware Supported: ZJ68 PCB  
Hardware Availability: [Drop](https://drop.com/buy/zj68-68-key-mechanical-keyboard-kit?mode=guest_open)

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

    make zj68: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).

A keyboards/zj68/rules.mk => keyboards/zj68/rules.mk +63 -0
@@ 0,0 1,63 @@
# MCU name
MCU = atmega32u4

# Processor frequency.
#     This will define a symbol, F_CPU, in all source code files equal to the
#     processor frequency in Hz. You can then use this symbol in your source code to
#     calculate timings. Do NOT tack on a 'UL' at the end, this will be done
#     automatically to create a 32-bit value in your source code.
#
#     This will be an integer division of F_USB below, as it is sourced by
#     F_USB after it has run through any CPU prescalers. Note that this value
#     does not *change* the processor frequency - it should merely be updated to
#     reflect the processor speed set externally so that the code can use accurate
#     software delays.
F_CPU = 16000000

#
# LUFA specific
#
# Target architecture (see library "Board Types" documentation).
ARCH = AVR8

# Input clock frequency.
#     This will define a symbol, F_USB, in all source code files equal to the
#     input clock frequency (before any prescaling is performed) in Hz. This value may
#     differ from F_CPU if prescaling is used on the latter, and is required as the
#     raw input clock is fed directly to the PLL sections of the AVR for high speed
#     clock generation for the USB and other AVR subsections. Do NOT tack on a 'UL'
#     at the end, this will be done automatically to create a 32-bit value in your
#     source code.
#
#     If no clock division is performed on the input clock inside the AVR (via the
#     CPU clock adjust registers or the clock division fuses), this will be equal to F_CPU.
F_USB = $(F_CPU)

# Interrupt driven control endpoint task(+60)
OPT_DEFS += -DINTERRUPT_CONTROL_ENDPOINT

# Bootloader selection
#   Teensy       halfkay
#   Pro Micro    caterina
#   Atmel DFU    atmel-dfu
#   LUFA DFU     lufa-dfu
#   QMK DFU      qmk-dfu
#   atmega32a    bootloadHID
BOOTLOADER = atmel-dfu

# Build Options
#   comment out to disable the options.
#
BACKLIGHT_ENABLE = yes  # Enable keyboard backlight functionality
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 = no	# Console for debug(+400)
COMMAND_ENABLE = no    # Commands for debug and configuration
NKRO_ENABLE = yes		# USB Nkey Rollover - if this doesn't work, see here: https://github.com/tmk/tmk_keyboard/wiki/FAQ#nkro-doesnt-work
AUDIO_ENABLE = no

SLEEP_LED_ENABLE = no  # Breathing sleep LED during USB suspend
RGBLIGHT_ENABLE = no

LAYOUTS = 65_ansi

A keyboards/zj68/zj68.c => keyboards/zj68/zj68.c +24 -0
@@ 0,0 1,24 @@
/* Copyright 2019 Collin Diekvoss <cdiekvoss@gmail.com>
 *
 * 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 "zj68.h"

void matrix_init_kb(void) {
    matrix_init_user();
}

void matrix_scan_kb(void) {
    matrix_scan_user();
}

A keyboards/zj68/zj68.h => keyboards/zj68/zj68.h +60 -0
@@ 0,0 1,60 @@
/* Copyright 2019 Collin Diekvoss <cdiekvoss@gmail.com>
 *
 * 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_65_ansi( \
    K00, K01, K02, K03, K04, K05, K06, K07, K08, K09, K0A, K0B, K0C, K0E, K4E, \
    K10, K11, K12, K13, K14, K15, K16, K17, K18, K19, K1A, K1B, K1C, K2C, K1E, \
    K20, K21, K22, K23, K24, K25, K26, K27, K28, K29, K2A, K2B, K1D, K2E, \
    K30, K32, K33, K34, K35, K36, K37, K38, K39, K3A, K3B, K3C, K3D, K3E, \
    K40, K41, K42,                   K46,       K48, K49, K4A, K4B, K4C, K4D  \
) { \
    { K00,  K01,   K02,   K03,   K04,   K05,   K06,  K07,   K08,   K09,   K0A,   K0B,   K0C,  KC_NO, K0E }, \
    { K10,  K11,   K12,   K13,   K14,   K15,   K16,  K17,   K18,   K19,   K1A,   K1B,   K1C,  K1D,   K1E }, \
    { K20,  K21,   K22,   K23,   K24,   K25,   K26,  K27,   K28,   K29,   K2A,   K2B,   K2C,  KC_NO, K2E }, \
    { K30,  KC_NO, K32,   K33,   K34,   K35,   K36,  K37,   K38,   K39,   K3A,   K3B,   K3C,  K3D,   K3E }, \
    { K40,  K41,   K42,   KC_NO, KC_NO, KC_NO, K46,  KC_NO, K48,   K49,   K4A,   K4B,   K4C,  K4D,   K4E }  \
}

#define LAYOUT_65_ansi_split_bs( \
    K00, K01, K02, K03, K04, K05, K06, K07, K08, K09, K0A, K0B, K0C, K0D, K0E, K4E, \
    K10, K11, K12, K13, K14, K15, K16, K17, K18, K19, K1A, K1B, K1C, K2C, K1E, \
    K20, K21, K22, K23, K24, K25, K26, K27, K28, K29, K2A, K2B, K1D, K2E, \
    K30, K32, K33, K34, K35, K36, K37, K38, K39, K3A, K3B, K3C, K3D, K3E, \
    K40, K41, K42,                   K46,       K48, K49, K4A, K4B, K4C, K4D  \
) { \
    { K00,  K01,   K02,   K03,   K04,   K05,   K06,  K07,   K08,   K09,   K0A,   K0B,   K0C,  K0D,   K0E }, \
    { K10,  K11,   K12,   K13,   K14,   K15,   K16,  K17,   K18,   K19,   K1A,   K1B,   K1C,  K1D,   K1E }, \
    { K20,  K21,   K22,   K23,   K24,   K25,   K26,  K27,   K28,   K29,   K2A,   K2B,   K2C,  KC_NO, K2E }, \
    { K30,  KC_NO, K32,   K33,   K34,   K35,   K36,  K37,   K38,   K39,   K3A,   K3B,   K3C,  K3D,   K3E }, \
    { K40,  K41,   K42,   KC_NO, KC_NO, KC_NO, K46,  KC_NO, K48,   K49,   K4A,   K4B,   K4C,  K4D,   K4E }  \
}

#define LAYOUT_all( \
    K00, K01, K02, K03, K04, K05, K06, K07, K08, K09, K0A, K0B, K0C, K0D, K0E, K4E, \
    K10, K11, K12, K13, K14, K15, K16, K17, K18, K19, K1A, K1B, K1C, K2C, K1E, \
    K20, K21, K22, K23, K24, K25, K26, K27, K28, K29, K2A, K2B, K1D, K2E, \
    K30, K31, K32, K33, K34, K35, K36, K37, K38, K39, K3A, K3B, K3C, K3D, K3E, \
    K40, K41, K42,                   K46,       K48, K49, K4A, K4B, K4C, K4D  \
) { \
    { K00,  K01,   K02,   K03,   K04,   K05,   K06,  K07,   K08,   K09,   K0A,   K0B,   K0C,  K0D,   K0E }, \
    { K10,  K11,   K12,   K13,   K14,   K15,   K16,  K17,   K18,   K19,   K1A,   K1B,   K1C,  K1D,   K1E }, \
    { K20,  K21,   K22,   K23,   K24,   K25,   K26,  K27,   K28,   K29,   K2A,   K2B,   K2C,  KC_NO, K2E }, \
    { K30,  K31,   K32,   K33,   K34,   K35,   K36,  K37,   K38,   K39,   K3A,   K3B,   K3C,  K3D,   K3E }, \
    { K40,  K41,   K42,   KC_NO, KC_NO, KC_NO, K46,  KC_NO, K48,   K49,   K4A,   K4B,   K4C,  K4D,   K4E }  \
}