@duet3d/objectmodel 3.7.0-alpha.13 → 3.7.0-alpha.14

package/dist/documentation.json

@@ -226,6 +226,7 @@
 	"inputs[].drivesRelative": "Whether relative extrusion is being used",
 	"inputs[].feedRate": "Current feedrate as passed by the last G0/G1 F... command",
 	"inputs[].inMacro": "Whether a macro file is being processed",
+	"inputs[].inverseTimeMode": "Indicates if inverse time mode (G73) is active",
 	"inputs[].lineNumber": "Number of the current line",
 	"inputs[].macroRestartable": "Indicates if the current macro file can be restarted after a pause",
 	"inputs[].motionSystem": "Active motion system index",
@@ -250,8 +251,8 @@
 		"summary": "Index of the current object being printed or -1 if unknown",
 		"remarks": "This value may now be greater than the length of the job.build.objects array. This is because the size of job.build.objects is limited to conserve memory (to 20 on Duet 2 or 40 on Duet 3), whereas when M486 labelling is used, many more objects can be numbered and the first 64 can be cancelled individually"
 	},
-	"job.build.m486names": "Whether M486 names are being used",
-	"job.build.m486numbers": "Whether M486 numbers are being used",
+	"job.build.m486Names": "Whether M486 names are being used",
+	"job.build.m486Numbers": "Whether M486 numbers are being used",
 	"job.build.objects": "List of detected build objects",
 	"job.build.objects[].cancelled": "Indicates if this build object is cancelled",
 	"job.build.objects[].name": "Name of the build object (if any)",
@@ -488,6 +489,8 @@
 	"move.currentMove": "Information about the current move",
 	"move.currentMove.acceleration": "Acceleration of the current move (in mm/s^2)",
 	"move.currentMove.deceleration": "Deceleration of the current move (in mm/s^2)",
+	"move.currentMove.distance": "Total distance of the current move (in mm)",
+	"move.currentMove.duration": "Duration of the current move (in s)",
 	"move.currentMove.extrusionRate": "Current extrusion rate (in mm/s)",
 	"move.currentMove.laserPwm": "Laser PWM of the current move (0..1) or null if not applicable",
 	"move.currentMove.requestedSpeed": "Requested speed of the current move (in mm/s)",
@@ -546,13 +549,14 @@
 		}
 	},
 	"move.kinematics.segmentation": "Segmentation parameters or null if not configured",
-	"move.kinematics.segmentation.minSegmentLength": "Minimum length of a segment (in mm)",
 	"move.kinematics.segmentation.segmentsPerSec": "Number of segments per second",
 	"move.limitAxes": "Limit axis positions by their minima and maxima",
 	"move.motionSystems": "List of configured motion systems",
 	"move.motionSystems[].currentMove": "Information about the current move",
 	"move.motionSystems[].currentMove.acceleration": "Acceleration of the current move (in mm/s^2)",
 	"move.motionSystems[].currentMove.deceleration": "Deceleration of the current move (in mm/s^2)",
+	"move.motionSystems[].currentMove.distance": "Total distance of the current move (in mm)",
+	"move.motionSystems[].currentMove.duration": "Duration of the current move (in s)",
 	"move.motionSystems[].currentMove.extrusionRate": "Current extrusion rate (in mm/s)",
 	"move.motionSystems[].currentMove.laserPwm": "Laser PWM of the current move (0..1) or null if not applicable",
 	"move.motionSystems[].currentMove.requestedSpeed": "Requested speed of the current move (in mm/s)",
@@ -669,6 +673,7 @@
 	},
 	"plugins[].sbcExecutableArguments": "Command-line arguments for the executable",
 	"plugins[].sbcExtraExecutables": "List of other filenames in the dsf directory that should be executable",
+	"plugins[].sbcNotifyStarted": "Plugin notifies DSF when it is fully started",
 	"plugins[].sbcOutputRedirected": "Defines if messages from stdout/stderr are output as generic messages",
 	"plugins[].sbcPackageDependencies": "List of packages this plugin depends on (apt packages in the case of DuetPi)",
 	"plugins[].sbcPermissions": "List of permissions required by the plugin executable running on the SBC",
@@ -676,6 +681,7 @@
 	"plugins[].sbcPythonDependencies": "List of Python packages this plugin depends on",
 	"plugins[].sbcRequired": "Set to true if a SBC is absolutely required for this plugin",
 	"plugins[].sdFiles": "List of files to be installed to the (virtual) SD excluding web files",
+	"plugins[].started": "Indicates if the plugin is fully started",
 	"plugins[].tags": "List of general tags for search",
 	"plugins[].version": "Version of the plugin",
 	"sbc": "Information about the SBC which Duet Software Framework is running on. This is null if the system is operating in standalone mode",
@@ -710,7 +716,7 @@
 			"TRACE": "HTTP TRACE request",
 			"DELETE": "HTTP DELETE request",
 			"OPTIONS": "HTTP OPTIONS request",
-			"WebSocket": "WebSocket request for bidirectional communication with a custom endpoint"
+			"WebSocket": "WebSocket request. This has not been implemented yet but it is reserved for future usage"
 		}
 	},
 	"sbc.dsf.httpEndpoints[].isUploadRequest": {
@@ -806,7 +812,7 @@
 			"rtdmax31865": "RTD MAX31865",
 			"thermocouplemax31855": "MAX31855 thermocouple",
 			"thermocouplemax31856": "MAX31856 thermocouple",
-			"linearanalog": "Linear analog sensor",
+			"linearanalog": null,
 			"dht21": "DHT21 sensor",
 			"dht22": "DHT22 sensor",
 			"dhthumidity": "DHT humidity sensor",
@@ -891,6 +897,7 @@
 	"sensors.probes[].tolerance": "Allowed tolerance deviation between two measures (in mm)",
 	"sensors.probes[].touchMode": "Touch mode options (if supported, otherwise null)",
 	"sensors.probes[].touchMode.active": "Indicates if the touch probe is enabled",
+	"sensors.probes[].touchMode.speed": "Speed while probing in touch mode (in mm/s)",
 	"sensors.probes[].touchMode.threshold": "Threshold value of the touch probe",
 	"sensors.probes[].touchMode.triggerHeight": "Height of the trigger point of the touch probe (in mm)",
 	"sensors.probes[].travelSpeed": "Travel speed when probing multiple points (in mm/min)",
@@ -1031,6 +1038,7 @@
 			"idle": "The machine is on but has nothing to do"
 		}
 	},
+	"state.thisActive": "Shorthand for inputs[state.thisInput].active",
 	"state.thisInput": {
 		"summary": "Index of the current G-code input channel (see ObjectModel.Inputs)",
 		"remarks": "This is primarily intended for macro files to determine on which G-code channel it is running. The value of this property is always null in object model queries"
@@ -1083,6 +1091,7 @@
 	"volumes[].mounted": "Whether the storage device is mounted",
 	"volumes[].name": "Name of this volume",
 	"volumes[].openFiles": "Number of currently open files or null if unknown",
+	"volumes[].partitionSize": "Total size of this volume (in bytes or null)",
 	"volumes[].path": "Logical path of the storage device",
 	"volumes[].speed": "Speed of the storage device (in bytes/s or null if unknown)"
 }

package/dist/inputs/InputChannel.d.ts

@@ -21,6 +21,7 @@ export declare class InputChannel extends ModelObject {
     drivesRelative: boolean;
     feedRate: number;
     inMacro: boolean;
+    inverseTimeMode: boolean;
     macroRestartable: boolean;
     motionSystem: number;
     name: string;

package/dist/inputs/InputChannel.js

@@ -25,6 +25,7 @@ export class InputChannel extends ModelObject {
         this.drivesRelative = true;
         this.feedRate = 50;
         this.inMacro = false;
+        this.inverseTimeMode = false;
         this.macroRestartable = false;
         this.motionSystem = 0;
         this.name = "";

package/dist/job/Build.d.ts

@@ -8,8 +8,8 @@ export declare class BuildObject extends ModelObject {
 }
 export declare class Build extends ModelObject {
     currentObject: number;
-    m486names: boolean;
-    m486numbers: boolean;
+    m486Names: boolean;
+    m486Numbers: boolean;
     readonly objects: ModelCollection<BuildObject>;
 }
 export default Build;

package/dist/job/Build.js

@@ -13,8 +13,8 @@ export class Build extends ModelObject {
     constructor() {
         super(...arguments);
         this.currentObject = -1;
-        this.m486names = false;
-        this.m486numbers = false;
+        this.m486Names = false;
+        this.m486Numbers = false;
         this.objects = new ModelCollection(BuildObject);
     }
 }

package/dist/move/index.d.ts

@@ -11,6 +11,8 @@ import Kinematics from "./kinematics";
 export declare class CurrentMove extends ModelObject {
     acceleration: number;
     deceleration: number;
+    distance: number;
+    duration: number;
     extrusionRate: number;
     laserPwm: number | null;
     requestedSpeed: number;

package/dist/move/index.js

@@ -13,6 +13,8 @@ export class CurrentMove extends ModelObject {
         super(...arguments);
         this.acceleration = 0;
         this.deceleration = 0;
+        this.distance = 0;
+        this.duration = 0;
         this.extrusionRate = 0;
         this.laserPwm = null;
         this.requestedSpeed = 0;

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

@@ -16,7 +16,7 @@ export declare enum KinematicsName {
 }
 export declare class MoveSegmentation extends ModelObject {
     segmentsPerSec: number;
-    minSegmentLength: number;
+    minSegLength: number;
 }
 export declare abstract class KinematicsBase extends ModelObject {
     readonly name: KinematicsName;

package/dist/move/kinematics/KinematicsBase.js

@@ -19,7 +19,7 @@ export class MoveSegmentation extends ModelObject {
     constructor() {
         super(...arguments);
         this.segmentsPerSec = 0;
-        this.minSegmentLength = 0;
+        this.minSegLength = 0;
     }
 }
 export class KinematicsBase extends ModelObject {

package/dist/plugins/PluginManifest.d.ts

@@ -54,6 +54,7 @@ export declare class PluginManifest extends ModelObject {
     sbcExecutableArguments: string | null;
     sbcExtraExecutables: Array<string>;
     sbcAutoRestart: boolean;
+    sbcNotifyStarted: boolean;
     sbcOutputRedirected: boolean;
     sbcPermissions: ModelSet<SbcPermission>;
     sbcConfigFiles: Array<string>;

package/dist/plugins/PluginManifest.js

@@ -55,6 +55,7 @@ export class PluginManifest extends ModelObject {
         this.sbcExecutableArguments = null;
         this.sbcExtraExecutables = [];
         this.sbcAutoRestart = false;
+        this.sbcNotifyStarted = false;
         this.sbcOutputRedirected = true;
         this.sbcPermissions = new ModelSet();
         this.sbcConfigFiles = [];

package/dist/plugins/index.d.ts

@@ -4,6 +4,7 @@ export declare class Plugin extends PluginManifest {
     dwcFiles: Array<string>;
     sdFiles: Array<string>;
     pid: number;
+    started: boolean;
 }
 export default Plugin;
 export * from "./PluginManifest";

package/dist/plugins/index.js

@@ -6,6 +6,7 @@ export class Plugin extends PluginManifest {
         this.dwcFiles = [];
         this.sdFiles = [];
         this.pid = -1;
+        this.started = false;
     }
 }
 export default Plugin;

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

@@ -4,7 +4,7 @@ import { Duet3DFilamentMonitor } from "./Duet3DFilamentMonitor";
 export declare class LaserFilamentMonitorCalibrated extends ModelObject {
     percentMax: number;
     percentMin: number;
-    sensivity: number;
+    sensitivity: number;
     totalDistance: number;
 }
 export declare class LaserFilamentMonitorConfigured extends ModelObject {

package/dist/sensors/FilamentMonitors/LaserFilamentMonitor.js

@@ -7,7 +7,7 @@ export class LaserFilamentMonitorCalibrated extends ModelObject {
         super(...arguments);
         this.percentMax = 0;
         this.percentMin = 0;
-        this.sensivity = 0;
+        this.sensitivity = 0;
         this.totalDistance = 0;
     }
 }

package/dist/sensors/Probe.d.ts

@@ -15,7 +15,7 @@ export declare enum ProbeType {
 }
 export declare class ProbeTouchMode extends ModelObject {
     active: boolean;
-    sensitivity: number;
+    speed: number;
     triggerHeight: number;
     threshold: number;
 }

package/dist/sensors/Probe.js

@@ -18,7 +18,7 @@ export class ProbeTouchMode extends ModelObject {
     constructor() {
         super(...arguments);
         this.active = false;
-        this.sensitivity = 0;
+        this.speed = 0;
         this.triggerHeight = 0;
         this.threshold = 0;
     }

package/dist/state/index.d.ts

@@ -59,6 +59,7 @@ export declare class State extends ModelObject {
     readonly restorePoints: ModelCollection<RestorePoint>;
     startupError: StartupError | null;
     status: MachineStatus;
+    thisActive: boolean | null;
     thisInput: number | null;
     time: string | null;
     upTime: number;

package/dist/state/index.js

@@ -71,6 +71,7 @@ export class State extends ModelObject {
         this.restorePoints = new ModelCollection(RestorePoint);
         this.startupError = null;
         this.status = MachineStatus.starting;
+        this.thisActive = null;
         this.thisInput = null;
         this.time = null;
         this.upTime = 0;

package/dist/volumes/index.d.ts

@@ -5,6 +5,7 @@ export declare class Volume extends ModelObject {
     mounted: boolean;
     name: string | null;
     openFiles: number | null;
+    partitionSize: number | bigint | null;
     path: string | null;
     speed: number | null;
 }

package/dist/volumes/index.js

@@ -7,6 +7,7 @@ export class Volume extends ModelObject {
         this.mounted = false;
         this.name = null;
         this.openFiles = null;
+        this.partitionSize = null;
         this.path = null;
         this.speed = null;
     }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@duet3d/objectmodel",
-  "version": "3.7.0-alpha.13",
+  "version": "3.7.0-alpha.14",
   "description": "TypeScript implementation of the Duet3D Object Model",
   "type": "module",
   "main": "dist/index.js",