~ruther/qmk_firmware

8af767cb1d36222a4d0ec8286d346d4896e923d4 — chent7 4 years ago a9f65b7
[Keyboard] Crazy Keyboard 68 (#10693)

* Entry and readme for crazy keyboard 68

* Defined layout in keyboard.h

* Basic setup done

* Working config, keymaps, rgb confirmed. Caps lock led untested

* Update readme.md

Image links

* Update config.h

* Update crazy_keyboard_68.c

#include "quantum.h"

* Match PR

* Update keyboards/crazy_keyboard_68/crazy_keyboard_68.c

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

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

* Update keyboards/crazy_keyboard_68/info.json

* Update keyboards/crazy_keyboard_68/crazy_keyboard_68.h

* Update keyboards/crazy_keyboard_68/rules.mk

* Update keyboards/crazy_keyboard_68/rules.mk

* Update keyboards/crazy_keyboard_68/config.h
A keyboards/crazy_keyboard_68/config.h => keyboards/crazy_keyboard_68/config.h +146 -0
@@ 0,0 1,146 @@
/*
Copyright 2020 chent7

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 // by default from pcb
#define PRODUCT_ID   0x13DE
#define DEVICE_VER   0x0001
#define MANUFACTURER chent7
#define PRODUCT      Crazy Keyboard 68

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

/*
 * 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 { D0, D1, D2, D3, D5 }
#define MATRIX_COL_PINS { F0, F1, E6, C7, C6, B6, D4, B1, B7, B5, B4, D7, D6, B3, F4 }
#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 F6
#ifdef RGB_DI_PIN
#    define RGBLED_NUM 84
#    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/crazy_keyboard_68/crazy_keyboard_68.c => keyboards/crazy_keyboard_68/crazy_keyboard_68.c +36 -0
@@ 0,0 1,36 @@
/* Copyright 2020 chent7
 *
 * 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 "crazy_keyboard_68.h"

void matrix_init_kb(void) {
	led_init_ports();
	
	matrix_init_user();
}

void led_init_ports(void) {
    // Caps lock pin
    setPinOutput(B0);
    writePinHigh(B0);
}

bool led_update_kb(led_t led_state) {
    if(led_update_user(led_state)) {
        writePin(B0, !led_state.caps_lock);
    }
    return true;
}

A keyboards/crazy_keyboard_68/crazy_keyboard_68.h => keyboards/crazy_keyboard_68/crazy_keyboard_68.h +57 -0
@@ 0,0 1,57 @@
/* Copyright 2020 chent7
 *
 * 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 XXX KC_NO

/* Crazy Keyboard 68 (ANSI) layout
 * ,----------------------------------------------------------------.
 * | 00 |01| 02| 03| 04| 05| 06| 07| 08| 09| 0a| 0b| 0c| 0d    | 0e |
 * |----------------------------------------------------------------|
 * | 10  | 11| 12| 13| 14| 15| 16| 17| 18| 19| 1a| 1b| 1c|  1d | 1e |
 * |----------------------------------------------------------------|
 * | 20    | 22| 23| 24| 25| 26| 27| 28| 29| 2a| 2b| 2c| 2d    | 2e |
 * |----------------------------------------------------------------|
 * | 31     | 32| 33| 34| 35| 36| 37| 38| 39| 3a| 3b|    3c| 3d| 3e |
 * |----------------------------------------------------------------|
 * | 40 | 41 | 43 |        46             | 49| 4a|  4b| 4c| 4d| 4e |
 * `----------------------------------------------------------------'
 *
 * 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_65_ansi( \
    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, k22, k23, k24, k25, k26, k27, k28, k29, k2a, k2b, k2c,      k2d, k2e, \
    k31,      k32, k33, k34, k35, k36, k37, k38, k39, k3a, k3b, k3c, k3d, k3e, \
    k40, k41, k43,                k46,           k49, k4a, k4b, k4c, k4d, k4e  \
) \
{ \
    {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, XXX, k22, k23, k24, k25, k26, k27, k28, k29, k2a, k2b, k2c, k2d, k2e}, \
    {XXX, k31, k32, k33, k34, k35, k36, k37, k38, k39, k3a, k3b, k3c, k3d, k3e}, \
    {k40, k41, XXX, k43, XXX, XXX, k46, XXX, XXX, k49, k4a, k4b, k4c, k4d, k4e}  \
}

A keyboards/crazy_keyboard_68/info.json => keyboards/crazy_keyboard_68/info.json +81 -0
@@ 0,0 1,81 @@
{
    "keyboard_name": "crazy_keyboard_68",
    "url": "",
    "maintainer": "chent7",
    "width": 15,
    "height": 5,
    "layouts": {
        "LAYOUT_65_ansi": {
            "layout": [
                {"label":"k00", "x":0, "y":0},
                {"label":"k01", "x":1, "y":0},
                {"label":"k02", "x":2, "y":0},
                {"label":"k03", "x":3, "y":0},
                {"label":"k04", "x":4, "y":0},
                {"label":"k05", "x":5, "y":0},
                {"label":"k06", "x":6, "y":0},
                {"label":"k07", "x":7, "y":0},
                {"label":"k08", "x":8, "y":0},
                {"label":"k09", "x":9, "y":0},
                {"label":"k0a", "x":10, "y":0},
                {"label":"k0b", "x":11, "y":0},
                {"label":"k0c", "x":12, "y":0},
                {"label":"k0d", "x":13, "y":0, "w":2},
                {"label":"k0e", "x":15, "y":0},
                {"label":"k10", "x":0, "y":1, "w":1.5},
                {"label":"k11", "x":1.5, "y":1},
                {"label":"k12", "x":2.5, "y":1},
                {"label":"k13", "x":3.5, "y":1},
                {"label":"k14", "x":4.5, "y":1},
                {"label":"k15", "x":5.5, "y":1},
                {"label":"k16", "x":6.5, "y":1},
                {"label":"k17", "x":7.5, "y":1},
                {"label":"k18", "x":8.5, "y":1},
                {"label":"k19", "x":9.5, "y":1},
                {"label":"k1a", "x":10.5, "y":1},
                {"label":"k1b", "x":11.5, "y":1},
                {"label":"k1c", "x":12.5, "y":1},
                {"label":"k1d", "x":13.5, "y":1, "w":1.5},
                {"label":"k1e", "x":15, "y":1},
                {"label":"k20", "x":0, "y":2, "w":1.75},
                {"label":"k22", "x":1.75, "y":2},
                {"label":"k23", "x":2.75, "y":2},
                {"label":"k24", "x":3.75, "y":2},
                {"label":"k25", "x":4.75, "y":2},
                {"label":"k26", "x":5.75, "y":2},
                {"label":"k27", "x":6.75, "y":2},
                {"label":"k28", "x":7.75, "y":2},
                {"label":"k29", "x":8.75, "y":2},
                {"label":"k2a", "x":9.75, "y":2},
                {"label":"k2b", "x":10.75, "y":2},
                {"label":"k2c", "x":11.75, "y":2},
                {"label":"k2d", "x":12.75, "y":2, "w":2.25},
                {"label":"k2e", "x":15, "y":2},
                {"label":"k31", "x":0, "y":3, "w":2.25},
                {"label":"k32", "x":2.25, "y":3},
                {"label":"k33", "x":3.25, "y":3},
                {"label":"k34", "x":4.25, "y":3},
                {"label":"k35", "x":5.25, "y":3},
                {"label":"k36", "x":6.25, "y":3},
                {"label":"k37", "x":7.25, "y":3},
                {"label":"k38", "x":8.25, "y":3},
                {"label":"k39", "x":9.25, "y":3},
                {"label":"k3a", "x":10.25, "y":3},
                {"label":"k3b", "x":11.25, "y":3},
                {"label":"k3c", "x":12.25, "y":3, "w":1.75},
                {"label":"k3d", "x":14, "y":3},
                {"label":"k3e", "x":15, "y":3},
                {"label":"k40", "x":0, "y":4, "w":1.25},
                {"label":"k41", "x":1.25, "y":4, "w":1.25},
                {"label":"k43", "x":2.5, "y":4, "w":1.25},
                {"label":"k46", "x":3.75, "y":4, "w":6.25},
                {"label":"k49", "x":10, "y":4},
                {"label":"k4a", "x":11, "y":4},
                {"label":"k4b", "x":12, "y":4},
                {"label":"k4c", "x":13, "y":4},
                {"label":"k4d", "x":14, "y":4},
                {"label":"k4e", "x":15, "y":4}
            ]
        }
    }
}

A keyboards/crazy_keyboard_68/keymaps/default/keymap.c => keyboards/crazy_keyboard_68/keymaps/default/keymap.c +66 -0
@@ 0,0 1,66 @@
/* Copyright 2020 chent7
 *
 * 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
};

const uint16_t PROGMEM keymaps[][MATRIX_ROWS][MATRIX_COLS] = {
    /* Keymap _BASE: (Base Layer) Default Layer
     * ,----------------------------------------------------------------.
     * |Esc | 1|  2|  3|  4|  5|  6|  7|  8|  9|  0|  -|  =|Backsp |~ ` |
     * |----------------------------------------------------------------|
     * |Tab  |  Q|  W|  E|  R|  T|  Y|  U|  I|  O|  P|  [|  ]|  \  |PgUp|
     * |----------------------------------------------------------------|
     * |CAPS   |  A|  S|  D|  F|  G|  H|  J|  K|  L|  ;|  '|Return |PgDn|
     * |----------------------------------------------------------------|
     * |Shift   |  Z|  X|  C|  V|  B|  N|  M|  ,|  .|  /|Shift | Up|Del |
     * |----------------------------------------------------------------|
     * |Ctrl|Win |Alt |        Space          |Alt|Fn |Ctrl|Lef|Dow|Rig |
     * `----------------------------------------------------------------'
     */
    [_BASE] = LAYOUT_65_ansi(
        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_GRV,
        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_Z,    KC_X,    KC_C,    KC_V,    KC_B,    KC_N,    KC_M,    KC_COMM, KC_DOT,  KC_SLSH, KC_RSFT, KC_UP,   KC_DEL,
        KC_LCTL, KC_LGUI, KC_LALT,                            KC_SPC,                    KC_RALT, MO(_FN), KC_RCTL, KC_LEFT, KC_DOWN, KC_RGHT
    ),

    /* Keymap _BASE: (Base Layer) Default Layer
     * ,----------------------------------------------------------------.
     * |    |F1| F2| F3| F4| F5| F6| F7| F8| F9|F10|F11|F12|       |Home|
     * |----------------------------------------------------------------|
     * |     |   |   |   |   |   |   |   |   |   |PSC|SLC|Pau|     |End |
     * |----------------------------------------------------------------|
     * |       |TOG|M_P|M_B|M_R|MSW|MSN|M_K|M_X|M_G|M_T|   |       |Ins |
     * |----------------------------------------------------------------|
     * |        |MOD|HUI|HUD|SAI|SAD|VAI|VAD|   |   |   |      |   |    |
     * |----------------------------------------------------------------|
     * |Reset|   |    |                       |   |   |    |   |   |    |
     * `----------------------------------------------------------------'
     */
    [_FN] = LAYOUT_65_ansi(
        _______, 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_HOME,
        _______, _______, _______, _______, _______, _______, _______, _______, _______, _______, KC_PSCR, KC_SLCK, KC_PAUS, _______, KC_END,
        _______, RGB_TOG, RGB_M_P, RGB_M_B, RGB_M_R,RGB_M_SW,RGB_M_SN, RGB_M_K, RGB_M_X, RGB_M_G, RGB_M_T, _______,          _______, KC_INS,
        _______,          RGB_MOD, RGB_HUI, RGB_HUD, RGB_SAI, RGB_SAD, RGB_VAI, RGB_VAD, _______, _______, _______, _______, _______, _______,
        RESET,   _______, _______,                            _______,                   _______, _______, _______, _______, _______, _______
    )
};

A keyboards/crazy_keyboard_68/keymaps/default/readme.md => keyboards/crazy_keyboard_68/keymaps/default/readme.md +4 -0
@@ 0,0 1,4 @@
# The default keymap for crazy_keyboard_68
```
make crazy_keyboard_68:default
```

A keyboards/crazy_keyboard_68/readme.md => keyboards/crazy_keyboard_68/readme.md +25 -0
@@ 0,0 1,25 @@
# Crazy Keyboard 68

![Front View of Crazy Keyboard 68 PCB](https://i.imgur.com/0nTjDbU.jpg)\
![Back View of Crazy Keyboard 68 PCB](https://i.imgur.com/gTpdux3.jpeg)

Obscure 68% hotswap PCB sold on taobao, powered by ATM32U4. RGB key lighting and underglow requires self-soldering.

* Keyboard Maintainer: [chent7](https://github.com/chent7)
* Hardware Supported: crazy keyboard 68 Standard
* Hardware Availability: [taobao.com](https://item.taobao.com/item.htm?spm=a1z09.2.0.0.19422e8dJUzj8d&id=605218560507)

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

    make crazy_keyboard_68:default

Flashing example for this keyboard:

    make crazy_keyboard_68:default:flash

## Layouts 

### ANSI
![Default ANSI Layout](https://i.imgur.com/y1ZApvU.png)

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/crazy_keyboard_68/rules.mk => keyboards/crazy_keyboard_68/rules.mk +24 -0
@@ 0,0 1,24 @@
# 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 = yes           # USB Nkey Rollover
BACKLIGHT_ENABLE = no       # Enable keyboard backlight functionality
RGBLIGHT_ENABLE = yes       # Enable keyboard RGB underglow
BLUETOOTH_ENABLE = no       # Enable Bluetooth
AUDIO_ENABLE = no           # Audio output

LAYOUTS = 65_ansi