@duet3d/objectmodel 3.7.0-alpha.1 → 3.7.0-alpha.11

package/dist/ModelCollection.d.ts

@@ -1,4 +1,4 @@
-import { IModelObject } from "./ModelObject";
+import type { IModelObject } from "./ModelObject";
 /**
  * Class for storing model object items in an array
  */

package/dist/ModelCollection.js

@@ -1,13 +1,9 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.ModelCollection = void 0;
-exports.initCollection = initCollection;
-const ModelObject_1 = require("./ModelObject");
-const index_1 = require("./index");
+import { isModelObject } from "./ModelObject";
+import { setArrayItem } from "./index";
 /**
  * Class for storing model object items in an array
  */
-class ModelCollection extends Array {
+export class ModelCollection extends Array {
     /**
      * Constructor of this class
      * @param itemConstructor Item constructor type that items must derive from
@@ -56,23 +52,23 @@ class ModelCollection extends Array {
             if (currentItem === null) {
                 const newItem = jsonElement[i];
                 if (newItem instanceof that.$itemConstructor) {
-                    (0, index_1.setArrayItem)(this, i, jsonElement[i]);
+                    setArrayItem(this, i, jsonElement[i]);
                 }
                 else {
                     const refItem = new that.$itemConstructor();
-                    (0, index_1.setArrayItem)(this, i, refItem.update(newItem));
+                    setArrayItem(this, i, refItem.update(newItem));
                 }
             }
-            else if ((0, ModelObject_1.isModelObject)(currentItem)) {
+            else if (isModelObject(currentItem)) {
                 const newItem = currentItem.update(jsonElement[i]);
                 if (currentItem !== newItem) {
-                    (0, index_1.setArrayItem)(this, i, newItem);
+                    setArrayItem(this, i, newItem);
                 }
             }
             else {
                 const newItem = jsonElement[i];
                 if (currentItem !== newItem) {
-                    (0, index_1.setArrayItem)(this, i, newItem);
+                    setArrayItem(this, i, newItem);
                 }
             }
         }
@@ -90,15 +86,14 @@ class ModelCollection extends Array {
         return this;
     }
 }
-exports.ModelCollection = ModelCollection;
-exports.default = ModelCollection;
+export default ModelCollection;
 /**
  * Initialize a model collection from the given data
  * @param itemType Item type to create
  * @param data Data to assign
  * @returns Initialized model collection
  */
-function initCollection(itemType, data) {
+export function initCollection(itemType, data) {
     const result = new ModelCollection(itemType);
     for (let presetItem of data) {
         const item = new itemType();

package/dist/ModelDictionary.d.ts

@@ -1,4 +1,4 @@
-import { IModelObject } from "./ModelObject";
+import type { IModelObject } from "./ModelObject";
 /**
  * Dictionary class to map object model data
  */

package/dist/ModelDictionary.js

@@ -1,12 +1,8 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.ModelDictionary = void 0;
-exports.initDictionary = initDictionary;
-const ModelObject_1 = require("./ModelObject");
+import { isModelObject } from "./ModelObject";
 /**
  * Dictionary class to map object model data
  */
-class ModelDictionary extends Map {
+export class ModelDictionary extends Map {
     /**
      * Constructor of this class
      * @param nullDeletesKeys Whether setting null to items effectively deletes them
@@ -36,13 +32,13 @@ class ModelDictionary extends Map {
         if (currentItem == null) {
             if (that.$itemConstructor !== null && !(value instanceof that.$itemConstructor)) {
                 const newItem = new that.$itemConstructor();
-                if ((0, ModelObject_1.isModelObject)(newItem)) {
+                if (isModelObject(newItem)) {
                     const updatedItem = newItem.update(value);
                     return super.set(key, updatedItem);
                 }
             }
         }
-        else if ((0, ModelObject_1.isModelObject)(currentItem)) {
+        else if (isModelObject(currentItem)) {
             const newItem = currentItem.update(value);
             if (currentItem !== newItem) {
                 return super.set(key, value);
@@ -84,8 +80,7 @@ class ModelDictionary extends Map {
         return json;
     }
 }
-exports.ModelDictionary = ModelDictionary;
-exports.default = ModelDictionary;
+export default ModelDictionary;
 /**
  * Initialize a model dictionary from the given data
  * @param nullDeletesKeys Defines whether setting values to null deletes the corresponding key
@@ -93,11 +88,11 @@ exports.default = ModelDictionary;
  * @param data Data to assign
  * @returns Initialized model dictionary
  */
-function initDictionary(nullDeletesKeys, itemConstructor, data) {
+export function initDictionary(nullDeletesKeys, itemConstructor, data) {
     const result = new ModelDictionary(nullDeletesKeys, itemConstructor);
     for (let key in data) {
         const item = new itemConstructor();
-        if ((0, ModelObject_1.isModelObject)(item)) {
+        if (isModelObject(item)) {
             item.update(data[key]);
             result.set(key, item);
         }

package/dist/ModelObject.js

@@ -1,20 +1,15 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.ModelObject = void 0;
-exports.isModelObject = isModelObject;
-exports.initObject = initObject;
-const index_1 = require("./index");
+import { ModelCollection, setArrayItem } from "./index";
 /**
  * Check whether a given value provides model update functionality
  * @param value Value to check
  */
-function isModelObject(value) {
+export function isModelObject(value) {
     return (value instanceof Object) && value.update !== undefined;
 }
 /**
  * Base class for object model classes
  */
-class ModelObject {
+export class ModelObject {
     /**
      * Update this instance from the given data
      * @param jsonElement JSON data to upgrade this instance from
@@ -54,12 +49,12 @@ class ModelObject {
                         for (let i = 0; i < Math.min(prop.length, value.length); i++) {
                             const propItem = prop[i];
                             if (propItem === null) {
-                                (0, index_1.setArrayItem)(prop, i, value[i]);
+                                setArrayItem(prop, i, value[i]);
                             }
                             else {
                                 const newItem = value[i];
                                 if (propItem !== newItem) {
-                                    (0, index_1.setArrayItem)(prop, i, newItem);
+                                    setArrayItem(prop, i, newItem);
                                 }
                             }
                         }
@@ -187,7 +182,7 @@ class ModelObject {
                     }
                 }
                 else {
-                    const newModel = new index_1.ModelCollection(itemConstructor);
+                    const newModel = new ModelCollection(itemConstructor);
                     propertyValue = newModel.update(newValue);
                 }
             },
@@ -224,14 +219,13 @@ class ModelObject {
         });
     }
 }
-exports.ModelObject = ModelObject;
-exports.default = ModelObject;
+export default ModelObject;
 /**
  * Initialize a model object from the given data
  * @param itemType Model type to create
  * @param data Data to assign
  * @returns Initialized model instance
  */
-function initObject(itemType, data) {
+export function initObject(itemType, data) {
     return new itemType().update(data);
 }

package/dist/ModelSet.js

@@ -1,15 +1,11 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.ModelSet = void 0;
 /**
  * Wrapper around a standard set to make sure it serializes to an array
  */
-class ModelSet extends Set {
+export class ModelSet extends Set {
     /**
      * Convert this object to JSON
      * @returns JSON object
      */
     toJSON() { return Array.from(this); }
 }
-exports.ModelSet = ModelSet;
-exports.default = ModelSet;
+export default ModelSet;

package/dist/ObjectModel.js

@@ -1,54 +1,50 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.ObjectModel = void 0;
-const ModelCollection_1 = require("./ModelCollection");
-const ModelDictionary_1 = require("./ModelDictionary");
-const ModelObject_1 = require("./ModelObject");
-const boards_1 = require("./boards");
-const directories_1 = require("./directories");
-const fans_1 = require("./fans");
-const heat_1 = require("./heat");
-const InputChannel_1 = require("./inputs/InputChannel");
-const job_1 = require("./job");
-const limits_1 = require("./limits");
-const messages_1 = require("./messages");
-const move_1 = require("./move");
-const network_1 = require("./network");
-const plugins_1 = require("./plugins");
-const sbc_1 = require("./sbc");
-const sensors_1 = require("./sensors");
-const spindles_1 = require("./spindles");
-const state_1 = require("./state");
-const tools_1 = require("./tools");
-const volumes_1 = require("./volumes");
-const ledStrips_1 = require("./ledStrips");
+import ModelCollection from "./ModelCollection";
+import ModelDictionary from "./ModelDictionary";
+import ModelObject from "./ModelObject";
+import Board from "./boards";
+import Directories from "./directories";
+import Fan from "./fans";
+import Heat from "./heat";
+import InputChannel from "./inputs/InputChannel";
+import Job from "./job";
+import Limits from "./limits";
+import Message from "./messages";
+import Move from "./move";
+import Network from "./network";
+import Plugin from "./plugins";
+import SBC from "./sbc";
+import Sensors from "./sensors";
+import Spindle from "./spindles";
+import State from "./state";
+import Tool from "./tools";
+import Volume from "./volumes";
+import LedStrip from "./ledStrips";
 /**
  * Refer to the DSF/RRF documentation for descriptions of the object model fields
  */
-class ObjectModel extends ModelObject_1.default {
+export class ObjectModel extends ModelObject {
     constructor() {
         super();
-        this.boards = new ModelCollection_1.default(boards_1.default);
-        this.directories = new directories_1.default();
-        this.fans = new ModelCollection_1.default(fans_1.default);
-        this.global = new ModelDictionary_1.default(false);
-        this.heat = new heat_1.default();
-        this.inputs = new ModelCollection_1.default(InputChannel_1.default);
-        this.job = new job_1.default();
-        this.ledStrips = new ModelCollection_1.default(ledStrips_1.default);
-        this.limits = new limits_1.default();
-        this.messages = new ModelCollection_1.default(messages_1.default); // must be manually cleared after updates
-        this.move = new move_1.default();
-        this.network = new network_1.default();
-        this.plugins = new ModelDictionary_1.default(true, plugins_1.default);
+        this.boards = new ModelCollection(Board);
+        this.directories = new Directories();
+        this.fans = new ModelCollection(Fan);
+        this.global = new ModelDictionary(false);
+        this.heat = new Heat();
+        this.inputs = new ModelCollection(InputChannel);
+        this.job = new Job();
+        this.ledStrips = new ModelCollection(LedStrip);
+        this.limits = new Limits();
+        this.messages = new ModelCollection(Message); // must be manually cleared after updates
+        this.move = new Move();
+        this.network = new Network();
+        this.plugins = new ModelDictionary(true, Plugin);
         this.sbc = null;
-        this.sensors = new sensors_1.default();
-        this.spindles = new ModelCollection_1.default(spindles_1.default);
-        this.state = new state_1.default();
-        this.tools = new ModelCollection_1.default(tools_1.default);
-        this.volumes = new ModelCollection_1.default(volumes_1.default);
-        ModelObject_1.default.wrapModelProperty(this, "sbc", sbc_1.default);
+        this.sensors = new Sensors();
+        this.spindles = new ModelCollection(Spindle);
+        this.state = new State();
+        this.tools = new ModelCollection(Tool);
+        this.volumes = new ModelCollection(Volume);
+        ModelObject.wrapModelProperty(this, "sbc", SBC);
     }
 }
-exports.ObjectModel = ObjectModel;
-exports.default = ObjectModel;
+export default ObjectModel;

package/dist/boards/Driver.d.ts

@@ -11,8 +11,21 @@ export declare class DriverClosedLoop extends ModelObject {
     readonly currentFraction: BoardClosedLoopCurrentFraction;
     readonly positionError: BoardClosedLoopPositionError;
 }
+export declare enum DriverMode {
+    constantOffTime = 0,
+    randomOffTime = 1,
+    spreadCycle = 2,
+    stealthChop = 3,
+    direct = 4,
+    unknown = 5
+}
+export declare class DriverConfig extends ModelObject {
+    direction: boolean;
+    mode: DriverMode;
+}
 export default class Driver extends ModelObject {
     constructor();
     closedLoop: DriverClosedLoop | null;
+    config: DriverConfig | null;
     status: number;
 }

package/dist/boards/Driver.js

@@ -1,37 +1,48 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.DriverClosedLoop = exports.BoardClosedLoopPositionError = exports.BoardClosedLoopCurrentFraction = void 0;
-const __1 = require("..");
-class BoardClosedLoopCurrentFraction extends __1.ModelObject {
+import { ModelObject } from "..";
+export class BoardClosedLoopCurrentFraction extends ModelObject {
     constructor() {
         super(...arguments);
         this.avg = 0;
         this.max = 0;
     }
 }
-exports.BoardClosedLoopCurrentFraction = BoardClosedLoopCurrentFraction;
-class BoardClosedLoopPositionError extends __1.ModelObject {
+export class BoardClosedLoopPositionError extends ModelObject {
     constructor() {
         super(...arguments);
         this.max = 0;
         this.rms = 0;
     }
 }
-exports.BoardClosedLoopPositionError = BoardClosedLoopPositionError;
-class DriverClosedLoop extends __1.ModelObject {
+export class DriverClosedLoop extends ModelObject {
     constructor() {
         super(...arguments);
         this.currentFraction = new BoardClosedLoopCurrentFraction();
         this.positionError = new BoardClosedLoopPositionError();
     }
 }
-exports.DriverClosedLoop = DriverClosedLoop;
-class Driver extends __1.ModelObject {
+export var DriverMode;
+(function (DriverMode) {
+    DriverMode[DriverMode["constantOffTime"] = 0] = "constantOffTime";
+    DriverMode[DriverMode["randomOffTime"] = 1] = "randomOffTime";
+    DriverMode[DriverMode["spreadCycle"] = 2] = "spreadCycle";
+    DriverMode[DriverMode["stealthChop"] = 3] = "stealthChop";
+    DriverMode[DriverMode["direct"] = 4] = "direct";
+    DriverMode[DriverMode["unknown"] = 5] = "unknown";
+})(DriverMode || (DriverMode = {}));
+export class DriverConfig extends ModelObject {
+    constructor() {
+        super(...arguments);
+        this.direction = true;
+        this.mode = DriverMode.spreadCycle;
+    }
+}
+export default class Driver extends ModelObject {
     constructor() {
         super();
         this.closedLoop = null;
+        this.config = null;
         this.status = 0;
-        __1.ModelObject.wrapModelProperty(this, "closedLoop", DriverClosedLoop);
+        ModelObject.wrapModelProperty(this, "closedLoop", DriverClosedLoop);
+        ModelObject.wrapModelProperty(this, "config", DriverConfig);
     }
 }
-exports.default = Driver;

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

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

package/dist/boards/directDisplay/DirectDisplayScreen.js

@@ -1,18 +1,14 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.DirectDisplayScreen = void 0;
-const _1 = require(".");
-const DirectDisplayScreenBase_1 = require("./DirectDisplayScreenBase");
-class DirectDisplayScreen extends DirectDisplayScreenBase_1.default {
+import { getDirectDisplayScreen } from ".";
+import DirectDisplayScreenBase from "./DirectDisplayScreenBase";
+export class DirectDisplayScreen extends DirectDisplayScreenBase {
     update(jsonElement) {
         if (jsonElement === null) {
             return null;
         }
         if (typeof jsonElement.controller === "string" && jsonElement.controller !== this.controller) {
-            return (0, _1.getDirectDisplayScreen)(jsonElement.controller).update(jsonElement);
+            return getDirectDisplayScreen(jsonElement.controller).update(jsonElement);
         }
         return super.update(jsonElement);
     }
 }
-exports.DirectDisplayScreen = DirectDisplayScreen;
-exports.default = DirectDisplayScreen;
+export default DirectDisplayScreen;

package/dist/boards/directDisplay/DirectDisplayScreenBase.js

@@ -1,8 +1,6 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.DirectDisplayScreenBase = void 0;
-const ModelObject_1 = require("../../ModelObject");
-class DirectDisplayScreenBase extends ModelObject_1.default {
+import ModelObject from "../../ModelObject";
+import { DirectDisplayController } from ".";
+export class DirectDisplayScreenBase extends ModelObject {
     constructor(type) {
         super();
         this.colourBits = 1;
@@ -12,5 +10,4 @@ class DirectDisplayScreenBase extends ModelObject_1.default {
         this.controller = type;
     }
 }
-exports.DirectDisplayScreenBase = DirectDisplayScreenBase;
-exports.default = DirectDisplayScreenBase;
+export default DirectDisplayScreenBase;

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

@@ -1,4 +1,4 @@
-import { IModelObject } from "../../ModelObject";
+import type { IModelObject } from "../../ModelObject";
 import DirectDisplayScreenBase from "./DirectDisplayScreen";
 export declare class DirectDisplayScreenST7567 extends DirectDisplayScreenBase {
     constructor();

package/dist/boards/directDisplay/DirectDisplayScreenST7567.js

@@ -1,11 +1,8 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.DirectDisplayScreenST7567 = void 0;
-const DirectDisplayScreen_1 = require("./DirectDisplayScreen");
-const _1 = require(".");
-class DirectDisplayScreenST7567 extends DirectDisplayScreen_1.default {
+import DirectDisplayScreenBase from "./DirectDisplayScreen";
+import { DirectDisplayController, getDirectDisplayScreen } from ".";
+export class DirectDisplayScreenST7567 extends DirectDisplayScreenBase {
     constructor() {
-        super(_1.DirectDisplayController.ST7567);
+        super(DirectDisplayController.ST7567);
         this.contrast = 30;
         this.resistorRatio = 6;
     }
@@ -14,10 +11,9 @@ class DirectDisplayScreenST7567 extends DirectDisplayScreen_1.default {
             return null;
         }
         if (typeof jsonElement.controller === "string" && jsonElement.controller !== this.controller) {
-            return (0, _1.getDirectDisplayScreen)(jsonElement.type).update(jsonElement);
+            return getDirectDisplayScreen(jsonElement.type).update(jsonElement);
         }
         return super.update(jsonElement);
     }
 }
-exports.DirectDisplayScreenST7567 = DirectDisplayScreenST7567;
-exports.default = DirectDisplayScreenST7567;
+export default DirectDisplayScreenST7567;

package/dist/boards/directDisplay/index.js

@@ -1,56 +1,37 @@
-"use strict";
-var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
-    if (k2 === undefined) k2 = k;
-    var desc = Object.getOwnPropertyDescriptor(m, k);
-    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
-      desc = { enumerable: true, get: function() { return m[k]; } };
-    }
-    Object.defineProperty(o, k2, desc);
-}) : (function(o, m, k, k2) {
-    if (k2 === undefined) k2 = k;
-    o[k2] = m[k];
-}));
-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.DirectDisplay = exports.DirectDisplayEncoder = exports.DirectDisplayController = void 0;
-exports.getDirectDisplayScreen = getDirectDisplayScreen;
-const ModelObject_1 = require("../../ModelObject");
-const DirectDisplayScreen_1 = require("./DirectDisplayScreen");
-const DirectDisplayScreenST7567_1 = require("./DirectDisplayScreenST7567");
-var DirectDisplayController;
+import ModelObject from "../../ModelObject";
+import DirectDisplayScreenBase from "./DirectDisplayScreenBase";
+import DirectDisplayScreen from "./DirectDisplayScreen";
+import { DirectDisplayScreenST7567 } from "./DirectDisplayScreenST7567";
+export var DirectDisplayController;
 (function (DirectDisplayController) {
     DirectDisplayController["ST7920"] = "ST7920";
     DirectDisplayController["ST7567"] = "ST7567";
     DirectDisplayController["ILI9488"] = "ILI9488";
-})(DirectDisplayController || (exports.DirectDisplayController = DirectDisplayController = {}));
-class DirectDisplayEncoder extends ModelObject_1.default {
+})(DirectDisplayController || (DirectDisplayController = {}));
+export class DirectDisplayEncoder extends ModelObject {
     constructor() {
         super(...arguments);
         this.pulsesPerClick = 1;
     }
 }
-exports.DirectDisplayEncoder = DirectDisplayEncoder;
-class DirectDisplay extends ModelObject_1.default {
+export class DirectDisplay extends ModelObject {
     constructor() {
         super();
         this.encoder = new DirectDisplayEncoder();
-        this.screen = new DirectDisplayScreen_1.default(DirectDisplayController.ST7920);
-        ModelObject_1.default.wrapModelProperty(this, "encoder", DirectDisplayEncoder);
+        this.screen = new DirectDisplayScreen(DirectDisplayController.ST7920);
+        ModelObject.wrapModelProperty(this, "encoder", DirectDisplayEncoder);
     }
 }
-exports.DirectDisplay = DirectDisplay;
-exports.default = DirectDisplay;
-function getDirectDisplayScreen(controller) {
+export default DirectDisplay;
+export function getDirectDisplayScreen(controller) {
     switch (controller) {
         case DirectDisplayController.ST7920:
         case DirectDisplayController.ILI9488:
         default:
-            return new DirectDisplayScreen_1.default(controller);
+            return new DirectDisplayScreen(controller);
         case DirectDisplayController.ST7567:
-            return new DirectDisplayScreenST7567_1.DirectDisplayScreenST7567();
+            return new DirectDisplayScreenST7567();
     }
 }
-__exportStar(require("./DirectDisplayScreen"), exports);
-__exportStar(require("./DirectDisplayScreenST7567"), exports);
+export * from "./DirectDisplayScreen";
+export * from "./DirectDisplayScreenST7567";

package/dist/boards/index.d.ts

@@ -16,7 +16,8 @@ export declare enum BoardState {
     flashing = "flashing",
     flashFailed = "flashFailed",
     resetting = "resetting",
-    running = "running"
+    running = "running",
+    timedOut = "timedOut"
 }
 export declare class InductiveSensor extends ModelObject {
 }