@openmouse/protocol 0.1.0

package/dist/steelseries/devices.js

@@ -0,0 +1,310 @@
+/**
+ * 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 const STEELSERIES_VENDOR_ID = 0x1038;
+export const STEELSERIES_PRODUCTS = new Map([
+    // Pre-0.37 firmware enumeration.
+    [0x1824, {
+            model: "Rival 3",
+            family: "rival3",
+            wireless: false,
+            settingsReadable: false,
+            hasFirmwareQuery: true,
+            verified: false,
+        }],
+    // The same mouse re-enumerated after the v0.37.0.0 firmware update; rivalcfg
+    // lists both ids against one profile and OpenRGB names 0x1824 "Old Firmware".
+    [0x184c, {
+            model: "Rival 3",
+            family: "rival3",
+            wireless: false,
+            settingsReadable: false,
+            hasFirmwareQuery: true,
+            verified: false,
+        }],
+    // aerox3.py defines no getter and no firmware-query command for this family.
+    [0x1836, {
+            model: "Aerox 3",
+            family: "aerox3",
+            wireless: false,
+            settingsReadable: false,
+            hasFirmwareQuery: false,
+            verified: false,
+        }],
+    // rival3_wireless.py: "2.4 GHz mode", endpoint 3. Own command set (0x20/
+    // 0x17/0x19), own DPI table (TrueMove Air), plus a battery_level read
+    // (0xAA 0x01) neither Rival 3 Gen 1 nor Aerox 3 has. See ./rival3-wireless.ts.
+    [0x1830, {
+            model: "Rival 3 Wireless",
+            family: "rival3-wireless",
+            wireless: true,
+            settingsReadable: false,
+            hasFirmwareQuery: true,
+            verified: false,
+        }],
+    // aerox5.py: plain wired Aerox 5. No getter, no firmware-query command.
+    [0x1850, {
+            model: "Aerox 5",
+            family: "aerox5",
+            wireless: false,
+            settingsReadable: false,
+            hasFirmwareQuery: false,
+            verified: false,
+        }],
+    // aerox5_wireless_wired.py: Aerox 5 Wireless in USB-cabled mode. Own
+    // command set from the plain Aerox 5 (different polling-rate bytes,
+    // different RGB zone packing, extra sleep/dim timers, a battery read the
+    // plain Aerox 5 has no equivalent of). No firmware-query command.
+    [0x1854, {
+            model: "Aerox 5 Wireless (wired mode)",
+            family: "aerox5-wireless",
+            wireless: true,
+            settingsReadable: false,
+            hasFirmwareQuery: false,
+            verified: false,
+        }],
+    [0x185e, {
+            model: "Aerox 5 Wireless Destiny 2 Edition (wired mode)",
+            family: "aerox5-wireless",
+            wireless: true,
+            settingsReadable: false,
+            hasFirmwareQuery: false,
+            verified: false,
+        }],
+    [0x1862, {
+            model: "Aerox 5 Wireless Diablo IV Edition (wired mode)",
+            family: "aerox5-wireless",
+            wireless: true,
+            settingsReadable: false,
+            hasFirmwareQuery: false,
+            verified: false,
+        }],
+    // aerox5_wireless_wireless.py: same mouse, 2.4 GHz dongle mode. Every
+    // command byte is `aerox5_wireless_wired.py`'s with `0b01000000` ORed into
+    // byte 0 (see ./aerox5-wireless.ts's `applyWirelessFlag`).
+    [0x1852, {
+            model: "Aerox 5 Wireless (2.4 GHz mode)",
+            family: "aerox5-wireless",
+            wireless: true,
+            settingsReadable: false,
+            hasFirmwareQuery: false,
+            verified: false,
+        }],
+    [0x185c, {
+            model: "Aerox 5 Wireless Destiny 2 Edition (2.4 GHz mode)",
+            family: "aerox5-wireless",
+            wireless: true,
+            settingsReadable: false,
+            hasFirmwareQuery: false,
+            verified: false,
+        }],
+    [0x1860, {
+            model: "Aerox 5 Wireless Diablo IV Edition (2.4 GHz mode)",
+            family: "aerox5-wireless",
+            wireless: true,
+            settingsReadable: false,
+            hasFirmwareQuery: false,
+            verified: false,
+        }],
+    // rival650.py: wired/USB-cabled mode, endpoint 0. Own command set (0x15/
+    // 0x17/0x20/0x19/0x2B), a battery_level read (0xAA 0x01, byte-identical
+    // shape to Rival 3 Wireless's) but no firmware-query command. See
+    // ./rival650.ts.
+    [0x172b, {
+            model: "Rival 650 Wireless (wired mode)",
+            family: "rival650",
+            wireless: true,
+            settingsReadable: false,
+            hasFirmwareQuery: false,
+            verified: false,
+        }],
+    // rival650.py: same mouse, 2.4 GHz wireless mode. Same command bytes as
+    // wired mode — no wireless-flag transform, unlike Aerox 5 Wireless.
+    [0x1726, {
+            model: "Rival 650 Wireless (2.4 GHz wireless mode)",
+            family: "rival650",
+            wireless: true,
+            settingsReadable: false,
+            hasFirmwareQuery: false,
+            verified: false,
+        }],
+    // aerox9_wireless_wired.py: Aerox 9 Wireless in USB-cabled mode. Shares
+    // the applyWirelessFlag transform with Aerox 5 Wireless (confirmed by
+    // diffing the two rivalcfg wired/wireless file pairs) but defines no
+    // button-mapping command. No firmware-query command.
+    [0x185a, {
+            model: "Aerox 9 Wireless (wired mode)",
+            family: "aerox9-wireless",
+            wireless: true,
+            settingsReadable: false,
+            hasFirmwareQuery: false,
+            verified: false,
+        }],
+    [0x1876, {
+            model: "Aerox 9 Wireless WOW Edition (wired mode)",
+            family: "aerox9-wireless",
+            wireless: true,
+            settingsReadable: false,
+            hasFirmwareQuery: false,
+            verified: false,
+        }],
+    // aerox9_wireless_wireless.py: same mouse, 2.4 GHz dongle mode. Every
+    // command byte is `aerox9_wireless_wired.py`'s with `0b01000000` ORed into
+    // byte 0 (see ./aerox9-wireless.ts's `applyWirelessFlag`).
+    [0x1858, {
+            model: "Aerox 9 Wireless (2.4 GHz mode)",
+            family: "aerox9-wireless",
+            wireless: true,
+            settingsReadable: false,
+            hasFirmwareQuery: false,
+            verified: false,
+        }],
+    [0x1874, {
+            model: "Aerox 9 Wireless WOW Edition (2.4 GHz mode)",
+            family: "aerox9-wireless",
+            wireless: true,
+            settingsReadable: false,
+            hasFirmwareQuery: false,
+            verified: false,
+        }],
+    // prime_plus.py: wired only, endpoint 0. No getter, no firmware-query
+    // command. Protocol is byte-identical to plain Prime's — see
+    // ./prime-plus.ts's doc comment for the full disclosure.
+    [0x182c, {
+            model: "Prime+",
+            family: "prime-plus",
+            wireless: false,
+            settingsReadable: false,
+            hasFirmwareQuery: false,
+            verified: false,
+        }],
+    // rival310.py: wired only, endpoint 0. Own command set (0x53/0x54/0x5B/
+    // 0x31), a linear (non-table) DPI encoding, and a readable firmware
+    // version behind 0x90 00 — see ./rival310.ts's doc comment, including its
+    // explicit libratbag/OpenRGB corroboration-gap disclosure.
+    [0x1720, {
+            model: "Rival 310",
+            family: "rival310",
+            wireless: false,
+            settingsReadable: false,
+            hasFirmwareQuery: true,
+            verified: false,
+        }],
+    [0x171e, {
+            model: "Rival 310 CS:GO Howl Edition",
+            family: "rival310",
+            wireless: false,
+            settingsReadable: false,
+            hasFirmwareQuery: true,
+            verified: false,
+        }],
+    [0x1736, {
+            model: "Rival 310 PUBG Edition",
+            family: "rival310",
+            wireless: false,
+            settingsReadable: false,
+            hasFirmwareQuery: true,
+            verified: false,
+        }],
+    // prime_wireless_wired.py: Prime Mini Wireless in USB-cabled mode (one of
+    // two models in that file's shared profile — the other is the plain Prime
+    // Wireless, out of scope for this cluster, see the doc comment above).
+    // No firmware-query command.
+    [0x184a, {
+            model: "Prime Mini Wireless (wired mode)",
+            family: "prime-mini-wireless",
+            wireless: true,
+            settingsReadable: false,
+            hasFirmwareQuery: false,
+            verified: false,
+        }],
+    // prime_wireless_wireless.py: same mouse, 2.4 GHz dongle mode. Every
+    // command byte is `prime_wireless_wired.py`'s with `0b01000000` ORed into
+    // byte 0 (see ./prime-mini-wireless.ts's `applyWirelessFlag`).
+    [0x1848, {
+            model: "Prime Mini Wireless (2.4 GHz mode)",
+            family: "prime-mini-wireless",
+            wireless: true,
+            settingsReadable: false,
+            hasFirmwareQuery: false,
+            verified: false,
+        }],
+    // sensei_ten.py: wired only, endpoint 0. Own command set (0x54/0x55/0x5B/
+    // 0x31/0x59), a linear (non-table) DPI encoding distinct from rival310's
+    // (2-byte little-endian words vs. 1-byte), and a readable firmware version
+    // behind 0x90 00 — see ./sensei-ten.ts's doc comment, including its
+    // explicit libratbag/OpenRGB corroboration-gap disclosure.
+    [0x1832, {
+            model: "Sensei TEN",
+            family: "sensei-ten",
+            wireless: false,
+            settingsReadable: false,
+            hasFirmwareQuery: true,
+            verified: false,
+        }],
+    [0x1834, {
+            model: "Sensei TEN CS:GO Neon Rider Edition",
+            family: "sensei-ten",
+            wireless: false,
+            settingsReadable: false,
+            hasFirmwareQuery: true,
+            verified: false,
+        }],
+]);
+//# sourceMappingURL=devices.js.map

package/dist/steelseries/devices.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"devices.js","sourceRoot":"","sources":["../../src/steelseries/devices.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GA0DG;AAEH,MAAM,CAAC,MAAM,qBAAqB,GAAG,MAAM,CAAC;AAmC5C,MAAM,CAAC,MAAM,oBAAoB,GAA4C,IAAI,GAAG,CAAC;IACnF,iCAAiC;IACjC,CAAC,MAAM,EAAE;YACP,KAAK,EAAE,SAAS;YAChB,MAAM,EAAE,QAAQ;YAChB,QAAQ,EAAE,KAAK;YACf,gBAAgB,EAAE,KAAK;YACvB,gBAAgB,EAAE,IAAI;YACtB,QAAQ,EAAE,KAAK;SAChB,CAAC;IACF,6EAA6E;IAC7E,8EAA8E;IAC9E,CAAC,MAAM,EAAE;YACP,KAAK,EAAE,SAAS;YAChB,MAAM,EAAE,QAAQ;YAChB,QAAQ,EAAE,KAAK;YACf,gBAAgB,EAAE,KAAK;YACvB,gBAAgB,EAAE,IAAI;YACtB,QAAQ,EAAE,KAAK;SAChB,CAAC;IACF,6EAA6E;IAC7E,CAAC,MAAM,EAAE;YACP,KAAK,EAAE,SAAS;YAChB,MAAM,EAAE,QAAQ;YAChB,QAAQ,EAAE,KAAK;YACf,gBAAgB,EAAE,KAAK;YACvB,gBAAgB,EAAE,KAAK;YACvB,QAAQ,EAAE,KAAK;SAChB,CAAC;IACF,yEAAyE;IACzE,sEAAsE;IACtE,+EAA+E;IAC/E,CAAC,MAAM,EAAE;YACP,KAAK,EAAE,kBAAkB;YACzB,MAAM,EAAE,iBAAiB;YACzB,QAAQ,EAAE,IAAI;YACd,gBAAgB,EAAE,KAAK;YACvB,gBAAgB,EAAE,IAAI;YACtB,QAAQ,EAAE,KAAK;SAChB,CAAC;IACF,wEAAwE;IACxE,CAAC,MAAM,EAAE;YACP,KAAK,EAAE,SAAS;YAChB,MAAM,EAAE,QAAQ;YAChB,QAAQ,EAAE,KAAK;YACf,gBAAgB,EAAE,KAAK;YACvB,gBAAgB,EAAE,KAAK;YACvB,QAAQ,EAAE,KAAK;SAChB,CAAC;IACF,qEAAqE;IACrE,oEAAoE;IACpE,yEAAyE;IACzE,kEAAkE;IAClE,CAAC,MAAM,EAAE;YACP,KAAK,EAAE,+BAA+B;YACtC,MAAM,EAAE,iBAAiB;YACzB,QAAQ,EAAE,IAAI;YACd,gBAAgB,EAAE,KAAK;YACvB,gBAAgB,EAAE,KAAK;YACvB,QAAQ,EAAE,KAAK;SAChB,CAAC;IACF,CAAC,MAAM,EAAE;YACP,KAAK,EAAE,iDAAiD;YACxD,MAAM,EAAE,iBAAiB;YACzB,QAAQ,EAAE,IAAI;YACd,gBAAgB,EAAE,KAAK;YACvB,gBAAgB,EAAE,KAAK;YACvB,QAAQ,EAAE,KAAK;SAChB,CAAC;IACF,CAAC,MAAM,EAAE;YACP,KAAK,EAAE,iDAAiD;YACxD,MAAM,EAAE,iBAAiB;YACzB,QAAQ,EAAE,IAAI;YACd,gBAAgB,EAAE,KAAK;YACvB,gBAAgB,EAAE,KAAK;YACvB,QAAQ,EAAE,KAAK;SAChB,CAAC;IACF,sEAAsE;IACtE,2EAA2E;IAC3E,2DAA2D;IAC3D,CAAC,MAAM,EAAE;YACP,KAAK,EAAE,iCAAiC;YACxC,MAAM,EAAE,iBAAiB;YACzB,QAAQ,EAAE,IAAI;YACd,gBAAgB,EAAE,KAAK;YACvB,gBAAgB,EAAE,KAAK;YACvB,QAAQ,EAAE,KAAK;SAChB,CAAC;IACF,CAAC,MAAM,EAAE;YACP,KAAK,EAAE,mDAAmD;YAC1D,MAAM,EAAE,iBAAiB;YACzB,QAAQ,EAAE,IAAI;YACd,gBAAgB,EAAE,KAAK;YACvB,gBAAgB,EAAE,KAAK;YACvB,QAAQ,EAAE,KAAK;SAChB,CAAC;IACF,CAAC,MAAM,EAAE;YACP,KAAK,EAAE,mDAAmD;YAC1D,MAAM,EAAE,iBAAiB;YACzB,QAAQ,EAAE,IAAI;YACd,gBAAgB,EAAE,KAAK;YACvB,gBAAgB,EAAE,KAAK;YACvB,QAAQ,EAAE,KAAK;SAChB,CAAC;IACF,yEAAyE;IACzE,wEAAwE;IACxE,kEAAkE;IAClE,iBAAiB;IACjB,CAAC,MAAM,EAAE;YACP,KAAK,EAAE,iCAAiC;YACxC,MAAM,EAAE,UAAU;YAClB,QAAQ,EAAE,IAAI;YACd,gBAAgB,EAAE,KAAK;YACvB,gBAAgB,EAAE,KAAK;YACvB,QAAQ,EAAE,KAAK;SAChB,CAAC;IACF,wEAAwE;IACxE,oEAAoE;IACpE,CAAC,MAAM,EAAE;YACP,KAAK,EAAE,4CAA4C;YACnD,MAAM,EAAE,UAAU;YAClB,QAAQ,EAAE,IAAI;YACd,gBAAgB,EAAE,KAAK;YACvB,gBAAgB,EAAE,KAAK;YACvB,QAAQ,EAAE,KAAK;SAChB,CAAC;IACF,wEAAwE;IACxE,sEAAsE;IACtE,qEAAqE;IACrE,qDAAqD;IACrD,CAAC,MAAM,EAAE;YACP,KAAK,EAAE,+BAA+B;YACtC,MAAM,EAAE,iBAAiB;YACzB,QAAQ,EAAE,IAAI;YACd,gBAAgB,EAAE,KAAK;YACvB,gBAAgB,EAAE,KAAK;YACvB,QAAQ,EAAE,KAAK;SAChB,CAAC;IACF,CAAC,MAAM,EAAE;YACP,KAAK,EAAE,2CAA2C;YAClD,MAAM,EAAE,iBAAiB;YACzB,QAAQ,EAAE,IAAI;YACd,gBAAgB,EAAE,KAAK;YACvB,gBAAgB,EAAE,KAAK;YACvB,QAAQ,EAAE,KAAK;SAChB,CAAC;IACF,sEAAsE;IACtE,2EAA2E;IAC3E,2DAA2D;IAC3D,CAAC,MAAM,EAAE;YACP,KAAK,EAAE,iCAAiC;YACxC,MAAM,EAAE,iBAAiB;YACzB,QAAQ,EAAE,IAAI;YACd,gBAAgB,EAAE,KAAK;YACvB,gBAAgB,EAAE,KAAK;YACvB,QAAQ,EAAE,KAAK;SAChB,CAAC;IACF,CAAC,MAAM,EAAE;YACP,KAAK,EAAE,6CAA6C;YACpD,MAAM,EAAE,iBAAiB;YACzB,QAAQ,EAAE,IAAI;YACd,gBAAgB,EAAE,KAAK;YACvB,gBAAgB,EAAE,KAAK;YACvB,QAAQ,EAAE,KAAK;SAChB,CAAC;IACF,sEAAsE;IACtE,6DAA6D;IAC7D,yDAAyD;IACzD,CAAC,MAAM,EAAE;YACP,KAAK,EAAE,QAAQ;YACf,MAAM,EAAE,YAAY;YACpB,QAAQ,EAAE,KAAK;YACf,gBAAgB,EAAE,KAAK;YACvB,gBAAgB,EAAE,KAAK;YACvB,QAAQ,EAAE,KAAK;SAChB,CAAC;IACF,wEAAwE;IACxE,oEAAoE;IACpE,0EAA0E;IAC1E,2DAA2D;IAC3D,CAAC,MAAM,EAAE;YACP,KAAK,EAAE,WAAW;YAClB,MAAM,EAAE,UAAU;YAClB,QAAQ,EAAE,KAAK;YACf,gBAAgB,EAAE,KAAK;YACvB,gBAAgB,EAAE,IAAI;YACtB,QAAQ,EAAE,KAAK;SAChB,CAAC;IACF,CAAC,MAAM,EAAE;YACP,KAAK,EAAE,8BAA8B;YACrC,MAAM,EAAE,UAAU;YAClB,QAAQ,EAAE,KAAK;YACf,gBAAgB,EAAE,KAAK;YACvB,gBAAgB,EAAE,IAAI;YACtB,QAAQ,EAAE,KAAK;SAChB,CAAC;IACF,CAAC,MAAM,EAAE;YACP,KAAK,EAAE,wBAAwB;YAC/B,MAAM,EAAE,UAAU;YAClB,QAAQ,EAAE,KAAK;YACf,gBAAgB,EAAE,KAAK;YACvB,gBAAgB,EAAE,IAAI;YACtB,QAAQ,EAAE,KAAK;SAChB,CAAC;IACF,0EAA0E;IAC1E,0EAA0E;IAC1E,uEAAuE;IACvE,6BAA6B;IAC7B,CAAC,MAAM,EAAE;YACP,KAAK,EAAE,kCAAkC;YACzC,MAAM,EAAE,qBAAqB;YAC7B,QAAQ,EAAE,IAAI;YACd,gBAAgB,EAAE,KAAK;YACvB,gBAAgB,EAAE,KAAK;YACvB,QAAQ,EAAE,KAAK;SAChB,CAAC;IACF,qEAAqE;IACrE,0EAA0E;IAC1E,+DAA+D;IAC/D,CAAC,MAAM,EAAE;YACP,KAAK,EAAE,oCAAoC;YAC3C,MAAM,EAAE,qBAAqB;YAC7B,QAAQ,EAAE,IAAI;YACd,gBAAgB,EAAE,KAAK;YACvB,gBAAgB,EAAE,KAAK;YACvB,QAAQ,EAAE,KAAK;SAChB,CAAC;IACF,0EAA0E;IAC1E,yEAAyE;IACzE,2EAA2E;IAC3E,oEAAoE;IACpE,2DAA2D;IAC3D,CAAC,MAAM,EAAE;YACP,KAAK,EAAE,YAAY;YACnB,MAAM,EAAE,YAAY;YACpB,QAAQ,EAAE,KAAK;YACf,gBAAgB,EAAE,KAAK;YACvB,gBAAgB,EAAE,IAAI;YACtB,QAAQ,EAAE,KAAK;SAChB,CAAC;IACF,CAAC,MAAM,EAAE;YACP,KAAK,EAAE,qCAAqC;YAC5C,MAAM,EAAE,YAAY;YACpB,QAAQ,EAAE,KAAK;YACf,gBAAgB,EAAE,KAAK;YACvB,gBAAgB,EAAE,IAAI;YACtB,QAAQ,EAAE,KAAK;SAChB,CAAC;CACH,CAAC,CAAC"}

package/dist/steelseries/index.d.ts

@@ -0,0 +1,13 @@
+export * from "./rival3.js";
+export * from "./rival310.js";
+export * from "./aerox3.js";
+export * from "./rival3-wireless.js";
+export * from "./aerox5.js";
+export * from "./aerox5-wireless.js";
+export * from "./rival650.js";
+export * from "./aerox9-wireless.js";
+export * from "./prime-plus.js";
+export * from "./prime-mini-wireless.js";
+export * from "./sensei-ten.js";
+export * from "./devices.js";
+//# sourceMappingURL=index.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/steelseries/index.ts"],"names":[],"mappings":"AAAA,cAAc,aAAa,CAAC;AAC5B,cAAc,eAAe,CAAC;AAC9B,cAAc,aAAa,CAAC;AAC5B,cAAc,sBAAsB,CAAC;AACrC,cAAc,aAAa,CAAC;AAC5B,cAAc,sBAAsB,CAAC;AACrC,cAAc,eAAe,CAAC;AAC9B,cAAc,sBAAsB,CAAC;AACrC,cAAc,iBAAiB,CAAC;AAChC,cAAc,0BAA0B,CAAC;AACzC,cAAc,iBAAiB,CAAC;AAChC,cAAc,cAAc,CAAC"}

package/dist/steelseries/index.js

@@ -0,0 +1,13 @@
+export * from "./rival3.js";
+export * from "./rival310.js";
+export * from "./aerox3.js";
+export * from "./rival3-wireless.js";
+export * from "./aerox5.js";
+export * from "./aerox5-wireless.js";
+export * from "./rival650.js";
+export * from "./aerox9-wireless.js";
+export * from "./prime-plus.js";
+export * from "./prime-mini-wireless.js";
+export * from "./sensei-ten.js";
+export * from "./devices.js";
+//# sourceMappingURL=index.js.map

package/dist/steelseries/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/steelseries/index.ts"],"names":[],"mappings":"AAAA,cAAc,aAAa,CAAC;AAC5B,cAAc,eAAe,CAAC;AAC9B,cAAc,aAAa,CAAC;AAC5B,cAAc,sBAAsB,CAAC;AACrC,cAAc,aAAa,CAAC;AAC5B,cAAc,sBAAsB,CAAC;AACrC,cAAc,eAAe,CAAC;AAC9B,cAAc,sBAAsB,CAAC;AACrC,cAAc,iBAAiB,CAAC;AAChC,cAAc,0BAA0B,CAAC;AACzC,cAAc,iBAAiB,CAAC;AAChC,cAAc,cAAc,CAAC"}

package/dist/steelseries/prime-mini-wireless.d.ts

@@ -0,0 +1,253 @@
+/**
+ * SteelSeries Prime Mini Wireless configuration protocol — pure encode/decode helpers.
+ *
+ * Reconstructed from public open-source implementations, not vendor software:
+ *
+ * - There is **no** `prime_mini_wireless.py` (nor a wired/wireless filename
+ *   pair) in rivalcfg. The Prime Mini Wireless is instead one of two models
+ *   inside the shared "Prime Wireless" profile pair:
+ *   `rivalcfg/devices/prime_wireless_wired.py` (USB-cabled mode) defines two
+ *   `models` entries — `"SteelSeries Prime Wireless (wired mode)"`
+ *   (`1038:1842`) and `"SteelSeries Prime Mini Wireless (wired mode)"`
+ *   (`1038:184A`) — sharing one `settings`/`battery_level`/`save_command`
+ *   dict. `rivalcfg/devices/prime_wireless_wireless.py` (2.4 GHz dongle mode)
+ *   mirrors that with `1038:1840` (Prime Wireless) and `1038:1848` (Prime
+ *   Mini Wireless), built by comprehending `prime_wireless_wired.py`'s
+ *   `settings`/`battery_level`/`save_command` through one `_patch_command`
+ *   helper — same transform this file implements as `applyPrimeMiniWirelessFlag`.
+ *   Both files were read in full. This module implements only the two Prime
+ *   Mini Wireless product ids (`0x184A` wired, `0x1848` 2.4 GHz) per the
+ *   scope of this change — see "Scope" below for why the plain Prime
+ *   Wireless PIDs (`0x1842`/`0x1840`) are deliberately not registered here
+ *   even though the command set is identical.
+ * - rivalcfg `rivalcfg/devices/dpi/truemove_air.py` — same TrueMove Air
+ *   sensor table as the Rival 3 Wireless and Aerox 5 Wireless — imported
+ *   from `./rival3-wireless.ts`'s `TRUEMOVE_AIR_DPI_TO_BYTE`, not re-derived.
+ * - rivalcfg `rivalcfg/handlers/multidpi_range_choice.py` — `dpi_length_byte: 1`,
+ *   `first_preset: 0` (same shape as `./aerox5-wireless.ts`, **not**
+ *   `./rival3-wireless.ts`'s `first_preset: 1`/`dpi_length_byte` via
+ *   `multidpi_range`).
+ * - rivalcfg `rivalcfg/handlers/range.py` — `sleep_timer`/`dim_timer`: the
+ *   exact same linear range-to-range mapping as `./aerox5-wireless.ts`
+ *   (`sleep_timer` = minutes × 60000 ms, `dim_timer` = seconds × 1000 ms,
+ *   both little-endian 3 bytes, `range_length_byte: 3`). Traced by hand
+ *   against `prime_wireless_wired.py`'s `output_range: [0x000000, 0x124F80, …]`
+ *   values, not assumed from the Aerox 5 Wireless precedent.
+ * - rivalcfg `rivalcfg/handlers/rgbcolor.py` — LED color: `command: [0x21, 0x01, 0x00]`
+ *   with the RGB triplet appended directly (no zone byte and no bitmask —
+ *   this is a single-LED mouse, unlike the Aerox 5 Wireless's
+ *   zone-indexed `steelseriesAerox5WirelessEncodeZoneColor`).
+ * - rivalcfg `rivalcfg/handlers/choice.py` — `polling_rate`
+ *   (`{125:0x03, 250:0x02, 500:0x01, 1000:0x00}`, byte-identical mapping to
+ *   `./aerox5-wireless.ts`'s table, confirmed by direct comparison — not
+ *   assumed) and `default_lighting` (`{"off": 0x00, "rainbow": 0x01}`).
+ * - rivalcfg `rivalcfg/handlers/buttons/buttons.py` (inferred generic
+ *   handler backing `value_type: "buttons"`) — 6 mappable buttons + scroll
+ *   up/down, `button_field_length: 5`, byte-identical ids/offsets to the
+ *   non-wireless `prime_mini.py`'s `buttons_mapping` block (confirmed by
+ *   direct comparison of both device files).
+ *
+ * ## Why wired-cable-mode and 2.4 GHz-dongle-mode share one module
+ *
+ * Same SteelSeries wireless pattern as `./aerox5-wireless.ts` and
+ * `./rival3-wireless.ts`: one physical mouse, two USB product ids depending
+ * on transport, one command set modulo a fixed transform.
+ * `prime_wireless_wireless.py`'s `_patch_command` ORs `0b01000000` (`0x40`)
+ * into `command[0]` of every setting, `battery_level`, and `save_command`
+ * inherited from `prime_wireless_wired.py`, and adds `readback_length: 64`
+ * (an expected reply length this module does not need to model — no
+ * function here reads or validates a readback payload). Every command byte
+ * in `PRIME_MINI_WIRELESS_COMMAND` below is the wired-mode value;
+ * `applyPrimeMiniWirelessFlag` produces the 2.4 GHz-mode byte from it on demand.
+ *
+ * ## Scope: Prime Mini Wireless only, not the plain Prime Wireless
+ *
+ * `prime_wireless_wired.py`/`prime_wireless_wireless.py` document the Prime
+ * Mini Wireless and the plain (non-Mini) Prime Wireless as one shared
+ * `settings` dict — genuinely the same command bytes, same DPI table, same
+ * battery shape, differing only in physical product id. This change is
+ * scoped to the Prime Mini Wireless cluster only: `./devices.ts` registers
+ * `0x184A`/`0x1848` (Prime Mini Wireless) under family
+ * `"prime-mini-wireless"` and deliberately does **not** register
+ * `0x1842`/`0x1840` (plain Prime Wireless) — even though this module's
+ * exported functions would encode identical bytes for either PID group, the
+ * plain Prime Wireless is out of scope for this change and is left for
+ * whichever future change actually verifies and ships it.
+ *
+ * ## No corroboration beyond rivalcfg was possible in this environment
+ *
+ * No local libratbag checkout was available, and OpenRGB's SteelSeries
+ * controller files were not reachable this pass — every command byte above
+ * is sourced from rivalcfg alone, same disclosure as `./aerox5-wireless.ts`.
+ * 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, LED color, sleep/dim timers, default
+ * lighting, and buttons 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` wired, `51 00`
+ * wireless) persists them to onboard flash. None of this has been verified
+ * on physical hardware by this project.
+ *
+ * ## Battery read
+ *
+ * `prime_wireless_wired.py` defines a `battery_level` block byte-identical
+ * in shape to `./aerox5-wireless.ts`'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, `- 1` because the raw byte is
+ * 1-indexed). Confirmed by reading `prime_wireless_wired.py` directly — this
+ * is **not** `./rival3-wireless.ts`'s `AA 01` / 3-byte-reply /
+ * plain-percentage-byte shape; do not conflate the two. In 2.4 GHz mode the
+ * query byte is `0x92 | 0x40 = 0xD2`, produced by `applyPrimeMiniWirelessFlag`.
+ */
+export declare const PRIME_MINI_WIRELESS_REPORT_ID = 0;
+/** Wired-cable-mode command bytes; OR `WIRELESS_FLAG` into byte 0 for 2.4 GHz mode. */
+export declare const PRIME_MINI_WIRELESS_COMMAND: {
+    readonly dpiPresets: readonly [45];
+    readonly pollingRate: readonly [43];
+    readonly color: readonly [33, 1, 0];
+    readonly buttonsMapping: readonly [42];
+    readonly sleepTimer: readonly [41];
+    readonly dimTimer: readonly [35, 15, 1, 0, 0];
+    readonly defaultLighting: readonly [39];
+    readonly batteryLevel: readonly [146];
+};
+/** `11 00` wired-mode / `51 00` 2.4 GHz-mode — see `applyPrimeMiniWirelessFlag`. */
+export declare const PRIME_MINI_WIRELESS_SAVE_COMMAND: readonly [17, 0];
+/**
+ * `_patch_command`: OR `0b01000000` into the command's first byte. Pass the
+ * wired-mode command bytes from `PRIME_MINI_WIRELESS_COMMAND` /
+ * `PRIME_MINI_WIRELESS_SAVE_COMMAND`; returns the 2.4 GHz-mode equivalent.
+ */
+export declare function applyPrimeMiniWirelessFlag(command: readonly number[]): number[];
+export declare const PRIME_MINI_WIRELESS_POLLING_RATES: readonly [125, 250, 500, 1000];
+export declare const PRIME_MINI_WIRELESS_DPI_MIN = 100;
+export declare const PRIME_MINI_WIRELESS_DPI_MAX = 18000;
+export declare const PRIME_MINI_WIRELESS_DPI_STEP = 100;
+export declare const PRIME_MINI_WIRELESS_MAX_DPI_PRESETS = 5;
+export declare const PRIME_MINI_WIRELESS_BATTERY_RESPONSE_LENGTH = 2;
+export declare class PrimeMiniWirelessProtocolError extends Error {
+}
+/** The 180 DPI values the shared TrueMove Air sensor table can express, ascending. */
+export declare function steelseriesPrimeMiniWirelessDpiOptions(): number[];
+/**
+ * `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 declare function steelseriesPrimeMiniWirelessEncodeDpiPresets(presets: readonly number[], selectedIndex: number, wireless: boolean): Uint8Array;
+/** `2B <v>` (`6B` wireless) with 1000→0x00, 500→0x01, 250→0x02, 125→0x03. */
+export declare function steelseriesPrimeMiniWirelessEncodePollingRate(pollingRateHz: number, wireless: boolean): Uint8Array;
+/**
+ * `21 01 00 <r> <g> <b>` (`61 01 00 …` wireless) — a fixed single-LED
+ * packet, no zone byte (this mouse has one LED, unlike the Aerox 5
+ * Wireless's zone-indexed color command).
+ */
+export declare function steelseriesPrimeMiniWirelessEncodeColor(r: number, g: number, b: number, wireless: boolean): Uint8Array;
+/**
+ * `29 <ms LE24>` (`69 …` wireless) — idle minutes before sleep, `0` disables.
+ * Encoded as `minutes * 60000` milliseconds, little-endian 3 bytes.
+ */
+export declare function steelseriesPrimeMiniWirelessEncodeSleepTimer(minutes: number, wireless: boolean): Uint8Array;
+/**
+ * `23 0F 01 00 00 <ms LE24>` (`63 …` wireless) — idle seconds before the LED
+ * dims, `0` disables. Encoded as `seconds * 1000` milliseconds,
+ * little-endian 3 bytes.
+ */
+export declare function steelseriesPrimeMiniWirelessEncodeDimTimer(seconds: number, wireless: boolean): Uint8Array;
+/** `off`/`rainbow` LED-at-startup choice. */
+export declare const PRIME_MINI_WIRELESS_DEFAULT_LIGHTING: {
+    readonly off: 0;
+    readonly rainbow: 1;
+};
+export type PrimeMiniWirelessDefaultLighting = keyof typeof PRIME_MINI_WIRELESS_DEFAULT_LIGHTING;
+/** `27 <v>` (`67 …` wireless) — what the mouse lights up as before a host ever connects. */
+export declare function steelseriesPrimeMiniWirelessEncodeDefaultLighting(mode: PrimeMiniWirelessDefaultLighting, wireless: boolean): Uint8Array;
+/** `11 00` wired-mode / `51 00` 2.4 GHz-mode — commit the current settings to onboard flash. */
+export declare function steelseriesPrimeMiniWirelessSaveCommand(wireless: boolean): Uint8Array;
+/** `92` wired-mode / `D2` 2.4 GHz-mode — the device answers with a two-byte input report. */
+export declare function steelseriesPrimeMiniWirelessBatteryQuery(wireless: boolean): Uint8Array;
+export interface PrimeMiniWirelessBattery {
+    /** `((data[1] & ~0x80) - 1) * 5` in rivalcfg — a coarse 0–100 scale in steps of 5. */
+    level: number;
+    /** `bool(data[1] & 0b10000000)` in rivalcfg. */
+    isCharging: boolean;
+}
+/**
+ * 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 declare function steelseriesPrimeMiniWirelessDecodeBattery(payload: Uint8Array): PrimeMiniWirelessBattery;
+/**
+ * `buttons_mapping.buttons` shared by `prime_wireless_wired.py` — same
+ * offsets/ids as the non-wireless `prime_mini.py`'s `buttons_mapping` block,
+ * confirmed by direct comparison of both device files, defined separately
+ * here so this family's button table stays self-contained.
+ */
+export declare const PRIME_MINI_WIRELESS_BUTTONS: {
+    readonly button1: {
+        readonly id: 1;
+        readonly offset: 0;
+    };
+    readonly button2: {
+        readonly id: 2;
+        readonly offset: 5;
+    };
+    readonly button3: {
+        readonly id: 3;
+        readonly offset: 10;
+    };
+    readonly button4: {
+        readonly id: 4;
+        readonly offset: 15;
+    };
+    readonly button5: {
+        readonly id: 5;
+        readonly offset: 20;
+    };
+    readonly button6: {
+        readonly id: 6;
+        readonly offset: 25;
+    };
+    readonly scrollUp: {
+        readonly id: 49;
+        readonly offset: 30;
+    };
+    readonly scrollDown: {
+        readonly id: 50;
+        readonly offset: 35;
+    };
+};
+export type PrimeMiniWirelessButtonName = keyof typeof PRIME_MINI_WIRELESS_BUTTONS;
+/**
+ * One button's target. `scrollUp`/`scrollDown` cannot be remap *targets*
+ * (`button_scroll_up`/`button_scroll_down` are `None` in the source) — only
+ * sources, same rule as `./aerox5-wireless.ts`.
+ */
+export type PrimeMiniWirelessButtonAction = {
+    type: "button";
+    target: Exclude<PrimeMiniWirelessButtonName, "scrollUp" | "scrollDown">;
+} | {
+    type: "disabled";
+} | {
+    type: "dpiSwitch";
+} | {
+    type: "keyboard";
+    code: number;
+} | {
+    type: "multimedia";
+    code: number;
+};
+/**
+ * `2A` (`6A` wireless) + 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 (rivalcfg instead fills in per-button defaults;
+ * this codec leaves that policy to the caller — pass every button
+ * explicitly for parity with rivalcfg's default profile).
+ */
+export declare function steelseriesPrimeMiniWirelessEncodeButtonsMapping(mapping: Partial<Record<PrimeMiniWirelessButtonName, PrimeMiniWirelessButtonAction>>, wireless: boolean): Uint8Array;
+//# sourceMappingURL=prime-mini-wireless.d.ts.map

package/dist/steelseries/prime-mini-wireless.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"prime-mini-wireless.d.ts","sourceRoot":"","sources":["../../src/steelseries/prime-mini-wireless.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAwGG;AAIH,eAAO,MAAM,6BAA6B,IAAO,CAAC;AAKlD,uFAAuF;AACvF,eAAO,MAAM,2BAA2B;;;;;;;;;CAS9B,CAAC;AAEX,oFAAoF;AACpF,eAAO,MAAM,gCAAgC,kBAAwB,CAAC;AAEtE;;;;GAIG;AACH,wBAAgB,0BAA0B,CAAC,OAAO,EAAE,SAAS,MAAM,EAAE,GAAG,MAAM,EAAE,CAK/E;AAED,eAAO,MAAM,iCAAiC,gCAAiC,CAAC;AAUhF,eAAO,MAAM,2BAA2B,MAAM,CAAC;AAC/C,eAAO,MAAM,2BAA2B,QAAQ,CAAC;AACjD,eAAO,MAAM,4BAA4B,MAAM,CAAC;AAChD,eAAO,MAAM,mCAAmC,IAAI,CAAC;AACrD,eAAO,MAAM,2CAA2C,IAAI,CAAC;AAI7D,qBAAa,8BAA+B,SAAQ,KAAK;CAAG;AAE5D,sFAAsF;AACtF,wBAAgB,sCAAsC,IAAI,MAAM,EAAE,CAEjE;AAED;;;;GAIG;AACH,wBAAgB,4CAA4C,CAC1D,OAAO,EAAE,SAAS,MAAM,EAAE,EAC1B,aAAa,EAAE,MAAM,EACrB,QAAQ,EAAE,OAAO,GAChB,UAAU,CAwBZ;AAED,6EAA6E;AAC7E,wBAAgB,6CAA6C,CAAC,aAAa,EAAE,MAAM,EAAE,QAAQ,EAAE,OAAO,GAAG,UAAU,CAWlH;AAED;;;;GAIG;AACH,wBAAgB,uCAAuC,CAAC,CAAC,EAAE,MAAM,EAAE,CAAC,EAAE,MAAM,EAAE,CAAC,EAAE,MAAM,EAAE,QAAQ,EAAE,OAAO,GAAG,UAAU,CAQtH;AAUD;;;GAGG;AACH,wBAAgB,4CAA4C,CAAC,OAAO,EAAE,MAAM,EAAE,QAAQ,EAAE,OAAO,GAAG,UAAU,CAM3G;AAED;;;;GAIG;AACH,wBAAgB,0CAA0C,CAAC,OAAO,EAAE,MAAM,EAAE,QAAQ,EAAE,OAAO,GAAG,UAAU,CAMzG;AAED,6CAA6C;AAC7C,eAAO,MAAM,oCAAoC;;;CAGvC,CAAC;AAEX,MAAM,MAAM,gCAAgC,GAAG,MAAM,OAAO,oCAAoC,CAAC;AAEjG,4FAA4F;AAC5F,wBAAgB,iDAAiD,CAC/D,IAAI,EAAE,gCAAgC,EACtC,QAAQ,EAAE,OAAO,GAChB,UAAU,CAWZ;AAED,gGAAgG;AAChG,wBAAgB,uCAAuC,CAAC,QAAQ,EAAE,OAAO,GAAG,UAAU,CAGrF;AAED,6FAA6F;AAC7F,wBAAgB,wCAAwC,CAAC,QAAQ,EAAE,OAAO,GAAG,UAAU,CAKtF;AAED,MAAM,WAAW,wBAAwB;IACvC,sFAAsF;IACtF,KAAK,EAAE,MAAM,CAAC;IACd,gDAAgD;IAChD,UAAU,EAAE,OAAO,CAAC;CACrB;AAED;;;;GAIG;AACH,wBAAgB,yCAAyC,CAAC,OAAO,EAAE,UAAU,GAAG,wBAAwB,CAUvG;AASD;;;;;GAKG;AACH,eAAO,MAAM,2BAA2B;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;CASwB,CAAC;AAEjE,MAAM,MAAM,2BAA2B,GAAG,MAAM,OAAO,2BAA2B,CAAC;AAQnF;;;;GAIG;AACH,MAAM,MAAM,6BAA6B,GACrC;IAAE,IAAI,EAAE,QAAQ,CAAC;IAAC,MAAM,EAAE,OAAO,CAAC,2BAA2B,EAAE,UAAU,GAAG,YAAY,CAAC,CAAA;CAAE,GAC3F;IAAE,IAAI,EAAE,UAAU,CAAA;CAAE,GACpB;IAAE,IAAI,EAAE,WAAW,CAAA;CAAE,GACrB;IAAE,IAAI,EAAE,UAAU,CAAC;IAAC,IAAI,EAAE,MAAM,CAAA;CAAE,GAClC;IAAE,IAAI,EAAE,YAAY,CAAC;IAAC,IAAI,EAAE,MAAM,CAAA;CAAE,CAAC;AAEzC;;;;;;GAMG;AACH,wBAAgB,gDAAgD,CAC9D,OAAO,EAAE,OAAO,CAAC,MAAM,CAAC,2BAA2B,EAAE,6BAA6B,CAAC,CAAC,EACpF,QAAQ,EAAE,OAAO,GAChB,UAAU,CAiDZ"}