IOF_GetBoxAddrByName

IOF_GetBoxAddrByName 1:

The IOF_GetBoxAddrByName function block determines the fieldbus address of a box (box = slave, module, station), knowing the box name and the device ID. If no fieldbus address is available, the function block returns a physical or a logical address. (In the case of the Beckhoff Lightbus, for instance, it is the physical box number in the optical fiber ring, while in Profibus it is the station address). The box identifier is passed as a string to the function block, and can be specified by the user during the configuration in the TwinCAT system.

IOF_GetBoxAddrByName 2: Inputs

VAR_INPUT
    NETID     : T_AmsNetId;
    DEVICEID  : UDINT;
    BOXNAME   : T_MaxString;
    START     : BOOL;
    TMOUT     : TIME := DEFAULT_ADS_TIMEOUT;
END_VAR

Name

Type

Description

NETID

T_AmsNetId

The network address of the TwinCAT computer on which the ADS command is to be executed can be specified here. For the local computer an empty string may be specified.

DEVICEID

UDINT

DeviceId specifies the I/O device on which the function is to be executed. The device IDs are specified by the TwinCAT system during the hardware configuration.

BOXNAME

T_MaxString

The box name as a string.

START

BOOL

The function block is enabled by a positive edge at this input.

TMOUT

TIME

Specifies the time-out period that must not be exceeded when the command is executed.

IOF_GetBoxAddrByName 3: Outputs

VAR_OUTPUT
    BUSY    : BOOL;
    ERR     : BOOL;
    ERRID   : UDINT;
    BOXADDR : UINT;
END_VAR

Name

Type

Description

BUSY

BOOL

When the function block is enabled, this output is set and remains set until a feedback is received.

ERR

BOOL

If an error should occur during the transfer of the command, then this output is set once the BUSY output was reset.

ERRID

UDINT

Returns the ADS error number when the ERR output is set.

BOXADDR

UINT

The fieldbus address or logical address of the box.

Requirements

Development environment

Target platform

IO hardware

PLC libraries to be integrated (category group)

TwinCAT v3.1.0

PC or CX (x86, x64, ARM)

All IO devices

Tc2_IoFunctions (IO)