@openmouse/protocol 0.1.0

package/dist/logitech/controls.js

@@ -0,0 +1,184 @@
+/**
+ * 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 const LOGITECH_REPROG_CONTROLS = {
+    /** getCount: [count]. */
+    count: 0x00,
+    /** getControlIdInfo(index): [cid(2), tid(2), flags, pos, group, gmask, ...]. */
+    info: 0x10,
+    /** getControlIdReporting(cid): [cid(2), flagsLow, remap(2), flagsHigh]. */
+    reporting: 0x20,
+    /** setControlIdReporting(cid, flags, remap(2)). */
+    setReporting: 0x30,
+};
+/** Control ids — the physical (or virtual) buttons a device exposes. */
+export const LOGITECH_CONTROL_NAMES = {
+    0x0050: "Left click",
+    0x0051: "Right click",
+    0x0052: "Middle click",
+    0x0053: "Back",
+    0x0054: "Back (alt)",
+    0x0056: "Forward",
+    0x0057: "Forward (as HID)",
+    0x0059: "Button 6",
+    0x005a: "Button 7",
+    0x005b: "Button 8",
+    0x005c: "Button 9",
+    0x005d: "Button 10",
+    0x005e: "Button 11",
+    0x00c3: "Gesture button",
+    0x00c4: "SmartShift button",
+    0x00d7: "Virtual gesture button",
+    0x00dc: "Back (long press)",
+    0x00e0: "Mission Control / Task View",
+    0x00e1: "Dashboard / Action Center",
+    0x00e2: "Backlight down",
+    0x00e3: "Backlight up",
+    0x00e4: "Previous track",
+    0x00e5: "Play / pause",
+    0x00e6: "Next track",
+    0x00e7: "Mute",
+    0x00e8: "Volume down",
+    0x00e9: "Volume up",
+    /** The MX Master 4's Actions Ring, the panel paired with 0x19B0 haptics. */
+    0x01a0: "Actions Ring",
+};
+/** Native task each control performs when it is neither remapped nor diverted. */
+export const LOGITECH_TASK_NAMES = {
+    0x0038: "Left click",
+    0x0039: "Right click",
+    0x003a: "Middle click",
+    0x003c: "Back",
+    0x003e: "Forward",
+    0x009c: "Gesture button",
+    0x009d: "SmartShift",
+    0x00b4: "Virtual gesture button",
+    0x0109: "App switch / Launchpad",
+};
+/**
+ * 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 const LOGITECH_KEY_FLAG = {
+    mouseButton: 0x01,
+    fkey: 0x02,
+    hotkey: 0x04,
+    fnToggle: 0x08,
+    reprogrammable: 0x10,
+    divertable: 0x20,
+    persistentlyDivertable: 0x40,
+    virtual: 0x80,
+};
+/**
+ * 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 const LOGITECH_MAPPING_FLAG = {
+    diverted: 0x0001,
+    persistentlyDiverted: 0x0004,
+    rawXy: 0x0010,
+    forceRawXy: 0x0040,
+    analyticsKeyEvents: 0x0100,
+    rawWheel: 0x0400,
+};
+export const logitechControlName = (controlId) => LOGITECH_CONTROL_NAMES[controlId]
+    ?? `Control 0x${controlId.toString(16).padStart(4, "0").toUpperCase()}`;
+export const logitechTaskName = (taskId) => LOGITECH_TASK_NAMES[taskId] ?? `Task 0x${taskId.toString(16).padStart(4, "0").toUpperCase()}`;
+/** Decodes the getControlIdInfo payload (function 0x10). */
+export function decodeControlInfo(payload) {
+    if (payload.length < 8)
+        return null;
+    const at = (index) => payload[index] ?? 0;
+    return {
+        controlId: (at(0) << 8) | at(1),
+        taskId: (at(2) << 8) | at(3),
+        flags: at(4),
+        // Byte 5 is the physical position, which is meaningful on keyboards only.
+        group: at(6),
+        groupMask: at(7),
+    };
+}
+/**
+ * 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 function decodeControlReporting(payload) {
+    if (payload.length < 6)
+        return null;
+    const at = (index) => payload[index] ?? 0;
+    const mappingFlags = at(2) | (at(5) << 8);
+    const diverted = LOGITECH_MAPPING_FLAG.diverted | LOGITECH_MAPPING_FLAG.persistentlyDiverted;
+    return {
+        controlId: (at(0) << 8) | at(1),
+        mappingFlags,
+        mappedTo: (at(3) << 8) | at(4),
+        diverted: (mappingFlags & diverted) !== 0,
+    };
+}
+/**
+ * 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 function remappableControlTargets(control, all) {
+    return all
+        // Group 0 means the control belongs to no group and is not a target. The
+        // mask test alone would also reject it — but only via a negative shift,
+        // which is an accident to rely on rather than a rule to read.
+        .filter((candidate) => candidate.group > 0
+        && (control.groupMask & (1 << (candidate.group - 1))) !== 0)
+        .map((candidate) => candidate.controlId);
+}
+/**
+ * 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 function buildControlRemapWrite(controlId, targetControlId) {
+    return [controlId >> 8, controlId & 0xff, 0x00, targetControlId >> 8, targetControlId & 0xff];
+}
+/**
+ * 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 function buildControlDiversionClearWrite(controlId) {
+    const clearDiverted = LOGITECH_MAPPING_FLAG.diverted << 1;
+    const clearPersistent = LOGITECH_MAPPING_FLAG.persistentlyDiverted << 1;
+    return [controlId >> 8, controlId & 0xff, clearDiverted | clearPersistent, 0x00, 0x00];
+}
+//# sourceMappingURL=controls.js.map

package/dist/logitech/controls.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"controls.js","sourceRoot":"","sources":["../../src/logitech/controls.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;GAaG;AAEH,MAAM,CAAC,MAAM,wBAAwB,GAAG;IACtC,yBAAyB;IACzB,KAAK,EAAE,IAAI;IACX,gFAAgF;IAChF,IAAI,EAAE,IAAI;IACV,2EAA2E;IAC3E,SAAS,EAAE,IAAI;IACf,mDAAmD;IACnD,YAAY,EAAE,IAAI;CACV,CAAC;AAEX,wEAAwE;AACxE,MAAM,CAAC,MAAM,sBAAsB,GAAqC;IACtE,MAAM,EAAE,YAAY;IACpB,MAAM,EAAE,aAAa;IACrB,MAAM,EAAE,cAAc;IACtB,MAAM,EAAE,MAAM;IACd,MAAM,EAAE,YAAY;IACpB,MAAM,EAAE,SAAS;IACjB,MAAM,EAAE,kBAAkB;IAC1B,MAAM,EAAE,UAAU;IAClB,MAAM,EAAE,UAAU;IAClB,MAAM,EAAE,UAAU;IAClB,MAAM,EAAE,UAAU;IAClB,MAAM,EAAE,WAAW;IACnB,MAAM,EAAE,WAAW;IACnB,MAAM,EAAE,gBAAgB;IACxB,MAAM,EAAE,mBAAmB;IAC3B,MAAM,EAAE,wBAAwB;IAChC,MAAM,EAAE,mBAAmB;IAC3B,MAAM,EAAE,6BAA6B;IACrC,MAAM,EAAE,2BAA2B;IACnC,MAAM,EAAE,gBAAgB;IACxB,MAAM,EAAE,cAAc;IACtB,MAAM,EAAE,gBAAgB;IACxB,MAAM,EAAE,cAAc;IACtB,MAAM,EAAE,YAAY;IACpB,MAAM,EAAE,MAAM;IACd,MAAM,EAAE,aAAa;IACrB,MAAM,EAAE,WAAW;IACnB,4EAA4E;IAC5E,MAAM,EAAE,cAAc;CACvB,CAAC;AAEF,kFAAkF;AAClF,MAAM,CAAC,MAAM,mBAAmB,GAAqC;IACnE,MAAM,EAAE,YAAY;IACpB,MAAM,EAAE,aAAa;IACrB,MAAM,EAAE,cAAc;IACtB,MAAM,EAAE,MAAM;IACd,MAAM,EAAE,SAAS;IACjB,MAAM,EAAE,gBAAgB;IACxB,MAAM,EAAE,YAAY;IACpB,MAAM,EAAE,wBAAwB;IAChC,MAAM,EAAE,wBAAwB;CACjC,CAAC;AAEF;;;;;GAKG;AACH,MAAM,CAAC,MAAM,iBAAiB,GAAG;IAC/B,WAAW,EAAE,IAAI;IACjB,IAAI,EAAE,IAAI;IACV,MAAM,EAAE,IAAI;IACZ,QAAQ,EAAE,IAAI;IACd,cAAc,EAAE,IAAI;IACpB,UAAU,EAAE,IAAI;IAChB,sBAAsB,EAAE,IAAI;IAC5B,OAAO,EAAE,IAAI;CACL,CAAC;AAEX;;;;GAIG;AACH,MAAM,CAAC,MAAM,qBAAqB,GAAG;IACnC,QAAQ,EAAE,MAAM;IAChB,oBAAoB,EAAE,MAAM;IAC5B,KAAK,EAAE,MAAM;IACb,UAAU,EAAE,MAAM;IAClB,kBAAkB,EAAE,MAAM;IAC1B,QAAQ,EAAE,MAAM;CACR,CAAC;AAsCX,MAAM,CAAC,MAAM,mBAAmB,GAAG,CAAC,SAAiB,EAAU,EAAE,CAC/D,sBAAsB,CAAC,SAAS,CAAC;OAC9B,aAAa,SAAS,CAAC,QAAQ,CAAC,EAAE,CAAC,CAAC,QAAQ,CAAC,CAAC,EAAE,GAAG,CAAC,CAAC,WAAW,EAAE,EAAE,CAAC;AAE1E,MAAM,CAAC,MAAM,gBAAgB,GAAG,CAAC,MAAc,EAAU,EAAE,CACzD,mBAAmB,CAAC,MAAM,CAAC,IAAI,UAAU,MAAM,CAAC,QAAQ,CAAC,EAAE,CAAC,CAAC,QAAQ,CAAC,CAAC,EAAE,GAAG,CAAC,CAAC,WAAW,EAAE,EAAE,CAAC;AAEhG,4DAA4D;AAC5D,MAAM,UAAU,iBAAiB,CAAC,OAAuC;IACvE,IAAI,OAAO,CAAC,MAAM,GAAG,CAAC;QAAE,OAAO,IAAI,CAAC;IACpC,MAAM,EAAE,GAAG,CAAC,KAAa,EAAU,EAAE,CAAC,OAAO,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC;IAC1D,OAAO;QACL,SAAS,EAAE,CAAC,EAAE,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,GAAG,EAAE,CAAC,CAAC,CAAC;QAC/B,MAAM,EAAE,CAAC,EAAE,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,GAAG,EAAE,CAAC,CAAC,CAAC;QAC5B,KAAK,EAAE,EAAE,CAAC,CAAC,CAAC;QACZ,0EAA0E;QAC1E,KAAK,EAAE,EAAE,CAAC,CAAC,CAAC;QACZ,SAAS,EAAE,EAAE,CAAC,CAAC,CAAC;KACjB,CAAC;AACJ,CAAC;AAED;;;;;;;;GAQG;AACH,MAAM,UAAU,sBAAsB,CACpC,OAAuC;IAEvC,IAAI,OAAO,CAAC,MAAM,GAAG,CAAC;QAAE,OAAO,IAAI,CAAC;IACpC,MAAM,EAAE,GAAG,CAAC,KAAa,EAAU,EAAE,CAAC,OAAO,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC;IAC1D,MAAM,YAAY,GAAG,EAAE,CAAC,CAAC,CAAC,GAAG,CAAC,EAAE,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC;IAC1C,MAAM,QAAQ,GAAG,qBAAqB,CAAC,QAAQ,GAAG,qBAAqB,CAAC,oBAAoB,CAAC;IAC7F,OAAO;QACL,SAAS,EAAE,CAAC,EAAE,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,GAAG,EAAE,CAAC,CAAC,CAAC;QAC/B,YAAY;QACZ,QAAQ,EAAE,CAAC,EAAE,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,GAAG,EAAE,CAAC,CAAC,CAAC;QAC9B,QAAQ,EAAE,CAAC,YAAY,GAAG,QAAQ,CAAC,KAAK,CAAC;KAC1C,CAAC;AACJ,CAAC;AAED;;;;;;GAMG;AACH,MAAM,UAAU,wBAAwB,CACtC,OAA4B,EAC5B,GAAmC;IAEnC,OAAO,GAAG;QACR,yEAAyE;QACzE,wEAAwE;QACxE,8DAA8D;SAC7D,MAAM,CAAC,CAAC,SAAS,EAAE,EAAE,CAAC,SAAS,CAAC,KAAK,GAAG,CAAC;WACrC,CAAC,OAAO,CAAC,SAAS,GAAG,CAAC,CAAC,IAAI,CAAC,SAAS,CAAC,KAAK,GAAG,CAAC,CAAC,CAAC,CAAC,KAAK,CAAC,CAAC;SAC7D,GAAG,CAAC,CAAC,SAAS,EAAE,EAAE,CAAC,SAAS,CAAC,SAAS,CAAC,CAAC;AAC7C,CAAC;AAED;;;;;;;;GAQG;AACH,MAAM,UAAU,sBAAsB,CAAC,SAAiB,EAAE,eAAuB;IAC/E,OAAO,CAAC,SAAS,IAAI,CAAC,EAAE,SAAS,GAAG,IAAI,EAAE,IAAI,EAAE,eAAe,IAAI,CAAC,EAAE,eAAe,GAAG,IAAI,CAAC,CAAC;AAChG,CAAC;AAED;;;;;;;;;;;;;GAaG;AACH,MAAM,UAAU,+BAA+B,CAAC,SAAiB;IAC/D,MAAM,aAAa,GAAG,qBAAqB,CAAC,QAAQ,IAAI,CAAC,CAAC;IAC1D,MAAM,eAAe,GAAG,qBAAqB,CAAC,oBAAoB,IAAI,CAAC,CAAC;IACxE,OAAO,CAAC,SAAS,IAAI,CAAC,EAAE,SAAS,GAAG,IAAI,EAAE,aAAa,GAAG,eAAe,EAAE,IAAI,EAAE,IAAI,CAAC,CAAC;AACzF,CAAC"}

package/dist/logitech/friendly-name.d.ts

@@ -0,0 +1,50 @@
+/**
+ * Feature 0x0007 (Device Friendly Name) — the editable name a device presents
+ * to a host, distinct from the fixed 0x0005 device name.
+ *
+ * Read from an MX Master 4 (WPID B042): fn 0x00 answers
+ * [currentLength, maxLength, ...], reporting 11 of a maximum 14 and holding
+ * "MX Master 4". fn 0x01 returns the text in chunks headed by the offset that
+ * was asked for, so characters begin one byte into the payload. fn 0x03 writes
+ * it back in the same shape.
+ */
+export declare const LOGITECH_FRIENDLY_NAME: {
+    /** getFriendlyNameLengths: [current, max]. */
+    readonly lengths: 0;
+    /** getFriendlyName(offset): [offset, ...characters]. */
+    readonly get: 16;
+    /** getDefaultFriendlyName(offset), same shape as get. */
+    readonly getDefault: 32;
+    /** setFriendlyName(offset, ...characters). */
+    readonly set: 48;
+};
+/**
+ * A long report carries 19 bytes: three of HID++ header, then the echoed
+ * offset, leaving fifteen for characters. The MX Master 4 allows fourteen, so
+ * one write covers any name it accepts — but the limit is the device's, read
+ * from the hardware rather than assumed, so this is the transport ceiling.
+ */
+export declare const LOGITECH_FRIENDLY_NAME_BYTES_PER_REPORT = 15;
+export interface LogitechFriendlyNameLengths {
+    length: number;
+    maxLength: number;
+}
+export declare function decodeFriendlyNameLengths(payload: Uint8Array | readonly number[]): LogitechFriendlyNameLengths | null;
+/**
+ * Characters from one chunk. The reply repeats the offset it was asked for, so
+ * the text starts at payload[1]; reading from payload[0] yields the offset as
+ * a stray character and shifts the whole name.
+ */
+export declare function decodeFriendlyNameChunk(payload: Uint8Array | readonly number[], remaining: number): number[];
+/** Trailing NULs are padding, not part of the name. */
+export declare function decodeFriendlyNameText(characters: readonly number[]): string;
+export type LogitechFriendlyNameRejection = "empty" | "too-long" | "non-ascii" | "too-long-for-one-report";
+/**
+ * Why a name cannot be written, or null when it can. Names are validated
+ * before any bytes go out: a device that accepts half a name and rejects the
+ * rest leaves a user with neither the old one nor the new.
+ */
+export declare function rejectFriendlyName(name: string, maxLength: number): LogitechFriendlyNameRejection | null;
+export declare function encodeFriendlyName(name: string): number[];
+export declare function buildFriendlyNameWrite(name: string): number[];
+//# sourceMappingURL=friendly-name.d.ts.map

package/dist/logitech/friendly-name.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"friendly-name.d.ts","sourceRoot":"","sources":["../../src/logitech/friendly-name.ts"],"names":[],"mappings":"AAAA;;;;;;;;;GASG;AAEH,eAAO,MAAM,sBAAsB;IACjC,8CAA8C;;IAE9C,wDAAwD;;IAExD,yDAAyD;;IAEzD,8CAA8C;;CAEtC,CAAC;AAEX;;;;;GAKG;AACH,eAAO,MAAM,uCAAuC,KAAK,CAAC;AAE1D,MAAM,WAAW,2BAA2B;IAC1C,MAAM,EAAE,MAAM,CAAC;IACf,SAAS,EAAE,MAAM,CAAC;CACnB;AAED,wBAAgB,yBAAyB,CACvC,OAAO,EAAE,UAAU,GAAG,SAAS,MAAM,EAAE,GACtC,2BAA2B,GAAG,IAAI,CAKpC;AAED;;;;GAIG;AACH,wBAAgB,uBAAuB,CACrC,OAAO,EAAE,UAAU,GAAG,SAAS,MAAM,EAAE,EACvC,SAAS,EAAE,MAAM,GAChB,MAAM,EAAE,CAGV;AAED,uDAAuD;AACvD,wBAAgB,sBAAsB,CAAC,UAAU,EAAE,SAAS,MAAM,EAAE,GAAG,MAAM,CAE5E;AAED,MAAM,MAAM,6BAA6B,GACrC,OAAO,GACP,UAAU,GACV,WAAW,GACX,yBAAyB,CAAC;AAE9B;;;;GAIG;AACH,wBAAgB,kBAAkB,CAAC,IAAI,EAAE,MAAM,EAAE,SAAS,EAAE,MAAM,GAAG,6BAA6B,GAAG,IAAI,CAUxG;AAED,wBAAgB,kBAAkB,CAAC,IAAI,EAAE,MAAM,GAAG,MAAM,EAAE,CAEzD;AAED,wBAAgB,sBAAsB,CAAC,IAAI,EAAE,MAAM,GAAG,MAAM,EAAE,CAE7D"}

package/dist/logitech/friendly-name.js

@@ -0,0 +1,74 @@
+/**
+ * Feature 0x0007 (Device Friendly Name) — the editable name a device presents
+ * to a host, distinct from the fixed 0x0005 device name.
+ *
+ * Read from an MX Master 4 (WPID B042): fn 0x00 answers
+ * [currentLength, maxLength, ...], reporting 11 of a maximum 14 and holding
+ * "MX Master 4". fn 0x01 returns the text in chunks headed by the offset that
+ * was asked for, so characters begin one byte into the payload. fn 0x03 writes
+ * it back in the same shape.
+ */
+export const LOGITECH_FRIENDLY_NAME = {
+    /** getFriendlyNameLengths: [current, max]. */
+    lengths: 0x00,
+    /** getFriendlyName(offset): [offset, ...characters]. */
+    get: 0x10,
+    /** getDefaultFriendlyName(offset), same shape as get. */
+    getDefault: 0x20,
+    /** setFriendlyName(offset, ...characters). */
+    set: 0x30,
+};
+/**
+ * A long report carries 19 bytes: three of HID++ header, then the echoed
+ * offset, leaving fifteen for characters. The MX Master 4 allows fourteen, so
+ * one write covers any name it accepts — but the limit is the device's, read
+ * from the hardware rather than assumed, so this is the transport ceiling.
+ */
+export const LOGITECH_FRIENDLY_NAME_BYTES_PER_REPORT = 15;
+export function decodeFriendlyNameLengths(payload) {
+    const length = payload[0];
+    const maxLength = payload[1];
+    if (length === undefined || maxLength === undefined || maxLength === 0)
+        return null;
+    return { length, maxLength };
+}
+/**
+ * Characters from one chunk. The reply repeats the offset it was asked for, so
+ * the text starts at payload[1]; reading from payload[0] yields the offset as
+ * a stray character and shifts the whole name.
+ */
+export function decodeFriendlyNameChunk(payload, remaining) {
+    const wanted = Math.min(LOGITECH_FRIENDLY_NAME_BYTES_PER_REPORT, Math.max(0, remaining));
+    return [...payload].slice(1, 1 + wanted);
+}
+/** Trailing NULs are padding, not part of the name. */
+export function decodeFriendlyNameText(characters) {
+    return new TextDecoder().decode(new Uint8Array(characters)).replace(/\0/g, "").trim();
+}
+/**
+ * Why a name cannot be written, or null when it can. Names are validated
+ * before any bytes go out: a device that accepts half a name and rejects the
+ * rest leaves a user with neither the old one nor the new.
+ */
+export function rejectFriendlyName(name, maxLength) {
+    const bytes = encodeFriendlyName(name);
+    if (bytes.length === 0)
+        return "empty";
+    if (bytes.length > maxLength)
+        return "too-long";
+    if (bytes.length > LOGITECH_FRIENDLY_NAME_BYTES_PER_REPORT)
+        return "too-long-for-one-report";
+    // The wire carries bytes, but a name outside printable ASCII has never been
+    // exercised on hardware and multi-byte characters would break the length
+    // accounting the device does in characters.
+    if (bytes.some((byte) => byte < 0x20 || byte > 0x7e))
+        return "non-ascii";
+    return null;
+}
+export function encodeFriendlyName(name) {
+    return [...new TextEncoder().encode(name.trim())];
+}
+export function buildFriendlyNameWrite(name) {
+    return [0x00, ...encodeFriendlyName(name)];
+}
+//# sourceMappingURL=friendly-name.js.map

package/dist/logitech/friendly-name.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"friendly-name.js","sourceRoot":"","sources":["../../src/logitech/friendly-name.ts"],"names":[],"mappings":"AAAA;;;;;;;;;GASG;AAEH,MAAM,CAAC,MAAM,sBAAsB,GAAG;IACpC,8CAA8C;IAC9C,OAAO,EAAE,IAAI;IACb,wDAAwD;IACxD,GAAG,EAAE,IAAI;IACT,yDAAyD;IACzD,UAAU,EAAE,IAAI;IAChB,8CAA8C;IAC9C,GAAG,EAAE,IAAI;CACD,CAAC;AAEX;;;;;GAKG;AACH,MAAM,CAAC,MAAM,uCAAuC,GAAG,EAAE,CAAC;AAO1D,MAAM,UAAU,yBAAyB,CACvC,OAAuC;IAEvC,MAAM,MAAM,GAAG,OAAO,CAAC,CAAC,CAAC,CAAC;IAC1B,MAAM,SAAS,GAAG,OAAO,CAAC,CAAC,CAAC,CAAC;IAC7B,IAAI,MAAM,KAAK,SAAS,IAAI,SAAS,KAAK,SAAS,IAAI,SAAS,KAAK,CAAC;QAAE,OAAO,IAAI,CAAC;IACpF,OAAO,EAAE,MAAM,EAAE,SAAS,EAAE,CAAC;AAC/B,CAAC;AAED;;;;GAIG;AACH,MAAM,UAAU,uBAAuB,CACrC,OAAuC,EACvC,SAAiB;IAEjB,MAAM,MAAM,GAAG,IAAI,CAAC,GAAG,CAAC,uCAAuC,EAAE,IAAI,CAAC,GAAG,CAAC,CAAC,EAAE,SAAS,CAAC,CAAC,CAAC;IACzF,OAAO,CAAC,GAAG,OAAO,CAAC,CAAC,KAAK,CAAC,CAAC,EAAE,CAAC,GAAG,MAAM,CAAC,CAAC;AAC3C,CAAC;AAED,uDAAuD;AACvD,MAAM,UAAU,sBAAsB,CAAC,UAA6B;IAClE,OAAO,IAAI,WAAW,EAAE,CAAC,MAAM,CAAC,IAAI,UAAU,CAAC,UAAU,CAAC,CAAC,CAAC,OAAO,CAAC,KAAK,EAAE,EAAE,CAAC,CAAC,IAAI,EAAE,CAAC;AACxF,CAAC;AAQD;;;;GAIG;AACH,MAAM,UAAU,kBAAkB,CAAC,IAAY,EAAE,SAAiB;IAChE,MAAM,KAAK,GAAG,kBAAkB,CAAC,IAAI,CAAC,CAAC;IACvC,IAAI,KAAK,CAAC,MAAM,KAAK,CAAC;QAAE,OAAO,OAAO,CAAC;IACvC,IAAI,KAAK,CAAC,MAAM,GAAG,SAAS;QAAE,OAAO,UAAU,CAAC;IAChD,IAAI,KAAK,CAAC,MAAM,GAAG,uCAAuC;QAAE,OAAO,yBAAyB,CAAC;IAC7F,4EAA4E;IAC5E,yEAAyE;IACzE,4CAA4C;IAC5C,IAAI,KAAK,CAAC,IAAI,CAAC,CAAC,IAAI,EAAE,EAAE,CAAC,IAAI,GAAG,IAAI,IAAI,IAAI,GAAG,IAAI,CAAC;QAAE,OAAO,WAAW,CAAC;IACzE,OAAO,IAAI,CAAC;AACd,CAAC;AAED,MAAM,UAAU,kBAAkB,CAAC,IAAY;IAC7C,OAAO,CAAC,GAAG,IAAI,WAAW,EAAE,CAAC,MAAM,CAAC,IAAI,CAAC,IAAI,EAAE,CAAC,CAAC,CAAC;AACpD,CAAC;AAED,MAAM,UAAU,sBAAsB,CAAC,IAAY;IACjD,OAAO,CAAC,IAAI,EAAE,GAAG,kBAAkB,CAAC,IAAI,CAAC,CAAC,CAAC;AAC7C,CAAC"}

package/dist/logitech/haptics.d.ts

@@ -0,0 +1,97 @@
+/**
+ * Feature 0x19B0 (Haptic), as implemented by the MX Master 4 (WPID B042).
+ *
+ * No public documentation exists for this feature. Everything here was read
+ * off hardware by watching Logi Options+ talk to the mouse: a Bolt receiver
+ * broadcasts replies to every open handle, and the low nibble of the function
+ * byte carries the requester's software id, so the vendor application's own
+ * traffic is visible alongside your own.
+ *
+ * The configuration is a two-byte pair behind get 0x10 / set 0x20.
+ *
+ * Byte 0 is a flag bitmask. Turning haptics off in Options+ cleared bit 0;
+ * turning its battery-saving mode off cleared bit 1; both returned together as
+ * 0x03. Ten writes for ten switch toggles, and only those two pairs moved
+ * anything — Options+'s per-context switches (Actions Ring, Gestures, Switch
+ * Screens) change no device byte at all, so those are decided in its software.
+ * Bits 2-7 were 0 throughout and their purpose is unknown, so a write carries
+ * them through rather than clearing them.
+ *
+ * Byte 1 is the strength. Options+'s four presets write exactly the values in
+ * LOGITECH_HAPTIC_PRESETS, and capability byte 3 reports 60 as the device
+ * default, matching its Medium.
+ */
+export declare const LOGITECH_HAPTIC: {
+    /** getCapabilities: [?, ?, ?, defaultIntensity, defaultEffect, ...]. */
+    readonly capabilities: 0;
+    readonly get: 16;
+    readonly set: 32;
+    /** Fires the motor once. Nothing is persisted. */
+    readonly play: 64;
+};
+/**
+ * Options+'s Subtle / Low / Medium / High, captured from its writes. The
+ * device takes any byte in range, so these are the vendor's choices rather
+ * than a device-imposed set.
+ */
+export declare const LOGITECH_HAPTIC_PRESETS: {
+    readonly Subtle: 25;
+    readonly Low: 45;
+    readonly Medium: 60;
+    readonly High: 100;
+};
+export type LogitechHapticPreset = keyof typeof LOGITECH_HAPTIC_PRESETS;
+/** The largest value any preset uses; nothing above it has been exercised. */
+export declare const LOGITECH_HAPTIC_INTENSITY_MAX: 100;
+export declare const LOGITECH_HAPTIC_FLAG: {
+    readonly enabled: 1;
+    readonly batterySaving: 2;
+};
+export type LogitechHapticFlag = keyof typeof LOGITECH_HAPTIC_FLAG;
+/**
+ * Effect ids the MX Master 4 accepts; every other id up to 0x3F answers
+ * INVALID_ARGUMENT. Sixteen ids but thirteen distinct sensations by hand:
+ * 0x00 and 0x01 are indistinguishable, as are 0x02, 0x03 and 0x04. 0x1B sits
+ * apart from the contiguous block and feels like a lighter variant of another
+ * effect, which one is unconfirmed.
+ */
+export declare const LOGITECH_HAPTIC_EFFECT_IDS: readonly number[];
+/**
+ * The effects Options+ plays for each action, captured from its traffic: 0x08
+ * straight after every strength write, 0x00 after re-enabling haptics.
+ */
+export declare const LOGITECH_HAPTIC_EFFECTS: {
+    readonly strengthSample: 8;
+    readonly enableConfirmation: 0;
+};
+export interface LogitechHapticConfig {
+    enabled: boolean;
+    batterySaving: boolean;
+    intensity: number;
+    /** Byte 0 as read, so a later write can carry its unknown bits through. */
+    flagByte: number;
+}
+export declare function decodeHapticConfig(payload: Uint8Array | readonly number[]): LogitechHapticConfig | null;
+/** Sets or clears one flag, leaving every other bit of the byte alone. */
+export declare function encodeHapticFlags(flagByte: number, flag: LogitechHapticFlag, on: boolean): number;
+/**
+ * A write carries both bytes, so a caller changing one field must supply the
+ * other as the device currently reports it. Passing a stale or invented flag
+ * byte silently discards whatever bits 2-7 hold.
+ */
+export declare function buildHapticConfigWrite(flagByte: number, intensity: number): number[];
+export declare function isLogitechHapticIntensity(value: number): boolean;
+export declare function isLogitechHapticEffect(effect: number): boolean;
+/**
+ * Byte 1 of a play reply reports that the motor was already running, not
+ * anything about the effect. Proven by playing one short effect from idle and
+ * again on the heels of the longest effect in the set: the same id answered 0
+ * three times and then 1 three times.
+ */
+export declare function decodeHapticPlayReply(payload: Uint8Array | readonly number[]): {
+    effect: number;
+    motorWasBusy: boolean;
+} | null;
+/** Capability byte 3 is the factory strength; the MX Master 4 reports 60. */
+export declare function decodeHapticDefaultIntensity(payload: Uint8Array | readonly number[]): number | null;
+//# sourceMappingURL=haptics.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"haptics.d.ts","sourceRoot":"","sources":["../../src/logitech/haptics.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;;;;;;;;GAsBG;AAEH,eAAO,MAAM,eAAe;IAC1B,wEAAwE;;;;IAIxE,kDAAkD;;CAE1C,CAAC;AAEX;;;;GAIG;AACH,eAAO,MAAM,uBAAuB;;;;;CAK1B,CAAC;AAEX,MAAM,MAAM,oBAAoB,GAAG,MAAM,OAAO,uBAAuB,CAAC;AAExE,8EAA8E;AAC9E,eAAO,MAAM,6BAA6B,KAA+B,CAAC;AAE1E,eAAO,MAAM,oBAAoB;;;CAGvB,CAAC;AAEX,MAAM,MAAM,kBAAkB,GAAG,MAAM,OAAO,oBAAoB,CAAC;AAEnE;;;;;;GAMG;AACH,eAAO,MAAM,0BAA0B,EAAE,SAAS,MAAM,EAGvD,CAAC;AAEF;;;GAGG;AACH,eAAO,MAAM,uBAAuB;;;CAG1B,CAAC;AAUX,MAAM,WAAW,oBAAoB;IACnC,OAAO,EAAE,OAAO,CAAC;IACjB,aAAa,EAAE,OAAO,CAAC;IACvB,SAAS,EAAE,MAAM,CAAC;IAClB,2EAA2E;IAC3E,QAAQ,EAAE,MAAM,CAAC;CAClB;AAED,wBAAgB,kBAAkB,CAAC,OAAO,EAAE,UAAU,GAAG,SAAS,MAAM,EAAE,GAAG,oBAAoB,GAAG,IAAI,CAUvG;AAED,0EAA0E;AAC1E,wBAAgB,iBAAiB,CAAC,QAAQ,EAAE,MAAM,EAAE,IAAI,EAAE,kBAAkB,EAAE,EAAE,EAAE,OAAO,GAAG,MAAM,CAGjG;AAED;;;;GAIG;AACH,wBAAgB,sBAAsB,CAAC,QAAQ,EAAE,MAAM,EAAE,SAAS,EAAE,MAAM,GAAG,MAAM,EAAE,CAEpF;AAED,wBAAgB,yBAAyB,CAAC,KAAK,EAAE,MAAM,GAAG,OAAO,CAEhE;AAED,wBAAgB,sBAAsB,CAAC,MAAM,EAAE,MAAM,GAAG,OAAO,CAE9D;AAED;;;;;GAKG;AACH,wBAAgB,qBAAqB,CACnC,OAAO,EAAE,UAAU,GAAG,SAAS,MAAM,EAAE,GACtC;IAAE,MAAM,EAAE,MAAM,CAAC;IAAC,YAAY,EAAE,OAAO,CAAA;CAAE,GAAG,IAAI,CAKlD;AAED,6EAA6E;AAC7E,wBAAgB,4BAA4B,CAAC,OAAO,EAAE,UAAU,GAAG,SAAS,MAAM,EAAE,GAAG,MAAM,GAAG,IAAI,CAEnG"}

package/dist/logitech/haptics.js

@@ -0,0 +1,116 @@
+/**
+ * Feature 0x19B0 (Haptic), as implemented by the MX Master 4 (WPID B042).
+ *
+ * No public documentation exists for this feature. Everything here was read
+ * off hardware by watching Logi Options+ talk to the mouse: a Bolt receiver
+ * broadcasts replies to every open handle, and the low nibble of the function
+ * byte carries the requester's software id, so the vendor application's own
+ * traffic is visible alongside your own.
+ *
+ * The configuration is a two-byte pair behind get 0x10 / set 0x20.
+ *
+ * Byte 0 is a flag bitmask. Turning haptics off in Options+ cleared bit 0;
+ * turning its battery-saving mode off cleared bit 1; both returned together as
+ * 0x03. Ten writes for ten switch toggles, and only those two pairs moved
+ * anything — Options+'s per-context switches (Actions Ring, Gestures, Switch
+ * Screens) change no device byte at all, so those are decided in its software.
+ * Bits 2-7 were 0 throughout and their purpose is unknown, so a write carries
+ * them through rather than clearing them.
+ *
+ * Byte 1 is the strength. Options+'s four presets write exactly the values in
+ * LOGITECH_HAPTIC_PRESETS, and capability byte 3 reports 60 as the device
+ * default, matching its Medium.
+ */
+export const LOGITECH_HAPTIC = {
+    /** getCapabilities: [?, ?, ?, defaultIntensity, defaultEffect, ...]. */
+    capabilities: 0x00,
+    get: 0x10,
+    set: 0x20,
+    /** Fires the motor once. Nothing is persisted. */
+    play: 0x40,
+};
+/**
+ * Options+'s Subtle / Low / Medium / High, captured from its writes. The
+ * device takes any byte in range, so these are the vendor's choices rather
+ * than a device-imposed set.
+ */
+export const LOGITECH_HAPTIC_PRESETS = {
+    Subtle: 25,
+    Low: 45,
+    Medium: 60,
+    High: 100,
+};
+/** The largest value any preset uses; nothing above it has been exercised. */
+export const LOGITECH_HAPTIC_INTENSITY_MAX = LOGITECH_HAPTIC_PRESETS.High;
+export const LOGITECH_HAPTIC_FLAG = {
+    enabled: 0x01,
+    batterySaving: 0x02,
+};
+/**
+ * Effect ids the MX Master 4 accepts; every other id up to 0x3F answers
+ * INVALID_ARGUMENT. Sixteen ids but thirteen distinct sensations by hand:
+ * 0x00 and 0x01 are indistinguishable, as are 0x02, 0x03 and 0x04. 0x1B sits
+ * apart from the contiguous block and feels like a lighter variant of another
+ * effect, which one is unconfirmed.
+ */
+export const LOGITECH_HAPTIC_EFFECT_IDS = [
+    0x00, 0x01, 0x02, 0x03, 0x04, 0x05, 0x06, 0x07,
+    0x08, 0x09, 0x0a, 0x0b, 0x0c, 0x0d, 0x0e, 0x1b,
+];
+/**
+ * The effects Options+ plays for each action, captured from its traffic: 0x08
+ * straight after every strength write, 0x00 after re-enabling haptics.
+ */
+export const LOGITECH_HAPTIC_EFFECTS = {
+    strengthSample: 0x08,
+    enableConfirmation: 0x00,
+};
+export function decodeHapticConfig(payload) {
+    const flagByte = payload[0];
+    const intensity = payload[1];
+    if (flagByte === undefined || intensity === undefined)
+        return null;
+    return {
+        enabled: (flagByte & LOGITECH_HAPTIC_FLAG.enabled) !== 0,
+        batterySaving: (flagByte & LOGITECH_HAPTIC_FLAG.batterySaving) !== 0,
+        intensity,
+        flagByte,
+    };
+}
+/** Sets or clears one flag, leaving every other bit of the byte alone. */
+export function encodeHapticFlags(flagByte, flag, on) {
+    const mask = LOGITECH_HAPTIC_FLAG[flag];
+    return on ? flagByte | mask : flagByte & ~mask;
+}
+/**
+ * A write carries both bytes, so a caller changing one field must supply the
+ * other as the device currently reports it. Passing a stale or invented flag
+ * byte silently discards whatever bits 2-7 hold.
+ */
+export function buildHapticConfigWrite(flagByte, intensity) {
+    return [flagByte & 0xff, intensity & 0xff];
+}
+export function isLogitechHapticIntensity(value) {
+    return Number.isInteger(value) && value >= 0 && value <= LOGITECH_HAPTIC_INTENSITY_MAX;
+}
+export function isLogitechHapticEffect(effect) {
+    return LOGITECH_HAPTIC_EFFECT_IDS.includes(effect);
+}
+/**
+ * Byte 1 of a play reply reports that the motor was already running, not
+ * anything about the effect. Proven by playing one short effect from idle and
+ * again on the heels of the longest effect in the set: the same id answered 0
+ * three times and then 1 three times.
+ */
+export function decodeHapticPlayReply(payload) {
+    const effect = payload[0];
+    const busy = payload[1];
+    if (effect === undefined || busy === undefined)
+        return null;
+    return { effect, motorWasBusy: busy !== 0 };
+}
+/** Capability byte 3 is the factory strength; the MX Master 4 reports 60. */
+export function decodeHapticDefaultIntensity(payload) {
+    return payload[3] ?? null;
+}
+//# sourceMappingURL=haptics.js.map

package/dist/logitech/haptics.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"haptics.js","sourceRoot":"","sources":["../../src/logitech/haptics.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;;;;;;;;GAsBG;AAEH,MAAM,CAAC,MAAM,eAAe,GAAG;IAC7B,wEAAwE;IACxE,YAAY,EAAE,IAAI;IAClB,GAAG,EAAE,IAAI;IACT,GAAG,EAAE,IAAI;IACT,kDAAkD;IAClD,IAAI,EAAE,IAAI;CACF,CAAC;AAEX;;;;GAIG;AACH,MAAM,CAAC,MAAM,uBAAuB,GAAG;IACrC,MAAM,EAAE,EAAE;IACV,GAAG,EAAE,EAAE;IACP,MAAM,EAAE,EAAE;IACV,IAAI,EAAE,GAAG;CACD,CAAC;AAIX,8EAA8E;AAC9E,MAAM,CAAC,MAAM,6BAA6B,GAAG,uBAAuB,CAAC,IAAI,CAAC;AAE1E,MAAM,CAAC,MAAM,oBAAoB,GAAG;IAClC,OAAO,EAAE,IAAI;IACb,aAAa,EAAE,IAAI;CACX,CAAC;AAIX;;;;;;GAMG;AACH,MAAM,CAAC,MAAM,0BAA0B,GAAsB;IAC3D,IAAI,EAAE,IAAI,EAAE,IAAI,EAAE,IAAI,EAAE,IAAI,EAAE,IAAI,EAAE,IAAI,EAAE,IAAI;IAC9C,IAAI,EAAE,IAAI,EAAE,IAAI,EAAE,IAAI,EAAE,IAAI,EAAE,IAAI,EAAE,IAAI,EAAE,IAAI;CAC/C,CAAC;AAEF;;;GAGG;AACH,MAAM,CAAC,MAAM,uBAAuB,GAAG;IACrC,cAAc,EAAE,IAAI;IACpB,kBAAkB,EAAE,IAAI;CAChB,CAAC;AAkBX,MAAM,UAAU,kBAAkB,CAAC,OAAuC;IACxE,MAAM,QAAQ,GAAG,OAAO,CAAC,CAAC,CAAC,CAAC;IAC5B,MAAM,SAAS,GAAG,OAAO,CAAC,CAAC,CAAC,CAAC;IAC7B,IAAI,QAAQ,KAAK,SAAS,IAAI,SAAS,KAAK,SAAS;QAAE,OAAO,IAAI,CAAC;IACnE,OAAO;QACL,OAAO,EAAE,CAAC,QAAQ,GAAG,oBAAoB,CAAC,OAAO,CAAC,KAAK,CAAC;QACxD,aAAa,EAAE,CAAC,QAAQ,GAAG,oBAAoB,CAAC,aAAa,CAAC,KAAK,CAAC;QACpE,SAAS;QACT,QAAQ;KACT,CAAC;AACJ,CAAC;AAED,0EAA0E;AAC1E,MAAM,UAAU,iBAAiB,CAAC,QAAgB,EAAE,IAAwB,EAAE,EAAW;IACvF,MAAM,IAAI,GAAG,oBAAoB,CAAC,IAAI,CAAC,CAAC;IACxC,OAAO,EAAE,CAAC,CAAC,CAAC,QAAQ,GAAG,IAAI,CAAC,CAAC,CAAC,QAAQ,GAAG,CAAC,IAAI,CAAC;AACjD,CAAC;AAED;;;;GAIG;AACH,MAAM,UAAU,sBAAsB,CAAC,QAAgB,EAAE,SAAiB;IACxE,OAAO,CAAC,QAAQ,GAAG,IAAI,EAAE,SAAS,GAAG,IAAI,CAAC,CAAC;AAC7C,CAAC;AAED,MAAM,UAAU,yBAAyB,CAAC,KAAa;IACrD,OAAO,MAAM,CAAC,SAAS,CAAC,KAAK,CAAC,IAAI,KAAK,IAAI,CAAC,IAAI,KAAK,IAAI,6BAA6B,CAAC;AACzF,CAAC;AAED,MAAM,UAAU,sBAAsB,CAAC,MAAc;IACnD,OAAO,0BAA0B,CAAC,QAAQ,CAAC,MAAM,CAAC,CAAC;AACrD,CAAC;AAED;;;;;GAKG;AACH,MAAM,UAAU,qBAAqB,CACnC,OAAuC;IAEvC,MAAM,MAAM,GAAG,OAAO,CAAC,CAAC,CAAC,CAAC;IAC1B,MAAM,IAAI,GAAG,OAAO,CAAC,CAAC,CAAC,CAAC;IACxB,IAAI,MAAM,KAAK,SAAS,IAAI,IAAI,KAAK,SAAS;QAAE,OAAO,IAAI,CAAC;IAC5D,OAAO,EAAE,MAAM,EAAE,YAAY,EAAE,IAAI,KAAK,CAAC,EAAE,CAAC;AAC9C,CAAC;AAED,6EAA6E;AAC7E,MAAM,UAAU,4BAA4B,CAAC,OAAuC;IAClF,OAAO,OAAO,CAAC,CAAC,CAAC,IAAI,IAAI,CAAC;AAC5B,CAAC"}

package/dist/logitech/hosts.d.ts

@@ -0,0 +1,55 @@
+/**
+ * Features 0x1815 (Hosts Info) and 0x1814 (Change Host) — Easy-Switch.
+ *
+ * Read from an MX Master 4 (WPID B042) over a Logi Bolt receiver. 0x1815
+ * fn 0x00 answers [capabilities(2), hostCount, currentHost]: the two leading
+ * capability bytes matter, because reading the counts one byte earlier reports
+ * eight slots on a device whose slots 3 and up refuse outright. That device
+ * reports three slots with two paired, itself on slot 0.
+ *
+ * Slot indices are zero-based on the wire. The button on the underside of the
+ * mouse and its indicator both count from one, so anything user-facing has to
+ * add one or it disagrees with the hardware in the user's hand.
+ */
+export declare const LOGITECH_HOSTS: {
+    /** getHostsInfo: [capabilities(2), hostCount, currentHost]. */
+    readonly info: 0;
+    /** getHostInfo(slot): [slot, status, ..., nameLength, maxNameLength]. */
+    readonly host: 16;
+    /**
+     * getHostFriendlyName(slot, offset). NOT the host's label: on an MX Master 4
+     * this answers six non-text bytes per slot regardless of the reported name
+     * length, which is an address rather than a name. Where the label actually
+     * lives is unknown, and the remaining function ids on this feature are
+     * reportedly set-name, move and delete-host — a blind call to the last would
+     * unpair one of the user's computers, so it was left alone.
+     */
+    readonly hostName: 32;
+};
+export declare const LOGITECH_CHANGE_HOST: {
+    /** getCurrentHost. */
+    readonly current: 0;
+    /** setCurrentHost(slot) — disconnects this host on success. */
+    readonly set: 16;
+};
+/** Status 1 means a computer is paired to the slot; 0 means it is empty. */
+export declare const LOGITECH_HOST_STATUS_PAIRED = 1;
+export interface LogitechHostsInfo {
+    hostCount: number;
+    currentHost: number;
+    capabilities: number;
+}
+export declare function decodeHostsInfo(payload: Uint8Array | readonly number[]): LogitechHostsInfo | null;
+export declare function decodeHostPaired(payload: Uint8Array | readonly number[]): boolean | null;
+export type LogitechHostSwitchRejection = "no-hosts" | "out-of-range" | "already-current" | "empty-slot";
+/**
+ * Why a host switch must not be sent, or null when it may be.
+ *
+ * Refusing an empty slot is the important one. Switching into a slot with no
+ * computer paired leaves the mouse unreachable until someone presses the
+ * button on its underside, and no warning text makes that an acceptable thing
+ * for a misclick to do.
+ */
+export declare function rejectHostSwitch(slot: number, info: LogitechHostsInfo | null, paired: readonly boolean[]): LogitechHostSwitchRejection | null;
+export declare function buildHostSwitchWrite(slot: number): number[];
+//# sourceMappingURL=hosts.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"hosts.d.ts","sourceRoot":"","sources":["../../src/logitech/hosts.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;GAYG;AAEH,eAAO,MAAM,cAAc;IACzB,+DAA+D;;IAE/D,yEAAyE;;IAEzE;;;;;;;OAOG;;CAEK,CAAC;AAEX,eAAO,MAAM,oBAAoB;IAC/B,sBAAsB;;IAEtB,+DAA+D;;CAEvD,CAAC;AAEX,4EAA4E;AAC5E,eAAO,MAAM,2BAA2B,IAAO,CAAC;AAEhD,MAAM,WAAW,iBAAiB;IAChC,SAAS,EAAE,MAAM,CAAC;IAClB,WAAW,EAAE,MAAM,CAAC;IACpB,YAAY,EAAE,MAAM,CAAC;CACtB;AAED,wBAAgB,eAAe,CAAC,OAAO,EAAE,UAAU,GAAG,SAAS,MAAM,EAAE,GAAG,iBAAiB,GAAG,IAAI,CAajG;AAED,wBAAgB,gBAAgB,CAAC,OAAO,EAAE,UAAU,GAAG,SAAS,MAAM,EAAE,GAAG,OAAO,GAAG,IAAI,CAGxF;AAED,MAAM,MAAM,2BAA2B,GAAG,UAAU,GAAG,cAAc,GAAG,iBAAiB,GAAG,YAAY,CAAC;AAEzG;;;;;;;GAOG;AACH,wBAAgB,gBAAgB,CAC9B,IAAI,EAAE,MAAM,EACZ,IAAI,EAAE,iBAAiB,GAAG,IAAI,EAC9B,MAAM,EAAE,SAAS,OAAO,EAAE,GACzB,2BAA2B,GAAG,IAAI,CAMpC;AAED,wBAAgB,oBAAoB,CAAC,IAAI,EAAE,MAAM,GAAG,MAAM,EAAE,CAE3D"}