@openmouse/protocol 0.1.0

package/dist/keychron/index.js

@@ -0,0 +1,341 @@
+/** Nape Pro VIA codec. Do not reuse these keymap/layer helpers for M-series Keychron mice. */
+export const KEYCHRON_VENDOR_ID = 0x3434;
+export const KEYCHRON_RAW_USAGE_PAGE = 0xff60;
+export const KEYCHRON_RAW_USAGE = 0x61;
+export const KEYCHRON_REPORT_ID = 0;
+export const KEYCHRON_PACKET_LENGTH = 32;
+/** Keychron M6 wired control interface and report layout, verified on PID 0xd060. */
+export const KEYCHRON_M6_PRODUCT_ID = 0xd060;
+/** Link-KM receiver paired with the Keychron M6, verified on 2.4 GHz. */
+export const KEYCHRON_M6_RECEIVER_PRODUCT_ID = 0xd029;
+export const KEYCHRON_M6_USAGE_PAGE = 0xffc1;
+export const KEYCHRON_M6_USAGE = 0x01;
+export const KEYCHRON_M6_COMMAND_REPORT_ID = 0xb3;
+export const KEYCHRON_M6_COMMAND_RESPONSE_REPORT_ID = 0xb4;
+export const KEYCHRON_M6_SETTINGS_REPORT_ID = 0xb5;
+export const KEYCHRON_M6_SETTINGS_RESPONSE_REPORT_ID = 0xb6;
+export const KEYCHRON_M6_STATUS_COMMAND = 0x06;
+export const KEYCHRON_M6_STATUS_PACKET_LENGTH = 63;
+export const KEYCHRON_PRODUCTS = new Map([
+    [0x0440, { name: "Nape Pro" }],
+    [0xd026, { name: "Keychron Link-KM", receiver: true }],
+    [0xd029, { name: "Keychron Link-KM Type C", receiver: true }],
+]);
+export const KEYCHRON_NAPE_PRODUCTS = new Map([
+    [0x0440, { name: "Nape Pro" }],
+    [0xd026, { name: "Keychron Link-KM", receiver: true }],
+    [0xd029, { name: "Keychron Link-KM Type C", receiver: true }],
+]);
+export const KEYCHRON_COMMAND = { firmwareVersion: 161, getCurrentLayer: 163, miscGroup: 167 };
+/** Standard VIA opcodes used by Nape for keymap metadata (not the 0xA7 misc group). */
+export const KEYCHRON_VIA_COMMAND = {
+    getKeycode: 4,
+    setKeycode: 5,
+    getLayerCount: 17,
+    getBuffer: 18,
+    getEncoder: 20,
+    setEncoder: 21,
+};
+export const KEYCHRON_NAPE_COMMAND = {
+    getOrientation: 32, getDpiStage: 33, setDpiStage: 34, setDpiValue: 35,
+    getDpiValue: 36, setLayer: 45, getBattery: 49, setOrientation: 52,
+    getCustomDpi: 54, setCustomDpi: 55, getLayerOrientation: 56, setLayerOrientation: 57,
+};
+/** Sensor heading is stored per layer in 45° steps (0–7 → 0°–315°). */
+export const KEYCHRON_NAPE_ORIENTATION_STEPS = 8;
+export const KEYCHRON_NAPE_ORIENTATION_STEP_DEGREES = 45;
+/**
+ * Nape Pro exposes eight user layers (1–8). VIA may report a spare slot at
+ * index 0; GET_CURRENT_LAYER and keymap/encoder commands use the same 1–8
+ * index. Keychron Launcher writes GET_BUFFER offset 14 * 3 when the mouse
+ * reports current layer 3.
+ */
+export const KEYCHRON_NAPE_LAYER_COUNT = 8;
+export const KEYCHRON_MISC_COMMAND = {
+    getSleep: 11,
+    setSleep: 12,
+    getPolling: 13,
+    setPolling: 14,
+};
+export const KEYCHRON_POLLING_TABLE = [8000, 4000, 2000, 1000, 500, 250, 125];
+/** Nape Pro only — observed on firmware v1.2.6-ZK (stage 5 stores 4000). Other Keychron mice should define their own ranges. */
+export const KEYCHRON_NAPE_DPI_MIN = 50;
+export const KEYCHRON_NAPE_DPI_MAX = 4000;
+export const KEYCHRON_NAPE_DPI_STEP = 50;
+export const KEYCHRON_NAPE_SLEEP_MIN_SECONDS = 60;
+export const KEYCHRON_NAPE_SLEEP_MAX_SECONDS = 12 * 3600 + 59 * 60 + 59;
+export const KEYCHRON_NAPE_SLEEP_OPTIONS = [
+    60, 120, 300, 600, 1800, 3600, 7200, 18_000, 43_200,
+];
+export function keychronPacket(command) {
+    const packet = new Uint8Array(KEYCHRON_PACKET_LENGTH);
+    packet.set(command.slice(0, KEYCHRON_PACKET_LENGTH));
+    return packet;
+}
+export function keychronDecodePolling(response) {
+    if (response.slice(2).every((byte) => byte === 0))
+        return { rateHz: 1000, supported: [125, 500, 1000] };
+    const mask = response[5] ?? 0;
+    const supported = KEYCHRON_POLLING_TABLE.filter((_, index) => ((mask >> index) & 1) === 1).slice().sort((a, b) => a - b);
+    const rateHz = KEYCHRON_POLLING_TABLE[Math.min(response[6] ?? 3, KEYCHRON_POLLING_TABLE.length - 1)] ?? 1000;
+    return { rateHz, supported: supported.length ? supported : [rateHz] };
+}
+export function keychronDecodeFirmware(response) {
+    const end = response.indexOf(0, 1);
+    const bytes = response.slice(1, end < 0 ? undefined : end);
+    if (!bytes.length)
+        return null;
+    const text = String.fromCharCode(...bytes);
+    return text.startsWith("v") ? text : `v${text}`;
+}
+export function keychronDecodeBattery(response) {
+    const percent = response[2] ?? 0xff;
+    const status = response[3] ?? 0;
+    const state = status === 1
+        ? "Charging"
+        : status === 2
+            ? "Full"
+            : "Discharging";
+    return { percent, state };
+}
+export function keychronDecodeSleepTimeout(response) {
+    return (response[5] ?? 0) | ((response[6] ?? 0) << 8);
+}
+export function keychronEncodeSleepTimeout(seconds) {
+    return [
+        KEYCHRON_COMMAND.miscGroup,
+        KEYCHRON_MISC_COMMAND.setSleep,
+        0,
+        0,
+        seconds & 0xff,
+        (seconds >> 8) & 0xff,
+        0,
+        0,
+    ];
+}
+export function keychronDecodeLayerCount(response) {
+    return response[1] ?? 0;
+}
+export function keychronDecodeCurrentLayer(response) {
+    const reported = response[1] ?? 1;
+    if (reported < 1)
+        return 1;
+    return Math.min(reported, KEYCHRON_NAPE_LAYER_COUNT);
+}
+export function keychronEncodeSetLayer(layer) {
+    return [KEYCHRON_COMMAND.miscGroup, KEYCHRON_NAPE_COMMAND.setLayer, layer & 0xff];
+}
+export function keychronOrientationIndex(index) {
+    if (!Number.isInteger(index) || index < 0 || index >= KEYCHRON_NAPE_ORIENTATION_STEPS) {
+        throw new Error(`Orientation must be a 45° step from 0° to 315°.`);
+    }
+    return index;
+}
+export function keychronOrientationDegrees(index) {
+    return KEYCHRON_NAPE_ORIENTATION_STEP_DEGREES * keychronOrientationIndex(index);
+}
+export function keychronOrientationLabel(index) {
+    return `${keychronOrientationDegrees(index)}\u00b0`;
+}
+export const KEYCHRON_NAPE_ORIENTATION_OPTIONS = Array.from({ length: KEYCHRON_NAPE_ORIENTATION_STEPS }, (_, index) => ({
+    index,
+    degrees: KEYCHRON_NAPE_ORIENTATION_STEP_DEGREES * index,
+    label: `${KEYCHRON_NAPE_ORIENTATION_STEP_DEGREES * index}\u00b0`,
+}));
+export function keychronDecodeOrientationIndex(response) {
+    return response[2] ?? 0xff;
+}
+export function keychronEncodeSetOrientation(index) {
+    return [KEYCHRON_COMMAND.miscGroup, KEYCHRON_NAPE_COMMAND.setOrientation, keychronOrientationIndex(index)];
+}
+export function keychronEncodeGetLayerOrientation(layer) {
+    return [KEYCHRON_COMMAND.miscGroup, KEYCHRON_NAPE_COMMAND.getLayerOrientation, layer & 0xff];
+}
+export function keychronEncodeSetLayerOrientation(layer, index) {
+    return [
+        KEYCHRON_COMMAND.miscGroup,
+        KEYCHRON_NAPE_COMMAND.setLayerOrientation,
+        layer & 0xff,
+        keychronOrientationIndex(index),
+    ];
+}
+/** Nape VIA keymap is 7 packed columns; the overlay exposes the first six. */
+export const KEYCHRON_NAPE_KEYMAP_COLUMNS = 7;
+export const KEYCHRON_NAPE_KEYMAP_BUFFER_SIZE = KEYCHRON_NAPE_KEYMAP_COLUMNS * 2;
+export const KEYCHRON_NAPE_KEY_CONTROLS = [
+    { col: 0, name: "03" },
+    { col: 1, name: "04" },
+    { col: 2, name: "01" },
+    { col: 3, name: "02" },
+    { col: 4, name: "M1" },
+    { col: 5, name: "M2" },
+];
+export const KEYCHRON_NAPE_ENCODER_ID = 0;
+export const KEYCHRON_NAPE_ENCODER_CCW = 0;
+export const KEYCHRON_NAPE_ENCODER_CW = 1;
+/** VIA protocol 12 QMK keycodes confirmed on Nape Pro firmware v1.2.6-ZK. */
+export const KEYCHRON_QK_USER = 0x7e00;
+export const KEYCHRON_QK_MOMENTARY = 0x5220;
+export const KEYCHRON_NAPE_KEYCODE = {
+    no: 0,
+    mute: 0x00a8,
+    volumeUp: 0x00a9,
+    volumeDown: 0x00aa,
+    leftClick: 0x00d1,
+    rightClick: 0x00d2,
+    middleClick: 0x00d3,
+    backward: 0x00d4,
+    forward: 0x00d5,
+    scrollUp: 0x00d9,
+    scrollDown: 0x00da,
+    scrollLeft: 0x00db,
+    scrollRight: 0x00dc,
+    dpiNext: KEYCHRON_QK_USER + 37,
+    dpiPrev: KEYCHRON_QK_USER + 38,
+    pollingPrev: KEYCHRON_QK_USER + 39,
+    pollingNext: KEYCHRON_QK_USER + 40,
+    orientationCycle: KEYCHRON_QK_USER + 43,
+    dpiCycle: KEYCHRON_QK_USER + 44,
+    pollingCycle: KEYCHRON_QK_USER + 45,
+    doubleClick: KEYCHRON_QK_USER + 46,
+    customDpi: KEYCHRON_QK_USER + 47,
+    gestureMode: KEYCHRON_QK_MOMENTARY + 9,
+    scrollMode: KEYCHRON_QK_MOMENTARY + 10,
+};
+export const KEYCHRON_NAPE_BUTTON_ACTIONS = [
+    "Disabled",
+    "Left click",
+    "Right click",
+    "Middle click",
+    "Back",
+    "Forward",
+    "Double left click",
+    "Scroll up",
+    "Scroll down",
+    "Scroll left",
+    "Scroll right",
+    "Volume up",
+    "Volume down",
+    "Mute",
+    "Scroll mode",
+    "Gesture mode",
+    "DPI cycle",
+    "DPI up",
+    "DPI down",
+    "Polling cycle",
+    "Polling up",
+    "Polling down",
+    "Cycle orientation",
+];
+const KEYCHRON_NAPE_BUTTON_KEYCODES = {
+    Disabled: KEYCHRON_NAPE_KEYCODE.no,
+    "Left click": KEYCHRON_NAPE_KEYCODE.leftClick,
+    "Right click": KEYCHRON_NAPE_KEYCODE.rightClick,
+    "Middle click": KEYCHRON_NAPE_KEYCODE.middleClick,
+    Back: KEYCHRON_NAPE_KEYCODE.backward,
+    Forward: KEYCHRON_NAPE_KEYCODE.forward,
+    "Double left click": KEYCHRON_NAPE_KEYCODE.doubleClick,
+    "Scroll up": KEYCHRON_NAPE_KEYCODE.scrollUp,
+    "Scroll down": KEYCHRON_NAPE_KEYCODE.scrollDown,
+    "Scroll left": KEYCHRON_NAPE_KEYCODE.scrollLeft,
+    "Scroll right": KEYCHRON_NAPE_KEYCODE.scrollRight,
+    "Volume up": KEYCHRON_NAPE_KEYCODE.volumeUp,
+    "Volume down": KEYCHRON_NAPE_KEYCODE.volumeDown,
+    Mute: KEYCHRON_NAPE_KEYCODE.mute,
+    "Scroll mode": KEYCHRON_NAPE_KEYCODE.scrollMode,
+    "Gesture mode": KEYCHRON_NAPE_KEYCODE.gestureMode,
+    "DPI cycle": KEYCHRON_NAPE_KEYCODE.dpiCycle,
+    "DPI up": KEYCHRON_NAPE_KEYCODE.dpiNext,
+    "DPI down": KEYCHRON_NAPE_KEYCODE.dpiPrev,
+    "Polling cycle": KEYCHRON_NAPE_KEYCODE.pollingCycle,
+    "Polling up": KEYCHRON_NAPE_KEYCODE.pollingNext,
+    "Polling down": KEYCHRON_NAPE_KEYCODE.pollingPrev,
+    "Cycle orientation": KEYCHRON_NAPE_KEYCODE.orientationCycle,
+};
+const KEYCHRON_NAPE_BUTTON_ACTION_BY_KEYCODE = new Map(Object.entries(KEYCHRON_NAPE_BUTTON_KEYCODES).map(([action, keycode]) => [keycode, action]));
+export function keychronUserLayerToVia(layer) {
+    return Math.min(Math.max(layer, 1), KEYCHRON_NAPE_LAYER_COUNT);
+}
+/** Firmware layers are 1–8; the UI and Launcher label them 0–7. */
+export function keychronLayerDisplayIndex(layer) {
+    return keychronUserLayerToVia(layer) - 1;
+}
+export function keychronLayerLabel(layer) {
+    return `Layer ${keychronLayerDisplayIndex(layer)}`;
+}
+export function keychronActionForKeycode(keycode) {
+    return KEYCHRON_NAPE_BUTTON_ACTION_BY_KEYCODE.get(keycode) ?? "Custom";
+}
+export function keychronKeycodeForAction(action) {
+    return KEYCHRON_NAPE_BUTTON_KEYCODES[action];
+}
+export function keychronMappedControl(keycode) {
+    return { keycode, action: keychronActionForKeycode(keycode) };
+}
+export function keychronLayerKeymapFromCodes(layer, columnCodes, ccw, cw, orientationIndex = 0) {
+    return {
+        layer,
+        keys: KEYCHRON_NAPE_KEY_CONTROLS.map((control) => ({
+            ...control,
+            ...keychronMappedControl(columnCodes[control.col] ?? 0),
+        })),
+        wheel: {
+            ccw: keychronMappedControl(ccw),
+            cw: keychronMappedControl(cw),
+        },
+        orientationIndex,
+    };
+}
+export function keychronEncodeGetBuffer(viaLayer) {
+    const offset = KEYCHRON_NAPE_KEYMAP_BUFFER_SIZE * viaLayer;
+    return [
+        KEYCHRON_VIA_COMMAND.getBuffer,
+        (offset >> 8) & 0xff,
+        offset & 0xff,
+        KEYCHRON_NAPE_KEYMAP_BUFFER_SIZE,
+    ];
+}
+export function keychronDecodeKeymapBuffer(response) {
+    const size = response[3] ?? 0;
+    const data = response.subarray(4, 4 + size);
+    const codes = [];
+    for (let index = 0; index + 1 < data.length; index += 2) {
+        codes.push(((data[index] ?? 0) << 8) | (data[index + 1] ?? 0));
+    }
+    return codes;
+}
+export function keychronEncodeGetKeycode(viaLayer, col) {
+    return [KEYCHRON_VIA_COMMAND.getKeycode, viaLayer & 0xff, 0, col & 0xff];
+}
+export function keychronEncodeSetKeycode(viaLayer, col, keycode) {
+    return [
+        KEYCHRON_VIA_COMMAND.setKeycode,
+        viaLayer & 0xff,
+        0,
+        col & 0xff,
+        (keycode >> 8) & 0xff,
+        keycode & 0xff,
+    ];
+}
+export function keychronEncodeGetEncoder(viaLayer, clockwise) {
+    return [
+        KEYCHRON_VIA_COMMAND.getEncoder,
+        viaLayer & 0xff,
+        KEYCHRON_NAPE_ENCODER_ID,
+        clockwise ? KEYCHRON_NAPE_ENCODER_CW : KEYCHRON_NAPE_ENCODER_CCW,
+    ];
+}
+export function keychronEncodeSetEncoder(viaLayer, clockwise, keycode) {
+    return [
+        KEYCHRON_VIA_COMMAND.setEncoder,
+        viaLayer & 0xff,
+        KEYCHRON_NAPE_ENCODER_ID,
+        clockwise ? KEYCHRON_NAPE_ENCODER_CW : KEYCHRON_NAPE_ENCODER_CCW,
+        (keycode >> 8) & 0xff,
+        keycode & 0xff,
+    ];
+}
+export function keychronDecodeKeycodeReply(response) {
+    return ((response[4] ?? 0) << 8) | (response[5] ?? 0);
+}
+//# sourceMappingURL=index.js.map

package/dist/keychron/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/keychron/index.ts"],"names":[],"mappings":"AAAA,8FAA8F;AAC9F,MAAM,CAAC,MAAM,kBAAkB,GAAG,MAAM,CAAC;AACzC,MAAM,CAAC,MAAM,uBAAuB,GAAG,MAAM,CAAC;AAC9C,MAAM,CAAC,MAAM,kBAAkB,GAAG,IAAI,CAAC;AACvC,MAAM,CAAC,MAAM,kBAAkB,GAAG,CAAC,CAAC;AACpC,MAAM,CAAC,MAAM,sBAAsB,GAAG,EAAE,CAAC;AACzC,qFAAqF;AACrF,MAAM,CAAC,MAAM,sBAAsB,GAAG,MAAM,CAAC;AAC7C,yEAAyE;AACzE,MAAM,CAAC,MAAM,+BAA+B,GAAG,MAAM,CAAC;AACtD,MAAM,CAAC,MAAM,sBAAsB,GAAG,MAAM,CAAC;AAC7C,MAAM,CAAC,MAAM,iBAAiB,GAAG,IAAI,CAAC;AACtC,MAAM,CAAC,MAAM,6BAA6B,GAAG,IAAI,CAAC;AAClD,MAAM,CAAC,MAAM,sCAAsC,GAAG,IAAI,CAAC;AAC3D,MAAM,CAAC,MAAM,8BAA8B,GAAG,IAAI,CAAC;AACnD,MAAM,CAAC,MAAM,uCAAuC,GAAG,IAAI,CAAC;AAC5D,MAAM,CAAC,MAAM,0BAA0B,GAAG,IAAI,CAAC;AAC/C,MAAM,CAAC,MAAM,gCAAgC,GAAG,EAAE,CAAC;AACnD,MAAM,CAAC,MAAM,iBAAiB,GAAG,IAAI,GAAG,CAA+C;IACrF,CAAC,MAAM,EAAE,EAAE,IAAI,EAAE,UAAU,EAAE,CAAC;IAC9B,CAAC,MAAM,EAAE,EAAE,IAAI,EAAE,kBAAkB,EAAE,QAAQ,EAAE,IAAI,EAAE,CAAC;IACtD,CAAC,MAAM,EAAE,EAAE,IAAI,EAAE,yBAAyB,EAAE,QAAQ,EAAE,IAAI,EAAE,CAAC;CAC9D,CAAC,CAAC;AACH,MAAM,CAAC,MAAM,sBAAsB,GAAG,IAAI,GAAG,CAA+C;IAC1F,CAAC,MAAM,EAAE,EAAE,IAAI,EAAE,UAAU,EAAE,CAAC;IAC9B,CAAC,MAAM,EAAE,EAAE,IAAI,EAAE,kBAAkB,EAAE,QAAQ,EAAE,IAAI,EAAE,CAAC;IACtD,CAAC,MAAM,EAAE,EAAE,IAAI,EAAE,yBAAyB,EAAE,QAAQ,EAAE,IAAI,EAAE,CAAC;CAC9D,CAAC,CAAC;AACH,MAAM,CAAC,MAAM,gBAAgB,GAAG,EAAE,eAAe,EAAE,GAAG,EAAE,eAAe,EAAE,GAAG,EAAE,SAAS,EAAE,GAAG,EAAW,CAAC;AACxG,uFAAuF;AACvF,MAAM,CAAC,MAAM,oBAAoB,GAAG;IAClC,UAAU,EAAE,CAAC;IACb,UAAU,EAAE,CAAC;IACb,aAAa,EAAE,EAAE;IACjB,SAAS,EAAE,EAAE;IACb,UAAU,EAAE,EAAE;IACd,UAAU,EAAE,EAAE;CACN,CAAC;AACX,MAAM,CAAC,MAAM,qBAAqB,GAAG;IACnC,cAAc,EAAE,EAAE,EAAE,WAAW,EAAE,EAAE,EAAE,WAAW,EAAE,EAAE,EAAE,WAAW,EAAE,EAAE;IACrE,WAAW,EAAE,EAAE,EAAE,QAAQ,EAAE,EAAE,EAAE,UAAU,EAAE,EAAE,EAAE,cAAc,EAAE,EAAE;IACjE,YAAY,EAAE,EAAE,EAAE,YAAY,EAAE,EAAE,EAAE,mBAAmB,EAAE,EAAE,EAAE,mBAAmB,EAAE,EAAE;CAC5E,CAAC;AACX,uEAAuE;AACvE,MAAM,CAAC,MAAM,+BAA+B,GAAG,CAAC,CAAC;AACjD,MAAM,CAAC,MAAM,sCAAsC,GAAG,EAAE,CAAC;AACzD;;;;;GAKG;AACH,MAAM,CAAC,MAAM,yBAAyB,GAAG,CAAC,CAAC;AAC3C,MAAM,CAAC,MAAM,qBAAqB,GAAG;IACnC,QAAQ,EAAE,EAAE;IACZ,QAAQ,EAAE,EAAE;IACZ,UAAU,EAAE,EAAE;IACd,UAAU,EAAE,EAAE;CACN,CAAC;AACX,MAAM,CAAC,MAAM,sBAAsB,GAAG,CAAC,IAAI,EAAE,IAAI,EAAE,IAAI,EAAE,IAAI,EAAE,GAAG,EAAE,GAAG,EAAE,GAAG,CAAU,CAAC;AACvF,gIAAgI;AAChI,MAAM,CAAC,MAAM,qBAAqB,GAAG,EAAE,CAAC;AACxC,MAAM,CAAC,MAAM,qBAAqB,GAAG,IAAI,CAAC;AAC1C,MAAM,CAAC,MAAM,sBAAsB,GAAG,EAAE,CAAC;AACzC,MAAM,CAAC,MAAM,+BAA+B,GAAG,EAAE,CAAC;AAClD,MAAM,CAAC,MAAM,+BAA+B,GAAG,EAAE,GAAG,IAAI,GAAG,EAAE,GAAG,EAAE,GAAG,EAAE,CAAC;AACxE,MAAM,CAAC,MAAM,2BAA2B,GAAG;IACzC,EAAE,EAAE,GAAG,EAAE,GAAG,EAAE,GAAG,EAAE,IAAI,EAAE,IAAI,EAAE,IAAI,EAAE,MAAM,EAAE,MAAM;CAC3C,CAAC;AAEX,MAAM,UAAU,cAAc,CAAC,OAA0B;IACvD,MAAM,MAAM,GAAG,IAAI,UAAU,CAAC,sBAAsB,CAAC,CAAC;IACtD,MAAM,CAAC,GAAG,CAAC,OAAO,CAAC,KAAK,CAAC,CAAC,EAAE,sBAAsB,CAAC,CAAC,CAAC;IACrD,OAAO,MAAM,CAAC;AAChB,CAAC;AAED,MAAM,UAAU,qBAAqB,CAAC,QAAoB;IACxD,IAAI,QAAQ,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,KAAK,CAAC,CAAC,IAAI,EAAE,EAAE,CAAC,IAAI,KAAK,CAAC,CAAC;QAAE,OAAO,EAAE,MAAM,EAAE,IAAI,EAAE,SAAS,EAAE,CAAC,GAAG,EAAE,GAAG,EAAE,IAAI,CAAC,EAAE,CAAC;IACxG,MAAM,IAAI,GAAG,QAAQ,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC;IAC9B,MAAM,SAAS,GAAG,sBAAsB,CAAC,MAAM,CAAC,CAAC,CAAC,EAAE,KAAK,EAAE,EAAE,CAAC,CAAC,CAAC,IAAI,IAAI,KAAK,CAAC,GAAG,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,KAAK,EAAE,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,CAAC,EAAE,EAAE,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC;IACzH,MAAM,MAAM,GAAG,sBAAsB,CAAC,IAAI,CAAC,GAAG,CAAC,QAAQ,CAAC,CAAC,CAAC,IAAI,CAAC,EAAE,sBAAsB,CAAC,MAAM,GAAG,CAAC,CAAC,CAAC,IAAI,IAAI,CAAC;IAC7G,OAAO,EAAE,MAAM,EAAE,SAAS,EAAE,SAAS,CAAC,MAAM,CAAC,CAAC,CAAC,SAAS,CAAC,CAAC,CAAC,CAAC,MAAM,CAAC,EAAE,CAAC;AACxE,CAAC;AAED,MAAM,UAAU,sBAAsB,CAAC,QAAoB;IACzD,MAAM,GAAG,GAAG,QAAQ,CAAC,OAAO,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC;IACnC,MAAM,KAAK,GAAG,QAAQ,CAAC,KAAK,CAAC,CAAC,EAAE,GAAG,GAAG,CAAC,CAAC,CAAC,CAAC,SAAS,CAAC,CAAC,CAAC,GAAG,CAAC,CAAC;IAC3D,IAAI,CAAC,KAAK,CAAC,MAAM;QAAE,OAAO,IAAI,CAAC;IAC/B,MAAM,IAAI,GAAG,MAAM,CAAC,YAAY,CAAC,GAAG,KAAK,CAAC,CAAC;IAC3C,OAAO,IAAI,CAAC,UAAU,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,IAAI,IAAI,EAAE,CAAC;AAClD,CAAC;AAED,MAAM,UAAU,qBAAqB,CACnC,QAAoB;IAEpB,MAAM,OAAO,GAAG,QAAQ,CAAC,CAAC,CAAC,IAAI,IAAI,CAAC;IACpC,MAAM,MAAM,GAAG,QAAQ,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC;IAChC,MAAM,KAAK,GAAG,MAAM,KAAK,CAAC;QACxB,CAAC,CAAC,UAAU;QACZ,CAAC,CAAC,MAAM,KAAK,CAAC;YACZ,CAAC,CAAC,MAAM;YACR,CAAC,CAAC,aAAa,CAAC;IACpB,OAAO,EAAE,OAAO,EAAE,KAAK,EAAE,CAAC;AAC5B,CAAC;AAED,MAAM,UAAU,0BAA0B,CAAC,QAAoB;IAC7D,OAAO,CAAC,QAAQ,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,GAAG,CAAC,CAAC,QAAQ,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC;AACxD,CAAC;AAED,MAAM,UAAU,0BAA0B,CAAC,OAAe;IACxD,OAAO;QACL,gBAAgB,CAAC,SAAS;QAC1B,qBAAqB,CAAC,QAAQ;QAC9B,CAAC;QACD,CAAC;QACD,OAAO,GAAG,IAAI;QACd,CAAC,OAAO,IAAI,CAAC,CAAC,GAAG,IAAI;QACrB,CAAC;QACD,CAAC;KACF,CAAC;AACJ,CAAC;AAED,MAAM,UAAU,wBAAwB,CAAC,QAAoB;IAC3D,OAAO,QAAQ,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC;AAC1B,CAAC;AAED,MAAM,UAAU,0BAA0B,CAAC,QAAoB;IAC7D,MAAM,QAAQ,GAAG,QAAQ,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC;IAClC,IAAI,QAAQ,GAAG,CAAC;QAAE,OAAO,CAAC,CAAC;IAC3B,OAAO,IAAI,CAAC,GAAG,CAAC,QAAQ,EAAE,yBAAyB,CAAC,CAAC;AACvD,CAAC;AAED,MAAM,UAAU,sBAAsB,CAAC,KAAa;IAClD,OAAO,CAAC,gBAAgB,CAAC,SAAS,EAAE,qBAAqB,CAAC,QAAQ,EAAE,KAAK,GAAG,IAAI,CAAC,CAAC;AACpF,CAAC;AAED,MAAM,UAAU,wBAAwB,CAAC,KAAa;IACpD,IAAI,CAAC,MAAM,CAAC,SAAS,CAAC,KAAK,CAAC,IAAI,KAAK,GAAG,CAAC,IAAI,KAAK,IAAI,+BAA+B,EAAE,CAAC;QACtF,MAAM,IAAI,KAAK,CAAC,iDAAiD,CAAC,CAAC;IACrE,CAAC;IACD,OAAO,KAAK,CAAC;AACf,CAAC;AAED,MAAM,UAAU,0BAA0B,CAAC,KAAa;IACtD,OAAO,sCAAsC,GAAG,wBAAwB,CAAC,KAAK,CAAC,CAAC;AAClF,CAAC;AAED,MAAM,UAAU,wBAAwB,CAAC,KAAa;IACpD,OAAO,GAAG,0BAA0B,CAAC,KAAK,CAAC,QAAQ,CAAC;AACtD,CAAC;AAED,MAAM,CAAC,MAAM,iCAAiC,GAAG,KAAK,CAAC,IAAI,CACzD,EAAE,MAAM,EAAE,+BAA+B,EAAE,EAC3C,CAAC,CAAC,EAAE,KAAK,EAAE,EAAE,CAAC,CAAC;IACb,KAAK;IACL,OAAO,EAAE,sCAAsC,GAAG,KAAK;IACvD,KAAK,EAAE,GAAG,sCAAsC,GAAG,KAAK,QAAQ;CACjE,CAAC,CACH,CAAC;AAEF,MAAM,UAAU,8BAA8B,CAAC,QAAoB;IACjE,OAAO,QAAQ,CAAC,CAAC,CAAC,IAAI,IAAI,CAAC;AAC7B,CAAC;AAED,MAAM,UAAU,4BAA4B,CAAC,KAAa;IACxD,OAAO,CAAC,gBAAgB,CAAC,SAAS,EAAE,qBAAqB,CAAC,cAAc,EAAE,wBAAwB,CAAC,KAAK,CAAC,CAAC,CAAC;AAC7G,CAAC;AAED,MAAM,UAAU,iCAAiC,CAAC,KAAa;IAC7D,OAAO,CAAC,gBAAgB,CAAC,SAAS,EAAE,qBAAqB,CAAC,mBAAmB,EAAE,KAAK,GAAG,IAAI,CAAC,CAAC;AAC/F,CAAC;AAED,MAAM,UAAU,iCAAiC,CAAC,KAAa,EAAE,KAAa;IAC5E,OAAO;QACL,gBAAgB,CAAC,SAAS;QAC1B,qBAAqB,CAAC,mBAAmB;QACzC,KAAK,GAAG,IAAI;QACZ,wBAAwB,CAAC,KAAK,CAAC;KAChC,CAAC;AACJ,CAAC;AAED,8EAA8E;AAC9E,MAAM,CAAC,MAAM,4BAA4B,GAAG,CAAC,CAAC;AAC9C,MAAM,CAAC,MAAM,gCAAgC,GAAG,4BAA4B,GAAG,CAAC,CAAC;AACjF,MAAM,CAAC,MAAM,0BAA0B,GAAG;IACxC,EAAE,GAAG,EAAE,CAAC,EAAE,IAAI,EAAE,IAAI,EAAE;IACtB,EAAE,GAAG,EAAE,CAAC,EAAE,IAAI,EAAE,IAAI,EAAE;IACtB,EAAE,GAAG,EAAE,CAAC,EAAE,IAAI,EAAE,IAAI,EAAE;IACtB,EAAE,GAAG,EAAE,CAAC,EAAE,IAAI,EAAE,IAAI,EAAE;IACtB,EAAE,GAAG,EAAE,CAAC,EAAE,IAAI,EAAE,IAAI,EAAE;IACtB,EAAE,GAAG,EAAE,CAAC,EAAE,IAAI,EAAE,IAAI,EAAE;CACd,CAAC;AACX,MAAM,CAAC,MAAM,wBAAwB,GAAG,CAAC,CAAC;AAC1C,MAAM,CAAC,MAAM,yBAAyB,GAAG,CAAC,CAAC;AAC3C,MAAM,CAAC,MAAM,wBAAwB,GAAG,CAAC,CAAC;AAE1C,6EAA6E;AAC7E,MAAM,CAAC,MAAM,gBAAgB,GAAG,MAAM,CAAC;AACvC,MAAM,CAAC,MAAM,qBAAqB,GAAG,MAAM,CAAC;AAC5C,MAAM,CAAC,MAAM,qBAAqB,GAAG;IACnC,EAAE,EAAE,CAAC;IACL,IAAI,EAAE,MAAM;IACZ,QAAQ,EAAE,MAAM;IAChB,UAAU,EAAE,MAAM;IAClB,SAAS,EAAE,MAAM;IACjB,UAAU,EAAE,MAAM;IAClB,WAAW,EAAE,MAAM;IACnB,QAAQ,EAAE,MAAM;IAChB,OAAO,EAAE,MAAM;IACf,QAAQ,EAAE,MAAM;IAChB,UAAU,EAAE,MAAM;IAClB,UAAU,EAAE,MAAM;IAClB,WAAW,EAAE,MAAM;IACnB,OAAO,EAAE,gBAAgB,GAAG,EAAE;IAC9B,OAAO,EAAE,gBAAgB,GAAG,EAAE;IAC9B,WAAW,EAAE,gBAAgB,GAAG,EAAE;IAClC,WAAW,EAAE,gBAAgB,GAAG,EAAE;IAClC,gBAAgB,EAAE,gBAAgB,GAAG,EAAE;IACvC,QAAQ,EAAE,gBAAgB,GAAG,EAAE;IAC/B,YAAY,EAAE,gBAAgB,GAAG,EAAE;IACnC,WAAW,EAAE,gBAAgB,GAAG,EAAE;IAClC,SAAS,EAAE,gBAAgB,GAAG,EAAE;IAChC,WAAW,EAAE,qBAAqB,GAAG,CAAC;IACtC,UAAU,EAAE,qBAAqB,GAAG,EAAE;CAC9B,CAAC;AAEX,MAAM,CAAC,MAAM,4BAA4B,GAAG;IAC1C,UAAU;IACV,YAAY;IACZ,aAAa;IACb,cAAc;IACd,MAAM;IACN,SAAS;IACT,mBAAmB;IACnB,WAAW;IACX,aAAa;IACb,aAAa;IACb,cAAc;IACd,WAAW;IACX,aAAa;IACb,MAAM;IACN,aAAa;IACb,cAAc;IACd,WAAW;IACX,QAAQ;IACR,UAAU;IACV,eAAe;IACf,YAAY;IACZ,cAAc;IACd,mBAAmB;CACX,CAAC;AAGX,MAAM,6BAA6B,GAA6C;IAC9E,QAAQ,EAAE,qBAAqB,CAAC,EAAE;IAClC,YAAY,EAAE,qBAAqB,CAAC,SAAS;IAC7C,aAAa,EAAE,qBAAqB,CAAC,UAAU;IAC/C,cAAc,EAAE,qBAAqB,CAAC,WAAW;IACjD,IAAI,EAAE,qBAAqB,CAAC,QAAQ;IACpC,OAAO,EAAE,qBAAqB,CAAC,OAAO;IACtC,mBAAmB,EAAE,qBAAqB,CAAC,WAAW;IACtD,WAAW,EAAE,qBAAqB,CAAC,QAAQ;IAC3C,aAAa,EAAE,qBAAqB,CAAC,UAAU;IAC/C,aAAa,EAAE,qBAAqB,CAAC,UAAU;IAC/C,cAAc,EAAE,qBAAqB,CAAC,WAAW;IACjD,WAAW,EAAE,qBAAqB,CAAC,QAAQ;IAC3C,aAAa,EAAE,qBAAqB,CAAC,UAAU;IAC/C,IAAI,EAAE,qBAAqB,CAAC,IAAI;IAChC,aAAa,EAAE,qBAAqB,CAAC,UAAU;IAC/C,cAAc,EAAE,qBAAqB,CAAC,WAAW;IACjD,WAAW,EAAE,qBAAqB,CAAC,QAAQ;IAC3C,QAAQ,EAAE,qBAAqB,CAAC,OAAO;IACvC,UAAU,EAAE,qBAAqB,CAAC,OAAO;IACzC,eAAe,EAAE,qBAAqB,CAAC,YAAY;IACnD,YAAY,EAAE,qBAAqB,CAAC,WAAW;IAC/C,cAAc,EAAE,qBAAqB,CAAC,WAAW;IACjD,mBAAmB,EAAE,qBAAqB,CAAC,gBAAgB;CAC5D,CAAC;AAEF,MAAM,sCAAsC,GAAG,IAAI,GAAG,CACpD,MAAM,CAAC,OAAO,CAAC,6BAA6B,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,MAAM,EAAE,OAAO,CAAC,EAAE,EAAE,CAAC,CAAC,OAAO,EAAE,MAAkC,CAAC,CAAC,CACxH,CAAC;AAeF,MAAM,UAAU,sBAAsB,CAAC,KAAa;IAClD,OAAO,IAAI,CAAC,GAAG,CAAC,IAAI,CAAC,GAAG,CAAC,KAAK,EAAE,CAAC,CAAC,EAAE,yBAAyB,CAAC,CAAC;AACjE,CAAC;AAED,mEAAmE;AACnE,MAAM,UAAU,yBAAyB,CAAC,KAAa;IACrD,OAAO,sBAAsB,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC;AAC3C,CAAC;AAED,MAAM,UAAU,kBAAkB,CAAC,KAAa;IAC9C,OAAO,SAAS,yBAAyB,CAAC,KAAK,CAAC,EAAE,CAAC;AACrD,CAAC;AAED,MAAM,UAAU,wBAAwB,CAAC,OAAe;IACtD,OAAO,sCAAsC,CAAC,GAAG,CAAC,OAAO,CAAC,IAAI,QAAQ,CAAC;AACzE,CAAC;AAED,MAAM,UAAU,wBAAwB,CAAC,MAAgC;IACvE,OAAO,6BAA6B,CAAC,MAAM,CAAC,CAAC;AAC/C,CAAC;AAED,MAAM,UAAU,qBAAqB,CAAC,OAAe;IACnD,OAAO,EAAE,OAAO,EAAE,MAAM,EAAE,wBAAwB,CAAC,OAAO,CAAC,EAAE,CAAC;AAChE,CAAC;AAED,MAAM,UAAU,4BAA4B,CAC1C,KAAa,EACb,WAA8B,EAC9B,GAAW,EACX,EAAU,EACV,gBAAgB,GAAG,CAAC;IAEpB,OAAO;QACL,KAAK;QACL,IAAI,EAAE,0BAA0B,CAAC,GAAG,CAAC,CAAC,OAAO,EAAE,EAAE,CAAC,CAAC;YACjD,GAAG,OAAO;YACV,GAAG,qBAAqB,CAAC,WAAW,CAAC,OAAO,CAAC,GAAG,CAAC,IAAI,CAAC,CAAC;SACxD,CAAC,CAAC;QACH,KAAK,EAAE;YACL,GAAG,EAAE,qBAAqB,CAAC,GAAG,CAAC;YAC/B,EAAE,EAAE,qBAAqB,CAAC,EAAE,CAAC;SAC9B;QACD,gBAAgB;KACjB,CAAC;AACJ,CAAC;AAED,MAAM,UAAU,uBAAuB,CAAC,QAAgB;IACtD,MAAM,MAAM,GAAG,gCAAgC,GAAG,QAAQ,CAAC;IAC3D,OAAO;QACL,oBAAoB,CAAC,SAAS;QAC9B,CAAC,MAAM,IAAI,CAAC,CAAC,GAAG,IAAI;QACpB,MAAM,GAAG,IAAI;QACb,gCAAgC;KACjC,CAAC;AACJ,CAAC;AAED,MAAM,UAAU,0BAA0B,CAAC,QAAoB;IAC7D,MAAM,IAAI,GAAG,QAAQ,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC;IAC9B,MAAM,IAAI,GAAG,QAAQ,CAAC,QAAQ,CAAC,CAAC,EAAE,CAAC,GAAG,IAAI,CAAC,CAAC;IAC5C,MAAM,KAAK,GAAa,EAAE,CAAC;IAC3B,KAAK,IAAI,KAAK,GAAG,CAAC,EAAE,KAAK,GAAG,CAAC,GAAG,IAAI,CAAC,MAAM,EAAE,KAAK,IAAI,CAAC,EAAE,CAAC;QACxD,KAAK,CAAC,IAAI,CAAC,CAAC,CAAC,IAAI,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC,IAAI,CAAC,CAAC,GAAG,CAAC,IAAI,CAAC,KAAK,GAAG,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC;IACjE,CAAC;IACD,OAAO,KAAK,CAAC;AACf,CAAC;AAED,MAAM,UAAU,wBAAwB,CAAC,QAAgB,EAAE,GAAW;IACpE,OAAO,CAAC,oBAAoB,CAAC,UAAU,EAAE,QAAQ,GAAG,IAAI,EAAE,CAAC,EAAE,GAAG,GAAG,IAAI,CAAC,CAAC;AAC3E,CAAC;AAED,MAAM,UAAU,wBAAwB,CAAC,QAAgB,EAAE,GAAW,EAAE,OAAe;IACrF,OAAO;QACL,oBAAoB,CAAC,UAAU;QAC/B,QAAQ,GAAG,IAAI;QACf,CAAC;QACD,GAAG,GAAG,IAAI;QACV,CAAC,OAAO,IAAI,CAAC,CAAC,GAAG,IAAI;QACrB,OAAO,GAAG,IAAI;KACf,CAAC;AACJ,CAAC;AAED,MAAM,UAAU,wBAAwB,CAAC,QAAgB,EAAE,SAAkB;IAC3E,OAAO;QACL,oBAAoB,CAAC,UAAU;QAC/B,QAAQ,GAAG,IAAI;QACf,wBAAwB;QACxB,SAAS,CAAC,CAAC,CAAC,wBAAwB,CAAC,CAAC,CAAC,yBAAyB;KACjE,CAAC;AACJ,CAAC;AAED,MAAM,UAAU,wBAAwB,CAAC,QAAgB,EAAE,SAAkB,EAAE,OAAe;IAC5F,OAAO;QACL,oBAAoB,CAAC,UAAU;QAC/B,QAAQ,GAAG,IAAI;QACf,wBAAwB;QACxB,SAAS,CAAC,CAAC,CAAC,wBAAwB,CAAC,CAAC,CAAC,yBAAyB;QAChE,CAAC,OAAO,IAAI,CAAC,CAAC,GAAG,IAAI;QACrB,OAAO,GAAG,IAAI;KACf,CAAC;AACJ,CAAC;AAED,MAAM,UAAU,0BAA0B,CAAC,QAAoB;IAC7D,OAAO,CAAC,CAAC,QAAQ,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,IAAI,CAAC,CAAC,GAAG,CAAC,QAAQ,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC;AACxD,CAAC"}

package/dist/ksnake/index.d.ts

@@ -0,0 +1,157 @@
+/**
+ * K-snake X11 configuration protocol, reverse-engineered from the vendor
+ * WebHID panel shipped at https://x1a11.yjx2012.com/ (Next.js `app/page` chunk).
+ *
+ * Transport: WebHID output report (`sendReport(0, 64 bytes starting with
+ * 0x55)`) with the reply arriving as a queued `inputreport` — not a feature
+ * report. Control collection is usage page 0xFF01, usage 0x10; the vendor
+ * picker requests:
+ *   [{ vendorId: 0xA8A4, productId: 0x2255, usagePage: 0xFF01, usage: 0x10 },
+ *    { vendorId: 0xA8A5, productId: 0x2255, usagePage: 0xFF01, usage: 0x10 }]
+ * 0xA8A4 reports "USB", 0xA8A5 is the 2.4 GHz dongle.
+ *
+ * This module is transport-independent: it only builds 64-byte report bodies
+ * and decodes reply buffers. See `src/drivers/ksnake/hid.ts` for the WebHID
+ * exchange queue.
+ */
+export declare const KSNAKE_USB_VENDOR_ID = 43172;
+export declare const KSNAKE_DONGLE_VENDOR_ID = 43173;
+export declare const KSNAKE_PRODUCT_ID = 8789;
+export declare const KSNAKE_USAGE_PAGE = 65281;
+export declare const KSNAKE_USAGE = 16;
+export declare const KSNAKE_REPORT_ID = 0;
+export declare const KSNAKE_MAGIC = 85;
+export declare const KSNAKE_REPORT_SIZE = 64;
+/** DPI range. Vendor panel slider allows 200–12000 (step 100); the manual's
+ *  factory steps are 800–12000 and 600 was observed in stage 0 on retail
+ *  hardware (user-customized via the vendor panel). */
+export declare const KSNAKE_DPI_MIN = 200;
+export declare const KSNAKE_DPI_MAX = 12000;
+export declare function ksnakeIsValidDpi(dpi: number): boolean;
+export interface KsnakeProduct {
+    model: string;
+    wireless: boolean;
+    /** Not yet exercised on hardware through this driver. */
+    verified: false;
+}
+export declare const KSNAKE_PRODUCTS: ReadonlyMap<number, KsnakeProduct>;
+/**
+ * Polling-rate index ↔ Hz.
+ * Endpoints confirmed by the X11 user manual: 1000 Hz in 2.4G/wired,
+ * 125 Hz in BT. Middle steps (250/500) come from the vendor panel screenshot
+ * + PAW3311 spec — keep until a hardware capture says otherwise.
+ * Default index 3 = 1000 Hz.
+ */
+export declare const KSNAKE_POLLING_RATES: readonly [125, 250, 500, 1000];
+export declare function ksnakeEncodePollingRate(hz: number): number | null;
+export declare function ksnakeDecodePollingRate(index: number): number | null;
+/**
+ * Lift-off mapping. The vendor panel offers two stops (lod_value 1/2,
+ * default 1, likely 1mm/2mm on the PAW3311); they map to the Low/High stops.
+ * Medium is not offered by the hardware.
+ */
+export declare function ksnakeDecodeLiftOff(value: number): "Low" | "High";
+export declare function ksnakeEncodeLiftOff(level: string): number | null;
+export declare const KSNAKE_DEFAULT_CONFIG: {
+    readonly lightMode: 2;
+    readonly reportRate: 3;
+    readonly dpiIndex: 2;
+    readonly dpiCount: 6;
+    readonly stages: readonly [800, 1200, 1600, 3200, 5000, 12000];
+    readonly scrollFlag: 0;
+    readonly lodValue: 1;
+    readonly sensorFlag: 53;
+    readonly keyRespond: 2;
+    readonly sleepLight: 10;
+    readonly highspeedMode: 0;
+    readonly wakeupFlag: 1;
+    readonly moveLightFlag: 1;
+};
+export interface KsnakeConfig {
+    lightMode: number;
+    /** 0-based index into KSNAKE_POLLING_RATES */
+    reportRate: number;
+    /** 0-based active DPI stage */
+    dpiIndex: number;
+    /** number of enabled DPI stages */
+    dpiCount: number;
+    /** up to 6 LE uint16 DPI stages */
+    stages: number[];
+    scrollFlag: number;
+    lodValue: number;
+    sensorFlag: number;
+    keyRespond: number;
+    sleepLight: number;
+    highspeedMode: number;
+    wakeupFlag: number;
+    moveLightFlag: number;
+}
+/** 64-byte output-report body (without the reportId prefix). */
+export declare function ksnakeGetVersionRequest(): Uint8Array;
+/** Vendor reply bytes [23..25] hold ASCII "x.y.z" when present. */
+export declare function ksnakeDecodeVersion(reply: Uint8Array): string | null;
+export declare function ksnakeGetBatteryRequest(): Uint8Array;
+export declare function ksnakeDecodeBattery(reply: Uint8Array): {
+    percent: number;
+    charging: number;
+} | null;
+export declare function ksnakeGetConfigRequest(): Uint8Array;
+/** Decode a getConfig reply, mirroring the vendor `getMouseConfigInfo()`. */
+export declare function ksnakeDecodeConfig(reply: Uint8Array): KsnakeConfig | null;
+/** Encode a setConfig request, mirroring vendor `setMouseConfigData()`. */
+export declare function ksnakeEncodeSetConfig(config: KsnakeConfig): Uint8Array;
+/** Physical button order for the 6 remappable slots. Labels follow the factory
+ *  functions; the side button ships as Forward (user-renameable to Macro1). */
+export declare const KSNAKE_BUTTON_NAMES: readonly ["Left", "Right", "Middle", "Backward", "Forward", "DPI"];
+/** Button function types from the vendor key catalog. */
+export declare const KSNAKE_KEY_TYPE: {
+    readonly mouse: 32;
+    readonly special: 33;
+    readonly media: 48;
+};
+/** One button slot: type 32 = mouse button (code1 = HID bitmask, 0 = disabled),
+ *  33 = special (DPI loop [85,0,0], scroll [56,1/255]), 48 = consumer/media
+ *  (code1 = consumer usage). Macro references (e.g. type 112) are preserved
+ *  opaquely — the catalog cannot rebuild them. */
+export interface KsnakeKeyBinding {
+    type: number;
+    code1: number;
+    code2: number;
+    code3: number;
+}
+export declare function ksnakeIsKnownKeyType(type: number): boolean;
+/** Remappable actions from the vendor key catalog (display label + bytes). */
+export declare const KSNAKE_BUTTON_ACTIONS: ReadonlyArray<{
+    label: string;
+    type: number;
+    code1: number;
+    code2: number;
+    code3: number;
+}>;
+/** Display label for a binding, or null when the catalog cannot name it. */
+export declare function ksnakeBindingLabel(binding: KsnakeKeyBinding): string | null;
+/** Catalog binding for a display label, or null for unknown labels. */
+export declare function ksnakeFindButtonAction(label: string): KsnakeKeyBinding | null;
+/**
+ * Plausibility gate for decoded key maps. `exchange()` resolves with the next
+ * input report, so a stray report from another command can land here; those
+ * decode to zeroed/garbage slot types. Real maps always carry nonzero types
+ * (32/33/48 catalog, plus opaque refs like macro 112).
+ */
+export declare function ksnakeKeysLookPlausible(keys: readonly KsnakeKeyBinding[]): boolean;
+/** GET_KEYS request tail observed in vendor JS: [0x55, 0x08, 0xA5, 0x0B, 0x20]. */
+export declare function ksnakeGetKeysRequest(): Uint8Array;
+/**
+ * Decode a getKeys reply: 7 slots of 4 bytes at reply[8..35] (the vendor
+ * slices 8). Slot 6 is a fixed scroll-up entry; slots 0-5 are remappable.
+ * Verified against a retail dongle (factory map decodes to
+ * Left/Right/Middle/Backward + DPI loop in order).
+ */
+export declare function ksnakeDecodeKeys(reply: Uint8Array): KsnakeKeyBinding[] | null;
+/**
+ * Encode a setKeys request, mirroring vendor `setMouseKeys()`: head
+ * [0x55, 0x09, 0xA5, 0x22, 0x20], slots 0-5 at body[9..32], fixed tail
+ * [33,56,1,0, 33,56,255,0] at body[33..40].
+ */
+export declare function ksnakeEncodeSetKeys(keys: readonly KsnakeKeyBinding[]): Uint8Array;
+//# sourceMappingURL=index.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/ksnake/index.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;GAeG;AAEH,eAAO,MAAM,oBAAoB,QAAS,CAAC;AAC3C,eAAO,MAAM,uBAAuB,QAAS,CAAC;AAC9C,eAAO,MAAM,iBAAiB,OAAS,CAAC;AACxC,eAAO,MAAM,iBAAiB,QAAS,CAAC;AACxC,eAAO,MAAM,YAAY,KAAO,CAAC;AAEjC,eAAO,MAAM,gBAAgB,IAAO,CAAC;AACrC,eAAO,MAAM,YAAY,KAAO,CAAC;AACjC,eAAO,MAAM,kBAAkB,KAAK,CAAC;AAErC;;uDAEuD;AACvD,eAAO,MAAM,cAAc,MAAM,CAAC;AAClC,eAAO,MAAM,cAAc,QAAQ,CAAC;AAEpC,wBAAgB,gBAAgB,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAErD;AAED,MAAM,WAAW,aAAa;IAC5B,KAAK,EAAE,MAAM,CAAC;IACd,QAAQ,EAAE,OAAO,CAAC;IAClB,yDAAyD;IACzD,QAAQ,EAAE,KAAK,CAAC;CACjB;AAED,eAAO,MAAM,eAAe,EAAE,WAAW,CAAC,MAAM,EAAE,aAAa,CAE7D,CAAC;AAgBH;;;;;;GAMG;AACH,eAAO,MAAM,oBAAoB,gCAAiC,CAAC;AAEnE,wBAAgB,uBAAuB,CAAC,EAAE,EAAE,MAAM,GAAG,MAAM,GAAG,IAAI,CAGjE;AAED,wBAAgB,uBAAuB,CAAC,KAAK,EAAE,MAAM,GAAG,MAAM,GAAG,IAAI,CAEpE;AAED;;;;GAIG;AACH,wBAAgB,mBAAmB,CAAC,KAAK,EAAE,MAAM,GAAG,KAAK,GAAG,MAAM,CAEjE;AAED,wBAAgB,mBAAmB,CAAC,KAAK,EAAE,MAAM,GAAG,MAAM,GAAG,IAAI,CAIhE;AAED,eAAO,MAAM,qBAAqB;;;;;;;;;;;;;;CAexB,CAAC;AAEX,MAAM,WAAW,YAAY;IAC3B,SAAS,EAAE,MAAM,CAAC;IAClB,8CAA8C;IAC9C,UAAU,EAAE,MAAM,CAAC;IACnB,+BAA+B;IAC/B,QAAQ,EAAE,MAAM,CAAC;IACjB,mCAAmC;IACnC,QAAQ,EAAE,MAAM,CAAC;IACjB,mCAAmC;IACnC,MAAM,EAAE,MAAM,EAAE,CAAC;IACjB,UAAU,EAAE,MAAM,CAAC;IACnB,QAAQ,EAAE,MAAM,CAAC;IACjB,UAAU,EAAE,MAAM,CAAC;IACnB,UAAU,EAAE,MAAM,CAAC;IACnB,UAAU,EAAE,MAAM,CAAC;IACnB,aAAa,EAAE,MAAM,CAAC;IACtB,UAAU,EAAE,MAAM,CAAC;IACnB,aAAa,EAAE,MAAM,CAAC;CACvB;AAMD,gEAAgE;AAChE,wBAAgB,uBAAuB,IAAI,UAAU,CAKpD;AAED,mEAAmE;AACnE,wBAAgB,mBAAmB,CAAC,KAAK,EAAE,UAAU,GAAG,MAAM,GAAG,IAAI,CAQpE;AAED,wBAAgB,uBAAuB,IAAI,UAAU,CAQpD;AAED,wBAAgB,mBAAmB,CAAC,KAAK,EAAE,UAAU,GAAG;IAAE,OAAO,EAAE,MAAM,CAAC;IAAC,QAAQ,EAAE,MAAM,CAAA;CAAE,GAAG,IAAI,CAGnG;AAED,wBAAgB,sBAAsB,IAAI,UAAU,CAQnD;AAED,6EAA6E;AAC7E,wBAAgB,kBAAkB,CAAC,KAAK,EAAE,UAAU,GAAG,YAAY,GAAG,IAAI,CAiCzE;AAED,2EAA2E;AAC3E,wBAAgB,qBAAqB,CAAC,MAAM,EAAE,YAAY,GAAG,UAAU,CAyBtE;AAED;+EAC+E;AAC/E,eAAO,MAAM,mBAAmB,oEAAqE,CAAC;AAEtG,yDAAyD;AACzD,eAAO,MAAM,eAAe;;;;CAIlB,CAAC;AAEX;;;kDAGkD;AAClD,MAAM,WAAW,gBAAgB;IAC/B,IAAI,EAAE,MAAM,CAAC;IACb,KAAK,EAAE,MAAM,CAAC;IACd,KAAK,EAAE,MAAM,CAAC;IACd,KAAK,EAAE,MAAM,CAAC;CACf;AAED,wBAAgB,oBAAoB,CAAC,IAAI,EAAE,MAAM,GAAG,OAAO,CAE1D;AAED,8EAA8E;AAC9E,eAAO,MAAM,qBAAqB,EAAE,aAAa,CAAC;IAChD,KAAK,EAAE,MAAM,CAAC;IACd,IAAI,EAAE,MAAM,CAAC;IACb,KAAK,EAAE,MAAM,CAAC;IACd,KAAK,EAAE,MAAM,CAAC;IACd,KAAK,EAAE,MAAM,CAAC;CACf,CAgBA,CAAC;AAEF,4EAA4E;AAC5E,wBAAgB,kBAAkB,CAAC,OAAO,EAAE,gBAAgB,GAAG,MAAM,GAAG,IAAI,CAQ3E;AAED,uEAAuE;AACvE,wBAAgB,sBAAsB,CAAC,KAAK,EAAE,MAAM,GAAG,gBAAgB,GAAG,IAAI,CAG7E;AAED;;;;;GAKG;AACH,wBAAgB,uBAAuB,CAAC,IAAI,EAAE,SAAS,gBAAgB,EAAE,GAAG,OAAO,CAElF;AAED,mFAAmF;AACnF,wBAAgB,oBAAoB,IAAI,UAAU,CAQjD;AAED;;;;;GAKG;AACH,wBAAgB,gBAAgB,CAAC,KAAK,EAAE,UAAU,GAAG,gBAAgB,EAAE,GAAG,IAAI,CAY7E;AAED;;;;GAIG;AACH,wBAAgB,mBAAmB,CAAC,IAAI,EAAE,SAAS,gBAAgB,EAAE,GAAG,UAAU,CAuBjF"}