led-matrix-controllers 0.2.1 → 0.2.3

package/package.json

@@ -1,6 +1,10 @@
 {
   "name": "led-matrix-controllers",
-  "version": "0.2.1",
+  "version": "0.2.3",
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/jpadgett314/led-matrix-controllers.git"
+  },
   "type": "module",
   "main": "./src/index.js",
   "module": "./src/index.js",
@@ -11,7 +15,6 @@
     "src",
     "dist"
   ],
-  "packageManager": "yarn@4.12.0",
   "devDependencies": {
     "@rollup/plugin-node-resolve": "^16.0.3",
     "@rollup/plugin-terser": "^0.4.4",
@@ -20,4 +23,4 @@
   "scripts": {
     "build": "rollup -c"
   }
-}
+}

package/src/HardwareControllerFactory.js

@@ -1,33 +1,33 @@
-import { DefaultController } from './supported-firmware/FrameworkComputer/inputmodule-rs/DefaultController.js';
-import { SigrootController } from './supported-firmware/sigroot/FW_LED_Matrix_Firmware/SigrootController.js';
-import { SparkleController } from './supported-firmware/vddCore/sparkle-fw16/SparkleController.js';
-
-export class HardwareControllerFactory {
-  static async detectSerial() {
-    const c1 = new DefaultController();
-    const c2 = new SigrootController();
-
-    await c1.connect();
-    if (await c1.verifyFirmware()) {
-      return c1;
-    }
-    
-    await c2.connect()
-    if (await c2.verifyFirmware()) {
-      return c2;
-    } 
-    
-    return null;
-  }
-
-  static async detectHID() {
-    const c1 = new SparkleController();
-    
-    await c1.connect();
-    if (await c1.verifyFirmware()) {
-      return c1;
-    } 
-    
-    return null;
-  }
-}
+import { DefaultController } from './supported-firmware/FrameworkComputer/inputmodule-rs/DefaultController.js';
+import { SigrootController } from './supported-firmware/sigroot/FW_LED_Matrix_Firmware/SigrootController.js';
+import { SparkleController } from './supported-firmware/vddCore/sparkle-fw16/SparkleController.js';
+
+export class HardwareControllerFactory {
+  static async detectSerial() {
+    const c1 = new DefaultController();
+    const c2 = new SigrootController();
+
+    await c1.connect();
+    if (await c1.verifyFirmware()) {
+      return c1;
+    }
+    
+    await c2.connect()
+    if (await c2.verifyFirmware()) {
+      return c2;
+    } 
+    
+    return null;
+  }
+
+  static async detectHID() {
+    const c1 = new SparkleController();
+
+    await c1.connect();
+    if (await c1.verifyFirmware()) {
+      return c1;
+    } 
+    
+    return null;
+  }
+}

package/src/hardware-constants.js

@@ -1,41 +1,41 @@
-export const WIDTH = 9;
-export const HEIGHT = 34;
-export const VID = 0x32AC;
-export const VID_ARR = [0x32, 0xAC];
-export const PID = 0x0020;
-export const PID_ARR = [0x00, 0x20];
-
-export const GAMMA = Object.freeze([
-  0, 0, 0, 0, 0, 0, 0, 1, 
-  1, 1, 1, 1, 1, 1, 1, 1, 
-  1, 1, 1, 1, 1, 1, 1, 1, 
-  1, 1, 1, 1, 1, 1, 1, 1, 
-  1, 1, 1, 2, 2, 2, 2, 2, 
-  2, 2, 2, 2, 3, 3, 3, 3, 
-  3, 3, 3, 4, 4, 4, 4, 4, 
-  4, 5, 5, 5, 5, 6, 6, 6, 
-  6, 6, 7, 7, 7, 7, 8, 8, 
-  8, 9, 9, 9, 10, 10, 10, 11, 
-  11, 11, 12, 12, 12, 13, 13, 14, 
-  14, 14, 15, 15, 16, 16, 17, 17, 
-  17, 18, 18, 19, 19, 20, 20, 21, 
-  22, 22, 23, 23, 24, 24, 25, 26, 
-  26, 27, 27, 28, 29, 29, 30, 31, 
-  32, 32, 33, 34, 34, 35, 36, 37, 
-  38, 38, 39, 40, 41, 42, 42, 43, 
-  44, 45, 46, 47, 48, 49, 50, 51, 
-  52, 53, 54, 55, 56, 57, 58, 59, 
-  60, 61, 62, 63, 64, 66, 67, 68, 
-  69, 70, 71, 73, 74, 75, 76, 78, 
-  79, 80, 82, 83, 84, 86, 87, 88, 
-  90, 91, 93, 94, 96, 97, 99, 100, 
-  102, 103, 105, 106, 108, 110, 111, 113, 
-  115, 116, 118, 120, 121, 123, 125, 127, 
-  128, 130, 132, 134, 136, 138, 140, 141, 
-  143, 145, 147, 149, 151, 153, 155, 157, 
-  159, 161, 164, 166, 168, 170, 172, 174, 
-  177, 179, 181, 183, 186, 188, 190, 193, 
-  195, 197, 200, 202, 205, 207, 210, 212, 
-  215, 217, 220, 222, 225, 228, 230, 233, 
-  236, 238, 241, 244, 247, 249, 252, 255
-]);
+export const WIDTH = 9;
+export const HEIGHT = 34;
+export const VID = 0x32AC;
+export const VID_ARR = [0x32, 0xAC];
+export const PID = 0x0020;
+export const PID_ARR = [0x00, 0x20];
+
+export const GAMMA = Object.freeze([
+  0, 0, 0, 0, 0, 0, 0, 1, 
+  1, 1, 1, 1, 1, 1, 1, 1, 
+  1, 1, 1, 1, 1, 1, 1, 1, 
+  1, 1, 1, 1, 1, 1, 1, 1, 
+  1, 1, 1, 2, 2, 2, 2, 2, 
+  2, 2, 2, 2, 3, 3, 3, 3, 
+  3, 3, 3, 4, 4, 4, 4, 4, 
+  4, 5, 5, 5, 5, 6, 6, 6, 
+  6, 6, 7, 7, 7, 7, 8, 8, 
+  8, 9, 9, 9, 10, 10, 10, 11, 
+  11, 11, 12, 12, 12, 13, 13, 14, 
+  14, 14, 15, 15, 16, 16, 17, 17, 
+  17, 18, 18, 19, 19, 20, 20, 21, 
+  22, 22, 23, 23, 24, 24, 25, 26, 
+  26, 27, 27, 28, 29, 29, 30, 31, 
+  32, 32, 33, 34, 34, 35, 36, 37, 
+  38, 38, 39, 40, 41, 42, 42, 43, 
+  44, 45, 46, 47, 48, 49, 50, 51, 
+  52, 53, 54, 55, 56, 57, 58, 59, 
+  60, 61, 62, 63, 64, 66, 67, 68, 
+  69, 70, 71, 73, 74, 75, 76, 78, 
+  79, 80, 82, 83, 84, 86, 87, 88, 
+  90, 91, 93, 94, 96, 97, 99, 100, 
+  102, 103, 105, 106, 108, 110, 111, 113, 
+  115, 116, 118, 120, 121, 123, 125, 127, 
+  128, 130, 132, 134, 136, 138, 140, 141, 
+  143, 145, 147, 149, 151, 153, 155, 157, 
+  159, 161, 164, 166, 168, 170, 172, 174, 
+  177, 179, 181, 183, 186, 188, 190, 193, 
+  195, 197, 200, 202, 205, 207, 210, 212, 
+  215, 217, 220, 222, 225, 228, 230, 233, 
+  236, 238, 241, 244, 247, 249, 252, 255
+]);

package/src/index.js

@@ -1,5 +1,5 @@
-export * from './hardware-constants.js'
-export * from './HardwareControllerFactory.js';
-export * from './supported-firmware/FrameworkComputer/inputmodule-rs/DefaultController.js';
-export * from './supported-firmware/sigroot/FW_LED_Matrix_Firmware/SigrootController.js'
-export * from './supported-firmware/vddCore/sparkle-fw16/SparkleController.js';
+export * from './hardware-constants.js'
+export * from './HardwareControllerFactory.js';
+export * from './supported-firmware/FrameworkComputer/inputmodule-rs/DefaultController.js';
+export * from './supported-firmware/sigroot/FW_LED_Matrix_Firmware/SigrootController.js'
+export * from './supported-firmware/vddCore/sparkle-fw16/SparkleController.js';

package/src/supported-firmware/FrameworkComputer/inputmodule-rs/CommandAbstractionLayer.js

@@ -1,75 +1,123 @@
-import { HEIGHT, VID_ARR, WIDTH } from '../../../hardware-constants.js';
-import { Command, RX_PACKET_SZ } from './commands.js';
-
-export class CommandAbstractionLayer {
-  constructor(portMutex = null) {
-    this.portMutex = portMutex;
-  }
-
-  async bootloader() {
-    await this.portMutex.acquire(async p => {
-      await p.tx([...VID_ARR, Command.BOOTLOADER]);
-    });
-  }
-
-  async draw(matrix) {
-    let index = 0;
-    let output = new Uint8Array(39).fill(0);
-
-    // Pack cells into bits
-    for (let r = 0; r < HEIGHT; r++) {
-      for (let c = 0; c < WIDTH; c++) {
-        if (matrix[r][c]) {
-          output[index >> 3] |= 1 << index % 8;
-        }
-        index++;
-      }
-    }
-
-    await this.portMutex.acquireIdempotent(
-      'drawMatrix', 
-      async p => {
-        await p.tx([...VID_ARR, Command.DRAW, ...output]);
-      }
-    );
-  }
-
-  async drawGrayscale(matrix) {
-    // Transpose & Gamma Correction
-    const buffers = Array.from(
-      { length: WIDTH }, 
-      (_, c) => new Array(
-        { length: HEIGHT }, 
-        (_, r) => GAMMA[Math.floor((matrix[r][c] ?? 0) * 255)]
-      )
-    );
-
-    // Only execute the most recent call 
-    await this.portMutex.acquireIdempotent(
-      'drawMatrix', 
-      async p => {
-        for (let i = 0; i < WIDTH; i++) {
-          await p.tx([Command.STAGE_GREY_COL, i, ...buffers[i]]);
-        }
-        await p.tx([Command.DRAW_GREY_COL_BUFFER]);
-      }
-    );
-  }
-
-  async version() {
-    let ver = {};
-
-    await this.portMutex.acquire(async p => {
-      await p.tx([...VID_ARR, Command.VERSION]);
-      const response = await p.rx(RX_PACKET_SZ);
-
-      // MMMMMMMM mmmmPPPP 0000000p
-      ver.major = response[0];
-      ver.minor = response[1] >> 4;
-      ver.patch = response[1] & 0x0F;
-      ver.preRelease = response[2] == 1;
-    });
-
-    return ver;
-  }
-}
+import { HEIGHT, VID_ARR, WIDTH } from '../../../hardware-constants.js';
+import { Command, RX_PACKET_SZ } from './commands.js';
+
+export class CommandAbstractionLayer {
+  constructor(portMutex = null) {
+    this.portMutex = portMutex;
+  }
+
+  async bootloader() {
+    await this.portMutex.acquire(async p => {
+      await p.tx([...VID_ARR, Command.BOOTLOADER]);
+    });
+  }
+
+  async brightness(brightness) {
+    await this.portMutex.acquire(async p => {
+      await p.tx([...VID_ARR, Command.BRIGHTNESS, brightness]);
+    });
+  }
+
+  async draw(matrix) {
+    let index = 0;
+    let output = new Uint8Array(39).fill(0);
+
+    // Pack cells into bits
+    for (let r = 0; r < HEIGHT; r++) {
+      for (let c = 0; c < WIDTH; c++) {
+        if (matrix[r][c]) {
+          output[index >> 3] |= 1 << index % 8;
+        }
+        index++;
+      }
+    }
+
+    await this.portMutex.acquireIdempotent(
+      'drawMatrix', 
+      async p => {
+        await p.tx([...VID_ARR, Command.DRAW, ...output]);
+      }
+    );
+  }
+
+  async drawGrayscale(matrix) {
+    // Transpose & Gamma Correction
+    const buffers = Array.from(
+      { length: WIDTH }, 
+      (_, c) => new Array(
+        { length: HEIGHT }, 
+        (_, r) => GAMMA[Math.floor((matrix[r][c] ?? 0) * 255)]
+      )
+    );
+
+    // Only execute the most recent call 
+    await this.portMutex.acquireIdempotent(
+      'drawMatrix', 
+      async p => {
+        for (let i = 0; i < WIDTH; i++) {
+          await p.tx([...VID_ARR, Command.STAGE_GREY_COL, i, ...buffers[i]]);
+        }
+        await p.tx([...VID_ARR, Command.DRAW_GREY_COL_BUFFER]);
+      }
+    );
+  }
+
+  async asleep() {
+    let asleep = false;
+
+    await this.portMutex.acquire(async p => {
+      await p.tx([...VID_ARR, Command.SLEEP]);
+      asleep = await p.rx(RX_PACKET_SZ);
+      asleep = asleep[0] != 0x00;
+    });
+
+    return asleep;
+  }
+
+  async sleep() {
+    await this.portMutex.acquire(async p => {
+      await p.tx([...VID_ARR, Command.SLEEP, 0x01]);
+    });
+  }
+
+  async wake() {
+    await this.portMutex.acquire(async p => {
+      await p.tx([...VID_ARR, Command.SLEEP]);
+    });
+  }
+
+  async pattern(pattern) {
+    await this.portMutex.acquireIdempotent(
+      'drawMatrix',
+      async p => {
+        await p.tx([...VID_ARR, Command.PATTERN, pattern]);
+      }
+    );
+  }
+
+  async percent(percent) {
+    await this.portMutex.acquireIdempotent(
+      'drawMatrix',
+      async p => {
+        await p.tx([...VID_ARR, Command.PATTERN, Pattern.PERCENTAGE, percent]);
+      }
+    );
+  }
+
+  async version() {
+    let ver = {};
+
+    await this.portMutex.acquire(async p => {
+      await p.tx([...VID_ARR, Command.VERSION]);
+      const response = await p.rx(RX_PACKET_SZ);
+
+      // MMMMMMMM mmmmPPPP 0000000p
+      ver.major = response[0];
+      ver.minor = response[1] >> 4;
+      ver.patch = response[1] & 0x0F;
+      ver.preRelease = response[2] == 1;
+    });
+
+    return ver;
+  }
+}

package/src/supported-firmware/FrameworkComputer/inputmodule-rs/DefaultController.js

@@ -1,54 +1,54 @@
-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';
-
-export class DefaultController extends CommandAbstractionLayer {
-  async bootloader() {
-    return 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) {
-    switch (this.#bitDepth) {
-
-      case BitDepth.GRAY_8BIT:
-        super.drawGrayscale(matrix);
-        break;
-
-      case BitDepth.MONO_1BIT:
-        super.draw(matrix);
-        break;
-    }
-  }
-
-  async verifyFirmware() {
-    try {
-      const version = await super.version();
-
-      return version
-        && version.major != undefined
-        && version.minor != undefined
-        && version.patch != undefined
-        && version.preRelease != undefined;
-        
-    } catch {
-      return false;
-    }
-  }
-
-  async version() {
-    return super.version();
-  }
-
-  #bitDepth;
-}
+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';
+
+export class DefaultController extends CommandAbstractionLayer {
+  async bootloader() {
+    return 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) {
+    switch (this.#bitDepth) {
+
+      case BitDepth.GRAY_8BIT:
+        super.drawGrayscale(matrix);
+        break;
+
+      case BitDepth.MONO_1BIT:
+        super.draw(matrix);
+        break;
+    }
+  }
+
+  async verifyFirmware() {
+    try {
+      const version = await super.version();
+
+      return version
+        && version.major != undefined
+        && version.minor != undefined
+        && version.patch != undefined
+        && version.preRelease != undefined;
+        
+    } catch {
+      return false;
+    }
+  }
+
+  async version() {
+    return super.version();
+  }
+
+  #bitDepth;
+}

package/src/supported-firmware/FrameworkComputer/inputmodule-rs/commands.js

@@ -1,36 +1,36 @@
-// All replies to all commands are 32 bytes
-export const RX_PACKET_SZ = 32;
-
-export const Command = Object.freeze({
-  ANIMATE: 0x04,
-  BRIGHTNESS: 0x00,
-  BOOTLOADER: 0x02,
-  DRAW: 0x06,
-  DRAW_GREY_COL_BUFFER: 0x08,
-  GAME_CTRL: 0x11,
-  GAME_STATUS: 0x12,
-  PANIC: 0x05,
-  PATTERN: 0x01,
-  SLEEP: 0x03,
-  STAGE_GREY_COL: 0x07,
-  START_GAME: 0x10,
-  VERSION: 0x20,
-});
-
-// Used with Command.PATTERN
-export const Pattern = Object.freeze({
-  DISPLAY_LOTUS_HORIZONTAL: 0x03,
-  DISPLAY_LOTUS_VERTICAL: 0x07,
-  DISPLAY_PANIC: 0x06,
-  DOUBLE_GRADIENT: 0x02,
-  FULL_BRIGHTNESS: 0x05,
-  GRADIENT: 0x01,
-  PERCENTAGE: 0x00,
-  ZIG_ZAG: 0x04,
-});
-
-// DRAW or DRAW_GREY_COL_BUFFER
-export const BitDepth = Object.freeze({
-  GRAY_8BIT: '8-bit',
-  MONO_1BIT: '1-bit',
-})
+// All replies to all commands are 32 bytes
+export const RX_PACKET_SZ = 32;
+
+export const Command = Object.freeze({
+  ANIMATE: 0x04,
+  BRIGHTNESS: 0x00,
+  BOOTLOADER: 0x02,
+  DRAW: 0x06,
+  DRAW_GREY_COL_BUFFER: 0x08,
+  GAME_CTRL: 0x11,
+  GAME_STATUS: 0x12,
+  PANIC: 0x05,
+  PATTERN: 0x01,
+  SLEEP: 0x03,
+  STAGE_GREY_COL: 0x07,
+  START_GAME: 0x10,
+  VERSION: 0x20,
+});
+
+// Used with Command.PATTERN
+export const Pattern = Object.freeze({
+  DISPLAY_LOTUS_HORIZONTAL: 0x03,
+  DISPLAY_LOTUS_VERTICAL: 0x07,
+  DISPLAY_PANIC: 0x06,
+  DOUBLE_GRADIENT: 0x02,
+  FULL_BRIGHTNESS: 0x05,
+  GRADIENT: 0x01,
+  PERCENTAGE: 0x00,
+  ZIG_ZAG: 0x04,
+});
+
+// DRAW or DRAW_GREY_COL_BUFFER
+export const BitDepth = Object.freeze({
+  GRAY_8BIT: '8-bit',
+  MONO_1BIT: '1-bit',
+})