@openmouse/protocol 0.1.0

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

@@ -0,0 +1,109 @@
+import type { MouseStatus } from "../mouse-types.ts";
+export declare class MchoseV3HidClient {
+    readonly device: HIDDevice;
+    private queue;
+    /**
+     * Set once a command has exhausted its retries, and cleared at the top of
+     * every status read. A status is six commands, so without this a mouse that
+     * is off or out of range costs six full retry budgets — long enough to look
+     * like the app has hung. One silent command is enough to conclude nothing is
+     * listening; the next poll gets a clean try.
+     */
+    private unresponsive;
+    /** Resolved once per session; every range check needs the model's limits. */
+    private cachedProduct;
+    /**
+     * Set when the device answered "ask again" rather than with data. It means
+     * the receiver is plugged in but the mouse behind it is not reachable, which
+     * is a different thing to tell the user than "nothing answered".
+     */
+    private linkBusy;
+    constructor(device: HIDDevice);
+    static isSupported(device: HIDDevice): boolean;
+    open(): Promise<void>;
+    close(): Promise<void>;
+    /** Nothing here subscribes to unsolicited state. */
+    startNotifications(): Promise<boolean>;
+    displayName(): string;
+    /** Wired when the host is talking to the mouse rather than to a receiver. */
+    private isWired;
+    /**
+     * Send one command and wait for the reply carrying the same id.
+     *
+     * Replies arrive as input reports rather than as the answer to a read, so
+     * the listener goes on before the write and the id match is what pairs them
+     * up — the mouse also pushes movement and battery reports down this pipe.
+     */
+    private request;
+    /** One send-and-wait, classifying whatever comes back. */
+    private attempt;
+    private readDeviceInfo;
+    private readSettings;
+    /**
+     * `0x0901` takes a target byte: 0 for the mouse, 1 for the receiver. Sent
+     * without one it answers with an **empty** data block rather than an error,
+     * which is how the first hardware capture came back with no firmware at all.
+     */
+    private readVersion;
+    /**
+     * Lift-off sits in two places depending on the model: the five-step ladders
+     * do not fit the sensor byte's two bits, so those models answer `0x0009`
+     * instead.
+     */
+    private readLiftOffIndex;
+    getDpiOptions(): number[];
+    /** Sleep timeouts this driver offers, in seconds. 0 disables the timer. */
+    getSleepOptions(): number[];
+    getDebounceMaxMs(): number;
+    /** Send a write and give the firmware time to commit before reading back. */
+    private write;
+    /** The model, needed for every range check. Resolved the same way as status. */
+    private resolveProduct;
+    /**
+     * Read the settings block, apply `edit` to it, write it back and return what
+     * the mouse reports afterwards.
+     */
+    private updateSettings;
+    setPollingRate(hertz: number): Promise<void>;
+    setSleepTimeout(seconds: number): Promise<void>;
+    /**
+     * Both primary buttons move together. The firmware keeps them separately and
+     * the shell offers one control, so writing only the left would leave the
+     * right on a value the user cannot see or change.
+     */
+    setDebounceTime(ms: number): Promise<void>;
+    setAngleTuning(degrees: number): Promise<void>;
+    setProfile(oneBased: number): Promise<void>;
+    setPowerMode(name: string): Promise<void>;
+    private setSensor;
+    private setProcessing;
+    setMotionSync(enabled: boolean): Promise<void>;
+    setAngleSnapping(enabled: boolean): Promise<void>;
+    setRippleControl(enabled: boolean): Promise<void>;
+    setGlassMode(enabled: boolean): Promise<void>;
+    /**
+     * Lift-off lives in two places depending on the model, and the write has to
+     * follow the read: the five-step ladders do not fit the sensor byte's two
+     * bits and answer `0x0109` instead.
+     */
+    setLiftOffDistance(label: string): Promise<void>;
+    /** Read the DPI table for the profile in use, so a write can edit it. */
+    private readDpiTable;
+    private updateDpiTable;
+    /** Change the stage currently in use, which is what the DPI box edits. */
+    setDpi(dpi: number): Promise<void>;
+    setDpiStageValue(stage: number, dpi: number): Promise<void>;
+    setActiveDpiStage(stage: number): Promise<void>;
+    setDpiStageCount(count: number): Promise<void>;
+    /**
+     * Reassign one button, leaving the other five exactly as they were read.
+     *
+     * The vocabulary comes from M HUB's own action tables — see
+     * `src/mchose/v3-buttons.ts` — so nothing here is a guess at what a value
+     * means. What has not been verified is the firmware accepting the write,
+     * which is why the read-back below decides whether it worked.
+     */
+    setButtonMapping(button: string, action: string): Promise<void>;
+    readStatus(): Promise<MouseStatus>;
+}
+//# sourceMappingURL=v3-hid.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"v3-hid.d.ts","sourceRoot":"","sources":["../../../src/drivers/mchose/v3-hid.ts"],"names":[],"mappings":"AA2CA,OAAO,KAAK,EAAE,WAAW,EAAE,MAAM,mBAAmB,CAAC;AAsFrD,qBAAa,iBAAiB;IAC5B,QAAQ,CAAC,MAAM,EAAE,SAAS,CAAC;IAE3B,OAAO,CAAC,KAAK,CAAuC;IAEpD;;;;;;OAMG;IACH,OAAO,CAAC,YAAY,CAAS;IAE7B,6EAA6E;IAC7E,OAAO,CAAC,aAAa,CAAgC;IAErD;;;;OAIG;IACH,OAAO,CAAC,QAAQ,CAAS;gBAEb,MAAM,EAAE,SAAS;IAI7B,MAAM,CAAC,WAAW,CAAC,MAAM,EAAE,SAAS,GAAG,OAAO;IAWxC,IAAI,IAAI,OAAO,CAAC,IAAI,CAAC;IAIrB,KAAK,IAAI,OAAO,CAAC,IAAI,CAAC;IAI5B,oDAAoD;IAC9C,kBAAkB,IAAI,OAAO,CAAC,OAAO,CAAC;IAI5C,WAAW,IAAI,MAAM;IAIrB,6EAA6E;IAC7E,OAAO,CAAC,OAAO;IAIf;;;;;;OAMG;IACH,OAAO,CAAC,OAAO;IAoCf,0DAA0D;IAC1D,OAAO,CAAC,OAAO;YAwBD,cAAc;YAKd,YAAY;IAK1B;;;;OAIG;YACW,WAAW;IASzB;;;;OAIG;YACW,gBAAgB;IAW9B,aAAa,IAAI,MAAM,EAAE;IAIzB,2EAA2E;IAC3E,eAAe,IAAI,MAAM,EAAE;IAI3B,gBAAgB,IAAI,MAAM;IAa1B,6EAA6E;YAC/D,KAAK;IAWnB,gFAAgF;YAClE,cAAc;IAS5B;;;OAGG;YACW,cAAc;IAmBtB,cAAc,CAAC,KAAK,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC;IAe5C,eAAe,CAAC,OAAO,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC;IAUrD;;;;OAIG;IACG,eAAe,CAAC,EAAE,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC;IAQ1C,cAAc,CAAC,OAAO,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC;IAK9C,UAAU,CAAC,QAAQ,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC;IAM3C,YAAY,CAAC,IAAI,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC;IAS/C,OAAO,CAAC,SAAS;YAQH,aAAa;IAU3B,aAAa,CAAC,OAAO,EAAE,OAAO,GAAG,OAAO,CAAC,IAAI,CAAC;IAC9C,gBAAgB,CAAC,OAAO,EAAE,OAAO,GAAG,OAAO,CAAC,IAAI,CAAC;IACjD,gBAAgB,CAAC,OAAO,EAAE,OAAO,GAAG,OAAO,CAAC,IAAI,CAAC;IACjD,YAAY,CAAC,OAAO,EAAE,OAAO,GAAG,OAAO,CAAC,IAAI,CAAC;IAE7C;;;;OAIG;IACG,kBAAkB,CAAC,KAAK,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC;IAyBtD,yEAAyE;YAC3D,YAAY;YAaZ,cAAc;IAU5B,0EAA0E;IACpE,MAAM,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC;IASlC,gBAAgB,CAAC,KAAK,EAAE,MAAM,EAAE,GAAG,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC;IAO3D,iBAAiB,CAAC,KAAK,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC;IAK/C,gBAAgB,CAAC,KAAK,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC;IASpD;;;;;;;OAOG;IACG,gBAAgB,CAAC,MAAM,EAAE,MAAM,EAAE,MAAM,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC;IA8B/D,UAAU,IAAI,OAAO,CAAC,WAAW,CAAC;CA6GzC"}