aboutsummaryrefslogtreecommitdiff
path: root/keyboards/ploopyco/mouse
diff options
context:
space:
mode:
Diffstat (limited to 'keyboards/ploopyco/mouse')
-rw-r--r--keyboards/ploopyco/mouse/config.h5
-rw-r--r--keyboards/ploopyco/mouse/info.json12
-rw-r--r--keyboards/ploopyco/mouse/keymaps/drag_scroll/keymap.c27
-rw-r--r--keyboards/ploopyco/mouse/keymaps/drag_scroll/readme.md3
-rw-r--r--keyboards/ploopyco/mouse/mouse.c223
-rw-r--r--keyboards/ploopyco/mouse/mouse.h49
-rw-r--r--keyboards/ploopyco/mouse/readme.md46
-rw-r--r--keyboards/ploopyco/mouse/rules.mk17
8 files changed, 15 insertions, 367 deletions
diff --git a/keyboards/ploopyco/mouse/config.h b/keyboards/ploopyco/mouse/config.h
index 86af11fc94..0375a8875a 100644
--- a/keyboards/ploopyco/mouse/config.h
+++ b/keyboards/ploopyco/mouse/config.h
@@ -33,5 +33,10 @@
/* PMW33XX Settings */
#define PMW33XX_CS_PIN B0
+#define ENCODER_BUTTON_COL 1
+#define ENCODER_BUTTON_ROW 0
/* Custom encoder needs to specify just how many encoders we have */
#define NUM_ENCODERS 1
+
+#define ENCODERS_PAD_A { F0 }
+#define ENCODERS_PAD_B { F4 }
diff --git a/keyboards/ploopyco/mouse/info.json b/keyboards/ploopyco/mouse/info.json
index 1f110aad71..e24572cc54 100644
--- a/keyboards/ploopyco/mouse/info.json
+++ b/keyboards/ploopyco/mouse/info.json
@@ -9,6 +9,15 @@
"device_version": "0.0.1",
"max_power": 100
},
+ "features": {
+ "bootmagic": true,
+ "extrakey": true,
+ "mousekey": true,
+ "nkro": false,
+ "pointing_device": true,
+ "rgblight": false,
+ "encoder": true
+ },
"bootmagic": {
"matrix": [0, 3]
},
@@ -31,9 +40,6 @@
["D4", "D2", "E6", "B6", "D7", "C6", "C7", "B7"]
]
},
- "features": {
- "encoder": true
- },
"encoder": {
"driver": "custom"
},
diff --git a/keyboards/ploopyco/mouse/keymaps/drag_scroll/keymap.c b/keyboards/ploopyco/mouse/keymaps/drag_scroll/keymap.c
deleted file mode 100644
index a072dfceca..0000000000
--- a/keyboards/ploopyco/mouse/keymaps/drag_scroll/keymap.c
+++ /dev/null
@@ -1,27 +0,0 @@
-/* Copyright 2020 Christopher Courtney, aka Drashna Jael're (@drashna) <[email protected]>
- * Copyright 2019 Sunjun Kim
- * Copyright 2020 Ploopy Corporation
- *
- * 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 */
- C(KC_C), KC_BTN1, KC_BTN3, LT(1, KC_BTN2), C(KC_V), KC_BTN4, KC_BTN5, DPI_CONFIG),
- [1] = LAYOUT(/* Base */
- _______, DRAG_SCROLL, _______, _______, _______, _______, _______, QK_BOOT),
-
-};
diff --git a/keyboards/ploopyco/mouse/keymaps/drag_scroll/readme.md b/keyboards/ploopyco/mouse/keymaps/drag_scroll/readme.md
deleted file mode 100644
index ddf5eb7084..0000000000
--- a/keyboards/ploopyco/mouse/keymaps/drag_scroll/readme.md
+++ /dev/null
@@ -1,3 +0,0 @@
-# The Drag Scroll keymap for PloopyCo Mouse
-
-This is a sample keymap showing off what you can do with the custom callback drivers.
diff --git a/keyboards/ploopyco/mouse/mouse.c b/keyboards/ploopyco/mouse/mouse.c
deleted file mode 100644
index 5f4a82e474..0000000000
--- a/keyboards/ploopyco/mouse/mouse.c
+++ /dev/null
@@ -1,223 +0,0 @@
-/* Copyright 2020 Christopher Courtney, aka Drashna Jael're (@drashna) <[email protected]>
- * Copyright 2019 Sunjun Kim
- * Copyright 2020 Ploopy Corporation
- *
- * 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 "mouse.h"
-
-#ifndef OPT_DEBOUNCE
-# define OPT_DEBOUNCE 5 // (ms) Time between scroll events
-#endif
-#ifndef SCROLL_BUTT_DEBOUNCE
-# define SCROLL_BUTT_DEBOUNCE 100 // (ms) Time between scroll events
-#endif
-#ifndef OPT_THRES
-# define OPT_THRES 150 // (0-1024) Threshold for actication
-#endif
-#ifndef OPT_SCALE
-# define OPT_SCALE 1 // Multiplier for wheel
-#endif
-#ifndef PLOOPY_DPI_OPTIONS
-# define PLOOPY_DPI_OPTIONS \
- { 1200, 1600, 2400 }
-# ifndef PLOOPY_DPI_DEFAULT
-# define PLOOPY_DPI_DEFAULT 1
-# endif
-#endif
-#ifndef PLOOPY_DPI_DEFAULT
-# define PLOOPY_DPI_DEFAULT 0
-#endif
-#ifndef PLOOPY_DRAGSCROLL_DPI
-# define PLOOPY_DRAGSCROLL_DPI 100 // Fixed-DPI Drag Scroll
-#endif
-#ifndef PLOOPY_DRAGSCROLL_MULTIPLIER
-# define PLOOPY_DRAGSCROLL_MULTIPLIER 0.75 // Variable-DPI Drag Scroll
-#endif
-
-keyboard_config_t keyboard_config;
-uint16_t dpi_array[] = PLOOPY_DPI_OPTIONS;
-#define DPI_OPTION_SIZE ARRAY_SIZE(dpi_array)
-
-// TODO: Implement libinput profiles
-// https://wayland.freedesktop.org/libinput/doc/latest/pointer-acceleration.html
-// Compile time accel selection
-// Valid options are ACC_NONE, ACC_LINEAR, ACC_CUSTOM, ACC_QUADRATIC
-
-// Trackball State
-bool is_scroll_clicked = false;
-bool BurstState = false; // init burst state for Trackball module
-uint16_t MotionStart = 0; // Timer for accel, 0 is resting state
-uint16_t lastScroll = 0; // Previous confirmed wheel event
-uint16_t lastMidClick = 0; // Stops scrollwheel from being read if it was pressed
-uint8_t OptLowPin = OPT_ENC1;
-bool debug_encoder = false;
-bool is_drag_scroll = false;
-
-bool encoder_update_kb(uint8_t index, bool clockwise) {
- if (!encoder_update_user(index, clockwise)) {
- return false;
- }
-#ifdef MOUSEKEY_ENABLE
- tap_code(clockwise ? KC_WH_U : KC_WH_D);
-#else
- report_mouse_t mouse_report = pointing_device_get_report();
- mouse_report.v = clockwise ? 1 : -1;
- pointing_device_set_report(mouse_report);
- pointing_device_send();
-#endif
- return true;
-}
-
-void encoder_driver_init(void) {
- setPinInput(OPT_ENC1);
- setPinInput(OPT_ENC2);
-
- opt_encoder_init();
-}
-
-void encoder_driver_task(void) {
- // Lovingly ripped from the Ploopy Source
-
- // If the mouse wheel was just released, do not scroll.
- if (timer_elapsed(lastMidClick) < SCROLL_BUTT_DEBOUNCE) {
- return;
- }
-
- // Limit the number of scrolls per unit time.
- if (timer_elapsed(lastScroll) < OPT_DEBOUNCE) {
- return;
- }
-
- // Don't scroll if the middle button is depressed.
- if (is_scroll_clicked) {
-#ifndef IGNORE_SCROLL_CLICK
- return;
-#endif
- }
-
- lastScroll = timer_read();
- uint16_t p1 = adc_read(OPT_ENC1_MUX);
- uint16_t p2 = adc_read(OPT_ENC2_MUX);
- if (debug_encoder) dprintf("OPT1: %d, OPT2: %d\n", p1, p2);
-
- int dir = opt_encoder_handler(p1, p2);
-
- if (dir == 0) return;
- encoder_queue_event(0, dir == 1);
-}
-
-report_mouse_t pointing_device_task_kb(report_mouse_t mouse_report) {
- if (is_drag_scroll) {
- mouse_report.h = mouse_report.x;
-#ifdef PLOOPY_DRAGSCROLL_INVERT
- // Invert vertical scroll direction
- mouse_report.v = -mouse_report.y;
-#else
- mouse_report.v = mouse_report.y;
-#endif
- mouse_report.x = 0;
- mouse_report.y = 0;
- }
-
- return pointing_device_task_user(mouse_report);
-}
-
-bool process_record_kb(uint16_t keycode, keyrecord_t* record) {
- if (debug_mouse) {
- dprintf("KL: kc: %u, col: %u, row: %u, pressed: %u\n", keycode, record->event.key.col, record->event.key.row, record->event.pressed);
- }
-
- // Update Timer to prevent accidental scrolls
- if ((record->event.key.col == 1) && (record->event.key.row == 0)) {
- lastMidClick = timer_read();
- is_scroll_clicked = record->event.pressed;
- }
-
- if (!process_record_user(keycode, record)) {
- return false;
- }
-
- if (keycode == DPI_CONFIG && record->event.pressed) {
- keyboard_config.dpi_config = (keyboard_config.dpi_config + 1) % DPI_OPTION_SIZE;
- eeconfig_update_kb(keyboard_config.raw);
- pointing_device_set_cpi(dpi_array[keyboard_config.dpi_config]);
- }
-
- if (keycode == DRAG_SCROLL) {
-#ifndef PLOOPY_DRAGSCROLL_MOMENTARY
- if (record->event.pressed)
-#endif
- {
- is_drag_scroll ^= 1;
- }
-#ifdef PLOOPY_DRAGSCROLL_FIXED
- pointing_device_set_cpi(is_drag_scroll ? PLOOPY_DRAGSCROLL_DPI : dpi_array[keyboard_config.dpi_config]);
-#else
- pointing_device_set_cpi(is_drag_scroll ? (dpi_array[keyboard_config.dpi_config] * PLOOPY_DRAGSCROLL_MULTIPLIER) : dpi_array[keyboard_config.dpi_config]);
-#endif
- }
-
- return true;
-}
-
-// Hardware Setup
-void keyboard_pre_init_kb(void) {
- // debug_enable = true;
- // debug_matrix = true;
- // debug_mouse = true;
- // debug_encoder = true;
-
- /* Ground all output pins connected to ground. This provides additional
- * pathways to ground. If you're messing with this, know this: driving ANY
- * of these pins high will cause a short. On the MCU. Ka-blooey.
- */
-#ifdef UNUSABLE_PINS
- const pin_t unused_pins[] = UNUSABLE_PINS;
-
- for (uint8_t i = 0; i < ARRAY_SIZE(unused_pins); i++) {
- setPinOutput(unused_pins[i]);
- writePinLow(unused_pins[i]);
- }
-#endif
-
- // This is the debug LED.
-#if defined(DEBUG_LED_PIN)
- setPinOutput(DEBUG_LED_PIN);
- writePin(DEBUG_LED_PIN, debug_enable);
-#endif
-
- keyboard_pre_init_user();
-}
-
-void pointing_device_init_kb(void) {
- pointing_device_set_cpi(dpi_array[keyboard_config.dpi_config]);
-}
-
-void eeconfig_init_kb(void) {
- keyboard_config.dpi_config = PLOOPY_DPI_DEFAULT;
- eeconfig_update_kb(keyboard_config.raw);
- eeconfig_init_user();
-}
-
-void matrix_init_kb(void) {
- // is safe to just read DPI setting since matrix init
- // comes before pointing device init.
- keyboard_config.raw = eeconfig_read_kb();
- if (keyboard_config.dpi_config > DPI_OPTION_SIZE) {
- eeconfig_init_kb();
- }
- matrix_init_user();
-}
diff --git a/keyboards/ploopyco/mouse/mouse.h b/keyboards/ploopyco/mouse/mouse.h
deleted file mode 100644
index 9123315fd4..0000000000
--- a/keyboards/ploopyco/mouse/mouse.h
+++ /dev/null
@@ -1,49 +0,0 @@
-/* Copyright 2020 Christopher Courtney, aka Drashna Jael're (@drashna) <[email protected]>
- * Copyright 2019 Sunjun Kim
- * Copyright 2020 Ploopy Corporation
- *
- * 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"
-#include "analog.h"
-#include "opt_encoder.h"
-
-// Sensor defs
-#define OPT_ENC1 F0
-#define OPT_ENC2 F4
-#define OPT_ENC1_MUX 0
-#define OPT_ENC2_MUX 4
-
-void process_wheel(void);
-
-typedef union {
- uint32_t raw;
- struct {
- uint8_t dpi_config;
- };
-} keyboard_config_t;
-
-extern keyboard_config_t keyboard_config;
-extern uint16_t dpi_array[];
-
-enum ploopy_keycodes {
- DPI_CONFIG = QK_KB_0,
- DRAG_SCROLL,
-};
-
-bool encoder_update_user(uint8_t index, bool clockwise);
-bool encoder_update_kb(uint8_t index, bool clockwise);
diff --git a/keyboards/ploopyco/mouse/readme.md b/keyboards/ploopyco/mouse/readme.md
index af3cb3520f..060448c2bf 100644
--- a/keyboards/ploopyco/mouse/readme.md
+++ b/keyboards/ploopyco/mouse/readme.md
@@ -19,48 +19,4 @@ See the [build environment setup](https://docs.qmk.fm/#/getting_started_build_to
# Customizing your PloopyCo Mouse
-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
-void process_wheel_user(report_mouse_t* mouse_report, int16_t h, int16_t v) {
- mouse_report->h = h;
- mouse_report->v = v;
-}
-
-void process_mouse_user(report_mouse_t* mouse_report, int16_t x, int16_t y) {
- mouse_report->x = x;
- mouse_report->y = y;
-}
-```
-
-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 `pointing_device_set_cpi` at any time. Additionally, there is a `DPI_CONFIG` macro 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`.
-
-```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.
-
-The `DPI_CONFIG` macro will cycle through the values in the array, each time you hit it. And it stores this value in persistent memory, so it will load it the next time the device powers up.
-
-## Drag Scroll
-
-Drag Sroll 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.
+You can find customziation options [here](../readme.md).
diff --git a/keyboards/ploopyco/mouse/rules.mk b/keyboards/ploopyco/mouse/rules.mk
index 6356950780..3d1d3fc961 100644
--- a/keyboards/ploopyco/mouse/rules.mk
+++ b/keyboards/ploopyco/mouse/rules.mk
@@ -1,21 +1,4 @@
# Processor frequency
F_CPU = 8000000
-# Build Options
-# change yes to no to disable
-#
-BOOTMAGIC_ENABLE = yes # Enable Bootmagic Lite
-EXTRAKEY_ENABLE = yes # Audio control and System control
-CONSOLE_ENABLE = no # Console for debug
-COMMAND_ENABLE = no # Commands for debug and configuration
-NKRO_ENABLE = no # Enable N-Key Rollover
-BACKLIGHT_ENABLE = no # Enable keyboard backlight functionality
-RGBLIGHT_ENABLE = no # Enable keyboard RGB underglow
-AUDIO_ENABLE = no # Audio output
-POINTING_DEVICE_ENABLE = yes
POINTING_DEVICE_DRIVER = pmw3360
-MOUSEKEY_ENABLE = yes # Mouse keys
-
-ANALOG_DRIVER_REQUIRED = yes
-
-SRC += opt_encoder.c