S7PlcRx 1.3.3

dotnet add package S7PlcRx --version 1.3.3                
NuGet\Install-Package S7PlcRx -Version 1.3.3                
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="S7PlcRx" Version="1.3.3" />                
For projects that support PackageReference, copy this XML node into the project file to reference the package.
paket add S7PlcRx --version 1.3.3                
#r "nuget: S7PlcRx, 1.3.3"                
#r directive can be used in F# Interactive and Polyglot Notebooks. Copy this into the interactive tool or source code of the script to reference the package.
// Install S7PlcRx as a Cake Addin
#addin nuget:?package=S7PlcRx&version=1.3.3

// Install S7PlcRx as a Cake Tool
#tool nuget:?package=S7PlcRx&version=1.3.3                

License Build Nuget NuGet

Alt

<p align="left"> <a href="https://github.com/ChrisPulman/S7PlcRx"> <img alt="S7PlcRx" src="./Images/S7PlcRx.png" width="200"/> </a> </p>

S7PlcRx

Reactive S7 PLC Communications Library

Introduction

S7PlcRx is a library that provides a simple interface to communicate with Siemens S7 PLCs.

Features

  • Read and Write to PLC
  • Read from PLC with Reactive Subscription

Getting Started

Installation

S7PlcRx is available on NuGet.

In the Siemens PLC program you need to enable PUT/GET communication in the PLC settings. You will also need to set any DBs you want to access to be non-optimized.

Package Manager
Install-Package S7PlcRx
.NET CLI
dotnet add package S7PlcRx

Usage

Setup Tags and Observe values in PLC
using S7PlcRx;

var plc = new RxS7(S7PlcRx.Enums.CpuType.S71500, "PLC_IP_ADDRESS", 0, 5);
// Add Tag without Polling
plc.AddUpdateTagItem<double>("Tag0", "DB500.DBD0").SetTagPollIng(false);
// Add Tag with Polling
plc.AddUpdateTagItem<double>("Tag1", "DB500.DBD8");

plc.IsConnected
    .Where(x => x)
    .Take(1)
    .Subscribe(async _ =>
    {
        Console.WriteLine("Connected");

        // Read Tag Value manually
        var tag0 = await plc.Value<double>("Tag0");
    });

// Subscribe to Tag Values
plc.Observe<double>("Tag0").Subscribe(x => Console.WriteLine($"Tag0: {x}"));
plc.Observe<double>("Tag1").Subscribe(x => Console.WriteLine($"Tag1: {x}"));
// Start Polling on previously disabled Tag
plc?.GetTag("Tag0")?.SetTagPollIng(true);

You can also use the S7xxxx static classes to setup the PLC. For example, S7PlcRx.S71500.Create(...... to setup a S7-1500 PLC.

Add Tag without Generic Type
plc.AddUpdateTagItem(typeof(double), "Tag0", "DB500.DBD0");
Add Tag with Chainable Options
plc.AddUpdateTagItem<double>("Tag0", "DB500.DBD0").SetTagPollIng(false)
   .AddUpdateTagItem(typeof(double), "Tag1", "DB500.DBD8");
Remove Tag
plc.RemoveTagItem("Tag0");
SetPolling

Polling is enabled by default when a Tag is added. You can disable and enable polling on a Tag at any time.

// Create a new Tag and with no Polling
plc.AddUpdateTagItem<double>("Tag0", "DB500.DBD0").SetTagPollIng(false);

// Set Polling on Tag
plc?.GetTag("Tag0")?.SetTagPollIng(true);

// Stop Polling on Tag
plc?.GetTag("Tag0")?.SetTagPollIng(false);
Write to PLC
plc.Value<double>("Tag0", 1.0);
Read PLC CPU Info
// Get CPU Info from PLC Async
var cpuInfo = await plc.CpuInfo();

// Get CPU Info from PLC Reactive
plc.GetCpuInfo().Subscribe(info =>
    {
    });

This returns a CpuInfo string Array with the following values: AS Name, Module Name, Copyright, Serial Number, Module Type Name, Order Code, Version.

Using the Watchdog

The Watchdog is a feature that writes a value to a specific address in the PLC at a set interval. This can be used to keep the PLC alive and prevent it from going into stop mode.

The functionallity of the PLC is down to the user to implement.

The recommended way to use the Watchdog is to use a timer to decrement a value in the PLC. If the value reaches 0 then the PLC can be stopped. The Watchdog will always write a value back to the PLC to reset the timer and resume normal operation.

var plc = new RxS7(S7PlcRx.Enums.CpuType.S71500, "PLC_IP_ADDRESS", 0, watchDogAddress, 5, watchDogValueToWrite, watchDogInterval);

The Watchdog is disabled by default. To enable the Watchdog set the watchDogAddress, it must be an address of type DBW. The watchDogInterval is the time in seconds between each write and the watchDogValueToWrite is the value to write to the PLC.

Supported Data Types
  • Bool - DB?.DBX?.?
  • Byte - DB?.DBB?
  • Byte[] - DB?.DBB? set length to number of bytes when creating array tags - example AddUpdateTagItem<byte[]>(PlcData, "DB100.DBB0", 64) - creates a tag with 64 bytes
  • Int - DB?.DBW?
  • Int[] - DB?.DBW?
  • UInt - DB?.DBW?
  • UInt[] - DB?.DBW?
  • DInt - DB?.DBD?
  • DInt[] - DB?.DBD?
  • UDInt - DB?.DBD?
  • UDInt[] - DB?.DBD?
  • Real - DB?.DBD?
  • Real[] - DB?.DBD?
  • LReal - DB?.DBD?
  • LReal[] - DB?.DBD?
  • String - TODO - for the time being use a Byte Array
  • Word - DB?.DBW?
  • Word[] - DB?.DBW?
  • DWord - DB?.DBD?
  • DWord[] - DB?.DBD?

Further types will be added in the future.

Supported PLCs
  • Logo-0BA8
  • S7-200
  • S7-300
  • S7-400
  • S7-1200
  • S7-1500
Product Compatible and additional computed target framework versions.
.NET net5.0 was computed.  net5.0-windows was computed.  net6.0 is compatible.  net6.0-android was computed.  net6.0-ios was computed.  net6.0-maccatalyst was computed.  net6.0-macos was computed.  net6.0-tvos was computed.  net6.0-windows was computed.  net7.0 is compatible.  net7.0-android was computed.  net7.0-ios was computed.  net7.0-maccatalyst was computed.  net7.0-macos was computed.  net7.0-tvos was computed.  net7.0-windows was computed.  net8.0 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. 
.NET Core netcoreapp2.0 was computed.  netcoreapp2.1 was computed.  netcoreapp2.2 was computed.  netcoreapp3.0 was computed.  netcoreapp3.1 was computed. 
.NET Standard netstandard2.0 is compatible.  netstandard2.1 was computed. 
.NET Framework net461 was computed.  net462 was computed.  net463 was computed.  net47 was computed.  net471 was computed.  net472 was computed.  net48 was computed.  net481 was computed. 
MonoAndroid monoandroid was computed. 
MonoMac monomac was computed. 
MonoTouch monotouch was computed. 
Tizen tizen40 was computed.  tizen60 was computed. 
Xamarin.iOS xamarinios was computed. 
Xamarin.Mac xamarinmac was computed. 
Xamarin.TVOS xamarintvos was computed. 
Xamarin.WatchOS xamarinwatchos was computed. 
Compatible target framework(s)
Included target framework(s) (in package)
Learn more about Target Frameworks and .NET Standard.

NuGet packages (1)

Showing the top 1 NuGet packages that depend on S7PlcRx:

Package Downloads
MQTTnet.Rx.S7Plc

Reactive extensions for MQTTnet Broker

GitHub repositories

This package is not used by any popular GitHub repositories.

Version Downloads Last updated
1.3.3 664 2/29/2024
1.3.2 147 1/18/2024
1.3.1 109 1/18/2024
1.3.0 123 1/16/2024
1.2.5 228 12/19/2023
1.2.4 210 10/30/2023
1.2.3 148 10/20/2023
1.2.2 125 10/19/2023
1.2.1 332 8/22/2023
1.2.0 129 8/21/2023
1.1.4 233 8/3/2023
1.1.3 163 8/2/2023
1.1.2 149 8/2/2023
1.1.1 215 7/27/2023
1.1.0 146 7/27/2023
1.0.3 237 5/19/2023
1.0.2 1,274 7/26/2022
1.0.1 387 7/25/2022

Compatability with Net 6 / 7 / 8 and netstandard2.0