@duet3d/objectmodel 3.4.0

package/lib/httpEndpoints/index.js

@@ -0,0 +1,26 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.HttpEndpointType = void 0;
+const ModelObject_1 = require("../ModelObject");
+var HttpEndpointType;
+(function (HttpEndpointType) {
+    HttpEndpointType["GET"] = "GET";
+    HttpEndpointType["POST"] = "POST";
+    HttpEndpointType["PUT"] = "PUT";
+    HttpEndpointType["PATCH"] = "PATCH";
+    HttpEndpointType["TRACE"] = "TRACE";
+    HttpEndpointType["DELETE"] = "DELETE";
+    HttpEndpointType["OPTIONS"] = "OPTIONS";
+    HttpEndpointType["WebSocket"] = "WebSocket";
+})(HttpEndpointType = exports.HttpEndpointType || (exports.HttpEndpointType = {}));
+class HttpEndpoint extends ModelObject_1.default {
+    constructor() {
+        super(...arguments);
+        this.endpointType = HttpEndpointType.GET;
+        this.namespace = "";
+        this.path = "";
+        this.isUploadRequest = false;
+        this.unixSocket = "";
+    }
+}
+exports.default = HttpEndpoint;

package/lib/index.d.ts

@@ -0,0 +1,44 @@
+import ModelObject from "./ModelObject";
+import Board from "./boards";
+import State from "./state";
+import ModelCollection from "./ModelCollection";
+import Directories from "./directories";
+import Fan from "./fans";
+import Heat from "./heat";
+import HttpEndpoint from "./httpEndpoints";
+import InputChannel from "./inputs/InputChannel";
+import Job from "./job";
+import Limits from "./limits";
+import Message from "./messages";
+import Move from "./move";
+import Plugin from "./plugins";
+import Scanner from "./scanner";
+import Sensors from "./sensors";
+import Spindle from "./spindles";
+import UserSession from "./userSessions";
+import Volume from "./volumes";
+import { ModelDictionary } from "./ModelDictionary";
+export declare function setArrayItem(array: Array<any>, index: number, value: any): void;
+/**
+ * Refer to the DSF/RRF documentation for descriptions of the object model fields
+ */
+export default class ObjectModel extends ModelObject {
+    readonly boards: ModelCollection<Board>;
+    readonly directories: Directories;
+    readonly fans: ModelCollection<Fan>;
+    readonly global: ModelDictionary<any>;
+    readonly heat: Heat;
+    readonly httpEndpoints: ModelCollection<HttpEndpoint>;
+    readonly inputs: ModelCollection<InputChannel>;
+    readonly job: Job;
+    readonly limits: Limits;
+    readonly messages: ModelCollection<Message>;
+    readonly move: Move;
+    readonly plugins: ModelDictionary<Plugin>;
+    readonly scanner: Scanner;
+    readonly sensors: Sensors;
+    readonly spindles: ModelCollection<Spindle>;
+    readonly state: State;
+    readonly userSessions: ModelCollection<UserSession>;
+    readonly volumes: ModelCollection<Volume>;
+}

package/lib/index.js

@@ -0,0 +1,59 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.setArrayItem = void 0;
+const ModelObject_1 = require("./ModelObject");
+const boards_1 = require("./boards");
+const state_1 = require("./state");
+const ModelCollection_1 = require("./ModelCollection");
+const directories_1 = require("./directories");
+const fans_1 = require("./fans");
+const heat_1 = require("./heat");
+const httpEndpoints_1 = require("./httpEndpoints");
+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 plugins_1 = require("./plugins");
+const scanner_1 = require("./scanner");
+const sensors_1 = require("./sensors");
+const spindles_1 = require("./spindles");
+const userSessions_1 = require("./userSessions");
+const volumes_1 = require("./volumes");
+const ModelDictionary_1 = require("./ModelDictionary");
+// Unfortunately we need to define a way to update arrays to remain compatible with Vue 2 (due to IE11).
+// This will become obsolete as soon as DWC is upgraded to Vue 3, but that isn't going to happen anytime soon.
+// Until then a Vue 2 user would have to call something like this on initialization to work around this limitation:
+// globalThis._duetModelSetArray = (array, index, value) => Vue.set(array, index, value);
+globalThis._duetModelSetArray = (array, index, value) => array[index] = value;
+function setArrayItem(array, index, value) {
+    globalThis._duetModelSetArray(array, index, value);
+}
+exports.setArrayItem = setArrayItem;
+/**
+ * Refer to the DSF/RRF documentation for descriptions of the object model fields
+ */
+class ObjectModel extends ModelObject_1.default {
+    constructor() {
+        super(...arguments);
+        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.ModelDictionary(false);
+        this.heat = new heat_1.default();
+        this.httpEndpoints = new ModelCollection_1.default(httpEndpoints_1.default);
+        this.inputs = new ModelCollection_1.default(InputChannel_1.default);
+        this.job = new job_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.plugins = new ModelDictionary_1.ModelDictionary(true, plugins_1.default);
+        this.scanner = new scanner_1.default();
+        this.sensors = new sensors_1.default();
+        this.spindles = new ModelCollection_1.default(spindles_1.default);
+        this.state = new state_1.default();
+        this.userSessions = new ModelCollection_1.default(userSessions_1.default);
+        this.volumes = new ModelCollection_1.default(volumes_1.default);
+    }
+}
+exports.default = ObjectModel;

package/lib/inputs/CodeChannel.d.ts

@@ -0,0 +1,15 @@
+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,
+    unknown = 12
+}

package/lib/inputs/CodeChannel.js

@@ -0,0 +1,19 @@
+"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["unknown"] = 12] = "unknown";
+})(CodeChannel = exports.CodeChannel || (exports.CodeChannel = {}));

package/lib/inputs/Compatibility.d.ts

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

package/lib/inputs/Compatibility.js

@@ -0,0 +1,13 @@
+"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 = {}));

package/lib/inputs/InputChannel.d.ts

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

package/lib/inputs/InputChannel.js

@@ -0,0 +1,36 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.InputChannelState = exports.DistanceUnit = void 0;
+const Compatibility_1 = require("./Compatibility");
+const ModelObject_1 = require("../ModelObject");
+var DistanceUnit;
+(function (DistanceUnit) {
+    DistanceUnit["mm"] = "mm";
+    DistanceUnit["inch"] = "inch";
+})(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.Compatibility.RepRapFirmware;
+        this.distanceUnit = DistanceUnit.mm;
+        this.drivesRelative = true;
+        this.feedRate = 50;
+        this.inMacro = false;
+        this.macroRestartable = false;
+        this.name = "";
+        this.stackDepth = 0;
+        this.state = InputChannelState.idle;
+        this.lineNumber = 0n;
+        this.volumetric = false;
+    }
+}
+exports.default = InputChannel;

package/lib/job/Build.d.ts

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

package/lib/job/Build.js

@@ -0,0 +1,25 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.BuildObject = void 0;
+const ModelObject_1 = require("../ModelObject");
+const ModelCollection_1 = require("../ModelCollection");
+class BuildObject extends ModelObject_1.default {
+    constructor() {
+        super(...arguments);
+        this.cancelled = false;
+        this.name = null;
+        this.x = new Array();
+        this.y = new Array();
+    }
+}
+exports.BuildObject = BuildObject;
+class Build extends ModelObject_1.default {
+    constructor() {
+        super(...arguments);
+        this.currentObject = -1;
+        this.m486names = false;
+        this.m486numbers = false;
+        this.objects = new ModelCollection_1.default(BuildObject);
+    }
+}
+exports.default = Build;

package/lib/job/GCodeFileInfo.d.ts

@@ -0,0 +1,16 @@
+import ModelObject from "../ModelObject";
+import ModelCollection from "../ModelCollection";
+import ThumbnailInfo from "./ThumbnailInfo";
+export default class GCodeFileInfo extends ModelObject {
+    filament: Array<number>;
+    fileName: string;
+    generatedBy: string;
+    height: number;
+    lastModified: string | null;
+    layerHeight: number;
+    numLayers: number;
+    printTime: bigint | null;
+    simulatedTime: bigint | null;
+    size: bigint;
+    readonly thumbnails: ModelCollection<ThumbnailInfo>;
+}

package/lib/job/GCodeFileInfo.js

@@ -0,0 +1,22 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+const ModelObject_1 = require("../ModelObject");
+const ModelCollection_1 = require("../ModelCollection");
+const ThumbnailInfo_1 = require("./ThumbnailInfo");
+class GCodeFileInfo extends ModelObject_1.default {
+    constructor() {
+        super(...arguments);
+        this.filament = new Array();
+        this.fileName = "";
+        this.generatedBy = "";
+        this.height = 0;
+        this.lastModified = null;
+        this.layerHeight = 0;
+        this.numLayers = 0;
+        this.printTime = null;
+        this.simulatedTime = null;
+        this.size = 0n;
+        this.thumbnails = new ModelCollection_1.default(ThumbnailInfo_1.default);
+    }
+}
+exports.default = GCodeFileInfo;

package/lib/job/ThumbnailInfo.d.ts

@@ -0,0 +1,14 @@
+import ModelObject from "../ModelObject";
+export declare enum ThumbnailFormat {
+    jpeg = "jpeg",
+    png = "png",
+    qoi = "qoi"
+}
+export default class ThumbnailInfo extends ModelObject {
+    data: string | null;
+    format: ThumbnailFormat;
+    height: number;
+    offset: number;
+    size: number;
+    width: number;
+}

package/lib/job/ThumbnailInfo.js

@@ -0,0 +1,22 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.ThumbnailFormat = void 0;
+const ModelObject_1 = require("../ModelObject");
+var ThumbnailFormat;
+(function (ThumbnailFormat) {
+    ThumbnailFormat["jpeg"] = "jpeg";
+    ThumbnailFormat["png"] = "png";
+    ThumbnailFormat["qoi"] = "qoi";
+})(ThumbnailFormat = exports.ThumbnailFormat || (exports.ThumbnailFormat = {}));
+class ThumbnailInfo extends ModelObject_1.default {
+    constructor() {
+        super(...arguments);
+        this.data = null;
+        this.format = ThumbnailFormat.png;
+        this.height = 0;
+        this.offset = 0;
+        this.size = 0;
+        this.width = 0;
+    }
+}
+exports.default = ThumbnailInfo;

package/lib/job/index.d.ts

@@ -0,0 +1,36 @@
+import Build from "./Build";
+import ModelCollection from "../ModelCollection";
+import ModelObject from "../ModelObject";
+import GCodeFileInfo from "./GCodeFileInfo";
+export declare class Layer extends ModelObject {
+    duration: number;
+    filament: Array<number>;
+    fractionPrinted: number;
+    height: number;
+    temperatures: Array<number>;
+}
+export declare class TimesLeft extends ModelObject {
+    filament: number | null;
+    file: number | null;
+    layer: number | null;
+    slicer: number | null;
+}
+export default class Job extends ModelObject {
+    constructor();
+    build: Build;
+    duration: number | null;
+    file: GCodeFileInfo | null;
+    filePosition: bigint | null;
+    lastDuration: number | null;
+    lastFileName: string | null;
+    lastFileAborted: boolean;
+    lastFileCancelled: boolean;
+    lastFileSimulated: boolean;
+    layer: number | null;
+    readonly layers: ModelCollection<Layer>;
+    layerTime: number | null;
+    pauseDuration: number | null;
+    rawExtrusion: number | null;
+    readonly timesLeft: TimesLeft;
+    warmUpDuration: number | null;
+}

package/lib/job/index.js

@@ -0,0 +1,52 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.TimesLeft = exports.Layer = void 0;
+const Build_1 = require("./Build");
+const ModelCollection_1 = require("../ModelCollection");
+const ModelObject_1 = require("../ModelObject");
+const GCodeFileInfo_1 = require("./GCodeFileInfo");
+class Layer extends ModelObject_1.default {
+    constructor() {
+        super(...arguments);
+        this.duration = 0;
+        this.filament = new Array();
+        this.fractionPrinted = 0;
+        this.height = 0;
+        this.temperatures = new Array();
+    }
+}
+exports.Layer = Layer;
+class TimesLeft extends ModelObject_1.default {
+    constructor() {
+        super(...arguments);
+        this.filament = null;
+        this.file = null;
+        this.layer = null;
+        this.slicer = null;
+    }
+}
+exports.TimesLeft = TimesLeft;
+class Job extends ModelObject_1.default {
+    constructor() {
+        super();
+        this.build = new Build_1.default();
+        this.duration = null;
+        this.file = null;
+        this.filePosition = null;
+        this.lastDuration = null;
+        this.lastFileName = null;
+        this.lastFileAborted = false;
+        this.lastFileCancelled = false;
+        this.lastFileSimulated = false;
+        this.layer = null;
+        this.layers = new ModelCollection_1.default(Layer);
+        this.layerTime = null;
+        this.pauseDuration = null;
+        this.rawExtrusion = null;
+        this.timesLeft = new TimesLeft();
+        this.warmUpDuration = null;
+        this.wrapModelProperty("build", Build_1.default);
+        this.wrapModelProperty("file", GCodeFileInfo_1.default);
+    }
+}
+exports.default = Job;

package/lib/limits/index.d.ts

@@ -0,0 +1,28 @@
+import ModelObject from "../ModelObject";
+export default class Limits extends ModelObject {
+    axes: number | null;
+    axesPlusExtruders: number | null;
+    bedHeaters: number | null;
+    boards: number | null;
+    chamberHeaters: number | null;
+    drivers: number | null;
+    driversPerAxis: number | null;
+    extruders: number | null;
+    extrudersPerTool: number | null;
+    fans: number | null;
+    gpInPorts: number | null;
+    gpOutPorts: number | null;
+    heaters: number | null;
+    heatersPerTool: number | null;
+    monitorsPerHeater: number | null;
+    restorePoints: number | null;
+    sensors: number | null;
+    spindles: number | null;
+    tools: number | null;
+    trackedObjects: number | null;
+    triggers: number | null;
+    volumes: number | null;
+    workplaces: number | null;
+    zProbeProgramBytes: number | null;
+    zProbes: number | null;
+}

package/lib/limits/index.js

@@ -0,0 +1,34 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+const ModelObject_1 = require("../ModelObject");
+class Limits extends ModelObject_1.default {
+    constructor() {
+        super(...arguments);
+        this.axes = null;
+        this.axesPlusExtruders = null;
+        this.bedHeaters = null;
+        this.boards = null;
+        this.chamberHeaters = null;
+        this.drivers = null;
+        this.driversPerAxis = null;
+        this.extruders = null;
+        this.extrudersPerTool = null;
+        this.fans = null;
+        this.gpInPorts = null;
+        this.gpOutPorts = null;
+        this.heaters = null;
+        this.heatersPerTool = null;
+        this.monitorsPerHeater = null;
+        this.restorePoints = null;
+        this.sensors = null;
+        this.spindles = null;
+        this.tools = null;
+        this.trackedObjects = null;
+        this.triggers = null;
+        this.volumes = null;
+        this.workplaces = null;
+        this.zProbeProgramBytes = null;
+        this.zProbes = null;
+    }
+}
+exports.default = Limits;

package/lib/messages/index.d.ts

@@ -0,0 +1,12 @@
+import ModelObject from "../ModelObject";
+export declare enum MessageType {
+    success = 0,
+    warning = 1,
+    error = 2
+}
+export default class Message extends ModelObject {
+    content: string;
+    time: Date;
+    type: MessageType;
+    toString(): string;
+}

package/lib/messages/index.js

@@ -0,0 +1,26 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.MessageType = void 0;
+const ModelObject_1 = require("../ModelObject");
+var MessageType;
+(function (MessageType) {
+    MessageType[MessageType["success"] = 0] = "success";
+    MessageType[MessageType["warning"] = 1] = "warning";
+    MessageType[MessageType["error"] = 2] = "error";
+})(MessageType = exports.MessageType || (exports.MessageType = {}));
+class Message extends ModelObject_1.default {
+    constructor() {
+        super(...arguments);
+        this.content = "";
+        this.time = new Date();
+        this.type = MessageType.success;
+    }
+    toString() {
+        switch (this.type) {
+            case MessageType.success: return this.content;
+            case MessageType.warning: return "Warning: " + this.content;
+            case MessageType.error: return "Error: " + this.content;
+        }
+    }
+}
+exports.default = Message;

package/lib/move/Axis.d.ts

@@ -0,0 +1,51 @@
+import ModelObject from "../ModelObject";
+import ModelCollection from "../ModelCollection";
+import DriverId from "./DriverId";
+import Microstepping from "./Microstepping";
+export declare enum AxisLetter {
+    X = "X",
+    Y = "Y",
+    Z = "Z",
+    U = "U",
+    V = "V",
+    W = "W",
+    A = "A",
+    B = "B",
+    C = "C",
+    D = "D",
+    a = "a",
+    b = "b",
+    c = "c",
+    d = "d",
+    e = "e",
+    f = "f",
+    g = "g",
+    h = "h",
+    i = "i",
+    j = "j",
+    k = "k",
+    l = "l",
+    none = ""
+}
+export default class Axis extends ModelObject {
+    acceleration: number;
+    babystep: number;
+    current: number;
+    readonly drivers: ModelCollection<DriverId>;
+    homed: boolean;
+    jerk: number;
+    letter: AxisLetter;
+    machinePosition: number | null;
+    max: number;
+    maxProbed: boolean;
+    readonly microstepping: Microstepping;
+    min: number;
+    minProbed: boolean;
+    percentCurrent: number;
+    percentStstCurrent: number | null;
+    speed: number;
+    stepsPerMm: number;
+    userPosition: number | null;
+    visible: boolean;
+    workplaceOffsets: Array<number>;
+}