Skip to content

Commit

Permalink
README and docs
Browse files Browse the repository at this point in the history
  • Loading branch information
jisotalo committed Oct 2, 2024
1 parent 19f06ae commit 578ee72
Show file tree
Hide file tree
Showing 3 changed files with 7 additions and 3 deletions.
6 changes: 5 additions & 1 deletion CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,14 +4,18 @@ 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.4] - UNRELEASED
## [2.0.0-beta.4] - 02.10.2024
- Improved TwinCAT 2 support
- Improved performance by caching base data types that aren't available in the PLC (for example, `INT16` in TC2)
- Bug fix: Building data types for TC2 system didn't always work (`DataType` flag is not set in base types)
- Bug fix: Building data types for TC2 system didn't always work (with arrays of base types)
- Added test suites for TwinCAT 2
- Separate TwinCAT 2 test PLC project created (See [https://github.com/jisotalo/ads-client-test-plc-project/tree/v2-dev](https://github.com/jisotalo/ads-client-test-plc-project/tree/v2-dev))
- Updated tests to work with TC2 (and removed tests for TC2 unsupported features)
- Bug fix: Client failed to disconnect when using [AdsRouterConsole](https://github.com/Beckhoff/TF6000_ADS_DOTNET_V5_Samples/tree/main/Sources/RouterSamples/AdsRouterConsoleApp) as a TwinCAT router
- Client now waits for port unregistering response, if the connection is not dropped immediately

Thank you [Christian Rishøj](https://github.com/crishoj) for contribution!

## [2.0.0-beta.3] - 10.09.2024
- **BREAKING:** Renamed `ReadWriteRawMultiCommand` property `writeData` to `value`
Expand Down
2 changes: 1 addition & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@ Connect to a Beckhoff TwinCAT automation system using the ADS protocol from a No

## v2 project status

**10.09.2024:** Beta 3 released! See [CHANGELOG.md](https://github.com/jisotalo/ads-client/blob/v2-dev/CHANGELOG.md) for details.
**02.10.2024:** Beta 4 released! See [CHANGELOG.md](https://github.com/jisotalo/ads-client/blob/v2-dev/CHANGELOG.md) for details.

All breaking changes are (hopefully) done.

Expand Down
2 changes: 1 addition & 1 deletion docs/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@
<a href="https://www.paypal.com/donate/?business=KUWBXXCVGZZME&amp;no_recurring=0&amp;currency_code=EUR"><img src="https://img.shields.io/badge/Donate-PayPal-yellow" alt="Support"></a></p>
<p>Beckhoff TwinCAT ADS client library for Node.js (unofficial).</p>
<p>Connect to a Beckhoff TwinCAT automation system using the ADS protocol from a Node.js app.</p>
<a id="md:v2-project-status" class="tsd-anchor"></a><h2 class="tsd-anchor-link">v2 project status<a href="#md:v2-project-status" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="assets/icons.svg#icon-anchor"></use></svg></a></h2><p><strong>10.09.2024:</strong> Beta 3 released! See <a href="https://github.com/jisotalo/ads-client/blob/v2-dev/CHANGELOG.md">CHANGELOG.md</a> for details.</p>
<a id="md:v2-project-status" class="tsd-anchor"></a><h2 class="tsd-anchor-link">v2 project status<a href="#md:v2-project-status" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="assets/icons.svg#icon-anchor"></use></svg></a></h2><p><strong>02.10.2024:</strong> Beta 4 released! See <a href="https://github.com/jisotalo/ads-client/blob/v2-dev/CHANGELOG.md">CHANGELOG.md</a> for details.</p>
<p>All breaking changes are (hopefully) done.</p>
<ul>
<li>See <a href="https://github.com/jisotalo/ads-client/milestone/2">milestone #2</a> for tasks to be done.</li>
Expand Down

0 comments on commit 578ee72

Please sign in to comment.