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

package/dist/ads-client.js

@@ -659,7 +659,7 @@ class Client extends events_1.default {
             };
             this.socket?.once('error', errorHandler);
             try {
-                await this.socketWrite(packet);
+                this.socketWrite(packet);
             }
             catch (err) {
                 this.socket?.off('error', errorHandler);
@@ -715,15 +715,45 @@ class Client extends events_1.default {
             //Sometimes close event is not received, so resolve already here
             this.socket.once('end', () => {
                 this.debugD(`unregisterAdsPort(): Socket connection ended, connection closed.`);
+                clearTimeout(this.portRegisterTimeoutTimer);
+                this.amsTcpCallback = undefined;
                 this.socket?.destroy();
                 resolve();
             });
+            this.amsTcpCallback = (res) => {
+                this.amsTcpCallback = undefined;
+                clearTimeout(this.portRegisterTimeoutTimer);
+                if (res.amsTcp.command === ADS.AMS_HEADER_FLAG.AMS_TCP_PORT_CLOSE) {
+                    this.debug(`unregisterAdsPort(): ADS port unregistered`);
+                    this.socket?.destroy();
+                    resolve();
+                }
+            };
+            //Timeout (if no answer from router)
+            this.portRegisterTimeoutTimer = setTimeout(() => {
+                //Callback is no longer needed, delete it
+                this.amsTcpCallback = undefined;
+                //Create a custom "ads error" so that the info is passed onwards
+                const adsError = {
+                    ads: {
+                        error: true,
+                        errorCode: -1,
+                        errorStr: `Timeout - no response in ${this.settings.timeoutDelay} ms`
+                    }
+                };
+                this.debug(`unregisterAdsPort(): Failed to unregister ADS port: Timeout - no response in ${this.settings.timeoutDelay} ms`);
+                return reject(new client_error_1.default(`unregisterAdsPort(): Timeout - no response in ${this.settings.timeoutDelay} ms`, adsError));
+            }, this.settings.timeoutDelay);
             try {
-                await this.socketWrite(buffer);
+                this.socketWrite(buffer);
             }
             catch (err) {
                 reject(err);
             }
+            finally {
+                this.amsTcpCallback = undefined;
+                clearTimeout(this.portRegisterTimeoutTimer);
+            }
         });
     }
     /**
@@ -1379,7 +1409,12 @@ class Client extends events_1.default {
             //AMS port unregister
             case ADS.AMS_HEADER_FLAG.AMS_TCP_PORT_CLOSE:
                 packet.amsTcp.commandStr = 'Port unregister';
-                //No action at the moment
+                if (this.amsTcpCallback) {
+                    this.amsTcpCallback(packet);
+                }
+                else {
+                    this.debug(`onAmsTcpPacketReceived(): Port unregister response received but no callback was assigned (${packet.amsTcp.commandStr})`);
+                }
                 break;
             //AMS port register
             case ADS.AMS_HEADER_FLAG.AMS_TCP_PORT_CONNECT:
@@ -2325,6 +2360,7 @@ class Client extends events_1.default {
                 if (err.adsError && err.adsError?.errorCode === 1808) {
                     //Type wasn't found.
                     //Might be TwinCAT 2 system that doesn't provide pseudo or base data types by ADS --> check if we know the type ourselves
+                    const originalName = name;
                     if (ADS.BASE_DATA_TYPES.isPseudoType(name)) {
                         //This converts e.g. PVOID to a primitive type
                         if (knownSize === undefined) {
@@ -2358,6 +2394,11 @@ class Client extends events_1.default {
                             extendedFlags: 0,
                             reserved: Buffer.alloc(0)
                         };
+                        //Adding to cache, even though it's not read from the target
+                        //With TwinCAT 2, this prevents trying to read base types again and again from the target (as there aren't any)
+                        if (!this.settings.disableCaching && !targetOpts.adsPort && !targetOpts.amsNetId) {
+                            this.metaData.plcDataTypes[originalName.toLowerCase()] = dataType;
+                        }
                     }
                     else {
                         //Type is unknown - we can't do anything
@@ -2401,7 +2442,7 @@ class Client extends events_1.default {
                 }
             }
             else if ((((dataType.type === '' && !ADS.BASE_DATA_TYPES.isPseudoType(dataType.name)) || ADS.BASE_DATA_TYPES.isKnownType(dataType.name))
-                && dataType.flagsStr.includes('DataType')
+                && (dataType.flagsStr.includes('DataType') || ADS.BASE_DATA_TYPES.isKnownType(dataType.name)) //isKnownType() call is for TwinCAT 2 support, as base types (like INT16) do not have DataType flag (but it's the final base type)
                 && !dataType.flagsStr.includes('EnumInfos')
                 && dataType.arrayDimension === 0)) {
                 //This is final form (no need to go deeper)
@@ -2409,8 +2450,10 @@ class Client extends events_1.default {
             }
             else if (dataType.arrayDimension > 0) {
                 //Data type is an array - get array subtype
+                //TwinCAT 2 support - calculate size if it's array of pointer etc.
+                const size = dataType.size / dataType.arrayInfos.reduce((total, dimension) => total * dimension.length, 1);
                 builtType = {
-                    ...(await this.buildDataType(dataType.type, targetOpts, false))
+                    ...(await this.buildDataType(dataType.type, targetOpts, false, size))
                 };
                 builtType.arrayInfos = [...dataType.arrayInfos, ...builtType.arrayInfos];
             }
@@ -3381,7 +3424,7 @@ class Client extends events_1.default {
      * @example
      * ```js
      * try {
-     *  const symbol = await client.getSymbol('GVL_Test.ExampleStruct');
+     *  const symbol = await client.getSymbol('GVL_Read.StandardTypes.INT_');
      * } catch (err) {
      *  console.log("Error:", err);
      * }
@@ -3677,7 +3720,7 @@ class Client extends events_1.default {
      * //Checks if value has changed every 100ms
      * //Callback is called only when the value has changed
      * await client.subscribeValue(
-     *  'GVL_Test.ExampleStruct.',
+     *  'GVL_Subscription.NumericValue_10ms',
      *  (data, subscription) => {
      *   console.log(`Value of ${subscription.symbol.name} has changed: ${data.value}`);
      *  },
@@ -3825,7 +3868,7 @@ class Client extends events_1.default {
      * //Checks if value has changed every 100ms
      * //Callback is called only when the value has changed
      * await client.subscribe({
-     *  target: 'GVL_Test.ExampleStruct',
+     *  target: 'GVL_Subscription.NumericValue_10ms',
      *  callback: (data, subscription) => {
      *    console.log(`Value of ${subscription.symbol.name} has changed: ${data.value}`);
      *  },
@@ -4773,7 +4816,6 @@ class Client extends events_1.default {
      *
      * NOTE: Unlike with {@link readRawByPath}(), this command uses multiple ADS requests for the operation.
      *
-     *
      * @example
      * ```js
      * try {
@@ -5042,7 +5084,7 @@ class Client extends events_1.default {
      * @example
      * ```js
      * try {
-     *  const res = await client.readValue('GVL_Test.ExampleStruct');
+     *  const res = await client.readValue('GVL_Read.StandardTypes.INT_');
      *  console.log(res.value);
      * } catch (err) {
      *  console.log("Error:", err);
@@ -5053,6 +5095,7 @@ class Client extends events_1.default {
      * @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`)
+     * @throws Throws an error if sending the command fails or if the target responds with an error.
      */
     async readValue(path, targetOpts = {}) {
         if (!this.connection.connected) {
@@ -5073,7 +5116,8 @@ class Client extends events_1.default {
         let dataType;
         try {
             this.debugD(`readValue(): Getting data type for ${path}`);
-            dataType = await this.buildDataType(symbol.type, targetOpts);
+            //Also passing size for TC2 pointer/pseudo type support
+            dataType = await this.buildDataType(symbol.type, targetOpts, true, symbol.size);
         }
         catch (err) {
             this.debug(`readValue(): Getting data type for ${path} failed: %o`, err);
@@ -5108,7 +5152,7 @@ class Client extends events_1.default {
         };
     }
     /**
-     * Reads variable's value from the target system by a symbol object
+     * Reads variable's value from the target system by a symbol object (acquired using `getSymbol()`)
      * and returns the value as a Javascript object.
      *
      * Returns variable's
@@ -5122,7 +5166,7 @@ class Client extends events_1.default {
      * @example
      * ```js
      * try {
-     *  const symbol = await client.getSymbol('GVL_Test.ExampleStruct');
+     *  const symbol = await client.getSymbol('GVL_Read.StandardTypes.INT_');
      *
      *  const res = await client.readValueBySymbol(symbol);
      *  console.log(res.value);
@@ -5131,10 +5175,11 @@ class Client extends events_1.default {
      * }
      * ```
      *
-     * @param symbol Symbol object (acquired using {@link getSymbol}())
+     * @param symbol Symbol object
      * @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`)
+     * @throws Throws an error if sending the command fails or if the target responds with an error.
      */
     async readValueBySymbol(symbol, targetOpts = {}) {
         if (!this.connection.connected) {
@@ -5163,7 +5208,7 @@ class Client extends events_1.default {
      *    example: true
      *  };
      *
-     *  const res = await client.writeValue('GVL_Test.ExampleStruct', value);
+     *  const res = await client.writeValue('GVL_Read.StandardTypes.INT_', value);
      * } catch (err) {
      *  console.log("Error:", err);
      * }
@@ -5172,9 +5217,10 @@ class Client extends events_1.default {
      * @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 set and the 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 active values read from target (kept as-is).
      *
      * @template T In Typescript, the data type of the value, for example `writeValue<number>(...)` or `writeValue<ST_TypedStruct>(...)`
+     * @throws Throws an error if sending the command fails or if the target responds with an error.
      */
     async writeValue(path, value, autoFill = false, targetOpts = {}) {
         if (!this.connection.connected) {
@@ -5195,7 +5241,8 @@ class Client extends events_1.default {
         let dataType;
         try {
             this.debugD(`writeValue(): Getting data type for ${path}`);
-            dataType = await this.buildDataType(symbol.type, targetOpts);
+            //Also passing size for TC2 pointer/pseudo type support
+            dataType = await this.buildDataType(symbol.type, targetOpts, true, symbol.size);
         }
         catch (err) {
             this.debug(`writeValue(): Getting data type for ${path} failed: %o`, err);
@@ -5253,20 +5300,37 @@ class Client extends events_1.default {
         };
     }
     /**
-     * **TODO - DOCUMENTATION ONGOING**
+     * Writes variable's value to the target system by a symbol object (acquired using `getSymbol()`).
+     * Converts the value from a Javascript object to a raw value.
+     *
+     * Returns variable's
+     * - converted value
+     * - raw value
+     * - data type
+     * - symbol
+     *
+     * **NOTE:** Do not use `autoFill` for `UNION` types, it doesn't work correctly.
      *
-     * Writes a value by symbol. Converts the value from a Javascript object to a raw value.
+     * **NOTE:** This requires that the target is a PLC runtime or has equivalent ADS protocol support.
      *
-     * Returns the converted value, the raw value, the data type and the symbol.
+     * @example
+     * ```js
+     * try {
+     *  const symbol = await client.getSymbol('GVL_Read.StandardTypes.INT_');
      *
-     * **NOTE:** Do not use `autoFill` for `UNION` types, it works without errors but the result isn't probably the desired one
+     *  const res = await client.writeValueBySymbol(symbol, 32767);
+     * } catch (err) {
+     *  console.log("Error:", err);
+     * }
+     * ```
      *
-     * @param symbol Symbol (acquired using `getSymbol()`)
+     * @param symbol Symbol object
      * @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 active values read from target (kept as-is).
      *
      * @template T In Typescript, the data type of the value, for example `writeValue<number>(...)` or `writeValue<ST_TypedStruct>(...)`
+     * @throws Throws an error if sending the command fails or if the target responds with an error.
      */
     async writeValueBySymbol(symbol, value, autoFill = false, targetOpts = {}) {
         if (!this.connection.connected) {
@@ -5275,14 +5339,27 @@ class Client extends events_1.default {
         return this.writeValue(symbol.name, value, autoFill, targetOpts);
     }
     /**
-     * **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
+     * @example
+     * ```js
+     * try {
+     *  const res = await client.getDefaultPlcObject('INT');
+     *  console.log(res); //0
+  
+     *  const res2 = await client.getDefaultPlcObject('Tc2_Standard.TON');
+     *  console.log(res2); //{ IN: false, PT: 0, Q: false, ET: 0, M: false, StartTime: 0 }
+     *
+     * } catch (err) {
+     *  console.log("Error:", err);
+     * }
+     * ```
+     *
+     * @param dataType Data type name in the PLC as string (such as `ST_Struct`) or data type object (acquired using {@link getDataType}())
      * @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>(...)`
+     * @template T Typescript data type of the PLC data, for example `getDefaultPlcObject<number>(...)` or `getDefaultPlcObject<ST_TypedStruct>(...)`
+     * @throws Throws an error if sending the command fails or if the target responds with an error.
      */
     async getDefaultPlcObject(dataType, targetOpts = {}) {
         if (!this.connection.connected) {
@@ -5306,15 +5383,28 @@ class Client extends events_1.default {
         return value;
     }
     /**
-     * **TODO - DOCUMENTATION ONGOING**
+     * Converts raw data to a Javascript object by using the provided data type.
      *
-     * Converts a raw byte value to a Javascript object.
+     * @example
+     * ```js
+     * try {
+     *  const data = await client.readRaw(16448, 414816, 2);
+     *  console.log(data); //<Buffer ff 7f>
      *
-     * @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
+     *  const converted = await client.convertFromRaw(data, 'INT');
+     *  console.log(converted); //32767
+     *
+     * } catch (err) {
+     *  console.log("Error:", err);
+     * }
+     * ```
+     *
+     * @param data Raw data (acquired for example using {@link readRaw}())
+     * @param dataType Data type name in the PLC as string (such as `ST_Struct`) or data type object (acquired using {@link getDataType}())
      * @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>(...)`
+     * @throws Throws an error if sending the command fails or if the target responds with an error.
      */
     async convertFromRaw(data, dataType, targetOpts = {}) {
         if (!this.connection.connected) {
@@ -5346,18 +5436,27 @@ class Client extends events_1.default {
         return value;
     }
     /**
-     * **TODO - DOCUMENTATION ONGOING**
+     * Converts a Javascript object to raw data by using the provided data type.
      *
-     * Converts a Javascript object to raw byte data.
+     * **NOTE:** Do not use `autoFill` for `UNION` types, it doesn't work correctly.
+     
+     * @example
+     * ```js
+     * try {
+     *  const data = await client.convertToRaw(32767, 'INT');
+     *  console.log(data); //<Buffer ff 7f>
      *
-     * **NOTE:** Do not use `autoFill` for `UNION` types, it works without errors but the result isn't probably the desired one
+     * } catch (err) {
+     *  console.log("Error:", err);
+     * }
+     * ```
      *
-     * @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 value Value to convert
+     * @param dataType Data type name in the PLC as string (such as `ST_Struct`) or data type object (acquired using {@link getDataType}())
+     * @param autoFill autoFill If set and the data type is a container (`STRUCT`, `FUNCTION_BLOCK` etc.), missing properties are automatically set to default values (`0` or empty string).
      * @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>(...)`
+     * @throws Throws an error if sending the command fails or if the target responds with an error.
      */
     async convertToRaw(value, dataType, autoFill = false, targetOpts = {}) {
         if (!this.connection.connected) {
@@ -5413,14 +5512,39 @@ class Client extends events_1.default {
         }
     }
     /**
-     * **TODO - DOCUMENTATION ONGOING**
+     * Creates a handle to a variable at the target system by variable path (such as `GVL_Test.ExampleStruct`).
      *
-     * Creates a variable handle for a PLC symbol by given variable path
+     * The handle can be then used for reading and writing the value.
      *
-     * Variable value can be accessed by using the handle with `readRawByHandle()` and `writeRawByHandle()`
+     * Reading and writing dereferenced `POINTER` and `REFERENCE` values is also possible.
+     * See {@link readRawByHandle}() and {@link 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)
+     * NOTE: The handle should be deleted after it's no longer needed,
+     * as there is a limited amount of handles available. See {@link deleteVariableHandle}().
+     *
+     * @example
+     * ```js
+     * try {
+     *  //POINTER value (Note the dereference operator ^)
+     *  const handle1 = await client.createVariableHandle('GVL_Read.ComplexTypes.POINTER_^');
+     *  const value = await client.readRawByHandle(handle1);
+     *  await client.deleteVariableHandle(handle1);
+     *
+     *  const handle2 = await client.createVariableHandle('GVL_Read.StandardTypes.INT_');
+     *  const value2 = await client.readRawByHandle(handle2);
+     *  await client.deleteVariableHandle(handle2);
+     *
+     *  //Now you use convertFromRaw() to get actual values
+     *
+     * } 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.
      */
     async createVariableHandle(path, targetOpts = {}) {
         if (!this.connection.connected) {
@@ -5478,18 +5602,44 @@ class Client extends events_1.default {
         }
     }
     /**
-     * **TODO - DOCUMENTATION ONGOING**
+     * Sends multiple {@link createVariableHandle}() commands in one ADS packet.
+     *
+     * Creates a handle to a variable at the target system by variable path (such as `GVL_Test.ExampleStruct`).
+     *
+     * The handle can be then used for reading and writing the value.
      *
-     * Sends multiple createVariableHandle() commands in one ADS packet
+     * Reading and writing dereferenced `POINTER` and `REFERENCE` values is also possible.
+     * See {@link readRawByHandle}() and {@link writeRawByHandle}().
      *
-     * Creates a variable handle for a PLC symbol by given variable path
+     * NOTE: The handle should be deleted after it's no longer needed,
+     * as there is a limited amount of handles available. See {@link deleteVariableHandle}().
      *
-     * Variable value can be accessed by using the handle with `readRawByHandle()` and `writeRawByHandle()`
+     * 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 {
+     *  const results = await client.createVariableHandleMulti([
+     *    'GVL_Read.StandardTypes.INT_',
+     *    'GVL_Read.StandardTypes.REAL_'
+     *  ]);
      *
-     * Uses ADS sum command under the hood (better perfomance)
+     *  if(results[0].success) {
+     *    console.log(`First handle: ${results[0].handle}`);
+     *  } else {
+     *    console.log(`Creating first handle failed: ${results[0].errorStr}`);
+     *  }
      *
-     * @param paths Array of full variable paths in the PLC (such as `GVL_Test.ExampleStruct`)
+     * } catch (err) {
+     *  console.log("Error:", err);
+     * }
+     * ```
+     *
+     * @param paths Array of variable paths 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.
      */
     async createVariableHandleMulti(paths, targetOpts = {}) {
         if (!this.connection.connected) {
@@ -5594,12 +5744,26 @@ class Client extends events_1.default {
         }
     }
     /**
-     * **TODO - DOCUMENTATION ONGOING**
+     * Deletes a variable handle that was previously created
+     * using {@link createVariableHandle}().
+     *
+     * @example
+     * ```js
+     * try {
+     *  const handle = createVariableHandle(...);
      *
-     * Deletes a variable handle that was previously created using `createVariableHandle()`
+     *  //After use, deleting the handle
+     *  await client.deleteVariableHandle(handle);
+     *
+     * } catch (err) {
+     *  console.log("Error:", err);
+     * }
+     * ```
      *
      * @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)
+     * @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.
      */
     async deleteVariableHandle(handle, targetOpts = {}) {
         if (!this.connection.connected) {
@@ -5637,16 +5801,38 @@ class Client extends events_1.default {
         }
     }
     /**
-     * **TODO - DOCUMENTATION ONGOING**
+     * Sends multiple {@link deleteVariableHandle}() commands in one ADS packet.
      *
-     * Sends multiple deleteVariableHandle() commands in one ADS packet
+     * Deletes a variable handle that was previously created
+     * using {@link createVariableHandle}().
      *
-     * Deletes a variable handle that was previously created using `createVariableHandle()`
+     * 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 {
+     *  const handle1 = createVariableHandle(...);
+     *  const handle2 = createVariableHandle(...);
+     *
+     *  //After use, deleting the handles
+     *  const results = await client.deleteVariableHandleMulti([handle1, handle2]);
+     *
+     *  if(results[0].success) {
+     *    console.log(`First deleted`);
+     *  } else {
+     *    console.log(`Deleting first handle failed: ${results[0].errorStr}`);
+     *  }
      *
-     * Uses ADS sum command under the hood (better performance)
+     * } catch (err) {
+     *  console.log("Error:", err);
+     * }
+     * ```
      *
      * @param handles Array of variable handles to delete
      * @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.
      */
     async deleteVariableHandleMulti(handles, targetOpts = {}) {
         if (!this.connection.connected) {
@@ -5718,13 +5904,24 @@ class Client extends events_1.default {
         }
     }
     /**
-     * **TODO - DOCUMENTATION ONGOING**
+     * Reads raw data from the target system by a previously created variable handle (acquired using {@link createVariableHandle}())
      *
-     * Reads raw byte data from the target system by previously created variable handle
+     * @example
+     * ```js
+     * try {
+     *  const handle = await client.createVariableHandle('GVL_Read.StandardTypes.INT_'');
+     *  const value = await client.readRawByHandle(handle);
+     *  await client.deleteVariableHandle(handle);
      *
+     * } catch (err) {
+     *  console.log("Error:", err);
+     * }
+     * ```
      * @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)
+     * @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.
      */
     async readRawByHandle(handle, size, targetOpts = {}) {
         if (!this.connection.connected) {
@@ -5748,13 +5945,28 @@ class Client extends events_1.default {
         }
     }
     /**
-     * **TODO - DOCUMENTATION ONGOING**
+     * Writes raw data to the target system by a previously created variable handle (acquired using {@link createVariableHandle}())
+     *
+     * @example
+     * ```js
+     * try {
+     *  const value = await client.convertToRaw(32767, 'INT');
+     *  console.log(value); //<Buffer ff 7f>
      *
-     * Writes raw byte data to the target system by previously created variable handle
+     *  const handle = await client.createVariableHandle('GVL_Read.StandardTypes.INT_');
+     *  await client.writeRawByHandle(handle, value);
+     *  await client.deleteVariableHandle(handle);
+     *
+     * } catch (err) {
+     *  console.log("Error:", err);
+     * }
+     * ```
      *
      * @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)
+     * @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.
      */
     async writeRawByHandle(handle, value, targetOpts = {}) {
         if (!this.connection.connected) {
@@ -5772,12 +5984,23 @@ class Client extends events_1.default {
         }
     }
     /**
-     * **TODO - DOCUMENTATION ONGOING**
+     * Reads raw data from the target system by a symbol object (acquired using `getSymbol()`)
      *
-     * Reads raw data by symbol
+     * @example
+     * ```js
+     * try {
+     *  const symbol = await client.getSymbol('GVL_Read.StandardTypes.INT_');
+     *  const value = await client.readRawBySymbol(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)
+     * } catch (err) {
+     *  console.log("Error:", err);
+     * }
+     * ```
+     *
+     * @param symbol Symbol
+     * @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.
      */
     async readRawBySymbol(symbol, targetOpts = {}) {
         if (!this.connection.connected) {
@@ -5795,13 +6018,27 @@ class Client extends events_1.default {
         }
     }
     /**
-     * **TODO - DOCUMENTATION ONGOING**
+     * Writes raw data to the target system by a symbol object (acquired using `getSymbol()`)
+     *
+     * @example
+     * ```js
+     * try {
+     *  const value = await client.convertToRaw(32767, 'INT');
+     *  console.log(value); //<Buffer ff 7f>
      *
-     * Writes raw data by symbol
+     *  const symbol = await client.getSymbol('GVL_Read.StandardTypes.INT_');
+     *  await client.writeRawBySymbol(symbol, value);
      *
-     * @param symbol Symbol (acquired using `getSymbol()`)
+     * } catch (err) {
+     *  console.log("Error:", err);
+     * }
+     * ```
+     *
+     * @param symbol Symbol
      * @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.
      */
     async writeRawBySymbol(symbol, value, targetOpts = {}) {
         if (!this.connection.connected) {
@@ -5818,21 +6055,40 @@ class Client extends events_1.default {
         }
     }
     /**
-     * **TODO - DOCUMENTATION ONGOING**
+     * Invokes a function block RPC method on the target system.
      *
-     * Invokes/calls a function block RPC method from PLC
+     * Returns the return value of the method and outputs (if any).
      *
-     * Returns method return value and/or outputs (if any)
+     * NOTE: In the PLC, `{attribute 'TcRpcEnable'}` is required above the `METHOD` definition.
      *
-     * For RPC support, the method needs to have `{attribute 'TcRpcEnable'}` attribute above the `METHOD` definition
+     * @example
+     * ```js
+     * try {
+     *  const res = await client.invokeRpcMethod('GVL_RPC.RpcBlock', 'Calculator', {
+     *    Value1: 1,
+     *    Value2: 123
+     *  });
+     *
+     *  console.log(res);
+     *  //{
+     *  //  returnValue: true,
+     *  //  outputs: { Sum: 124, Product: 123, Division: 0.008130080997943878 }
+     *  //}
      *
-     * @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)
+     * } catch (err) {
+     *  console.log("Error:", err);
+     * }
+     * ```
+     *
+     * @param path Variable path in the PLC of the function block instance (such as `GVL_Test.ExampleBlock`)
+     * @param method Function block method name
+     * @param parameters 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>(...)`
+     *
+     * @throws Throws an error if sending the command fails or if the target responds with an error.
      */
     async invokeRpcMethod(path, method, parameters = {}, targetOpts = {}) {
         if (!this.connection.connected) {