FC_SercosSetUserRealTimeControlBits - General Information

Overview

Type:

Function

Available as of:

SystemInterface_1.32.6.1

NOTE: This function can be used for the PacDrive 3 controllers with a firmware version V3.1 SP1 or greater.

The PacDrive 3 drive must use at least the firmware version 1.36.0.0.

This function can only be used with PacDrive 3 Sercos devices (Lexium LXM52 Drive, Lexium LXM62 Drive, and Lexium ILM62 Drive Module).

Task

Set specific real-time control bits in a Sercos command for a PacDrive 3 axis.

For instance, you want to set the motor brake in real time. If the control bits are set in real time for the PacDrive 3 axis, then the motor brake can be set in real time.

Description

FC_SercosSetUserRealTimeControlBits sets the real-time control bits in a Sercos command for a certain axis.

The axis is specified by its local address. The Sercos command is specified by the Identification Number (IDN).

To avoid an unintentional setting of bits, a bitmask has to be used. This bitmask describes which bits shall be set via the function.

The parameter value sets the bits that were selected in the bitmask to a certain value.

The bits in the Sercos command that you can set remain set until you modify them. The function does not have to be called up cyclically in the Sercos cycle.

Further information on the function as well as an example can be found under Using FC_SercosSetUserRealTimeControlBits.

Interface

Input

Data type

Description

i_stLogAddr

ST_LogicalAddress

Logical address of the axis that is necessary to set the real-time control bits.

i_dwMask

DWORD

Mask to select the real-time bits that shall be set.

i_dwIDN

DWORD

Identification number (IDN) of the Sercos command

Input/Output

Data type

Description

iq_dwValue

DWORD

Value to write and read the real-time control bits

Return Value

Data type

Description

DINT

0: OK

-1: invalid logical address

-2: invalid identification number (IDN): Writing is not permitted for this IDN.

-3: invalid mask: The mask contains bits which cannot be written.

-4: invalid value: A bit that was not defined in the mask is set to 1.

-5: The firmware version of the axis does not support the support function.