@openmouse/protocol 0.1.0

package/dist/glorious/index.js

@@ -0,0 +1,236 @@
+/**
+ * Pure encoding rules of the Glorious Model O 2 / I 2 family (Pixart firmware,
+ * VID 0x093a). The configuration interface is write-only: the firmware accepts
+ * a 256-byte settings payload assembled from four 64-byte feature reports
+ * (report ID 0x03) on USB interface 1, but never echoes settings back.
+ * Reverse-engineered layout: https://github.com/zeppybabe/gloriousctl-linux.
+ */
+export const GLORIOUS_CONFIG_REPORT_ID = 0x03;
+export const GLORIOUS_PACKET_LENGTH = 64;
+const SETTINGS_FRAGMENTS = 4;
+const SETTINGS_CMD = [0x04, 0xfb];
+export const GLORIOUS_DPI_UNIT = 50;
+export const GLORIOUS_DPI_MIN = 100;
+export const GLORIOUS_DPI_MAX = 26000;
+/** Payload byte [9]: 0x01(1k), 0x02(125), 0x03(250), 0x04(500). */
+export const GLORIOUS_POLLING_RATES = [
+    [0x02, 125],
+    [0x03, 250],
+    [0x04, 500],
+    [0x01, 1000],
+];
+/** Payload byte [7]: 0x01 (1 mm) or 0x02 (2 mm); 0.7 mm is not exposed. */
+export const GLORIOUS_LOD_MEDIUM_MM = 1;
+export const GLORIOUS_LOD_HIGH_MM = 2;
+/** Payload byte [8]: debounce in milliseconds, even numbers, 0x00-0x10. */
+export const GLORIOUS_DEBOUNCE_MAX_MS = 16;
+export const GLORIOUS_MAX_STAGES = 6;
+/** Lighting payload (cmd 02 fb) RGB effect ids ([5]). */
+export const GLORIOUS_RGB_EFFECTS = {
+    off: 0x00,
+    glorious: 0x01,
+    seamlessBreathing: 0x02,
+    breathing: 0x03,
+    normallyOn: 0x04,
+    breathingSingle: 0x05,
+    tail: 0x06,
+    rave: 0x07,
+    wave: 0x08,
+};
+export const GLORIOUS_EFFECT_OPTIONS = [
+    ["glorious", "Glorious"],
+    ["off", "LEDs off"],
+    ["seamlessBreathing", "Seamless breathing"],
+    ["breathing", "Breathing (rainbow)"],
+    ["normallyOn", "Solid color"],
+    ["breathingSingle", "Breathing (solid)"],
+    ["tail", "Tail"],
+    ["rave", "Rave"],
+    ["wave", "Wave"],
+];
+/** Brightness ([6]/[7]) and speed ([9]) map onto five/four CORE levels. */
+export const GLORIOUS_BRIGHTNESS_LEVELS = [0x00, 0x05, 0x0a, 0x0f, 0x14];
+export const GLORIOUS_SPEED_LEVELS = [0x05, 0x0a, 0x0f, 0x14];
+export const GLORIOUS_DEFAULT_LIGHTING = {
+    effect: GLORIOUS_RGB_EFFECTS.glorious,
+    brightnessWired: 0x14,
+    brightnessWireless: 0x14,
+    speed: 0x0a,
+    colors: ["#ff0000", "#ff7f00", "#ffff00", "#00ff00", "#0000ff", "#4b0082", "#9400d3"],
+};
+const LIGHTING_CMD = [0x02, 0xfb];
+const LIGHTING_FRAGMENTS = 3;
+const LIGHTING_MODIFIER = 0x14;
+/** Number of palette slots an effect consumes ([8]): solid 1, rave 2, rainbow 7. */
+export function gloriousLightingColorCount(effect) {
+    if (effect === GLORIOUS_RGB_EFFECTS.rave)
+        return 2;
+    if (effect === GLORIOUS_RGB_EFFECTS.off
+        || effect === GLORIOUS_RGB_EFFECTS.normallyOn
+        || effect === GLORIOUS_RGB_EFFECTS.breathingSingle)
+        return 1;
+    return 7;
+}
+function hexToRgb(hex) {
+    return [
+        parseInt(hex.slice(1, 3), 16) || 0,
+        parseInt(hex.slice(3, 5), 16) || 0,
+        parseInt(hex.slice(5, 7), 16) || 0,
+    ];
+}
+/**
+ * Builds the three 64-byte feature-report fragments of the lighting payload:
+ * fragment 0 carries effect, wireless/wired brightness, color count, speed,
+ * modifier, and the primary color; fragment 1 echoes the effect and holds the
+ * six-cycle palette; fragment 2 echoes the effect again.
+ */
+export function buildGloriousLightingPayload(lighting) {
+    const fragments = Array.from({ length: LIGHTING_FRAGMENTS }, () => new Uint8Array(GLORIOUS_PACKET_LENGTH));
+    fragments.forEach((fragment, index) => {
+        fragment[0] = GLORIOUS_CONFIG_REPORT_ID;
+        fragment[1] = LIGHTING_CMD[0];
+        fragment[2] = LIGHTING_CMD[1];
+        fragment[3] = index;
+        fragment[4] = 0x01;
+    });
+    const first = fragments[0];
+    first[5] = lighting.effect;
+    first[6] = lighting.brightnessWireless;
+    first[7] = lighting.brightnessWired;
+    first[8] = gloriousLightingColorCount(lighting.effect);
+    first[9] = lighting.speed;
+    first[10] = LIGHTING_MODIFIER;
+    first.set(hexToRgb(lighting.colors[0] ?? GLORIOUS_DEFAULT_LIGHTING.colors[0]), 11);
+    const second = fragments[1];
+    second[5] = lighting.effect;
+    for (let index = 1; index <= 6; index += 1) {
+        second.set(hexToRgb(lighting.colors[index] ?? "#000000"), 3 + index * 3);
+    }
+    fragments[2][5] = lighting.effect;
+    return fragments;
+}
+/** Repairs untrusted persisted lighting state into a payload-safe object. */
+export function gloriousNormalizeLighting(value) {
+    const parsed = typeof value === "object" && value !== null ? value : {};
+    const validEffects = new Set(Object.values(GLORIOUS_RGB_EFFECTS));
+    const nearestLevel = (levels, candidate) => {
+        if (typeof candidate !== "number")
+            return levels.at(-1);
+        return levels.reduce((best, level) => Math.abs(level - candidate) < Math.abs(best - candidate) ? level : best);
+    };
+    const colorPattern = /^#[0-9a-f]{6}$/i;
+    return {
+        effect: validEffects.has(Number(parsed.effect)) ? Number(parsed.effect) : GLORIOUS_DEFAULT_LIGHTING.effect,
+        brightnessWired: nearestLevel(GLORIOUS_BRIGHTNESS_LEVELS, parsed.brightnessWired),
+        brightnessWireless: nearestLevel(GLORIOUS_BRIGHTNESS_LEVELS, parsed.brightnessWireless),
+        speed: nearestLevel(GLORIOUS_SPEED_LEVELS, parsed.speed),
+        colors: GLORIOUS_DEFAULT_LIGHTING.colors.map((fallback, index) => {
+            const stored = Array.isArray(parsed.colors) ? parsed.colors[index] : undefined;
+            return typeof stored === "string" && colorPattern.test(stored) ? stored.toLowerCase() : fallback;
+        }),
+    };
+}
+/** Factory per-stage indicator colors (red, blue, green, yellow), then unset. */
+export const GLORIOUS_DEFAULT_STAGE_COLORS = [
+    "#ff0000",
+    "#0000ff",
+    "#00ff00",
+    "#ffff00",
+    "#000000",
+    "#000000",
+];
+export const GLORIOUS_DEFAULT_SETTINGS = {
+    activeStage: 0,
+    stageCount: 4,
+    stageDpis: [400, 800, 1600, 3200, 0, 0],
+    stageColors: [...GLORIOUS_DEFAULT_STAGE_COLORS],
+    lodMm: GLORIOUS_LOD_MEDIUM_MM,
+    debounceMs: 10,
+    pollingCode: 0x01,
+};
+// Stage 1 lives in fragment 0 after the global bytes; stages 2-3 share
+// fragment 1, stages 4-5 fragment 2, and stage 6 fragment 3.
+const STAGE_OFFSETS = [
+    [0, 11],
+    [1, 5],
+    [1, 10],
+    [2, 5],
+    [2, 10],
+    [3, 5],
+];
+export function gloriousEncodeDpi(dpi) {
+    return Math.round(dpi / GLORIOUS_DPI_UNIT);
+}
+export function gloriousIsSupportedDpi(dpi) {
+    return Number.isInteger(dpi)
+        && dpi >= GLORIOUS_DPI_MIN
+        && dpi <= GLORIOUS_DPI_MAX
+        && dpi % GLORIOUS_DPI_UNIT === 0;
+}
+export function gloriousEncodePolling(hertz) {
+    return GLORIOUS_POLLING_RATES.find(([, value]) => value === hertz)?.[0] ?? null;
+}
+export function gloriousDecodePolling(code) {
+    return GLORIOUS_POLLING_RATES.find(([value]) => value === code)?.[1] ?? null;
+}
+export function gloriousSanitizeDebounce(milliseconds) {
+    const clamped = Math.min(Math.max(Math.round(milliseconds), 0), GLORIOUS_DEBOUNCE_MAX_MS);
+    return clamped % 2 === 0 ? clamped : clamped - 1;
+}
+/**
+ * Builds the four 64-byte feature-report fragments of the settings payload:
+ * header (report ID 0x03, cmd 04 fb, sequence, pad 0x01), then the global
+ * bytes ([5] active stage, [6] total stages, [7] LOD, [8] debounce, [9]
+ * polling) followed by little-endian DPI u16 divided by 50 plus RGB per stage.
+ */
+export function buildGloriousSettingsPayload(settings) {
+    const fragments = Array.from({ length: SETTINGS_FRAGMENTS }, () => new Uint8Array(GLORIOUS_PACKET_LENGTH));
+    fragments.forEach((fragment, index) => {
+        fragment[0] = GLORIOUS_CONFIG_REPORT_ID;
+        fragment[1] = SETTINGS_CMD[0];
+        fragment[2] = SETTINGS_CMD[1];
+        fragment[3] = index;
+        fragment[4] = 0x01;
+    });
+    const first = fragments[0];
+    first[5] = settings.activeStage;
+    first[6] = settings.stageCount;
+    first[7] = settings.lodMm;
+    first[8] = settings.debounceMs;
+    first[9] = settings.pollingCode;
+    first[10] = 0x00;
+    STAGE_OFFSETS.forEach(([fragmentIndex, offset], stageIndex) => {
+        const encoded = gloriousEncodeDpi(settings.stageDpis[stageIndex] ?? 0);
+        const fragment = fragments[fragmentIndex];
+        fragment[offset] = encoded & 0xff;
+        fragment[offset + 1] = encoded >> 8 & 0xff;
+        fragment.set(hexToRgb(settings.stageColors?.[stageIndex] ?? GLORIOUS_DEFAULT_STAGE_COLORS[stageIndex]), offset + 2);
+    });
+    return fragments;
+}
+/** Repairs untrusted persisted state into a payload-safe settings object. */
+export function gloriousNormalizeSettings(value) {
+    const parsed = typeof value === "object" && value !== null ? value : {};
+    const stageDpis = GLORIOUS_DEFAULT_SETTINGS.stageDpis.map((fallback, index) => {
+        const stored = Array.isArray(parsed.stageDpis) ? parsed.stageDpis[index] : undefined;
+        return typeof stored === "number" && gloriousIsSupportedDpi(stored) ? stored : fallback;
+    });
+    const pollingCode = Number(parsed.pollingCode);
+    const colorPattern = /^#[0-9a-f]{6}$/i;
+    return {
+        activeStage: sanitizeIndex(parsed.activeStage),
+        stageCount: Math.min(Math.max(sanitizeIndex(parsed.stageCount, GLORIOUS_MAX_STAGES), GLORIOUS_DEFAULT_SETTINGS.stageCount), GLORIOUS_MAX_STAGES),
+        stageDpis,
+        stageColors: GLORIOUS_DEFAULT_STAGE_COLORS.map((fallback, index) => {
+            const stored = Array.isArray(parsed.stageColors) ? parsed.stageColors[index] : undefined;
+            return typeof stored === "string" && colorPattern.test(stored) ? stored.toLowerCase() : fallback;
+        }),
+        lodMm: parsed.lodMm === GLORIOUS_LOD_HIGH_MM ? GLORIOUS_LOD_HIGH_MM : GLORIOUS_LOD_MEDIUM_MM,
+        debounceMs: gloriousSanitizeDebounce(typeof parsed.debounceMs === "number" ? parsed.debounceMs : GLORIOUS_DEFAULT_SETTINGS.debounceMs),
+        pollingCode: gloriousDecodePolling(pollingCode) ? pollingCode : GLORIOUS_DEFAULT_SETTINGS.pollingCode,
+    };
+}
+function sanitizeIndex(value, max = GLORIOUS_MAX_STAGES - 1) {
+    return typeof value === "number" && Number.isInteger(value) && value >= 0 && value <= max ? value : 0;
+}
+//# sourceMappingURL=index.js.map

package/dist/glorious/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/glorious/index.ts"],"names":[],"mappings":"AAAA;;;;;;GAMG;AAEH,MAAM,CAAC,MAAM,yBAAyB,GAAG,IAAI,CAAC;AAC9C,MAAM,CAAC,MAAM,sBAAsB,GAAG,EAAE,CAAC;AAEzC,MAAM,kBAAkB,GAAG,CAAC,CAAC;AAC7B,MAAM,YAAY,GAA8B,CAAC,IAAI,EAAE,IAAI,CAAC,CAAC;AAE7D,MAAM,CAAC,MAAM,iBAAiB,GAAG,EAAE,CAAC;AACpC,MAAM,CAAC,MAAM,gBAAgB,GAAG,GAAG,CAAC;AACpC,MAAM,CAAC,MAAM,gBAAgB,GAAG,KAAK,CAAC;AAEtC,mEAAmE;AACnE,MAAM,CAAC,MAAM,sBAAsB,GAA0D;IAC3F,CAAC,IAAI,EAAE,GAAG,CAAC;IACX,CAAC,IAAI,EAAE,GAAG,CAAC;IACX,CAAC,IAAI,EAAE,GAAG,CAAC;IACX,CAAC,IAAI,EAAE,IAAI,CAAC;CACb,CAAC;AAEF,2EAA2E;AAC3E,MAAM,CAAC,MAAM,sBAAsB,GAAG,CAAC,CAAC;AACxC,MAAM,CAAC,MAAM,oBAAoB,GAAG,CAAC,CAAC;AAEtC,2EAA2E;AAC3E,MAAM,CAAC,MAAM,wBAAwB,GAAG,EAAE,CAAC;AAE3C,MAAM,CAAC,MAAM,mBAAmB,GAAG,CAAC,CAAC;AAErC,yDAAyD;AACzD,MAAM,CAAC,MAAM,oBAAoB,GAAG;IAClC,GAAG,EAAE,IAAI;IACT,QAAQ,EAAE,IAAI;IACd,iBAAiB,EAAE,IAAI;IACvB,SAAS,EAAE,IAAI;IACf,UAAU,EAAE,IAAI;IAChB,eAAe,EAAE,IAAI;IACrB,IAAI,EAAE,IAAI;IACV,IAAI,EAAE,IAAI;IACV,IAAI,EAAE,IAAI;CACF,CAAC;AAIX,MAAM,CAAC,MAAM,uBAAuB,GAAqE;IACvG,CAAC,UAAU,EAAE,UAAU,CAAC;IACxB,CAAC,KAAK,EAAE,UAAU,CAAC;IACnB,CAAC,mBAAmB,EAAE,oBAAoB,CAAC;IAC3C,CAAC,WAAW,EAAE,qBAAqB,CAAC;IACpC,CAAC,YAAY,EAAE,aAAa,CAAC;IAC7B,CAAC,iBAAiB,EAAE,mBAAmB,CAAC;IACxC,CAAC,MAAM,EAAE,MAAM,CAAC;IAChB,CAAC,MAAM,EAAE,MAAM,CAAC;IAChB,CAAC,MAAM,EAAE,MAAM,CAAC;CACjB,CAAC;AAEF,2EAA2E;AAC3E,MAAM,CAAC,MAAM,0BAA0B,GAA0B,CAAC,IAAI,EAAE,IAAI,EAAE,IAAI,EAAE,IAAI,EAAE,IAAI,CAAC,CAAC;AAChG,MAAM,CAAC,MAAM,qBAAqB,GAA0B,CAAC,IAAI,EAAE,IAAI,EAAE,IAAI,EAAE,IAAI,CAAC,CAAC;AAYrF,MAAM,CAAC,MAAM,yBAAyB,GAAqB;IACzD,MAAM,EAAE,oBAAoB,CAAC,QAAQ;IACrC,eAAe,EAAE,IAAI;IACrB,kBAAkB,EAAE,IAAI;IACxB,KAAK,EAAE,IAAI;IACX,MAAM,EAAE,CAAC,SAAS,EAAE,SAAS,EAAE,SAAS,EAAE,SAAS,EAAE,SAAS,EAAE,SAAS,EAAE,SAAS,CAAC;CACtF,CAAC;AAEF,MAAM,YAAY,GAA8B,CAAC,IAAI,EAAE,IAAI,CAAC,CAAC;AAC7D,MAAM,kBAAkB,GAAG,CAAC,CAAC;AAC7B,MAAM,iBAAiB,GAAG,IAAI,CAAC;AAE/B,oFAAoF;AACpF,MAAM,UAAU,0BAA0B,CAAC,MAAc;IACvD,IAAI,MAAM,KAAK,oBAAoB,CAAC,IAAI;QAAE,OAAO,CAAC,CAAC;IACnD,IAAI,MAAM,KAAK,oBAAoB,CAAC,GAAG;WAClC,MAAM,KAAK,oBAAoB,CAAC,UAAU;WAC1C,MAAM,KAAK,oBAAoB,CAAC,eAAe;QAAE,OAAO,CAAC,CAAC;IAC/D,OAAO,CAAC,CAAC;AACX,CAAC;AAED,SAAS,QAAQ,CAAC,GAAW;IAC3B,OAAO;QACL,QAAQ,CAAC,GAAG,CAAC,KAAK,CAAC,CAAC,EAAE,CAAC,CAAC,EAAE,EAAE,CAAC,IAAI,CAAC;QAClC,QAAQ,CAAC,GAAG,CAAC,KAAK,CAAC,CAAC,EAAE,CAAC,CAAC,EAAE,EAAE,CAAC,IAAI,CAAC;QAClC,QAAQ,CAAC,GAAG,CAAC,KAAK,CAAC,CAAC,EAAE,CAAC,CAAC,EAAE,EAAE,CAAC,IAAI,CAAC;KACnC,CAAC;AACJ,CAAC;AAED;;;;;GAKG;AACH,MAAM,UAAU,4BAA4B,CAAC,QAA0B;IACrE,MAAM,SAAS,GAAG,KAAK,CAAC,IAAI,CAAC,EAAE,MAAM,EAAE,kBAAkB,EAAE,EAAE,GAAG,EAAE,CAAC,IAAI,UAAU,CAAC,sBAAsB,CAAC,CAAC,CAAC;IAC3G,SAAS,CAAC,OAAO,CAAC,CAAC,QAAQ,EAAE,KAAK,EAAE,EAAE;QACpC,QAAQ,CAAC,CAAC,CAAC,GAAG,yBAAyB,CAAC;QACxC,QAAQ,CAAC,CAAC,CAAC,GAAG,YAAY,CAAC,CAAC,CAAC,CAAC;QAC9B,QAAQ,CAAC,CAAC,CAAC,GAAG,YAAY,CAAC,CAAC,CAAC,CAAC;QAC9B,QAAQ,CAAC,CAAC,CAAC,GAAG,KAAK,CAAC;QACpB,QAAQ,CAAC,CAAC,CAAC,GAAG,IAAI,CAAC;IACrB,CAAC,CAAC,CAAC;IAEH,MAAM,KAAK,GAAG,SAAS,CAAC,CAAC,CAAC,CAAC;IAC3B,KAAK,CAAC,CAAC,CAAC,GAAG,QAAQ,CAAC,MAAM,CAAC;IAC3B,KAAK,CAAC,CAAC,CAAC,GAAG,QAAQ,CAAC,kBAAkB,CAAC;IACvC,KAAK,CAAC,CAAC,CAAC,GAAG,QAAQ,CAAC,eAAe,CAAC;IACpC,KAAK,CAAC,CAAC,CAAC,GAAG,0BAA0B,CAAC,QAAQ,CAAC,MAAM,CAAC,CAAC;IACvD,KAAK,CAAC,CAAC,CAAC,GAAG,QAAQ,CAAC,KAAK,CAAC;IAC1B,KAAK,CAAC,EAAE,CAAC,GAAG,iBAAiB,CAAC;IAC9B,KAAK,CAAC,GAAG,CAAC,QAAQ,CAAC,QAAQ,CAAC,MAAM,CAAC,CAAC,CAAC,IAAI,yBAAyB,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC;IAEnF,MAAM,MAAM,GAAG,SAAS,CAAC,CAAC,CAAC,CAAC;IAC5B,MAAM,CAAC,CAAC,CAAC,GAAG,QAAQ,CAAC,MAAM,CAAC;IAC5B,KAAK,IAAI,KAAK,GAAG,CAAC,EAAE,KAAK,IAAI,CAAC,EAAE,KAAK,IAAI,CAAC,EAAE,CAAC;QAC3C,MAAM,CAAC,GAAG,CAAC,QAAQ,CAAC,QAAQ,CAAC,MAAM,CAAC,KAAK,CAAC,IAAI,SAAS,CAAC,EAAE,CAAC,GAAG,KAAK,GAAG,CAAC,CAAC,CAAC;IAC3E,CAAC;IAED,SAAS,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,GAAG,QAAQ,CAAC,MAAM,CAAC;IAClC,OAAO,SAAS,CAAC;AACnB,CAAC;AAED,6EAA6E;AAC7E,MAAM,UAAU,yBAAyB,CAAC,KAAc;IACtD,MAAM,MAAM,GAAG,OAAO,KAAK,KAAK,QAAQ,IAAI,KAAK,KAAK,IAAI,CAAC,CAAC,CAAC,KAAkC,CAAC,CAAC,CAAC,EAAE,CAAC;IACrG,MAAM,YAAY,GAAG,IAAI,GAAG,CAAC,MAAM,CAAC,MAAM,CAAC,oBAAoB,CAAC,CAAC,CAAC;IAClE,MAAM,YAAY,GAAG,CAAC,MAA6B,EAAE,SAAkB,EAAU,EAAE;QACjF,IAAI,OAAO,SAAS,KAAK,QAAQ;YAAE,OAAO,MAAM,CAAC,EAAE,CAAC,CAAC,CAAC,CAAE,CAAC;QACzD,OAAO,MAAM,CAAC,MAAM,CAAC,CAAC,IAAI,EAAE,KAAK,EAAE,EAAE,CACnC,IAAI,CAAC,GAAG,CAAC,KAAK,GAAG,SAAS,CAAC,GAAG,IAAI,CAAC,GAAG,CAAC,IAAI,GAAG,SAAS,CAAC,CAAC,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC;IAC7E,CAAC,CAAC;IACF,MAAM,YAAY,GAAG,iBAAiB,CAAC;IACvC,OAAO;QACL,MAAM,EAAE,YAAY,CAAC,GAAG,CAAC,MAAM,CAAC,MAAM,CAAC,MAAM,CAAU,CAAC,CAAC,CAAC,CAAC,MAAM,CAAC,MAAM,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC,yBAAyB,CAAC,MAAM;QACnH,eAAe,EAAE,YAAY,CAAC,0BAA0B,EAAE,MAAM,CAAC,eAAe,CAAC;QACjF,kBAAkB,EAAE,YAAY,CAAC,0BAA0B,EAAE,MAAM,CAAC,kBAAkB,CAAC;QACvF,KAAK,EAAE,YAAY,CAAC,qBAAqB,EAAE,MAAM,CAAC,KAAK,CAAC;QACxD,MAAM,EAAE,yBAAyB,CAAC,MAAM,CAAC,GAAG,CAAC,CAAC,QAAQ,EAAE,KAAK,EAAE,EAAE;YAC/D,MAAM,MAAM,GAAG,KAAK,CAAC,OAAO,CAAC,MAAM,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC,MAAM,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,SAAS,CAAC;YAC/E,OAAO,OAAO,MAAM,KAAK,QAAQ,IAAI,YAAY,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC,MAAM,CAAC,WAAW,EAAE,CAAC,CAAC,CAAC,QAAQ,CAAC;QACnG,CAAC,CAAC;KACH,CAAC;AACJ,CAAC;AAgBD,iFAAiF;AACjF,MAAM,CAAC,MAAM,6BAA6B,GAA0B;IAClE,SAAS;IACT,SAAS;IACT,SAAS;IACT,SAAS;IACT,SAAS;IACT,SAAS;CACV,CAAC;AAEF,MAAM,CAAC,MAAM,yBAAyB,GAAqB;IACzD,WAAW,EAAE,CAAC;IACd,UAAU,EAAE,CAAC;IACb,SAAS,EAAE,CAAC,GAAG,EAAE,GAAG,EAAE,IAAI,EAAE,IAAI,EAAE,CAAC,EAAE,CAAC,CAAC;IACvC,WAAW,EAAE,CAAC,GAAG,6BAA6B,CAAC;IAC/C,KAAK,EAAE,sBAAsB;IAC7B,UAAU,EAAE,EAAE;IACd,WAAW,EAAE,IAAI;CAClB,CAAC;AAEF,uEAAuE;AACvE,6DAA6D;AAC7D,MAAM,aAAa,GAA+D;IAChF,CAAC,CAAC,EAAE,EAAE,CAAC;IACP,CAAC,CAAC,EAAE,CAAC,CAAC;IACN,CAAC,CAAC,EAAE,EAAE,CAAC;IACP,CAAC,CAAC,EAAE,CAAC,CAAC;IACN,CAAC,CAAC,EAAE,EAAE,CAAC;IACP,CAAC,CAAC,EAAE,CAAC,CAAC;CACP,CAAC;AAEF,MAAM,UAAU,iBAAiB,CAAC,GAAW;IAC3C,OAAO,IAAI,CAAC,KAAK,CAAC,GAAG,GAAG,iBAAiB,CAAC,CAAC;AAC7C,CAAC;AAED,MAAM,UAAU,sBAAsB,CAAC,GAAW;IAChD,OAAO,MAAM,CAAC,SAAS,CAAC,GAAG,CAAC;WACvB,GAAG,IAAI,gBAAgB;WACvB,GAAG,IAAI,gBAAgB;WACvB,GAAG,GAAG,iBAAiB,KAAK,CAAC,CAAC;AACrC,CAAC;AAED,MAAM,UAAU,qBAAqB,CAAC,KAAa;IACjD,OAAO,sBAAsB,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,KAAK,CAAC,EAAE,EAAE,CAAC,KAAK,KAAK,KAAK,CAAC,EAAE,CAAC,CAAC,CAAC,IAAI,IAAI,CAAC;AAClF,CAAC;AAED,MAAM,UAAU,qBAAqB,CAAC,IAAY;IAChD,OAAO,sBAAsB,CAAC,IAAI,CAAC,CAAC,CAAC,KAAK,CAAC,EAAE,EAAE,CAAC,KAAK,KAAK,IAAI,CAAC,EAAE,CAAC,CAAC,CAAC,IAAI,IAAI,CAAC;AAC/E,CAAC;AAED,MAAM,UAAU,wBAAwB,CAAC,YAAoB;IAC3D,MAAM,OAAO,GAAG,IAAI,CAAC,GAAG,CAAC,IAAI,CAAC,GAAG,CAAC,IAAI,CAAC,KAAK,CAAC,YAAY,CAAC,EAAE,CAAC,CAAC,EAAE,wBAAwB,CAAC,CAAC;IAC1F,OAAO,OAAO,GAAG,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,OAAO,CAAC,CAAC,CAAC,OAAO,GAAG,CAAC,CAAC;AACnD,CAAC;AAED;;;;;GAKG;AACH,MAAM,UAAU,4BAA4B,CAAC,QAA0B;IACrE,MAAM,SAAS,GAAG,KAAK,CAAC,IAAI,CAAC,EAAE,MAAM,EAAE,kBAAkB,EAAE,EAAE,GAAG,EAAE,CAAC,IAAI,UAAU,CAAC,sBAAsB,CAAC,CAAC,CAAC;IAC3G,SAAS,CAAC,OAAO,CAAC,CAAC,QAAQ,EAAE,KAAK,EAAE,EAAE;QACpC,QAAQ,CAAC,CAAC,CAAC,GAAG,yBAAyB,CAAC;QACxC,QAAQ,CAAC,CAAC,CAAC,GAAG,YAAY,CAAC,CAAC,CAAC,CAAC;QAC9B,QAAQ,CAAC,CAAC,CAAC,GAAG,YAAY,CAAC,CAAC,CAAC,CAAC;QAC9B,QAAQ,CAAC,CAAC,CAAC,GAAG,KAAK,CAAC;QACpB,QAAQ,CAAC,CAAC,CAAC,GAAG,IAAI,CAAC;IACrB,CAAC,CAAC,CAAC;IAEH,MAAM,KAAK,GAAG,SAAS,CAAC,CAAC,CAAC,CAAC;IAC3B,KAAK,CAAC,CAAC,CAAC,GAAG,QAAQ,CAAC,WAAW,CAAC;IAChC,KAAK,CAAC,CAAC,CAAC,GAAG,QAAQ,CAAC,UAAU,CAAC;IAC/B,KAAK,CAAC,CAAC,CAAC,GAAG,QAAQ,CAAC,KAAK,CAAC;IAC1B,KAAK,CAAC,CAAC,CAAC,GAAG,QAAQ,CAAC,UAAU,CAAC;IAC/B,KAAK,CAAC,CAAC,CAAC,GAAG,QAAQ,CAAC,WAAW,CAAC;IAChC,KAAK,CAAC,EAAE,CAAC,GAAG,IAAI,CAAC;IAEjB,aAAa,CAAC,OAAO,CAAC,CAAC,CAAC,aAAa,EAAE,MAAM,CAAC,EAAE,UAAU,EAAE,EAAE;QAC5D,MAAM,OAAO,GAAG,iBAAiB,CAAC,QAAQ,CAAC,SAAS,CAAC,UAAU,CAAC,IAAI,CAAC,CAAC,CAAC;QACvE,MAAM,QAAQ,GAAG,SAAS,CAAC,aAAa,CAAC,CAAC;QAC1C,QAAQ,CAAC,MAAM,CAAC,GAAG,OAAO,GAAG,IAAI,CAAC;QAClC,QAAQ,CAAC,MAAM,GAAG,CAAC,CAAC,GAAG,OAAO,IAAI,CAAC,GAAG,IAAI,CAAC;QAC3C,QAAQ,CAAC,GAAG,CAAC,QAAQ,CAAC,QAAQ,CAAC,WAAW,EAAE,CAAC,UAAU,CAAC,IAAI,6BAA6B,CAAC,UAAU,CAAC,CAAC,EAAE,MAAM,GAAG,CAAC,CAAC,CAAC;IACtH,CAAC,CAAC,CAAC;IACH,OAAO,SAAS,CAAC;AACnB,CAAC;AAED,6EAA6E;AAC7E,MAAM,UAAU,yBAAyB,CAAC,KAAc;IACtD,MAAM,MAAM,GAAG,OAAO,KAAK,KAAK,QAAQ,IAAI,KAAK,KAAK,IAAI,CAAC,CAAC,CAAC,KAAkC,CAAC,CAAC,CAAC,EAAE,CAAC;IACrG,MAAM,SAAS,GAAG,yBAAyB,CAAC,SAAS,CAAC,GAAG,CAAC,CAAC,QAAQ,EAAE,KAAK,EAAE,EAAE;QAC5E,MAAM,MAAM,GAAG,KAAK,CAAC,OAAO,CAAC,MAAM,CAAC,SAAS,CAAC,CAAC,CAAC,CAAC,MAAM,CAAC,SAAS,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,SAAS,CAAC;QACrF,OAAO,OAAO,MAAM,KAAK,QAAQ,IAAI,sBAAsB,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC,MAAM,CAAC,CAAC,CAAC,QAAQ,CAAC;IAC1F,CAAC,CAAC,CAAC;IACH,MAAM,WAAW,GAAG,MAAM,CAAC,MAAM,CAAC,WAAW,CAAC,CAAC;IAC/C,MAAM,YAAY,GAAG,iBAAiB,CAAC;IACvC,OAAO;QACL,WAAW,EAAE,aAAa,CAAC,MAAM,CAAC,WAAW,CAAC;QAC9C,UAAU,EAAE,IAAI,CAAC,GAAG,CAClB,IAAI,CAAC,GAAG,CAAC,aAAa,CAAC,MAAM,CAAC,UAAU,EAAE,mBAAmB,CAAC,EAAE,yBAAyB,CAAC,UAAU,CAAC,EACrG,mBAAmB,CAAC;QACtB,SAAS;QACT,WAAW,EAAE,6BAA6B,CAAC,GAAG,CAAC,CAAC,QAAQ,EAAE,KAAK,EAAE,EAAE;YACjE,MAAM,MAAM,GAAG,KAAK,CAAC,OAAO,CAAC,MAAM,CAAC,WAAW,CAAC,CAAC,CAAC,CAAC,MAAM,CAAC,WAAW,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,SAAS,CAAC;YACzF,OAAO,OAAO,MAAM,KAAK,QAAQ,IAAI,YAAY,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC,MAAM,CAAC,WAAW,EAAE,CAAC,CAAC,CAAC,QAAQ,CAAC;QACnG,CAAC,CAAC;QACF,KAAK,EAAE,MAAM,CAAC,KAAK,KAAK,oBAAoB,CAAC,CAAC,CAAC,oBAAoB,CAAC,CAAC,CAAC,sBAAsB;QAC5F,UAAU,EAAE,wBAAwB,CAClC,OAAO,MAAM,CAAC,UAAU,KAAK,QAAQ,CAAC,CAAC,CAAC,MAAM,CAAC,UAAU,CAAC,CAAC,CAAC,yBAAyB,CAAC,UAAU,CAAC;QACnG,WAAW,EAAE,qBAAqB,CAAC,WAAW,CAAC,CAAC,CAAC,CAAC,WAAW,CAAC,CAAC,CAAC,yBAAyB,CAAC,WAAW;KACtG,CAAC;AACJ,CAAC;AAED,SAAS,aAAa,CAAC,KAAc,EAAE,GAAG,GAAG,mBAAmB,GAAG,CAAC;IAClE,OAAO,OAAO,KAAK,KAAK,QAAQ,IAAI,MAAM,CAAC,SAAS,CAAC,KAAK,CAAC,IAAI,KAAK,IAAI,CAAC,IAAI,KAAK,IAAI,GAAG,CAAC,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,CAAC;AACxG,CAAC"}

package/dist/glorious-classic/index.d.ts

@@ -0,0 +1,103 @@
+/**
+ * Pure encoding rules for Glorious's "classic" HID feature-report protocol,
+ * used by the pre-Pixart Model O / Model D / Model I lines (VIDs 0x258a,
+ * 0x22d4, 0x320f, 0x3794) — the same wire format the official Windows
+ * software, and community tools glorious-ctl and mxw, use. Distinct from the
+ * Pixart Model O 2 / I 2 protocol in ../glorious/index.ts, which is
+ * write-only in a different way and has a different report layout.
+ *
+ * RGB, debounce, and battery are reverse-engineered from
+ * https://github.com/louis4craft/glorious-ctl (mouse.py). DPI, polling rate,
+ * and lift-off distance are reverse-engineered from
+ * https://github.com/korkje/mxw (Rust; src/config/*.rs). Neither tool reads
+ * DPI/polling/LOD back from the mouse — both are write-only for those three,
+ * so this module is too; the driver keeps its own cache of the last-applied
+ * values (see ../drivers/glorious/classic-hid.ts).
+ *
+ * Reports are unnumbered 64-byte feature reports (report id 0). Both source
+ * tools build a 65-byte buffer with byte [0] as the hidapi report-id slot
+ * (always 0) followed by the 64-byte body; WebHID takes the report id
+ * separately, so every offset below is the source's buffer index minus 1.
+ * `bfr()` documents that shift at each call site with the source's own index.
+ */
+export declare const GLORIOUS_CLASSIC_REPORT_ID = 0;
+export declare const GLORIOUS_CLASSIC_PACKET_LENGTH = 64;
+export declare const GLORIOUS_CLASSIC_PROFILE_DEFAULT = 1;
+export declare const GLORIOUS_CLASSIC_DEBOUNCE_MAX_MS = 32;
+export type GloriousClassicRgbEffect = "off" | "glorious" | "cycle" | "pulse" | "solid" | "pulseOne" | "tail" | "rave" | "wave";
+export declare const GLORIOUS_CLASSIC_RGB_EFFECT_OPTIONS: ReadonlyArray<readonly [GloriousClassicRgbEffect, string]>;
+export interface GloriousClassicRgb {
+    effect: GloriousClassicRgbEffect;
+    /** 0-100, ignored by effects that don't take a rate. */
+    rate: number;
+    /** "#rrggbb" strings, meaning depends on effect (see buildGloriousClassicRgbPayload). */
+    colors: string[];
+    profileId?: number;
+}
+export declare const GLORIOUS_CLASSIC_DEFAULT_RGB: GloriousClassicRgb;
+/**
+ * `rate_check()` from mouse.py: 0-100 input, clamped, mapped onto the
+ * hardware's inverted byte scale. Effects 7/8 (rave/wave) use a finer step.
+ */
+export declare function gloriousClassicRateByte(rate: number, effect: GloriousClassicRgbEffect): number;
+/**
+ * Builds the single 64-byte feature-report body for an RGB write. Mirrors
+ * `set_rgb()` in mouse.py exactly, including its per-effect payload length
+ * and color-slot layout:
+ *   bfr[3]=0x02 (class), bfr[4]=<length, effect-dependent>, bfr[5]=0x02,
+ *   bfr[7]=profile, bfr[8]=0xFF, bfr[9]=<effect id>, bfr[11]=<rate>,
+ *   bfr[12..]=color triplets.
+ */
+export declare function buildGloriousClassicRgbPayload(rgb: GloriousClassicRgb): Uint8Array<ArrayBuffer>;
+export declare function buildGloriousClassicDebouncePayload(milliseconds: number, profileId?: number): Uint8Array<ArrayBuffer>;
+export declare function buildGloriousClassicBatteryRequestPayload(): Uint8Array<ArrayBuffer>;
+export type GloriousClassicBatteryState = "Normal" | "Asleep" | "WakingUp" | "Unknown";
+export interface GloriousClassicBattery {
+    state: GloriousClassicBatteryState;
+    /** 1-100, or null when the state has no meaningful percentage. */
+    percent: number | null;
+    /**
+     * bfr[7], independently confirmed by a second, unrelated implementation
+     * (AwesomeTy18/GloriousBatteryMonitor's MouseV2ProBatteryChecker.cs, C#)
+     * that reads this same command's response for the whole 0x258a device
+     * range (both core1 and core2/"V2 Pro" generations) — `inputReport[7] == 1`
+     * there is this same byte, byte-for-byte.
+     */
+    charging: boolean;
+}
+/**
+ * Mirrors `get_battery_status()`'s response parsing. `body` is the 64-byte
+ * feature-report body (bfr[1] is body[0], i.e. `bfr[n]` is `body[n-1]`).
+ */
+export declare function parseGloriousClassicBatteryResponse(body: Uint8Array): GloriousClassicBattery;
+export declare const GLORIOUS_CLASSIC_DPI_MIN = 100;
+export declare const GLORIOUS_CLASSIC_DPI_MAX = 19000;
+export declare const GLORIOUS_CLASSIC_DPI_STAGE_COUNT = 4;
+/**
+ * DPI stages (mxw src/config/dpi_stages.rs): bfr[3]=0x02, bfr[4]=0x12,
+ * bfr[5]=0x01, bfr[6]=0x01, bfr[7]=profile, bfr[8]=stage count, then per
+ * stage a 4-byte big-endian u16 value written twice (X and Y, always equal
+ * in mxw): bfr[9+4i]=hi, bfr[10+4i]=lo, bfr[11+4i]=hi, bfr[12+4i]=lo.
+ */
+export declare function buildGloriousClassicDpiStagesPayload(stages: readonly number[], profileId?: number): Uint8Array<ArrayBuffer>;
+/** Active DPI stage (mxw src/config/dpi_stage.rs), stageId is 1-based (1-4). */
+export declare function buildGloriousClassicActiveStagePayload(stageId: number, profileId?: number): Uint8Array<ArrayBuffer>;
+/**
+ * Polling rate (mxw src/config/polling_rate.rs): bfr[3]=0x02, bfr[4]=0x01,
+ * bfr[5]=0x01, bfr[7]=poll interval in milliseconds. mxw only offers
+ * {1,2,4,8} ms, i.e. {1000,500,250,125} Hz — this generation has no 2K/4K/8K
+ * mode.
+ */
+export declare const GLORIOUS_CLASSIC_POLLING_RATES: ReadonlyArray<readonly [ms: number, hertz: number]>;
+export declare function gloriousClassicEncodePollingRate(hertz: number): number | null;
+export declare function gloriousClassicDecodePollingRate(ms: number): number | null;
+export declare function buildGloriousClassicPollingRatePayload(intervalMs: number): Uint8Array<ArrayBuffer>;
+/**
+ * Lift-off distance (mxw src/config/lift_off.rs): bfr[3]=0x02, bfr[4]=0x01,
+ * bfr[5]=0x01, bfr[6]=0x07, bfr[7]=millimetres-1 (0=1mm, 1=2mm — only those
+ * two are valid on this generation).
+ */
+export declare const GLORIOUS_CLASSIC_LOD_MEDIUM_MM = 1;
+export declare const GLORIOUS_CLASSIC_LOD_HIGH_MM = 2;
+export declare function buildGloriousClassicLiftOffPayload(millimetres: number): Uint8Array<ArrayBuffer>;
+//# sourceMappingURL=index.d.ts.map

package/dist/glorious-classic/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/glorious-classic/index.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;;;;;;;GAqBG;AAEH,eAAO,MAAM,0BAA0B,IAAI,CAAC;AAC5C,eAAO,MAAM,8BAA8B,KAAK,CAAC;AAEjD,eAAO,MAAM,gCAAgC,IAAI,CAAC;AAClD,eAAO,MAAM,gCAAgC,KAAK,CAAC;AAkBnD,MAAM,MAAM,wBAAwB,GAChC,KAAK,GAAG,UAAU,GAAG,OAAO,GAAG,OAAO,GAAG,OAAO,GAAG,UAAU,GAAG,MAAM,GAAG,MAAM,GAAG,MAAM,CAAC;AAc7F,eAAO,MAAM,mCAAmC,EAAE,aAAa,CAAC,SAAS,CAAC,wBAAwB,EAAE,MAAM,CAAC,CAU1G,CAAC;AAEF,MAAM,WAAW,kBAAkB;IACjC,MAAM,EAAE,wBAAwB,CAAC;IACjC,wDAAwD;IACxD,IAAI,EAAE,MAAM,CAAC;IACb,yFAAyF;IACzF,MAAM,EAAE,MAAM,EAAE,CAAC;IACjB,SAAS,CAAC,EAAE,MAAM,CAAC;CACpB;AAED,eAAO,MAAM,4BAA4B,EAAE,kBAK1C,CAAC;AAYF;;;GAGG;AACH,wBAAgB,uBAAuB,CAAC,IAAI,EAAE,MAAM,EAAE,MAAM,EAAE,wBAAwB,GAAG,MAAM,CAM9F;AAED;;;;;;;GAOG;AACH,wBAAgB,8BAA8B,CAAC,GAAG,EAAE,kBAAkB,GAAG,UAAU,CAAC,WAAW,CAAC,CA4E/F;AAOD,wBAAgB,mCAAmC,CAAC,YAAY,EAAE,MAAM,EAAE,SAAS,SAAmC,GAAG,UAAU,CAAC,WAAW,CAAC,CAS/I;AAOD,wBAAgB,yCAAyC,IAAI,UAAU,CAAC,WAAW,CAAC,CAMnF;AAED,MAAM,MAAM,2BAA2B,GAAG,QAAQ,GAAG,QAAQ,GAAG,UAAU,GAAG,SAAS,CAAC;AAEvF,MAAM,WAAW,sBAAsB;IACrC,KAAK,EAAE,2BAA2B,CAAC;IACnC,kEAAkE;IAClE,OAAO,EAAE,MAAM,GAAG,IAAI,CAAC;IACvB;;;;;;OAMG;IACH,QAAQ,EAAE,OAAO,CAAC;CACnB;AAWD;;;GAGG;AACH,wBAAgB,mCAAmC,CAAC,IAAI,EAAE,UAAU,GAAG,sBAAsB,CAa5F;AAQD,eAAO,MAAM,wBAAwB,MAAM,CAAC;AAC5C,eAAO,MAAM,wBAAwB,QAAQ,CAAC;AAC9C,eAAO,MAAM,gCAAgC,IAAI,CAAC;AAElD;;;;;GAKG;AACH,wBAAgB,oCAAoC,CAClD,MAAM,EAAE,SAAS,MAAM,EAAE,EACzB,SAAS,SAAmC,GAC3C,UAAU,CAAC,WAAW,CAAC,CAmBzB;AAED,gFAAgF;AAChF,wBAAgB,sCAAsC,CACpD,OAAO,EAAE,MAAM,EACf,SAAS,SAAmC,GAC3C,UAAU,CAAC,WAAW,CAAC,CASzB;AAED;;;;;GAKG;AACH,eAAO,MAAM,8BAA8B,EAAE,aAAa,CAAC,SAAS,CAAC,EAAE,EAAE,MAAM,EAAE,KAAK,EAAE,MAAM,CAAC,CAK9F,CAAC;AAEF,wBAAgB,gCAAgC,CAAC,KAAK,EAAE,MAAM,GAAG,MAAM,GAAG,IAAI,CAE7E;AAED,wBAAgB,gCAAgC,CAAC,EAAE,EAAE,MAAM,GAAG,MAAM,GAAG,IAAI,CAE1E;AAED,wBAAgB,sCAAsC,CAAC,UAAU,EAAE,MAAM,GAAG,UAAU,CAAC,WAAW,CAAC,CAOlG;AAED;;;;GAIG;AACH,eAAO,MAAM,8BAA8B,IAAI,CAAC;AAChD,eAAO,MAAM,4BAA4B,IAAI,CAAC;AAE9C,wBAAgB,kCAAkC,CAAC,WAAW,EAAE,MAAM,GAAG,UAAU,CAAC,WAAW,CAAC,CAQ/F"}

package/dist/glorious-classic/index.js

@@ -0,0 +1,304 @@
+/**
+ * Pure encoding rules for Glorious's "classic" HID feature-report protocol,
+ * used by the pre-Pixart Model O / Model D / Model I lines (VIDs 0x258a,
+ * 0x22d4, 0x320f, 0x3794) — the same wire format the official Windows
+ * software, and community tools glorious-ctl and mxw, use. Distinct from the
+ * Pixart Model O 2 / I 2 protocol in ../glorious/index.ts, which is
+ * write-only in a different way and has a different report layout.
+ *
+ * RGB, debounce, and battery are reverse-engineered from
+ * https://github.com/louis4craft/glorious-ctl (mouse.py). DPI, polling rate,
+ * and lift-off distance are reverse-engineered from
+ * https://github.com/korkje/mxw (Rust; src/config/*.rs). Neither tool reads
+ * DPI/polling/LOD back from the mouse — both are write-only for those three,
+ * so this module is too; the driver keeps its own cache of the last-applied
+ * values (see ../drivers/glorious/classic-hid.ts).
+ *
+ * Reports are unnumbered 64-byte feature reports (report id 0). Both source
+ * tools build a 65-byte buffer with byte [0] as the hidapi report-id slot
+ * (always 0) followed by the 64-byte body; WebHID takes the report id
+ * separately, so every offset below is the source's buffer index minus 1.
+ * `bfr()` documents that shift at each call site with the source's own index.
+ */
+export const GLORIOUS_CLASSIC_REPORT_ID = 0;
+export const GLORIOUS_CLASSIC_PACKET_LENGTH = 64;
+export const GLORIOUS_CLASSIC_PROFILE_DEFAULT = 1;
+export const GLORIOUS_CLASSIC_DEBOUNCE_MAX_MS = 32;
+function packet() {
+    return new Uint8Array(GLORIOUS_CLASSIC_PACKET_LENGTH);
+}
+/**
+ * Sets `body[bufferIndex - 1]`, i.e. the byte the source (mouse.py / mxw)
+ * calls `bfr[bufferIndex]` in its 65-byte, report-id-prefixed buffer.
+ */
+function bfr(body, bufferIndex, value) {
+    body[bufferIndex - 1] = value & 0xff;
+}
+const EFFECT_IDS = {
+    off: 0x00,
+    glorious: 0x01,
+    cycle: 0x02,
+    pulse: 0x03,
+    solid: 0x04,
+    pulseOne: 0x05,
+    tail: 0x06,
+    rave: 0x07,
+    wave: 0x08,
+};
+export const GLORIOUS_CLASSIC_RGB_EFFECT_OPTIONS = [
+    ["glorious", "Glorious"],
+    ["off", "LEDs off"],
+    ["cycle", "Cycle"],
+    ["pulse", "Pulse"],
+    ["solid", "Solid color"],
+    ["pulseOne", "Pulse (solid)"],
+    ["tail", "Tail"],
+    ["rave", "Rave"],
+    ["wave", "Wave"],
+];
+export const GLORIOUS_CLASSIC_DEFAULT_RGB = {
+    effect: "glorious",
+    rate: 50,
+    colors: ["#ff0000"],
+    profileId: GLORIOUS_CLASSIC_PROFILE_DEFAULT,
+};
+function hexToRgb(hex) {
+    const match = /^#?([0-9a-f]{6})$/i.exec(hex.trim());
+    const value = match ? match[1] : "ff0000";
+    return [
+        Number.parseInt(value.slice(0, 2), 16),
+        Number.parseInt(value.slice(2, 4), 16),
+        Number.parseInt(value.slice(4, 6), 16),
+    ];
+}
+/**
+ * `rate_check()` from mouse.py: 0-100 input, clamped, mapped onto the
+ * hardware's inverted byte scale. Effects 7/8 (rave/wave) use a finer step.
+ */
+export function gloriousClassicRateByte(rate, effect) {
+    const clamped = Math.max(0, Math.min(100, Math.round(rate)));
+    const id = EFFECT_IDS[effect];
+    return id === EFFECT_IDS.rave || id === EFFECT_IDS.wave
+        ? (105 - clamped) * 2
+        : Math.floor((105 - clamped) / 5);
+}
+/**
+ * Builds the single 64-byte feature-report body for an RGB write. Mirrors
+ * `set_rgb()` in mouse.py exactly, including its per-effect payload length
+ * and color-slot layout:
+ *   bfr[3]=0x02 (class), bfr[4]=<length, effect-dependent>, bfr[5]=0x02,
+ *   bfr[7]=profile, bfr[8]=0xFF, bfr[9]=<effect id>, bfr[11]=<rate>,
+ *   bfr[12..]=color triplets.
+ */
+export function buildGloriousClassicRgbPayload(rgb) {
+    const body = packet();
+    const profileId = rgb.profileId ?? GLORIOUS_CLASSIC_PROFILE_DEFAULT;
+    const id = EFFECT_IDS[rgb.effect];
+    const rateByte = gloriousClassicRateByte(rgb.rate, rgb.effect);
+    const rgbColors = rgb.colors.map(hexToRgb);
+    bfr(body, 3, 0x02);
+    bfr(body, 5, 0x02);
+    bfr(body, 7, profileId);
+    bfr(body, 8, 0xff);
+    bfr(body, 9, id);
+    switch (rgb.effect) {
+        case "off":
+            bfr(body, 4, 0x05);
+            break;
+        case "glorious":
+            bfr(body, 4, 0x05);
+            bfr(body, 11, rateByte);
+            break;
+        case "cycle":
+            bfr(body, 4, 0x05);
+            bfr(body, 11, rateByte);
+            bfr(body, 12, 0xff);
+            break;
+        case "pulse": {
+            const colors = rgbColors.slice(0, 6);
+            bfr(body, 4, colors.length * 3 + 5);
+            bfr(body, 11, rateByte);
+            colors.forEach(([r, g, b], index) => {
+                bfr(body, 12 + index * 3, r);
+                bfr(body, 13 + index * 3, g);
+                bfr(body, 14 + index * 3, b);
+            });
+            break;
+        }
+        case "solid": {
+            bfr(body, 4, 0x08);
+            const [r, g, b] = rgbColors[0] ?? [255, 0, 0];
+            bfr(body, 12, r);
+            bfr(body, 13, g);
+            bfr(body, 14, b);
+            break;
+        }
+        case "pulseOne": {
+            bfr(body, 4, 0x08);
+            bfr(body, 11, rateByte);
+            const [r, g, b] = rgbColors[0] ?? [255, 0, 0];
+            bfr(body, 12, r);
+            bfr(body, 13, g);
+            bfr(body, 14, b);
+            break;
+        }
+        case "tail":
+            bfr(body, 4, 0x05);
+            bfr(body, 11, rateByte);
+            break;
+        case "rave": {
+            const colors = rgbColors.slice(0, 2);
+            bfr(body, 4, colors.length * 3 + 5);
+            bfr(body, 11, rateByte);
+            colors.forEach(([r, g, b], index) => {
+                bfr(body, 12 + index * 3, r);
+                bfr(body, 13 + index * 3, g);
+                bfr(body, 14 + index * 3, b);
+            });
+            break;
+        }
+        case "wave":
+            bfr(body, 4, 0x05);
+            bfr(body, 11, rateByte);
+            break;
+    }
+    return body;
+}
+// ---------------------------------------------------------------------------
+// Debounce (mouse.py set_debounce_time): bfr[3]=0x02, bfr[4]=0x01, bfr[6]=0x08,
+// bfr[7]=profile, bfr[8]=ms.
+// ---------------------------------------------------------------------------
+export function buildGloriousClassicDebouncePayload(milliseconds, profileId = GLORIOUS_CLASSIC_PROFILE_DEFAULT) {
+    const clamped = Math.max(0, Math.min(GLORIOUS_CLASSIC_DEBOUNCE_MAX_MS, Math.round(milliseconds)));
+    const body = packet();
+    bfr(body, 3, 0x02);
+    bfr(body, 4, 0x01);
+    bfr(body, 6, 0x08);
+    bfr(body, 7, profileId);
+    bfr(body, 8, clamped);
+    return body;
+}
+// ---------------------------------------------------------------------------
+// Battery (mouse.py get_battery_status). Request: bfr[3]=0x02, bfr[4]=0x02,
+// bfr[6]=0x83. Response: bfr[1]=status, bfr[6]=echo, bfr[8]=percent.
+// ---------------------------------------------------------------------------
+export function buildGloriousClassicBatteryRequestPayload() {
+    const body = packet();
+    bfr(body, 3, 0x02);
+    bfr(body, 4, 0x02);
+    bfr(body, 6, 0x83);
+    return body;
+}
+/** Raw status byte -> meaning, per `status_map.index(bfr_r[1])` in mouse.py. */
+const STATUS_BYTE_TO_STATE = new Map([
+    [0xa1, "Normal"],
+    [0xa4, "Asleep"],
+    [0xa2, "Unknown"],
+    [0xa0, "WakingUp"],
+    [0xa3, "Unknown"],
+]);
+/**
+ * Mirrors `get_battery_status()`'s response parsing. `body` is the 64-byte
+ * feature-report body (bfr[1] is body[0], i.e. `bfr[n]` is `body[n-1]`).
+ */
+export function parseGloriousClassicBatteryResponse(body) {
+    const statusByte = body[0]; // bfr[1]
+    const echo = body[5]; // bfr[6]
+    const charging = body[6] === 1; // bfr[7]
+    const rawPercent = body[7]; // bfr[8]
+    if (echo !== 0x83)
+        return { state: "Unknown", percent: null, charging: false };
+    const state = STATUS_BYTE_TO_STATE.get(statusByte) ?? "Unknown";
+    if (state !== "Normal")
+        return { state, percent: null, charging: false };
+    const percent = rawPercent === 0 ? 1 : rawPercent;
+    return { state, percent: percent > 0 && percent <= 100 ? percent : null, charging };
+}
+// ---------------------------------------------------------------------------
+// DPI, polling rate, lift-off distance (korkje/mxw). None of these three has
+// a read command in mxw either — every write below is fire-and-forget, same
+// as the RGB/debounce commands above.
+// ---------------------------------------------------------------------------
+export const GLORIOUS_CLASSIC_DPI_MIN = 100;
+export const GLORIOUS_CLASSIC_DPI_MAX = 19000;
+export const GLORIOUS_CLASSIC_DPI_STAGE_COUNT = 4;
+/**
+ * DPI stages (mxw src/config/dpi_stages.rs): bfr[3]=0x02, bfr[4]=0x12,
+ * bfr[5]=0x01, bfr[6]=0x01, bfr[7]=profile, bfr[8]=stage count, then per
+ * stage a 4-byte big-endian u16 value written twice (X and Y, always equal
+ * in mxw): bfr[9+4i]=hi, bfr[10+4i]=lo, bfr[11+4i]=hi, bfr[12+4i]=lo.
+ */
+export function buildGloriousClassicDpiStagesPayload(stages, profileId = GLORIOUS_CLASSIC_PROFILE_DEFAULT) {
+    const clamped = stages.map((dpi) => Math.max(GLORIOUS_CLASSIC_DPI_MIN, Math.min(GLORIOUS_CLASSIC_DPI_MAX, Math.round(dpi))));
+    const body = packet();
+    bfr(body, 3, 0x02);
+    bfr(body, 4, 0x12);
+    bfr(body, 5, 0x01);
+    bfr(body, 6, 0x01);
+    bfr(body, 7, profileId);
+    bfr(body, 8, clamped.length);
+    clamped.forEach((dpi, index) => {
+        const hi = (dpi >> 8) & 0xff;
+        const lo = dpi & 0xff;
+        const base = 9 + 4 * index;
+        bfr(body, base, hi);
+        bfr(body, base + 1, lo);
+        bfr(body, base + 2, hi);
+        bfr(body, base + 3, lo);
+    });
+    return body;
+}
+/** Active DPI stage (mxw src/config/dpi_stage.rs), stageId is 1-based (1-4). */
+export function buildGloriousClassicActiveStagePayload(stageId, profileId = GLORIOUS_CLASSIC_PROFILE_DEFAULT) {
+    const body = packet();
+    bfr(body, 3, 0x02);
+    bfr(body, 4, 0x02);
+    bfr(body, 5, 0x01);
+    bfr(body, 6, 0x02);
+    bfr(body, 7, profileId);
+    bfr(body, 8, stageId);
+    return body;
+}
+/**
+ * Polling rate (mxw src/config/polling_rate.rs): bfr[3]=0x02, bfr[4]=0x01,
+ * bfr[5]=0x01, bfr[7]=poll interval in milliseconds. mxw only offers
+ * {1,2,4,8} ms, i.e. {1000,500,250,125} Hz — this generation has no 2K/4K/8K
+ * mode.
+ */
+export const GLORIOUS_CLASSIC_POLLING_RATES = [
+    [1, 1000],
+    [2, 500],
+    [4, 250],
+    [8, 125],
+];
+export function gloriousClassicEncodePollingRate(hertz) {
+    return GLORIOUS_CLASSIC_POLLING_RATES.find(([, hz]) => hz === hertz)?.[0] ?? null;
+}
+export function gloriousClassicDecodePollingRate(ms) {
+    return GLORIOUS_CLASSIC_POLLING_RATES.find(([interval]) => interval === ms)?.[1] ?? null;
+}
+export function buildGloriousClassicPollingRatePayload(intervalMs) {
+    const body = packet();
+    bfr(body, 3, 0x02);
+    bfr(body, 4, 0x01);
+    bfr(body, 5, 0x01);
+    bfr(body, 7, intervalMs);
+    return body;
+}
+/**
+ * Lift-off distance (mxw src/config/lift_off.rs): bfr[3]=0x02, bfr[4]=0x01,
+ * bfr[5]=0x01, bfr[6]=0x07, bfr[7]=millimetres-1 (0=1mm, 1=2mm — only those
+ * two are valid on this generation).
+ */
+export const GLORIOUS_CLASSIC_LOD_MEDIUM_MM = 1;
+export const GLORIOUS_CLASSIC_LOD_HIGH_MM = 2;
+export function buildGloriousClassicLiftOffPayload(millimetres) {
+    const body = packet();
+    bfr(body, 3, 0x02);
+    bfr(body, 4, 0x01);
+    bfr(body, 5, 0x01);
+    bfr(body, 6, 0x07);
+    bfr(body, 7, millimetres - 1);
+    return body;
+}
+//# sourceMappingURL=index.js.map