Class Axis

Information about a configured axis

Inheritance

object

ModelObject

Axis

Implements

IModelObject

ICloneable

INotifyPropertyChanged

INotifyPropertyChanging

Inherited Members

ModelObject.PropertyChanging

ModelObject.PropertyChanged

ModelObject.JsonProperties

ModelObject.Assign(object)

ModelObject.Clone()

ModelObject.FindDifferences(IModelObject)

ModelObject.MakeUtf8Patch(ModelObject)

ModelObject.MakeStringPatch(ModelObject)

ModelObject.UpdateFromJson(JsonElement, bool)

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.ReferenceEquals(object, object)

object.ToString()

Namespace: DuetAPI.ObjectModel

Assembly: DuetAPI.dll

Syntax

public sealed class Axis : ModelObject, IModelObject, ICloneable, INotifyPropertyChanged, INotifyPropertyChanging

Fields

Letters

List of supported axis letters

Declaration

public static readonly char[] Letters

Field Value

Type	Description
char[]

Properties

Acceleration

Acceleration of this axis (in mm/s^2)

Declaration

public float Acceleration { get; set; }

Property Value

Type	Description
float

Babystep

Babystep amount (in mm)

Declaration

public float Babystep { get; set; }

Property Value

Type	Description
float

Backlash

Configured backlash of this axis (in mm)

Declaration

public float Backlash { get; set; }

Property Value

Type	Description
float

Current

Motor current (in mA)

Declaration

public int Current { get; set; }

Property Value

Type	Description
int

Drivers

List of the assigned drivers

Declaration

public ModelCollection<DriverId> Drivers { get; }

Property Value

Type	Description
ModelCollection<DriverId>

Homed

Whether or not the axis is homed

Declaration

public bool Homed { get; set; }

Property Value

Type	Description
bool

Jerk

Motor jerk (in mm/min)

Declaration

public float Jerk { get; set; }

Property Value

Type	Description
float

Letter

Letter of this axis

Declaration

public char Letter { get; set; }

Property Value

Type	Description
char

MachinePosition

Current machine position (in mm) or null if unknown/unset

Declaration

public float? MachinePosition { get; set; }

Property Value

Type	Description
float?

Remarks

This value reflects the machine position of the move being performed or of the last one if the machine is not moving

Max

Maximum travel of this axis (in mm)

Declaration

public float Max { get; set; }

Property Value

Type	Description
float

MaxProbed

Whether the axis maximum was probed

Declaration

public bool MaxProbed { get; set; }

Property Value

Type	Description
bool

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
float

MinProbed

Whether the axis minimum was probed

Declaration

public bool MinProbed { get; set; }

Property Value

Type	Description
bool

PercentCurrent

Percentage applied to the motor current (0..100)

Declaration

public int PercentCurrent { get; set; }

Property Value

Type	Description
int

PercentStstCurrent

Percentage applied to the motor current during standstill (0..100 or null if not supported)

Declaration

public int? PercentStstCurrent { get; set; }

Property Value

Type	Description
int?

ReducedAcceleration

Reduced accelerations used by Z probing and stall homing moves (in mm/s^2)

Declaration

public float ReducedAcceleration { get; set; }

Property Value

Type	Description
float

Speed

Maximum speed (in mm/min)

Declaration

public float Speed { get; set; }

Property Value

Type	Description
float

StepsPerMm

Number of microsteps per mm

Declaration

public float StepsPerMm { get; set; }

Property Value

Type	Description
float

UserPosition

Current user position (in mm) or null if unknown

Declaration

public float? UserPosition { get; set; }

Property Value

Type	Description
float?

Remarks

This value reflects the target position of the last move fed into the look-ahead buffer

Visible

Whether or not the axis is visible

Declaration

public bool Visible { get; set; }

Property Value

Type	Description
bool

WorkplaceOffsets

Offsets of this axis for each workplace (in mm)

Declaration

public ModelCollection<float> WorkplaceOffsets { get; }

Property Value

Type	Description
ModelCollection<float>

Implements

IModelObject

ICloneable

INotifyPropertyChanged

INotifyPropertyChanging