Table of Contents

Class Probe

Namespace
DuetAPI.ObjectModel
Assembly
DuetAPI.dll

Information about a configured probe

public class Probe : ModelObject, INotifyPropertyChanging, IStaticModelObject, IModelObject, ICloneable, INotifyPropertyChanged
Inheritance
Probe
Implements
Inherited Members

Constructors

Probe() 

public Probe()

Properties

CalibA

Linear coefficient for scanning probes

public float? CalibA { get; set; }

Property Value

float?

CalibB

Quadratic coefficient for scanning probes

public float? CalibB { get; set; }

Property Value

float?

CalibrationTemperature

Calibration temperature (in C)

public float CalibrationTemperature { get; set; }

Property Value

float

DeployedByUser

Indicates if the user has deployed the probe

public bool DeployedByUser { get; set; }

Property Value

bool

DisablesHeaters

Whether probing disables the heater(s)

public bool DisablesHeaters { get; set; }

Property Value

bool

DiveHeight

Dive height of the probe (in mm)

[Obsolete("Use DiveHeights instead")]
public float DiveHeight { get; set; }

Property Value

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

public ObservableCollection<float> DiveHeights { get; }

Property Value

ObservableCollection<float>

IsCalibrated

Indicates if the scanning probe is calibrated

public bool? IsCalibrated { get; set; }

Property Value

bool?

LastStopHeight

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

public float LastStopHeight { get; set; }

Property Value

float

MaxProbeCount

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

public int MaxProbeCount { get; set; }

Property Value

int

MeasuredHeight

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

[Live]
public float? MeasuredHeight { get; set; }

Property Value

float?

Offsets

X+Y offsets (in mm)

public ObservableCollection<float> Offsets { get; }

Property Value

ObservableCollection<float>

RecoveryTime

Recovery time (in s)

public float RecoveryTime { get; set; }

Property Value

float

ScanCoefficients

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

public ObservableCollection<float>? ScanCoefficients { get; set; }

Property Value

ObservableCollection<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

public ObservableCollection<float> Speeds { get; }

Property Value

ObservableCollection<float>

TemperatureCoefficients

List of temperature coefficients

public ObservableCollection<float> TemperatureCoefficients { get; }

Property Value

ObservableCollection<float>

Threshold

Configured trigger threshold (0..1023)

public int Threshold { get; set; }

Property Value

int

Tolerance

Allowed tolerance deviation between two measures (in mm)

public float Tolerance { get; set; }

Property Value

float

TouchMode

Touch mode options (if supported, otherwise null)

public ProbeTouchMode? TouchMode { get; set; }

Property Value

ProbeTouchMode

TravelSpeed

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

public float TravelSpeed { get; set; }

Property Value

float

TriggerHeight

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

public float TriggerHeight { get; set; }

Property Value

float

Type

Type of the configured probe

public ProbeType Type { get; set; }

Property Value

ProbeType
See Also

Value

Current analog values of the probe

[Live]
public ObservableCollection<int> Value { get; }

Property Value

ObservableCollection<int>

Methods

Assign(IStaticModelObject)

Assign the properties from another instance. This is required to update model properties which do not have a setter

public void Assign(IStaticModelObject from)

Parameters

from IStaticModelObject

Other instance

Clone()

Clone this instance

public object Clone()

Returns

object

Cloned instance

Remarks

This method is auto-generated

UpdateFromJson(JsonElement, bool)

Update this instance from a given JSON element

public void UpdateFromJson(JsonElement jsonElement, bool ignoreSbcProperties)

Parameters

jsonElement JsonElement

Element to update this intance from

ignoreSbcProperties bool

Whether SBC properties are ignored

Remarks

This method is auto-generated

Exceptions

JsonException

Failed to deserialize data

UpdateFromJsonReader(ref Utf8JsonReader, bool)

Update this instance from a given JSON element

public void UpdateFromJsonReader(ref Utf8JsonReader reader, bool ignoreSbcProperties)

Parameters

reader Utf8JsonReader

Reader to update this intance from

ignoreSbcProperties bool

Whether SBC properties are ignored

Remarks

This method is auto-generated

Exceptions

JsonException

Failed to deserialize data