@duet3d/objectmodel 3.5.0-b8 → 3.5.0-beta.12

package/dist/ModelObject.d.ts

@@ -24,12 +24,21 @@ export declare abstract class ModelObject implements IModelObject {
      * @returns Updated instance (may not equal the original instance)
      */
     update(jsonElement: any): IModelObject | null;
+    /**
+     * Called to check if a diverging property type may be set.
+     * Note that this is not applicable to null values; null is always legit
+     * @param key Property key
+     * @param oldValue Old member value
+     * @param newValue New member value
+     * @returns True if the value can be set by the update call
+     */
+    protected checkDivergingDataType<K extends keyof this>(key: K, oldValue: typeof this[K], newValue: any): boolean;
     /**
      * 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
      */
-    wrapModelProperty<K extends keyof this, T extends IModelObject>(key: K, constructor: {
+    protected wrapModelProperty<K extends keyof this, T extends IModelObject>(key: K, constructor: {
         new (): T;
     }): void;
 }

package/dist/ModelObject.js

@@ -105,7 +105,7 @@ class ModelObject {
                         if (typeof value === "boolean") {
                             this[ownKey] = value;
                         }
-                        else if (typeof value === "number") {
+                        else if (typeof value === "number" || this.checkDivergingDataType(ownKey, prop, value)) {
                             // RRF used to report booleans as integers so convert them if necessary
                             this[ownKey] = Boolean(value);
                         }
@@ -114,7 +114,7 @@ class ModelObject {
                         }
                     }
                     else if (propType === "number") {
-                        if (typeof value === "number" || typeof value === "bigint") {
+                        if (typeof value === "number" || typeof value === "bigint" || this.checkDivergingDataType(ownKey, prop, value)) {
                             this[ownKey] = value;
                         }
                         else if (process.env.NODE_ENV !== "production") {
@@ -122,7 +122,7 @@ class ModelObject {
                         }
                     }
                     else if (propType === "bigint") {
-                        if (typeof value === "number" || typeof value === "bigint") {
+                        if (typeof value === "number" || typeof value === "bigint" || this.checkDivergingDataType(ownKey, prop, value)) {
                             this[ownKey] = value;
                         }
                         else if (process.env.NODE_ENV !== "production") {
@@ -130,7 +130,7 @@ class ModelObject {
                         }
                     }
                     else if (propType === "string") {
-                        if (typeof value === "string") {
+                        if (typeof value === "string" || this.checkDivergingDataType(ownKey, prop, value)) {
                             this[ownKey] = value;
                         }
                         else if (process.env.NODE_ENV !== "production") {
@@ -138,7 +138,7 @@ class ModelObject {
                         }
                     }
                     else if (propType === "function") {
-                        if (typeof value === "function") {
+                        if (typeof value === "function" || this.checkDivergingDataType(ownKey, prop, value)) {
                             this[ownKey] = value;
                         }
                         else if (process.env.NODE_ENV !== "production") {
@@ -146,7 +146,7 @@ class ModelObject {
                         }
                     }
                     else if (propType === "object") {
-                        if (typeof value === "object") {
+                        if (typeof value === "object" || this.checkDivergingDataType(ownKey, prop, value)) {
                             this[ownKey] = value;
                         }
                         else if (process.env.NODE_ENV !== "production") {
@@ -161,6 +161,17 @@ class ModelObject {
         }
         return this;
     }
+    /**
+     * Called to check if a diverging property type may be set.
+     * Note that this is not applicable to null values; null is always legit
+     * @param key Property key
+     * @param oldValue Old member value
+     * @param newValue New member value
+     * @returns True if the value can be set by the update call
+     */
+    checkDivergingDataType(key, oldValue, newValue) {
+        return false;
+    }
     /**
      * Wrap a nullable model object property so that type checks can be performed
      * @param key Property key of the derived class

package/dist/move/kinematics/KinematicsBase.d.ts

@@ -1,17 +1,17 @@
 import ModelObject from "../../ModelObject";
 export declare enum KinematicsName {
     cartesian = "cartesian",
-    coreXY = "corexy",
-    coreXYU = "corexyu",
-    coreXYUV = "corexyuv",
-    coreXZ = "corexz",
-    markForged = "markforged",
-    fiveBarScara = "fivebarscara",
-    hangprinter = "hangprinter",
+    coreXY = "coreXY",
+    coreXYU = "coreXYU",
+    coreXYUV = "coreXYUV",
+    coreXZ = "coreXZ",
+    markForged = "markForged",
+    fiveBarScara = "FiveBarScara",
+    hangprinter = "Hangprinter",
     delta = "delta",
-    polar = "polar",
-    rotaryDelta = "rotary delta",
-    scara = "scara",
+    polar = "Polar",
+    rotaryDelta = "Rotary delta",
+    scara = "Scara",
     unknown = "unknown"
 }
 export declare class MoveSegmentation extends ModelObject {

package/dist/move/kinematics/KinematicsBase.js

@@ -5,17 +5,17 @@ const ModelObject_1 = require("../../ModelObject");
 var KinematicsName;
 (function (KinematicsName) {
     KinematicsName["cartesian"] = "cartesian";
-    KinematicsName["coreXY"] = "corexy";
-    KinematicsName["coreXYU"] = "corexyu";
-    KinematicsName["coreXYUV"] = "corexyuv";
-    KinematicsName["coreXZ"] = "corexz";
-    KinematicsName["markForged"] = "markforged";
-    KinematicsName["fiveBarScara"] = "fivebarscara";
-    KinematicsName["hangprinter"] = "hangprinter";
+    KinematicsName["coreXY"] = "coreXY";
+    KinematicsName["coreXYU"] = "coreXYU";
+    KinematicsName["coreXYUV"] = "coreXYUV";
+    KinematicsName["coreXZ"] = "coreXZ";
+    KinematicsName["markForged"] = "markForged";
+    KinematicsName["fiveBarScara"] = "FiveBarScara";
+    KinematicsName["hangprinter"] = "Hangprinter";
     KinematicsName["delta"] = "delta";
-    KinematicsName["polar"] = "polar";
-    KinematicsName["rotaryDelta"] = "rotary delta";
-    KinematicsName["scara"] = "scara";
+    KinematicsName["polar"] = "Polar";
+    KinematicsName["rotaryDelta"] = "Rotary delta";
+    KinematicsName["scara"] = "Scara";
     KinematicsName["unknown"] = "unknown";
 })(KinematicsName = exports.KinematicsName || (exports.KinematicsName = {}));
 class MoveSegmentation extends ModelObject_1.default {

package/dist/sensors/AnalogSensor.d.ts

@@ -15,9 +15,31 @@ export declare enum AnalogSensorType {
     driversDuex = "driversduex",
     unknown = "unknown"
 }
+export declare enum TemperatureError {
+    ok = "ok",
+    shortCircuit = "shortCircuit",
+    shortToVcc = "shortToVcc",
+    shortToGround = "shortToGround",
+    openCircuit = "openCircuit",
+    timeout = "timeout",
+    ioError = "ioError",
+    hardwareError = "hardwareError",
+    notReady = "notReady",
+    invalidOutputNumber = "invalidOutputNumber",
+    busBusy = "busBusy",
+    badResponse = "badResponse",
+    unknownPort = "unknownPort",
+    notInitialised = "notInitialised",
+    unknownSensor = "unknownSensor",
+    overOrUnderVoltage = "overOrUnderVoltage",
+    badVref = "badVref",
+    badVssa = "badVssa",
+    unknownError = "unknownError"
+}
 export declare class AnalogSensor extends ModelObject {
     lastReading: number | null;
     name: string | null;
+    state: TemperatureError;
     type: AnalogSensorType;
 }
 export default AnalogSensor;

package/dist/sensors/AnalogSensor.js

@@ -1,6 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.AnalogSensor = exports.AnalogSensorType = void 0;
+exports.AnalogSensor = exports.TemperatureError = exports.AnalogSensorType = void 0;
 const ModelObject_1 = require("../ModelObject");
 var AnalogSensorType;
 (function (AnalogSensorType) {
@@ -19,11 +19,34 @@ var AnalogSensorType;
     AnalogSensorType["driversDuex"] = "driversduex";
     AnalogSensorType["unknown"] = "unknown";
 })(AnalogSensorType = exports.AnalogSensorType || (exports.AnalogSensorType = {}));
+var TemperatureError;
+(function (TemperatureError) {
+    TemperatureError["ok"] = "ok";
+    TemperatureError["shortCircuit"] = "shortCircuit";
+    TemperatureError["shortToVcc"] = "shortToVcc";
+    TemperatureError["shortToGround"] = "shortToGround";
+    TemperatureError["openCircuit"] = "openCircuit";
+    TemperatureError["timeout"] = "timeout";
+    TemperatureError["ioError"] = "ioError";
+    TemperatureError["hardwareError"] = "hardwareError";
+    TemperatureError["notReady"] = "notReady";
+    TemperatureError["invalidOutputNumber"] = "invalidOutputNumber";
+    TemperatureError["busBusy"] = "busBusy";
+    TemperatureError["badResponse"] = "badResponse";
+    TemperatureError["unknownPort"] = "unknownPort";
+    TemperatureError["notInitialised"] = "notInitialised";
+    TemperatureError["unknownSensor"] = "unknownSensor";
+    TemperatureError["overOrUnderVoltage"] = "overOrUnderVoltage";
+    TemperatureError["badVref"] = "badVref";
+    TemperatureError["badVssa"] = "badVssa";
+    TemperatureError["unknownError"] = "unknownError";
+})(TemperatureError = exports.TemperatureError || (exports.TemperatureError = {}));
 class AnalogSensor extends ModelObject_1.default {
     constructor() {
         super(...arguments);
         this.lastReading = null;
         this.name = null;
+        this.state = TemperatureError.ok;
         this.type = AnalogSensorType.unknown;
     }
 }

package/dist/spindles/index.d.ts

@@ -10,8 +10,11 @@ export declare class Spindle extends ModelObject {
     canReverse: boolean;
     current: number;
     frequency: number;
+    idlePwm: number;
     min: number;
+    minPwm: number;
     max: number;
+    maxPwm: number;
     state: SpindleState;
 }
 export default Spindle;

package/dist/spindles/index.js

@@ -16,8 +16,11 @@ class Spindle extends ModelObject_1.default {
         this.canReverse = false;
         this.current = 0;
         this.frequency = 0;
+        this.idlePwm = 0;
         this.min = 60;
+        this.minPwm = 0;
         this.max = 10000;
+        this.maxPwm = 1;
         this.state = SpindleState.unconfigured;
     }
 }

package/dist/state/MessageBox.d.ts

@@ -21,5 +21,6 @@ export declare class MessageBox extends ModelObject {
     seq: number;
     timeout: number;
     title: string;
+    protected checkDivergingDataType<K extends keyof this>(key: K, oldValue: this[K], newValue: any): boolean;
 }
 export default MessageBox;

package/dist/state/MessageBox.js

@@ -28,6 +28,9 @@ class MessageBox extends ModelObject_1.default {
         this.timeout = 0;
         this.title = "";
     }
+    checkDivergingDataType(key, oldValue, newValue) {
+        return key === "default" && (typeof newValue === "number" || typeof newValue === "string");
+    }
 }
 exports.MessageBox = MessageBox;
 exports.default = MessageBox;

package/package.json

@@ -1,32 +1,32 @@
-{
-  "name": "@duet3d/objectmodel",
-  "version": "3.5.0-b8",
-  "description": "TypeScript implementation of the Duet3D Object Model",
-  "main": "dist/index.js",
-  "types": "dist/index.d.ts",
-  "scripts": {
-    "test": "jest --config jestconfig.json",
-    "build": "tsc",
-    "prepare": "npm run build",
-    "prepublishOnly": "npm test"
-  },
-  "repository": {
-    "type": "git",
-    "url": "git+https://github.com/Duet3D/ObjectModel.git"
-  },
-  "author": "Christian Hammacher",
-  "license": "LGPL-2.1",
-  "bugs": {
-    "url": "https://github.com/Duet3D/ObjectModel/issues"
-  },
-  "homepage": "https://github.com/Duet3D/ObjectModel#readme",
-  "devDependencies": {
-    "@types/jest": "^27.5.0",
-    "jest": "^27.5.1",
-    "ts-jest": "^27.1.4",
-    "typescript": "^4.6.4"
-  },
-  "files": [
-    "/dist"
-  ]
-}
+{
+  "name": "@duet3d/objectmodel",
+  "version": "3.5.0-beta.12",
+  "description": "TypeScript implementation of the Duet3D Object Model",
+  "main": "dist/index.js",
+  "types": "dist/index.d.ts",
+  "scripts": {
+    "test": "jest --config jestconfig.json",
+    "build": "tsc",
+    "prepare": "npm run build",
+    "prepublishOnly": "npm test"
+  },
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/Duet3D/ObjectModel.git"
+  },
+  "author": "Christian Hammacher",
+  "license": "LGPL-2.1",
+  "bugs": {
+    "url": "https://github.com/Duet3D/ObjectModel/issues"
+  },
+  "homepage": "https://github.com/Duet3D/ObjectModel#readme",
+  "devDependencies": {
+    "@types/jest": "^27.5.0",
+    "jest": "^27.5.1",
+    "ts-jest": "^27.1.4",
+    "typescript": "^4.6.4"
+  },
+  "files": [
+    "/dist"
+  ]
+}