@duet3d/objectmodel 3.5.0-beta.42 → 3.5.0-beta.44

package/dist/boards/index.d.ts

@@ -0,0 +1,52 @@
+import ModelObject from "../ModelObject";
+export declare class Accelerometer extends ModelObject {
+    points: number;
+    runs: number;
+}
+export declare enum BoardState {
+    unknown = "unknown",
+    flashing = "flashing",
+    flashFailed = "flashFailed",
+    resetting = "resetting",
+    running = "running"
+}
+export declare class ClosedLoop extends ModelObject {
+    points: number;
+    runs: number;
+}
+export declare class MinMaxCurrent extends ModelObject {
+    current: number;
+    min: number;
+    max: number;
+}
+export declare class DirectDisplay extends ModelObject {
+    pulsesPerClick: number;
+    spiFreq: number;
+    typeName: string;
+}
+export declare class Board extends ModelObject {
+    constructor();
+    accelerometer: Accelerometer | null;
+    bootloaderFileName: string | null;
+    canAddress: number | null;
+    closedLoop: ClosedLoop | null;
+    directDisplay: DirectDisplay | null;
+    firmwareDate: string;
+    firmwareFileName: string;
+    firmwareName: string;
+    firmwareVersion: string;
+    iapFileNameSBC: string | null;
+    iapFileNameSD: string | null;
+    maxHeaters: number;
+    maxMotors: number;
+    mcuTemp: MinMaxCurrent | null;
+    name: string;
+    shortName: string;
+    state: BoardState;
+    supportsDirectDisplay: boolean;
+    uniqueId: string | null;
+    v12: MinMaxCurrent | null;
+    vIn: MinMaxCurrent | null;
+    wifiFirmwareFileName: string | null;
+}
+export default Board;

package/dist/boards/index.js

@@ -0,0 +1,81 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.Board = exports.DirectDisplay = exports.MinMaxCurrent = exports.ClosedLoop = exports.BoardState = exports.Accelerometer = void 0;
+const ModelObject_1 = require("../ModelObject");
+class Accelerometer extends ModelObject_1.default {
+    constructor() {
+        super(...arguments);
+        this.points = 0;
+        this.runs = 0;
+    }
+}
+exports.Accelerometer = Accelerometer;
+var BoardState;
+(function (BoardState) {
+    BoardState["unknown"] = "unknown";
+    BoardState["flashing"] = "flashing";
+    BoardState["flashFailed"] = "flashFailed";
+    BoardState["resetting"] = "resetting";
+    BoardState["running"] = "running";
+})(BoardState = exports.BoardState || (exports.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);
+        this.current = 0;
+        this.min = 0;
+        this.max = 0;
+    }
+}
+exports.MinMaxCurrent = MinMaxCurrent;
+class DirectDisplay extends ModelObject_1.default {
+    constructor() {
+        super(...arguments);
+        this.pulsesPerClick = 0;
+        this.spiFreq = 0;
+        this.typeName = "";
+    }
+}
+exports.DirectDisplay = DirectDisplay;
+class Board extends ModelObject_1.default {
+    constructor() {
+        super();
+        this.accelerometer = null;
+        this.bootloaderFileName = null;
+        this.canAddress = null;
+        this.closedLoop = null;
+        this.directDisplay = null;
+        this.firmwareDate = "";
+        this.firmwareFileName = "";
+        this.firmwareName = "";
+        this.firmwareVersion = "";
+        this.iapFileNameSBC = null;
+        this.iapFileNameSD = null;
+        this.maxHeaters = 0;
+        this.maxMotors = 0;
+        this.mcuTemp = null;
+        this.name = "";
+        this.shortName = "";
+        this.state = BoardState.unknown;
+        this.supportsDirectDisplay = false;
+        this.uniqueId = null;
+        this.v12 = null;
+        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, "directDisplay", DirectDisplay);
+        ModelObject_1.default.wrapModelProperty(this, "mcuTemp", MinMaxCurrent);
+        ModelObject_1.default.wrapModelProperty(this, "v12", MinMaxCurrent);
+        ModelObject_1.default.wrapModelProperty(this, "vIn", MinMaxCurrent);
+    }
+}
+exports.Board = Board;
+exports.default = Board;

package/dist/directories/index.d.ts

@@ -0,0 +1,11 @@
+import ModelObject from "../ModelObject";
+export declare class Directories extends ModelObject {
+    filaments: string;
+    firmware: string;
+    gCodes: string;
+    macros: string;
+    menu: string;
+    system: string;
+    web: string;
+}
+export default Directories;

package/dist/directories/index.js

@@ -0,0 +1,18 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.Directories = void 0;
+const ModelObject_1 = require("../ModelObject");
+class Directories extends ModelObject_1.default {
+    constructor() {
+        super(...arguments);
+        this.filaments = "0:/filaments";
+        this.firmware = "0:/firmware";
+        this.gCodes = "0:/gcodes";
+        this.macros = "0:/macros";
+        this.menu = "0:/menu";
+        this.system = "0:/sys";
+        this.web = "0:/www";
+    }
+}
+exports.Directories = Directories;
+exports.default = Directories;

package/dist/fans/index.d.ts

@@ -0,0 +1,19 @@
+import ModelObject from "../ModelObject";
+export declare class FanThermostaticControl extends ModelObject {
+    heaters: Array<number>;
+    highTemperature: number | null;
+    lowTemperature: number | null;
+    sensors: Array<number>;
+}
+export declare class Fan extends ModelObject {
+    actualValue: number;
+    blip: number;
+    frequency: number;
+    max: number;
+    min: number;
+    name: string;
+    requestedValue: number;
+    rpm: number;
+    readonly thermostatic: FanThermostaticControl;
+}
+export default Fan;

package/dist/fans/index.js

@@ -0,0 +1,30 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.Fan = exports.FanThermostaticControl = void 0;
+const ModelObject_1 = require("../ModelObject");
+class FanThermostaticControl extends ModelObject_1.default {
+    constructor() {
+        super(...arguments);
+        this.heaters = []; // *** deprecated as of v3.5, use sensors instead
+        this.highTemperature = null;
+        this.lowTemperature = null;
+        this.sensors = [];
+    }
+}
+exports.FanThermostaticControl = FanThermostaticControl;
+class Fan extends ModelObject_1.default {
+    constructor() {
+        super(...arguments);
+        this.actualValue = 0;
+        this.blip = 0.1;
+        this.frequency = 250;
+        this.max = 1;
+        this.min = 0;
+        this.name = "";
+        this.requestedValue = 0;
+        this.rpm = -1;
+        this.thermostatic = new FanThermostaticControl();
+    }
+}
+exports.Fan = Fan;
+exports.default = Fan;

package/dist/heat/Heater.d.ts

@@ -0,0 +1,28 @@
+import ModelCollection from "../ModelCollection";
+import HeaterModel from "./HeaterModel";
+import ModelObject from "../ModelObject";
+import HeaterMonitor from "./HeaterMonitor";
+export declare enum HeaterState {
+    off = "off",
+    standby = "standby",
+    active = "active",
+    fault = "fault",
+    tuning = "tuning",
+    offline = "offline"
+}
+export declare class Heater extends ModelObject {
+    active: number;
+    avgPwm: number;
+    current: number;
+    max: number;
+    maxBadReadings: number;
+    maxHeatingFaultTime: number;
+    maxTempExcursion: number;
+    min: number;
+    readonly model: HeaterModel;
+    readonly monitors: ModelCollection<HeaterMonitor>;
+    sensor: number;
+    standby: number;
+    state: HeaterState;
+}
+export default Heater;

package/dist/heat/Heater.js

@@ -0,0 +1,36 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.Heater = exports.HeaterState = void 0;
+const ModelCollection_1 = require("../ModelCollection");
+const HeaterModel_1 = require("./HeaterModel");
+const ModelObject_1 = require("../ModelObject");
+const HeaterMonitor_1 = require("./HeaterMonitor");
+var HeaterState;
+(function (HeaterState) {
+    HeaterState["off"] = "off";
+    HeaterState["standby"] = "standby";
+    HeaterState["active"] = "active";
+    HeaterState["fault"] = "fault";
+    HeaterState["tuning"] = "tuning";
+    HeaterState["offline"] = "offline";
+})(HeaterState = exports.HeaterState || (exports.HeaterState = {}));
+class Heater extends ModelObject_1.default {
+    constructor() {
+        super(...arguments);
+        this.active = 0;
+        this.avgPwm = 0;
+        this.current = -273.15;
+        this.max = 285;
+        this.maxBadReadings = 3;
+        this.maxHeatingFaultTime = 5;
+        this.maxTempExcursion = 15;
+        this.min = -10;
+        this.model = new HeaterModel_1.default();
+        this.monitors = new ModelCollection_1.default(HeaterMonitor_1.default);
+        this.sensor = -1;
+        this.standby = 0;
+        this.state = HeaterState.off;
+    }
+}
+exports.Heater = Heater;
+exports.default = Heater;

package/dist/heat/HeaterModel.d.ts

@@ -0,0 +1,21 @@
+import ModelObject from "../ModelObject";
+export declare class HeaterModelPID extends ModelObject {
+    d: number;
+    i: number;
+    overridden: boolean;
+    p: number;
+    used: boolean;
+}
+export declare class HeaterModel extends ModelObject {
+    coolingExp: number;
+    coolingRate: number;
+    deadTime: number;
+    enabled: boolean;
+    fanCoolingRate: number;
+    heatingRate: number;
+    inverted: boolean;
+    maxPwm: number;
+    readonly pid: HeaterModelPID;
+    standardVoltage: number;
+}
+export default HeaterModel;

package/dist/heat/HeaterModel.js

@@ -0,0 +1,32 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.HeaterModel = exports.HeaterModelPID = void 0;
+const ModelObject_1 = require("../ModelObject");
+class HeaterModelPID extends ModelObject_1.default {
+    constructor() {
+        super(...arguments);
+        this.d = 0;
+        this.i = 0;
+        this.overridden = false;
+        this.p = 0;
+        this.used = true;
+    }
+}
+exports.HeaterModelPID = HeaterModelPID;
+class HeaterModel extends ModelObject_1.default {
+    constructor() {
+        super(...arguments);
+        this.coolingExp = 1.35;
+        this.coolingRate = 0.56;
+        this.deadTime = 5.5;
+        this.enabled = false;
+        this.fanCoolingRate = 0.56;
+        this.heatingRate = 2.43;
+        this.inverted = false;
+        this.maxPwm = 1;
+        this.pid = new HeaterModelPID();
+        this.standardVoltage = 0;
+    }
+}
+exports.HeaterModel = HeaterModel;
+exports.default = HeaterModel;

package/dist/heat/HeaterMonitor.d.ts

@@ -0,0 +1,18 @@
+import ModelObject from "../ModelObject";
+export declare enum HeaterMonitorAction {
+    generateFault = 0,
+    permanentSwitchOff = 1,
+    temporarySwitchOff = 2,
+    shutDown = 3
+}
+export declare enum HeaterMonitorCondition {
+    disabled = "disabled",
+    tooHigh = "tooHigh",
+    tooLow = "tooLow"
+}
+export declare class HeaterMonitor extends ModelObject {
+    action: HeaterMonitorAction | null;
+    condition: HeaterMonitorCondition;
+    limit: number | null;
+}
+export default HeaterMonitor;

package/dist/heat/HeaterMonitor.js

@@ -0,0 +1,27 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.HeaterMonitor = exports.HeaterMonitorCondition = exports.HeaterMonitorAction = void 0;
+const ModelObject_1 = require("../ModelObject");
+var HeaterMonitorAction;
+(function (HeaterMonitorAction) {
+    HeaterMonitorAction[HeaterMonitorAction["generateFault"] = 0] = "generateFault";
+    HeaterMonitorAction[HeaterMonitorAction["permanentSwitchOff"] = 1] = "permanentSwitchOff";
+    HeaterMonitorAction[HeaterMonitorAction["temporarySwitchOff"] = 2] = "temporarySwitchOff";
+    HeaterMonitorAction[HeaterMonitorAction["shutDown"] = 3] = "shutDown";
+})(HeaterMonitorAction = exports.HeaterMonitorAction || (exports.HeaterMonitorAction = {}));
+var HeaterMonitorCondition;
+(function (HeaterMonitorCondition) {
+    HeaterMonitorCondition["disabled"] = "disabled";
+    HeaterMonitorCondition["tooHigh"] = "tooHigh";
+    HeaterMonitorCondition["tooLow"] = "tooLow";
+})(HeaterMonitorCondition = exports.HeaterMonitorCondition || (exports.HeaterMonitorCondition = {}));
+class HeaterMonitor extends ModelObject_1.default {
+    constructor() {
+        super(...arguments);
+        this.action = null;
+        this.condition = HeaterMonitorCondition.disabled;
+        this.limit = null;
+    }
+}
+exports.HeaterMonitor = HeaterMonitor;
+exports.default = HeaterMonitor;

package/dist/heat/index.d.ts

@@ -0,0 +1,14 @@
+import ModelCollection from "../ModelCollection";
+import ModelObject from "../ModelObject";
+import Heater from "./Heater";
+export declare class Heat extends ModelObject {
+    bedHeaters: Array<number>;
+    chamberHeaters: Array<number>;
+    coldExtrudeTemperature: number;
+    coldRetractTemperature: number;
+    readonly heaters: ModelCollection<Heater | null>;
+}
+export default Heat;
+export * from "./Heater";
+export * from "./HeaterModel";
+export * from "./HeaterMonitor";

package/dist/heat/index.js

@@ -0,0 +1,35 @@
+"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.Heat = void 0;
+const ModelCollection_1 = require("../ModelCollection");
+const ModelObject_1 = require("../ModelObject");
+const Heater_1 = require("./Heater");
+class Heat extends ModelObject_1.default {
+    constructor() {
+        super(...arguments);
+        this.bedHeaters = new Array();
+        this.chamberHeaters = new Array();
+        this.coldExtrudeTemperature = 160;
+        this.coldRetractTemperature = 90;
+        this.heaters = new ModelCollection_1.default(Heater_1.default);
+    }
+}
+exports.Heat = Heat;
+exports.default = Heat;
+__exportStar(require("./Heater"), exports);
+__exportStar(require("./HeaterModel"), exports);
+__exportStar(require("./HeaterMonitor"), exports);

package/dist/index.d.ts

@@ -0,0 +1,26 @@
+export * from "./ModelCollection";
+export * from "./ModelDictionary";
+export * from "./ModelObject";
+export * from "./ModelSet";
+export * from "./boards";
+export * from "./directories";
+export * from "./fans";
+export * from "./heat";
+export * from "./inputs";
+export * from "./job";
+export * from "./limits";
+export * from "./messages";
+export * from "./move";
+export * from "./network";
+export * from "./plugins";
+export * from "./sensors";
+export * from "./spindles";
+export * from "./sbc";
+export * from "./state";
+export * from "./tools";
+export * from "./userSessions";
+export * from "./volumes";
+export * from "./ObjectModel";
+import ObjectModel from "./ObjectModel";
+export default ObjectModel;
+export declare function setArrayItem(array: Array<any>, index: number, value: any): void;

package/dist/inputs/CodeChannel.d.ts

@@ -0,0 +1,18 @@
+export declare enum CodeChannel {
+    http = 0,
+    telnet = 1,
+    file = 2,
+    usb = 3,
+    aux = 4,
+    trigger = 5,
+    queue = 6,
+    lcd = 7,
+    sbc = 8,
+    daemon = 9,
+    aux2 = 10,
+    autopause = 11,
+    file2 = 12,
+    queue2 = 13,
+    unknown = 14
+}
+export default CodeChannel;

package/dist/inputs/CodeChannel.js

@@ -0,0 +1,22 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.CodeChannel = void 0;
+var CodeChannel;
+(function (CodeChannel) {
+    CodeChannel[CodeChannel["http"] = 0] = "http";
+    CodeChannel[CodeChannel["telnet"] = 1] = "telnet";
+    CodeChannel[CodeChannel["file"] = 2] = "file";
+    CodeChannel[CodeChannel["usb"] = 3] = "usb";
+    CodeChannel[CodeChannel["aux"] = 4] = "aux";
+    CodeChannel[CodeChannel["trigger"] = 5] = "trigger";
+    CodeChannel[CodeChannel["queue"] = 6] = "queue";
+    CodeChannel[CodeChannel["lcd"] = 7] = "lcd";
+    CodeChannel[CodeChannel["sbc"] = 8] = "sbc";
+    CodeChannel[CodeChannel["daemon"] = 9] = "daemon";
+    CodeChannel[CodeChannel["aux2"] = 10] = "aux2";
+    CodeChannel[CodeChannel["autopause"] = 11] = "autopause";
+    CodeChannel[CodeChannel["file2"] = 12] = "file2";
+    CodeChannel[CodeChannel["queue2"] = 13] = "queue2";
+    CodeChannel[CodeChannel["unknown"] = 14] = "unknown";
+})(CodeChannel = exports.CodeChannel || (exports.CodeChannel = {}));
+exports.default = CodeChannel;

package/dist/inputs/Compatibility.d.ts

@@ -0,0 +1,10 @@
+export declare enum Compatibility {
+    Default = "Default",
+    RepRapFirmware = "RepRapFirmware",
+    Marlin = "Marlin",
+    Teacup = "Teacup",
+    Sprinter = "Sprinter",
+    Repetier = "Repetier",
+    NanoDLP = "NanoDLP"
+}
+export default Compatibility;

package/dist/inputs/Compatibility.js

@@ -0,0 +1,14 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.Compatibility = void 0;
+var Compatibility;
+(function (Compatibility) {
+    Compatibility["Default"] = "Default";
+    Compatibility["RepRapFirmware"] = "RepRapFirmware";
+    Compatibility["Marlin"] = "Marlin";
+    Compatibility["Teacup"] = "Teacup";
+    Compatibility["Sprinter"] = "Sprinter";
+    Compatibility["Repetier"] = "Repetier";
+    Compatibility["NanoDLP"] = "NanoDLP";
+})(Compatibility = exports.Compatibility || (exports.Compatibility = {}));
+exports.default = Compatibility;

package/dist/inputs/InputChannel.d.ts

@@ -0,0 +1,30 @@
+import ModelObject from "../ModelObject";
+import Compatibility from "./Compatibility";
+export declare enum DistanceUnit {
+    mm = "mm",
+    inch = "in"
+}
+export declare enum InputChannelState {
+    awaitingAcknowledgement = "awaitingAcknowledgement",
+    idle = "idle",
+    executing = "executing",
+    waiting = "waiting",
+    reading = "reading"
+}
+export declare class InputChannel extends ModelObject {
+    axesRelative: boolean;
+    compatibility: Compatibility;
+    distanceUnit: DistanceUnit;
+    drivesRelative: boolean;
+    feedRate: number;
+    inMacro: boolean;
+    macroRestartable: boolean;
+    motionSystem: number;
+    name: string;
+    selectedPlane: number;
+    stackDepth: number;
+    state: InputChannelState;
+    lineNumber: number | bigint;
+    volumetric: boolean;
+}
+export default InputChannel;

package/dist/inputs/InputChannel.js

@@ -0,0 +1,39 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.InputChannel = exports.InputChannelState = exports.DistanceUnit = void 0;
+const ModelObject_1 = require("../ModelObject");
+const Compatibility_1 = require("./Compatibility");
+var DistanceUnit;
+(function (DistanceUnit) {
+    DistanceUnit["mm"] = "mm";
+    DistanceUnit["inch"] = "in";
+})(DistanceUnit = exports.DistanceUnit || (exports.DistanceUnit = {}));
+var InputChannelState;
+(function (InputChannelState) {
+    InputChannelState["awaitingAcknowledgement"] = "awaitingAcknowledgement";
+    InputChannelState["idle"] = "idle";
+    InputChannelState["executing"] = "executing";
+    InputChannelState["waiting"] = "waiting";
+    InputChannelState["reading"] = "reading";
+})(InputChannelState = exports.InputChannelState || (exports.InputChannelState = {}));
+class InputChannel extends ModelObject_1.default {
+    constructor() {
+        super(...arguments);
+        this.axesRelative = false;
+        this.compatibility = Compatibility_1.default.RepRapFirmware;
+        this.distanceUnit = DistanceUnit.mm;
+        this.drivesRelative = true;
+        this.feedRate = 50;
+        this.inMacro = false;
+        this.macroRestartable = false;
+        this.motionSystem = 0;
+        this.name = "";
+        this.selectedPlane = 0;
+        this.stackDepth = 0;
+        this.state = InputChannelState.idle;
+        this.lineNumber = 0;
+        this.volumetric = false;
+    }
+}
+exports.InputChannel = InputChannel;
+exports.default = InputChannel;

package/dist/inputs/index.d.ts

@@ -0,0 +1,3 @@
+export * from "./CodeChannel";
+export * from "./Compatibility";
+export * from "./InputChannel";

package/dist/inputs/index.js

@@ -0,0 +1,19 @@
+"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 });
+__exportStar(require("./CodeChannel"), exports);
+__exportStar(require("./Compatibility"), exports);
+__exportStar(require("./InputChannel"), exports);

package/dist/job/Build.d.ts

@@ -0,0 +1,15 @@
+import ModelCollection from "../ModelCollection";
+import ModelObject from "../ModelObject";
+export declare class BuildObject extends ModelObject {
+    cancelled: boolean;
+    name: string | null;
+    x: Array<number | null>;
+    y: Array<number | null>;
+}
+export declare class Build extends ModelObject {
+    currentObject: number;
+    m486names: boolean;
+    m486numbers: boolean;
+    readonly objects: ModelCollection<BuildObject>;
+}
+export default Build;