~ruther/qmk_firmware

f490777502fb5af088b4ec2a1bf93ac61b95b59a — klausweiss 4 years ago 6e79767
[Keyboard] Add handwired/bolek keyboard (#12234)

Co-authored-by: Drashna Jaelre <drashna@live.com>
Co-authored-by: Ryan <fauxpark@gmail.com>
A keyboards/handwired/bolek/bolek.c => keyboards/handwired/bolek/bolek.c +17 -0
@@ 0,0 1,17 @@
/* Copyright 2021 Mikołaj Biel
 *
 * 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 "bolek.h"

A keyboards/handwired/bolek/bolek.h => keyboards/handwired/bolek/bolek.h +43 -0
@@ 0,0 1,43 @@
/* Copyright 2021 Mikołaj Biel
 *
 * 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( \
	K000, K001, K002, K003, K004, K405, K406, K407, K408, K409, \
	K100, K101, K102, K103, K104, K505, K506, K507, K508, K509, \
	K200, K201, K202, K203, K204, K605, K606, K607, K608, K609, \
	            K302, K303, K304, K705, K706, K707  \
) { \
	{ K000,  K001,  K002,  K003,  K004,  KC_NO, KC_NO, KC_NO, KC_NO, KC_NO }, \
	{ K100,  K101,  K102,  K103,  K104,  KC_NO, KC_NO, KC_NO, KC_NO, KC_NO }, \
	{ K200,  K201,  K202,  K203,  K204,  KC_NO, KC_NO, KC_NO, KC_NO, KC_NO }, \
	{ KC_NO, KC_NO, K302,  K303,  K304,  KC_NO, KC_NO, KC_NO, KC_NO, KC_NO }, \
	{ KC_NO, KC_NO, KC_NO, KC_NO, KC_NO, K405,  K406,  K407,  K408,  K409 }, \
	{ KC_NO, KC_NO, KC_NO, KC_NO, KC_NO, K505,  K506,  K507,  K508,  K509 }, \
	{ KC_NO, KC_NO, KC_NO, KC_NO, KC_NO, K605,  K606,  K607,  K608,  K609 }, \
	{ KC_NO, KC_NO, KC_NO, KC_NO, KC_NO, K705,  K706,  K707,  KC_NO, KC_NO }  \
}

A keyboards/handwired/bolek/config.h => keyboards/handwired/bolek/config.h +147 -0
@@ 0,0 1,147 @@
/*
Copyright 2021 Mikołaj Biel

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   0x3708
#define DEVICE_VER   0x0001
#define MANUFACTURER Mikołaj Biel
#define PRODUCT      bolek

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

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

/* COL2ROW, ROW2COL */
#define DIODE_DIRECTION COL2ROW

//#define LED_NUM_LOCK_PIN B0
//#define LED_CAPS_LOCK_PIN B1
//#define LED_SCROLL_LOCK_PIN B2
//#define LED_COMPOSE_PIN B3
//#define LED_KANA_PIN B4

//#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/handwired/bolek/info.json => keyboards/handwired/bolek/info.json +49 -0
@@ 0,0 1,49 @@
{
    "keyboard_name": "bolek",
    "url": "https://github.com/klausweiss/bolek",
    "maintainer": "klausweiss",
    "height": 5,
    "width": 11,
    "layouts": {
        "LAYOUT": {
            "layout": [
                { "label": "Q", "x": 0, "y": 0.25 },
                { "label": "W", "x": 1, "y": 0 },
                { "label": "E", "x": 2, "y": 0 },
                { "label": "R", "x": 3, "y": 0.25 },
                { "label": "T", "x": 4, "y": 0.5 },
                { "label": "A", "x": 0, "y": 1.25 },
                { "label": "S", "x": 1, "y": 1 },
                { "label": "D", "x": 2, "y": 1 },
                { "label": "F", "x": 3, "y": 1.25 },
                { "label": "G", "x": 4, "y": 1.5 },
                { "label": "Z", "x": 0, "y": 2.25 },
                { "label": "X", "x": 1, "y": 2 },
                { "label": "C", "x": 2, "y": 2 },
                { "label": "V", "x": 3, "y": 2.25 },
                { "label": "B", "x": 4, "y": 2.5 },
                { "label": "ESC", "x": 3.25, "y": 3.75 },
                { "label": "SPC", "x": 4.25, "y": 4 },
                { "label": "TAB", "x": 5.25, "y": 4.25 },
                { "label": "Y", "x": 7.75, "y": 0.5 },
                { "label": "U", "x": 8.75, "y": 0.25 },
                { "label": "I", "x": 9.75, "y": 0 },
                { "label": "O", "x": 10.75, "y": 0 },
                { "label": "P", "x": 11.75, "y": 0.25 },
                { "label": "H", "x": 7.75, "y": 1.5 },
                { "label": "J", "x": 8.75, "y": 1.25 },
                { "label": "K", "x": 9.75, "y": 1 },
                { "label": "L", "x": 10.75, "y": 1 },
                { "label": ";", "x": 11.75, "y": 1.25 },
                { "label": "N", "x": 7.75, "y": 2.5 },
                { "label": "M", "x": 8.75, "y": 2.25 },
                { "label": ",", "x": 9.75, "y": 2 },
                { "label": ".", "x": 10.75, "y": 2 },
                { "label": "'", "x": 11.75, "y": 2.25 },
                { "label": "RET", "x": 6.5, "y": 4.25 },
                { "label": "BSPC", "x": 7.5, "y": 4 },
                { "label": "RESET", "x": 8.5, "y": 3.75 }
            ]
        }
    }
}

A keyboards/handwired/bolek/keymaps/default/keymap.c => keyboards/handwired/bolek/keymaps/default/keymap.c +32 -0
@@ 0,0 1,32 @@
/* Copyright 2021 Mikołaj Biel
 *
 * 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,
};


const uint16_t PROGMEM keymaps[][MATRIX_ROWS][MATRIX_COLS] = {
    /* Base */
    [_BASE] = LAYOUT(
        KC_Q,    KC_W,    KC_E,    KC_R,    KC_T,    KC_Y,    KC_U,    KC_I,    KC_O,    KC_P,
        KC_A,    KC_S,    KC_D,    KC_F,    KC_G,    KC_H,    KC_J,    KC_K,    KC_L,    KC_EQL,
        KC_Z,    KC_X,    KC_C,    KC_V,    KC_B,    KC_N,    KC_M,    KC_COMM, KC_DOT,  KC_MINS,
                         KC_ESC,  KC_SPC,  KC_TAB,  KC_ENT,  KC_BSPC, RESET
     )
};

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

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

Low-profile 36% 3d-printed keyboard designed to go with pro micro and kailh chocs

* Keyboard Maintainer: [klausweiss](https://github.com/klausweiss)
* Repository: https://github.com/klausweiss/bolek
* Hardware Supported: Pro Micro

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

    make handwired/bolek:default

Flashing example for this keyboard:

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

# Bootloader selection
BOOTLOADER = caterina

# 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