@openmouse/protocol 0.1.0

package/dist/lamzu/atlantis.js

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

package/dist/lamzu/atlantis.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"atlantis.js","sourceRoot":"","sources":["../../src/lamzu/atlantis.ts"],"names":[],"mappings":"AAAA,OAAO,EACL,cAAc,EACd,2BAA2B,EAC3B,uBAAuB,EACvB,YAAY,EACZ,oBAAoB,GACrB,MAAM,oBAAoB,CAAC;AAE5B;;;;;;;;;;;;;;;;;;;;GAoBG;AAEH,MAAM,CAAC,MAAM,wBAAwB,GAAG,MAAM,CAAC;AAE/C,gFAAgF;AAChF,MAAM,CAAC,MAAM,yBAAyB,GAAG,MAAM,CAAC;AAChD,MAAM,CAAC,MAAM,oBAAoB,GAAG,IAAI,CAAC;AAEzC,8EAA8E;AAC9E,MAAM,CAAC,MAAM,wBAAwB,GAAG,uBAAuB,CAAC;AAChE,MAAM,CAAC,MAAM,4BAA4B,GAAG,2BAA2B,CAAC;AACxE,MAAM,CAAC,MAAM,6BAA6B,GAAG,CAAC,CAAC;AAC/C,MAAM,CAAC,MAAM,0BAA0B,GAAG,EAAE,CAAC;AAE7C;;;;;;;;;;GAUG;AACH,MAAM,CAAC,MAAM,sBAAsB,GAAG,cAAc,CAAC;AAErD;;;;;GAKG;AACH,MAAM,CAAC,MAAM,mCAAmC,GAAG,IAAI,CAAC;AAExD;;;;;;;;;GASG;AACH,MAAM,CAAC,MAAM,oBAAoB,GAAG;IAClC,GAAG,YAAY;IACf,aAAa,EAAE,CAAC;IAChB,cAAc,EAAE,EAAE;IAClB,aAAa,EAAE,EAAE;IACjB,eAAe,EAAE,GAAG;CACZ,CAAC;AAEX,MAAM,CAAC,MAAM,2BAA2B,GAAG,CAAC,CAAC;AAC7C,MAAM,CAAC,MAAM,6BAA6B,GAAG,CAAC,CAAC;AAE/C;;;;GAIG;AACH,MAAM,CAAC,MAAM,4BAA4B,GAAG,CAAC,CAAC;AAE9C,4EAA4E;AAC5E,MAAM,CAAC,MAAM,uBAAuB,GAAG,EAAE,CAAC;AAC1C,MAAM,CAAC,MAAM,sBAAsB,GAAG,EAAE,CAAC;AACzC,MAAM,CAAC,MAAM,sBAAsB,GAAG,KAAK,CAAC;AAE5C;;;GAGG;AACH,MAAM,CAAC,MAAM,iCAAiC,GAAG,EAAE,CAAC;AACpD,MAAM,CAAC,MAAM,gCAAgC,GAAG,IAAI,GAAG,iCAAiC,CAAC;AAEzF,kEAAkE;AAClE,MAAM,CAAC,MAAM,4BAA4B,GAAG,CAAC,EAAE,EAAE,EAAE,EAAE,EAAE,EAAE,GAAG,EAAE,GAAG,EAAE,IAAI,CAAU,CAAC;AAmBlF,MAAM,WAAW,GAAG,CAAC,GAAG,EAAE,GAAG,EAAE,GAAG,EAAE,IAAI,CAAU,CAAC;AACnD,MAAM,QAAQ,GAAG,CAAC,GAAG,EAAE,IAAI,EAAE,IAAI,EAAE,IAAI,CAAU,CAAC;AAElD;;;;;;;;;;;;;GAaG;AACH,MAAM,CAAC,MAAM,uBAAuB,GAA8C,IAAI,GAAG,CAAC;IACxF,CAAC,MAAM,EAAE,EAAE,KAAK,EAAE,UAAU,EAAE,QAAQ,EAAE,KAAK,EAAE,YAAY,EAAE,WAAW,EAAE,UAAU,EAAE,OAAO,EAAE,QAAQ,EAAE,IAAI,EAAE,CAAC;IAChH,CAAC,MAAM,EAAE,EAAE,KAAK,EAAE,UAAU,EAAE,QAAQ,EAAE,IAAI,EAAE,YAAY,EAAE,WAAW,EAAE,UAAU,EAAE,OAAO,EAAE,QAAQ,EAAE,KAAK,EAAE,CAAC;IAChH,CAAC,MAAM,EAAE,EAAE,KAAK,EAAE,UAAU,EAAE,QAAQ,EAAE,IAAI,EAAE,YAAY,EAAE,QAAQ,EAAE,UAAU,EAAE,UAAU,EAAE,QAAQ,EAAE,KAAK,EAAE,CAAC;IAChH,CAAC,MAAM,EAAE,EAAE,KAAK,EAAE,UAAU,EAAE,QAAQ,EAAE,IAAI,EAAE,YAAY,EAAE,QAAQ,EAAE,UAAU,EAAE,UAAU,EAAE,QAAQ,EAAE,KAAK,EAAE,CAAC;CACjH,CAAC,CAAC;AAEH;;;;;;;;;;GAUG;AACH,MAAM,CAAC,MAAM,4BAA4B,GAAG;IAC1C,CAAC,IAAI,EAAE,GAAG,CAAC,EAAE,CAAC,IAAI,EAAE,GAAG,CAAC,EAAE,CAAC,IAAI,EAAE,GAAG,CAAC,EAAE,CAAC,IAAI,EAAE,IAAI,CAAC;IACnD,CAAC,IAAI,EAAE,IAAI,CAAC,EAAE,CAAC,IAAI,EAAE,IAAI,CAAC,EAAE,CAAC,IAAI,EAAE,IAAI,CAAC,EAAE,CAAC,IAAI,EAAE,IAAI,CAAC;CAC9C,CAAC;AAIX;;;;GAIG;AACH,MAAM,CAAC,MAAM,iCAAiC,GAAG;IAC/C,CAAC,IAAI,EAAE,KAAK,CAAC,EAAE,CAAC,IAAI,EAAE,QAAQ,CAAC;CACkD,CAAC;AAsBpF;;;;GAIG;AACH,MAAM,UAAU,0BAA0B,CAAC,IAA0B;IACnE,MAAM,OAAO,GAAG,IAAI,CAAC,OAAO,IAAI,EAAE,CAAC;IACnC,IAAI,OAAO,CAAC,MAAM,GAAG,0BAA0B,EAAE,CAAC;QAChD,MAAM,IAAI,KAAK,CAAC,0CAA0C,0BAA0B,iBAAiB,CAAC,CAAC;IACzG,CAAC;IACD,MAAM,OAAO,GAAG,IAAI,CAAC,OAAO,IAAI,CAAC,CAAC;IAClC,MAAM,MAAM,GAAG,IAAI,UAAU,CAAC,4BAA4B,CAAC,CAAC;IAC5D,MAAM,CAAC,CAAC,CAAC,GAAG,IAAI,CAAC,OAAO,CAAC;IACzB,MAAM,CAAC,CAAC,CAAC,GAAG,CAAC,OAAO,IAAI,CAAC,CAAC,GAAG,IAAI,CAAC;IAClC,MAAM,CAAC,CAAC,CAAC,GAAG,OAAO,GAAG,IAAI,CAAC;IAC3B,MAAM,CAAC,CAAC,CAAC,GAAG,OAAO,CAAC,MAAM,CAAC;IAC3B,MAAM,CAAC,GAAG,CAAC,OAAO,EAAE,6BAA6B,CAAC,CAAC;IACnD,MAAM,CAAC,4BAA4B,GAAG,CAAC,CAAC,GAAG,oBAAoB,CAAC,MAAM,CAAC,CAAC;IACxE,OAAO,MAAM,CAAC;AAChB,CAAC;AAED;;;;;GAKG;AACH,MAAM,UAAU,wBAAwB,CAAC,IAAgB;IACvD,IAAI,IAAI,CAAC,MAAM,GAAG,4BAA4B;QAAE,OAAO,IAAI,CAAC;IAC5D,MAAM,MAAM,GAAG,IAAI,CAAC,QAAQ,CAAC,CAAC,EAAE,4BAA4B,CAAC,CAAC;IAC9D,IAAI,oBAAoB,CAAC,MAAM,CAAC,KAAK,MAAM,CAAC,4BAA4B,GAAG,CAAC,CAAC;QAAE,OAAO,IAAI,CAAC;IAC3F,OAAO;QACL,OAAO,EAAE,MAAM,CAAC,CAAC,CAAC,IAAI,CAAC;QACvB,KAAK,EAAE,MAAM,CAAC,CAAC,CAAC,IAAI,CAAC;QACrB,OAAO,EAAE,CAAC,CAAC,MAAM,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,IAAI,CAAC,CAAC,GAAG,CAAC,MAAM,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC;QACnD,OAAO,EAAE,MAAM,CAAC,KAAK,CACnB,6BAA6B,EAC7B,6BAA6B,GAAG,0BAA0B,CAC3D;QACD,cAAc,EAAE,IAAI,CAAC,GAAG,CAAC,MAAM,CAAC,CAAC,CAAC,IAAI,CAAC,EAAE,0BAA0B,CAAC;KACrE,CAAC;AACJ,CAAC;AAED;;;GAGG;AACH,MAAM,UAAU,0BAA0B,CAAC,KAAiB;IAC1D,IAAI,GAAG,GAAG,CAAC,CAAC;IACZ,KAAK,MAAM,IAAI,IAAI,KAAK;QAAE,GAAG,GAAG,CAAC,GAAG,GAAG,IAAI,CAAC,GAAG,IAAI,CAAC;IACpD,OAAO,GAAG,KAAK,IAAI,CAAC;AACtB,CAAC;AAED,kEAAkE;AAClE,MAAM,UAAU,sBAAsB,CAAC,MAAyB;IAC9D,IAAI,GAAG,GAAG,CAAC,CAAC;IACZ,KAAK,MAAM,KAAK,IAAI,MAAM;QAAE,GAAG,GAAG,CAAC,GAAG,GAAG,KAAK,CAAC,GAAG,IAAI,CAAC;IACvD,OAAO,CAAC,GAAG,MAAM,EAAE,CAAC,IAAI,GAAG,GAAG,CAAC,GAAG,IAAI,CAAC,CAAC;AAC1C,CAAC;AAOD;;;;;;;;;GASG;AACH,MAAM,UAAU,2BAA2B,CAAC,KAAiB;IAC3D,IAAI,KAAK,CAAC,MAAM,GAAG,2BAA2B,IAAI,CAAC,0BAA0B,CAAC,KAAK,CAAC;QAAE,OAAO,IAAI,CAAC;IAClG,MAAM,KAAK,GAAG,KAAK,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC;IAC5B,MAAM,IAAI,GAAG,CAAC,GAAW,EAAE,IAAY,EAAE,EAAE,CAAC,CAAC,CAAC,CAAC,IAAI,GAAG,IAAI,CAAC,IAAI,CAAC,CAAC,GAAG,GAAG,GAAG,CAAC,CAAC,GAAG,uBAAuB,CAAC;IACvG,OAAO;QACL,CAAC,EAAE,IAAI,CAAC,KAAK,CAAC,CAAC,CAAC,IAAI,CAAC,EAAE,KAAK,IAAI,CAAC,CAAC;QAClC,CAAC,EAAE,IAAI,CAAC,KAAK,CAAC,CAAC,CAAC,IAAI,CAAC,EAAE,KAAK,IAAI,CAAC,CAAC;KACnC,CAAC;AACJ,CAAC;AAED,MAAM,UAAU,8BAA8B,CAAC,GAAW;IACxD,OAAO,4BAA4B,CAAC,IAAI,CAAC,CAAC,CAAC,OAAO,CAAC,EAAE,EAAE,CAAC,OAAO,KAAK,GAAG,CAAC,EAAE,CAAC,CAAC,CAAC,IAAI,IAAI,CAAC;AACxF,CAAC;AAED;;;GAGG;AACH,MAAM,UAAU,8BAA8B,CAC5C,KAAa,EACb,MAA+B;IAE/B,MAAM,UAAU,GAAG,4BAA4B,CAAC,MAAM,CAAC,CAAC,CAAC,EAAE,IAAI,CAAC,EAAE,EAAE,CAAC,IAAI,KAAK,KAAK,CAAC,CAAC;IACrF,IAAI,UAAU,CAAC,MAAM,KAAK,CAAC;QAAE,OAAO,IAAI,CAAC;IACzC,MAAM,SAAS,GAAG,MAAM,KAAK,UAAU;QACrC,CAAC,CAAC,UAAU,CAAC,IAAI,CAAC,CAAC,CAAC,OAAO,CAAC,EAAE,EAAE,CAAC,OAAO,IAAI,IAAI,CAAC;QACjD,CAAC,CAAC,UAAU,CAAC,IAAI,CAAC,CAAC,CAAC,OAAO,CAAC,EAAE,EAAE,CAAC,OAAO,IAAI,IAAI,CAAC,CAAC;IACpD,OAAO,CAAC,SAAS,IAAI,UAAU,CAAC,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,IAAI,IAAI,CAAC;AACnD,CAAC;AAED,MAAM,UAAU,kCAAkC,CAAC,GAAW;IAC5D,OAAO,iCAAiC,CAAC,IAAI,CAAC,CAAC,CAAC,OAAO,CAAC,EAAE,EAAE,CAAC,OAAO,KAAK,GAAG,CAAC,EAAE,CAAC,CAAC,CAAC,IAAI,IAAI,CAAC;AAC7F,CAAC;AAED,MAAM,UAAU,kCAAkC,CAAC,KAAa;IAC9D,OAAO,iCAAiC,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,IAAI,CAAC,EAAE,EAAE,CAAC,IAAI,KAAK,KAAK,CAAC,EAAE,CAAC,CAAC,CAAC,IAAI,IAAI,CAAC;AAC3F,CAAC;AAQD;;;;;;;;GAQG;AACH,MAAM,UAAU,0BAA0B,CAAC,OAAmB;IAC5D,IAAI,OAAO,CAAC,MAAM,GAAG,CAAC;QAAE,OAAO,EAAE,OAAO,EAAE,IAAI,EAAE,UAAU,EAAE,IAAI,EAAE,QAAQ,EAAE,KAAK,EAAE,CAAC;IACpF,MAAM,OAAO,GAAG,OAAO,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC;IAChC,MAAM,UAAU,GAAG,CAAC,CAAC,OAAO,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,IAAI,CAAC,CAAC,GAAG,CAAC,OAAO,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC;IAChE,OAAO;QACL,OAAO,EAAE,OAAO,IAAI,GAAG,CAAC,CAAC,CAAC,OAAO,CAAC,CAAC,CAAC,IAAI;QACxC,UAAU,EAAE,UAAU,GAAG,CAAC,CAAC,CAAC,CAAC,UAAU,CAAC,CAAC,CAAC,IAAI;QAC9C,QAAQ,EAAE,CAAC,OAAO,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,KAAK,CAAC;KAClC,CAAC;AACJ,CAAC;AAED,2EAA2E;AAC3E,MAAM,UAAU,2BAA2B,CAAC,KAAa,EAAE,OAAmB;IAC5E,IAAI,OAAO,CAAC,MAAM,GAAG,CAAC;QAAE,OAAO,IAAI,CAAC;IACpC,OAAO,GAAG,KAAK,KAAK,OAAO,CAAC,CAAC,CAAC,IAAI,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,QAAQ,CAAC,EAAE,CAAC,CAAC,QAAQ,CAAC,CAAC,EAAE,GAAG,CAAC,EAAE,CAAC;AAC3F,CAAC;AAED,MAAM,UAAU,oBAAoB,CAAC,QAAgB,EAAE,SAAiB;IACtE,IAAI,QAAQ,KAAK,wBAAwB;QAAE,OAAO,SAAS,CAAC;IAC5D,OAAO,uBAAuB,CAAC,GAAG,CAAC,SAAS,CAAC,CAAC;AAChD,CAAC"}

package/dist/lamzu/index.d.ts

@@ -0,0 +1,60 @@
+export * from "../compx/codec.js";
+export * from "./atlantis.js";
+export interface LamzuProduct {
+    model: string;
+    wireless: boolean;
+    pollingRates: readonly number[];
+    brand?: "Lamzu" | "CRDRAKO" | "Attack Shark";
+    uiFamily?: string;
+    mouseTarget?: number;
+    maxDpi?: number;
+    sleepOptions?: readonly number[];
+}
+export declare const LAMZU_VENDOR_ID = 14142;
+export declare const CRDRAKO_PRODUCT_IDS: readonly [106, 107];
+export declare const ATTACKSHARK_PRODUCT_IDS: readonly [70, 71];
+export declare const LAMZU_PRODUCTS: ReadonlyMap<number, LamzuProduct>;
+/**
+ * Lamzu's own vendor id, introduced with the Inca 8K. Every earlier Lamzu
+ * model enumerates under the shared CompX ODM id 0x373e above, which CRDRAKO
+ * and Attack Shark also use, so the two catalogs are kept apart: the same
+ * product id means different hardware depending on which vendor id it arrived
+ * under. The Inca answers the identical CompX framing, so only the lookup
+ * needed splitting, not the protocol.
+ */
+export declare const LAMZU_INCA_VENDOR_ID = 14256;
+export declare const LAMZU_VENDOR_IDS: readonly number[];
+/**
+ * Products under Lamzu's own vendor id. 0x0009 (the mouse on its cable) and
+ * 0x0010 (the 8K receiver) are confirmed on hardware — see
+ * docs/lamzu-inca-testing.md. Both answer the mouse on target 0x02, so neither
+ * needs a `mouseTarget` override.
+ *
+ * The rate split shows up in the capture itself: LAMZU_POLLING_RATES encodes
+ * 1000 Hz twice, 0x01 in the 125/250/500/1000 family and 0x10 in the
+ * 1000/2000/4000/8000 family, and the cable answered 0x01 where the 8K
+ * receiver answered 0x40. Lamzu's Aurora configurator agrees — its device
+ * table gives the Inca `PollingRateWired` 125-1000 and `_8KDonglePollingRate`
+ * 500-8000 — and its `DPIMax` of 30000 is already the driver default, so no
+ * `maxDpi` override is needed.
+ *
+ * 0x000f is the 1K receiver the Inca can also ship with. It is taken from that
+ * same Aurora table (`_1KDongle` 000F, `_1KDonglePollingRate` 125-1000) and
+ * has NOT been exercised on hardware; the protocol is the receiver protocol
+ * either way, so the risk is a wrong rate list rather than a dead device.
+ *
+ * Deliberately absent: 0x000a and 0x0002, which Aurora lists as
+ * `DeviceBLPID` and `Receiver4K8KBLPID` — the DFU bootloader identities the
+ * mouse and dongle take while flashing firmware. They never speak this
+ * protocol and must not be offered in the picker.
+ */
+export declare const LAMZU_INCA_PRODUCTS: ReadonlyMap<number, LamzuProduct>;
+/**
+ * Resolves a product against the catalog its vendor id belongs to. A vendor id
+ * this brand does not use resolves to nothing rather than falling through to
+ * the 0x373e catalog, so the same product id under a foreign vendor id is never
+ * mistaken for a Lamzu.
+ */
+export declare function lamzuProduct(vendorId: number, productId: number): LamzuProduct | undefined;
+export declare const LAMZU_POLLING_RATES: readonly [readonly [8, 125], readonly [4, 250], readonly [2, 500], readonly [1, 1000], readonly [16, 1000], readonly [32, 2000], readonly [64, 4000], readonly [128, 8000]];
+//# sourceMappingURL=index.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/lamzu/index.ts"],"names":[],"mappings":"AAAA,cAAc,mBAAmB,CAAC;AAClC,cAAc,eAAe,CAAC;AAC9B,MAAM,WAAW,YAAY;IAC3B,KAAK,EAAE,MAAM,CAAC;IACd,QAAQ,EAAE,OAAO,CAAC;IAClB,YAAY,EAAE,SAAS,MAAM,EAAE,CAAC;IAChC,KAAK,CAAC,EAAE,OAAO,GAAG,SAAS,GAAG,cAAc,CAAC;IAC7C,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,YAAY,CAAC,EAAE,SAAS,MAAM,EAAE,CAAC;CAClC;AACD,eAAO,MAAM,eAAe,QAAS,CAAC;AAItC,eAAO,MAAM,mBAAmB,qBAA4B,CAAC;AAC7D,eAAO,MAAM,uBAAuB,mBAA4B,CAAC;AACjE,eAAO,MAAM,cAAc,EAAE,WAAW,CAAC,MAAM,EAAE,YAAY,CAoB3D,CAAC;AACH;;;;;;;GAOG;AACH,eAAO,MAAM,oBAAoB,QAAS,CAAC;AAE3C,eAAO,MAAM,gBAAgB,EAAE,SAAS,MAAM,EAA4C,CAAC;AAE3F;;;;;;;;;;;;;;;;;;;;;;;GAuBG;AACH,eAAO,MAAM,mBAAmB,EAAE,WAAW,CAAC,MAAM,EAAE,YAAY,CAIhE,CAAC;AAEH;;;;;GAKG;AACH,wBAAgB,YAAY,CAAC,QAAQ,EAAE,MAAM,EAAE,SAAS,EAAE,MAAM,GAAG,YAAY,GAAG,SAAS,CAI1F;AAED,eAAO,MAAM,mBAAmB,6KAGtB,CAAC"}

package/dist/lamzu/index.js

@@ -0,0 +1,86 @@
+export * from "../compx/codec.js";
+export * from "./atlantis.js";
+export const LAMZU_VENDOR_ID = 0x373e;
+const RATES_1K = [125, 250, 500, 1000];
+const RATES_8K = [500, 1000, 2000, 4000, 8000];
+const RATES_8K_FULL = [125, 250, 500, 1000, 2000, 4000, 8000];
+export const CRDRAKO_PRODUCT_IDS = [0x006a, 0x006b];
+export const ATTACKSHARK_PRODUCT_IDS = [0x0046, 0x0047];
+export const LAMZU_PRODUCTS = new Map([
+    [0x001c, { model: "Maya X", wireless: false, pollingRates: RATES_1K }],
+    [0x001d, { model: "Maya X", wireless: true, pollingRates: RATES_1K }],
+    [0x001e, { model: "Maya X", wireless: true, pollingRates: RATES_8K }],
+    [0x006a, {
+            brand: "CRDRAKO", model: "KO-ONE", wireless: false,
+            pollingRates: RATES_8K_FULL, mouseTarget: 0x00, uiFamily: "crdrako",
+        }],
+    [0x006b, {
+            brand: "CRDRAKO", model: "KO-ONE", wireless: true,
+            pollingRates: RATES_8K_FULL, mouseTarget: 0x02, uiFamily: "crdrako",
+        }],
+    [0x0046, {
+            brand: "Attack Shark", model: "R5 Ultra", wireless: false,
+            pollingRates: RATES_1K, maxDpi: 42000, uiFamily: "attack-shark",
+        }],
+    [0x0047, {
+            brand: "Attack Shark", model: "R5 Ultra", wireless: true,
+            pollingRates: RATES_8K, maxDpi: 42000, uiFamily: "attack-shark",
+        }],
+]);
+/**
+ * Lamzu's own vendor id, introduced with the Inca 8K. Every earlier Lamzu
+ * model enumerates under the shared CompX ODM id 0x373e above, which CRDRAKO
+ * and Attack Shark also use, so the two catalogs are kept apart: the same
+ * product id means different hardware depending on which vendor id it arrived
+ * under. The Inca answers the identical CompX framing, so only the lookup
+ * needed splitting, not the protocol.
+ */
+export const LAMZU_INCA_VENDOR_ID = 0x37b0;
+export const LAMZU_VENDOR_IDS = [LAMZU_VENDOR_ID, LAMZU_INCA_VENDOR_ID];
+/**
+ * Products under Lamzu's own vendor id. 0x0009 (the mouse on its cable) and
+ * 0x0010 (the 8K receiver) are confirmed on hardware — see
+ * docs/lamzu-inca-testing.md. Both answer the mouse on target 0x02, so neither
+ * needs a `mouseTarget` override.
+ *
+ * The rate split shows up in the capture itself: LAMZU_POLLING_RATES encodes
+ * 1000 Hz twice, 0x01 in the 125/250/500/1000 family and 0x10 in the
+ * 1000/2000/4000/8000 family, and the cable answered 0x01 where the 8K
+ * receiver answered 0x40. Lamzu's Aurora configurator agrees — its device
+ * table gives the Inca `PollingRateWired` 125-1000 and `_8KDonglePollingRate`
+ * 500-8000 — and its `DPIMax` of 30000 is already the driver default, so no
+ * `maxDpi` override is needed.
+ *
+ * 0x000f is the 1K receiver the Inca can also ship with. It is taken from that
+ * same Aurora table (`_1KDongle` 000F, `_1KDonglePollingRate` 125-1000) and
+ * has NOT been exercised on hardware; the protocol is the receiver protocol
+ * either way, so the risk is a wrong rate list rather than a dead device.
+ *
+ * Deliberately absent: 0x000a and 0x0002, which Aurora lists as
+ * `DeviceBLPID` and `Receiver4K8KBLPID` — the DFU bootloader identities the
+ * mouse and dongle take while flashing firmware. They never speak this
+ * protocol and must not be offered in the picker.
+ */
+export const LAMZU_INCA_PRODUCTS = new Map([
+    [0x0009, { model: "Inca 8K", wireless: false, pollingRates: RATES_1K }],
+    [0x000f, { model: "Inca 8K", wireless: true, pollingRates: RATES_1K }],
+    [0x0010, { model: "Inca 8K", wireless: true, pollingRates: RATES_8K }],
+]);
+/**
+ * Resolves a product against the catalog its vendor id belongs to. A vendor id
+ * this brand does not use resolves to nothing rather than falling through to
+ * the 0x373e catalog, so the same product id under a foreign vendor id is never
+ * mistaken for a Lamzu.
+ */
+export function lamzuProduct(vendorId, productId) {
+    if (vendorId === LAMZU_INCA_VENDOR_ID)
+        return LAMZU_INCA_PRODUCTS.get(productId);
+    if (vendorId === LAMZU_VENDOR_ID)
+        return LAMZU_PRODUCTS.get(productId);
+    return undefined;
+}
+export const LAMZU_POLLING_RATES = [
+    [0x08, 125], [0x04, 250], [0x02, 500], [0x01, 1000],
+    [0x10, 1000], [0x20, 2000], [0x40, 4000], [0x80, 8000],
+];
+//# sourceMappingURL=index.js.map

package/dist/lamzu/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/lamzu/index.ts"],"names":[],"mappings":"AAAA,cAAc,mBAAmB,CAAC;AAClC,cAAc,eAAe,CAAC;AAW9B,MAAM,CAAC,MAAM,eAAe,GAAG,MAAM,CAAC;AACtC,MAAM,QAAQ,GAAG,CAAC,GAAG,EAAE,GAAG,EAAE,GAAG,EAAE,IAAI,CAAU,CAAC;AAChD,MAAM,QAAQ,GAAG,CAAC,GAAG,EAAE,IAAI,EAAE,IAAI,EAAE,IAAI,EAAE,IAAI,CAAU,CAAC;AACxD,MAAM,aAAa,GAAG,CAAC,GAAG,EAAE,GAAG,EAAE,GAAG,EAAE,IAAI,EAAE,IAAI,EAAE,IAAI,EAAE,IAAI,CAAU,CAAC;AACvE,MAAM,CAAC,MAAM,mBAAmB,GAAG,CAAC,MAAM,EAAE,MAAM,CAAU,CAAC;AAC7D,MAAM,CAAC,MAAM,uBAAuB,GAAG,CAAC,MAAM,EAAE,MAAM,CAAU,CAAC;AACjE,MAAM,CAAC,MAAM,cAAc,GAAsC,IAAI,GAAG,CAAC;IACvE,CAAC,MAAM,EAAE,EAAE,KAAK,EAAE,QAAQ,EAAE,QAAQ,EAAE,KAAK,EAAE,YAAY,EAAE,QAAQ,EAAE,CAAC;IACtE,CAAC,MAAM,EAAE,EAAE,KAAK,EAAE,QAAQ,EAAE,QAAQ,EAAE,IAAI,EAAE,YAAY,EAAE,QAAQ,EAAE,CAAC;IACrE,CAAC,MAAM,EAAE,EAAE,KAAK,EAAE,QAAQ,EAAE,QAAQ,EAAE,IAAI,EAAE,YAAY,EAAE,QAAQ,EAAE,CAAC;IACrE,CAAC,MAAM,EAAE;YACP,KAAK,EAAE,SAAS,EAAE,KAAK,EAAE,QAAQ,EAAE,QAAQ,EAAE,KAAK;YAClD,YAAY,EAAE,aAAa,EAAE,WAAW,EAAE,IAAI,EAAE,QAAQ,EAAE,SAAS;SACpE,CAAC;IACF,CAAC,MAAM,EAAE;YACP,KAAK,EAAE,SAAS,EAAE,KAAK,EAAE,QAAQ,EAAE,QAAQ,EAAE,IAAI;YACjD,YAAY,EAAE,aAAa,EAAE,WAAW,EAAE,IAAI,EAAE,QAAQ,EAAE,SAAS;SACpE,CAAC;IACF,CAAC,MAAM,EAAE;YACP,KAAK,EAAE,cAAc,EAAE,KAAK,EAAE,UAAU,EAAE,QAAQ,EAAE,KAAK;YACzD,YAAY,EAAE,QAAQ,EAAE,MAAM,EAAE,KAAK,EAAE,QAAQ,EAAE,cAAc;SAChE,CAAC;IACF,CAAC,MAAM,EAAE;YACP,KAAK,EAAE,cAAc,EAAE,KAAK,EAAE,UAAU,EAAE,QAAQ,EAAE,IAAI;YACxD,YAAY,EAAE,QAAQ,EAAE,MAAM,EAAE,KAAK,EAAE,QAAQ,EAAE,cAAc;SAChE,CAAC;CACH,CAAC,CAAC;AACH;;;;;;;GAOG;AACH,MAAM,CAAC,MAAM,oBAAoB,GAAG,MAAM,CAAC;AAE3C,MAAM,CAAC,MAAM,gBAAgB,GAAsB,CAAC,eAAe,EAAE,oBAAoB,CAAC,CAAC;AAE3F;;;;;;;;;;;;;;;;;;;;;;;GAuBG;AACH,MAAM,CAAC,MAAM,mBAAmB,GAAsC,IAAI,GAAG,CAAC;IAC5E,CAAC,MAAM,EAAE,EAAE,KAAK,EAAE,SAAS,EAAE,QAAQ,EAAE,KAAK,EAAE,YAAY,EAAE,QAAQ,EAAE,CAAC;IACvE,CAAC,MAAM,EAAE,EAAE,KAAK,EAAE,SAAS,EAAE,QAAQ,EAAE,IAAI,EAAE,YAAY,EAAE,QAAQ,EAAE,CAAC;IACtE,CAAC,MAAM,EAAE,EAAE,KAAK,EAAE,SAAS,EAAE,QAAQ,EAAE,IAAI,EAAE,YAAY,EAAE,QAAQ,EAAE,CAAC;CACvE,CAAC,CAAC;AAEH;;;;;GAKG;AACH,MAAM,UAAU,YAAY,CAAC,QAAgB,EAAE,SAAiB;IAC9D,IAAI,QAAQ,KAAK,oBAAoB;QAAE,OAAO,mBAAmB,CAAC,GAAG,CAAC,SAAS,CAAC,CAAC;IACjF,IAAI,QAAQ,KAAK,eAAe;QAAE,OAAO,cAAc,CAAC,GAAG,CAAC,SAAS,CAAC,CAAC;IACvE,OAAO,SAAS,CAAC;AACnB,CAAC;AAED,MAAM,CAAC,MAAM,mBAAmB,GAAG;IACjC,CAAC,IAAI,EAAE,GAAG,CAAC,EAAE,CAAC,IAAI,EAAE,GAAG,CAAC,EAAE,CAAC,IAAI,EAAE,GAAG,CAAC,EAAE,CAAC,IAAI,EAAE,IAAI,CAAC;IACnD,CAAC,IAAI,EAAE,IAAI,CAAC,EAAE,CAAC,IAAI,EAAE,IAAI,CAAC,EAAE,CAAC,IAAI,EAAE,IAAI,CAAC,EAAE,CAAC,IAAI,EAAE,IAAI,CAAC;CAC9C,CAAC"}

package/dist/logitech/controls.d.ts

@@ -0,0 +1,138 @@
+/**
+ * Feature 0x1B04 (REPROG CONTROLS V4) — which buttons a device has, what each
+ * one currently does, and which of them may be pointed at another.
+ *
+ * Read from an MX Master 4 (WPID B042) over a Logi Bolt receiver, which
+ * reports nine controls at version 6. Control and task names follow Solaar's
+ * special_keys tables; the ids this device actually reports were confirmed
+ * against it, and the rest are carried from that list unverified.
+ *
+ * The device decides what is legal here, not this code. Every control carries
+ * a group and a mask of the groups it accepts, and the primary buttons report
+ * a mask of zero — so firmware, not a rule invented here, is what refuses to
+ * let left click be moved.
+ */
+export declare const LOGITECH_REPROG_CONTROLS: {
+    /** getCount: [count]. */
+    readonly count: 0;
+    /** getControlIdInfo(index): [cid(2), tid(2), flags, pos, group, gmask, ...]. */
+    readonly info: 16;
+    /** getControlIdReporting(cid): [cid(2), flagsLow, remap(2), flagsHigh]. */
+    readonly reporting: 32;
+    /** setControlIdReporting(cid, flags, remap(2)). */
+    readonly setReporting: 48;
+};
+/** Control ids — the physical (or virtual) buttons a device exposes. */
+export declare const LOGITECH_CONTROL_NAMES: Readonly<Record<number, string>>;
+/** Native task each control performs when it is neither remapped nor diverted. */
+export declare const LOGITECH_TASK_NAMES: Readonly<Record<number, string>>;
+/**
+ * Bits of the flags byte from getControlIdInfo. Confirmed against an
+ * MX Master 4: left click reports 0x01 (a plain mouse button, not
+ * reprogrammable), the gesture button 0x31, and the virtual gesture button
+ * 0xA0 — virtual and divertable, but not a physical key.
+ */
+export declare const LOGITECH_KEY_FLAG: {
+    readonly mouseButton: 1;
+    readonly fkey: 2;
+    readonly hotkey: 4;
+    readonly fnToggle: 8;
+    readonly reprogrammable: 16;
+    readonly divertable: 32;
+    readonly persistentlyDivertable: 64;
+    readonly virtual: 128;
+};
+/**
+ * Bits of the mapping flags from getControlIdReporting, which is one 16-bit
+ * field split across two non-adjacent payload bytes — low at [2], high at [5],
+ * with the remap target wedged between them.
+ */
+export declare const LOGITECH_MAPPING_FLAG: {
+    readonly diverted: 1;
+    readonly persistentlyDiverted: 4;
+    readonly rawXy: 16;
+    readonly forceRawXy: 64;
+    readonly analyticsKeyEvents: 256;
+    readonly rawWheel: 1024;
+};
+export interface LogitechControlInfo {
+    controlId: number;
+    taskId: number;
+    /** The getControlIdInfo capability flags — LOGITECH_KEY_FLAG bits. */
+    flags: number;
+    /** Group this control belongs to when it is used as a remap target. */
+    group: number;
+    /** Bitmask of the groups this control may be remapped into. */
+    groupMask: number;
+}
+export interface LogitechControlReporting {
+    controlId: number;
+    /**
+     * The 16-bit mapping field, reassembled from its two payload bytes.
+     * Named apart from LogitechControlInfo.flags on purpose: the two are
+     * different fields, and a control merges both, so a shared name would have
+     * one silently overwrite the other.
+     */
+    mappingFlags: number;
+    /** Control id this button currently acts as. */
+    mappedTo: number;
+    /** Another application is consuming this button's events. */
+    diverted: boolean;
+}
+export interface LogitechReprogrammableControl extends LogitechControlInfo, LogitechControlReporting {
+    name: string;
+    taskName: string;
+    reprogrammable: boolean;
+    /** A software-side control, not a physical button anyone can press. */
+    virtual: boolean;
+    /** Control ids this button may legally be remapped to. */
+    remappableTo: number[];
+}
+export declare const logitechControlName: (controlId: number) => string;
+export declare const logitechTaskName: (taskId: number) => string;
+/** Decodes the getControlIdInfo payload (function 0x10). */
+export declare function decodeControlInfo(payload: Uint8Array | readonly number[]): LogitechControlInfo | null;
+/**
+ * Decodes the getControlIdReporting payload (function 0x20).
+ *
+ * The mapping flags are one 16-bit field whose halves are not adjacent: the
+ * low byte sits at [2] and the high byte at [5], with the remap target at
+ * [3..4] between them. Reading the two as a contiguous pair puts the remap
+ * target's high byte where the flags belong, which reports a button remapped
+ * to anything in 0x01.. as diverted.
+ */
+export declare function decodeControlReporting(payload: Uint8Array | readonly number[]): LogitechControlReporting | null;
+/**
+ * Which controls a given control may be remapped to.
+ *
+ * The device's group mask names the groups it accepts, and only controls
+ * belonging to one of those groups are legal targets. Left and right click
+ * report a mask of zero, so they come back with nothing.
+ */
+export declare function remappableControlTargets(control: LogitechControlInfo, all: readonly LogitechControlInfo[]): number[];
+/**
+ * Builds the setControlIdReporting payload for a pure remap.
+ *
+ * Each mapping flag occupies two bits — the value, and a companion "valid" bit
+ * one position higher — and the device ignores any flag whose valid bit is
+ * clear. A flags byte of zero therefore changes no flag at all, which is
+ * exactly what is wanted here: turning diversion on would route the button to
+ * HID++ notifications that nothing consumes, leaving it dead.
+ */
+export declare function buildControlRemapWrite(controlId: number, targetControlId: number): number[];
+/**
+ * Builds the payload that hands a button back to the hardware.
+ *
+ * A diverted button emits HID++ notifications instead of acting, which is how
+ * a vendor application implements behaviours of its own. Logi Options+ uses
+ * the temporary flag, which the device clears when its owner stops — but the
+ * persistent flag survives, and a button left that way does nothing at all
+ * until something clears it.
+ *
+ * Only the valid bits are set, with both value bits left clear, so this can
+ * only ever turn diversion off. There is deliberately no way to turn it on:
+ * nothing here consumes those notifications. A remap target of zero leaves the
+ * existing mapping untouched.
+ */
+export declare function buildControlDiversionClearWrite(controlId: number): number[];
+//# sourceMappingURL=controls.d.ts.map

package/dist/logitech/controls.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"controls.d.ts","sourceRoot":"","sources":["../../src/logitech/controls.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;GAaG;AAEH,eAAO,MAAM,wBAAwB;IACnC,yBAAyB;;IAEzB,gFAAgF;;IAEhF,2EAA2E;;IAE3E,mDAAmD;;CAE3C,CAAC;AAEX,wEAAwE;AACxE,eAAO,MAAM,sBAAsB,EAAE,QAAQ,CAAC,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CA8BnE,CAAC;AAEF,kFAAkF;AAClF,eAAO,MAAM,mBAAmB,EAAE,QAAQ,CAAC,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAUhE,CAAC;AAEF;;;;;GAKG;AACH,eAAO,MAAM,iBAAiB;;;;;;;;;CASpB,CAAC;AAEX;;;;GAIG;AACH,eAAO,MAAM,qBAAqB;;;;;;;CAOxB,CAAC;AAEX,MAAM,WAAW,mBAAmB;IAClC,SAAS,EAAE,MAAM,CAAC;IAClB,MAAM,EAAE,MAAM,CAAC;IACf,sEAAsE;IACtE,KAAK,EAAE,MAAM,CAAC;IACd,uEAAuE;IACvE,KAAK,EAAE,MAAM,CAAC;IACd,+DAA+D;IAC/D,SAAS,EAAE,MAAM,CAAC;CACnB;AAED,MAAM,WAAW,wBAAwB;IACvC,SAAS,EAAE,MAAM,CAAC;IAClB;;;;;OAKG;IACH,YAAY,EAAE,MAAM,CAAC;IACrB,gDAAgD;IAChD,QAAQ,EAAE,MAAM,CAAC;IACjB,6DAA6D;IAC7D,QAAQ,EAAE,OAAO,CAAC;CACnB;AAED,MAAM,WAAW,6BAA8B,SAAQ,mBAAmB,EAAE,wBAAwB;IAClG,IAAI,EAAE,MAAM,CAAC;IACb,QAAQ,EAAE,MAAM,CAAC;IACjB,cAAc,EAAE,OAAO,CAAC;IACxB,uEAAuE;IACvE,OAAO,EAAE,OAAO,CAAC;IACjB,0DAA0D;IAC1D,YAAY,EAAE,MAAM,EAAE,CAAC;CACxB;AAED,eAAO,MAAM,mBAAmB,GAAI,WAAW,MAAM,KAAG,MAEiB,CAAC;AAE1E,eAAO,MAAM,gBAAgB,GAAI,QAAQ,MAAM,KAAG,MAC6C,CAAC;AAEhG,4DAA4D;AAC5D,wBAAgB,iBAAiB,CAAC,OAAO,EAAE,UAAU,GAAG,SAAS,MAAM,EAAE,GAAG,mBAAmB,GAAG,IAAI,CAWrG;AAED;;;;;;;;GAQG;AACH,wBAAgB,sBAAsB,CACpC,OAAO,EAAE,UAAU,GAAG,SAAS,MAAM,EAAE,GACtC,wBAAwB,GAAG,IAAI,CAWjC;AAED;;;;;;GAMG;AACH,wBAAgB,wBAAwB,CACtC,OAAO,EAAE,mBAAmB,EAC5B,GAAG,EAAE,SAAS,mBAAmB,EAAE,GAClC,MAAM,EAAE,CAQV;AAED;;;;;;;;GAQG;AACH,wBAAgB,sBAAsB,CAAC,SAAS,EAAE,MAAM,EAAE,eAAe,EAAE,MAAM,GAAG,MAAM,EAAE,CAE3F;AAED;;;;;;;;;;;;;GAaG;AACH,wBAAgB,+BAA+B,CAAC,SAAS,EAAE,MAAM,GAAG,MAAM,EAAE,CAI3E"}