• DuetAPI
  • DuetAPIClient
  • DuetControlServer
  • DuetWebServer
Show / Hide Table of Contents
  • DuetAPI
    • CodeChannel
  • DuetAPI.Commands
    • Acknowledge
    • AddHttpEndpoint
    • AddUserSession
    • BaseCommand
    • BaseResponse
    • Cancel
    • Code
    • CodeFlags
    • CodeParameter
    • CodeParameterConverter
    • CodeParserBuffer
    • CodeParserException
    • CodeResult
    • CodeType
    • Command
    • Command<T>
    • ErrorResponse
    • EvaluateExpression
    • Flush
    • GetFileInfo
    • GetMachineModel
    • HttpResponseType
    • Ignore
    • KeywordType
    • LockMachineModel
    • PatchMachineModel
    • ReceivedHttpRequest
    • RemoveHttpEndpoint
    • RemoveUserSession
    • Resolve
    • ResolvePath
    • Response<T>
    • SendHttpResponse
    • SetMachineModel
    • SimpleCode
    • SyncMachineModel
    • UnlockMachineModel
    • WriteMessage
  • DuetAPI.Connection
    • ConnectionMode
    • Defaults
    • IncompatibleVersionException
    • InterceptionMode
    • SubscriptionMode
  • DuetAPI.Connection.InitMessages
    • ClientInitMessage
    • CommandInitMessage
    • InterceptInitMessage
    • ServerInitMessage
    • SubscribeInitMessage
  • DuetAPI.Machine
    • AccessLevel
    • AnalogSensor
    • AnalogSensorType
    • AnalogSensorTypeConverter
    • Axis
    • BeepRequest
    • Board
    • BoardState
    • Build
    • BuildObject
    • Compatibility
    • CoreKinematics
    • CurrentMove
    • DAA
    • DeltaKinematics
    • DeltaTower
    • Directories
    • DistanceUnit
    • Endstop
    • EndstopType
    • Extruder
    • ExtruderNonlinear
    • Fan
    • FanThermostaticControl
    • FilamentMonitor
    • FilamentMonitorType
    • GpInputPort
    • GpOutputPort
    • HangprinterKinematics
    • Heat
    • Heater
    • HeaterModel
    • HeaterModelPID
    • HeaterMonitor
    • HeaterMonitorAction
    • HeaterMonitorCondition
    • HeaterState
    • HttpEndpoint
    • HttpEndpointType
    • InputChannel
    • InputChannelState
    • Inputs
    • InterfaceType
    • Job
    • Kinematics
    • KinematicsName
    • KinematicsNameConverter
    • LaserFilamentMonitor
    • LaserFilamentMonitorCalibrated
    • LaserFilamentMonitorConfigured
    • Layer
    • Limits
    • LinuxPropertyAttribute
    • MachineMode
    • MachineModel
    • MachineModelConverter
    • MachineStatus
    • Message
    • MessageBox
    • MessageBoxMode
    • MessageType
    • Microstepping
    • MinMaxCurrent<T>
    • ModelCollection
    • ModelCollection<T>
    • ModelGrowingCollection
    • ModelGrowingCollection<T>
    • ModelObject
    • MotorsIdleControl
    • Move
    • MoveCalibration
    • MoveCompensation
    • MoveCompensationType
    • MoveDeviations
    • Network
    • NetworkInterface
    • NetworkProtocol
    • ParsedFileInfo
    • Probe
    • ProbeGrid
    • ProbeType
    • PulsedFilamentMonitor
    • PulsedFilamentMonitorCalibrated
    • PulsedFilamentMonitorConfigured
    • RestorePoint
    • RotatingMagnetFilamentMonitor
    • RotatingMagnetFilamentMonitorCalibrated
    • RotatingMagnetFilamentMonitorConfigured
    • Scanner
    • ScannerStatus
    • ScaraKinematics
    • Sensors
    • SessionType
    • SimpleFilamentMonitor
    • Skew
    • Spindle
    • State
    • TiltCorrection
    • TimesLeft
    • Tool
    • ToolRetraction
    • ToolState
    • UserSession
    • UserVariable
    • Volume
    • ZLeadscrewKinematics
  • DuetAPI.Utility
    • DriverId
    • FileLists
    • Heightmap
    • JsonCamelCaseStringEnumConverter
    • JsonCharEnumConverter
    • JsonHelper
    • JsonLowerCaseStringEnumConverter
    • JsonPolymorphicWriteOnlyConverter<T>
    • JsonRegexListConverter
  • DuetAPIClient
    • BaseCommandConnection
    • BaseConnection
    • CommandConnection
    • HttpEndpointConnection
    • HttpEndpointUnixSocket
    • HttpEndpointUnixSocket.EndpointRequestReceived
    • InterceptConnection
    • InternalServerException
    • SubscribeConnection
  • DuetControlServer
    • Program
    • Settings
  • DuetControlServer.Codes
    • GCodes
    • MCodes
    • TCodes
  • DuetControlServer.Commands
    • AddHttpEndpoint
    • AddUserSession
    • Code
    • EvaluateExpression
    • Flush
    • GetFileInfo
    • GetMachineModel
    • LockMachineModel
    • RemoveHttpEndpoint
    • RemoveUserSession
    • ResolvePath
    • SetMachineModel
    • SimpleCode
    • SyncMachineModel
    • UnlockMachineModel
    • WriteMessage
  • DuetControlServer.FileExecution
    • Job
    • Macro
  • DuetControlServer.Files
    • CodeBlock
    • CodeFile
    • ConfigOverride
    • FileDirectory
    • FilePath
    • InfoParser
  • DuetControlServer.IPC
    • Connection
    • LockManager
    • Server
  • DuetControlServer.IPC.Processors
    • Base
    • Command
    • Interception
    • Subscription
  • DuetControlServer.Model
    • Expressions
    • Filter
    • ItemPathNode
    • Observer
    • Observer.PropertyPathChanged
    • PeriodicUpdater
    • PropertyChangeType
    • Provider
    • Updater
  • DuetControlServer.SPI
    • DataTransfer
    • EvaluateExpressionRequest
    • Interface
  • DuetControlServer.SPI.Channel
    • LockRequest
    • Manager
    • Processor
    • State
  • DuetControlServer.SPI.Communication
    • Consts
  • DuetControlServer.SPI.Communication.FirmwareRequests
    • AbortFileHeader
    • CodeBufferUpdateHeader
    • DoCodeHeader
    • EvaluationResultHeader
    • ExecuteMacroHeader
    • FileChunkHeader
    • PrintPausedHeader
    • PrintPausedReason
    • Request
  • DuetControlServer.SPI.Communication.LinuxRequests
    • AssignFilamentHeader
    • CodeFlags
    • CodeHeader
    • CodeParameter
    • FileChunk
    • GetObjectModelHeader
    • MacroCompleteHeader
    • PrintStartedHeader
    • PrintStoppedHeader
    • Request
    • SetObjectModelHeader
  • DuetControlServer.SPI.Communication.Shared
    • CodeChannelHeader
    • DataType
    • HeightMapHeader
    • MessageHeader
    • MessageTypeFlags
    • PacketHeader
    • PrintStoppedReason
    • StringHeader
    • TransferHeader
    • TransferResponse
  • DuetControlServer.SPI.Serialization
    • Reader
    • Writer
  • DuetControlServer.Utility
    • CRC16
    • FilamentManager
    • Logger
  • DuetWebServer
    • Program
    • Startup
  • DuetWebServer.Controllers
    • MachineController
    • WebSocketController
  • DuetWebServer.FileProviders
    • DuetFileProvider
  • DuetWebServer.Middleware
    • CustomEndpointMiddleware
    • FallbackMiddleware
    • HttpEndpointConnection
  • DuetWebServer.Services
    • ModelObserver
    • ModelObserver.WebDirectoryChanged

Namespace DuetAPI.Machine

Classes

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

Build

Information about the current build

BuildObject

Information about a detected build object

CoreKinematics

Information about core kinematics

CurrentMove

Information about the current move

DAA

Information about dynamic acceleration adjustment

DeltaKinematics

Delta kinematics

DeltaTower

Delta tower properties

Directories

Information about the configured directories

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

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

InputChannel

Information about a G/M/T-code channel

Inputs

List holding information about the available G/M/T-code channels

Job

Information about the current job

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

Limits

Machine configuration limits

LinuxPropertyAttribute

Attribute used to mark properties that are overridden by the control server

MachineModel

Representation of the full machine model as maintained by DCS

MachineModelConverter

Class used to convert machine models to and from JSON

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

Helper class to keep track of individual model collection subtypes

ModelCollection<T>

Generic container for object model arrays

ModelGrowingCollection

Helper class to keep track of individual model collection subtypes

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

Network

Information about the network subsystem

NetworkInterface

Information about a network interface

ParsedFileInfo

Holds information about a parsed G-code file

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

Scanner

Information about the 3D scanner subsystem

ScaraKinematics

Kinematics class for SCARA kinematics

Sensors

Information about sensors

SimpleFilamentMonitor

Representation of a simple filament monitor

Skew

Class holding details about orthogonoal axis compensation parameters

Spindle

Information about a CNC spindle

State

Information about the machine state

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

UserVariable

Class holding information about a user variable

Volume

Information about a storage device

ZLeadscrewKinematics

Base kinematics class that provides the ability to level the bed using Z leadscrews

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

DistanceUnit

Distance unit used for positioning

EndstopType

Type of a configured endstop

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

InterfaceType

Supported types of network interfaces

KinematicsName

Enumeration of supported kinematics

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

NetworkProtocol

Supported network protocols

ProbeType

Supported probe types

ScannerStatus

Possible states of the attached 3D scanner

SessionType

Types of user sessions

ToolState

States of a tool

Back to top Generated by DocFX