Digitizer HID interface : absolute coordinates for mouse cursor (#12851)
* Add digitizer HID interface for setting the mouse cursor position at absolute screen coordinates. Tested on Pro Micro, Proton C and Blackpill. * Update docs/feature_digitizer.md Co-authored-by: Ryan <fauxpark@gmail.com> * Update tmk_core/protocol/usb_descriptor.c Co-authored-by: Ryan <fauxpark@gmail.com> * Add missing copyrights Add V-USB support * Add support for digitizer dedicated endpoint for lufa and chibios. Fix formatting issues Move digitizer_task definition to the feature's base implementation file * Run cformat on modified files * Change digitizer report usage to Digitizer instead of Pen to avoid pointer disappearing on Windows. * Update tmk_core/protocol/vusb/vusb.c Co-authored-by: Ryan <fauxpark@gmail.com> * Run cformat from docker image * Remove send_digitizer from host_driver_t and instead rely on the declaration being the interface to the implementation in each HW-specific usb implementation. * Fix build : send_digitizer shouldn't be static in vusb and add weak-linkage implementation for tests without usb implementation * Change digitizer user interface to match pointing device's * Update documentation with new API Co-authored-by: a-chol <nothing@none.com> Co-authored-by: Ryan <fauxpark@gmail.com>qmk_compile_improvements
a-chol
4 years ago
committed by
GitHub
parent
7794e97f32
commit
75b49aff56
@ -0,0 +1,35 @@ |
||||
## Digitizer |
||||
|
||||
The digitizer HID interface allows setting the mouse cursor position at absolute coordinates, unlike the Pointing Device feature that applies relative displacements. |
||||
|
||||
To enable the digitizer interface, add the following line to your rules.mk: |
||||
|
||||
```makefile |
||||
DIGITIZER_ENABLE = yes |
||||
``` |
||||
|
||||
In order to change the mouse cursor position from your keymap.c file, include the digitizer header : |
||||
|
||||
```c |
||||
#include "digitizer.h" |
||||
``` |
||||
|
||||
This gives you access to the `digitizer` structure which members allow you to change the cursor position. |
||||
|
||||
The coordinates are normalized, meaning there value must be set between 0 and 1. For the `x` coordinate, the value `0` is the leftmost position, whereas the value `1` is the rightmost position. |
||||
For the `y` coordinate, `0` is at the top and `1` at the bottom. |
||||
|
||||
Here is an example setting the cursor in the middle of the screen: |
||||
|
||||
```c |
||||
digitizer_t digitizer; |
||||
digitizer.x = 0.5; |
||||
digitizer.y = 0.5; |
||||
digitizer.tipswitch = 0; |
||||
digitizer.inrange = 1; |
||||
digitizer_set_report(digitizer); |
||||
``` |
||||
|
||||
The `tipswitch` member triggers what equates to a click when set to `1`. The `inrange` member is required for the change in coordinates to be taken. It can then be set to `0` in a new report to signal the end of the digitizer interaction, but it is not strictly required. |
||||
|
||||
Once all members are set to the desired value, the `status` member needs its bitmask `DZ_UPDATED` to be set so the report is sent during the next main loop iteration. |
||||
@ -0,0 +1,38 @@ |
||||
/* Copyright 2021 QMK
|
||||
*
|
||||
* 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 |
||||
|
||||
#include "digitizer.h" |
||||
|
||||
#include "math.h" |
||||
|
||||
const uint16_t PROGMEM keymaps[][MATRIX_ROWS][MATRIX_COLS] = {LAYOUT_ortho_1x1(KC_A)}; |
||||
|
||||
uint32_t timer = 0; |
||||
|
||||
void matrix_scan_user() { |
||||
if (timer_elapsed32(timer) < 200) { |
||||
return; |
||||
} |
||||
|
||||
timer = timer_read32(); |
||||
digitizer_t digitizer; |
||||
digitizer.x = 0.5 - 0.2 * cos(timer_read() / 250. / 6.28); |
||||
digitizer.y = 0.5 - 0.2 * sin(timer_read() / 250. / 6.28); |
||||
digitizer.tipswitch = 0; |
||||
digitizer.inrange = 1; |
||||
digitizer_set_report(digitizer); |
||||
} |
||||
@ -0,0 +1 @@ |
||||
DIGITIZER_ENABLE = yes
|
||||
@ -0,0 +1,34 @@ |
||||
/* Copyright 2021
|
||||
* |
||||
* 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 "digitizer.h" |
||||
|
||||
digitizer_t digitizerReport = {.tipswitch = 0, .inrange = 0, .id = 0, .x = 0, .y = 0, .status = DZ_INITIALIZED}; |
||||
|
||||
__attribute__((weak)) void digitizer_send(void) { |
||||
if (digitizerReport.status & DZ_UPDATED) { |
||||
host_digitizer_send(&digitizerReport); |
||||
digitizerReport.status &= ~DZ_UPDATED; |
||||
} |
||||
} |
||||
|
||||
__attribute__((weak)) void digitizer_task(void) { digitizer_send(); } |
||||
|
||||
digitizer_t digitizer_get_report(void) { return digitizerReport; } |
||||
|
||||
void digitizer_set_report(digitizer_t newDigitizerReport) { |
||||
digitizerReport = newDigitizerReport; |
||||
digitizerReport.status |= DZ_UPDATED; |
||||
} |
||||
@ -0,0 +1,41 @@ |
||||
/* Copyright 2021
|
||||
* |
||||
* 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 <stdint.h> |
||||
|
||||
enum digitizer_status { DZ_INITIALIZED = 1, DZ_UPDATED = 2 }; |
||||
|
||||
typedef struct { |
||||
int8_t tipswitch; |
||||
int8_t inrange; |
||||
uint8_t id; |
||||
float x; |
||||
float y; |
||||
uint8_t status : 2; |
||||
} digitizer_t; |
||||
|
||||
extern digitizer_t digitizer; |
||||
|
||||
digitizer_t digitizer_get_report(void); |
||||
|
||||
void digitizer_set_report(digitizer_t newDigitizerReport); |
||||
|
||||
void digitizer_task(void); |
||||
|
||||
void host_digitizer_send(digitizer_t *digitizer); |
||||
Loading…
Reference in new issue