[Keyboard] Add ANAVI Arrows

ANAVI Arrows is a compact inverted T hot-swappable mechanical keyboard with 4 Cherry MX compatible switches, translucent key caps, rotary encoder, USB-C, RP2040 microcontroller, backlighting and under lighting. This commits adds initial QMK support for ANAVI Arrows with: - Default keymap - Rotary encoder - Mini OLED I2C Display - WS2812B RGB underlighting - Backlighting (with PWMD5 and channel A as defined for GPIO 26 in the Raspberry Pi RP2040 datasheet) The Neopixel on XIAO RP2040 is not supported as of the moment. Signed-off-by: Leon Anavi <leon@anavi.org>
qmk · Nov 13, 2023 · 36fd769 · 36fd769
1 parent 935c894
commit 36fd769
Show file tree

Hide file tree

Showing 9 changed files with 198 additions and 0 deletions.
diff --git a/keyboards/anavi/arrows/arrows.c b/keyboards/anavi/arrows/arrows.c
@@ -0,0 +1,38 @@
+// Copyright 2023 Leon Anavi <leon@anavi.org>
+// SPDX-License-Identifier: GPL-2.0-or-later
+
+#include "quantum.h"
+
+#ifdef OLED_ENABLE
+
+bool oled_task_kb(void) {
+
+    if (!oled_task_user()) {
+        return false;
+    }
+
+    // Host Keyboard Layer Status
+    oled_write_ln_P(PSTR("ANAVI Arrows"), false);
+    oled_write_ln_P(PSTR("Keymap: Default"), false);
+
+    // Host Keyboard LED Status
+    led_t led_state = host_keyboard_led_state();
+    oled_write_P(PSTR("Num Lock: "), false);
+    oled_write_ln_P(led_state.num_lock ? PSTR("On") : PSTR("Off"), false);
+    oled_write_P(PSTR("Caps Lock: "), false);
+    oled_write_ln_P(led_state.caps_lock ? PSTR("On") : PSTR("Off"), false);
+    oled_write_P(PSTR("Scroll Lock: "), false);
+    oled_write_ln_P(led_state.scroll_lock ? PSTR("On") : PSTR("Off"), false);
+#   ifdef RGBLIGHT_ENABLE
+        oled_write_P(PSTR("RGB Mode: "), false);
+        oled_write_ln(get_u8_str(rgblight_get_mode(), ' '), false);
+        oled_write_P(PSTR("h: "), false);
+        oled_write(get_u8_str(rgblight_get_hue(), ' '), false);
+        oled_write_P(PSTR("s: "), false);
+        oled_write(get_u8_str(rgblight_get_sat(), ' '), false);
+        oled_write_P(PSTR("v: "), false);
+        oled_write_ln(get_u8_str(rgblight_get_val(), ' '), false);
+#   endif
+    return false;
+}
+#endif
diff --git a/keyboards/anavi/arrows/config.h b/keyboards/anavi/arrows/config.h
@@ -0,0 +1,25 @@
+// Copyright 2023 Leon Anavi <leon@anavi.org>
+// SPDX-License-Identifier: GPL-2.0-or-later
+
+#pragma once
+
+#define RGBLIGHT_DEFAULT_MODE RGBLIGHT_MODE_RAINBOW_MOOD
+
+/* Double tap reset button to enter bootloader */
+#define RP2040_BOOTLOADER_DOUBLE_TAP_RESET
+#define RP2040_BOOTLOADER_DOUBLE_TAP_RESET_LED GP17
+#define RP2040_BOOTLOADER_DOUBLE_TAP_RESET_TIMEOUT 500U
+
+#ifdef BACKLIGHT_ENABLE
+#   define BACKLIGHT_PWM_DRIVER PWMD5
+#   define BACKLIGHT_PWM_CHANNEL RP2040_PWM_CHANNEL_A
+#endif
+
+#define I2C1_SDA_PIN GP6
+#define I2C1_SCL_PIN GP7
+
+#ifdef OLED_ENABLE
+#   define OLED_DISPLAY_128X64
+#   define OLED_TIMEOUT 60000
+#   define OLED_BRIGHTNESS 128
+#endif
diff --git a/keyboards/anavi/arrows/halconf.h b/keyboards/anavi/arrows/halconf.h
@@ -0,0 +1,9 @@
+// Copyright 2023 Leon Anavi <leon@anavi.org>
+// SPDX-License-Identifier: GPL-2.0-or-later
+
+#pragma once
+
+#define HAL_USE_I2C TRUE
+#define HAL_USE_PWM TRUE
+
+#include_next <halconf.h>
diff --git a/keyboards/anavi/arrows/info.json b/keyboards/anavi/arrows/info.json
@@ -0,0 +1,68 @@
+{
+    "keyboard_name": "arrows",
+    "manufacturer": "ANAVI",
+    "url": "https://github.com/AnaviTechnology/anavi-arrows",
+    "maintainer": "leon-anavi",
+    "processor": "RP2040",
+    "bootloader": "rp2040",
+    "matrix_pins": {
+        "direct": [
+	    ["GP4", "GP0", "GP27", "GP28", "GP29"]
+        ]
+    },
+    "features": {
+        "bootmagic": true,
+        "command": false,
+        "console": false,
+        "extrakey": true,
+        "mousekey": true,
+        "nkro": true,
+        "rgblight": true,
+        "backlight": true,
+        "oled": true,
+        "encoder": true
+    },
+    "rgblight": {
+        "led_count": 4,
+        "animations": {
+            "alternating": true,
+            "breathing": true,
+            "christmas": true,
+            "knight": true,
+            "rainbow_mood": true,
+            "rainbow_swirl": true,
+            "rgb_test": true,
+            "snake": true,
+            "static_gradient": true,
+            "twinkle": true
+        }
+    },
+    "ws2812": {
+        "pin": "GP3",
+        "driver": "vendor"
+    },
+    "backlight": {
+        "pin": "GP26"
+    },
+    "encoder": {
+        "rotary": [
+            {"pin_a": "GP1", "pin_b": "GP2", "resolution": 2}
+        ]
+    },
+    "layouts": {
+        "LAYOUT": {
+            "layout": [
+                {"matrix": [0, 0], "x": 2, "y": 0},
+                {"matrix": [0, 1], "x": 1, "y": 1},
+                {"matrix": [0, 2], "x": 0, "y": 2},
+                {"matrix": [0, 3], "x": 1, "y": 2},
+                {"matrix": [0, 4], "x": 2, "y": 2}
+            ]
+        }
+    },
+    "usb": {
+        "device_version": "1.0.0",
+        "pid": "0x9A25",
+        "vid": "0xFEED"
+    }
+}
diff --git a/keyboards/anavi/arrows/keymaps/default/keymap.c b/keyboards/anavi/arrows/keymaps/default/keymap.c
@@ -0,0 +1,20 @@
+// Copyright 2023 Leon Anavi <leon@anavi.org>
+// SPDX-License-Identifier: GPL-2.0-or-later
+
+#include QMK_KEYBOARD_H
+
+enum layer_names {
+    _BASE
+};
+
+const uint16_t PROGMEM keymaps[][MATRIX_ROWS][MATRIX_COLS] = {
+    [_BASE] = LAYOUT(
+                           KC_MUTE,
+                  KC_UP,
+        KC_RIGHT, KC_DOWN, KC_LEFT)
+};
+
+const uint16_t PROGMEM backlight_combo[] = {KC_UP, KC_DOWN, COMBO_END};
+combo_t key_combos[] = {
+    COMBO(backlight_combo, BL_STEP)
+};
diff --git a/keyboards/anavi/arrows/keymaps/default/rules.mk b/keyboards/anavi/arrows/keymaps/default/rules.mk
@@ -0,0 +1 @@
+COMBO_ENABLE = yes # Enables combo keys
diff --git a/keyboards/anavi/arrows/mcuconf.h b/keyboards/anavi/arrows/mcuconf.h
@@ -0,0 +1,15 @@
+// Copyright 2023 Leon Anavi (@leon-anavi)
+// SPDX-License-Identifier: GPL-2.0-or-later
+
+#pragma once
+
+#include_next <mcuconf.h>
+
+#undef RP_I2C_USE_I2C0
+#define RP_I2C_USE_I2C0 FALSE
+
+#undef RP_I2C_USE_I2C1
+#define RP_I2C_USE_I2C1 TRUE
+
+#undef RP_PWM_USE_PWM5
+#define RP_PWM_USE_PWM5 TRUE
diff --git a/keyboards/anavi/arrows/readme.md b/keyboards/anavi/arrows/readme.md
@@ -0,0 +1,21 @@
+# ANAVI Arrows
+
+ANAVI Arrows is a compact inverted T mechanical keyboard with hot-swappable Cherry MX compatible mechanical switches, translucent keycaps, rotary encoder, USB-C, RP2040 microcontroller, backlighting and under lighting.
+
+* Keyboard Maintainer: [Leon Anavi](https://github.com/leon-anavi)
+* Hardware Supported: ANAVI Arrows
+* Hardware Availability: [Crowd Supply](https://www.crowdsupply.com/anavi-technology/anavi-macro-pad-12-and-arrows), [GitHub repository](https://github.com/AnaviTechnology/anavi-arrows)
+
+Make example for this keyboard (after setting up your build environment):
+
+    qmk compile -kb anavi/arrows -km default
+
+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 3 ways:
+
+* **Bootmagic reset**: Hold down the top left key on the left half, or top right key on the right half, and then plug in the USB cable on that keyboard half.
+* **Physical reset button**: Double tap the reset button on the XIAO RP2040.
+* **Keycode in layout**: Press the key mapped to `QK_BOOT` if it is available.
diff --git a/keyboards/anavi/arrows/rules.mk b/keyboards/anavi/arrows/rules.mk
@@ -0,0 +1 @@
+# This file intentionally left blank