@openmouse/protocol 0.1.0

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

@@ -0,0 +1,86 @@
+import type { MouseStatus } from "../mouse-types.ts";
+import { type WootingAnalogKey } from "@openmouse/protocol/wooting";
+export declare class WootingHidClient {
+    readonly device: HIDDevice;
+    private responseWaiter;
+    private responseTimer;
+    private readonly replies;
+    private commandLock;
+    private collecting;
+    private readonly onInputReport;
+    private listening;
+    constructor(device: HIDDevice);
+    /**
+     * Wooting VID plus the command-capable config collection: usage page `0xFF55`,
+     * usage `0x01`. Only this collection is matched — a board also presents a
+     * legacy `0xFF00` collection and the `0xFF53` analog stream, and matching those
+     * would list the same physical keyboard several times.
+     */
+    static isSupported(device: HIDDevice): boolean;
+    /** The command-capable config collection, if this device exposes one. */
+    private static configCollection;
+    /**
+     * Part of the shared client contract the control panel calls on every device.
+     * A keyboard exposes no mouse DPI, so there are no options to offer.
+     */
+    getDpiOptions(): number[];
+    open(): Promise<void>;
+    close(): Promise<void>;
+    /**
+     * Subscribe to the live analog key stream. The 60HE+ pushes a full snapshot of
+     * the currently-pressed keys as input reports on its analog interface (0xFF53,
+     * a sibling of the config interface). Opens that interface, forwards each
+     * decoded frame to `onFrame`, and resolves to a stop function that detaches the
+     * listener. Rejects if the analog interface is not available to the page.
+     */
+    startAnalog(onFrame: (keys: WootingAnalogKey[]) => void): Promise<() => void>;
+    /** The sibling analog-stream interface (same board, usage page 0xFF53). */
+    private analogDevice;
+    readStatus(): Promise<MouseStatus>;
+    /**
+     * Best-effort live read of a command's raw reply, attempted once per connection
+     * and then cached. Never throws: on any failure it returns null, the caller
+     * falls back to whatever it has, and the failure is remembered so a background
+     * refresh does not try (and fail) the write again.
+     */
+    private command;
+    /**
+     * Live (uncached) read of the connected profile's actuation / rapid-trigger
+     * settings: the current profile index plus the raw analog-profile "main part"
+     * reply, for the analog UI to decode.
+     */
+    readAnalogProfile(): Promise<{
+        index: number | null;
+        reports: Uint8Array[];
+        note: string;
+    }>;
+    /**
+     * Send a command and gather every input report it triggers within a short
+     * window. `viaOutput` chooses Wootility's output-report channel (id 2) versus
+     * the feature-report channel.
+     */
+    private collectCommand;
+    /** Serialize command sends so overlapping callers never share the reply channel. */
+    private sendCommand;
+    /**
+     * Send a command on the config interface's declared feature report and read the
+     * reply. The 60HE+ answers with the multi-report magic (0xD1), so commands go
+     * out in that form. The answer arrives as an input report (matching Wooting's
+     * own tooling); a feature GET is tried only as a fallback. Returns the raw
+     * reply for the matching command, or null if nothing usable came back.
+     */
+    private probeCommand;
+    /** Report id of the config collection's declared feature report (0 if none). */
+    private featureReportId;
+    /** Resolve with the next input report, or reject on timeout. */
+    private nextInputReport;
+    private clearPendingRead;
+    /**
+     * Turn the command replies into readable lines. Decoded fields (firmware
+     * version, layout) are shown on their own; a raw hex preview appears only as a
+     * fallback when a reply could not be decoded, so a fully-decoded board reads as
+     * a clean two-line card rather than a debug dump.
+     */
+    private firmwareLines;
+}
+//# sourceMappingURL=hid.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"hid.d.ts","sourceRoot":"","sources":["../../../src/drivers/wooting/hid.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,WAAW,EAAE,MAAM,mBAAmB,CAAC;AACrD,OAAO,EAUL,KAAK,gBAAgB,EAOtB,MAAM,6BAA6B,CAAC;AAsBrC,qBAAa,gBAAgB;IAC3B,QAAQ,CAAC,MAAM,EAAE,SAAS,CAAC;IAE3B,OAAO,CAAC,cAAc,CAAwF;IAC9G,OAAO,CAAC,aAAa,CAA8C;IAKnE,OAAO,CAAC,QAAQ,CAAC,OAAO,CAAwC;IAIhE,OAAO,CAAC,WAAW,CAAuC;IAI1D,OAAO,CAAC,UAAU,CAA6B;IAE/C,OAAO,CAAC,QAAQ,CAAC,aAAa,CAY5B;IAEF,OAAO,CAAC,SAAS,CAAS;gBAEd,MAAM,EAAE,SAAS;IAI7B;;;;;OAKG;IACH,MAAM,CAAC,WAAW,CAAC,MAAM,EAAE,SAAS,GAAG,OAAO;IAM9C,yEAAyE;IACzE,OAAO,CAAC,MAAM,CAAC,gBAAgB;IAc/B;;;OAGG;IACH,aAAa,IAAI,MAAM,EAAE;IAInB,IAAI,IAAI,OAAO,CAAC,IAAI,CAAC;IAQrB,KAAK,IAAI,OAAO,CAAC,IAAI,CAAC;IAQ5B;;;;;;OAMG;IACG,WAAW,CAAC,OAAO,EAAE,CAAC,IAAI,EAAE,gBAAgB,EAAE,KAAK,IAAI,GAAG,OAAO,CAAC,MAAM,IAAI,CAAC;IAgBnF,2EAA2E;YAC7D,YAAY;IAYpB,UAAU,IAAI,OAAO,CAAC,WAAW,CAAC;IAkCxC;;;;;OAKG;YACW,OAAO;IAOrB;;;;OAIG;IACG,iBAAiB,IAAI,OAAO,CAAC;QAAE,KAAK,EAAE,MAAM,GAAG,IAAI,CAAC;QAAC,OAAO,EAAE,UAAU,EAAE,CAAC;QAAC,IAAI,EAAE,MAAM,CAAA;KAAE,CAAC;IAuBjG;;;;OAIG;YACW,cAAc;IAwB5B,oFAAoF;YACtE,WAAW;IAMzB;;;;;;OAMG;YACW,YAAY;IA4B1B,gFAAgF;IAChF,OAAO,CAAC,eAAe;IAKvB,gEAAgE;IAChE,OAAO,CAAC,eAAe;IAYvB,OAAO,CAAC,gBAAgB;IAQxB;;;;;OAKG;IACH,OAAO,CAAC,aAAa;CAmBtB"}

package/dist/drivers/wooting/hid.js

@@ -0,0 +1,320 @@
+import { decodeWootingAnalogReport, decodeWootingDeviceConfig, decodeWootingVersion, encodeWootingCommand, isWootingReply, wootingFeatureReport, wootingProductName, WOOTING_MAGIC_MULTI, WOOTING_MAGIC_WORD_1, WOOTING_ANALOG_USAGE_PAGE, WOOTING_COMMAND, WOOTING_CONFIG_USAGE, WOOTING_CONFIG_USAGE_PAGE, WOOTING_PRODUCTS, WOOTING_VENDOR_ID, } from "@openmouse/protocol/wooting";
+/**
+ * Wooting analog keyboard (60HE+) read-only WebHID control — stage one.
+ *
+ * OpenMouse is a mouse control panel, so a keyboard has no home in the settings
+ * grid. This driver's job is narrow and honest: recognise a supported Wooting
+ * board, connect to its vendor config interface, and report what it is. It sets
+ * `ui.settingsReady = false` so the mouse settings grid stays hidden, and it
+ * exposes no setters, so nothing here can change a key, curve, or profile.
+ *
+ * Device identity always succeeds — it comes from the `HIDDevice` metadata. The
+ * live device-config read is best-effort: the 60HE+ config interface declares
+ * only an input report, so whether the browser permits the outgoing feature
+ * report is hardware/Chrome-specific. When it is not permitted the driver still
+ * connects and identifies the board; it just omits the live layout line.
+ */
+const CONFIG_RESPONSE_TIMEOUT_MS = 400;
+/** How long to gather input reports for a multi-report reply (ack + data). */
+const COLLECT_WINDOW_MS = 130;
+export class WootingHidClient {
+    device;
+    responseWaiter = null;
+    responseTimer = null;
+    // Each command's raw reply is read once per connection and cached, so a
+    // failure (or a device that just will not answer) never re-spams writes on
+    // every background refresh.
+    replies = new Map();
+    // Serializes command sends so a profile read and a status refresh never share
+    // the single input-report reply channel at the same time.
+    commandLock = Promise.resolve();
+    // When set, input reports are accumulated here instead of resolving a single
+    // waiter — used to gather a multi-report reply (ack + data) for one command.
+    collecting = null;
+    onInputReport = (event) => {
+        const bytes = new Uint8Array(event.data.buffer.slice(event.data.byteOffset, event.data.byteOffset + event.data.byteLength));
+        if (this.collecting) {
+            this.collecting.push(bytes);
+            return;
+        }
+        const waiter = this.responseWaiter;
+        if (!waiter)
+            return;
+        this.clearPendingRead();
+        waiter.resolve(bytes);
+    };
+    listening = false;
+    constructor(device) {
+        this.device = device;
+    }
+    /**
+     * Wooting VID plus the command-capable config collection: usage page `0xFF55`,
+     * usage `0x01`. Only this collection is matched — a board also presents a
+     * legacy `0xFF00` collection and the `0xFF53` analog stream, and matching those
+     * would list the same physical keyboard several times.
+     */
+    static isSupported(device) {
+        if (device.vendorId !== WOOTING_VENDOR_ID)
+            return false;
+        if (!WOOTING_PRODUCTS.has(device.productId))
+            return false;
+        return WootingHidClient.configCollection(device.collections) !== null;
+    }
+    /** The command-capable config collection, if this device exposes one. */
+    static configCollection(collections) {
+        for (const collection of collections) {
+            if (collection.usage === WOOTING_CONFIG_USAGE
+                && collection.usagePage === WOOTING_CONFIG_USAGE_PAGE) {
+                return collection;
+            }
+            const nested = WootingHidClient.configCollection(collection.children);
+            if (nested)
+                return nested;
+        }
+        return null;
+    }
+    /**
+     * Part of the shared client contract the control panel calls on every device.
+     * A keyboard exposes no mouse DPI, so there are no options to offer.
+     */
+    getDpiOptions() {
+        return [];
+    }
+    async open() {
+        if (!this.device.opened)
+            await this.device.open();
+        if (!this.listening) {
+            this.device.addEventListener("inputreport", this.onInputReport);
+            this.listening = true;
+        }
+    }
+    async close() {
+        if (this.listening) {
+            this.device.removeEventListener("inputreport", this.onInputReport);
+            this.listening = false;
+        }
+        if (this.device.opened)
+            await this.device.close();
+    }
+    /**
+     * Subscribe to the live analog key stream. The 60HE+ pushes a full snapshot of
+     * the currently-pressed keys as input reports on its analog interface (0xFF53,
+     * a sibling of the config interface). Opens that interface, forwards each
+     * decoded frame to `onFrame`, and resolves to a stop function that detaches the
+     * listener. Rejects if the analog interface is not available to the page.
+     */
+    async startAnalog(onFrame) {
+        const analog = await this.analogDevice();
+        if (!analog) {
+            throw new Error("This Wooting's analog interface is not available to OpenMouse.");
+        }
+        if (!analog.opened)
+            await analog.open();
+        const listener = (event) => {
+            const data = new Uint8Array(event.data.buffer.slice(event.data.byteOffset, event.data.byteOffset + event.data.byteLength));
+            onFrame(decodeWootingAnalogReport(data));
+        };
+        analog.addEventListener("inputreport", listener);
+        return () => analog.removeEventListener("inputreport", listener);
+    }
+    /** The sibling analog-stream interface (same board, usage page 0xFF53). */
+    async analogDevice() {
+        const hid = globalThis.navigator?.hid;
+        if (!hid)
+            return null;
+        const devices = await hid.getDevices();
+        return devices.find((device) => device.vendorId === WOOTING_VENDOR_ID
+            && device.productId === this.device.productId
+            && device.collections.some((collection) => collection.usagePage === WOOTING_ANALOG_USAGE_PAGE && collection.usage === WOOTING_CONFIG_USAGE)) ?? null;
+    }
+    async readStatus() {
+        await this.open();
+        // Sequential: each reply is awaited before the next command is sent, so the
+        // input-report answers never interleave.
+        const version = await this.command(WOOTING_COMMAND.getVersion);
+        const config = await this.command(WOOTING_COMMAND.getDeviceConfig);
+        return {
+            brand: "Wooting",
+            name: wootingProductName(this.device.productId),
+            ui: {
+                family: "wooting",
+                // Keyboard analog controls have no place in the mouse settings grid yet.
+                settingsReady: false,
+                defaultDisplayName: wootingProductName(this.device.productId),
+            },
+            batteryPercent: null,
+            batteryState: "Unknown",
+            // Placeholder mouse fields the shared status shape still requires; the grid
+            // is hidden, so these are never shown.
+            dpi: 0,
+            pollingRateHz: 0,
+            activeProfile: null,
+            connectionType: "Wired",
+            connectionDetail: "USB",
+            liftOffDistance: null,
+            firmware: this.firmwareLines(version, config),
+        };
+    }
+    // ---------------------------------------------------------------------------
+    // Report I/O
+    // ---------------------------------------------------------------------------
+    /**
+     * Best-effort live read of a command's raw reply, attempted once per connection
+     * and then cached. Never throws: on any failure it returns null, the caller
+     * falls back to whatever it has, and the failure is remembered so a background
+     * refresh does not try (and fail) the write again.
+     */
+    async command(commandId) {
+        if (this.replies.has(commandId))
+            return this.replies.get(commandId) ?? null;
+        const raw = await this.sendCommand(commandId).catch(() => null);
+        this.replies.set(commandId, raw);
+        return raw;
+    }
+    /**
+     * Live (uncached) read of the connected profile's actuation / rapid-trigger
+     * settings: the current profile index plus the raw analog-profile "main part"
+     * reply, for the analog UI to decode.
+     */
+    async readAnalogProfile() {
+        const indexReply = await this.sendCommand(WOOTING_COMMAND.getCurrentKeyboardProfileIndex).catch(() => null);
+        const index = indexReply && indexReply.length > 4 ? indexReply[4] : null;
+        // Send the profile-read command over Wootility's OUTPUT-report channel and
+        // collect whatever comes back. Surface exactly what happened for diagnosis.
+        // The parameter is an "optionalProfile" selector: qQ = (namespace << 8) | index
+        // in the low 16 bits (namespace enum: onboard=0, linked=1). We've confirmed the
+        // command/selector but not the exact CHANNEL + MAGIC. Wootility uses output
+        // reports with magic 0xD0 0xDA; our feature commands use 0xD1 0xDA. Sweep the
+        // combinations and keep whichever returns a real body. All read-only.
+        // get_keyboard_profile (0x27) carries the actuation (nested field 1 = mm × 20480)
+        // and rapid-trigger fields. Read it over the working channel (feature, magic
+        // 0xD1, current-profile selector 0xFFFF).
+        const command = new Uint8Array([
+            WOOTING_MAGIC_MULTI, WOOTING_MAGIC_WORD_1, WOOTING_COMMAND.getKeyboardProfile, 0xff, 0xff, 0x00, 0x00,
+        ]);
+        const reports = await this.collectCommand(command, false).catch(() => []);
+        const note = reports.some((report) => report.subarray(4).some((byte) => byte !== 0))
+            ? "get_keyboard_profile"
+            : "no body";
+        return { index, reports, note };
+    }
+    /**
+     * Send a command and gather every input report it triggers within a short
+     * window. `viaOutput` chooses Wootility's output-report channel (id 2) versus
+     * the feature-report channel.
+     */
+    async collectCommand(command, viaOutput) {
+        const run = this.commandLock.then(async () => {
+            this.collecting = [];
+            try {
+                if (viaOutput) {
+                    const report = new Uint8Array(62);
+                    report.set(command.subarray(0, 62));
+                    await this.device.sendReport(2, report);
+                }
+                else {
+                    await this.device.sendFeatureReport(this.featureReportId(), command.slice());
+                }
+            }
+            catch (error) {
+                this.collecting = null;
+                throw error;
+            }
+            await new Promise((resolve) => setTimeout(resolve, COLLECT_WINDOW_MS));
+            const reports = this.collecting ?? [];
+            this.collecting = null;
+            return reports;
+        });
+        this.commandLock = run.then(() => undefined, () => undefined);
+        return run;
+    }
+    /** Serialize command sends so overlapping callers never share the reply channel. */
+    async sendCommand(commandId, param0 = 0) {
+        const run = this.commandLock.then(() => this.probeCommand(commandId, param0));
+        this.commandLock = run.then(() => undefined, () => undefined);
+        return run;
+    }
+    /**
+     * Send a command on the config interface's declared feature report and read the
+     * reply. The 60HE+ answers with the multi-report magic (0xD1), so commands go
+     * out in that form. The answer arrives as an input report (matching Wooting's
+     * own tooling); a feature GET is tried only as a fallback. Returns the raw
+     * reply for the matching command, or null if nothing usable came back.
+     */
+    async probeCommand(commandId, param0 = 0) {
+        const reportId = this.featureReportId();
+        // Magic + command payload, without hidapi's leading report-index byte —
+        // WebHID carries the report id separately.
+        const payload = wootingFeatureReport(encodeWootingCommand(commandId, param0, 0, 0, 0, { multiReport: true })).data;
+        const inputReply = this.nextInputReport();
+        inputReply.catch(() => { }); // guard: this promise may go unused
+        try {
+            await this.device.sendFeatureReport(reportId, payload);
+        }
+        catch {
+            this.clearPendingRead();
+            return null;
+        }
+        const viaInput = await inputReply.catch(() => null);
+        if (viaInput && isWootingReply(viaInput))
+            return viaInput;
+        this.clearPendingRead();
+        const viaFeature = await this.device.receiveFeatureReport(reportId)
+            .then((view) => new Uint8Array(view.buffer, view.byteOffset, view.byteLength))
+            .catch(() => null);
+        return viaFeature && isWootingReply(viaFeature) ? viaFeature : null;
+    }
+    /** Report id of the config collection's declared feature report (0 if none). */
+    featureReportId() {
+        const collection = WootingHidClient.configCollection(this.device.collections);
+        return collection?.featureReports?.[0]?.reportId ?? 0;
+    }
+    /** Resolve with the next input report, or reject on timeout. */
+    nextInputReport() {
+        return new Promise((resolve, reject) => {
+            this.responseWaiter = { resolve, reject };
+            this.responseTimer = setTimeout(() => {
+                const waiter = this.responseWaiter;
+                if (!waiter)
+                    return;
+                this.clearPendingRead();
+                waiter.reject(new Error("Wooting keyboard did not answer the config request."));
+            }, CONFIG_RESPONSE_TIMEOUT_MS);
+        });
+    }
+    clearPendingRead() {
+        if (this.responseTimer !== null) {
+            clearTimeout(this.responseTimer);
+            this.responseTimer = null;
+        }
+        this.responseWaiter = null;
+    }
+    /**
+     * Turn the command replies into readable lines. Decoded fields (firmware
+     * version, layout) are shown on their own; a raw hex preview appears only as a
+     * fallback when a reply could not be decoded, so a fully-decoded board reads as
+     * a clean two-line card rather than a debug dump.
+     */
+    firmwareLines(version, config) {
+        const lines = [];
+        if (version) {
+            const decoded = decodeWootingVersion(version);
+            lines.push(decoded ? `Firmware: ${decoded}` : `Version reply: ${wootingHexPreview(version, 20)}`);
+        }
+        if (config) {
+            // Only decode when the reply carries a payload past its 4-byte header — a
+            // header-only answer has no config, so never invent a layout.
+            const decoded = config.subarray(4).some((byte) => byte !== 0)
+                ? decodeWootingDeviceConfig(config)
+                : null;
+            lines.push(decoded ? `Layout: ${decoded.layout}` : `Config reply: ${wootingHexPreview(config, 20)}`);
+        }
+        return lines;
+    }
+}
+/** First `count` bytes of a buffer as spaced hex, with an ellipsis if truncated. */
+function wootingHexPreview(bytes, count) {
+    const shown = [...bytes.subarray(0, count)].map((byte) => byte.toString(16).padStart(2, "0")).join(" ");
+    return bytes.length > count ? `${shown} …` : shown;
+}
+//# sourceMappingURL=hid.js.map

package/dist/drivers/wooting/hid.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"hid.js","sourceRoot":"","sources":["../../../src/drivers/wooting/hid.ts"],"names":[],"mappings":"AACA,OAAO,EACL,yBAAyB,EACzB,yBAAyB,EACzB,oBAAoB,EACpB,oBAAoB,EACpB,cAAc,EACd,oBAAoB,EACpB,kBAAkB,EAClB,mBAAmB,EACnB,oBAAoB,EAEpB,yBAAyB,EACzB,eAAe,EACf,oBAAoB,EACpB,yBAAyB,EACzB,gBAAgB,EAChB,iBAAiB,GAClB,MAAM,6BAA6B,CAAC;AAErC;;;;;;;;;;;;;;GAcG;AAEH,MAAM,0BAA0B,GAAG,GAAG,CAAC;AACvC,8EAA8E;AAC9E,MAAM,iBAAiB,GAAG,GAAG,CAAC;AAE9B,MAAM,OAAO,gBAAgB;IAClB,MAAM,CAAY;IAEnB,cAAc,GAAmF,IAAI,CAAC;IACtG,aAAa,GAAyC,IAAI,CAAC;IAEnE,wEAAwE;IACxE,2EAA2E;IAC3E,4BAA4B;IACX,OAAO,GAAG,IAAI,GAAG,EAA6B,CAAC;IAEhE,8EAA8E;IAC9E,0DAA0D;IAClD,WAAW,GAAqB,OAAO,CAAC,OAAO,EAAE,CAAC;IAE1D,6EAA6E;IAC7E,6EAA6E;IACrE,UAAU,GAAwB,IAAI,CAAC;IAE9B,aAAa,GAAG,CAAC,KAA0B,EAAQ,EAAE;QACpE,MAAM,KAAK,GAAG,IAAI,UAAU,CAC1B,KAAK,CAAC,IAAI,CAAC,MAAM,CAAC,KAAK,CAAC,KAAK,CAAC,IAAI,CAAC,UAAU,EAAE,KAAK,CAAC,IAAI,CAAC,UAAU,GAAG,KAAK,CAAC,IAAI,CAAC,UAAU,CAAC,CAC9F,CAAC;QACF,IAAI,IAAI,CAAC,UAAU,EAAE,CAAC;YACpB,IAAI,CAAC,UAAU,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC;YAC5B,OAAO;QACT,CAAC;QACD,MAAM,MAAM,GAAG,IAAI,CAAC,cAAc,CAAC;QACnC,IAAI,CAAC,MAAM;YAAE,OAAO;QACpB,IAAI,CAAC,gBAAgB,EAAE,CAAC;QACxB,MAAM,CAAC,OAAO,CAAC,KAAK,CAAC,CAAC;IACxB,CAAC,CAAC;IAEM,SAAS,GAAG,KAAK,CAAC;IAE1B,YAAY,MAAiB;QAC3B,IAAI,CAAC,MAAM,GAAG,MAAM,CAAC;IACvB,CAAC;IAED;;;;;OAKG;IACH,MAAM,CAAC,WAAW,CAAC,MAAiB;QAClC,IAAI,MAAM,CAAC,QAAQ,KAAK,iBAAiB;YAAE,OAAO,KAAK,CAAC;QACxD,IAAI,CAAC,gBAAgB,CAAC,GAAG,CAAC,MAAM,CAAC,SAAS,CAAC;YAAE,OAAO,KAAK,CAAC;QAC1D,OAAO,gBAAgB,CAAC,gBAAgB,CAAC,MAAM,CAAC,WAAW,CAAC,KAAK,IAAI,CAAC;IACxE,CAAC;IAED,yEAAyE;IACjE,MAAM,CAAC,gBAAgB,CAC7B,WAAyC;QAEzC,KAAK,MAAM,UAAU,IAAI,WAAW,EAAE,CAAC;YACrC,IAAI,UAAU,CAAC,KAAK,KAAK,oBAAoB;mBACxC,UAAU,CAAC,SAAS,KAAK,yBAAyB,EAAE,CAAC;gBACxD,OAAO,UAAU,CAAC;YACpB,CAAC;YACD,MAAM,MAAM,GAAG,gBAAgB,CAAC,gBAAgB,CAAC,UAAU,CAAC,QAAQ,CAAC,CAAC;YACtE,IAAI,MAAM;gBAAE,OAAO,MAAM,CAAC;QAC5B,CAAC;QACD,OAAO,IAAI,CAAC;IACd,CAAC;IAED;;;OAGG;IACH,aAAa;QACX,OAAO,EAAE,CAAC;IACZ,CAAC;IAED,KAAK,CAAC,IAAI;QACR,IAAI,CAAC,IAAI,CAAC,MAAM,CAAC,MAAM;YAAE,MAAM,IAAI,CAAC,MAAM,CAAC,IAAI,EAAE,CAAC;QAClD,IAAI,CAAC,IAAI,CAAC,SAAS,EAAE,CAAC;YACpB,IAAI,CAAC,MAAM,CAAC,gBAAgB,CAAC,aAAa,EAAE,IAAI,CAAC,aAAa,CAAC,CAAC;YAChE,IAAI,CAAC,SAAS,GAAG,IAAI,CAAC;QACxB,CAAC;IACH,CAAC;IAED,KAAK,CAAC,KAAK;QACT,IAAI,IAAI,CAAC,SAAS,EAAE,CAAC;YACnB,IAAI,CAAC,MAAM,CAAC,mBAAmB,CAAC,aAAa,EAAE,IAAI,CAAC,aAAa,CAAC,CAAC;YACnE,IAAI,CAAC,SAAS,GAAG,KAAK,CAAC;QACzB,CAAC;QACD,IAAI,IAAI,CAAC,MAAM,CAAC,MAAM;YAAE,MAAM,IAAI,CAAC,MAAM,CAAC,KAAK,EAAE,CAAC;IACpD,CAAC;IAED;;;;;;OAMG;IACH,KAAK,CAAC,WAAW,CAAC,OAA2C;QAC3D,MAAM,MAAM,GAAG,MAAM,IAAI,CAAC,YAAY,EAAE,CAAC;QACzC,IAAI,CAAC,MAAM,EAAE,CAAC;YACZ,MAAM,IAAI,KAAK,CAAC,gEAAgE,CAAC,CAAC;QACpF,CAAC;QACD,IAAI,CAAC,MAAM,CAAC,MAAM;YAAE,MAAM,MAAM,CAAC,IAAI,EAAE,CAAC;QACxC,MAAM,QAAQ,GAAG,CAAC,KAA0B,EAAQ,EAAE;YACpD,MAAM,IAAI,GAAG,IAAI,UAAU,CACzB,KAAK,CAAC,IAAI,CAAC,MAAM,CAAC,KAAK,CAAC,KAAK,CAAC,IAAI,CAAC,UAAU,EAAE,KAAK,CAAC,IAAI,CAAC,UAAU,GAAG,KAAK,CAAC,IAAI,CAAC,UAAU,CAAC,CAC9F,CAAC;YACF,OAAO,CAAC,yBAAyB,CAAC,IAAI,CAAC,CAAC,CAAC;QAC3C,CAAC,CAAC;QACF,MAAM,CAAC,gBAAgB,CAAC,aAAa,EAAE,QAAQ,CAAC,CAAC;QACjD,OAAO,GAAG,EAAE,CAAC,MAAM,CAAC,mBAAmB,CAAC,aAAa,EAAE,QAAQ,CAAC,CAAC;IACnE,CAAC;IAED,2EAA2E;IACnE,KAAK,CAAC,YAAY;QACxB,MAAM,GAAG,GAAI,UAAU,CAAC,SAAmC,EAAE,GAAG,CAAC;QACjE,IAAI,CAAC,GAAG;YAAE,OAAO,IAAI,CAAC;QACtB,MAAM,OAAO,GAAG,MAAM,GAAG,CAAC,UAAU,EAAE,CAAC;QACvC,OAAO,OAAO,CAAC,IAAI,CAAC,CAAC,MAAM,EAAE,EAAE,CAC7B,MAAM,CAAC,QAAQ,KAAK,iBAAiB;eAClC,MAAM,CAAC,SAAS,KAAK,IAAI,CAAC,MAAM,CAAC,SAAS;eAC1C,MAAM,CAAC,WAAW,CAAC,IAAI,CAAC,CAAC,UAAU,EAAE,EAAE,CACxC,UAAU,CAAC,SAAS,KAAK,yBAAyB,IAAI,UAAU,CAAC,KAAK,KAAK,oBAAoB,CAAC,CACnG,IAAI,IAAI,CAAC;IACZ,CAAC;IAED,KAAK,CAAC,UAAU;QACd,MAAM,IAAI,CAAC,IAAI,EAAE,CAAC;QAClB,4EAA4E;QAC5E,yCAAyC;QACzC,MAAM,OAAO,GAAG,MAAM,IAAI,CAAC,OAAO,CAAC,eAAe,CAAC,UAAU,CAAC,CAAC;QAC/D,MAAM,MAAM,GAAG,MAAM,IAAI,CAAC,OAAO,CAAC,eAAe,CAAC,eAAe,CAAC,CAAC;QAEnE,OAAO;YACL,KAAK,EAAE,SAAS;YAChB,IAAI,EAAE,kBAAkB,CAAC,IAAI,CAAC,MAAM,CAAC,SAAS,CAAC;YAC/C,EAAE,EAAE;gBACF,MAAM,EAAE,SAAS;gBACjB,yEAAyE;gBACzE,aAAa,EAAE,KAAK;gBACpB,kBAAkB,EAAE,kBAAkB,CAAC,IAAI,CAAC,MAAM,CAAC,SAAS,CAAC;aAC9D;YACD,cAAc,EAAE,IAAI;YACpB,YAAY,EAAE,SAAS;YACvB,4EAA4E;YAC5E,uCAAuC;YACvC,GAAG,EAAE,CAAC;YACN,aAAa,EAAE,CAAC;YAChB,aAAa,EAAE,IAAI;YACnB,cAAc,EAAE,OAAO;YACvB,gBAAgB,EAAE,KAAK;YACvB,eAAe,EAAE,IAAI;YACrB,QAAQ,EAAE,IAAI,CAAC,aAAa,CAAC,OAAO,EAAE,MAAM,CAAC;SAC9C,CAAC;IACJ,CAAC;IAED,8EAA8E;IAC9E,aAAa;IACb,8EAA8E;IAE9E;;;;;OAKG;IACK,KAAK,CAAC,OAAO,CAAC,SAAiB;QACrC,IAAI,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,SAAS,CAAC;YAAE,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,SAAS,CAAC,IAAI,IAAI,CAAC;QAC5E,MAAM,GAAG,GAAG,MAAM,IAAI,CAAC,WAAW,CAAC,SAAS,CAAC,CAAC,KAAK,CAAC,GAAG,EAAE,CAAC,IAAI,CAAC,CAAC;QAChE,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,SAAS,EAAE,GAAG,CAAC,CAAC;QACjC,OAAO,GAAG,CAAC;IACb,CAAC;IAED;;;;OAIG;IACH,KAAK,CAAC,iBAAiB;QACrB,MAAM,UAAU,GAAG,MAAM,IAAI,CAAC,WAAW,CAAC,eAAe,CAAC,8BAA8B,CAAC,CAAC,KAAK,CAAC,GAAG,EAAE,CAAC,IAAI,CAAC,CAAC;QAC5G,MAAM,KAAK,GAAG,UAAU,IAAI,UAAU,CAAC,MAAM,GAAG,CAAC,CAAC,CAAC,CAAC,UAAU,CAAC,CAAC,CAAE,CAAC,CAAC,CAAC,IAAI,CAAC;QAC1E,2EAA2E;QAC3E,4EAA4E;QAC5E,gFAAgF;QAChF,gFAAgF;QAChF,4EAA4E;QAC5E,8EAA8E;QAC9E,sEAAsE;QACtE,kFAAkF;QAClF,6EAA6E;QAC7E,0CAA0C;QAC1C,MAAM,OAAO,GAAG,IAAI,UAAU,CAAC;YAC7B,mBAAmB,EAAE,oBAAoB,EAAE,eAAe,CAAC,kBAAkB,EAAE,IAAI,EAAE,IAAI,EAAE,IAAI,EAAE,IAAI;SACtG,CAAC,CAAC;QACH,MAAM,OAAO,GAAG,MAAM,IAAI,CAAC,cAAc,CAAC,OAAO,EAAE,KAAK,CAAC,CAAC,KAAK,CAAC,GAAG,EAAE,CAAC,EAAE,CAAC,CAAC;QAC1E,MAAM,IAAI,GAAG,OAAO,CAAC,IAAI,CAAC,CAAC,MAAM,EAAE,EAAE,CAAC,MAAM,CAAC,QAAQ,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,IAAI,EAAE,EAAE,CAAC,IAAI,KAAK,CAAC,CAAC,CAAC;YAClF,CAAC,CAAC,sBAAsB;YACxB,CAAC,CAAC,SAAS,CAAC;QACd,OAAO,EAAE,KAAK,EAAE,OAAO,EAAE,IAAI,EAAE,CAAC;IAClC,CAAC;IAED;;;;OAIG;IACK,KAAK,CAAC,cAAc,CAAC,OAAmB,EAAE,SAAkB;QAClE,MAAM,GAAG,GAAG,IAAI,CAAC,WAAW,CAAC,IAAI,CAAC,KAAK,IAAI,EAAE;YAC3C,IAAI,CAAC,UAAU,GAAG,EAAE,CAAC;YACrB,IAAI,CAAC;gBACH,IAAI,SAAS,EAAE,CAAC;oBACd,MAAM,MAAM,GAAG,IAAI,UAAU,CAAC,EAAE,CAAC,CAAC;oBAClC,MAAM,CAAC,GAAG,CAAC,OAAO,CAAC,QAAQ,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC;oBACpC,MAAM,IAAI,CAAC,MAAM,CAAC,UAAU,CAAC,CAAC,EAAE,MAAM,CAAC,CAAC;gBAC1C,CAAC;qBAAM,CAAC;oBACN,MAAM,IAAI,CAAC,MAAM,CAAC,iBAAiB,CAAC,IAAI,CAAC,eAAe,EAAE,EAAE,OAAO,CAAC,KAAK,EAAE,CAAC,CAAC;gBAC/E,CAAC;YACH,CAAC;YAAC,OAAO,KAAK,EAAE,CAAC;gBACf,IAAI,CAAC,UAAU,GAAG,IAAI,CAAC;gBACvB,MAAM,KAAK,CAAC;YACd,CAAC;YACD,MAAM,IAAI,OAAO,CAAC,CAAC,OAAO,EAAE,EAAE,CAAC,UAAU,CAAC,OAAO,EAAE,iBAAiB,CAAC,CAAC,CAAC;YACvE,MAAM,OAAO,GAAG,IAAI,CAAC,UAAU,IAAI,EAAE,CAAC;YACtC,IAAI,CAAC,UAAU,GAAG,IAAI,CAAC;YACvB,OAAO,OAAO,CAAC;QACjB,CAAC,CAAC,CAAC;QACH,IAAI,CAAC,WAAW,GAAG,GAAG,CAAC,IAAI,CAAC,GAAG,EAAE,CAAC,SAAS,EAAE,GAAG,EAAE,CAAC,SAAS,CAAC,CAAC;QAC9D,OAAO,GAAG,CAAC;IACb,CAAC;IAED,oFAAoF;IAC5E,KAAK,CAAC,WAAW,CAAC,SAAiB,EAAE,MAAM,GAAG,CAAC;QACrD,MAAM,GAAG,GAAG,IAAI,CAAC,WAAW,CAAC,IAAI,CAAC,GAAG,EAAE,CAAC,IAAI,CAAC,YAAY,CAAC,SAAS,EAAE,MAAM,CAAC,CAAC,CAAC;QAC9E,IAAI,CAAC,WAAW,GAAG,GAAG,CAAC,IAAI,CAAC,GAAG,EAAE,CAAC,SAAS,EAAE,GAAG,EAAE,CAAC,SAAS,CAAC,CAAC;QAC9D,OAAO,GAAG,CAAC;IACb,CAAC;IAED;;;;;;OAMG;IACK,KAAK,CAAC,YAAY,CAAC,SAAiB,EAAE,MAAM,GAAG,CAAC;QACtD,MAAM,QAAQ,GAAG,IAAI,CAAC,eAAe,EAAE,CAAC;QACxC,wEAAwE;QACxE,2CAA2C;QAC3C,MAAM,OAAO,GAAG,oBAAoB,CAClC,oBAAoB,CAAC,SAAS,EAAE,MAAM,EAAE,CAAC,EAAE,CAAC,EAAE,CAAC,EAAE,EAAE,WAAW,EAAE,IAAI,EAAE,CAAC,CACxE,CAAC,IAAI,CAAC;QAEP,MAAM,UAAU,GAAG,IAAI,CAAC,eAAe,EAAE,CAAC;QAC1C,UAAU,CAAC,KAAK,CAAC,GAAG,EAAE,GAAE,CAAC,CAAC,CAAC,CAAC,oCAAoC;QAEhE,IAAI,CAAC;YACH,MAAM,IAAI,CAAC,MAAM,CAAC,iBAAiB,CAAC,QAAQ,EAAE,OAAO,CAAC,CAAC;QACzD,CAAC;QAAC,MAAM,CAAC;YACP,IAAI,CAAC,gBAAgB,EAAE,CAAC;YACxB,OAAO,IAAI,CAAC;QACd,CAAC;QAED,MAAM,QAAQ,GAAG,MAAM,UAAU,CAAC,KAAK,CAAC,GAAG,EAAE,CAAC,IAAI,CAAC,CAAC;QACpD,IAAI,QAAQ,IAAI,cAAc,CAAC,QAAQ,CAAC;YAAE,OAAO,QAAQ,CAAC;QAE1D,IAAI,CAAC,gBAAgB,EAAE,CAAC;QACxB,MAAM,UAAU,GAAG,MAAM,IAAI,CAAC,MAAM,CAAC,oBAAoB,CAAC,QAAQ,CAAC;aAChE,IAAI,CAAC,CAAC,IAAI,EAAE,EAAE,CAAC,IAAI,UAAU,CAAC,IAAI,CAAC,MAAM,EAAE,IAAI,CAAC,UAAU,EAAE,IAAI,CAAC,UAAU,CAAC,CAAC;aAC7E,KAAK,CAAC,GAAG,EAAE,CAAC,IAAI,CAAC,CAAC;QACrB,OAAO,UAAU,IAAI,cAAc,CAAC,UAAU,CAAC,CAAC,CAAC,CAAC,UAAU,CAAC,CAAC,CAAC,IAAI,CAAC;IACtE,CAAC;IAED,gFAAgF;IACxE,eAAe;QACrB,MAAM,UAAU,GAAG,gBAAgB,CAAC,gBAAgB,CAAC,IAAI,CAAC,MAAM,CAAC,WAAW,CAAC,CAAC;QAC9E,OAAO,UAAU,EAAE,cAAc,EAAE,CAAC,CAAC,CAAC,EAAE,QAAQ,IAAI,CAAC,CAAC;IACxD,CAAC;IAED,gEAAgE;IACxD,eAAe;QACrB,OAAO,IAAI,OAAO,CAAa,CAAC,OAAO,EAAE,MAAM,EAAE,EAAE;YACjD,IAAI,CAAC,cAAc,GAAG,EAAE,OAAO,EAAE,MAAM,EAAE,CAAC;YAC1C,IAAI,CAAC,aAAa,GAAG,UAAU,CAAC,GAAG,EAAE;gBACnC,MAAM,MAAM,GAAG,IAAI,CAAC,cAAc,CAAC;gBACnC,IAAI,CAAC,MAAM;oBAAE,OAAO;gBACpB,IAAI,CAAC,gBAAgB,EAAE,CAAC;gBACxB,MAAM,CAAC,MAAM,CAAC,IAAI,KAAK,CAAC,qDAAqD,CAAC,CAAC,CAAC;YAClF,CAAC,EAAE,0BAA0B,CAAC,CAAC;QACjC,CAAC,CAAC,CAAC;IACL,CAAC;IAEO,gBAAgB;QACtB,IAAI,IAAI,CAAC,aAAa,KAAK,IAAI,EAAE,CAAC;YAChC,YAAY,CAAC,IAAI,CAAC,aAAa,CAAC,CAAC;YACjC,IAAI,CAAC,aAAa,GAAG,IAAI,CAAC;QAC5B,CAAC;QACD,IAAI,CAAC,cAAc,GAAG,IAAI,CAAC;IAC7B,CAAC;IAED;;;;;OAKG;IACK,aAAa,CAAC,OAA0B,EAAE,MAAyB;QACzE,MAAM,KAAK,GAAa,EAAE,CAAC;QAE3B,IAAI,OAAO,EAAE,CAAC;YACZ,MAAM,OAAO,GAAG,oBAAoB,CAAC,OAAO,CAAC,CAAC;YAC9C,KAAK,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC,CAAC,aAAa,OAAO,EAAE,CAAC,CAAC,CAAC,kBAAkB,iBAAiB,CAAC,OAAO,EAAE,EAAE,CAAC,EAAE,CAAC,CAAC;QACpG,CAAC;QAED,IAAI,MAAM,EAAE,CAAC;YACX,0EAA0E;YAC1E,8DAA8D;YAC9D,MAAM,OAAO,GAAG,MAAM,CAAC,QAAQ,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,IAAI,EAAE,EAAE,CAAC,IAAI,KAAK,CAAC,CAAC;gBAC3D,CAAC,CAAC,yBAAyB,CAAC,MAAM,CAAC;gBACnC,CAAC,CAAC,IAAI,CAAC;YACT,KAAK,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC,CAAC,WAAW,OAAO,CAAC,MAAM,EAAE,CAAC,CAAC,CAAC,iBAAiB,iBAAiB,CAAC,MAAM,EAAE,EAAE,CAAC,EAAE,CAAC,CAAC;QACvG,CAAC;QAED,OAAO,KAAK,CAAC;IACf,CAAC;CACF;AAED,oFAAoF;AACpF,SAAS,iBAAiB,CAAC,KAAiB,EAAE,KAAa;IACzD,MAAM,KAAK,GAAG,CAAC,GAAG,KAAK,CAAC,QAAQ,CAAC,CAAC,EAAE,KAAK,CAAC,CAAC,CAAC,GAAG,CAAC,CAAC,IAAI,EAAE,EAAE,CAAC,IAAI,CAAC,QAAQ,CAAC,EAAE,CAAC,CAAC,QAAQ,CAAC,CAAC,EAAE,GAAG,CAAC,CAAC,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;IACxG,OAAO,KAAK,CAAC,MAAM,GAAG,KAAK,CAAC,CAAC,CAAC,GAAG,KAAK,IAAI,CAAC,CAAC,CAAC,KAAK,CAAC;AACrD,CAAC"}

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

@@ -0,0 +1,31 @@
+import type { MouseStatus } from "../mouse-types.ts";
+import { type ZaunkoenigPrimaryButton, type ZaunkoenigUsbSpeed } from "@openmouse/protocol/zaunkoenig";
+type LiftOffDistance = NonNullable<MouseStatus["liftOffDistance"]>;
+/** WebHID client for the public Zaunkoenfigurator protocol (M3K and M2K). */
+export declare class ZaunkoenigHidClient {
+    readonly canDisableSleep = false;
+    readonly device: HIDDevice;
+    private queue;
+    constructor(device: HIDDevice);
+    static isSupported(device: HIDDevice): boolean;
+    get pollIntervalMs(): number;
+    getDpiOptions(): number[];
+    getSupportedPollingRates(): number[];
+    open(): Promise<void>;
+    close(): Promise<void>;
+    startNotifications(_onChange?: () => void): Promise<boolean>;
+    readStatus(): Promise<MouseStatus>;
+    setDpi(dpi: number): Promise<number>;
+    setPollingRate(pollingRateHz: number): Promise<number>;
+    setLiftOffDistance(value: LiftOffDistance): Promise<LiftOffDistance>;
+    setAngleSnapping(enabled: boolean): Promise<boolean>;
+    setUsbSpeed(usbSpeed: ZaunkoenigUsbSpeed): Promise<ZaunkoenigUsbSpeed>;
+    setPrimaryButton(primaryButton: ZaunkoenigPrimaryButton): Promise<ZaunkoenigPrimaryButton>;
+    factoryReset(): Promise<MouseStatus>;
+    private update;
+    private readStatusDirect;
+    private readConfig;
+    private run;
+}
+export {};
+//# sourceMappingURL=hid.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"hid.d.ts","sourceRoot":"","sources":["../../../src/drivers/zaunkoenig/hid.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,WAAW,EAAE,MAAM,mBAAmB,CAAC;AACrD,OAAO,EAOL,KAAK,uBAAuB,EAC5B,KAAK,kBAAkB,EAQxB,MAAM,gCAAgC,CAAC;AAKxC,KAAK,eAAe,GAAG,WAAW,CAAC,WAAW,CAAC,iBAAiB,CAAC,CAAC,CAAC;AAEnE,6EAA6E;AAC7E,qBAAa,mBAAmB;IAC9B,QAAQ,CAAC,eAAe,SAAS;IACjC,QAAQ,CAAC,MAAM,EAAE,SAAS,CAAC;IAC3B,OAAO,CAAC,KAAK,CAAuC;gBAExC,MAAM,EAAE,SAAS;IAI7B,MAAM,CAAC,WAAW,CAAC,MAAM,EAAE,SAAS,GAAG,OAAO;IAK9C,IAAI,cAAc,IAAI,MAAM,CAAmB;IAE/C,aAAa,IAAI,MAAM,EAAE;IAKzB,wBAAwB,IAAI,MAAM,EAAE;IAE9B,IAAI,IAAI,OAAO,CAAC,IAAI,CAAC;IAIrB,KAAK,IAAI,OAAO,CAAC,IAAI,CAAC;IAItB,kBAAkB,CAAC,SAAS,CAAC,EAAE,MAAM,IAAI,GAAG,OAAO,CAAC,OAAO,CAAC;IAE5D,UAAU,IAAI,OAAO,CAAC,WAAW,CAAC;IAOlC,MAAM,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAAC,MAAM,CAAC;IAKpC,cAAc,CAAC,aAAa,EAAE,MAAM,GAAG,OAAO,CAAC,MAAM,CAAC;IAatD,kBAAkB,CAAC,KAAK,EAAE,eAAe,GAAG,OAAO,CAAC,eAAe,CAAC;IAMpE,gBAAgB,CAAC,OAAO,EAAE,OAAO,GAAG,OAAO,CAAC,OAAO,CAAC;IAIpD,WAAW,CAAC,QAAQ,EAAE,kBAAkB,GAAG,OAAO,CAAC,kBAAkB,CAAC;IAStE,gBAAgB,CAAC,aAAa,EAAE,uBAAuB,GAAG,OAAO,CAAC,uBAAuB,CAAC;IAI1F,YAAY,IAAI,OAAO,CAAC,WAAW,CAAC;YAQ5B,MAAM;YAoBN,gBAAgB;YA0ChB,UAAU;YAOV,GAAG;CAKlB"}

package/dist/drivers/zaunkoenig/hid.js

@@ -0,0 +1,162 @@
+import { ZAUNKOENIG_CONFIG_REPORT_ID, ZAUNKOENIG_PRODUCT_IDS, ZAUNKOENIG_USAGE_PAGE, ZAUNKOENIG_VENDOR_ID, ZAUNKOENIG_VERSION_REPORT_ID, zaunkoenigBuildConfigPayload, zaunkoenigBuildFactoryResetPayload, zaunkoenigDecodeConfigReport, zaunkoenigDecodeVersionReport, zaunkoenigDevice, zaunkoenigEncodeConfigWord, zaunkoenigFirmwareIsSupported, } from "@openmouse/protocol/zaunkoenig";
+const PRODUCT_IDS = new Set(ZAUNKOENIG_PRODUCT_IDS);
+const POLLING_RATES = [1000, 2000, 4000, 8000];
+/** WebHID client for the public Zaunkoenfigurator protocol (M3K and M2K). */
+export class ZaunkoenigHidClient {
+    canDisableSleep = false;
+    device;
+    queue = Promise.resolve();
+    constructor(device) {
+        this.device = device;
+    }
+    static isSupported(device) {
+        if (device.vendorId !== ZAUNKOENIG_VENDOR_ID || !PRODUCT_IDS.has(device.productId))
+            return false;
+        return hasControlCollection(device.collections);
+    }
+    get pollIntervalMs() { return 30_000; }
+    getDpiOptions() {
+        const { dpiStep, dpiMax } = zaunkoenigDevice(this.device.productId);
+        return Array.from({ length: dpiMax / dpiStep }, (_, index) => (index + 1) * dpiStep);
+    }
+    getSupportedPollingRates() { return [...POLLING_RATES]; }
+    async open() {
+        if (!this.device.opened)
+            await this.device.open();
+    }
+    async close() {
+        if (this.device.opened)
+            await this.device.close();
+    }
+    async startNotifications(_onChange) { return false; }
+    async readStatus() {
+        return await this.run(async () => {
+            await this.open();
+            return await this.readStatusDirect();
+        });
+    }
+    async setDpi(dpi) {
+        const confirmed = await this.update((config) => ({ ...config, dpi }));
+        return confirmed.dpi;
+    }
+    async setPollingRate(pollingRateHz) {
+        if (!POLLING_RATES.includes(pollingRateHz)) {
+            throw new Error("Zaunkoenig polling rate must be 1000, 2000, 4000, or 8000 Hz.");
+        }
+        const confirmed = await this.update((config) => ({
+            ...config,
+            pollingRateHz: pollingRateHz,
+            pollingRateCode: pollingCode(pollingRateHz),
+            usbSpeed: pollingRateHz > 1000 ? "High" : config.usbSpeed,
+        }));
+        return confirmed.pollingRateHz;
+    }
+    async setLiftOffDistance(value) {
+        const millimetres = value === "Low" ? 1 : value === "Medium" ? 2 : 3;
+        const confirmed = await this.update((config) => ({ ...config, liftOffDistanceMm: millimetres }));
+        return lodName(confirmed.liftOffDistanceMm);
+    }
+    async setAngleSnapping(enabled) {
+        return (await this.update((config) => ({ ...config, angleSnapping: enabled }))).angleSnapping;
+    }
+    async setUsbSpeed(usbSpeed) {
+        const confirmed = await this.update((config) => ({
+            ...config,
+            usbSpeed,
+            pollingRateHz: usbSpeed === "Full" ? 1000 : pollingRate(config.pollingRateCode),
+        }));
+        return confirmed.usbSpeed;
+    }
+    async setPrimaryButton(primaryButton) {
+        return (await this.update((config) => ({ ...config, primaryButton }))).primaryButton;
+    }
+    async factoryReset() {
+        return await this.run(async () => {
+            await this.open();
+            await this.device.sendFeatureReport(ZAUNKOENIG_CONFIG_REPORT_ID, buffer(zaunkoenigBuildFactoryResetPayload()));
+            return await this.readStatusDirect();
+        });
+    }
+    async update(change) {
+        return await this.run(async () => {
+            await this.open();
+            const current = await this.readConfig();
+            const wanted = change(current);
+            const wantedWord = zaunkoenigEncodeConfigWord(wanted, this.device.productId);
+            if (wantedWord !== zaunkoenigEncodeConfigWord(current, this.device.productId)) {
+                await this.device.sendFeatureReport(ZAUNKOENIG_CONFIG_REPORT_ID, buffer(zaunkoenigBuildConfigPayload(wanted, this.device.productId)));
+            }
+            const confirmed = await this.readConfig();
+            if (zaunkoenigEncodeConfigWord(confirmed, this.device.productId) !== wantedWord) {
+                throw new Error("The Zaunkoenig mouse did not retain the requested configuration.");
+            }
+            return confirmed;
+        });
+    }
+    async readStatusDirect() {
+        const firmware = zaunkoenigDecodeVersionReport(await this.device.receiveFeatureReport(ZAUNKOENIG_VERSION_REPORT_ID));
+        if (!zaunkoenigFirmwareIsSupported(firmware)) {
+            throw new Error(`Unsupported Zaunkoenig firmware: ${firmware || "unknown"}. parawizard new v0.8 is required.`);
+        }
+        const config = await this.readConfig();
+        const definition = zaunkoenigDevice(this.device.productId);
+        return {
+            brand: "Zaunkoenig",
+            name: this.device.productName?.trim() || `Zaunkoenig ${definition.model}`,
+            batteryPercent: null,
+            batteryState: "Unknown",
+            dpi: config.dpi,
+            pollingRateHz: config.pollingRateHz,
+            supportedPollingRates: [...POLLING_RATES],
+            activeProfile: null,
+            connectionType: "Wired",
+            connectionDetail: `USB ${config.usbSpeed}-speed`,
+            liftOffDistance: lodName(config.liftOffDistanceMm),
+            supportedLiftOffDistances: definition.liftOffDistancesMm.map(lodName),
+            angleSnapping: config.angleSnapping,
+            motionSync: null,
+            rippleControl: null,
+            usbSpeed: config.usbSpeed,
+            primaryButton: config.primaryButton,
+            firmware: firmware ? [firmware] : [],
+            ui: {
+                family: "zaunkoenig",
+                hideUnsupportedPollingRates: true,
+                hideMotionSync: true,
+                hideRippleControl: true,
+                hideSleepCard: true,
+                hideSignalCard: true,
+                showAdvancedSection: true,
+                pollingNote: "Full-speed is limited to 1,000 Hz; High-speed supports 1,000–8,000 Hz.",
+                defaultDisplayName: `Zaunkoenig ${definition.model}`,
+            },
+        };
+    }
+    async readConfig() {
+        return zaunkoenigDecodeConfigReport(await this.device.receiveFeatureReport(ZAUNKOENIG_CONFIG_REPORT_ID), this.device.productId);
+    }
+    async run(operation) {
+        const result = this.queue.then(operation, operation);
+        this.queue = result.then(() => undefined, () => undefined);
+        return await result;
+    }
+}
+function lodName(millimetres) {
+    return millimetres === 1 ? "Low" : millimetres === 2 ? "Medium" : "High";
+}
+function pollingCode(rate) {
+    return { 8000: 0, 4000: 1, 2000: 2, 1000: 3 }[rate] ?? 3;
+}
+function pollingRate(code) {
+    return [8000, 4000, 2000, 1000][code];
+}
+function hasControlCollection(items) {
+    return items.some((collection) => (collection.usagePage === ZAUNKOENIG_USAGE_PAGE
+        && collection.featureReports.some((report) => report.reportId === ZAUNKOENIG_VERSION_REPORT_ID)
+        && collection.featureReports.some((report) => report.reportId === ZAUNKOENIG_CONFIG_REPORT_ID))
+        || hasControlCollection(collection.children));
+}
+function buffer(payload) {
+    return new Uint8Array(payload).buffer;
+}
+//# sourceMappingURL=hid.js.map

package/dist/drivers/zaunkoenig/hid.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"hid.js","sourceRoot":"","sources":["../../../src/drivers/zaunkoenig/hid.ts"],"names":[],"mappings":"AACA,OAAO,EACL,2BAA2B,EAC3B,sBAAsB,EACtB,qBAAqB,EACrB,oBAAoB,EACpB,4BAA4B,EAI5B,4BAA4B,EAC5B,kCAAkC,EAClC,4BAA4B,EAC5B,6BAA6B,EAC7B,gBAAgB,EAChB,0BAA0B,EAC1B,6BAA6B,GAC9B,MAAM,gCAAgC,CAAC;AAExC,MAAM,WAAW,GAAG,IAAI,GAAG,CAAS,sBAAsB,CAAC,CAAC;AAC5D,MAAM,aAAa,GAAG,CAAC,IAAI,EAAE,IAAI,EAAE,IAAI,EAAE,IAAI,CAAU,CAAC;AAIxD,6EAA6E;AAC7E,MAAM,OAAO,mBAAmB;IACrB,eAAe,GAAG,KAAK,CAAC;IACxB,MAAM,CAAY;IACnB,KAAK,GAAqB,OAAO,CAAC,OAAO,EAAE,CAAC;IAEpD,YAAY,MAAiB;QAC3B,IAAI,CAAC,MAAM,GAAG,MAAM,CAAC;IACvB,CAAC;IAED,MAAM,CAAC,WAAW,CAAC,MAAiB;QAClC,IAAI,MAAM,CAAC,QAAQ,KAAK,oBAAoB,IAAI,CAAC,WAAW,CAAC,GAAG,CAAC,MAAM,CAAC,SAAS,CAAC;YAAE,OAAO,KAAK,CAAC;QACjG,OAAO,oBAAoB,CAAC,MAAM,CAAC,WAAW,CAAC,CAAC;IAClD,CAAC;IAED,IAAI,cAAc,KAAa,OAAO,MAAM,CAAC,CAAC,CAAC;IAE/C,aAAa;QACX,MAAM,EAAE,OAAO,EAAE,MAAM,EAAE,GAAG,gBAAgB,CAAC,IAAI,CAAC,MAAM,CAAC,SAAS,CAAC,CAAC;QACpE,OAAO,KAAK,CAAC,IAAI,CAAC,EAAE,MAAM,EAAE,MAAM,GAAG,OAAO,EAAE,EAAE,CAAC,CAAC,EAAE,KAAK,EAAE,EAAE,CAAC,CAAC,KAAK,GAAG,CAAC,CAAC,GAAG,OAAO,CAAC,CAAC;IACvF,CAAC;IAED,wBAAwB,KAAe,OAAO,CAAC,GAAG,aAAa,CAAC,CAAC,CAAC,CAAC;IAEnE,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,IAAI,CAAC,MAAM,CAAC,MAAM;YAAE,MAAM,IAAI,CAAC,MAAM,CAAC,KAAK,EAAE,CAAC;IACpD,CAAC;IAED,KAAK,CAAC,kBAAkB,CAAC,SAAsB,IAAsB,OAAO,KAAK,CAAC,CAAC,CAAC;IAEpF,KAAK,CAAC,UAAU;QACd,OAAO,MAAM,IAAI,CAAC,GAAG,CAAC,KAAK,IAAI,EAAE;YAC/B,MAAM,IAAI,CAAC,IAAI,EAAE,CAAC;YAClB,OAAO,MAAM,IAAI,CAAC,gBAAgB,EAAE,CAAC;QACvC,CAAC,CAAC,CAAC;IACL,CAAC;IAED,KAAK,CAAC,MAAM,CAAC,GAAW;QACtB,MAAM,SAAS,GAAG,MAAM,IAAI,CAAC,MAAM,CAAC,CAAC,MAAM,EAAE,EAAE,CAAC,CAAC,EAAE,GAAG,MAAM,EAAE,GAAG,EAAE,CAAC,CAAC,CAAC;QACtE,OAAO,SAAS,CAAC,GAAG,CAAC;IACvB,CAAC;IAED,KAAK,CAAC,cAAc,CAAC,aAAqB;QACxC,IAAI,CAAC,aAAa,CAAC,QAAQ,CAAC,aAA+C,CAAC,EAAE,CAAC;YAC7E,MAAM,IAAI,KAAK,CAAC,+DAA+D,CAAC,CAAC;QACnF,CAAC;QACD,MAAM,SAAS,GAAG,MAAM,IAAI,CAAC,MAAM,CAAC,CAAC,MAAM,EAAE,EAAE,CAAC,CAAC;YAC/C,GAAG,MAAM;YACT,aAAa,EAAE,aAAkD;YACjE,eAAe,EAAE,WAAW,CAAC,aAAa,CAAC;YAC3C,QAAQ,EAAE,aAAa,GAAG,IAAI,CAAC,CAAC,CAAC,MAAM,CAAC,CAAC,CAAC,MAAM,CAAC,QAAQ;SAC1D,CAAC,CAAC,CAAC;QACJ,OAAO,SAAS,CAAC,aAAa,CAAC;IACjC,CAAC;IAED,KAAK,CAAC,kBAAkB,CAAC,KAAsB;QAC7C,MAAM,WAAW,GAAG,KAAK,KAAK,KAAK,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,KAAK,KAAK,QAAQ,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC;QACrE,MAAM,SAAS,GAAG,MAAM,IAAI,CAAC,MAAM,CAAC,CAAC,MAAM,EAAE,EAAE,CAAC,CAAC,EAAE,GAAG,MAAM,EAAE,iBAAiB,EAAE,WAAW,EAAE,CAAC,CAAC,CAAC;QACjG,OAAO,OAAO,CAAC,SAAS,CAAC,iBAAiB,CAAC,CAAC;IAC9C,CAAC;IAED,KAAK,CAAC,gBAAgB,CAAC,OAAgB;QACrC,OAAO,CAAC,MAAM,IAAI,CAAC,MAAM,CAAC,CAAC,MAAM,EAAE,EAAE,CAAC,CAAC,EAAE,GAAG,MAAM,EAAE,aAAa,EAAE,OAAO,EAAE,CAAC,CAAC,CAAC,CAAC,aAAa,CAAC;IAChG,CAAC;IAED,KAAK,CAAC,WAAW,CAAC,QAA4B;QAC5C,MAAM,SAAS,GAAG,MAAM,IAAI,CAAC,MAAM,CAAC,CAAC,MAAM,EAAE,EAAE,CAAC,CAAC;YAC/C,GAAG,MAAM;YACT,QAAQ;YACR,aAAa,EAAE,QAAQ,KAAK,MAAM,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,WAAW,CAAC,MAAM,CAAC,eAAe,CAAC;SAChF,CAAC,CAAC,CAAC;QACJ,OAAO,SAAS,CAAC,QAAQ,CAAC;IAC5B,CAAC;IAED,KAAK,CAAC,gBAAgB,CAAC,aAAsC;QAC3D,OAAO,CAAC,MAAM,IAAI,CAAC,MAAM,CAAC,CAAC,MAAM,EAAE,EAAE,CAAC,CAAC,EAAE,GAAG,MAAM,EAAE,aAAa,EAAE,CAAC,CAAC,CAAC,CAAC,aAAa,CAAC;IACvF,CAAC;IAED,KAAK,CAAC,YAAY;QAChB,OAAO,MAAM,IAAI,CAAC,GAAG,CAAC,KAAK,IAAI,EAAE;YAC/B,MAAM,IAAI,CAAC,IAAI,EAAE,CAAC;YAClB,MAAM,IAAI,CAAC,MAAM,CAAC,iBAAiB,CAAC,2BAA2B,EAAE,MAAM,CAAC,kCAAkC,EAAE,CAAC,CAAC,CAAC;YAC/G,OAAO,MAAM,IAAI,CAAC,gBAAgB,EAAE,CAAC;QACvC,CAAC,CAAC,CAAC;IACL,CAAC;IAEO,KAAK,CAAC,MAAM,CAAC,MAAsD;QACzE,OAAO,MAAM,IAAI,CAAC,GAAG,CAAC,KAAK,IAAI,EAAE;YAC/B,MAAM,IAAI,CAAC,IAAI,EAAE,CAAC;YAClB,MAAM,OAAO,GAAG,MAAM,IAAI,CAAC,UAAU,EAAE,CAAC;YACxC,MAAM,MAAM,GAAG,MAAM,CAAC,OAAO,CAAC,CAAC;YAC/B,MAAM,UAAU,GAAG,0BAA0B,CAAC,MAAM,EAAE,IAAI,CAAC,MAAM,CAAC,SAAS,CAAC,CAAC;YAC7E,IAAI,UAAU,KAAK,0BAA0B,CAAC,OAAO,EAAE,IAAI,CAAC,MAAM,CAAC,SAAS,CAAC,EAAE,CAAC;gBAC9E,MAAM,IAAI,CAAC,MAAM,CAAC,iBAAiB,CACjC,2BAA2B,EAC3B,MAAM,CAAC,4BAA4B,CAAC,MAAM,EAAE,IAAI,CAAC,MAAM,CAAC,SAAS,CAAC,CAAC,CACpE,CAAC;YACJ,CAAC;YACD,MAAM,SAAS,GAAG,MAAM,IAAI,CAAC,UAAU,EAAE,CAAC;YAC1C,IAAI,0BAA0B,CAAC,SAAS,EAAE,IAAI,CAAC,MAAM,CAAC,SAAS,CAAC,KAAK,UAAU,EAAE,CAAC;gBAChF,MAAM,IAAI,KAAK,CAAC,kEAAkE,CAAC,CAAC;YACtF,CAAC;YACD,OAAO,SAAS,CAAC;QACnB,CAAC,CAAC,CAAC;IACL,CAAC;IAEO,KAAK,CAAC,gBAAgB;QAC5B,MAAM,QAAQ,GAAG,6BAA6B,CAC5C,MAAM,IAAI,CAAC,MAAM,CAAC,oBAAoB,CAAC,4BAA4B,CAAC,CACrE,CAAC;QACF,IAAI,CAAC,6BAA6B,CAAC,QAAQ,CAAC,EAAE,CAAC;YAC7C,MAAM,IAAI,KAAK,CAAC,oCAAoC,QAAQ,IAAI,SAAS,oCAAoC,CAAC,CAAC;QACjH,CAAC;QACD,MAAM,MAAM,GAAG,MAAM,IAAI,CAAC,UAAU,EAAE,CAAC;QACvC,MAAM,UAAU,GAAG,gBAAgB,CAAC,IAAI,CAAC,MAAM,CAAC,SAAS,CAAC,CAAC;QAC3D,OAAO;YACL,KAAK,EAAE,YAAY;YACnB,IAAI,EAAE,IAAI,CAAC,MAAM,CAAC,WAAW,EAAE,IAAI,EAAE,IAAI,cAAc,UAAU,CAAC,KAAK,EAAE;YACzE,cAAc,EAAE,IAAI;YACpB,YAAY,EAAE,SAAS;YACvB,GAAG,EAAE,MAAM,CAAC,GAAG;YACf,aAAa,EAAE,MAAM,CAAC,aAAa;YACnC,qBAAqB,EAAE,CAAC,GAAG,aAAa,CAAC;YACzC,aAAa,EAAE,IAAI;YACnB,cAAc,EAAE,OAAO;YACvB,gBAAgB,EAAE,OAAO,MAAM,CAAC,QAAQ,QAAQ;YAChD,eAAe,EAAE,OAAO,CAAC,MAAM,CAAC,iBAAiB,CAAC;YAClD,yBAAyB,EAAE,UAAU,CAAC,kBAAkB,CAAC,GAAG,CAAC,OAAO,CAAC;YACrE,aAAa,EAAE,MAAM,CAAC,aAAa;YACnC,UAAU,EAAE,IAAI;YAChB,aAAa,EAAE,IAAI;YACnB,QAAQ,EAAE,MAAM,CAAC,QAAQ;YACzB,aAAa,EAAE,MAAM,CAAC,aAAa;YACnC,QAAQ,EAAE,QAAQ,CAAC,CAAC,CAAC,CAAC,QAAQ,CAAC,CAAC,CAAC,CAAC,EAAE;YACpC,EAAE,EAAE;gBACF,MAAM,EAAE,YAAY;gBACpB,2BAA2B,EAAE,IAAI;gBACjC,cAAc,EAAE,IAAI;gBACpB,iBAAiB,EAAE,IAAI;gBACvB,aAAa,EAAE,IAAI;gBACnB,cAAc,EAAE,IAAI;gBACpB,mBAAmB,EAAE,IAAI;gBACzB,WAAW,EAAE,wEAAwE;gBACrF,kBAAkB,EAAE,cAAc,UAAU,CAAC,KAAK,EAAE;aACrD;SACF,CAAC;IACJ,CAAC;IAEO,KAAK,CAAC,UAAU;QACtB,OAAO,4BAA4B,CACjC,MAAM,IAAI,CAAC,MAAM,CAAC,oBAAoB,CAAC,2BAA2B,CAAC,EACnE,IAAI,CAAC,MAAM,CAAC,SAAS,CACtB,CAAC;IACJ,CAAC;IAEO,KAAK,CAAC,GAAG,CAAI,SAA2B;QAC9C,MAAM,MAAM,GAAG,IAAI,CAAC,KAAK,CAAC,IAAI,CAAC,SAAS,EAAE,SAAS,CAAC,CAAC;QACrD,IAAI,CAAC,KAAK,GAAG,MAAM,CAAC,IAAI,CAAC,GAAG,EAAE,CAAC,SAAS,EAAE,GAAG,EAAE,CAAC,SAAS,CAAC,CAAC;QAC3D,OAAO,MAAM,MAAM,CAAC;IACtB,CAAC;CACF;AAED,SAAS,OAAO,CAAC,WAAsB;IACrC,OAAO,WAAW,KAAK,CAAC,CAAC,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,WAAW,KAAK,CAAC,CAAC,CAAC,CAAC,QAAQ,CAAC,CAAC,CAAC,MAAM,CAAC;AAC3E,CAAC;AAED,SAAS,WAAW,CAAC,IAAY;IAC/B,OAAQ,EAAE,IAAI,EAAE,CAAC,EAAE,IAAI,EAAE,CAAC,EAAE,IAAI,EAAE,CAAC,EAAE,IAAI,EAAE,CAAC,EAAY,CAAC,IAAY,CAAC,IAAI,CAAC,CAAC;AAC9E,CAAC;AAED,SAAS,WAAW,CAAC,IAAyC;IAC5D,OAAO,CAAC,IAAI,EAAE,IAAI,EAAE,IAAI,EAAE,IAAI,CAAC,CAAC,IAAI,CAAsC,CAAC;AAC7E,CAAC;AAED,SAAS,oBAAoB,CAAC,KAAmC;IAC/D,OAAO,KAAK,CAAC,IAAI,CAAC,CAAC,UAAU,EAAE,EAAE,CAC/B,CAAC,UAAU,CAAC,SAAS,KAAK,qBAAqB;WAC1C,UAAU,CAAC,cAAc,CAAC,IAAI,CAAC,CAAC,MAAM,EAAE,EAAE,CAAC,MAAM,CAAC,QAAQ,KAAK,4BAA4B,CAAC;WAC5F,UAAU,CAAC,cAAc,CAAC,IAAI,CAAC,CAAC,MAAM,EAAE,EAAE,CAAC,MAAM,CAAC,QAAQ,KAAK,2BAA2B,CAAC,CAAC;WAC9F,oBAAoB,CAAC,UAAU,CAAC,QAAQ,CAAC,CAAC,CAAC;AAClD,CAAC;AAED,SAAS,MAAM,CAAC,OAAmB;IACjC,OAAO,IAAI,UAAU,CAAC,OAAO,CAAC,CAAC,MAAM,CAAC;AACxC,CAAC"}