Class Probe
Information about a configured probe
Implements
System.ICloneable
System.ComponentModel.INotifyPropertyChanged
System.ComponentModel.INotifyPropertyChanging
Inherited Members
System.Object.Equals(System.Object)
System.Object.Equals(System.Object, System.Object)
System.Object.GetHashCode()
System.Object.GetType()
System.Object.MemberwiseClone()
System.Object.ReferenceEquals(System.Object, System.Object)
System.Object.ToString()
Namespace: DuetAPI.ObjectModel
Assembly: DuetAPI.dll
Syntax
public sealed class Probe : ModelObject, IModelObject, ICloneable, INotifyPropertyChanged, INotifyPropertyChanging
Properties
CalibrationTemperature
Calibration temperature (in C)
Declaration
public float CalibrationTemperature { get; set; }
Property Value
Type | Description |
---|---|
System.Single |
DeployedByUser
Indicates if the user has deployed the probe
Declaration
public bool DeployedByUser { get; set; }
Property Value
Type | Description |
---|---|
System.Boolean |
DisablesHeaters
Whether probing disables the heater(s)
Declaration
public bool DisablesHeaters { get; set; }
Property Value
Type | Description |
---|---|
System.Boolean |
DiveHeight
Dive height (in mm)
Declaration
public float DiveHeight { get; set; }
Property Value
Type | Description |
---|---|
System.Single |
LastStopHeight
Height of the probe where it stopped last time (in mm)
Declaration
public float LastStopHeight { get; set; }
Property Value
Type | Description |
---|---|
System.Single |
MaxProbeCount
Maximum number of times to probe after a bad reading was determined
Declaration
public int MaxProbeCount { get; set; }
Property Value
Type | Description |
---|---|
System.Int32 |
Offsets
X+Y offsets (in mm)
Declaration
public ModelCollection<float> Offsets { get; }
Property Value
Type | Description |
---|---|
ModelCollection<System.Single> |
RecoveryTime
Recovery time (in s)
Declaration
public float RecoveryTime { get; set; }
Property Value
Type | Description |
---|---|
System.Single |
Speed
Probe speed (in mm/s)
Declaration
[JsonIgnore]
[Obsolete("Use Speeds[0] instead")]
public float Speed { get; set; }
Property Value
Type | Description |
---|---|
System.Single |
Speeds
Fast and slow probing speeds (in mm/s)
Declaration
public ModelCollection<float> Speeds { get; }
Property Value
Type | Description |
---|---|
ModelCollection<System.Single> |
TemperatureCoefficient
First temperature coefficient
Declaration
[JsonIgnore]
[Obsolete("Use TemperatureCoefficients instead")]
public float TemperatureCoefficient { get; set; }
Property Value
Type | Description |
---|---|
System.Single |
TemperatureCoefficients
List of temperature coefficients
Declaration
public ModelCollection<float> TemperatureCoefficients { get; }
Property Value
Type | Description |
---|---|
ModelCollection<System.Single> |
Threshold
Configured trigger threshold (0..1023)
Declaration
public int Threshold { get; set; }
Property Value
Type | Description |
---|---|
System.Int32 |
Tolerance
Allowed tolerance deviation between two measures (in mm)
Declaration
public float Tolerance { get; set; }
Property Value
Type | Description |
---|---|
System.Single |
TravelSpeed
Travel speed when probing multiple points (in mm/min)
Declaration
public float TravelSpeed { get; set; }
Property Value
Type | Description |
---|---|
System.Single |
TriggerHeight
Z height at which the probe is triggered (in mm)
Declaration
public float TriggerHeight { get; set; }
Property Value
Type | Description |
---|---|
System.Single |
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<System.Int32> |
Implements
System.ICloneable
System.ComponentModel.INotifyPropertyChanged
System.ComponentModel.INotifyPropertyChanging