@openmouse/protocol 0.1.0

package/dist/steelseries/sensei-ten.js

@@ -0,0 +1,389 @@
+/**
+ * SteelSeries Sensei TEN configuration protocol — pure encode/decode helpers.
+ *
+ * Reconstructed from public open-source implementations, not vendor software:
+ *
+ * - rivalcfg `rivalcfg/devices/sensei_ten.py` — the primary source for every
+ *   command byte, default, and product id here.
+ * - rivalcfg `rivalcfg/test/devices/old_specs/test_sensei_ten.py` — the
+ *   device-specific fixture test, which pins exact expected HID report bytes
+ *   for polling rate, sensitivity presets, logo/wheel color gradients,
+ *   buttons mapping, save, and the firmware query. Every byte sequence in
+ *   this module's own tests was cross-checked against that file rather than
+ *   re-derived solely from the handler source, since it is ground truth for
+ *   how rivalcfg actually serializes this device's settings.
+ * - rivalcfg `rivalcfg/handlers/range.py` (the `range` value type the
+ *   `multidpi_range` handler below builds on: linear input→output mapping,
+ *   rounded to the nearest step) and `rivalcfg/handlers/rgbgradient.py` (the
+ *   color/gradient wire format for `logo_color` and `wheel_color`).
+ * - `rivalcfg/devices/sensei_raw.py` and `rivalcfg/devices/sensei310.py` were
+ *   read to confirm they are unrelated protocols (different command bytes,
+ *   different DPI encodings) and were not a source for anything here.
+ *
+ * **Corroboration gap, flagged prominently per this rollout's instructions:**
+ * libratbag and the OpenRGB SteelSeries controller sources were not
+ * reachable from this environment (no network access to
+ * github.com/libratbag/libratbag or OpenRGB's SteelSeries controller files),
+ * so unlike some earlier SteelSeries clusters in this project, **nothing
+ * here has a second independent source** — rivalcfg (source + its own test
+ * fixture) is the only corroboration this module has. Treat every byte below
+ * as "rivalcfg says so", not "two independent projects agree".
+ *
+ * Every command is an HID **output report** (id `0x00`) except `logo_color`
+ * and `wheel_color`, which are HID **feature reports** — `sensei_ten.py`
+ * marks them `usbhid.HID_REPORT_TYPE_FEATURE` while every other setting is
+ * `HID_REPORT_TYPE_OUTPUT`. The functions here build the report *payload* —
+ * the bytes after the report id — unpadded, matching rivalcfg's `usbhid.py`
+ * writes (`_hid_write` always prepends `report_id = 0x00` and otherwise
+ * sends the payload as-is with no fixed packet length for this device).
+ *
+ * **This device is write-only except for firmware.** No public
+ * implementation has a getter for DPI, polling, or lighting/buttons; the
+ * single readable value is the two-byte firmware version behind `90 00`
+ * (`response_length: 2`, `report_type: OUTPUT`), the same shape as Rival 3
+ * Gen 1's `10 00` — see `steelseriesSenseiTenDecodeFirmware`, which reuses
+ * Rival 3's read-order-byte-join convention and the same byte-order caveat.
+ *
+ * Settings apply immediately; `save_command` (`59 00`) persists them to
+ * onboard flash — distinct from Rival 3 Gen 1's `09 00` and Aerox 3's
+ * `11 00`; do not reuse across families.
+ *
+ * ## Sensor / DPI encoding
+ *
+ * Unlike Rival 3 Gen 1 and Aerox 3 (TrueMove Core, a byte lookup table),
+ * Sensei TEN's `sensitivity` setting uses rivalcfg's plain `multidpi_range`
+ * handler with `input_range: [50, 18000, 50]` and `output_range: [1, 0x0168,
+ * 1]` — a **linear** mapping, not a table: `output = input / 50`, written as
+ * a 2-byte little-endian integer per preset (`dpi_length_byte: 2`). This
+ * matches SteelSeries marketing calling Sensei TEN's sensor a newer
+ * generation (TrueMove3+) than the TrueMove Core/Air families used by
+ * Rival 3 and Aerox 3/5 — confirmed here by the *shape* of the DPI handler
+ * (linear range vs. lookup table) rather than by an independent sensor-name
+ * source, which was not reachable (see corroboration gap above).
+ *
+ * `count_mode: "flag"` — like Aerox 3's `dpiPresets`, the on-wire preset
+ * count is a bitmask (`0b00000001` for 1 preset, `0b00001111` for 4, etc.),
+ * not a plain integer, unlike Rival 3 Gen 1's `count_mode: "number"`.
+ *
+ * ## RGB: `logo_color` / `wheel_color`
+ *
+ * Sensei TEN has two independently addressable RGB zones — the SteelSeries
+ * logo and the scroll-wheel light — both using rivalcfg's full `rgbgradient`
+ * value type (multi-stop animated gradients), not the simpler flat
+ * `rgbcolor`/zone-bitmask scheme Aerox 3 and Aerox 5 use. This module
+ * implements the complete gradient encoding (not just a solid-color special
+ * case), because the wire format is small and precisely pinned by
+ * `test_sensei_ten.py`'s `test_set_logo_color`/`test_set_wheel_color`
+ * fixtures, which this module's tests reproduce byte-for-byte.
+ *
+ * The packet layout, from `rgbgradient.py`'s `process_value` with Sensei
+ * TEN's `rgbgradient_header` (`header_length: 26`, `led_id_offsets: [0]`,
+ * `duration_offset: 1` (2 bytes, little-endian ms), `repeat_offset: 17`,
+ * `triggers_offset: 21`, `color_count_offset: 25`):
+ *
+ * ```
+ * 5B 00 <led_id> <duration_lo> <duration_hi> <14 zero bytes>
+ *       <repeat> <3 zero bytes> <triggers> <3 zero bytes> <color_count>
+ *       <initial_color r,g,b> <color1 r,g,b> <pos1> ... <colorN r,g,b> <posN>
+ * ```
+ *
+ * `led_id` is `0x00` for `logo_color`, `0x01` for `wheel_color` — the only
+ * difference between the two settings' commands. `repeat` is `0x01` for a
+ * solid color (no animation) or when the gradient has button triggers
+ * (`triggers` — not exposed by this module, always `0x00`, matching
+ * `sensei_ten.py`'s profile, which never sets it); `0x00` for an animated
+ * gradient with no trigger.
+ *
+ * **The per-stop `pos` byte is a *delta*, not an absolute position** — easy
+ * to get wrong reading `rgbgradient.py` casually, and this module's first
+ * draft did. Each stop's true 0–255 position is `Math.trunc(pos * 255 /
+ * 100)` (rivalcfg uses Python's `int()`, which truncates toward zero, not
+ * `round()`); the wire byte for that stop is the *difference* between this
+ * truncated position and the previous stop's, starting from 0. This was
+ * confirmed against `test_sensei_ten.py`'s `test_set_wheel_color` fixture:
+ * stops at 0/25/50/75/100% truncate to real positions 0/63/127/191/255, and
+ * the fixture's actual bytes are the deltas 0/63/64/64/64, not the absolute
+ * values — reproduced exactly by this module's own tests. rivalcfg
+ * auto-appends a final stop equal to the first color at pos 100 if the
+ * caller's last stop is not already at 100, "smoothing" the loop — this
+ * module requires the caller to pass every stop explicitly (including the
+ * closing one, if wanted) rather than silently appending one, to keep the
+ * encoder a pure function of its input.
+ *
+ * ## Buttons mapping — reduced scope, mirrors `aerox3.ts`
+ *
+ * `31 00` + one 40-byte (8 buttons × 5-byte field) packet, zero-filled
+ * except where a mapping is given — byte-identical field layout to Aerox 3's
+ * `buttons_mapping`, but Sensei TEN's `button_scroll_up`/`button_scroll_down`
+ * (`0x31`/`0x32`) are function **codes** a button's slot can hold (used when
+ * *another* button is remapped to act as a scroll action), unlike Aerox 3
+ * where `scrollUp`/`scrollDown` are physical button *sources* that cannot be
+ * remap targets. Sensei TEN has no such restriction — every one of its 8
+ * buttons is a valid remap target for another button's id (Button1–Button8,
+ * ids `0x01`–`0x08`). As with `aerox3.ts`, this module implements the exact
+ * packet shape and the mouse-button/disable/DPI-switch/scroll-up/scroll-down
+ * special actions, but does not re-implement rivalcfg's QWERTY/multimedia
+ * key-name tables — keyboard and multimedia targets are raw
+ * `{ type: "keyboard" | "multimedia", code }` scan-code bytes, matching
+ * `button_keyboard: 0x51` / `button_multimedia: 0x61` verbatim. The
+ * documented defaults (`test_set_buttons_mapping`'s `"default"` case) are
+ * exposed as `SENSEI_TEN_DEFAULT_BUTTONS_MAPPING` for callers/tests: Button6
+ * defaults to keyboard code `0x4E` (Page Down), Button7 to `0x4B` (Page Up),
+ * Button8 to DPI-switch — the rest map to themselves.
+ *
+ * None of this has been verified on physical Sensei TEN hardware by this
+ * project. The Sensei RAW (`sensei_raw.py`) and Sensei 310 (`sensei310.py`)
+ * use different, incompatible command sets and must not reuse this module.
+ */
+export const SENSEI_TEN_REPORT_ID = 0x00;
+/** Two-byte command prefixes; the payload is the prefix plus its arguments. */
+export const SENSEI_TEN_COMMAND = {
+    buttonsMapping: [0x31, 0x00],
+    pollingRate: [0x54, 0x00],
+    sensitivity: [0x55, 0x00],
+    logoColor: [0x5b, 0x00],
+    wheelColor: [0x5b, 0x00],
+    save: [0x59, 0x00],
+    firmware: [0x90, 0x00],
+};
+export const SENSEI_TEN_POLLING_RATES = [125, 250, 500, 1000];
+const POLLING_RATE_TO_BYTE = new Map([
+    [1000, 0x01],
+    [500, 0x02],
+    [250, 0x03],
+    [125, 0x04],
+]);
+export const SENSEI_TEN_DPI_MIN = 50;
+export const SENSEI_TEN_DPI_MAX = 18000;
+export const SENSEI_TEN_DPI_STEP = 50;
+export const SENSEI_TEN_MAX_DPI_PRESETS = 5;
+export const SENSEI_TEN_FIRMWARE_RESPONSE_LENGTH = 2;
+export class SenseiTenProtocolError extends Error {
+}
+/** Every DPI value the linear 50–18,000 (step 50) range can express, ascending. */
+export function steelseriesSenseiTenDpiOptions() {
+    const options = [];
+    for (let dpi = SENSEI_TEN_DPI_MIN; dpi <= SENSEI_TEN_DPI_MAX; dpi += SENSEI_TEN_DPI_STEP) {
+        options.push(dpi);
+    }
+    return options;
+}
+function dpiToWord(dpi) {
+    if (!Number.isInteger(dpi) ||
+        dpi < SENSEI_TEN_DPI_MIN ||
+        dpi > SENSEI_TEN_DPI_MAX ||
+        dpi % SENSEI_TEN_DPI_STEP !== 0) {
+        throw new SenseiTenProtocolError(`SteelSeries Sensei TEN DPI must be ${SENSEI_TEN_DPI_MIN}–${SENSEI_TEN_DPI_MAX.toLocaleString()} in ${SENSEI_TEN_DPI_STEP} DPI steps.`);
+    }
+    return dpi / SENSEI_TEN_DPI_STEP;
+}
+/**
+ * `55 00 <count flag> <selected> <v1 lo,hi> ... <vN lo,hi>` — replaces the
+ * mouse's whole preset table. Each DPI is 2 bytes little-endian
+ * (`dpi_length_byte: 2`); `count` is a bitmask of the preset count
+ * (`count_mode: "flag"`), not a plain integer. `selectedIndex` is 0-based
+ * here and encoded 1-based on the wire (`first_preset: 1`).
+ */
+export function steelseriesSenseiTenEncodeDpiPresets(presets, selectedIndex) {
+    if (presets.length < 1 || presets.length > SENSEI_TEN_MAX_DPI_PRESETS) {
+        throw new SenseiTenProtocolError(`SteelSeries Sensei TEN supports 1–${SENSEI_TEN_MAX_DPI_PRESETS} DPI presets.`);
+    }
+    if (!Number.isInteger(selectedIndex) || selectedIndex < 0 || selectedIndex >= presets.length) {
+        throw new SenseiTenProtocolError(`Selected DPI preset must be an index into the ${presets.length} presets being written.`);
+    }
+    const words = presets.map(dpiToWord);
+    const countFlag = 0b11111111 >> (8 - presets.length);
+    const bytes = [...SENSEI_TEN_COMMAND.sensitivity, countFlag, selectedIndex + 1];
+    for (const word of words) {
+        bytes.push(word & 0xff, (word >> 8) & 0xff);
+    }
+    return new Uint8Array(bytes);
+}
+/** `54 00 <v>` with 1000→0x01, 500→0x02, 250→0x03, 125→0x04. */
+export function steelseriesSenseiTenEncodePollingRate(pollingRateHz) {
+    const byte = POLLING_RATE_TO_BYTE.get(pollingRateHz);
+    if (byte === undefined) {
+        throw new SenseiTenProtocolError("SteelSeries Sensei TEN supports 125, 250, 500, or 1000 Hz polling.");
+    }
+    return new Uint8Array([...SENSEI_TEN_COMMAND.pollingRate, byte]);
+}
+const LED_ID = { logo: 0x00, wheel: 0x01 };
+const RGBGRADIENT_HEADER_LENGTH = 26;
+const RGBGRADIENT_DURATION_OFFSET = 1;
+const RGBGRADIENT_REPEAT_OFFSET = 17;
+const RGBGRADIENT_TRIGGERS_OFFSET = 21;
+const RGBGRADIENT_COLOR_COUNT_OFFSET = 25;
+const RGBGRADIENT_MAX_STOPS = 14;
+function validateColorChannel(value) {
+    if (!Number.isInteger(value) || value < 0 || value > 255) {
+        throw new SenseiTenProtocolError("RGB channels must be integers 0–255.");
+    }
+}
+/**
+ * `5B 00 <led_id> ...` — encodes a color or animated gradient for the logo
+ * (`led: "logo"`) or scroll-wheel (`led: "wheel"`) LED. See the module doc
+ * comment for the full packet layout.
+ *
+ * - A single stop (`stops.length === 1`) is treated as a solid, non-animated
+ *   color: `repeat` is set to `0x01` regardless of that stop's `pos`
+ *   (matching `rgbgradient.py`'s `is_gradient = False` path for a bare color
+ *   string/tuple, which always uses `pos = 0` internally — pass `pos: 0`
+ *   here for parity, though the wire format ignores it for a single stop
+ *   since there is nothing to interpolate toward).
+ * - Two or more stops are encoded as an animated gradient at `durationMs`,
+ *   `repeat` `0x00`. Unlike rivalcfg's CLI parser, this function does **not**
+ *   auto-append a closing stop equal to the first color at pos 100 — pass it
+ *   explicitly if a smooth loop is wanted (see `test_set_logo_color`'s
+ *   fixture, which does include that stop as its 4th entry).
+ */
+export function steelseriesSenseiTenEncodeLedColor(led, stops, durationMs = 1000) {
+    if (stops.length === 0) {
+        throw new SenseiTenProtocolError("SteelSeries Sensei TEN LED color needs at least one color stop.");
+    }
+    if (stops.length > RGBGRADIENT_MAX_STOPS) {
+        throw new SenseiTenProtocolError(`SteelSeries Sensei TEN allows a maximum of ${RGBGRADIENT_MAX_STOPS} color stops.`);
+    }
+    if (!Number.isInteger(durationMs) || durationMs < 0 || durationMs > 0xffff) {
+        throw new SenseiTenProtocolError("SteelSeries Sensei TEN gradient duration must be an integer 0–65535 ms.");
+    }
+    for (const stop of stops) {
+        validateColorChannel(stop.r);
+        validateColorChannel(stop.g);
+        validateColorChannel(stop.b);
+        if (!Number.isInteger(stop.pos) || stop.pos < 0 || stop.pos > 100) {
+            throw new SenseiTenProtocolError("SteelSeries Sensei TEN gradient stop positions must be integers 0–100.");
+        }
+    }
+    const header = new Array(RGBGRADIENT_HEADER_LENGTH).fill(0x00);
+    header[0] = LED_ID[led];
+    header[RGBGRADIENT_DURATION_OFFSET] = durationMs & 0xff;
+    header[RGBGRADIENT_DURATION_OFFSET + 1] = (durationMs >> 8) & 0xff;
+    header[RGBGRADIENT_REPEAT_OFFSET] = stops.length === 1 ? 0x01 : 0x00;
+    header[RGBGRADIENT_TRIGGERS_OFFSET] = 0x00;
+    header[RGBGRADIENT_COLOR_COUNT_OFFSET] = stops.length;
+    const body = [stops[0].r, stops[0].g, stops[0].b];
+    let lastRealPos = 0;
+    for (const stop of stops) {
+        const realPos = Math.trunc((stop.pos * 255) / 100);
+        body.push(stop.r, stop.g, stop.b, realPos - lastRealPos);
+        lastRealPos = realPos;
+    }
+    const command = led === "logo" ? SENSEI_TEN_COMMAND.logoColor : SENSEI_TEN_COMMAND.wheelColor;
+    return new Uint8Array([...command, ...header, ...body]);
+}
+/** `59 00` — commit the current settings to onboard flash. */
+export function steelseriesSenseiTenSaveCommand() {
+    return new Uint8Array(SENSEI_TEN_COMMAND.save);
+}
+/** `90 00` — the two-byte firmware version query, this device's only readable value. */
+export function steelseriesSenseiTenFirmwareQuery() {
+    return new Uint8Array(SENSEI_TEN_COMMAND.firmware);
+}
+/**
+ * Decode the two-byte firmware response, reusing Rival 3 Gen 1's read-order
+ * join convention (`steelseriesRival3DecodeFirmware`) — the byte order is
+ * contested between public implementations for that family, and no
+ * corroborating source (libratbag, OpenRGB) was reachable for Sensei TEN
+ * specifically to settle it independently. Both raw bytes are returned.
+ */
+export function steelseriesSenseiTenDecodeFirmware(payload) {
+    if (payload.length < SENSEI_TEN_FIRMWARE_RESPONSE_LENGTH) {
+        throw new SenseiTenProtocolError("SteelSeries Sensei TEN firmware response is shorter than two bytes.");
+    }
+    const bytes = [payload[0], payload[1]];
+    return { bytes, display: `${bytes[0]}.${bytes[1]}` };
+}
+/** `buttons_mapping.buttons` from `sensei_ten.py`, id + byte offset into the packet. */
+export const SENSEI_TEN_BUTTONS = {
+    button1: { id: 0x01, offset: 0x00 },
+    button2: { id: 0x02, offset: 0x05 },
+    button3: { id: 0x03, offset: 0x0a },
+    button4: { id: 0x04, offset: 0x0f },
+    button5: { id: 0x05, offset: 0x14 },
+    button6: { id: 0x06, offset: 0x19 },
+    button7: { id: 0x07, offset: 0x1e },
+    button8: { id: 0x08, offset: 0x23 },
+};
+const SENSEI_TEN_BUTTON_FIELD_LENGTH = 5;
+const SENSEI_TEN_BUTTON_DISABLE = 0x00;
+const SENSEI_TEN_BUTTON_DPI_SWITCH = 0x30;
+const SENSEI_TEN_BUTTON_SCROLL_UP = 0x31;
+const SENSEI_TEN_BUTTON_SCROLL_DOWN = 0x32;
+const SENSEI_TEN_BUTTON_KEYBOARD = 0x51;
+const SENSEI_TEN_BUTTON_MULTIMEDIA = 0x61;
+/**
+ * `31 00` + one 40-byte (`8 buttons × 5-byte field length`) packet,
+ * zero-filled except where a mapping is given. Unmapped buttons are left as
+ * all-zero fields — pass every button explicitly for parity with rivalcfg's
+ * default profile (see `SENSEI_TEN_DEFAULT_BUTTONS_MAPPING`).
+ */
+export function steelseriesSenseiTenEncodeButtonsMapping(mapping) {
+    const names = Object.keys(SENSEI_TEN_BUTTONS);
+    const packet = new Array(names.length * SENSEI_TEN_BUTTON_FIELD_LENGTH).fill(0x00);
+    for (const [name, action] of Object.entries(mapping)) {
+        const slot = SENSEI_TEN_BUTTONS[name];
+        if (!slot) {
+            throw new SenseiTenProtocolError(`Unknown SteelSeries Sensei TEN button "${name}".`);
+        }
+        const { offset } = slot;
+        switch (action.type) {
+            case "button": {
+                packet[offset] = SENSEI_TEN_BUTTONS[action.target].id;
+                break;
+            }
+            case "disabled": {
+                packet[offset] = SENSEI_TEN_BUTTON_DISABLE;
+                break;
+            }
+            case "dpiSwitch": {
+                packet[offset] = SENSEI_TEN_BUTTON_DPI_SWITCH;
+                break;
+            }
+            case "scrollUp": {
+                packet[offset] = SENSEI_TEN_BUTTON_SCROLL_UP;
+                break;
+            }
+            case "scrollDown": {
+                packet[offset] = SENSEI_TEN_BUTTON_SCROLL_DOWN;
+                break;
+            }
+            case "keyboard": {
+                if (!Number.isInteger(action.code) || action.code < 0 || action.code > 255) {
+                    throw new SenseiTenProtocolError("Keyboard scan codes must be integers 0–255.");
+                }
+                packet[offset] = SENSEI_TEN_BUTTON_KEYBOARD;
+                packet[offset + 1] = action.code;
+                break;
+            }
+            case "multimedia": {
+                if (!Number.isInteger(action.code) || action.code < 0 || action.code > 255) {
+                    throw new SenseiTenProtocolError("Multimedia key codes must be integers 0–255.");
+                }
+                packet[offset] = SENSEI_TEN_BUTTON_MULTIMEDIA;
+                packet[offset + 1] = action.code;
+                break;
+            }
+            default: {
+                throw new SenseiTenProtocolError(`Unsupported SteelSeries Sensei TEN button action.`);
+            }
+        }
+    }
+    return new Uint8Array([...SENSEI_TEN_COMMAND.buttonsMapping, ...packet]);
+}
+/**
+ * `sensei_ten.py`'s documented default mapping (`test_set_buttons_mapping`'s
+ * `"default"` fixture): buttons 1–5 map to themselves, Button6 to keyboard
+ * Page Down (`0x4E`), Button7 to keyboard Page Up (`0x4B`), Button8 to the
+ * DPI switch.
+ */
+export const SENSEI_TEN_DEFAULT_BUTTONS_MAPPING = {
+    button1: { type: "button", target: "button1" },
+    button2: { type: "button", target: "button2" },
+    button3: { type: "button", target: "button3" },
+    button4: { type: "button", target: "button4" },
+    button5: { type: "button", target: "button5" },
+    button6: { type: "keyboard", code: 0x4e },
+    button7: { type: "keyboard", code: 0x4b },
+    button8: { type: "dpiSwitch" },
+};
+//# sourceMappingURL=sensei-ten.js.map

package/dist/steelseries/sensei-ten.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"sensei-ten.js","sourceRoot":"","sources":["../../src/steelseries/sensei-ten.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAwIG;AAEH,MAAM,CAAC,MAAM,oBAAoB,GAAG,IAAI,CAAC;AAEzC,+EAA+E;AAC/E,MAAM,CAAC,MAAM,kBAAkB,GAAG;IAChC,cAAc,EAAE,CAAC,IAAI,EAAE,IAAI,CAAC;IAC5B,WAAW,EAAE,CAAC,IAAI,EAAE,IAAI,CAAC;IACzB,WAAW,EAAE,CAAC,IAAI,EAAE,IAAI,CAAC;IACzB,SAAS,EAAE,CAAC,IAAI,EAAE,IAAI,CAAC;IACvB,UAAU,EAAE,CAAC,IAAI,EAAE,IAAI,CAAC;IACxB,IAAI,EAAE,CAAC,IAAI,EAAE,IAAI,CAAC;IAClB,QAAQ,EAAE,CAAC,IAAI,EAAE,IAAI,CAAC;CACd,CAAC;AAEX,MAAM,CAAC,MAAM,wBAAwB,GAAG,CAAC,GAAG,EAAE,GAAG,EAAE,GAAG,EAAE,IAAI,CAAU,CAAC;AAEvE,MAAM,oBAAoB,GAAgC,IAAI,GAAG,CAAC;IAChE,CAAC,IAAI,EAAE,IAAI,CAAC;IACZ,CAAC,GAAG,EAAE,IAAI,CAAC;IACX,CAAC,GAAG,EAAE,IAAI,CAAC;IACX,CAAC,GAAG,EAAE,IAAI,CAAC;CACZ,CAAC,CAAC;AAEH,MAAM,CAAC,MAAM,kBAAkB,GAAG,EAAE,CAAC;AACrC,MAAM,CAAC,MAAM,kBAAkB,GAAG,KAAK,CAAC;AACxC,MAAM,CAAC,MAAM,mBAAmB,GAAG,EAAE,CAAC;AACtC,MAAM,CAAC,MAAM,0BAA0B,GAAG,CAAC,CAAC;AAC5C,MAAM,CAAC,MAAM,mCAAmC,GAAG,CAAC,CAAC;AAErD,MAAM,OAAO,sBAAuB,SAAQ,KAAK;CAAG;AAEpD,mFAAmF;AACnF,MAAM,UAAU,8BAA8B;IAC5C,MAAM,OAAO,GAAa,EAAE,CAAC;IAC7B,KAAK,IAAI,GAAG,GAAG,kBAAkB,EAAE,GAAG,IAAI,kBAAkB,EAAE,GAAG,IAAI,mBAAmB,EAAE,CAAC;QACzF,OAAO,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;IACpB,CAAC;IACD,OAAO,OAAO,CAAC;AACjB,CAAC;AAED,SAAS,SAAS,CAAC,GAAW;IAC5B,IACE,CAAC,MAAM,CAAC,SAAS,CAAC,GAAG,CAAC;QACtB,GAAG,GAAG,kBAAkB;QACxB,GAAG,GAAG,kBAAkB;QACxB,GAAG,GAAG,mBAAmB,KAAK,CAAC,EAC/B,CAAC;QACD,MAAM,IAAI,sBAAsB,CAC9B,sCAAsC,kBAAkB,IAAI,kBAAkB,CAAC,cAAc,EAAE,OAAO,mBAAmB,aAAa,CACvI,CAAC;IACJ,CAAC;IACD,OAAO,GAAG,GAAG,mBAAmB,CAAC;AACnC,CAAC;AAED;;;;;;GAMG;AACH,MAAM,UAAU,oCAAoC,CAClD,OAA0B,EAC1B,aAAqB;IAErB,IAAI,OAAO,CAAC,MAAM,GAAG,CAAC,IAAI,OAAO,CAAC,MAAM,GAAG,0BAA0B,EAAE,CAAC;QACtE,MAAM,IAAI,sBAAsB,CAC9B,qCAAqC,0BAA0B,eAAe,CAC/E,CAAC;IACJ,CAAC;IACD,IAAI,CAAC,MAAM,CAAC,SAAS,CAAC,aAAa,CAAC,IAAI,aAAa,GAAG,CAAC,IAAI,aAAa,IAAI,OAAO,CAAC,MAAM,EAAE,CAAC;QAC7F,MAAM,IAAI,sBAAsB,CAC9B,iDAAiD,OAAO,CAAC,MAAM,yBAAyB,CACzF,CAAC;IACJ,CAAC;IACD,MAAM,KAAK,GAAG,OAAO,CAAC,GAAG,CAAC,SAAS,CAAC,CAAC;IACrC,MAAM,SAAS,GAAG,UAAU,IAAI,CAAC,CAAC,GAAG,OAAO,CAAC,MAAM,CAAC,CAAC;IACrD,MAAM,KAAK,GAAa,CAAC,GAAG,kBAAkB,CAAC,WAAW,EAAE,SAAS,EAAE,aAAa,GAAG,CAAC,CAAC,CAAC;IAC1F,KAAK,MAAM,IAAI,IAAI,KAAK,EAAE,CAAC;QACzB,KAAK,CAAC,IAAI,CAAC,IAAI,GAAG,IAAI,EAAE,CAAC,IAAI,IAAI,CAAC,CAAC,GAAG,IAAI,CAAC,CAAC;IAC9C,CAAC;IACD,OAAO,IAAI,UAAU,CAAC,KAAK,CAAC,CAAC;AAC/B,CAAC;AAED,gEAAgE;AAChE,MAAM,UAAU,qCAAqC,CAAC,aAAqB;IACzE,MAAM,IAAI,GAAG,oBAAoB,CAAC,GAAG,CAAC,aAAa,CAAC,CAAC;IACrD,IAAI,IAAI,KAAK,SAAS,EAAE,CAAC;QACvB,MAAM,IAAI,sBAAsB,CAAC,oEAAoE,CAAC,CAAC;IACzG,CAAC;IACD,OAAO,IAAI,UAAU,CAAC,CAAC,GAAG,kBAAkB,CAAC,WAAW,EAAE,IAAI,CAAC,CAAC,CAAC;AACnE,CAAC;AAMD,MAAM,MAAM,GAAiC,EAAE,IAAI,EAAE,IAAI,EAAE,KAAK,EAAE,IAAI,EAAE,CAAC;AAUzE,MAAM,yBAAyB,GAAG,EAAE,CAAC;AACrC,MAAM,2BAA2B,GAAG,CAAC,CAAC;AACtC,MAAM,yBAAyB,GAAG,EAAE,CAAC;AACrC,MAAM,2BAA2B,GAAG,EAAE,CAAC;AACvC,MAAM,8BAA8B,GAAG,EAAE,CAAC;AAC1C,MAAM,qBAAqB,GAAG,EAAE,CAAC;AAEjC,SAAS,oBAAoB,CAAC,KAAa;IACzC,IAAI,CAAC,MAAM,CAAC,SAAS,CAAC,KAAK,CAAC,IAAI,KAAK,GAAG,CAAC,IAAI,KAAK,GAAG,GAAG,EAAE,CAAC;QACzD,MAAM,IAAI,sBAAsB,CAAC,sCAAsC,CAAC,CAAC;IAC3E,CAAC;AACH,CAAC;AAED;;;;;;;;;;;;;;;;GAgBG;AACH,MAAM,UAAU,kCAAkC,CAChD,GAAiB,EACjB,KAAoC,EACpC,UAAU,GAAG,IAAI;IAEjB,IAAI,KAAK,CAAC,MAAM,KAAK,CAAC,EAAE,CAAC;QACvB,MAAM,IAAI,sBAAsB,CAAC,iEAAiE,CAAC,CAAC;IACtG,CAAC;IACD,IAAI,KAAK,CAAC,MAAM,GAAG,qBAAqB,EAAE,CAAC;QACzC,MAAM,IAAI,sBAAsB,CAAC,8CAA8C,qBAAqB,eAAe,CAAC,CAAC;IACvH,CAAC;IACD,IAAI,CAAC,MAAM,CAAC,SAAS,CAAC,UAAU,CAAC,IAAI,UAAU,GAAG,CAAC,IAAI,UAAU,GAAG,MAAM,EAAE,CAAC;QAC3E,MAAM,IAAI,sBAAsB,CAAC,yEAAyE,CAAC,CAAC;IAC9G,CAAC;IACD,KAAK,MAAM,IAAI,IAAI,KAAK,EAAE,CAAC;QACzB,oBAAoB,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC;QAC7B,oBAAoB,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC;QAC7B,oBAAoB,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC;QAC7B,IAAI,CAAC,MAAM,CAAC,SAAS,CAAC,IAAI,CAAC,GAAG,CAAC,IAAI,IAAI,CAAC,GAAG,GAAG,CAAC,IAAI,IAAI,CAAC,GAAG,GAAG,GAAG,EAAE,CAAC;YAClE,MAAM,IAAI,sBAAsB,CAAC,wEAAwE,CAAC,CAAC;QAC7G,CAAC;IACH,CAAC;IAED,MAAM,MAAM,GAAG,IAAI,KAAK,CAAS,yBAAyB,CAAC,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;IACvE,MAAM,CAAC,CAAC,CAAC,GAAG,MAAM,CAAC,GAAG,CAAC,CAAC;IACxB,MAAM,CAAC,2BAA2B,CAAC,GAAG,UAAU,GAAG,IAAI,CAAC;IACxD,MAAM,CAAC,2BAA2B,GAAG,CAAC,CAAC,GAAG,CAAC,UAAU,IAAI,CAAC,CAAC,GAAG,IAAI,CAAC;IACnE,MAAM,CAAC,yBAAyB,CAAC,GAAG,KAAK,CAAC,MAAM,KAAK,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,IAAI,CAAC;IACrE,MAAM,CAAC,2BAA2B,CAAC,GAAG,IAAI,CAAC;IAC3C,MAAM,CAAC,8BAA8B,CAAC,GAAG,KAAK,CAAC,MAAM,CAAC;IAEtD,MAAM,IAAI,GAAa,CAAC,KAAK,CAAC,CAAC,CAAE,CAAC,CAAC,EAAE,KAAK,CAAC,CAAC,CAAE,CAAC,CAAC,EAAE,KAAK,CAAC,CAAC,CAAE,CAAC,CAAC,CAAC,CAAC;IAC/D,IAAI,WAAW,GAAG,CAAC,CAAC;IACpB,KAAK,MAAM,IAAI,IAAI,KAAK,EAAE,CAAC;QACzB,MAAM,OAAO,GAAG,IAAI,CAAC,KAAK,CAAC,CAAC,IAAI,CAAC,GAAG,GAAG,GAAG,CAAC,GAAG,GAAG,CAAC,CAAC;QACnD,IAAI,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC,EAAE,IAAI,CAAC,CAAC,EAAE,IAAI,CAAC,CAAC,EAAE,OAAO,GAAG,WAAW,CAAC,CAAC;QACzD,WAAW,GAAG,OAAO,CAAC;IACxB,CAAC;IAED,MAAM,OAAO,GAAG,GAAG,KAAK,MAAM,CAAC,CAAC,CAAC,kBAAkB,CAAC,SAAS,CAAC,CAAC,CAAC,kBAAkB,CAAC,UAAU,CAAC;IAC9F,OAAO,IAAI,UAAU,CAAC,CAAC,GAAG,OAAO,EAAE,GAAG,MAAM,EAAE,GAAG,IAAI,CAAC,CAAC,CAAC;AAC1D,CAAC;AAED,8DAA8D;AAC9D,MAAM,UAAU,+BAA+B;IAC7C,OAAO,IAAI,UAAU,CAAC,kBAAkB,CAAC,IAAI,CAAC,CAAC;AACjD,CAAC;AAED,wFAAwF;AACxF,MAAM,UAAU,iCAAiC;IAC/C,OAAO,IAAI,UAAU,CAAC,kBAAkB,CAAC,QAAQ,CAAC,CAAC;AACrD,CAAC;AASD;;;;;;GAMG;AACH,MAAM,UAAU,kCAAkC,CAAC,OAAmB;IACpE,IAAI,OAAO,CAAC,MAAM,GAAG,mCAAmC,EAAE,CAAC;QACzD,MAAM,IAAI,sBAAsB,CAAC,qEAAqE,CAAC,CAAC;IAC1G,CAAC;IACD,MAAM,KAAK,GAAqB,CAAC,OAAO,CAAC,CAAC,CAAE,EAAE,OAAO,CAAC,CAAC,CAAE,CAAC,CAAC;IAC3D,OAAO,EAAE,KAAK,EAAE,OAAO,EAAE,GAAG,KAAK,CAAC,CAAC,CAAC,IAAI,KAAK,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC;AACvD,CAAC;AASD,wFAAwF;AACxF,MAAM,CAAC,MAAM,kBAAkB,GAAG;IAChC,OAAO,EAAE,EAAE,EAAE,EAAE,IAAI,EAAE,MAAM,EAAE,IAAI,EAAE;IACnC,OAAO,EAAE,EAAE,EAAE,EAAE,IAAI,EAAE,MAAM,EAAE,IAAI,EAAE;IACnC,OAAO,EAAE,EAAE,EAAE,EAAE,IAAI,EAAE,MAAM,EAAE,IAAI,EAAE;IACnC,OAAO,EAAE,EAAE,EAAE,EAAE,IAAI,EAAE,MAAM,EAAE,IAAI,EAAE;IACnC,OAAO,EAAE,EAAE,EAAE,EAAE,IAAI,EAAE,MAAM,EAAE,IAAI,EAAE;IACnC,OAAO,EAAE,EAAE,EAAE,EAAE,IAAI,EAAE,MAAM,EAAE,IAAI,EAAE;IACnC,OAAO,EAAE,EAAE,EAAE,EAAE,IAAI,EAAE,MAAM,EAAE,IAAI,EAAE;IACnC,OAAO,EAAE,EAAE,EAAE,EAAE,IAAI,EAAE,MAAM,EAAE,IAAI,EAAE;CACmB,CAAC;AAIzD,MAAM,8BAA8B,GAAG,CAAC,CAAC;AACzC,MAAM,yBAAyB,GAAG,IAAI,CAAC;AACvC,MAAM,4BAA4B,GAAG,IAAI,CAAC;AAC1C,MAAM,2BAA2B,GAAG,IAAI,CAAC;AACzC,MAAM,6BAA6B,GAAG,IAAI,CAAC;AAC3C,MAAM,0BAA0B,GAAG,IAAI,CAAC;AACxC,MAAM,4BAA4B,GAAG,IAAI,CAAC;AAa1C;;;;;GAKG;AACH,MAAM,UAAU,wCAAwC,CACtD,OAAoE;IAEpE,MAAM,KAAK,GAAG,MAAM,CAAC,IAAI,CAAC,kBAAkB,CAA0B,CAAC;IACvE,MAAM,MAAM,GAAG,IAAI,KAAK,CAAS,KAAK,CAAC,MAAM,GAAG,8BAA8B,CAAC,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;IAE3F,KAAK,MAAM,CAAC,IAAI,EAAE,MAAM,CAAC,IAAI,MAAM,CAAC,OAAO,CAAC,OAAO,CAAwD,EAAE,CAAC;QAC5G,MAAM,IAAI,GAAG,kBAAkB,CAAC,IAAI,CAAC,CAAC;QACtC,IAAI,CAAC,IAAI,EAAE,CAAC;YACV,MAAM,IAAI,sBAAsB,CAAC,0CAA0C,IAAI,IAAI,CAAC,CAAC;QACvF,CAAC;QACD,MAAM,EAAE,MAAM,EAAE,GAAG,IAAI,CAAC;QACxB,QAAQ,MAAM,CAAC,IAAI,EAAE,CAAC;YACpB,KAAK,QAAQ,CAAC,CAAC,CAAC;gBACd,MAAM,CAAC,MAAM,CAAC,GAAG,kBAAkB,CAAC,MAAM,CAAC,MAAM,CAAC,CAAC,EAAE,CAAC;gBACtD,MAAM;YACR,CAAC;YACD,KAAK,UAAU,CAAC,CAAC,CAAC;gBAChB,MAAM,CAAC,MAAM,CAAC,GAAG,yBAAyB,CAAC;gBAC3C,MAAM;YACR,CAAC;YACD,KAAK,WAAW,CAAC,CAAC,CAAC;gBACjB,MAAM,CAAC,MAAM,CAAC,GAAG,4BAA4B,CAAC;gBAC9C,MAAM;YACR,CAAC;YACD,KAAK,UAAU,CAAC,CAAC,CAAC;gBAChB,MAAM,CAAC,MAAM,CAAC,GAAG,2BAA2B,CAAC;gBAC7C,MAAM;YACR,CAAC;YACD,KAAK,YAAY,CAAC,CAAC,CAAC;gBAClB,MAAM,CAAC,MAAM,CAAC,GAAG,6BAA6B,CAAC;gBAC/C,MAAM;YACR,CAAC;YACD,KAAK,UAAU,CAAC,CAAC,CAAC;gBAChB,IAAI,CAAC,MAAM,CAAC,SAAS,CAAC,MAAM,CAAC,IAAI,CAAC,IAAI,MAAM,CAAC,IAAI,GAAG,CAAC,IAAI,MAAM,CAAC,IAAI,GAAG,GAAG,EAAE,CAAC;oBAC3E,MAAM,IAAI,sBAAsB,CAAC,6CAA6C,CAAC,CAAC;gBAClF,CAAC;gBACD,MAAM,CAAC,MAAM,CAAC,GAAG,0BAA0B,CAAC;gBAC5C,MAAM,CAAC,MAAM,GAAG,CAAC,CAAC,GAAG,MAAM,CAAC,IAAI,CAAC;gBACjC,MAAM;YACR,CAAC;YACD,KAAK,YAAY,CAAC,CAAC,CAAC;gBAClB,IAAI,CAAC,MAAM,CAAC,SAAS,CAAC,MAAM,CAAC,IAAI,CAAC,IAAI,MAAM,CAAC,IAAI,GAAG,CAAC,IAAI,MAAM,CAAC,IAAI,GAAG,GAAG,EAAE,CAAC;oBAC3E,MAAM,IAAI,sBAAsB,CAAC,8CAA8C,CAAC,CAAC;gBACnF,CAAC;gBACD,MAAM,CAAC,MAAM,CAAC,GAAG,4BAA4B,CAAC;gBAC9C,MAAM,CAAC,MAAM,GAAG,CAAC,CAAC,GAAG,MAAM,CAAC,IAAI,CAAC;gBACjC,MAAM;YACR,CAAC;YACD,OAAO,CAAC,CAAC,CAAC;gBACR,MAAM,IAAI,sBAAsB,CAAC,mDAAmD,CAAC,CAAC;YACxF,CAAC;QACH,CAAC;IACH,CAAC;IAED,OAAO,IAAI,UAAU,CAAC,CAAC,GAAG,kBAAkB,CAAC,cAAc,EAAE,GAAG,MAAM,CAAC,CAAC,CAAC;AAC3E,CAAC;AAED;;;;;GAKG;AACH,MAAM,CAAC,MAAM,kCAAkC,GAAuD;IACpG,OAAO,EAAE,EAAE,IAAI,EAAE,QAAQ,EAAE,MAAM,EAAE,SAAS,EAAE;IAC9C,OAAO,EAAE,EAAE,IAAI,EAAE,QAAQ,EAAE,MAAM,EAAE,SAAS,EAAE;IAC9C,OAAO,EAAE,EAAE,IAAI,EAAE,QAAQ,EAAE,MAAM,EAAE,SAAS,EAAE;IAC9C,OAAO,EAAE,EAAE,IAAI,EAAE,QAAQ,EAAE,MAAM,EAAE,SAAS,EAAE;IAC9C,OAAO,EAAE,EAAE,IAAI,EAAE,QAAQ,EAAE,MAAM,EAAE,SAAS,EAAE;IAC9C,OAAO,EAAE,EAAE,IAAI,EAAE,UAAU,EAAE,IAAI,EAAE,IAAI,EAAE;IACzC,OAAO,EAAE,EAAE,IAAI,EAAE,UAAU,EAAE,IAAI,EAAE,IAAI,EAAE;IACzC,OAAO,EAAE,EAAE,IAAI,EAAE,WAAW,EAAE;CAC/B,CAAC"}

package/dist/teevolution/index.d.ts

@@ -0,0 +1,211 @@
+export declare const TEEVOLUTION_REPORT_ID = 8;
+export declare const TEEVOLUTION_PACKET_LENGTH = 16;
+/** RapidSync 8K LCD clock — separate HID collection from Compx report 8. */
+export declare const TEEVOLUTION_LCD_REPORT_ID = 10;
+export declare const TEEVOLUTION_LCD_PACKET_LENGTH = 40;
+export declare const TEEVOLUTION_LCD_USAGE_PAGE = 65288;
+export declare const TEEVOLUTION_LCD_USAGE = 2;
+export declare const TEEVOLUTION_LCD_SET_TIME = 16;
+export declare const TEEVOLUTION_MAX_CHUNK = 10;
+export declare const TEEVOLUTION_DPI_MAX = 42000;
+export declare const TEEVOLUTION_PRODUCT_IDS: Set<number>;
+export declare const TEEVOLUTION_POLLING_RATES: readonly [125, 250, 500, 1000, 2000, 4000, 8000];
+export declare const TEEVOLUTION_SLEEP_OPTIONS: readonly [1, 3, 6, 12, 30, 60, 180];
+/** Teevolink "Highest performance" duration codes (flash 0xB7). */
+export declare const TEEVOLUTION_PERFORMANCE_TIME_OPTIONS: readonly [1, 3, 6, 12, 30, 60, 90];
+export declare const TEEVOLUTION_PERFORMANCE_TIME_LABELS: ReadonlyArray<readonly [number, string]>;
+export declare const TEEVOLUTION_DPI_LIGHT_MODES: readonly [0, 1, 2];
+export type TeevolutionDpiLightMode = typeof TEEVOLUTION_DPI_LIGHT_MODES[number];
+export type TeevolutionSensorMode = "Eco" | "High" | "Ultra";
+export type TeevolutionLiftOffDistance = "Low" | "Medium" | "High";
+export interface TeevolutionDeviceProfile {
+    cid: number;
+    name: string;
+    protocol: "compX-terra-v1";
+    dpiStageCount: number;
+    dpi: {
+        min: number;
+        standardMax: number;
+        max: number;
+        standardStep: number;
+        highStep: number;
+    };
+    pollingRates: readonly number[];
+    liftOffDistances: readonly TeevolutionLiftOffDistance[];
+    debounce: {
+        min: number;
+        max: number;
+    };
+    sleepOptions: readonly number[];
+    performanceTimeOptions: readonly number[];
+    sensorModes: readonly Exclude<TeevolutionSensorMode, "Ultra">[];
+    dpiLighting: {
+        modes: readonly TeevolutionDpiLightMode[];
+        brightness: {
+            min: number;
+            max: number;
+        };
+        speed: {
+            min: number;
+            max: number;
+        };
+    };
+}
+export declare const TEEVOLUTION_DEVICE_PROFILES: ReadonlyMap<number, TeevolutionDeviceProfile>;
+export declare function teevolutionProfileForCid(cid: number): TeevolutionDeviceProfile | null;
+export declare const TEEVOLUTION_COMMAND: {
+    readonly encryptionData: 1;
+    readonly deviceOnline: 3;
+    readonly batteryLevel: 4;
+    readonly writeFlashData: 7;
+    readonly readFlashData: 8;
+    readonly getCurrentConfig: 14;
+    readonly setCurrentConfig: 15;
+    readonly readVersionId: 18;
+    readonly getDongleVersion: 29;
+    readonly getRssi: 43;
+};
+/** Flash offsets used by Teevolink / Compx HUB for Terra Pro. */
+export declare const TEEVOLUTION_FLASH: {
+    readonly reportRate: 0;
+    /** Number of enabled DPI stages (1…dpiStageCount). */
+    readonly maxDpiStage: 2;
+    /** Active DPI stage index (0-based). */
+    readonly currentDpi: 4;
+    readonly liftOffDistance: 10;
+    /** Base of 4-byte DPI stage records. */
+    readonly dpiValues: 12;
+    readonly dpiLightMode: 76;
+    readonly dpiLightBrightness: 78;
+    readonly dpiLightSpeed: 80;
+    readonly dpiLightState: 82;
+    /** Base of 4-byte key-function records (one per physical button). */
+    readonly keyFunction: 96;
+    readonly debounceTime: 169;
+    readonly motionSync: 171;
+    readonly sleepTime: 173;
+    readonly angleSnapping: 175;
+    readonly rippleControl: 177;
+    readonly performanceState: 181;
+    readonly performanceTime: 183;
+    readonly sensorMode: 185;
+};
+/** Teevolink MouseKeyFunction class byte stored at flash 0x60 + 4×index. */
+export declare const TEEVOLUTION_KEY_CLASS: {
+    readonly disable: 0;
+    readonly mouse: 1;
+    readonly dpi: 2;
+    readonly tilt: 3;
+};
+export declare const TEEVOLUTION_BUTTONS: readonly [{
+    readonly name: "Left";
+    readonly index: 0;
+}, {
+    readonly name: "Right";
+    readonly index: 1;
+}, {
+    readonly name: "Middle";
+    readonly index: 2;
+}, {
+    readonly name: "Back";
+    readonly index: 3;
+}, {
+    readonly name: "Forward";
+    readonly index: 4;
+}, {
+    readonly name: "DPI";
+    readonly index: 5;
+}];
+export type TeevolutionButtonName = (typeof TEEVOLUTION_BUTTONS)[number]["name"];
+export interface TeevolutionButtonAction {
+    label: string;
+    cls: number;
+    param: number;
+}
+/** Simple assignments the generic remap dropdown can write. */
+export declare const TEEVOLUTION_BUTTON_ACTIONS: readonly TeevolutionButtonAction[];
+export declare const TEEVOLUTION_BUTTON_OPTIONS: string[];
+export declare const TEEVOLUTION_KEY_RECORD_LENGTH = 4;
+export declare const TEEVOLUTION_KEY_TABLE_LENGTH: number;
+/** TeevoLink ProfileOptions: four firmware-managed flash banks. */
+export declare const TEEVOLUTION_PROFILE_COUNT = 4;
+export declare function teevolutionKeyFunctionAddress(index: number): number;
+export declare function teevolutionEncodeKeyFunction(cls: number, param: number): Uint8Array;
+export declare function teevolutionDecodeKeyFunction(data: Uint8Array | readonly number[]): {
+    cls: number;
+    param: number;
+    checksumValid: boolean;
+};
+export declare function teevolutionFindButtonAction(label: string): TeevolutionButtonAction | null;
+export declare function teevolutionFindButton(name: string): (typeof TEEVOLUTION_BUTTONS)[number] | null;
+export declare function teevolutionKeyFunctionLabel(data: Uint8Array | readonly number[]): string;
+export declare function teevolutionIsLeftClick(cls: number, param: number): boolean;
+export declare function teevolutionKeyTableHasLeftClick(table: Uint8Array | readonly number[]): boolean;
+export declare function teevolutionDecodeButtonMappings(flash: Uint8Array | readonly number[]): Record<string, string>;
+export declare const TEEVOLUTION_TYPE_MAX_POLL: Record<number, number>;
+export interface TeevolutionBattery {
+    percent: number | null;
+    charging: boolean;
+}
+export declare function teevolutionPacketChecksum(packet: Uint8Array | readonly number[]): number;
+export declare function teevolutionPacketChecksumIsValid(payload: Uint8Array | readonly number[]): boolean;
+export declare function teevolutionDataChecksum(data: Uint8Array | readonly number[]): number;
+export declare function teevolutionBuildSimplePayload(command: number): Uint8Array;
+export declare function teevolutionBuildReadPayload(address: number, length: number): Uint8Array;
+export declare function teevolutionBuildWritePayload(address: number, data: readonly number[]): Uint8Array;
+export declare function teevolutionBuildWriteScalarPayload(address: number, value: number): Uint8Array;
+export declare function teevolutionBuildOnlinePayload(enabled: boolean): Uint8Array;
+/** Build SetCurrentConfig with TeevoLink's length byte and zero-based bank. */
+export declare function teevolutionBuildSetCurrentProfile(profile: number): Uint8Array;
+/**
+ * Decode GetCurrentConfig. TeevoLink treats status 1 as “no profile switch”
+ * (`supportChangeProfile = false`); only a 0–3 bank in byte 5 is usable.
+ */
+export declare function teevolutionDecodeCurrentProfile(response: Uint8Array | readonly number[]): number | null;
+export declare function teevolutionParseReadResponse(response: Uint8Array, address: number, length: number): Uint8Array | null;
+export declare function teevolutionParseBattery(response: Uint8Array): TeevolutionBattery | null;
+export declare function teevolutionEncodePollingRate(rate: number): number;
+export declare function teevolutionDecodePollingRate(encoded: number): number;
+/**
+ * PAW3950 Compx packing used by Teevolink: 50 DPI steps below 30,100, then
+ * 100 DPI steps to 42,000 via dpiEx 0x11 (halve before packing).
+ */
+export declare function teevolutionEncodeDpi(dpi: number): Uint8Array;
+export declare function teevolutionDecodeDpi(data: Uint8Array | readonly number[]): number;
+export declare function teevolutionDecodeLiftOff(value: number): "Low" | "Medium" | "High" | null;
+export declare function teevolutionEncodeLiftOff(liftOffDistance: "Low" | "Medium" | "High"): number;
+export declare function teevolutionDecodeFirmwareVersion(label: string, response: Uint8Array): string;
+export declare function teevolutionDpiOptions(profile: TeevolutionDeviceProfile): number[];
+/** Converts Teevolink's 1–10 brightness slider to the byte stored in flash 0x4E. */
+export declare function teevolutionEncodeDpiLightBrightness(level: number): number;
+/** Mirrors Teevolink's fallback to level 5 for an unrecognised stored byte. */
+export declare function teevolutionDecodeDpiLightBrightness(value: number): number;
+export declare function teevolutionDecodeDpiLightMode(mode: number, state: number): TeevolutionDpiLightMode;
+export declare function teevolutionEncodeSensorMode(mode: TeevolutionSensorMode): number;
+export declare function teevolutionDecodeSensorModeStored(value: number): TeevolutionSensorMode;
+/**
+ * Mirrors Teevolink Update_MS_SensorModeDisplay for PAW3950 Terra Pro links.
+ * Ultra (256) is display-only when high poll rates force corded tracking.
+ */
+export declare function teevolutionSensorModeUi(options: {
+    storedMode: number;
+    pollingRateHz: number;
+    connection: "Wired" | "Wireless";
+    fps20k?: boolean;
+}): {
+    mode: TeevolutionSensorMode;
+    editable: boolean;
+    storedValue: 0 | 1;
+};
+/**
+ * Teevolink Generate_CRC for RapidSync LCD writes: last byte is
+ * `(0x55 - sum(packet[0..len-2])) & 0xff`, including the report-id byte.
+ */
+export declare function teevolutionLcdChecksum(packet: Uint8Array | readonly number[]): number;
+/**
+ * 40-byte RapidSync set-time write, including report id 0x0A as byte 0.
+ * DateTime layout matches Teevolink GetCurrentTimer_Tick (year big-endian,
+ * Sunday = 0). WebHID sendReport uses bytes 1…39.
+ */
+export declare function teevolutionBuildLcdTimePacket(now: Date): Uint8Array;
+//# sourceMappingURL=index.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/teevolution/index.ts"],"names":[],"mappings":"AAAA,eAAO,MAAM,qBAAqB,IAAO,CAAC;AAC1C,eAAO,MAAM,yBAAyB,KAAK,CAAC;AAC5C,4EAA4E;AAC5E,eAAO,MAAM,yBAAyB,KAAO,CAAC;AAC9C,eAAO,MAAM,6BAA6B,KAAK,CAAC;AAChD,eAAO,MAAM,0BAA0B,QAAS,CAAC;AACjD,eAAO,MAAM,qBAAqB,IAAO,CAAC;AAC1C,eAAO,MAAM,wBAAwB,KAAS,CAAC;AAC/C,eAAO,MAAM,qBAAqB,KAAK,CAAC;AACxC,eAAO,MAAM,mBAAmB,QAAQ,CAAC;AACzC,eAAO,MAAM,uBAAuB,aAA4C,CAAC;AACjF,eAAO,MAAM,yBAAyB,kDAAmD,CAAC;AAC1F,eAAO,MAAM,yBAAyB,qCAAsC,CAAC;AAC7E,mEAAmE;AACnE,eAAO,MAAM,oCAAoC,oCAAqC,CAAC;AACvF,eAAO,MAAM,mCAAmC,EAAE,aAAa,CAAC,SAAS,CAAC,MAAM,EAAE,MAAM,CAAC,CAGxF,CAAC;AACF,eAAO,MAAM,2BAA2B,oBAAqB,CAAC;AAC9D,MAAM,MAAM,uBAAuB,GAAG,OAAO,2BAA2B,CAAC,MAAM,CAAC,CAAC;AACjF,MAAM,MAAM,qBAAqB,GAAG,KAAK,GAAG,MAAM,GAAG,OAAO,CAAC;AAC7D,MAAM,MAAM,0BAA0B,GAAG,KAAK,GAAG,QAAQ,GAAG,MAAM,CAAC;AAEnE,MAAM,WAAW,wBAAwB;IACvC,GAAG,EAAE,MAAM,CAAC;IACZ,IAAI,EAAE,MAAM,CAAC;IACb,QAAQ,EAAE,gBAAgB,CAAC;IAC3B,aAAa,EAAE,MAAM,CAAC;IACtB,GAAG,EAAE;QACH,GAAG,EAAE,MAAM,CAAC;QACZ,WAAW,EAAE,MAAM,CAAC;QACpB,GAAG,EAAE,MAAM,CAAC;QACZ,YAAY,EAAE,MAAM,CAAC;QACrB,QAAQ,EAAE,MAAM,CAAC;KAClB,CAAC;IACF,YAAY,EAAE,SAAS,MAAM,EAAE,CAAC;IAChC,gBAAgB,EAAE,SAAS,0BAA0B,EAAE,CAAC;IACxD,QAAQ,EAAE;QAAE,GAAG,EAAE,MAAM,CAAC;QAAC,GAAG,EAAE,MAAM,CAAA;KAAE,CAAC;IACvC,YAAY,EAAE,SAAS,MAAM,EAAE,CAAC;IAChC,sBAAsB,EAAE,SAAS,MAAM,EAAE,CAAC;IAC1C,WAAW,EAAE,SAAS,OAAO,CAAC,qBAAqB,EAAE,OAAO,CAAC,EAAE,CAAC;IAChE,WAAW,EAAE;QACX,KAAK,EAAE,SAAS,uBAAuB,EAAE,CAAC;QAC1C,UAAU,EAAE;YAAE,GAAG,EAAE,MAAM,CAAC;YAAC,GAAG,EAAE,MAAM,CAAA;SAAE,CAAC;QACzC,KAAK,EAAE;YAAE,GAAG,EAAE,MAAM,CAAC;YAAC,GAAG,EAAE,MAAM,CAAA;SAAE,CAAC;KACrC,CAAC;CACH;AAED,eAAO,MAAM,2BAA2B,EAAE,WAAW,CAAC,MAAM,EAAE,wBAAwB,CAyBpF,CAAC;AAEH,wBAAgB,wBAAwB,CAAC,GAAG,EAAE,MAAM,GAAG,wBAAwB,GAAG,IAAI,CAErF;AAED,eAAO,MAAM,mBAAmB;;;;;;;;;;;CAWtB,CAAC;AAEX,iEAAiE;AACjE,eAAO,MAAM,iBAAiB;;IAE5B,sDAAsD;;IAEtD,wCAAwC;;;IAGxC,wCAAwC;;;;;;IAMxC,qEAAqE;;;;;;;;;;CAU7D,CAAC;AAEX,4EAA4E;AAC5E,eAAO,MAAM,qBAAqB;;;;;CAKxB,CAAC;AAEX,eAAO,MAAM,mBAAmB;;;;;;;;;;;;;;;;;;EAOtB,CAAC;AAEX,MAAM,MAAM,qBAAqB,GAAG,CAAC,OAAO,mBAAmB,CAAC,CAAC,MAAM,CAAC,CAAC,MAAM,CAAC,CAAC;AAEjF,MAAM,WAAW,uBAAuB;IACtC,KAAK,EAAE,MAAM,CAAC;IACd,GAAG,EAAE,MAAM,CAAC;IACZ,KAAK,EAAE,MAAM,CAAC;CACf;AAED,+DAA+D;AAC/D,eAAO,MAAM,0BAA0B,EAAE,SAAS,uBAAuB,EAYxE,CAAC;AAEF,eAAO,MAAM,0BAA0B,UAA2D,CAAC;AAEnG,eAAO,MAAM,6BAA6B,IAAI,CAAC;AAC/C,eAAO,MAAM,4BAA4B,QAA6D,CAAC;AACvG,mEAAmE;AACnE,eAAO,MAAM,yBAAyB,IAAI,CAAC;AAE3C,wBAAgB,6BAA6B,CAAC,KAAK,EAAE,MAAM,GAAG,MAAM,CAKnE;AAED,wBAAgB,4BAA4B,CAAC,GAAG,EAAE,MAAM,EAAE,KAAK,EAAE,MAAM,GAAG,UAAU,CASnF;AAED,wBAAgB,4BAA4B,CAAC,IAAI,EAAE,UAAU,GAAG,SAAS,MAAM,EAAE,GAAG;IAClF,GAAG,EAAE,MAAM,CAAC;IACZ,KAAK,EAAE,MAAM,CAAC;IACd,aAAa,EAAE,OAAO,CAAC;CACxB,CAMA;AAED,wBAAgB,2BAA2B,CAAC,KAAK,EAAE,MAAM,GAAG,uBAAuB,GAAG,IAAI,CAEzF;AAED,wBAAgB,qBAAqB,CAAC,IAAI,EAAE,MAAM,GAAG,CAAC,OAAO,mBAAmB,CAAC,CAAC,MAAM,CAAC,GAAG,IAAI,CAE/F;AAED,wBAAgB,2BAA2B,CAAC,IAAI,EAAE,UAAU,GAAG,SAAS,MAAM,EAAE,GAAG,MAAM,CAIxF;AAED,wBAAgB,sBAAsB,CAAC,GAAG,EAAE,MAAM,EAAE,KAAK,EAAE,MAAM,GAAG,OAAO,CAE1E;AAED,wBAAgB,+BAA+B,CAAC,KAAK,EAAE,UAAU,GAAG,SAAS,MAAM,EAAE,GAAG,OAAO,CAO9F;AAED,wBAAgB,+BAA+B,CAAC,KAAK,EAAE,UAAU,GAAG,SAAS,MAAM,EAAE,GAAG,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAS7G;AAED,eAAO,MAAM,yBAAyB,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAO5D,CAAC;AAEF,MAAM,WAAW,kBAAkB;IACjC,OAAO,EAAE,MAAM,GAAG,IAAI,CAAC;IACvB,QAAQ,EAAE,OAAO,CAAC;CACnB;AAQD,wBAAgB,yBAAyB,CAAC,MAAM,EAAE,UAAU,GAAG,SAAS,MAAM,EAAE,GAAG,MAAM,CAKxF;AAED,wBAAgB,gCAAgC,CAAC,OAAO,EAAE,UAAU,GAAG,SAAS,MAAM,EAAE,GAAG,OAAO,CAGjG;AAED,wBAAgB,uBAAuB,CAAC,IAAI,EAAE,UAAU,GAAG,SAAS,MAAM,EAAE,GAAG,MAAM,CAIpF;AAOD,wBAAgB,6BAA6B,CAAC,OAAO,EAAE,MAAM,GAAG,UAAU,CAKzE;AAED,wBAAgB,2BAA2B,CAAC,OAAO,EAAE,MAAM,EAAE,MAAM,EAAE,MAAM,GAAG,UAAU,CAYvF;AAED,wBAAgB,4BAA4B,CAAC,OAAO,EAAE,MAAM,EAAE,IAAI,EAAE,SAAS,MAAM,EAAE,GAAG,UAAU,CAajG;AAED,wBAAgB,kCAAkC,CAAC,OAAO,EAAE,MAAM,EAAE,KAAK,EAAE,MAAM,GAAG,UAAU,CAG7F;AAED,wBAAgB,6BAA6B,CAAC,OAAO,EAAE,OAAO,GAAG,UAAU,CAI1E;AAED,+EAA+E;AAC/E,wBAAgB,iCAAiC,CAAC,OAAO,EAAE,MAAM,GAAG,UAAU,CAQ7E;AAED;;;GAGG;AACH,wBAAgB,+BAA+B,CAAC,QAAQ,EAAE,UAAU,GAAG,SAAS,MAAM,EAAE,GAAG,MAAM,GAAG,IAAI,CAKvG;AAED,wBAAgB,4BAA4B,CAC1C,QAAQ,EAAE,UAAU,EACpB,OAAO,EAAE,MAAM,EACf,MAAM,EAAE,MAAM,GACb,UAAU,GAAG,IAAI,CAMnB;AAED,wBAAgB,uBAAuB,CAAC,QAAQ,EAAE,UAAU,GAAG,kBAAkB,GAAG,IAAI,CAQvF;AAED,wBAAgB,4BAA4B,CAAC,IAAI,EAAE,MAAM,GAAG,MAAM,CAOjE;AAED,wBAAgB,4BAA4B,CAAC,OAAO,EAAE,MAAM,GAAG,MAAM,CAEpE;AAED;;;GAGG;AACH,wBAAgB,oBAAoB,CAAC,GAAG,EAAE,MAAM,GAAG,UAAU,CAe5D;AAED,wBAAgB,oBAAoB,CAAC,IAAI,EAAE,UAAU,GAAG,SAAS,MAAM,EAAE,GAAG,MAAM,CAQjF;AAED,wBAAgB,wBAAwB,CAAC,KAAK,EAAE,MAAM,GAAG,KAAK,GAAG,QAAQ,GAAG,MAAM,GAAG,IAAI,CAExF;AAED,wBAAgB,wBAAwB,CAAC,eAAe,EAAE,KAAK,GAAG,QAAQ,GAAG,MAAM,GAAG,MAAM,CAE3F;AAED,wBAAgB,gCAAgC,CAAC,KAAK,EAAE,MAAM,EAAE,QAAQ,EAAE,UAAU,GAAG,MAAM,CAE5F;AAED,wBAAgB,qBAAqB,CAAC,OAAO,EAAE,wBAAwB,GAAG,MAAM,EAAE,CAajF;AAED,oFAAoF;AACpF,wBAAgB,mCAAmC,CAAC,KAAK,EAAE,MAAM,GAAG,MAAM,CASzE;AAED,+EAA+E;AAC/E,wBAAgB,mCAAmC,CAAC,KAAK,EAAE,MAAM,GAAG,MAAM,CAUzE;AAED,wBAAgB,6BAA6B,CAAC,IAAI,EAAE,MAAM,EAAE,KAAK,EAAE,MAAM,GAAG,uBAAuB,CAGlG;AAED,wBAAgB,2BAA2B,CAAC,IAAI,EAAE,qBAAqB,GAAG,MAAM,CAI/E;AAED,wBAAgB,iCAAiC,CAAC,KAAK,EAAE,MAAM,GAAG,qBAAqB,CAEtF;AAED;;;GAGG;AACH,wBAAgB,uBAAuB,CAAC,OAAO,EAAE;IAC/C,UAAU,EAAE,MAAM,CAAC;IACnB,aAAa,EAAE,MAAM,CAAC;IACtB,UAAU,EAAE,OAAO,GAAG,UAAU,CAAC;IACjC,MAAM,CAAC,EAAE,OAAO,CAAC;CAClB,GAAG;IAAE,IAAI,EAAE,qBAAqB,CAAC;IAAC,QAAQ,EAAE,OAAO,CAAC;IAAC,WAAW,EAAE,CAAC,GAAG,CAAC,CAAA;CAAE,CAazE;AAED;;;GAGG;AACH,wBAAgB,sBAAsB,CAAC,MAAM,EAAE,UAAU,GAAG,SAAS,MAAM,EAAE,GAAG,MAAM,CAKrF;AAED;;;;GAIG;AACH,wBAAgB,6BAA6B,CAAC,GAAG,EAAE,IAAI,GAAG,UAAU,CAenE"}