Click or drag to resize

IMotorItem Interface

Represents a motor hardware item

Namespace:  LynceeTec.API.Hardware
Assembly:  LynceeTec.API.Hardware (in LynceeTec.API.Hardware.dll) Version: 9.0.26418.0 , built 2021-10-22 08:54:13 UTC
Syntax
public interface IMotorItem : IHardwareItem, 
	IMovableItem

The IMotorItem type exposes the following members.

Properties
  NameDescription
Public propertyIsAvailable (Inherited from IHardwareItem.)
Public propertyIsConnected (Inherited from IHardwareItem.)
Public propertyIsEnabled (Inherited from IHardwareItem.)
Public propertyIsInitialized (Inherited from IHardwareItem.)
Public propertyMaxPosition
Maximal physical position of the movable item. (The unit is always SI and depends on the type of axis: [m] for linear axes and [rad] for rotation axes)
(Inherited from IMovableItem.)
Public propertyMinPosition
Minimal physical position of the movable item. (The unit is always SI and depends on the type of axis: [m] for linear axes and [rad] for rotation axes)
(Inherited from IMovableItem.)
Public propertyMovableItemUniqueId
The unique ID of the movable item
(Inherited from IMovableItem.)
Public propertyMovementType
The type of movement of the motor (linear or rotation)
Public propertyPositioningType
The type of positioning of the motor (continuous or discrete)
Public propertyStatus (Inherited from IHardwareItem.)
Public propertyUniqueID (Inherited from IHardwareItem.)
Public propertyUsage (Inherited from IHardwareItem.)
Top
Methods
  NameDescription
Public methodGetCurrentPosition
Gets the current position of the movable item. (The unit is always SI and depends on the type of axis: [m] for linear axes and [rad] for rotation axes)
(Inherited from IMovableItem.)
Public methodGetDescription
Gets the description of the hardware item
(Inherited from IHardwareItem.)
Public methodGetPhysicalPosition
Get the current physical position of the motor, in the physical unit of the motor. (The unit is always SI and depends on the type of motor: [m] for linear motors and [rad] for rotation motors)
Public methodGoToPhysicalPosition
Moves to an absolute position. Synchronous
Public methodMoveToAbsolutePosition
Move the movable item to an absolute position. The command is blocking (it will return after the movable item has finished moving).
(Inherited from IMovableItem.)
Public methodMoveToRelativePosition
Move the movable item to a relative position. The command is blocking (it will return after the movable item has finished moving).
(Inherited from IMovableItem.)
Top
Events
  NameDescription
Public eventIsAvailableChanged
Occurs when the availability of the hardware item changes
(Inherited from IHardwareItem.)
Public eventIsConnectedChanged
Occurs when the connected state of the hardware item changes
(Inherited from IHardwareItem.)
Public eventIsInitializedChanged
Occurs when the initialized state of the hardware item changes
(Inherited from IHardwareItem.)
Top
See Also