Groupreferencingactionexecute - Newport XPS Programmer's Manual

XPS Unified
EDH0373En1023 — 01/18
7.2.1.101

GroupReferencingActionExecute

Name
GroupReferencingActionExecute – Initiates the given action, with the given sensor
and parameters.
Input tests
- Refer to section 7.1: "Input Tests Common to all XPS Functions".
- Valids action name and sensor name: (-8)
- Input parameter coherence: (-17)
• For a "LatchOnHighToLowTransition" or "LatchOnLowToHighTransition" or
"LatchOnIndex" or "LatchOnIndexAfterSensorHighToLowTransition" or
"MoveToPreviouslyLatchedPosition" action.
• Parameter ≤MaximumVelocity.
• Parameter ≠ 0.
• Referencing state: (-22)
• Latch must be done since referencing start for a
"MoveToPreviouslyLatchedPosition" action.
- Valids positioner name: (-18)
- Group status must be "NOT REFERENCED": (-22)
Description
Initiates a referencing action for a positioner. A referencing action is defined by a given
action name (see "Action list" below), with a given sensor name (see "Sensor list"
below) and parameters. For more detail, see XPS User's manual referencing section.
Action list
LatchOnHighToLowTransition
LatchOnIndex
LatchOnIndexAfterSensorHighToLowTransition
LatchOnLowToHighTransition
MoveRelative
MoveToPreviouslyLatchedPosition
SetPosition
SetPositionToHomePreset
Sensor list
MechanicalZero
MinusEndOfRun
PlusEndOfRun
None.
If a following error occurs during the referencing and motion is in progress, an
emergency brake is applied and error (-25) is returned. The group state becomes
"NOTINIT".
If the home search time out is reached, error (-28) is returned. The group state becomes
"NOTINIT".
After referencing is done, to exit the "REFERENCING" state and to go to "READY"
state use "GroupReferencingStop" function.
162
Programmer's Manual
Sensor to be defined
Yes
None
Yes
Yes
None
None
None
None