AdsClient Class

Inheritance Hierarchy

SystemObject
TwinCAT.AdsAdsClient

Namespace: TwinCAT.Ads
Assembly: TwinCAT.Ads (in TwinCAT.Ads.dll) Version: 7.0.0+e56d35ccc4675faac24789a4aab60071fc61d470

C#

public sealed class AdsClient : IAdsDisposableConnection, 
    IAdsConnectAddress, IAdsConnection, IConnection, IConnectionStateProvider, IAdsNotifications, 
    IAdsSymbolicAccess, IAdsAnyAccess, IAdsHandle, IAdsReadWrite, IAdsStateProvider, 
    IAdsStateControl, IAdsSymbolChangedProvider, IAdsRpcInvoke, IRouterNotificationProvider, IDisposable, 
    ITcAdsRaw

The AdsClient type exposes the following members.

Constructors

	Name	Description
	AdsClient	Initializes a new instance of the AdsClient class.
	AdsClient(AdsClientSettings)	Initializes a new instance of the AdsClient class with the specified settings.
	AdsClient(ILoggerFactory)	Initializes a new instance of the AdsClient class.
	AdsClient(IConfiguration, ILoggerFactory)	Initializes a new instance of the AdsClient class.
	AdsClient(ISession, IConfiguration, ILoggerFactory)	Initializes a new instance of the AdsClient class bound to a session.
	AdsClient(ISession, AdsClientSettings, ILoggerFactory)	Initializes a new instance of the AdsClient class.
	AdsClient(ISession, AdsClientSettings, IConfiguration, ILoggerFactory)	Initializes a new instance of the AdsClient class.

Properties

	Name	Description
	Address	Gets the target AmsAddress of of the established ADS connection (Destination side).
	ChannelPortType	Gets the channel port type.
	ChannelProtocol	Gets the the used channel protocol.
	ClientAddress	Get the AmsAddress of the ADS client. Obsolete
	Configuration	Gets the optional Configuration
	DefaultValueEncoding	Gets the default value encoding.
	Id	Gets the AdsClient Identifier.
	IsConnected	Gets a value indicating whether the local ADS port was opened successfully. It does not indicate if the target port is available. Use the method ReadState to determine if the target port is available.
	IsDisposed	Gets a value indicating whether this instance is disposed.
	IsLocal	Gets a value indicating whether the ADS client is connected to a ADS Server on the local computer.
	Logger	Gets the logger inteface.
	LoggerFactory	Gets the logger factory.
	PlatformPointerSize	Gets the target platform pointer size
	Session	Gets the session that initiated this IConnection
	SourceAddress	Get the client/source AmsAddress (Source side).
	SymbolEncoding	Gets the symbol encoding.
	Timeout	Sets the timeout for the ads communication. Unit is in ms.

Methods

	Name	Description
	AddDeviceNotification(String, Int32, NotificationSettings, Object)	Connects a variable to the ADS client. The ADS client will be notified by the AdsNotification event.
	AddDeviceNotification(UInt32, UInt32, Int32, NotificationSettings, Object)	Connects a variable to the ADS client. The ADS client will be notified by the AdsNotification event.
	AddDeviceNotificationAsync(String, Int32, NotificationSettings, Object, CancellationToken)	Connects a variable to the ADS client asynchronously. The ADS client will be notified by the AdsNotification event.
	AddDeviceNotificationAsync(UInt32, UInt32, Int32, NotificationSettings, Object, CancellationToken)	Adds a device notification as an asynchronous operation.
	AddDeviceNotificationEx(String, NotificationSettings, Object, Type)	Connects a variable to the ADS client. The ADS client will be notified by the AdsNotificationEx event.
	AddDeviceNotificationEx(String, NotificationSettings, Object, Type, Int32)	Connects a variable to the ADS client. The ADS client will be notified by the AdsNotificationEx event.
	AddDeviceNotificationEx(UInt32, UInt32, NotificationSettings, Object, Type)	Connects a variable to the ADS client. The ADS client will be notified by the AdsNotificationEx event.
	AddDeviceNotificationEx(UInt32, UInt32, NotificationSettings, Object, Type, Int32)	Connects a variable to the ADS client. The ADS client will be notified by the AdsNotification event. If type is a string type, the first element of the parameter args specifies the number of characters of the string. If type is an array type, the number of elements for each dimension has to be specified in the parameter args. Only primitive ('AnyType') types are allowed for the parameter type.
	AddDeviceNotificationExAsync(String, NotificationSettings, Object, Type, Int32, CancellationToken)	Connects a variable to the ADS client asynchronously. The ADS client will be notified by the AdsNotificationEx event.
	AddDeviceNotificationExAsync(UInt32, UInt32, NotificationSettings, Object, Type, Int32, CancellationToken)	Connects a variable to the ADS client asynchronously. The ADS client will be notified by the AdsNotificationEx event.
	CleanupSymbolTable	Clears the internal symbol cache.
	Close	Closes this AdsClient
	Connect(AmsAddress)	Connects/Reconnects to the specified target address.
	Connect(AmsPort)	Connects the specified port.
	Connect(Int32)	Connects/Reconnects to the specified port of the local ADS target device.
	Connect(AmsNetId, Int32)	Connects/Reconnects to the specified target address.
	Connect(AmsNetId, AmsPort)	Connects the specified net identifier.
	Connect(String, Int32)	Connects/Reconnects to the specified target address.
	ConnectAndWaitAsync	Connects/Reconnects to the target address and waits until the IAdsConnection is disconnected asynchronously.
	ConnectAsync(AmsAddress, CancellationToken)	Connects/Reconnects to the specified target address asynchronously.
	ConnectAsync(Int32, CancellationToken)	Connects/Reconnects to the specified port of the local system asynchonously.
	ConnectAsync(AmsNetId, Int32, CancellationToken)	Connects/Reconnects to the specified target address asynchronously.
	CreateVariableHandle	Determines the Symbol handle by its instance path synchronously.
	CreateVariableHandleAsync	Determines the Symbol handle by its instance path asynchronously.
	DeleteDeviceNotification	Deletes a registered notification.
	DeleteDeviceNotificationAsync	Deletes a registered notification asynchronously.
	DeleteVariableHandle	Releases the specified symbol/variable handle synchronously.
	DeleteVariableHandleAsync	Releases the specified symbol/variable handle asynchronously.
	Disconnect	Disconnects this AdsClient from the local ADS router.
	DisconnectAsync	Disconnects this AdsClient from the local ADS router.
	Dispose	Performs application-defined tasks associated with freeing, releasing, or resetting unmanaged resources.
	Equals	Determines whether the specified object is equal to the current object. (Inherited from Object)
	Finalize	Finalizes an instance of the AdsClient class. (Overrides ObjectFinalize)
	GetHashCode	Serves as the default hash function. (Inherited from Object)
	GetType	Gets the Type of the current instance. (Inherited from Object)
	InvokeRpcMethodAsync(IRpcCallableInstance, IRpcMethod, Object, CancellationToken)	invoke RPC method as an asynchronous operation.
	InvokeRpcMethodAsync(String, String, Object, CancellationToken)	Invokes the specified RPC Method asynchronously
	InvokeRpcMethodAsync(IRpcCallableInstance, IRpcMethod, Object, AnyTypeSpecifier, AnyTypeSpecifier, CancellationToken)	invoke RPC method as an asynchronous operation.
	InvokeRpcMethodAsync(String, String, Object, AnyTypeSpecifier, AnyTypeSpecifier, CancellationToken)	Invokes the specified RPC Method asynchronously
	ReadAny(String, Type)	Reads any.
	ReadAny(UInt32, Type)	Reads data synchronously from an ADS device and writes it to an object.
	ReadAny(String, Type, Int32)	Reads data synchronously from an ADS device and writes it to an object.
	ReadAny(UInt32, Type, Int32)	Reads data synchronously from an ADS device and writes it to an object.
	ReadAny(UInt32, UInt32, Type)	Reads data synchronously from an ADS device and writes it to an object.
	ReadAny(UInt32, UInt32, Type, Int32)	Reads data synchronously from an ADS device and writes it to an object.
	ReadAnyT(String)	Reads any.
	ReadAnyT(UInt32)	Reads data synchronously from an ADS device and writes it to an object.
	ReadAnyT(String, Int32)	Reads any.
	ReadAnyT(UInt32, Int32)	Reads data synchronously from an ADS device and writes it to an object.
	ReadAnyT(UInt32, UInt32)	Reads data synchronously from an ADS device and writes it to an object.
	ReadAnyT(UInt32, UInt32, Int32)	Reads data synchronously from an ADS device and writes it to an object.
	ReadAnyAsResultT(String)	Reads any as result.
	ReadAnyAsResultT(String, Int32)	Reads any as result.
	ReadAnyAsync(String, Type, CancellationToken)	Reads any asynchronous.
	ReadAnyAsync(UInt32, Type, CancellationToken)	Reads data synchronously from an ADS device and writes it to an object.
	ReadAnyAsync(String, Type, Int32, CancellationToken)	Read any as an asynchronous operation.
	ReadAnyAsync(UInt32, Type, Int32, CancellationToken)	Read any as an asynchronous operation.
	ReadAnyAsync(UInt32, UInt32, Type, CancellationToken)	Reads data asynchronously from an ADS device and writes it to an object.
	ReadAnyAsync(UInt32, UInt32, Type, Int32, CancellationToken)	Read any as an asynchronous operation.
	ReadAnyAsyncT(String, CancellationToken)	Reads any asynchronous.
	ReadAnyAsyncT(UInt32, CancellationToken)	Read any as an asynchronous operation.
	ReadAnyAsyncT(String, Int32, CancellationToken)	Read any as an asynchronous operation.
	ReadAnyAsyncT(UInt32, Int32, CancellationToken)	Read any as an asynchronous operation.
	ReadAnyAsyncT(UInt32, UInt32, CancellationToken)	Read any as an asynchronous operation.
	ReadAnyAsyncT(UInt32, UInt32, Int32, CancellationToken)	Read any as an asynchronous operation.
	ReadAnyString(String, Int32, Encoding)	Reads any string.
	ReadAnyString(UInt32, Int32, Encoding)	Reads a string from the specified symbol/variable.
	ReadAnyString(UInt32, UInt32, Int32, Encoding)	Reads as string from a specified address.
	ReadAnyStringAsync(String, Int32, Encoding, CancellationToken)	Reads a string asynchronously from the specified symbol/variable
	ReadAnyStringAsync(UInt32, Int32, Encoding, CancellationToken)	Reads a string asynchronously from the specified symbol/variable
	ReadAnyStringAsync(UInt32, UInt32, Int32, Encoding, CancellationToken)	Reads a string from a specified address asynchronously.
	ReadAsResult(UInt32, Int32)	Reads the value synchronously />.
	ReadAsResult(UInt32, UInt32, Int32)	Reads data synchronously from an ADS device.
	ReadDataType	Reads/Determines the DataType Inforrmation with the specifed name.
	ReadDataTypeAsync	Read data type as an asynchronous operation.
	ReadDeviceInfo	Reads the identification and version number of an ADS server.
	ReadDeviceInfoAsync	Reads the identification and version number of an ADS server.
	ReadState	Reads the ADS status and the device status from an ADS server.
	ReadStateAsync	Reads the ADS status and the device status from an ADS server.
	ReadSymbol	Reads the symbol.
	ReadSymbolAsync	Read symbol as an asynchronous operation.
	ReadValue(ISymbol)	Reads the value of a symbol and returns the value as (boxed) object.
	ReadValue(String)	Reads the value of a symbol specified with its instance path and returns the value as boxed object.
	ReadValue(String, Type)	Reads the value of a symbol specified with its instance path and returns the value as object of the specified type.
	ReadValueT(ISymbol)	Reads the value of a symbol and returns it as an typed object.
	ReadValueT(String)	Reads the value.
	ReadValueAsync(ISymbol, CancellationToken)	Read value as an asynchronous operation.
	ReadValueAsync(String, Type, CancellationToken)	Read value as an asynchronous operation.
	ReadValueAsyncTValue(ISymbol, CancellationToken)	Read value as an asynchronous operation.
	ReadValueAsyncT(String, CancellationToken)	Read value as an asynchronous operation.
	ReadWrite(UInt32, MemoryByte, ReadOnlyMemoryByte)	Writes data synchronously to an ADS device and then Reads data from that target.
	ReadWrite(UInt32, UInt32, MemoryByte, ReadOnlyMemoryByte)	Writes data synchronously to an ADS device and then Reads data from this device into the readBuffer
	ReadWriteAsResult	Writes data synchronously to an ADS device and reads data from that device.
	RegisterAdsStateChangedAsync	Registers for AdsStateChanged events as an asynchronous operation.
	RegisterSymbolVersionChanged	Registers the symbol version changed event (synchronously)
	RegisterSymbolVersionChangedAsync	Register symbol version changed as an asynchronous operation.
	ResurrectAsync	Resurrects the connection
	ToString	Returns a string that represents the current object. (Inherited from Object)
	TryAddDeviceNotification(String, Int32, NotificationSettings, Object, UInt32)	Connects a variable to the ADS client. The ADS client will be notified by the AdsNotification event.
	TryAddDeviceNotification(UInt32, UInt32, Int32, NotificationSettings, Object, UInt32)	Connects a variable to the ADS client. The ADS client will be notified by the AdsNotification event.
	TryAddDeviceNotificationEx(String, NotificationSettings, Object, Type, Int32, UInt32)	Connects a variable to the ADS client. The ADS client will be notified by the AdsNotificationEx event.
	TryAddDeviceNotificationEx(UInt32, UInt32, NotificationSettings, Object, Type, Int32, UInt32)	Connects a variable to the ADS client. The ADS client will be notified by the AdsNotificationEx event.
	TryCreateVariableHandle	Determines the Symbol handle by its instance path synchronously.
	TryDeleteDeviceNotification(UInt32)	Deletes a registered notification.
	TryDeleteDeviceNotification(UInt32, Int32)	Deletes a registered notification.
	TryDeleteVariableHandle	Releases the specified symbol/variable handle synchronously.
	TryInvokeRpcMethod(String, String, Object, Object)	Invokes the specified RPC Method
	TryInvokeRpcMethod(String, String, Object, Object, Object)	Invokes the specified RPC Method
	TryInvokeRpcMethod(IRpcCallableInstance, IRpcMethod, Object, AnyTypeSpecifier, AnyTypeSpecifier, Object, Object)	Tries the invoke RPC method.
	TryInvokeRpcMethod(String, String, Object, AnyTypeSpecifier, AnyTypeSpecifier, Object, Object)	Invokes the RPC Method
	TryReadAnyString	Tries the read any string.
	TryReadDataType	Tries to Read/Determine the DataType of the specified type.
	TryReadState	Reads the ADS status and the device status from an ADS server. Unlike the ReadState method this method does not call an exception on failure. Instead an AdsErrorCode is returned. If the return value is equal to AdsErrorCode.NoError the call was successful.
	TryReadSymbol	Tries to read the symbol information object specified by the instance path.
	TryReadValue(ISymbol, Object)	Tries to read the value of a symbol and returns the value as boxed object.
	TryReadValue(String, Type, Object)	Tries to the value of a symbol specified as instance path and returns the value as (boxed) object.
	TryReadValueT(ISymbol, T)	Reads the value of a symbol and returns the value as typed value.
	TryReadValueT(String, T)	Tries to reads the value of a symbol specified with instance path and returns the typed value.
	TryReadWrite(UInt32, MemoryByte, ReadOnlyMemoryByte, Int32)	ReadWrites value data synchronously to/from the symbol represented by the variableHandle.
	TryReadWrite(UInt32, UInt32, MemoryByte, ReadOnlyMemoryByte, Int32)	Writes data synchronously to an ADS device and reads data from that device.
	TryResurrect	Resurrects the connection
	TryWrite(UInt32, ReadOnlyMemoryByte)	Writes the value data synchronously that is represented in the writeBuffer to the symbol with the specified variableHandle.
	TryWrite(UInt32, UInt32, ReadOnlyMemoryByte)	Writes data synchronously to an ADS device.
	TryWriteControl(StateInfo)	Changes the ADS status and the device status of an ADS server.
	TryWriteControl(StateInfo, ReadOnlyMemoryByte)	Changes the ADS status and the device status of an ADS server.
	TryWriteValue(ISymbol, Object)	Tries to write a (boxed) value to the symbol
	TryWriteValue(String, Object)	Tries to write a (boxed) value to the symbol instance specified by its instance/symbol path.
	TryWriteValueT(ISymbol, T)	Tries to write a value to the symbol.
	TryWriteValueT(String, T)	Tries to Write a (typed) value to the symbol instance specified by its instance/symbol path.
	UnregisterAdsStateChangedAsync	unregister ads state changed as an asynchronous operation.
	UnregisterSymbolVersionChanged	Unregisters the symbol version changed event (synchronously)
	UnregisterSymbolVersionChangedAsync	Unregister symbol version changed as an asynchronous operation.
	Write(UInt32, ReadOnlyMemoryByte)	Writes data synchronously to an ADS device.
	Write(UInt32, UInt32)	Triggers a 'Write' call to the ADS device at the specified address.
	Write(UInt32, UInt32, ReadOnlyMemoryByte)	Writes data synchronously to an ADS device.
	WriteAny(UInt32, Object)	Writes an object synchronously to an ADS device.
	WriteAny(UInt32, Object, Int32)	Writes an object synchronously to an ADS device. If the Type of the object to be written is a string type, the first element of parameter args specifies the number of characters of the string.
	WriteAny(UInt32, UInt32, Object)	Writes an object synchronously to an ADS device.
	WriteAny(UInt32, UInt32, Object, Int32)	Writes an object synchronously to an ADS device.
	WriteAnyAsync(UInt32, Object, CancellationToken)	Writes an object synchronously to an ADS device. If the Type of the object to be written is a string type, the first element of parameter args specifies the number of characters of the string.
	WriteAnyAsync(UInt32, Object, Int32, CancellationToken)	Writes an object asynchronously to an ADS device. If the Type of the object to be written is a string type, the first element of parameter args specifies the number of characters of the string.
	WriteAnyAsync(UInt32, UInt32, Object, CancellationToken)	Writes an object asynchronously to an ADS device. If the Type of the object to be written is a string type, the first element of parameter args specifies the number of characters of the string.
	WriteAnyAsync(UInt32, UInt32, Object, Int32, CancellationToken)	Writes an object asynchronously to an ADS device. If the Type of the object to be written is a string type, the first element of parameter args specifies the number of characters of the string.
	WriteAnyStringAsync	Writes the string (Potentially unsafe!)
	WriteAsResult	Writes the data / Value into the specified writeBuffer.
	WriteAsync(UInt32, ReadOnlyMemoryByte, CancellationToken)	Write as an asynchronous operation.
	WriteAsync(UInt32, UInt32, CancellationToken)	Writes the asynchronous.
	WriteAsync(UInt32, UInt32, ReadOnlyMemoryByte, CancellationToken)	Write as an asynchronous operation.
	WriteControl(StateInfo)	Changes the ADS status and the device status of an ADS server.
	WriteControl(StateInfo, ReadOnlyMemoryByte)	Changes the ADS status and the device status of an ADS server.
	WriteControlAsync(AdsState, UInt16, CancellationToken)	Changes the ADS status and device status of the ADS server asynchronously.
	WriteControlAsync(AdsState, UInt16, ReadOnlyMemoryByte, CancellationToken)	Writes the state asynchronously
	WriteSymbolAsync	Writes the passed object value to the specified ADS symbol.The parameter type must have the same layout as the ADS symbol.
	WriteValue(ISymbol, Object)	Writes a (boxed) value to the symbol.
	WriteValue(String, Object)	Writes a (boxed value) to the symbol instance specified by its instance/symbol path.
	WriteValueT(ISymbol, T)	Writes a (typed) value to the symbol.
	WriteValueT(String, T)	Writes a typed value to the symbol instance specified by its instance/symbol path.
	WriteValueAsync(ISymbol, Object, CancellationToken)	Writes a (boxed) value to the symbol as an asynchronous operation.
	WriteValueAsyncT(ISymbol, T, CancellationToken)	Writes a (typed) value to the symbol as an asynchronous operation.
	WriteValueAsyncT(String, T, CancellationToken)	Writes a (typed) value to the symbol instance specified by its instance/symbol path as an asynchronous operation.

Events

	Name	Description
	AdsNotification	Occurs when the ADS device sends a notification to the client.
	AdsNotificationError	Occurs when a exception has occurred during notification management.
	AdsNotificationEx	Occurs when the ADS devices sends a notification to the client.
	AdsNotificationsInvalidated	Occurs when Notification Unregistrations / Invalidates are received from the AdsServer
	AdsStateChanged	Occurs when the ADS state changes.
	AdsSumNotification	Occurs when Notifications are send (bundled notifications)
	AdsSymbolVersionChanged	Occurs when the SymbolVersion table of a TwinCAT PLC System has been changed.
	ConnectionStateChanged	Occurs when the connection state has been changed.
	RouterStateChanged	(Local) Router state changed event.

Extension Methods

	Name	Description
	PollAdsState	Gets an observable sequence of ResultReadAdsStates via Polling. (Defined by ConnectionStateExtension)
	PollAdsState	Gets an observable sequence of AdsStates via Polling. (Defined by AdsClientExtensions)
	PollAdsState	Gets an observable sequence of ResultReadAdsStates via Polling. (Defined by ConnectionStateExtension)
	PollAdsState	Gets an observable sequence of AdsStates via Polling. (Defined by AdsClientExtensions)
	PollAdsState2	Gets an observable sequence of ResultReadAdsStates via Polling. (Defined by AdsClientExtensions)
	PollAdsState2	Gets an observable sequence of ResultReadAdsStates via Polling. (Defined by AdsClientExtensions)
	PollAdsState2Async	Gets an observable sequence of AdsStates via Polling. (Defined by AdsClientExtensions)
	PollAdsState2Async	Gets an observable sequence of ResultReadAdsStates via Polling. (Defined by AdsClientExtensions)
	PollAdsStateAsync	Gets an observable sequence of AdsStates via Polling. (Defined by ConnectionStateExtension)
	PollAdsStateAsync	Gets an observable sequence of AdsStates via Polling. (Defined by AdsClientExtensions)
	PollAdsStateAsync	Gets an observable sequence of AdsStates via Polling. (Defined by ConnectionStateExtension)
	PollAdsStateAsync	Gets an observable sequence of AdsStates via Polling. (Defined by AdsClientExtensions)
	PollDeviceState	Gets an observable sequence of ResultReadDeviceStates via Polling. (Defined by AdsClientExtensions)
	PollDeviceState	Gets an observable sequence of ResultReadDeviceStates via Polling. (Defined by AdsClientExtensions)
	PollDeviceStateAsync	Gets an observable sequence of ResultReadDeviceStates via Polling. (Defined by AdsClientExtensions)
	PollDeviceStateAsync	Gets an observable sequence of ResultReadDeviceStates via Polling. (Defined by AdsClientExtensions)
	PollSystemServiceState	Polls the state of the system service. (Defined by SystemServiceExtension)
	PollSystemServiceStateAsync	Polls the system service state asynchronously (Defined by SystemServiceExtension)
	PollValues	Polls the symbol values on timepoints where the polling observable streams data / triggers (Defined by AnyTypeExtensions)
	PollValues	Polls the symbol as value sequence of object values with a specified period time. (Defined by AnyTypeExtensions)
	PollValues	Polls the symbol values on timepoints where the polling observable streams data / triggers (Defined by AnyTypeExtensions)
	PollValues	Polls the symbol as value sequence of object values with a specified period time. (Defined by AnyTypeExtensions)
	PollValues	Polls the symbol as value sequence of object values with a specified period time. (Defined by AnyTypeExtensions)
	PollValues	Polls the symbol values on timepoints where the polling observable streams data / triggers (Defined by AnyTypeExtensions)
	PollValues	Polls the symbol as value sequence of object values with a specified period time. (Defined by AnyTypeExtensions)
	PollValues	Polls the symbol as value sequence of object values with a specified period time. (Defined by AnyTypeExtensions)
	PollValues	Polls the symbol values on timepoints where the polling observable streams data / triggers (Defined by AnyTypeExtensions)
	PollValues	Polls the symbol as value sequence of object values with a specified period time. (Defined by AnyTypeExtensions)
	PollValues	Polls the symbol values on time points where the polling observable streams data / triggers (Defined by AnyTypeExtensions)
	PollValues	Polls the symbol as value sequence of object values with a specified period time. (Defined by AnyTypeExtensions)
	PollValues	Polls the symbol values on time points where the polling observable streams data / triggers (Defined by AnyTypeExtensions)
	PollValues	Polls the symbol as value sequence of object values with a specified period time. (Defined by AnyTypeExtensions)
	PollValuesT	Polls the symbol values on timepoints where the polling observable streams data / triggers (Defined by AnyTypeExtensions)
	PollValuesT	Polls the symbol as value sequence of object values with a specified period time. (Defined by AnyTypeExtensions)
	PollValuesT	Polls the symbol values on timepoints where the polling observable streams data / triggers (Defined by AnyTypeExtensions)
	PollValuesT	Polls the symbol as value sequence of object values with a specified period time. (Defined by AnyTypeExtensions)
	PollValuesT	Polls the symbol values on timepoints where the polling observable streams data / triggers (Defined by AnyTypeExtensions)
	PollValuesT	Polls the symbol as value sequence of object values with a specified period time. (Defined by AnyTypeExtensions)
	PollValuesT	Polls the symbol values on time points where the polling observable streams data / triggers (Defined by AnyTypeExtensions)
	PollValuesT	Polls the symbol as value sequence of object values with a specified period time. (Defined by AnyTypeExtensions)
	PollValuesT	Polls the symbol values on timepoints where the polling observable streams data / triggers (Defined by AnyTypeExtensions)
	PollValuesT	Polls the symbol as value sequence of object values with a specified period time. (Defined by AnyTypeExtensions)
	PollValuesT	Polls the symbol values on time points where the polling observable streams data / triggers (Defined by AnyTypeExtensions)
	PollValuesT	Polls the symbol as value sequence of object values with a specified period time. (Defined by AnyTypeExtensions)
	PollValuesT	Polls the symbol values on timepoints where the polling observable streams data / triggers (Defined by AnyTypeExtensions)
	PollValuesT	Polls the symbol as value sequence of object values with a specified period time. (Defined by AnyTypeExtensions)
	PollValuesT	Polls the symbol values on timepoints where the polling observable streams data / triggers (Defined by AnyTypeExtensions)
	PollValuesT	Polls the symbol as value sequence of object values with a specified period time. (Defined by AnyTypeExtensions)
	PollValues2T	Polls the symbol values on timepoints where the polling observable streams data / triggers (Defined by AnyTypeExtensions)
	PollValues2T	Polls the symbol values on time points where the polling observable streams data / triggers (Defined by AnyTypeExtensions)
	ReadSysServState	Reads the System Service state (AdsSysServState) (Defined by SystemServiceExtension)
	ReadSysServStateAsync	Reads the System Service state (AdsSysServState) (asynchronous) (Defined by SystemServiceExtension)
	ReadWithFallback	Read with fallback. (Defined by AdsClientExtensions)
	ReadWithFallback	Ads Read with Fallback. (Defined by AdsClientExtensions)
	ReadWithFallback	Ads Read with Fallback. (Defined by AdsClientExtensions)
	ReadWithFallbackAsync	Ads Read with fallback as an asynchronous operation. (Defined by AdsClientExtensions)
	ReadWithFallbackAsync	Ads Read with fallback as an asynchronous operation. (Defined by AdsClientExtensions)
	ReadWithFallbackAsync	Ads Read with fallback as an asynchronous operation. (Defined by AdsClientExtensions)
	ReadWriteWithFallback	Ads Read with Fallback. (Defined by AdsClientExtensions)
	ReadWriteWithFallback	ReadWrite with Fallback. (Defined by AdsClientExtensions)
	ReadWriteWithFallbackAsync	Ads Read with fallback as an asynchronous operation. (Defined by AdsClientExtensions)
	ReadWriteWithFallbackAsync	Ads Read with fallback as an asynchronous operation. (Defined by AdsClientExtensions)
	RepeatedRead	Repeated AdsRead. (Defined by AdsClientExtensions)
	RepeatedRead	Repeated AdsRead. (Defined by AdsClientExtensions)
	RepeatedReadAsync	Repeated AdsRead as an asynchronous operation. (Defined by AdsClientExtensions)
	RepeatedReadAsync	Repeated AdsRead as an asynchronous operation. (Defined by AdsClientExtensions)
	RepeatedReadWrite	Repeated AdsRead. (Defined by AdsClientExtensions)
	RepeatedReadWriteAsync	Repeated AdsReadWrite as an asynchronous operation. (Defined by AdsClientExtensions)
	RepeatedWrite	Repeated AdsWrie. (Defined by AdsClientExtensions)
	RepeatedWriteAsync	Repeated AdsReadWrite as an asynchronous operation. (Defined by AdsClientExtensions)
	RestartTwinCATAsync	Sends a SystemService Restart to the target system and waits until the system has finished the state changes (SystemService, Port 10000) (asynchronously) (Defined by SystemServiceExtension)
	SetAdsState	Sends an AdsState/AdsStateCommand Request to an AdsServer and waits until the StateChange is done or fails. (Defined by ConnectionStateExtension)
	SetAdsStateAsync	Sends an AdsState/AdsStateCommand Request to an AdsServer and waits until the StateChange is done or fails (asynchronously) (Defined by ConnectionStateExtension)
	WaitForTargetState	Waits until the target AdsServer reaches the requested state. (Defined by ConnectionStateExtension)
	WaitForTargetStateAsync	Waits until the target AdsServer reaches the requested state (asynchronous) (Defined by ConnectionStateExtension)
	WaitUntilRestarted	Waits until the Restart is detected on the client (SystemService, Port 10000) (Defined by SystemServiceExtension)
	WaitUntilRestartedAsync	Waits until the SystemService Restart is detectd on the client (SystemService, Port 10000) (asynchronously) (Defined by SystemServiceExtension)
	WhenAdsStateChanges	Gets an observable sequence of AdsStates. (Defined by AdsClientExtensions)
	WhenNotification	Gets an observable sequence of Notifications. (Defined by AdsClientExtensions)
	WhenNotification	Gets an observable sequence of Notification objects. (Defined by AdsClientExtensions)
	WhenNotification	Gets an observable sequence of Notification objects. (Defined by AdsClientExtensions)
	WhenNotification	Gets an observable sequence of SymbolValueNotifications. (Defined by AdsClientExtensions)
	WhenNotification	Creates an observable sequence of values that are created by ADS Notifications. (Defined by AnyTypeExtensions)
	WhenNotificationT	Creates an observable sequence of values that are created by ADS Notifications. (Defined by AnyTypeExtensions)
	WhenSymbolVersionChanges	Gets an observable sequence of SymbolVersion changed counts. (Defined by AdsClientExtensions)
	WhenSymbolVersionChanges	Gets an observable sequence of SymbolVersion changed counts. (Defined by AdsClientExtensions)
	WhenValueChanged	Observable sequence of Values driven by ADS Notifications on the specified symbol. (Defined by ValueSymbolExtensions)
	WriteValuesT	Writes the sequence of values to the symbol specified by the instance path. (Defined by AnyTypeExtensions)
	WriteValuesT	Writes the sequence of values to the symbol specified by the instance path. (Defined by AnyTypeExtensions)

Remarks

The class AdsClient enables synchronous/asynchronous access to data of an ADS Device.

Example

The following sample shows how to instantiate and use the AdsClient class.

AdsClient Demo (async)

using System;
using System.Buffers.Binary;
using System.Threading;
using System.Threading.Tasks;
using TwinCAT.Ads;
using TwinCAT.TypeSystem;

namespace Sample
{
    class ClientAsync
    {
    /// <summary>
    /// Defines the entry point of the application.
    /// </summary>
    /// <param name="args">The arguments.</param>
    static async void Main(string[] args)
    {
        AmsAddress address = ArgParser.Parse(args);
        CancellationTokenSource cancelSource = new CancellationTokenSource();
        CancellationToken cancel = cancelSource.Token;

        using (AdsClient client = new AdsClient())
        {

        // Connect to Address
        client.Connect(address.NetId, address.Port); // Connect to Port (851, first PLC by default)

        // Read the identification and version number of the device
        ResultDeviceInfo resultDeviceInfo = await client.ReadDeviceInfoAsync(cancel);

        if (resultDeviceInfo.Succeeded)
        {
            DeviceInfo deviceInfo = resultDeviceInfo.DeviceInfo;
            Version version = deviceInfo.Version.ConvertToStandard();
            Console.WriteLine(string.Format("DeviceName: {0}", deviceInfo.Name));
            Console.WriteLine(string.Format("DeviceVersion: {0}", version.ToString(3)));
        }
        // Read the state of the device
        ResultReadDeviceState resultReadDeviceState = await client.ReadStateAsync(cancel);
        AdsState state = AdsState.Invalid;

        if (resultReadDeviceState.Succeeded)
        {
            StateInfo stateInfo = resultReadDeviceState.State;

            state = stateInfo.AdsState;
            short deviceState = stateInfo.DeviceState;
            Console.WriteLine(string.Format("DeviceState: {0}", deviceState));
            Console.WriteLine(string.Format("AdsState   : {0}", state));
        }

        // Write ADS Commands (write state) to target
        // Set PLC to Run

        if (state == AdsState.Stop)
        {
            await client.WriteControlAsync(AdsState.Run, 0, cancel);
        }

        //create variable handle for Plc Project Name (automatic generated symbol in PLC)
        ResultHandle resultHandle = await client.CreateVariableHandleAsync("TwinCAT_SystemInfoVarList._AppInfo.ProjectName", cancel);

        if (resultHandle.Succeeded)
        {
            uint handleProjectName = resultHandle.Handle;
            uint handleNotification = 0; // Notification Handle for Task1 CycleCount changes

            try
            {
            // Read value from target and Marshal data into string
            ResultReadBytes resultRead = await client.ReadAsync(handleProjectName, 256, cancel);

            if (resultRead.Succeeded)
            {
                PrimitiveTypeMarshaler marshaler = PrimitiveTypeMarshaler.Default;

                string projectName = null;
                int unmarshaledBytes = marshaler.Unmarshal(resultRead.Data.Span, out projectName);
                Console.WriteLine(string.Format("ProjectName  : {0}", projectName));
            }

            //_notificationBuffer = new byte[4]; // Sizeof UDINT
            int size = sizeof(UInt32); // Sizeof UDINT

            client.AdsNotification += client_NotificationEvent; // Register for Notification event

            //Register Notification for Task1 CycleCount symbol (automatic generated symbol in PLC)
            resultHandle = await client.AddDeviceNotificationAsync("TwinCAT_SystemInfoVarList._TaskInfo[1].CycleCount", size, NotificationSettings.Default, null, cancel);

            if (resultHandle.Succeeded)
            {
                handleNotification = resultHandle.Handle;
                // Sleep 10 Seconds to receive events
                await Task.Delay(10000, cancel); // Async Delay (some time for notifications)
            }
            }
            finally
            {
            // Cleanup all handles
            // Dispose all Streams

            ResultAds result = await client.DeleteDeviceNotificationAsync(handleNotification, cancel);

            // Always delete all variable handles.
            result = await client.DeleteVariableHandleAsync(handleProjectName, cancel);
            }
        }
        Console.WriteLine("");
        Console.WriteLine("Press [Enter] for leave:");
        Console.ReadLine();
        }
    }

AdsClient Demo (sync)

using System;
using System.Buffers.Binary;
using System.Threading;
using System.Threading.Tasks;
using TwinCAT.Ads;
using TwinCAT.TypeSystem;

namespace Sample
{
    class Client
    {
    /// <summary>
    /// Defines the entry point of the application.
    /// </summary>
    /// <param name="args">The arguments.</param>
    static void Main(string[] args)
    {
        AmsAddress address = ArgParser.Parse(args);

        using (AdsClient client = new AdsClient())
        {

        // Connect to Address
        client.Connect(address.NetId, address.Port); // Connect to Port (851, first PLC by default)

        // Read the identification and version number of the device
        DeviceInfo deviceInfo = client.ReadDeviceInfo();

        Version version = deviceInfo.Version.ConvertToStandard();
        Console.WriteLine(string.Format("DeviceName: {0}", deviceInfo.Name));
        Console.WriteLine(string.Format("DeviceVersion: {0}", version.ToString(3)));

        // Read the state of the device
        StateInfo stateInfo = client.ReadState();
        AdsState state = AdsState.Invalid;

        state = stateInfo.AdsState;
        short deviceState = stateInfo.DeviceState;
        Console.WriteLine(string.Format("DeviceState: {0}", deviceState));
        Console.WriteLine(string.Format("AdsState   : {0}", state));

        // Write ADS Commands (write state) to target
        // Set PLC to Run

        if (state == AdsState.Stop)
        {
            client.WriteControl(new StateInfo(AdsState.Run, 0));
        }

        //create variable handle for Plc Project Name (automatic generated symbol in PLC)
        uint handleProjectName = client.CreateVariableHandle("TwinCAT_SystemInfoVarList._AppInfo.ProjectName");
        uint handleNotification = 0; // Notification Handle for Task1 CycleCount changes

        try
        {
            // Read value from target and Marshal data into string
            var readResult = client.ReadAsResult(handleProjectName, 256);
            readResult.ThrowOnError(); // Throw if error

            PrimitiveTypeMarshaler marshaler = PrimitiveTypeMarshaler.Default;

            string projectName = null;
            int unmarshaledBytes = marshaler.Unmarshal(readResult.Data.Span, client.DefaultValueEncoding, out projectName);
            Console.WriteLine(string.Format("ProjectName  : {0}", projectName));

            //_notificationBuffer = new byte[4]; // Sizeof UDINT
            int size = sizeof(UInt32); // Sizeof UDINT

            client.AdsNotification += client_NotificationEvent; // Register for Notification event

            //Register Notification for Task1 CycleCount symbol (automatic generated symbol in PLC)
            handleNotification = client.AddDeviceNotification("TwinCAT_SystemInfoVarList._TaskInfo[1].CycleCount", size, NotificationSettings.Default, null);

            // Sleep 10 Seconds to receive events
            Thread.Sleep(10000); // Sleep to get notifications
        }
        finally
        {
            // Cleanup all handles
            // Dispose all Streams
            client.DeleteDeviceNotification(handleNotification);

            // Always delete all variable handles.
            client.DeleteVariableHandle(handleProjectName);
        }
        Console.WriteLine("");
        Console.WriteLine("Press [Enter] for leave:");
        Console.ReadLine();
        }
    }

Argument Parser

public static class ArgParser
{
    /// <summary>
    /// Parses the arguments.
    /// </summary>
    /// <param name="args">The arguments.</param>
    /// <returns>AmsAddress.</returns>
    public static AmsAddress Parse(string[] args)
    {
    AmsNetId netId = AmsNetId.Local;
    int port = 851;

    if (args != null)
    {
        if (args.Length > 0 && args[0] != null)
        netId = AmsNetId.Parse(args[0]);

        if (args.Length > 1 && args[1] != null)
        port = int.Parse(args[1]);
    }
    return new AmsAddress(netId, port);
    }
}

The following sample shows how to call (Remote Procedures / Methods) within the PLC directly from the AdsClient class.

RPC Call Example (async)

namespace Sample
{
    using System;
    using System.Diagnostics;
    using System.Threading;
    using TwinCAT.Ads;
    using TwinCAT.TypeSystem;

    class RpcCallAsync
    {
    /// <summary>
    /// Defines the entry point of the application.
    /// </summary>
    /// <param name="args">The arguments.</param>
    static async void Main(string[] args)
    {
        //Parse the AmsAddress from command-line arguments
        AmsAddress address = ArgParser.Parse(args);

        // Create the ADS Client
        using (AdsClient client = new AdsClient())
        {
        // Establish Connection
        client.Connect(address);

        // Call a Method that has the following signature (within the FunctionBlock instance 'fbInst')

        /*  {attribute 'TcRpcEnable'}
            METHOD PUBLIC M_Add : INT
            VAR_INPUT
            i1 : INT := 0;
            i2 : INT := 0;
            END_VAR 
        */

        ResultRpcMethod result1 = await client.InvokeRpcMethodAsync("fbInst", "M_Add", new object[] { (short)1, (short)4 }, CancellationToken.None);
        short result = (short)result1.ReturnValue;

        // Call a Method that has no parameter and returns VOID
        await client.InvokeRpcMethodAsync("fbInst", "M_Method1", new object[] { },CancellationToken.None);
        }
    }
    }
}

RPC Call Example (sync)

namespace Sample
{
    using System;
    using System.Diagnostics;
    using TwinCAT.Ads;
    using TwinCAT.TypeSystem;

    class RpcCall
    {
    /// <summary>
    /// Defines the entry point of the application.
    /// </summary>
    /// <param name="args">The arguments.</param>
    static void Main(string[] args)
    {
        //Parse the AmsAddress from command-line arguments
        AmsAddress address = ArgParser.Parse(args);

        // Create the ADS Client
        using (AdsClient client = new AdsClient())
        {
        // Establish Connection
        client.Connect(address);

        // Call a Method that has the following signature (within the FunctionBlock instance 'fbInst')

        /*  {attribute 'TcRpcEnable'}
            METHOD PUBLIC M_Add : INT
            VAR_INPUT
            i1 : INT := 0;
            i2 : INT := 0;
            END_VAR 
        */

        short result = (short)client.InvokeRpcMethod("fbInst", "M_Add", new object[] { (short)1, (short)4 });

        // Call a Method that has no parameter and returns VOID
        client.InvokeRpcMethod("fbInst", "M_Method1", new object[] { });
        }
    }
    }
}

Add a custom logger

static async void Main(string[] args)
{
    CancellationTokenSource cancelSource = new CancellationTokenSource();
    CancellationToken cancel = cancelSource.Token;

    var address = new AmsAddress(AmsNetId.Local, AmsPort.SystemService);
    var sessionSettings = SessionSettings.Default;

    //https://learn.microsoft.com/en-us/dotnet/core/extensions/logging?tabs=command-line

    // Create a configuration for the custom logger
    var loggerConfig = new AdsLoggerConfiguration
    {
    LogLevel = LogLevel.Information,
    EventId = 0
    };

    // Create an ILoggerFactory and add the custom logger provider
    var loggerFactory = LoggerFactory.Create(builder =>
    {
    //builder.SetMinimumLevel(LogLevel.Information)
    builder.AddProvider(new AdsLoggerProvider(() => loggerConfig))
       .AddConsole(); // Adds the console
    });

    // Use AdsClient with custom logger
    using (AdsClient client = new AdsClient(loggerFactory))
    {
    // Connect
    client.Connect(address);
    }

    // Use AdsSession with custom logger
    using (AdsSession session = new AdsSession(address, sessionSettings, loggerFactory))
    {
    // Connect
    session.Connect();
    }
}

Reference

TwinCAT.Ads Namespace

Beckhoff Automation GmbH & Co. KG 2001-2026