Class Probe

Information about a configured probe

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

Properties

CalibA

Linear coefficient for scanning probes

Declaration
public float? CalibA { get; set; }
Property Value
Type Description
float?

CalibB

Quadratic coefficient for scanning probes

Declaration
public float? CalibB { get; set; }
Property Value
Type Description
float?

CalibrationTemperature

Calibration temperature (in C)

Declaration
public float CalibrationTemperature { get; set; }
Property Value
Type Description
float

DeployedByUser

Indicates if the user has deployed the probe

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

DisablesHeaters

Whether probing disables the heater(s)

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

DiveHeight

Dive height (in mm)

Declaration
[Obsolete("Use DiveHeights[0] instead")]
public float DiveHeight { get; set; }
Property Value
Type Description
float

DiveHeights

Dive heights of the probe. The first element is the regular dive height, the second element may be used by scanning Z-probes

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

IsCalibrated

Indicates if the scanning probe is calibrated

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

LastStopHeight

Height of the probe where it stopped last time (in mm)

Declaration
public float LastStopHeight { get; set; }
Property Value
Type Description
float

MaxProbeCount

Maximum number of times to probe after a bad reading was determined

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

MeasuredHeight

Measured height (only applicable for scanning probes, in mm or null)

Declaration
public float? MeasuredHeight { get; set; }
Property Value
Type Description
float?

Offsets

X+Y offsets (in mm)

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

RecoveryTime

Recovery time (in s)

Declaration
public float RecoveryTime { get; set; }
Property Value
Type Description
float

ScanCoefficients

Coefficients for the scanning Z-probe (4 elements, if applicable)

Declaration
public ModelCollection<float>? ScanCoefficients { get; set; }
Property Value
Type Description
ModelCollection<float>

Speeds

Fast and slow probing speeds (in mm/s). Scanning probes may have three speeds where the last one is the movement speed while probing heightmaps

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

TemperatureCoefficients

List of temperature coefficients

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

Threshold

Configured trigger threshold (0..1023)

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

Tolerance

Allowed tolerance deviation between two measures (in mm)

Declaration
public float Tolerance { get; set; }
Property Value
Type Description
float

TravelSpeed

Travel speed when probing multiple points (in mm/min)

Declaration
public float TravelSpeed { get; set; }
Property Value
Type Description
float

TriggerHeight

Z height at which the probe is triggered (in mm)

Declaration
public float TriggerHeight { get; set; }
Property Value
Type Description
float

Type

Type of the configured probe

Declaration
public ProbeType Type { get; set; }
Property Value
Type Description
ProbeType
See Also

Value

Current analog values of the probe

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

Implements