Class EcoDriveModule

Namespace

Loehnert.Lisrt.Drive.Jat

Assembly

Loehnert.Lisrt.Drive.Jat.dll

Represents a LisRT module for a JAT ECO drive (ECOVARIO, ECOCOMPACT, ECOMODUL, and ECOSTEP), with serial communication.

public class EcoDriveModule : InitializableCompositeModule, ICompositeModule, ILisrtModule, IInitializable, INotifyPropertyChangedEx, INotifyPropertyChanged, IPositioningAxis, IHasServiceView

Inheritance

object

PropertyChangedBase

LisrtModule

CompositeModule

InitializableCompositeModule

EcoDriveModule

Implements

ICompositeModule

ILisrtModule

IInitializable

INotifyPropertyChangedEx

INotifyPropertyChanged

IPositioningAxis

IHasServiceView

Inherited Members

InitializableCompositeModule.InitializeSubModules()

InitializableCompositeModule.InitializationState

CompositeModule.SubModules

LisrtModule.ToString()

LisrtModule.Name

LisrtModule.Enabled

LisrtModule.TreeItem

LisrtModule.Parent

PropertyChangedBase.Refresh()

PropertyChangedBase.NotifyOfPropertyChange(string)

PropertyChangedBase.NotifyOfPropertyChange<TProperty>(Expression<Func<TProperty>>)

PropertyChangedBase.OnUIThread(Action)

PropertyChangedBase.Set<T>(ref T, T, string)

PropertyChangedBase.IsNotifying

PropertyChangedBase.PropertyChanged

object.Equals(object)

object.Equals(object, object)

object.ReferenceEquals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

Constructors

EcoDriveModule(string, ICommunication)

Initializes a new instance of the EcoDriveModule class.

public EcoDriveModule(string name, ICommunication communication)

Parameters

name string

The name of the instance.

communication ICommunication

The module for communication.

Exceptions

ArgumentNullException

Thrown when name is null or empty or communication is null.

Properties

CurrentPosition

Gets the current position in PositionUnit.

public double CurrentPosition { get; }

Property Value

double

DeviceId

Gets or sets the device id.

[Configuration(0, Description = "0 to 126")]
public byte DeviceId { get; set; }

Property Value

byte

Remarks

A value from 0 to 126.

Icon

Gets an icon which is representative for the module.

public override Uri Icon { get; }

Property Value

Uri

MaximumPosition

Gets or sets the maximum position in PositionUnit.

[Configuration(0, Description = "Maximum position of the axis", Unit = "position unit")]
public double MaximumPosition { get; set; }

Property Value

double

MinimumPosition

Gets or sets the minimum position in PositionUnit.

[Configuration(0, Description = "Minimum position of the axis", Unit = "Position unit")]
public double MinimumPosition { get; set; }

Property Value

double

PositionFactor

Gets or sets the position factor. PositionFactor = increments per unit, for example 1024 = 1024 increments per mm.

[Configuration(1, Description = "PositionFactor = increments per unit")]
public double PositionFactor { get; set; }

Property Value

double

PositionUnit

Gets or sets the position unit (e. g. mm).

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

Property Value

string

PositioningTimeoutInMS

Gets or sets the maximum time in ms for positioning. Default is 10000ms.

[Configuration(10000, Unit = "ms", Description = "Maximum time for positioning")]
public int PositioningTimeoutInMS { get; set; }

Property Value

int

PositioningVelocity

Gets or sets the maximum velocity for positioning in PositionUnit per second.

[Configuration(0, Unit = "Position unit per second")]
public double PositioningVelocity { get; set; }

Property Value

double

Methods

DisableDrive()

Disables the drive.

public void DisableDrive()

EnableDrive()

Enables the drive.

public void EnableDrive()

Exceptions

TimeoutException

Thrown when device gets not ready to enable, drive gets not enabled or operation gets not enabled.

Exit()

De initializes the object.

public override void Exit()

GoToPosition(double, int)

Goes to the absolute position.

public void GoToPosition(double position, int timeout = -1)

Parameters

position double

Set point position in PositionUnit.

timeout int

Timeout for reaching position in ms.

Remarks

When timeout is less than 0, the PositioningTimeoutInMS is used.

Exceptions

ArgumentOutOfRangeException

Thrown when position is not between MinimumPosition and MaximumPosition.

TimeoutException

Thrown when motion was not completed in the expected time span.

InvalidOperationException

Thrown when this drive is not initialized, not referenced, not enabled or an operation (GoToPosition(double, int) or jog) is already running.

Initialize()

Initializes the module.

public override void Initialize()

Exceptions

InvalidOperationException

Thrown when hardware is not enabled.

ResetFault()

Resets the fault state of the device.

public void ResetFault()

ShowServiceView()

Shows the service window.

public void ShowServiceView()

StartNegativeJog()

Starts negative jog.

public void StartNegativeJog()

Exceptions

InvalidOperationException

Thrown when jog is already started.

StartPositiveJog()

Starts positive jog.

public void StartPositiveJog()

Exceptions

InvalidOperationException

Thrown when jog is already started, or an other operation (GoToPosition(double, int)) is already running.

StopJog()

Stops jog.

public void StopJog()