@duet3d/objectmodel 3.5.0-rc.1 → 3.5.0-rc.2

package/dist/ModelObject.d.ts

@@ -24,6 +24,14 @@ export declare abstract class ModelObject implements IModelObject {
      * @returns Updated instance (may not equal the original instance)
      */
     update(jsonElement: any): IModelObject | null;
+    /**
+     * Wrap a nullable model object property so that type checks can be performed
+     * @param key Property key of the derived class
+     * @param constructor Constructor for creating new elements
+     */
+    static wrapModelCollectionProperty<S extends IModelObject, K extends keyof S, T extends IModelObject | null>(self: S, key: K, itemConstructor: {
+        new (): T;
+    }): void;
     /**
      * Wrap a nullable model object property so that type checks can be performed
      * @param key Property key of the derived class

package/dist/ModelObject.js

@@ -169,6 +169,34 @@ class ModelObject {
         }
         return this;
     }
+    /**
+     * Wrap a nullable model object property so that type checks can be performed
+     * @param key Property key of the derived class
+     * @param constructor Constructor for creating new elements
+     */
+    static wrapModelCollectionProperty(self, key, itemConstructor) {
+        let propertyValue = self[key];
+        Object.defineProperty(self, key, {
+            get() { return propertyValue; },
+            set(newValue) {
+                if (newValue === null) {
+                    propertyValue = null;
+                }
+                else if (propertyValue !== null) {
+                    const newModel = propertyValue.update(newValue);
+                    if (propertyValue !== newModel) {
+                        propertyValue = newModel;
+                    }
+                }
+                else {
+                    const newModel = new index_1.ModelCollection(itemConstructor);
+                    propertyValue = newModel.update(newValue);
+                }
+            },
+            configurable: true,
+            enumerable: true
+        });
+    }
     /**
      * Wrap a nullable model object property so that type checks can be performed
      * @param key Property key of the derived class

package/dist/boards/Driver.d.ts

@@ -0,0 +1,18 @@
+import { ModelObject } from "..";
+export declare class BoardClosedLoopCurrentFraction extends ModelObject {
+    avg: number;
+    positionError: number;
+}
+export declare class BoardClosedLoopPositionError extends ModelObject {
+    max: number;
+    rms: number;
+}
+export declare class DriverClosedLoop extends ModelObject {
+    readonly currentFraction: BoardClosedLoopCurrentFraction;
+    readonly positionError: BoardClosedLoopPositionError;
+}
+export default class Driver extends ModelObject {
+    constructor();
+    closedLoop: DriverClosedLoop | null;
+    status: number;
+}

package/dist/boards/Driver.js

@@ -0,0 +1,37 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.DriverClosedLoop = exports.BoardClosedLoopPositionError = exports.BoardClosedLoopCurrentFraction = void 0;
+const __1 = require("..");
+class BoardClosedLoopCurrentFraction extends __1.ModelObject {
+    constructor() {
+        super(...arguments);
+        this.avg = 0;
+        this.positionError = 0;
+    }
+}
+exports.BoardClosedLoopCurrentFraction = BoardClosedLoopCurrentFraction;
+class BoardClosedLoopPositionError extends __1.ModelObject {
+    constructor() {
+        super(...arguments);
+        this.max = 0;
+        this.rms = 0;
+    }
+}
+exports.BoardClosedLoopPositionError = BoardClosedLoopPositionError;
+class DriverClosedLoop extends __1.ModelObject {
+    constructor() {
+        super(...arguments);
+        this.currentFraction = new BoardClosedLoopCurrentFraction();
+        this.positionError = new BoardClosedLoopPositionError();
+    }
+}
+exports.DriverClosedLoop = DriverClosedLoop;
+class Driver extends __1.ModelObject {
+    constructor() {
+        super();
+        this.closedLoop = null;
+        this.status = 0;
+        __1.ModelObject.wrapModelProperty(this, "closedLoop", DriverClosedLoop);
+    }
+}
+exports.default = Driver;

package/dist/boards/index.d.ts

@@ -1,9 +1,15 @@
+import ModelCollection from "../ModelCollection";
 import ModelObject from "../ModelObject";
 import DirectDisplay from "./directDisplay";
+import Driver from "./Driver";
 export declare class Accelerometer extends ModelObject {
     points: number;
     runs: number;
 }
+export declare class BoardClosedLoop extends ModelObject {
+    points: number;
+    runs: number;
+}
 export declare enum BoardState {
     unknown = "unknown",
     flashing = "flashing",
@@ -11,10 +17,6 @@ export declare enum BoardState {
     resetting = "resetting",
     running = "running"
 }
-export declare class ClosedLoop extends ModelObject {
-    points: number;
-    runs: number;
-}
 export declare class MinMaxCurrent extends ModelObject {
     current: number;
     min: number;
@@ -25,8 +27,9 @@ export declare class Board extends ModelObject {
     accelerometer: Accelerometer | null;
     bootloaderFileName: string | null;
     canAddress: number | null;
-    closedLoop: ClosedLoop | null;
+    closedLoop: BoardClosedLoop | null;
     directDisplay: DirectDisplay | null;
+    drivers: ModelCollection<Driver>;
     firmwareDate: string;
     firmwareFileName: string;
     firmwareName: string;
@@ -47,3 +50,4 @@ export declare class Board extends ModelObject {
 }
 export default Board;
 export * from "./directDisplay";
+export * from "./Driver";

package/dist/boards/index.js

@@ -14,9 +14,11 @@ var __exportStar = (this && this.__exportStar) || function(m, exports) {
     for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.Board = exports.MinMaxCurrent = exports.ClosedLoop = exports.BoardState = exports.Accelerometer = void 0;
+exports.Board = exports.MinMaxCurrent = exports.BoardState = exports.BoardClosedLoop = exports.Accelerometer = void 0;
+const ModelCollection_1 = require("../ModelCollection");
 const ModelObject_1 = require("../ModelObject");
 const directDisplay_1 = require("./directDisplay");
+const Driver_1 = require("./Driver");
 class Accelerometer extends ModelObject_1.default {
     constructor() {
         super(...arguments);
@@ -25,6 +27,14 @@ class Accelerometer extends ModelObject_1.default {
     }
 }
 exports.Accelerometer = Accelerometer;
+class BoardClosedLoop extends ModelObject_1.default {
+    constructor() {
+        super(...arguments);
+        this.points = 0;
+        this.runs = 0;
+    }
+}
+exports.BoardClosedLoop = BoardClosedLoop;
 var BoardState;
 (function (BoardState) {
     BoardState["unknown"] = "unknown";
@@ -33,14 +43,6 @@ var BoardState;
     BoardState["resetting"] = "resetting";
     BoardState["running"] = "running";
 })(BoardState || (exports.BoardState = BoardState = {}));
-class ClosedLoop extends ModelObject_1.default {
-    constructor() {
-        super(...arguments);
-        this.points = 0;
-        this.runs = 0;
-    }
-}
-exports.ClosedLoop = ClosedLoop;
 class MinMaxCurrent extends ModelObject_1.default {
     constructor() {
         super(...arguments);
@@ -58,6 +60,7 @@ class Board extends ModelObject_1.default {
         this.canAddress = null;
         this.closedLoop = null;
         this.directDisplay = null;
+        this.drivers = new ModelCollection_1.default(Driver_1.default);
         this.firmwareDate = "";
         this.firmwareFileName = "";
         this.firmwareName = "";
@@ -76,8 +79,9 @@ class Board extends ModelObject_1.default {
         this.vIn = null;
         this.wifiFirmwareFileName = null;
         ModelObject_1.default.wrapModelProperty(this, "accelerometer", Accelerometer);
-        ModelObject_1.default.wrapModelProperty(this, "closedLoop", ClosedLoop);
+        ModelObject_1.default.wrapModelProperty(this, "closedLoop", BoardClosedLoop);
         ModelObject_1.default.wrapModelProperty(this, "directDisplay", directDisplay_1.default);
+        ModelObject_1.default.wrapModelCollectionProperty(this, "drivers", Driver_1.default);
         ModelObject_1.default.wrapModelProperty(this, "mcuTemp", MinMaxCurrent);
         ModelObject_1.default.wrapModelProperty(this, "v12", MinMaxCurrent);
         ModelObject_1.default.wrapModelProperty(this, "vIn", MinMaxCurrent);
@@ -86,3 +90,4 @@ class Board extends ModelObject_1.default {
 exports.Board = Board;
 exports.default = Board;
 __exportStar(require("./directDisplay"), exports);
+__exportStar(require("./Driver"), exports);

package/dist/move/KeepoutZone.d.ts

@@ -6,5 +6,5 @@ export declare class KeepoutZoneCoordinates extends ModelObject {
 }
 export default class KeepoutZone extends ModelObject {
     active: boolean;
-    coords: ModelCollection<KeepoutZoneCoordinates | null>;
+    readonly coords: ModelCollection<KeepoutZoneCoordinates | null>;
 }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@duet3d/objectmodel",
-  "version": "3.5.0-rc.1",
+  "version": "3.5.0-rc.2",
   "description": "TypeScript implementation of the Duet3D Object Model",
   "main": "dist/index.js",
   "types": "dist/index.d.ts",