IOF_GetDeviceName
The IOF_GetDeviceName function block reads the device name of an I/O device. The device name can be specified by the user during the configuration in the TwinCAT system. This is then sent as a string to the I/O driver at system startup and can be read using the ADS commands. The DEVICEID input variable is used to specify the I/O device whose device name is to be read.
Inputs
VAR_INPUT
NETID : T_AmsNetId;
DEVICEID : UDINT;
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. |
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;
DEVICENAME : T_MaxString;
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. |
DEVICENAME | T_MaxString | The device name of an I/O device 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) |