~ruther/qmk_firmware

0014c3237556b8c94bbf6d287d53a7b55534fa69 — Simon 4 years ago 0967d4c
[Keyboard] Added Frooastboard (#13970)

Co-authored-by: Drashna Jaelre <drashna@live.com>
Co-authored-by: Ryan <fauxpark@gmail.com>
A keyboards/frooastboard/config.h => keyboards/frooastboard/config.h +66 -0
@@ 0,0 1,66 @@
/* Copyright 2021 frooastside
 *
 * 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 3 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       0x4642 /*F rooast B oards*/
#define PRODUCT_ID      0x6F21 /*osu!*/
#define DEVICE_VER      0x0001
#define MANUFACTURER    frooastside
#define PRODUCT         Frooastboard

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

/* key matrix pins */
#define MATRIX_ROW_PINS { B0, B1 }
#define MATRIX_COL_PINS { B2, B3 }
#define UNUSED_PINS

#define BOOTMAGIC_LITE_ROW 1
#define BOOTMAGIC_LITE_COLUMN 1

/* COL2ROW or ROW2COL */
#define DIODE_DIRECTION COL2ROW

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

#define RGB_DI_PIN B4
#define RGBLED_NUM 8

#define RGBLIGHT_SLEEP

#define RGBLIGHT_HUE_STEP 8
#define RGBLIGHT_SAT_STEP 8
#define RGBLIGHT_VAL_STEP 8

#define RGBLIGHT_DEFAULT_HUE 234

#define RGBLIGHT_LIMIT_VAL 255
#define RGBLIGHT_DEFAULT_VAL 190

#define RGBLIGHT_EFFECT_RAINBOW_MOOD
#define RGBLIGHT_EFFECT_RAINBOW_SWIRL
#define RGBLIGHT_EFFECT_TWINKLE
#define RGBLIGHT_EFFECT_BREATHING
#define RGBLIGHT_EFFECT_SNAKE

#define RGBLIGHT_DEFAULT_MODE RGBLIGHT_MODE_RAINBOW_MOOD + 2

A keyboards/frooastboard/frooastboard.c => keyboards/frooastboard/frooastboard.c +17 -0
@@ 0,0 1,17 @@
/* Copyright 2021 frooastside
 *
 * 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 3 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 "frooastboard.h"

A keyboards/frooastboard/frooastboard.h => keyboards/frooastboard/frooastboard.h +27 -0
@@ 0,0 1,27 @@
/* Copyright 2021 frooastside
 *
 * 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 3 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, \
	K10, K11  \
) { \
	{ K00,   K01 }, \
	{ K10,   K11 }  \
}

A keyboards/frooastboard/info.json => keyboards/frooastboard/info.json +44 -0
@@ 0,0 1,44 @@
{
    "keyboard_name": "Frooastboard",
    "url": "https://github.com/frooastside/qmk_firmware/tree/master/keyboards/frooastboard",
    "maintainer": "frooastside",
    "width": 2,
    "height": 2,
    "debounce": 5,
    "diode_direction": "COL2ROW",
    "layouts": {
        "LAYOUT": {
          "layout": [
            {
              "label": "Z",
              "x": 0,
              "y": 0
            },
            {
              "label": "X",
              "x": 1,
              "y": 0
            },
            {
              "label": "Esc",
              "x": 0,
              "y": 1
            },
            {
              "label": "~",
              "x": 1,
              "y": 1
            }
          ]
        },
    },
    "matrix_pins": {
        "rows": ["B0", "B1"],
        "cols": ["B2", "B3"]
    },
    "usb": {
        "vid": "0x4642",
        "pid": "0x6F21",
        "device_ver": "0x0001"
    }
}

A keyboards/frooastboard/keymaps/default/keymap.c => keyboards/frooastboard/keymaps/default/keymap.c +47 -0
@@ 0,0 1,47 @@
/* Copyright 2021 frooastside
 *
 * 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 3 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] = {
	[0] = LAYOUT(
		KC_Z, KC_X,
		LT(1, KC_ESC), KC_TILD),

	[1] = LAYOUT(
		KC_F23, KC_F24,
		KC_TRNS, TO(2)),

	[2] = LAYOUT(
		RGB_TOG, RGB_MOD,
		TO(3), TO(0)),

	[3] = LAYOUT(
		RGB_HUD, RGB_HUI,
		TO(4), TO(2)),

	[4] = LAYOUT(
		RGB_SAD, RGB_SAI,
		TO(5), TO(3)),

	[5] = LAYOUT(
		RGB_VAD, RGB_VAI,
		TO(6), TO(4)),

	[6] = LAYOUT(
		KC_TRNS, KC_TRNS,
		RESET, TO(5))
};

A keyboards/frooastboard/keymaps/safe_mode/keymap.c => keyboards/frooastboard/keymaps/safe_mode/keymap.c +43 -0
@@ 0,0 1,43 @@
/* Copyright 2021 frooastside
 *
 * 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 3 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] = {
	[0] = LAYOUT(
		KC_Z, KC_X,
		TO(1), KC_TILD),

	[1] = LAYOUT(
		RGB_TOG, RGB_MOD,
		TO(2), TO(0)),

	[2] = LAYOUT(
		RGB_HUD, RGB_HUI,
		TO(3), TO(1)),

	[3] = LAYOUT(
		RGB_SAD, RGB_SAI,
		TO(4), TO(2)),

	[4] = LAYOUT(
		RGB_VAD, RGB_VAI,
		TO(5), TO(3)),

	[5] = LAYOUT(
		KC_TRNS, KC_TRNS,
		RESET, TO(4))
};

A keyboards/frooastboard/keymaps/via/config.h => keyboards/frooastboard/keymaps/via/config.h +30 -0
@@ 0,0 1,30 @@
/* Copyright 2021 frooastside
 *
 * 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 3 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

#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
#define RGBLIGHT_EFFECT_TWINKLE

#define DYNAMIC_KEYMAP_LAYER_COUNT 2

A keyboards/frooastboard/keymaps/via/keymap.c => keyboards/frooastboard/keymaps/via/keymap.c +27 -0
@@ 0,0 1,27 @@
/* Copyright 2021 frooastside
 *
 * 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 3 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] = {
	[0] = LAYOUT(
		KC_Z, KC_X,
		LT(1, KC_ESC), KC_TILD),

	[1] = LAYOUT(
		KC_F23, KC_F24,
		KC_TRNS, RGB_TOG)
};

A keyboards/frooastboard/keymaps/via/rules.mk => keyboards/frooastboard/keymaps/via/rules.mk +2 -0
@@ 0,0 1,2 @@
VIA_ENABLE = yes
LTO_ENABLE = yes

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

![Frooastboard](https://i.imgur.com/f26O8JLh.jpg)

* Keyboard Maintainer: [Frooastside](https://github.com/frooastside)
* Hardware Supported: Frooastboard
* Hardware Availability: https://github.com/Frooastside/Frooastboard

**Reset Key:** Hold down the key located at `K00`, commonly programmed as ESCAPE while plugging in the keyboard. (If via is used it is the key located at `K10`.)

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

    make frooastboard:default

Flashing example for this keyboard:

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

# Bootloader selection
BOOTLOADER = atmel-dfu

# Build Options
#   change yes to no to disable
#
BOOTMAGIC_ENABLE = lite     # Virtual DIP switch configuration
MOUSEKEY_ENABLE = no        # Mouse keys
EXTRAKEY_ENABLE = no        # 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