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

package/dist/ModelCollection.js

@@ -39,6 +39,9 @@ class ModelCollection extends Array {
      * @returns Updated instance
      */
     update(jsonElement) {
+        if (jsonElement === null) {
+            return null;
+        }
         if (!(jsonElement instanceof Array)) {
             throw new Error(`Invalid JSON element type for model collection ${typeof jsonElement}`);
         }

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,12 +27,14 @@ 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> | null;
     firmwareDate: string;
     firmwareFileName: string;
     firmwareName: string;
     firmwareVersion: string;
+    freeRam: number | null;
     iapFileNameSBC: string | null;
     iapFileNameSD: string | null;
     maxHeaters: number;
@@ -47,3 +51,4 @@ export declare class Board extends ModelObject {
 }
 export default Board;
 export * from "./directDisplay";
+export * from "./Driver";

package/dist/boards/index.js

@@ -14,9 +14,10 @@ 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 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 +26,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 +42,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,10 +59,12 @@ class Board extends ModelObject_1.default {
         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.maxHeaters = 0;
@@ -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/inputs/InputChannel.d.ts

@@ -12,6 +12,7 @@ export declare enum InputChannelState {
     reading = "reading"
 }
 export declare class InputChannel extends ModelObject {
+    active: boolean;
     axesRelative: boolean;
     compatibility: Compatibility;
     distanceUnit: DistanceUnit;

package/dist/inputs/InputChannel.js

@@ -19,6 +19,7 @@ var InputChannelState;
 class InputChannel extends ModelObject_1.default {
     constructor() {
         super(...arguments);
+        this.active = true;
         this.axesRelative = false;
         this.compatibility = Compatibility_1.default.RepRapFirmware;
         this.distanceUnit = DistanceUnit.mm;

package/dist/move/InputShaping.d.ts

@@ -14,7 +14,7 @@ export declare class InputShaping extends ModelObject {
     damping: number;
     durations: Array<number>;
     frequency: number;
-    minAcceleration: number;
+    reductionLimit: number;
     type: InputShapingType;
 }
 export default InputShaping;

package/dist/move/InputShaping.js

@@ -20,7 +20,7 @@ class InputShaping extends ModelObject_1.default {
         this.damping = 0.1;
         this.durations = [];
         this.frequency = 40;
-        this.minAcceleration = 10;
+        this.reductionLimit = 10;
         this.type = InputShapingType.none;
     }
 }

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/dist/plugins/PluginManifest.d.ts

@@ -52,8 +52,10 @@ export declare class PluginManifest extends ModelObject {
     sbcExecutable: string | null;
     sbcExecutableArguments: string | null;
     sbcExtraExecutables: Array<string>;
+    sbcAutoRestart: boolean;
     sbcOutputRedirected: boolean;
     sbcPermissions: ModelSet<SbcPermission>;
+    sbcConfigFiles: Array<string>;
     sbcPackageDependencies: Array<string>;
     sbcPluginDependencies: Array<string>;
     sbcPythonDependencies: Array<string>;

package/dist/plugins/PluginManifest.js

@@ -57,8 +57,10 @@ class PluginManifest extends ModelObject_1.default {
         this.sbcExecutable = null;
         this.sbcExecutableArguments = null;
         this.sbcExtraExecutables = [];
+        this.sbcAutoRestart = false;
         this.sbcOutputRedirected = true;
         this.sbcPermissions = new ModelSet_1.default();
+        this.sbcConfigFiles = [];
         this.sbcPackageDependencies = [];
         this.sbcPluginDependencies = [];
         this.sbcPythonDependencies = [];

package/dist/sbc/dsf/index.d.ts

@@ -2,12 +2,14 @@ import ModelCollection from "../../ModelCollection";
 import ModelObject from "../../ModelObject";
 import HttpEndpoint from "./HttpEndpoint";
 import UserSession from "./UserSession";
-export declare class SBC extends ModelObject {
+export declare class DSF extends ModelObject {
+    buildDateTime: string;
     readonly httpEndpoints: ModelCollection<HttpEndpoint>;
+    is64Bit: boolean;
     pluginSupport: boolean;
     rootPluginSupport: boolean;
     readonly userSessions: ModelCollection<UserSession>;
     version: string;
 }
-export default SBC;
+export default DSF;
 export * from "./HttpEndpoint";

package/dist/sbc/dsf/index.js

@@ -14,21 +14,23 @@ 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.SBC = void 0;
+exports.DSF = void 0;
 const ModelCollection_1 = require("../../ModelCollection");
 const ModelObject_1 = require("../../ModelObject");
 const HttpEndpoint_1 = require("./HttpEndpoint");
 const UserSession_1 = require("./UserSession");
-class SBC extends ModelObject_1.default {
+class DSF extends ModelObject_1.default {
     constructor() {
         super(...arguments);
+        this.buildDateTime = "";
         this.httpEndpoints = new ModelCollection_1.default(HttpEndpoint_1.default);
+        this.is64Bit = false;
         this.pluginSupport = false;
         this.rootPluginSupport = false;
         this.userSessions = new ModelCollection_1.default(UserSession_1.default);
         this.version = "";
     }
 }
-exports.SBC = SBC;
-exports.default = SBC;
+exports.DSF = DSF;
+exports.default = DSF;
 __exportStar(require("./HttpEndpoint"), exports);

package/dist/sensors/FilamentMonitors/Duet3DFilamentMonitor.d.ts

@@ -0,0 +1,10 @@
+import { FilamentMonitorBase, FilamentMonitorType } from "./FilamentMonitorBase";
+export declare class Duet3DFilamentMonitor extends FilamentMonitorBase {
+    avgPercentage: number | null;
+    lastPercentage: number | null;
+    maxPercentage: number | null;
+    minPercentage: number | null;
+    totalExtrusion: number;
+    constructor(type?: FilamentMonitorType);
+}
+export default Duet3DFilamentMonitor;

package/dist/sensors/FilamentMonitors/Duet3DFilamentMonitor.js

@@ -0,0 +1,16 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.Duet3DFilamentMonitor = void 0;
+const FilamentMonitorBase_1 = require("./FilamentMonitorBase");
+class Duet3DFilamentMonitor extends FilamentMonitorBase_1.FilamentMonitorBase {
+    constructor(type = FilamentMonitorBase_1.FilamentMonitorType.unknown) {
+        super(type);
+        this.avgPercentage = null;
+        this.lastPercentage = null;
+        this.maxPercentage = null;
+        this.minPercentage = null;
+        this.totalExtrusion = 0;
+    }
+}
+exports.Duet3DFilamentMonitor = Duet3DFilamentMonitor;
+exports.default = Duet3DFilamentMonitor;

package/dist/sensors/FilamentMonitors/LaserFilamentMonitor.d.ts

@@ -1,5 +1,5 @@
 import ModelObject, { IModelObject } from "../../ModelObject";
-import FilamentMonitorBase from "./FilamentMonitorBase";
+import { Duet3DFilamentMonitor } from "./Duet3DFilamentMonitor";
 export declare class LaserFilamentMonitorCalibrated extends ModelObject {
     calibrationFactor: number;
     percentMax: number;
@@ -13,7 +13,7 @@ export declare class LaserFilamentMonitorConfigured extends ModelObject {
     percentMin: number;
     sampleDistance: number;
 }
-export declare class LaserFilamentMonitor extends FilamentMonitorBase {
+export declare class LaserFilamentMonitor extends Duet3DFilamentMonitor {
     constructor();
     calibrated: LaserFilamentMonitorCalibrated | null;
     readonly configured: LaserFilamentMonitorConfigured;

package/dist/sensors/FilamentMonitors/LaserFilamentMonitor.js

@@ -3,6 +3,7 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.LaserFilamentMonitor = exports.LaserFilamentMonitorConfigured = exports.LaserFilamentMonitorCalibrated = void 0;
 const ModelObject_1 = require("../../ModelObject");
 const FilamentMonitorBase_1 = require("./FilamentMonitorBase");
+const Duet3DFilamentMonitor_1 = require("./Duet3DFilamentMonitor");
 const index_1 = require("./index");
 class LaserFilamentMonitorCalibrated extends ModelObject_1.default {
     constructor() {
@@ -25,7 +26,7 @@ class LaserFilamentMonitorConfigured extends ModelObject_1.default {
     }
 }
 exports.LaserFilamentMonitorConfigured = LaserFilamentMonitorConfigured;
-class LaserFilamentMonitor extends FilamentMonitorBase_1.default {
+class LaserFilamentMonitor extends Duet3DFilamentMonitor_1.Duet3DFilamentMonitor {
     constructor() {
         super(FilamentMonitorBase_1.FilamentMonitorType.laser);
         this.calibrated = new LaserFilamentMonitorCalibrated();

package/dist/sensors/FilamentMonitors/RotatingMagnetFilamentMonitor.d.ts

@@ -1,5 +1,5 @@
 import ModelObject, { IModelObject } from "../../ModelObject";
-import FilamentMonitorBase from "./FilamentMonitorBase";
+import { Duet3DFilamentMonitor } from "./Duet3DFilamentMonitor";
 export declare class RotatingMagnetFilamentMonitorCalibrated extends ModelObject {
     mmPerPulse: number;
     percentMax: number;
@@ -13,7 +13,7 @@ export declare class RotatingMagnetFilamentMonitorConfigured extends ModelObject
     percentMin: number;
     sampleDistance: number;
 }
-export declare class RotatingMagnetFilamentMonitor extends FilamentMonitorBase {
+export declare class RotatingMagnetFilamentMonitor extends Duet3DFilamentMonitor {
     constructor();
     calibrated: RotatingMagnetFilamentMonitorCalibrated | null;
     readonly configured: RotatingMagnetFilamentMonitorConfigured;

package/dist/sensors/FilamentMonitors/RotatingMagnetFilamentMonitor.js

@@ -3,6 +3,7 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.RotatingMagnetFilamentMonitor = exports.RotatingMagnetFilamentMonitorConfigured = exports.RotatingMagnetFilamentMonitorCalibrated = void 0;
 const ModelObject_1 = require("../../ModelObject");
 const FilamentMonitorBase_1 = require("./FilamentMonitorBase");
+const Duet3DFilamentMonitor_1 = require("./Duet3DFilamentMonitor");
 const index_1 = require("./index");
 class RotatingMagnetFilamentMonitorCalibrated extends ModelObject_1.default {
     constructor() {
@@ -25,7 +26,7 @@ class RotatingMagnetFilamentMonitorConfigured extends ModelObject_1.default {
     }
 }
 exports.RotatingMagnetFilamentMonitorConfigured = RotatingMagnetFilamentMonitorConfigured;
-class RotatingMagnetFilamentMonitor extends FilamentMonitorBase_1.default {
+class RotatingMagnetFilamentMonitor extends Duet3DFilamentMonitor_1.Duet3DFilamentMonitor {
     constructor() {
         super(FilamentMonitorBase_1.FilamentMonitorType.rotatingMagnet);
         this.calibrated = new RotatingMagnetFilamentMonitorCalibrated();

package/dist/sensors/FilamentMonitors/index.d.ts

@@ -6,6 +6,7 @@ export declare class FilamentMonitor extends FilamentMonitorBase {
 export default FilamentMonitor;
 export declare function getFilamentMonitor(type: FilamentMonitorType): FilamentMonitorBase;
 export * from "./FilamentMonitorBase";
+export * from "./Duet3DFilamentMonitor";
 export * from "./LaserFilamentMonitor";
 export * from "./PulsedFilamentMonitor";
 export * from "./RotatingMagnetFilamentMonitor";

package/dist/sensors/FilamentMonitors/index.js

@@ -46,6 +46,7 @@ function getFilamentMonitor(type) {
 }
 exports.getFilamentMonitor = getFilamentMonitor;
 __exportStar(require("./FilamentMonitorBase"), exports);
+__exportStar(require("./Duet3DFilamentMonitor"), exports);
 __exportStar(require("./LaserFilamentMonitor"), exports);
 __exportStar(require("./PulsedFilamentMonitor"), exports);
 __exportStar(require("./RotatingMagnetFilamentMonitor"), exports);

package/dist/sensors/Probe.d.ts

@@ -10,7 +10,8 @@ export declare enum ProbeType {
     zSwitch_obsolete = 7,
     unfilteredDigital = 8,
     blTouch = 9,
-    zMotorStall = 10
+    zMotorStall = 10,
+    scanningAnalog = 11
 }
 export declare class Probe extends ModelObject {
     calibA: number | null;
@@ -26,6 +27,7 @@ export declare class Probe extends ModelObject {
     isCalibrated: boolean | null;
     lastStopHeight: number;
     maxProbeCount: number;
+    measuredHeight: number | null;
     offsets: Array<number>;
     recoveryTime: number;
     scanCoefficients: Array<number> | null;

package/dist/sensors/Probe.js

@@ -15,6 +15,7 @@ var ProbeType;
     ProbeType[ProbeType["unfilteredDigital"] = 8] = "unfilteredDigital";
     ProbeType[ProbeType["blTouch"] = 9] = "blTouch";
     ProbeType[ProbeType["zMotorStall"] = 10] = "zMotorStall";
+    ProbeType[ProbeType["scanningAnalog"] = 11] = "scanningAnalog";
 })(ProbeType || (exports.ProbeType = ProbeType = {}));
 class Probe extends ModelObject_1.default {
     constructor() {
@@ -32,10 +33,11 @@ class Probe extends ModelObject_1.default {
         this.isCalibrated = null;
         this.lastStopHeight = 0;
         this.maxProbeCount = 1;
+        this.measuredHeight = null;
         this.offsets = [0, 0];
         this.recoveryTime = 0;
         this.scanCoefficients = null;
-        this.speeds = [2, 2];
+        this.speeds = [2, 2, 2];
         this.temperatureCoefficients = [0, 0];
         this.threshold = 500;
         this.tolerance = 0.03;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@duet3d/objectmodel",
-  "version": "3.5.0-rc.1",
+  "version": "3.5.0-rc.11",
   "description": "TypeScript implementation of the Duet3D Object Model",
   "main": "dist/index.js",
   "types": "dist/index.d.ts",
@@ -21,10 +21,10 @@
   },
   "homepage": "https://github.com/Duet3D/ObjectModel#readme",
   "devDependencies": {
-    "@types/jest": "^29.4.0",
-    "jest": "^29.4.1",
-    "ts-jest": "^29.0.5",
-    "typescript": "^5.0.2"
+    "@types/jest": "^29.5.12",
+    "jest": "^29.7.0",
+    "ts-jest": "^29.1.2",
+    "typescript": "^5.3.3"
   },
   "files": [
     "/dist"