Class Tool

Information about a configured tool

Inheritance
object
ModelObject
Tool
Implements
Inherited Members
Namespace: DuetAPI.ObjectModel
Assembly: DuetAPI.dll
Syntax
public sealed class Tool : ModelObject, IModelObject, ICloneable, INotifyPropertyChanged, INotifyPropertyChanging

Properties

Active

Active temperatures of the associated heaters (in C)

Declaration
public ModelCollection<float> Active { get; }
Property Value
Type Description
ModelCollection<float>

Axes

Associated axes. At present only X and Y can be mapped per tool.

Declaration
public ModelCollection<int[]> Axes { get; }
Property Value
Type Description
ModelCollection<int[]>
Remarks

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. Each item is a bitmap represented as an array

Extruders

Extruder drives of this tool

Declaration
public ModelCollection<int> Extruders { get; }
Property Value
Type Description
ModelCollection<int>

Fans

List of associated fans (indices)

Declaration
public ModelCollection<int> Fans { get; }
Property Value
Type Description
ModelCollection<int>
Remarks

This is a bitmap represented as an array

FeedForward

Feedforward coefficients to apply to the mapped heaters during extrusions

Declaration
public ModelCollection<float> FeedForward { get; }
Property Value
Type Description
ModelCollection<float>

FilamentExtruder

Extruder drive index for resolving the tool filament (index or -1)

Declaration
public int FilamentExtruder { get; set; }
Property Value
Type Description
int

Heaters

List of associated heaters (indices)

Declaration
public ModelCollection<int> Heaters { get; }
Property Value
Type Description
ModelCollection<int>

IsRetracted

True if the filament has been firmware-retracted

Declaration
public bool IsRetracted { get; set; }
Property Value
Type Description
bool

Mix

Mix ratios of the associated extruder drives

Declaration
public ModelCollection<float> Mix { get; }
Property Value
Type Description
ModelCollection<float>

Name

Name of this tool

Declaration
public string Name { get; set; }
Property Value
Type Description
string

Number

Number of this tool

Declaration
public int Number { get; set; }
Property Value
Type Description
int

Offsets

Axis offsets (in mm) This list is in the same order as Axes

Declaration
public ModelCollection<float> Offsets { get; }
Property Value
Type Description
ModelCollection<float>
See Also

OffsetsProbed

Bitmap of the probed axis offsets

Declaration
public int OffsetsProbed { get; set; }
Property Value
Type Description
int

Retraction

Firmware retraction parameters

Declaration
public ToolRetraction Retraction { get; }
Property Value
Type Description
ToolRetraction

Spindle

Index of the mapped spindle or -1 if not mapped

Declaration
public int Spindle { get; set; }
Property Value
Type Description
int

SpindleRpm

RPM of the mapped spindle

Declaration
public int SpindleRpm { get; set; }
Property Value
Type Description
int

Standby

Standby temperatures of the associated heaters (in C)

Declaration
public ModelCollection<float> Standby { get; }
Property Value
Type Description
ModelCollection<float>

State

Current state of this tool

Declaration
public ToolState State { get; set; }
Property Value
Type Description
ToolState

Implements