Class Axis
Information about a configured axis
Implements
System.ICloneable
System.ComponentModel.INotifyPropertyChanging
System.ComponentModel.INotifyPropertyChanged
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.Machine
Assembly: DuetAPI.dll
Syntax
public sealed class Axis : ModelObject, ICloneable, INotifyPropertyChanging, INotifyPropertyChanged
Fields
Letters
List of supported axis letters
Declaration
public static readonly char[] Letters
Field Value
Type | Description |
---|---|
System.Char[] |
Properties
Acceleration
Acceleration of this axis (in mm/s^2)
Declaration
public float Acceleration { get; set; }
Property Value
Type | Description |
---|---|
System.Single |
Babystep
Babystep amount (in mm)
Declaration
public float Babystep { get; set; }
Property Value
Type | Description |
---|---|
System.Single |
Current
Motor current (in mA)
Declaration
public int Current { get; set; }
Property Value
Type | Description |
---|---|
System.Int32 |
Drivers
List of the assigned drivers
Declaration
public ModelCollection<string> Drivers { get; }
Property Value
Type | Description |
---|---|
ModelCollection<System.String> |
Homed
Whether or not the axis is homed
Declaration
public bool Homed { get; set; }
Property Value
Type | Description |
---|---|
System.Boolean |
Jerk
Motor jerk (in mm/s)
Declaration
public float Jerk { get; set; }
Property Value
Type | Description |
---|---|
System.Single |
Letter
Letter of the axis (always upper-case)
Declaration
public char Letter { get; set; }
Property Value
Type | Description |
---|---|
System.Char |
MachinePosition
Current machine position (in mm) or null if unknown/unset
Declaration
public float? MachinePosition { get; set; }
Property Value
Type | Description |
---|---|
System.Nullable<System.Single> |
Max
Maximum travel of this axis (in mm)
Declaration
public float Max { get; set; }
Property Value
Type | Description |
---|---|
System.Single |
MaxProbed
Whether the axis maximum was probed
Declaration
public bool MaxProbed { get; set; }
Property Value
Type | Description |
---|---|
System.Boolean |
Microstepping
Microstepping configuration
Declaration
public Microstepping Microstepping { get; }
Property Value
Type | Description |
---|---|
Microstepping |
Min
Minimum travel of this axis (in mm)
Declaration
public float Min { get; set; }
Property Value
Type | Description |
---|---|
System.Single |
MinProbed
Whether the axis minimum was probed
Declaration
public bool MinProbed { get; set; }
Property Value
Type | Description |
---|---|
System.Boolean |
Speed
Maximum speed (in mm/s)
Declaration
public float Speed { get; set; }
Property Value
Type | Description |
---|---|
System.Single |
StepsPerMm
Number of microsteps per mm
Declaration
public float StepsPerMm { get; set; }
Property Value
Type | Description |
---|---|
System.Single |
UserPosition
Current user position (in mm) or null if unknown
Declaration
public float? UserPosition { get; set; }
Property Value
Type | Description |
---|---|
System.Nullable<System.Single> |
Visible
Whether or not the axis is visible
Declaration
public bool Visible { get; set; }
Property Value
Type | Description |
---|---|
System.Boolean |
WorkplaceOffsets
Offsets of this axis for each workplace (in mm)
Declaration
public ModelCollection<float> WorkplaceOffsets { get; }
Property Value
Type | Description |
---|---|
ModelCollection<System.Single> |
Implements
System.ICloneable
System.ComponentModel.INotifyPropertyChanging
System.ComponentModel.INotifyPropertyChanged