Namespace DuetAPI.ObjectModel
Classes
Accelerometer
This represents an accelerometer
AnalogSensor
Representation of an analog sensor
AnalogSensorTypeConverter
Class to convert an AnalogSensorType to and from JSON
Axis
Information about a configured axis
BeepRequest
Details about a requested beep
Board
Information about a connected board
BoardClosedLoop
This represents information about closed-loop tuning
Build
Information about the current build
BuildObject
Information about a detected build object
CPU
Information about the SBC's CPU
ClosedLoopCurrentFraction
Information about the current fraction of the closed-loop configuration
ClosedLoopPositionError
Information about the current fraction of the closed-loop configuration
CoreKinematics
Information about core kinematics
CurrentMove
Information about the current move
DSF
Information about Duet Software Framework
DeltaKinematics
Delta kinematics
DeltaTower
Delta tower properties
DeserializationFailedEventArgs
Event arguments for the event to be called when deserialization fails
DirectDisplay
Class providing information about a connected direct-connect display
DirectDisplayEncoder
Class providing information about a connected display encoder
DirectDisplayScreen
Standard direct-connect display screen
DirectDisplayScreenST7567
Direct-connected display screen with a ST7567 controller
Directories
Information about the configured directories
DistanceUnitConverter
Class used to convert distance units to and from JSON
Driver
Information about a driver
DriverClosedLoop
This represents information about closed-loop tuning
Duet3DFilamentMonitor
Base class for Duet3D filament monitors
Endstop
Information about an endstop
Extruder
Information about an extruder drive
ExtruderNonlinear
Nonlinear extrusion parameters (see M592)
Fan
Class representing information about an attached fan
FanThermostaticControl
Thermostatic parameters of a fan
FilamentMonitor
Information about a filament monitor
GCodeFileInfo
Holds information about a G-code file
GCodeFileInfoConverter
Class used to convert G-code file info to and from JSON
GpInputPort
Details about a general-purpose input port
GpOutputPort
Details about a general-purpose output port
HangprinterKinematics
Information about hangprinter kinematics
Heat
Information about the heat subsystem
Heater
Information about a heater
HeaterModel
Information about the way the heater heats up
HeaterModelPID
Details about the PID model of a heater
HeaterMonitor
Information about a heater monitor
HttpEndpoint
Class representing an extra HTTP endpoint
InductiveSensor
Information about an inductive sensor
InputChannel
Information about a G/M/T-code channel
InputShaping
Parameters describing input shaping
Inputs
List holding information about the available G/M/T-code channels
Job
Information about the current job
KeepoutZone
Information about a configured keep-out zone
KeepoutZoneCoordinates
Coordinates of a keep-out zone
Kinematics
Information about the configured geometry
KinematicsNameConverter
Class to convert a KinematicsName to and from JSON
LaserFilamentMonitor
Information about a laser filament monitor
LaserFilamentMonitorCalibrated
Calibrated properties of a laser filament monitor
LaserFilamentMonitorConfigured
Configured properties of a laser filament monitor
Layer
Information about a layer from a file being printed
LedStrip
Information about a configured LED strip
LimitedResponseCountAttribute
Attribute used to mark properties that provide only a limited number of items in a standard model response
Limits
Machine configuration limits
Memory
Information about the SBC's memory (RAM)
Message
Generic container for messages
MessageBox
Information about the message box to show
Microstepping
Microstepping configuration
MinMaxCurrent<T>
Provides minimum, maximum and current values
ModelCollection<T>
Generic container for object model arrays
ModelDictionaryConverter
Converter factory class for ModelDictionary<TValue> types
ModelDictionary<TValue>
Class for holding string keys and custom values
ModelGrowingCollection<T>
Generic list container to which items can be added or which can be cleared only
ModelObject
Base class for machine model properties
MotorsIdleControl
Idle factor parameters for automatic motor current reduction
Move
Information about the move subsystem
MoveCalibration
Information about configured calibration options
MoveCompensation
Information about the configured compensation options
MoveDeviations
Calibration or mesh grid results
MoveQueueItem
Information about a DDA ring
MoveRotation
Information about centre rotation as defined by G68
MoveSegmentation
Move segmentation parameters
Network
Information about the network subsystem
NetworkInterface
Information about a network interface
ObjectModel
Representation of the Duet3D object model
ObjectModelConverter
Class used to convert model objects to and from JSON
Plugin
Class representing a loaded plugin
PluginManifest
Information about a third-party plugin
PolarKinematics
Kinematics class for polar kinematics
Probe
Information about a configured probe
ProbeGrid
Information about the configured probe grid (see M557)
PulsedFilamentMonitor
Information about a pulsed filament monitor
PulsedFilamentMonitorCalibrated
Calibrated properties of a pulsed filament monitor
PulsedFilamentMonitorConfigured
Configured properties of a pulsed filament monitor
RestorePoint
Class holding information about a restore point
RotatingMagnetFilamentMonitor
Information about a rotating magnet filament monitor
RotatingMagnetFilamentMonitorCalibrated
Calibrated properties of a rotating magnet filament monitor
RotatingMagnetFilamentMonitorConfigured
Configured properties of a rotating magnet filament monitor
SBC
Information about the SBC in SBC mode
SbcPropertyAttribute
Attribute used to mark properties that are overridden by the control server
ScaraKinematics
Kinematics class for SCARA kinematics
Sensors
Information about sensors
Skew
Class holding details about orthogonoal axis compensation parameters
Spindle
Information about a CNC spindle
StartupError
Details about the first error on start-up
State
Information about the machine state
ThumbnailInfo
Information about a thumbnail from a G-code file
TiltCorrection
Tilt correction parameters for Z leadscrew compensation
TimesLeft
Estimations about the times left
Tool
Information about a configured tool
ToolRetraction
Tool retraction parameters
UserSession
Class representing a user session
Volume
Information about a storage device
ZLeadscrewKinematics
Base kinematics class that provides the ability to level the bed using Z leadscrews
Interfaces
IGrowingModelCollection
Interface for growing model collections
IModelCollection
Interface that all object model collections must implement
IModelDictionary
Interface for model dictionaries
IModelObject
Basic interface for object model classes that have properties
Enums
AccessLevel
Defines what a user is allowed to do
AnalogSensorType
Enumeration of supported analog sensor types
BoardState
Enumeration of possible expansion board states
Compatibility
Compatibility level for emulation
DirectDisplayController
Enumeration of possible direct-connect display controllers
DistanceUnit
Distance unit used for positioning
EndstopType
Type of a configured endstop
FilamentMonitorEnableMode
Enumeration of supported filament sensors
FilamentMonitorStatus
Possible filament sensor status
FilamentMonitorType
Enumeration of supported filament sensors
HeaterMonitorAction
Action to take when a heater monitor is triggered
HeaterMonitorCondition
Trigger condition for a heater monitor
HeaterState
State of a heater
HttpEndpointType
Enumeration of supported HTTP request types
InputChannelState
State of a channel
InputShapingType
Enumeration of possible input shaping methods
KinematicsName
Enumeration of supported kinematics
LedStripType
Types of supported LED strips
LogLevel
Class representing the configured log level
MachineMode
Possible operation modes of the machine
MachineStatus
Possible states of the firmware
MessageBoxMode
Supported modes of displaying a message box
MessageType
Type of a generic message
MoveCompensationType
Supported compensation types
NetworkInterfaceType
Supported types of network interfaces
NetworkProtocol
Supported network protocols
NetworkState
Enumeration of possible network interface states
ProbeType
Supported probe types
SessionType
Types of user sessions
SpindleState
Possible state of a spindle
TemperatureError
Result codes returned by temperature sensor drivers
ThumbnailInfoFormat
Image formats for parsed thumbnails
ToolState
States of a tool
Delegates
DeserializationFailedEventHandler
Delegate of the event to be called when deserialization of a property fails