Table of Contents

Class AxisModule

Namespace
Loehnert.Lisrt.AutomationController
Assembly
Loehnert.Lisrt.AutomationController.dll

Represents an axis module.

public class AxisModule : PropertyChangedBase, ILisrtModule, IHasServiceView, IInitializable, INotifyPropertyChangedEx, INotifyPropertyChanged, IHasDeviceLabel
Inheritance
PropertyChangedBase
AxisModule
Implements
INotifyPropertyChangedEx
Inherited Members
PropertyChangedBase.Refresh()
PropertyChangedBase.IsNotifying
PropertyChangedBase.PropertyChanged

Properties

ClockwiseLimitSwitchType

Gets or sets the clockwise limit switch type.

[Configuration(LimitSwitchType.None, Description = "Configures the clockwise limit switch type.")]
public LimitSwitchType ClockwiseLimitSwitchType { get; set; }

Property Value

LimitSwitchType

CounterclockwiseLimitSwitchType

Gets or sets the counter clockwise limit switch type.

[Configuration(LimitSwitchType.None, Description = "Configures the counter clockwise limit switch type.")]
public LimitSwitchType CounterclockwiseLimitSwitchType { get; set; }

Property Value

LimitSwitchType

CurrentCurrent

Gets the actual current of the DC drive.

public float CurrentCurrent { get; }

Property Value

float

CurrentStep

Gets the current step of the axis state machine.

public int CurrentStep { get; }

Property Value

int

DelayTimeWhenLimitSwitchIsReached

Gets or sets the delay time in milliseconds after which the drive is switched off after reaching the limit switch.

[Configuration(0, Unit = "ms")]
public int DelayTimeWhenLimitSwitchIsReached { get; set; }

Property Value

int

DeviceLabel

Gets or sets the label for the device.

[Configuration("")]
public string DeviceLabel { get; set; }

Property Value

string

DriveIsEnabled

Gets a value indicating whether the drive is enabled.

public bool DriveIsEnabled { get; }

Property Value

bool

Enabled

Gets or sets a value indicating whether the module is enabled.

[Configuration(false)]
public bool Enabled { get; set; }

Property Value

bool

HasError

Gets a value indicating whether the axis has an error.

public bool HasError { get; }

Property Value

bool

Icon

Gets the icon from the module.

public Uri Icon { get; }

Property Value

Uri

InitializationState

Gets a value indicating whether the object is initialized.

public InitializationState InitializationState { get; }

Property Value

InitializationState

InstanceID

Gets or sets the ID for this instance.

public int InstanceID { get; set; }

Property Value

int

IsInBasePosition

Gets a value indicating whether the axis is in base position.

public bool IsInBasePosition { get; }

Property Value

bool

IsInMiddlePosition

Gets a value indicating whether the axis is in middle position.

public bool IsInMiddlePosition { get; }

Property Value

bool

IsInWorkPosition

Gets a value indicating whether the axis is in work position.

public bool IsInWorkPosition { get; }

Property Value

bool

IsReady

Gets a value indicating whether the axis is ready for an operation.

public bool IsReady { get; }

Property Value

bool

MiddlePositionInput

Gets or sets the input for middle position reached switch. Set to -1 for disabling the middle position.

[Configuration(-1, Description = "Configures the input for the middle position reached switch. Set to -1 for disabling the mid position.")]
public int MiddlePositionInput { get; set; }

Property Value

int

MiddlePositionReachedSwitchType

Gets or sets the middle reached switch type.

[Configuration(LimitSwitchType.None, Description = "Configures the middle limit switch type.")]
public LimitSwitchType MiddlePositionReachedSwitchType { get; set; }

Property Value

LimitSwitchType

MotionTimeOutInMS

Gets or sets the motion timeout time in milliseconds.

[Configuration(10000, Unit = "ms")]
public int MotionTimeOutInMS { get; set; }

Property Value

int

Name

Gets or sets the name.

public string Name { get; set; }

Property Value

string

Parent

Gets or sets the parent module.

public ILisrtModule Parent { get; set; }

Property Value

ILisrtModule

PwmDutyCycle

Gets or sets the PWM duty cycle in percent.

[Configuration(50, Unit = "%")]
public int PwmDutyCycle { get; set; }

Property Value

int

PwmDutyCycleWhenLimitSwitchIsReached

Gets or sets the duty cycle in percent after reaching the limit switch.

[Configuration(0, Unit = "%")]
public int PwmDutyCycleWhenLimitSwitchIsReached { get; set; }

Property Value

int

PwmFrequency

Gets or sets the PWM frequency in hertz.

[Configuration(8000, Unit = "Hz")]
public int PwmFrequency { get; set; }

Property Value

int

SafetyCircuitType

Gets or sets the safety circuit type.

[Configuration(SafetyCircuit.ProtectionDoor, Description = "Configures the type of circuit used for this drive")]
public SafetyCircuit SafetyCircuitType { get; set; }

Property Value

SafetyCircuit

SafetyIsReleased

Gets a value indicating whether the safety circuit is released.

public bool SafetyIsReleased { get; }

Property Value

bool

StartRampTimeInMs

Gets or sets the start ramp up time in ms.

[Configuration(0, Unit = "ms")]
public int StartRampTimeInMs { get; set; }

Property Value

int

TreeItem

Gets the view model for the module.

public ITreeItem TreeItem { get; }

Property Value

ITreeItem

Methods

Exit()

De initializes the object.

public void Exit()

GoToBasePosition()

Goes to base position.

public void GoToBasePosition()

Exceptions

TimeoutException

Throw if going to position takes longer than MotionTimeOutInMS.

GoToMiddlePosition()

Goes to middle position.

public void GoToMiddlePosition()

Exceptions

TimeoutException

Throw if going to position takes longer than MotionTimeOutInMS.

GoToWorkPosition()

Goes to work position.

public void GoToWorkPosition()

Exceptions

TimeoutException

Throw if going to position takes longer than MotionTimeOutInMS.

Initialize()

Initializes the object.

public void Initialize()

Exceptions

InvalidOperationException

Thrown when the AutomationController is not initialized
-or- the axis is enabled and the AutomationController is disabled.

ShowServiceView()

Shows the service window.

public void ShowServiceView()