ads-client 2.0.0-beta.1 → 2.0.0-beta.3

package/dist/ads-client.d.ts

@@ -1,29 +1,39 @@
 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';
+import type { ActiveSubscription, AdsClientConnection, AdsClientSettings, AdsCommandToSend, AdsDataTypeContainer, AdsSymbolContainer, AdsUploadInfo, ConnectionMetaData, SubscriptionSettings, ReadValueResult, WriteValueResult, VariableHandle, RpcMethodCallResult, CreateVariableHandleMultiResult, ReadRawMultiResult, ReadRawMultiCommand, WriteRawMultiResult, DeleteVariableHandleMultiResult, ReadWriteRawMultiResult, ReadWriteRawMultiCommand, WriteRawMultiCommand, SubscriptionCallback, DebugLevel, AdsClientEvents } from "./types/ads-client-types";
+import { AdsDataType, AdsDeviceInfo, AdsResponse, AdsState, AdsSymbol, AmsAddress, AmsTcpPacket } from "./types/ads-protocol-types";
 export type * from "./types/ads-client-types";
 export type * from './types/ads-protocol-types';
 export type * from './client-error';
+/**
+ * Common ADS constants and helper functions
+ *
+ * @category Client
+ */
+export * as ADS from './ads-commons';
 /**
  * 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.
+ * A client instance should be created for each target.
+ * However, a single client instance can also be used to communicate with
+ * multiple endpoints using the `targetOpts` parameter available in all methods.
  *
- * @example
+ * Client also emits different events, such as `client.on('connect', ...)`.
+ * See {@link AdsClientEvents} for all available events.
  *
+ * @example
  * ```js
  * const client = new Client({
  *  targetAmsNetId: "192.168.4.1.1.1",
  *  targetAdsPort: 851
  * });
  * ```
+ *
+ * @category Client
  */
-export declare class Client extends EventEmitter<ClientEvents> {
+export declare class Client extends EventEmitter<AdsClientEvents> {
     /**
      * Debug instance for debug level 1.
      */
@@ -169,6 +179,12 @@ export declare class Client extends EventEmitter<ClientEvents> {
      * ```
      */
     constructor(settings: AdsClientSettings);
+    /**
+     * Emits a warning, which results in a `warning` event, and a console message if `hideConsoleWarnings` is not set.
+     *
+     * @param message Warning message
+     */
+    private warn;
     /**
      * Clears given timer if it's available and increases the ID.
      *
@@ -573,14 +589,44 @@ export declare class Client extends EventEmitter<ClientEvents> {
      * - {@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
+     * try {
+     *  //Creating readRaw(16448, 414816, 2) command manually and sending it using sendAdsCommand()
+     *
+     *  const data = Buffer.alloc(12);
+     *  let pos = 0;
+     *
+     *  //0..3 IndexGroup
+     *  data.writeUInt32LE(16448, pos);
+     *  pos += 4;
+     *
+     *  //4..7 IndexOffset
+     *  data.writeUInt32LE(414816, pos);
+     *  pos += 4;
+     *
+     *  //8..11 Read data length
+     *  data.writeUInt32LE(2, pos);
+     *  pos += 4;
+     *
+     *  const res = await this.sendAdsCommand<AdsReadResponse>({
+     *    adsCommand: ADS.ADS_COMMAND.Read,
+     *    targetAmsNetId: targetOpts.amsNetId,
+     *    targetAdsPort: targetOpts.adsPort,
+     *    payload: data
+     *  });
+     *
+     *  console.log(res.ads.payload); //<Buffer ff 7f>
+     *
+     * } catch (err) {
+     *  console.log("Error:", err);
+     * }
      * ```
+     *
+     * @template T In Typescript, the type of the ADS response. If omitted, generic {@link AdsResponse} type is used.
+     *
+     * @throws Throws an error if sending the command fails or if target responds with an error
+     *
      */
     sendAdsCommand<T = AdsResponse>(command: AdsCommandToSend): Promise<AmsTcpPacket<T>>;
     /**
@@ -752,7 +798,7 @@ export declare class Client extends EventEmitter<ClientEvents> {
      */
     restartTcSystem(reconnect?: boolean, targetOpts?: Partial<AmsAddress>): Promise<void>;
     /**
-     * Returns symbol for given variable path, such as `GVL_Test.ExampleStruct`.
+     * Returns a symbol object for given variable path, such as `GVL_Test.ExampleStruct`.
      *
      * Returns previously cached value if available, otherwise reads it from the target
      * and caches it.
@@ -903,13 +949,13 @@ export declare class Client extends EventEmitter<ClientEvents> {
      */
     readPlcSymbolVersion(targetOpts?: Partial<AmsAddress>): Promise<number>;
     /**
-     * Subscribes to symbol value change notifications (ADS notifications) by variable path,
+     * Subscribes to value change notifications (ADS notifications) by a 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.
+     * Check also `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.
      *
@@ -917,7 +963,7 @@ export declare class Client extends EventEmitter<ClientEvents> {
      * ```js
      * //Checks if value has changed every 100ms
      * //Callback is called only when the value has changed
-     * await client.subscribeSymbol(
+     * await client.subscribeValue(
      *  'GVL_Test.ExampleStruct.',
      *  (data, subscription) => {
      *   console.log(`Value of ${subscription.symbol.name} has changed: ${data.value}`);
@@ -956,17 +1002,17 @@ export declare class Client extends EventEmitter<ClientEvents> {
      *
      * @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`)
+     * @template T In Typescript, the data type of the value, for example `subscribeValue<number>(...)` or `subscribeValue<ST_TypedStruct>(...)`. (default: `any`)
      *
      */
-    subscribeSymbol<T = any>(path: string, callback: SubscriptionCallback<T>, cycleTime?: number, sendOnChange?: boolean, maxDelay?: number, targetOpts?: Partial<AmsAddress>): Promise<ActiveSubscription<T>>;
+    subscribeValue<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).
+     * Subscribes to raw value change notifications (ADS notifications) by a 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.
+     * Check also `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.
      *
@@ -1082,6 +1128,17 @@ export declare class Client extends EventEmitter<ClientEvents> {
      * @throws Throws an error if sending the command fails or if the target responds with an error.
      */
     unsubscribe(subscription: ActiveSubscription): Promise<void>;
+    /**
+     * Sends a delete ADS notification command to the target system.
+     *
+     * Doesn't delete subscriptions, just sends the ADS command.
+     *
+     * @param notificationHandle Notification handle to delete (number)
+     * @param targetAmsAddress Target system address
+     *
+     * @throws NOTE: Throws error if failed
+     */
+    private deleteNotificationHandle;
     /**
      * Unsubscribes all active subscription (deletes all ADS notifications).
      *
@@ -1253,148 +1310,384 @@ export declare class Client extends EventEmitter<ClientEvents> {
      */
     cacheDataTypes(): Promise<void>;
     /**
-     * **TODO - DOCUMENTATION ONGOING**
+     * Reads raw data from the target system by a raw ADS address (index group, index offset and data length).
+     *
+     * This is the ADS protocol `Read` command.
      *
-     * Reads raw byte data from the target system by provided index group, index offset and data length (bytes)
+     * @example
+     * ```js
+     * try {
+     *  const data = await client.readRaw(16448, 414816, 2);
+     *  console.log(data); //<Buffer ff 7f>
      *
-     * This is the `ADS read` command in ADS protocol.
+     *  const converted = await client.convertFromRaw(data, 'INT');
+     *  console.log(converted); //32767
+     *
+     * } catch (err) {
+     *  console.log("Error:", err);
+     * }
+     * ```
      *
      * @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`
+     *
+     * @throws Throws an error if sending the command fails or if the target responds with an error.
      */
     readRaw(indexGroup: number, indexOffset: number, size: number, targetOpts?: Partial<AmsAddress>): Promise<Buffer>;
     /**
-     * **TODO - DOCUMENTATION ONGOING**
+     * Writes raw data to the target system by a raw ADS address (index group, index offset and data length).
      *
-     * Writes raw byte data to the target system by provided index group and index offset.
+     * This is the ADS protocol `Write` command.
+     *
+     * @example
+     * ```js
+     * try {
+     *  const data = await client.convertToRaw(32767, 'INT');
+     *  console.log(data); //<Buffer ff 7f>
      *
-     * This is the `ADS write` command in ADS protocol.
+     *  await client.writeRaw(16448, 414816, data);
+     * } catch (err) {
+     *  console.log("Error:", err);
+     * }
+     * ```
      *
      * @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`
+     *
+     * @throws Throws an error if sending the command fails or if the target responds with an error.
      */
     writeRaw(indexGroup: number, indexOffset: number, value: Buffer, targetOpts?: Partial<AmsAddress>): Promise<void>;
     /**
-     * **TODO - DOCUMENTATION ONGOING**
+     * Sends multiple `readRaw()` commands in one ADS packet.
      *
-     * Sends multiple readRaw() commands in one ADS packet
+     * Reads raw data from the target system by a raw ADS addresses (index group, index offset and data length).
+     * Results are returned for each command separately - see {@link ReadRawMultiResult} for details.
      *
-     * 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 and faster performance).
+     * See [Beckhoff Information System](https://infosys.beckhoff.com/english.php?content=../content/1033/tc3_adsdll2/9007199379576075.html&id=9180083787138954512) for more info.
      *
-     * Uses ADS sum command under the hood (better performance)
+     * @example
+     * ```js
+     * try {
+     *  const results = await client.readRawMulti([
+     *    {
+     *      indexGroup: 16448,
+     *      indexOffset: 414816,
+     *      size: 2
+     *    },
+     *    {
+     *      indexGroup: 16448,
+     *      indexOffset: 414900,
+     *      size: 128
+     *    }
+     *  ]);
+     *
+     *  if(results[0].success) {
+     *    console.log(`First result: ${results[0].value}`); //First result: <Buffer ff 7f>
+     *  } else {
+     *    console.log(`First read command failed: ${results[0].errorStr}`);
+     *  }
+     *
+     * } catch (err) {
+     *  console.log("Error:", err);
+     * }
+     * ```
      *
      * @param commands Array of read commands
      * @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.
      */
     readRawMulti(commands: ReadRawMultiCommand[], targetOpts?: Partial<AmsAddress>): Promise<ReadRawMultiResult[]>;
     /**
-     * **TODO - DOCUMENTATION ONGOING**
+     * Sends multiple `writeRaw()` commands in one ADS packet.
      *
-     * Sends multiple writeRaw() commands in one ADS packet
+     * Writes raw data to the target system by a raw ADS addresses (index group and index offset).
+     * Results are returned for each command separately - see {@link WriteRawMultiResult} for details.
      *
-     * Writes raw byte data to the target system by provided index group and index offset.
+     * Uses ADS sum command under the hood (better and faster performance).
+     * See [Beckhoff Information System](https://infosys.beckhoff.com/english.php?content=../content/1033/tc3_adsdll2/9007199379576075.html&id=9180083787138954512) for more info.
      *
-     * Uses ADS sum command under the hood (better performance)
+     * @example
+     * ```js
+     * try {
+     *  const data1 = await client.convertToRaw(32767, 'INT');
+     *  console.log(data1); //<Buffer ff 7f>
+     *
+     *  const data2 = Buffer.alloc(128); //example
+     *
+     *  const results = await client.writeRawMulti([
+     *    {
+     *      indexGroup: 16448,
+     *      indexOffset: 414816,
+     *      value: data1
+     *    },
+     *    {
+     *      indexGroup: 16448,
+     *      indexOffset: 414900,
+     *      value: data2
+     *    }
+     *  ]);
+     *
+     *  if(results[0].success) {
+     *    console.log(`First write command successful`);
+     *  } else {
+     *    console.log(`First write command failed: ${results[0].errorStr}`);
+     *  }
+     *
+     * } catch (err) {
+     *  console.log("Error:", err);
+     * }
+     * ```
      *
      * @param commands Array of write commands
      * @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.
      */
     writeRawMulti(commands: WriteRawMultiCommand[], targetOpts?: Partial<AmsAddress>): Promise<WriteRawMultiResult[]>;
     /**
-     * **TODO - DOCUMENTATION ONGOING**
+     * Reads raw data from the target system by variable path (such as `GVL_Test.ExampleStruct`).
+     *
+     * Supports also reading `POINTER` and `REFERENCE` values (see example).
+     *
+     * This uses the ADS `READ_SYMVAL_BYNAME` under the hood, so only one
+     * round-trip is needed.
+     *
+     * @example
+     * ```js
+     * try {
+     *  const data = await client.readRawByPath('GVL_Read.StandardTypes.INT_');
+     *  console.log(data); //<Buffer ff 7f>
+     *
+     *  const converted = await client.convertFromRaw(data, 'INT');
+     *  console.log(converted); //32767
      *
-     * Reads raw byte data from the target system by symbol path.
+     * //Reading a POINTER value (Note the dereference operator ^)
+     * const ptrValue = await client.readRawByPath('GVL_Read.ComplexTypes.POINTER_^');
      *
-     * Supports also reading POINTER and REFERENCE values by using deference operator in path (`^`)
+     * //Reading a REFERENCE value
+     * const refValue = await client.readRawByPath('GVL_Read.ComplexTypes.REFERENCE_');
      *
-     * This uses the ADS command `READ_SYMVAL_BYNAME` under the hood
+     * } catch (err) {
+     *  console.log("Error:", err);
+     * }
+     * ```
      *
      * @param path Variable path in the PLC to read (such as `GVL_Test.ExampleStruct`)
      * @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.
      */
     readRawByPath(path: string, targetOpts?: Partial<AmsAddress>): Promise<Buffer>;
     /**
-     * **TODO - DOCUMENTATION ONGOING**
+     * Writes raw data to the target system by variable path (such as `GVL_Test.ExampleStruct`).
      *
-     * Writes raw byte data to the target system by symbol path.
+     * Supports also writing `POINTER` and `REFERENCE` values (see example).
      *
-     * Supports also reading POINTER and REFERENCE values by using deference operator in path (`^`)
+     * NOTE: Unlike with {@link readRawByPath}(), this command uses multiple ADS requests for the operation.
      *
-     * 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`)
+     * @example
+     * ```js
+     * try {
+     *  const data = await client.convertToRaw(32767, 'INT');
+     *  console.log(data); //<Buffer ff 7f>
+     *
+     *  await client.writeRawByPath('GVL_Write.StandardTypes.INT_', data);
+     *
+     * //Writing a POINTER value (Note the dereference operator ^)
+     * const ptrValue = ...
+     * await client.writeRawByPath('GVL_Read.ComplexTypes.POINTER_^', ptrValue);
+     *
+     * //Writing a REFERENCE value
+     * const refValue = ...
+     * await client.readRawByPath('GVL_Read.ComplexTypes.REFERENCE_');
+     *
+     * } catch (err) {
+     *  console.log("Error:", err);
+     * }
+     * ```
+     *
+     * @param path Variable path in the PLC to write (such as `GVL_Test.ExampleStruct`)
      * @param value Data to write
      * @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.
      */
     writeRawByPath(path: string, value: Buffer, targetOpts?: Partial<AmsAddress>): Promise<void>;
     /**
-     * **TODO - DOCUMENTATION ONGOING**
+     * Writes raw data to the target system by a raw ADS address (index group, index offset)
+     * and reads the result as raw data.
      *
-     * Writes raw data to the target and reads the result as raw data
+     * This is the ADS protocol `ReadWrite` command.
      *
-     * Uses `ADS ReadWrite` command
+     * @example
+     * ```js
+     * const { ADS } = require('../dist/ads-client');
+     *
+     * try {
+     *  //Reading raw value by symbol path (= same as readRawByPath())
+     *  const path = ADS.encodeStringToPlcStringBuffer('GVL_Read.StandardTypes.INT_');
+     *  const data = await client.readWriteRaw(ADS.ADS_RESERVED_INDEX_GROUPS.SymbolValueByName, 0, 0xFFFFFFFF, path);
+     *  console.log(data); //<Buffer ff 7f>
+     *
+     * } catch (err) {
+     *  console.log("Error:", err);
+     * }
+     * ```
      *
      * @param indexGroup Address index group
      * @param indexOffset Address index offset
-     * @param size How many bytes to read
-     * @param writeData Data to write
+     * @param size Data length to read (bytes)
+     * @param value Value to write
      * @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.
      */
-    readWriteRaw(indexGroup: number, indexOffset: number, size: number, writeData: Buffer, targetOpts?: Partial<AmsAddress>): Promise<Buffer>;
+    readWriteRaw(indexGroup: number, indexOffset: number, size: number, value: Buffer, targetOpts?: Partial<AmsAddress>): Promise<Buffer>;
     /**
-     * **TODO - DOCUMENTATION ONGOING**
+     * Sends multiple `readWriteRaw()` commands in one ADS packet.
      *
-     * Sends multiple readWriteRaw() commands in one ADS packet
+     * Writes raw data to the target system by a raw ADS address (index group, index offset)
+     * and reads the result as raw data.
      *
-     * Uses ADS sum command under the hood (better performance)
+     * Uses ADS sum command under the hood (better and faster performance).
+     * See [Beckhoff Information System](https://infosys.beckhoff.com/english.php?content=../content/1033/tc3_adsdll2/9007199379576075.html&id=9180083787138954512) for more info.
+     *
+     * @example
+     * ```js
+     * try {
+     *  //Reading raw values by symbol paths (= same as readRawByPath())
+     *  const path = ADS.encodeStringToPlcStringBuffer('GVL_Read.StandardTypes.INT_');
+     *  const path2 = ADS.encodeStringToPlcStringBuffer('GVL_Read.StandardTypes.REAL_');
+     *
+     *  const results = await client.readWriteRawMulti([
+     *    {
+     *      indexGroup: ADS.ADS_RESERVED_INDEX_GROUPS.SymbolValueByName,
+     *      indexOffset: 0,
+     *      size: 0xFFFF,
+     *      value: path
+     *    },
+     *    {
+     *      indexGroup: ADS.ADS_RESERVED_INDEX_GROUPS.SymbolValueByName,
+     *      indexOffset: 0,
+     *      size: 0xFFFF,
+     *      value: path2
+     *    }
+     *  ]);
+     *
+     *  if(results[0].success) {
+     *    console.log(`First result: ${results[0].value}`); //First result: <Buffer ff 7f>
+     *  } else {
+     *    console.log(`First read/write command failed: ${results[0].errorStr}`);
+     *  }
+     *
+     * } catch (err) {
+     *  console.log("Error:", err);
+     * }
      *
-     * @param commands Array of read write commands
+     * ```
+     *
+     * @param commands Array of read/write commands
      * @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.
      */
     readWriteRawMulti(commands: ReadWriteRawMultiCommand[], targetOpts?: Partial<AmsAddress>): Promise<ReadWriteRawMultiResult[]>;
     /**
-     * **TODO - DOCUMENTATION ONGOING**
+     * Reads variable's value from the target system by a variable path (such as `GVL_Test.ExampleStruct`)
+     * and returns the value as a Javascript object.
      *
-     * Reads a value by a variable path (such as `GVL_Test.ExampleStruct`) and converts the value to a Javascript object.
+     * Returns variable's
+     * - converted value
+     * - raw value
+     * - data type
+     * - symbol
      *
-     * Returns the converted value, the raw value, the data type and the symbol.
+     * **NOTE:** This requires that the target is a PLC runtime or has equivalent ADS protocol support.
      *
-     * @param path Variable path in the PLC to read (such as `GVL_Test.ExampleStruct`)
+     * @example
+     * ```js
+     * try {
+     *  const res = await client.readValue('GVL_Test.ExampleStruct');
+     *  console.log(res.value);
+     * } catch (err) {
+     *  console.log("Error:", err);
+     * }
+     * ```
+     *
+     * @param path Variable path in the PLC (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 variable's value from the target system by a symbol object
+     * and returns the value as a Javascript object.
      *
-     * Reads a value by a symbol and converts the value to a Javascript object.
+     * Returns variable's
+     * - converted value
+     * - raw value
+     * - data type
+     * - symbol
      *
-     * Returns the converted value, the raw value, the data type and the symbol.
+     * **NOTE:** This requires that the target is a PLC runtime or has equivalent ADS protocol support.
      *
-     * @param symbol Symbol (acquired using `getSymbol()`)
+     * @example
+     * ```js
+     * try {
+     *  const symbol = await client.getSymbol('GVL_Test.ExampleStruct');
+     *
+     *  const res = await client.readValueBySymbol(symbol);
+     *  console.log(res.value);
+     * } catch (err) {
+     *  console.log("Error:", err);
+     * }
+     * ```
+     *
+     * @param symbol Symbol object (acquired using {@link 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 variable's value to the target system by a variable path (such as `GVL_Test.ExampleStruct`).
+     * Converts the value from a Javascript object to a raw value.
      *
-     * Writes a value by a variable path (such as `GVL_Test.ExampleStruct`). Converts the value from a Javascript object to a raw value.
+     * Returns variable's
+     * - converted value
+     * - raw value
+     * - data type
+     * - symbol
      *
-     * Returns the converted value, the raw value, the data type and the symbol.
+     * **NOTE:** Do not use `autoFill` for `UNION` types, it doesn't work correctly.
      *
-     * **NOTE:** Do not use `autoFill` for `UNION` types, it works without errors but the result isn't probably the desired one
+     * **NOTE:** This requires that the target is a PLC runtime or has equivalent ADS protocol support.
      *
-     * @param path Variable path in the PLC to read (such as `GVL_Test.ExampleStruct`)
+     * @example
+     * ```js
+     * try {
+     *  const value = {
+     *    example: true
+     *  };
+     *
+     *  const res = await client.writeValue('GVL_Test.ExampleStruct', value);
+     * } catch (err) {
+     *  console.log("Error:", err);
+     * }
+     * ```
+     *
+     * @param path Variable path in the PLC (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 `''`)
+     * @param autoFill If set and the 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>(...)`
      */