ads-client 1.14.2 → 2.0.0-beta.1

package/dist/ads-client.d.ts

@@ -0,0 +1,1562 @@
+import EventEmitter from "events";
+import type { ActiveSubscription, AdsClientConnection, AdsClientSettings, AdsCommandToSend, AdsDataTypeContainer, AdsSymbolContainer, AdsUploadInfo, ConnectionMetaData, SubscriptionSettings, ReadValueResult, WriteValueResult, VariableHandle, RpcMethodCallResult, CreateVariableHandleMultiResult, ReadRawMultiResult, ReadRawMultiCommand, WriteRawMultiResult, DeleteVariableHandleMultiResult, ReadWriteRawMultiResult, ReadWriteRawMultiCommand, WriteRawMultiCommand, ClientEvents, SubscriptionCallback, DebugLevel } from "./types/ads-client-types";
+import { AdsDataType, AdsDeviceInfo, AdsResponse, AdsState, AdsSymbol, AmsAddress, AmsTcpPacket } from "./types/ads-protocol-types";
+import * as ADS from './ads-commons';
+export * as ADS from './ads-commons';
+export type * from "./types/ads-client-types";
+export type * from './types/ads-protocol-types';
+export type * from './client-error';
+/**
+ * A class for handling TwinCAT ADS protocol communication.
+ *
+ * Settings are provided in constructor - see {@link Client.constructor} and {@link AdsClientSettings}.
+ *
+ * A client instance should be created for each target, however, a single client
+ * can also be used to communicate with multiple endpoints.
+ *
+ * @example
+ *
+ * ```js
+ * const client = new Client({
+ *  targetAmsNetId: "192.168.4.1.1.1",
+ *  targetAdsPort: 851
+ * });
+ * ```
+ */
+export declare class Client extends EventEmitter<ClientEvents> {
+    /**
+     * Debug instance for debug level 1.
+     */
+    private debug;
+    /**
+     * Debug instance for debug level 2.
+     */
+    private debugD;
+    /**
+     * Debug instance for debug level 3.
+     */
+    private debugIO;
+    /**
+     * Active debug level.
+     */
+    private debugLevel_;
+    /**
+     * Default metadata (when no active connection).
+     */
+    private defaultMetaData;
+    /**
+     * Callback used for AMS/TCP commands, such as port registering.
+     *
+     * When a response is received, `amsTcpCallback` is called with the response packet.
+     */
+    private amsTcpCallback?;
+    /**
+     * Buffer for received data.
+     *
+     * All received data from TCP socket is copied here for further processing.
+     */
+    private receiveBuffer;
+    /**
+     * Used TCP socket instance.
+     */
+    private socket?;
+    /**
+     * Handler for socket error event.
+     *
+     * Called when the socket emits error event (`socket.on("error")`).
+     */
+    private socketErrorHandler?;
+    /**
+     * Handler for socket close event.
+     *
+     * Called when the socket emits error event (`socket.on("close")`).
+     */
+    private socketConnectionLostHandler?;
+    /**
+     * Timer handle and ID of the timer used for automatic reconnecting.
+     */
+    private reconnectionTimer;
+    /**
+     * Timer handle and ID of the timer used for reading TwinCAT system state.
+     */
+    private tcSystemStatePollerTimer;
+    /**
+     * Timer handle of the timer used for detecting ADS port registeration timeout.
+     */
+    private portRegisterTimeoutTimer?;
+    /**
+     * Container for all active subscriptions.
+     */
+    private activeSubscriptions;
+    /**
+     * Container for previous subscriptions that were active
+     * before reconnecting or when PLC runtime symbol version changed.
+     */
+    private previousSubscriptions?;
+    /**
+     * Active ADS requests that are waiting for responses.
+     */
+    private activeAdsRequests;
+    /**
+     * Next invoke ID to be used for ADS requests.
+     */
+    private nextInvokeId;
+    /**
+     * Timestamp (epoch) when the conection to the remote was lost for the first time.
+     *
+     * Used for detecting if the connection has been lost for long enough
+     * for starting the reconnection.
+     */
+    private connectionDownSince?;
+    /**
+     * Active debug level (read-only).
+     *
+     * Use {@link Client.setDebugLevel} for setting debug level.
+     *
+     * Debug levels:
+     *  - 0: no debugging (default)
+     *  - 1: basic debugging (`$env:DEBUG='ads-client'`)
+     *  - 2: detailed debugging (`$env:DEBUG='ads-client,ads-client:details'`)
+     *  - 3: detailed debugging with raw I/O data (`$env:DEBUG='ads-client,ads-client:details,ads-client:raw-data'`)
+     *
+     * Debug data is available in the console (See [Debug](https://www.npmjs.com/package/debug) library for mode).
+    */
+    get debugLevel(): Readonly<DebugLevel>;
+    /**
+     * Active client settings.
+     *
+     * You can change some settings directly from this object on the fly, mainly
+     * some non-communication related ones.
+     *
+     * If the client is not yet connected, it's OK to change all settings from here.
+     *
+     * However, the most correct way is to use the {@link Client.constructor}.
+     *
+     * @example
+     *
+     * ```js
+     * client.settings.convertDatesToJavascript = false; //OK
+     * client.settings.targetAdsPort = 852; //Not OK if already connected (some things might break)
+     * ```
+     */
+    settings: Required<AdsClientSettings>;
+    /**
+     * Active connection information.
+     *
+     * See {@link AdsClientConnection}
+     */
+    connection: AdsClientConnection;
+    /**
+     * Active connection metadata.
+     *
+     * Metadata includes target device information, symbols, data types and so on.
+     *
+     * Some properties might not be available in all connection setups and setting combinations.
+     */
+    metaData: ConnectionMetaData;
+    /**
+     * Creates a new ADS client instance.
+     *
+     * Settings are provided in `settings` parameter - see {@link AdsClientSettings}.
+     *
+     * @example
+     *
+     * ```js
+     * const client = new Client({
+     *  targetAmsNetId: "192.168.4.1.1.1",
+     *  targetAdsPort: 851
+     * });
+     * ```
+     */
+    constructor(settings: AdsClientSettings);
+    /**
+     * Clears given timer if it's available and increases the ID.
+     *
+     * @param timerObject Timer object
+     */
+    private clearTimer;
+    /**
+     * Returns target AMS address as a string in a format `amsNetId:port`.
+     *
+     * @param targetOpts Optional target settings that override values in `settings`
+     */
+    private targetToString;
+    /**
+     * Writes given data buffer to the socket.
+     *
+     * @param data Data to write
+     */
+    private socketWrite;
+    /**
+     * Connects to the target.
+     *
+     * @param isReconnecting If `true`, reconnecting is in progress
+     */
+    private connectToTarget;
+    /**
+     * Unregisters ADS port from the router (if required and disconnects from the target.
+     *
+     * @param forceDisconnect If `true`, the connection is dropped immediately (default: `false`)
+     * @param isReconnecting If `true`, reconnecting is in progress (default: `false`)
+     */
+    private disconnectFromTarget;
+    /**
+     * Backups subscriptions, disconnects from the target, connects again to the target
+     * and restores the subscriptions.
+     *
+     * @param forceDisconnect If `true`, the connection is dropped immediately (default: `false`)
+     * @param isReconnecting If `true`, reconnecting is in progress (default: `false`)
+     *
+     * @throws Throws an error if connecting fails
+     */
+    private reconnectToTarget;
+    /**
+     * Registers a free ADS port from the AMS router.
+     *
+     * If the `settings.localAmsNetId` and `settings.localAdsPort` are set, does nothing.
+     */
+    private registerAdsPort;
+    /**
+     * Unregisters a previously registered ADS port from the AMS router.
+     *
+     * The remote seems to drop TCP connection after unregistering,
+     * so basically calling this always disconnects too.
+     */
+    private unregisterAdsPort;
+    /**
+     * Configures the connection to handle a TwinCAT PLC connection, which is the default
+     * assumption when using ads-client.
+     *
+     * This is not called if the `settings.rawClient` is `true`.
+     */
+    private setupPlcConnection;
+    /**
+     * Starts a poller that will read TwinCAT system state every `settings.connectionCheckInterval` milliseconds.
+     *
+     * This is used to detect connection operation and if the target TwinCAT system state has changed.
+     *
+     * This is not called if the `settings.rawClient` is `true`.
+     */
+    private startTcSystemStatePoller;
+    /**
+     * Reads active TwinCAT system state and detects if it has changed or if the connection is down.
+     *
+     * This is called from timer started by `startTcSystemStatePoller()`.
+     *
+     * Afterwards starts the poller timer again.
+     */
+    private checkTcSystemState;
+    /**
+     * A subscription callback that is called when the target PLC runtime state has changed.
+     *
+     * This is not called if the `settings.rawClient` is `true`.
+     *
+     * @param data Received data
+     * @param subscription The subscription object (unused here)
+     */
+    private onPlcRuntimeStateChanged;
+    /**
+     * A subscription callback that is called when the target PLC runtime symbol version has changed.
+     *
+     * @param data Received data
+     * @param subscription The subscription object (unused here)
+     */
+    private onPlcSymbolVersionChanged;
+    /**
+     * Event listener callback for TCP socket error event.
+     *
+     * See also {@link Client.socketErrorHandler} which is `onSocketError.bind(this)`
+     */
+    private onSocketError;
+    /**
+     * Handles a lost connection, called when connection to the remote is lost.
+     *
+     * The connection might be lost for example due to a closed socket, socket error,
+     * TwinCAT system state change or local router state change.
+     *
+     * @param socketFailure If `true`, the connection was lost due to a TCP socket problem (default: `false`)
+     */
+    private onConnectionLost;
+    /**
+     * Creates an AMS/TCP request from given packet object.
+     *
+     * @param packet Object containing the full AMS/TCP packet
+     */
+    private createAmsTcpRequest;
+    /**
+     * Creates an AMS header from given packet object.
+     *
+     * @param packet Object containing the full AMS/TCP packet
+     */
+    private createAmsHeader;
+    /**
+     * Creates an AMS/TCP header from given packet and AMS header
+     *
+     * @param packet Object containing the full AMS/TCP packet
+     * @param amsHeader Buffer containing the previously created AMS header
+     */
+    private createAmsTcpHeader;
+    /**
+     * Checks received data buffer for full AMS packets.
+     *
+     * If a full packet is found, it is passed forward.
+     *
+     * Calls itself recursively if multiple packets available.
+     * If so, calls also `setImmediate()` to prevent blocking the event loop.
+     */
+    private handleReceivedData;
+    /**
+     * Parses an AMS/TCP packet from given buffer and then handles it.
+     *
+     * @param data Buffer that contains data for a single full AMS/TCP packet
+     */
+    private parseAmsTcpPacket;
+    /**
+     * Parses an AMS/TCP header from given buffer.
+     *
+     * Returns the rest of the payload as data,
+     *
+     * @param data Buffer that contains data for a single full AMS/TCP packet
+     */
+    private parseAmsTcpHeader;
+    /**
+     * Parses an AMS header from given buffer.
+     *
+     * Returns the rest of the payload as data.
+     *
+     * @param data Buffer that contains data for a single AMS packet (without AMS/TCP header)
+     */
+    private parseAmsHeader;
+    /**
+     * Parses ADS data from given buffer.
+     *
+     * Uses `packet.ams` to determine the ADS command.
+    *
+    * @param data Buffer that contains data for a single ADS packet (without AMS/TCP header and AMS header)
+    */
+    private parseAdsResponse;
+    /**
+     * Handles the parsed AMS/TCP packet and actions/callbacks related to it.
+     *
+     * @param packet Fully parsed AMS/TCP packet, includes AMS/TCP header and if available, also AMS header and ADS data
+     */
+    private onAmsTcpPacketReceived;
+    /**
+     * Handles received ADS command.
+     *
+     * @param packet Fully parsed AMS/TCP packet, includes AMS/TCP header, AMS header and ADS data
+     */
+    private onAdsCommandReceived;
+    /**
+     * Called when local AMS router state has changed (router notification is received).
+     *
+     * Router state changes multiple times for example when local TwinCAT system
+     * is changed from `Config` -> `Run` and vice-versa. If connected to a local system, router state changes might also cause
+     * client the reconnect automatically.
+     *
+     * Router state is received from the router with AMS command `AMS_TCP_PORT_ROUTER_NOTE` (see {@link ADS.AMS_HEADER_FLAG.AMS_TCP_PORT_ROUTER_NOTE})
+     *
+     * @param state New router state
+     */
+    private onRouterStateChanged;
+    /**
+     * Parses received ADS notification data (stamps) from given data.
+     *
+     * @param data Raw data to convert
+     */
+    private parseAdsNotification;
+    /**
+     * Adds a new subscription to the target (an ADS device notification).
+     *
+     * Sends a `AddNotification` ADS command.
+     *
+     * @param settings Subscription settings / subscription to add
+     * @param internal If `true`, this is an internal subscription of the client
+     * @param targetOpts Optional target settings that override values in `settings` (**NOTE:** If used, no caching is available -> possible performance impact)
+     */
+    private addSubscription;
+    /**
+     * Unsubscribes from all active subscriptions.
+     *
+     * @param internals If `true`, also internal subscriptions are unsubscribed
+     */
+    private removeSubscriptions;
+    /**
+     * Backups active subscriptions for restoring them later (after reconnecting).
+     *
+     * Returns number of subscriptions that were saved for restoring.
+     *
+     * @param unsubscribe If `true`, {@link Client.unsubscribeAll()} is also called after saving
+     */
+    private backupSubscriptions;
+    /**
+     * Restores all previously backed up subscriptions.
+     *
+     * Returns array of subscription targets that failed to be subscribed
+     * (empty array if all were restored successfully).
+     */
+    private restoreSubscriptions;
+    /**
+     * Parses symbol from raw ADS response payload.
+     *
+     * @param data Data containing ADS symbol (without first 4 bytes of ADS payload containing entry length)
+     */
+    private parseAdsResponseSymbol;
+    /**
+     * Parses data type declaration from raw ADS response payload.
+     *
+     * @param data Data containing data type declaration (without first 4 bytes of ADS payload containing entry length)
+     */
+    private parseAdsResponseDataType;
+    /**
+     * Gets data type declaration for requested data type.
+     *
+     * **NOTE:** Only returns the requested data type and its direct children. Not the children of children.
+     *
+     * To get the full datatype with all items, use {@link Client.buildDataType()}.
+     *
+     * Returns previously cached value if available, otherwise reads it from the target
+     * and caches it.
+     *
+     * If caching is disabled using `settings.disableCaching`, data is always read from the target.
+     *
+     * If `targetOpts` is used to override target, caching is always disabled.
+     *
+     * @param name Data type name in the PLC (such as `ST_Struct`)
+     * @param targetOpts Optional target settings that override values in `settings` (**NOTE:** If used, no caching is available -> possible performance impact)
+     */
+    private getDataTypeDeclaration;
+    /**
+     * Builds full data type declaration for requested data type with all children (and their children and so on).
+     *
+     * If available, previously cached data is used for building the full data type. Otherwise data is read from the target
+     * and cached.
+     *
+     * If caching is disabled using `settings.disableCaching`, data is always read from the target.
+     *
+     * If `targetOpts` is used to override target, caching is always disabled.
+     *
+     * @param name Data type name in the PLC (such as `ST_Struct`)
+     * @param targetOpts Optional target settings that override values in `settings` (**NOTE:** If used, no caching is available -> possible performance impact)
+     * @param isRootType If `true`, this is the root type / first call / not recursive call (default: `true`)
+     * @param knownSize Data type size (if known) - used with pseudo data types and TwinCAT 2 primite types
+     */
+    private buildDataType;
+    /**
+     * Converts raw data to Javascript object (primitive PLC types only)
+     *
+     * @param buffer The raw data to convert
+     * @param dataType Target data type
+     */
+    private convertBufferToPrimitiveType;
+    /**
+     * Converts raw data to Javascript object.
+     *
+     * This is usually called recursively.
+     *
+     * @param data The raw data to convert
+     * @param dataType Target data type
+     * @param isArrayItem If `true`, this is an array item (default: `false`)
+     */
+    private convertBufferToObject;
+    /**
+     * Converts a Javascript object to raw data.
+     *
+     * @param value Javascript object to convert
+     * @param dataType Target data type
+     * @param objectPath Object path that is passed forward when calling recursively. This is used for error reporting if a property is missing
+     * @param isArrayItem If `true`, this is an array item (default: `false`)
+     */
+    private convertObjectToBuffer;
+    /**
+     * Converts a Javascript object (that is PLC primitive type) to raw data
+     *
+     * @param value Javascript object to convert
+     * @param dataType Data type
+     * @param buffer Reference to Buffer object where to write the raw value
+     */
+    private convertPrimitiveTypeToBuffer;
+    /**
+     * Merges objects recursively.
+     *
+     * Used for example in {@link Client.writeValue()} when `autoFill` setting is used
+     * to merge active values (missing properties) to user-provided properties.
+     *
+     * This is based on https://stackoverflow.com/a/34749873/8140625
+     * and https://stackoverflow.com/a/49727784/8140625 with some changes.
+     *
+     * @param caseSensitive If `true`, the property keys are handled as case-sensitive (as they normally are). In TwinCAT everything is case-insensitive --> `false`.
+     * @param target Target object where to merge source objects (this is the value provide by user)
+     * @param sources One or more source object, which keys are merged to target if target is missing them
+     */
+    private deepMergeObjects;
+    /**
+     * Connects to the target that is configured in {@link Client.settings} (set in {@link Client.constructor}).
+     *
+     * If success, returns the connection information (see {@link AdsClientConnection})
+     *
+     * @throws Throws an error if connecting fails
+     *
+     * @example
+     * ```js
+     * try {
+     *  const res = await client.connect();
+     *
+     *  console.log(`Connected to the ${res.targetAmsNetId}`);
+     *  console.log(`Router assigned us AmsNetId ${res.localAmsNetId} and port ${res.localAdsPort}`);
+     * } catch (err) {
+     *  console.log("Connecting failed:", err);
+     * }
+     * ```
+     */
+    connect(): Promise<Required<AdsClientConnection>>;
+    /**
+     * Disconnects from the target and closes active connection.
+     *
+     * Subscriptions are deleted in a handled manner and ADS port is unregisterd.
+     *
+     * **WARNING:** If `force` is used, active subscriptions are not deleted!
+     * This affects PLCs performance in the long run.
+     *
+     * @param force If `true`, the connection is dropped immediately (uncontrolled) - use only in special "emergency" cases (default: `false`)
+     *
+     * @throws Throws an error if disconnecting fails. However the connection stil ended.
+     *
+     * @example
+     * ```js
+     * try {
+     *  const res = await client.disconnect();
+     *  console.log("Disconnected");
+     * } catch (err) {
+     *  console.log("Disconnected with error:", err);
+     * }
+     * ```
+     */
+    disconnect(force?: boolean): Promise<void>;
+    /**
+     * Reconnects to the target (disconnects and then connects again).
+     *
+     * Active subscriptions are saved and restored automatically after reconnecting.
+     *
+     * **WARNING:** If `forceDisconnect` is used, active subscriptions are not deleted!
+     * This affects PLCs performance in the long run.
+     *
+     * @param forceDisconnect If `true`, the connection is dropped immediately (uncontrolled - as `force` in {@link Client.disconnect()}) - use only in special "emergency" cases (default: `false`)
+     *
+     * @throws Throws an error if connecting fails
+     */
+    reconnect(forceDisconnect?: boolean): Promise<Required<AdsClientConnection>>;
+    /**
+     * Sets active debug level.
+     *
+     * Debug levels:
+     *  - 0: no debugging (default)
+     *  - 1: basic debugging (`$env:DEBUG='ads-client'`)
+     *  - 2: detailed debugging (`$env:DEBUG='ads-client,ads-client:details'`)
+     *  - 3: detailed debugging with raw I/O data (`$env:DEBUG='ads-client,ads-client:details,ads-client:raw-data'`)
+     *
+     * Debug data is available in the console (See [Debug](https://www.npmjs.com/package/debug) library for mode).
+     */
+    setDebugLevel(level: DebugLevel): void;
+    /**
+     * Sends a raw ADS command to the target.
+     *
+     * This can be useful in some special cases or custom system. See {@link ADS.ADS_COMMAND} for common commands.
+     *
+     * **NOTE:** Client already includes all the most common commands:
+     * - {@link Client.readRaw}() - `Read` command
+     * - {@link Client.writeRaw}() - `Write` command
+     * - {@link Client.readDeviceInfo}() - `ReadDeviceInfo` command
+     * - {@link Client.readState}() - `ReadState` command
+     * - {@link Client.writeControl}() - `WriteControl` command
+     * - {@link Client.subscribe}() - `AddNotification` command
+     * - {@link Client.unsubscribe}() - `DeleteNotification` command
+     * - {@link Client.readWriteRaw}() - `ReadWrite` command
+     *
+     * @template T ADS response type. If omitted, generic {@link AdsResponse} type is used
+     *
+     * @throws Throws an error if sending the command fails or if target responds with an error
+     *
+     * @example
+     * ```js
+     * TODO - DOCUMENTATION ONGOING
+     * ```
+     */
+    sendAdsCommand<T = AdsResponse>(command: AdsCommandToSend): Promise<AmsTcpPacket<T>>;
+    /**
+     * Sends an ADS `WriteControl` command to the target.
+     *
+     * More info: [Beckhoff documentation](https://infosys.beckhoff.com/content/1033/tc3_ads_intro/115879947.html?id=4720330147059483431)
+     *
+     * @param adsState Requested ADS state - see {@link ADS.ADS_STATE}. Can be a number or a valid string, such as `Config`
+     * @param deviceState  Requested device state (default: `0`)
+     * @param data Additional data to send (if any)
+     * @param targetOpts Optional target settings that override values in `settings`
+     *
+     * @throws Throws an error if sending the command fails or if the target responds with an error.
+     *
+     * @example
+     * ```js
+     * try {
+     *  //Set target (PLC) to run
+     *  await client.writeControl("Run");
+     * } catch (err) {
+     *  console.log("Error:", err);
+     * }
+     * ```
+     */
+    writeControl(adsState: keyof typeof ADS.ADS_STATE | number, deviceState?: number, data?: Buffer, targetOpts?: Partial<AmsAddress>): Promise<void>;
+    /**
+     * Starts the target PLC runtime. Same as pressing the green play button in TwinCAT XAE.
+     *
+     * **NOTE:** This requires that the target is a PLC runtime or has equivalent ADS protocol support.
+     *
+     * @param targetOpts Optional target settings that override values in `settings`
+     *
+     * @throws Throws an error if sending the command fails or if target responds with an error
+     *
+     * @example
+     * ```js
+     * try {
+     *  await client.startPlc();
+     * } catch (err) {
+     *  console.log("Error:", err);
+     * }
+     * ```
+     */
+    startPlc(targetOpts?: Partial<AmsAddress>): Promise<void>;
+    /**
+     * Resets the target PLC runtime. Same as reset cold in TwinCAT XAE.
+     *
+     * @param targetOpts Optional target settings that override values in `settings`
+     *
+     * @throws Throws an error if sending the command fails or if the target responds with an error.
+     *
+     * @example
+     * ```js
+     * try {
+     *  await client.resetPlc();
+     * } catch (err) {
+     *  console.log("Error:", err);
+     * }
+     * ```
+     */
+    resetPlc(targetOpts?: Partial<AmsAddress>): Promise<void>;
+    /**
+     * Stops the target PLC runtime. Same as pressing the red stop button in TwinCAT XAE.
+     *
+     * @param targetOpts Optional target settings that override values in `settings`
+     *
+     * @throws Throws an error if sending the command fails or if the target responds with an error.
+     *
+     * @example
+     * ```js
+     * try {
+     *  await client.stopPlc();
+     * } catch (err) {
+     *  console.log("Error:", err);
+     * }
+     * ```
+     */
+    stopPlc(targetOpts?: Partial<AmsAddress>): Promise<void>;
+    /**
+     * Restarts the PLC runtime. Same as calling first {@link resetPlc}() and then {@link startPlc}()`
+     *
+     * **NOTE:** This requires that the target is a PLC runtime or has equivalent ADS protocol support.
+     *
+     * @example
+     * ```js
+     * try {
+     *  await client.restartPlc();
+     * } catch (err) {
+     *  console.log("Error:", err);
+     * }
+     * ```
+     *
+     * @param targetOpts Optional target settings that override values in `settings`
+     *
+     * @throws Throws an error if sending the command fails or if the target responds with an error.
+     *
+     */
+    restartPlc(targetOpts?: Partial<AmsAddress>): Promise<void>;
+    /**
+     * Sets the target TwinCAT system to run mode. Same as **Restart TwinCAT system** in TwinCAT XAE.
+     *
+     * **NOTE:** As default, also reconnects the client afterwards to restore subscriptions.
+     *
+     * @example
+     * ```js
+     * try {
+     *  //Reconnect the client
+     *  await client.setTcSystemToRun();
+     *
+     *  //Don't reconnect the client
+     *  await client.setTcSystemToRun(false);
+     * } catch (err) {
+     *  console.log("Error:", err);
+     * }
+     * ```
+     *
+     * @param reconnect If `true`, connection is reconnected afterwards to restore subscriptions etc. (default: `true`)
+     * @param targetOpts Optional target settings that override values in `settings`
+     *
+     * @throws Throws an error if sending the command fails or if the target responds with an error.
+     *
+     */
+    setTcSystemToRun(reconnect?: boolean, targetOpts?: Partial<AmsAddress>): Promise<void>;
+    /**
+     * Sets the target TwinCAT system to config mode. Same as **Restart TwinCAT (Config mode)** in TwinCAT XAE.
+     *
+     * **NOTE:** If the target is a PLC runtime, the connection might be lost.
+     *
+     * @example
+     * ```js
+     * try {
+     *  await client.setTcSystemToConfig();
+     * } catch (err) {
+     *  console.log("Error:", err);
+     * }
+     * ```
+     *
+     * @param targetOpts Optional target settings that override values in `settings`
+     *
+     * @throws Throws an error if sending the command fails or if the target responds with an error.
+     *
+     */
+    setTcSystemToConfig(targetOpts?: Partial<AmsAddress>): Promise<void>;
+    /**
+     * Restarts the target TwinCAT system.
+     *
+     * Just a wrapper for {@link setTcSystemToRun}() - the operation is the same.
+     *
+     * **NOTE:** As default, also reconnects the client afterwards to restore subscriptions.
+     *
+     * @example
+     * ```js
+     * try {
+     *  //Reconnect the client
+     *  await client.restartTcSystem();
+     *
+     *  //Don't reconnect the client
+     *  await client.restartTcSystem(false);
+     * } catch (err) {
+     *  console.log("Error:", err);
+     * }
+     * ```
+     *
+     * @param reconnect If `true`, connection is reconnected afterwards to restore subscriptions etc. (default: `true`)
+     * @param targetOpts Optional target settings that override values in `settings`
+     *
+     * @throws Throws an error if sending the command fails or if the target responds with an error.
+     *
+     */
+    restartTcSystem(reconnect?: boolean, targetOpts?: Partial<AmsAddress>): Promise<void>;
+    /**
+     * Returns symbol for given variable path, such as `GVL_Test.ExampleStruct`.
+     *
+     * Returns previously cached value if available, otherwise reads it from the target
+     * and caches it.
+     *
+     * If caching is disabled using `settings.disableCaching`, data is always read from the target.
+     *
+     * If `targetOpts` is used to override target, caching is always disabled.
+     *
+     * **NOTE:** This requires that the target is a PLC runtime or has equivalent ADS protocol support.
+     *
+     * @example
+     * ```js
+     * try {
+     *  const symbol = await client.getSymbol('GVL_Test.ExampleStruct');
+     * } catch (err) {
+     *  console.log("Error:", err);
+     * }
+     * ```
+     *
+     * @param path Symbol variable path at the target (such as `GVL_Test.ExampleStruct`)
+     * @param targetOpts Optional target settings that override values in `settings`. If used, caching is disabled -> possible performance impact.
+     *
+     * @throws Throws an error if sending the command fails or if the target responds with an error.
+     */
+    getSymbol(path: string, targetOpts?: Partial<AmsAddress>): Promise<AdsSymbol>;
+    /**
+     * Returns full data type declaration for requested data type (such as `ST_Struct`) with all children (and their children and so on).
+     *
+     * If available, previously cached data is used for building the full data type. Otherwise data is read from the target
+     * and cached.
+     *
+     * If caching is disabled using `settings.disableCaching`, data is always read from the target.
+     *
+     * If `targetOpts` is used to override target, caching is always disabled.
+     *
+     * **NOTE:** This requires that the target is a PLC runtime or has equivalent ADS protocol support.
+     *
+     * @example
+     * ```js
+     * try {
+     *  const dataType = await client.getDataType('ST_Struct');
+     * } catch (err) {
+     *  console.log("Error:", err);
+     * }
+     * ```
+     *
+     * @param name Data type name at the target (such as `ST_Struct`)
+     * @param targetOpts Optional target settings that override values in `settings`. If used, caching is disabled -> possible performance impact.
+     *
+     * @throws Throws an error if sending the command fails or if the target responds with an error.
+     */
+    getDataType(name: string, targetOpts?: Partial<AmsAddress>): Promise<AdsDataType>;
+    /**
+     * Reads target ADS state - see {@link ADS.ADS_STATE}).
+     *
+     * This is the ADS protocol `ReadState` command.
+     *
+     * See also {@link readPlcRuntimeState}() and {@link readTcSystemState}().
+     *
+     * @example
+     * ```js
+     * try {
+     *  const state = await client.readState();
+     * } catch (err) {
+     *  console.log("Error:", err);
+     * }
+     * ```
+     *
+     * @param targetOpts Optional target settings that override values in `settings`
+     *
+     * @throws Throws an error if sending the command fails or if the target responds with an error.
+     */
+    readState(targetOpts?: Partial<AmsAddress>): Promise<AdsState>;
+    /**
+     * Reads target PLC runtime state (usually `Run`, `Stop` etc. - see {@link ADS.ADS_STATE})
+     *
+     * If `targetOpts` is not used to override target, the state is also
+     * saved to the `metaData.plcRuntimeState`.
+     *
+     * This is the same as {@link readState}(), except that the result is saved to
+     * the `metaData.plcRuntimeState`.
+     *
+     * **NOTE:** This requires that the target is a PLC runtime or has equivalent ADS protocol support.
+     *
+     * @example
+     * ```js
+     * try {
+     *  const plcState = await client.readPlcRuntimeState();
+     * } catch (err) {
+     *  console.log("Error:", err);
+     * }
+     * ```
+     *
+     * @param targetOpts Optional target settings that override values in `settings`
+     *
+     * @throws Throws an error if sending the command fails or if the target responds with an error.
+     */
+    readPlcRuntimeState(targetOpts?: Partial<AmsAddress>): Promise<AdsState>;
+    /**
+     * Reads target TwinCAT system state from ADS port 10000 (usually `Run` or `Config`).
+     *
+     * If `targetOpts` is not used to override target, the state is also
+     * saved to the `metaData.tcSystemState`.
+     *
+     * This is the same as {@link readState}(), except that the result is saved to
+     * the `metaData.tcSystemState`.
+     *
+     * @example
+     * ```js
+     * try {
+     *  const tcSystemState = await client.readTcSystemState();
+     * } catch (err) {
+     *  console.log("Error:", err);
+     * }
+     * ```
+     *
+     * @param targetOpts Optional target settings that override values in `settings`
+     *
+     * @throws Throws an error if sending the command fails or if the target responds with an error.
+     */
+    readTcSystemState(targetOpts?: Partial<AmsAddress>): Promise<AdsState>;
+    /**
+     * Reads target PLC runtime symbol version.
+     *
+     * Symbol version usually changes when the PLC software is updated with download.
+     *
+     * **NOTE:** This requires that the target is a PLC runtime or has equivalent ADS protocol support.
+     *
+     * Note that if `settings.rawClient` is not used, the symbol version should
+     * already be up-to-date in `metaData.plcSymbolVersion`, as the client
+     * subscribes to its changes during connecting.
+     *
+     * If `targetOpts` is not used to override target, the state is also
+     * saved to the `metaData.plcSymbolVersion`.
+     *
+     * @example
+     * ```js
+     * try {
+     *  const symbolVersion = await client.readPlcSymbolVersion();
+     * } catch (err) {
+     *  console.log("Error:", err);
+     * }
+     * ```
+     *
+     * @param targetOpts Optional target settings that override values in `settings`
+     *
+     * @throws Throws an error if sending the command fails or if the target responds with an error.
+     */
+    readPlcSymbolVersion(targetOpts?: Partial<AmsAddress>): Promise<number>;
+    /**
+     * Subscribes to symbol value change notifications (ADS notifications) by variable path,
+     * such as `GVL_Test.ExampleStruct`.
+     *
+     * Provided callback is called with the latest value of the symbol when the value changes or when
+     * enough time has passed (depending on settings).
+     *
+     * **NOTE**: Consider using `subscribe()` instead, this is just a wrapper for it.
+     *
+     * **NOTE:** This requires that the target is a PLC runtime or has equivalent ADS protocol support.
+     *
+     * @example
+     * ```js
+     * //Checks if value has changed every 100ms
+     * //Callback is called only when the value has changed
+     * await client.subscribeSymbol(
+     *  'GVL_Test.ExampleStruct.',
+     *  (data, subscription) => {
+     *   console.log(`Value of ${subscription.symbol.name} has changed: ${data.value}`);
+     *  },
+     *  100
+     * );
+     * ```
+     *
+     * @param path Variable path in the PLC  (such as `GVL_Test.ExampleStruct`)
+     * @param callback Callback function to call when a new value is received (`(data, subscription) => {}`)
+     * @param cycleTime Cycle time for subscription (default: `200 ms`)
+     *
+     * - If `sendOnChange` is `true` (default), PLC checks if value has changed with `cycleTime` interval.
+     * If the value has changed, the PLC sends the value and the callback is called.
+     * - If `sendOnChange` is `false`, PLC constantly sends the value with `cycleTime` interval
+     * and the callback is called.
+     *
+     * @param sendOnChange Send a new value only when the value has changed (default: `true`)
+     *
+     * - If `true` (default), the PLC checks the value for changes every `cycleTime` milliseconds. If the value has changed, PLC sends the new value and the callback is called.
+     * - If `false`, the PLC sends the value cyclically every `cycleTime` milliseconds (and the callback is called)
+     *
+     * NOTE: When subscribing, the value is always sent once.
+     *
+     * @param maxDelay How long the PLC waits before sending the value at maximum? (default: `0` ms --> maximum delay is off)
+     *
+     * If the value is not changing, the first notification with the active value after subscribing is sent after `maxDelay`.
+     *
+     * If the value is changing, the PLC sends one or more notifications every `maxDelay`.
+     *
+     * So if `cycleTime` is 100 ms, `maxDelay` is 1000 ms and value changes every 100 ms, the PLC sends 10 notifications every 1000 ms.
+     * This can be useful for throttling.
+     *
+     * @param targetOpts Optional target settings that override values in `settings`. If used, caching
+     * is disabled -> possible performance impact.
+     *
+     * @throws Throws an error if sending the command fails or if the target responds with an error.
+     *
+     * @template T In Typescript, the data type of the value, for example `subscribeSymbol<number>(...)` or `subscribeSymbol<ST_TypedStruct>(...)`. (default: `any`)
+     *
+     */
+    subscribeSymbol<T = any>(path: string, callback: SubscriptionCallback<T>, cycleTime?: number, sendOnChange?: boolean, maxDelay?: number, targetOpts?: Partial<AmsAddress>): Promise<ActiveSubscription<T>>;
+    /**
+     * Subscribes to raw value change notifications (ADS notifications) by raw ADS address (index group, index offset and data length).
+     *
+     * Provided callback is called with the latest value when the value changes or when
+     * enough time has passed (depending on settings).
+     *
+     * **NOTE**: Consider using `subscribe()` instead, this is just a wrapper for it.
+     *
+     * **NOTE:** This requires that the target is a PLC runtime or has equivalent ADS protocol support.
+     *
+     * @example
+     * ```js
+     * //Checks if value has changed every 100ms
+     * //Callback is called only when the value has changed
+     * await client.subscribeRaw(16448, 414816, 2, (data, subscription) => {
+     *   console.log(`Value has changed: ${data.value.toString('hex')}`);
+     *  }, 100);
+     * ```
+     *
+     * @param indexGroup Index group (address) of the data to subscribe to
+     * @param indexOffset Index offset (address) of the data to subscribe to
+     * @param size Data length (bytes)
+     * @param callback Callback function to call when a new value is received (`(data, subscription) => {}`)
+     * @param cycleTime Cycle time for subscription (default: `200 ms`)
+     *
+     * - If `sendOnChange` is `true` (default), PLC checks if value has changed with `cycleTime` interval.
+     * If the value has changed, the PLC sends the value and the callback is called.
+     * - If `sendOnChange` is `false`, PLC constantly sends the value with `cycleTime` interval
+     * and the callback is called.
+     *
+     * @param sendOnChange Send a new value only when the value has changed (default: `true`)
+     *
+     * - If `true` (default), the PLC checks the value for changes every `cycleTime` milliseconds. If the value has changed, PLC sends the new value and the callback is called.
+     * - If `false`, the PLC sends the value cyclically every `cycleTime` milliseconds (and the callback is called)
+     *
+     * NOTE: When subscribing, the value is always sent once.
+     *
+     * @param maxDelay How long the PLC waits before sending the value at maximum? (default: `0` ms --> maximum delay is off)
+     *
+     * If the value is not changing, the first notification with the active value after subscribing is sent after `maxDelay`.
+     *
+     * If the value is changing, the PLC sends one or more notifications every `maxDelay`.
+     *
+     * So if `cycleTime` is 100 ms, `maxDelay` is 1000 ms and value changes every 100 ms, the PLC sends 10 notifications every 1000 ms.
+     * This can be useful for throttling.
+     *
+     * @param targetOpts Optional target settings that override values in `settings`. If used, caching
+     * is disabled -> possible performance impact.
+     *
+     * @throws Throws an error if sending the command fails or if the target responds with an error.
+     */
+    subscribeRaw(indexGroup: number, indexOffset: number, size: number, callback: SubscriptionCallback<Buffer>, cycleTime?: number, sendOnChange?: boolean, maxDelay?: number, targetOpts?: Partial<AmsAddress>): Promise<ActiveSubscription<Buffer>>;
+    /**
+     * Subscribes to value change notifications (ADS notifications) by variable path
+     * (such as `GVL_Test.ExampleStruct`) or raw ADS address (index group, index offset and data length).
+     *
+     * Provided callback is called with the latest value when the value changes or when
+     * enough time has passed (depending on settings).
+     *
+     * **NOTE:** This requires that the target is a PLC runtime or has equivalent ADS protocol support.
+     *
+     * @example
+     * ```js
+     * //Checks if value has changed every 100ms
+     * //Callback is called only when the value has changed
+     * await client.subscribe({
+     *  target: 'GVL_Test.ExampleStruct',
+     *  callback: (data, subscription) => {
+     *    console.log(`Value of ${subscription.symbol.name} has changed: ${data.value}`);
+     *  },
+     *  cycleTime: 100
+     * });
+     * ```
+     *
+     * @example
+     * ```js
+     * //Checks if value has changed every 100ms
+     * //Callback is called only when the value has changed
+     * await client.subscribe({
+     *  target: {
+     *    indexGroup: 16448,
+     *    indexOffset: 414816,
+     *    size: 2
+     *  },
+     *  callback: (data, subscription) => {
+     *    console.log(`Value has changed: ${data.value}`);
+     *  },
+     *  cycleTime: 100
+     * });
+     * ```
+     *
+     * @param options Subscription options
+     * @param targetOpts Optional target settings that override values in `settings`. If used, caching
+     * is disabled -> possible performance impact.
+     *
+     * @throws Throws an error if sending the command fails or if the target responds with an error.
+     *
+     * @template T In Typescript, the data type of the value, for example `subscribe<number>(...)` or `subscribe<ST_TypedStruct>(...)`. If the target is a raw address, use `subscribe<Buffer>`. (default: `any`)
+     */
+    subscribe<T = any>(options: SubscriptionSettings<T>, targetOpts?: Partial<AmsAddress>): Promise<ActiveSubscription<T>>;
+    /**
+     * Unsubscribes the subscription (deletes ADS notification).
+     *
+     * PLC stops checking the value for changes (if configured so) and no longer sends new values.
+     *
+     * @example
+     * ```js
+     * const sub = await client.subscribe(...);
+     *
+     * //later
+     * try {
+     *  await client.unsubscribe(sub);
+     * } catch (err) {
+     *  console.log("Error:", err);
+     * }
+     * ```
+     *
+     * @param subscription Subscription to unsubscribe (created previously by subscribing for example using `subscribe()`)
+     *
+     * @throws Throws an error if sending the command fails or if the target responds with an error.
+     */
+    unsubscribe(subscription: ActiveSubscription): Promise<void>;
+    /**
+     * Unsubscribes all active subscription (deletes all ADS notifications).
+     *
+     * PLC stops checking the values for changes (if configured so) and no longer sends new values.
+     *
+     * @example
+     * ```js
+     * const sub = await client.subscribe(...);
+     * const sub2 = await client.subscribe(...);
+     *
+     * //later
+     * try {
+     *  await client.unsubscribeAll();
+     * } catch (err) {
+     *  console.log("Error:", err);
+     * }
+     * ```
+     *
+     * @throws Throws an error if sending the command fails or if the target responds with an error.
+     */
+    unsubscribeAll(): Promise<void>;
+    /**
+     * Reads target device information.
+     *
+     * This is the ADS protocol `ReadDeviceInfo` command.
+     *
+     * If `targetOpts` is not used to override target, the state is also
+     * saved to the `metaData.deviceInfo`.
+     *
+     * @example
+     * ```js
+     * try {
+     *  const deviceInfo = await client.readDeviceInfo();
+     * } catch (err) {
+     *  console.log("Error:", err);
+     * }
+     * ```
+     *
+     * @param targetOpts Optional target settings that override values in `settings`
+     *
+     * @throws Throws an error if sending the command fails or if the target responds with an error.
+     */
+    readDeviceInfo(targetOpts?: Partial<AmsAddress>): Promise<AdsDeviceInfo>;
+    /**
+     * Reads target PLC runtime upload information.
+     *
+     * Upload information includes information about target PLC runtime data types and symbols (count and total data length).
+     *
+     * **NOTE:** This requires that the target is a PLC runtime or has equivalent ADS protocol support.
+     *
+     * If `targetOpts` is not used to override target, the upload info is also
+     * saved to the `metaData.plcUploadInfo`.
+     *
+     * @example
+     * ```js
+     * try {
+     *  const uploadInfo = await client.readPlcUploadInfo();
+     * } catch (err) {
+     *  console.log("Error:", err);
+     * }
+     * ```
+     *
+     * @param targetOpts Optional target settings that override values in `settings`
+     *
+     * @throws Throws an error if sending the command fails or if the target responds with an error.
+     */
+    readPlcUploadInfo(targetOpts?: Partial<AmsAddress>): Promise<AdsUploadInfo>;
+    /**
+     * Returns all symbols from the target PLC runtime.
+     *
+     * **NOTE:** This requires that the target is a PLC runtime or has equivalent ADS protocol support.
+     *
+     * **WARNING:** The returned object might be VERY large!
+     *
+     * If `targetOpts` is not used to override target, the upload info is also
+     * saved to the `metaData.symbols`.
+     *
+     * @example
+     * ```js
+     * try {
+     *  const symbols = await client.getSymbols();
+     * } catch (err) {
+     *  console.log("Error:", err);
+     * }
+     * ```
+     *
+     * @throws Throws an error if sending the command fails or if the target responds with an error.
+     *
+     * @param targetOpts Optional target settings that override values in `settings`
+     */
+    getSymbols(targetOpts?: Partial<AmsAddress>): Promise<AdsSymbolContainer>;
+    /**
+     * Caches all symbols from the target PLC runtime.
+     *
+     * Can be used to pre-cache all symbols to speed up communication.
+     * Caching is only available for the original target configured in the settings.
+     *
+     * If caching is disabled using `settings.disableCaching` nothing is done.
+     *
+     * Calling `getSymbols()` without `targetOpts` has the same effect.
+     *
+     * **NOTE:** This requires that the target is a PLC runtime or has equivalent ADS protocol support.
+     *
+     * @example
+     * ```js
+     * try {
+     *  await client.cacheSymbols();
+     *  //client.metaData.plcSymbols now has all PLC runtime symbols
+     * } catch (err) {
+     *  console.log("Error:", err);
+     * }
+     * ```
+     *
+     * @throws Throws an error if sending the command fails or if the target responds with an error.
+     */
+    cacheSymbols(): Promise<void>;
+    /**
+     * Returns all target PLC runtime data types.
+     *
+     * If `targetOpts` is not used to override target and `settings.disableCaching` is not set,
+     * the results are cached.
+     *
+     * **WARNING: The returned object might be VERY large!**
+     *
+     * As default, the results do not have subitems constructred, unlike when calling `getDataType()`.
+     * To get all data types with full constructions (children and their children and so on), set parameter
+     * `fullTypes` to `true`. **WARNING: This heavily increases the result size and CPU usage.**
+     *
+     * @example
+     * ```js
+     * try {
+     *  const dataTypes = await client.getDataTypes();
+     *  //with built data types
+     *  const fullDataTypes = await client.getDataTypes(true);
+     * } catch (err) {
+     *  console.log("Error:", err);
+     * }
+     * ```
+     *
+     * @param buildFullTypes If `true`, all data types are built to include all subitems (and their subitems and so on)
+     * @param targetOpts Optional target settings that override values in `settings`
+     *
+     * @throws Throws an error if sending the command fails or if the target responds with an error.
+     */
+    getDataTypes(buildFullTypes?: boolean, targetOpts?: Partial<AmsAddress>): Promise<AdsDataTypeContainer>;
+    /**
+     * Caches all data types from the target PLC runtime.
+     *
+     * Can be used to pre-cache all data types to speed up communication.
+     * Caching is only available for the original target configured in the settings.
+     *
+     * If caching is disabled using `settings.disableCaching` nothing is done.
+     *
+     * Calling `getDataTypes()` without `targetOpts` has the same effect.
+     *
+     * **NOTE:** This requires that the target is a PLC runtime or has equivalent ADS protocol support.
+     *
+     * @example
+     * ```js
+     * try {
+     *  await client.cacheDataTypes();
+     *  //client.metaData.plcDataTypes now has all PLC runtime data types
+     * } catch (err) {
+     *  console.log("Error:", err);
+     * }
+     * ```
+     *
+     * @throws Throws an error if sending the command fails or if the target responds with an error.
+     */
+    cacheDataTypes(): Promise<void>;
+    /**
+     * **TODO - DOCUMENTATION ONGOING**
+     *
+     * Reads raw byte data from the target system by provided index group, index offset and data length (bytes)
+     *
+     * This is the `ADS read` command in ADS protocol.
+     *
+     * @param indexGroup Index group (address) of the data to read
+     * @param indexOffset Index offset (address) of the data to read
+     * @param size Data length to read (bytes)
+     * @param targetOpts Optional target settings that override values in `settings`
+     */
+    readRaw(indexGroup: number, indexOffset: number, size: number, targetOpts?: Partial<AmsAddress>): Promise<Buffer>;
+    /**
+     * **TODO - DOCUMENTATION ONGOING**
+     *
+     * Writes raw byte data to the target system by provided index group and index offset.
+     *
+     * This is the `ADS write` command in ADS protocol.
+     *
+     * @param indexGroup Index group (address) of the data to write to
+     * @param indexOffset Index offset (address) of the data to write to
+     * @param value Data to write
+     * @param targetOpts Optional target settings that override values in `settings`
+     */
+    writeRaw(indexGroup: number, indexOffset: number, value: Buffer, targetOpts?: Partial<AmsAddress>): Promise<void>;
+    /**
+     * **TODO - DOCUMENTATION ONGOING**
+     *
+     * Sends multiple readRaw() commands in one ADS packet
+     *
+     * Reads raw byte data from the target system by provided index group, index offset and data length (bytes)
+     *
+     * Uses ADS sum command under the hood (better performance)
+     *
+     * @param commands Array of read commands
+     * @param targetOpts Optional target settings that override values in `settings`
+     */
+    readRawMulti(commands: ReadRawMultiCommand[], targetOpts?: Partial<AmsAddress>): Promise<ReadRawMultiResult[]>;
+    /**
+     * **TODO - DOCUMENTATION ONGOING**
+     *
+     * Sends multiple writeRaw() commands in one ADS packet
+     *
+     * Writes raw byte data to the target system by provided index group and index offset.
+     *
+     * Uses ADS sum command under the hood (better performance)
+     *
+     * @param commands Array of write commands
+     * @param targetOpts Optional target settings that override values in `settings`
+     */
+    writeRawMulti(commands: WriteRawMultiCommand[], targetOpts?: Partial<AmsAddress>): Promise<WriteRawMultiResult[]>;
+    /**
+     * **TODO - DOCUMENTATION ONGOING**
+     *
+     * Reads raw byte data from the target system by symbol path.
+     *
+     * Supports also reading POINTER and REFERENCE values by using deference operator in path (`^`)
+     *
+     * This uses the ADS command `READ_SYMVAL_BYNAME` under the hood
+     *
+     * @param path Variable path in the PLC to read (such as `GVL_Test.ExampleStruct`)
+     * @param targetOpts Optional target settings that override values in `settings`
+     */
+    readRawByPath(path: string, targetOpts?: Partial<AmsAddress>): Promise<Buffer>;
+    /**
+     * **TODO - DOCUMENTATION ONGOING**
+     *
+     * Writes raw byte data to the target system by symbol path.
+     *
+     * Supports also reading POINTER and REFERENCE values by using deference operator in path (`^`)
+     *
+     * Unlike `readRawByPath()`, this uses variable handles under the hood, the as there is no direct ADS command available for this.
+     *
+     * @param path Variable path in the PLC to read (such as `GVL_Test.ExampleStruct`)
+     * @param value Data to write
+     * @param targetOpts Optional target settings that override values in `settings`
+     */
+    writeRawByPath(path: string, value: Buffer, targetOpts?: Partial<AmsAddress>): Promise<void>;
+    /**
+     * **TODO - DOCUMENTATION ONGOING**
+     *
+     * Writes raw data to the target and reads the result as raw data
+     *
+     * Uses `ADS ReadWrite` command
+     *
+     * @param indexGroup Address index group
+     * @param indexOffset Address index offset
+     * @param size How many bytes to read
+     * @param writeData Data to write
+     * @param targetOpts Optional target settings that override values in `settings`
+     */
+    readWriteRaw(indexGroup: number, indexOffset: number, size: number, writeData: Buffer, targetOpts?: Partial<AmsAddress>): Promise<Buffer>;
+    /**
+     * **TODO - DOCUMENTATION ONGOING**
+     *
+     * Sends multiple readWriteRaw() commands in one ADS packet
+     *
+     * Uses ADS sum command under the hood (better performance)
+     *
+     * @param commands Array of read write commands
+     * @param targetOpts Optional target settings that override values in `settings`
+     */
+    readWriteRawMulti(commands: ReadWriteRawMultiCommand[], targetOpts?: Partial<AmsAddress>): Promise<ReadWriteRawMultiResult[]>;
+    /**
+     * **TODO - DOCUMENTATION ONGOING**
+     *
+     * Reads a value by a variable path (such as `GVL_Test.ExampleStruct`) and converts the value to a Javascript object.
+     *
+     * Returns the converted value, the raw value, the data type and the symbol.
+     *
+     * @param path Variable path in the PLC to read (such as `GVL_Test.ExampleStruct`)
+     * @param targetOpts Optional target settings that override values in `settings`
+     *
+     * @template T In Typescript, the data type of the value, for example `readValue<number>(...)` or `readValue<ST_TypedStruct>(...)` (default: `any`)
+     */
+    readValue<T = any>(path: string, targetOpts?: Partial<AmsAddress>): Promise<ReadValueResult<T>>;
+    /**
+     * **TODO - DOCUMENTATION ONGOING**
+     *
+     * Reads a value by a symbol and converts the value to a Javascript object.
+     *
+     * Returns the converted value, the raw value, the data type and the symbol.
+     *
+     * @param symbol Symbol (acquired using `getSymbol()`)
+     * @param targetOpts Optional target settings that override values in `settings`
+     *
+     * @template T In Typescript, the data type of the value, for example `readValueBySymbol<number>(...)` or `readValueBySymbol<ST_TypedStruct>(...)` (default: `any`)
+     */
+    readValueBySymbol<T = any>(symbol: AdsSymbol, targetOpts?: Partial<AmsAddress>): Promise<ReadValueResult<T>>;
+    /**
+     * **TODO - DOCUMENTATION ONGOING**
+     *
+     * Writes a value by a variable path (such as `GVL_Test.ExampleStruct`). Converts the value from a Javascript object to a raw value.
+     *
+     * Returns the converted value, the raw value, the data type and the symbol.
+     *
+     * **NOTE:** Do not use `autoFill` for `UNION` types, it works without errors but the result isn't probably the desired one
+     *
+     * @param path Variable path in the PLC to read (such as `GVL_Test.ExampleStruct`)
+     * @param value Value to write
+     * @param targetOpts Optional target settings that override values in `settings`
+     * @param autoFill If true and data type is a container (`STRUCT`, `FUNCTION_BLOCK` etc.), missing properties are automatically **set to default values** (usually `0` or `''`)
+     *
+     * @template T In Typescript, the data type of the value, for example `writeValue<number>(...)` or `writeValue<ST_TypedStruct>(...)`
+     */
+    writeValue<T = any>(path: string, value: T, autoFill?: boolean, targetOpts?: Partial<AmsAddress>): Promise<WriteValueResult<T>>;
+    /**
+     * **TODO - DOCUMENTATION ONGOING**
+     *
+     * Writes a value by symbol. Converts the value from a Javascript object to a raw value.
+     *
+     * Returns the converted value, the raw value, the data type and the symbol.
+     *
+     * **NOTE:** Do not use `autoFill` for `UNION` types, it works without errors but the result isn't probably the desired one
+     *
+     * @param symbol Symbol (acquired using `getSymbol()`)
+     * @param value Value to write
+     * @param targetOpts Optional target settings that override values in `settings`
+     * @param autoFill If true and data type is a container (`STRUCT`, `FUNCTION_BLOCK` etc.), missing properties are automatically **set to default values** (usually `0` or `''`)
+     *
+     * @template T In Typescript, the data type of the value, for example `writeValue<number>(...)` or `writeValue<ST_TypedStruct>(...)`
+     */
+    writeValueBySymbol<T = any>(symbol: AdsSymbol, value: T, autoFill?: boolean, targetOpts?: Partial<AmsAddress>): Promise<WriteValueResult<T>>;
+    /**
+     * **TODO - DOCUMENTATION ONGOING**
+     *
+     * Returns a default (empty) Javascript object representing provided PLC data type.
+     *
+     * @param dataType Data type name in the PLC as string (such as `ST_Struct`) or `AdsDataType` object
+     * @param targetOpts Optional target settings that override values in `settings`
+     *
+     * @template T Typescript data type of the PLC data, for example `readValue<number>(...)` or `readValue<ST_TypedStruct>(...)`
+     */
+    getDefaultPlcObject<T = any>(dataType: string | AdsDataType, targetOpts?: Partial<AmsAddress>): Promise<T>;
+    /**
+     * **TODO - DOCUMENTATION ONGOING**
+     *
+     * Converts a raw byte value to a Javascript object.
+     *
+     * @param data Raw PLC data as Buffer (read for example with `readRaw()`)
+     * @param dataType Data type name in the PLC as string (such as `ST_Struct`) or `AdsDataType` object
+     * @param targetOpts Optional target settings that override values in `settings`
+     *
+     * @template T Typescript data type of the PLC data, for example `convertFromRaw<number>(...)` or `convertFromRaw<ST_TypedStruct>(...)`
+     */
+    convertFromRaw<T = any>(data: Buffer, dataType: string | AdsDataType, targetOpts?: Partial<AmsAddress>): Promise<T>;
+    /**
+     * **TODO - DOCUMENTATION ONGOING**
+     *
+     * Converts a Javascript object to raw byte data.
+     *
+     * **NOTE:** Do not use `autoFill` for `UNION` types, it works without errors but the result isn't probably the desired one
+     *
+     * @param value Javascript object that represents the `dataType` in target system
+     * @param dataType Data type name in the PLC as string (such as `ST_Struct`) or `AdsDataType` object
+     * @param autoFill If true and data type is a container (`STRUCT`, `FUNCTION_BLOCK` etc.), missing properties are automatically **set to default values** (usually `0` or `''`)
+     * @param targetOpts Optional target settings that override values in `settings`
+     *
+     * @template T Typescript data type of the PLC data, for example `convertFromRaw<number>(...)` or `convertFromRaw<ST_TypedStruct>(...)`
+     */
+    convertToRaw(value: any, dataType: string | AdsDataType, autoFill?: boolean, targetOpts?: Partial<AmsAddress>): Promise<Buffer>;
+    /**
+     * **TODO - DOCUMENTATION ONGOING**
+     *
+     * Creates a variable handle for a PLC symbol by given variable path
+     *
+     * Variable value can be accessed by using the handle with `readRawByHandle()` and `writeRawByHandle()`
+     *
+     * @param path Full variable path in the PLC (such as `GVL_Test.ExampleStruct`)
+     * @param targetOpts Optional target settings that override values in `settings` (**NOTE:** If used, no caching is available -> possible performance impact)
+     */
+    createVariableHandle(path: string, targetOpts?: Partial<AmsAddress>): Promise<VariableHandle>;
+    /**
+     * **TODO - DOCUMENTATION ONGOING**
+     *
+     * Sends multiple createVariableHandle() commands in one ADS packet
+     *
+     * Creates a variable handle for a PLC symbol by given variable path
+     *
+     * Variable value can be accessed by using the handle with `readRawByHandle()` and `writeRawByHandle()`
+     *
+     * Uses ADS sum command under the hood (better perfomance)
+     *
+     * @param paths Array of full variable paths in the PLC (such as `GVL_Test.ExampleStruct`)
+     * @param targetOpts Optional target settings that override values in `settings`
+     */
+    createVariableHandleMulti(paths: string[], targetOpts?: Partial<AmsAddress>): Promise<CreateVariableHandleMultiResult[]>;
+    /**
+     * **TODO - DOCUMENTATION ONGOING**
+     *
+     * Deletes a variable handle that was previously created using `createVariableHandle()`
+     *
+     * @param handle Variable handle to delete
+     * @param targetOpts Optional target settings that override values in `settings` (**NOTE:** If used, no caching is available -> possible performance impact)
+     */
+    deleteVariableHandle(handle: VariableHandle | number, targetOpts?: Partial<AmsAddress>): Promise<void>;
+    /**
+     * **TODO - DOCUMENTATION ONGOING**
+     *
+     * Sends multiple deleteVariableHandle() commands in one ADS packet
+     *
+     * Deletes a variable handle that was previously created using `createVariableHandle()`
+     *
+     * Uses ADS sum command under the hood (better performance)
+     *
+     * @param handles Array of variable handles to delete
+     * @param targetOpts Optional target settings that override values in `settings`
+     */
+    deleteVariableHandleMulti(handles: (VariableHandle | number)[], targetOpts?: Partial<AmsAddress>): Promise<DeleteVariableHandleMultiResult[]>;
+    /**
+     * **TODO - DOCUMENTATION ONGOING**
+     *
+     * Reads raw byte data from the target system by previously created variable handle
+     *
+     * @param handle Variable handle
+     * @param size Optional data length to read (bytes) - as default, size in handle is used if available. Uses 0xFFFFFFFF as fallback.
+     * @param targetOpts Optional target settings that override values in `settings` (**NOTE:** If used, no caching is available -> possible performance impact)
+     */
+    readRawByHandle(handle: VariableHandle | number, size?: number, targetOpts?: Partial<AmsAddress>): Promise<Buffer>;
+    /**
+     * **TODO - DOCUMENTATION ONGOING**
+     *
+     * Writes raw byte data to the target system by previously created variable handle
+     *
+     * @param handle Variable handle
+     * @param value Data to write
+     * @param targetOpts Optional target settings that override values in `settings` (**NOTE:** If used, no caching is available -> possible performance impact)
+     */
+    writeRawByHandle(handle: VariableHandle | number, value: Buffer, targetOpts?: Partial<AmsAddress>): Promise<void>;
+    /**
+     * **TODO - DOCUMENTATION ONGOING**
+     *
+     * Reads raw data by symbol
+     *
+     * @param symbol Symbol (acquired using `getSymbol()`)
+     * @param targetOpts Optional target settings that override values in `settings` (**NOTE:** If used, no caching is available -> possible performance impact)
+     */
+    readRawBySymbol(symbol: AdsSymbol, targetOpts?: Partial<AmsAddress>): Promise<Buffer>;
+    /**
+     * **TODO - DOCUMENTATION ONGOING**
+     *
+     * Writes raw data by symbol
+     *
+     * @param symbol Symbol (acquired using `getSymbol()`)
+     * @param value Data to write
+     * @param targetOpts Optional target settings that override values in `settings`
+     */
+    writeRawBySymbol(symbol: AdsSymbol, value: Buffer, targetOpts?: Partial<AmsAddress>): Promise<void>;
+    /**
+     * **TODO - DOCUMENTATION ONGOING**
+     *
+     * Invokes/calls a function block RPC method from PLC
+     *
+     * Returns method return value and/or outputs (if any)
+     *
+     * For RPC support, the method needs to have `{attribute 'TcRpcEnable'}` attribute above the `METHOD` definition
+     *
+     * @param path Full function block instance path in the PLC (such as `GVL_Test.ExampleBlock`)
+     * @param method Function block method name to call
+     * @param parameters Function block method parameters (inputs) (if any)
+     * @param targetOpts Optional target settings that override values in `settings`
+     *
+     * @template T Typescript data type of the method return value, for example `invokeRpcMethod<number>(...)` or `invokeRpcMethod<ST_TypedStruct>(...)`
+     * @template U Typescript data type of the method outputs object, for example `invokeRpcMethod<number, ST_TypedStruct>(...)`
+     */
+    invokeRpcMethod<T = any, U = Record<string, any>>(path: string, method: string, parameters?: Record<string, any>, targetOpts?: Partial<AmsAddress>): Promise<RpcMethodCallResult<T, U>>;
+}