control: drive the ATK ZERO, and let a mouse state its own lift-off range - #159
Open
itsnttt wants to merge 2 commits into
Open
control: drive the ATK ZERO, and let a mouse state its own lift-off range#159itsnttt wants to merge 2 commits into
itsnttt wants to merge 2 commits into
Conversation
The ZERO does not speak the 0xff02 EEPROM protocol the existing ATK driver implements, so the "ATK driver (0x373b) likely covers" note on the VXE Zero Normal row was wrong: that vendor id alone is not enough. The family uses the BITMOUSE channel on usage page 0xff05, added in OpenMouse-Project/mouse-protocol. Pin the two PIDs verified on hardware and let the PID universe in the test import them from the protocol package, so the row cannot drift. Co-Authored-By: Claude Opus 5 <noreply@anthropic.com>
…ange Wiring the BITMOUSE driver up exposed three things the app assumed. A driver the app does not name is treated as Pulsar. `pulsarClient()` is a negative test — anything not in DEDICATED falls through to the Pulsar explorer — so connecting an ATK ZERO failed on `client.describeCollections is not a function`. The client joins DM_CLASSES, beside the older ATK, Lamzu and WLMouse drivers whose surface it shares. Cards come from BY_FAMILY, not from the status. `ui.showAdvancedSection` opens the section but `sleep` and `debounce` stay false until the family is in the table, so both cards were missing even though the driver reported values for them. "atk-bitmouse" gets the same DIRECT_MODE entry as "atk". Lift-off was three stops for everyone. `liftOffDistance` has only Low, Medium and High, so a mouse that tunes lift-off continuously — the ATK ZERO runs 0.7 mm to 1.7 mm in eleven steps — had ten of its settings thrown away. Drivers can now report a `liftOffScale`, and the card renders a slider over the raw device codes labelled with the millimetres the driver supplies, so the scale stays in the driver and any brand can use the control. The coarse field is still reported alongside it, and a driver that sets no scale keeps the three stops exactly as before. Sensor sampling mode was likewise Teevolution-only; a generic row now shows whenever a status carries `sensorMode`. Ultra Long Range gets a toggle against the new `longRangeMode` field. Also maps both ATK ZERO product ids to atk-zero.png. The art itself goes through an artwork request, as public/devices/README.md asks. Co-Authored-By: Claude Opus 5 <noreply@anthropic.com>
This was referenced Sep 5, 2026
Open
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Companion to OpenMouse-Project/mouse-protocol#50, which adds the
BITMOUSE driver for the ATK ZERO. That PR needs to land first — the imports
here do not resolve without it.
Driving the new driver from the app turned up three things the app assumed, and
one of them is not ATK-specific at all.
A driver the app does not name is treated as Pulsar
pulsarClient()is a negative test — anything not inDEDICATEDfalls throughto the Pulsar explorer:
So connecting an ATK ZERO failed with
client.describeCollections is not a function. The client joinsDM_CLASSES, beside the older ATK, Lamzu andWLMouse drivers whose surface it already shares.
Cards come from the family table, not from the status
ui.showAdvancedSectionopens the section, butsleepanddebouncestayfalse until the family appears in
BY_FAMILY, so both cards were missing eventhough the driver was reporting values for them.
"atk-bitmouse"gets the sameDIRECT_MODEentry as"atk".Lift-off was three stops for every mouse
liftOffDistanceoffers only Low, Medium and High. A mouse that tunes lift-offcontinuously — the ATK ZERO runs 0.7 mm to 1.7 mm in eleven steps, and the
vendor software shows a slider — had eight of its eleven settings thrown away.
Drivers can now report an optional
liftOffScale, and the sensor card renders aslider over the raw device codes, labelled with the millimetres the driver
supplies. The scale therefore stays in the driver and the control is not
ATK-specific; any brand whose firmware exposes a range can use it. The coarse
liftOffDistanceis still reported alongside, and a driver that sets no scalekeeps the three stops exactly as before.
This part is independent of the ATK work and can be split into its own PR if
you would rather review it separately — happy to do that.
Two smaller controls
Sensor sampling mode was Teevolution-only; a generic row now shows whenever a
status carries
sensorMode. Ultra Long Range gets a toggle against the newlongRangeModefield.Supported devices
Adds the ATK ZERO as supported, pinning
0x1154and0x1155, withPID_UNIVERSEimportingBITMOUSE_PRODUCT_IDSfrom the protocol package so therow cannot drift from the driver.
It also corrects the "VXE Zero Normal" note, which read "ATK driver (0x373b)
likely covers — needs hardware test". That inference was wrong: the ZERO family
does not expose the
0xff02collection the existing ATK driver matches on. Therow stays
likely— that model's own PID still needs confirming — but the notenow says why the existing driver does not reach it.
Artwork
Maps both ATK ZERO product ids to
atk-zero.png. No image file is included, aspublic/devices/README.mdasks; the art itself goes through a Device artworkrequest.
Verified
npm run checkagainst the local protocol build:tsc --noEmitandvite buildclean, 112 tests.On an ATK ZERO over its receiver, through this app: DPI, polling rate, lift-off,
angle snapping, debounce, sleep, motion sync, ripple control, sensor sampling
mode and Ultra Long Range all read and write. Lift-off and angle snapping were
checked by hand — lifting the mouse and dragging it — rather than by read-back
alone, because the protocol PR describes a defect where a write verified
correctly and still did nothing.