1upocarina (qmk#21039)

Co-authored-by: Joel Challis <git@zvecr.com>

keyboards/1upkeyboards/1upocarina/config.h

@@ -0,0 +1,70 @@
+/* Copyright 2023 Ziptyze
+ *
+ * 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 RGB_MATRIX_LED_COUNT 32
+#define RGB_MATRIX_KEYPRESSES // reacts to keypresses
+
+#    define RGB_DISABLE_WHEN_USB_SUSPENDED // turn off effects when suspended
+// RGB Matrix Animation modes. Explicitly enabled
+// For full list of effects, see:
+// https://docs.qmk.fm/#/feature_rgb_matrix?id=rgb-matrix-effects
+// #    define ENABLE_RGB_MATRIX_ALPHAS_MODS
+// #    define ENABLE_RGB_MATRIX_GRADIENT_UP_DOWN
+#    define ENABLE_RGB_MATRIX_GRADIENT_LEFT_RIGHT
+#    define ENABLE_RGB_MATRIX_BREATHING
+#    define ENABLE_RGB_MATRIX_BAND_SAT
+#    define ENABLE_RGB_MATRIX_BAND_VAL
+#    define ENABLE_RGB_MATRIX_BAND_PINWHEEL_SAT
+#    define ENABLE_RGB_MATRIX_BAND_PINWHEEL_VAL
+#    define ENABLE_RGB_MATRIX_BAND_SPIRAL_SAT
+#    define ENABLE_RGB_MATRIX_BAND_SPIRAL_VAL
+#    define ENABLE_RGB_MATRIX_CYCLE_ALL
+#    define ENABLE_RGB_MATRIX_CYCLE_LEFT_RIGHT
+#    define ENABLE_RGB_MATRIX_CYCLE_UP_DOWN
+#    define ENABLE_RGB_MATRIX_RAINBOW_MOVING_CHEVRON
+#    define ENABLE_RGB_MATRIX_CYCLE_OUT_IN
+#    define ENABLE_RGB_MATRIX_CYCLE_OUT_IN_DUAL
+#    define ENABLE_RGB_MATRIX_CYCLE_PINWHEEL
+#    define ENABLE_RGB_MATRIX_CYCLE_SPIRAL
+#    define ENABLE_RGB_MATRIX_DUAL_BEACON
+#    define ENABLE_RGB_MATRIX_RAINBOW_BEACON
+#    define ENABLE_RGB_MATRIX_RAINBOW_PINWHEELS
+#    define ENABLE_RGB_MATRIX_RAINDROPS
+#    define ENABLE_RGB_MATRIX_JELLYBEAN_RAINDROPS
+#    define ENABLE_RGB_MATRIX_HUE_BREATHING
+#    define ENABLE_RGB_MATRIX_HUE_PENDULUM
+#    define ENABLE_RGB_MATRIX_HUE_WAVE
+// #    define ENABLE_RGB_MATRIX_PIXEL_RAIN
+// #    define ENABLE_RGB_MATRIX_PIXEL_FLOW
+// #    define ENABLE_RGB_MATRIX_PIXEL_FRACTAL
+// enabled only if RGB_MATRIX_FRAMEBUFFER_EFFECTS is defined
+#    define ENABLE_RGB_MATRIX_TYPING_HEATMAP
+// #    define ENABLE_RGB_MATRIX_DIGITAL_RAIN
+// enabled only of RGB_MATRIX_KEYPRESSES or RGB_MATRIX_KEYRELEASES is defined
+#    define ENABLE_RGB_MATRIX_SOLID_REACTIVE_SIMPLE
+#    define ENABLE_RGB_MATRIX_SOLID_REACTIVE
+#    define ENABLE_RGB_MATRIX_SOLID_REACTIVE_WIDE
+#    define ENABLE_RGB_MATRIX_SOLID_REACTIVE_MULTIWIDE
+#    define ENABLE_RGB_MATRIX_SOLID_REACTIVE_CROSS
+#    define ENABLE_RGB_MATRIX_SOLID_REACTIVE_MULTICROSS
+#    define ENABLE_RGB_MATRIX_SOLID_REACTIVE_NEXUS
+#    define ENABLE_RGB_MATRIX_SOLID_REACTIVE_MULTINEXUS
+#    define ENABLE_RGB_MATRIX_SPLASH
+#    define ENABLE_RGB_MATRIX_MULTISPLASH
+#    define ENABLE_RGB_MATRIX_SOLID_SPLASH
+#    define ENABLE_RGB_MATRIX_SOLID_MULTISPLASH

keyboards/1upkeyboards/1upocarina/info.json

@@ -0,0 +1,96 @@
+{
+    "manufacturer": "1upkeyboards",
+    "keyboard_name": "1upocarina",
+    "maintainer": "ziptyze",
+    "processor": "RP2040",
+    "bootloader": "rp2040",
+    "board": "GENERIC_RP_RP2040",
+    "usb": {
+        "device_version": "1.0.0",
+        "pid": "0x5607",
+        "vid": "0x6F75"
+    },
+    "dynamic_keymap": {
+        "layer_count": 10
+    },
+    "features": {
+        "bootmagic": true,
+        "command": false,
+        "console": false,
+        "encoder": true,
+        "extrakey": true,
+        "mousekey": true,
+        "nkro": false,
+        "rgb_matrix": true
+    },
+    "encoder": {
+        "enabled": true,
+        "rotary": [
+            {
+                "pin_a": "GP25", "pin_b": "GP26"
+            }
+        ]
+    },
+    "matrix_pins": {
+        "direct": [
+            ["GP28", "GP29", "GP27", "GP1", "GP2"]
+        ]
+    },
+    "ws2812": {
+        "pin": "GP24"
+    },
+    "rgb_matrix": {
+        "driver": "WS2812",
+        "layout": [
+        { "flags": 4, "matrix": [0, 0], "x": 23, "y": 26 },
+        { "flags": 4, "matrix": [0, 1], "x": 62, "y": 26 },
+        { "flags": 4, "matrix": [0, 2], "x": 112, "y": 34 },
+        { "flags": 4, "matrix": [0, 3], "x": 161, "y": 26 },
+        { "flags": 4, "matrix": [0, 4], "x": 200, "y": 26 },
+
+        { "flags": 2, "x": 133, "y": 3 },
+        { "flags": 2, "x": 154, "y": 3 },
+        { "flags": 2, "x": 174, "y": 3 },
+        { "flags": 2, "x": 194, "y": 3 },
+        { "flags": 2, "x": 218, "y": 5 },
+
+        { "flags": 2, "x": 221, "y": 19 },
+        { "flags": 2, "x": 221, "y": 31 },
+        { "flags": 2, "x": 221, "y": 44 },
+        { "flags": 2, "x": 217, "y": 58 },
+        { "flags": 2, "x": 195, "y": 61 },
+
+        { "flags": 2, "x": 174, "y": 61 },
+        { "flags": 2, "x": 154, "y": 61 },
+        { "flags": 2, "x": 133, "y": 61 },
+        { "flags": 2, "x": 112, "y": 61 },
+        { "flags": 2, "x": 91, "y": 61 },
+
+        { "flags": 2, "x": 70, "y": 61 },
+        { "flags": 2, "x": 49, "y": 61 },
+        { "flags": 2, "x": 28, "y": 61 },
+        { "flags": 2, "x": 5, "y": 58 },
+        { "flags": 2, "x": 2, "y": 44 },
+
+        { "flags": 2, "x": 2, "y": 31 },
+        { "flags": 2, "x": 2, "y": 19 },
+        { "flags": 2, "x": 5, "y": 5 },
+        { "flags": 2, "x": 28, "y": 3 },
+        { "flags": 2, "x": 49, "y": 3 },
+
+        { "flags": 2, "x": 70, "y": 3 },
+        { "flags": 2, "x": 91, "y": 3 }
+        ]
+    },
+    "layouts": {
+        "LAYOUT_1x5": {
+            "layout": [
+                { "label": "z", "matrix": [0, 0], "w": 1, "x": 0, "y": 0 },
+                { "label": "x", "matrix": [0, 1], "w": 1, "x": 1, "y": 0 },
+                { "label": "esc", "matrix": [0, 2], "w": 1, "x": 2, "y": 0 },
+                { "label": "c", "matrix": [0, 3], "w": 1, "x": 3, "y": 0 },
+                { "label": "v", "matrix": [0, 4], "w": 1, "x": 4, "y": 0 }
+            ]
+        }
+    }
+}

keyboards/1upkeyboards/1upocarina/keymaps/default/keymap.c

@@ -0,0 +1,34 @@
+/* Copyright 2023 ziptyze
+ *
+ * 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_1x5(
+        KC_Z,    KC_X, LT(1, KC_ESC),  KC_C,    KC_V
+    ),
+
+    [1] = LAYOUT_1x5(
+        RGB_TOG, RGB_MOD, KC_TRNS, RGB_VAD, RGB_VAI
+    )
+};
+
+#if defined(ENCODER_MAP_ENABLE)
+const uint16_t PROGMEM encoder_map[][NUM_ENCODERS][NUM_DIRECTIONS] = {
+    [0] =  { ENCODER_CCW_CW(KC_VOLD, KC_VOLU)},
+    [1] =  { ENCODER_CCW_CW(KC_TRNS, KC_TRNS)}
+};
+#endif

keyboards/1upkeyboards/1upocarina/keymaps/default/rules.mk

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

keyboards/1upkeyboards/1upocarina/keymaps/via/keymap.c

@@ -0,0 +1,34 @@
+/* Copyright 2023 ziptyze
+ *
+ * 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_1x5(
+        KC_Z,    KC_X, LT(1, KC_ESC),  KC_C,    KC_V
+    ),
+
+    [1] = LAYOUT_1x5(
+        RGB_TOG, RGB_MOD, KC_TRNS, RGB_VAD, RGB_VAI
+    )
+};
+
+#if defined(ENCODER_MAP_ENABLE)
+const uint16_t PROGMEM encoder_map[][NUM_ENCODERS][NUM_DIRECTIONS] = {
+    [0] =  { ENCODER_CCW_CW(KC_VOLD, KC_VOLU)},
+    [1] =  { ENCODER_CCW_CW(KC_TRNS, KC_TRNS)}
+};
+#endif

keyboards/1upkeyboards/1upocarina/keymaps/via/rules.mk

@@ -0,0 +1,4 @@
+VIA_ENABLE = yes
+LTO_ENABLE = yes
+
+ENCODER_MAP_ENABLE = yes

keyboards/1upkeyboards/1upocarina/readme.md

@@ -0,0 +1,22 @@
+# 1upocarina
+
+This keyboard is the Ocarina from 1upkeyboards. It is a five button keypad designed for osu. There is an option to add an encoder to the center position, and the keypad features in-switch per-key addressable RGB leds, as well as 27 right angle underglow RGB leds for very bright and smooth lighting effects.
+
+* Keyboard Maintainer: [ziptyze](https://github.com/ziptyze)
+
+Make example for this keyboard (after setting up your build environment):
+
+    make 1upkeyboards/1upocarina:default
+
+Flashing example for this keyboard:
+
+    make 1upkeyboards/1upocarina: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
+
+Enter the bootloader in 2 ways:
+
+* **Bootmagic reset**: Hold down the key at (0,0) in the matrix (usually the top left key or Escape) and plug in the keyboard
+* **Physical reset button**: Hold the button on the back of the PCB and plug in the keyboard

keyboards/1upkeyboards/1upocarina/rules.mk

@@ -0,0 +1 @@
+WS2812_DRIVER = vendor