Global

Type of the error (AMS error, ADS error)

• AMS error: Something went wrong with the routing, the command was unknown etc.
• ADS error: The command failed

ADS error code

The description/message of ADS error code https://infosys.beckhoff.com/english.php?content=../content/1033/tf6610_tc3_s5s7communication/36028797393240971.html&id=

True if target is connected

True if target is local runtime / loopback connection

Local system AmsNetId

Local system ADS port

Target system AmsNetId

Target system ADS port

True if creating handle was successful

Error information (if any)

Target variable name

Returned variable handle (if successful)

Received variable handle

Received target variable size

Received target variable type

True if deleting handle was successful

Error information (if any)

The variable handle that was tried to be deleted

Index group in the PLC

Index offset in the PLC

Target device info (read after connecting)

Target device system manager state (run, config, etc.)

Target PLC runtime state (run, stop, etc.) (the runtime state of settings.targetAdsPort PLC runtime)

Contains information of target data types, symbols and so on

Active symbol version at target system. Changes when PLC software is updated

True if all symbols are cached (so we know to re-cache all during symbol version change)

Object containing all so far cached symbols

True if all data types are cached (so we know to re-cache all during symbol version change)

Object containing all so far cached data types

Local AMS router state (RUN, STOP etc) - Updated only if router sends notification (debug/run change etc)

If true, command failed

If error, ADS error code

If error, ADS error as string

Variable index group in the PLC

Variable index offset in the PLC

Variable size in the PLC (bytes)

True if read was successful

Error information (if any)

Original target info

Read data as byte Buffer

The return value of the method

Object containing all VAR_OUTPUT variables of the method

Target system AmsNetId, use '127.0.0.1.1.1' if connecting to a local system

Target system ADS port, TwinCAT 3: 851 (1st runtime), 852 (2nd runtime) and so on

If true, read ENUM data types are converted to objects instead of numbers, e.g. {name: 'enumValue', value: 5} instead of 5 - (default: true)

If true, PLC DT (DATE_AND_TIME) and DATE types are converted to Javascript dates - Optional (default: true)

If true, all PLC symbols are cached during connecting. Otherwise they are read and cached only when needed - Optional (default: false)

If true, all PLC data types are cached during connecting. Otherwise they are read and cached only when needed - Optional (default: false)

If true, PLC symbol version changes aren't monitored and cached symbols and datatypes won't be updated after PLC program download - Optional - Optional (default: false)

Target ADS router TCP port - Optional (default: 48898)

Target ADS router IP address/hostname - Optional (default: 127.0.0.1)

Local IP address to use, use this to change used network interface if required - Optional (default: System default)

Local TCP port to use for outgoing connections - Optional (default: System default)

Local AmsNetId to use - Optional (default: From AMS router)

Local ADS port to use - Optional (default: From AMS router)

Time (milliseconds) after connecting to the router or waiting for command response is canceled to timeout - Optional (default: 2000 ms)

If true, no warnings are written to console (=nothing is ever written to console) - Optional (default: false)

If true and connection is lost, the client tries to reconnect automatically - Optional (default: true)

Time (milliseconds) how often the lost connection is tried to re-establish - Optional (default: 2000 ms)

Time (milliseconds) how often the system manager state is read to see if connection is OK - Optional (default: 1000 ms)

Time (milliseconds) after no successful reading of the system manager state the connection is determined to be lost - Optional (default: 5000 ms)

If true, connect() is successful even if no PLC runtime is found (but target and system manager are available) - Can be useful if it's ok that after connect() the PLC runtime is not immediately available (example: connecting before uploading PLC code and reading data later) - WARNING: If true, reinitializing subscriptions might fail after connection loss.

If true, 64 bit integer PLC variables are kept as Buffer objects instead of converting to Javascript BigInt variables (JSON.strigify and libraries that use it have no BigInt support)

If true, only direct ads connection is established (no system manager etc) - Can be used to connect to systems without PLC runtimes etc.

Parsed data (if available) or Buffer

Date object that contains the PLC timestamp of the data

Data type object (if available)

Variable index group in the PLC

Variable index offset in the PLC

Buffer object that contains the data (and byteLength is acceptable)

True if write was successful

Error information (if any)

Original target info