@openmouse/protocol 0.1.0

package/dist/wallhack/index.js

@@ -0,0 +1,226 @@
+/**
+ * WALLHACK device codec — wire format for the WALLHACK M-001 mouse and K-001
+ * keyboard, reverse-engineered from the WALLHACK Terminal WebHID app
+ * (terminal.wallhack.com). Pure functions only: packet builders and response
+ * decoders, no I/O. The WebHID drivers live in ../drivers/wallhack.
+ *
+ * Transport (shared): output on **report id 4**, fixed **63-byte** reports,
+ * zero-padded. Responses arrive as input reports with the command code echoed at
+ * byte 2 and, for function-area reads, the 16-bit little-endian address echoed at
+ * bytes 4-5 and the payload from byte 7.
+ *
+ * The two devices are told apart by their command interface's HID usage page:
+ * the mouse answers on 0xFF1C, the keyboard on 0xFFA0.
+ */
+export const WALLHACK_VENDOR_ID = 0x3879; // 14457
+/** A second vendor id some K-001 units enumerate under (the switch-matrix MCU). */
+export const WALLHACK_KEYBOARD_ALT_VENDOR_ID = 0x1caa; // 7338
+/** M-001 mouse: real config PID and the in-app demo PID. */
+export const WALLHACK_MOUSE_PRODUCT_IDS = new Set([0x1110, 0x0807]);
+/** K-001 keyboard PID (shared across both keyboard vendor ids). */
+export const WALLHACK_KEYBOARD_PRODUCT_IDS = new Set([0x0806]);
+/** Command-interface usage pages, from the app's `CS` map. */
+export const WALLHACK_MOUSE_USAGE_PAGE = 0xff1c; // 65308
+export const WALLHACK_MOUSE_USAGE = 0x92; // 146
+export const WALLHACK_KEYBOARD_USAGE_PAGE = 0xffa0; // 65440
+export const WALLHACK_KEYBOARD_USAGE = 0x01;
+/** Every report is sent under this report id and is this many bytes long. */
+export const WALLHACK_REPORT_ID = 4;
+export const WALLHACK_REPORT_LENGTH = 63;
+/**
+ * Mouse command codes (`Pt`). The function-area pair reads/writes the config
+ * map (`WALLHACK_FLASH`); the rest are direct queries and actions.
+ */
+export const WALLHACK_COMMAND = {
+    checkConn: 0xa0,
+    fastBegin: 0xa1,
+    fastEnd: 0xa2,
+    getBasicInfo: 0xa3,
+    readFunctionArea: 0xa4,
+    writeFunctionArea: 0xa5,
+    getDefaultKeys: 0xa6,
+    getKeys: 0xa7,
+    setKeys: 0xa8,
+    getLighting: 0xa9,
+    setLighting: 0xaa,
+    factoryReset: 0xab,
+    getMacro: 0xac,
+    setMacro: 0xad,
+    pair: 0xae,
+    clearPairing: 0xaf,
+    testColor: 0xb0,
+    readMouseChipId: 0xb8,
+    readDongleChipId: 0xb9,
+    battery: 0xba,
+    readVersion: 0xbc,
+};
+/**
+ * Byte offsets into the mouse config "function area" (`We`). Each named field is
+ * a single byte unless noted. `dpi8Block` is the base of the per-stage DPI
+ * records.
+ */
+export const WALLHACK_FLASH = {
+    profileIndex: 0,
+    ledMode: 1,
+    ledLight: 2,
+    reportEsb: 10, // wireless (2.4 GHz) polling rank
+    reportUsb: 11, // wired polling rank
+    dpiRank: 12, // active DPI stage (0-based)
+    dpi8Block: 77, // base of the 8 DPI-stage records
+    reportUser: 104,
+    sleepTime: 105,
+    deepSleepTime: 107,
+    keyDebounceTime: 109,
+    silentHeight: 110, // lift-off distance
+    angleSnapEnable: 111,
+    rippleControlEnable: 112,
+    motionSyncEnable: 113,
+    turnOffAutomaticSleep: 114,
+    angleTuneValue: 115,
+    gameMode: 116,
+};
+/** Polling-rate rank → Hz (`Z1`). Same table for wired and wireless. */
+export const WALLHACK_POLLING_BY_RANK = {
+    0: 125, 1: 250, 2: 500, 3: 1000, 4: 1500, 5: 2000, 6: 2500, 7: 3000,
+    8: 3500, 9: 4000, 10: 4500, 11: 5000, 12: 5500, 13: 6000, 14: 6500,
+    15: 7000, 16: 7500, 17: 8000,
+};
+/** Full list of selectable polling rates, in Hz (`jm`). */
+export const WALLHACK_POLLING_RATES = Object.values(WALLHACK_POLLING_BY_RANK);
+/** Lift-off-distance code → millimetres (`s6`). */
+export const WALLHACK_LOD_MM_BY_CODE = { 0: 0.7, 1: 1, 2: 2 };
+export function wallhackPollingRankToHz(rank) {
+    return WALLHACK_POLLING_BY_RANK[rank] ?? null;
+}
+export function wallhackPollingHzToRank(hz) {
+    for (const [rank, value] of Object.entries(WALLHACK_POLLING_BY_RANK)) {
+        if (value === hz)
+            return Number(rank);
+    }
+    return null;
+}
+/**
+ * Lift-off code (0/1/2) → OpenMouse's three-stop LOD. The device's three heights
+ * (0.7 / 1 / 2 mm) map onto Low / Medium / High in order.
+ */
+export function wallhackLodFromCode(code) {
+    switch (code) {
+        case 0: return "Low";
+        case 1: return "Medium";
+        case 2: return "High";
+        default: return null;
+    }
+}
+export function wallhackLodToCode(lod) {
+    return lod === "Low" ? 0 : lod === "Medium" ? 1 : 2;
+}
+/** Human-facing product name for a device by product id. */
+export function wallhackMouseName(_productId) {
+    return "WALLHACK M-001";
+}
+export function wallhackKeyboardName(_productId) {
+    return "WALLHACK K-001";
+}
+/** Pack `bytes` into a fresh zero-padded 63-byte report body (`as`). */
+export function wallhackReport(bytes) {
+    const frame = new Uint8Array(WALLHACK_REPORT_LENGTH);
+    frame.set([...bytes].slice(0, WALLHACK_REPORT_LENGTH), 0);
+    return frame;
+}
+/**
+ * Build a simple (non-function-area) command: `[0, 0, command, ...args]` padded
+ * to the report length. Matches the app's `as(new Uint8Array([0, 0, cmd, …]))`.
+ */
+export function wallhackBuildSimple(command, args = []) {
+    return wallhackReport([0, 0, command, ...args]);
+}
+/**
+ * Build a function-area read/write packet (`Ht`):
+ * `[0, 0, cmd, n, addrLo, addrHi, 0, ...payload]`, where `cmd` is
+ * READ/WRITE_FUNCTION_AREA, `n` is the payload length (write) or byte count
+ * (read), and `addr` is the 16-bit little-endian offset.
+ */
+export function wallhackBuildFunctionArea(write, address, n, payload = []) {
+    const command = write ? WALLHACK_COMMAND.writeFunctionArea : WALLHACK_COMMAND.readFunctionArea;
+    const header = [0, 0, command, n & 0xff, address & 0xff, (address >> 8) & 0xff, 0];
+    return wallhackReport([...header, ...payload]);
+}
+/** Read `count` bytes from the config map at `address`. */
+export function wallhackBuildRead(address, count = 1) {
+    return wallhackBuildFunctionArea(false, address, count);
+}
+/** Write `payload` bytes to the config map at `address`. */
+export function wallhackBuildWrite(address, payload) {
+    return wallhackBuildFunctionArea(true, address, payload.length, payload);
+}
+/** A DPI value as the two little-endian bytes the DPI-stage record stores. */
+export function wallhackDpiBytes(dpi) {
+    return [dpi & 0xff, (dpi >> 8) & 0xff];
+}
+/**
+ * One DPI-stage record as written by the app (`sJ`):
+ * `[enabled, 0, dpiLo, dpiHi, 0x90, 1, colorHi, colorLo, 0]`. The trailing bytes
+ * are the stage's LED colour; the app writes 0x90/0xFFFF as defaults.
+ */
+export function wallhackBuildSetDpiStage(dpi) {
+    const [lo, hi] = wallhackDpiBytes(dpi);
+    return wallhackBuildWrite(WALLHACK_FLASH.dpi8Block, [1, 0, lo, hi, 0x90, 1, 0xff, 0xff, 0]);
+}
+/**
+ * A response is a valid reply for `command` when it echoes that command code at
+ * byte 2. (Bytes 0-1 are report framing / status.)
+ */
+export function wallhackIsReplyFor(response, command) {
+    return response.length > 2 && response[2] === command;
+}
+/** The function-area address a read/write response echoes back (bytes 4-5, LE). */
+export function wallhackResponseAddress(response) {
+    if (response.length < 6)
+        return null;
+    return (response[4] | (response[5] << 8)) & 0xffff;
+}
+/**
+ * The single config byte a function-area read returns. The payload begins at
+ * byte 7 (`gJ`, `fJ`, `mJ` all read `t[7]`).
+ */
+export function wallhackReadByte(response) {
+    if (response.length < 8)
+        return null;
+    return response[7];
+}
+/**
+ * The active DPI stage's value from a `dpi8Block` read. The stage record's DPI
+ * lives at payload bytes 2-3, i.e. response bytes 9-10, little-endian (`lJ`).
+ */
+export function wallhackReadDpi(response) {
+    if (response.length < 11)
+        return null;
+    return (response[9] | (response[10] << 8)) & 0xffff;
+}
+/**
+ * Decode a READ_VERSION reply (`rJ`): three big-endian 16-bit versions at bytes
+ * 7-8 (mouse), 9-10 (dongle), 11-12 (NXP), each rendered `major.minor`.
+ */
+export function wallhackDecodeVersions(response) {
+    if (response.length < 13)
+        return null;
+    const render = (hi, lo) => `${hi}.${lo}`;
+    return {
+        mouse: render(response[7], response[8]),
+        dongle: render(response[9], response[10]),
+        nxp: render(response[11], response[12]),
+    };
+}
+/**
+ * Decode a BATTERY reply: percentage at byte 7, charging flag at byte 8. The
+ * exact byte positions are best-effort from the obfuscated bundle and want
+ * hardware confirmation; a percent outside 0-100 is treated as unknown.
+ */
+export function wallhackDecodeBattery(response) {
+    if (response.length < 9)
+        return null;
+    const raw = response[7];
+    const percent = raw >= 0 && raw <= 100 ? raw : null;
+    return { percent, charging: response[8] === 1 };
+}
+//# sourceMappingURL=index.js.map

package/dist/wallhack/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/wallhack/index.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;GAaG;AAEH,MAAM,CAAC,MAAM,kBAAkB,GAAG,MAAM,CAAC,CAAC,QAAQ;AAClD,mFAAmF;AACnF,MAAM,CAAC,MAAM,+BAA+B,GAAG,MAAM,CAAC,CAAC,OAAO;AAE9D,4DAA4D;AAC5D,MAAM,CAAC,MAAM,0BAA0B,GAAG,IAAI,GAAG,CAAS,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC,CAAC;AAC5E,mEAAmE;AACnE,MAAM,CAAC,MAAM,6BAA6B,GAAG,IAAI,GAAG,CAAS,CAAC,MAAM,CAAC,CAAC,CAAC;AAEvE,8DAA8D;AAC9D,MAAM,CAAC,MAAM,yBAAyB,GAAG,MAAM,CAAC,CAAC,QAAQ;AACzD,MAAM,CAAC,MAAM,oBAAoB,GAAG,IAAI,CAAC,CAAC,MAAM;AAChD,MAAM,CAAC,MAAM,4BAA4B,GAAG,MAAM,CAAC,CAAC,QAAQ;AAC5D,MAAM,CAAC,MAAM,uBAAuB,GAAG,IAAI,CAAC;AAE5C,6EAA6E;AAC7E,MAAM,CAAC,MAAM,kBAAkB,GAAG,CAAC,CAAC;AACpC,MAAM,CAAC,MAAM,sBAAsB,GAAG,EAAE,CAAC;AAEzC;;;GAGG;AACH,MAAM,CAAC,MAAM,gBAAgB,GAAG;IAC9B,SAAS,EAAE,IAAI;IACf,SAAS,EAAE,IAAI;IACf,OAAO,EAAE,IAAI;IACb,YAAY,EAAE,IAAI;IAClB,gBAAgB,EAAE,IAAI;IACtB,iBAAiB,EAAE,IAAI;IACvB,cAAc,EAAE,IAAI;IACpB,OAAO,EAAE,IAAI;IACb,OAAO,EAAE,IAAI;IACb,WAAW,EAAE,IAAI;IACjB,WAAW,EAAE,IAAI;IACjB,YAAY,EAAE,IAAI;IAClB,QAAQ,EAAE,IAAI;IACd,QAAQ,EAAE,IAAI;IACd,IAAI,EAAE,IAAI;IACV,YAAY,EAAE,IAAI;IAClB,SAAS,EAAE,IAAI;IACf,eAAe,EAAE,IAAI;IACrB,gBAAgB,EAAE,IAAI;IACtB,OAAO,EAAE,IAAI;IACb,WAAW,EAAE,IAAI;CACT,CAAC;AAEX;;;;GAIG;AACH,MAAM,CAAC,MAAM,cAAc,GAAG;IAC5B,YAAY,EAAE,CAAC;IACf,OAAO,EAAE,CAAC;IACV,QAAQ,EAAE,CAAC;IACX,SAAS,EAAE,EAAE,EAAE,kCAAkC;IACjD,SAAS,EAAE,EAAE,EAAE,qBAAqB;IACpC,OAAO,EAAE,EAAE,EAAE,6BAA6B;IAC1C,SAAS,EAAE,EAAE,EAAE,kCAAkC;IACjD,UAAU,EAAE,GAAG;IACf,SAAS,EAAE,GAAG;IACd,aAAa,EAAE,GAAG;IAClB,eAAe,EAAE,GAAG;IACpB,YAAY,EAAE,GAAG,EAAE,oBAAoB;IACvC,eAAe,EAAE,GAAG;IACpB,mBAAmB,EAAE,GAAG;IACxB,gBAAgB,EAAE,GAAG;IACrB,qBAAqB,EAAE,GAAG;IAC1B,cAAc,EAAE,GAAG;IACnB,QAAQ,EAAE,GAAG;CACL,CAAC;AAEX,wEAAwE;AACxE,MAAM,CAAC,MAAM,wBAAwB,GAA2B;IAC9D,CAAC,EAAE,GAAG,EAAE,CAAC,EAAE,GAAG,EAAE,CAAC,EAAE,GAAG,EAAE,CAAC,EAAE,IAAI,EAAE,CAAC,EAAE,IAAI,EAAE,CAAC,EAAE,IAAI,EAAE,CAAC,EAAE,IAAI,EAAE,CAAC,EAAE,IAAI;IACnE,CAAC,EAAE,IAAI,EAAE,CAAC,EAAE,IAAI,EAAE,EAAE,EAAE,IAAI,EAAE,EAAE,EAAE,IAAI,EAAE,EAAE,EAAE,IAAI,EAAE,EAAE,EAAE,IAAI,EAAE,EAAE,EAAE,IAAI;IAClE,EAAE,EAAE,IAAI,EAAE,EAAE,EAAE,IAAI,EAAE,EAAE,EAAE,IAAI;CAC7B,CAAC;AAEF,2DAA2D;AAC3D,MAAM,CAAC,MAAM,sBAAsB,GAAsB,MAAM,CAAC,MAAM,CAAC,wBAAwB,CAAC,CAAC;AAEjG,mDAAmD;AACnD,MAAM,CAAC,MAAM,uBAAuB,GAA2B,EAAE,CAAC,EAAE,GAAG,EAAE,CAAC,EAAE,CAAC,EAAE,CAAC,EAAE,CAAC,EAAE,CAAC;AAEtF,MAAM,UAAU,uBAAuB,CAAC,IAAY;IAClD,OAAO,wBAAwB,CAAC,IAAI,CAAC,IAAI,IAAI,CAAC;AAChD,CAAC;AAED,MAAM,UAAU,uBAAuB,CAAC,EAAU;IAChD,KAAK,MAAM,CAAC,IAAI,EAAE,KAAK,CAAC,IAAI,MAAM,CAAC,OAAO,CAAC,wBAAwB,CAAC,EAAE,CAAC;QACrE,IAAI,KAAK,KAAK,EAAE;YAAE,OAAO,MAAM,CAAC,IAAI,CAAC,CAAC;IACxC,CAAC;IACD,OAAO,IAAI,CAAC;AACd,CAAC;AAED;;;GAGG;AACH,MAAM,UAAU,mBAAmB,CAAC,IAAY;IAC9C,QAAQ,IAAI,EAAE,CAAC;QACb,KAAK,CAAC,CAAC,CAAC,OAAO,KAAK,CAAC;QACrB,KAAK,CAAC,CAAC,CAAC,OAAO,QAAQ,CAAC;QACxB,KAAK,CAAC,CAAC,CAAC,OAAO,MAAM,CAAC;QACtB,OAAO,CAAC,CAAC,OAAO,IAAI,CAAC;IACvB,CAAC;AACH,CAAC;AAED,MAAM,UAAU,iBAAiB,CAAC,GAA8B;IAC9D,OAAO,GAAG,KAAK,KAAK,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,GAAG,KAAK,QAAQ,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC;AACtD,CAAC;AAED,4DAA4D;AAC5D,MAAM,UAAU,iBAAiB,CAAC,UAAkB;IAClD,OAAO,gBAAgB,CAAC;AAC1B,CAAC;AAED,MAAM,UAAU,oBAAoB,CAAC,UAAkB;IACrD,OAAO,gBAAgB,CAAC;AAC1B,CAAC;AAED,wEAAwE;AACxE,MAAM,UAAU,cAAc,CAAC,KAAuB;IACpD,MAAM,KAAK,GAAG,IAAI,UAAU,CAAC,sBAAsB,CAAC,CAAC;IACrD,KAAK,CAAC,GAAG,CAAC,CAAC,GAAG,KAAK,CAAC,CAAC,KAAK,CAAC,CAAC,EAAE,sBAAsB,CAAC,EAAE,CAAC,CAAC,CAAC;IAC1D,OAAO,KAAK,CAAC;AACf,CAAC;AAED;;;GAGG;AACH,MAAM,UAAU,mBAAmB,CAAC,OAAe,EAAE,OAA0B,EAAE;IAC/E,OAAO,cAAc,CAAC,CAAC,CAAC,EAAE,CAAC,EAAE,OAAO,EAAE,GAAG,IAAI,CAAC,CAAC,CAAC;AAClD,CAAC;AAED;;;;;GAKG;AACH,MAAM,UAAU,yBAAyB,CACvC,KAAc,EACd,OAAe,EACf,CAAS,EACT,UAA6B,EAAE;IAE/B,MAAM,OAAO,GAAG,KAAK,CAAC,CAAC,CAAC,gBAAgB,CAAC,iBAAiB,CAAC,CAAC,CAAC,gBAAgB,CAAC,gBAAgB,CAAC;IAC/F,MAAM,MAAM,GAAG,CAAC,CAAC,EAAE,CAAC,EAAE,OAAO,EAAE,CAAC,GAAG,IAAI,EAAE,OAAO,GAAG,IAAI,EAAE,CAAC,OAAO,IAAI,CAAC,CAAC,GAAG,IAAI,EAAE,CAAC,CAAC,CAAC;IACnF,OAAO,cAAc,CAAC,CAAC,GAAG,MAAM,EAAE,GAAG,OAAO,CAAC,CAAC,CAAC;AACjD,CAAC;AAED,2DAA2D;AAC3D,MAAM,UAAU,iBAAiB,CAAC,OAAe,EAAE,KAAK,GAAG,CAAC;IAC1D,OAAO,yBAAyB,CAAC,KAAK,EAAE,OAAO,EAAE,KAAK,CAAC,CAAC;AAC1D,CAAC;AAED,4DAA4D;AAC5D,MAAM,UAAU,kBAAkB,CAAC,OAAe,EAAE,OAA0B;IAC5E,OAAO,yBAAyB,CAAC,IAAI,EAAE,OAAO,EAAE,OAAO,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;AAC3E,CAAC;AAED,8EAA8E;AAC9E,MAAM,UAAU,gBAAgB,CAAC,GAAW;IAC1C,OAAO,CAAC,GAAG,GAAG,IAAI,EAAE,CAAC,GAAG,IAAI,CAAC,CAAC,GAAG,IAAI,CAAC,CAAC;AACzC,CAAC;AAED;;;;GAIG;AACH,MAAM,UAAU,wBAAwB,CAAC,GAAW;IAClD,MAAM,CAAC,EAAE,EAAE,EAAE,CAAC,GAAG,gBAAgB,CAAC,GAAG,CAAC,CAAC;IACvC,OAAO,kBAAkB,CAAC,cAAc,CAAC,SAAS,EAAE,CAAC,CAAC,EAAE,CAAC,EAAE,EAAE,EAAE,EAAE,EAAE,IAAI,EAAE,CAAC,EAAE,IAAI,EAAE,IAAI,EAAE,CAAC,CAAC,CAAC,CAAC;AAC9F,CAAC;AAED;;;GAGG;AACH,MAAM,UAAU,kBAAkB,CAAC,QAAoB,EAAE,OAAe;IACtE,OAAO,QAAQ,CAAC,MAAM,GAAG,CAAC,IAAI,QAAQ,CAAC,CAAC,CAAC,KAAK,OAAO,CAAC;AACxD,CAAC;AAED,mFAAmF;AACnF,MAAM,UAAU,uBAAuB,CAAC,QAAoB;IAC1D,IAAI,QAAQ,CAAC,MAAM,GAAG,CAAC;QAAE,OAAO,IAAI,CAAC;IACrC,OAAO,CAAC,QAAQ,CAAC,CAAC,CAAE,GAAG,CAAC,QAAQ,CAAC,CAAC,CAAE,IAAI,CAAC,CAAC,CAAC,GAAG,MAAM,CAAC;AACvD,CAAC;AAED;;;GAGG;AACH,MAAM,UAAU,gBAAgB,CAAC,QAAoB;IACnD,IAAI,QAAQ,CAAC,MAAM,GAAG,CAAC;QAAE,OAAO,IAAI,CAAC;IACrC,OAAO,QAAQ,CAAC,CAAC,CAAE,CAAC;AACtB,CAAC;AAED;;;GAGG;AACH,MAAM,UAAU,eAAe,CAAC,QAAoB;IAClD,IAAI,QAAQ,CAAC,MAAM,GAAG,EAAE;QAAE,OAAO,IAAI,CAAC;IACtC,OAAO,CAAC,QAAQ,CAAC,CAAC,CAAE,GAAG,CAAC,QAAQ,CAAC,EAAE,CAAE,IAAI,CAAC,CAAC,CAAC,GAAG,MAAM,CAAC;AACxD,CAAC;AAWD;;;GAGG;AACH,MAAM,UAAU,sBAAsB,CAAC,QAAoB;IACzD,IAAI,QAAQ,CAAC,MAAM,GAAG,EAAE;QAAE,OAAO,IAAI,CAAC;IACtC,MAAM,MAAM,GAAG,CAAC,EAAU,EAAE,EAAU,EAAU,EAAE,CAAC,GAAG,EAAE,IAAI,EAAE,EAAE,CAAC;IACjE,OAAO;QACL,KAAK,EAAE,MAAM,CAAC,QAAQ,CAAC,CAAC,CAAE,EAAE,QAAQ,CAAC,CAAC,CAAE,CAAC;QACzC,MAAM,EAAE,MAAM,CAAC,QAAQ,CAAC,CAAC,CAAE,EAAE,QAAQ,CAAC,EAAE,CAAE,CAAC;QAC3C,GAAG,EAAE,MAAM,CAAC,QAAQ,CAAC,EAAE,CAAE,EAAE,QAAQ,CAAC,EAAE,CAAE,CAAC;KAC1C,CAAC;AACJ,CAAC;AAOD;;;;GAIG;AACH,MAAM,UAAU,qBAAqB,CAAC,QAAoB;IACxD,IAAI,QAAQ,CAAC,MAAM,GAAG,CAAC;QAAE,OAAO,IAAI,CAAC;IACrC,MAAM,GAAG,GAAG,QAAQ,CAAC,CAAC,CAAE,CAAC;IACzB,MAAM,OAAO,GAAG,GAAG,IAAI,CAAC,IAAI,GAAG,IAAI,GAAG,CAAC,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,IAAI,CAAC;IACpD,OAAO,EAAE,OAAO,EAAE,QAAQ,EAAE,QAAQ,CAAC,CAAC,CAAC,KAAK,CAAC,EAAE,CAAC;AAClD,CAAC"}

package/dist/wlmouse/index.d.ts

@@ -0,0 +1,4 @@
+export * from "../compx/codec.js";
+export declare const WLMOUSE_VENDOR_ID = 13991;
+export declare const WLMOUSE_POLLING_RATES: readonly [readonly [8, 125], readonly [4, 250], readonly [2, 500], readonly [1, 1000], readonly [16, 1000], readonly [32, 2000], readonly [64, 4000], readonly [128, 8000]];
+//# sourceMappingURL=index.d.ts.map

package/dist/wlmouse/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/wlmouse/index.ts"],"names":[],"mappings":"AAAA,cAAc,mBAAmB,CAAC;AAClC,eAAO,MAAM,iBAAiB,QAAS,CAAC;AACxC,eAAO,MAAM,qBAAqB,6KAGxB,CAAC"}

package/dist/wlmouse/index.js

@@ -0,0 +1,7 @@
+export * from "../compx/codec.js";
+export const WLMOUSE_VENDOR_ID = 0x36a7;
+export const WLMOUSE_POLLING_RATES = [
+    [0x08, 125], [0x04, 250], [0x02, 500], [0x01, 1000],
+    [0x10, 1000], [0x20, 2000], [0x40, 4000], [0x80, 8000],
+];
+//# sourceMappingURL=index.js.map

package/dist/wlmouse/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/wlmouse/index.ts"],"names":[],"mappings":"AAAA,cAAc,mBAAmB,CAAC;AAClC,MAAM,CAAC,MAAM,iBAAiB,GAAG,MAAM,CAAC;AACxC,MAAM,CAAC,MAAM,qBAAqB,GAAG;IACnC,CAAC,IAAI,EAAE,GAAG,CAAC,EAAE,CAAC,IAAI,EAAE,GAAG,CAAC,EAAE,CAAC,IAAI,EAAE,GAAG,CAAC,EAAE,CAAC,IAAI,EAAE,IAAI,CAAC;IACnD,CAAC,IAAI,EAAE,IAAI,CAAC,EAAE,CAAC,IAAI,EAAE,IAAI,CAAC,EAAE,CAAC,IAAI,EAAE,IAAI,CAAC,EAAE,CAAC,IAAI,EAAE,IAAI,CAAC;CAC9C,CAAC"}

package/dist/wooting/index.d.ts

@@ -0,0 +1,225 @@
+/**
+ * Wooting analog keyboard vendor HID protocol — transport-independent codec.
+ *
+ * Wire mechanics mirror the official Wooting RGB SDK (`src/wooting-usb.c`,
+ * `wooting_usb_send_feature_buff`). Commands are 8-byte HID *feature* reports:
+ *
+ *   [reportIndex, magic0, magic1, commandId, param3, param2, param1, param0]
+ *
+ * where `magic0`/`magic1` are `0xD0`/`0xDA` on single-report (v1/v2-interface)
+ * devices and `0xD1`/`0xDA` on multi-report (v3) devices, and `reportIndex`
+ * (0 or 1) matches. Note the SDK writes the four parameters in reverse order
+ * (param3 first). The response is read back as an *input* report; its layout is
+ * command-specific.
+ *
+ * The Wooting 60HE+ (VID `0x31E3`, PID `0x1322`) is a single-report,
+ * v2-interface board, so it uses magic `0xD0`/`0xDA` and report index 0, and
+ * exposes its config interface on vendor usage page `0xFF53`, usage `0x01`.
+ *
+ * These helpers are read-only building blocks: OpenMouse uses them to identify
+ * a board and, where the browser permits, read its device config. No firmware
+ * flashing, profile writes, or key remapping live here.
+ */
+/** Wooting "VID2" — used by every Hall-effect / ARM board (Two HE, 60HE, 60HE+, 80HE…). */
+export declare const WOOTING_VENDOR_ID = 12771;
+/** Atmel VID on the original AVR boards (Wooting One / Two). Kept for discovery only. */
+export declare const WOOTING_LEGACY_VENDOR_ID = 1003;
+/**
+ * Vendor config interface exposed over WebHID. The 60HE+ presents several
+ * vendor-defined collections; only `0xFF55` usage `0x01` declares a writable
+ * feature report (confirmed on hardware — the `0xFF53` collection is the
+ * analog/HID data stream and declares no feature report, so a WebHID feature
+ * write there fails). `0xFF00` is the legacy generic interface on older boards.
+ */
+export declare const WOOTING_CONFIG_USAGE_PAGE = 65365;
+export declare const WOOTING_CONFIG_USAGE_PAGE_LEGACY = 65280;
+/** The analog/HID data stream — not used for commands. */
+export declare const WOOTING_ANALOG_USAGE_PAGE = 65363;
+export declare const WOOTING_CONFIG_USAGE = 1;
+export interface WootingProduct {
+    name: string;
+    /** True only once the board has been exercised on real hardware through OpenMouse. */
+    verified: boolean;
+}
+/**
+ * Known product IDs. Only the 60HE+ is listed until other boards are captured
+ * with `openmouse-collect` and confirmed on hardware.
+ */
+export declare const WOOTING_PRODUCTS: ReadonlyMap<number, WootingProduct>;
+export declare const WOOTING_PRODUCT_IDS: readonly number[];
+export declare const WOOTING_COMMAND_SIZE = 8;
+export declare const WOOTING_MAGIC_SINGLE = 208;
+export declare const WOOTING_MAGIC_MULTI = 209;
+export declare const WOOTING_MAGIC_WORD_1 = 218;
+/**
+ * Command IDs from the D0DA command table (the `d0da` project's
+ * `d0da_feature.py`, cross-checked with the RGB SDK). Only read-only queries are
+ * listed here — deliberately NOT the neighbouring destructive ones
+ * (`reset_to_bootloader = 0x02`, `keys_off = 0x15`, `do_soft_reset = 0x19`).
+ */
+export declare const WOOTING_COMMAND: {
+    /** get_version — firmware version. */
+    readonly getVersion: 1;
+    /** get_serial — device serial number. */
+    readonly getSerial: 3;
+    /** get_current_keyboard_profile_index — which onboard profile is active. */
+    readonly getCurrentKeyboardProfileIndex: 11;
+    /** get_actuation_profile — per-key actuation overrides for a profile. */
+    readonly getActuationProfile: 49;
+    /** get_keyboard_profile — the active profile: actuation (field 1, mm × 20480), rapid trigger, etc. */
+    readonly getKeyboardProfile: 39;
+    /** get_settings — global device settings protobuf. */
+    readonly getSettings: 51;
+    /** get_device_config — board layout / config block. */
+    readonly getDeviceConfig: 19;
+};
+/** Total key travel of a Wooting Lekker/analog switch, in millimetres (0–255 maps onto this). */
+export declare const WOOTING_TRAVEL_MM = 4;
+/** Convert a raw 0–255 analog value to millimetres of travel. */
+export declare function wootingAnalogMm(value: number): number;
+/** One decoded protobuf field: its number, wire type, and value(s). */
+export interface ProtobufField {
+    field: number;
+    wire: number;
+    /** varint / 32-bit / 64-bit numeric value (wire 0/5/1). */
+    int?: number;
+    /** the same 32-/64-bit value read as a float, for spotting mm settings. */
+    float?: number;
+    /** length-delimited payload (wire 2) — sub-message or string/bytes. */
+    bytes?: Uint8Array;
+}
+/**
+ * Decode a protobuf message into its raw fields — no schema needed, because the
+ * wire format tags every field with its number and type. Used to read the
+ * Wooting profile blob and pick out the actuation / rapid-trigger values by
+ * correlating with known settings. Returns [] if the bytes are not valid protobuf.
+ */
+export declare function decodeProtobufFields(data: Uint8Array): ProtobufField[];
+/** Decoded actuation / rapid-trigger settings for the active profile. */
+export interface WootingActuation {
+    /** Actuation point in millimetres (the depth at which a press registers). */
+    actuationMm: number;
+    /** Whether rapid trigger is enabled. */
+    rapidTrigger: boolean;
+    /** Rapid-trigger sensitivity in millimetres, when rapid trigger is on. */
+    rapidTriggerSensitivityMm: number | null;
+    /** Continuous rapid trigger (release only when the key fully lifts). */
+    continuousRapidTrigger: boolean;
+}
+/** Raw global settings decoded from a get_settings (0x33) reply. */
+export interface WootingGlobalSettings {
+    /** Raw actuation value (nested field 1). Multiply by the mm factor to display. */
+    actuationRaw: number | null;
+    /** Raw rapid-trigger sensitivity value (nested field 2). */
+    rapidTriggerSensitivityRaw: number | null;
+}
+/**
+ * Decode the global settings from a `get_settings` (0x33) reply, confirmed on a
+ * real 60HE+: `d1 da 33 88 <len:u16> <protobuf>`. The body's field 1 is a nested
+ * message whose field 1 is the global actuation and field 2 the rapid-trigger
+ * sensitivity (raw units). Example `08 05 10 0a` → actuation 5, RT sensitivity 10
+ * for a keyboard set to 0.20mm / 0.15mm.
+ */
+/**
+ * Decode the nested-message fields of a profile reply
+ * (`magic magic cmd status <len:u16> 0a <len> <nested>`). Returns the nested
+ * message's fields as {field, value}. Used to read the keyboard profile (0x27),
+ * whose field 1 is the actuation (stored as mm × 20480).
+ */
+export declare function decodeWootingProfileFields(reply: Uint8Array): Array<{
+    field: number;
+    value: number;
+}>;
+/**
+ * Millimetres of actuation from the keyboard profile's raw value. Confirmed on a
+ * 60HE+ across two settings: 1.00mm → 20480, 0.50mm → 18432, i.e. a line
+ * `raw = 16384 + mm * 4096` (raw 0x4000 = 0mm, 0x8000 = 4mm).
+ */
+export declare const WOOTING_ACTUATION_ZERO = 16384;
+export declare const WOOTING_ACTUATION_UNITS_PER_MM = 4096;
+export declare function wootingActuationMm(raw: number): number;
+export declare function decodeWootingGlobalSettings(reply: Uint8Array): WootingGlobalSettings | null;
+export interface WootingCommandOptions {
+    /** Multi-report (v3) boards use magic 0xD1 and report index 1. The 60HE+ does not. */
+    multiReport?: boolean;
+}
+/**
+ * Build the full 8-byte command buffer exactly as the SDK lays it out, with the
+ * hidapi report-index byte first. Transports that take the report id separately
+ * (WebHID) should send `buffer[0]` as the report id and `buffer.subarray(1)` as
+ * the data — see {@link wootingFeatureReport}.
+ */
+export declare function encodeWootingCommand(commandId: number, param0?: number, param1?: number, param2?: number, param3?: number, { multiReport }?: WootingCommandOptions): Uint8Array;
+/**
+ * Split an encoded command into the `{ reportId, data }` pair a WebHID
+ * `sendFeatureReport(reportId, data)` call expects: the leading hidapi index
+ * byte becomes the report id, and the remaining seven bytes are the data.
+ */
+export declare function wootingFeatureReport(buffer: Uint8Array): {
+    reportId: number;
+    data: Uint8Array<ArrayBuffer>;
+};
+/**
+ * Board physical layout as reported in the device-config response. Values follow
+ * the SDK's `WOOTING_DEVICE_LAYOUT` enum (wooting-usb.h); anything outside it is
+ * surfaced as `Unknown` with the raw id kept.
+ */
+export type WootingLayout = "ANSI" | "ISO" | "JIS" | "ANSI Split" | "ISO Split" | "Unknown";
+export interface WootingDeviceConfig {
+    layout: WootingLayout;
+    /** Raw layout byte, preserved for boards whose value we do not name yet. */
+    layoutId: number;
+}
+/**
+ * Offset of the layout byte inside the device-config response as WebHID delivers
+ * it. The Wooting SDK reads index 10, but its buffer includes the leading
+ * report-id byte that a WebHID `inputreport` event strips, so the same field
+ * sits at index 9 here — confirmed against a 60HE+ reply
+ * (`d1 da 13 88 07 00 00 00 00 00 …`, byte 9 = 0x00 = ANSI).
+ */
+export declare const WOOTING_DEVICE_CONFIG_LAYOUT_OFFSET = 9;
+/**
+ * Decode the layout out of a device-config response. `response` is the raw input
+ * report payload (no report-id prefix, matching the WebHID `inputreport` event).
+ * Returns `null` when the buffer is too short to trust.
+ */
+export declare function decodeWootingDeviceConfig(response: Uint8Array, offset?: number): WootingDeviceConfig | null;
+/**
+ * True when a buffer looks like a genuine Wooting command reply: it starts with
+ * the magic word (`0xD0` or `0xD1`, then `0xDA`) and is long enough to carry a
+ * command byte. Used to reject stub responses — e.g. a feature GET that echoes
+ * only the report id — so the driver waits for the real input-report reply.
+ */
+export declare function isWootingReply(bytes: Uint8Array): boolean;
+/** Offset of the `major` byte in a get_version reply (minor/patch follow). */
+export declare const WOOTING_VERSION_OFFSET = 6;
+/**
+ * Decode the firmware version out of a `get_version` reply.
+ *
+ * Confirmed against a real 60HE+ answer `d1 da 01 88 03 00 02 0d 00 …` whose
+ * Wootility-reported version is v2.13.0: after the 4-byte header
+ * (`magic0 magic1 command status`, status 0x88 = OK) and a two-byte leading
+ * field, the version is `major minor patch` at offset 6 — here 2, 13, 0 → "2.13.0".
+ * Returns null when the reply is not a version answer or carries no version.
+ */
+export declare function decodeWootingVersion(reply: Uint8Array): string | null;
+/** One key's live analog reading: a USB HID keyboard usage id and its 0–255 travel. */
+export interface WootingAnalogKey {
+    /** USB HID keyboard/keypad usage id (e.g. 0x04 = A). */
+    usage: number;
+    /** Analog value, 0 (released) to 255 (fully pressed). */
+    value: number;
+}
+/**
+ * Decode one analog input report from the Wooting analog stream (the 0xFF53
+ * interface). The report is a run of 3-byte entries `[usageHigh, usage, value]`;
+ * a full snapshot of the currently-pressed keys arrives on every event (a key at
+ * value 0 / usage 0 is absent). Layout matches the community WebHID readers
+ * (colecrouter/wooting-js). Returns the pressed keys in a stable order (by usage
+ * id) so a live UI can keep each key's row in place instead of reordering as
+ * values fluctuate.
+ */
+export declare function decodeWootingAnalogReport(data: Uint8Array): WootingAnalogKey[];
+/** Human name for a product id, falling back to a generic Wooting label. */
+export declare function wootingProductName(productId: number): string;
+//# sourceMappingURL=index.d.ts.map

package/dist/wooting/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/wooting/index.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;;;;;;;GAqBG;AAEH,2FAA2F;AAC3F,eAAO,MAAM,iBAAiB,QAAS,CAAC;AACxC,yFAAyF;AACzF,eAAO,MAAM,wBAAwB,OAAS,CAAC;AAE/C;;;;;;GAMG;AACH,eAAO,MAAM,yBAAyB,QAAS,CAAC;AAChD,eAAO,MAAM,gCAAgC,QAAS,CAAC;AACvD,0DAA0D;AAC1D,eAAO,MAAM,yBAAyB,QAAS,CAAC;AAChD,eAAO,MAAM,oBAAoB,IAAO,CAAC;AAEzC,MAAM,WAAW,cAAc;IAC7B,IAAI,EAAE,MAAM,CAAC;IACb,sFAAsF;IACtF,QAAQ,EAAE,OAAO,CAAC;CACnB;AAED;;;GAGG;AACH,eAAO,MAAM,gBAAgB,EAAE,WAAW,CAAC,MAAM,EAAE,cAAc,CAE/D,CAAC;AAEH,eAAO,MAAM,mBAAmB,EAAE,SAAS,MAAM,EAAiC,CAAC;AAEnF,eAAO,MAAM,oBAAoB,IAAI,CAAC;AACtC,eAAO,MAAM,oBAAoB,MAAO,CAAC;AACzC,eAAO,MAAM,mBAAmB,MAAO,CAAC;AACxC,eAAO,MAAM,oBAAoB,MAAO,CAAC;AAEzC;;;;;GAKG;AACH,eAAO,MAAM,eAAe;IAC1B,sCAAsC;;IAEtC,yCAAyC;;IAEzC,4EAA4E;;IAE5E,yEAAyE;;IAEzE,sGAAsG;;IAEtG,sDAAsD;;IAEtD,uDAAuD;;CAE/C,CAAC;AAEX,iGAAiG;AACjG,eAAO,MAAM,iBAAiB,IAAM,CAAC;AAErC,iEAAiE;AACjE,wBAAgB,eAAe,CAAC,KAAK,EAAE,MAAM,GAAG,MAAM,CAErD;AAED,uEAAuE;AACvE,MAAM,WAAW,aAAa;IAC5B,KAAK,EAAE,MAAM,CAAC;IACd,IAAI,EAAE,MAAM,CAAC;IACb,2DAA2D;IAC3D,GAAG,CAAC,EAAE,MAAM,CAAC;IACb,2EAA2E;IAC3E,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,uEAAuE;IACvE,KAAK,CAAC,EAAE,UAAU,CAAC;CACpB;AAgBD;;;;;GAKG;AACH,wBAAgB,oBAAoB,CAAC,IAAI,EAAE,UAAU,GAAG,aAAa,EAAE,CAkCtE;AAED,yEAAyE;AACzE,MAAM,WAAW,gBAAgB;IAC/B,6EAA6E;IAC7E,WAAW,EAAE,MAAM,CAAC;IACpB,wCAAwC;IACxC,YAAY,EAAE,OAAO,CAAC;IACtB,0EAA0E;IAC1E,yBAAyB,EAAE,MAAM,GAAG,IAAI,CAAC;IACzC,wEAAwE;IACxE,sBAAsB,EAAE,OAAO,CAAC;CACjC;AAED,oEAAoE;AACpE,MAAM,WAAW,qBAAqB;IACpC,kFAAkF;IAClF,YAAY,EAAE,MAAM,GAAG,IAAI,CAAC;IAC5B,4DAA4D;IAC5D,0BAA0B,EAAE,MAAM,GAAG,IAAI,CAAC;CAC3C;AAED;;;;;;GAMG;AACH;;;;;GAKG;AACH,wBAAgB,0BAA0B,CAAC,KAAK,EAAE,UAAU,GAAG,KAAK,CAAC;IAAE,KAAK,EAAE,MAAM,CAAC;IAAC,KAAK,EAAE,MAAM,CAAA;CAAE,CAAC,CASrG;AAED;;;;GAIG;AACH,eAAO,MAAM,sBAAsB,QAAQ,CAAC;AAC5C,eAAO,MAAM,8BAA8B,OAAO,CAAC;AACnD,wBAAgB,kBAAkB,CAAC,GAAG,EAAE,MAAM,GAAG,MAAM,CAEtD;AAED,wBAAgB,2BAA2B,CAAC,KAAK,EAAE,UAAU,GAAG,qBAAqB,GAAG,IAAI,CAS3F;AAED,MAAM,WAAW,qBAAqB;IACpC,sFAAsF;IACtF,WAAW,CAAC,EAAE,OAAO,CAAC;CACvB;AAED;;;;;GAKG;AACH,wBAAgB,oBAAoB,CAClC,SAAS,EAAE,MAAM,EACjB,MAAM,SAAI,EACV,MAAM,SAAI,EACV,MAAM,SAAI,EACV,MAAM,SAAI,EACV,EAAE,WAAmB,EAAE,GAAE,qBAA0B,GAClD,UAAU,CAWZ;AAED;;;;GAIG;AACH,wBAAgB,oBAAoB,CAAC,MAAM,EAAE,UAAU;;;EAEtD;AAED;;;;GAIG;AACH,MAAM,MAAM,aAAa,GAAG,MAAM,GAAG,KAAK,GAAG,KAAK,GAAG,YAAY,GAAG,WAAW,GAAG,SAAS,CAAC;AAW5F,MAAM,WAAW,mBAAmB;IAClC,MAAM,EAAE,aAAa,CAAC;IACtB,4EAA4E;IAC5E,QAAQ,EAAE,MAAM,CAAC;CAClB;AAED;;;;;;GAMG;AACH,eAAO,MAAM,mCAAmC,IAAI,CAAC;AAErD;;;;GAIG;AACH,wBAAgB,yBAAyB,CACvC,QAAQ,EAAE,UAAU,EACpB,MAAM,GAAE,MAA4C,GACnD,mBAAmB,GAAG,IAAI,CAI5B;AAED;;;;;GAKG;AACH,wBAAgB,cAAc,CAAC,KAAK,EAAE,UAAU,GAAG,OAAO,CAIzD;AAED,8EAA8E;AAC9E,eAAO,MAAM,sBAAsB,IAAI,CAAC;AAExC;;;;;;;;GAQG;AACH,wBAAgB,oBAAoB,CAAC,KAAK,EAAE,UAAU,GAAG,MAAM,GAAG,IAAI,CAMrE;AAED,uFAAuF;AACvF,MAAM,WAAW,gBAAgB;IAC/B,wDAAwD;IACxD,KAAK,EAAE,MAAM,CAAC;IACd,yDAAyD;IACzD,KAAK,EAAE,MAAM,CAAC;CACf;AAED;;;;;;;;GAQG;AACH,wBAAgB,yBAAyB,CAAC,IAAI,EAAE,UAAU,GAAG,gBAAgB,EAAE,CAQ9E;AAED,4EAA4E;AAC5E,wBAAgB,kBAAkB,CAAC,SAAS,EAAE,MAAM,GAAG,MAAM,CAE5D"}