MC_ReadStatus

PLCopen motion icon

Function Block A function block groups an algorithm and a set of private data. It has inputs and outputs. - Returns the state of the specified axis.

Inputs

Input	Data Type	Range	Unit	Default	Description
Enable	BOOL	0, 1	N/A	No default	Request to read and return the axis status.
Axis	AXIS_REF	1, 256	N/A	No default	Name of a declared instance of the AXIS_REF library function. See Axis Name and Number for more information. See AXIS_REF Structure for more information.

Input

Data Type

Range

Unit

Default

Description

Enable

BOOL

0, 1

N/A

No default

Request to read and return the axis status.

Axis

AXIS_REF

1, 256

N/A

No default

Name of a declared instance of the AXIS_REF library function.

See Axis Name and Number for more information.
See AXIS_REF Structure for more information.

Outputs

Output	Data Type	Description
Valid	BOOL	Indicates the outputs are valid.
Busy	BOOL	Indicates this function block is executing.
Error	BOOL	Indicates an invalid input was specified.
ErrorID	INT	Indicates the error if Error output is TRUE. See PLCopen Function Block ErrorIDs for more information.
ErrorStop	BOOL	Indicates Error Stop state. Either E-stop or C-stop.
Disabled	BOOL	Indicates Disabled state. Open loop A positioning technique, typically utilizing stepper motors, in which the controller issues a sequence of commands to the motor without an absolute means of detecting if the move has been made. When the load and move velocity and acceleration are appropriately defined, open loop positioning is capable of extended operation without losing steps. and drive is disabled.
Stopping	BOOL	Indicates Stopping state. MC_Stop command.
StandStill	BOOL	Indicates Stand Still state. No move, closed loop The use of feedback devices (encoders, resolvers, interferometers, etc.) to allow a motor to position a user payload accurately., drive enabled.
DiscreteMotion	BOOL	Indicates Discrete Motion state. Pprogrammed endpoint move is active.
ContinuousMotion	BOOL	Indicates Continuous Motion state. Unending, single-axis move is active.
SynchronizedMotion	BOOL	Indicates Synchronized Motion state Slave move is active.
Homing The Homing procedure allows, based on a position measurement, to set a position offset to the motor in order to ensure it is physically at the home position	BOOL	Indicates Homing state. A homing cycle is currently executing.
ConstantVelocity	BOOL	Indicates the axis is moving at a constant velocity.
Accelerating	BOOL	Indicates the axis is accelerating.
Decelerating	BOOL	Indicates the axis is decelerating.

Remarks

This function or function block returns cached data.
See Program a Multi-Core Controller for more information.

See Function Blocks - General Rules for more information about how inputs and outputs work.

Figure 6-219: MC_ReadStatus

FBD Language Example

Not available.

FFLD Language Example

IL Language Example

Not available.

ST Language Example

            (* MC_ReadStatus ST example *)
            
Inst_MC_ReadStatus( EnableRead, Axis1 );
//Inst_MC_ReadStatus is an instance of MC_ReadStatus function block
AxisStopping := Inst_MC_ReadStatus.Stopping; // store Stopping output to a user defined variable
AxisAccelerating := Inst_MC_ReadStatus.Accelerating; // store Accelerating output to a user defined variable