[Keyboard] Add Albacore (#13200)

Co-authored-by: Drashna Jaelre <drashna@live.com>

keyboards/paprikman/albacore/albacore.c

@@ -0,0 +1,30 @@
+/* Copyright 2021 paprikman
+ *
+ * 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 "albacore.h"
+
+#ifdef RGB_MATRIX_ENABLE
+led_config_t g_led_config = { {
+  { 0, 1, 2, 3 },
+  { 7, 6, 5, 4 }
+}, {
+  { 56, 16 }, { 112, 16 }, { 168, 16 }, { 224, 16 },
+  { 56, 24 }, { 112, 24 }, { 168, 24 }, { 224, 24 }
+}, {
+    1, 1, 1, 1,
+    1, 1, 1, 1
+} };
+#endif

keyboards/paprikman/albacore/albacore.h

@@ -0,0 +1,36 @@
+/* Copyright 2021 paprikman
+ *
+ * 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
+#define ___ KC_NO
+
+#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( \
+      K01, K02, K03, \
+  K10, K11, K12, K13 \
+) { \
+  { ___, K01, K02, K03 }, \
+  { K10, K11, K12, K13 }  \
+}

keyboards/paprikman/albacore/config.h

@@ -0,0 +1,80 @@
+/*
+Copyright 2021 paprikman
+
+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    0x736D
+#define PRODUCT_ID   0x000A
+#define DEVICE_VER   0x0001
+#define MANUFACTURER paprikman
+#define PRODUCT      Albacore
+
+/* key matrix size */
+#define MATRIX_ROWS 2
+#define MATRIX_COLS 4
+
+/*
+ * 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 { D5, C7 }
+#define MATRIX_COL_PINS { C6, B6, B5, B4 }
+
+/* COL2ROW, ROW2COL */
+#define DIODE_DIRECTION COL2ROW
+
+#define RGB_DI_PIN B3
+
+#ifdef RGB_MATRIX_ENABLE
+  #define DRIVER_LED_TOTAL 8
+  #define RGB_DISABLE_AFTER_TIMEOUT 0 // number of ticks to wait until disabling effects
+  #define RGB_DISABLE_WHEN_USB_SUSPENDED
+  #define RGB_MATRIX_MAXIMUM_BRIGHTNESS 220
+  #define DISABLE_RGB_MATRIX_GRADIENT_UP_DOWN
+  #define DISABLE_RGB_MATRIX_BAND_SAT
+  #define DISABLE_RGB_MATRIX_BAND_PINWHEEL_SAT
+  #define DISABLE_RGB_MATRIX_CYCLE_LEFT_RIGHT
+  #define DISABLE_RGB_MATRIX_CYCLE_UP_DOWN
+  #define DISABLE_RGB_MATRIX_CYCLE_OUT_IN
+  #define DISABLE_RGB_MATRIX_CYCLE_OUT_IN_DUAL
+  #define DISABLE_RGB_MATRIX_BAND_SPIRAL_SAT
+  #define DISABLE_RGB_MATRIX_SPLASH
+  #define DISABLE_RGB_MATRIX_MULTISPLASH
+  #define DISABLE_RGB_MATRIX_SOLID_SPLASH
+  #define DISABLE_RGB_MATRIX_SOLID_MULTISPLASH
+  #define DISABLE_RGB_MATRIX_DIGITAL_RAIN
+#endif
+
+/* Debounce reduces chatter (unintended double-presses) - set 0 if debouncing is not needed */
+#define DEBOUNCE 5
+
+/* disable these deprecated features by default */
+#define NO_ACTION_MACRO
+#define NO_ACTION_FUNCTION
+
+/* Set lower left modifier key as a bootmagic key */
+#define BOOTMAGIC_LITE_ROW 1
+#define BOOTMAGIC_LITE_COLUMN 0

keyboards/paprikman/albacore/info.json

@@ -0,0 +1,19 @@
+{
+    "keyboard_name": "Albacore",
+    "url": "https://github.com/paprikman/qmk_firmware/tree/master/keyboards/paprikman/albacore",
+    "maintainer": "paprikman",
+    "layouts": {
+        "LAYOUT": {
+            "layout": [
+                {"x": 0.75, "y": 0},
+                {"x": 1.75, "y": 0},
+                {"x": 2.75, "y": 0},
+
+                {"x": 0, "y": 1},
+                {"x": 1, "y": 1},
+                {"x": 2, "y": 1},
+                {"x": 3, "y": 1}
+            ]
+        }
+    }
+}

keyboards/paprikman/albacore/keymaps/default/keymap.c

@@ -0,0 +1,27 @@
+/* Copyright 2021 paprikman
+ *
+ * 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] = {
+  [0] = LAYOUT(
+          KC_VOLD, KC_MUTE, KC_VOLU,
+    MO(1), KC_MPRV, KC_MPLY, KC_MNXT
+  ),
+  [1] = LAYOUT(
+          RGB_TOG, RGB_MOD, RGB_VAI,
+    _______, RGB_SPI, RGB_SPD, RGB_VAD
+  ),
+};

keyboards/paprikman/albacore/keymaps/pulp/keymap.c

@@ -0,0 +1,75 @@
+/* Copyright 2021 paprikman
+ *
+ * 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
+
+uint16_t layer_timer;
+
+enum layer_keycodes {
+  TG_LAYER = USER00
+};
+
+uint8_t get_hold_layer(void) {
+  switch(get_highest_layer(layer_state)) {
+    case 0:
+    case 1:
+      return 1;
+    case 2:
+    case 3:
+      return 3;
+    default:
+      return 1;
+  }
+}
+
+bool process_record_user(uint16_t keycode, keyrecord_t *record) {
+  switch(keycode) {
+    case TG_LAYER:
+      if (record->event.pressed) {
+        layer_timer = timer_read();
+        layer_on(get_hold_layer());
+      } else {
+        layer_off(get_hold_layer());
+
+        if (timer_elapsed(layer_timer) < TAPPING_TERM) {
+          layer_invert(2);
+        }
+      }
+
+      return false;
+      break;
+  }
+
+  return true;
+}
+
+const uint16_t PROGMEM keymaps[][MATRIX_ROWS][MATRIX_COLS] = {
+  [0] = LAYOUT(
+            KC_VOLD, KC_MUTE, KC_VOLU,
+    TG_LAYER, KC_MPRV, KC_MPLY, KC_MNXT
+  ),
+  [1] = LAYOUT(
+          RGB_TOG, RGB_MOD, RGB_VAI,
+    KC_NO, RGB_SPI, RGB_SPD, RGB_VAD
+  ),
+  [2] = LAYOUT(
+            KC_F1, KC_F2, KC_F3,
+    TG_LAYER, KC_F4, KC_F5, KC_F6
+  ),
+  [3] = LAYOUT(
+      LCTL(KC_PSCR), KC_NLCK, KC_SLCK,
+    KC_NO, _______, _______, _______
+  ),
+};

keyboards/paprikman/albacore/keymaps/pulp/rules.mk

@@ -0,0 +1 @@
+VIA_ENABLE = yes

keyboards/paprikman/albacore/keymaps/via/keymap.c

@@ -0,0 +1,35 @@
+/* Copyright 2021 paprikman
+ *
+ * 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] = {
+  [0] = LAYOUT(
+          KC_VOLD, KC_MUTE, KC_VOLU,
+    MO(1), KC_MPRV, KC_MPLY, KC_MNXT
+  ),
+  [1] = LAYOUT(
+          RGB_TOG, RGB_MOD, RGB_VAI,
+    _______, RGB_SPI, RGB_SPD, RGB_VAD
+  ),
+  [2] = LAYOUT(
+            _______, _______, _______,
+    _______, _______, _______, _______
+  ),
+  [3] = LAYOUT(
+            _______, _______, _______,
+    _______, _______, _______, _______
+  ),
+};

keyboards/paprikman/albacore/keymaps/via/rules.mk

@@ -0,0 +1 @@
+VIA_ENABLE = yes

keyboards/paprikman/albacore/readme.md

@@ -0,0 +1,26 @@
+# Albacore
+
+A small 7-key macropad featuring hotswap and per-key RGB
+
+![Albacore](https://i.imgur.com/BTPHnuQh.jpg)
+
+* Keyboard Maintainer: paprikman
+* Hardware Supported: Albacore hotswap pcb
+* Hardware Availability: Private group buy
+
+Make example for this keyboard (after setting up your build environment):
+
+    make paprikman/albacore:default
+
+Flashing example for this keyboard:
+
+    make paprikman/albacore: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).
+
+## Bootloader
+
+There are several ways to enter the bootloader:
+* **Using keycode**: Press the `RESET` key (if mapped)
+* **Bootmagic reset**: Hold the left bottom key (default mod key) and plug the usb cable
+* **Physical reset**: In the top right corner of the bottom part of the pcb you will find two pads. Shorten them with tweezers and plug the usb cable, then release. It is also possible to shorten these pads while the macropad is already connected (shorten and hold for a couple of seconds, then release).

keyboards/paprikman/albacore/rules.mk

@@ -0,0 +1,26 @@
+# MCU name
+MCU = atmega32u4
+
+# Bootloader selection
+BOOTLOADER = atmel-dfu
+
+# Build Options
+#   change yes to no to disable
+#
+BOOTMAGIC_ENABLE = yes      # Enable Bootmagic Lite
+MOUSEKEY_ENABLE = no        # 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
+AUDIO_ENABLE = no           # Audio output
+
+RGB_MATRIX_ENABLE = yes
+RGB_MATRIX_DRIVER = WS2812
+
+LTO_ENABLE = yes