Class EcoDriveModule
Represents a LisRT module for a JAT ECO drive (ECOVARIO, ECOCOMPACT, ECOMODUL, and ECOSTEP), with serial communication.
Inheritance
Implements
Inherited Members
Namespace: Loehnert.Lisrt.Drive.Jat
Assembly: Loehnert.Lisrt.Drive.Jat.dll
Syntax
public class EcoDriveModule : InitializableCompositeModule, ICompositeModule, ILisrtModule, IInitializable, INotifyPropertyChangedEx, INotifyPropertyChanged, IPositioningAxis, IHasServiceView
Constructors
EcoDriveModule(String, ICommunication)
Initializes a new instance of the EcoDriveModule class.
Declaration
public EcoDriveModule(string name, ICommunication communication)
Parameters
Type | Name | Description |
---|---|---|
String | name | The name of the instance. |
ICommunication | communication | The module for communication. |
Exceptions
Type | Condition |
---|---|
System.ArgumentNullException | Thrown when |
Properties
CurrentPosition
Gets the current position in PositionUnit.
Declaration
public double CurrentPosition { get; }
Property Value
Type | Description |
---|---|
Double |
DeviceId
Gets or sets the device id.
Declaration
[Configuration((byte)0, Description = "0 to 126")]
public byte DeviceId { get; set; }
Property Value
Type | Description |
---|---|
System.Byte |
Remarks
A value from 0 to 126.
Icon
Gets an icon which is representative for the module.
Declaration
public override Uri Icon { get; }
Property Value
Type | Description |
---|---|
Uri |
Overrides
MaximumPosition
Gets or sets the maximum position in PositionUnit.
Declaration
[Configuration(0, Description = "Maximum position of the axis", Unit = "position unit")]
public double MaximumPosition { get; set; }
Property Value
Type | Description |
---|---|
Double |
MinimumPosition
Gets or sets the minimum position in PositionUnit.
Declaration
[Configuration(0, Description = "Minimum position of the axis", Unit = "Position unit")]
public double MinimumPosition { get; set; }
Property Value
Type | Description |
---|---|
Double |
PositionFactor
Gets or sets the position factor. PositionFactor = increments per unit, for example 1024 = 1024 increments per mm.
Declaration
[Configuration(1, Description = "PositionFactor = increments per unit")]
public double PositionFactor { get; set; }
Property Value
Type | Description |
---|---|
Double |
PositioningTimeoutInMS
Gets or sets the maximum time in ms for positioning. Default is 10000ms.
Declaration
[Configuration(10000, Unit = "ms", Description = "Maximum time for positioning")]
public int PositioningTimeoutInMS { get; set; }
Property Value
Type | Description |
---|---|
System.Int32 |
PositioningVelocity
Gets or sets the maximum velocity for positioning in PositionUnit per second.
Declaration
[Configuration(0, Unit = "Position unit per second")]
public double PositioningVelocity { get; set; }
Property Value
Type | Description |
---|---|
Double |
PositionUnit
Gets or sets the position unit (e. g. mm).
Declaration
[Configuration("")]
public string PositionUnit { get; set; }
Property Value
Type | Description |
---|---|
String |
Methods
DisableDrive()
Disables the drive.
Declaration
public void DisableDrive()
EnableDrive()
Enables the drive.
Declaration
public void EnableDrive()
Exceptions
Type | Condition |
---|---|
System.TimeoutException | Thrown when device gets not ready to enable, drive gets not enabled or operation gets not enabled. |
Exit()
De initializes the object.
Declaration
public override void Exit()
Overrides
GoToPosition(Double, Int32)
Goes to the absolute position
.
Declaration
public void GoToPosition(double position, int timeout = -1)
Parameters
Type | Name | Description |
---|---|---|
Double | position | Set point position in PositionUnit. |
System.Int32 | timeout | Timeout for reaching position in ms. |
Remarks
When timeout
is less than 0, the PositioningTimeoutInMS is used.
Exceptions
Type | Condition |
---|---|
ArgumentOutOfRangeException | Thrown when |
System.TimeoutException | Thrown when motion was not completed in the expected time span. |
System.InvalidOperationException | Thrown when this drive is not initialized, not referenced, not enabled or an operation (GoToPosition(Double, Int32) or jog) is already running. |
Initialize()
Initializes the module.
Declaration
public override void Initialize()
Overrides
Exceptions
Type | Condition |
---|---|
System.InvalidOperationException | Thrown when hardware is not enabled. |
ResetFault()
Resets the fault state of the device.
Declaration
public void ResetFault()
ShowServiceView()
Shows the service window.
Declaration
public void ShowServiceView()
StartNegativeJog()
Starts negative jog.
Declaration
public void StartNegativeJog()
Exceptions
Type | Condition |
---|---|
System.InvalidOperationException | Thrown when jog is already started. |
StartPositiveJog()
Starts positive jog.
Declaration
public void StartPositiveJog()
Exceptions
Type | Condition |
---|---|
System.InvalidOperationException | Thrown when jog is already started, or an other operation (GoToPosition(Double, Int32)) is already running. |
StopJog()
Stops jog.
Declaration
public void StopJog()