]> git.donarmstrong.com Git - qmk_firmware.git/commitdiff
[Keyboard] Add Pulse 4k, a macropad by Maxr1998 (#6195)
authorMax Rumpf <max.rumpf1998@gmail.com>
Wed, 26 Jun 2019 20:42:14 +0000 (22:42 +0200)
committerDrashna Jaelre <drashna@live.com>
Wed, 26 Jun 2019 20:42:14 +0000 (13:42 -0700)
* Add Pulse 4k, a macropad by Maxr1998

* Some config tweaks

* Remove image note

* Add license headers

* Fix media keys

* Remove Play/pause again as it doesn't work on Linux

keyboards/maxr1998/pulse4k/config.h [new file with mode: 0644]
keyboards/maxr1998/pulse4k/info.json [new file with mode: 0644]
keyboards/maxr1998/pulse4k/keymaps/default/keymap.c [new file with mode: 0644]
keyboards/maxr1998/pulse4k/keymaps/default/rules.mk [new file with mode: 0644]
keyboards/maxr1998/pulse4k/pulse4k.c [new file with mode: 0644]
keyboards/maxr1998/pulse4k/pulse4k.h [new file with mode: 0644]
keyboards/maxr1998/pulse4k/readme.md [new file with mode: 0644]
keyboards/maxr1998/pulse4k/rules.mk [new file with mode: 0644]

diff --git a/keyboards/maxr1998/pulse4k/config.h b/keyboards/maxr1998/pulse4k/config.h
new file mode 100644 (file)
index 0000000..cb4eab6
--- /dev/null
@@ -0,0 +1,76 @@
+/*
+Copyright (C) 2012-2019  Jun Wako <wakojun@gmail.com>, Maxr1998 <max.rumpf1998@gmail.com>
+
+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      0x6060
+#define DEVICE_VER      0x0001
+#define MANUFACTURER    Maxr1998
+#define PRODUCT         Pulse 4k
+#define DESCRIPTION     A four-key macropad
+
+/* Key matrix size */
+#define MATRIX_ROWS 2
+#define MATRIX_COLS 3
+
+/* Matrix pins */
+#define MATRIX_ROW_PINS { B4, E6 }
+#define MATRIX_COL_PINS { B7, B3, F0 }
+#define UNUSED_PINS
+
+/* COL2ROW or ROW2COL */
+#define DIODE_DIRECTION COL2ROW
+
+/* Set 0 if debouncing isn't needed */
+#define DEBOUNCE 5
+
+/* Rotary encoders */
+#define NUMBER_OF_ENCODERS 2
+#define ENCODERS_PAD_A { D2, F6 }
+#define ENCODERS_PAD_B { D3, F5 }
+#define ENCODER_RESOLUTION 4
+
+/* Combo setup */
+#define COMBO_COUNT 1
+#define COMBO_TERM 150
+
+/* RGB LED Setup */
+#define RGB_DI_PIN          F7 // pin the DI on the WS2812B is hooked-up to
+#define RGBLIGHT_ANIMATIONS    // run RGB animations
+#define RGBLED_NUM          2  // number of LEDs
+
+/*
+ * 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
+//#define NO_ACTION_MACRO
+//#define NO_ACTION_FUNCTION
diff --git a/keyboards/maxr1998/pulse4k/info.json b/keyboards/maxr1998/pulse4k/info.json
new file mode 100644 (file)
index 0000000..0ac4f06
--- /dev/null
@@ -0,0 +1,20 @@
+{
+  "keyboard_name": "Pulse 4k",
+  "keyboard_folder": "maxr1998/pulse4k",
+  "url": "https://github.com/Maxr1998/Pulse_4k",
+  "maintainer": "Maxr1998",
+  "width": 3,
+  "height": 2,
+  "layouts": {
+    "LAYOUT_pulse4k": {
+      "key_count": 6,
+      "layout": [ 
+        { "w": 1, "x": 0, "y": 0 }, 
+        { "w": 1, "x": 1, "y": 0 }, 
+        { "w": 1, "x": 2, "y": 0 }, 
+        { "w": 1, "x": 0, "y": 1 }, 
+        { "w": 1, "x": 1, "y": 1 }, 
+        { "w": 1, "x": 2, "y": 1 } ]
+    }
+  }
+}
diff --git a/keyboards/maxr1998/pulse4k/keymaps/default/keymap.c b/keyboards/maxr1998/pulse4k/keymaps/default/keymap.c
new file mode 100644 (file)
index 0000000..873c87d
--- /dev/null
@@ -0,0 +1,48 @@
+/*
+Copyright (C) 2019  Maxr1998 <max.rumpf1998@gmail.com>
+
+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
+
+enum layers {
+  DEFAULT
+};
+
+const uint16_t PROGMEM keymaps[][MATRIX_ROWS][MATRIX_COLS] = {
+    [DEFAULT] = {
+        { KC_END,  KC_UP,   KC_MUTE },
+        { KC_LEFT, KC_DOWN, KC_RGHT }
+    }
+};
+
+void matrix_init_user(void) {
+}
+
+void encoder_one_update(bool clockwise) {
+    if (clockwise) {
+        tap_code(KC_PGDN);
+    } else {
+        tap_code(KC_PGUP);
+    }
+}
+
+void encoder_two_update(bool clockwise) {
+    if (clockwise) {
+        tap_code(KC_VOLU);
+    } else {
+        tap_code(KC_VOLD);
+    }
+}
diff --git a/keyboards/maxr1998/pulse4k/keymaps/default/rules.mk b/keyboards/maxr1998/pulse4k/keymaps/default/rules.mk
new file mode 100644 (file)
index 0000000..e69de29
diff --git a/keyboards/maxr1998/pulse4k/pulse4k.c b/keyboards/maxr1998/pulse4k/pulse4k.c
new file mode 100644 (file)
index 0000000..ee3d41c
--- /dev/null
@@ -0,0 +1,61 @@
+/*
+Copyright (C) 2019  Maxr1998 <max.rumpf1998@gmail.com>
+
+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 "pulse4k.h"
+#include "rgblight.h"
+
+enum combo_events {
+    LED_ADJUST
+};
+
+const uint16_t PROGMEM led_adjust_combo[] = {KC_LEFT, KC_RGHT, COMBO_END};
+
+combo_t key_combos[COMBO_COUNT] = {
+    [LED_ADJUST] = COMBO_ACTION(led_adjust_combo)
+};
+
+bool led_adjust_active = false;
+
+void matrix_init_kb(void) {
+    matrix_init_user();
+}
+
+void process_combo_event(uint8_t combo_index, bool pressed) {
+    if (combo_index == LED_ADJUST) {
+        led_adjust_active = pressed;
+    }
+}
+
+void encoder_update_kb(uint8_t index, bool clockwise) {
+    if (index == 0) {
+        if (led_adjust_active) {
+            if (clockwise) {
+                rgblight_increase_val();
+            } else {
+                rgblight_decrease_val();
+            }
+        } else encoder_one_update(clockwise);
+    } else if (index == 1) {
+        if (led_adjust_active) {
+            if (clockwise) {
+                rgblight_increase_hue();
+            } else {
+                rgblight_decrease_hue();
+            }
+        } else encoder_two_update(clockwise);
+    }
+}
diff --git a/keyboards/maxr1998/pulse4k/pulse4k.h b/keyboards/maxr1998/pulse4k/pulse4k.h
new file mode 100644 (file)
index 0000000..7c34870
--- /dev/null
@@ -0,0 +1,33 @@
+/*
+Copyright (C) 2019  Maxr1998 <max.rumpf1998@gmail.com>
+
+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"
+
+#define LAYOUT( \
+      k00, k01, k02, \
+      k10, k11, k12 \
+) \
+{ \
+    { k00, k01, k02 }, \
+    { k10, k11, k12 }, \
+}
+
+void encoder_one_update(bool clockwise);
+
+void encoder_two_update(bool clockwise);
diff --git a/keyboards/maxr1998/pulse4k/readme.md b/keyboards/maxr1998/pulse4k/readme.md
new file mode 100644 (file)
index 0000000..3a55218
--- /dev/null
@@ -0,0 +1,11 @@
+# Pulse 4k
+A four-key macropad with two rotary encoders, developed by Maxr1998, [fully open-source](https://github.com/Maxr1998/Pulse_4k).
+
+Keyboard Maintainer: [Maxr1998](https://github.com/Maxr1998)  
+Hardware Availability: DIY from the [open-source design files](https://github.com/Maxr1998/Pulse_4k), potential official distribution in the future
+
+Make example for this keyboard (after setting up your build environment):
+
+    make maxr1998/pulse4k: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).
diff --git a/keyboards/maxr1998/pulse4k/rules.mk b/keyboards/maxr1998/pulse4k/rules.mk
new file mode 100644 (file)
index 0000000..6446662
--- /dev/null
@@ -0,0 +1,33 @@
+# MCU name
+MCU = atmega32u4
+
+# Bootloader
+#     This definition is optional, and if your keyboard supports multiple bootloaders of
+#     different sizes, comment this out, and the correct address will be loaded
+#     automatically (+60). See bootloader.mk for all options.
+BOOTLOADER = atmel-dfu
+
+# Interrupt driven control endpoint task(+60)
+OPT_DEFS += -DINTERRUPT_CONTROL_ENDPOINT
+
+# Build Options
+#   change to "no" to disable the options, or define them in the Makefile in
+#   the appropriate keymap folder that will get included automatically
+#
+BOOTMAGIC_ENABLE = lite    # Virtual DIP switch configuration(+1000)
+MOUSEKEY_ENABLE = no       # Mouse keys(+4700)
+ENCODER_ENABLE = yes       # Rotary encoders
+EXTRAKEY_ENABLE = yes      # Audio control and System control(+450)
+CONSOLE_ENABLE = yes       # Console for debug(+400)
+COMMAND_ENABLE = no        # Commands for debug and configuration
+COMBO_ENABLE = yes         # Key combo feature
+NKRO_ENABLE = yes          # Nkey Rollover - if this doesn't work, see here: https://github.com/tmk/tmk_keyboard/wiki/FAQ#nkro-doesnt-work
+BACKLIGHT_ENABLE = no      # Enable keyboard backlight functionality
+MIDI_ENABLE = no           # MIDI controls
+AUDIO_ENABLE = no          # Audio output on port C6
+UNICODE_ENABLE = no        # Unicode
+BLUETOOTH_ENABLE = no      # Enable Bluetooth with the Adafruit EZ-Key HID
+RGBLIGHT_ENABLE = yes      # Enable WS2812 RGB underlight.
+API_SYSEX_ENABLE = no
+SLEEP_LED_ENABLE = no      # Breathing sleep LED during USB suspend
+