IoT-Driver.TwinCATRx.Reactive 1.0.2

.NET 8.0 .NET Framework 4.6.2

dotnet add package IoT-Driver.TwinCATRx.Reactive --version 1.0.2

NuGet\Install-Package IoT-Driver.TwinCATRx.Reactive -Version 1.0.2

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="IoT-Driver.TwinCATRx.Reactive" Version="1.0.2" />

For projects that support PackageReference, copy this XML node into the project file to reference the package.

<PackageVersion Include="IoT-Driver.TwinCATRx.Reactive" Version="1.0.2" />
                    

                            Directory.Packages.props

<PackageReference Include="IoT-Driver.TwinCATRx.Reactive" />
                    

                            Project file

For projects that support Central Package Management (CPM), copy this XML node into the solution Directory.Packages.props file to version the package.

paket add IoT-Driver.TwinCATRx.Reactive --version 1.0.2

The NuGet Team does not provide support for this client. Please contact its maintainers for support.

#r "nuget: IoT-Driver.TwinCATRx.Reactive, 1.0.2"

#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.

#:package IoT-Driver.TwinCATRx.Reactive@1.0.2

#:package directive can be used in C# file-based apps starting in .NET 10 preview 4. Copy this into a .cs file before any lines of code to reference the package.

#addin nuget:?package=IoT-Driver.TwinCATRx.Reactive&version=1.0.2
                    

                            Install as a Cake Addin

#tool nuget:?package=IoT-Driver.TwinCATRx.Reactive&version=1.0.2
                    

                            Install as a Cake Tool

The NuGet Team does not provide support for this client. Please contact its maintainers for support.

TwinCATRx

Overview

IoT-Driver.TwinCATRx provides reactive Beckhoff TwinCAT ADS access: configuration-driven notifications, one-shot reads and writes, typed observation extensions, structured values, and an in-memory ADS client for deterministic tests.

Safety

ADS writes change PLC state. Use a non-production target for development, separate engineering and production networks, restrict routes and credentials, validate every value and array length, and retain controller-side interlocks. Never use a reactive stream as the sole safety mechanism.

Package matrix

Package	Default namespace	Targets	Purpose
`IoT-Driver.TwinCATRx`	`IoT.Driver.TwinCATRx`	core targets plus Windows targets	ADS client, observables, and structures
`IoT-Driver.TwinCATRx.Reactive`	`IoT.Driver.TwinCATRx.Reactive`	matching package targets	System.Reactive-compatible surface where supplied
`IoT-Driver.TwinCATRx.Core`	`IoT.Driver.TwinCATRx.Core`	net462, net472, net48, net481, net8.0-net11.0	Shared settings, ADS abstractions, conversion, retry, and dynamic-code helpers
`IoT-Driver.TwinCATRx.Core.Reactive`	`IoT.Driver.TwinCATRx.Core.Reactive`	matching core targets	System.Reactive-compatible core helper surface
`IoT-Driver.TwinCATRx.Generators`	source attributes are in `IoT.Driver.TwinCATRx`	analyzer targets supplied by the compiler	Standalone reactive-stream analyzer package.

The package references HashTableRx, ReactiveUI.Primitives, and ReactiveUI.Primitives.Async. The TwinCATRx.Core dependency supplies Settings, ISettings, ADS abstractions, and configuration extensions. Dynamic ADS type generation is annotated for trimming/AOT analysis; source-generated stream models avoid application-level runtime reflection.

Install

dotnet add package IoT-Driver.TwinCATRx
# Add separately only when using generated stream or connection models.
dotnet add package IoT-Driver.TwinCATRx.Generators

Quick start

using IoT.Driver.TwinCATRx;
using IoT.Driver.TwinCATRx.Core;

using var client = new RxTcAdsClient();
var settings = new Settings { AdsAddress = "5.35.59.10.1.1", Port = 851, SettingsId = "Default" };
settings.AddNotification(".AInt");
settings.AddWriteVariable(".AInt");

using var values = client.Observe<short>(".AInt", value => Convert.ToInt16(value))
    .Subscribe(value => Console.WriteLine($"AInt = {value}"));
using var failures = client.ErrorReceived.Subscribe(Console.Error.WriteLine);

client.Connect(settings);
client.Read(".AInt");
client.Write(".AInt", (short)42);

InitializeComplete is the readiness signal for a completed connection/setup. DataReceived emits (Variable, Data, Id) updates; use the id overloads of Read, Write, and Observe to correlate one-shot activity.

Configuration

Set Settings.AdsAddress, Port, and SettingsId, then register every notification with AddNotification and every writable variable with AddWriteVariable. The configuration overloads accept a cycle time and an array/string size. Supply a positive explicit size for ADS strings and arrays when the protocol cannot infer it.

Use Connect(ISettings), then Disconnect() before disposing. Dynamic structure materialization in Connect is marked RequiresDynamicCode and RequiresUnreferencedCode; publish trimmed/AOT applications only after validating their exact ADS structures.

Detailed features

Connection lifecycle, events, errors, and disposal

IRxTcAdsClient is the common contract implemented by RxTcAdsClient for ADS and InMemoryAdsClient for tests. Construct/configure the client, subscribe to its streams, call Connect(ISettings), wait for InitializeComplete, then read/write or observe. Disconnect() releases ADS handles while allowing a later Connect; Dispose() is terminal. Connected, Settings, IsPaused, IsPausedObservable, IsDisposed, ReadWriteHandleInfo, and WriteHandleInfo expose session state. There is no cancellation token on the synchronous ADS operations: cancel work by disposing the subscription/client or by composing an async observable with its cancellation-aware subscription.

ErrorReceived is the fault stream: subscribe before Connect, report the exception with the variable/correlation context held by your application, and do not assume an exception has stopped other notifications. Code exposes generated/dynamic type code where applicable, OnWrite emits written variable names, and DataReceived emits (Variable, Data, Id) for notification and correlated read results. Each has an IObservableAsync<T> counterpart where declared (...Async), suitable for the ReactiveUI.Primitives async observer model.

using IoT.Driver.TwinCATRx;
using IoT.Driver.TwinCATRx.Core;

using var client = new RxTcAdsClient();
using var errors = client.ErrorReceived.Subscribe(ex => AuditFailure(ex));
using var ready = client.InitializeComplete.Subscribe(_ => Console.WriteLine("ADS handles ready"));
using var written = client.OnWrite.Subscribe(name => Console.WriteLine($"Wrote {name}"));

var settings = new Settings { AdsAddress = "5.35.59.10.1.1", Port = 851, SettingsId = "LineA" };
settings.AddNotification(".Main.Temperature", cycleTime: 250);
settings.AddWriteVariable(".Main.Setpoint");
client.Connect(settings);
// Dispose subscriptions first, then Disconnect/Dispose when the application stops.

Settings, ADS addressing, notifications, and handles

Settings implements ISettings: set AdsAddress to the route/net-id accepted by TwinCAT, set the ADS Port (commonly 851 for a PLC runtime but use the configured target), and give the configuration a stable SettingsId. Its Notifications are INotification/Notification records (Variable, UpdateRate, ArraySize); write registrations are IWriteVariable/WriteVariable (Variable, ArraySize). The TwinCatRxExtensions.AddNotification overloads accept a name alone, name/cycle, or name/cycle/array size. AddWriteVariable accepts a name alone or name/array size. Register all desired handles before Connect; adding to Settings afterwards does not retrofit an existing session.

Use the exact PLC symbol spelling, including the leading-dot convention used by your project. For fixed-length STRING, arrays, or an ANYTYPE shape the runtime cannot infer, use the explicit size. A non-positive or incorrect size produces a handle/read conversion failure or truncated data; it is not a network retry condition.

var settings = new Settings
{
    AdsAddress = "5.35.59.10.1.1",
    Port = 851,
    SettingsId = "PackagingCell"
};
settings.AddNotification(".Main.State", 100);
settings.AddNotification(".Main.BatchName", 500, arraySize: 80);
settings.AddWriteVariable(".Main.RequestedSpeed");
settings.AddWriteVariable(".Main.Recipe", arraySize: 80);

One-shot reads, correlated requests, writes, and pause windows

Read(variable), Read(variable, id), Read(variable, arrayLength), and Read(variable, arrayLength, id) issue a one-shot read and publish its result through DataReceived. Use an id when several reads of the same variable can overlap; use arrayLength for an array/string request whose size is not registered. Write(variable, value) and Write(variable, value, id) issue a write and publish the variable through OnWrite; check ErrorReceived for asynchronous ADS failures. Calls are void because their useful completion signals are these streams.

Pause(TimeSpan) sets the pause state for paced write workflows; observe IsPausedObservable rather than guessing timing. It coordinates client work but does not create PLC-side transaction semantics. Use a PLC handshake/sequence value when multiple writes must be observed atomically by the control program.

using var reply = client.DataReceived
    .Where(x => x.Variable == ".Main.State" && x.Id == "state-42")
    .Take(1)
    .Subscribe(x => Console.WriteLine(Convert.ToInt16(x.Data)));

client.Read(".Main.State", "state-42");
client.Pause(TimeSpan.FromMilliseconds(100));
client.Write(".Main.RequestedSpeed", (short)1200, "speed-42");

Typed observable and asynchronous-observable APIs

TwinCatRxExtensions.Observe<T> is the usual typed adapter over DataReceived. Supply a variable and converter; its overload with an id lets one stream accept a particular correlated read/notification identity. It registers no magic conversion: the converter owns the cast/scale and should validate arrays/structures. ObserveAsyncObservable<T> provides the same value stream as IObservableAsync<T>; use it when downstream consumers implement IObserverAsync<T> or require cancellation-aware SubscribeAsync disposal.

using ReactiveUI.Primitives;
using ReactiveUI.Primitives.Async;

using var temperature = client.Observe<float>(".Main.Temperature", value => Convert.ToSingle(value))
    .DistinctUntilChanged()
    .Subscribe(RenderTemperature);

var asynchronous = client.ObserveAsyncObservable<short>(
    ".Main.State", "state-42", value => Convert.ToInt16(value));
await using var subscription = await asynchronous.SubscribeAsync(
    new ConsoleAsyncObserver<short>(Console.WriteLine), CancellationToken.None);

sealed class ConsoleAsyncObserver<T>(Action<T> onNext) : IObserverAsync<T>
{
    public ValueTask DisposeAsync() => default;
    public ValueTask OnCompletedAsync(Result result) => default;
    public ValueTask OnErrorResumeAsync(Exception error, CancellationToken cancellationToken) =>
        ValueTask.FromException(error);
    public ValueTask OnNextAsync(T value, CancellationToken cancellationToken)
    {
        cancellationToken.ThrowIfCancellationRequested();
        onNext(value);
        return default;
    }
}

ObservableBridgeExtensions.ToAsyncObservable adapts any ordinary IObservable<T> and SubscribeTo wires an IObservableAsync<T> into a standard observer. The concrete bridge adapters are implementation details; use the public extension methods and dispose the returned IDisposable or IAsyncDisposable, otherwise ADS notifications and UI handlers remain alive.

Structured variables and coordinated member writes

CreateStruct(variable) creates a TwinCatStructureTable backed by HashTableRx for a structured ADS symbol. It subscribes to updates and exposes the mapped fields; StructureReady() signals when the first usable structure has been materialized. CreateClone() returns a snapshot suitable for editing off-stream. WriteValues(table => ...) applies an edit against a clone and writes it; WriteValuesAsync(..., pace) performs the same action coordinated with Pause. These helpers suit engineering/configuration screens; for trimming/AOT-sensitive or high-throughput workloads, prefer a source-generated typed stream model.

var table = client.CreateStruct(".Main.Recipe");
if (table is null) throw new InvalidOperationException("Symbol is not a structure.");
using (table)
using (table.StructureReady().Take(1).Subscribe(_ => Console.WriteLine("Recipe available")))
{
    var editable = table.CreateClone();
    editable.Value("TargetWeight", 12.5f);
    if (!table.WriteValues(copy => copy.Value("TargetWeight", 12.5f)))
        Console.Error.WriteLine("Write was not accepted");

    bool completed = await table.WriteValuesAsync(
        copy => copy.Value("Enabled", true), TimeSpan.FromMilliseconds(150));
}

Logical tags, catalogs, persistence, and bulk workflows

TwinCatLogicalTagClient is the common logical-tag facade over an IRxTcAdsClient. Construct it with the native client and optionally an ILogicalTagCatalog, LogicalTagSqliteStore, and TimeProvider. Its Catalog holds the mappings. CreateTag, RegisterTag, and RemoveTag manage the in-memory map; ReadAsync/WriteAsync, ReadManyAsync/WriteManyAsync, Observe/ObserveMany, and ObserveAsync/ObserveManyAsync operate by logical name. Results are TagOperationResult<LogicalTagValue>: inspect their success/error data rather than assuming every request was accepted.

The persistence members InitializeStoreAsync, LoadTagsAsync, GetTagAsync, ListTagsAsync, UpsertTagAsync, EditTagAsync, DeleteTagAsync, group CRUD, ImportCsvAsync, and ExportCsvAsync support commissioning data. All have cancellation-bearing overloads where I/O occurs. Import into a staged catalog/store, validate address/type information against the PLC, then replace the active set - avoid modifying a live safety mapping from an unreviewed CSV.

using IoT.Driver.Core;

using var catalog = new LogicalTagCatalog();
var store = new LogicalTagSqliteStore("Data Source=logical-tags.db");
using var tags = new TwinCatLogicalTagClient(client, catalog, store);
await tags.InitializeStoreAsync(CancellationToken.None);
tags.RegisterTag(tags.CreateTag("Line.Speed", ".Main.ActualSpeed", "Int16"));

var read = await tags.ReadAsync("Line.Speed", CancellationToken.None);
if (read.Succeeded) Console.WriteLine(read.Value.Value);

var writes = await tags.WriteManyAsync(
    [new LogicalTagValue(
        "Line.Speed", (short)900, TimeProvider.System.GetUtcNow(), "Good")],
    CancellationToken.None);
using var changes = tags.Observe("Line.Speed").Subscribe(value => RenderSpeed((short)value.Value!));

In-memory ADS client and deterministic tests

InMemoryAdsClient implements IRxTcAdsClient without a TwinCAT runtime. Register scalar or typed symbols through RegisterSymbol/RegisterStructure, configure/connect it exactly as the production client, and exercise Read, Write, ReadMany, WriteMany, PublishNotifications, Pause, Reconnect, SetValue, TryGetValue, and RemoveSymbol. QueueFault(InMemoryAdsOperation, Exception) injects an expected failure. ConnectionState/ConnectionStates, Symbols, and OperationMetrics (InMemoryAdsOperationMetrics) make tests assertable without timing against a real ADS route. ResetOperationMetrics clears counters between scenarios.

using var fake = new InMemoryAdsClient();
fake.RegisterSymbol(".Main.Counter", 0);
fake.Connect(new Settings { SettingsId = "test", Port = 851 });
fake.QueueFault(InMemoryAdsOperation.Write, new InMemoryAdsException("planned"));
using var failed = fake.ErrorReceived.Take(1).Subscribe(_ => Console.WriteLine("fault observed"));
fake.Write(".Main.Counter", 1);            // exercises the failure route
fake.SetValue(".Main.Counter", 2);
fake.PublishNotifications();
Console.WriteLine(fake.OperationMetrics.WriteCount);

Source-generated reactive stream and connection models

Install IoT-Driver.TwinCATRx.Generators alongside exactly one TwinCAT runtime package. Runtime packages never contain the generator assembly. Apply TwinCatReactiveStreamAttribute(variable, dataType) to a partial class for the legacy stream surface, or apply TwinCatPlcConnectionAttribute(adsAddress, port) to a partial connection class and decorate members with DirectNotificationAttribute, StructuredNotificationAttribute, and/or WriteOnlyAttribute.

DirectNotificationAttribute accepts Address, optional CycleTime, ArraySize, Id, ObservableName, CanWrite, and WriteAddress. StructuredNotificationAttribute supplies an address and optional member address plus the same notification/write options. WriteOnlyAttribute supplies Address, ArraySize, and Id. The generator emits strongly typed properties, observable members, read/write helpers, settings registrations and connection lifecycle wiring; inspect compiler diagnostics/obj generated source when a partial declaration does not produce the expected member.

using IoT.Driver.TwinCATRx;

[TwinCatPlcConnection("5.35.59.10.1.1", 851, SettingsId = "LineA")]
public sealed partial class LineConnection
{
    [DirectNotification(".Main.Temperature", CycleTime = 250, CanWrite = false)]
    public float Temperature { get; private set; }

    [WriteOnly(".Main.Setpoint")]
    public float Setpoint { get; private set; }
}
// Generated members own typed observation/settings; the partial source remains the schema.

The legacy stream attribute is useful for a small, focused model rather than a full connection declaration. It generates a nullable typed property, classic/async observable properties, logical-tag read/write helpers, and BindTwinCatRx(IRxTcAdsClient). The analyzer is supplied only by IoT-Driver.TwinCATRx.Generators.

using IoT.Driver.TwinCATRx;
using IoT.Driver.TwinCATRx.Core;
using ReactiveUI.Primitives;

[TwinCatReactiveStream(
    ".Main.Counter", typeof(short), PropertyName = "Counter", ObservableName = "CounterValues")]
public sealed partial class LegacyCounterStream
{
}

using var client = new InMemoryAdsClient();
client.RegisterSymbol(".Main.Counter", (short)41);
client.Connect(new Settings { SettingsId = "legacy-demo", Port = 851 });

var model = new LegacyCounterStream();
using var values = model.CounterValues.Subscribe(value => Console.WriteLine(value));
using var binding = model.BindTwinCatRx(client);
client.Read(".Main.Counter"); // updates Counter and CounterValues through the generated binding

Core helpers, dynamic code generation, and service monitoring

IoT-Driver.TwinCATRx.Core contains CodeGenerator/ICodeGenerator, CSharpLanguage/ILanguageService, INodeEmulator, DirectoryInfoExtensions, Notification, WriteVariable, and the SimpleTypeException/UnsuportedTypeException error types. CodeGenerator uses a symbol graph to produce/compile dynamic type support. These are advanced integration APIs and carry dynamic-code/trimming annotations: validate the actual published artifact, preserve required members or choose source generation for NativeAOT/trimmed applications.

TwinCatRxExtensions.AdsStateChangedObserver and AdsStateObserver expose ADS state changes. Its OnErrorRetry overload family retries an observable with optional exception type, retry count/delay, and error callback; use bounded retry with telemetry, not an infinite blind loop around a safety operation. AssemblyLoad and GetType support plug-in/type loading. ObservableServiceController, IObservableServiceController, and ServiceStatus are Windows service-monitoring APIs; use them only on supported Windows targets and dispose their polling subscription.

using IoT.Driver.TwinCATRx.Core;
using ReactiveUI.Primitives;
using TwinCAT.Ads;

using var ads = new AdsClient();
using var adsState = TwinCatRxExtensions.OnErrorRetry<StateInfo, Exception>(
    TwinCatRxExtensions.AdsStateObserver(ads),
        error => Console.Error.WriteLine(error.Message),
        retryCount: 3,
        delay: TimeSpan.FromSeconds(1))
    .Subscribe(state => Console.WriteLine(state.AdsState));

using var service = new ObservableServiceController(
    new System.ServiceProcess.ServiceController("TcSysSrv"));
using var status = service.StatusObserver.Subscribe(s => Console.WriteLine(s));

The core APIs are independently usable, but dynamic-code methods are deliberately explicit about their deployment cost. The following source-verified recipe gives an ADS-state observer a bounded retry policy, emits a small support assembly, and emits source from a symbol tree discovered from the configured route. Run the dynamic part only in a non-trimmed, trusted engineering tool; it is not required for normal RxTcAdsClient use.

using IoT.Driver.TwinCATRx.Core;
using TwinCAT.Ads;

static IDisposable WatchAdsState(AdsClient ads) =>
    TwinCatRxExtensions.OnErrorRetry<StateInfo, Exception>(
        TwinCatRxExtensions.AdsStateObserver(ads),
            error => Console.Error.WriteLine(error.Message),
            retryCount: 3,
            delay: TimeSpan.FromSeconds(1))
        .Subscribe(state => Console.WriteLine(state.AdsState));

using var generator = new CodeGenerator(Console.Error.WriteLine);
var roots = generator.LoadSymbols("5.35.59.10.1.1", 851);
var root = roots.FirstOrDefault();
if (root is not null)
{
    var source = generator.CreateCSharpCodeString(root, isTwinCat3: true, "LineA.Generated");
    bool emitted = CSharpLanguage.CreateAssembly(source, "LineA.Generated.dll");
    Console.WriteLine($"Generated: {emitted}");
}

var generatedFiles = new DirectoryInfo(".").GetFilesWhere("*.cs", file => file.Length > 0);

Two combined production workflows

Workflow 1 - typed live dashboard with a commanded setpoint. Build Settings with notifications and write handles, subscribe to ErrorReceived, InitializeComplete, a typed Observe<float> stream and OnWrite, then Connect. Render only values from the stream; correlate a one-shot confirmation read with an id after the user requests a setpoint. Call Pause before the write if the UI must visibly rate-limit it; rely on a PLC acknowledgement tag, not the local pause, before declaring the change complete. Dispose streams then client on shutdown.

using var live = new RxTcAdsClient();
var dashboard = new Settings { AdsAddress = "5.35.59.10.1.1", Port = 851, SettingsId = "Dashboard" };
dashboard.AddNotification(".Main.ActualSpeed", 200);
dashboard.AddWriteVariable(".Main.RequestedSpeed");
using var errors = live.ErrorReceived.Subscribe(ex => ReportAdsFailure(ex));
using var values = live.Observe<float>(".Main.ActualSpeed", Convert.ToSingle)
    .Subscribe(speed => RenderSpeed(speed));
using var confirm = live.DataReceived.Where(x => x.Id == "speed-confirm").Take(1)
    .Subscribe(x => ConfirmSpeed(Convert.ToSingle(x.Data)));
live.Connect(dashboard);

if (await OperatorInterlockAllowsAsync())
{
    live.Pause(TimeSpan.FromMilliseconds(100));
    live.Write(".Main.RequestedSpeed", 900f, "speed-command");
    live.Read(".Main.ActualSpeed", "speed-confirm");
}
live.Disconnect();

Workflow 2 - commissioning and regression test. Define logical tags in CSV, import them into a TwinCatLogicalTagClient over InMemoryAdsClient, register the corresponding fake symbols, run ReadManyAsync/WriteManyAsync, inject a queued InMemoryAdsException to test error handling, then point the unchanged logical-tag configuration at RxTcAdsClient in an isolated TwinCAT environment. For stable application schemas, replace runtime structure reflection with the generator attributes and test the generated connection class against InMemoryAdsClient.

using var test = new InMemoryAdsClient();
test.RegisterSymbol(".Main.ActualSpeed", (short)500);
test.RegisterSymbol(".Main.RequestedSpeed", (short)0);
var configuration = new Settings { SettingsId = "commissioning", Port = 851 };
configuration.AddNotification(".Main.ActualSpeed");
configuration.AddWriteVariable(".Main.RequestedSpeed");
test.Connect(configuration);
using var observed = test.Observe<short>(".Main.ActualSpeed", Convert.ToInt16)
    .Subscribe(value => Console.WriteLine($"Observed {value}"));
test.ReadMany(new[] { ".Main.ActualSpeed", ".Main.RequestedSpeed" }, "baseline");
test.WriteMany(new[] { new KeyValuePair<string, object>(".Main.RequestedSpeed", (short)700) }, "setpoint");
test.QueueFault(InMemoryAdsOperation.Write, new InMemoryAdsException("Expected commissioning failure"));
using var fault = test.ErrorReceived.Take(1).Subscribe(ex => AssertExpectedFailure(ex));
test.Write(".Main.RequestedSpeed", (short)701, "expected-fault");
test.PublishNotifications();
test.Disconnect();

Correlated reads and async streams

using var client = new InMemoryAdsClient();
client.RegisterSymbol(".AInt", (short)5);
client.Connect(new Settings { Port = 851, SettingsId = "Test" });

using var result = client.Observe<short>(".AInt", "request-7", value => Convert.ToInt16(value))
    .Subscribe(value => Console.WriteLine(value));
client.Read(".AInt", "request-7");

var asyncData = client.DataReceivedAsync;

IRxTcAdsClient has async-native forms for initialization, data, errors, writes, and pause state. TwinCatRxExtensions.ObserveAsyncObservable<T> converts either typed observation overload to IObservableAsync<T>.

Structures and paced writes

var structure = client.CreateStruct(".Machine");
if (structure is not null)
{
    using var ready = structure.StructureReady().Subscribe(_ => Console.WriteLine("Structure ready"));
    bool written = structure.WriteValues(table => table.Value("Enabled", true));
    bool paced = await structure.WriteValuesAsync(
        table => table.Value("Enabled", false), TimeSpan.FromMilliseconds(200));
}

CreateStruct listens for the named variable and maps its received structure into HashTableRx. WriteValues and WriteValuesAsync clone before applying edits; the async variant coordinates the client's pause window. These helpers may use reflection for structures, so heed their trimming annotations.

Test without an ADS runtime

using var testClient = new InMemoryAdsClient();
testClient.RegisterSymbol(".Counter", 0);
testClient.Connect(new Settings { Port = 851, SettingsId = "Test" });
testClient.Write(".Counter", 1);
testClient.Read(".Counter");

InMemoryAdsClient also supports symbol removal/updates, publication, queued operation faults, operation metrics, reconnect, and bulk read/write helpers for deterministic tests.

Complete public API reference

The following is the public surface by member family. Overloads with id add correlation; overloads with arrayLength provide a required ADS size; ...Async observable properties use the ReactiveUI.Primitives async-observable contract, rather than converting an ADS call into Task.

Area	Types and complete member families	Purpose, result, and lifetime
ADS contract	`IRxTcAdsClient`: `Code`, `InitializeComplete`/`InitializeCompleteAsync`, `DataReceived`/`DataReceivedAsync`, `ErrorReceived`/`ErrorReceivedAsync`, `OnWrite`/`OnWriteAsync`, `ReadWriteHandleInfo`, `WriteHandleInfo`, `Settings`, `IsPaused`, `IsPausedObservable`/`IsPausedObservableAsync`, `IsDisposed`; `Connect`, `Disconnect`, `Pause`, `Read(variable)`, `Read(variable,id)`, `Read(variable,arrayLength)`, `Read(variable,arrayLength,id)`, `Write(variable,value)`, `Write(variable,value,id)`, `Dispose`.	This is the operational API. Stream subscriptions are individually disposable; client disposal releases handles and completes the owned infrastructure.
Production client	`RxTcAdsClient` constructors (default and `TimeProvider`) plus the complete `IRxTcAdsClient` contract.	`RxTcAdsClient` is the normal implementation. Platform/runtime adapters are intentionally internal composition details.
Standard and async observables	Main `TwinCatRxExtensions`: `Observe<T>` (variable/converter and variable/id/converter), `ObserveAsyncObservable<T>` matching both overloads, `CreateStruct`, `StructureReady`, `CreateClone`, `WriteValues`, `WriteValuesAsync`. `ObservableBridgeExtensions.ToAsyncObservable` and all public `SubscribeTo` overloads.	`Observe*` returns a stream that must be disposed. Structure helpers clone before modifying. Bridge methods adapt subscriptions; prefer their extensions to direct adapter construction.
In-memory test ADS	`InMemoryAdsClient` constructors and full `IRxTcAdsClient` surface, plus `ConnectionState`, `ConnectionStates`, `OperationMetrics`, `Symbols`, `Reconnect`, `PublishNotifications`, `QueueFault`, `ReadMany`, `WriteMany`, `RegisterSymbol` overloads, `RegisterStructure<T>` overloads, `RemoveSymbol`, `SetValue`, `TryGetValue<T>`, `ResetOperationMetrics`. `InMemoryAdsSymbol`, `InMemoryAdsOperation`, `InMemoryAdsOperationMetrics`, `InMemoryAdsException`, `InMemoryAdsConnectionState`.	Use only for deterministic tests/simulators. Calls are synchronous but publish the same events as the production contract; queue a fault before the operation whose failure path is being tested.
Logical tags	`TwinCatLogicalTagClient` constructors for native client, catalog/store and optional `TimeProvider`; `Catalog`, `CreateTag` overloads, `RegisterTag`, `RemoveTag`, `ReadAsync`, `ReadManyAsync`, `WriteAsync`, `WriteManyAsync`, `Observe`, `ObserveMany`, `ObserveAsync`, `ObserveManyAsync`, `Dispose`. Persistence: `ImportCsvAsync` overloads, `ExportCsvAsync` overloads, `InitializeStoreAsync`, `LoadTagsAsync` overloads, `GetTagAsync`, `ListTagsAsync`, `UpsertTagAsync`, `EditTagAsync`, `DeleteTagAsync`, `GetGroupAsync`, `ListGroupsAsync`, `UpsertGroupAsync`, `DeleteGroupAsync`.	Read/write methods return logical-tag operation results; observation returns normal or async streams. Store methods use cancellation-bearing I/O overloads and are not a substitute for validating PLC mappings.
Service monitoring	`IObservableServiceController`, `ObservableServiceController` constructors accepting `ServiceController` and interval, `IsDisposed`, `CanStop`, `DisplayName`, `ServiceName`, `Status`, `StatusObserver`, static `GetServices`, `Restart`, `Start`, `Stop`, `Dispose`, and `ServiceStatus`.	Windows-only operational integration. `StatusObserver` must be disposed with the controller; start/stop/restart can alter host services and require authorization.
Core configuration	`ISettings`/`Settings` (`AdsAddress`, `Port`, `Notifications`, `WriteVariables`, `SettingsId`); `INotification`/`Notification` (`Variable`, `UpdateRate`, `ArraySize`); `IWriteVariable`/`WriteVariable` (`Variable`, `ArraySize`). Core `TwinCatRxExtensions.AddNotification` three overloads and `AddWriteVariable` two overloads.	These values are consumed during `Connect`. Make a fresh settings instance for a different endpoint or shape rather than mutate a live connected configuration.
Core retry, state and loading	Core `TwinCatRxExtensions.AdsStateChangedObserver`, `AdsStateObserver`, all `OnErrorRetry` overloads (basic; typed error callback; callback plus delay; callback plus retry count; callback plus retry count/delay/sequencer), `AssemblyLoad`, `GetType`.	State observers are streams. Retry extension overloads return a new sequence; use a finite count/delay/callback for production recovery and observe terminal errors.
Dynamic code generation	`ICodeGenerator`, `CodeGenerator` constructors/properties, static `CodeGenerator.PLCToCSharpTypeConverter`, `CreateCSharpCode` overloads, `CreateCSharpCodeString` overloads, `CreateDll` overloads, `LoadSymbols` overloads, `ReadSymbol`, `SearchSymbols`, and `Dispose`; `ILanguageService`/`CSharpLanguage` (`CreateAssembly`, `ParseText`, `CreateLibraryCompilation`); `INodeEmulator`; `DirectoryInfoExtensions.GetFilesWhere` overloads; `SimpleTypeException`, `UnsuportedTypeException`.	Advanced reflection/dynamic-compilation integration. Generated DLL/source file operations return success flags and can throw IO/compiler errors; guard them and validate trim/AOT deployment.
Structures	`CreateStruct` returns the public `HashTableRx` abstraction from its extension API.	It materializes ADS structure values; dispose the returned table to release its source subscription.
Analyzer	`TwinCatReactiveStreamGenerator`.	The standalone `IoT-Driver.TwinCATRx.Generators` package emits the compile-time schema attributes `TwinCatReactiveStreamAttribute`, `TwinCatPlcConnectionAttribute`, `DirectNotificationAttribute`, `StructuredNotificationAttribute`, and `WriteOnlyAttribute` into the consuming compilation; they are not public runtime package types.

Operational guidance

Register notifications before connecting, retain subscriptions for the whole operational session, and treat ErrorReceived and OnWrite as first-class telemetry. Use correlation identifiers for concurrent reads. Avoid high-rate notifications unless the PLC, ADS route, and consumer can keep up. Dispose structures and clients; do not silently recover from a safety-relevant write failure.

Troubleshooting

Connect fails: verify TwinCAT is in Run mode, the ADS route/address and port are correct, and the host can reach ADS.
No value arrives: register a notification before Connect, wait for InitializeComplete, then check the exact variable spelling and route.
Strings/arrays are truncated or fail: provide the required positive array/string length during registration or read.
Structure code fails under trimming/AOT: preserve required members or use source-generated application stream wiring; validate the published artifact.
Write cadence is wrong: use Pause/WriteValuesAsync deliberately and observe IsPausedObservable rather than adding uncoordinated delays.

AI skill

Use the packaged twincat-rx skill for concise source-grounded workflow guidance and use this README as the detailed reference.

MIT licensed. See the repository LICENSE.

Exhaustive public API reference

This catalogue is generated from the packaged runtime assemblies and their XML documentation. It includes exported public types and their declared public members; inherited members and non-public implementation details are intentionally omitted.

`TwinCATRx`

Exported public types: 14; declared public members: 220.

`T:IoT.Driver.TwinCATRx.IObservableServiceController`

public interface IoT.Driver.TwinCATRx.IObservableServiceController

Interface for Observable Service Controller.

Declared public members

`M:IoT.Driver.TwinCATRx.IObservableServiceController.Restart`

public void Restart()

Restarts this instance.

`M:IoT.Driver.TwinCATRx.IObservableServiceController.Start`

public void Start()

Starts this instance.

`M:IoT.Driver.TwinCATRx.IObservableServiceController.Stop`

public void Stop()

Stops this instance.

`P:IoT.Driver.TwinCATRx.IObservableServiceController.CanStop`

public bool CanStop { get; }

Gets a value indicating whether this instance can stop.

Value: true if this instance can stop; otherwise, false .

`P:IoT.Driver.TwinCATRx.IObservableServiceController.DisplayName`

public string DisplayName { get; }

Gets the display name.

Value: The display name.

`P:IoT.Driver.TwinCATRx.IObservableServiceController.ServiceName`

public string ServiceName { get; }

Gets the name of the service.

Value: The name of the service.

`P:IoT.Driver.TwinCATRx.IObservableServiceController.Status`

public System.ServiceProcess.ServiceControllerStatus Status { get; }

Gets the status.

Value: The status.

`P:IoT.Driver.TwinCATRx.IObservableServiceController.StatusObserver`

public System.IObservable<System.ServiceProcess.ServiceControllerStatus> StatusObserver { get; }

Gets the status observer.

Value: The status observer.

`T:IoT.Driver.TwinCATRx.IRxTcAdsClient`

public interface IoT.Driver.TwinCATRx.IRxTcAdsClient

Interface for Rx Tc Ads Client.

Declared public members

`M:IoT.Driver.TwinCATRx.IRxTcAdsClient.Connect(IoT.Driver.TwinCATRx.Core.ISettings)`

public void Connect(IoT.Driver.TwinCATRx.Core.ISettings settings)

Connects the specified settings.

Parameter settings: The settings.

`M:IoT.Driver.TwinCATRx.IRxTcAdsClient.Disconnect`

public void Disconnect()

Disconnects this instance.

`M:IoT.Driver.TwinCATRx.IRxTcAdsClient.Pause(System.TimeSpan)`

public void Pause(System.TimeSpan time)

Pauses the specified time.

Parameter time: The time.

`M:IoT.Driver.TwinCATRx.IRxTcAdsClient.Read(System.String)`

public void Read(string variable)

Reads the specified data.

Parameter variable: The data.

`M:IoT.Driver.TwinCATRx.IRxTcAdsClient.Read(System.String,System.Nullable`1{System.Int32})`

public void Read(string variable, System.Nullable<int> arrayLength)

Executes the Read operation.

Parameter variable: The variable value.
Parameter arrayLength: The arrayLength value.

`M:IoT.Driver.TwinCATRx.IRxTcAdsClient.Read(System.String,System.Nullable`1{System.Int32},System.String)`

public void Read(string variable, System.Nullable<int> arrayLength, string id)

Executes the Read operation.

Parameter variable: The variable value.
Parameter arrayLength: The arrayLength value.
Parameter id: The id value.

`M:IoT.Driver.TwinCATRx.IRxTcAdsClient.Read(System.String,System.String)`

public void Read(string variable, string id)

Reads the specified data with a correlation identifier.

Parameter variable: The data.
Parameter id: The identifier.

`M:IoT.Driver.TwinCATRx.IRxTcAdsClient.Write(System.String,System.Object)`

public void Write(string variable, object value)

Writes the specified value.

Parameter variable: The variable.
Parameter value: The value.

`M:IoT.Driver.TwinCATRx.IRxTcAdsClient.Write(System.String,System.Object,System.String)`

public void Write(string variable, object value, string id)

Writes the specified value with a correlation identifier.

Parameter variable: The variable.
Parameter value: The value.
Parameter id: The identifier.

`P:IoT.Driver.TwinCATRx.IRxTcAdsClient.Code`

public System.IObservable<string[]> Code { get; }

Gets the code.

Value: The code.

`P:IoT.Driver.TwinCATRx.IRxTcAdsClient.DataReceived`

public System.IObservable<System.ValueTuple<string, object, string>> DataReceived { get; }

Gets the data received.

Value: The data received.

`P:IoT.Driver.TwinCATRx.IRxTcAdsClient.DataReceivedAsync`

public ReactiveUI.Primitives.Async.IObservableAsync<System.ValueTuple<string, object, string>> DataReceivedAsync { get; }

Gets the async data received stream.

Value: The DataReceivedAsync value.

`P:IoT.Driver.TwinCATRx.IRxTcAdsClient.ErrorReceived`

public System.IObservable<System.Exception> ErrorReceived { get; }

Gets the error received.

Value: The error received.

`P:IoT.Driver.TwinCATRx.IRxTcAdsClient.ErrorReceivedAsync`

public ReactiveUI.Primitives.Async.IObservableAsync<System.Exception> ErrorReceivedAsync { get; }

Gets the async error received stream.

Value: The ErrorReceivedAsync value.

`P:IoT.Driver.TwinCATRx.IRxTcAdsClient.InitializeComplete`

public System.IObservable<ReactiveUI.Primitives.RxVoid> InitializeComplete { get; }

Gets the initialize complete. PLC is ready to read and write.

Value: The initialize complete.

`P:IoT.Driver.TwinCATRx.IRxTcAdsClient.InitializeCompleteAsync`

public ReactiveUI.Primitives.Async.IObservableAsync<ReactiveUI.Primitives.RxVoid> InitializeCompleteAsync { get; }

Gets the async initialize complete stream.

Value: The InitializeCompleteAsync value.

`P:IoT.Driver.TwinCATRx.IRxTcAdsClient.IsDisposed`

public bool IsDisposed { get; }

Gets a value indicating whether the instance is disposed.

Value: The IsDisposed value.

`P:IoT.Driver.TwinCATRx.IRxTcAdsClient.IsPaused`

public bool IsPaused { get; }

Gets a value indicating whether this instance is paused within WriteValuesAsync.

Value: true if this instance is paused; otherwise, false .

`P:IoT.Driver.TwinCATRx.IRxTcAdsClient.IsPausedObservable`

public System.IObservable<bool> IsPausedObservable { get; }

Gets the is paused observable.

Value: The is paused observable.

`P:IoT.Driver.TwinCATRx.IRxTcAdsClient.IsPausedObservableAsync`

public ReactiveUI.Primitives.Async.IObservableAsync<bool> IsPausedObservableAsync { get; }

Gets the async paused state stream.

Value: The IsPausedObservableAsync value.

`P:IoT.Driver.TwinCATRx.IRxTcAdsClient.OnWrite`

public System.IObservable<string> OnWrite { get; }

Gets the on write.

Value: The on write.

`P:IoT.Driver.TwinCATRx.IRxTcAdsClient.OnWriteAsync`

public ReactiveUI.Primitives.Async.IObservableAsync<string> OnWriteAsync { get; }

Gets the async write result stream.

Value: The OnWriteAsync value.

`P:IoT.Driver.TwinCATRx.IRxTcAdsClient.ReadWriteHandleInfo`

public System.Collections.Generic.IDictionary<string, System.Nullable<uint>> ReadWriteHandleInfo { get; }

Gets the read write handle information.

Value: The read write handle information.

`P:IoT.Driver.TwinCATRx.IRxTcAdsClient.Settings`

public IoT.Driver.TwinCATRx.Core.ISettings Settings { get; }

Gets the settings.

Value: The settings.

`P:IoT.Driver.TwinCATRx.IRxTcAdsClient.WriteHandleInfo`

public System.Collections.Generic.IDictionary<string, System.ValueTuple<System.Nullable<uint>, int>> WriteHandleInfo { get; }

Gets the write handle information.

Value: The write handle information.

`T:IoT.Driver.TwinCATRx.InMemoryAdsClient`

public class IoT.Driver.TwinCATRx.InMemoryAdsClient

Provides a deterministic, production-usable ADS simulator for applications that need to run without a TwinCAT runtime or physical PLC.

Declared public members

`M:IoT.Driver.TwinCATRx.InMemoryAdsClient.#ctor`

public IoT.Driver.TwinCATRx.InMemoryAdsClient()

Initializes a new instance of the T:IoT.Driver.TwinCATRx.InMemoryAdsClient class.

`M:IoT.Driver.TwinCATRx.InMemoryAdsClient.Connect(IoT.Driver.TwinCATRx.Core.ISettings)`

public void Connect(IoT.Driver.TwinCATRx.Core.ISettings settings)

Inherits XML documentation from its implemented or overridden member.

Parameter settings: The settings value.

`M:IoT.Driver.TwinCATRx.InMemoryAdsClient.Disconnect`

public void Disconnect()

Inherits XML documentation from its implemented or overridden member.

`M:IoT.Driver.TwinCATRx.InMemoryAdsClient.Dispose`

public void Dispose()

Inherits XML documentation from its implemented or overridden member.

`M:IoT.Driver.TwinCATRx.InMemoryAdsClient.Pause(System.TimeSpan)`

public void Pause(System.TimeSpan time)

Inherits XML documentation from its implemented or overridden member.

Parameter time: The time value.

`M:IoT.Driver.TwinCATRx.InMemoryAdsClient.PublishNotifications`

public void PublishNotifications()

Publishes every configured notification using the latest in-memory symbol values.

`M:IoT.Driver.TwinCATRx.InMemoryAdsClient.QueueFault(IoT.Driver.TwinCATRx.InMemoryAdsOperation,System.Exception)`

public IoT.Driver.TwinCATRx.InMemoryAdsClient QueueFault(IoT.Driver.TwinCATRx.InMemoryAdsOperation operation, System.Exception error)

Queues a failure for the next matching operation.

Parameter operation: The operation that will consume the failure.
Parameter error: The error to publish.
Returns: This simulator for fluent setup.

`M:IoT.Driver.TwinCATRx.InMemoryAdsClient.Read(System.String)`

public void Read(string variable)

Inherits XML documentation from its implemented or overridden member.

Parameter variable: The variable value.

`M:IoT.Driver.TwinCATRx.InMemoryAdsClient.Read(System.String,System.Nullable`1{System.Int32})`

public void Read(string variable, System.Nullable<int> arrayLength)

Executes the Read operation.

Parameter variable: The variable value.
Parameter arrayLength: The arrayLength value.

`M:IoT.Driver.TwinCATRx.InMemoryAdsClient.Read(System.String,System.Nullable`1{System.Int32},System.String)`

public void Read(string variable, System.Nullable<int> arrayLength, string id)

Executes the Read operation.

Parameter variable: The variable value.
Parameter arrayLength: The arrayLength value.
Parameter id: The id value.

`M:IoT.Driver.TwinCATRx.InMemoryAdsClient.Read(System.String,System.String)`

public void Read(string variable, string id)

Inherits XML documentation from its implemented or overridden member.

Parameter variable: The variable value.
Parameter id: The id value.

`M:IoT.Driver.TwinCATRx.InMemoryAdsClient.ReadMany(System.Collections.Generic.IEnumerable`1{System.String})`

public void ReadMany(System.Collections.Generic.IEnumerable<string> variables)

Executes the ReadMany operation.

Parameter variables: The variables value.

`M:IoT.Driver.TwinCATRx.InMemoryAdsClient.ReadMany(System.Collections.Generic.IEnumerable`1{System.String},System.String)`

public void ReadMany(System.Collections.Generic.IEnumerable<string> variables, string correlationPrefix)

Executes the ReadMany operation.

Parameter variables: The variables value.
Parameter correlationPrefix: The correlationPrefix value.

`M:IoT.Driver.TwinCATRx.InMemoryAdsClient.Reconnect`

public void Reconnect()

Reconnects with the latest settings while preserving registered symbols and queued faults.

M:IoT.Driver.TwinCATRx.InMemoryAdsClient.RegisterStructure``1(System.String,``0)

public IoT.Driver.TwinCATRx.InMemoryAdsClient RegisterStructure<T>(string name, T value)

Registers or replaces an in-memory structure symbol.

Parameter name: The root symbol name.
Parameter value: The structure value.
Returns: This simulator for fluent setup.

M:IoT.Driver.TwinCATRx.InMemoryAdsClient.RegisterStructure``1(System.String,``0,System.Boolean,System.Boolean)

public IoT.Driver.TwinCATRx.InMemoryAdsClient RegisterStructure<T>(string name, T value, bool isReadable, bool isWritable)

Registers or replaces an in-memory structure symbol with full access metadata.

Parameter name: The root symbol name.
Parameter value: The structure value.
Parameter isReadable: Whether reads are permitted.
Parameter isWritable: Whether writes are permitted.
Returns: This simulator for fluent setup.

`M:IoT.Driver.TwinCATRx.InMemoryAdsClient.RegisterSymbol(System.String,System.Object)`

public IoT.Driver.TwinCATRx.InMemoryAdsClient RegisterSymbol(string name, object value)

Registers or replaces an in-memory ADS symbol.

Parameter name: The symbol name.
Parameter value: The initial value.
Returns: This simulator for fluent setup.

`M:IoT.Driver.TwinCATRx.InMemoryAdsClient.RegisterSymbol(System.String,System.Object,System.Type)`

public IoT.Driver.TwinCATRx.InMemoryAdsClient RegisterSymbol(string name, object value, System.Type dataType)

Registers or replaces an in-memory ADS symbol with an explicit declared type.

Parameter name: The symbol name.
Parameter value: The initial value.
Parameter dataType: The declared type.
Returns: This simulator for fluent setup.

`M:IoT.Driver.TwinCATRx.InMemoryAdsClient.RegisterSymbol(System.String,System.Object,System.Type,System.Int32,System.Boolean,System.Boolean)`

public IoT.Driver.TwinCATRx.InMemoryAdsClient RegisterSymbol(string name, object value, System.Type dataType, int arrayLength, bool isReadable, bool isWritable)

Registers or replaces an in-memory ADS symbol with full access metadata.

Parameter name: The symbol name.
Parameter value: The initial value.
Parameter dataType: The declared type.
Parameter arrayLength: The array or string length, or -1 for a scalar.
Parameter isReadable: Whether reads are permitted.
Parameter isWritable: Whether writes are permitted.
Returns: This simulator for fluent setup.

`M:IoT.Driver.TwinCATRx.InMemoryAdsClient.RemoveSymbol(System.String)`

public bool RemoveSymbol(string name)

Removes a registered symbol and any configured handles for it.

Parameter name: The symbol name.
Returns: Whether a symbol was removed.

`M:IoT.Driver.TwinCATRx.InMemoryAdsClient.ResetOperationMetrics`

public void ResetOperationMetrics()

Resets deterministic native ADS operation counts without changing simulator state.

`M:IoT.Driver.TwinCATRx.InMemoryAdsClient.SetValue(System.String,System.Object)`

public void SetValue(string variable, object value)

Updates a symbol as if its value changed in the simulated PLC.

Parameter variable: The variable to update.
Parameter value: The new value.

M:IoT.Driver.TwinCATRx.InMemoryAdsClient.TryGetValue``1(System.String,``0@)

public bool TryGetValue<T>(string variable, out T value)

Tries to retrieve and convert a registered symbol value.

Parameter variable: The symbol name.
Parameter value: The converted value when successful.
Returns: Whether the symbol exists and its value is compatible.

`M:IoT.Driver.TwinCATRx.InMemoryAdsClient.Write(System.String,System.Object)`

public void Write(string variable, object value)

Inherits XML documentation from its implemented or overridden member.

Parameter variable: The variable value.
Parameter value: The value value.

`M:IoT.Driver.TwinCATRx.InMemoryAdsClient.Write(System.String,System.Object,System.String)`

public void Write(string variable, object value, string id)

Inherits XML documentation from its implemented or overridden member.

Parameter variable: The variable value.
Parameter value: The value value.
Parameter id: The id value.

`M:IoT.Driver.TwinCATRx.InMemoryAdsClient.WriteMany(System.Collections.Generic.IEnumerable`1{System.Collections.Generic.KeyValuePair`2{System.String,System.Object}})`

public void WriteMany(System.Collections.Generic.IEnumerable<System.Collections.Generic.KeyValuePair<string, object>> values)

Executes the WriteMany operation.

Parameter values: The values value.

`M:IoT.Driver.TwinCATRx.InMemoryAdsClient.WriteMany(System.Collections.Generic.IEnumerable`1{System.Collections.Generic.KeyValuePair`2{System.String,System.Object}},System.String)`

public void WriteMany(System.Collections.Generic.IEnumerable<System.Collections.Generic.KeyValuePair<string, object>> values, string correlationPrefix)

Executes the WriteMany operation.

Parameter values: The values value.
Parameter correlationPrefix: The correlationPrefix value.

`P:IoT.Driver.TwinCATRx.InMemoryAdsClient.Code`

public System.IObservable<string[]> Code { get; }

Inherits XML documentation from its implemented or overridden member.

Value: The Code value.

`P:IoT.Driver.TwinCATRx.InMemoryAdsClient.Connected`

public bool Connected { get; }

Gets a value indicating whether the simulator is connected.

Value: The Connected value.

`P:IoT.Driver.TwinCATRx.InMemoryAdsClient.ConnectionState`

public IoT.Driver.TwinCATRx.InMemoryAdsConnectionState ConnectionState { get; }

Gets the current simulator connection state.

Value: The ConnectionState value.

`P:IoT.Driver.TwinCATRx.InMemoryAdsClient.ConnectionStates`

public System.IObservable<IoT.Driver.TwinCATRx.InMemoryAdsConnectionState> ConnectionStates { get; }

Gets the observable connection state stream.

Value: The ConnectionStates value.

`P:IoT.Driver.TwinCATRx.InMemoryAdsClient.DataReceived`

public System.IObservable<System.ValueTuple<string, object, string>> DataReceived { get; }

Inherits XML documentation from its implemented or overridden member.

Value: The DataReceived value.

`P:IoT.Driver.TwinCATRx.InMemoryAdsClient.DataReceivedAsync`

public ReactiveUI.Primitives.Async.IObservableAsync<System.ValueTuple<string, object, string>> DataReceivedAsync { get; }

Inherits XML documentation from its implemented or overridden member.

Value: The DataReceivedAsync value.

`P:IoT.Driver.TwinCATRx.InMemoryAdsClient.ErrorReceived`

public System.IObservable<System.Exception> ErrorReceived { get; }

Inherits XML documentation from its implemented or overridden member.

Value: The ErrorReceived value.

`P:IoT.Driver.TwinCATRx.InMemoryAdsClient.ErrorReceivedAsync`

public ReactiveUI.Primitives.Async.IObservableAsync<System.Exception> ErrorReceivedAsync { get; }

Inherits XML documentation from its implemented or overridden member.

Value: The ErrorReceivedAsync value.

`P:IoT.Driver.TwinCATRx.InMemoryAdsClient.InitializeComplete`

public System.IObservable<ReactiveUI.Primitives.RxVoid> InitializeComplete { get; }

Inherits XML documentation from its implemented or overridden member.

Value: The InitializeComplete value.

`P:IoT.Driver.TwinCATRx.InMemoryAdsClient.InitializeCompleteAsync`

public ReactiveUI.Primitives.Async.IObservableAsync<ReactiveUI.Primitives.RxVoid> InitializeCompleteAsync { get; }

Inherits XML documentation from its implemented or overridden member.

Value: The InitializeCompleteAsync value.

`P:IoT.Driver.TwinCATRx.InMemoryAdsClient.IsDisposed`

public bool IsDisposed { get; }

Inherits XML documentation from its implemented or overridden member.

Value: The IsDisposed value.

`P:IoT.Driver.TwinCATRx.InMemoryAdsClient.IsPaused`

public bool IsPaused { get; }

Inherits XML documentation from its implemented or overridden member.

Value: The IsPaused value.

`P:IoT.Driver.TwinCATRx.InMemoryAdsClient.IsPausedObservable`

public System.IObservable<bool> IsPausedObservable { get; }

Inherits XML documentation from its implemented or overridden member.

Value: The IsPausedObservable value.

`P:IoT.Driver.TwinCATRx.InMemoryAdsClient.IsPausedObservableAsync`

public ReactiveUI.Primitives.Async.IObservableAsync<bool> IsPausedObservableAsync { get; }

Inherits XML documentation from its implemented or overridden member.

Value: The IsPausedObservableAsync value.

`P:IoT.Driver.TwinCATRx.InMemoryAdsClient.OnWrite`

public System.IObservable<string> OnWrite { get; }

Inherits XML documentation from its implemented or overridden member.

Value: The OnWrite value.

`P:IoT.Driver.TwinCATRx.InMemoryAdsClient.OnWriteAsync`

public ReactiveUI.Primitives.Async.IObservableAsync<string> OnWriteAsync { get; }

Inherits XML documentation from its implemented or overridden member.

Value: The OnWriteAsync value.

`P:IoT.Driver.TwinCATRx.InMemoryAdsClient.OperationMetrics`

public IoT.Driver.TwinCATRx.InMemoryAdsOperationMetrics OperationMetrics { get; }

Gets a deterministic snapshot of native ADS operation counts.

Value: The OperationMetrics value.

`P:IoT.Driver.TwinCATRx.InMemoryAdsClient.ReadWriteHandleInfo`

public System.Collections.Generic.IDictionary<string, System.Nullable<uint>> ReadWriteHandleInfo { get; }

Inherits XML documentation from its implemented or overridden member.

Value: The ReadWriteHandleInfo value.

`P:IoT.Driver.TwinCATRx.InMemoryAdsClient.Settings`

public IoT.Driver.TwinCATRx.Core.ISettings Settings { get; }

Inherits XML documentation from its implemented or overridden member.

Value: The Settings value.

`P:IoT.Driver.TwinCATRx.InMemoryAdsClient.Symbols`

public System.Collections.Generic.IReadOnlyCollection<IoT.Driver.TwinCATRx.InMemoryAdsSymbol> Symbols { get; }

Gets a snapshot of all registered symbols.

Value: The Symbols value.

`P:IoT.Driver.TwinCATRx.InMemoryAdsClient.WriteHandleInfo`

public System.Collections.Generic.IDictionary<string, System.ValueTuple<System.Nullable<uint>, int>> WriteHandleInfo { get; }

Inherits XML documentation from its implemented or overridden member.

Value: The WriteHandleInfo value.

`T:IoT.Driver.TwinCATRx.InMemoryAdsConnectionState`

public enum IoT.Driver.TwinCATRx.InMemoryAdsConnectionState

Describes the lifecycle state of an T:IoT.Driver.TwinCATRx.InMemoryAdsClient .

Declared public members

`F:IoT.Driver.TwinCATRx.InMemoryAdsConnectionState.Connected`

public static const IoT.Driver.TwinCATRx.InMemoryAdsConnectionState Connected

The simulator is ready to service reads, writes, and notifications.

`F:IoT.Driver.TwinCATRx.InMemoryAdsConnectionState.Connecting`

public static const IoT.Driver.TwinCATRx.InMemoryAdsConnectionState Connecting

The simulator is validating settings and creating handles.

`F:IoT.Driver.TwinCATRx.InMemoryAdsConnectionState.Disconnected`

public static const IoT.Driver.TwinCATRx.InMemoryAdsConnectionState Disconnected

The simulator is disconnected and can be connected.

`F:IoT.Driver.TwinCATRx.InMemoryAdsConnectionState.Disposed`

public static const IoT.Driver.TwinCATRx.InMemoryAdsConnectionState Disposed

The simulator and its observable streams have been disposed.

`F:IoT.Driver.TwinCATRx.InMemoryAdsConnectionState.Faulted`

public static const IoT.Driver.TwinCATRx.InMemoryAdsConnectionState Faulted

The latest connection attempt or simulated operation failed.

`T:IoT.Driver.TwinCATRx.InMemoryAdsException`

public class IoT.Driver.TwinCATRx.InMemoryAdsException

Represents a deterministic in-memory ADS operation failure.

Declared public members

`M:IoT.Driver.TwinCATRx.InMemoryAdsException.#ctor`

public IoT.Driver.TwinCATRx.InMemoryAdsException()

Initializes a new instance of the T:IoT.Driver.TwinCATRx.InMemoryAdsException class.

`M:IoT.Driver.TwinCATRx.InMemoryAdsException.#ctor(IoT.Driver.TwinCATRx.InMemoryAdsOperation,System.String)`

public IoT.Driver.TwinCATRx.InMemoryAdsException(IoT.Driver.TwinCATRx.InMemoryAdsOperation operation, string message)

Initializes a new instance of the T:IoT.Driver.TwinCATRx.InMemoryAdsException class.

Parameter operation: The failed operation.
Parameter message: The failure message.

`M:IoT.Driver.TwinCATRx.InMemoryAdsException.#ctor(IoT.Driver.TwinCATRx.InMemoryAdsOperation,System.String,System.String)`

public IoT.Driver.TwinCATRx.InMemoryAdsException(IoT.Driver.TwinCATRx.InMemoryAdsOperation operation, string message, string variable)

Initializes a new instance of the T:IoT.Driver.TwinCATRx.InMemoryAdsException class.

Parameter operation: The failed operation.
Parameter message: The failure message.
Parameter variable: The optional ADS variable involved in the failure.

`M:IoT.Driver.TwinCATRx.InMemoryAdsException.#ctor(System.String)`

public IoT.Driver.TwinCATRx.InMemoryAdsException(string message)

Initializes a new instance of the T:IoT.Driver.TwinCATRx.InMemoryAdsException class.

Parameter message: The failure message.

`M:IoT.Driver.TwinCATRx.InMemoryAdsException.#ctor(System.String,System.Exception)`

public IoT.Driver.TwinCATRx.InMemoryAdsException(string message, System.Exception innerException)

Initializes a new instance of the T:IoT.Driver.TwinCATRx.InMemoryAdsException class.

Parameter message: The failure message.
Parameter innerException: The failure that caused this exception.

`P:IoT.Driver.TwinCATRx.InMemoryAdsException.Operation`

public IoT.Driver.TwinCATRx.InMemoryAdsOperation Operation { get; }

Gets the failed operation.

Value: The Operation value.

`P:IoT.Driver.TwinCATRx.InMemoryAdsException.Variable`

public string Variable { get; }

Gets the optional ADS variable involved in the failure.

Value: The Variable value.

`T:IoT.Driver.TwinCATRx.InMemoryAdsOperation`

public enum IoT.Driver.TwinCATRx.InMemoryAdsOperation

Identifies an operation that can receive a deterministic simulator fault.

Declared public members

`F:IoT.Driver.TwinCATRx.InMemoryAdsOperation.Connect`

public static const IoT.Driver.TwinCATRx.InMemoryAdsOperation Connect

A connection or reconnection operation.

`F:IoT.Driver.TwinCATRx.InMemoryAdsOperation.Notification`

public static const IoT.Driver.TwinCATRx.InMemoryAdsOperation Notification

A configured notification publication.

`F:IoT.Driver.TwinCATRx.InMemoryAdsOperation.Read`

public static const IoT.Driver.TwinCATRx.InMemoryAdsOperation Read

A symbol read operation.

`F:IoT.Driver.TwinCATRx.InMemoryAdsOperation.Write`

public static const IoT.Driver.TwinCATRx.InMemoryAdsOperation Write

A symbol write operation.

`T:IoT.Driver.TwinCATRx.InMemoryAdsOperationMetrics`

public class IoT.Driver.TwinCATRx.InMemoryAdsOperationMetrics

Provides a deterministic snapshot of native ADS operations issued to an in-memory client.

Declared public members

`M:IoT.Driver.TwinCATRx.InMemoryAdsOperationMetrics.#ctor(System.Int64,System.Int64,System.Int64)`

public IoT.Driver.TwinCATRx.InMemoryAdsOperationMetrics(long readOperations, long writeOperations, long notificationPublications)

Initializes a new instance of the T:IoT.Driver.TwinCATRx.InMemoryAdsOperationMetrics class.

Parameter readOperations: The number of native read attempts.
Parameter writeOperations: The number of native write attempts.
Parameter notificationPublications: The number of notification publication attempts.

`P:IoT.Driver.TwinCATRx.InMemoryAdsOperationMetrics.NotificationPublications`

public long NotificationPublications { get; }

Gets the number of notification publication attempts.

Value: The NotificationPublications value.

`P:IoT.Driver.TwinCATRx.InMemoryAdsOperationMetrics.ReadOperations`

public long ReadOperations { get; }

Gets the number of native read attempts.

Value: The ReadOperations value.

`P:IoT.Driver.TwinCATRx.InMemoryAdsOperationMetrics.WriteOperations`

public long WriteOperations { get; }

Gets the number of native write attempts.

Value: The WriteOperations value.

`T:IoT.Driver.TwinCATRx.InMemoryAdsSymbol`

public class IoT.Driver.TwinCATRx.InMemoryAdsSymbol

Describes one symbol hosted by an T:IoT.Driver.TwinCATRx.InMemoryAdsClient .

Declared public members

`M:IoT.Driver.TwinCATRx.InMemoryAdsSymbol.#ctor(System.String,System.Object,System.Type,System.Int32,System.Boolean,System.Boolean)`

public IoT.Driver.TwinCATRx.InMemoryAdsSymbol(string name, object value, System.Type dataType, int arrayLength, bool isReadable, bool isWritable)

Initializes a new instance of the T:IoT.Driver.TwinCATRx.InMemoryAdsSymbol class.

Parameter name: The case-insensitive ADS variable name.
Parameter value: The initial symbol value.
Parameter dataType: The declared value type.
Parameter arrayLength: The declared array or string length, or -1 for a scalar.
Parameter isReadable: Whether ADS reads are permitted.
Parameter isWritable: Whether ADS writes are permitted.

`P:IoT.Driver.TwinCATRx.InMemoryAdsSymbol.ArrayLength`

public int ArrayLength { get; }

Gets the declared array or string length, or -1 for a scalar.

Value: The ArrayLength value.

`P:IoT.Driver.TwinCATRx.InMemoryAdsSymbol.DataType`

public System.Type DataType { get; }

Gets the declared value type.

Value: The DataType value.

`P:IoT.Driver.TwinCATRx.InMemoryAdsSymbol.IsReadable`

public bool IsReadable { get; }

Gets a value indicating whether ADS reads are permitted.

Value: The IsReadable value.

`P:IoT.Driver.TwinCATRx.InMemoryAdsSymbol.IsWritable`

public bool IsWritable { get; }

Gets a value indicating whether ADS writes are permitted.

Value: The IsWritable value.

`P:IoT.Driver.TwinCATRx.InMemoryAdsSymbol.Name`

public string Name { get; }

Gets the case-insensitive ADS variable name.

Value: The Name value.

`P:IoT.Driver.TwinCATRx.InMemoryAdsSymbol.Value`

public object Value { get; }

Gets the current symbol value.

Value: The Value value.

`T:IoT.Driver.TwinCATRx.ObservableBridgeExtensions`

public class IoT.Driver.TwinCATRx.ObservableBridgeExtensions

Observable bridge helpers.

Declared public members

M:IoT.Driver.TwinCATRx.ObservableBridgeExtensions.SubscribeTo``1(System.IObservable1{``0})`

public static System.IDisposable SubscribeTo<T>(System.IObservable<T> source)

Executes the SubscribeTo operation.

Parameter source: The source value.
Returns: A System.IDisposable result.

M:IoT.Driver.TwinCATRx.ObservableBridgeExtensions.SubscribeTo``1(System.IObservable1{0},System.Action`1{0})`

public static System.IDisposable SubscribeTo<T>(System.IObservable<T> source, System.Action<T> onNext)

Executes the SubscribeTo operation.

Parameter source: The source value.
Parameter onNext: The onNext value.
Returns: A System.IDisposable result.

M:IoT.Driver.TwinCATRx.ObservableBridgeExtensions.SubscribeTo``1(System.IObservable1{0},System.Action`1{0},System.Action`1{System.Exception},System.Action)`

public static System.IDisposable SubscribeTo<T>(System.IObservable<T> source, System.Action<T> onNext, System.Action<System.Exception> onError, System.Action onCompleted)

Executes the SubscribeTo operation.

Parameter source: The source value.
Parameter onNext: The onNext value.
Parameter onError: The onError value.
Parameter onCompleted: The onCompleted value.
Returns: A System.IDisposable result.

M:IoT.Driver.TwinCATRx.ObservableBridgeExtensions.ToAsyncObservable``1(System.IObservable1{``0})`

public static ReactiveUI.Primitives.Async.IObservableAsync<T> ToAsyncObservable<T>(System.IObservable<T> source)

Executes the ToAsyncObservable operation.

Parameter source: The source value.
Returns: A ReactiveUI.Primitives.Async.IObservableAsync<T> result.

`T:IoT.Driver.TwinCATRx.ObservableServiceController`

public class IoT.Driver.TwinCATRx.ObservableServiceController

Observable Service Controller.

Declared public members

`M:IoT.Driver.TwinCATRx.ObservableServiceController.#ctor(System.ServiceProcess.ServiceController)`

public IoT.Driver.TwinCATRx.ObservableServiceController(System.ServiceProcess.ServiceController service)

Initializes a new instance of the T:IoT.Driver.TwinCATRx.ObservableServiceController class.

Parameter service: The service.

`M:IoT.Driver.TwinCATRx.ObservableServiceController.#ctor(System.ServiceProcess.ServiceController,System.TimeSpan)`

public IoT.Driver.TwinCATRx.ObservableServiceController(System.ServiceProcess.ServiceController service, System.TimeSpan interval)

Initializes a new instance of the T:IoT.Driver.TwinCATRx.ObservableServiceController class.

Parameter service: The service.
Parameter interval: The interval.

`M:IoT.Driver.TwinCATRx.ObservableServiceController.Dispose`

public void Dispose()

Releases managed and unmanaged resources.

`M:IoT.Driver.TwinCATRx.ObservableServiceController.GetServices`

public static System.IObservable<IoT.Driver.TwinCATRx.ObservableServiceController> GetServices()

Gets the services.

Returns: A Value.

`M:IoT.Driver.TwinCATRx.ObservableServiceController.Restart`

public void Restart()

Restarts this instance.

`M:IoT.Driver.TwinCATRx.ObservableServiceController.Start`

public void Start()

Starts this instance.

`M:IoT.Driver.TwinCATRx.ObservableServiceController.Stop`

public void Stop()

Stops this instance.

`P:IoT.Driver.TwinCATRx.ObservableServiceController.CanStop`

public bool CanStop { get; }

Gets a value indicating whether this instance can stop.

Value: true if this instance can stop; otherwise, false .

`P:IoT.Driver.TwinCATRx.ObservableServiceController.DisplayName`

public string DisplayName { get; }

Gets the display name.

Value: The display name.

`P:IoT.Driver.TwinCATRx.ObservableServiceController.IsDisposed`

public bool IsDisposed { get; }

Gets a value indicating whether the is disposed.

Value: The IsDisposed value.

`P:IoT.Driver.TwinCATRx.ObservableServiceController.ServiceName`

public string ServiceName { get; }

Gets the name of the service.

Value: The name of the service.

`P:IoT.Driver.TwinCATRx.ObservableServiceController.Status`

public System.ServiceProcess.ServiceControllerStatus Status { get; }

Gets the status.

Value: The status.

`P:IoT.Driver.TwinCATRx.ObservableServiceController.StatusObserver`

public System.IObservable<System.ServiceProcess.ServiceControllerStatus> StatusObserver { get; }

Gets the status.

Value: The status.

`T:IoT.Driver.TwinCATRx.RxTcAdsClient`

public class IoT.Driver.TwinCATRx.RxTcAdsClient

Observable TwinCAT ADS Client.

Declared public members

`M:IoT.Driver.TwinCATRx.RxTcAdsClient.#ctor`

public IoT.Driver.TwinCATRx.RxTcAdsClient()

Initializes a new instance of the T:IoT.Driver.TwinCATRx.RxTcAdsClient class.

`M:IoT.Driver.TwinCATRx.RxTcAdsClient.#ctor(System.TimeProvider)`

public IoT.Driver.TwinCATRx.RxTcAdsClient(System.TimeProvider timeProvider)

Initializes a new instance of the T:IoT.Driver.TwinCATRx.RxTcAdsClient class.

Parameter timeProvider: The time provider.

`M:IoT.Driver.TwinCATRx.RxTcAdsClient.Connect(IoT.Driver.TwinCATRx.Core.ISettings)`

public void Connect(IoT.Driver.TwinCATRx.Core.ISettings settings)

Connects the specified settings.

Parameter settings: The settings.

`M:IoT.Driver.TwinCATRx.RxTcAdsClient.Disconnect`

public void Disconnect()

Disconnects this instance.

`M:IoT.Driver.TwinCATRx.RxTcAdsClient.Dispose`

public void Dispose()

Releases unmanaged and - optionally - managed resources.

`M:IoT.Driver.TwinCATRx.RxTcAdsClient.Pause(System.TimeSpan)`

public void Pause(System.TimeSpan time)

Pauses the specified time.

Parameter time: The time.

`M:IoT.Driver.TwinCATRx.RxTcAdsClient.Read(System.String)`

public void Read(string variable)

Reads the specified variable.

Parameter variable: The data.

`M:IoT.Driver.TwinCATRx.RxTcAdsClient.Read(System.String,System.Nullable`1{System.Int32})`

public void Read(string variable, System.Nullable<int> arrayLength)

Executes the Read operation.

Parameter variable: The variable value.
Parameter arrayLength: The arrayLength value.

`M:IoT.Driver.TwinCATRx.RxTcAdsClient.Read(System.String,System.Nullable`1{System.Int32},System.String)`

public void Read(string variable, System.Nullable<int> arrayLength, string id)

Executes the Read operation.

Parameter variable: The variable value.
Parameter arrayLength: The arrayLength value.
Parameter id: The id value.

`M:IoT.Driver.TwinCATRx.RxTcAdsClient.Read(System.String,System.String)`

public void Read(string variable, string id)

Reads a variable with a correlation identifier.

Parameter variable: The variable.
Parameter id: The correlation identifier.

`M:IoT.Driver.TwinCATRx.RxTcAdsClient.Write(System.String,System.Object)`

public void Write(string variable, object value)

Writes the specified variable.

Parameter variable: The variable.
Parameter value: The value.

`M:IoT.Driver.TwinCATRx.RxTcAdsClient.Write(System.String,System.Object,System.String)`

public void Write(string variable, object value, string id)

Writes a variable with a correlation identifier.

Parameter variable: The variable.
Parameter value: The value.
Parameter id: The correlation identifier.

`P:IoT.Driver.TwinCATRx.RxTcAdsClient.Code`

public System.IObservable<string[]> Code { get; }

Gets codes this instance.

Returns: A Value.
Value: The Code value.

`P:IoT.Driver.TwinCATRx.RxTcAdsClient.Connected`

public bool Connected { get; }

Gets a value indicating whether this T:IoT.Driver.TwinCATRx.RxTcAdsClient is connected.

Value: true if connected; otherwise, false .

`P:IoT.Driver.TwinCATRx.RxTcAdsClient.DataReceived`

public System.IObservable<System.ValueTuple<string, object, string>> DataReceived { get; }

Gets the data received.

Value: The data received.

`P:IoT.Driver.TwinCATRx.RxTcAdsClient.DataReceivedAsync`

public ReactiveUI.Primitives.Async.IObservableAsync<System.ValueTuple<string, object, string>> DataReceivedAsync { get; }

Inherits XML documentation from its implemented or overridden member.

Value: The DataReceivedAsync value.

`P:IoT.Driver.TwinCATRx.RxTcAdsClient.ErrorReceived`

public System.IObservable<System.Exception> ErrorReceived { get; }

Gets error received.

Returns: A Value.
Value: The ErrorReceived value.

`P:IoT.Driver.TwinCATRx.RxTcAdsClient.ErrorReceivedAsync`

public ReactiveUI.Primitives.Async.IObservableAsync<System.Exception> ErrorReceivedAsync { get; }

Inherits XML documentation from its implemented or overridden member.

Value: The ErrorReceivedAsync value.

`P:IoT.Driver.TwinCATRx.RxTcAdsClient.InitializeComplete`

public System.IObservable<ReactiveUI.Primitives.RxVoid> InitializeComplete { get; }

Gets the initialize complete. PLC is ready to read and write.

Value: The initialize complete.

`P:IoT.Driver.TwinCATRx.RxTcAdsClient.InitializeCompleteAsync`

public ReactiveUI.Primitives.Async.IObservableAsync<ReactiveUI.Primitives.RxVoid> InitializeCompleteAsync { get; }

Inherits XML documentation from its implemented or overridden member.

Value: The InitializeCompleteAsync value.

`P:IoT.Driver.TwinCATRx.RxTcAdsClient.IsDisposed`

public bool IsDisposed { get; }

Gets a value indicating whether gets a value that indicates whether the object is disposed.

Value: The IsDisposed value.

`P:IoT.Driver.TwinCATRx.RxTcAdsClient.IsPaused`

public bool IsPaused { get; }

Gets a value indicating whether this instance is paused.

Value: true if this instance is paused; otherwise, false .

`P:IoT.Driver.TwinCATRx.RxTcAdsClient.IsPausedObservable`

public System.IObservable<bool> IsPausedObservable { get; }

Gets the is paused observable.

Value: The is paused observable.

`P:IoT.Driver.TwinCATRx.RxTcAdsClient.IsPausedObservableAsync`

public ReactiveUI.Primitives.Async.IObservableAsync<bool> IsPausedObservableAsync { get; }

Inherits XML documentation from its implemented or overridden member.

Value: The IsPausedObservableAsync value.

`P:IoT.Driver.TwinCATRx.RxTcAdsClient.OnWrite`

public System.IObservable<string> OnWrite { get; }

Gets the on write.

Value: The on write.

`P:IoT.Driver.TwinCATRx.RxTcAdsClient.OnWriteAsync`

public ReactiveUI.Primitives.Async.IObservableAsync<string> OnWriteAsync { get; }

Inherits XML documentation from its implemented or overridden member.

Value: The OnWriteAsync value.

`P:IoT.Driver.TwinCATRx.RxTcAdsClient.ReadWriteHandleInfo`

public System.Collections.Generic.IDictionary<string, System.Nullable<uint>> ReadWriteHandleInfo { get; }

Gets the read write handle information.

Value: The read write handle information.

`P:IoT.Driver.TwinCATRx.RxTcAdsClient.Settings`

public IoT.Driver.TwinCATRx.Core.ISettings Settings { get; }

Gets the settings.

Value: The settings.

`P:IoT.Driver.TwinCATRx.RxTcAdsClient.WriteHandleInfo`

public System.Collections.Generic.IDictionary<string, System.ValueTuple<System.Nullable<uint>, int>> WriteHandleInfo { get; }

Gets the write handle information.

Value: The write handle information.

`T:IoT.Driver.TwinCATRx.ServiceStatus`

public enum IoT.Driver.TwinCATRx.ServiceStatus

Service Status.

Declared public members

`F:IoT.Driver.TwinCATRx.ServiceStatus.Faulted`

public static const IoT.Driver.TwinCATRx.ServiceStatus Faulted

The faulted.

`F:IoT.Driver.TwinCATRx.ServiceStatus.Paused`

public static const IoT.Driver.TwinCATRx.ServiceStatus Paused

The paused.

`F:IoT.Driver.TwinCATRx.ServiceStatus.Running`

public static const IoT.Driver.TwinCATRx.ServiceStatus Running

The running.

`F:IoT.Driver.TwinCATRx.ServiceStatus.Starting`

public static const IoT.Driver.TwinCATRx.ServiceStatus Starting

The starting.

`F:IoT.Driver.TwinCATRx.ServiceStatus.StatusChanging`

public static const IoT.Driver.TwinCATRx.ServiceStatus StatusChanging

The status changing.

`F:IoT.Driver.TwinCATRx.ServiceStatus.Stopped`

public static const IoT.Driver.TwinCATRx.ServiceStatus Stopped

The stopped.

`F:IoT.Driver.TwinCATRx.ServiceStatus.Stopping`

public static const IoT.Driver.TwinCATRx.ServiceStatus Stopping

The stopping.

`F:IoT.Driver.TwinCATRx.ServiceStatus.Unknown`

public static const IoT.Driver.TwinCATRx.ServiceStatus Unknown

The unknown.

`T:IoT.Driver.TwinCATRx.TwinCatLogicalTagClient`

public class IoT.Driver.TwinCATRx.TwinCatLogicalTagClient

Maps logical CP.IoT tags onto an event-driven TwinCAT ADS client.

Declared public members

`M:IoT.Driver.TwinCATRx.TwinCatLogicalTagClient.#ctor(IoT.Driver.TwinCATRx.IRxTcAdsClient)`

public IoT.Driver.TwinCATRx.TwinCatLogicalTagClient(IoT.Driver.TwinCATRx.IRxTcAdsClient nativeClient)

Initializes a new instance of the T:IoT.Driver.TwinCATRx.TwinCatLogicalTagClient class.

Parameter nativeClient: The composed ADS client.

`M:IoT.Driver.TwinCATRx.TwinCatLogicalTagClient.#ctor(IoT.Driver.TwinCATRx.IRxTcAdsClient,IoT.Driver.Core.ILogicalTagCatalog)`

public IoT.Driver.TwinCATRx.TwinCatLogicalTagClient(IoT.Driver.TwinCATRx.IRxTcAdsClient nativeClient, IoT.Driver.Core.ILogicalTagCatalog catalog)

Initializes a new instance of the T:IoT.Driver.TwinCATRx.TwinCatLogicalTagClient class.

Parameter nativeClient: The composed ADS client.
Parameter catalog: The caller-owned catalog.

`M:IoT.Driver.TwinCATRx.TwinCatLogicalTagClient.#ctor(IoT.Driver.TwinCATRx.IRxTcAdsClient,IoT.Driver.Core.ILogicalTagCatalog,IoT.Driver.Core.LogicalTagSqliteStore)`

public IoT.Driver.TwinCATRx.TwinCatLogicalTagClient(IoT.Driver.TwinCATRx.IRxTcAdsClient nativeClient, IoT.Driver.Core.ILogicalTagCatalog catalog, IoT.Driver.Core.LogicalTagSqliteStore store)

Initializes a new instance of the T:IoT.Driver.TwinCATRx.TwinCatLogicalTagClient class.

Parameter nativeClient: The composed ADS client.
Parameter catalog: The caller-owned catalog.
Parameter store: The SQLite store.

`M:IoT.Driver.TwinCATRx.TwinCatLogicalTagClient.#ctor(IoT.Driver.TwinCATRx.IRxTcAdsClient,IoT.Driver.Core.ILogicalTagCatalog,IoT.Driver.Core.LogicalTagSqliteStore,System.TimeProvider)`

public IoT.Driver.TwinCATRx.TwinCatLogicalTagClient(IoT.Driver.TwinCATRx.IRxTcAdsClient nativeClient, IoT.Driver.Core.ILogicalTagCatalog catalog, IoT.Driver.Core.LogicalTagSqliteStore store, System.TimeProvider timeProvider)

Initializes a new instance of the T:IoT.Driver.TwinCATRx.TwinCatLogicalTagClient class.

Parameter nativeClient: The composed ADS client.
Parameter catalog: The caller-owned catalog.
Parameter store: The SQLite store.
Parameter timeProvider: The time provider.

`M:IoT.Driver.TwinCATRx.TwinCatLogicalTagClient.#ctor(IoT.Driver.TwinCATRx.IRxTcAdsClient,IoT.Driver.Core.ILogicalTagCatalog,System.TimeProvider)`

public IoT.Driver.TwinCATRx.TwinCatLogicalTagClient(IoT.Driver.TwinCATRx.IRxTcAdsClient nativeClient, IoT.Driver.Core.ILogicalTagCatalog catalog, System.TimeProvider timeProvider)

Initializes a new instance of the T:IoT.Driver.TwinCATRx.TwinCatLogicalTagClient class.

Parameter nativeClient: The composed ADS client.
Parameter catalog: The caller-owned catalog.
Parameter timeProvider: The time provider.

`M:IoT.Driver.TwinCATRx.TwinCatLogicalTagClient.#ctor(IoT.Driver.TwinCATRx.IRxTcAdsClient,IoT.Driver.Core.LogicalTagSqliteStore)`

public IoT.Driver.TwinCATRx.TwinCatLogicalTagClient(IoT.Driver.TwinCATRx.IRxTcAdsClient nativeClient, IoT.Driver.Core.LogicalTagSqliteStore store)

Initializes a new instance of the T:IoT.Driver.TwinCATRx.TwinCatLogicalTagClient class.

Parameter nativeClient: The composed ADS client.
Parameter store: The SQLite store.

`M:IoT.Driver.TwinCATRx.TwinCatLogicalTagClient.#ctor(IoT.Driver.TwinCATRx.IRxTcAdsClient,IoT.Driver.Core.LogicalTagSqliteStore,System.TimeProvider)`

public IoT.Driver.TwinCATRx.TwinCatLogicalTagClient(IoT.Driver.TwinCATRx.IRxTcAdsClient nativeClient, IoT.Driver.Core.LogicalTagSqliteStore store, System.TimeProvider timeProvider)

Initializes a new instance of the T:IoT.Driver.TwinCATRx.TwinCatLogicalTagClient class.

Parameter nativeClient: The composed ADS client.
Parameter store: The SQLite store.
Parameter timeProvider: The time provider.

`M:IoT.Driver.TwinCATRx.TwinCatLogicalTagClient.#ctor(IoT.Driver.TwinCATRx.IRxTcAdsClient,System.TimeProvider)`

public IoT.Driver.TwinCATRx.TwinCatLogicalTagClient(IoT.Driver.TwinCATRx.IRxTcAdsClient nativeClient, System.TimeProvider timeProvider)

Initializes a new instance of the T:IoT.Driver.TwinCATRx.TwinCatLogicalTagClient class.

Parameter nativeClient: The composed ADS client.
Parameter timeProvider: The time provider.

`M:IoT.Driver.TwinCATRx.TwinCatLogicalTagClient.CreateTag(IoT.Driver.Core.LogicalTag)`

public IoT.Driver.Core.LogicalTag CreateTag(IoT.Driver.Core.LogicalTag tag)

Creates a tag from a complete shared tag definition and registers it.

Parameter tag: The complete shared tag definition.
Returns: The registered tag.

`M:IoT.Driver.TwinCATRx.TwinCatLogicalTagClient.CreateTag(System.String,System.String,System.String)`

public IoT.Driver.Core.LogicalTag CreateTag(string name, string address, string dataType)

Creates and registers a logical TwinCAT tag.

Parameter name: The logical name.
Parameter address: The ADS address.
Parameter dataType: The logical data type.
Returns: The registered tag.

`M:IoT.Driver.TwinCATRx.TwinCatLogicalTagClient.DeleteGroupAsync(System.String,System.Threading.CancellationToken)`

public System.Threading.Tasks.Task<bool> DeleteGroupAsync(string name, System.Threading.CancellationToken cancellationToken)

Inherits XML documentation from its implemented or overridden member.

Parameter name: The name value.
Parameter cancellationToken: The cancellationToken value.
Returns: A System.Threading.Tasks.Task<bool> result.

`M:IoT.Driver.TwinCATRx.TwinCatLogicalTagClient.DeleteTagAsync(System.String)`

public System.Threading.Tasks.Task<bool> DeleteTagAsync(string name)

Deletes a tag from SQLite and the live registry.

Parameter name: The logical tag name.
Returns: Whether an existing tag was deleted.

`M:IoT.Driver.TwinCATRx.TwinCatLogicalTagClient.DeleteTagAsync(System.String,System.Threading.CancellationToken)`

public System.Threading.Tasks.Task<bool> DeleteTagAsync(string name, System.Threading.CancellationToken cancellationToken)

Deletes a tag from SQLite and the live registry.

Parameter name: The logical tag name.
Parameter cancellationToken: The cancellation token.
Returns: Whether an existing tag was deleted.

`M:IoT.Driver.TwinCATRx.TwinCatLogicalTagClient.Dispose`

public void Dispose()

Releases registry-owned resources without disposing the composed ADS client.

`M:IoT.Driver.TwinCATRx.TwinCatLogicalTagClient.EditTagAsync(IoT.Driver.Core.LogicalTag)`

public System.Threading.Tasks.Task<bool> EditTagAsync(IoT.Driver.Core.LogicalTag tag)

Edits an existing SQLite tag and refreshes the live registry.

Parameter tag: The logical tag.
Returns: Whether an existing tag was edited.

`M:IoT.Driver.TwinCATRx.TwinCatLogicalTagClient.EditTagAsync(IoT.Driver.Core.LogicalTag,System.Threading.CancellationToken)`

public System.Threading.Tasks.Task<bool> EditTagAsync(IoT.Driver.Core.LogicalTag tag, System.Threading.CancellationToken cancellationToken)

Edits an existing SQLite tag and refreshes the live registry.

Parameter tag: The logical tag.
Parameter cancellationToken: The cancellation token.
Returns: Whether an existing tag was edited.

`M:IoT.Driver.TwinCATRx.TwinCatLogicalTagClient.ExportCsvAsync(System.IO.TextWriter)`

public System.Threading.Tasks.Task ExportCsvAsync(System.IO.TextWriter writer)

Exports the live registry as CSV.

Parameter writer: The CSV writer.
Returns: The export operation.

`M:IoT.Driver.TwinCATRx.TwinCatLogicalTagClient.ExportCsvAsync(System.IO.TextWriter,System.Char,System.Threading.CancellationToken)`

public System.Threading.Tasks.Task ExportCsvAsync(System.IO.TextWriter writer, char delimiter, System.Threading.CancellationToken cancellationToken)

Inherits XML documentation from its implemented or overridden member.

Parameter writer: The writer value.
Parameter delimiter: The delimiter value.
Parameter cancellationToken: The cancellationToken value.
Returns: A System.Threading.Tasks.Task result.

`M:IoT.Driver.TwinCATRx.TwinCatLogicalTagClient.ExportCsvAsync(System.IO.TextWriter,System.Threading.CancellationToken)`

public System.Threading.Tasks.Task ExportCsvAsync(System.IO.TextWriter writer, System.Threading.CancellationToken cancellationToken)

Exports the live registry as CSV.

Parameter writer: The CSV writer.
Parameter cancellationToken: The cancellation token.
Returns: The export operation.

`M:IoT.Driver.TwinCATRx.TwinCatLogicalTagClient.GetGroupAsync(System.String,System.Threading.CancellationToken)`

public System.Threading.Tasks.Task<IoT.Driver.Core.LogicalTagGroup> GetGroupAsync(string name, System.Threading.CancellationToken cancellationToken)

Inherits XML documentation from its implemented or overridden member.

Parameter name: The name value.
Parameter cancellationToken: The cancellationToken value.
Returns: A System.Threading.Tasks.Task<IoT.Driver.Core.LogicalTagGroup> result.

`M:IoT.Driver.TwinCATRx.TwinCatLogicalTagClient.GetTagAsync(System.String)`

public System.Threading.Tasks.Task<IoT.Driver.Core.LogicalTag> GetTagAsync(string name)

Gets a persisted tag.

Parameter name: The logical tag name.
Returns: The persisted tag, or null.

`M:IoT.Driver.TwinCATRx.TwinCatLogicalTagClient.GetTagAsync(System.String,System.Threading.CancellationToken)`

public System.Threading.Tasks.Task<IoT.Driver.Core.LogicalTag> GetTagAsync(string name, System.Threading.CancellationToken cancellationToken)

Gets a persisted tag.

Parameter name: The logical tag name.
Parameter cancellationToken: The cancellation token.
Returns: The persisted tag, or null.

`M:IoT.Driver.TwinCATRx.TwinCatLogicalTagClient.ImportCsvAsync(System.IO.TextReader)`

public System.Threading.Tasks.Task<System.Collections.Generic.IReadOnlyList<IoT.Driver.Core.LogicalTag>> ImportCsvAsync(System.IO.TextReader reader)

Imports CSV definitions into the live registry.

Parameter reader: The CSV reader.
Returns: The imported tags.

`M:IoT.Driver.TwinCATRx.TwinCatLogicalTagClient.ImportCsvAsync(System.IO.TextReader,System.Boolean)`

public System.Threading.Tasks.Task<System.Collections.Generic.IReadOnlyList<IoT.Driver.Core.LogicalTag>> ImportCsvAsync(System.IO.TextReader reader, bool replaceExisting)

Imports CSV definitions into the live registry.

Parameter reader: The CSV reader.
Parameter replaceExisting: Whether imported tags replace matching live tags.
Returns: The imported tags.

`M:IoT.Driver.TwinCATRx.TwinCatLogicalTagClient.ImportCsvAsync(System.IO.TextReader,System.Boolean,System.Threading.CancellationToken)`

public System.Threading.Tasks.Task<System.Collections.Generic.IReadOnlyList<IoT.Driver.Core.LogicalTag>> ImportCsvAsync(System.IO.TextReader reader, bool replaceExisting, System.Threading.CancellationToken cancellationToken)

Imports CSV definitions into the live registry.

Parameter reader: The CSV reader.
Parameter replaceExisting: Whether imported tags replace matching live tags.
Parameter cancellationToken: The cancellation token.
Returns: The imported tags.

`M:IoT.Driver.TwinCATRx.TwinCatLogicalTagClient.ImportCsvAsync(System.IO.TextReader,System.Char,System.Boolean,System.Threading.CancellationToken)`

public System.Threading.Tasks.Task<System.Collections.Generic.IReadOnlyList<IoT.Driver.Core.LogicalTag>> ImportCsvAsync(System.IO.TextReader reader, char delimiter, bool replaceExisting, System.Threading.CancellationToken cancellationToken)

Imports CSV definitions into the live registry.

Parameter reader: The CSV reader.
Parameter delimiter: The CSV delimiter.
Parameter replaceExisting: Whether imported tags replace matching live tags.
Parameter cancellationToken: The cancellation token.
Returns: The imported tags.

`M:IoT.Driver.TwinCATRx.TwinCatLogicalTagClient.ImportCsvAsync(System.IO.TextReader,System.Char,System.Threading.CancellationToken)`

public System.Threading.Tasks.Task<System.Collections.Generic.IReadOnlyList<IoT.Driver.Core.LogicalTag>> ImportCsvAsync(System.IO.TextReader reader, char delimiter, System.Threading.CancellationToken cancellationToken)

Inherits XML documentation from its implemented or overridden member.

Parameter reader: The reader value.
Parameter delimiter: The delimiter value.
Parameter cancellationToken: The cancellationToken value.
Returns: A System.Threading.Tasks.Task<System.Collections.Generic.IReadOnlyList<IoT.Driver.Core.LogicalTag>> result.

`M:IoT.Driver.TwinCATRx.TwinCatLogicalTagClient.InitializeStoreAsync`

public System.Threading.Tasks.Task InitializeStoreAsync()

Initializes the configured SQLite store.

Returns: The initialization operation.

`M:IoT.Driver.TwinCATRx.TwinCatLogicalTagClient.InitializeStoreAsync(System.Threading.CancellationToken)`

public System.Threading.Tasks.Task InitializeStoreAsync(System.Threading.CancellationToken cancellationToken)

Initializes the configured SQLite store.

Parameter cancellationToken: The cancellation token.
Returns: The initialization operation.

`M:IoT.Driver.TwinCATRx.TwinCatLogicalTagClient.ListGroupsAsync(System.Threading.CancellationToken)`

public System.Threading.Tasks.Task<System.Collections.Generic.IReadOnlyList<IoT.Driver.Core.LogicalTagGroup>> ListGroupsAsync(System.Threading.CancellationToken cancellationToken)

Inherits XML documentation from its implemented or overridden member.

Parameter cancellationToken: The cancellationToken value.
Returns: A System.Threading.Tasks.Task<System.Collections.Generic.IReadOnlyList<IoT.Driver.Core.LogicalTagGroup>> result.

`M:IoT.Driver.TwinCATRx.TwinCatLogicalTagClient.ListTagsAsync(System.Threading.CancellationToken)`

public System.Threading.Tasks.Task<System.Collections.Generic.IReadOnlyList<IoT.Driver.Core.LogicalTag>> ListTagsAsync(System.Threading.CancellationToken cancellationToken)

Inherits XML documentation from its implemented or overridden member.

Parameter cancellationToken: The cancellationToken value.
Returns: A System.Threading.Tasks.Task<System.Collections.Generic.IReadOnlyList<IoT.Driver.Core.LogicalTag>> result.

`M:IoT.Driver.TwinCATRx.TwinCatLogicalTagClient.LoadTagsAsync`

public System.Threading.Tasks.Task<System.Collections.Generic.IReadOnlyList<IoT.Driver.Core.LogicalTag>> LoadTagsAsync()

Dynamically loads persisted tags into the live registry.

Returns: The loaded tags.

`M:IoT.Driver.TwinCATRx.TwinCatLogicalTagClient.LoadTagsAsync(System.Boolean)`

public System.Threading.Tasks.Task<System.Collections.Generic.IReadOnlyList<IoT.Driver.Core.LogicalTag>> LoadTagsAsync(bool replaceExisting)

Dynamically loads persisted tags into the live registry.

Parameter replaceExisting: Whether persisted tags replace matching live tags.
Returns: The loaded tags.

`M:IoT.Driver.TwinCATRx.TwinCatLogicalTagClient.LoadTagsAsync(System.Boolean,System.Threading.CancellationToken)`

public System.Threading.Tasks.Task<System.Collections.Generic.IReadOnlyList<IoT.Driver.Core.LogicalTag>> LoadTagsAsync(bool replaceExisting, System.Threading.CancellationToken cancellationToken)

Dynamically loads persisted tags into the live registry.

Parameter replaceExisting: Whether persisted tags replace matching live tags.
Parameter cancellationToken: The cancellation token.
Returns: The loaded tags.

`M:IoT.Driver.TwinCATRx.TwinCatLogicalTagClient.LoadTagsAsync(System.Threading.CancellationToken)`

public System.Threading.Tasks.Task<System.Collections.Generic.IReadOnlyList<IoT.Driver.Core.LogicalTag>> LoadTagsAsync(System.Threading.CancellationToken cancellationToken)

Inherits XML documentation from its implemented or overridden member.

Parameter cancellationToken: The cancellationToken value.
Returns: A System.Threading.Tasks.Task<System.Collections.Generic.IReadOnlyList<IoT.Driver.Core.LogicalTag>> result.

`M:IoT.Driver.TwinCATRx.TwinCatLogicalTagClient.Observe(System.String)`

public System.IObservable<IoT.Driver.Core.LogicalTagValue> Observe(string tagName)

Inherits XML documentation from its implemented or overridden member.

Parameter tagName: The tagName value.
Returns: A System.IObservable<IoT.Driver.Core.LogicalTagValue> result.

`M:IoT.Driver.TwinCATRx.TwinCatLogicalTagClient.ObserveAsync(System.String,System.Threading.CancellationToken)`

public System.Collections.Generic.IAsyncEnumerable<IoT.Driver.Core.LogicalTagValue> ObserveAsync(string tagName, System.Threading.CancellationToken cancellationToken)

Inherits XML documentation from its implemented or overridden member.

Parameter tagName: The tagName value.
Parameter cancellationToken: The cancellationToken value.
Returns: A System.Collections.Generic.IAsyncEnumerable<IoT.Driver.Core.LogicalTagValue> result.

`M:IoT.Driver.TwinCATRx.TwinCatLogicalTagClient.ObserveMany(System.Collections.Generic.IReadOnlyCollection`1{System.String})`

public System.IObservable<IoT.Driver.Core.LogicalTagValue> ObserveMany(System.Collections.Generic.IReadOnlyCollection<string> tagNames)

Executes the ObserveMany operation.

Parameter tagNames: The tagNames value.
Returns: A System.IObservable<IoT.Driver.Core.LogicalTagValue> result.

`M:IoT.Driver.TwinCATRx.TwinCatLogicalTagClient.ObserveManyAsync(System.Collections.Generic.IReadOnlyCollection`1{System.String},System.Threading.CancellationToken)`

public System.Collections.Generic.IAsyncEnumerable<IoT.Driver.Core.LogicalTagValue> ObserveManyAsync(System.Collections.Generic.IReadOnlyCollection<string> tagNames, System.Threading.CancellationToken cancellationToken)

Executes the ObserveManyAsync operation.

Parameter tagNames: The tagNames value.
Parameter cancellationToken: The cancellationToken value.
Returns: A System.Collections.Generic.IAsyncEnumerable<IoT.Driver.Core.LogicalTagValue> result.

`M:IoT.Driver.TwinCATRx.TwinCatLogicalTagClient.ReadAsync(System.String,System.Threading.CancellationToken)`

public System.Threading.Tasks.Task<IoT.Driver.Core.TagOperationResult<IoT.Driver.Core.LogicalTagValue>> ReadAsync(string tagName, System.Threading.CancellationToken cancellationToken)

Inherits XML documentation from its implemented or overridden member.

Parameter tagName: The tagName value.
Parameter cancellationToken: The cancellationToken value.
Returns: A System.Threading.Tasks.Task<IoT.Driver.Core.TagOperationResult<IoT.Driver.Core.LogicalTagValue>> result.

`M:IoT.Driver.TwinCATRx.TwinCatLogicalTagClient.ReadManyAsync(System.Collections.Generic.IReadOnlyCollection`1{System.String},System.Threading.CancellationToken)`

public System.Threading.Tasks.Task<System.Collections.Generic.IReadOnlyList<IoT.Driver.Core.TagOperationResult<IoT.Driver.Core.LogicalTagValue>>> ReadManyAsync(System.Collections.Generic.IReadOnlyCollection<string> tagNames, System.Threading.CancellationToken cancellationToken)

Executes the ReadManyAsync operation.

Parameter tagNames: The tagNames value.
Parameter cancellationToken: The cancellationToken value.
Returns: A System.Threading.Tasks.Task<System.Collections.Generic.IReadOnlyList<IoT.Driver.Core.TagOperationResult<IoT.Driver.Core.LogicalTagValue>>> result.

`M:IoT.Driver.TwinCATRx.TwinCatLogicalTagClient.RegisterTag(IoT.Driver.Core.LogicalTag)`

public void RegisterTag(IoT.Driver.Core.LogicalTag tag)

Adds or replaces a logical tag in the live registry.

Parameter tag: The logical tag.

`M:IoT.Driver.TwinCATRx.TwinCatLogicalTagClient.RemoveTag(System.String)`

public bool RemoveTag(string name)

Removes a logical tag from the live registry.

Parameter name: The logical tag name.
Returns: Whether the tag was removed.

`M:IoT.Driver.TwinCATRx.TwinCatLogicalTagClient.UpsertGroupAsync(IoT.Driver.Core.LogicalTagGroup,System.Threading.CancellationToken)`

public System.Threading.Tasks.Task UpsertGroupAsync(IoT.Driver.Core.LogicalTagGroup group, System.Threading.CancellationToken cancellationToken)

Inherits XML documentation from its implemented or overridden member.

Parameter group: The group value.
Parameter cancellationToken: The cancellationToken value.
Returns: A System.Threading.Tasks.Task result.

`M:IoT.Driver.TwinCATRx.TwinCatLogicalTagClient.UpsertTagAsync(IoT.Driver.Core.LogicalTag)`

public System.Threading.Tasks.Task UpsertTagAsync(IoT.Driver.Core.LogicalTag tag)

Upserts a tag in SQLite and the live registry.

Parameter tag: The logical tag.
Returns: The upsert operation.

`M:IoT.Driver.TwinCATRx.TwinCatLogicalTagClient.UpsertTagAsync(IoT.Driver.Core.LogicalTag,System.Threading.CancellationToken)`

public System.Threading.Tasks.Task UpsertTagAsync(IoT.Driver.Core.LogicalTag tag, System.Threading.CancellationToken cancellationToken)

Upserts a tag in SQLite and the live registry.

Parameter tag: The logical tag.
Parameter cancellationToken: The cancellation token.
Returns: The upsert operation.

`M:IoT.Driver.TwinCATRx.TwinCatLogicalTagClient.WriteAsync(IoT.Driver.Core.LogicalTagValue,System.Threading.CancellationToken)`

public System.Threading.Tasks.Task<IoT.Driver.Core.TagOperationResult<IoT.Driver.Core.LogicalTagValue>> WriteAsync(IoT.Driver.Core.LogicalTagValue value, System.Threading.CancellationToken cancellationToken)

Inherits XML documentation from its implemented or overridden member.

Parameter value: The value value.
Parameter cancellationToken: The cancellationToken value.
Returns: A System.Threading.Tasks.Task<IoT.Driver.Core.TagOperationResult<IoT.Driver.Core.LogicalTagValue>> result.

`M:IoT.Driver.TwinCATRx.TwinCatLogicalTagClient.WriteManyAsync(System.Collections.Generic.IReadOnlyCollection`1{IoT.Driver.Core.LogicalTagValue},System.Threading.CancellationToken)`

public System.Threading.Tasks.Task<System.Collections.Generic.IReadOnlyList<IoT.Driver.Core.TagOperationResult<IoT.Driver.Core.LogicalTagValue>>> WriteManyAsync(System.Collections.Generic.IReadOnlyCollection<IoT.Driver.Core.LogicalTagValue> values, System.Threading.CancellationToken cancellationToken)

Executes the WriteManyAsync operation.

Parameter values: The values value.
Parameter cancellationToken: The cancellationToken value.
Returns: A System.Threading.Tasks.Task<System.Collections.Generic.IReadOnlyList<IoT.Driver.Core.TagOperationResult<IoT.Driver.Core.LogicalTagValue>>> result.

`P:IoT.Driver.TwinCATRx.TwinCatLogicalTagClient.Catalog`

public IoT.Driver.Core.ILogicalTagCatalog Catalog { get; }

Gets the logical tag catalog.

Value: The Catalog value.

`T:IoT.Driver.TwinCATRx.TwinCatRxExtensions`

public class IoT.Driver.TwinCATRx.TwinCatRxExtensions

Observable TwinCAT extensions.

Declared public members

`M:IoT.Driver.TwinCATRx.TwinCatRxExtensions.CreateClone(CP.Collections.HashTableRx)`

public static CP.Collections.HashTableRx CreateClone(CP.Collections.HashTableRx hashTable)

Clones the specified HashTableRx.

Parameter hashTable: The HashTableRx instance.
Returns: A HashTableRx.

`M:IoT.Driver.TwinCATRx.TwinCatRxExtensions.CreateStruct(IoT.Driver.TwinCATRx.IRxTcAdsClient,System.String)`

public static CP.Collections.HashTableRx CreateStruct(IoT.Driver.TwinCATRx.IRxTcAdsClient client, string variable)

Creates the structure.

Parameter client: The reactive TwinCAT client.
Parameter variable: The variable.
Returns: A HashTableRx with a link to the PLC.

M:IoT.Driver.TwinCATRx.TwinCatRxExtensions.ObserveAsyncObservable``1(IoT.Driver.TwinCATRx.IRxTcAdsClient,System.String,System.Func2{System.Object,``0})`

public static ReactiveUI.Primitives.Async.IObservableAsync<T> ObserveAsyncObservable<T>(IoT.Driver.TwinCATRx.IRxTcAdsClient client, string variable, System.Func<object, T> converter)

Executes the ObserveAsyncObservable operation.

Parameter client: The client value.
Parameter variable: The variable value.
Parameter converter: The converter value.
Returns: A ReactiveUI.Primitives.Async.IObservableAsync<T> result.

M:IoT.Driver.TwinCATRx.TwinCatRxExtensions.ObserveAsyncObservable``1(IoT.Driver.TwinCATRx.IRxTcAdsClient,System.String,System.String,System.Func2{System.Object,``0})`

public static ReactiveUI.Primitives.Async.IObservableAsync<T> ObserveAsyncObservable<T>(IoT.Driver.TwinCATRx.IRxTcAdsClient client, string variable, string id, System.Func<object, T> converter)

Executes the ObserveAsyncObservable operation.

Parameter client: The client value.
Parameter variable: The variable value.
Parameter id: The id value.
Parameter converter: The converter value.
Returns: A ReactiveUI.Primitives.Async.IObservableAsync<T> result.

M:IoT.Driver.TwinCATRx.TwinCatRxExtensions.Observe``1(IoT.Driver.TwinCATRx.IRxTcAdsClient,System.String,System.Func2{System.Object,``0})`

public static System.IObservable<T> Observe<T>(IoT.Driver.TwinCATRx.IRxTcAdsClient client, string variable, System.Func<object, T> converter)

Executes the Observe operation.

Parameter client: The client value.
Parameter variable: The variable value.
Parameter converter: The converter value.
Returns: A System.IObservable<T> result.

M:IoT.Driver.TwinCATRx.TwinCatRxExtensions.Observe``1(IoT.Driver.TwinCATRx.IRxTcAdsClient,System.String,System.String,System.Func2{System.Object,``0})`

public static System.IObservable<T> Observe<T>(IoT.Driver.TwinCATRx.IRxTcAdsClient client, string variable, string id, System.Func<object, T> converter)

Executes the Observe operation.

Parameter client: The client value.
Parameter variable: The variable value.
Parameter id: The id value.
Parameter converter: The converter value.
Returns: A System.IObservable<T> result.

`M:IoT.Driver.TwinCATRx.TwinCatRxExtensions.StructureReady(CP.Collections.HashTableRx)`

public static System.IObservable<CP.Collections.HashTableRx> StructureReady(CP.Collections.HashTableRx hashTable)

Returns an observable that fires when the structure is ready.

Parameter hashTable: The HashTableRx instance.
Returns: An observable when values have been set.

`M:IoT.Driver.TwinCATRx.TwinCatRxExtensions.WriteValues(CP.Collections.HashTableRx,System.Action`1{CP.Collections.HashTableRx})`

public static bool WriteValues(CP.Collections.HashTableRx hashTable, System.Action<CP.Collections.HashTableRx> setValues)

Executes the WriteValues operation.

Parameter hashTable: The hashTable value.
Parameter setValues: The setValues value.
Returns: A bool result.

`M:IoT.Driver.TwinCATRx.TwinCatRxExtensions.WriteValuesAsync(CP.Collections.HashTableRx,System.Action`1{CP.Collections.HashTableRx},System.TimeSpan)`

public static System.Threading.Tasks.Task<bool> WriteValuesAsync(CP.Collections.HashTableRx hashTable, System.Action<CP.Collections.HashTableRx> setValues, System.TimeSpan time)

Executes the WriteValuesAsync operation.

Parameter hashTable: The hashTable value.
Parameter setValues: The setValues value.
Parameter time: The time value.
Returns: A System.Threading.Tasks.Task<bool> result.

`TwinCATRx.Core`

Exported public types: 13; declared public members: 97.

`T:IoT.Driver.TwinCATRx.Core.CSharpLanguage`

public class IoT.Driver.TwinCATRx.Core.CSharpLanguage

C Sharp Language.

Declared public members

`M:IoT.Driver.TwinCATRx.Core.CSharpLanguage.#ctor`

public IoT.Driver.TwinCATRx.Core.CSharpLanguage()

Initializes a new instance of IoT.Driver.TwinCATRx.Core.CSharpLanguage.

`M:IoT.Driver.TwinCATRx.Core.CSharpLanguage.CreateAssembly(System.String,System.String)`

public static bool CreateAssembly(string code, string assemblyFileName)

Creates the assembly.

Parameter code: The code.
Parameter assemblyFileName: Name of the assembly file.
Returns: A bool.

`M:IoT.Driver.TwinCATRx.Core.CSharpLanguage.CreateLibraryCompilation(System.String,System.Boolean)`

public Microsoft.CodeAnalysis.Compilation CreateLibraryCompilation(string assemblyName, bool enableOptimisations)

Inherits XML documentation from its implemented or overridden member.

Parameter assemblyName: The assemblyName value.
Parameter enableOptimisations: The enableOptimisations value.
Returns: A Microsoft.CodeAnalysis.Compilation result.

`M:IoT.Driver.TwinCATRx.Core.CSharpLanguage.ParseText(System.String,Microsoft.CodeAnalysis.SourceCodeKind)`

public Microsoft.CodeAnalysis.SyntaxTree ParseText(string code, Microsoft.CodeAnalysis.SourceCodeKind kind)

Inherits XML documentation from its implemented or overridden member.

Parameter code: The code value.
Parameter kind: The kind value.
Returns: A Microsoft.CodeAnalysis.SyntaxTree result.

`T:IoT.Driver.TwinCATRx.Core.CodeGenerator`

public class IoT.Driver.TwinCATRx.Core.CodeGenerator

Code Generator.

Declared public members

`M:IoT.Driver.TwinCATRx.Core.CodeGenerator.#ctor`

public IoT.Driver.TwinCATRx.Core.CodeGenerator()

Initializes a new instance of the T:IoT.Driver.TwinCATRx.Core.CodeGenerator class.

`M:IoT.Driver.TwinCATRx.Core.CodeGenerator.#ctor(System.Action`1{System.Exception})`

public IoT.Driver.TwinCATRx.Core.CodeGenerator(System.Action<System.Exception> errorHandler)

Initializes a new instance of IoT.Driver.TwinCATRx.Core.CodeGenerator.

Parameter errorHandler: The errorHandler value.

`M:IoT.Driver.TwinCATRx.Core.CodeGenerator.CreateCSharpCode(IoT.Driver.TwinCATRx.Core.INodeEmulator)`

public bool CreateCSharpCode(IoT.Driver.TwinCATRx.Core.INodeEmulator selectedTN)

Creates a C# code file using the default TwinCAT version.

Parameter selectedTN: The selected node.
Returns: true when code was created.

`M:IoT.Driver.TwinCATRx.Core.CodeGenerator.CreateCSharpCode(IoT.Driver.TwinCATRx.Core.INodeEmulator,System.Boolean)`

public bool CreateCSharpCode(IoT.Driver.TwinCATRx.Core.INodeEmulator selectedTN, bool isTwinCat3)

Creates a C# code file based on the selected node structure.

Parameter selectedTN: The selected tn.
Parameter isTwinCat3: Whether TwinCAT 3 packing should be used.
Returns: Result as a Boolean.

`M:IoT.Driver.TwinCATRx.Core.CodeGenerator.CreateCSharpCode(IoT.Driver.TwinCATRx.Core.INodeEmulator,System.String)`

public bool CreateCSharpCode(IoT.Driver.TwinCATRx.Core.INodeEmulator selectedTN, string fileName)

Creates a C# code file using default generation settings.

Parameter selectedTN: The selectedTN value.
Parameter fileName: The fileName value.
Returns: A bool result.

`M:IoT.Driver.TwinCATRx.Core.CodeGenerator.CreateCSharpCode(IoT.Driver.TwinCATRx.Core.INodeEmulator,System.String,System.Boolean)`

public bool CreateCSharpCode(IoT.Driver.TwinCATRx.Core.INodeEmulator selectedTN, string fileName, bool isTwinCat3)

Creates a C# code file using the default namespace.

Parameter selectedTN: The selectedTN value.
Parameter fileName: The fileName value.
Parameter isTwinCat3: The isTwinCat3 value.
Returns: A bool result.

`M:IoT.Driver.TwinCATRx.Core.CodeGenerator.CreateCSharpCode(IoT.Driver.TwinCATRx.Core.INodeEmulator,System.String,System.Boolean,System.String)`

public bool CreateCSharpCode(IoT.Driver.TwinCATRx.Core.INodeEmulator selectedTN, string fileName, bool isTwinCat3, string classNamespace)

Creates a C# code file based on the selected node structure.

Parameter selectedTN: The selected tn.
Parameter fileName: Name of the file.
Parameter isTwinCat3: if set to true [is twin cat3].
Parameter classNamespace: The class namespace.
Returns: Result as a Boolean.

`M:IoT.Driver.TwinCATRx.Core.CodeGenerator.CreateCSharpCodeString(IoT.Driver.TwinCATRx.Core.INodeEmulator)`

public string CreateCSharpCodeString(IoT.Driver.TwinCATRx.Core.INodeEmulator selectedTN)

Creates a C# code string using default generation settings.

Parameter selectedTN: The selected node.
Returns: The generated code.

`M:IoT.Driver.TwinCATRx.Core.CodeGenerator.CreateCSharpCodeString(IoT.Driver.TwinCATRx.Core.INodeEmulator,System.Boolean)`

public string CreateCSharpCodeString(IoT.Driver.TwinCATRx.Core.INodeEmulator selectedTN, bool isTwinCat3)

Creates a C# code string using the default namespace.

Parameter selectedTN: The selectedTN value.
Parameter isTwinCat3: The isTwinCat3 value.
Returns: A string result.

`M:IoT.Driver.TwinCATRx.Core.CodeGenerator.CreateCSharpCodeString(IoT.Driver.TwinCATRx.Core.INodeEmulator,System.Boolean,System.String)`

public string CreateCSharpCodeString(IoT.Driver.TwinCATRx.Core.INodeEmulator selectedTN, bool isTwinCat3, string classNamespace)

Creates the C# code string.

Parameter selectedTN: The selected tn.
Parameter isTwinCat3: if set to true [is twin cat3].
Parameter classNamespace: The class namespace.
Returns: A Value.

`M:IoT.Driver.TwinCATRx.Core.CodeGenerator.CreateDll(IoT.Driver.TwinCATRx.Core.INodeEmulator)`

public bool CreateDll(IoT.Driver.TwinCATRx.Core.INodeEmulator selectedTN)

Creates a DLL based on the selected node structure.

Parameter selectedTN: The selected tn.
Returns: Result as a Boolean.

`M:IoT.Driver.TwinCATRx.Core.CodeGenerator.CreateDll(IoT.Driver.TwinCATRx.Core.INodeEmulator,System.Boolean)`

public bool CreateDll(IoT.Driver.TwinCATRx.Core.INodeEmulator selectedTN, bool isTwinCat3)

Creates a DLL based on the selected node structure.

Parameter selectedTN: The selected node.
Parameter isTwinCat3: Whether TwinCAT 3 packing should be used.
Returns: true when the DLL was created.

`M:IoT.Driver.TwinCATRx.Core.CodeGenerator.CreateDll(IoT.Driver.TwinCATRx.Core.INodeEmulator,System.String)`

public bool CreateDll(IoT.Driver.TwinCATRx.Core.INodeEmulator selectedTN, string fileName)

Creates a DLL using default generation settings.

Parameter selectedTN: The selectedTN value.
Parameter fileName: The fileName value.
Returns: A bool result.

`M:IoT.Driver.TwinCATRx.Core.CodeGenerator.CreateDll(IoT.Driver.TwinCATRx.Core.INodeEmulator,System.String,System.Boolean)`

public bool CreateDll(IoT.Driver.TwinCATRx.Core.INodeEmulator selectedTN, string fileName, bool isTwinCat3)

Creates a DLL using the default namespace.

Parameter selectedTN: The selectedTN value.
Parameter fileName: The fileName value.
Parameter isTwinCat3: The isTwinCat3 value.
Returns: A bool result.

`M:IoT.Driver.TwinCATRx.Core.CodeGenerator.CreateDll(IoT.Driver.TwinCATRx.Core.INodeEmulator,System.String,System.Boolean,System.String)`

public bool CreateDll(IoT.Driver.TwinCATRx.Core.INodeEmulator selectedTN, string fileName, bool isTwinCat3, string classNamespace)

Creates a DLL based on the selected node structure.

Parameter selectedTN: The selected tn.
Parameter fileName: Name of the file.
Parameter isTwinCat3: if set to true [is twincat3].
Parameter classNamespace: The class namespace.
Returns: Result as a Boolean.

`M:IoT.Driver.TwinCATRx.Core.CodeGenerator.CreateDll(System.String,System.String)`

public bool CreateDll(string sourceCode, string fileName)

Creates the DLL from raw source.

Parameter sourceCode: The C# source code.
Parameter fileName: Name of the file.
Returns: A Value.

`M:IoT.Driver.TwinCATRx.Core.CodeGenerator.Dispose`

public void Dispose()

Performs application-defined tasks associated with freeing resources.

`M:IoT.Driver.TwinCATRx.Core.CodeGenerator.LoadSymbols(System.Int32)`

public System.Collections.Generic.HashSet<IoT.Driver.TwinCATRx.Core.INodeEmulator> LoadSymbols(int port)

Loads symbols from the specified PLC ADS port.

Parameter port: The port.
Returns: A Value.

`M:IoT.Driver.TwinCATRx.Core.CodeGenerator.LoadSymbols(System.String)`

public System.Collections.Generic.HashSet<IoT.Driver.TwinCATRx.Core.INodeEmulator> LoadSymbols(string adsAddress)

Loads symbols from the specified PLC ADS address.

Parameter adsAddress: The ADS address.
Returns: HashSet(Of NodeEmulator).

`M:IoT.Driver.TwinCATRx.Core.CodeGenerator.LoadSymbols(System.String,System.Int32)`

public System.Collections.Generic.HashSet<IoT.Driver.TwinCATRx.Core.INodeEmulator> LoadSymbols(string adsAddress, int port)

Loads symbols from the specified PLC ADS address and port.

Parameter adsAddress: The ADS address.
Parameter port: The port.
Returns: HashSet(Of NodeEmulator).

`M:IoT.Driver.TwinCATRx.Core.CodeGenerator.PLCToCSharpTypeConverter(System.String)`

public static string PLCToCSharpTypeConverter(string plcType)

Converts a supported PLC scalar, string, or array type name to its CLR representation.

Parameter plcType: Type of the PLC.
Returns: A Value.

`M:IoT.Driver.TwinCATRx.Core.CodeGenerator.ReadSymbol(System.String,System.Int32,System.String,System.Type)`

public object ReadSymbol(string adsAddress, int port, string variable, System.Type variableType)

Reads the symbol.

Parameter adsAddress: The ADS address.
Parameter port: The port.
Parameter variable: The variable.
Parameter variableType: Type of the variable.
Returns: A Value.

`M:IoT.Driver.TwinCATRx.Core.CodeGenerator.SearchSymbols(System.String)`

public IoT.Driver.TwinCATRx.Core.INodeEmulator SearchSymbols(string symbolName)

Searches for the nearest matching symbol list element.

Parameter symbolName: Name of the symbol.
Returns: NodeEmulator.

`P:IoT.Driver.TwinCATRx.Core.CodeGenerator.SymbolList`

public System.Collections.Generic.HashSet<IoT.Driver.TwinCATRx.Core.INodeEmulator> SymbolList { get; }

Gets the symbol list.

Value: The symbol list.

`T:IoT.Driver.TwinCATRx.Core.DirectoryInfoExtensions`

public class IoT.Driver.TwinCATRx.Core.DirectoryInfoExtensions

Provides filtered file enumeration extensions for T:System.IO.DirectoryInfo .

Declared public members

`M:IoT.Driver.TwinCATRx.Core.DirectoryInfoExtensions.GetFilesWhere(System.IO.DirectoryInfo,System.Func`2{System.IO.FileInfo,System.Boolean})`

public static System.IO.FileInfo[] GetFilesWhere(System.IO.DirectoryInfo directory, System.Func<System.IO.FileInfo, bool> predicate)

Executes the GetFilesWhere operation.

Parameter directory: The directory value.
Parameter predicate: The predicate value.
Returns: A System.IO.FileInfo[] result.

`M:IoT.Driver.TwinCATRx.Core.DirectoryInfoExtensions.GetFilesWhere(System.IO.DirectoryInfo,System.String,System.Func`2{System.IO.FileInfo,System.Boolean})`

public static System.IO.FileInfo[] GetFilesWhere(System.IO.DirectoryInfo directory, string searchPattern, System.Func<System.IO.FileInfo, bool> predicate)

Executes the GetFilesWhere operation.

Parameter directory: The directory value.
Parameter searchPattern: The searchPattern value.
Parameter predicate: The predicate value.
Returns: A System.IO.FileInfo[] result.

`M:IoT.Driver.TwinCATRx.Core.DirectoryInfoExtensions.GetFilesWhere(System.IO.DirectoryInfo,System.String,System.IO.SearchOption,System.Func`2{System.IO.FileInfo,System.Boolean})`

public static System.IO.FileInfo[] GetFilesWhere(System.IO.DirectoryInfo directory, string searchPattern, System.IO.SearchOption searchOption, System.Func<System.IO.FileInfo, bool> predicate)

Executes the GetFilesWhere operation.

Parameter directory: The directory value.
Parameter searchPattern: The searchPattern value.
Parameter searchOption: The searchOption value.
Parameter predicate: The predicate value.
Returns: A System.IO.FileInfo[] result.

`M:IoT.Driver.TwinCATRx.Core.DirectoryInfoExtensions.GetFilesWhere(System.IO.DirectoryInfo,System.String[],System.Func`2{System.IO.FileInfo,System.Boolean})`

public static System.IO.FileInfo[] GetFilesWhere(System.IO.DirectoryInfo directory, string[] searchPatterns, System.Func<System.IO.FileInfo, bool> predicate)

Executes the GetFilesWhere operation.

Parameter directory: The directory value.
Parameter searchPatterns: The searchPatterns value.
Parameter predicate: The predicate value.
Returns: A System.IO.FileInfo[] result.

`M:IoT.Driver.TwinCATRx.Core.DirectoryInfoExtensions.GetFilesWhere(System.IO.DirectoryInfo,System.String[],System.IO.SearchOption,System.Func`2{System.IO.FileInfo,System.Boolean})`

public static System.IO.FileInfo[] GetFilesWhere(System.IO.DirectoryInfo directory, string[] searchPatterns, System.IO.SearchOption searchOption, System.Func<System.IO.FileInfo, bool> predicate)

Executes the GetFilesWhere operation.

Parameter directory: The directory value.
Parameter searchPatterns: The searchPatterns value.
Parameter searchOption: The searchOption value.
Parameter predicate: The predicate value.
Returns: A System.IO.FileInfo[] result.

`T:IoT.Driver.TwinCATRx.Core.ICodeGenerator`

public interface IoT.Driver.TwinCATRx.Core.ICodeGenerator

Interface for Code Generator.

Declared public members

`M:IoT.Driver.TwinCATRx.Core.ICodeGenerator.CreateCSharpCode(IoT.Driver.TwinCATRx.Core.INodeEmulator)`

public bool CreateCSharpCode(IoT.Driver.TwinCATRx.Core.INodeEmulator selectedTN)

Creates the c sharp code.

Parameter selectedTN: The selected tn.
Returns: A Value.

`M:IoT.Driver.TwinCATRx.Core.ICodeGenerator.CreateCSharpCode(IoT.Driver.TwinCATRx.Core.INodeEmulator,System.Boolean)`

public bool CreateCSharpCode(IoT.Driver.TwinCATRx.Core.INodeEmulator selectedTN, bool isTwinCat3)

Creates the c sharp code.

Parameter selectedTN: The selected tn.
Parameter isTwinCat3: Whether TwinCAT 3 conventions are used.
Returns: A Value.

`M:IoT.Driver.TwinCATRx.Core.ICodeGenerator.CreateCSharpCode(IoT.Driver.TwinCATRx.Core.INodeEmulator,System.String)`

public bool CreateCSharpCode(IoT.Driver.TwinCATRx.Core.INodeEmulator selectedTN, string fileName)

Creates the c sharp code.

Parameter selectedTN: The selected tn.
Parameter fileName: Name of the file.
Returns: A Value.

`M:IoT.Driver.TwinCATRx.Core.ICodeGenerator.CreateCSharpCode(IoT.Driver.TwinCATRx.Core.INodeEmulator,System.String,System.Boolean)`

public bool CreateCSharpCode(IoT.Driver.TwinCATRx.Core.INodeEmulator selectedTN, string fileName, bool isTwinCat3)

Creates the c sharp code.

Parameter selectedTN: The selected tn.
Parameter fileName: Name of the file.
Parameter isTwinCat3: if set to true [is twin cat3].
Returns: A Value.

`M:IoT.Driver.TwinCATRx.Core.ICodeGenerator.CreateCSharpCode(IoT.Driver.TwinCATRx.Core.INodeEmulator,System.String,System.Boolean,System.String)`

public bool CreateCSharpCode(IoT.Driver.TwinCATRx.Core.INodeEmulator selectedTN, string fileName, bool isTwinCat3, string classNamespace)

Creates the c sharp code.

Parameter selectedTN: The selected tn.
Parameter fileName: Name of the file.
Parameter isTwinCat3: Whether TwinCAT 3 conventions are used.
Parameter classNamespace: The namespace for generated types.
Returns: A Value.

`M:IoT.Driver.TwinCATRx.Core.ICodeGenerator.CreateCSharpCodeString(IoT.Driver.TwinCATRx.Core.INodeEmulator)`

public string CreateCSharpCodeString(IoT.Driver.TwinCATRx.Core.INodeEmulator selectedTN)

Creates the c sharp code string.

Parameter selectedTN: The selected tn.
Returns: A Value.

`M:IoT.Driver.TwinCATRx.Core.ICodeGenerator.CreateCSharpCodeString(IoT.Driver.TwinCATRx.Core.INodeEmulator,System.Boolean)`

public string CreateCSharpCodeString(IoT.Driver.TwinCATRx.Core.INodeEmulator selectedTN, bool isTwinCat3)

Creates the c sharp code string.

Parameter selectedTN: The selected tn.
Parameter isTwinCat3: if set to true [is twin cat3].
Returns: A Value.

`M:IoT.Driver.TwinCATRx.Core.ICodeGenerator.CreateCSharpCodeString(IoT.Driver.TwinCATRx.Core.INodeEmulator,System.Boolean,System.String)`

public string CreateCSharpCodeString(IoT.Driver.TwinCATRx.Core.INodeEmulator selectedTN, bool isTwinCat3, string classNamespace)

Creates the c sharp code string.

Parameter selectedTN: The selected tn.
Parameter isTwinCat3: Whether TwinCAT 3 conventions are used.
Parameter classNamespace: The namespace for generated types.
Returns: A Value.

`M:IoT.Driver.TwinCATRx.Core.ICodeGenerator.CreateDll(IoT.Driver.TwinCATRx.Core.INodeEmulator)`

public bool CreateDll(IoT.Driver.TwinCATRx.Core.INodeEmulator selectedTN)

Creates the DLL.

Parameter selectedTN: The selected tn.
Returns: A Value.

`M:IoT.Driver.TwinCATRx.Core.ICodeGenerator.CreateDll(IoT.Driver.TwinCATRx.Core.INodeEmulator,System.Boolean)`

public bool CreateDll(IoT.Driver.TwinCATRx.Core.INodeEmulator selectedTN, bool isTwinCat3)

Creates the DLL.

Parameter selectedTN: The selected tn.
Parameter isTwinCat3: Whether TwinCAT 3 conventions are used.
Returns: A Value.

`M:IoT.Driver.TwinCATRx.Core.ICodeGenerator.CreateDll(IoT.Driver.TwinCATRx.Core.INodeEmulator,System.String)`

public bool CreateDll(IoT.Driver.TwinCATRx.Core.INodeEmulator selectedTN, string fileName)

Creates the DLL.

Parameter selectedTN: The selected tn.
Parameter fileName: Name of the file.
Returns: A Value.

`M:IoT.Driver.TwinCATRx.Core.ICodeGenerator.CreateDll(IoT.Driver.TwinCATRx.Core.INodeEmulator,System.String,System.Boolean)`

public bool CreateDll(IoT.Driver.TwinCATRx.Core.INodeEmulator selectedTN, string fileName, bool isTwinCat3)

Creates the DLL.

Parameter selectedTN: The selected tn.
Parameter fileName: Name of the file.
Parameter isTwinCat3: if set to true [is twin cat3].
Returns: A Value.

`M:IoT.Driver.TwinCATRx.Core.ICodeGenerator.CreateDll(IoT.Driver.TwinCATRx.Core.INodeEmulator,System.String,System.Boolean,System.String)`

public bool CreateDll(IoT.Driver.TwinCATRx.Core.INodeEmulator selectedTN, string fileName, bool isTwinCat3, string classNamespace)

Creates the DLL.

Parameter selectedTN: The selected tn.
Parameter fileName: Name of the file.
Parameter isTwinCat3: Whether TwinCAT 3 conventions are used.
Parameter classNamespace: The namespace for generated types.
Returns: A Value.

`M:IoT.Driver.TwinCATRx.Core.ICodeGenerator.CreateDll(System.String,System.String)`

public bool CreateDll(string sourceCode, string fileName)

Creates the DLL.

Parameter sourceCode: The C# source code.
Parameter fileName: Name of the file.
Returns: A Value.

`M:IoT.Driver.TwinCATRx.Core.ICodeGenerator.LoadSymbols(System.Int32)`

public System.Collections.Generic.HashSet<IoT.Driver.TwinCATRx.Core.INodeEmulator> LoadSymbols(int port)

Loads the symbols.

Parameter port: The port.
Returns: A Value.

`M:IoT.Driver.TwinCATRx.Core.ICodeGenerator.LoadSymbols(System.String)`

public System.Collections.Generic.HashSet<IoT.Driver.TwinCATRx.Core.INodeEmulator> LoadSymbols(string adsAddress)

Loads the symbols.

Parameter adsAddress: The ADS address.
Returns: A Value.

`M:IoT.Driver.TwinCATRx.Core.ICodeGenerator.LoadSymbols(System.String,System.Int32)`

public System.Collections.Generic.HashSet<IoT.Driver.TwinCATRx.Core.INodeEmulator> LoadSymbols(string adsAddress, int port)

Loads the symbols.

Parameter adsAddress: The ADS address.
Parameter port: The port.
Returns: A Value.

`M:IoT.Driver.TwinCATRx.Core.ICodeGenerator.ReadSymbol(System.String,System.Int32,System.String,System.Type)`

public object ReadSymbol(string adsAddress, int port, string variable, System.Type variableType)

Reads the symbol.

Parameter adsAddress: The ADS address.
Parameter port: The port.
Parameter variable: The variable.
Parameter variableType: Type of the variable.
Returns: A Value.

`M:IoT.Driver.TwinCATRx.Core.ICodeGenerator.SearchSymbols(System.String)`

public IoT.Driver.TwinCATRx.Core.INodeEmulator SearchSymbols(string symbolName)

Searches the symbols.

Parameter symbolName: Name of the symbol.
Returns: A Value.

`P:IoT.Driver.TwinCATRx.Core.ICodeGenerator.SymbolList`

public System.Collections.Generic.HashSet<IoT.Driver.TwinCATRx.Core.INodeEmulator> SymbolList { get; }

Gets the symbol list.

Value: The symbol list.

`T:IoT.Driver.TwinCATRx.Core.ILanguageService`

public interface IoT.Driver.TwinCATRx.Core.ILanguageService

I Language Service.

Declared public members

`M:IoT.Driver.TwinCATRx.Core.ILanguageService.CreateLibraryCompilation(System.String,System.Boolean)`

public Microsoft.CodeAnalysis.Compilation CreateLibraryCompilation(string assemblyName, bool enableOptimisations)

Creates the library compilation.

Parameter assemblyName: Name of the assembly.
Parameter enableOptimisations: if set to true [enable optimisations].
Returns: A Compilation.

`M:IoT.Driver.TwinCATRx.Core.ILanguageService.ParseText(System.String,Microsoft.CodeAnalysis.SourceCodeKind)`

public Microsoft.CodeAnalysis.SyntaxTree ParseText(string code, Microsoft.CodeAnalysis.SourceCodeKind kind)

Parses the text.

Parameter code: The code.
Parameter kind: The kind.
Returns: A SyntaxTree.

`T:IoT.Driver.TwinCATRx.Core.INodeEmulator`

public interface IoT.Driver.TwinCATRx.Core.INodeEmulator

Interface for Node Emulator.

Declared public members

`P:IoT.Driver.TwinCATRx.Core.INodeEmulator.Nodes`

public System.Collections.Generic.HashSet<IoT.Driver.TwinCATRx.Core.INodeEmulator> Nodes { get; }

Gets the nodes.

Value: The nodes.

`P:IoT.Driver.TwinCATRx.Core.INodeEmulator.Tag`

public object Tag { get; set; }

Gets or sets the tag.

Value: The tag.

`P:IoT.Driver.TwinCATRx.Core.INodeEmulator.Text`

public string Text { get; set; }

Gets or sets the text.

Value: The text.

`T:IoT.Driver.TwinCATRx.Core.INotification`

public interface IoT.Driver.TwinCATRx.Core.INotification

Interface for Notification.

Declared public members

`P:IoT.Driver.TwinCATRx.Core.INotification.ArraySize`

public int ArraySize { get; }

Gets the size of the array.

Value: The size of the array.

`P:IoT.Driver.TwinCATRx.Core.INotification.UpdateRate`

public int UpdateRate { get; }

Gets the update rate.

Value: The update rate.

`P:IoT.Driver.TwinCATRx.Core.INotification.Variable`

public string Variable { get; }

Gets the variable.

Value: The variable.

`T:IoT.Driver.TwinCATRx.Core.ISettings`

public interface IoT.Driver.TwinCATRx.Core.ISettings

Interface for engine settings.

Declared public members

M:IoT.Driver.TwinCATRx.Core.ISettings.Defaults``1(``0)

public T Defaults<T>(T defaultSettings)

Gets or sets Default settings.

Parameter defaultSettings: The settings instance that establishes the requested type.
Returns: Default values of type T.

`P:IoT.Driver.TwinCATRx.Core.ISettings.AdsAddress`

public string AdsAddress { get; set; }

Gets or sets the ads address.

Value: The ads address.

`P:IoT.Driver.TwinCATRx.Core.ISettings.Notifications`

public System.Collections.Generic.IList<IoT.Driver.TwinCATRx.Core.INotification> Notifications { get; }

Gets or sets Notifications of this Engine.

Value: The Notifications value.

`P:IoT.Driver.TwinCATRx.Core.ISettings.Port`

public int Port { get; set; }

Gets or sets the port.

Value: The port.

`P:IoT.Driver.TwinCATRx.Core.ISettings.SettingsId`

public string SettingsId { get; set; }

Gets or sets System Identifier.

Value: The SettingsId value.

`P:IoT.Driver.TwinCATRx.Core.ISettings.WriteVariables`

public System.Collections.Generic.IList<IoT.Driver.TwinCATRx.Core.IWriteVariable> WriteVariables { get; }

Gets or sets Write variables to this Engine.

Value: The WriteVariables value.

`T:IoT.Driver.TwinCATRx.Core.IWriteVariable`

public interface IoT.Driver.TwinCATRx.Core.IWriteVariable

Interface for Write Variable.

Declared public members

`P:IoT.Driver.TwinCATRx.Core.IWriteVariable.ArraySize`

public int ArraySize { get; }

Gets the size of the array.

Value: The size of the array.

`P:IoT.Driver.TwinCATRx.Core.IWriteVariable.Variable`

public string Variable { get; }

Gets the variable.

Value: The variable.

`T:IoT.Driver.TwinCATRx.Core.Settings`

public class IoT.Driver.TwinCATRx.Core.Settings

Base settings for Engine Settings file.

Declared public members

`M:IoT.Driver.TwinCATRx.Core.Settings.#ctor`

public IoT.Driver.TwinCATRx.Core.Settings()

Initializes a new instance of IoT.Driver.TwinCATRx.Core.Settings.

M:IoT.Driver.TwinCATRx.Core.Settings.Defaults``1(``0)

public T Defaults<T>(T defaultSettings)

Creates default settings when no persisted file exists.

Parameter defaultSettings: The settings instance that establishes the requested type.
Returns: The default settings.

`P:IoT.Driver.TwinCATRx.Core.Settings.AdsAddress`

public string AdsAddress { get; set; }

Gets or sets the Ads Address.

Value: The AdsAddress value.

`P:IoT.Driver.TwinCATRx.Core.Settings.Notifications`

public System.Collections.Generic.List<IoT.Driver.TwinCATRx.Core.INotification> Notifications { get; set; }

Gets or sets Notifications of this Engine.

Value: The Notifications value.

`P:IoT.Driver.TwinCATRx.Core.Settings.Port`

public int Port { get; set; }

Gets or sets the Port of the PLC to connect to.

Value: The Port value.

`P:IoT.Driver.TwinCATRx.Core.Settings.SettingsId`

public string SettingsId { get; set; }

Gets or sets System Identifier.

Value: The SettingsId value.

`P:IoT.Driver.TwinCATRx.Core.Settings.WriteVariables`

public System.Collections.Generic.List<IoT.Driver.TwinCATRx.Core.IWriteVariable> WriteVariables { get; set; }

Gets or sets Write variables to this Engine.

Value: The WriteVariables value.

`T:IoT.Driver.TwinCATRx.Core.SimpleTypeException`

public class IoT.Driver.TwinCATRx.Core.SimpleTypeException

Exception thrown when a simple type is not supported.

Declared public members

`M:IoT.Driver.TwinCATRx.Core.SimpleTypeException.#ctor`

public IoT.Driver.TwinCATRx.Core.SimpleTypeException()

Initializes a new instance of the T:IoT.Driver.TwinCATRx.Core.SimpleTypeException class.

`M:IoT.Driver.TwinCATRx.Core.SimpleTypeException.#ctor(System.String)`

public IoT.Driver.TwinCATRx.Core.SimpleTypeException(string message)

Initializes a new instance of the T:IoT.Driver.TwinCATRx.Core.SimpleTypeException class.

Parameter message: The message that describes the error.

`M:IoT.Driver.TwinCATRx.Core.SimpleTypeException.#ctor(System.String,System.Exception)`

public IoT.Driver.TwinCATRx.Core.SimpleTypeException(string message, System.Exception innerException)

Initializes a new instance of the T:IoT.Driver.TwinCATRx.Core.SimpleTypeException class.

Parameter message: The error message that explains the reason for the exception.
Parameter innerException: The exception that caused this exception, or null when no inner exception is specified.

`T:IoT.Driver.TwinCATRx.Core.TwinCatRxExtensions`

public class IoT.Driver.TwinCATRx.Core.TwinCatRxExtensions

Observable TwinCAT extensions.

Declared public members

`M:IoT.Driver.TwinCATRx.Core.TwinCatRxExtensions.AddNotification(IoT.Driver.TwinCATRx.Core.ISettings,System.String)`

public static void AddNotification(IoT.Driver.TwinCATRx.Core.ISettings settings, string variableName)

Adds a notification variable to the settings.

Parameter settings: The TwinCAT settings.
Parameter variableName: The PLC variable name.

`M:IoT.Driver.TwinCATRx.Core.TwinCatRxExtensions.AddNotification(IoT.Driver.TwinCATRx.Core.ISettings,System.String,System.Int32)`

public static void AddNotification(IoT.Driver.TwinCATRx.Core.ISettings settings, string variableName, int cycleTime)

Adds a notification variable to the settings.

Parameter settings: The TwinCAT settings.
Parameter variableName: The PLC variable name.
Parameter cycleTime: The polling cycle time.

`M:IoT.Driver.TwinCATRx.Core.TwinCatRxExtensions.AddNotification(IoT.Driver.TwinCATRx.Core.ISettings,System.String,System.Int32,System.Int32)`

public static void AddNotification(IoT.Driver.TwinCATRx.Core.ISettings settings, string variableName, int cycleTime, int arraySize)

Adds a notification variable to the settings.

Parameter settings: The TwinCAT settings.
Parameter variableName: The PLC variable name.
Parameter cycleTime: The polling cycle time.
Parameter arraySize: The array size.

`M:IoT.Driver.TwinCATRx.Core.TwinCatRxExtensions.AddWriteVariable(IoT.Driver.TwinCATRx.Core.ISettings,System.String)`

public static void AddWriteVariable(IoT.Driver.TwinCATRx.Core.ISettings settings, string variableName)

Adds a write variable to the settings.

Parameter settings: The TwinCAT settings.
Parameter variableName: The PLC variable name.

`M:IoT.Driver.TwinCATRx.Core.TwinCatRxExtensions.AddWriteVariable(IoT.Driver.TwinCATRx.Core.ISettings,System.String,System.Int32)`

public static void AddWriteVariable(IoT.Driver.TwinCATRx.Core.ISettings settings, string variableName, int arraySize)

Adds a write variable to the settings.

Parameter settings: The TwinCAT settings.
Parameter variableName: The PLC variable name.
Parameter arraySize: The array size.

`M:IoT.Driver.TwinCATRx.Core.TwinCatRxExtensions.AdsStateChangedObserver(TwinCAT.Ads.AdsClient)`

public static System.IObservable<TwinCAT.Ads.AdsStateChangedEventArgs> AdsStateChangedObserver(TwinCAT.Ads.AdsClient client)

Observes ADS state changed events.

Parameter client: The ADS client.
Returns: The ADS state changed observable sequence.

`M:IoT.Driver.TwinCATRx.Core.TwinCatRxExtensions.AdsStateObserver(TwinCAT.Ads.AdsClient)`

public static System.IObservable<TwinCAT.Ads.StateInfo> AdsStateObserver(TwinCAT.Ads.AdsClient client)

Polls ADS state from the client.

Parameter client: The ADS client.
Returns: The ADS state observable sequence.

`M:IoT.Driver.TwinCATRx.Core.TwinCatRxExtensions.AssemblyLoad(System.String)`

public static System.Reflection.Assembly AssemblyLoad(string dllFullName)

Loads an assembly from a DLL file path.

Parameter dllFullName: The full DLL path.
Returns: The loaded assembly.

`M:IoT.Driver.TwinCATRx.Core.TwinCatRxExtensions.GetType(System.String,System.String)`

public static System.Type GetType(string dllFullName, string engineType)

Gets a type from an assembly file.

Parameter dllFullName: The full DLL path.
Parameter engineType: The type name.
Returns: The resolved type.

M:IoT.Driver.TwinCATRx.Core.TwinCatRxExtensions.OnErrorRetry``1(System.IObservable1{``0})`

public static System.IObservable<TSource> OnErrorRetry<TSource>(System.IObservable<TSource> source)

Executes the OnErrorRetry operation.

Parameter source: The source value.
Returns: A System.IObservable<TSource> result.

M:IoT.Driver.TwinCATRx.Core.TwinCatRxExtensions.OnErrorRetry``2(System.IObservable1{0},System.Action`1{1})`

public static System.IObservable<TSource> OnErrorRetry<TSource, TException>(System.IObservable<TSource> source, System.Action<TException> onError)

Executes the OnErrorRetry operation.

Parameter source: The source value.
Parameter onError: The onError value.
Returns: A System.IObservable<TSource> result.

M:IoT.Driver.TwinCATRx.Core.TwinCatRxExtensions.OnErrorRetry``2(System.IObservable1{0},System.Action`1{1},System.Int32)`

public static System.IObservable<TSource> OnErrorRetry<TSource, TException>(System.IObservable<TSource> source, System.Action<TException> onError, int retryCount)

Executes the OnErrorRetry operation.

Parameter source: The source value.
Parameter onError: The onError value.
Parameter retryCount: The retryCount value.
Returns: A System.IObservable<TSource> result.

M:IoT.Driver.TwinCATRx.Core.TwinCatRxExtensions.OnErrorRetry``2(System.IObservable1{0},System.Action`1{1},System.Int32,System.TimeSpan)`

public static System.IObservable<TSource> OnErrorRetry<TSource, TException>(System.IObservable<TSource> source, System.Action<TException> onError, int retryCount, System.TimeSpan delay)

Executes the OnErrorRetry operation.

Parameter source: The source value.
Parameter onError: The onError value.
Parameter retryCount: The retryCount value.
Parameter delay: The delay value.
Returns: A System.IObservable<TSource> result.

M:IoT.Driver.TwinCATRx.Core.TwinCatRxExtensions.OnErrorRetry``2(System.IObservable1{0},System.Action`1{1},System.Int32,System.TimeSpan,ReactiveUI.Primitives.Concurrency.ISequencer)`

public static System.IObservable<TSource> OnErrorRetry<TSource, TException>(System.IObservable<TSource> source, System.Action<TException> onError, int retryCount, System.TimeSpan delay, ReactiveUI.Primitives.Concurrency.ISequencer delaySequencer)

Executes the OnErrorRetry operation.

Parameter source: The source value.
Parameter onError: The onError value.
Parameter retryCount: The retryCount value.
Parameter delay: The delay value.
Parameter delaySequencer: The delaySequencer value.
Returns: A System.IObservable<TSource> result.

M:IoT.Driver.TwinCATRx.Core.TwinCatRxExtensions.OnErrorRetry``2(System.IObservable1{0},System.Action`1{1},System.TimeSpan)`

public static System.IObservable<TSource> OnErrorRetry<TSource, TException>(System.IObservable<TSource> source, System.Action<TException> onError, System.TimeSpan delay)

Executes the OnErrorRetry operation.

Parameter source: The source value.
Parameter onError: The onError value.
Parameter delay: The delay value.
Returns: A System.IObservable<TSource> result.

`T:IoT.Driver.TwinCATRx.Core.UnsuportedTypeException`

public class IoT.Driver.TwinCATRx.Core.UnsuportedTypeException

Exception thrown when a simple type is not supported.

Declared public members

`M:IoT.Driver.TwinCATRx.Core.UnsuportedTypeException.#ctor`

public IoT.Driver.TwinCATRx.Core.UnsuportedTypeException()

Initializes a new instance of the T:IoT.Driver.TwinCATRx.Core.UnsuportedTypeException class.

`M:IoT.Driver.TwinCATRx.Core.UnsuportedTypeException.#ctor(System.String)`

public IoT.Driver.TwinCATRx.Core.UnsuportedTypeException(string message)

Initializes a new instance of the T:IoT.Driver.TwinCATRx.Core.UnsuportedTypeException class.

Parameter message: The message that describes the error.

`M:IoT.Driver.TwinCATRx.Core.UnsuportedTypeException.#ctor(System.String,System.Exception)`

public IoT.Driver.TwinCATRx.Core.UnsuportedTypeException(string message, System.Exception innerException)

Initializes a new instance of the T:IoT.Driver.TwinCATRx.Core.UnsuportedTypeException class.

Parameter message: The error message that explains the reason for the exception.
Parameter innerException: The exception that caused this exception, or null when no inner exception is specified.

Product	Compatible and additional computed target framework versions.
.NET	net8.0 is compatible. 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. net8.0-windows10.0.19041 is compatible. net9.0 is compatible. net9.0-android was computed. net9.0-browser was computed. net9.0-ios was computed. net9.0-maccatalyst was computed. net9.0-macos was computed. net9.0-tvos was computed. net9.0-windows was computed. net9.0-windows10.0.19041 is compatible. net10.0 is compatible. net10.0-android was computed. net10.0-browser was computed. net10.0-ios was computed. net10.0-maccatalyst was computed. net10.0-macos was computed. net10.0-tvos was computed. net10.0-windows was computed. net10.0-windows10.0.19041 is compatible. net11.0 is compatible. net11.0-windows10.0.19041 is compatible.
.NET Framework	net462 is compatible. net463 was computed. net47 was computed. net471 was computed. net472 is compatible. net48 is compatible. net481 is compatible.

Product

.NET

.NET Framework

Compatible target framework(s)

Included target framework(s) (in package)

Learn more about Target Frameworks and .NET Standard.

.NETFramework 4.6.2
- HashTableRx.Reactive (>= 4.0.0)
- IoT-Driver.Core (>= 1.0.2)
- IoT-Driver.TwinCATRx.Core.Reactive (>= 1.0.2)
- ReactiveUI.Primitives.Async.Reactive (>= 7.1.0)
- ReactiveUI.Primitives.Reactive (>= 7.1.0)
.NETFramework 4.7.2
- HashTableRx.Reactive (>= 4.0.0)
- IoT-Driver.Core (>= 1.0.2)
- IoT-Driver.TwinCATRx.Core.Reactive (>= 1.0.2)
- ReactiveUI.Primitives.Async.Reactive (>= 7.1.0)
- ReactiveUI.Primitives.Reactive (>= 7.1.0)
.NETFramework 4.8
- HashTableRx.Reactive (>= 4.0.0)
- IoT-Driver.Core (>= 1.0.2)
- IoT-Driver.TwinCATRx.Core.Reactive (>= 1.0.2)
- ReactiveUI.Primitives.Async.Reactive (>= 7.1.0)
- ReactiveUI.Primitives.Reactive (>= 7.1.0)
.NETFramework 4.8.1
- HashTableRx.Reactive (>= 4.0.0)
- IoT-Driver.Core (>= 1.0.2)
- IoT-Driver.TwinCATRx.Core.Reactive (>= 1.0.2)
- ReactiveUI.Primitives.Async.Reactive (>= 7.1.0)
- ReactiveUI.Primitives.Reactive (>= 7.1.0)
net10.0
- HashTableRx.Reactive (>= 4.0.0)
- IoT-Driver.Core (>= 1.0.2)
- IoT-Driver.TwinCATRx.Core.Reactive (>= 1.0.2)
- ReactiveUI.Primitives.Async.Reactive (>= 7.1.0)
- ReactiveUI.Primitives.Reactive (>= 7.1.0)
net10.0-windows10.0.19041
- HashTableRx.Reactive (>= 4.0.0)
- IoT-Driver.Core (>= 1.0.2)
- IoT-Driver.TwinCATRx.Core.Reactive (>= 1.0.2)
- ReactiveUI.Primitives.Async.Reactive (>= 7.1.0)
- ReactiveUI.Primitives.Reactive (>= 7.1.0)
net11.0
- HashTableRx.Reactive (>= 4.0.0)
- IoT-Driver.Core (>= 1.0.2)
- IoT-Driver.TwinCATRx.Core.Reactive (>= 1.0.2)
- ReactiveUI.Primitives.Async.Reactive (>= 7.1.0)
- ReactiveUI.Primitives.Reactive (>= 7.1.0)
net11.0-windows10.0.19041
- HashTableRx.Reactive (>= 4.0.0)
- IoT-Driver.Core (>= 1.0.2)
- IoT-Driver.TwinCATRx.Core.Reactive (>= 1.0.2)
- ReactiveUI.Primitives.Async.Reactive (>= 7.1.0)
- ReactiveUI.Primitives.Reactive (>= 7.1.0)
net8.0
- HashTableRx.Reactive (>= 4.0.0)
- IoT-Driver.Core (>= 1.0.2)
- IoT-Driver.TwinCATRx.Core.Reactive (>= 1.0.2)
- ReactiveUI.Primitives.Async.Reactive (>= 7.1.0)
- ReactiveUI.Primitives.Reactive (>= 7.1.0)
net8.0-windows10.0.19041
- HashTableRx.Reactive (>= 4.0.0)
- IoT-Driver.Core (>= 1.0.2)
- IoT-Driver.TwinCATRx.Core.Reactive (>= 1.0.2)
- ReactiveUI.Primitives.Async.Reactive (>= 7.1.0)
- ReactiveUI.Primitives.Reactive (>= 7.1.0)
net9.0
- HashTableRx.Reactive (>= 4.0.0)
- IoT-Driver.Core (>= 1.0.2)
- IoT-Driver.TwinCATRx.Core.Reactive (>= 1.0.2)
- ReactiveUI.Primitives.Async.Reactive (>= 7.1.0)
- ReactiveUI.Primitives.Reactive (>= 7.1.0)
net9.0-windows10.0.19041
- HashTableRx.Reactive (>= 4.0.0)
- IoT-Driver.Core (>= 1.0.2)
- IoT-Driver.TwinCATRx.Core.Reactive (>= 1.0.2)
- ReactiveUI.Primitives.Async.Reactive (>= 7.1.0)
- ReactiveUI.Primitives.Reactive (>= 7.1.0)

NuGet packages (1)

Showing the top 1 NuGet packages that depend on IoT-Driver.TwinCATRx.Reactive:

Package	Downloads
MQTTnet.TwinCATRx.Reactive ReactiveUI.Primitives extensions for MQTTnet clients, brokers, and industrial device bridges	48

GitHub repositories

This package is not used by any popular GitHub repositories.

Version	Downloads	Last Updated
1.0.2	100	8/3/2026
1.0.1	133	8/1/2026
1.0.0	89	7/31/2026

Beckhoff TwinCAT ADS logical-tag communication, structured-variable access, reactive observation, and grouped bulk operations.

IoT-Driver.TwinCATRx.Reactive 1.0.2

TwinCATRx

Overview

Safety

Package matrix

Install

Quick start

Configuration

Detailed features

Connection lifecycle, events, errors, and disposal

Settings, ADS addressing, notifications, and handles

One-shot reads, correlated requests, writes, and pause windows

Typed observable and asynchronous-observable APIs

Structured variables and coordinated member writes

Logical tags, catalogs, persistence, and bulk workflows

In-memory ADS client and deterministic tests

Source-generated reactive stream and connection models

Core helpers, dynamic code generation, and service monitoring

Two combined production workflows

Correlated reads and async streams

Structures and paced writes

Test without an ADS runtime

Complete public API reference

Operational guidance

Troubleshooting

AI skill

Exhaustive public API reference

TwinCATRx

T:IoT.Driver.TwinCATRx.IObservableServiceController

Declared public members

M:IoT.Driver.TwinCATRx.IObservableServiceController.Restart

M:IoT.Driver.TwinCATRx.IObservableServiceController.Start

M:IoT.Driver.TwinCATRx.IObservableServiceController.Stop

P:IoT.Driver.TwinCATRx.IObservableServiceController.CanStop

P:IoT.Driver.TwinCATRx.IObservableServiceController.DisplayName

P:IoT.Driver.TwinCATRx.IObservableServiceController.ServiceName

P:IoT.Driver.TwinCATRx.IObservableServiceController.Status

P:IoT.Driver.TwinCATRx.IObservableServiceController.StatusObserver

T:IoT.Driver.TwinCATRx.IRxTcAdsClient

Declared public members

M:IoT.Driver.TwinCATRx.IRxTcAdsClient.Connect(IoT.Driver.TwinCATRx.Core.ISettings)

M:IoT.Driver.TwinCATRx.IRxTcAdsClient.Disconnect

M:IoT.Driver.TwinCATRx.IRxTcAdsClient.Pause(System.TimeSpan)

M:IoT.Driver.TwinCATRx.IRxTcAdsClient.Read(System.String)

M:IoT.Driver.TwinCATRx.IRxTcAdsClient.Read(System.String,System.Nullable1{System.Int32})`

M:IoT.Driver.TwinCATRx.IRxTcAdsClient.Read(System.String,System.Nullable1{System.Int32},System.String)`

M:IoT.Driver.TwinCATRx.IRxTcAdsClient.Read(System.String,System.String)

M:IoT.Driver.TwinCATRx.IRxTcAdsClient.Write(System.String,System.Object)

M:IoT.Driver.TwinCATRx.IRxTcAdsClient.Write(System.String,System.Object,System.String)

P:IoT.Driver.TwinCATRx.IRxTcAdsClient.Code

P:IoT.Driver.TwinCATRx.IRxTcAdsClient.DataReceived

P:IoT.Driver.TwinCATRx.IRxTcAdsClient.DataReceivedAsync

P:IoT.Driver.TwinCATRx.IRxTcAdsClient.ErrorReceived

P:IoT.Driver.TwinCATRx.IRxTcAdsClient.ErrorReceivedAsync

P:IoT.Driver.TwinCATRx.IRxTcAdsClient.InitializeComplete

P:IoT.Driver.TwinCATRx.IRxTcAdsClient.InitializeCompleteAsync

P:IoT.Driver.TwinCATRx.IRxTcAdsClient.IsDisposed

P:IoT.Driver.TwinCATRx.IRxTcAdsClient.IsPaused

P:IoT.Driver.TwinCATRx.IRxTcAdsClient.IsPausedObservable

P:IoT.Driver.TwinCATRx.IRxTcAdsClient.IsPausedObservableAsync

P:IoT.Driver.TwinCATRx.IRxTcAdsClient.OnWrite

P:IoT.Driver.TwinCATRx.IRxTcAdsClient.OnWriteAsync

P:IoT.Driver.TwinCATRx.IRxTcAdsClient.ReadWriteHandleInfo

P:IoT.Driver.TwinCATRx.IRxTcAdsClient.Settings

P:IoT.Driver.TwinCATRx.IRxTcAdsClient.WriteHandleInfo

T:IoT.Driver.TwinCATRx.InMemoryAdsClient

Declared public members

M:IoT.Driver.TwinCATRx.InMemoryAdsClient.#ctor

M:IoT.Driver.TwinCATRx.InMemoryAdsClient.Connect(IoT.Driver.TwinCATRx.Core.ISettings)

M:IoT.Driver.TwinCATRx.InMemoryAdsClient.Disconnect

M:IoT.Driver.TwinCATRx.InMemoryAdsClient.Dispose

M:IoT.Driver.TwinCATRx.InMemoryAdsClient.Pause(System.TimeSpan)

M:IoT.Driver.TwinCATRx.InMemoryAdsClient.PublishNotifications

M:IoT.Driver.TwinCATRx.InMemoryAdsClient.QueueFault(IoT.Driver.TwinCATRx.InMemoryAdsOperation,System.Exception)

M:IoT.Driver.TwinCATRx.InMemoryAdsClient.Read(System.String)

M:IoT.Driver.TwinCATRx.InMemoryAdsClient.Read(System.String,System.Nullable1{System.Int32})`

M:IoT.Driver.TwinCATRx.InMemoryAdsClient.Read(System.String,System.Nullable1{System.Int32},System.String)`

M:IoT.Driver.TwinCATRx.InMemoryAdsClient.Read(System.String,System.String)

M:IoT.Driver.TwinCATRx.InMemoryAdsClient.ReadMany(System.Collections.Generic.IEnumerable1{System.String})`

M:IoT.Driver.TwinCATRx.InMemoryAdsClient.ReadMany(System.Collections.Generic.IEnumerable1{System.String},System.String)`

`TwinCATRx`

`T:IoT.Driver.TwinCATRx.IObservableServiceController`

`M:IoT.Driver.TwinCATRx.IObservableServiceController.Restart`

`M:IoT.Driver.TwinCATRx.IObservableServiceController.Start`

`M:IoT.Driver.TwinCATRx.IObservableServiceController.Stop`

`P:IoT.Driver.TwinCATRx.IObservableServiceController.CanStop`

`P:IoT.Driver.TwinCATRx.IObservableServiceController.DisplayName`

`P:IoT.Driver.TwinCATRx.IObservableServiceController.ServiceName`

`P:IoT.Driver.TwinCATRx.IObservableServiceController.Status`

`P:IoT.Driver.TwinCATRx.IObservableServiceController.StatusObserver`

`T:IoT.Driver.TwinCATRx.IRxTcAdsClient`

`M:IoT.Driver.TwinCATRx.IRxTcAdsClient.Connect(IoT.Driver.TwinCATRx.Core.ISettings)`

`M:IoT.Driver.TwinCATRx.IRxTcAdsClient.Disconnect`

`M:IoT.Driver.TwinCATRx.IRxTcAdsClient.Pause(System.TimeSpan)`

`M:IoT.Driver.TwinCATRx.IRxTcAdsClient.Read(System.String)`

`M:IoT.Driver.TwinCATRx.IRxTcAdsClient.Read(System.String,System.Nullable`1{System.Int32})`

`M:IoT.Driver.TwinCATRx.IRxTcAdsClient.Read(System.String,System.Nullable`1{System.Int32},System.String)`

`M:IoT.Driver.TwinCATRx.IRxTcAdsClient.Read(System.String,System.String)`

`M:IoT.Driver.TwinCATRx.IRxTcAdsClient.Write(System.String,System.Object)`

`M:IoT.Driver.TwinCATRx.IRxTcAdsClient.Write(System.String,System.Object,System.String)`

`P:IoT.Driver.TwinCATRx.IRxTcAdsClient.Code`

`P:IoT.Driver.TwinCATRx.IRxTcAdsClient.DataReceived`

`P:IoT.Driver.TwinCATRx.IRxTcAdsClient.DataReceivedAsync`

`P:IoT.Driver.TwinCATRx.IRxTcAdsClient.ErrorReceived`

`P:IoT.Driver.TwinCATRx.IRxTcAdsClient.ErrorReceivedAsync`

`P:IoT.Driver.TwinCATRx.IRxTcAdsClient.InitializeComplete`

`P:IoT.Driver.TwinCATRx.IRxTcAdsClient.InitializeCompleteAsync`

`P:IoT.Driver.TwinCATRx.IRxTcAdsClient.IsDisposed`

`P:IoT.Driver.TwinCATRx.IRxTcAdsClient.IsPaused`

`P:IoT.Driver.TwinCATRx.IRxTcAdsClient.IsPausedObservable`

`P:IoT.Driver.TwinCATRx.IRxTcAdsClient.IsPausedObservableAsync`

`P:IoT.Driver.TwinCATRx.IRxTcAdsClient.OnWrite`

`P:IoT.Driver.TwinCATRx.IRxTcAdsClient.OnWriteAsync`

`P:IoT.Driver.TwinCATRx.IRxTcAdsClient.ReadWriteHandleInfo`

`P:IoT.Driver.TwinCATRx.IRxTcAdsClient.Settings`

`P:IoT.Driver.TwinCATRx.IRxTcAdsClient.WriteHandleInfo`

`T:IoT.Driver.TwinCATRx.InMemoryAdsClient`

`M:IoT.Driver.TwinCATRx.InMemoryAdsClient.#ctor`

`M:IoT.Driver.TwinCATRx.InMemoryAdsClient.Connect(IoT.Driver.TwinCATRx.Core.ISettings)`

`M:IoT.Driver.TwinCATRx.InMemoryAdsClient.Disconnect`

`M:IoT.Driver.TwinCATRx.InMemoryAdsClient.Dispose`

`M:IoT.Driver.TwinCATRx.InMemoryAdsClient.Pause(System.TimeSpan)`

`M:IoT.Driver.TwinCATRx.InMemoryAdsClient.PublishNotifications`

`M:IoT.Driver.TwinCATRx.InMemoryAdsClient.QueueFault(IoT.Driver.TwinCATRx.InMemoryAdsOperation,System.Exception)`

`M:IoT.Driver.TwinCATRx.InMemoryAdsClient.Read(System.String)`

`M:IoT.Driver.TwinCATRx.InMemoryAdsClient.Read(System.String,System.Nullable`1{System.Int32})`

`M:IoT.Driver.TwinCATRx.InMemoryAdsClient.Read(System.String,System.Nullable`1{System.Int32},System.String)`

`M:IoT.Driver.TwinCATRx.InMemoryAdsClient.Read(System.String,System.String)`

`M:IoT.Driver.TwinCATRx.InMemoryAdsClient.ReadMany(System.Collections.Generic.IEnumerable`1{System.String})`

`M:IoT.Driver.TwinCATRx.InMemoryAdsClient.ReadMany(System.Collections.Generic.IEnumerable`1{System.String},System.String)`

`M:IoT.Driver.TwinCATRx.InMemoryAdsClient.Reconnect`

`M:IoT.Driver.TwinCATRx.InMemoryAdsClient.RegisterSymbol(System.String,System.Object)`

`M:IoT.Driver.TwinCATRx.InMemoryAdsClient.RegisterSymbol(System.String,System.Object,System.Type)`

`M:IoT.Driver.TwinCATRx.InMemoryAdsClient.RegisterSymbol(System.String,System.Object,System.Type,System.Int32,System.Boolean,System.Boolean)`

`M:IoT.Driver.TwinCATRx.InMemoryAdsClient.RemoveSymbol(System.String)`

`M:IoT.Driver.TwinCATRx.InMemoryAdsClient.ResetOperationMetrics`

`M:IoT.Driver.TwinCATRx.InMemoryAdsClient.SetValue(System.String,System.Object)`

`M:IoT.Driver.TwinCATRx.InMemoryAdsClient.Write(System.String,System.Object)`

`M:IoT.Driver.TwinCATRx.InMemoryAdsClient.Write(System.String,System.Object,System.String)`

`M:IoT.Driver.TwinCATRx.InMemoryAdsClient.WriteMany(System.Collections.Generic.IEnumerable`1{System.Collections.Generic.KeyValuePair`2{System.String,System.Object}})`

`M:IoT.Driver.TwinCATRx.InMemoryAdsClient.WriteMany(System.Collections.Generic.IEnumerable`1{System.Collections.Generic.KeyValuePair`2{System.String,System.Object}},System.String)`

`P:IoT.Driver.TwinCATRx.InMemoryAdsClient.Code`

`P:IoT.Driver.TwinCATRx.InMemoryAdsClient.Connected`

`P:IoT.Driver.TwinCATRx.InMemoryAdsClient.ConnectionState`

`P:IoT.Driver.TwinCATRx.InMemoryAdsClient.ConnectionStates`

`P:IoT.Driver.TwinCATRx.InMemoryAdsClient.DataReceived`

`P:IoT.Driver.TwinCATRx.InMemoryAdsClient.DataReceivedAsync`

`P:IoT.Driver.TwinCATRx.InMemoryAdsClient.ErrorReceived`

`P:IoT.Driver.TwinCATRx.InMemoryAdsClient.ErrorReceivedAsync`

`P:IoT.Driver.TwinCATRx.InMemoryAdsClient.InitializeComplete`

`P:IoT.Driver.TwinCATRx.InMemoryAdsClient.InitializeCompleteAsync`

`P:IoT.Driver.TwinCATRx.InMemoryAdsClient.IsDisposed`

`P:IoT.Driver.TwinCATRx.InMemoryAdsClient.IsPaused`

`P:IoT.Driver.TwinCATRx.InMemoryAdsClient.IsPausedObservable`

`P:IoT.Driver.TwinCATRx.InMemoryAdsClient.IsPausedObservableAsync`

`P:IoT.Driver.TwinCATRx.InMemoryAdsClient.OnWrite`

`P:IoT.Driver.TwinCATRx.InMemoryAdsClient.OnWriteAsync`

`P:IoT.Driver.TwinCATRx.InMemoryAdsClient.OperationMetrics`

`P:IoT.Driver.TwinCATRx.InMemoryAdsClient.ReadWriteHandleInfo`

`P:IoT.Driver.TwinCATRx.InMemoryAdsClient.Settings`