ads-client 1.14.0 → 1.14.2

package/CHANGELOG.md

@@ -4,6 +4,28 @@ All notable changes to this project will be documented in this file.
 The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
 and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
 
+## [1.14.2] - 02.05.2023
+### Changed
+- Bug fix: `ADS_DATA_TYPE_FLAGS` (`dataType.flags`) were parsed incorrectly. 
+  - See [issue #109](https://github.com/jisotalo/ads-client/issues/109)
+  - Thank you [Michael Croes](https://github.com/mycroes) for contribution!
+- Bug fix: If calling `unsubcribeAll()` when client is already unsubcribing and disconnecting, an error might be thrown
+  - See [issue #103](https://github.com/jisotalo/ads-client/issues/103#issuecomment-1450640160)
+- Bug fix: Check that subscription callback exists before calling it
+  - Fixes unecessary error if receiving notification data (for subscription) but it's being unsubscribed at the same time
+- Bump json5 from 2.2.1 to 2.2.3
+  - See [pull request 101](https://github.com/jisotalo/ads-client/pull/101)
+  - Not used in production code, only when running tests
+
+### Added
+- New test for [issue #103](https://github.com/jisotalo/ads-client/issues/103)
+
+## [1.14.1] - 13.09.2022
+### Changed
+- Bug fix: Connecting to local router failed with ECONNREFUSED error on Node.js version 17 and newer
+  - See [https://github.com/nodejs/node/issues/40702](https://github.com/nodejs/node/issues/40702)
+  - Fixed by using `127.0.0.1` instead of `localhost`
+
 ## [1.14.0] - 23.07.2022
 ### Added
 - Created end-to-end testing for the library using Jest

package/README.md

@@ -1713,8 +1713,6 @@ Solution:
 Solution:
 - See [this issue comment](https://github.com/jisotalo/ads-client/issues/51#issuecomment-758016428) by hansipete how to do it.
 
-
-
 ### A data type is not found even when it should be
 
 If you use methods like `convertFromRaw()` and `getDataType()` but receive an error similar to `ClientException: Finding data type *data type* failed`, make sure you have really written the data type correctly.
@@ -1756,6 +1754,16 @@ Another option is to use setting `bareClient: true` (since v.1.13.0). However, w
 
 I would suggest to use ads-client normally without any special settings. If the target is at config mode, use separate client instance to start it, and the again the normal instance to connect to a running system. This way the client works the best.
 
+### Getting a message `Ads notification received but it has unknown notificationHandle (**). Use unsubscribe() to save resources.`
+
+Possible reasons:
+* You have created notifications (subscriptions) using `subscribe()` and then closed the Node.js application without unsubscribing them first (TwinCAT still sends the data)
+* You are connecting without router (providing directly the target IP as router address) and you have other connections too like TwinCAT XAE running. See issue: https://github.com/jisotalo/ads-client/issues/85
+
+Solution:
+* When closing application, first unsubscribe from all notifications using `unsubscribeAll()`
+* Use router instead of direct connection, see https://github.com/jisotalo/ads-client/issues/85#issuecomment-1193098519
+
 # Automatic testing
 Since version 1.14.0 the library has automatic testing using Jest. Idea is to run the tests before updates to make sure everything works OK (this should have been done much earlier...)
 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "ads-client",
-  "version": "1.14.0",
+  "version": "1.14.2",
   "description": "Beckhoff TwinCAT ADS client library for Node.js (unofficial). Connects to Beckhoff TwinCAT automation systems using ADS protocol.",
   "main": "./src/ads-client.js",
   "scripts": {

package/src/ads-client.js

@@ -61,7 +61,7 @@ class Client extends EventEmitter {
    * @property {boolean} [readAndCacheDataTypes=false] - If true, all PLC data types are cached during connecting. Otherwise they are read and cached only when needed - Optional (**default**: false)
    * @property {boolean} [disableSymbolVersionMonitoring=false] - If true, PLC symbol version changes aren't monitored and cached symbols and datatypes won't be updated after PLC program download - Optional - Optional (**default**: false)
    * @property {number} [routerTcpPort=48898] - Target ADS router TCP port - Optional (**default**: 48898)
-   * @property {string} [routerAddress=localhost] - Target ADS router IP address/hostname - Optional (**default**: localhost)
+   * @property {string} [routerAddress=127.0.0.1] - Target ADS router IP address/hostname - Optional (**default**: 127.0.0.1)
    * @property {string} [localAddress='(system default)'] - Local IP address to use, use this to change used network interface if required - Optional (**default**: System default)
    * @property {number} [localTcpPort='(system default)'] - Local TCP port to use for outgoing connections - Optional (**default**: System default)
    * @property {string} [localAmsNetId='(from AMS router)'] - Local AmsNetId to use - Optional (**default**: From AMS router)
@@ -91,7 +91,7 @@ class Client extends EventEmitter {
       readAndCacheDataTypes: false,
       disableSymbolVersionMonitoring: false,
       routerTcpPort: 48898,
-      routerAddress: 'localhost',
+      routerAddress: '127.0.0.1',
       localAddress: null,
       localTcpPort: null,
       localAmsNetId: null,
@@ -145,6 +145,12 @@ class Client extends EventEmitter {
       this.settings.targetAmsNetId = '127.0.0.1.1.1'
     }
 
+    //Checking that router address is 127.0.0.1 instead of localhost
+    //to prevent problem like https://github.com/nodejs/node/issues/40702
+    if (this.settings.routerAddress.toLowerCase() === 'localhost') {
+      this.settings.routerAddress = '127.0.0.1'
+    }
+
     /**
      * Internal variables - Not intended for external use
      * 
@@ -1218,7 +1224,11 @@ class Client extends EventEmitter {
           unSubCount++
 
         } catch (err) {
-          debug(`unsubscribeAll(): Unsubscribing from notification ${JSON.stringify(this._internals.activeSubscriptions[sub].target)} failed`)
+          if (this._internals.activeSubscriptions[sub] && this._internals.activeSubscriptions[sub].target !== undefined) {
+            debug(`unsubscribeAll(): Unsubscribing from notification ${JSON.stringify(this._internals.activeSubscriptions[sub].target)} failed`)
+          } else {
+            debug(`unsubscribeAll(): Unsubscribing from notification with handle ${sub} failed`)
+          }
 
           firstError = new ClientException(this, 'unsubscribeAll()', err)
         }
@@ -4716,32 +4726,32 @@ async function _parseDataType(data) {
   dataType.adsDataTypeStr = ADS.ADS_DATA_TYPES.toString(dataType.adsDataType)
   pos += 4
 
-  //27..30 Flags (AdsDataTypeFlags)
-  dataType.flags = data.readUInt16LE(pos)
+  //28..31 Flags (AdsDataTypeFlags)
+  dataType.flags = data.readUInt32LE(pos)
   dataType.flagsStr = ADS.ADS_DATA_TYPE_FLAGS.toStringArray(dataType.flags)
   pos += 4
 
-  //31..32 Name length
+  //32..33 Name length
   dataType.nameLength = data.readUInt16LE(pos)
   pos += 2
 
-  //33..34 Type length
+  //34..35 Type length
   dataType.typeLength = data.readUInt16LE(pos)
   pos += 2
 
-  //35..36 Comment length
+  //36..37 Comment length
   dataType.commentLength = data.readUInt16LE(pos)
   pos += 2
 
-  //37..40 Array dimension
+  //38..39 Array dimension
   dataType.arrayDimension = data.readUInt16LE(pos)
   pos += 2
 
-  //41..42 Subitem count
+  //40..41 Subitem count
   dataType.subItemCount = data.readUInt16LE(pos)
   pos += 2
 
-  //43.... Name
+  //42.... Name
   dataType.name = _trimPlcString(iconv.decode(data.slice(pos, pos + dataType.nameLength + 1), 'cp1252'))
   pos += dataType.nameLength + 1
 
@@ -6321,7 +6331,7 @@ async function _onAdsCommandReceived(packet) {
               parsedValue.timeStamp = stamp.timeStamp
 
               //Then lets call the users callback
-              sub.callback(
+              sub.callback && sub.callback(
                 parsedValue,
                 sub
               )