Skip to content

Commit

Permalink
Updated notes on compatibility
Browse files Browse the repository at this point in the history
More nuanced note on macOS compatibility. 

Clarified Azoteq compatibility issue.

Added note on potential firmware size issues with AVR.
  • Loading branch information
Wimads authored Nov 16, 2024
1 parent 376a3be commit 7a38743
Showing 1 changed file with 5 additions and 3 deletions.
8 changes: 5 additions & 3 deletions maccel/readme.md
Original file line number Diff line number Diff line change
Expand Up @@ -240,19 +240,21 @@ Finally, after flashing the firmware to your board, load the custom via definiti
**Mac OS compatibility:**
Unfortunately it seems maccel does not work well together with Mac OS. We cannot say with certainty why, but it seems like Apple does some post processing to the mouse reports that distorts the maccel result, even when the OS level acceleration is disabled. But some consolation for mac users: the default mac OS acceleration implementation seems to be quite good.
*It's complicated...* Yes, you can use maccel with MacOS, but there is some caveats to consider:
* Even after disabling the OS level acceleration, macOS does some kind of post processing to smooth cursor movement, which you cannot disable. This will distort the result of maccel, which will make it harder to dial in, and the result may or may not be satisfactory.
* Secondly, the OS level acceleration of macOS seems to be quite good, so whether maccel (with the smoothing issue in mind) will actually be an improvement is debatable. We've heard opinions both ways from macOS users. So in other words, your mileage may vary.
**Sensor compatibility:**
* PMW3360: fully compatible, elaborately tested
* Other PMW33xx sensors will very likely perform equally well (but not tested so far)
* adns5050: compatible, tested

Check warning on line 250 in maccel/readme.md

View workflow job for this annotation

GitHub Actions / spellcheck

Unknown word (adns)
* Cirque trackpad: compatible, limited testing
* Azoteq: still some issues to be resolved, not yet compatible
* Azoteq: not compatible, due to issues in how the driver handles DPI settings.
* No other QMK compatible sensors have been tested so far. We expect most sensors to work fine with maccel, but there could always be unexpected driver/firmware related conflicts we are not aware of.
* If you are using maccel successfully (or unsuccessfully) with a sensor that isn't listed here, we'd love to hear!
**MCU compatibility:**
Despite our initial worries about the extensive use of floating point operations likely not working well on AVR, it's been tested and works adequately.
Despite our initial worries about the extensive use of floating point operations likely not working well on AVR, it's been tested and works adequately. However, firmware size might be an issue. Depending on what other QMK features you have enabled, you may need to make some compromises to fit maccel.
It is currently unknown how the un-throttled polling when used with `POINTING_DEVICE_MOTION_PIN` would interact with the expensive calculations.
Expand Down

0 comments on commit 7a38743

Please sign in to comment.