ads-client 1.13.0 → 1.13.1

package/CHANGELOG.md

@@ -4,6 +4,12 @@ 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.13.1] - 04.04.2022
+### Changed
+- Bug fix: Undefined variable `message` [See issue #89](https://github.com/jisotalo/ads-client/issues/89)
+- Updated ADS error codes with new ones [See issue #88](https://github.com/jisotalo/ads-client/issues/88)
+- Updated README
+
 ## [1.13.0] - 27.02.2022
 ### Added
 - Added new setting `bareClient`. If it's set, the client will only connect to the target, nothing else

package/README.md

@@ -2,7 +2,7 @@
 
 
 [![npm version](https://img.shields.io/npm/v/ads-client)](https://www.npmjs.org/package/ads-client) 
-[![GitHub milestone](https://img.shields.io/github/milestones/progress-percent/jisotalo/ads-client/1)](https://github.com/jisotalo/ads-client/milestone/1)
+[![Donate](https://img.shields.io/badge/Donate-PayPal-yellow)](https://www.paypal.com/donate/?business=KUWBXXCVGZZME&no_recurring=0&currency_code=EUR)
 [![GitHub](https://img.shields.io/badge/View%20on-GitHub-brightgreen)](https://github.com/jisotalo/ads-client)
 [![License](https://img.shields.io/github/license/jisotalo/ads-client)](https://choosealicense.com/licenses/mit/)
 
@@ -13,10 +13,15 @@ Coded from scratch using [TwinCAT ADS specification](https://infosys.beckhoff.co
 There is automatically created documentation available at https://jisotalo.github.io/ads-client/
 
 # Project status
-This project is currently "ready". It's maintained actively and used in projects by the author and others.
+This project is currently "ready". It's maintained actively and used in projects by the author and others (also lot's of commercial projects)
 
 Bugs are fixed if found and new features can be added. Please let me know if you have any ideas!
 
+And if you want you can buy me a beer using PayPal :)
+
+[![Donate](https://img.shields.io/badge/Donate%20a%20beer!-PayPal-yellow)](https://www.paypal.com/donate/?business=KUWBXXCVGZZME&no_recurring=0&currency_code=EUR)
+
+
 # Using Node-RED?
 Check out the [node-red-contrib-ads-client](https://www.npmjs.com/package/node-red-contrib-ads-client) package. It's an `ads-client` wrapper for Node-RED to get the same functionality.
 
@@ -1662,6 +1667,19 @@ See https://github.com/jisotalo/ads-client/issues/82
 
 - EADDRNOTAVAIL: See above and https://github.com/jisotalo/ads-client/issues/82
 
+### How to connect to PLC that is in CONFIG mode?
+As default, the ads-client checks if the target has PLC runtime at given port. However, when target system manager is at config mode, there is none. The client will throw an error during connecting.
+
+`Target and system manager found but couldn't connect to the PLC runtime (see settings allowHalfOpen and bareClient)`
+
+You can disable the check by providing setting `allowHalfOpen: true`. After that, it's possible to start the PLC by `setSystemManagerToRun()`. However, when using this setting internal subscription like symbol version etc. might not work properly.
+
+Another option is to use setting `bareClient: true` (since v.1.13.0). However, when using this option, the ads-client does not handle anything automatically - it's just a bare client (duh).
+
+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.
+
+
+
 # Documentation
 
 You can find the full html documentation from the project [GitHub home page](https://jisotalo.github.io/ads-client/) as well as from `./docs/` folder in the repository.

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "ads-client",
-  "version": "1.13.0",
+  "version": "1.13.1",
   "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-ads.js

@@ -352,6 +352,8 @@ const ADS_ERROR = {
   26: 'TCP send error',
   27: 'Host unreachable',
   28: 'Invalid AMS fragment',
+  29: 'TLS send error – secure ADS connection failed.',
+  30: 'Access denied – secure ADS access denied.',
   1280: 'No locked memory can be allocated',
   1281: 'The size of the router memory could not be changed',
   1282: 'The mailbox has reached the maximum number of possible messages. The current sent message was rejected',
@@ -363,6 +365,9 @@ const ADS_ERROR = {
   1288: 'The maximum number of Ports reached',
   1289: 'Invalid port',
   1290: 'TwinCAT Router not active',
+  1291: 'The mailbox has reached the maximum number for fragmented messages.',
+  1292: 'A fragment timeout has occurred.',
+  1293: 'The port is removed.',
   1792: 'General device error',
   1793: 'Service is not supported by server',
   1794: 'Invalid index group',
@@ -420,6 +425,7 @@ const ADS_ERROR = {
   1862: 'Error in win32 subsystem',
   1863: 'Invalid client timeout value',
   1864: 'Ads-port not opened',
+  1865: 'No AMS address.',
   1872: 'Internal error in ads sync',
   1873: 'Hash table overflow',
   1874: 'Key not found in hash',

package/src/ads-client.js

@@ -3128,7 +3128,7 @@ class ClientException extends Error {
     if (typeof Error.captureStackTrace === 'function') {
       Error.captureStackTrace(this, this.constructor)
     } else {
-      this.stack = (new Error(message)).stack
+      this.stack = (new Error(messageOrError)).stack
     }
 
     /**