ItpReadToolDesc

from library version 4.0

from TwinCAT V2.7, Build 500

ItpReadToolDesc 1:

ItpReadToolDesc 2:

Outdated version

The sole purpose of the function block is to ensure compatibility with existing projects. For new projects please use the function block ItpReadToolDescEx.

Interface

VAR_INPUT
bExecute       : BOOL;
nChnId         : UDINT;
nDNo           : UDINT;
tTimeOut       : TIME;
END_VAR
VAR_IN_OUT
sToolDesc      : ToolDesc;
END_VAR
VAR_OUTPUT
bBusy          : BOOL;
bErr           : BOOL;
nErrId         : UDINT;
END_VAR
TYPE ToolDesc:
STRUCT
nToolNumber    : UDINT; (*valid range from 0 .. 65535*)
nToolType      : UDINT;
fParam         : ARRAY [2..15] OF LREAL;
END_STRUCT
END_TYPE

The ItpReadToolDesc block reads the tool parameters for the supplied D-word.

Input

Data type

Description

bExecute

BOOL

The command is triggered by a rising edge at this input.

nChnId

UDINT

Channel ID

nDNo

UDINT

D-word for which the tool parameters are to be read. nDoNo can assume values between 1 and 50 (the library TcNci.lib from version 5.4.16 supports 255 tool parameters).

tTimeOut

TIME

ADS Timeout-Delay

Input & output

Data type

Description

sToolDesc

ToolDesc

A structure into which the tool parameters of nDNo are written. The meaning of the parameters depends on the tool type, and can be found in the tool data.

Output

Data type

Description

bBusy

BOOL

This output remains TRUE until the function block has executed a command, but at the longest for the duration supplied to the 'Timeout' input. While Busy = TRUE, no new command will be accepted at the inputs. Please note that it is not the execution of the service but its acceptance whose time is monitored.

bErr

BOOL

This output is switched to TRUE as soon as an error occurs during the execution of a command. The command-specific error code is contained in ‘nErrId’. Is reset to FALSE by the execution of a command at the inputs.

nErrId

UDINT

Contains the command-specific error code of the most recently executed command. Is reset to 0 by the execution of a command at the inputs. The error numbers in ErrId can be looked up in the ADS error documentation or in the NC error documentation (error codes above 0x4000).

see also:

ItpWriteToolDesc; ItpSetToolDescNull

Requirements

Development Environment

Target System

PLC libraries to include

TwinCAT v2.7.0

PC (i386)

TcNciItp.lib

TwinCAT v2.8.0

PC (i386)

TcNci.lib