ads-client 1.14.2 → 2.0.0-beta.1

package/CHANGELOG.md

@@ -4,6 +4,51 @@ 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).
 
+## [2.0.0-beta.1] - 24.08.2024
+**IMPORTANT:** This is a major version update. There are lots of **breaking changes**! 
+
+<u>**Updating v1 -> v2 requires manual changes to your codebase!**</u>
+
+See [MIGRATION.md](MIGRATION.md) for all breaking changes and follow the instructions. This changelog does not have breaking changes listed for 2.0.0.
+
+### Changes
+- Everything rewritten in TypeScript
+- Everything is tested before releasing
+- Lots of optimizations
+- Lots of name changes
+- New methods: `resetPlc()`, `readWriteRawMulti()`, `writeRawByPath()`, `readValueBySymbol()`, `writeValueBySymbol()`
+- New setting `disableCaching`: disables all symbol and data type caching
+- Added optional `targetOpts` argument in **all methods**
+  - Possible to provide different target address (AmsNetId and/or AdsPort) than specified in the settings
+  - Caching is only available for the original target provided in settings
+  - The same client can be used for many different targets at the same time
+- Added support for reading/writing `INTERFACE` data types
+- Added support for reading/writing empty `FUNCTION_BLOCK`s
+- Added support for reading/writing `BIT` data type
+- Writing a `STRING` or `WSTRING` value that is longer than the target data type causes the string to be truncated.
+  - Previously the string end character was lost, which caused "never ending string" and `<Value of the expression cannot be retrieved` in PLC online view.
+  - E.g. writing 85 bytes of string to `STRING(80)` variable
+- `BOOL` and `BIT` data values are now true if the value is anything else than 0
+  - In TwinCAT, `BOOL` is true if the value is anything else than zero (see [x_TO_BOOL](https://infosys.beckhoff.com/english.php?content=../content/1033/tc3_plc_intro/2529047435.html&id=))
+  - Before, ads-client set the value to true only if value was true or 1, otherwise it was 0
+- `writeControl()` accepts also string values for `adsState`
+
+## [1.14.3] - 23.09.2023
+### Changed
+- Bug fix: Some TwinCAT 2 devices (such as BK9050) do not send data length if answering with error code
+  - This caused `RangeError: Index out of range` exception as there wasn't enough bytes received
+  - See [issue #116](https://github.com/jisotalo/ads-client/issues/116)
+- Bug fix: If using older Node.js versions such as 8.x, connection lost could have caused unhandled exception
+  - Reason was `catch {}` which isn't supported in old versions
+  - See [issue #116](https://github.com/jisotalo/ads-client/issues/116)
+
+### Added
+- Updated readme to include information about TypeScript types
+  - Thanks to [Christian Rishøj](https://github.com/crishoj)
+- Updated readme with FAQ about TwinCAT 2 low-end devices
+- Updated readme about v2 development
+- Added option to run tests with usermode runtime AmsNetId (`192.168.4.1.1.1`) instead of localhost (`npm run test-um`)
+
 ## [1.14.2] - 02.05.2023
 ### Changed
 - Bug fix: `ADS_DATA_TYPE_FLAGS` (`dataType.flags`) were parsed incorrectly. 
@@ -26,6 +71,7 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
   - 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/LICENSE.txt

@@ -1,6 +1,6 @@
 MIT License
 
-Copyright (c) 2020 Jussi Isotalo <j.isotalo91@gmail.com>
+Copyright (c) Jussi Isotalo <j.isotalo91@gmail.com>
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal