[Keyboard] Ploopy Thumb Trackball (#18214)

Co-authored-by: Drashna Jaelre <[email protected]>
Co-authored-by: Ryan <[email protected]>
Co-authored-by: Nick Brassel <[email protected]>
Co-authored-by: ploopyco <[email protected]>

keyboards/ploopyco/trackball_thumb/config.h

@@ -0,0 +1,38 @@
+/* Copyright 2021 Colin Lam (Ploopy Corporation)
+ * Copyright 2020 Christopher Courtney, aka Drashna Jael're  (@drashna) <[email protected]>
+ * Copyright 2019 Sunjun Kim
+ *
+ * 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"
+
+/* define if matrix has ghost (lacks anti-ghosting diodes) */
+//#define MATRIX_HAS_GHOST
+
+/* disable action features */
+//#define NO_ACTION_LAYER
+//#define NO_ACTION_TAPPING
+//#define NO_ACTION_ONESHOT
+
+// #define ROTATIONAL_TRANSFORM_ANGLE 0
+#define POINTING_DEVICE_INVERT_Y
+
+// If board has a debug LED, you can enable it by defining this
+// #define DEBUG_LED_PIN F7
+
+/* PMW3360 Settings */
+#define POINTING_DEVICE_CS_PIN B0

keyboards/ploopyco/trackball_thumb/info.json

@@ -0,0 +1,36 @@
+{
+    "keyboard_name": "PloopyCo Thumb Trackball",
+    "url": "www.ploopy.co",
+    "maintainer": "ploopyco",
+    "manufacturer": "Ploopy Corporation",
+    "processor": "atmega32u4",
+    "bootloader": "atmel-dfu",
+    "usb": {
+        "vid": "0x5043",
+        "pid": "0x5C46",
+        "max_power": 100
+    },
+    "features": {
+        "bootmagic": true,
+        "command": false,
+        "console": false,
+        "extrakey": true,
+        "mousekey": true,
+        "nkro": true,
+        "pointing_device": true,
+        "encoder": false
+    },
+    "debounce": 5,
+    "layouts": {
+        "LAYOUT": {
+            "layout": [
+                {"matrix":[0,0], "x":0, "y":0, "h": 1},
+                {"matrix":[0,2], "x":1, "y":0, "h":2},
+                {"matrix":[0,3],"x":2.5, "y":0.25, "h":1.5},
+                {"matrix":[0,4],"x":4, "y":0, "h":2},
+                {"matrix":[0,5],"x":5, "y":0.5, "h":1},
+                {"matrix":[0,1],"x":0, "y":1, "h":1}
+            ]
+        }
+    }
+}

keyboards/ploopyco/trackball_thumb/keymaps/default/keymap.c

@@ -0,0 +1,27 @@
+/* Copyright 2021 Colin Lam (Ploopy Corporation)
+ * Copyright 2020 Christopher Courtney, aka Drashna Jael're  (@drashna) <[email protected]>
+ * Copyright 2019 Sunjun Kim
+ *
+ * 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
+
+// safe range starts at `PLOOPY_SAFE_RANGE` instead.
+
+const uint16_t PROGMEM keymaps[][MATRIX_ROWS][MATRIX_COLS] = {
+    [0] = LAYOUT( /* Base */
+        KC_BTN4, KC_BTN1, KC_BTN3, KC_BTN2, KC_BTN5,
+        DPI_CONFIG
+    ),
+};

keyboards/ploopyco/trackball_thumb/keymaps/default/readme.md

@@ -0,0 +1 @@
+# The default keymap for Ploopyco Thumb Trackball

keyboards/ploopyco/trackball_thumb/keymaps/drag_scroll/keymap.c

@@ -0,0 +1,30 @@
+/* Copyright 2021 Colin Lam (Ploopy Corporation)
+ * Copyright 2020 Christopher Courtney, aka Drashna Jael're  (@drashna) <[email protected]>
+ * Copyright 2019 Sunjun Kim
+ *
+ * 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( /* Base */
+        KC_BTN4, KC_BTN1, KC_BTN3, KC_BTN2, KC_BTN5,
+        MO(1)
+    ),
+    [1] = LAYOUT(
+        _______, _______, _______, _______, _______,
+        DRAG_SCROLL
+    )
+};

keyboards/ploopyco/trackball_thumb/keymaps/drag_scroll/readme.md

@@ -0,0 +1,3 @@
+# The Drag Scroll keymap for Ploopyco Thumb Trackball
+
+This is a sample keymap showing off what you can do with the custom callback drivers. 

keyboards/ploopyco/trackball_thumb/keymaps/via/config.h

@@ -0,0 +1,21 @@
+/* Copyright 2021 Colin Lam (Ploopy Corporation)
+ * Copyright 2020 Christopher Courtney, aka Drashna Jael're  (@drashna) <[email protected]>
+ * Copyright 2019 Sunjun Kim
+ *
+ * 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 DYNAMIC_KEYMAP_LAYER_COUNT 8

keyboards/ploopyco/trackball_thumb/keymaps/via/keymap.c

@@ -0,0 +1,30 @@
+/* Copyright 2021 Colin Lam (Ploopy Corporation)
+ * Copyright 2020 Christopher Courtney, aka Drashna Jael're  (@drashna) <[email protected]>
+ * Copyright 2019 Sunjun Kim
+ *
+ * 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_BTN4, KC_BTN1, KC_BTN3, KC_BTN2, KC_BTN5, DPI_CONFIG ),
+    [1] = LAYOUT( _______, _______, _______, _______, _______, _______ ),
+    [2] = LAYOUT( _______, _______, _______, _______, _______, _______ ),
+    [3] = LAYOUT( _______, _______, _______, _______, _______, _______ ),
+    [4] = LAYOUT( _______, _______, _______, _______, _______, _______ ),
+    [5] = LAYOUT( _______, _______, _______, _______, _______, _______ ),
+    [6] = LAYOUT( _______, _______, _______, _______, _______, _______ ),
+    [7] = LAYOUT( _______, _______, _______, _______, _______, _______ )
+};

keyboards/ploopyco/trackball_thumb/keymaps/via/rules.mk

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

keyboards/ploopyco/trackball_thumb/post_rules.mk

@@ -0,0 +1,4 @@
+# Force encoder to be disabled
+# But enable the defines for it
+ENCODER_ENABLE := no
+OPT_DEFS += -DENCODER_ENABLE

keyboards/ploopyco/trackball_thumb/readme.md

@@ -0,0 +1,58 @@
+# Ploopyco Thumb Trackball
+
+It's a DIY, QMK Powered Trackball...for thumb ballers!
+
+* Keyboard Maintainer: [PloopyCo](https://github.com/ploopyco), [Drashna Jael're](https://github.com/drashna/), [Germ](https://github.com/germ/)
+* Hardware Supported: ATMega32u4 8MHz(3.3v)
+* Hardware Availability: [Store](https://ploopy.co), [GitHub](https://github.com/ploopyco)
+
+Make example for this keyboard (after setting up your build environment):
+
+    make ploopyco/trackball_thumb/rev1_001:default:flash
+
+To jump to the bootloader, hold down "Button 4" (button closest to the USB port).
+
+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).
+
+# Customizing your PloopyCo Thumb
+
+While the defaults are designed so that it can be plugged in and used right away, there are a number of things that you may want to change.  Such as adding DPI control, or to use the ball to scroll while holding a button.   To allow for this sort of control, there is a callback for both the scroll wheel and the mouse sensor.
+
+The default behavior for this is:
+
+```c
+report_mouse_t pointing_device_task_kb(report_mouse_t mouse_report) {
+
+    return mouse_report;
+}
+```
+
+This should allow you to more heavily customize the behavior. 
+
+Alternatively, the `process_wheel` and `process_mouse` functions can both be replaced too, to allow for even more functionality.
+
+Additionally, you can change the DPI/CPI or speed of the trackball by calling `pmw_set_cpi` at any time. Additionally, there is a `DPI_CONFIG` keycode that will cycle through an array of options for the DPI.  This is set to 1200, 1600, and 2400, but can be changed.  1600 is also set to the default.
+
+To configure/set your own array, there are two defines to use, `PLOOPY_DPI_OPTIONS` to set the array, and `PLOOPY_DPI_DEFAULT`, which is the `0`-based index into the `PLOOPY_DPI_OPTIONS` array. 
+
+```c
+#define PLOOPY_DPI_OPTIONS { 1200, 1600, 2400 }
+#define PLOOPY_DPI_DEFAULT 1
+```
+The `PLOOPY_DPI_OPTIONS` array sets the values that you want to be able to cycle through, and the order they are in.  The "default" define lets the firmware know which of these options is the default and should be loaded by default. 
+
+When inserted into your keymap, the `DPI_CONFIG` keycode will cycle through the values in the array each time you hit it.  It stores this value in persistent memory, so it will remember your selection the next time the device powers up. 
+
+## Drag Scroll
+
+Drag Scroll is a custom keycode for the Ploopy devices that allow you to hold or tap a button and have the mouse movement translate into scrolling instead. 
+
+Nothing needs to be enabled to use this functionality.  Just add the `DRAG_SCROLL` to your keymap. 
+
+### Drag Scroll Configuration
+
+* `#define PLOOPY_DRAGSCROLL_MOMENTARY` - Makes the key into a momentary key, rather than a toggle.
+* `#define PLOOPY_DRAGSCROLL_MULTIPLIER 0.75` - Sets the DPI multiplier to use when drag scroll is enabled. 
+* `#define PLOOPY_DRAGSCROLL_FIXED` - Normally, when activating Drag Scroll, it uses a fraction of the current DPI. You can define this to use a specific, set DPI rather than a fraction of the current DPI. 
+  * `#define PLOOPY_DRAGSCROLL_DPI 100` - When the fixed DPI option is enabled, this sets the DPI to be used for Drag Scroll.
+* `#define PLOOPY_DRAGSCROLL_INVERT` - This reverses the direction that the scroll is performed. 

keyboards/ploopyco/trackball_thumb/rev1_001/config.h

@@ -0,0 +1,24 @@
+/* Copyright 2021 Colin Lam (Ploopy Corporation)
+ * Copyright 2020 Christopher Courtney, aka Drashna Jael're  (@drashna) <[email protected]>
+ * Copyright 2019 Sunjun Kim
+ *
+ * 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
+
+// These pins are not broken out, and cannot be used normally.
+// They are set as output and pulled high, by default
+#define UNUSED_PINS \
+    { D1, D3, B4, B7, D6, C7, F6, F5, F3, F7 }

keyboards/ploopyco/trackball_thumb/rev1_001/info.json

@@ -0,0 +1,20 @@
+{
+    "usb": {
+        "device_version": "1.0.0"
+    },
+    "diode_direction": "COL2ROW",
+    "matrix_pins": {
+        "direct": [ [ "D5", "B6", "D4", "D2", "E6", "D7" ] ]
+    },
+    "rgblight": {
+        "led_count": 3,
+        "pin": "B5",
+        "max_brightness": 40,
+        "animations": {
+            "breathing": true,
+            "rainbow_mood": true,
+            "rainbow_swirl": true
+        }
+    }
+
+}

keyboards/ploopyco/trackball_thumb/rev1_001/readme.md

@@ -0,0 +1,3 @@
+This is the R1.001+ version of the Thumb. Future versions may have other features.
+
+See the [main readme](../readme.md) for more details. 

keyboards/ploopyco/trackball_thumb/rev1_001/rev1_001.h

@@ -0,0 +1,21 @@
+/* Copyright Colin Lam (Ploopy Corporation)
+ * Copyright 2020 Christopher Courtney, aka Drashna Jael're  (@drashna) <[email protected]>
+ * Copyright 2019 Sunjun Kim
+ *
+ * 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 "trackball_thumb.h"

keyboards/ploopyco/trackball_thumb/rules.mk

@@ -0,0 +1,9 @@
+# Processor frequency
+F_CPU = 8000000
+
+POINTING_DEVICE_DRIVER = pmw3360
+
+QUANTUM_LIB_SRC += analog.c
+SRC += opt_encoder.c
+
+DEFAULT_FOLDER = ploopyco/trackball_thumb/rev1_001