@openmouse/protocol 0.1.0

package/dist/valkyrie/settings.js

@@ -0,0 +1,84 @@
+function readRequest(command) {
+    const payload = new Uint8Array(32);
+    payload[0] = command;
+    return payload;
+}
+export function valkyrieEncodePollingRequest() {
+    return readRequest(0x12);
+}
+export function valkyrieEncodeDpiRequest() {
+    return readRequest(0x13);
+}
+function replyView(payload, command, dataLength) {
+    if (payload.length !== 32)
+        return undefined;
+    if (payload[0] !== command || payload[1] !== 0 || payload[2] !== 1 || payload[3] !== dataLength) {
+        return undefined;
+    }
+    const checksum = payload.subarray(4, 31).reduce((sum, byte) => sum + byte, 0) & 0xff;
+    if (payload[31] !== checksum)
+        return undefined;
+    return new DataView(payload.buffer, payload.byteOffset, payload.byteLength);
+}
+/** Returns uninterpreted wire values and an independent copy of the complete reply. */
+export function valkyrieDecodePollingReply(payload) {
+    const view = replyView(payload, 0x12, 1);
+    if (!view)
+        return undefined;
+    return { pollingCodeRaw: view.getUint8(4), rawReply: payload.slice() };
+}
+/** The stage nibbles and six coordinate pairs remain raw; no DPI scale or index base is assumed. */
+export function valkyrieDecodeDpiReply(payload) {
+    const view = replyView(payload, 0x13, 0x19);
+    if (!view)
+        return undefined;
+    const stageByte = view.getUint8(4);
+    return {
+        activeCountRaw: stageByte & 0x0f,
+        activeIndexRaw: stageByte >>> 4,
+        stagesRaw: Array.from({ length: 6 }, (_, index) => ({
+            x: view.getUint16(5 + index * 4, true),
+            y: view.getUint16(7 + index * 4, true),
+        })),
+        rawReply: payload.slice(),
+    };
+}
+/** Codes 1/2/4/8 (1000/500/250/125 Hz); requires a complete validated polling read reply. */
+export function valkyrieEncodePollingWrite(rawReply, code) {
+    const settings = valkyrieDecodePollingReply(rawReply);
+    if (!settings)
+        throw new RangeError("Invalid Valkyrie polling reply");
+    if (code !== 1 && code !== 2 && code !== 4 && code !== 8) {
+        throw new RangeError("Valkyrie polling code must be 1, 2, 4, or 8");
+    }
+    const payload = settings.rawReply;
+    payload[0] = 0x02;
+    payload[4] = code;
+    payload[31] = payload.subarray(4, 31).reduce((sum, byte) => sum + byte, 0) & 0xff;
+    return payload;
+}
+/**
+ * Sensor-0x11 raw range only (1..232), with equal X/Y values. The caller must
+ * establish the sensor separately and restrict writes to active stages.
+ * Returns the verified 32-byte write payload, excluding transport report ID zero.
+ */
+export function valkyrieEncodeDpiStageWrite(rawReply, stage, rawValue) {
+    const settings = valkyrieDecodeDpiReply(rawReply);
+    if (!settings)
+        throw new RangeError("Invalid Valkyrie DPI reply");
+    if (!Number.isInteger(stage) || stage < 0 || stage > 5) {
+        throw new RangeError("Valkyrie DPI stage must be an integer from 0 through 5");
+    }
+    if (!Number.isInteger(rawValue) || rawValue < 1 || rawValue > 232) {
+        throw new RangeError("Valkyrie sensor-0x11 raw DPI must be an integer from 1 through 232");
+    }
+    const payload = settings.rawReply;
+    payload[0] = 0x03;
+    payload[3] = 0x25;
+    const view = new DataView(payload.buffer, payload.byteOffset, payload.byteLength);
+    view.setUint16(5 + stage * 4, rawValue, true);
+    view.setUint16(7 + stage * 4, rawValue, true);
+    payload[31] = payload.subarray(4, 31).reduce((sum, byte) => sum + byte, 0) & 0xff;
+    return payload;
+}
+//# sourceMappingURL=settings.js.map

package/dist/valkyrie/settings.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"settings.js","sourceRoot":"","sources":["../../src/valkyrie/settings.ts"],"names":[],"mappings":"AAYA,SAAS,WAAW,CAAC,OAAoB;IACvC,MAAM,OAAO,GAAG,IAAI,UAAU,CAAC,EAAE,CAAC,CAAC;IACnC,OAAO,CAAC,CAAC,CAAC,GAAG,OAAO,CAAC;IACrB,OAAO,OAAO,CAAC;AACjB,CAAC;AAED,MAAM,UAAU,4BAA4B;IAC1C,OAAO,WAAW,CAAC,IAAI,CAAC,CAAC;AAC3B,CAAC;AAED,MAAM,UAAU,wBAAwB;IACtC,OAAO,WAAW,CAAC,IAAI,CAAC,CAAC;AAC3B,CAAC;AAED,SAAS,SAAS,CAAC,OAAmB,EAAE,OAAe,EAAE,UAAkB;IACzE,IAAI,OAAO,CAAC,MAAM,KAAK,EAAE;QAAE,OAAO,SAAS,CAAC;IAC5C,IAAI,OAAO,CAAC,CAAC,CAAC,KAAK,OAAO,IAAI,OAAO,CAAC,CAAC,CAAC,KAAK,CAAC,IAAI,OAAO,CAAC,CAAC,CAAC,KAAK,CAAC,IAAI,OAAO,CAAC,CAAC,CAAC,KAAK,UAAU,EAAE,CAAC;QAChG,OAAO,SAAS,CAAC;IACnB,CAAC;IACD,MAAM,QAAQ,GAAG,OAAO,CAAC,QAAQ,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,MAAM,CAAC,CAAC,GAAG,EAAE,IAAI,EAAE,EAAE,CAAC,GAAG,GAAG,IAAI,EAAE,CAAC,CAAC,GAAG,IAAI,CAAC;IACrF,IAAI,OAAO,CAAC,EAAE,CAAC,KAAK,QAAQ;QAAE,OAAO,SAAS,CAAC;IAC/C,OAAO,IAAI,QAAQ,CAAC,OAAO,CAAC,MAAM,EAAE,OAAO,CAAC,UAAU,EAAE,OAAO,CAAC,UAAU,CAAC,CAAC;AAC9E,CAAC;AAED,uFAAuF;AACvF,MAAM,UAAU,0BAA0B,CAAC,OAAmB;IAC5D,MAAM,IAAI,GAAG,SAAS,CAAC,OAAO,EAAE,IAAI,EAAE,CAAC,CAAC,CAAC;IACzC,IAAI,CAAC,IAAI;QAAE,OAAO,SAAS,CAAC;IAC5B,OAAO,EAAE,cAAc,EAAE,IAAI,CAAC,QAAQ,CAAC,CAAC,CAAC,EAAE,QAAQ,EAAE,OAAO,CAAC,KAAK,EAAE,EAAE,CAAC;AACzE,CAAC;AAED,oGAAoG;AACpG,MAAM,UAAU,sBAAsB,CAAC,OAAmB;IACxD,MAAM,IAAI,GAAG,SAAS,CAAC,OAAO,EAAE,IAAI,EAAE,IAAI,CAAC,CAAC;IAC5C,IAAI,CAAC,IAAI;QAAE,OAAO,SAAS,CAAC;IAC5B,MAAM,SAAS,GAAG,IAAI,CAAC,QAAQ,CAAC,CAAC,CAAC,CAAC;IACnC,OAAO;QACL,cAAc,EAAE,SAAS,GAAG,IAAI;QAChC,cAAc,EAAE,SAAS,KAAK,CAAC;QAC/B,SAAS,EAAE,KAAK,CAAC,IAAI,CAAC,EAAE,MAAM,EAAE,CAAC,EAAE,EAAE,CAAC,CAAC,EAAE,KAAK,EAAE,EAAE,CAAC,CAAC;YAClD,CAAC,EAAE,IAAI,CAAC,SAAS,CAAC,CAAC,GAAG,KAAK,GAAG,CAAC,EAAE,IAAI,CAAC;YACtC,CAAC,EAAE,IAAI,CAAC,SAAS,CAAC,CAAC,GAAG,KAAK,GAAG,CAAC,EAAE,IAAI,CAAC;SACvC,CAAC,CAAC;QACH,QAAQ,EAAE,OAAO,CAAC,KAAK,EAAE;KAC1B,CAAC;AACJ,CAAC;AAED,6FAA6F;AAC7F,MAAM,UAAU,0BAA0B,CAAC,QAAoB,EAAE,IAAY;IAC3E,MAAM,QAAQ,GAAG,0BAA0B,CAAC,QAAQ,CAAC,CAAC;IACtD,IAAI,CAAC,QAAQ;QAAE,MAAM,IAAI,UAAU,CAAC,gCAAgC,CAAC,CAAC;IACtE,IAAI,IAAI,KAAK,CAAC,IAAI,IAAI,KAAK,CAAC,IAAI,IAAI,KAAK,CAAC,IAAI,IAAI,KAAK,CAAC,EAAE,CAAC;QACzD,MAAM,IAAI,UAAU,CAAC,6CAA6C,CAAC,CAAC;IACtE,CAAC;IACD,MAAM,OAAO,GAAG,QAAQ,CAAC,QAAQ,CAAC;IAClC,OAAO,CAAC,CAAC,CAAC,GAAG,IAAI,CAAC;IAClB,OAAO,CAAC,CAAC,CAAC,GAAG,IAAI,CAAC;IAClB,OAAO,CAAC,EAAE,CAAC,GAAG,OAAO,CAAC,QAAQ,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,MAAM,CAAC,CAAC,GAAG,EAAE,IAAI,EAAE,EAAE,CAAC,GAAG,GAAG,IAAI,EAAE,CAAC,CAAC,GAAG,IAAI,CAAC;IAClF,OAAO,OAAO,CAAC;AACjB,CAAC;AAED;;;;GAIG;AACH,MAAM,UAAU,2BAA2B,CAAC,QAAoB,EAAE,KAAa,EAAE,QAAgB;IAC/F,MAAM,QAAQ,GAAG,sBAAsB,CAAC,QAAQ,CAAC,CAAC;IAClD,IAAI,CAAC,QAAQ;QAAE,MAAM,IAAI,UAAU,CAAC,4BAA4B,CAAC,CAAC;IAClE,IAAI,CAAC,MAAM,CAAC,SAAS,CAAC,KAAK,CAAC,IAAI,KAAK,GAAG,CAAC,IAAI,KAAK,GAAG,CAAC,EAAE,CAAC;QACvD,MAAM,IAAI,UAAU,CAAC,wDAAwD,CAAC,CAAC;IACjF,CAAC;IACD,IAAI,CAAC,MAAM,CAAC,SAAS,CAAC,QAAQ,CAAC,IAAI,QAAQ,GAAG,CAAC,IAAI,QAAQ,GAAG,GAAG,EAAE,CAAC;QAClE,MAAM,IAAI,UAAU,CAAC,oEAAoE,CAAC,CAAC;IAC7F,CAAC;IACD,MAAM,OAAO,GAAG,QAAQ,CAAC,QAAQ,CAAC;IAClC,OAAO,CAAC,CAAC,CAAC,GAAG,IAAI,CAAC;IAClB,OAAO,CAAC,CAAC,CAAC,GAAG,IAAI,CAAC;IAClB,MAAM,IAAI,GAAG,IAAI,QAAQ,CAAC,OAAO,CAAC,MAAM,EAAE,OAAO,CAAC,UAAU,EAAE,OAAO,CAAC,UAAU,CAAC,CAAC;IAClF,IAAI,CAAC,SAAS,CAAC,CAAC,GAAG,KAAK,GAAG,CAAC,EAAE,QAAQ,EAAE,IAAI,CAAC,CAAC;IAC9C,IAAI,CAAC,SAAS,CAAC,CAAC,GAAG,KAAK,GAAG,CAAC,EAAE,QAAQ,EAAE,IAAI,CAAC,CAAC;IAC9C,OAAO,CAAC,EAAE,CAAC,GAAG,OAAO,CAAC,QAAQ,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,MAAM,CAAC,CAAC,GAAG,EAAE,IAAI,EAAE,EAAE,CAAC,GAAG,GAAG,IAAI,EAAE,CAAC,CAAC,GAAG,IAAI,CAAC;IAClF,OAAO,OAAO,CAAC;AACjB,CAAC"}

package/dist/vgn/index.d.ts

@@ -0,0 +1,59 @@
+export declare const VGN_REPORT_ID = 8;
+export declare const VGN_PAYLOAD_LENGTH = 16;
+export declare const VGN_MAX_CHUNK = 10;
+export declare const VGN_COMMAND: {
+    readonly handshake: 1;
+    readonly online: 3;
+    readonly battery: 4;
+    readonly write: 7;
+    readonly read: 8;
+    readonly profile: 14;
+    readonly firmware: 18;
+    readonly dongleFirmware: 29;
+};
+export declare const VGN_ADDRESS: {
+    readonly pollingRate: 0;
+    readonly dpiStageCount: 2;
+    readonly activeDpiStage: 4;
+    readonly lod: 10;
+    readonly dpiStages: 12;
+    readonly debounce: 169;
+    readonly motionSync: 171;
+    readonly sleep: 173;
+    readonly angleSnapping: 175;
+    readonly rippleControl: 177;
+    readonly performanceMode: 181;
+};
+export interface VgnBattery {
+    percent: number;
+    charging: boolean;
+    voltageMv: number;
+}
+export interface VgnProfile {
+    dpi: number;
+    dpiStageCount: number;
+    activeDpiStage: number;
+    pollingRateHz: number;
+    liftOffDistance: "Low" | "Medium" | "High" | null;
+    debounceMs: number | null;
+    sleepTimeout: number | null;
+    motionSync: boolean | null;
+    angleSnapping: boolean | null;
+    rippleControl: boolean | null;
+    performanceMode: boolean | null;
+}
+export declare function vgnReportChecksum(data15: Iterable<number>): number;
+export declare function vgnReportChecksumIsValid(payload: Uint8Array | readonly number[]): boolean;
+export declare function vgnBuildSimplePayload(command: number): Uint8Array;
+export declare function vgnBuildReadPayload(address: number, length: number): Uint8Array;
+export declare function vgnBuildWritePayload(address: number, data: readonly number[]): Uint8Array;
+export declare function vgnBuildWriteScalarPayload(address: number, value: number): Uint8Array;
+export declare function vgnParseReadResponse(response: Uint8Array, address: number, length: number): Uint8Array | null;
+export declare function vgnParseBattery(response: Uint8Array): VgnBattery | null;
+export declare function vgnEncodePollingRate(rate: number): number;
+export declare function vgnDecodePollingRate(raw: number): number | null;
+export declare function vgnEncodeDpi(dpi: number): Uint8Array;
+export declare function vgnDecodeDpi(stage: Uint8Array | readonly number[]): number | null;
+export declare function vgnUnpackScalar(value: number, parity: number): number | null;
+export declare function vgnDecodeProfile(profile: Uint8Array): VgnProfile;
+//# sourceMappingURL=index.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/vgn/index.ts"],"names":[],"mappings":"AAAA,eAAO,MAAM,aAAa,IAAO,CAAC;AAClC,eAAO,MAAM,kBAAkB,KAAK,CAAC;AACrC,eAAO,MAAM,aAAa,KAAK,CAAC;AAEhC,eAAO,MAAM,WAAW;;;;;;;;;CASd,CAAC;AAEX,eAAO,MAAM,WAAW;;;;;;;;;;;;CAYd,CAAC;AAEX,MAAM,WAAW,UAAU;IACzB,OAAO,EAAE,MAAM,CAAC;IAChB,QAAQ,EAAE,OAAO,CAAC;IAClB,SAAS,EAAE,MAAM,CAAC;CACnB;AAED,MAAM,WAAW,UAAU;IACzB,GAAG,EAAE,MAAM,CAAC;IACZ,aAAa,EAAE,MAAM,CAAC;IACtB,cAAc,EAAE,MAAM,CAAC;IACvB,aAAa,EAAE,MAAM,CAAC;IACtB,eAAe,EAAE,KAAK,GAAG,QAAQ,GAAG,MAAM,GAAG,IAAI,CAAC;IAClD,UAAU,EAAE,MAAM,GAAG,IAAI,CAAC;IAC1B,YAAY,EAAE,MAAM,GAAG,IAAI,CAAC;IAC5B,UAAU,EAAE,OAAO,GAAG,IAAI,CAAC;IAC3B,aAAa,EAAE,OAAO,GAAG,IAAI,CAAC;IAC9B,aAAa,EAAE,OAAO,GAAG,IAAI,CAAC;IAC9B,eAAe,EAAE,OAAO,GAAG,IAAI,CAAC;CACjC;AAQD,wBAAgB,iBAAiB,CAAC,MAAM,EAAE,QAAQ,CAAC,MAAM,CAAC,GAAG,MAAM,CAIlE;AAED,wBAAgB,wBAAwB,CAAC,OAAO,EAAE,UAAU,GAAG,SAAS,MAAM,EAAE,GAAG,OAAO,CAGzF;AAOD,wBAAgB,qBAAqB,CAAC,OAAO,EAAE,MAAM,GAAG,UAAU,CAKjE;AAED,wBAAgB,mBAAmB,CAAC,OAAO,EAAE,MAAM,EAAE,MAAM,EAAE,MAAM,GAAG,UAAU,CAQ/E;AAED,wBAAgB,oBAAoB,CAAC,OAAO,EAAE,MAAM,EAAE,IAAI,EAAE,SAAS,MAAM,EAAE,GAAG,UAAU,CASzF;AAED,wBAAgB,0BAA0B,CAAC,OAAO,EAAE,MAAM,EAAE,KAAK,EAAE,MAAM,GAAG,UAAU,CAGrF;AAED,wBAAgB,oBAAoB,CAAC,QAAQ,EAAE,UAAU,EAAE,OAAO,EAAE,MAAM,EAAE,MAAM,EAAE,MAAM,GAAG,UAAU,GAAG,IAAI,CAM7G;AAED,wBAAgB,eAAe,CAAC,QAAQ,EAAE,UAAU,GAAG,UAAU,GAAG,IAAI,CASvE;AAED,wBAAgB,oBAAoB,CAAC,IAAI,EAAE,MAAM,GAAG,MAAM,CAKzD;AAED,wBAAgB,oBAAoB,CAAC,GAAG,EAAE,MAAM,GAAG,MAAM,GAAG,IAAI,CAE/D;AAED,wBAAgB,YAAY,CAAC,GAAG,EAAE,MAAM,GAAG,UAAU,CASpD;AAED,wBAAgB,YAAY,CAAC,KAAK,EAAE,UAAU,GAAG,SAAS,MAAM,EAAE,GAAG,MAAM,GAAG,IAAI,CAQjF;AAED,wBAAgB,eAAe,CAAC,KAAK,EAAE,MAAM,EAAE,MAAM,EAAE,MAAM,GAAG,MAAM,GAAG,IAAI,CAE5E;AAED,wBAAgB,gBAAgB,CAAC,OAAO,EAAE,UAAU,GAAG,UAAU,CA4BhE"}

package/dist/vgn/index.js

@@ -0,0 +1,165 @@
+export const VGN_REPORT_ID = 0x08;
+export const VGN_PAYLOAD_LENGTH = 16;
+export const VGN_MAX_CHUNK = 10;
+export const VGN_COMMAND = {
+    handshake: 0x01,
+    online: 0x03,
+    battery: 0x04,
+    write: 0x07,
+    read: 0x08,
+    profile: 0x0e,
+    firmware: 0x12,
+    dongleFirmware: 0x1d,
+};
+export const VGN_ADDRESS = {
+    pollingRate: 0x00,
+    dpiStageCount: 0x02,
+    activeDpiStage: 0x04,
+    lod: 0x0a,
+    dpiStages: 0x0c,
+    debounce: 0xa9,
+    motionSync: 0xab,
+    sleep: 0xad,
+    angleSnapping: 0xaf,
+    rippleControl: 0xb1,
+    performanceMode: 0xb5,
+};
+function assertByte(value, label) {
+    if (!Number.isInteger(value) || value < 0 || value > 0xff) {
+        throw new Error(`${label} must be one byte.`);
+    }
+}
+export function vgnReportChecksum(data15) {
+    let sum = VGN_REPORT_ID;
+    for (const byte of data15)
+        sum += byte & 0xff;
+    return (0x55 - (sum & 0xff)) & 0xff;
+}
+export function vgnReportChecksumIsValid(payload) {
+    if (payload.length !== VGN_PAYLOAD_LENGTH)
+        return false;
+    return ((VGN_REPORT_ID + [...payload].reduce((sum, byte) => sum + (byte & 0xff), 0)) & 0xff) === 0x55;
+}
+function finalize(payload) {
+    payload[15] = vgnReportChecksum(payload.subarray(0, 15));
+    return payload;
+}
+export function vgnBuildSimplePayload(command) {
+    assertByte(command, "VGN command");
+    const payload = new Uint8Array(VGN_PAYLOAD_LENGTH);
+    payload[0] = command;
+    return finalize(payload);
+}
+export function vgnBuildReadPayload(address, length) {
+    if (!Number.isInteger(address) || address < 0 || address > 0xffff)
+        throw new Error("VGN address is out of range.");
+    if (!Number.isInteger(length) || length < 1 || length > VGN_MAX_CHUNK)
+        throw new Error("VGN read length must be 1–10 bytes.");
+    const payload = vgnBuildSimplePayload(VGN_COMMAND.read);
+    payload[2] = address >> 8;
+    payload[3] = address & 0xff;
+    payload[4] = length;
+    return finalize(payload);
+}
+export function vgnBuildWritePayload(address, data) {
+    if (!Number.isInteger(address) || address < 0 || address > 0xffff)
+        throw new Error("VGN address is out of range.");
+    if (data.length < 1 || data.length > VGN_MAX_CHUNK)
+        throw new Error("VGN write length must be 1–10 bytes.");
+    const payload = vgnBuildSimplePayload(VGN_COMMAND.write);
+    payload[2] = address >> 8;
+    payload[3] = address & 0xff;
+    payload[4] = data.length;
+    payload.set(data.map((byte) => byte & 0xff), 5);
+    return finalize(payload);
+}
+export function vgnBuildWriteScalarPayload(address, value) {
+    assertByte(value, "VGN scalar");
+    return vgnBuildWritePayload(address, [value, (0x55 - value) & 0xff]);
+}
+export function vgnParseReadResponse(response, address, length) {
+    if (!vgnReportChecksumIsValid(response))
+        return null;
+    if (response[0] !== VGN_COMMAND.read || response[1] !== 0)
+        return null;
+    if (response[2] !== ((address >> 8) & 0xff) || response[3] !== (address & 0xff))
+        return null;
+    if (response[4] !== length || response.length < 5 + length)
+        return null;
+    return response.slice(5, 5 + length);
+}
+export function vgnParseBattery(response) {
+    if (!vgnReportChecksumIsValid(response) || response[0] !== VGN_COMMAND.battery || response[1] !== 0)
+        return null;
+    const percent = response[5];
+    if (percent === undefined || percent > 100)
+        return null;
+    return {
+        percent,
+        charging: response[6] === 1,
+        voltageMv: ((response[7] ?? 0) << 8) | (response[8] ?? 0),
+    };
+}
+export function vgnEncodePollingRate(rate) {
+    const raw = { 125: 8, 250: 4, 500: 2, 1000: 1, 2000: 16, 4000: 32, 8000: 64 };
+    const value = raw[rate];
+    if (value === undefined)
+        throw new Error("VGN polling rate must be 125, 250, 500, 1000, 2000, 4000, or 8000 Hz.");
+    return value;
+}
+export function vgnDecodePollingRate(raw) {
+    return { 8: 125, 4: 250, 2: 500, 1: 1000, 16: 2000, 32: 4000, 64: 8000 }[raw] ?? null;
+}
+export function vgnEncodeDpi(dpi) {
+    if (!Number.isInteger(dpi) || dpi < 50 || dpi > 26000 || dpi % 50 !== 0) {
+        throw new Error("VGN DPI must be 50–26,000 in 50 DPI steps.");
+    }
+    const encoded = dpi / 50 - 1;
+    const low = encoded & 0xff;
+    const high = (encoded >> 8) & 0x03;
+    const flags = (high << 2) | (high << 6);
+    return new Uint8Array([low, low, flags, (0x55 - low - low - flags) & 0xff]);
+}
+export function vgnDecodeDpi(stage) {
+    if (stage.length < 4)
+        return null;
+    const low = stage[0] & 0xff;
+    const duplicate = stage[1] & 0xff;
+    const flags = stage[2] & 0xff;
+    const checksum = stage[3] & 0xff;
+    if (low !== duplicate || ((low + duplicate + flags + checksum) & 0xff) !== 0x55)
+        return null;
+    return ((((flags >> 2) & 0x03) << 8) + low + 1) * 50;
+}
+export function vgnUnpackScalar(value, parity) {
+    return ((value + parity) & 0xff) === 0x55 ? value : null;
+}
+export function vgnDecodeProfile(profile) {
+    const scalar = (address) => profile.length > address + 1
+        ? vgnUnpackScalar(profile[address], profile[address + 1])
+        : null;
+    const stageCount = Math.min(Math.max(scalar(VGN_ADDRESS.dpiStageCount) ?? 1, 1), 8);
+    const activeStage = Math.min(Math.max(scalar(VGN_ADDRESS.activeDpiStage) ?? 0, 0), stageCount - 1);
+    const stageOffset = VGN_ADDRESS.dpiStages + activeStage * 4;
+    const dpi = vgnDecodeDpi(profile.subarray(stageOffset, stageOffset + 4)) ?? 800;
+    const lodRaw = scalar(VGN_ADDRESS.lod);
+    const pollingRaw = scalar(VGN_ADDRESS.pollingRate);
+    const boolean = (address) => {
+        const value = scalar(address);
+        return value === null ? null : value !== 0;
+    };
+    return {
+        dpi,
+        dpiStageCount: stageCount,
+        activeDpiStage: activeStage,
+        pollingRateHz: pollingRaw === null ? 1000 : (vgnDecodePollingRate(pollingRaw) ?? 1000),
+        liftOffDistance: lodRaw === 3 ? "Low" : lodRaw === 1 ? "Medium" : lodRaw === 2 ? "High" : null,
+        debounceMs: scalar(VGN_ADDRESS.debounce),
+        sleepTimeout: (scalar(VGN_ADDRESS.sleep) ?? 0) * 10 || null,
+        motionSync: boolean(VGN_ADDRESS.motionSync),
+        angleSnapping: boolean(VGN_ADDRESS.angleSnapping),
+        rippleControl: boolean(VGN_ADDRESS.rippleControl),
+        performanceMode: boolean(VGN_ADDRESS.performanceMode),
+    };
+}
+//# sourceMappingURL=index.js.map

package/dist/vgn/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/vgn/index.ts"],"names":[],"mappings":"AAAA,MAAM,CAAC,MAAM,aAAa,GAAG,IAAI,CAAC;AAClC,MAAM,CAAC,MAAM,kBAAkB,GAAG,EAAE,CAAC;AACrC,MAAM,CAAC,MAAM,aAAa,GAAG,EAAE,CAAC;AAEhC,MAAM,CAAC,MAAM,WAAW,GAAG;IACzB,SAAS,EAAE,IAAI;IACf,MAAM,EAAE,IAAI;IACZ,OAAO,EAAE,IAAI;IACb,KAAK,EAAE,IAAI;IACX,IAAI,EAAE,IAAI;IACV,OAAO,EAAE,IAAI;IACb,QAAQ,EAAE,IAAI;IACd,cAAc,EAAE,IAAI;CACZ,CAAC;AAEX,MAAM,CAAC,MAAM,WAAW,GAAG;IACzB,WAAW,EAAE,IAAI;IACjB,aAAa,EAAE,IAAI;IACnB,cAAc,EAAE,IAAI;IACpB,GAAG,EAAE,IAAI;IACT,SAAS,EAAE,IAAI;IACf,QAAQ,EAAE,IAAI;IACd,UAAU,EAAE,IAAI;IAChB,KAAK,EAAE,IAAI;IACX,aAAa,EAAE,IAAI;IACnB,aAAa,EAAE,IAAI;IACnB,eAAe,EAAE,IAAI;CACb,CAAC;AAsBX,SAAS,UAAU,CAAC,KAAa,EAAE,KAAa;IAC9C,IAAI,CAAC,MAAM,CAAC,SAAS,CAAC,KAAK,CAAC,IAAI,KAAK,GAAG,CAAC,IAAI,KAAK,GAAG,IAAI,EAAE,CAAC;QAC1D,MAAM,IAAI,KAAK,CAAC,GAAG,KAAK,oBAAoB,CAAC,CAAC;IAChD,CAAC;AACH,CAAC;AAED,MAAM,UAAU,iBAAiB,CAAC,MAAwB;IACxD,IAAI,GAAG,GAAG,aAAa,CAAC;IACxB,KAAK,MAAM,IAAI,IAAI,MAAM;QAAE,GAAG,IAAI,IAAI,GAAG,IAAI,CAAC;IAC9C,OAAO,CAAC,IAAI,GAAG,CAAC,GAAG,GAAG,IAAI,CAAC,CAAC,GAAG,IAAI,CAAC;AACtC,CAAC;AAED,MAAM,UAAU,wBAAwB,CAAC,OAAuC;IAC9E,IAAI,OAAO,CAAC,MAAM,KAAK,kBAAkB;QAAE,OAAO,KAAK,CAAC;IACxD,OAAO,CAAC,CAAC,aAAa,GAAG,CAAC,GAAG,OAAO,CAAC,CAAC,MAAM,CAAC,CAAC,GAAG,EAAE,IAAI,EAAE,EAAE,CAAC,GAAG,GAAG,CAAC,IAAI,GAAG,IAAI,CAAC,EAAE,CAAC,CAAC,CAAC,GAAG,IAAI,CAAC,KAAK,IAAI,CAAC;AACxG,CAAC;AAED,SAAS,QAAQ,CAAC,OAAmB;IACnC,OAAO,CAAC,EAAE,CAAC,GAAG,iBAAiB,CAAC,OAAO,CAAC,QAAQ,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC;IACzD,OAAO,OAAO,CAAC;AACjB,CAAC;AAED,MAAM,UAAU,qBAAqB,CAAC,OAAe;IACnD,UAAU,CAAC,OAAO,EAAE,aAAa,CAAC,CAAC;IACnC,MAAM,OAAO,GAAG,IAAI,UAAU,CAAC,kBAAkB,CAAC,CAAC;IACnD,OAAO,CAAC,CAAC,CAAC,GAAG,OAAO,CAAC;IACrB,OAAO,QAAQ,CAAC,OAAO,CAAC,CAAC;AAC3B,CAAC;AAED,MAAM,UAAU,mBAAmB,CAAC,OAAe,EAAE,MAAc;IACjE,IAAI,CAAC,MAAM,CAAC,SAAS,CAAC,OAAO,CAAC,IAAI,OAAO,GAAG,CAAC,IAAI,OAAO,GAAG,MAAM;QAAE,MAAM,IAAI,KAAK,CAAC,8BAA8B,CAAC,CAAC;IACnH,IAAI,CAAC,MAAM,CAAC,SAAS,CAAC,MAAM,CAAC,IAAI,MAAM,GAAG,CAAC,IAAI,MAAM,GAAG,aAAa;QAAE,MAAM,IAAI,KAAK,CAAC,qCAAqC,CAAC,CAAC;IAC9H,MAAM,OAAO,GAAG,qBAAqB,CAAC,WAAW,CAAC,IAAI,CAAC,CAAC;IACxD,OAAO,CAAC,CAAC,CAAC,GAAG,OAAO,IAAI,CAAC,CAAC;IAC1B,OAAO,CAAC,CAAC,CAAC,GAAG,OAAO,GAAG,IAAI,CAAC;IAC5B,OAAO,CAAC,CAAC,CAAC,GAAG,MAAM,CAAC;IACpB,OAAO,QAAQ,CAAC,OAAO,CAAC,CAAC;AAC3B,CAAC;AAED,MAAM,UAAU,oBAAoB,CAAC,OAAe,EAAE,IAAuB;IAC3E,IAAI,CAAC,MAAM,CAAC,SAAS,CAAC,OAAO,CAAC,IAAI,OAAO,GAAG,CAAC,IAAI,OAAO,GAAG,MAAM;QAAE,MAAM,IAAI,KAAK,CAAC,8BAA8B,CAAC,CAAC;IACnH,IAAI,IAAI,CAAC,MAAM,GAAG,CAAC,IAAI,IAAI,CAAC,MAAM,GAAG,aAAa;QAAE,MAAM,IAAI,KAAK,CAAC,sCAAsC,CAAC,CAAC;IAC5G,MAAM,OAAO,GAAG,qBAAqB,CAAC,WAAW,CAAC,KAAK,CAAC,CAAC;IACzD,OAAO,CAAC,CAAC,CAAC,GAAG,OAAO,IAAI,CAAC,CAAC;IAC1B,OAAO,CAAC,CAAC,CAAC,GAAG,OAAO,GAAG,IAAI,CAAC;IAC5B,OAAO,CAAC,CAAC,CAAC,GAAG,IAAI,CAAC,MAAM,CAAC;IACzB,OAAO,CAAC,GAAG,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC,IAAI,EAAE,EAAE,CAAC,IAAI,GAAG,IAAI,CAAC,EAAE,CAAC,CAAC,CAAC;IAChD,OAAO,QAAQ,CAAC,OAAO,CAAC,CAAC;AAC3B,CAAC;AAED,MAAM,UAAU,0BAA0B,CAAC,OAAe,EAAE,KAAa;IACvE,UAAU,CAAC,KAAK,EAAE,YAAY,CAAC,CAAC;IAChC,OAAO,oBAAoB,CAAC,OAAO,EAAE,CAAC,KAAK,EAAE,CAAC,IAAI,GAAG,KAAK,CAAC,GAAG,IAAI,CAAC,CAAC,CAAC;AACvE,CAAC;AAED,MAAM,UAAU,oBAAoB,CAAC,QAAoB,EAAE,OAAe,EAAE,MAAc;IACxF,IAAI,CAAC,wBAAwB,CAAC,QAAQ,CAAC;QAAE,OAAO,IAAI,CAAC;IACrD,IAAI,QAAQ,CAAC,CAAC,CAAC,KAAK,WAAW,CAAC,IAAI,IAAI,QAAQ,CAAC,CAAC,CAAC,KAAK,CAAC;QAAE,OAAO,IAAI,CAAC;IACvE,IAAI,QAAQ,CAAC,CAAC,CAAC,KAAK,CAAC,CAAC,OAAO,IAAI,CAAC,CAAC,GAAG,IAAI,CAAC,IAAI,QAAQ,CAAC,CAAC,CAAC,KAAK,CAAC,OAAO,GAAG,IAAI,CAAC;QAAE,OAAO,IAAI,CAAC;IAC7F,IAAI,QAAQ,CAAC,CAAC,CAAC,KAAK,MAAM,IAAI,QAAQ,CAAC,MAAM,GAAG,CAAC,GAAG,MAAM;QAAE,OAAO,IAAI,CAAC;IACxE,OAAO,QAAQ,CAAC,KAAK,CAAC,CAAC,EAAE,CAAC,GAAG,MAAM,CAAC,CAAC;AACvC,CAAC;AAED,MAAM,UAAU,eAAe,CAAC,QAAoB;IAClD,IAAI,CAAC,wBAAwB,CAAC,QAAQ,CAAC,IAAI,QAAQ,CAAC,CAAC,CAAC,KAAK,WAAW,CAAC,OAAO,IAAI,QAAQ,CAAC,CAAC,CAAC,KAAK,CAAC;QAAE,OAAO,IAAI,CAAC;IACjH,MAAM,OAAO,GAAG,QAAQ,CAAC,CAAC,CAAC,CAAC;IAC5B,IAAI,OAAO,KAAK,SAAS,IAAI,OAAO,GAAG,GAAG;QAAE,OAAO,IAAI,CAAC;IACxD,OAAO;QACL,OAAO;QACP,QAAQ,EAAE,QAAQ,CAAC,CAAC,CAAC,KAAK,CAAC;QAC3B,SAAS,EAAE,CAAC,CAAC,QAAQ,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,IAAI,CAAC,CAAC,GAAG,CAAC,QAAQ,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC;KAC1D,CAAC;AACJ,CAAC;AAED,MAAM,UAAU,oBAAoB,CAAC,IAAY;IAC/C,MAAM,GAAG,GAA2B,EAAE,GAAG,EAAE,CAAC,EAAE,GAAG,EAAE,CAAC,EAAE,GAAG,EAAE,CAAC,EAAE,IAAI,EAAE,CAAC,EAAE,IAAI,EAAE,EAAE,EAAE,IAAI,EAAE,EAAE,EAAE,IAAI,EAAE,EAAE,EAAE,CAAC;IACtG,MAAM,KAAK,GAAG,GAAG,CAAC,IAAI,CAAC,CAAC;IACxB,IAAI,KAAK,KAAK,SAAS;QAAE,MAAM,IAAI,KAAK,CAAC,uEAAuE,CAAC,CAAC;IAClH,OAAO,KAAK,CAAC;AACf,CAAC;AAED,MAAM,UAAU,oBAAoB,CAAC,GAAW;IAC9C,OAAQ,EAAE,CAAC,EAAE,GAAG,EAAE,CAAC,EAAE,GAAG,EAAE,CAAC,EAAE,GAAG,EAAE,CAAC,EAAE,IAAI,EAAE,EAAE,EAAE,IAAI,EAAE,EAAE,EAAE,IAAI,EAAE,EAAE,EAAE,IAAI,EAA6B,CAAC,GAAG,CAAC,IAAI,IAAI,CAAC;AACpH,CAAC;AAED,MAAM,UAAU,YAAY,CAAC,GAAW;IACtC,IAAI,CAAC,MAAM,CAAC,SAAS,CAAC,GAAG,CAAC,IAAI,GAAG,GAAG,EAAE,IAAI,GAAG,GAAG,KAAK,IAAI,GAAG,GAAG,EAAE,KAAK,CAAC,EAAE,CAAC;QACxE,MAAM,IAAI,KAAK,CAAC,4CAA4C,CAAC,CAAC;IAChE,CAAC;IACD,MAAM,OAAO,GAAG,GAAG,GAAG,EAAE,GAAG,CAAC,CAAC;IAC7B,MAAM,GAAG,GAAG,OAAO,GAAG,IAAI,CAAC;IAC3B,MAAM,IAAI,GAAG,CAAC,OAAO,IAAI,CAAC,CAAC,GAAG,IAAI,CAAC;IACnC,MAAM,KAAK,GAAG,CAAC,IAAI,IAAI,CAAC,CAAC,GAAG,CAAC,IAAI,IAAI,CAAC,CAAC,CAAC;IACxC,OAAO,IAAI,UAAU,CAAC,CAAC,GAAG,EAAE,GAAG,EAAE,KAAK,EAAE,CAAC,IAAI,GAAG,GAAG,GAAG,GAAG,GAAG,KAAK,CAAC,GAAG,IAAI,CAAC,CAAC,CAAC;AAC9E,CAAC;AAED,MAAM,UAAU,YAAY,CAAC,KAAqC;IAChE,IAAI,KAAK,CAAC,MAAM,GAAG,CAAC;QAAE,OAAO,IAAI,CAAC;IAClC,MAAM,GAAG,GAAG,KAAK,CAAC,CAAC,CAAE,GAAG,IAAI,CAAC;IAC7B,MAAM,SAAS,GAAG,KAAK,CAAC,CAAC,CAAE,GAAG,IAAI,CAAC;IACnC,MAAM,KAAK,GAAG,KAAK,CAAC,CAAC,CAAE,GAAG,IAAI,CAAC;IAC/B,MAAM,QAAQ,GAAG,KAAK,CAAC,CAAC,CAAE,GAAG,IAAI,CAAC;IAClC,IAAI,GAAG,KAAK,SAAS,IAAI,CAAC,CAAC,GAAG,GAAG,SAAS,GAAG,KAAK,GAAG,QAAQ,CAAC,GAAG,IAAI,CAAC,KAAK,IAAI;QAAE,OAAO,IAAI,CAAC;IAC7F,OAAO,CAAC,CAAC,CAAC,CAAC,KAAK,IAAI,CAAC,CAAC,GAAG,IAAI,CAAC,IAAI,CAAC,CAAC,GAAG,GAAG,GAAG,CAAC,CAAC,GAAG,EAAE,CAAC;AACvD,CAAC;AAED,MAAM,UAAU,eAAe,CAAC,KAAa,EAAE,MAAc;IAC3D,OAAO,CAAC,CAAC,KAAK,GAAG,MAAM,CAAC,GAAG,IAAI,CAAC,KAAK,IAAI,CAAC,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,IAAI,CAAC;AAC3D,CAAC;AAED,MAAM,UAAU,gBAAgB,CAAC,OAAmB;IAClD,MAAM,MAAM,GAAG,CAAC,OAAe,EAAiB,EAAE,CAAC,OAAO,CAAC,MAAM,GAAG,OAAO,GAAG,CAAC;QAC7E,CAAC,CAAC,eAAe,CAAC,OAAO,CAAC,OAAO,CAAE,EAAE,OAAO,CAAC,OAAO,GAAG,CAAC,CAAE,CAAC;QAC3D,CAAC,CAAC,IAAI,CAAC;IACT,MAAM,UAAU,GAAG,IAAI,CAAC,GAAG,CAAC,IAAI,CAAC,GAAG,CAAC,MAAM,CAAC,WAAW,CAAC,aAAa,CAAC,IAAI,CAAC,EAAE,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC;IACpF,MAAM,WAAW,GAAG,IAAI,CAAC,GAAG,CAAC,IAAI,CAAC,GAAG,CAAC,MAAM,CAAC,WAAW,CAAC,cAAc,CAAC,IAAI,CAAC,EAAE,CAAC,CAAC,EAAE,UAAU,GAAG,CAAC,CAAC,CAAC;IACnG,MAAM,WAAW,GAAG,WAAW,CAAC,SAAS,GAAG,WAAW,GAAG,CAAC,CAAC;IAC5D,MAAM,GAAG,GAAG,YAAY,CAAC,OAAO,CAAC,QAAQ,CAAC,WAAW,EAAE,WAAW,GAAG,CAAC,CAAC,CAAC,IAAI,GAAG,CAAC;IAChF,MAAM,MAAM,GAAG,MAAM,CAAC,WAAW,CAAC,GAAG,CAAC,CAAC;IACvC,MAAM,UAAU,GAAG,MAAM,CAAC,WAAW,CAAC,WAAW,CAAC,CAAC;IACnD,MAAM,OAAO,GAAG,CAAC,OAAe,EAAkB,EAAE;QAClD,MAAM,KAAK,GAAG,MAAM,CAAC,OAAO,CAAC,CAAC;QAC9B,OAAO,KAAK,KAAK,IAAI,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,KAAK,KAAK,CAAC,CAAC;IAC7C,CAAC,CAAC;IAEF,OAAO;QACL,GAAG;QACH,aAAa,EAAE,UAAU;QACzB,cAAc,EAAE,WAAW;QAC3B,aAAa,EAAE,UAAU,KAAK,IAAI,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,oBAAoB,CAAC,UAAU,CAAC,IAAI,IAAI,CAAC;QACtF,eAAe,EAAE,MAAM,KAAK,CAAC,CAAC,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,MAAM,KAAK,CAAC,CAAC,CAAC,CAAC,QAAQ,CAAC,CAAC,CAAC,MAAM,KAAK,CAAC,CAAC,CAAC,CAAC,MAAM,CAAC,CAAC,CAAC,IAAI;QAC9F,UAAU,EAAE,MAAM,CAAC,WAAW,CAAC,QAAQ,CAAC;QACxC,YAAY,EAAE,CAAC,MAAM,CAAC,WAAW,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC,GAAG,EAAE,IAAI,IAAI;QAC3D,UAAU,EAAE,OAAO,CAAC,WAAW,CAAC,UAAU,CAAC;QAC3C,aAAa,EAAE,OAAO,CAAC,WAAW,CAAC,aAAa,CAAC;QACjD,aAAa,EAAE,OAAO,CAAC,WAAW,CAAC,aAAa,CAAC;QACjD,eAAe,EAAE,OAAO,CAAC,WAAW,CAAC,eAAe,CAAC;KACtD,CAAC;AACJ,CAAC"}

package/dist/wallhack/index.d.ts

@@ -0,0 +1,165 @@
+/**
+ * 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 declare const WALLHACK_VENDOR_ID = 14457;
+/** A second vendor id some K-001 units enumerate under (the switch-matrix MCU). */
+export declare const WALLHACK_KEYBOARD_ALT_VENDOR_ID = 7338;
+/** M-001 mouse: real config PID and the in-app demo PID. */
+export declare const WALLHACK_MOUSE_PRODUCT_IDS: Set<number>;
+/** K-001 keyboard PID (shared across both keyboard vendor ids). */
+export declare const WALLHACK_KEYBOARD_PRODUCT_IDS: Set<number>;
+/** Command-interface usage pages, from the app's `CS` map. */
+export declare const WALLHACK_MOUSE_USAGE_PAGE = 65308;
+export declare const WALLHACK_MOUSE_USAGE = 146;
+export declare const WALLHACK_KEYBOARD_USAGE_PAGE = 65440;
+export declare const WALLHACK_KEYBOARD_USAGE = 1;
+/** Every report is sent under this report id and is this many bytes long. */
+export declare const WALLHACK_REPORT_ID = 4;
+export declare 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 declare const WALLHACK_COMMAND: {
+    readonly checkConn: 160;
+    readonly fastBegin: 161;
+    readonly fastEnd: 162;
+    readonly getBasicInfo: 163;
+    readonly readFunctionArea: 164;
+    readonly writeFunctionArea: 165;
+    readonly getDefaultKeys: 166;
+    readonly getKeys: 167;
+    readonly setKeys: 168;
+    readonly getLighting: 169;
+    readonly setLighting: 170;
+    readonly factoryReset: 171;
+    readonly getMacro: 172;
+    readonly setMacro: 173;
+    readonly pair: 174;
+    readonly clearPairing: 175;
+    readonly testColor: 176;
+    readonly readMouseChipId: 184;
+    readonly readDongleChipId: 185;
+    readonly battery: 186;
+    readonly readVersion: 188;
+};
+/**
+ * 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 declare const WALLHACK_FLASH: {
+    readonly profileIndex: 0;
+    readonly ledMode: 1;
+    readonly ledLight: 2;
+    readonly reportEsb: 10;
+    readonly reportUsb: 11;
+    readonly dpiRank: 12;
+    readonly dpi8Block: 77;
+    readonly reportUser: 104;
+    readonly sleepTime: 105;
+    readonly deepSleepTime: 107;
+    readonly keyDebounceTime: 109;
+    readonly silentHeight: 110;
+    readonly angleSnapEnable: 111;
+    readonly rippleControlEnable: 112;
+    readonly motionSyncEnable: 113;
+    readonly turnOffAutomaticSleep: 114;
+    readonly angleTuneValue: 115;
+    readonly gameMode: 116;
+};
+/** Polling-rate rank → Hz (`Z1`). Same table for wired and wireless. */
+export declare const WALLHACK_POLLING_BY_RANK: Record<number, number>;
+/** Full list of selectable polling rates, in Hz (`jm`). */
+export declare const WALLHACK_POLLING_RATES: readonly number[];
+/** Lift-off-distance code → millimetres (`s6`). */
+export declare const WALLHACK_LOD_MM_BY_CODE: Record<number, number>;
+export declare function wallhackPollingRankToHz(rank: number): number | null;
+export declare function wallhackPollingHzToRank(hz: number): number | 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 declare function wallhackLodFromCode(code: number): "Low" | "Medium" | "High" | null;
+export declare function wallhackLodToCode(lod: "Low" | "Medium" | "High"): number;
+/** Human-facing product name for a device by product id. */
+export declare function wallhackMouseName(_productId: number): string;
+export declare function wallhackKeyboardName(_productId: number): string;
+/** Pack `bytes` into a fresh zero-padded 63-byte report body (`as`). */
+export declare function wallhackReport(bytes: Iterable<number>): Uint8Array;
+/**
+ * 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 declare function wallhackBuildSimple(command: number, args?: readonly number[]): Uint8Array;
+/**
+ * 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 declare function wallhackBuildFunctionArea(write: boolean, address: number, n: number, payload?: readonly number[]): Uint8Array;
+/** Read `count` bytes from the config map at `address`. */
+export declare function wallhackBuildRead(address: number, count?: number): Uint8Array;
+/** Write `payload` bytes to the config map at `address`. */
+export declare function wallhackBuildWrite(address: number, payload: readonly number[]): Uint8Array;
+/** A DPI value as the two little-endian bytes the DPI-stage record stores. */
+export declare function wallhackDpiBytes(dpi: number): [number, number];
+/**
+ * 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 declare function wallhackBuildSetDpiStage(dpi: number): Uint8Array;
+/**
+ * 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 declare function wallhackIsReplyFor(response: Uint8Array, command: number): boolean;
+/** The function-area address a read/write response echoes back (bytes 4-5, LE). */
+export declare function wallhackResponseAddress(response: Uint8Array): number | null;
+/**
+ * The single config byte a function-area read returns. The payload begins at
+ * byte 7 (`gJ`, `fJ`, `mJ` all read `t[7]`).
+ */
+export declare function wallhackReadByte(response: Uint8Array): number | null;
+/**
+ * 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 declare function wallhackReadDpi(response: Uint8Array): number | null;
+export interface WallhackVersions {
+    /** Mouse Nordic firmware, e.g. "1.4". */
+    mouse: string;
+    /** Receiver/dongle Nordic firmware. */
+    dongle: string;
+    /** Receiver NXP (nxp5516) firmware. */
+    nxp: string;
+}
+/**
+ * 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 declare function wallhackDecodeVersions(response: Uint8Array): WallhackVersions | null;
+export interface WallhackBattery {
+    percent: number | null;
+    charging: boolean;
+}
+/**
+ * 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 declare function wallhackDecodeBattery(response: Uint8Array): WallhackBattery | null;
+//# sourceMappingURL=index.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/wallhack/index.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;GAaG;AAEH,eAAO,MAAM,kBAAkB,QAAS,CAAC;AACzC,mFAAmF;AACnF,eAAO,MAAM,+BAA+B,OAAS,CAAC;AAEtD,4DAA4D;AAC5D,eAAO,MAAM,0BAA0B,aAAoC,CAAC;AAC5E,mEAAmE;AACnE,eAAO,MAAM,6BAA6B,aAA4B,CAAC;AAEvE,8DAA8D;AAC9D,eAAO,MAAM,yBAAyB,QAAS,CAAC;AAChD,eAAO,MAAM,oBAAoB,MAAO,CAAC;AACzC,eAAO,MAAM,4BAA4B,QAAS,CAAC;AACnD,eAAO,MAAM,uBAAuB,IAAO,CAAC;AAE5C,6EAA6E;AAC7E,eAAO,MAAM,kBAAkB,IAAI,CAAC;AACpC,eAAO,MAAM,sBAAsB,KAAK,CAAC;AAEzC;;;GAGG;AACH,eAAO,MAAM,gBAAgB;;;;;;;;;;;;;;;;;;;;;;CAsBnB,CAAC;AAEX;;;;GAIG;AACH,eAAO,MAAM,cAAc;;;;;;;;;;;;;;;;;;;CAmBjB,CAAC;AAEX,wEAAwE;AACxE,eAAO,MAAM,wBAAwB,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAI3D,CAAC;AAEF,2DAA2D;AAC3D,eAAO,MAAM,sBAAsB,EAAE,SAAS,MAAM,EAA4C,CAAC;AAEjG,mDAAmD;AACnD,eAAO,MAAM,uBAAuB,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAA0B,CAAC;AAEtF,wBAAgB,uBAAuB,CAAC,IAAI,EAAE,MAAM,GAAG,MAAM,GAAG,IAAI,CAEnE;AAED,wBAAgB,uBAAuB,CAAC,EAAE,EAAE,MAAM,GAAG,MAAM,GAAG,IAAI,CAKjE;AAED;;;GAGG;AACH,wBAAgB,mBAAmB,CAAC,IAAI,EAAE,MAAM,GAAG,KAAK,GAAG,QAAQ,GAAG,MAAM,GAAG,IAAI,CAOlF;AAED,wBAAgB,iBAAiB,CAAC,GAAG,EAAE,KAAK,GAAG,QAAQ,GAAG,MAAM,GAAG,MAAM,CAExE;AAED,4DAA4D;AAC5D,wBAAgB,iBAAiB,CAAC,UAAU,EAAE,MAAM,GAAG,MAAM,CAE5D;AAED,wBAAgB,oBAAoB,CAAC,UAAU,EAAE,MAAM,GAAG,MAAM,CAE/D;AAED,wEAAwE;AACxE,wBAAgB,cAAc,CAAC,KAAK,EAAE,QAAQ,CAAC,MAAM,CAAC,GAAG,UAAU,CAIlE;AAED;;;GAGG;AACH,wBAAgB,mBAAmB,CAAC,OAAO,EAAE,MAAM,EAAE,IAAI,GAAE,SAAS,MAAM,EAAO,GAAG,UAAU,CAE7F;AAED;;;;;GAKG;AACH,wBAAgB,yBAAyB,CACvC,KAAK,EAAE,OAAO,EACd,OAAO,EAAE,MAAM,EACf,CAAC,EAAE,MAAM,EACT,OAAO,GAAE,SAAS,MAAM,EAAO,GAC9B,UAAU,CAIZ;AAED,2DAA2D;AAC3D,wBAAgB,iBAAiB,CAAC,OAAO,EAAE,MAAM,EAAE,KAAK,SAAI,GAAG,UAAU,CAExE;AAED,4DAA4D;AAC5D,wBAAgB,kBAAkB,CAAC,OAAO,EAAE,MAAM,EAAE,OAAO,EAAE,SAAS,MAAM,EAAE,GAAG,UAAU,CAE1F;AAED,8EAA8E;AAC9E,wBAAgB,gBAAgB,CAAC,GAAG,EAAE,MAAM,GAAG,CAAC,MAAM,EAAE,MAAM,CAAC,CAE9D;AAED;;;;GAIG;AACH,wBAAgB,wBAAwB,CAAC,GAAG,EAAE,MAAM,GAAG,UAAU,CAGhE;AAED;;;GAGG;AACH,wBAAgB,kBAAkB,CAAC,QAAQ,EAAE,UAAU,EAAE,OAAO,EAAE,MAAM,GAAG,OAAO,CAEjF;AAED,mFAAmF;AACnF,wBAAgB,uBAAuB,CAAC,QAAQ,EAAE,UAAU,GAAG,MAAM,GAAG,IAAI,CAG3E;AAED;;;GAGG;AACH,wBAAgB,gBAAgB,CAAC,QAAQ,EAAE,UAAU,GAAG,MAAM,GAAG,IAAI,CAGpE;AAED;;;GAGG;AACH,wBAAgB,eAAe,CAAC,QAAQ,EAAE,UAAU,GAAG,MAAM,GAAG,IAAI,CAGnE;AAED,MAAM,WAAW,gBAAgB;IAC/B,yCAAyC;IACzC,KAAK,EAAE,MAAM,CAAC;IACd,uCAAuC;IACvC,MAAM,EAAE,MAAM,CAAC;IACf,uCAAuC;IACvC,GAAG,EAAE,MAAM,CAAC;CACb;AAED;;;GAGG;AACH,wBAAgB,sBAAsB,CAAC,QAAQ,EAAE,UAAU,GAAG,gBAAgB,GAAG,IAAI,CAQpF;AAED,MAAM,WAAW,eAAe;IAC9B,OAAO,EAAE,MAAM,GAAG,IAAI,CAAC;IACvB,QAAQ,EAAE,OAAO,CAAC;CACnB;AAED;;;;GAIG;AACH,wBAAgB,qBAAqB,CAAC,QAAQ,EAAE,UAAU,GAAG,eAAe,GAAG,IAAI,CAKlF"}