Class Axis

Namespace

DuetAPI.ObjectModel

Assembly

DuetAPI.dll

Information about a configured axis

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

Inheritance

object

ModelObject

Axis

Implements

INotifyPropertyChanging

IStaticModelObject

IModelObject

ICloneable

INotifyPropertyChanged

Inherited Members

ModelObject.SetPropertyValue<T>(ref T, T, string)

ModelObject.PropertyChanging

ModelObject.PropertyChanged

object.GetType()

object.MemberwiseClone()

object.ToString()

object.Equals(object)

object.Equals(object, object)

object.ReferenceEquals(object, object)

object.GetHashCode()

Constructors

Axis()

public Axis()

Fields

Letters

List of supported axis letters

public static readonly char[] Letters

Field Value

char[]

Properties

Acceleration

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

public float Acceleration { get; set; }

Property Value

float

Babystep

Babystep amount (in mm)

public float Babystep { get; set; }

Property Value

float

Backlash

Configured backlash of this axis (in mm)

public float Backlash { get; set; }

Property Value

float

Current

Motor current (in mA)

public int Current { get; set; }

Property Value

int

Drivers

List of the assigned drivers

public ObservableCollection<DriverId> Drivers { get; }

Property Value

ObservableCollection<DriverId>

Homed

Whether or not the axis is homed

public bool Homed { get; set; }

Property Value

bool

Jerk

Motor jerk (in mm/min)

public float Jerk { get; set; }

Property Value

float

Letter

Letter of this axis

public char Letter { get; set; }

Property Value

char

MachinePosition

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

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

Property Value

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)

public float Max { get; set; }

Property Value

float

MaxProbed

Whether the axis maximum was probed

public bool MaxProbed { get; set; }

Property Value

bool

Microstepping

Microstepping configuration

public Microstepping Microstepping { get; }

Property Value

Microstepping

Min

Minimum travel of this axis (in mm)

public float Min { get; set; }

Property Value

float

MinProbed

Whether the axis minimum was probed

public bool MinProbed { get; set; }

Property Value

bool

PercentCurrent

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

public int PercentCurrent { get; set; }

Property Value

int

PercentStstCurrent

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

public int? PercentStstCurrent { get; set; }

Property Value

int?

PhaseStep

Whether or not the axis is currently using phase stepping

public bool? PhaseStep { get; set; }

Property Value

bool?

PrintingJerk

Motor jerk during the current print only (in mm/s)

public float PrintingJerk { get; set; }

Property Value

float

ReducedAcceleration

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

public float ReducedAcceleration { get; set; }

Property Value

float

Speed

Maximum speed (in mm/min)

public float Speed { get; set; }

Property Value

float

StepPos

Current step position of the axis (in steps)

[Live]
public int StepPos { get; set; }

Property Value

int

StepsPerMm

Number of microsteps per mm

public float StepsPerMm { get; set; }

Property Value

float

UserPosition

Current user position (in mm) or null if unknown

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

Property Value

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

public bool Visible { get; set; }

Property Value

bool

WorkplaceOffsets

Offsets of this axis for each workplace (in mm)

public ObservableCollection<float> WorkplaceOffsets { get; }

Property Value

ObservableCollection<float>

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