Beckhoff.TwinCAT.Ads.Reactive 4.4.12

The ID prefix of this package has been reserved for one of the owners of this package by NuGet.org. Prefix Reserved
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.Reactive --version 4.4.12
NuGet\Install-Package Beckhoff.TwinCAT.Ads.Reactive -Version 4.4.12
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.Reactive" Version="4.4.12" />
For projects that support PackageReference, copy this XML node into the project file to reference the package.
paket add Beckhoff.TwinCAT.Ads.Reactive --version 4.4.12
#r "nuget: Beckhoff.TwinCAT.Ads.Reactive, 4.4.12"
#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.Reactive as a Cake Addin
#addin nuget:?package=Beckhoff.TwinCAT.Ads.Reactive&version=4.4.12

// Install Beckhoff.TwinCAT.Ads.Reactive as a Cake Tool
#tool nuget:?package=Beckhoff.TwinCAT.Ads.Reactive&version=4.4.12

Description

The package 'Beckhoff.TwinCAT.Ads.Reactive' implements reactive extensions for the TwinCAT.Ads.TcAdsClient class included in the 'Beckhoff.TwinCAT.Ads' package.

Reactive Extensions (Rx) is a .NET library for composing asynchronous and event-based programs using observable sequences and LINQ-style query operators. Using Rx, developers represent asynchronous data streams with Observables, query asynchronous data streams using LINQ operators, and parameterize the concurrency in the asynchronous data streams using Schedulers.

Simply put, Rx = Observables + LINQ + Schedulers.

In ADS terms, not only the reading and writing data or symbol values can be put into reactive data streams, also ADS Notifications or polling of values are a perfect fit for reactive code. With the help of this package not only data binding to reactive frameworks (e.g. reactive UI) is simplified but also enhanced data manipulation via synchronous and asynchronous observers. Multithreaded and parallelized code paths that support multiple CPU cores can be written very easily without the burden of deadlock and synchronization issues.

Requirements

  • .NET Framework 4.61 or later
  • A TwinCAT Installation (ADS, XAR or Full)

First Steps

The following code instantiates an AdsClient object, connects to the local PLC System Port 851 and subscribes fir the first 20 change notifications of the Task cycle count and writes the value to the Console.

sing System;
using System.Collections.Generic;
using System.Linq;
using System.Reactive;
using System.Reactive.Linq;
using TwinCAT.Ads;
using TwinCAT.Ads.Reactive;
using TwinCAT.Ads.TypeSystem;
using TwinCAT.TypeSystem;

namespace ReactiveTest
{
    class Program
    {
        // To Test the Observer run a project on the local PLC System (Port 851)
        using (TcAdsClient client = new TcAdsClient())
        {
            // Connect to target
            client.Connect(new AmsAddress(AmsNetId.Local, 851));

            // Reactive Notification Handler
            var valueObserver = Observer.Create<ushort>(val =>
            {
                Console.WriteLine(string.Format("Value: {0}", val.ToString()));
            }
            );

            // Turning ADS Notifications into sequences of Value Objects (Taking 20 Values)
            // and subscribe to them.
            IDisposable subscription = client.WhenNotification<ushort>("TwinCAT_SystemInfoVarList._TaskInfo.CycleCount", NotificationSettings.Default).Take(20).Subscribe(valueObserver);

            Console.ReadKey(); // Wait for Key press
            subscription.Dispose(); // Dispose the Subscription
        }
    }
}

Hints

For more information and Samples please consult the Beckhoff InfoSystem: Beckhoff.TwinCAT.Ads API Documentation

Product Compatible and additional computed target framework versions.
.NET Framework net40 is compatible.  net403 was computed.  net45 was computed.  net451 was computed.  net452 was computed.  net46 was computed.  net461 was computed.  net462 was computed.  net463 was computed.  net47 was computed.  net471 was computed.  net472 was computed.  net48 was computed.  net481 was computed. 
Compatible target framework(s)
Included target framework(s) (in package)
Learn more about Target Frameworks and .NET Standard.

NuGet packages (2)

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

Package Downloads
PlcInterface.Ads

A PLC communication implementation for Beckhoff ADS

Community.TwinCAT.Mdp.Reactive

Contains a MDP client implementation for the Beckhoff Device Manager communication protocol based on the TwinCAT.Ads.AdsClient. The Root object is the TwinCAT.MDP.MdpClient to communicate with the Beckhoff Device Manager via ADS. Use TwinCAT.Mdp.Reactive for reactive extensions.

GitHub repositories

This package is not used by any popular GitHub repositories.

Version Downloads Last updated
6.1.203 737 3/15/2024
6.1.197 737 2/12/2024
6.1.154 5,042 12/8/2023
6.1.125 767 11/23/2023
6.0.356 822 2/12/2024
6.0.334 477 12/8/2023
6.0.322 107 11/23/2023
4.4.26 646 7/27/2023

Release Notes::
===============

4.4.7
=====
Bug: Nuget Package Dependencies are referencing System.Reactive Version 4.1. Changed to 4.4.1

4.4.2
=====
Enh: Reactive extension methods WhenNotification, WhenNotificationEx, WhenAdsStateChanges, PollAdsState, PollValues, WriteValues now detect the SymbolVersionChanged event and recreate internally stored
handles. This enables the Observables to survive an upload of PlcPrograms (with still existing symbols.)
Enh: Added WhenSymbolVersionChanges Observable.

4.4.0
=====
Enh: Referencing TwinCAT.Ads.dll AssemblyVersion 4.4.0.0 to prevent GAC usage in TwinCAT installations and restore Nuget Semantic Package Versioning.

4.3.10.0
========
Enh: Updated System.Reactive package from 4.1.0 to 4.1.6

4.3.7.0
=======
Enh: Some minor improvements.

4.3.1.0
=======
Enh: AdsClientExtensions.PollAdsState added

4.3.0.0
=======
First version of the 4.3.X.X series of the Beckhoff.TwinCAT.Ads.Reactive package