MC_ReadActualPosition
The
MC_ReadActualPosition
returns the feedback position of the axis in user units configured by the user.
Parameters
| * | Parameter | Data Type | Description | Default |
|---|---|---|---|---|
| VAR_IN_OUT | ||||
| B | Axis | AXIS_REF | Logical axis reference. | |
| VAR_INPUT |
|
|||
| B | Enable | BOOL | The function block will continue to execute every scan while Enable is TRUE and there are no errors. | FALSE |
| VAR_OUTPUT | ||||
| B | Valid | BOOL | The Valid output indicates that the function block is operating normally and the outputs of the function block are valid. | |
| B | Busy | BOOL | For function blocks with Execute input, the Busy output is set to TRUE upon the rising edge of the Execute, and set to FALSE when Done, CommandAborted or Error outputs becomes TRUE. In the case of a function block with an Enable input, Busy indicates that the function block is operating, but may not be ready to provide valid outputs. | |
| B | Error | BOOL | The Error output is set to TRUE if an error has occurred during the operation of the function block. The output is cleared when the Execute or Enable input becomes FALSE. | |
| E | ErrorID | UINT | The ErrorID output provides the identifier of the error when there is an active error in the function block execution. The output is cleared when the Execute or Enable input becomes FALSE. | |
| B | Position | LREAL | A positive or negative value within the coordinate system in user units. | |
Notes
The actual position is also available using MC_ReadParameter 1000. For additional parameters related to the axis position, check the Axis Parameter List.
Error Description
See the
Function Block ErrorID List
Example
Instance of
MC_ReadActualPosition
reading the position of an axis that has been powered on with
MC_Power.
The LogicAnalyzer timing trace for the above example of MC_ReadActualPosition is shown below: