@openmouse/protocol 0.1.0

package/dist/steelseries/aerox9-wireless.js

@@ -0,0 +1,305 @@
+/**
+ * SteelSeries Aerox 9 Wireless configuration protocol — pure encode/decode helpers.
+ *
+ * Reconstructed from public open-source implementations, not vendor software:
+ *
+ * - rivalcfg `rivalcfg/devices/aerox9_wireless_wired.py` — the primary source
+ *   for every command byte, product id, and default here, for the mouse's
+ *   USB-cabled mode (`1038:185A`, plus the WOW Edition `0x1876`).
+ * - rivalcfg `rivalcfg/devices/aerox9_wireless_wireless.py` — the 2.4 GHz
+ *   dongle mode (`1038:1858`, WOW Edition `0x1874`). Read in full and diffed
+ *   directly against the wired-mode file: it is **not** a separate command
+ *   set. It is `aerox9_wireless_wired.py`'s settings dict comprehended
+ *   through one `_patch_command` helper that (1) ORs `0b01000000` (`0x40`)
+ *   into every command's first byte and (2) adds a 64-byte `readback_length`.
+ *   This is the exact same transform cluster 3 found for the Aerox 5
+ *   Wireless (`./aerox5-wireless.ts`'s `applyWirelessFlag`) — confirmed here
+ *   by direct `diff` of the two device files, not assumed from precedent.
+ *   This module implements that transform (`applyAerox9WirelessFlag`, named
+ *   distinctly from `./aerox5-wireless.ts`'s `applyWirelessFlag` to avoid a
+ *   re-export collision in `./index.ts`) rather than hand-duplicating the
+ *   wired-mode byte tables.
+ * - rivalcfg `rivalcfg/devices/dpi/truemove_air.py` — same TrueMove Air
+ *   sensor table as Aerox 5 / Aerox 5 Wireless / Rival 3 Wireless — imported
+ *   from `./rival3-wireless.ts`'s `TRUEMOVE_AIR_DPI_TO_BYTE`, not re-derived
+ *   (same `input_range`/`output_choices` reference).
+ * - rivalcfg `rivalcfg/handlers/multidpi_range_choice.py` — `dpi_length_byte: 1`,
+ *   `first_preset: 0` (same as Aerox 5 and Aerox 5 Wireless — not 1, unlike
+ *   Aerox 3 and Rival 3 Wireless), `max_preset_count: 5`.
+ * - rivalcfg `rivalcfg/handlers/range.py` — `sleep_timer`/`dim_timer`: same
+ *   linear range-to-range mapping as Aerox 5 Wireless, same output ranges
+ *   (`sleep_timer`: `[0x000000, 0x124F80, 60000]` against `[0, 20, 1]`
+ *   minutes, i.e. `minutes * 60000` ms; `dim_timer`:
+ *   `[0x000000, 0x124F80, 1000]` against `[0, 1200, 1]` seconds, i.e.
+ *   `seconds * 1000` ms), little-endian 3 bytes (`range_length_byte: 3`).
+ * - rivalcfg `rivalcfg/handlers/rgbcolor.py` / `reactive_rgbcolor.py` — RGB
+ *   value encoding, same as every other SteelSeries family in this codebase.
+ * - rivalcfg `rivalcfg/handlers/none.py` — `rainbow_effect` is a fixed
+ *   no-argument enable, `22 FF` (`62 FF` wireless), same shape as Aerox 5
+ *   Wireless's — **not** the plain Aerox 5's zone-bitmask choice.
+ *
+ * ## No button-mapping command in this device's rivalcfg profile
+ *
+ * Despite SteelSeries marketing the Aerox 9 (Wireless) as a 9-button
+ * "MMO-style" mouse, `aerox9_wireless_wired.py` defines **no**
+ * `buttons_mapping` setting and no button-remap command at all — confirmed
+ * by reading the full settings dict, which has exactly nine entries
+ * (`sensitivity`, `polling_rate`, `z1_color`, `z2_color`, `z3_color`,
+ * `reactive_color`, `sleep_timer`, `dim_timer`, `rainbow_effect`,
+ * `default_lighting`) plus `battery_level`/`save_command`, none of them a
+ * buttons handler. This is unlike `./aerox5.ts` and `./aerox5-wireless.ts`,
+ * both of which do define one. This module therefore exposes no button
+ * remap function — there is nothing in the reference implementation to
+ * reconstruct it from, not an oversight.
+ *
+ * ## Why wired-cable-mode and 2.4 GHz-dongle-mode share one module
+ *
+ * Same pattern as Aerox 5 Wireless: one physical mouse, two USB product-id
+ * groups depending on how the host currently sees it, driven by the same
+ * command set modulo the fixed `applyAerox9WirelessFlag` transform. Every command
+ * byte in `AEROX9_WIRELESS_COMMAND` below is the wired-mode value;
+ * `applyAerox9WirelessFlag` produces the 2.4 GHz-mode byte on demand.
+ *
+ * ## Why this is a separate protocol family from Aerox 5 / Aerox 5 Wireless
+ *
+ * Aerox 9 Wireless shares several command bytes with Aerox 5 Wireless
+ * (`0x2D`/`0x2B`/`0x29`/`0x22`/`0x27`/`0x92`/`0x11 00`, the same
+ * `_patch_command` wireless-flag transform, the same `readback_length: 64`),
+ * but is a genuinely different device profile, confirmed by direct
+ * comparison of the two rivalcfg files rather than assumed from the shared
+ * "Aerox" naming and similar wireless architecture:
+ *
+ * - RGB zone commands are `21 01 <zone> <r> <g> <b>` here, same fixed-packet
+ *   shape as Aerox 5 Wireless's `steelseriesAerox5WirelessEncodeZoneColor`,
+ *   confirmed byte-identical (`z1_color`/`z2_color`/`z3_color` commands
+ *   `[0x21, 0x01, 0x00/0x01/0x02]` match exactly) — reused here as a
+ *   structurally identical function rather than imported, so each family's
+ *   codec stays self-contained.
+ * - `dim_timer`'s command is `23 0F 01 00 00`, byte-identical to Aerox 5
+ *   Wireless's.
+ * - No button-mapping command at all (see above) — Aerox 5 Wireless has one.
+ * - Distinct product-id space entirely: `0x185A`/`0x1876` (wired),
+ *   `0x1858`/`0x1874` (2.4 GHz) — none overlap Aerox 5 Wireless's
+ *   `0x1852`/`0x1854`/`0x185C`/`0x185E`/`0x1860`/`0x1862`, or any PID
+ *   claimed by clusters 1–3.
+ *
+ * PIDs are therefore registered under their own family
+ * (`"aerox9-wireless"`), never `"aerox5-wireless"`.
+ *
+ * No corroborating libratbag or OpenRGB source for any of these PIDs was
+ * available in this environment (no local libratbag checkout, and OpenRGB's
+ * SteelSeries controller files were not reachable this pass) — every command
+ * byte above is sourced from rivalcfg alone, same single-source caveat
+ * clusters 2 and 3 flagged for their devices. This should be treated as
+ * unverified beyond rivalcfg until corroborated or hardware-tested.
+ *
+ * Every command is an HID output report, report id `0x00`, on the vendor
+ * configuration interface (`"endpoint": 3` for every model in both rivalcfg
+ * files). DPI presets, polling rate, zone colors, reactive color, sleep/dim
+ * timers, rainbow, and default lighting are write-only — neither rivalcfg
+ * file defines a getter for any of them. Battery level **is** readable (see
+ * below). Settings apply immediately; the save command (`11 00`,
+ * wireless-mode `51 00`) persists them to onboard flash. None of this has
+ * been verified on physical hardware by this project.
+ *
+ * ## Battery read
+ *
+ * `aerox9_wireless_wired.py` defines a `battery_level` block identical in
+ * shape to Aerox 5 Wireless's: an output-report write of `0x92` gets a
+ * 2-byte input-report reply, where `data[1] & 0b10000000` is the charging
+ * flag and `((data[1] & ~0b10000000) - 1) * 5` is the percentage (coarse
+ * 0–100 scale in steps of 5). Confirmed byte-for-byte identical to
+ * `aerox5_wireless_wired.py`'s `battery_level` block by direct comparison —
+ * not assumed. 2.4 GHz mode additionally needs `0x92 | 0x40 = 0xD2`, produced
+ * by `applyAerox9WirelessFlag`. This is the same battery-response shape as
+ * `./aerox5-wireless.ts` and a **different** shape from
+ * `./rival3-wireless.ts`'s `AA 01` / 3-byte-reply / plain-percentage-byte
+ * battery read — do not conflate the three devices' battery decoding.
+ */
+import { TRUEMOVE_AIR_DPI_TO_BYTE } from "./rival3-wireless.js";
+export const AEROX9_WIRELESS_REPORT_ID = 0x00;
+/** `_WIRELESS_FLAG = 0b01000000` in `aerox9_wireless_wireless.py` — identical constant to Aerox 5 Wireless's. */
+const WIRELESS_FLAG = 0b01000000;
+/** Wired-cable-mode command bytes; OR `WIRELESS_FLAG` into byte 0 for 2.4 GHz mode. */
+export const AEROX9_WIRELESS_COMMAND = {
+    dpiPresets: [0x2d],
+    pollingRate: [0x2b],
+    zoneColor: [0x21, 0x01],
+    reactiveColor: [0x26],
+    sleepTimer: [0x29],
+    dimTimer: [0x23, 0x0f, 0x01, 0x00, 0x00],
+    rainbowEffect: [0x22, 0xff],
+    defaultLighting: [0x27],
+    batteryLevel: [0x92],
+};
+/** `11 00` wired-mode / `51 00` 2.4 GHz-mode — see `applyAerox9WirelessFlag`. */
+export const AEROX9_WIRELESS_SAVE_COMMAND = [0x11, 0x00];
+/**
+ * `_patch_command`: OR `0b01000000` into the command's first byte. Pass the
+ * wired-mode command bytes from `AEROX9_WIRELESS_COMMAND` /
+ * `AEROX9_WIRELESS_SAVE_COMMAND`; returns the 2.4 GHz-mode equivalent.
+ */
+export function applyAerox9WirelessFlag(command) {
+    if (command.length === 0) {
+        throw new Aerox9WirelessProtocolError("Cannot apply the wireless flag to an empty command.");
+    }
+    return [command[0] | WIRELESS_FLAG, ...command.slice(1)];
+}
+export const AEROX9_WIRELESS_POLLING_RATES = [125, 250, 500, 1000];
+/** `{125:0x03, 250:0x02, 500:0x01, 1000:0x00}` in `aerox9_wireless_wired.py` — same mapping as Aerox 5 Wireless. */
+const POLLING_RATE_TO_BYTE = new Map([
+    [1000, 0x00],
+    [500, 0x01],
+    [250, 0x02],
+    [125, 0x03],
+]);
+export const AEROX9_WIRELESS_DPI_MIN = 100;
+export const AEROX9_WIRELESS_DPI_MAX = 18000;
+export const AEROX9_WIRELESS_DPI_STEP = 100;
+export const AEROX9_WIRELESS_MAX_DPI_PRESETS = 5;
+export const AEROX9_WIRELESS_BATTERY_RESPONSE_LENGTH = 2;
+const BATTERY_CHARGING_FLAG = 0b10000000;
+export class Aerox9WirelessProtocolError extends Error {
+}
+/** The 180 DPI values the shared TrueMove Air sensor table can express, ascending. */
+export function steelseriesAerox9WirelessDpiOptions() {
+    return [...TRUEMOVE_AIR_DPI_TO_BYTE.keys()].sort((a, b) => a - b);
+}
+/**
+ * `2D <count> <selected> <v1>…<vN>` (or `6D …` in 2.4 GHz mode). One byte
+ * per DPI; `selectedIndex` is 0-based and encoded 0-based on the wire
+ * (`first_preset: 0`).
+ */
+export function steelseriesAerox9WirelessEncodeDpiPresets(presets, selectedIndex, wireless) {
+    if (presets.length < 1 || presets.length > AEROX9_WIRELESS_MAX_DPI_PRESETS) {
+        throw new Aerox9WirelessProtocolError(`SteelSeries Aerox 9 Wireless supports 1–${AEROX9_WIRELESS_MAX_DPI_PRESETS} DPI presets.`);
+    }
+    if (!Number.isInteger(selectedIndex) || selectedIndex < 0 || selectedIndex >= presets.length) {
+        throw new Aerox9WirelessProtocolError(`Selected DPI preset must be an index into the ${presets.length} presets being written.`);
+    }
+    const encoded = presets.map((dpi) => {
+        const byte = TRUEMOVE_AIR_DPI_TO_BYTE.get(dpi);
+        if (byte === undefined) {
+            throw new Aerox9WirelessProtocolError(`SteelSeries Aerox 9 Wireless DPI must be ${AEROX9_WIRELESS_DPI_MIN}–${AEROX9_WIRELESS_DPI_MAX.toLocaleString()} in ${AEROX9_WIRELESS_DPI_STEP} DPI steps.`);
+        }
+        return byte;
+    });
+    const command = wireless ? applyAerox9WirelessFlag(AEROX9_WIRELESS_COMMAND.dpiPresets) : AEROX9_WIRELESS_COMMAND.dpiPresets;
+    return new Uint8Array([...command, presets.length, selectedIndex, ...encoded]);
+}
+/** `2B <v>` (`6B` wireless) with 1000→0x00, 500→0x01, 250→0x02, 125→0x03. */
+export function steelseriesAerox9WirelessEncodePollingRate(pollingRateHz, wireless) {
+    const byte = POLLING_RATE_TO_BYTE.get(pollingRateHz);
+    if (byte === undefined) {
+        throw new Aerox9WirelessProtocolError("SteelSeries Aerox 9 Wireless supports 125, 250, 500, or 1000 Hz polling.");
+    }
+    const command = wireless ? applyAerox9WirelessFlag(AEROX9_WIRELESS_COMMAND.pollingRate) : AEROX9_WIRELESS_COMMAND.pollingRate;
+    return new Uint8Array([...command, byte]);
+}
+function encodeRgb(r, g, b) {
+    for (const channel of [r, g, b]) {
+        if (!Number.isInteger(channel) || channel < 0 || channel > 255) {
+            throw new Aerox9WirelessProtocolError("RGB channels must be integers 0–255.");
+        }
+    }
+    return [r, g, b];
+}
+const ZONE_INDEX = { 1: 0x00, 2: 0x01, 3: 0x02 };
+/**
+ * `21 01 <zone-index> <r> <g> <b>` (`61 01 …` wireless) — a fixed 6-byte
+ * packet. Zone 1 = top LED, zone 2 = middle LED, zone 3 = bottom LED (strip
+ * order, per `z1_color`/`z2_color`/`z3_color`'s CLI flag labels).
+ */
+export function steelseriesAerox9WirelessEncodeZoneColor(zone, r, g, b, wireless) {
+    const zoneIndex = ZONE_INDEX[zone];
+    if (zoneIndex === undefined) {
+        throw new Aerox9WirelessProtocolError("SteelSeries Aerox 9 Wireless has zones 1 (top), 2 (middle), and 3 (bottom) only.");
+    }
+    const [red, green, blue] = encodeRgb(r, g, b);
+    const command = wireless ? applyAerox9WirelessFlag(AEROX9_WIRELESS_COMMAND.zoneColor) : AEROX9_WIRELESS_COMMAND.zoneColor;
+    return new Uint8Array([...command, zoneIndex, red, green, blue]);
+}
+/**
+ * `26 00 00 00 00 00` when disabled, `26 01 00 <r> <g> <b>` when enabled
+ * (`66 …` wireless) — same shape as every other SteelSeries family here.
+ */
+export function steelseriesAerox9WirelessEncodeReactiveColor(color, wireless) {
+    const command = wireless ? applyAerox9WirelessFlag(AEROX9_WIRELESS_COMMAND.reactiveColor) : AEROX9_WIRELESS_COMMAND.reactiveColor;
+    if (color === null) {
+        return new Uint8Array([...command, 0x00, 0x00, 0x00, 0x00, 0x00]);
+    }
+    const [r, g, b] = encodeRgb(color.r, color.g, color.b);
+    return new Uint8Array([...command, 0x01, 0x00, r, g, b]);
+}
+function encodeRangeLE3(value, min, max, unit, msPerUnit) {
+    if (!Number.isInteger(value) || value < min || value > max) {
+        throw new Aerox9WirelessProtocolError(`SteelSeries Aerox 9 Wireless ${unit} must be an integer ${min}–${max}.`);
+    }
+    const ms = value * msPerUnit;
+    return [ms & 0xff, (ms >> 8) & 0xff, (ms >> 16) & 0xff];
+}
+/**
+ * `29 <ms LE24>` (`69 …` wireless) — idle minutes before sleep, `0` disables.
+ * Encoded as `minutes * 60000` milliseconds, little-endian 3 bytes.
+ */
+export function steelseriesAerox9WirelessEncodeSleepTimer(minutes, wireless) {
+    const bytes = encodeRangeLE3(minutes, 0, 20, "sleep timer minutes", 60_000);
+    const command = wireless ? applyAerox9WirelessFlag(AEROX9_WIRELESS_COMMAND.sleepTimer) : AEROX9_WIRELESS_COMMAND.sleepTimer;
+    return new Uint8Array([...command, ...bytes]);
+}
+/**
+ * `23 0F 01 00 00 <ms LE24>` (`63 …` wireless) — idle seconds before the LEDs
+ * dim, `0` disables. Encoded as `seconds * 1000` milliseconds, little-endian
+ * 3 bytes.
+ */
+export function steelseriesAerox9WirelessEncodeDimTimer(seconds, wireless) {
+    const bytes = encodeRangeLE3(seconds, 0, 1200, "dim timer seconds", 1_000);
+    const command = wireless ? applyAerox9WirelessFlag(AEROX9_WIRELESS_COMMAND.dimTimer) : AEROX9_WIRELESS_COMMAND.dimTimer;
+    return new Uint8Array([...command, ...bytes]);
+}
+/** `22 FF` (`62 FF` wireless) — enables the rainbow effect on all zones; a color write clears it. */
+export function steelseriesAerox9WirelessEncodeRainbowEffect(wireless) {
+    const command = wireless ? applyAerox9WirelessFlag(AEROX9_WIRELESS_COMMAND.rainbowEffect) : AEROX9_WIRELESS_COMMAND.rainbowEffect;
+    return new Uint8Array(command);
+}
+/** Byte-identical to `./aerox5-wireless.ts`'s `AEROX5_WIRELESS_DEFAULT_LIGHTING`, confirmed by direct comparison. */
+export const AEROX9_WIRELESS_DEFAULT_LIGHTING = {
+    off: [0x00, 0x00],
+    reactive: [0x00, 0x01],
+    rainbow: [0x01, 0x00],
+    "reactive-rainbow": [0x01, 0x01],
+};
+/** `27 <v1> <v2>` (`67 …` wireless) — what the mouse lights up as before a host ever connects. */
+export function steelseriesAerox9WirelessEncodeDefaultLighting(mode, wireless) {
+    const bytes = AEROX9_WIRELESS_DEFAULT_LIGHTING[mode];
+    if (bytes === undefined) {
+        throw new Aerox9WirelessProtocolError(`SteelSeries Aerox 9 Wireless default lighting must be one of: ${Object.keys(AEROX9_WIRELESS_DEFAULT_LIGHTING).join(", ")}.`);
+    }
+    const command = wireless ? applyAerox9WirelessFlag(AEROX9_WIRELESS_COMMAND.defaultLighting) : AEROX9_WIRELESS_COMMAND.defaultLighting;
+    return new Uint8Array([...command, ...bytes]);
+}
+/** `11 00` wired-mode / `51 00` 2.4 GHz-mode — commit the current settings to onboard flash. */
+export function steelseriesAerox9WirelessSaveCommand(wireless) {
+    const command = wireless ? applyAerox9WirelessFlag(AEROX9_WIRELESS_SAVE_COMMAND) : AEROX9_WIRELESS_SAVE_COMMAND;
+    return new Uint8Array(command);
+}
+/** `92` wired-mode / `D2` 2.4 GHz-mode — the device answers with a two-byte input report. */
+export function steelseriesAerox9WirelessBatteryQuery(wireless) {
+    const command = wireless ? applyAerox9WirelessFlag(AEROX9_WIRELESS_COMMAND.batteryLevel) : AEROX9_WIRELESS_COMMAND.batteryLevel;
+    return new Uint8Array(command);
+}
+/**
+ * Decode the two-byte battery response: `data[0]` is unused by rivalcfg's
+ * lambdas, `data[1]`'s top bit is the charging flag and the remaining 7 bits
+ * (1-indexed, hence `- 1`) scaled by 5 give the percentage.
+ */
+export function steelseriesAerox9WirelessDecodeBattery(payload) {
+    if (payload.length < AEROX9_WIRELESS_BATTERY_RESPONSE_LENGTH) {
+        throw new Aerox9WirelessProtocolError("SteelSeries Aerox 9 Wireless battery response is shorter than two bytes.");
+    }
+    const statusByte = payload[1];
+    const isCharging = (statusByte & BATTERY_CHARGING_FLAG) !== 0;
+    const level = ((statusByte & ~BATTERY_CHARGING_FLAG) - 1) * 5;
+    return { level, isCharging };
+}
+//# sourceMappingURL=aerox9-wireless.js.map

package/dist/steelseries/aerox9-wireless.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"aerox9-wireless.js","sourceRoot":"","sources":["../../src/steelseries/aerox9-wireless.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAqHG;AAEH,OAAO,EAAE,wBAAwB,EAAE,MAAM,sBAAsB,CAAC;AAEhE,MAAM,CAAC,MAAM,yBAAyB,GAAG,IAAI,CAAC;AAE9C,iHAAiH;AACjH,MAAM,aAAa,GAAG,UAAU,CAAC;AAEjC,uFAAuF;AACvF,MAAM,CAAC,MAAM,uBAAuB,GAAG;IACrC,UAAU,EAAE,CAAC,IAAI,CAAC;IAClB,WAAW,EAAE,CAAC,IAAI,CAAC;IACnB,SAAS,EAAE,CAAC,IAAI,EAAE,IAAI,CAAC;IACvB,aAAa,EAAE,CAAC,IAAI,CAAC;IACrB,UAAU,EAAE,CAAC,IAAI,CAAC;IAClB,QAAQ,EAAE,CAAC,IAAI,EAAE,IAAI,EAAE,IAAI,EAAE,IAAI,EAAE,IAAI,CAAC;IACxC,aAAa,EAAE,CAAC,IAAI,EAAE,IAAI,CAAC;IAC3B,eAAe,EAAE,CAAC,IAAI,CAAC;IACvB,YAAY,EAAE,CAAC,IAAI,CAAC;CACZ,CAAC;AAEX,iFAAiF;AACjF,MAAM,CAAC,MAAM,4BAA4B,GAAG,CAAC,IAAI,EAAE,IAAI,CAAU,CAAC;AAElE;;;;GAIG;AACH,MAAM,UAAU,uBAAuB,CAAC,OAA0B;IAChE,IAAI,OAAO,CAAC,MAAM,KAAK,CAAC,EAAE,CAAC;QACzB,MAAM,IAAI,2BAA2B,CAAC,qDAAqD,CAAC,CAAC;IAC/F,CAAC;IACD,OAAO,CAAC,OAAO,CAAC,CAAC,CAAE,GAAG,aAAa,EAAE,GAAG,OAAO,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,CAAC;AAC5D,CAAC;AAED,MAAM,CAAC,MAAM,6BAA6B,GAAG,CAAC,GAAG,EAAE,GAAG,EAAE,GAAG,EAAE,IAAI,CAAU,CAAC;AAE5E,oHAAoH;AACpH,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,uBAAuB,GAAG,GAAG,CAAC;AAC3C,MAAM,CAAC,MAAM,uBAAuB,GAAG,KAAK,CAAC;AAC7C,MAAM,CAAC,MAAM,wBAAwB,GAAG,GAAG,CAAC;AAC5C,MAAM,CAAC,MAAM,+BAA+B,GAAG,CAAC,CAAC;AACjD,MAAM,CAAC,MAAM,uCAAuC,GAAG,CAAC,CAAC;AAEzD,MAAM,qBAAqB,GAAG,UAAU,CAAC;AAEzC,MAAM,OAAO,2BAA4B,SAAQ,KAAK;CAAG;AAEzD,sFAAsF;AACtF,MAAM,UAAU,mCAAmC;IACjD,OAAO,CAAC,GAAG,wBAAwB,CAAC,IAAI,EAAE,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,CAAC,EAAE,EAAE,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC;AACpE,CAAC;AAED;;;;GAIG;AACH,MAAM,UAAU,yCAAyC,CACvD,OAA0B,EAC1B,aAAqB,EACrB,QAAiB;IAEjB,IAAI,OAAO,CAAC,MAAM,GAAG,CAAC,IAAI,OAAO,CAAC,MAAM,GAAG,+BAA+B,EAAE,CAAC;QAC3E,MAAM,IAAI,2BAA2B,CACnC,2CAA2C,+BAA+B,eAAe,CAC1F,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,2BAA2B,CACnC,iDAAiD,OAAO,CAAC,MAAM,yBAAyB,CACzF,CAAC;IACJ,CAAC;IACD,MAAM,OAAO,GAAG,OAAO,CAAC,GAAG,CAAC,CAAC,GAAG,EAAE,EAAE;QAClC,MAAM,IAAI,GAAG,wBAAwB,CAAC,GAAG,CAAC,GAAG,CAAC,CAAC;QAC/C,IAAI,IAAI,KAAK,SAAS,EAAE,CAAC;YACvB,MAAM,IAAI,2BAA2B,CACnC,4CAA4C,uBAAuB,IAAI,uBAAuB,CAAC,cAAc,EAAE,OAAO,wBAAwB,aAAa,CAC5J,CAAC;QACJ,CAAC;QACD,OAAO,IAAI,CAAC;IACd,CAAC,CAAC,CAAC;IACH,MAAM,OAAO,GAAG,QAAQ,CAAC,CAAC,CAAC,uBAAuB,CAAC,uBAAuB,CAAC,UAAU,CAAC,CAAC,CAAC,CAAC,uBAAuB,CAAC,UAAU,CAAC;IAC5H,OAAO,IAAI,UAAU,CAAC,CAAC,GAAG,OAAO,EAAE,OAAO,CAAC,MAAM,EAAE,aAAa,EAAE,GAAG,OAAO,CAAC,CAAC,CAAC;AACjF,CAAC;AAED,6EAA6E;AAC7E,MAAM,UAAU,0CAA0C,CAAC,aAAqB,EAAE,QAAiB;IACjG,MAAM,IAAI,GAAG,oBAAoB,CAAC,GAAG,CAAC,aAAa,CAAC,CAAC;IACrD,IAAI,IAAI,KAAK,SAAS,EAAE,CAAC;QACvB,MAAM,IAAI,2BAA2B,CACnC,0EAA0E,CAC3E,CAAC;IACJ,CAAC;IACD,MAAM,OAAO,GAAG,QAAQ,CAAC,CAAC,CAAC,uBAAuB,CAAC,uBAAuB,CAAC,WAAW,CAAC,CAAC,CAAC,CAAC,uBAAuB,CAAC,WAAW,CAAC;IAC9H,OAAO,IAAI,UAAU,CAAC,CAAC,GAAG,OAAO,EAAE,IAAI,CAAC,CAAC,CAAC;AAC5C,CAAC;AAED,SAAS,SAAS,CAAC,CAAS,EAAE,CAAS,EAAE,CAAS;IAChD,KAAK,MAAM,OAAO,IAAI,CAAC,CAAC,EAAE,CAAC,EAAE,CAAC,CAAC,EAAE,CAAC;QAChC,IAAI,CAAC,MAAM,CAAC,SAAS,CAAC,OAAO,CAAC,IAAI,OAAO,GAAG,CAAC,IAAI,OAAO,GAAG,GAAG,EAAE,CAAC;YAC/D,MAAM,IAAI,2BAA2B,CAAC,sCAAsC,CAAC,CAAC;QAChF,CAAC;IACH,CAAC;IACD,OAAO,CAAC,CAAC,EAAE,CAAC,EAAE,CAAC,CAAC,CAAC;AACnB,CAAC;AAID,MAAM,UAAU,GAAuC,EAAE,CAAC,EAAE,IAAI,EAAE,CAAC,EAAE,IAAI,EAAE,CAAC,EAAE,IAAI,EAAE,CAAC;AAErF;;;;GAIG;AACH,MAAM,UAAU,wCAAwC,CACtD,IAAwB,EACxB,CAAS,EACT,CAAS,EACT,CAAS,EACT,QAAiB;IAEjB,MAAM,SAAS,GAAG,UAAU,CAAC,IAAI,CAAC,CAAC;IACnC,IAAI,SAAS,KAAK,SAAS,EAAE,CAAC;QAC5B,MAAM,IAAI,2BAA2B,CACnC,kFAAkF,CACnF,CAAC;IACJ,CAAC;IACD,MAAM,CAAC,GAAG,EAAE,KAAK,EAAE,IAAI,CAAC,GAAG,SAAS,CAAC,CAAC,EAAE,CAAC,EAAE,CAAC,CAAC,CAAC;IAC9C,MAAM,OAAO,GAAG,QAAQ,CAAC,CAAC,CAAC,uBAAuB,CAAC,uBAAuB,CAAC,SAAS,CAAC,CAAC,CAAC,CAAC,uBAAuB,CAAC,SAAS,CAAC;IAC1H,OAAO,IAAI,UAAU,CAAC,CAAC,GAAG,OAAO,EAAE,SAAS,EAAE,GAAG,EAAE,KAAK,EAAE,IAAI,CAAC,CAAC,CAAC;AACnE,CAAC;AAED;;;GAGG;AACH,MAAM,UAAU,4CAA4C,CAC1D,KAAiD,EACjD,QAAiB;IAEjB,MAAM,OAAO,GAAG,QAAQ,CAAC,CAAC,CAAC,uBAAuB,CAAC,uBAAuB,CAAC,aAAa,CAAC,CAAC,CAAC,CAAC,uBAAuB,CAAC,aAAa,CAAC;IAClI,IAAI,KAAK,KAAK,IAAI,EAAE,CAAC;QACnB,OAAO,IAAI,UAAU,CAAC,CAAC,GAAG,OAAO,EAAE,IAAI,EAAE,IAAI,EAAE,IAAI,EAAE,IAAI,EAAE,IAAI,CAAC,CAAC,CAAC;IACpE,CAAC;IACD,MAAM,CAAC,CAAC,EAAE,CAAC,EAAE,CAAC,CAAC,GAAG,SAAS,CAAC,KAAK,CAAC,CAAC,EAAE,KAAK,CAAC,CAAC,EAAE,KAAK,CAAC,CAAC,CAAC,CAAC;IACvD,OAAO,IAAI,UAAU,CAAC,CAAC,GAAG,OAAO,EAAE,IAAI,EAAE,IAAI,EAAE,CAAC,EAAE,CAAC,EAAE,CAAC,CAAC,CAAC,CAAC;AAC3D,CAAC;AAED,SAAS,cAAc,CAAC,KAAa,EAAE,GAAW,EAAE,GAAW,EAAE,IAAY,EAAE,SAAiB;IAC9F,IAAI,CAAC,MAAM,CAAC,SAAS,CAAC,KAAK,CAAC,IAAI,KAAK,GAAG,GAAG,IAAI,KAAK,GAAG,GAAG,EAAE,CAAC;QAC3D,MAAM,IAAI,2BAA2B,CAAC,gCAAgC,IAAI,uBAAuB,GAAG,IAAI,GAAG,GAAG,CAAC,CAAC;IAClH,CAAC;IACD,MAAM,EAAE,GAAG,KAAK,GAAG,SAAS,CAAC;IAC7B,OAAO,CAAC,EAAE,GAAG,IAAI,EAAE,CAAC,EAAE,IAAI,CAAC,CAAC,GAAG,IAAI,EAAE,CAAC,EAAE,IAAI,EAAE,CAAC,GAAG,IAAI,CAAC,CAAC;AAC1D,CAAC;AAED;;;GAGG;AACH,MAAM,UAAU,yCAAyC,CAAC,OAAe,EAAE,QAAiB;IAC1F,MAAM,KAAK,GAAG,cAAc,CAAC,OAAO,EAAE,CAAC,EAAE,EAAE,EAAE,qBAAqB,EAAE,MAAM,CAAC,CAAC;IAC5E,MAAM,OAAO,GAAG,QAAQ,CAAC,CAAC,CAAC,uBAAuB,CAAC,uBAAuB,CAAC,UAAU,CAAC,CAAC,CAAC,CAAC,uBAAuB,CAAC,UAAU,CAAC;IAC5H,OAAO,IAAI,UAAU,CAAC,CAAC,GAAG,OAAO,EAAE,GAAG,KAAK,CAAC,CAAC,CAAC;AAChD,CAAC;AAED;;;;GAIG;AACH,MAAM,UAAU,uCAAuC,CAAC,OAAe,EAAE,QAAiB;IACxF,MAAM,KAAK,GAAG,cAAc,CAAC,OAAO,EAAE,CAAC,EAAE,IAAI,EAAE,mBAAmB,EAAE,KAAK,CAAC,CAAC;IAC3E,MAAM,OAAO,GAAG,QAAQ,CAAC,CAAC,CAAC,uBAAuB,CAAC,uBAAuB,CAAC,QAAQ,CAAC,CAAC,CAAC,CAAC,uBAAuB,CAAC,QAAQ,CAAC;IACxH,OAAO,IAAI,UAAU,CAAC,CAAC,GAAG,OAAO,EAAE,GAAG,KAAK,CAAC,CAAC,CAAC;AAChD,CAAC;AAED,qGAAqG;AACrG,MAAM,UAAU,4CAA4C,CAAC,QAAiB;IAC5E,MAAM,OAAO,GAAG,QAAQ,CAAC,CAAC,CAAC,uBAAuB,CAAC,uBAAuB,CAAC,aAAa,CAAC,CAAC,CAAC,CAAC,uBAAuB,CAAC,aAAa,CAAC;IAClI,OAAO,IAAI,UAAU,CAAC,OAAO,CAAC,CAAC;AACjC,CAAC;AAED,qHAAqH;AACrH,MAAM,CAAC,MAAM,gCAAgC,GAAG;IAC9C,GAAG,EAAE,CAAC,IAAI,EAAE,IAAI,CAAC;IACjB,QAAQ,EAAE,CAAC,IAAI,EAAE,IAAI,CAAC;IACtB,OAAO,EAAE,CAAC,IAAI,EAAE,IAAI,CAAC;IACrB,kBAAkB,EAAE,CAAC,IAAI,EAAE,IAAI,CAAC;CACxB,CAAC;AAIX,kGAAkG;AAClG,MAAM,UAAU,8CAA8C,CAC5D,IAAmC,EACnC,QAAiB;IAEjB,MAAM,KAAK,GAAG,gCAAgC,CAAC,IAAI,CAAC,CAAC;IACrD,IAAI,KAAK,KAAK,SAAS,EAAE,CAAC;QACxB,MAAM,IAAI,2BAA2B,CACnC,iEAAiE,MAAM,CAAC,IAAI,CAAC,gCAAgC,CAAC,CAAC,IAAI,CAAC,IAAI,CAAC,GAAG,CAC7H,CAAC;IACJ,CAAC;IACD,MAAM,OAAO,GAAG,QAAQ,CAAC,CAAC,CAAC,uBAAuB,CAAC,uBAAuB,CAAC,eAAe,CAAC,CAAC,CAAC,CAAC,uBAAuB,CAAC,eAAe,CAAC;IACtI,OAAO,IAAI,UAAU,CAAC,CAAC,GAAG,OAAO,EAAE,GAAG,KAAK,CAAC,CAAC,CAAC;AAChD,CAAC;AAED,gGAAgG;AAChG,MAAM,UAAU,oCAAoC,CAAC,QAAiB;IACpE,MAAM,OAAO,GAAG,QAAQ,CAAC,CAAC,CAAC,uBAAuB,CAAC,4BAA4B,CAAC,CAAC,CAAC,CAAC,4BAA4B,CAAC;IAChH,OAAO,IAAI,UAAU,CAAC,OAAO,CAAC,CAAC;AACjC,CAAC;AAED,6FAA6F;AAC7F,MAAM,UAAU,qCAAqC,CAAC,QAAiB;IACrE,MAAM,OAAO,GAAG,QAAQ,CAAC,CAAC,CAAC,uBAAuB,CAAC,uBAAuB,CAAC,YAAY,CAAC,CAAC,CAAC,CAAC,uBAAuB,CAAC,YAAY,CAAC;IAChI,OAAO,IAAI,UAAU,CAAC,OAAO,CAAC,CAAC;AACjC,CAAC;AASD;;;;GAIG;AACH,MAAM,UAAU,sCAAsC,CAAC,OAAmB;IACxE,IAAI,OAAO,CAAC,MAAM,GAAG,uCAAuC,EAAE,CAAC;QAC7D,MAAM,IAAI,2BAA2B,CACnC,0EAA0E,CAC3E,CAAC;IACJ,CAAC;IACD,MAAM,UAAU,GAAG,OAAO,CAAC,CAAC,CAAE,CAAC;IAC/B,MAAM,UAAU,GAAG,CAAC,UAAU,GAAG,qBAAqB,CAAC,KAAK,CAAC,CAAC;IAC9D,MAAM,KAAK,GAAG,CAAC,CAAC,UAAU,GAAG,CAAC,qBAAqB,CAAC,GAAG,CAAC,CAAC,GAAG,CAAC,CAAC;IAC9D,OAAO,EAAE,KAAK,EAAE,UAAU,EAAE,CAAC;AAC/B,CAAC"}

package/dist/steelseries/devices.d.ts

@@ -0,0 +1,82 @@
+/**
+ * SteelSeries per-PID catalog.
+ *
+ * SteelSeries is a multi-family vendor: rivalcfg alone documents four
+ * incompatible Rival 3 command sets (Gen 1, Gen 2, Wireless, Wireless Gen 2),
+ * and libratbag distinguishes four more protocol versions for older mice. The
+ * `family` field selects which codec module drives a product; command bytes,
+ * framing, and value tables live in that module, never here, and no family's
+ * codec branches on product id.
+ *
+ * Only PIDs whose protocol has been traced to a public implementation belong
+ * here. The Rival 3 Wireless Gen 2 (`0x1872`) and Rival 3 Gen 2 (`0x1870`)
+ * are deliberately absent: their command sets are documented as different
+ * from every family below, and listing them would claim devices this codec
+ * would misprogram. The Rival 3 Wireless (`0x1830`) is present with family
+ * `"rival3-wireless"` — its own module, `./rival3-wireless.ts`, distinct from
+ * both Rival 3 Gen 1 and Aerox 3 (different command bytes throughout, a
+ * different DPI sensor table, and, unlike either wired family, a readable
+ * battery/firmware state — see that module's doc comment).
+ *
+ * The Aerox 3 (`0x1836`, family `"aerox3"`) is a separate protocol family
+ * from Rival 3 despite both being SteelSeries, single-byte vs. two-byte
+ * command prefixes and all — see `./aerox3.ts`'s doc comment, including its
+ * reconciliation of PR flozz/rivalcfg#269's Rival 3 Gen 2 claim (not added
+ * here: its DPI command differs from Aerox 3's even though most other
+ * commands match).
+ *
+ * The Aerox 5 is split across **two** families despite one product line and
+ * mostly-shared command bytes: `"aerox5"` (`0x1850`, the plain wired mouse —
+ * see `./aerox5.ts`) and `"aerox5-wireless"` (the separately-sold Aerox 5
+ * Wireless, six PIDs across its USB-cabled and 2.4 GHz dongle modes — see
+ * `./aerox5-wireless.ts`). The two families' polling-rate byte values and
+ * RGB zone-color packet shapes differ even though several other command
+ * bytes match; do not assume one family's codec for the other's PIDs.
+ *
+ * The Aerox 9 Wireless (`"aerox9-wireless"`, four PIDs across its
+ * USB-cabled and 2.4 GHz dongle modes — see `./aerox9-wireless.ts`) is its
+ * own family, not folded into `"aerox5-wireless"` despite sharing the same
+ * `_patch_command`-style wireless-flag transform and several command bytes:
+ * its RGB zone commands, dim timer, and battery read match Aerox 5
+ * Wireless's byte-for-byte, but it defines no button-mapping command at all
+ * (`./aerox9-wireless.ts`'s doc comment) where Aerox 5 Wireless does, and
+ * its product-id space is disjoint from every other family here.
+ *
+ * The Prime+ (`0x182C`, family `"prime-plus"`) is its own family per this
+ * rollout's per-cluster scoping, even though — see `./prime-plus.ts`'s doc
+ * comment for the full corroboration-gap disclosure — its rivalcfg profile
+ * (`prime_plus.py`) is byte-identical to plain Prime's (`prime.py`, PIDs
+ * `0x182E`/`0x182A`/`0x1856`, none of which are listed here: plain/non-Plus
+ * Prime is out of scope for this cluster and deliberately not added).
+ *
+ * The Prime Mini Wireless (`"prime-mini-wireless"`, PIDs `0x184A` wired /
+ * `0x1848` 2.4 GHz — see `./prime-mini-wireless.ts`) is its own family for
+ * the same reason: rivalcfg documents it and the plain (non-Mini) Prime
+ * Wireless as one shared `settings` dict inside
+ * `prime_wireless_wired.py`/`prime_wireless_wireless.py`, but the plain
+ * Prime Wireless's PIDs (`0x1842` wired / `0x1840` 2.4 GHz) are out of scope
+ * for this cluster and deliberately not added here.
+ */
+export declare const STEELSERIES_VENDOR_ID = 4152;
+export type SteelSeriesProtocolFamily = "rival3" | "rival310" | "aerox3" | "rival3-wireless" | "aerox5" | "aerox5-wireless" | "rival650" | "aerox9-wireless" | "prime-plus" | "prime-mini-wireless" | "sensei-ten";
+export interface SteelSeriesProduct {
+    model: string;
+    /** Selects the codec module. Never infer one family's commands from another. */
+    family: SteelSeriesProtocolFamily;
+    wireless: boolean;
+    /**
+     * No public implementation has a settings getter for DPI/polling/buttons on
+     * any family here — rivalcfg keeps a local JSON mirror because the mouse
+     * cannot be asked those specific settings. Typed as the literal `false` so
+     * a future settings-readable family forces a conscious widening rather than
+     * silently defaulting reads on. This is independent of `rival3-wireless`'s
+     * separate readable battery/firmware state, which is not a "setting".
+     */
+    settingsReadable: false;
+    /** The `10 00` firmware query; the Gen 2 profile has no firmware command. */
+    hasFirmwareQuery: boolean;
+    /** True only after this exact product id was exercised on real hardware. */
+    verified: boolean;
+}
+export declare const STEELSERIES_PRODUCTS: ReadonlyMap<number, SteelSeriesProduct>;
+//# sourceMappingURL=devices.d.ts.map

package/dist/steelseries/devices.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"devices.d.ts","sourceRoot":"","sources":["../../src/steelseries/devices.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GA0DG;AAEH,eAAO,MAAM,qBAAqB,OAAS,CAAC;AAE5C,MAAM,MAAM,yBAAyB,GACjC,QAAQ,GACR,UAAU,GACV,QAAQ,GACR,iBAAiB,GACjB,QAAQ,GACR,iBAAiB,GACjB,UAAU,GACV,iBAAiB,GACjB,YAAY,GACZ,qBAAqB,GACrB,YAAY,CAAC;AAEjB,MAAM,WAAW,kBAAkB;IACjC,KAAK,EAAE,MAAM,CAAC;IACd,gFAAgF;IAChF,MAAM,EAAE,yBAAyB,CAAC;IAClC,QAAQ,EAAE,OAAO,CAAC;IAClB;;;;;;;OAOG;IACH,gBAAgB,EAAE,KAAK,CAAC;IACxB,6EAA6E;IAC7E,gBAAgB,EAAE,OAAO,CAAC;IAC1B,4EAA4E;IAC5E,QAAQ,EAAE,OAAO,CAAC;CACnB;AAED,eAAO,MAAM,oBAAoB,EAAE,WAAW,CAAC,MAAM,EAAE,kBAAkB,CAwPvE,CAAC"}