MLMstStatus

Pipe Network motion icon

Function - Returns the status of the generator.

Inputs

Input	Data Type	Range	Unit	Default	Description
EN	BOOL	FALSE, TRUE	N/A	No default	Enables the FB to be executed.
BlockID	DINT	-2147483648 to 2147483647	N/A	No default	ID name of the Master Block.

Output	Data Type	Range	Unit	Description
OK	BOOL	FALSE, TRUE	N/A	Returns TRUE when the function successfully executes. See Function - General Rules.
Default (.Q)	DINT			Returns the status of the generator.

Output

Data Type

Range

Unit

Description

BOOL

FALSE, TRUE

N/A

Returns TRUE when the function successfully executes.

See Function - General Rules.

Default (.Q)

DINT

Returns the status of the generator.

The value returned is the state being executed by the TMP generator as it processes the various motion commands.
Some states are transitory, others are stable until the next event takes place.

These terms are relevant to the returned values:

Term	Definition
Running	Speed is non-zero.
Stopped	Speed is 0 (zero).
Positioning	A target position has been programmed with a relative, additive, or absolute command.

Status Definitions Table

Status	Definition
0	New speed programmed is entered when both: A jog move (MLMstRun) is commanded. The current speed is not at the commanded speed.
1	Stable state Running or Stopped is entered when both: A jog move (MLMstRun) is commanded. The current speed is at the commanded speed. Stable state Running or Stopped is entered when both: A position move is programmed. Motion is completed.
2	Speed change is entered when the current speed is greater than the commanded speed.
3	Speed reversal while positioning is entered when both: A position move is programmed. The distance to go requires a speed reversal.
4	Acceleration while positioning current speed is below the travel speed.
5	Constant Speed while positioning is entered when both: A positioning move is commanded. The current speed is at the commanded speed.
6	Deceleration while positioning is entered when both: A positioning move is commanded. The current speed is changing to achieve the target position at 0 (zero) speed.
7	Micro step is entered when both: A small change in position is required. The current speed is 0 (zero).

Not available.

MasterStatus := MLMstStatus( PipeNetwork.MASTER );