@openmouse/protocol 0.1.0

package/dist/ksnake/index.js

@@ -0,0 +1,314 @@
+/**
+ * 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 const KSNAKE_USB_VENDOR_ID = 0xa8a4;
+export const KSNAKE_DONGLE_VENDOR_ID = 0xa8a5;
+export const KSNAKE_PRODUCT_ID = 0x2255;
+export const KSNAKE_USAGE_PAGE = 0xff01;
+export const KSNAKE_USAGE = 0x10;
+export const KSNAKE_REPORT_ID = 0x00;
+export const KSNAKE_MAGIC = 0x55;
+export 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 const KSNAKE_DPI_MIN = 200;
+export const KSNAKE_DPI_MAX = 12000;
+export function ksnakeIsValidDpi(dpi) {
+    return Number.isInteger(dpi) && dpi >= KSNAKE_DPI_MIN && dpi <= KSNAKE_DPI_MAX;
+}
+export const KSNAKE_PRODUCTS = new Map([
+    [KSNAKE_PRODUCT_ID, { model: "X11", wireless: true, verified: false }],
+]);
+const CMD = {
+    GET_VERSION: 0x03,
+    GET_KEYS: 0x08,
+    SET_KEYS: 0x09,
+    GET_CONFIG: 0x0e,
+    SET_CONFIG: 0x0f,
+    SET_LIGHT: 0x21,
+    GET_BATTERY: 0x30,
+};
+const GET_CONFIG_TAIL = [0xa5, 0x0b, 0x2f, 0x01, 0x01, 0x00, 0x00, 0x00];
+const SET_CONFIG_HEAD = [0xae, 0x0a, 0x2f, 0x01, 0x01, 0x00, 0x00];
+const GET_BATTERY_TAIL = [0xa5, 0x0b, 0x2e, 0x01, 0x01, 0x00, 0x00, 0x00];
+/**
+ * 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 const KSNAKE_POLLING_RATES = [125, 250, 500, 1000];
+export function ksnakeEncodePollingRate(hz) {
+    const index = KSNAKE_POLLING_RATES.indexOf(hz);
+    return index === -1 ? null : index;
+}
+export function ksnakeDecodePollingRate(index) {
+    return index >= 0 && index < KSNAKE_POLLING_RATES.length ? KSNAKE_POLLING_RATES[index] : 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 function ksnakeDecodeLiftOff(value) {
+    return value === 2 ? "High" : "Low";
+}
+export function ksnakeEncodeLiftOff(level) {
+    if (level === "Low")
+        return 1;
+    if (level === "High")
+        return 2;
+    return null;
+}
+export const KSNAKE_DEFAULT_CONFIG = {
+    lightMode: 2,
+    reportRate: 3,
+    dpiIndex: 2,
+    // Hardware reports 6 (retail 2.4 GHz dongle, FW 2.1.7).
+    dpiCount: 6,
+    stages: [800, 1200, 1600, 3200, 5000, 12000],
+    scrollFlag: 0,
+    lodValue: 1,
+    sensorFlag: 53,
+    keyRespond: 2,
+    sleepLight: 10,
+    highspeedMode: 0,
+    wakeupFlag: 1,
+    moveLightFlag: 1,
+};
+function le16(lo, hi) {
+    return ((hi & 0xff) << 8) | (lo & 0xff);
+}
+/** 64-byte output-report body (without the reportId prefix). */
+export function ksnakeGetVersionRequest() {
+    const buf = new Uint8Array(KSNAKE_REPORT_SIZE);
+    buf[0] = KSNAKE_MAGIC;
+    buf[1] = CMD.GET_VERSION;
+    return buf;
+}
+/** Vendor reply bytes [23..25] hold ASCII "x.y.z" when present. */
+export function ksnakeDecodeVersion(reply) {
+    if (reply.length < 26)
+        return null;
+    const digit = (b) => (b >= 48 && b <= 57 ? String.fromCharCode(b) : null);
+    const major = digit(reply[23]);
+    const minor = digit(reply[24]);
+    const patch = digit(reply[25]);
+    if (major === null || minor === null || patch === null)
+        return null;
+    return `${major}.${minor}.${patch}`;
+}
+export function ksnakeGetBatteryRequest() {
+    const buf = new Uint8Array(KSNAKE_REPORT_SIZE);
+    buf[0] = KSNAKE_MAGIC;
+    buf[1] = CMD.GET_BATTERY;
+    GET_BATTERY_TAIL.forEach((b, i) => {
+        buf[2 + i] = b;
+    });
+    return buf;
+}
+export function ksnakeDecodeBattery(reply) {
+    if (reply.length < 10)
+        return null;
+    return { percent: reply[8] & 0xff, charging: reply[9] & 0xff };
+}
+export function ksnakeGetConfigRequest() {
+    const buf = new Uint8Array(KSNAKE_REPORT_SIZE);
+    buf[0] = KSNAKE_MAGIC;
+    buf[1] = CMD.GET_CONFIG;
+    GET_CONFIG_TAIL.forEach((b, i) => {
+        buf[2 + i] = b;
+    });
+    return buf;
+}
+/** Decode a getConfig reply, mirroring the vendor `getMouseConfigInfo()`. */
+export function ksnakeDecodeConfig(reply) {
+    if (reply.length < 56)
+        return null;
+    const blank = reply[13] === 0 && reply[14] === 0 && reply[15] === 0;
+    const erased = reply[13] === 255 && reply[14] === 255 && reply[15] === 255;
+    if (blank || erased) {
+        return { ...KSNAKE_DEFAULT_CONFIG, stages: [...KSNAKE_DEFAULT_CONFIG.stages] };
+    }
+    return {
+        lightMode: reply[9],
+        reportRate: reply[10] - 1,
+        dpiIndex: reply[12] - 1,
+        dpiCount: reply[11],
+        stages: [
+            le16(reply[13], reply[14]),
+            le16(reply[15], reply[16]),
+            le16(reply[17], reply[18]),
+            le16(reply[19], reply[20]),
+            le16(reply[21], reply[22]),
+            le16(reply[23], reply[24]),
+        ],
+        scrollFlag: reply[48],
+        lodValue: reply[49],
+        sensorFlag: reply[50],
+        keyRespond: reply[51],
+        sleepLight: reply[52],
+        highspeedMode: reply[53],
+        // NOTE: the vendor panel itself is asymmetric here — its decode reads
+        // wakeup from the LOW nibble (`15 & t[55]`) but its encode writes
+        // `wakeup << 4 | move`. This codec mirrors the vendor byte-for-byte, so
+        // states round-trip exactly like the vendor panel does.
+        wakeupFlag: reply[55] & 15,
+        moveLightFlag: (reply[55] >> 4) & 15,
+    };
+}
+/** Encode a setConfig request, mirroring vendor `setMouseConfigData()`. */
+export function ksnakeEncodeSetConfig(config) {
+    const buf = new Uint8Array(KSNAKE_REPORT_SIZE);
+    buf[0] = KSNAKE_MAGIC;
+    buf[1] = CMD.SET_CONFIG;
+    SET_CONFIG_HEAD.forEach((b, i) => {
+        buf[2 + i] = b;
+    });
+    buf[9] = config.lightMode & 0xff;
+    buf[10] = (config.reportRate + 1) & 0xff;
+    buf[11] = config.dpiCount & 0xff;
+    buf[12] = (config.dpiIndex + 1) & 0xff;
+    const stages = [...config.stages];
+    while (stages.length < 6)
+        stages.push(0);
+    for (let i = 0; i < 6; i++) {
+        buf[13 + i * 2] = stages[i] & 0xff;
+        buf[14 + i * 2] = (stages[i] >> 8) & 0xff;
+    }
+    buf[48] = config.scrollFlag & 0xff;
+    buf[49] = config.lodValue & 0xff;
+    buf[50] = config.sensorFlag & 0xff;
+    buf[51] = config.keyRespond & 0xff;
+    buf[52] = config.sleepLight & 0xff;
+    buf[53] = config.highspeedMode & 0xff;
+    buf[54] = ((config.wakeupFlag << 4) | (config.moveLightFlag & 15)) & 0xff;
+    return buf;
+}
+/** Physical button order for the 6 remappable slots. Labels follow the factory
+ *  functions; the side button ships as Forward (user-renameable to Macro1). */
+export const KSNAKE_BUTTON_NAMES = ["Left", "Right", "Middle", "Backward", "Forward", "DPI"];
+/** Button function types from the vendor key catalog. */
+export const KSNAKE_KEY_TYPE = {
+    mouse: 32,
+    special: 33,
+    media: 48,
+};
+export function ksnakeIsKnownKeyType(type) {
+    return type === KSNAKE_KEY_TYPE.mouse || type === KSNAKE_KEY_TYPE.special || type === KSNAKE_KEY_TYPE.media;
+}
+/** Remappable actions from the vendor key catalog (display label + bytes). */
+export const KSNAKE_BUTTON_ACTIONS = [
+    { label: "Left click", type: 32, code1: 1, code2: 0, code3: 0 },
+    { label: "Right click", type: 32, code1: 2, code2: 0, code3: 0 },
+    { label: "Middle click", type: 32, code1: 4, code2: 0, code3: 0 },
+    { label: "Backward", type: 32, code1: 8, code2: 0, code3: 0 },
+    { label: "Forward", type: 32, code1: 16, code2: 0, code3: 0 },
+    { label: "Disabled", type: 32, code1: 0, code2: 0, code3: 0 },
+    { label: "DPI loop", type: 33, code1: 85, code2: 0, code3: 0 },
+    { label: "Scroll up", type: 33, code1: 56, code2: 1, code3: 0 },
+    { label: "Scroll down", type: 33, code1: 56, code2: 255, code3: 0 },
+    { label: "Volume +", type: 48, code1: 233, code2: 0, code3: 0 },
+    { label: "Volume −", type: 48, code1: 234, code2: 0, code3: 0 },
+    { label: "Mute", type: 48, code1: 226, code2: 0, code3: 0 },
+    { label: "Play/Pause", type: 48, code1: 205, code2: 0, code3: 0 },
+    { label: "Prev track", type: 48, code1: 182, code2: 0, code3: 0 },
+    { label: "Next track", type: 48, code1: 181, code2: 0, code3: 0 },
+];
+/** Display label for a binding, or null when the catalog cannot name it. */
+export function ksnakeBindingLabel(binding) {
+    return KSNAKE_BUTTON_ACTIONS.find((action) => action.type === binding.type &&
+        action.code1 === binding.code1 &&
+        action.code2 === binding.code2 &&
+        action.code3 === binding.code3)?.label ?? null;
+}
+/** Catalog binding for a display label, or null for unknown labels. */
+export function ksnakeFindButtonAction(label) {
+    const action = KSNAKE_BUTTON_ACTIONS.find((entry) => entry.label === label);
+    return action ? { type: action.type, code1: action.code1, code2: action.code2, code3: action.code3 } : 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 function ksnakeKeysLookPlausible(keys) {
+    return keys.length === 7 && keys.every((key) => key.type !== 0);
+}
+/** GET_KEYS request tail observed in vendor JS: [0x55, 0x08, 0xA5, 0x0B, 0x20]. */
+export function ksnakeGetKeysRequest() {
+    const buf = new Uint8Array(KSNAKE_REPORT_SIZE);
+    buf[0] = KSNAKE_MAGIC;
+    buf[1] = CMD.GET_KEYS;
+    buf[2] = 0xa5;
+    buf[3] = 0x0b;
+    buf[4] = 0x20;
+    return buf;
+}
+/**
+ * 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 function ksnakeDecodeKeys(reply) {
+    if (reply.length < 36)
+        return null;
+    const bindings = [];
+    for (let i = 0; i < 7; i++) {
+        bindings.push({
+            type: reply[8 + i * 4],
+            code1: reply[9 + i * 4],
+            code2: reply[10 + i * 4],
+            code3: reply[11 + i * 4],
+        });
+    }
+    return bindings;
+}
+/**
+ * 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 function ksnakeEncodeSetKeys(keys) {
+    const buf = new Uint8Array(KSNAKE_REPORT_SIZE);
+    buf[0] = KSNAKE_MAGIC;
+    buf[1] = CMD.SET_KEYS;
+    buf[2] = 0xa5;
+    buf[3] = 0x22;
+    buf[4] = 0x20;
+    const slots = [...keys].slice(0, 6);
+    while (slots.length < 6)
+        slots.push({ type: 32, code1: 0, code2: 0, code3: 0 });
+    // Wire offsets, NOT vendor-JS t[] indices: t[0] is the report id, so the
+    // request slots at t[9..32] land at data[8..31]. (buf[9..] bricked buttons.)
+    for (let n = 0; n < 6; n++) {
+        const key = slots[n];
+        buf[8 + n * 4] = key.type & 0xff;
+        buf[9 + n * 4] = key.code1 & 0xff;
+        buf[10 + n * 4] = key.code2 & 0xff;
+        buf[11 + n * 4] = key.code3 & 0xff;
+    }
+    const tail = [33, 56, 1, 0, 33, 56, 255, 0];
+    tail.forEach((b, i) => {
+        buf[32 + i] = b;
+    });
+    return buf;
+}
+//# sourceMappingURL=index.js.map

package/dist/ksnake/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/ksnake/index.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;GAeG;AAEH,MAAM,CAAC,MAAM,oBAAoB,GAAG,MAAM,CAAC;AAC3C,MAAM,CAAC,MAAM,uBAAuB,GAAG,MAAM,CAAC;AAC9C,MAAM,CAAC,MAAM,iBAAiB,GAAG,MAAM,CAAC;AACxC,MAAM,CAAC,MAAM,iBAAiB,GAAG,MAAM,CAAC;AACxC,MAAM,CAAC,MAAM,YAAY,GAAG,IAAI,CAAC;AAEjC,MAAM,CAAC,MAAM,gBAAgB,GAAG,IAAI,CAAC;AACrC,MAAM,CAAC,MAAM,YAAY,GAAG,IAAI,CAAC;AACjC,MAAM,CAAC,MAAM,kBAAkB,GAAG,EAAE,CAAC;AAErC;;uDAEuD;AACvD,MAAM,CAAC,MAAM,cAAc,GAAG,GAAG,CAAC;AAClC,MAAM,CAAC,MAAM,cAAc,GAAG,KAAK,CAAC;AAEpC,MAAM,UAAU,gBAAgB,CAAC,GAAW;IAC1C,OAAO,MAAM,CAAC,SAAS,CAAC,GAAG,CAAC,IAAI,GAAG,IAAI,cAAc,IAAI,GAAG,IAAI,cAAc,CAAC;AACjF,CAAC;AASD,MAAM,CAAC,MAAM,eAAe,GAAuC,IAAI,GAAG,CAAC;IACzE,CAAC,iBAAiB,EAAE,EAAE,KAAK,EAAE,KAAK,EAAE,QAAQ,EAAE,IAAI,EAAE,QAAQ,EAAE,KAAK,EAAE,CAAC;CACvE,CAAC,CAAC;AAEH,MAAM,GAAG,GAAG;IACV,WAAW,EAAE,IAAI;IACjB,QAAQ,EAAE,IAAI;IACd,QAAQ,EAAE,IAAI;IACd,UAAU,EAAE,IAAI;IAChB,UAAU,EAAE,IAAI;IAChB,SAAS,EAAE,IAAI;IACf,WAAW,EAAE,IAAI;CACT,CAAC;AAEX,MAAM,eAAe,GAAG,CAAC,IAAI,EAAE,IAAI,EAAE,IAAI,EAAE,IAAI,EAAE,IAAI,EAAE,IAAI,EAAE,IAAI,EAAE,IAAI,CAAU,CAAC;AAClF,MAAM,eAAe,GAAG,CAAC,IAAI,EAAE,IAAI,EAAE,IAAI,EAAE,IAAI,EAAE,IAAI,EAAE,IAAI,EAAE,IAAI,CAAU,CAAC;AAC5E,MAAM,gBAAgB,GAAG,CAAC,IAAI,EAAE,IAAI,EAAE,IAAI,EAAE,IAAI,EAAE,IAAI,EAAE,IAAI,EAAE,IAAI,EAAE,IAAI,CAAU,CAAC;AAEnF;;;;;;GAMG;AACH,MAAM,CAAC,MAAM,oBAAoB,GAAG,CAAC,GAAG,EAAE,GAAG,EAAE,GAAG,EAAE,IAAI,CAAU,CAAC;AAEnE,MAAM,UAAU,uBAAuB,CAAC,EAAU;IAChD,MAAM,KAAK,GAAI,oBAA0C,CAAC,OAAO,CAAC,EAAE,CAAC,CAAC;IACtE,OAAO,KAAK,KAAK,CAAC,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,KAAK,CAAC;AACrC,CAAC;AAED,MAAM,UAAU,uBAAuB,CAAC,KAAa;IACnD,OAAO,KAAK,IAAI,CAAC,IAAI,KAAK,GAAG,oBAAoB,CAAC,MAAM,CAAC,CAAC,CAAC,oBAAoB,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC;AAChG,CAAC;AAED;;;;GAIG;AACH,MAAM,UAAU,mBAAmB,CAAC,KAAa;IAC/C,OAAO,KAAK,KAAK,CAAC,CAAC,CAAC,CAAC,MAAM,CAAC,CAAC,CAAC,KAAK,CAAC;AACtC,CAAC;AAED,MAAM,UAAU,mBAAmB,CAAC,KAAa;IAC/C,IAAI,KAAK,KAAK,KAAK;QAAE,OAAO,CAAC,CAAC;IAC9B,IAAI,KAAK,KAAK,MAAM;QAAE,OAAO,CAAC,CAAC;IAC/B,OAAO,IAAI,CAAC;AACd,CAAC;AAED,MAAM,CAAC,MAAM,qBAAqB,GAAG;IACnC,SAAS,EAAE,CAAC;IACZ,UAAU,EAAE,CAAC;IACb,QAAQ,EAAE,CAAC;IACX,wDAAwD;IACxD,QAAQ,EAAE,CAAC;IACX,MAAM,EAAE,CAAC,GAAG,EAAE,IAAI,EAAE,IAAI,EAAE,IAAI,EAAE,IAAI,EAAE,KAAK,CAAC;IAC5C,UAAU,EAAE,CAAC;IACb,QAAQ,EAAE,CAAC;IACX,UAAU,EAAE,EAAE;IACd,UAAU,EAAE,CAAC;IACb,UAAU,EAAE,EAAE;IACd,aAAa,EAAE,CAAC;IAChB,UAAU,EAAE,CAAC;IACb,aAAa,EAAE,CAAC;CACR,CAAC;AAsBX,SAAS,IAAI,CAAC,EAAU,EAAE,EAAU;IAClC,OAAO,CAAC,CAAC,EAAE,GAAG,IAAI,CAAC,IAAI,CAAC,CAAC,GAAG,CAAC,EAAE,GAAG,IAAI,CAAC,CAAC;AAC1C,CAAC;AAED,gEAAgE;AAChE,MAAM,UAAU,uBAAuB;IACrC,MAAM,GAAG,GAAG,IAAI,UAAU,CAAC,kBAAkB,CAAC,CAAC;IAC/C,GAAG,CAAC,CAAC,CAAC,GAAG,YAAY,CAAC;IACtB,GAAG,CAAC,CAAC,CAAC,GAAG,GAAG,CAAC,WAAW,CAAC;IACzB,OAAO,GAAG,CAAC;AACb,CAAC;AAED,mEAAmE;AACnE,MAAM,UAAU,mBAAmB,CAAC,KAAiB;IACnD,IAAI,KAAK,CAAC,MAAM,GAAG,EAAE;QAAE,OAAO,IAAI,CAAC;IACnC,MAAM,KAAK,GAAG,CAAC,CAAS,EAAiB,EAAE,CAAC,CAAC,CAAC,IAAI,EAAE,IAAI,CAAC,IAAI,EAAE,CAAC,CAAC,CAAC,MAAM,CAAC,YAAY,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC;IACjG,MAAM,KAAK,GAAG,KAAK,CAAC,KAAK,CAAC,EAAE,CAAC,CAAC,CAAC;IAC/B,MAAM,KAAK,GAAG,KAAK,CAAC,KAAK,CAAC,EAAE,CAAC,CAAC,CAAC;IAC/B,MAAM,KAAK,GAAG,KAAK,CAAC,KAAK,CAAC,EAAE,CAAC,CAAC,CAAC;IAC/B,IAAI,KAAK,KAAK,IAAI,IAAI,KAAK,KAAK,IAAI,IAAI,KAAK,KAAK,IAAI;QAAE,OAAO,IAAI,CAAC;IACpE,OAAO,GAAG,KAAK,IAAI,KAAK,IAAI,KAAK,EAAE,CAAC;AACtC,CAAC;AAED,MAAM,UAAU,uBAAuB;IACrC,MAAM,GAAG,GAAG,IAAI,UAAU,CAAC,kBAAkB,CAAC,CAAC;IAC/C,GAAG,CAAC,CAAC,CAAC,GAAG,YAAY,CAAC;IACtB,GAAG,CAAC,CAAC,CAAC,GAAG,GAAG,CAAC,WAAW,CAAC;IACzB,gBAAgB,CAAC,OAAO,CAAC,CAAC,CAAC,EAAE,CAAC,EAAE,EAAE;QAChC,GAAG,CAAC,CAAC,GAAG,CAAC,CAAC,GAAG,CAAC,CAAC;IACjB,CAAC,CAAC,CAAC;IACH,OAAO,GAAG,CAAC;AACb,CAAC;AAED,MAAM,UAAU,mBAAmB,CAAC,KAAiB;IACnD,IAAI,KAAK,CAAC,MAAM,GAAG,EAAE;QAAE,OAAO,IAAI,CAAC;IACnC,OAAO,EAAE,OAAO,EAAE,KAAK,CAAC,CAAC,CAAC,GAAG,IAAI,EAAE,QAAQ,EAAE,KAAK,CAAC,CAAC,CAAC,GAAG,IAAI,EAAE,CAAC;AACjE,CAAC;AAED,MAAM,UAAU,sBAAsB;IACpC,MAAM,GAAG,GAAG,IAAI,UAAU,CAAC,kBAAkB,CAAC,CAAC;IAC/C,GAAG,CAAC,CAAC,CAAC,GAAG,YAAY,CAAC;IACtB,GAAG,CAAC,CAAC,CAAC,GAAG,GAAG,CAAC,UAAU,CAAC;IACxB,eAAe,CAAC,OAAO,CAAC,CAAC,CAAC,EAAE,CAAC,EAAE,EAAE;QAC/B,GAAG,CAAC,CAAC,GAAG,CAAC,CAAC,GAAG,CAAC,CAAC;IACjB,CAAC,CAAC,CAAC;IACH,OAAO,GAAG,CAAC;AACb,CAAC;AAED,6EAA6E;AAC7E,MAAM,UAAU,kBAAkB,CAAC,KAAiB;IAClD,IAAI,KAAK,CAAC,MAAM,GAAG,EAAE;QAAE,OAAO,IAAI,CAAC;IACnC,MAAM,KAAK,GAAG,KAAK,CAAC,EAAE,CAAC,KAAK,CAAC,IAAI,KAAK,CAAC,EAAE,CAAC,KAAK,CAAC,IAAI,KAAK,CAAC,EAAE,CAAC,KAAK,CAAC,CAAC;IACpE,MAAM,MAAM,GAAG,KAAK,CAAC,EAAE,CAAC,KAAK,GAAG,IAAI,KAAK,CAAC,EAAE,CAAC,KAAK,GAAG,IAAI,KAAK,CAAC,EAAE,CAAC,KAAK,GAAG,CAAC;IAC3E,IAAI,KAAK,IAAI,MAAM,EAAE,CAAC;QACpB,OAAO,EAAE,GAAG,qBAAqB,EAAE,MAAM,EAAE,CAAC,GAAG,qBAAqB,CAAC,MAAM,CAAC,EAAE,CAAC;IACjF,CAAC;IACD,OAAO;QACL,SAAS,EAAE,KAAK,CAAC,CAAC,CAAC;QACnB,UAAU,EAAE,KAAK,CAAC,EAAE,CAAC,GAAG,CAAC;QACzB,QAAQ,EAAE,KAAK,CAAC,EAAE,CAAC,GAAG,CAAC;QACvB,QAAQ,EAAE,KAAK,CAAC,EAAE,CAAC;QACnB,MAAM,EAAE;YACN,IAAI,CAAC,KAAK,CAAC,EAAE,CAAC,EAAE,KAAK,CAAC,EAAE,CAAC,CAAC;YAC1B,IAAI,CAAC,KAAK,CAAC,EAAE,CAAC,EAAE,KAAK,CAAC,EAAE,CAAC,CAAC;YAC1B,IAAI,CAAC,KAAK,CAAC,EAAE,CAAC,EAAE,KAAK,CAAC,EAAE,CAAC,CAAC;YAC1B,IAAI,CAAC,KAAK,CAAC,EAAE,CAAC,EAAE,KAAK,CAAC,EAAE,CAAC,CAAC;YAC1B,IAAI,CAAC,KAAK,CAAC,EAAE,CAAC,EAAE,KAAK,CAAC,EAAE,CAAC,CAAC;YAC1B,IAAI,CAAC,KAAK,CAAC,EAAE,CAAC,EAAE,KAAK,CAAC,EAAE,CAAC,CAAC;SAC3B;QACD,UAAU,EAAE,KAAK,CAAC,EAAE,CAAC;QACrB,QAAQ,EAAE,KAAK,CAAC,EAAE,CAAC;QACnB,UAAU,EAAE,KAAK,CAAC,EAAE,CAAC;QACrB,UAAU,EAAE,KAAK,CAAC,EAAE,CAAC;QACrB,UAAU,EAAE,KAAK,CAAC,EAAE,CAAC;QACrB,aAAa,EAAE,KAAK,CAAC,EAAE,CAAC;QACxB,sEAAsE;QACtE,kEAAkE;QAClE,wEAAwE;QACxE,wDAAwD;QACxD,UAAU,EAAE,KAAK,CAAC,EAAE,CAAC,GAAG,EAAE;QAC1B,aAAa,EAAE,CAAC,KAAK,CAAC,EAAE,CAAC,IAAI,CAAC,CAAC,GAAG,EAAE;KACrC,CAAC;AACJ,CAAC;AAED,2EAA2E;AAC3E,MAAM,UAAU,qBAAqB,CAAC,MAAoB;IACxD,MAAM,GAAG,GAAG,IAAI,UAAU,CAAC,kBAAkB,CAAC,CAAC;IAC/C,GAAG,CAAC,CAAC,CAAC,GAAG,YAAY,CAAC;IACtB,GAAG,CAAC,CAAC,CAAC,GAAG,GAAG,CAAC,UAAU,CAAC;IACxB,eAAe,CAAC,OAAO,CAAC,CAAC,CAAC,EAAE,CAAC,EAAE,EAAE;QAC/B,GAAG,CAAC,CAAC,GAAG,CAAC,CAAC,GAAG,CAAC,CAAC;IACjB,CAAC,CAAC,CAAC;IACH,GAAG,CAAC,CAAC,CAAC,GAAG,MAAM,CAAC,SAAS,GAAG,IAAI,CAAC;IACjC,GAAG,CAAC,EAAE,CAAC,GAAG,CAAC,MAAM,CAAC,UAAU,GAAG,CAAC,CAAC,GAAG,IAAI,CAAC;IACzC,GAAG,CAAC,EAAE,CAAC,GAAG,MAAM,CAAC,QAAQ,GAAG,IAAI,CAAC;IACjC,GAAG,CAAC,EAAE,CAAC,GAAG,CAAC,MAAM,CAAC,QAAQ,GAAG,CAAC,CAAC,GAAG,IAAI,CAAC;IACvC,MAAM,MAAM,GAAG,CAAC,GAAG,MAAM,CAAC,MAAM,CAAC,CAAC;IAClC,OAAO,MAAM,CAAC,MAAM,GAAG,CAAC;QAAE,MAAM,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC;IACzC,KAAK,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC,GAAG,CAAC,EAAE,CAAC,EAAE,EAAE,CAAC;QAC3B,GAAG,CAAC,EAAE,GAAG,CAAC,GAAG,CAAC,CAAC,GAAG,MAAM,CAAC,CAAC,CAAC,GAAG,IAAI,CAAC;QACnC,GAAG,CAAC,EAAE,GAAG,CAAC,GAAG,CAAC,CAAC,GAAG,CAAC,MAAM,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,GAAG,IAAI,CAAC;IAC5C,CAAC;IACD,GAAG,CAAC,EAAE,CAAC,GAAG,MAAM,CAAC,UAAU,GAAG,IAAI,CAAC;IACnC,GAAG,CAAC,EAAE,CAAC,GAAG,MAAM,CAAC,QAAQ,GAAG,IAAI,CAAC;IACjC,GAAG,CAAC,EAAE,CAAC,GAAG,MAAM,CAAC,UAAU,GAAG,IAAI,CAAC;IACnC,GAAG,CAAC,EAAE,CAAC,GAAG,MAAM,CAAC,UAAU,GAAG,IAAI,CAAC;IACnC,GAAG,CAAC,EAAE,CAAC,GAAG,MAAM,CAAC,UAAU,GAAG,IAAI,CAAC;IACnC,GAAG,CAAC,EAAE,CAAC,GAAG,MAAM,CAAC,aAAa,GAAG,IAAI,CAAC;IACtC,GAAG,CAAC,EAAE,CAAC,GAAG,CAAC,CAAC,MAAM,CAAC,UAAU,IAAI,CAAC,CAAC,GAAG,CAAC,MAAM,CAAC,aAAa,GAAG,EAAE,CAAC,CAAC,GAAG,IAAI,CAAC;IAC1E,OAAO,GAAG,CAAC;AACb,CAAC;AAED;+EAC+E;AAC/E,MAAM,CAAC,MAAM,mBAAmB,GAAG,CAAC,MAAM,EAAE,OAAO,EAAE,QAAQ,EAAE,UAAU,EAAE,SAAS,EAAE,KAAK,CAAU,CAAC;AAEtG,yDAAyD;AACzD,MAAM,CAAC,MAAM,eAAe,GAAG;IAC7B,KAAK,EAAE,EAAE;IACT,OAAO,EAAE,EAAE;IACX,KAAK,EAAE,EAAE;CACD,CAAC;AAaX,MAAM,UAAU,oBAAoB,CAAC,IAAY;IAC/C,OAAO,IAAI,KAAK,eAAe,CAAC,KAAK,IAAI,IAAI,KAAK,eAAe,CAAC,OAAO,IAAI,IAAI,KAAK,eAAe,CAAC,KAAK,CAAC;AAC9G,CAAC;AAED,8EAA8E;AAC9E,MAAM,CAAC,MAAM,qBAAqB,GAM7B;IACH,EAAE,KAAK,EAAE,YAAY,EAAE,IAAI,EAAE,EAAE,EAAE,KAAK,EAAE,CAAC,EAAE,KAAK,EAAE,CAAC,EAAE,KAAK,EAAE,CAAC,EAAE;IAC/D,EAAE,KAAK,EAAE,aAAa,EAAE,IAAI,EAAE,EAAE,EAAE,KAAK,EAAE,CAAC,EAAE,KAAK,EAAE,CAAC,EAAE,KAAK,EAAE,CAAC,EAAE;IAChE,EAAE,KAAK,EAAE,cAAc,EAAE,IAAI,EAAE,EAAE,EAAE,KAAK,EAAE,CAAC,EAAE,KAAK,EAAE,CAAC,EAAE,KAAK,EAAE,CAAC,EAAE;IACjE,EAAE,KAAK,EAAE,UAAU,EAAE,IAAI,EAAE,EAAE,EAAE,KAAK,EAAE,CAAC,EAAE,KAAK,EAAE,CAAC,EAAE,KAAK,EAAE,CAAC,EAAE;IAC7D,EAAE,KAAK,EAAE,SAAS,EAAE,IAAI,EAAE,EAAE,EAAE,KAAK,EAAE,EAAE,EAAE,KAAK,EAAE,CAAC,EAAE,KAAK,EAAE,CAAC,EAAE;IAC7D,EAAE,KAAK,EAAE,UAAU,EAAE,IAAI,EAAE,EAAE,EAAE,KAAK,EAAE,CAAC,EAAE,KAAK,EAAE,CAAC,EAAE,KAAK,EAAE,CAAC,EAAE;IAC7D,EAAE,KAAK,EAAE,UAAU,EAAE,IAAI,EAAE,EAAE,EAAE,KAAK,EAAE,EAAE,EAAE,KAAK,EAAE,CAAC,EAAE,KAAK,EAAE,CAAC,EAAE;IAC9D,EAAE,KAAK,EAAE,WAAW,EAAE,IAAI,EAAE,EAAE,EAAE,KAAK,EAAE,EAAE,EAAE,KAAK,EAAE,CAAC,EAAE,KAAK,EAAE,CAAC,EAAE;IAC/D,EAAE,KAAK,EAAE,aAAa,EAAE,IAAI,EAAE,EAAE,EAAE,KAAK,EAAE,EAAE,EAAE,KAAK,EAAE,GAAG,EAAE,KAAK,EAAE,CAAC,EAAE;IACnE,EAAE,KAAK,EAAE,UAAU,EAAE,IAAI,EAAE,EAAE,EAAE,KAAK,EAAE,GAAG,EAAE,KAAK,EAAE,CAAC,EAAE,KAAK,EAAE,CAAC,EAAE;IAC/D,EAAE,KAAK,EAAE,UAAU,EAAE,IAAI,EAAE,EAAE,EAAE,KAAK,EAAE,GAAG,EAAE,KAAK,EAAE,CAAC,EAAE,KAAK,EAAE,CAAC,EAAE;IAC/D,EAAE,KAAK,EAAE,MAAM,EAAE,IAAI,EAAE,EAAE,EAAE,KAAK,EAAE,GAAG,EAAE,KAAK,EAAE,CAAC,EAAE,KAAK,EAAE,CAAC,EAAE;IAC3D,EAAE,KAAK,EAAE,YAAY,EAAE,IAAI,EAAE,EAAE,EAAE,KAAK,EAAE,GAAG,EAAE,KAAK,EAAE,CAAC,EAAE,KAAK,EAAE,CAAC,EAAE;IACjE,EAAE,KAAK,EAAE,YAAY,EAAE,IAAI,EAAE,EAAE,EAAE,KAAK,EAAE,GAAG,EAAE,KAAK,EAAE,CAAC,EAAE,KAAK,EAAE,CAAC,EAAE;IACjE,EAAE,KAAK,EAAE,YAAY,EAAE,IAAI,EAAE,EAAE,EAAE,KAAK,EAAE,GAAG,EAAE,KAAK,EAAE,CAAC,EAAE,KAAK,EAAE,CAAC,EAAE;CAClE,CAAC;AAEF,4EAA4E;AAC5E,MAAM,UAAU,kBAAkB,CAAC,OAAyB;IAC1D,OAAO,qBAAqB,CAAC,IAAI,CAC/B,CAAC,MAAM,EAAE,EAAE,CACT,MAAM,CAAC,IAAI,KAAK,OAAO,CAAC,IAAI;QAC5B,MAAM,CAAC,KAAK,KAAK,OAAO,CAAC,KAAK;QAC9B,MAAM,CAAC,KAAK,KAAK,OAAO,CAAC,KAAK;QAC9B,MAAM,CAAC,KAAK,KAAK,OAAO,CAAC,KAAK,CACjC,EAAE,KAAK,IAAI,IAAI,CAAC;AACnB,CAAC;AAED,uEAAuE;AACvE,MAAM,UAAU,sBAAsB,CAAC,KAAa;IAClD,MAAM,MAAM,GAAG,qBAAqB,CAAC,IAAI,CAAC,CAAC,KAAK,EAAE,EAAE,CAAC,KAAK,CAAC,KAAK,KAAK,KAAK,CAAC,CAAC;IAC5E,OAAO,MAAM,CAAC,CAAC,CAAC,EAAE,IAAI,EAAE,MAAM,CAAC,IAAI,EAAE,KAAK,EAAE,MAAM,CAAC,KAAK,EAAE,KAAK,EAAE,MAAM,CAAC,KAAK,EAAE,KAAK,EAAE,MAAM,CAAC,KAAK,EAAE,CAAC,CAAC,CAAC,IAAI,CAAC;AAC9G,CAAC;AAED;;;;;GAKG;AACH,MAAM,UAAU,uBAAuB,CAAC,IAAiC;IACvE,OAAO,IAAI,CAAC,MAAM,KAAK,CAAC,IAAI,IAAI,CAAC,KAAK,CAAC,CAAC,GAAG,EAAE,EAAE,CAAC,GAAG,CAAC,IAAI,KAAK,CAAC,CAAC,CAAC;AAClE,CAAC;AAED,mFAAmF;AACnF,MAAM,UAAU,oBAAoB;IAClC,MAAM,GAAG,GAAG,IAAI,UAAU,CAAC,kBAAkB,CAAC,CAAC;IAC/C,GAAG,CAAC,CAAC,CAAC,GAAG,YAAY,CAAC;IACtB,GAAG,CAAC,CAAC,CAAC,GAAG,GAAG,CAAC,QAAQ,CAAC;IACtB,GAAG,CAAC,CAAC,CAAC,GAAG,IAAI,CAAC;IACd,GAAG,CAAC,CAAC,CAAC,GAAG,IAAI,CAAC;IACd,GAAG,CAAC,CAAC,CAAC,GAAG,IAAI,CAAC;IACd,OAAO,GAAG,CAAC;AACb,CAAC;AAED;;;;;GAKG;AACH,MAAM,UAAU,gBAAgB,CAAC,KAAiB;IAChD,IAAI,KAAK,CAAC,MAAM,GAAG,EAAE;QAAE,OAAO,IAAI,CAAC;IACnC,MAAM,QAAQ,GAAuB,EAAE,CAAC;IACxC,KAAK,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC,GAAG,CAAC,EAAE,CAAC,EAAE,EAAE,CAAC;QAC3B,QAAQ,CAAC,IAAI,CAAC;YACZ,IAAI,EAAE,KAAK,CAAC,CAAC,GAAG,CAAC,GAAG,CAAC,CAAC;YACtB,KAAK,EAAE,KAAK,CAAC,CAAC,GAAG,CAAC,GAAG,CAAC,CAAC;YACvB,KAAK,EAAE,KAAK,CAAC,EAAE,GAAG,CAAC,GAAG,CAAC,CAAC;YACxB,KAAK,EAAE,KAAK,CAAC,EAAE,GAAG,CAAC,GAAG,CAAC,CAAC;SACzB,CAAC,CAAC;IACL,CAAC;IACD,OAAO,QAAQ,CAAC;AAClB,CAAC;AAED;;;;GAIG;AACH,MAAM,UAAU,mBAAmB,CAAC,IAAiC;IACnE,MAAM,GAAG,GAAG,IAAI,UAAU,CAAC,kBAAkB,CAAC,CAAC;IAC/C,GAAG,CAAC,CAAC,CAAC,GAAG,YAAY,CAAC;IACtB,GAAG,CAAC,CAAC,CAAC,GAAG,GAAG,CAAC,QAAQ,CAAC;IACtB,GAAG,CAAC,CAAC,CAAC,GAAG,IAAI,CAAC;IACd,GAAG,CAAC,CAAC,CAAC,GAAG,IAAI,CAAC;IACd,GAAG,CAAC,CAAC,CAAC,GAAG,IAAI,CAAC;IACd,MAAM,KAAK,GAAG,CAAC,GAAG,IAAI,CAAC,CAAC,KAAK,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC;IACpC,OAAO,KAAK,CAAC,MAAM,GAAG,CAAC;QAAE,KAAK,CAAC,IAAI,CAAC,EAAE,IAAI,EAAE,EAAE,EAAE,KAAK,EAAE,CAAC,EAAE,KAAK,EAAE,CAAC,EAAE,KAAK,EAAE,CAAC,EAAE,CAAC,CAAC;IAChF,yEAAyE;IACzE,6EAA6E;IAC7E,KAAK,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC,GAAG,CAAC,EAAE,CAAC,EAAE,EAAE,CAAC;QAC3B,MAAM,GAAG,GAAG,KAAK,CAAC,CAAC,CAAC,CAAC;QACrB,GAAG,CAAC,CAAC,GAAG,CAAC,GAAG,CAAC,CAAC,GAAG,GAAG,CAAC,IAAI,GAAG,IAAI,CAAC;QACjC,GAAG,CAAC,CAAC,GAAG,CAAC,GAAG,CAAC,CAAC,GAAG,GAAG,CAAC,KAAK,GAAG,IAAI,CAAC;QAClC,GAAG,CAAC,EAAE,GAAG,CAAC,GAAG,CAAC,CAAC,GAAG,GAAG,CAAC,KAAK,GAAG,IAAI,CAAC;QACnC,GAAG,CAAC,EAAE,GAAG,CAAC,GAAG,CAAC,CAAC,GAAG,GAAG,CAAC,KAAK,GAAG,IAAI,CAAC;IACrC,CAAC;IACD,MAAM,IAAI,GAAG,CAAC,EAAE,EAAE,EAAE,EAAE,CAAC,EAAE,CAAC,EAAE,EAAE,EAAE,EAAE,EAAE,GAAG,EAAE,CAAC,CAAC,CAAC;IAC5C,IAAI,CAAC,OAAO,CAAC,CAAC,CAAC,EAAE,CAAC,EAAE,EAAE;QACpB,GAAG,CAAC,EAAE,GAAG,CAAC,CAAC,GAAG,CAAC,CAAC;IAClB,CAAC,CAAC,CAAC;IACH,OAAO,GAAG,CAAC;AACb,CAAC"}

package/dist/lamzu/atlantis.d.ts

@@ -0,0 +1,237 @@
+/**
+ * Lamzu's "Atlantis" generation — CompX vendor id 0x3554.
+ *
+ * These mice do not speak the page/command feature-report protocol in
+ * `../compx/codec.ts` that the 0x373e and 0x37b0 Lamzu models use. They speak
+ * the *other* CompX stack: report 8, 16-byte interrupt reports, settings in a
+ * flash image addressed by byte offset — the same wire protocol this package
+ * already implements for the Pulsar 4K receiver and the VGN and Teevolution
+ * mice that share vendor id 0x3554. CompX is the ODM for all of them; the
+ * user's own device reports `manufacturer: "compx"`.
+ *
+ * So the framing, command ids, checksum and 50-step DPI encoding are imported
+ * from the Pulsar entry point rather than restated here. What this module adds
+ * is only what is genuinely Lamzu: the product catalog, the flash fields
+ * Lamzu's firmware uses that the Pulsar driver never reads, the lift-off
+ * encoding (which differs), and the polling-rate table (which differs).
+ *
+ * Verified on a Lamzu Atlantis Mini 4K, firmware 1.24, wired 0x3554:0xf50f —
+ * see docs/lamzu-atlantis-testing.md. Protocol groundwork: LeadSun/lamzu-cfg
+ * (Apache-2.0/MIT), reverse-engineered from an Atlantis Mini Pro.
+ */
+export declare const LAMZU_ATLANTIS_VENDOR_ID = 13652;
+/** The one collection that answers: interface 1, usage page 0xff02, usage 2. */
+export declare const LAMZU_ATLANTIS_USAGE_PAGE = 65282;
+export declare const LAMZU_ATLANTIS_USAGE = 2;
+/** Shared CompX report-8 framing, re-stated under Lamzu names for callers. */
+export declare const LAMZU_ATLANTIS_REPORT_ID = 8;
+export declare const LAMZU_ATLANTIS_PACKET_LENGTH = 16;
+export declare const LAMZU_ATLANTIS_PAYLOAD_OFFSET = 5;
+export declare const LAMZU_ATLANTIS_MAX_PAYLOAD = 10;
+/**
+ * The commands are CompX's, not Lamzu's, so the whole Pulsar set is aliased
+ * here rather than a Lamzu-specific subset. Only six have been exercised on
+ * Atlantis hardware: 0x04 battery, 0x07/0x08 flash write/read, 0x0e active
+ * profile, 0x0f set active profile, and 0x12 firmware version (returned
+ * 0x01 0x24 — v1.24, matching both the USB bcdDevice and the version Lamzu's
+ * download page lists for this model). The dongle-only commands (0x15, 0x1d,
+ * 0x2b) answer status 1 over the cable; the rest — `encryptionData`,
+ * `deviceOnline`, `setDongleRgb` — are inherited names this driver never
+ * sends and are unverified on this family.
+ */
+export declare const LAMZU_ATLANTIS_COMMAND: {
+    readonly encryptionData: 1;
+    readonly deviceOnline: 3;
+    readonly batteryLevel: 4;
+    readonly writeFlashData: 7;
+    readonly readFlashData: 8;
+    readonly getCurrentConfig: 14;
+    readonly readVersionId: 18;
+    readonly setDongleRgb: 20;
+    readonly getDongleRgb: 21;
+    readonly getDongleVersion: 29;
+    readonly getRssi: 43;
+};
+/**
+ * Switching the active onboard profile. It is the write counterpart of
+ * `getCurrentConfig` (0x0e) and is absent from `PULSAR_COMMAND` because the
+ * Pulsar driver only reads the profile. Documented by lamzu-cfg as
+ * `WriteActiveProfile` and exercised here on an Atlantis Mini 4K.
+ */
+export declare const LAMZU_ATLANTIS_WRITE_ACTIVE_PROFILE = 15;
+/**
+ * Flash offsets. Everything in `PULSAR_FLASH` matched byte for byte on Lamzu
+ * hardware — same firmware family, same layout — so those are inherited rather
+ * than re-typed, and only the fields Lamzu's configurator exposes that the
+ * Pulsar driver never reads are added here.
+ *
+ * `sleepTime` deserves a note: the byte is a count of ten-second units, not
+ * seconds. Lamzu's configurator showed a 1-minute timeout while address 173
+ * held 0x06, and 10 seconds while it held 0x01.
+ */
+export declare const LAMZU_ATLANTIS_FLASH: {
+    readonly dpiStageCount: 2;
+    readonly dpiStageColors: 44;
+    readonly buttonActions: 96;
+    readonly highPerformance: 185;
+    readonly reportRate: 0;
+    readonly currentDpi: 4;
+    readonly liftOffDistance: 10;
+    readonly dpiValues: 12;
+    readonly debounceTime: 169;
+    readonly motionSync: 171;
+    readonly sleepTime: 173;
+    readonly angleSnapping: 175;
+    readonly rippleControl: 177;
+    readonly performanceState: 181;
+    readonly performanceTime: 183;
+};
+export declare const LAMZU_ATLANTIS_STAGE_STRIDE = 4;
+export declare const LAMZU_ATLANTIS_MAX_DPI_STAGES = 8;
+/**
+ * Onboard profiles, 1-based in Lamzu's UI and 0-based on the wire. Probed on
+ * hardware: writing indices 0-3 is accepted and reads back, while 4 and above
+ * are rejected with status 1 and leave the mouse on its previous profile.
+ */
+export declare const LAMZU_ATLANTIS_PROFILE_COUNT = 4;
+/** PAW3395: 50-26,000 DPI in 50 DPI steps, per Lamzu's own device table. */
+export declare const LAMZU_ATLANTIS_DPI_STEP = 50;
+export declare const LAMZU_ATLANTIS_MIN_DPI = 50;
+export declare const LAMZU_ATLANTIS_MAX_DPI = 26000;
+/**
+ * Both timers this firmware stores — the peak-performance window and the sleep
+ * timeout — count ten-second units in a single byte.
+ */
+export declare const LAMZU_ATLANTIS_TIMER_STEP_SECONDS = 10;
+export declare const LAMZU_ATLANTIS_MAX_TIMER_SECONDS: number;
+/** Sleep timeouts Lamzu's own configurator offers, in seconds. */
+export declare const LAMZU_ATLANTIS_SLEEP_OPTIONS: readonly [10, 30, 60, 300, 600, 1800];
+/**
+ * Which of the two encodings of 1,000 Hz a transport wants. Stored per product
+ * rather than derived from the rate ceiling: the 1K receiver tops out at
+ * 1,000 Hz like the cable does, so a ceiling test would silently decide its
+ * encoding for it, and no 1K receiver has been on hand to check.
+ */
+export type LamzuAtlantisRateFamily = "wired" | "receiver";
+export interface LamzuAtlantisProduct {
+    model: string;
+    wireless: boolean;
+    pollingRates: readonly number[];
+    rateFamily: LamzuAtlantisRateFamily;
+    /** False until this exact product id has been exercised on hardware. */
+    verified: boolean;
+}
+/**
+ * Six models share these ids — Atlantis OG V2, Atlantis Mini, Atlantis Mini
+ * Pro, Thorn, Maya and Paro of this generation — and nothing on the wire
+ * separates them: same product id, same USB product string ("LAMZU Atlantis
+ * Pro" on the cable, "LAMZU 4K Receiver" on the dongle), same firmware
+ * version. Lamzu's own Windows configurator has the same problem and solves it
+ * by making the user pick the model from a list, so this catalog names the
+ * family rather than pretending to identify one model.
+ *
+ * 0xf50f (the mouse on its cable) is confirmed on hardware. The three receiver
+ * ids come from Lamzu's shipped device table and nothing more: no receiver has
+ * been exercised, so neither their rate lists nor the transport itself is
+ * established, and they stay `verified: false` until one is.
+ */
+export declare const LAMZU_ATLANTIS_PRODUCTS: ReadonlyMap<number, LamzuAtlantisProduct>;
+/**
+ * The rate byte uses the encoding the other Lamzu generations use, where
+ * 1,000 Hz appears twice: 0x01 in the wired 125-1000 family and 0x10 in the
+ * receiver family. Both were read from the same mouse — 0x10 before Lamzu's
+ * configurator touched the profile and 0x01 after it wrote 1,000 Hz over the
+ * cable, with the vendor UI reading "1000Hz" both times — and selecting
+ * 500 Hz in that UI wrote 0x02.
+ *
+ * This is why the Lamzu units need their own table rather than
+ * `pulsarDecodePollingRate`, which reads 0x10 as 2,000 Hz.
+ */
+export declare const LAMZU_ATLANTIS_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]];
+export type LamzuAtlantisLiftOffDistance = "Low" | "Medium";
+/**
+ * Only two lift-off heights exist on this generation, 1 mm and 2 mm, and they
+ * encode as 1 and 2. The Pulsar driver's 3/1/2 → Low/Medium/High mapping would
+ * report a Lamzu's 1 mm as "Medium".
+ */
+export declare const LAMZU_ATLANTIS_LIFT_OFF_DISTANCES: readonly [readonly [1, "Low"], readonly [2, "Medium"]];
+export interface LamzuAtlantisRequest {
+    command: number;
+    address?: number;
+    payload?: readonly number[];
+}
+export interface LamzuAtlantisReply {
+    command: number;
+    error: number;
+    address: number;
+    /**
+     * The full payload window, not a slice of `declaredLength` bytes: the
+     * battery reply declares 2 while carrying 4 meaningful bytes (percent,
+     * charging, then the millivolts), so trusting the length byte would drop the
+     * voltage. Callers slice to what they asked for.
+     */
+    payload: Uint8Array;
+    declaredLength: number;
+}
+/**
+ * Builds the 16 bytes WebHID sends for report 8. The report id is excluded
+ * from the buffer but included in the checksum, which is what
+ * `pulsarPacketChecksum` accounts for.
+ */
+export declare function lamzuAtlantisEncodeRequest(spec: LamzuAtlantisRequest): Uint8Array<ArrayBuffer>;
+/**
+ * Decodes an input report body (the 16 bytes WebHID delivers, report id
+ * excluded). Returns null for a truncated frame or a failed checksum so a
+ * caller waiting on a reply can skip the unsolicited reports this firmware
+ * emits rather than throwing on them.
+ */
+export declare function lamzuAtlantisDecodeReply(body: Uint8Array): LamzuAtlantisReply | null;
+/**
+ * A flash field is stored with a trailing checksum byte, so the value bytes
+ * and that byte together must sum to 0x55.
+ */
+export declare function lamzuAtlantisFieldIsIntact(field: Uint8Array): boolean;
+/** Appends the trailing checksum a flash field is stored with. */
+export declare function lamzuAtlantisSealField(values: readonly number[]): number[];
+export interface LamzuAtlantisDpiStage {
+    x: number;
+    y: number;
+}
+/**
+ * Decodes a DPI stage field: `[x, y, flags, checksum]`, where the flags byte
+ * carries each axis's ninth and tenth bits — bits 2-3 for x, bits 6-7 for y,
+ * which is how `pulsarVgnEncodeDpi` lays them out.
+ *
+ * `pulsarVgnDecodeDpi` cannot be used for reads here: it returns null unless
+ * the two axis bytes are identical, because the Pulsar driver only ever
+ * writes them in lockstep. A Lamzu configured with separate axes stores a
+ * perfectly valid field that would then read as corrupt.
+ */
+export declare function lamzuAtlantisDecodeDpiStage(field: Uint8Array): LamzuAtlantisDpiStage | null;
+export declare function lamzuAtlantisDecodePollingRate(raw: number): number | null;
+/**
+ * Picks the byte for a rate. Only 1,000 Hz is ambiguous, and the transport's
+ * declared family decides it rather than anything inferred from the rate list.
+ */
+export declare function lamzuAtlantisEncodePollingRate(hertz: number, family: LamzuAtlantisRateFamily): number | null;
+export declare function lamzuAtlantisDecodeLiftOffDistance(raw: number): LamzuAtlantisLiftOffDistance | null;
+export declare function lamzuAtlantisEncodeLiftOffDistance(value: string): number | null;
+export interface LamzuAtlantisBattery {
+    percent: number | null;
+    millivolts: number | null;
+    charging: boolean;
+}
+/**
+ * Battery reply payload: [percent, charging, millivolts high, millivolts low].
+ *
+ * lamzu-cfg reads only the millivolts and derives a percentage linearly
+ * between 3,050 and 4,200 mV, which disagrees with the mouse while it charges:
+ * at 4,239 mV that estimate says 100%, where both the reported byte and
+ * Lamzu's configurator said 95%. The reported byte wins; the voltage is kept
+ * for display.
+ */
+export declare function lamzuAtlantisDecodeBattery(payload: Uint8Array): LamzuAtlantisBattery;
+/** Formats the 0x12 firmware reply the same way the Pulsar driver does. */
+export declare function lamzuAtlantisDecodeFirmware(label: string, payload: Uint8Array): string | null;
+export declare function lamzuAtlantisProduct(vendorId: number, productId: number): LamzuAtlantisProduct | undefined;
+//# sourceMappingURL=atlantis.d.ts.map

package/dist/lamzu/atlantis.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"atlantis.d.ts","sourceRoot":"","sources":["../../src/lamzu/atlantis.ts"],"names":[],"mappings":"AAQA;;;;;;;;;;;;;;;;;;;;GAoBG;AAEH,eAAO,MAAM,wBAAwB,QAAS,CAAC;AAE/C,gFAAgF;AAChF,eAAO,MAAM,yBAAyB,QAAS,CAAC;AAChD,eAAO,MAAM,oBAAoB,IAAO,CAAC;AAEzC,8EAA8E;AAC9E,eAAO,MAAM,wBAAwB,IAA0B,CAAC;AAChE,eAAO,MAAM,4BAA4B,KAA8B,CAAC;AACxE,eAAO,MAAM,6BAA6B,IAAI,CAAC;AAC/C,eAAO,MAAM,0BAA0B,KAAK,CAAC;AAE7C;;;;;;;;;;GAUG;AACH,eAAO,MAAM,sBAAsB;;;;;;;;;;;;CAAiB,CAAC;AAErD;;;;;GAKG;AACH,eAAO,MAAM,mCAAmC,KAAO,CAAC;AAExD;;;;;;;;;GASG;AACH,eAAO,MAAM,oBAAoB;;;;;;;;;;;;;;;;CAMvB,CAAC;AAEX,eAAO,MAAM,2BAA2B,IAAI,CAAC;AAC7C,eAAO,MAAM,6BAA6B,IAAI,CAAC;AAE/C;;;;GAIG;AACH,eAAO,MAAM,4BAA4B,IAAI,CAAC;AAE9C,4EAA4E;AAC5E,eAAO,MAAM,uBAAuB,KAAK,CAAC;AAC1C,eAAO,MAAM,sBAAsB,KAAK,CAAC;AACzC,eAAO,MAAM,sBAAsB,QAAQ,CAAC;AAE5C;;;GAGG;AACH,eAAO,MAAM,iCAAiC,KAAK,CAAC;AACpD,eAAO,MAAM,gCAAgC,QAA2C,CAAC;AAEzF,kEAAkE;AAClE,eAAO,MAAM,4BAA4B,uCAAwC,CAAC;AAElF;;;;;GAKG;AACH,MAAM,MAAM,uBAAuB,GAAG,OAAO,GAAG,UAAU,CAAC;AAE3D,MAAM,WAAW,oBAAoB;IACnC,KAAK,EAAE,MAAM,CAAC;IACd,QAAQ,EAAE,OAAO,CAAC;IAClB,YAAY,EAAE,SAAS,MAAM,EAAE,CAAC;IAChC,UAAU,EAAE,uBAAuB,CAAC;IACpC,wEAAwE;IACxE,QAAQ,EAAE,OAAO,CAAC;CACnB;AAKD;;;;;;;;;;;;;GAaG;AACH,eAAO,MAAM,uBAAuB,EAAE,WAAW,CAAC,MAAM,EAAE,oBAAoB,CAK5E,CAAC;AAEH;;;;;;;;;;GAUG;AACH,eAAO,MAAM,4BAA4B,6KAG/B,CAAC;AAEX,MAAM,MAAM,4BAA4B,GAAG,KAAK,GAAG,QAAQ,CAAC;AAE5D;;;;GAIG;AACH,eAAO,MAAM,iCAAiC,wDAEqC,CAAC;AAEpF,MAAM,WAAW,oBAAoB;IACnC,OAAO,EAAE,MAAM,CAAC;IAChB,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,OAAO,CAAC,EAAE,SAAS,MAAM,EAAE,CAAC;CAC7B;AAED,MAAM,WAAW,kBAAkB;IACjC,OAAO,EAAE,MAAM,CAAC;IAChB,KAAK,EAAE,MAAM,CAAC;IACd,OAAO,EAAE,MAAM,CAAC;IAChB;;;;;OAKG;IACH,OAAO,EAAE,UAAU,CAAC;IACpB,cAAc,EAAE,MAAM,CAAC;CACxB;AAED;;;;GAIG;AACH,wBAAgB,0BAA0B,CAAC,IAAI,EAAE,oBAAoB,GAAG,UAAU,CAAC,WAAW,CAAC,CAc9F;AAED;;;;;GAKG;AACH,wBAAgB,wBAAwB,CAAC,IAAI,EAAE,UAAU,GAAG,kBAAkB,GAAG,IAAI,CAcpF;AAED;;;GAGG;AACH,wBAAgB,0BAA0B,CAAC,KAAK,EAAE,UAAU,GAAG,OAAO,CAIrE;AAED,kEAAkE;AAClE,wBAAgB,sBAAsB,CAAC,MAAM,EAAE,SAAS,MAAM,EAAE,GAAG,MAAM,EAAE,CAI1E;AAED,MAAM,WAAW,qBAAqB;IACpC,CAAC,EAAE,MAAM,CAAC;IACV,CAAC,EAAE,MAAM,CAAC;CACX;AAED;;;;;;;;;GASG;AACH,wBAAgB,2BAA2B,CAAC,KAAK,EAAE,UAAU,GAAG,qBAAqB,GAAG,IAAI,CAQ3F;AAED,wBAAgB,8BAA8B,CAAC,GAAG,EAAE,MAAM,GAAG,MAAM,GAAG,IAAI,CAEzE;AAED;;;GAGG;AACH,wBAAgB,8BAA8B,CAC5C,KAAK,EAAE,MAAM,EACb,MAAM,EAAE,uBAAuB,GAC9B,MAAM,GAAG,IAAI,CAOf;AAED,wBAAgB,kCAAkC,CAAC,GAAG,EAAE,MAAM,GAAG,4BAA4B,GAAG,IAAI,CAEnG;AAED,wBAAgB,kCAAkC,CAAC,KAAK,EAAE,MAAM,GAAG,MAAM,GAAG,IAAI,CAE/E;AAED,MAAM,WAAW,oBAAoB;IACnC,OAAO,EAAE,MAAM,GAAG,IAAI,CAAC;IACvB,UAAU,EAAE,MAAM,GAAG,IAAI,CAAC;IAC1B,QAAQ,EAAE,OAAO,CAAC;CACnB;AAED;;;;;;;;GAQG;AACH,wBAAgB,0BAA0B,CAAC,OAAO,EAAE,UAAU,GAAG,oBAAoB,CASpF;AAED,2EAA2E;AAC3E,wBAAgB,2BAA2B,CAAC,KAAK,EAAE,MAAM,EAAE,OAAO,EAAE,UAAU,GAAG,MAAM,GAAG,IAAI,CAG7F;AAED,wBAAgB,oBAAoB,CAAC,QAAQ,EAAE,MAAM,EAAE,SAAS,EAAE,MAAM,GAAG,oBAAoB,GAAG,SAAS,CAG1G"}