Y_GroupJogTCP
This function block jogs a Group's TCP in the specified coordinate system.
Parameters
| * | Parameter | Data Type | Description | Default |
|---|---|---|---|---|
|
VAR_IN_OUT
|
||||
| B |
AxesGroup | AXES_GROUP_REF | A logical reference to a group of axes, which contains several additional substructures pertaining to the group. | |
| VAR_INPUT | ||||
| B | Enable |
BOOL | The function will continue to execute every scan while Enable is held high and there are no errors. | FALSE |
| V |
TCPCoordinate |
Yt_TCPCoordinate | An enumeration to specify an axis (X, Y, Z, Rx, Ry, Rz) | Array of LREAL#0.0 |
| B |
Velocity |
LREAL | Velocity in user units/second. | LREAL#0.0 |
| B |
Acceleration |
LREAL | Acceleration in user units/second^2. | LREAL#0.0 |
| B |
Deceleration |
LREAL | Deceleration in user units/second^2. | LREAL#0.0 |
| E | Jerk |
LREAL | Not supported; reserved for future use. Value of the jerk in [user units / second^3]. | LREAL#0.0 |
| V | MoveOptions |
Yt_GroupMoveOptions | Commands to specify the pose of a robot mechanism, set Cartesian or rotational velocity, velocity units, etc. | All zeros in structure |
| E | Direction |
MC_Direction |
Specifies the direction of motion. Allowable modes are positive_direction, shortest_way, negative_direction, current_direction.
MC_Direction#Positive_Direction
MC_Direction#Shortest_Way
MC_Direction#Negative_Direction
MC_Direction#Current_Direction
Only Positive and Negative are supported for groups. |
MC_Direction#Positive_Direction |
| E | CoordSystem |
MC_CoordinateSystem | Enumeration with the following values: 0 = ACS, 1 = MCS, 2 = PCS, 3 = TCS, 4 = WCS, 5 = TPCS. | MC_CoordinateSystem#ACS |
| B | BufferMode |
MC_BufferMode | Defines the behavior of the axis - allowable modes are Aborting, Buffered, BlendingLow, BlendingPrevious, BlendingNext, and BlendingHigh. MC_BufferMode#Aborting MC_BufferMode#Buffered MC_BufferMode#BlendingLow MC_BufferMode#BlendingPrevious MC_BufferMode#BlendingNext MC_BufferMode#BlendingHigh | MC_BufferMode#Aborting |
| VAR_OUTPUT | ||||
| B |
Valid |
BOOL | Indicates that the function is operating normally and the outputs of the function are valid. | |
| B | Done |
BOOL | Set high when the commanded action has completed successfully. If another block takes control before the action is completed, the Done output will not be set. This output is reset when Execute goes low. | |
| E |
Busy |
BOOL | Set high upon the rising edge of the Execute input, and reset when Done, CommandAborted, or Error is true. In the case of a function block with an Enable input, a Busy output indicates the function is operating, but not ready to provide Valid information. (No Error) | |
| E | Active |
BOOL | For buffered modes, this output is set high at the moment the block takes control of the axis. For non buffered modes, the outputs Busy and Active have the same value. | |
| E | CommandAborted |
BOOL | Set high if motion is aborted by another motion command or MC_Stop. This output is cleared with the same behavior as the Done output. | |
| B | Error | BOOL | Set high if an error has occurred during the execution of the function block. This output is cleared when 'Execute' or 'Enable' goes low. |
|
| E |
ErrorID | UINT | If Error is true, this output provides the Error ID. This output is reset when 'Execute' or 'Enable' goes low. |
|
Notes
- Setting Enable low will cause the group to stop jogging.
- The Velocity can be specified as either absolute values (e.g. 750 mm/sec) or a percentage of the max speed (e.g. 50%) by setting MoveOptions.ProfileUnit accordingly.
- For MotomanSync groups there are a few differences.
- Minimum time the group will jog is 100 mSec.
- CoordSystem = TCS is supported.
- Acceleration and Deceleration inputs are not supported. Jog acceleration and deceleration will specified by robot controller.
Error Description
See the Function Block ErrorID List.