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
- DriverConfig
Configured (M569) settings of a driver
- Duet3DFilamentMonitor
Base class for Duet3D filament monitors
- DynamicModelCollection<T>
Generic container for model object arrays with dynamic items
- Endstop
Information about an endstop
- Extruder
Information about an extruder drive
- ExtruderNonlinear
Nonlinear extrusion parameters (see M592)
- ExtruderPressureAdvance
Pressure advance parameters (see M572)
- Fan
Class representing information about an attached fan
- FanThermostaticControl
Thermostatic parameters of a fan
- FilamentMonitor
Base class for filament monitors
- GCodeFileInfo
Holds information about a G-code file
- 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
- JsonModelDictionary
Class for holding string keys and custom values
- JsonModelDictionaryConverter
Converter factory class for JsonModelDictionary types
- KeepoutZone
Information about a configured keep-out zone
- KeepoutZoneCoordinates
Coordinates of a keep-out zone
- Kinematics
Information about the configured geometry
- 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
- LiveAttribute
Attribute used to mark properties that change frequently (e.g. temperatures, positions, status). Properties with this attribute are included when the 'f' flag is used in object model queries.
- Memory
Information about the SBC's memory (RAM)
- Message
Generic container for messages
- MessageBox
Information about the message box to show
- MessageCollection
Generic list container to which messages can only be added or cleared
- Microstepping
Microstepping configuration
- MinMaxCurrent
Provides minimum, maximum and current values
- ModelObject
Base class for object model classes
- MotionSystem
Information about a motion system
- 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
- ObjectModelContext
Context for JSON handling of the main object model classes
- 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)
- ProbeTouchMode
Information about a configured probe
- 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
- StaticModelCollection<T>
Generic container for model object arrays with static items
- StaticModelDictionary<TValue>
Class for holding string keys and custom values
- 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
- VerboseAttribute
Attribute used to mark properties that are excluded from standard object model responses. Properties with this attribute are only included when the 'v' flag is used in object model queries.
- Volume
Information about a storage device
- ZLeadscrewKinematics
Base kinematics class that provides the ability to level the bed using Z leadscrews
Interfaces
- IDynamicModelObject
Dynamic interface for object model classes that have properties. Classes that implement this interface may change its instance on update
- IModelCollection
Interface that all object model collections must implement
- IModelDictionary
Interface for model dictionaries
- IModelObject
Base interface for object model classes
- IStaticModelObject
Static interface for object model classes that have properties. Classes that implement this interface may not change its instance on update
Enums
- AccessLevel
Defines what a user is allowed to do
- AnalogSensorType
Enumeration of supported analog sensor types
- BoardState
Enumeration of possible expansion board states
- CommunicationMethod
Communication method used to talk to the firmware
- Compatibility
Compatibility level for emulation
- DirectDisplayController
Enumeration of possible direct-connect display controllers
- DistanceUnit
Distance unit used for positioning
- DriverMode
Operating mode of a stepper driver
- EndstopType
Type of a configured endstop
- EventLogLevel
Class representing the configured log level
- 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
- LedStripColorOrder
Order in which colour components are sent to an LED strip
- LedStripType
Types of supported LED strips
- 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
- SpindleType
Spindle type
- 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