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. oFALSE: Execution of the function block is terminated. The outputs Valid, Busy, and Error are set to FALSE. oTRUE: 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: o10: Actual velocity RFRD. o11: Target velocity LFRD. o1000: Selection via input Address. LXM32: o1: Reference position (from profile generator). _RAMP_p_target o2: Positive position limit of software limit switch. MON_swLimP o3: Negative position limit of software limit switch. MON_swLimN o4: Monitoring of the positive software limit switch. (Activated: Bit 0 = 0. Deactivated: Bit 0 = 1). MON_SW_Limits o5: Monitoring of the negative software limit switch. (Activated: Bit 0 = 0. Deactivated: Bit 0 = 1). MON_SW_Limits o8: Maximum user-defined value for velocities in user-defined units _ScaleVELmax o10: Actual velocity in user-defined units. _v_act o11: Target velocity in user-defined units. _RAMP_v_target o12/14: Maximum user-defined value for acceleration and deceleration in user-defined units. _ScaleRAMPmax o1000: Selection via input Address. Lexium ILA, ILE and ILS integrated drives (EtherNet/IP and Modbus/TCP): o1: Reference position (from profile generator). _p_tarRAMPusr o2: Positive position limit of software limit switch. SPVswLimPusr o3: Negative position limit of software limit switch. SPVswLimNusr o4: Monitoring of the positive software limit switch. (Activated: Bit 0= 0. Deactivated: Bit 0 = 1). SPV_SW_Limits o5: Monitoring of the negative software limit switch. (Activated: Bit 0 = 0. Deactivated: Bit 0 = 1). SPV_SW_Limits o8: Maximum user-defined value for velocities in user-defined units. RAMPn_max o10: Actual velocity in user-defined units. _n_act o11: Target velocity in user-defined units. _n_targetRAMP o1000: Selection via input Address. Lexium ILA, ILE and ILS integrated drives (CANopen): o1: Reference position (from profile generator). p_ref o8: Maximum user-defined value for velocities in user-defined units. n_maxDrv o10: Actual velocity in user-defined units. n_profile o11: Target velocity in user-defined units. n_target o1000: 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: 2038_h, Subindex: 05_h -> 00203805_h Example of the address for Ethernet/IP: Class: 8C_h, Instance: 01_h, Attribute: 05h -> 008C0105_h Example of the address for ModbusTCP: Logic/Modbus address: 219C_h -> 0000219C_h

Input

Data type

Description

Enable

BOOL

Value range: FALSE, TRUE.

Default value: FALSE.

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

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

oTRUE: 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:

o10: Actual velocity RFRD.

o11: Target velocity LFRD.

o1000: Selection via input Address.

LXM32:

o1: Reference position (from profile generator). _RAMP_p_target

o2: Positive position limit of software limit switch. MON_swLimP

o3: Negative position limit of software limit switch. MON_swLimN

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

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

o8: Maximum user-defined value for velocities in user-defined units _ScaleVELmax

o10: Actual velocity in user-defined units. _v_act

o11: Target velocity in user-defined units. _RAMP_v_target

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

o1000: Selection via input Address.

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

o1: Reference position (from profile generator). _p_tarRAMPusr

o2: Positive position limit of software limit switch. SPVswLimPusr

o3: Negative position limit of software limit switch. SPVswLimNusr

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

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

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

o10: Actual velocity in user-defined units. _n_act

o11: Target velocity in user-defined units. _n_targetRAMP

o1000: Selection via input Address.

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

o1: Reference position (from profile generator). p_ref

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

o10: Actual velocity in user-defined units. n_profile

o11: Target velocity in user-defined units. n_target

o1000: 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: 2038_h, Subindex: 05_h -> 00203805_h

Example of the address for Ethernet/IP:

Class: 8C_h, Instance: 01_h, Attribute: 05h -> 008C0105_h

Example of the address for ModbusTCP:

Logic/Modbus address: 219C_h -> 0000219C_h

Outputs

Output	Data type	Description
Valid	BOOL	Value range: FALSE, TRUE. Default value: FALSE. oFALSE: Execution has not been started or an error has been detected. The values at the outputs are not valid. oTRUE: 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. oFALSE: Function block is not being executed. oTRUE: Function block is being executed.
Error	BOOL	Value range: FALSE, TRUE. Default value: FALSE. oFALSE: Execution of the function block is running, no error has been detected. oTRUE: 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