IOF_GetBoxNetId

IOF_GetBoxNetId 1:

Some boxes (slave modules) can be assigned an AmsNetId during the configuration in TwinCAT. The AmsNetId can then be used to execute firmware functions on the box. The IOF_GetBoxNetId function block determines the TwinCAT network address, knowing the device ID of the master and the fieldbus address or logical address in the fieldbus. The device IDs are specified by the TwinCAT system during the configuration and cannot be configured by the user.

Inputs

VAR_INPUT
    NETID     : T_AmsNetId;
    DEVICEID  : UDINT;
    BOXADDR   : WORD;
    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.
BOXADDR	WORD	The fieldbus address, or the logical address of the box (slave module) whose AmsNetId is to be read.
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.

Outputs

VAR_OUTPUT
    BUSY     : BOOL;
    ERR      : BOOL;
    ERRID    : UDINT;
    BoxNetId : T_AmsNetId;
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.
BoxNetId	T_AmsNetID	The TwinCAT network address of the box as a string.

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)