@openmouse/protocol 0.1.0

package/dist/drivers/mchose/dock-hid.js

@@ -0,0 +1,176 @@
+import { MCHOSE_DOCK_COMMAND, MCHOSE_DOCK_COLOR_MODES, MCHOSE_DOCK_LEVELS, MCHOSE_DOCK_MODE_LABELS, MCHOSE_DOCK_PRODUCT_ID, MCHOSE_DOCK_REPORT_ID, MCHOSE_DOCK_USAGE, MCHOSE_DOCK_USAGE_PAGE, mchoseDockColorFromHex, mchoseDockColorToHex, mchoseDockDecodeLighting, mchoseDockEffectFor, mchoseDockEncode, mchoseDockEncodeLighting, mchoseDockModeLabel, mchoseDockPayload, } from "@openmouse/protocol/mchose";
+import { VENDOR_ID } from "../vendors.js";
+/**
+ * MCHOSE MagDock — the charging base, which is where this family's RGB lives.
+ * The A7 V2 mice have no controllable LEDs of their own.
+ *
+ * It is not a mouse, so it follows the non-mouse pattern: a `MouseStatus` with
+ * `ui.settingsReady: false` so the settings grid stays hidden, carrying only
+ * the lighting the device actually has.
+ */
+const REPLY_TIMEOUT_MS = 700;
+const WRITE_SETTLE_MS = 400;
+const READ_ATTEMPTS = 6;
+const delay = (ms) => new Promise((resolve) => { setTimeout(resolve, ms); });
+export class MchoseDockHidClient {
+    device;
+    queue = Promise.resolve();
+    lastKnown = null;
+    constructor(device) {
+        this.device = device;
+    }
+    static isSupported(device) {
+        const search = (collection) => (collection.usagePage === MCHOSE_DOCK_USAGE_PAGE
+            && collection.usage === MCHOSE_DOCK_USAGE)
+            || collection.children.some(search);
+        return device.vendorId === VENDOR_ID.mchose
+            && device.productId === MCHOSE_DOCK_PRODUCT_ID
+            && device.collections.some(search);
+    }
+    async open() {
+        if (!this.device.opened)
+            await this.device.open();
+    }
+    async close() {
+        this.lastKnown = null;
+        if (this.device.opened)
+            await this.device.close();
+    }
+    /** The dock pushes no unsolicited state the panel can use. */
+    async startNotifications() {
+        return false;
+    }
+    displayName() {
+        return this.device.productName?.trim() || "MCHOSE MagDock";
+    }
+    /** Called for every connected client, dock or not. */
+    getDpiOptions() {
+        return [];
+    }
+    /** Send a request and wait for the matching reply on the input report. */
+    request(command, params = []) {
+        const run = async () => {
+            const frame = mchoseDockEncode(command, params);
+            for (let attempt = 0; attempt < READ_ATTEMPTS; attempt += 1) {
+                const reply = await new Promise((resolve) => {
+                    const timer = setTimeout(() => {
+                        this.device.removeEventListener("inputreport", listener);
+                        resolve(null);
+                    }, REPLY_TIMEOUT_MS);
+                    const listener = (event) => {
+                        const report = event;
+                        const payload = mchoseDockPayload(new Uint8Array(report.data.buffer), command);
+                        if (!payload)
+                            return;
+                        clearTimeout(timer);
+                        this.device.removeEventListener("inputreport", listener);
+                        resolve(payload);
+                    };
+                    this.device.addEventListener("inputreport", listener);
+                    this.device.sendReport(MCHOSE_DOCK_REPORT_ID, frame).catch(() => {
+                        clearTimeout(timer);
+                        this.device.removeEventListener("inputreport", listener);
+                        resolve(null);
+                    });
+                });
+                if (reply)
+                    return reply;
+            }
+            return null;
+        };
+        const next = this.queue.then(run, run);
+        this.queue = next.catch(() => undefined);
+        return next;
+    }
+    async readLighting() {
+        await this.open();
+        const payload = await this.request(MCHOSE_DOCK_COMMAND.readLighting);
+        const decoded = payload ? mchoseDockDecodeLighting(payload) : null;
+        if (decoded)
+            this.lastKnown = decoded;
+        return decoded;
+    }
+    async readStatus() {
+        const lighting = await this.readLighting();
+        return {
+            brand: "MCHOSE",
+            name: this.displayName(),
+            batteryPercent: null,
+            batteryState: "Unknown",
+            dpi: 0,
+            pollingRateHz: 0,
+            activeProfile: null,
+            liftOffDistance: null,
+            connectionType: "Wired",
+            firmware: [],
+            lighting: lighting ? this.toMouseLighting(lighting) : undefined,
+            ui: {
+                family: "mchose-dock",
+                // Not a mouse: the settings grid would render nothing but blanks.
+                settingsReady: false,
+                defaultDisplayName: "MCHOSE MagDock",
+                statusNote: lighting
+                    // Not just the V2's base: an A7 V3 owner's MagDock enumerates
+                    // identically and reads correctly through this same driver.
+                    ? "Charging base — lighting only. The A7 mice have no LEDs of their own."
+                    : "Charging base — the lighting state could not be read.",
+            },
+        };
+    }
+    toMouseLighting(state) {
+        const modes = MCHOSE_DOCK_MODE_LABELS.map(([, label]) => label);
+        return {
+            zone: "Base",
+            modes: ["Off", ...modes],
+            mode: state.enabled ? mchoseDockModeLabel(state.effect) : "Off",
+            color: mchoseDockColorToHex(state.color),
+            color2: null,
+            colorModes: MCHOSE_DOCK_COLOR_MODES,
+            dualColorModes: [],
+            reactiveModes: [],
+            speeds: [...MCHOSE_DOCK_LEVELS],
+            speed: state.speed,
+            brightness: state.brightness,
+            brightnessLevels: [...MCHOSE_DOCK_LEVELS],
+        };
+    }
+    /**
+     * The dock takes its whole lighting block in one write, so anything the panel
+     * does not specify is carried over from the last read rather than zeroed.
+     */
+    async setLighting(next) {
+        const current = this.lastKnown ?? await this.readLighting();
+        if (!current)
+            throw new Error("The dock did not report its lighting state.");
+        const off = next.mode === "Off";
+        const effect = off ? current.effect : mchoseDockEffectFor(next.mode ?? "") ?? current.effect;
+        const color = next.color ? mchoseDockColorFromHex(next.color) : null;
+        const state = {
+            enabled: !off,
+            effect,
+            effectCount: current.effectCount,
+            speed: next.speed ?? current.speed,
+            brightness: next.brightness ?? current.brightness,
+            // The music effect is what the sync flag is for.
+            musicSync: effect === mchoseDockEffectFor("Reactive"),
+            color: color ?? current.color,
+            direction: current.direction,
+        };
+        await this.open();
+        const frame = mchoseDockEncodeLighting(state);
+        const send = async () => {
+            await this.device.sendReport(MCHOSE_DOCK_REPORT_ID, frame);
+            await delay(WRITE_SETTLE_MS);
+        };
+        const queued = this.queue.then(send, send);
+        this.queue = queued.catch(() => undefined);
+        await queued;
+        const after = await this.readLighting();
+        if (!after)
+            throw new Error("The dock did not confirm the lighting change.");
+        if (after.enabled !== state.enabled || (state.enabled && after.effect !== state.effect)) {
+            throw new Error("The dock did not accept the lighting change.");
+        }
+    }
+}
+//# sourceMappingURL=dock-hid.js.map

package/dist/drivers/mchose/dock-hid.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"dock-hid.js","sourceRoot":"","sources":["../../../src/drivers/mchose/dock-hid.ts"],"names":[],"mappings":"AAAA,OAAO,EACL,mBAAmB,EACnB,uBAAuB,EACvB,kBAAkB,EAClB,uBAAuB,EACvB,sBAAsB,EACtB,qBAAqB,EACrB,iBAAiB,EACjB,sBAAsB,EACtB,sBAAsB,EACtB,oBAAoB,EACpB,wBAAwB,EACxB,mBAAmB,EACnB,gBAAgB,EAChB,wBAAwB,EACxB,mBAAmB,EACnB,iBAAiB,GAElB,MAAM,4BAA4B,CAAC;AAEpC,OAAO,EAAE,SAAS,EAAE,MAAM,eAAe,CAAC;AAE1C;;;;;;;GAOG;AAEH,MAAM,gBAAgB,GAAG,GAAG,CAAC;AAC7B,MAAM,eAAe,GAAG,GAAG,CAAC;AAC5B,MAAM,aAAa,GAAG,CAAC,CAAC;AAExB,MAAM,KAAK,GAAG,CAAC,EAAU,EAAiB,EAAE,CAAC,IAAI,OAAO,CAAC,CAAC,OAAO,EAAE,EAAE,GAAG,UAAU,CAAC,OAAO,EAAE,EAAE,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC;AAEpG,MAAM,OAAO,mBAAmB;IACrB,MAAM,CAAY;IAEnB,KAAK,GAAqB,OAAO,CAAC,OAAO,EAAE,CAAC;IAC5C,SAAS,GAA8B,IAAI,CAAC;IAEpD,YAAY,MAAiB;QAC3B,IAAI,CAAC,MAAM,GAAG,MAAM,CAAC;IACvB,CAAC;IAED,MAAM,CAAC,WAAW,CAAC,MAAiB;QAClC,MAAM,MAAM,GAAG,CAAC,UAA6B,EAAW,EAAE,CACxD,CAAC,UAAU,CAAC,SAAS,KAAK,sBAAsB;eAC3C,UAAU,CAAC,KAAK,KAAK,iBAAiB,CAAC;eACzC,UAAU,CAAC,QAAQ,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC;QACtC,OAAO,MAAM,CAAC,QAAQ,KAAK,SAAS,CAAC,MAAM;eACtC,MAAM,CAAC,SAAS,KAAK,sBAAsB;eAC3C,MAAM,CAAC,WAAW,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC;IACvC,CAAC;IAED,KAAK,CAAC,IAAI;QACR,IAAI,CAAC,IAAI,CAAC,MAAM,CAAC,MAAM;YAAE,MAAM,IAAI,CAAC,MAAM,CAAC,IAAI,EAAE,CAAC;IACpD,CAAC;IAED,KAAK,CAAC,KAAK;QACT,IAAI,CAAC,SAAS,GAAG,IAAI,CAAC;QACtB,IAAI,IAAI,CAAC,MAAM,CAAC,MAAM;YAAE,MAAM,IAAI,CAAC,MAAM,CAAC,KAAK,EAAE,CAAC;IACpD,CAAC;IAED,8DAA8D;IAC9D,KAAK,CAAC,kBAAkB;QACtB,OAAO,KAAK,CAAC;IACf,CAAC;IAED,WAAW;QACT,OAAO,IAAI,CAAC,MAAM,CAAC,WAAW,EAAE,IAAI,EAAE,IAAI,gBAAgB,CAAC;IAC7D,CAAC;IAED,sDAAsD;IACtD,aAAa;QACX,OAAO,EAAE,CAAC;IACZ,CAAC;IAED,0EAA0E;IAClE,OAAO,CAAC,OAAe,EAAE,SAA4B,EAAE;QAC7D,MAAM,GAAG,GAAG,KAAK,IAAgC,EAAE;YACjD,MAAM,KAAK,GAAG,gBAAgB,CAAC,OAAO,EAAE,MAAM,CAAC,CAAC;YAChD,KAAK,IAAI,OAAO,GAAG,CAAC,EAAE,OAAO,GAAG,aAAa,EAAE,OAAO,IAAI,CAAC,EAAE,CAAC;gBAC5D,MAAM,KAAK,GAAG,MAAM,IAAI,OAAO,CAAoB,CAAC,OAAO,EAAE,EAAE;oBAC7D,MAAM,KAAK,GAAG,UAAU,CAAC,GAAG,EAAE;wBAC5B,IAAI,CAAC,MAAM,CAAC,mBAAmB,CAAC,aAAa,EAAE,QAAQ,CAAC,CAAC;wBACzD,OAAO,CAAC,IAAI,CAAC,CAAC;oBAChB,CAAC,EAAE,gBAAgB,CAAC,CAAC;oBACrB,MAAM,QAAQ,GAAG,CAAC,KAAY,EAAQ,EAAE;wBACtC,MAAM,MAAM,GAAG,KAA4B,CAAC;wBAC5C,MAAM,OAAO,GAAG,iBAAiB,CAAC,IAAI,UAAU,CAAC,MAAM,CAAC,IAAI,CAAC,MAAM,CAAC,EAAE,OAAO,CAAC,CAAC;wBAC/E,IAAI,CAAC,OAAO;4BAAE,OAAO;wBACrB,YAAY,CAAC,KAAK,CAAC,CAAC;wBACpB,IAAI,CAAC,MAAM,CAAC,mBAAmB,CAAC,aAAa,EAAE,QAAQ,CAAC,CAAC;wBACzD,OAAO,CAAC,OAAO,CAAC,CAAC;oBACnB,CAAC,CAAC;oBACF,IAAI,CAAC,MAAM,CAAC,gBAAgB,CAAC,aAAa,EAAE,QAAQ,CAAC,CAAC;oBACtD,IAAI,CAAC,MAAM,CAAC,UAAU,CAAC,qBAAqB,EAAE,KAAK,CAAC,CAAC,KAAK,CAAC,GAAG,EAAE;wBAC9D,YAAY,CAAC,KAAK,CAAC,CAAC;wBACpB,IAAI,CAAC,MAAM,CAAC,mBAAmB,CAAC,aAAa,EAAE,QAAQ,CAAC,CAAC;wBACzD,OAAO,CAAC,IAAI,CAAC,CAAC;oBAChB,CAAC,CAAC,CAAC;gBACL,CAAC,CAAC,CAAC;gBACH,IAAI,KAAK;oBAAE,OAAO,KAAK,CAAC;YAC1B,CAAC;YACD,OAAO,IAAI,CAAC;QACd,CAAC,CAAC;QACF,MAAM,IAAI,GAAG,IAAI,CAAC,KAAK,CAAC,IAAI,CAAC,GAAG,EAAE,GAAG,CAAC,CAAC;QACvC,IAAI,CAAC,KAAK,GAAG,IAAI,CAAC,KAAK,CAAC,GAAG,EAAE,CAAC,SAAS,CAAC,CAAC;QACzC,OAAO,IAAI,CAAC;IACd,CAAC;IAEO,KAAK,CAAC,YAAY;QACxB,MAAM,IAAI,CAAC,IAAI,EAAE,CAAC;QAClB,MAAM,OAAO,GAAG,MAAM,IAAI,CAAC,OAAO,CAAC,mBAAmB,CAAC,YAAY,CAAC,CAAC;QACrE,MAAM,OAAO,GAAG,OAAO,CAAC,CAAC,CAAC,wBAAwB,CAAC,OAAO,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC;QACnE,IAAI,OAAO;YAAE,IAAI,CAAC,SAAS,GAAG,OAAO,CAAC;QACtC,OAAO,OAAO,CAAC;IACjB,CAAC;IAED,KAAK,CAAC,UAAU;QACd,MAAM,QAAQ,GAAG,MAAM,IAAI,CAAC,YAAY,EAAE,CAAC;QAE3C,OAAO;YACL,KAAK,EAAE,QAAQ;YACf,IAAI,EAAE,IAAI,CAAC,WAAW,EAAE;YACxB,cAAc,EAAE,IAAI;YACpB,YAAY,EAAE,SAAS;YACvB,GAAG,EAAE,CAAC;YACN,aAAa,EAAE,CAAC;YAChB,aAAa,EAAE,IAAI;YACnB,eAAe,EAAE,IAAI;YACrB,cAAc,EAAE,OAAO;YACvB,QAAQ,EAAE,EAAE;YACZ,QAAQ,EAAE,QAAQ,CAAC,CAAC,CAAC,IAAI,CAAC,eAAe,CAAC,QAAQ,CAAC,CAAC,CAAC,CAAC,SAAS;YAC/D,EAAE,EAAE;gBACF,MAAM,EAAE,aAAa;gBACrB,kEAAkE;gBAClE,aAAa,EAAE,KAAK;gBACpB,kBAAkB,EAAE,gBAAgB;gBACpC,UAAU,EAAE,QAAQ;oBAClB,8DAA8D;oBAC9D,4DAA4D;oBAC5D,CAAC,CAAC,uEAAuE;oBACzE,CAAC,CAAC,uDAAuD;aAC5D;SACF,CAAC;IACJ,CAAC;IAEO,eAAe,CAAC,KAAyB;QAC/C,MAAM,KAAK,GAAG,uBAAuB,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,KAAK,CAAC,EAAE,EAAE,CAAC,KAA0B,CAAC,CAAC;QACrF,OAAO;YACL,IAAI,EAAE,MAAM;YACZ,KAAK,EAAE,CAAC,KAAK,EAAE,GAAG,KAAK,CAAC;YACxB,IAAI,EAAE,KAAK,CAAC,OAAO,CAAC,CAAC,CAAE,mBAAmB,CAAC,KAAK,CAAC,MAAM,CAAuB,CAAC,CAAC,CAAC,KAAK;YACtF,KAAK,EAAE,oBAAoB,CAAC,KAAK,CAAC,KAAK,CAAC;YACxC,MAAM,EAAE,IAAI;YACZ,UAAU,EAAE,uBAA8C;YAC1D,cAAc,EAAE,EAAE;YAClB,aAAa,EAAE,EAAE;YACjB,MAAM,EAAE,CAAC,GAAG,kBAAkB,CAAC;YAC/B,KAAK,EAAE,KAAK,CAAC,KAAK;YAClB,UAAU,EAAE,KAAK,CAAC,UAAU;YAC5B,gBAAgB,EAAE,CAAC,GAAG,kBAAkB,CAAC;SAC1C,CAAC;IACJ,CAAC;IAED;;;OAGG;IACH,KAAK,CAAC,WAAW,CAAC,IAAmB;QACnC,MAAM,OAAO,GAAG,IAAI,CAAC,SAAS,IAAI,MAAM,IAAI,CAAC,YAAY,EAAE,CAAC;QAC5D,IAAI,CAAC,OAAO;YAAE,MAAM,IAAI,KAAK,CAAC,6CAA6C,CAAC,CAAC;QAE7E,MAAM,GAAG,GAAG,IAAI,CAAC,IAAI,KAAK,KAAK,CAAC;QAChC,MAAM,MAAM,GAAG,GAAG,CAAC,CAAC,CAAC,OAAO,CAAC,MAAM,CAAC,CAAC,CAAC,mBAAmB,CAAC,IAAI,CAAC,IAAI,IAAI,EAAE,CAAC,IAAI,OAAO,CAAC,MAAM,CAAC;QAC7F,MAAM,KAAK,GAAG,IAAI,CAAC,KAAK,CAAC,CAAC,CAAC,sBAAsB,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC;QAErE,MAAM,KAAK,GAAuB;YAChC,OAAO,EAAE,CAAC,GAAG;YACb,MAAM;YACN,WAAW,EAAE,OAAO,CAAC,WAAW;YAChC,KAAK,EAAE,IAAI,CAAC,KAAK,IAAI,OAAO,CAAC,KAAK;YAClC,UAAU,EAAE,IAAI,CAAC,UAAU,IAAI,OAAO,CAAC,UAAU;YACjD,iDAAiD;YACjD,SAAS,EAAE,MAAM,KAAK,mBAAmB,CAAC,UAAU,CAAC;YACrD,KAAK,EAAE,KAAK,IAAI,OAAO,CAAC,KAAK;YAC7B,SAAS,EAAE,OAAO,CAAC,SAAS;SAC7B,CAAC;QAEF,MAAM,IAAI,CAAC,IAAI,EAAE,CAAC;QAClB,MAAM,KAAK,GAAG,wBAAwB,CAAC,KAAK,CAAC,CAAC;QAC9C,MAAM,IAAI,GAAG,KAAK,IAAmB,EAAE;YACrC,MAAM,IAAI,CAAC,MAAM,CAAC,UAAU,CAAC,qBAAqB,EAAE,KAAK,CAAC,CAAC;YAC3D,MAAM,KAAK,CAAC,eAAe,CAAC,CAAC;QAC/B,CAAC,CAAC;QACF,MAAM,MAAM,GAAG,IAAI,CAAC,KAAK,CAAC,IAAI,CAAC,IAAI,EAAE,IAAI,CAAC,CAAC;QAC3C,IAAI,CAAC,KAAK,GAAG,MAAM,CAAC,KAAK,CAAC,GAAG,EAAE,CAAC,SAAS,CAAC,CAAC;QAC3C,MAAM,MAAM,CAAC;QAEb,MAAM,KAAK,GAAG,MAAM,IAAI,CAAC,YAAY,EAAE,CAAC;QACxC,IAAI,CAAC,KAAK;YAAE,MAAM,IAAI,KAAK,CAAC,+CAA+C,CAAC,CAAC;QAC7E,IAAI,KAAK,CAAC,OAAO,KAAK,KAAK,CAAC,OAAO,IAAI,CAAC,KAAK,CAAC,OAAO,IAAI,KAAK,CAAC,MAAM,KAAK,KAAK,CAAC,MAAM,CAAC,EAAE,CAAC;YACxF,MAAM,IAAI,KAAK,CAAC,8CAA8C,CAAC,CAAC;QAClE,CAAC;IACH,CAAC;CACF"}

package/dist/drivers/mchose/hid.d.ts

@@ -0,0 +1,118 @@
+import type { MouseStatus } from "../mouse-types.ts";
+export declare class MchoseHidClient {
+    readonly device: HIDDevice;
+    private queue;
+    private cachedProduct;
+    constructor(device: HIDDevice);
+    static isSupported(device: HIDDevice): boolean;
+    open(): Promise<void>;
+    close(): Promise<void>;
+    /** MCHOSE pushes unsolicited reports, but their layout is not decoded yet. */
+    startNotifications(): Promise<boolean>;
+    displayName(): string;
+    isWireless(): boolean;
+    /**
+     * Over a cable the host talks to the mouse itself, so the product id is a
+     * model id; every other link enumerates as a shared receiver id. Which link
+     * is live decides which half of the config byte pair applies.
+     */
+    private isWired;
+    /**
+     * Send a command and poll for its answer.
+     *
+     * Two guards matter here, because every command shares one reply buffer: the
+     * command echo must un-invert to what was sent, and the caller's `accept`
+     * check must pass. Without both, a stale answer left by a previous command
+     * reads as a valid one — which is exactly how a config read can hand back a
+     * battery reply.
+     */
+    private request;
+    private nonZero;
+    /** A config payload always carries a plausible first DPI stage. */
+    private static looksLikeConfig;
+    private readConfigPayload;
+    /**
+     * Read the config, apply `changes`, write it back and confirm it took. The
+     * whole payload is echoed apart from the changed fields, so button mappings
+     * and macros are preserved rather than zeroed by a partial write.
+     */
+    private updateConfig;
+    private linkRates;
+    readStatus(): Promise<MouseStatus>;
+    /** Called for every connected client; the stage editor drives DPI here. */
+    getDpiOptions(): number[];
+    setPollingRate(hertz: number): Promise<void>;
+    setActiveDpiStage(stage: number): Promise<void>;
+    setDpiStageValue(stage: number, dpi: number): Promise<void>;
+    /**
+     * Switch the active onboard profile. `profile` is 1-based to match what the
+     * shell displays; the firmware is 0-based.
+     *
+     * Each profile carries its own DPI stages and per-link rate, so everything
+     * the panel shows changes with it — the caller is expected to re-read status
+     * afterwards. The device also needs a moment before it will answer for the
+     * newly selected profile, hence the settle below.
+     */
+    setProfile(profile: number): Promise<void>;
+    /**
+       * Lift-off and the processing toggles share one command and one status byte,
+       * so both go through here rather than `updateConfig`. They still read back
+       * out of the config blob, which is what confirms the change.
+       */
+    private writePerformance;
+    /** The current lift-off step, needed because the command always carries it. */
+    private currentLiftOffIndex;
+    setLiftOffDistance(label: NonNullable<MouseStatus["liftOffDistance"]>): Promise<void>;
+    setMotionSync(enabled: boolean): Promise<void>;
+    setAngleSnapping(enabled: boolean): Promise<void>;
+    setRippleControl(enabled: boolean): Promise<void>;
+    /** The named power/performance modes this mouse offers. */
+    getPowerModes(): string[];
+    /**
+     * MCHOSE's mode selector — Performance, eSports or Ultra. It is a three-way
+     * choice, not a switch: the two bits live at the top of the same `sensor`
+     * byte as lift-off and the processing toggles.
+     */
+    setPowerMode(name: string): Promise<void>;
+    /** Angle tuning in degrees; 0 turns the correction off. */
+    setAngleTuning(degrees: number): Promise<void>;
+    /**
+     * How many of the six DPI stages the mouse cycles through. Stored in the
+     * config blob, so it goes through the ordinary read-modify-write.
+     */
+    setDpiStageCount(count: number): Promise<void>;
+    /**
+     * The three profile names the mouse stores. Read one at a time; a profile
+     * whose name will not come back is left out rather than guessed at, and the
+     * caller falls back to numbering.
+     */
+    private readProfileNames;
+    /**
+     * Name whichever buttons carry a macro. A macro's name is the only thing
+     * about it this driver can surface — recording one is not implemented — so
+     * labelling it beats showing a bare "Macro". Buttons without one answer with
+     * a zero-length name and are left alone.
+     */
+    private labelMacros;
+    /** Every action a button can be assigned, for the picker. */
+    getButtonOptions(): string[];
+    /**
+     * Reassign one button. This is a standalone command rather than part of the
+     * config blob, so it cannot disturb DPI, polling or the other buttons —
+     * confirmed on hardware, where only the target button's four bytes moved.
+     *
+     * "Default" restores the factory function, which is the firmware's own escape
+     * hatch (type 0 with a zero value).
+     */
+    setButtonMapping(button: string, actionLabel: string): Promise<void>;
+    /** Sleep timeouts this driver offers, in seconds. 0 disables the timer. */
+    getSleepOptions(): number[];
+    getDebounceMaxMs(): number;
+    /** The firmware stores whole minutes; the panel works in seconds. */
+    setSleepTimeout(seconds: number): Promise<void>;
+    /** Debounce rides along in the config blob rather than its own command. */
+    setDebounceTime(milliseconds: number): Promise<void>;
+    /** Sets the DPI of whichever stage the live connection is using. */
+    setDpi(dpi: number): Promise<void>;
+}
+//# sourceMappingURL=hid.d.ts.map

package/dist/drivers/mchose/hid.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"hid.d.ts","sourceRoot":"","sources":["../../../src/drivers/mchose/hid.ts"],"names":[],"mappings":"AA6CA,OAAO,KAAK,EAAE,WAAW,EAAE,MAAM,mBAAmB,CAAC;AAuCrD,qBAAa,eAAe;IAC1B,QAAQ,CAAC,MAAM,EAAE,SAAS,CAAC;IAE3B,OAAO,CAAC,KAAK,CAAuC;IACpD,OAAO,CAAC,aAAa,CAA8C;gBAEvD,MAAM,EAAE,SAAS;IAI7B,MAAM,CAAC,WAAW,CAAC,MAAM,EAAE,SAAS,GAAG,OAAO;IAiBxC,IAAI,IAAI,OAAO,CAAC,IAAI,CAAC;IAIrB,KAAK,IAAI,OAAO,CAAC,IAAI,CAAC;IAI5B,8EAA8E;IACxE,kBAAkB,IAAI,OAAO,CAAC,OAAO,CAAC;IAI5C,WAAW,IAAI,MAAM;IAMrB,UAAU,IAAI,OAAO;IAIrB;;;;OAIG;IACH,OAAO,CAAC,OAAO;IAIf;;;;;;;;OAQG;IACH,OAAO,CAAC,OAAO;IAkCf,OAAO,CAAC,OAAO;IAKf,mEAAmE;IACnE,OAAO,CAAC,MAAM,CAAC,eAAe;IAM9B,OAAO,CAAC,iBAAiB;IASzB;;;;OAIG;YACW,YAAY;IAuB1B,OAAO,CAAC,SAAS;IAIX,UAAU,IAAI,OAAO,CAAC,WAAW,CAAC;IA+FxC,2EAA2E;IAC3E,aAAa,IAAI,MAAM,EAAE;IAMnB,cAAc,CAAC,KAAK,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC;IAU5C,iBAAiB,CAAC,KAAK,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC;IAU/C,gBAAgB,CAAC,KAAK,EAAE,MAAM,EAAE,GAAG,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC;IAoBjE;;;;;;;;OAQG;IACG,UAAU,CAAC,OAAO,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC;IAsBlD;;;;SAIK;YACW,gBAAgB;IAoC9B,+EAA+E;YACjE,mBAAmB;IAO3B,kBAAkB,CAAC,KAAK,EAAE,WAAW,CAAC,WAAW,CAAC,iBAAiB,CAAC,CAAC,GAAG,OAAO,CAAC,IAAI,CAAC;IAUrF,aAAa,CAAC,OAAO,EAAE,OAAO,GAAG,OAAO,CAAC,IAAI,CAAC;IAO9C,gBAAgB,CAAC,OAAO,EAAE,OAAO,GAAG,OAAO,CAAC,IAAI,CAAC;IAOjD,gBAAgB,CAAC,OAAO,EAAE,OAAO,GAAG,OAAO,CAAC,IAAI,CAAC;IAOvD,2DAA2D;IAC3D,aAAa,IAAI,MAAM,EAAE;IAIzB;;;;OAIG;IACG,YAAY,CAAC,IAAI,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC;IAW/C,2DAA2D;IACrD,cAAc,CAAC,OAAO,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC;IAWpD;;;OAGG;IACG,gBAAgB,CAAC,KAAK,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC;IAUpD;;;;OAIG;YACW,gBAAgB;IAiB9B;;;;;OAKG;YACW,WAAW;IAezB,6DAA6D;IAC7D,gBAAgB,IAAI,MAAM,EAAE;IAI5B;;;;;;;OAOG;IACG,gBAAgB,CAAC,MAAM,EAAE,MAAM,EAAE,WAAW,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC;IA0B1E,2EAA2E;IAC3E,eAAe,IAAI,MAAM,EAAE;IAI3B,gBAAgB,IAAI,MAAM;IAI1B,qEAAqE;IAC/D,eAAe,CAAC,OAAO,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC;IAkBrD,2EAA2E;IACrE,eAAe,CAAC,YAAY,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC;IAU1D,oEAAoE;IAC9D,MAAM,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC;CASzC"}