@openmouse/protocol 0.1.0

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

@@ -0,0 +1,163 @@
+import type { MouseStatus } from "../mouse-types.ts";
+import { type AtkProduct } from "./products.ts";
+type LiftOffDistance = NonNullable<MouseStatus["liftOffDistance"]>;
+export declare class AtkHidClient {
+    readonly canDisableSleep = false;
+    readonly device: HIDDevice;
+    private queue;
+    private lastStatus;
+    private product;
+    private identified;
+    private identifyAttempts;
+    constructor(device: HIDDevice);
+    static isSupported(device: HIDDevice): boolean;
+    open(): Promise<void>;
+    close(): Promise<void>;
+    /** ATK broadcasts are undocumented; the panel falls back to polling. */
+    startNotifications(): Promise<boolean>;
+    displayName(): string;
+    deviceBrand(): AtkProduct["brand"];
+    /**
+     * A wired A9 still reports a battery level, so the receiver is identified by
+     * its own product string instead: "ATK Nearlink Mouse Dongle" against the
+     * mouse's own "ATK A9 PLUS 2.0 NK".
+     */
+    isWireless(): boolean;
+    /** VXE R1-family devices using the shared EEPROM command framing. */
+    isR1(): boolean;
+    maxDpi(): number;
+    getSleepOptions(): readonly number[];
+    getDebounceMaxMs(): number;
+    getDebounceOptions(): readonly number[];
+    getSupportedPollingRates(): number[];
+    /**
+     * The encoding steps by 10 DPI, then 50 above 10,000 and 100 above 30,000.
+     * Models top out below 42,000; writes are confirmed by reading back.
+     */
+    getDpiOptions(): number[];
+    readStatus(live?: boolean): Promise<MouseStatus>;
+    /** Read the active R1 profile and its six button records without changing either. */
+    readR1StoredConfiguration(): Promise<{
+        activeProfile: number;
+        buttons: NonNullable<MouseStatus["atkButtonMappings"]>;
+    }>;
+    /** Select one of the four verified R1 banks and require readback. */
+    setR1ActiveProfile(profile: number): Promise<number>;
+    /** Read receiver online/RF identity and pairing countdown; this never starts pairing. */
+    readR1ReceiverInfo(): Promise<NonNullable<MouseStatus["atkReceiver"]>>;
+    /** Start receiver pairing for one exact CID/MID; callers must poll telemetry for completion. */
+    startR1ReceiverPairing(cid: number, mid: number): Promise<void>;
+    setPollingRate(pollingRateHz: number): Promise<number>;
+    setDpi(dpi: number, dpiY?: number): Promise<number>;
+    setDpiStageCount(count: number): Promise<number>;
+    setActiveDpiStage(index: number): Promise<number>;
+    setDpiStageValue(index: number, dpi: number): Promise<number>;
+    setDpiStageColor(index: number, color: string): Promise<string>;
+    setPerformanceMode(enabled: boolean): Promise<boolean>;
+    setLongRangeMode(enabled: boolean): Promise<boolean>;
+    setDpiLighting(mode: number, brightness: number, speed: number): Promise<void>;
+    setLiftOffDistance(value: LiftOffDistance): Promise<LiftOffDistance>;
+    setLiftOffScale(code: number): Promise<number>;
+    setMotionSync(enabled: boolean): Promise<boolean>;
+    setRippleControl(enabled: boolean): Promise<boolean>;
+    setAngleSnapping(enabled: boolean): Promise<boolean>;
+    setDebounceTime(milliseconds: number): Promise<number>;
+    setSleepTimeout(seconds: number): Promise<number>;
+    private setAdvancedFlag;
+    /** The advanced block is written whole, so read it back, patch one pair, write. */
+    private writeAdvanced;
+    /**
+     * F58A DPI stage colours are stored as two 4-byte colour records per
+     * 8-byte EEPROM group, matching the captured receiver write/echo path.
+     */
+    private writeR1ProMaxReceiverDpiColorGroup;
+    /**
+     * F58A DPI lighting uses the same complete 8-byte 0x004c row as wired.
+     */
+    private writeR1ProMaxReceiverDpiLighting;
+    private readR1Extras;
+    private decodeR1DpiLighting;
+    private readLongRangeMode;
+    /**
+     * F58A Performance Mode uses the same 6-byte 0x00b5 row as wired, but
+     * receiver writes are enabled only after their write/echo path was captured.
+     */
+    private writeR1ProMaxReceiverPerformanceBlock;
+    private writeR1PerformanceBlock;
+    private dpiAddress;
+    private readDpiStage;
+    private stageIndex;
+    private stageCount;
+    private decodePollingRate;
+    private decodeLiftOffDistance;
+    private supportsLiftOffScale;
+    private liftOffScale;
+    private decodeAngle;
+    /**
+     * R1 polling comes from the live-settings row at 0x0070, not the A9 system
+     * block (whose first pair is a link-mode byte on this family). A stock row
+     * may be unpopulated, so fall back to the receiver's ceiling when unknown.
+     */
+    private readPollingRate;
+    /**
+     * The R1 applies the write through its live-settings row (OpenVXE sends it
+     * fire-and-forget), so confirmation stays optimistic rather than erroring on
+     * a register that may not echo what was applied.
+     */
+    private setR1PollingRate;
+    /** The R1's lift-off levels are 1 mm and 2 mm, applied through the live-settings row. */
+    private setR1LiftOffDistance;
+    private setR1DebounceTime;
+    private setR1AngleSnapping;
+    private patch;
+    private hasValidChecksum;
+    private readR1CurrentProfile;
+    private identify;
+    private usesSharedR1Transport;
+    /** Only the SE/SE+ receiver family uses the selector-based 0x0070 live row. */
+    private usesR1LiveSettings;
+    private isR1ProMax;
+    private usesVerifiedR1ProMaxReceiverTransport;
+    /**
+     * Wired F58C and receiver F58A expose the same R1 Pro Max settings surface.
+     * This predicate is for reads/UI only; write paths remain individually gated.
+     */
+    private usesR1ProMaxUiTransport;
+    private usesVerifiedR1WiredTransport;
+    /**
+     * Command 0x12 (GetMouseVersion) reports the version as BCD, matching the
+     * Endgame Gear siblings: an A9 Nearlink dongle answering 0x01 0x23 is 1.23.
+     */
+    private readFirmware;
+    private readBattery;
+    private read;
+    private write;
+    /**
+     * F58A advanced settings are written as the complete 10-byte EEPROM row.
+     * Callers remain individually gated until each field is hardware-verified.
+     */
+    private writeR1ProMaxReceiverAdvanced;
+    /**
+     * The F58A vendor path writes LOD as one checksum-protected scalar pair at
+     * EEPROM 0x000a and echoes the committed pair back on report 0x08.
+     */
+    private writeR1ProMaxReceiverLiftOffDistance;
+    /**
+     * ATK Hub writes F58A DPI records as an 8-byte pair of adjacent stages.
+     * Preserve the neighbouring stage and require the receiver to echo the
+     * complete group before the normal DPI readback confirms the active stage.
+     */
+    private writeR1ProMaxReceiverDpiStage;
+    /**
+     * The verified F58A polling path writes the complete system row and echoes
+     * the committed row back on report 0x08. No other receiver EEPROM writes
+     * are enabled through this helper.
+     */
+    private writeR1ProMaxReceiverSystem;
+    private send;
+    /** Send a frame and resolve with the first input report the matcher accepts. */
+    private exchange;
+    private run;
+}
+export {};
+//# sourceMappingURL=hid.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"hid.d.ts","sourceRoot":"","sources":["../../../src/drivers/atk/hid.ts"],"names":[],"mappings":"AASA,OAAO,KAAK,EAAE,WAAW,EAAE,MAAM,mBAAmB,CAAC;AA+BrD,OAAO,EAAE,KAAK,UAAU,EAAuC,MAAM,eAAe,CAAC;AA+ErF,KAAK,eAAe,GAAG,WAAW,CAAC,WAAW,CAAC,iBAAiB,CAAC,CAAC,CAAC;AAenE,qBAAa,YAAY;IAEvB,QAAQ,CAAC,eAAe,SAAS;IAEjC,QAAQ,CAAC,MAAM,EAAE,SAAS,CAAC;IAE3B,OAAO,CAAC,KAAK,CAAuC;IACpD,OAAO,CAAC,UAAU,CAA4B;IAC9C,OAAO,CAAC,OAAO,CAA2B;IAC1C,OAAO,CAAC,UAAU,CAAS;IAC3B,OAAO,CAAC,gBAAgB,CAAK;gBAEjB,MAAM,EAAE,SAAS;IAI7B,MAAM,CAAC,WAAW,CAAC,MAAM,EAAE,SAAS,GAAG,OAAO;IASxC,IAAI,IAAI,OAAO,CAAC,IAAI,CAAC;IAIrB,KAAK,IAAI,OAAO,CAAC,IAAI,CAAC;IAQ5B,wEAAwE;IAClE,kBAAkB,IAAI,OAAO,CAAC,OAAO,CAAC;IAI5C,WAAW,IAAI,MAAM;IAOrB,WAAW,IAAI,UAAU,CAAC,OAAO,CAAC;IAIlC;;;;OAIG;IACH,UAAU,IAAI,OAAO;IAQrB,qEAAqE;IACrE,IAAI,IAAI,OAAO;IAKf,MAAM,IAAI,MAAM;IAIhB,eAAe,IAAI,SAAS,MAAM,EAAE;IAIpC,gBAAgB,IAAI,MAAM;IAI1B,kBAAkB,IAAI,SAAS,MAAM,EAAE;IASvC,wBAAwB,IAAI,MAAM,EAAE;IAQpC;;;OAGG;IACH,aAAa,IAAI,MAAM,EAAE;IASnB,UAAU,CAAC,IAAI,UAAQ,GAAG,OAAO,CAAC,WAAW,CAAC;IAgGpD,qFAAqF;IAC/E,yBAAyB,IAAI,OAAO,CAAC;QACzC,aAAa,EAAE,MAAM,CAAC;QACtB,OAAO,EAAE,WAAW,CAAC,WAAW,CAAC,mBAAmB,CAAC,CAAC,CAAC;KACxD,CAAC;IAgCF,qEAAqE;IAC/D,kBAAkB,CAAC,OAAO,EAAE,MAAM,GAAG,OAAO,CAAC,MAAM,CAAC;IAmC1D,yFAAyF;IACnF,kBAAkB,IAAI,OAAO,CAAC,WAAW,CAAC,WAAW,CAAC,aAAa,CAAC,CAAC,CAAC;IAyB5E,gGAAgG;IAC1F,sBAAsB,CAAC,GAAG,EAAE,MAAM,EAAE,GAAG,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC;IAY/D,cAAc,CAAC,aAAa,EAAE,MAAM,GAAG,OAAO,CAAC,MAAM,CAAC;IAwBtD,MAAM,CAAC,GAAG,EAAE,MAAM,EAAE,IAAI,GAAE,MAAY,GAAG,OAAO,CAAC,MAAM,CAAC;IA0BxD,gBAAgB,CAAC,KAAK,EAAE,MAAM,GAAG,OAAO,CAAC,MAAM,CAAC;IAsDhD,iBAAiB,CAAC,KAAK,EAAE,MAAM,GAAG,OAAO,CAAC,MAAM,CAAC;IA2DjD,gBAAgB,CAAC,KAAK,EAAE,MAAM,EAAE,GAAG,EAAE,MAAM,GAAG,OAAO,CAAC,MAAM,CAAC;IA0C7D,gBAAgB,CAAC,KAAK,EAAE,MAAM,EAAE,KAAK,EAAE,MAAM,GAAG,OAAO,CAAC,MAAM,CAAC;IAiC/D,kBAAkB,CAAC,OAAO,EAAE,OAAO,GAAG,OAAO,CAAC,OAAO,CAAC;IAiBtD,gBAAgB,CAAC,OAAO,EAAE,OAAO,GAAG,OAAO,CAAC,OAAO,CAAC;IAoCpD,cAAc,CAAC,IAAI,EAAE,MAAM,EAAE,UAAU,EAAE,MAAM,EAAE,KAAK,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC;IAuD9E,kBAAkB,CAAC,KAAK,EAAE,eAAe,GAAG,OAAO,CAAC,eAAe,CAAC;IAqBpE,eAAe,CAAC,IAAI,EAAE,MAAM,GAAG,OAAO,CAAC,MAAM,CAAC;IAiB9C,aAAa,CAAC,OAAO,EAAE,OAAO,GAAG,OAAO,CAAC,OAAO,CAAC;IAsBjD,gBAAgB,CAAC,OAAO,EAAE,OAAO,GAAG,OAAO,CAAC,OAAO,CAAC;IAsBpD,gBAAgB,CAAC,OAAO,EAAE,OAAO,GAAG,OAAO,CAAC,OAAO,CAAC;IAoCpD,eAAe,CAAC,YAAY,EAAE,MAAM,GAAG,OAAO,CAAC,MAAM,CAAC;IAkBtD,eAAe,CAAC,OAAO,EAAE,MAAM,GAAG,OAAO,CAAC,MAAM,CAAC;YAsBzC,eAAe;IAY7B,mFAAmF;YACrE,aAAa;IAO3B;;;OAGG;YACW,kCAAkC;IAqChD;;OAEG;YACW,gCAAgC;YAiChC,YAAY;IAsC1B,OAAO,CAAC,mBAAmB;YAuCb,iBAAiB;IAS/B;;;OAGG;YACW,qCAAqC;YAwCrC,uBAAuB;IAWrC,OAAO,CAAC,UAAU;YAQJ,YAAY;IAU1B,OAAO,CAAC,UAAU;IAKlB,OAAO,CAAC,UAAU;IAKlB,OAAO,CAAC,iBAAiB;IAMzB,OAAO,CAAC,qBAAqB;IAQ7B,OAAO,CAAC,oBAAoB;IAI5B,OAAO,CAAC,YAAY;IAapB,OAAO,CAAC,WAAW;IAInB;;;;OAIG;YACW,eAAe;IAS7B;;;;OAIG;YACW,gBAAgB;IAU9B,yFAAyF;YAC3E,oBAAoB;YASpB,iBAAiB;YAajB,kBAAkB;IAUhC,OAAO,CAAC,KAAK;IAIb,OAAO,CAAC,gBAAgB;YAKV,oBAAoB;YAWpB,QAAQ;IAuBtB,OAAO,CAAC,qBAAqB;IAM7B,+EAA+E;IAC/E,OAAO,CAAC,kBAAkB;IAM1B,OAAO,CAAC,UAAU;IAIlB,OAAO,CAAC,qCAAqC;IAM7C;;;OAGG;IACH,OAAO,CAAC,uBAAuB;IAK/B,OAAO,CAAC,4BAA4B;IAMpC;;;OAGG;YACW,YAAY;YAYZ,WAAW;YAmBX,IAAI;YAaJ,KAAK;IAgBnB;;;OAGG;YACW,6BAA6B;IAuC3C;;;OAGG;YACW,oCAAoC;IA+BlD;;;;OAIG;YACW,6BAA6B;IA8C3C;;;;OAIG;YACW,2BAA2B;YA4B3B,IAAI;IAOlB,gFAAgF;YAClE,QAAQ;YA4BR,GAAG;CAKlB"}