-
Notifications
You must be signed in to change notification settings - Fork 534
Object Model Documentation
This page is auto-generated. If you find any errors, please report them on the forum and DO NOT EDIT this page! If you are capable of editing source code, it is encouraged to make pull requests for the original DSF API code instead.
This page refers to version 3.3 of the Object Model.
All Duet software projects share the same object model to store configuration and sensor data. This page provides documentation about the different object model keys and associated properties.
Some fields may not be available in standalone mode because some fields are only maintained by DSF and/or DWC. It is advised to consider this when developing applications that address Duets in standalone and SBC mode.
Certain fields have class names in braces (...) appended to the object model path.
These class names are present for items where different item types may be configured.
If a class inherits values from a base type, the inheritance is marked using a colon (:) followed by the base class name.
So, for example, LaserFilamentMonitor : FilamentMonitor means that a LaserFilamentMonitor inherits all the properties from the FilamentMonitor base class.
This page is preliminary and subject to further changes.
List of connected boards
Note: The first item represents the main board
Filename of the firmware binary
CAN address of this board or null if not applicable
Details about a connected display or null if none is connected
Number of pulses per click of the rotary encoder
SPI frequency of the display (in Hz)
Name of the attached display type
Date of the firmware build
Filename of the firmware binary
Name of the firmware build
Version of the firmware build
Filename of the IAP binary that is used for updates from the SBC or null if unsupported
Filename of the IAP binary that is used for updates from the SD card or null if unsupported
Maximum number of heaters this board can control
Maximum number of motors this board can drive
Minimum, maximum, and current temperatures of the MCU
Full name of the board
Short name of this board
State of this board
Indicates if this board supports external 12864 displays
Indicates if this board supports external displays
Unique identifier of the board
Minimum, maximum, and current voltages on the 12V rail
Minimum, maximum, and current voltages on the input rail
Information about the individual directories
Note: This may not be available in RepRapFirmware if no mass storages are available
Path to the filaments directory
Path to the firmware directory
Path to the G-Codes directory
Path to the macros directory
Path to the menu directory
Note: Intended for 12864 displays but currently unused in DSF. It is only needed for the Duet Maestro + DWC
Path to the scans directory
Path to the system directory
Path to the web directory
List of configured fans
Value of this fan (0..1 or -1 if unknown)
Blip value indicating how long the fan is supposed to run at 100% when turning it on to get it started (in s)
Configured frequency of this fan (in Hz)
Maximum value of this fan (0..1)
Minimum value of this fan (0..1)
Name of the fan
Requested value for this fan on a scale between 0 to 1
Current RPM of this fan or -1 if unknown/unset
Thermostatic control parameters
List of the heaters to monitor (indices)
Upper temperature range required to turn on the fan (in C)
Lower temperature range required to turn on the fan (in C)
Dictionary of global variables vs JSON values
Note: When DSF attempts to reconnect to RRF, this may be set to null to clear the contents
Information about the heat subsystem
List of configured bed heaters (indices)
Note: Items may be -1 if unconfigured
List of configured chamber heaters (indices)
Note: Items may be -1 if unconfigured
Minimum required temperature for extrusion moves (in C)
Minimum required temperature for retraction moves (in C)
List of configured heaters
Active temperature of the heater (in C)
Current temperature of the heater (in C)
Maximum temperature allowed for this heater (in C)
Note: This is only temporary and should be replaced by a representation of the heater protection as in RRF
Minimum temperature allowed for this heater (in C)
Note: This is only temporary and should be replaced by a representation of the heater protection as in RRF
Information about the heater model
Dead time
Indicates if this heater is enabled
Gain value
Heating rate (in K/s)
Indicates if the heater PWM signal is inverted
Maximum PWM value
Details about the PID controller
Indicates if custom PID values are used
Proportional value of the PID regulator
Integral value of the PID regulator
Derivative value of the PID regulator
Indicates if PID control is being used
Standard voltage or null if unknown
Time constant
Time constant with the fans on
Monitors of this heater
Action to perform when the trigger condition is met
Condition to meet to perform an action
Limit threshold for this heater monitor
Name of the heater or null if unset
Sensor number of this heater or -1 if not configured
Standby temperature of the heater (in C)
State of the heater
This field is maintained by DSF in SBC mode and might not be available in standalone mode
List of registered third-party HTTP endpoints
HTTP type of this endpoint
Namespace of the endpoint
Note: May be to register root-level rr_ requests (to emulate RRF poll requests)
Path to the endpoint
Whether this is a upload request
Note: If set to true, the whole body payload is written to a temporary file and the file path is passed via the property
Path to the UNIX socket
Information about every available G/M/T-code channel
Whether relative positioning is being used
Emulation used on this channel
Whether inches are being used instead of mm
Whether relative extrusion is being used
Current feedrate in mm/s
Whether a macro file is being processed
Name of this channel
Depth of the stack
State of this input channel
Number of the current line
Whether volumetric extrusion is being used
Information about the current job
Information about the current build or null if not available
Index of the current object being printed or -1 if unknown
Whether M486 names are being used
Whether M486 numbers are being used
List of detected build objects
Indicates if this build object is cancelled
Name of the build object (if any)
X coordinates of the build object (in mm or null if not found)
Y coordinates of the build object (in mm or null if not found)
Total duration of the current job (in s or null)
Information about the file being processed
Filament consumption per extruder drive (in mm)
The filename of the G-code file
Height of the first layer or 0 if not found (in mm)
Name of the application that generated this file
Build height of the G-code job or 0 if not found (in mm)
Value indicating when the file was last modified or null if unknown
Height of each other layer or 0 if not found (in mm)
Number of total layers or 0 if unknown
Estimated print time (in s)
Estimated print time from G-code simulation (in s)
Size of the file
Collection of thumbnails parsed from Gcode
base64 encoded thumbnail
Height of thumbnail
Width of thumbnail
Current position in the file being processed (in bytes or null)
Total duration of the last job (in s or null)
Name of the last file processed or null if none
This field is maintained by DSF in SBC mode and might not be available in standalone mode
Indicates if the last file was aborted (unexpected cancellation)
This field is maintained by DSF in SBC mode and might not be available in standalone mode
Indicates if the last file was cancelled (user cancelled)
This field is maintained by DSF in SBC mode and might not be available in standalone mode
Indicates if the last file processed was simulated
Note: This is not set if the file was aborted or cancelled
Number of the current layer or null not available
This field is maintained by DSF in SBC mode and might not be available in standalone mode
Information about the past layers
Note: In previous API versions this was a but it has been changed to to allow past layers to be modified again when needed. Note that previous plugins subscribing to this property will not receive any more updates about this property to avoid memory leaks
Duration of the layer (in s)
Actual amount of filament extruded during this layer (in mm)
Fraction of the file printed during this layer (0..1)
Height of the layer (in mm or 0 if unknown)
Last heater temperatures (in C or null if unknown)
Time elapsed since the last layer change (in s or null)
Total pause time since the job started
Total extrusion amount without extrusion factors applied (in mm)
Estimated times left
Time left based on filament consumption (in s or null)
Time left based on file progress (in s or null)
Time left based on the slicer reports (see M73, in s or null)
Time needed to heat up the heaters (in s or null)
Machine configuration limits
Maximum number of axes or null if unknown
Maximum number of axes + extruders or null if unknown
Maximum number of bed heaters or null if unknown
Maximum number of boards or null if unknown
Maximum number of chamber heaters or null if unknown
Maximum number of drivers or null if unknown
Maximum number of drivers per axis or null if unknown
Maximum number of extruders or null if unknown
Maximum number of extruders per tool or null if unknown
Maximum number of fans or null if unknown
Maximum number of general-purpose input ports or null if unknown
Maximum number of general-purpose output ports or null if unknown
Maximum number of heaters or null if unknown
Maximum number of heaters per tool or null if unknown
Maximum number of monitors per heater or null if unknown
Maximum number of restore points or null if unknown
Maximum number of sensors or null if unknown
Maximum number of spindles or null if unknown
Maximum number of tools or null if unknown
Maximum number of tracked objects or null if unknown
Maximum number of triggers or null if unknown
Maximum number of volumes or null if unknown
Maximum number of workplaces or null if unknown
Maximum number of Z-probe programming bytes or null if unknown
Maximum number of Z-probes or null if unknown
This field is maintained by DSF in SBC mode and might not be available in standalone mode
Generic messages that do not belong explicitly to codes being executed. This includes status messages, generic errors and outputs generated by M118
Information about the move subsystem
List of the configured axes
Acceleration of this axis (in mm/s^2)
Babystep amount (in mm)
Motor current (in mA)
List of the assigned drivers
Whether or not the axis is homed
Motor jerk (in mm/s)
Letter of the axis (always upper-case)
Current machine position (in mm) or null if unknown/unset
Maximum travel of this axis (in mm)
Whether the axis maximum was probed
Microstepping configuration
Indicates if the stepper driver uses interpolation
Microsteps per full step
Minimum travel of this axis (in mm)
Whether the axis minimum was probed
Maximum speed (in mm/s)
Number of microsteps per mm
Current user position (in mm) or null if unknown
Whether or not the axis is visible
Offsets of this axis for each workplace (in mm)
Information about the automatic calibration
Final calibration results (for Delta calibration)
RMS deviation (in mm)
Mean deviation (in mm)
Initial calibration results (for Delta calibration)
RMS deviation (in mm)
Mean deviation (in mm)
Number of factors used (for Delta calibration)
Information about the currently configured compensation options
Effective height before the bed compensation is turned off (in mm) or null if not configured
This field is maintained by DSF in SBC mode and might not be available in standalone mode
Full path to the currently used height map file or null if none is in use
Deviations of the mesh grid or null if not applicable
RMS deviation (in mm)
Mean deviation (in mm)
Settings of the current probe grid
Axis letters of this heightmap
End coordinates of the heightmap
Start coordinates of the heightmap
Probing radius for delta kinematics
Spacings between the coordinates
Information about the configured orthogonal axis parameters
Indicates if the value is applied to the X or Y axis value
Tangent of the skew angle for the XY or YX axes
Tangent of the skew angle for the XZ axes
Tangent of the skew angle for the YZ axes
Type of the compensation in use
Information about the current move
Acceleration of the current move (in mm/s^2)
Deceleration of the current move (in mm/s^2)
Laser PWM of the current move (0..1) or null if not applicable
Requested speed of the current move (in mm/s)
Top speed of the current move (in mm/s)
List of configured extruders
Acceleration of this extruder (in mm/s^2)
Motor current (in mA)
Assigned driver
Name of the currently loaded filament
Extrusion factor to use (0..1 or greater)
Motor jerk (in mm/s)
Microstepping configuration
Indicates if the stepper driver uses interpolation
Microsteps per full step
Nonlinear extrusion parameters (see M592)
A coefficient in the extrusion formula
B coefficient in the extrusion formula
Upper limit of the nonlinear extrusion compensation
Extruder position (in mm)
Pressure advance
Raw extruder position as commanded by the slicer without extrusion factor applied (in mm)
Maximum speed (in mm/s)
Number of microsteps per mm
Idle current reduction parameters
Idle timeout after which the stepper motor currents are reduced (in s)
Motor current reduction factor (0..1)
Configured kinematics options
Information about core kinematics
Forward matrix
Inverse matrix
Delta kinematics
Delta radius (in mm)
Homed height of a delta printer in mm
Print radius for Hangprinter and Delta geometries (in mm)
Delta tower properties
Tower position corrections (in degrees)
Diagonal rod length (in mm)
Deviation of the ideal endstop position (in mm)
X coordinate of this tower (in mm)
Y coordinate of this tower (in mm)
How much Z needs to be raised for each unit of movement in the +X direction
How much Z needs to be raised for each unit of movement in the +Y direction
Information about hangprinter kinematics
Anchor configurations for A, B, C, Dz
Print radius (in mm)
Currently configured geometry type
Kinematics class for SCARA kinematics
Base kinematics class that provides the ability to level the bed using Z leadscrews
Parameters describing the tilt correction
Correction factor
Last corrections (in mm)
Maximum Z correction (in mm)
Pitch of the Z leadscrews (in mm)
X positions of the leadscrews (in mm)
Y positions of the leadscrews (in mm)
Maximum acceleration allowed while printing (in mm/s^2)
List of move queue items (DDA rings)
The minimum idle time before we should start a move (in s)
Maximum number of moves that can be accomodated in the DDA ring
Parameters for input shaping
Damping factor
Frequency (in Hz)
Minimum acceleration (in mm/s)
Configured input shaping type
Speed factor applied to every regular move (0.01..1 or greater)
Maximum acceleration allowed while travelling (in mm/s^2)
Virtual total extruder position
Index of the currently selected workplace
Information about connected network adapters
This field is maintained by DSF in SBC mode and might not be available in standalone mode
If this is set, the web server will allow cross-origin requests via the Access-Control-Allow-Origin header
Hostname of the machine
This field is maintained by DSF in SBC mode and might not be available in standalone mode
List of available network interfaces
List of active protocols
Actual IPv4 address of the network adapter
Configured IPv4 address of the network adapter
Configured IPv4 DNS server fo the network adapter
Version of the network interface or null if unknown. This is primarily intended for the ESP8266-based network interfaces as used on the Duet WiFi
IPv4 gateway of the network adapter
Physical address of the network adapter
Number of reconnect attempts or null if unknown
Signal of the WiFi adapter (only WiFi, in dBm, or null if unknown)
Speed of the network interface (in MBit, null if unknown, 0 if not connected)
Subnet of the network adapter
Type of this network interface
Name of the machine
This field is maintained by DSF in SBC mode and might not be available in standalone mode
Dictionary of SBC plugins where each key is the plugin identifier
Note: Values in this dictionary cannot become null. If a change to null is reported, the corresponding key is deleted. Do not rely on the setter of this property; it will be removed from a future version.
Identifier of this plugin. May consist of letters and digits only (max length 32 chars)
Note: For plugins with DWC components, this is the Webpack chunk name too
Name of the plugin. May consist of letters, digits, dashes, and underscores only (max length 64 chars)
Author of the plugin
Version of the plugin
License of the plugin. Should follow the SPDX format (see https://spdx.org/licenses/)
Link to the plugin homepage or source code repository
Major/minor compatible DWC version
List of DWC plugins this plugin depends on. Circular dependencies are not supported
Set to true if a SBC is absolutely required for this plugin
Required DSF version for the plugin running on the SBC (ignored if there is no SBC executable)
Filename in the dsf directory used to start the plugin
Note: A plugin may provide different binaries in subdirectories per architecture. Supported architectures are: arm, arm64, x86, x86_64
List of other filenames in the dsf directory that should be executable
Command-line arguments for the executable
Defines if messages from stdout/stderr are output as generic messages
List of permissions required by the plugin executable running on the SBC
List of packages this plugin depends on (apt packages in the case of DuetPi)
List of SBC plugins this plugin depends on. Circular dependencies are not supported
Major/minor supported RRF version (optional)
Custom plugin data to be populated in the object model (DSF/DWC in SBC mode - or - DWC in standalone mode). Before can be used, corresponding properties must be registered via this property first!
Class representing a loaded plugin
List of files for the DSF plugin
List of files for the DWC plugin
List of files to be installed to the (virtual) SD excluding web files
Process ID of the plugin or -1 if not started. It is set to 0 while the plugin is being shut down
This field is maintained by DSF in SBC mode and might not be available in standalone mode
Information about the 3D scanner subsystem
Progress of the current action (on a scale between 0 to 1)
Note: Previous status responses used a scale of 0..100
Status of the 3D scanner
Information about connected sensors including Z-probes and endstops
List of analog sensors
Last sensor reading (in C) or null if invalid
Name of this sensor or null if not configured
Type of this sensor
List of configured endstops
Whether this endstop is at the high end of the axis
Whether or not the endstop is hit
Type of the endstop
List of configured filament monitors
Indicates if this filament monitor is enabled
Last reported status of this filament monitor
Type of this filament monitor
Information about a laser filament monitor
Calibrated properties of this filament monitor
Calibration factor of this sensor
Maximum percentage (0..1 or greater)
Minimum percentage (0..1)
Calibrated sensivity
Total extruded distance (in mm)
Configured properties of this filament monitor
Maximum percentage (0..1 or greater)
Minimum percentage (0..1)
Sample distance (in mm)
Indicates if a filament is present
Information about a pulsed filament monitor
Calibrated properties of this filament monitor
Extruded distance per pulse (in mm)
Maximum percentage (0..1 or greater)
Minimum percentage (0..1)
Total extruded distance (in mm)
Configured properties of this filament monitor
Extruded distance per pulse (in mm)
Maximum percentage (0..1 or greater)
Minimum percentage (0..1)
Sample distance (in mm)
Information about a rotating magnet filament monitor
Calibrated properties of this filament monitor
Extruded distance per revolution (in mm)
Maximum percentage (0..1 or greater)
Minimum percentage (0..1)
sensors.filamentMonitors[].calibrated.totalDistance (RotatingMagnetFilamentMonitor : FilamentMonitor)
Total extruded distance (in mm)
Configured properties of this filament monitor
Extruded distance per revolution (in mm)
Maximum percentage (0..1 or greater)
Minimum percentage (0..1)
sensors.filamentMonitors[].configured.sampleDistance (RotatingMagnetFilamentMonitor : FilamentMonitor)
Sample distance (in mm)
Indicates if a filament is present
Representation of a simple filament monitor
Indicates if a filament is present
List of general-purpose input ports
Value of this port (0..1)
List of configured probes
Calibration temperature (in C)
Indicates if the user has deployed the probe
Whether probing disables the heater(s)
Dive height (in mm)
Height of the probe where it stopped last time (in mm)
Maximum number of times to probe after a bad reading was determined
X+Y offsets (in mm)
Recovery time (in s)
Fast and slow probing speeds (in mm/s)
List of temperature coefficients
Configured trigger threshold (0..1023)
Allowed tolerance deviation between two measures (in mm)
Travel speed when probing multiple points (in mm/s)
Z height at which the probe is triggered (in mm)
Type of the configured probe
Current analog values of the probe
List of configured CNC spindles
Active RPM
Current RPM, negative if anticlockwise direction
Frequency (in Hz)
Minimum RPM when turned on
Maximum RPM
Current state
Information about the machine state
State of the ATX power pin (if controlled)
Information about a requested beep or null if none is requested
Duration of the requested beep (in ms)
Frequency of the requested beep (in Hz)
Number of the currently selected tool or -1 if none is selected
Persistent message to display (see M117)
This field is maintained by DSF in SBC mode and might not be available in standalone mode
Version of the Duet Software Framework package
This field is maintained by DSF in SBC mode and might not be available in standalone mode
Indicates if DSF allows the installation and usage of third-party plugins
This field is maintained by DSF in SBC mode and might not be available in standalone mode
Indicates if DSF allows the installation and usage of third-party root plugins (potentially dangerous)
List of general-purpose output ports
PWM value of this port (0..1)
Laser PWM of the next commanded move (0..1) or null if not applicable
This field is maintained by DSF in SBC mode and might not be available in standalone mode
Log file being written to or null if logging is disabled
This field is maintained by DSF in SBC mode and might not be available in standalone mode
Current log level
Details about a requested message box or null if none is requested
Bitmap of the axis movement controls to show (indices)
Content of the message box
Mode of the message box to display
Sequence number of the message box
Note: This is increased whenever a new message box is supposed to be displayed
Total timeout for this message box (in ms)
Title of the message box
Current mode of operation
Millisecond fraction of
Number of the next tool to be selected
Indicates if at least one plugin has been started
Script to execute when the power fails
Number of the previous tool
List of restore points
Axis coordinates of the restore point (in mm)
The virtual extruder position at the start of this move
PWM value of the tool fan (0..1)
Requested feedrate (in mm/s)
The output port bits setting for this move or null if not applicable
Laser PWM value (0..1) or null if not applicable
The spindle RPMs that were set, negative if anticlockwise direction
The tool number that was active
Current state of the machine
Internal date and time in RepRapFirmware or null if unknown
How long the machine has been running (in s)
List of configured tools
Active temperatures of the associated heaters (in C)
Associated axes. At present only X and Y can be mapped per tool.
Note: The order is the same as the visual axes, so by default the layout is [ [0], // X [1] // Y ] Make sure to set each item individually so the change events are called
Extruder drives of this tool
List of associated fans (indices)
Extruder drive index for resolving the tool filament (index or -1)
List of associated heaters (indices)
Mix ratios of the associated extruder drives
Name of this tool
Number of this tool
Axis offsets (in mm) This list is in the same order as
Bitmap of the probed axis offsets
Firmware retraction parameters
Amount of additional filament to extrude when undoing a retraction (in mm)
Retraction length (in mm)
Retraction speed (in mm/s)
Unretract speed (in mm/s)
Amount of Z lift after doing a retraction (in mm)
Index of the mapped spindle or -1 if not mapped
RPM of the mapped spindle
Standby temperatures of the associated heaters (in C)
Current state of this tool
This field is maintained by DSF in SBC mode and might not be available in standalone mode
List of user sessions
Identifier of this session
Access level of this session
Type of this sessionSessionAccessLevel
Origin of this session. For remote sessions, this equals the remote IP address
Corresponding identifier of the origin. If it is a remote session, it is the remote port, else it defaults to the PID of the current process
This field is maintained by DSF in SBC mode and might not be available in standalone mode
List of available mass storages
Total capacity of the storage device (in bytes or null)
How much space is still available on this device (in bytes or null)
Whether the storage device is mounted
Name of this volume
Number of currently open files or null if unknown
Logical path of the storage device
Speed of the storage device (in bytes/s or null if unknown)
This documentation file was generated by DocGen.