gitbot/qmk_firmware
0
0
Fork 0
mirror of https://github.com/qmk/qmk_firmware.git synced 2025-07-20 14:42:03 +00:00
Code Issues Packages Projects Releases Wiki Activity

Add docs

Browse Source 
To be honest, there isn't a lot that needs to be customized here, but there is a lot that could/shold be done for handling the other axises.  But drashna doesn't want to do it, at this time
This commit is contained in:
Drashna Jael're 2023-11-20 18:40:22 -08:00
parent 300fb2bc1d
commit 9efbd11052
No known key found for this signature in database
GPG Key ID: DBA1FD3A860D1B11
2 changed files with 22 additions and 3 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

21
docs/features/pointing_device.md
View File

@ -368,6 +368,27 @@ report_mouse_t pointing_device_task_kb(report_mouse_t mouse_report) {
```
### SpaceMouse Module (UART)
To use the SpaceMouse module to control the pointer, add this to your `rules.mk`
```make
POINTING_DEVICE_DRIVER = spacemouse_module
```
The SpaceMouse Module is a UART driven sensor, with 6 axises of motion.
While there isn't a whole lot to configure here, only the X and Y movement is enabled by default. The Z axis and the twist and turn axises are not supported out of box. These can be handled with a custom function:
```c
void spacemouse_module_handle_axises(spacemouse_data_t *spacemouse_data, report_mouse_t* mouse_report) {
mouse_report->x = CONSTRAIN_HID_XY(spacemouse_data->x);
mouse_report->y = CONSTRAIN_HID_XY(spacemouse_data->y);
mouse_report->h = CONSTRAIN_HID(spacemouse_data->b);
mouse_report->v = CONSTRAIN_HID(spacemouse_data->c);
}
```
### Custom Driver
If you have a sensor type that isn't supported above, a custom option is available by adding the following to your `rules.mk`

2
drivers/sensors/spacemouse_module.h
View File

@ -13,9 +13,7 @@
// - no parity
// - 100/s data rate
#ifndef SPACEMOUSE_BAUD_RATE
#define SPACEMOUSE_BAUD_RATE 38400
#endif
#define SPACEMOUSE_AXIS_COUNT 6