@duet3d/objectmodel 3.7.0-beta.8 → 3.7.0-rc.1

package/dist/ModelCollection.d.ts

@@ -1,15 +1,25 @@
 import type { IModelObject } from "./ModelObject";
+/**
+ * Factory creating the item for a given index
+ */
+export type ItemFactory<T> = (index: number) => T;
 /**
  * Class for storing model object items in an array
  */
 export declare class ModelCollection<T extends IModelObject | null> extends Array<T> implements IModelObject {
+    /**
+     * Derived arrays from filter, map, slice etc. would otherwise be constructed as
+     * new ModelCollection(length), leaving $itemConstructor set to a number
+     */
+    static get [Symbol.species](): ArrayConstructor;
     /**
      * Constructor of this class
      * @param itemConstructor Item constructor type that items must derive from
+     * @param itemFactory Factory to use for collections whose item class depends on the position, e.g. boards
      */
     constructor(itemConstructor: {
         new (): T;
-    });
+    }, itemFactory?: ItemFactory<T> | null);
     /**
      * Overridden push method to perform better type checks
      * @param items Items to add

package/dist/ModelCollection.js

@@ -1,16 +1,36 @@
 import { isModelObject } from "./ModelObject";
+/**
+ * Create the item for a given index. This is deliberately not a method of the collection because
+ * a non-public member would make the class nominally typed, which breaks assignability of the
+ * reactive proxies consumers wrap the object model in
+ * @param collection Collection the item is created for
+ * @param index Index the new item is going to be stored at
+ * @returns New item
+ */
+function createItem(collection, index) {
+    return (collection.$itemFactory !== null) ? collection.$itemFactory(index) : new collection.$itemConstructor();
+}
 /**
  * Class for storing model object items in an array
  */
 export class ModelCollection extends Array {
+    /**
+     * Derived arrays from filter, map, slice etc. would otherwise be constructed as
+     * new ModelCollection(length), leaving $itemConstructor set to a number
+     */
+    static get [Symbol.species]() {
+        return Array;
+    }
     /**
      * Constructor of this class
      * @param itemConstructor Item constructor type that items must derive from
+     * @param itemFactory Factory to use for collections whose item class depends on the position, e.g. boards
      */
-    constructor(itemConstructor) {
+    constructor(itemConstructor, itemFactory = null) {
         super();
         Object.setPrototypeOf(this, ModelCollection.prototype);
         Object.defineProperty(this, "$itemConstructor", { enumerable: false, value: itemConstructor });
+        Object.defineProperty(this, "$itemFactory", { enumerable: false, value: itemFactory });
     }
     // Unfortunately it isn't possible to override index operators in JS/TS
     /**
@@ -24,7 +44,7 @@ export class ModelCollection extends Array {
                 super.push(item);
             }
             else {
-                const newItem = new that.$itemConstructor();
+                const newItem = createItem(that, this.length);
                 super.push(newItem.update(item));
             }
         }
@@ -55,7 +75,7 @@ export class ModelCollection extends Array {
                     this[i] = jsonElement[i];
                 }
                 else {
-                    const refItem = new that.$itemConstructor();
+                    const refItem = createItem(that, i);
                     this[i] = refItem.update(newItem, authoritative);
                 }
             }
@@ -79,7 +99,7 @@ export class ModelCollection extends Array {
                 super.push(itemToAdd);
             }
             else {
-                const newItem = new that.$itemConstructor();
+                const newItem = createItem(that, i);
                 super.push(newItem.update(itemToAdd, authoritative));
             }
         }

package/dist/ObjectModel.js

@@ -1,7 +1,7 @@
 import ModelCollection from "./ModelCollection";
 import ModelDictionary from "./ModelDictionary";
 import ModelObject from "./ModelObject";
-import Board from "./boards";
+import Board, { getBoard } from "./boards";
 import Directories from "./directories";
 import Fan from "./fans";
 import Heat from "./heat";
@@ -25,7 +25,7 @@ import LedStrip from "./ledStrips";
 export class ObjectModel extends ModelObject {
     constructor() {
         super();
-        this.boards = new ModelCollection(Board);
+        this.boards = new ModelCollection(Board, getBoard);
         this.directories = new Directories();
         this.fans = new ModelCollection(Fan);
         this.global = new ModelDictionary(false);

package/dist/boards/directDisplay/DirectDisplayScreen.d.ts

@@ -1,6 +1,6 @@
 import type { IModelObject } from "../../ModelObject";
 import DirectDisplayScreenBase from "./DirectDisplayScreenBase";
 export declare class DirectDisplayScreen extends DirectDisplayScreenBase {
-    update(jsonElement: any): IModelObject | null;
+    update(jsonElement: any, authoritative?: boolean): IModelObject | null;
 }
 export default DirectDisplayScreen;

package/dist/boards/directDisplay/DirectDisplayScreen.js

@@ -1,14 +1,14 @@
 import { getDirectDisplayScreen } from ".";
 import DirectDisplayScreenBase from "./DirectDisplayScreenBase";
 export class DirectDisplayScreen extends DirectDisplayScreenBase {
-    update(jsonElement) {
+    update(jsonElement, authoritative = false) {
         if (jsonElement === null) {
             return null;
         }
         if (typeof jsonElement.controller === "string" && jsonElement.controller !== this.controller) {
-            return getDirectDisplayScreen(jsonElement.controller).update(jsonElement);
+            return getDirectDisplayScreen(jsonElement.controller).update(jsonElement, authoritative);
         }
-        return super.update(jsonElement);
+        return super.update(jsonElement, authoritative);
     }
 }
 export default DirectDisplayScreen;

package/dist/boards/directDisplay/DirectDisplayScreenST7567.d.ts

@@ -4,6 +4,6 @@ export declare class DirectDisplayScreenST7567 extends DirectDisplayScreenBase {
     constructor();
     contrast: number;
     resistorRatio: number;
-    update(jsonElement: any): IModelObject | null;
+    update(jsonElement: any, authoritative?: boolean): IModelObject | null;
 }
 export default DirectDisplayScreenST7567;

package/dist/boards/directDisplay/DirectDisplayScreenST7567.js

@@ -6,14 +6,14 @@ export class DirectDisplayScreenST7567 extends DirectDisplayScreenBase {
         this.contrast = 30;
         this.resistorRatio = 6;
     }
-    update(jsonElement) {
+    update(jsonElement, authoritative = false) {
         if (jsonElement === null) {
             return null;
         }
         if (typeof jsonElement.controller === "string" && jsonElement.controller !== this.controller) {
-            return getDirectDisplayScreen(jsonElement.controller).update(jsonElement);
+            return getDirectDisplayScreen(jsonElement.controller).update(jsonElement, authoritative);
         }
-        return super.update(jsonElement);
+        return super.update(jsonElement, authoritative);
     }
 }
 export default DirectDisplayScreenST7567;

package/dist/boards/index.d.ts

@@ -5,7 +5,9 @@ import Driver from "./Driver";
 export declare class Accelerometer extends ModelObject {
     orientation: number;
     points: number;
+    resolution: number;
     runs: number;
+    samplingRate: number;
 }
 export declare class BoardClosedLoop extends ModelObject {
     points: number;
@@ -30,30 +32,43 @@ export declare class Board extends ModelObject {
     constructor();
     accelerometer: Accelerometer | null;
     canAddress: number | null;
-    closedLoop: BoardClosedLoop | null;
-    directDisplay: DirectDisplay | null;
     drivers: ModelCollection<Driver> | null;
     firmwareDate: string;
     firmwareFileName: string;
-    firmwareName: string;
     firmwareVersion: string;
     freeRam: number | null;
-    iapFileNameSBC: string | null;
-    iapFileNameSD: string | null;
-    inductiveSensor: InductiveSensor | null;
-    maxHeaters: number;
     maxMotors: number;
     mcuTemp: MinMaxCurrent | null;
     name: string;
     shortName: string;
-    state: BoardState;
-    supportsDirectDisplay: boolean;
-    timeout: number;
     uniqueId: string | null;
     v12: MinMaxCurrent | null;
     vIn: MinMaxCurrent | null;
+}
+export declare class MainBoard extends Board {
+    constructor();
+    directDisplay: DirectDisplay | null;
+    firmwareName: string;
+    iapFileNameSBC: string | null;
+    iapFileNameSD: string | null;
+    maxHeaters: number;
+    supportsDirectDisplay: boolean;
     wifiFirmwareFileName: string | null;
 }
+export declare class ExpansionBoard extends Board {
+    constructor();
+    closedLoop: BoardClosedLoop | null;
+    inductiveSensor: InductiveSensor | null;
+    state: BoardState;
+    timeout: number;
+}
 export default Board;
+/**
+ * Create the board instance for a given index. The first item is always the mainboard,
+ * every other item is an expansion board connected over CAN
+ * @param index Index in the boards array
+ * @returns New board instance
+ */
+export declare function getBoard(index: number): Board;
 export * from "./directDisplay";
 export * from "./Driver";

package/dist/boards/index.js

@@ -7,7 +7,9 @@ export class Accelerometer extends ModelObject {
         super(...arguments);
         this.orientation = 20;
         this.points = 0;
+        this.resolution = 0;
         this.runs = 0;
+        this.samplingRate = 0;
     }
 }
 export class BoardClosedLoop extends ModelObject {
@@ -41,39 +43,58 @@ export class Board extends ModelObject {
         super();
         this.accelerometer = null;
         this.canAddress = null;
-        this.closedLoop = null;
-        this.directDisplay = null;
         this.drivers = null;
         this.firmwareDate = "";
         this.firmwareFileName = "";
-        this.firmwareName = "";
         this.firmwareVersion = "";
         this.freeRam = null;
-        this.iapFileNameSBC = null;
-        this.iapFileNameSD = null;
-        this.inductiveSensor = null;
-        this.maxHeaters = 0;
         this.maxMotors = 0;
         this.mcuTemp = null;
         this.name = "";
         this.shortName = "";
-        this.state = BoardState.unknown;
-        this.supportsDirectDisplay = false;
-        this.timeout = 10;
         this.uniqueId = null;
         this.v12 = null;
         this.vIn = null;
-        this.wifiFirmwareFileName = null;
         ModelObject.wrapModelProperty(this, "accelerometer", Accelerometer);
-        ModelObject.wrapModelProperty(this, "closedLoop", BoardClosedLoop);
-        ModelObject.wrapModelProperty(this, "directDisplay", DirectDisplay);
         ModelObject.wrapModelCollectionProperty(this, "drivers", Driver);
-        ModelObject.wrapModelProperty(this, "inductiveSensor", InductiveSensor);
         ModelObject.wrapModelProperty(this, "mcuTemp", MinMaxCurrent);
         ModelObject.wrapModelProperty(this, "v12", MinMaxCurrent);
         ModelObject.wrapModelProperty(this, "vIn", MinMaxCurrent);
     }
 }
+export class MainBoard extends Board {
+    constructor() {
+        super();
+        this.directDisplay = null;
+        this.firmwareName = "";
+        this.iapFileNameSBC = null;
+        this.iapFileNameSD = null;
+        this.maxHeaters = 0;
+        this.supportsDirectDisplay = false;
+        this.wifiFirmwareFileName = null;
+        ModelObject.wrapModelProperty(this, "directDisplay", DirectDisplay);
+    }
+}
+export class ExpansionBoard extends Board {
+    constructor() {
+        super();
+        this.closedLoop = null;
+        this.inductiveSensor = null;
+        this.state = BoardState.unknown;
+        this.timeout = 10;
+        ModelObject.wrapModelProperty(this, "closedLoop", BoardClosedLoop);
+        ModelObject.wrapModelProperty(this, "inductiveSensor", InductiveSensor);
+    }
+}
 export default Board;
+/**
+ * Create the board instance for a given index. The first item is always the mainboard,
+ * every other item is an expansion board connected over CAN
+ * @param index Index in the boards array
+ * @returns New board instance
+ */
+export function getBoard(index) {
+    return (index === 0) ? new MainBoard() : new ExpansionBoard();
+}
 export * from "./directDisplay";
 export * from "./Driver";