MC_ReadBoolPar

PLCopen motion icon

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

Inputs

Input	Data Type	Range	Unit	Default	Description
Enable Enable signal for the drive, Hardware-Enable with 24V signal to X8, Software-Enable command by setup Software, fieldbus or permanently set. Both are required for enabling the drive.	BOOL	FALSE, TRUE	N/A	No default	Requests to read a Boolean axis parameter.
Axis	AXIS_REF	1, 256	N/A	No default	Name of a declared instance of the AXIS_REF library function A function calculates a result according to the current value of its inputs. A function has no internal data and is not linked to declared instances.. See Axis Name and Number. See AXIS_REF Structure.
ParameterNumber	INT	-32768 to +32767	N/A	No default	Parameter number. See Axis Parameters.

Input

Data Type

Range

Unit

Default

Description

Enable Enable signal for the drive, Hardware-Enable with 24V signal to X8, Software-Enable command by setup Software, fieldbus or permanently set. Both are required for enabling the drive.

BOOL

FALSE, TRUE

N/A

No default

Requests to read a Boolean axis parameter.

Axis

AXIS_REF

1, 256

N/A

No default

Name of a declared instance of the AXIS_REF library function A function calculates a result according to the current value of its inputs. A function has no internal data and is not linked to declared instances..

See Axis Name and Number.
See AXIS_REF Structure.

ParameterNumber

INT

-32768 to +32767

N/A

No default

Parameter number.

See Axis Parameters.

Outputs

Output	Data Type	Range	Unit	Description
Valid	BOOL	FALSE, TRUE	N/A	Indicates the Value output is valid.
Busy	BOOL	FALSE, TRUE	N/A	Indicates this function block is executing.
Error	BOOL	FALSE, TRUE	N/A	Indicates an invalid input was specified.
ErrorID	INT	-32768 to +32767		Indicates the error if Error output is TRUE. See PLCopen Function Block ErrorIDs.
Value	BOOL	FALSE, TRUE	N/A	State of the Boolean parameter.

Remarks

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

Returns the value of a drive In electrical engineering, a drive is an electronic device to provide power to a motor or servo. Control device for regulating the speed, torque and position of a motor. A unit controlling a motor using the current and timing in its coils. parameter.

The returned value has to be converted to REAL if required.
If not possible, the vendor must provide a supplier-dependent FB for it.

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

Figure 1: MC_ReadBoolPar

FBD Language Example

Not available.

FFLD Language Example

IL Language Example

Not available.

ST Language Example

            (* MC_ReadBoolPar ST example *)
Inst_MC_ReadBoolPar( EnableRead, Axis1, MC_AXIS_PARAM_IN_POSITION Position means a point in space which is described by different coordinates. 
Depending on the used system and transformation it can consist of a maximum of six dimensions (coordinates).This means three Cartesian coordinates in space and coordinates for the orientation.
In ACS there can be even more than six coordinates.
If the same position is described in different coordinate systems the values of the coordinates are different. );
Axis1InPosition := Inst_MC_ReadBoolPar.Value;