MC_ReadParameter

Functional Description

This function block reads a value from a specific parameter.

Library and Namespace

Library name: GMC Independent PLCopen MC

Namespace: GIPLC

Graphical Representation

Inputs

Input

Data type

Description

Enable

BOOL

Value range: FALSE, TRUE.

Default value: FALSE.

The input Enable starts or terminates execution of a function block.

  • FALSE: Execution of the function block is terminated. The outputs Valid, Busy, and Error are set to FALSE.

  • TRUE: The function block is being executed. The function block continues executing as long as the input Enable is set to TRUE.

ParameterNumber

UINT

Value range: 0...65535

Default value: 1000

ATV:

  • 10: Actual velocity RFRD.

  • 11: Target velocity LFRD.

  • 1000: Selection via input Address.

LXM32:

  • 1: Reference position (from profile generator). _RAMP_p_target

  • 2: Positive position limit of software limit switch. MON_swLimP

  • 3: Negative position limit of software limit switch. MON_swLimN

  • 4: Monitoring of the positive software limit switch. (Activated: Bit 0 = 0. Deactivated: Bit 0 = 1). MON_SW_Limits

  • 5: Monitoring of the negative software limit switch. (Activated: Bit 0 = 0. Deactivated: Bit 0 = 1). MON_SW_Limits

  • 8: Maximum user-defined value for velocities in user-defined units _ScaleVELmax

  • 10: Actual velocity in user-defined units. _v_act

  • 11: Target velocity in user-defined units. _RAMP_v_target

  • 12/14: Maximum user-defined value for acceleration and deceleration in user-defined units. _ScaleRAMPmax

  • 1000: Selection via input Address.

Lexium ILA, ILE and ILS integrated drives (EtherNet/IP and Modbus TCP):

  • 1: Reference position (from profile generator). _p_tarRAMPusr

  • 2: Positive position limit of software limit switch. SPVswLimPusr

  • 3: Negative position limit of software limit switch. SPVswLimNusr

  • 4: Monitoring of the positive software limit switch. (Activated: Bit 0= 0. Deactivated: Bit 0 = 1). SPV_SW_Limits

  • 5: Monitoring of the negative software limit switch. (Activated: Bit 0 = 0. Deactivated: Bit 0 = 1). SPV_SW_Limits

  • 8: Maximum user-defined value for velocities in user-defined units. RAMPn_max

  • 10: Actual velocity in user-defined units. _n_act

  • 11: Target velocity in user-defined units. _n_targetRAMP

  • 1000: Selection via input Address.

Lexium ILA, ILE and ILS integrated drives (CANopen):

  • 1: Reference position (from profile generator). p_ref

  • 8: Maximum user-defined value for velocities in user-defined units. n_maxDrv

  • 10: Actual velocity in user-defined units. n_profile

  • 11: Target velocity in user-defined units. n_target

  • 1000: Selection via input Address.

Address

DWORD

Address of the parameter to be read. Can only be used if the input ParameterNumber = 1000.

Refer to the documentation of the drive for a list of the parameters with the corresponding address of the parameters.

Example of the address for CANopen:

Index: 2038h, Subindex: 05h -> 00203805h

Example of the address for EtherNet/IP:

Class: 8Ch, Instance: 01h, Attribute: 05h -> 008C0105h

Example of the address for Modbus TCP:

Logic/Modbus address: 219Ch -> 0000219Ch

Outputs

Output

Data type

Description

Valid

BOOL

Value range: FALSE, TRUE.

Default value: FALSE.

  • FALSE: Execution has not been started or an error has been detected. The values at the outputs are not valid.

  • TRUE: Execution has been completed without an error detected. The values at the outputs are valid and can be further processed.

Busy

BOOL

Value range: FALSE, TRUE.

Default value: FALSE.

  • FALSE: Function block is not being executed.

  • TRUE: Function block is being executed.

Error

BOOL

Value range: FALSE, TRUE.

Default value: FALSE.

  • FALSE: Execution of the function block is running, no error has been detected.

  • TRUE: An error has been detected in the execution of the function block.

ErrorID

WORD

Returns the value of a diagnostic code. Refer to Library Diagnostic Codes. If the value is 0 and if the output Error of this function block is set to TRUE, then the diagnostic code can be read with the output AxisErrorID of the function block MC_ReadAxisError.

Value

DINT

Value range: -2147483648...2147483647

Default value: 0

Value of the parameter.

Inputs/Outputs

Input/Output

Data type

Description

Axis

Axis_Ref

Reference to the axis (instance) for which the function block is to be executed (corresponds to the name of the axis). The name of the axis must be defined in the EcoStruxure Machine Expert Devices tree.

Additional Information

Reading a Parameter