led-matrix-controllers 0.2.2 → 0.2.3

package/src/supported-firmware/sigroot/FW_LED_Matrix_Firmware/CommandAbstractionLayer.js

@@ -1,89 +1,89 @@
-import { GAMMA } from '../../../hardware-constants.js';
-import { Command, IDENTITY_STR_LEN } from './commands.js';
-
-export class CommandAbstractionLayer {
-  constructor(portMutex = null) {
-    this.portMutex = portMutex;
-  }
-
-  async bootloader() {
-    await this.portMutex.acquire(async p => {
-      await p.tx([Command.BOOTLOADER]);
-    });
-  }
-
-  async identityString() {
-    let ident = null;
-
-    await this.portMutex.acquire(async p => {
-      await p.tx([Command.IDENTITY_STRING]);
-      ident = await p.rx(IDENTITY_STR_LEN);
-    });
-
-    return String.fromCharCode(...ident);
-  }
-
-  async setPixelPwm(r, c, brightness) {
-    await this.portMutex.acquire(
-      async p => {
-        await p.tx([Command.SET_PX_PWM, c, r, brightness]);
-      }
-    );
-  }
-
-  async setGlobalPwm(brightness) {
-    await this.portMutex.acquire(
-      async p => {
-        await p.tx([Command.SET_CONST_PWM, brightness]);
-      }
-    );
-  }
-
-  async setMatrixPwm(matrix) {
-    // Only execute the most recent call 
-    await this.portMutex.acquireIdempotent(
-      'drawMatrix', 
-      async p => {
-        await p.tx(
-          [Command.DRAW_PWM].concat(
-            matrix.flat().map(v => 
-              GAMMA[Math.floor((v ?? 0) * 255)]
-            )
-          )
-        );
-      }
-    );
-  }
-
-  async setPixelAnalog(r, c, brightness) {
-    await this.portMutex.acquire(
-      async p => {
-        await p.tx([Command.SET_PX_SCALE, c, r, brightness]);
-      }
-    );
-  }
-
-  async setGlobalAnalog(brightness) {
-    await this.portMutex.acquire(
-      async p => {
-        await p.tx([Command.SET_CONST_SCALE, brightness]);
-      }
-    );
-  }
-
-  async setMatrixAnalog(matrix) {
-    // Only execute the most recent call 
-    await this.portMutex.acquireIdempotent(
-      'drawMatrix', 
-      async p => {
-        await p.tx(
-          [Command.DRAW_SCALE].concat(
-            matrix.flat().map(v => 
-              GAMMA[Math.floor((v ?? 0) * 255)]
-            )
-          )
-        );
-      }
-    );
-  }
-}
+import { GAMMA } from '../../../hardware-constants.js';
+import { Command, IDENTITY_STR_LEN } from './commands.js';
+
+export class CommandAbstractionLayer {
+  constructor(portMutex = null) {
+    this.portMutex = portMutex;
+  }
+
+  async bootloader() {
+    await this.portMutex.acquire(async p => {
+      await p.tx([Command.BOOTLOADER]);
+    });
+  }
+
+  async identityString() {
+    let ident = null;
+
+    await this.portMutex.acquire(async p => {
+      await p.tx([Command.IDENTITY_STRING]);
+      ident = await p.rx(IDENTITY_STR_LEN);
+    });
+
+    return String.fromCharCode(...ident);
+  }
+
+  async setPixelPwm(r, c, brightness) {
+    await this.portMutex.acquire(
+      async p => {
+        await p.tx([Command.SET_PX_PWM, c, r, brightness]);
+      }
+    );
+  }
+
+  async setGlobalPwm(brightness) {
+    await this.portMutex.acquire(
+      async p => {
+        await p.tx([Command.SET_CONST_PWM, brightness]);
+      }
+    );
+  }
+
+  async setMatrixPwm(matrix) {
+    // Only execute the most recent call 
+    await this.portMutex.acquireIdempotent(
+      'drawMatrix', 
+      async p => {
+        await p.tx(
+          [Command.DRAW_PWM].concat(
+            matrix.flat().map(v => 
+              GAMMA[Math.floor((v ?? 0) * 255)]
+            )
+          )
+        );
+      }
+    );
+  }
+
+  async setPixelAnalog(r, c, brightness) {
+    await this.portMutex.acquire(
+      async p => {
+        await p.tx([Command.SET_PX_SCALE, c, r, brightness]);
+      }
+    );
+  }
+
+  async setGlobalAnalog(brightness) {
+    await this.portMutex.acquire(
+      async p => {
+        await p.tx([Command.SET_CONST_SCALE, brightness]);
+      }
+    );
+  }
+
+  async setMatrixAnalog(matrix) {
+    // Only execute the most recent call 
+    await this.portMutex.acquireIdempotent(
+      'drawMatrix', 
+      async p => {
+        await p.tx(
+          [Command.DRAW_SCALE].concat(
+            matrix.flat().map(v => 
+              GAMMA[Math.floor((v ?? 0) * 255)]
+            )
+          )
+        );
+      }
+    );
+  }
+}

package/src/supported-firmware/sigroot/FW_LED_Matrix_Firmware/SigrootController.js

@@ -1,50 +1,50 @@
-import { close, getPort } from '../../../web-serial/port.js';
-import { PortMutex } from '../../../web-serial/PortMutex.js';
-import { PortOperations } from '../../../web-serial/PortOperations.js';
-import { CommandAbstractionLayer } from './CommandAbstractionLayer.js';
-import { IDENTITY_STR_REGEX } from './commands.js';
-
-export class SigrootController extends CommandAbstractionLayer {
-  async bootloader() {
-    await super.bootloader();
-  }
-
-  async connect() {
-    const port = await getPort();
-
-    if (port?.connected) {
-      await close(port);
-      await port.open({ baudRate: 115200 });
-      this.portMutex = new PortMutex(new PortOperations(port));
-    }
-  }
-
-  async draw(matrix) {
-    if (!this.#scaleInitialized) {
-      await super.setGlobalAnalog(0x20);
-      this.#scaleInitialized = true;
-    }
-
-    await super.setMatrixPwm(matrix);
-  }
-
-  async verifyFirmware() { 
-    return await this.version() != null;
-  }
-
-  async version() {
-    const ident = await super.identityString();
-    const match = ident.match(IDENTITY_STR_REGEX);
-
-    if (match && match.length == 3) {
-      return {
-        major: match[1],
-        minor: match[2]
-      }
-    } else {
-      return null;
-    }
-  }
-
-  #scaleInitialized;
-}
+import { close, getPort } from '../../../web-serial/port.js';
+import { PortMutex } from '../../../web-serial/PortMutex.js';
+import { PortOperations } from '../../../web-serial/PortOperations.js';
+import { CommandAbstractionLayer } from './CommandAbstractionLayer.js';
+import { IDENTITY_STR_REGEX } from './commands.js';
+
+export class SigrootController extends CommandAbstractionLayer {
+  async bootloader() {
+    await super.bootloader();
+  }
+
+  async connect() {
+    const port = await getPort();
+
+    if (port?.connected) {
+      await close(port);
+      await port.open({ baudRate: 115200 });
+      this.portMutex = new PortMutex(new PortOperations(port));
+    }
+  }
+
+  async draw(matrix) {
+    if (!this.#scaleInitialized) {
+      await super.setGlobalAnalog(0x20);
+      this.#scaleInitialized = true;
+    }
+
+    await super.setMatrixPwm(matrix);
+  }
+
+  async verifyFirmware() { 
+    return await this.version() != null;
+  }
+
+  async version() {
+    const ident = await super.identityString();
+    const match = ident.match(IDENTITY_STR_REGEX);
+
+    if (match && match.length == 3) {
+      return {
+        major: match[1],
+        minor: match[2]
+      }
+    } else {
+      return null;
+    }
+  }
+
+  #scaleInitialized;
+}

package/src/supported-firmware/sigroot/FW_LED_Matrix_Firmware/commands.js

@@ -1,26 +1,26 @@
-export const Command = Object.freeze({
-  /* 000 */ NOOP: 0x00,
-  /* 'd' */ ANIMATION_DIAMOND: 0x64,
-  /* 'b' */ ANIMATION_FIRE: 0x62,
-  /* 'f' */ ANIMATION_FIREPLACE: 0x66,
-  /* 'g' */ ANIMATION_GEAR: 0x67,
-  /* 'r' */ ANIMATION_RING: 0x72,
-  /* 'a' */ ANIMATION_STARTUP: 0x61,
-  /* 'A' */ ANIMATION_STARTUP_ONCE: 0x41,
-  /* 'e' */ BOOTLOADER: 0x65,
-  /* 'm' */ DRAW_PWM: 0x6D,
-  /* 'M' */ DRAW_PWM_BLOCKING: 0x4D,
-  /* 'n' */ DRAW_SCALE: 0x6E,
-  /* 'N' */ DRAW_SCALE_BLOCKING: 0x4E,
-  /* 'c' */ FLUSH_CMD_QUEUE: 0x63,
-  /* 't' */ TEST_PATTERN: 0x74,
-  /* 'w' */ SET_CONST_PWM: 0x77,
-  /* 's' */ SET_CONST_SCALE: 0x73,
-  /* 'p' */ SET_PX_PWM: 0x70,
-  /* 'q' */ SET_PX_SCALE: 0x71,
-  /* 127 */ IDENTITY_STRING: 0x7F,
-});
-
-export const IDENTITY_STR_LEN = 25;
-
-export const IDENTITY_STR_REGEX = /^Sig\sFW\sLED\sMatrix\sFW\sV(\d+)\.(\d+)$/;
+export const Command = Object.freeze({
+  /* 000 */ NOOP: 0x00,
+  /* 'd' */ ANIMATION_DIAMOND: 0x64,
+  /* 'b' */ ANIMATION_FIRE: 0x62,
+  /* 'f' */ ANIMATION_FIREPLACE: 0x66,
+  /* 'g' */ ANIMATION_GEAR: 0x67,
+  /* 'r' */ ANIMATION_RING: 0x72,
+  /* 'a' */ ANIMATION_STARTUP: 0x61,
+  /* 'A' */ ANIMATION_STARTUP_ONCE: 0x41,
+  /* 'e' */ BOOTLOADER: 0x65,
+  /* 'm' */ DRAW_PWM: 0x6D,
+  /* 'M' */ DRAW_PWM_BLOCKING: 0x4D,
+  /* 'n' */ DRAW_SCALE: 0x6E,
+  /* 'N' */ DRAW_SCALE_BLOCKING: 0x4E,
+  /* 'c' */ FLUSH_CMD_QUEUE: 0x63,
+  /* 't' */ TEST_PATTERN: 0x74,
+  /* 'w' */ SET_CONST_PWM: 0x77,
+  /* 's' */ SET_CONST_SCALE: 0x73,
+  /* 'p' */ SET_PX_PWM: 0x70,
+  /* 'q' */ SET_PX_SCALE: 0x71,
+  /* 127 */ IDENTITY_STRING: 0x7F,
+});
+
+export const IDENTITY_STR_LEN = 25;
+
+export const IDENTITY_STR_REGEX = /^Sig\sFW\sLED\sMatrix\sFW\sV(\d+)\.(\d+)$/;

package/src/supported-firmware/vddCore/sparkle-fw16/ReportAbstractionLayer.js

@@ -1,115 +1,115 @@
-import { GAMMA } from '../../../hardware-constants.js';
-import { Commands, Reports } from './reports.js';
-
-export class ReportAbstractionLayer {
-  constructor(device = null) {
-    this.device = device;
-  }
-
-  async info() {
-    const infoRaw = await this.device.request(Reports.GLITTER_DEVICE_INFO);
-
-    return {
-      sleep_pin: infoRaw.getUint8(1),
-      dip1_pin: infoRaw.getUint8(2),
-      intb_pin: infoRaw.getUint8(3),
-      state_flags: infoRaw.getUint8(4),
-      id_reg: infoRaw.getUint8(5),
-      config_reg: infoRaw.getUint8(6),
-      global_brightness: infoRaw.getUint8(7),
-      display_width: infoRaw.getUint8(8),
-      display_height: infoRaw.getUint8(9),
-      timeout_ms: infoRaw.getUint32(10),
-      version_major: infoRaw.getUint8(14),
-      version_minor: infoRaw.getUint8(15),
-    };
-  }
-
-  async wake() {
-    await this.device.send(
-      Reports.GLITTER_BASIC_CMD,
-      [Commands.GLITTER_CMD_SLEEP, false]
-    );
-  }
-
-  async sleep() {
-    await this.device.send(
-      Reports.GLITTER_BASIC_CMD,
-      [Commands.GLITTER_CMD_SLEEP, true]
-    );
-  }
-
-  async disableSleep() {
-    await this.device.send(
-      Reports.GLITTER_BASIC_CMD, 
-      [Commands.GLITTER_CMD_SET_SLEEP_TIMEOUT, 0xff, 0xff, 0xff, 0xff]
-    );
-  }
-
-  async disableDeepSleep() {
-    await this.device.send(
-      Reports.GLITTER_BASIC_CMD, 
-      [Commands.GLITTER_CMD_WAKE_ON_COMMAND, 0x01]
-    );
-  }
-
-  async disableSleepTimer() {
-    await this.device.send(
-      Reports.GLITTER_BASIC_CMD, 
-      [Commands.GLITTER_CMD_SET_SLEEP_TIMEOUT, 0x00, 0x00, 0x00, 0x00]
-    );
-  }
-  
-  async enableDeepSleep() {
-    await this.device.send(
-      Reports.GLITTER_BASIC_CMD, 
-      [Commands.GLITTER_CMD_WAKE_ON_COMMAND, 0x00]
-    );
-  }
-
-  async enableSleepTimer(milliseconds) {
-    const view = new DataView(new ArrayBuffer(4));
-    const littleEndian = false;
-    view.setInt32(0, milliseconds, littleEndian);
-    await this.device.send(
-      Reports.GLITTER_BASIC_CMD, 
-      [
-        Commands.GLITTER_CMD_SET_SLEEP_TIMEOUT, 
-        view.getUint8(0), 
-        view.getUint8(1), 
-        view.getUint8(2), 
-        view.getUint8(3),
-      ]
-    );
-  }
-
-  async reboot(mode) {
-    await this.device.send(
-      Reports.GLITTER_BASIC_CMD, 
-      [Commands.GLITTER_CMD_REBOOT, mode]
-    );
-  }
-
-  async drawMatrix(matrix) {
-    await this.device.send(
-      Reports.GLITTER_GRID_PWM_CNTL,
-      matrix.flat().map(v => GAMMA[Math.floor((v ?? 0) * 255)])
-    );
-  }
-
-  async drawPixel(r, c, brightness) {
-    await this.device.send(
-      Reports.GLITTER_BASIC_CMD,
-      [Commands.GLITTER_CMD_DRAW_PIXEL, c, r, brightness]
-    );
-  }
-
-  async drawLine({r1, c1}, {r2, c2}, brightness) {
-    await this.device.send(
-      Reports.GLITTER_BASIC_CMD,
-      [Commands.GLITTER_CMD_DRAW_PIXEL, r1, c1, r2, c2, brightness]
-    );
-  }
-
-  device;
-}
+import { GAMMA } from '../../../hardware-constants.js';
+import { Commands, Reports } from './reports.js';
+
+export class ReportAbstractionLayer {
+  constructor(device = null) {
+    this.device = device;
+  }
+
+  async info() {
+    const infoRaw = await this.device.request(Reports.GLITTER_DEVICE_INFO);
+
+    return {
+      sleep_pin: infoRaw.getUint8(1),
+      dip1_pin: infoRaw.getUint8(2),
+      intb_pin: infoRaw.getUint8(3),
+      state_flags: infoRaw.getUint8(4),
+      id_reg: infoRaw.getUint8(5),
+      config_reg: infoRaw.getUint8(6),
+      global_brightness: infoRaw.getUint8(7),
+      display_width: infoRaw.getUint8(8),
+      display_height: infoRaw.getUint8(9),
+      timeout_ms: infoRaw.getUint32(10),
+      version_major: infoRaw.getUint8(14),
+      version_minor: infoRaw.getUint8(15),
+    };
+  }
+
+  async wake() {
+    await this.device.send(
+      Reports.GLITTER_BASIC_CMD,
+      [Commands.GLITTER_CMD_SLEEP, false]
+    );
+  }
+
+  async sleep() {
+    await this.device.send(
+      Reports.GLITTER_BASIC_CMD,
+      [Commands.GLITTER_CMD_SLEEP, true]
+    );
+  }
+
+  async disableSleep() {
+    await this.device.send(
+      Reports.GLITTER_BASIC_CMD, 
+      [Commands.GLITTER_CMD_SET_SLEEP_TIMEOUT, 0xff, 0xff, 0xff, 0xff]
+    );
+  }
+
+  async disableDeepSleep() {
+    await this.device.send(
+      Reports.GLITTER_BASIC_CMD, 
+      [Commands.GLITTER_CMD_WAKE_ON_COMMAND, 0x01]
+    );
+  }
+
+  async disableSleepTimer() {
+    await this.device.send(
+      Reports.GLITTER_BASIC_CMD, 
+      [Commands.GLITTER_CMD_SET_SLEEP_TIMEOUT, 0x00, 0x00, 0x00, 0x00]
+    );
+  }
+  
+  async enableDeepSleep() {
+    await this.device.send(
+      Reports.GLITTER_BASIC_CMD, 
+      [Commands.GLITTER_CMD_WAKE_ON_COMMAND, 0x00]
+    );
+  }
+
+  async enableSleepTimer(milliseconds) {
+    const view = new DataView(new ArrayBuffer(4));
+    const littleEndian = false;
+    view.setInt32(0, milliseconds, littleEndian);
+    await this.device.send(
+      Reports.GLITTER_BASIC_CMD, 
+      [
+        Commands.GLITTER_CMD_SET_SLEEP_TIMEOUT, 
+        view.getUint8(0), 
+        view.getUint8(1), 
+        view.getUint8(2), 
+        view.getUint8(3),
+      ]
+    );
+  }
+
+  async reboot(mode) {
+    await this.device.send(
+      Reports.GLITTER_BASIC_CMD, 
+      [Commands.GLITTER_CMD_REBOOT, mode]
+    );
+  }
+
+  async drawMatrix(matrix) {
+    await this.device.send(
+      Reports.GLITTER_GRID_PWM_CNTL,
+      matrix.flat().map(v => GAMMA[Math.floor((v ?? 0) * 255)])
+    );
+  }
+
+  async drawPixel(r, c, brightness) {
+    await this.device.send(
+      Reports.GLITTER_BASIC_CMD,
+      [Commands.GLITTER_CMD_DRAW_PIXEL, c, r, brightness]
+    );
+  }
+
+  async drawLine({r1, c1}, {r2, c2}, brightness) {
+    await this.device.send(
+      Reports.GLITTER_BASIC_CMD,
+      [Commands.GLITTER_CMD_DRAW_PIXEL, r1, c1, r2, c2, brightness]
+    );
+  }
+
+  device;
+}

package/src/supported-firmware/vddCore/sparkle-fw16/SparkleController.js

@@ -1,50 +1,50 @@
-import { HEIGHT, WIDTH } from '../../../hardware-constants.js';
-import { getDevice } from '../../../web-hid/device.js';
-import { HIDOperations } from '../../../web-hid/HIDOperations.js';
-import { ReportAbstractionLayer } from './ReportAbstractionLayer.js';
-import { BootMode } from './reports.js';
-
-export class SparkleController extends ReportAbstractionLayer {
-  async bootloader() {
-    await super.reboot(BootMode.BOOTSEL);
-  }
-
-  async connect() {
-    const device = await getDevice();
-    if (device) {
-      await device.open();
-      this.device = new HIDOperations(device);
-    }
-  }
-  
-  async draw(matrix) {
-    await super.drawMatrix(matrix);
-  }
-
-  async verifyFirmware() {
-    try {
-      const info = await super.info();
-      return (
-        info.display_height == HEIGHT &&
-        info.display_width == WIDTH
-      );
-    } catch {
-      return false;
-    }
-  }
-
-  async version() {
-    const info = await super.info();
-    if (info.version_major != undefined 
-      && info.version_minor != undefined
-      && (info.version_major > 0 || info.version_minor > 0)) {
-      return {
-        major: info.version_major,
-        minor: info.version_minor
-      }
-    } else {
-      // Sparkle <=1.1.1: Glitter version unavailable 
-      return { major: 1, minor: 0 };
-    }
-  }
-}
+import { HEIGHT, WIDTH } from '../../../hardware-constants.js';
+import { getDevice } from '../../../web-hid/device.js';
+import { HIDOperations } from '../../../web-hid/HIDOperations.js';
+import { ReportAbstractionLayer } from './ReportAbstractionLayer.js';
+import { BootMode } from './reports.js';
+
+export class SparkleController extends ReportAbstractionLayer {
+  async bootloader() {
+    await super.reboot(BootMode.BOOTSEL);
+  }
+
+  async connect() {
+    const device = await getDevice();
+    if (device) {
+      await device.open();
+      this.device = new HIDOperations(device);
+    }
+  }
+  
+  async draw(matrix) {
+    await super.drawMatrix(matrix);
+  }
+
+  async verifyFirmware() {
+    try {
+      const info = await super.info();
+      return (
+        info.display_height == HEIGHT &&
+        info.display_width == WIDTH
+      );
+    } catch {
+      return false;
+    }
+  }
+
+  async version() {
+    const info = await super.info();
+    if (info.version_major != undefined 
+      && info.version_minor != undefined
+      && (info.version_major > 0 || info.version_minor > 0)) {
+      return {
+        major: info.version_major,
+        minor: info.version_minor
+      }
+    } else {
+      // Sparkle <=1.1.1: Glitter version unavailable 
+      return { major: 1, minor: 0 };
+    }
+  }
+}