Beckhoff.TwinCAT.Ads 5.0.0-preview6

The ID prefix of this package has been reserved for one of the owners of this package by NuGet.org. Prefix Reserved
.NET Core 3.0 .NET Standard 2.0 .NET Framework 4.6.1
This is a prerelease version of Beckhoff.TwinCAT.Ads.
There is a newer version of this package available.
See the version list below for details.
The owner has unlisted this package. This could mean that the package is deprecated, has security vulnerabilities or shouldn't be used anymore. 
dotnet add package Beckhoff.TwinCAT.Ads --version 5.0.0-preview6
NuGet\Install-Package Beckhoff.TwinCAT.Ads -Version 5.0.0-preview6
This command is intended to be used within the Package Manager Console in Visual Studio, as it uses the NuGet module's version of Install-Package. 
<PackageReference Include="Beckhoff.TwinCAT.Ads" Version="5.0.0-preview6" />
For projects that support PackageReference, copy this XML node into the project file to reference the package. 
paket add Beckhoff.TwinCAT.Ads --version 5.0.0-preview6
#r "nuget: Beckhoff.TwinCAT.Ads, 5.0.0-preview6"
#r directive can be used in F# Interactive and Polyglot Notebooks. Copy this into the interactive tool or source code of the script to reference the package. 
// Install Beckhoff.TwinCAT.Ads as a Cake Addin
#addin nuget:?package=Beckhoff.TwinCAT.Ads&version=5.0.0-preview6&prerelease

// Install Beckhoff.TwinCAT.Ads as a Cake Tool
#tool nuget:?package=Beckhoff.TwinCAT.Ads&version=5.0.0-preview6&prerelease

Description

The package 'Beckhoff.TwinCAT.Ads' contains a client implementation for the ADS Communication protocol used by .NET Core and .NET Full Framework. It includes everything to develop own .NET applications (e.g. HMI, Datalogger) to communicate with TwinCAT devices (e.g. PLC, NC or IO-devices).

The Root object is the TwinCAT.Ads.AdsClient to communicate to all variants of local and remote ADS servers and devices or the AdsSession object.

Requirements

  • .NET Core 3.0, .NET Framework 4.61 or .NET Standard 2.0 compatible SDK or later For ADS clients on TwinCAT systems
  • A TwinCAT 3.1.4024 Build (XAE, XAR or ADS Setup) or alternatively the Beckhoff.TwinCAT.AdsRouterConsole Application For ADS clients on Non-TwinCAT systems
  • Nuget package 'Beckhoff.TwinCAT.Ads.AdsRouterConsole'. to route ADS communication

Installation

System with TwinCAT System Service (TCP Loopback enabled, Versions 4024.0 and 4025.5)

  1. Running TwinCAT 3.1.4024 Installation

  2. Stop TwinCAT System Service

  3. Enable TCP Loopback for TwinCAT 3.1.4024.0 or 3.1.4024.4 via regkey:
    32-Bit Windows Operating System:

     HKEY_LOCAL_MACHINE\SOFTWARE\Beckhoff\TwinCAT3\System\EnableAmsTcpLoopbackDWORD (1)

    64-Bit Windows Operating System:

     HKEY_LOCAL_MACHINE\SOFTWARE\WOW6432Node\Beckhoff\TwinCAT3\System\EnableAmsTcpLoopback	DWORD(1)

    Systems >= 3.1.4024.5 support TCPLoopback out of the box. No registry changes necessary

  4. Restart TwinCAT System Service

System without TwinCAT System Service

Install the 'Beckhoff.TwinCAT.Ads.AdsRouterConsole' package from Nuget.org:

PS> nuget install Beckhoff.TwinCAT.Ads.AdsRouterConsole

To enable ADS Communication via the AdsRouteConsole, the following settings have to be made:

  • Select the local unique AmsNetId and the route name of the system in the local "StaticRoutes.xml" beside of the AdsRouteConsole
  • Add remote connections to the local "StaticRoutes.xml".
  • Add the "Backroute" from the remote system linking to the your system (via AmsNeTId) running the AdsRouteConsole. This can be done within of a TwinCAT Project or via the TwinCAT System Tray icon.

An example of the local "StaticRoutes.xml" is given here:

<?xml version="1.0" encoding="utf-8"?>
<TcConfig xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="C:\TwinCAT3\Config\TcConfig.xsd">
  <Local>
      <Name>MyLocalSystem</Name>
      <NetId>192.168.1.22.1.1</NetId>
  </Local>
  <RemoteConnections>
    <Route>
      <Name>MyRemoteSystem</Name>
      <Address>RemoteSytem</Address> 
       
      <NetId>192.168.1.21.1.1</NetId>
      <Type>TCP_IP</Type>
    </Route>
  </RemoteConnections>
</TcConfig>

First Steps

The following code instantiates an AdsClient object, connects to a target device (here the local System Service) and reads the ADS state asynchronously.

using System;
using System.Threading.Tasks;
using System.Threading;
using TwinCAT.Ads;

namespace AdsAsyncTest
{
    class Program
    {
        static async Task Main(string[] args)
        {
            AdsClient myClient = new AdsClient();
            try
            {
                // Connect to local TwinCAT System Service
                myClient.Connect(AmsNetId.Local, 10000);
                ResultReadDeviceState result = await myClient.ReadStateAsync(CancellationToken.None);
                Console.WriteLine("State: " + result.State.AdsState);
                Console.WriteLine("Press key to exit...");
                Console.ReadKey();
            }
            catch (Exception e)
            {
                Console.WriteLine(e.Message.ToString());
            }
            finally
            {
                myClient.Dispose();
            }
        }
    }
}

Please be aware, that the AdsRouteConsole doesn't provide the AmsPort 10000, due to the missing TwinCAT System Service. Therefore the AmsNetId of the connection must be changed to a registered remote system.

Hints

There are a few breaking changes in the new version to enable asynchronous programming, reducing the memory footprint and enhancement of the performance. Nevertheless the usage the TwinCAT.Ads.AdsClient is very similar to the documented 4.3.0 Version of the class TwinCAT.Ads.TcAdsClient.

The Link to the Version 4.3.0 API documentation is:

https://infosys.beckhoff.com/content/1031/tcadsnetref/6358291723.html?id=8100459743587155746

Please use this documentation as long as the 'official' Version for ADS 5.0.0 is not released.

The main issues you will have with 'legacy' code:

  • Renaming the TcAdsClient class to AdsClient
  • Changing synchronous code to 'async'. The new asynchronous methods are indicated with “MethodNameAsync” and could be used very similar to their synchronous counterparts.
  • For using .NET Core more efficiently, all the AdsStream class appearances in method interfaces are replaced by the new more efficient Span<byte> and Memory[byte] classes.
  • AdsBinaryReader and AdsBinaryWriter should be replaced by using the standard BinaryReader and/or System.Buffers.Binary.BinaryPrimitives Methods.

VersionHistory

5.0.0-preview6

Fix: ArgumentOutOfRange Exception on CNC GEO Task Fix: TwinCAT.AdsSymbolLoaderSettings.Default corrected to 'Symbolic' Enh: Refactoring InvokeRpcMethod (Support of out-parameters), Parameter checking enhanced Enh: Support of platform specific data types 'UXINT, XINT, XWORD'. Enh: Support of Recreating cached symbol handles on SymbolVersionChanged event when using AdsClient ReadSymbol, WriteSymbol methods and AddDeviceNotifications with SymbolPath.

Product Compatible and additional computed target framework versions.
.NET net5.0 was computed.  net5.0-windows was computed.  net6.0 was computed.  net6.0-android was computed.  net6.0-ios was computed.  net6.0-maccatalyst was computed.  net6.0-macos was computed.  net6.0-tvos was computed.  net6.0-windows was computed.  net7.0 was computed.  net7.0-android was computed.  net7.0-ios was computed.  net7.0-maccatalyst was computed.  net7.0-macos was computed.  net7.0-tvos was computed.  net7.0-windows was computed.  net8.0 was computed.  net8.0-android was computed.  net8.0-browser was computed.  net8.0-ios was computed.  net8.0-maccatalyst was computed.  net8.0-macos was computed.  net8.0-tvos was computed.  net8.0-windows was computed. 
.NET Core netcoreapp2.0 was computed.  netcoreapp2.1 was computed.  netcoreapp2.2 was computed.  netcoreapp3.0 is compatible.  netcoreapp3.1 was computed. 
.NET Standard netstandard2.0 is compatible.  netstandard2.1 was computed. 
.NET Framework net461 is compatible.  net462 was computed.  net463 was computed.  net47 was computed.  net471 was computed.  net472 was computed.  net48 was computed.  net481 was computed. 
MonoAndroid monoandroid was computed. 
MonoMac monomac was computed. 
MonoTouch monotouch was computed. 
Tizen tizen40 was computed.  tizen60 was computed. 
Xamarin.iOS xamarinios was computed. 
Xamarin.Mac xamarinmac was computed. 
Xamarin.TVOS xamarintvos was computed. 
Xamarin.WatchOS xamarinwatchos was computed. 
Compatible target framework(s)
Included target framework(s) (in package)
Learn more about Target Frameworks and .NET Standard.

NuGet packages (19)

Showing the top 5 NuGet packages that depend on Beckhoff.TwinCAT.Ads:

Package Downloads
TwinCAT.JsonExtension

Convert TwinCAT variables to and from Json
Haku.Zvar

Package Description
Beckhoff.TwinCAT.Ads.SymbolicServer The ID prefix of this package has been reserved for one of the owners of this package by NuGet.org.

The Beckhoff.TwinCAT.Ads.SymbolicServer Package can be used to implement your own ADS Server.
YSAI.Beckhoff

采集协议：Beckhoff ( 倍福 - Tcp )
PlcInterface.Ads

A PLC communication implementation for Beckhoff ADS

GitHub repositories

This package is not used by any popular GitHub repositories.

Version Downloads Last updated
6.1.203 4,031 3/15/2024
6.1.197 10,217 2/12/2024
6.1.154 16,216 12/8/2023
6.1.125 4,944 11/23/2023
6.0.356 1,113 2/12/2024
6.0.334 961 12/8/2023
6.0.322 725 11/23/2023
4.4.26 4,121 7/27/2023

Preview version of the Beckhoff.TwinCAT.Ads 5.0.0 Version branch. Don't use for productive code.