https://github.com/chrispulman/s7plcrx
A Reactive S7 PLC Communications Library
https://github.com/chrispulman/s7plcrx
plc-programming reactive s7-plc siemens
Last synced: 7 months ago
JSON representation
A Reactive S7 PLC Communications Library
- Host: GitHub
- URL: https://github.com/chrispulman/s7plcrx
- Owner: ChrisPulman
- License: mit
- Created: 2022-07-25T20:12:00.000Z (about 3 years ago)
- Default Branch: main
- Last Pushed: 2024-05-19T19:40:17.000Z (over 1 year ago)
- Last Synced: 2024-05-19T20:38:54.345Z (over 1 year ago)
- Topics: plc-programming, reactive, s7-plc, siemens
- Language: C#
- Homepage:
- Size: 14.1 MB
- Stars: 9
- Watchers: 1
- Forks: 4
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
 [](https://github.com/ChrisPulman/S7PlcRx/actions/workflows/BuildOnly.yml)  [](https://www.nuget.org/packages/S7PlcRx)
# 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](https://www.nuget.org/packages/S7PlcRx/).
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
```powershell
Install-Package S7PlcRx
```
#### .NET CLI
```powershell
dotnet add package S7PlcRx
```
### Usage
#### Setup Tags and Observe values in PLC
```csharp
using S7PlcRx;
var plc = new RxS7(S7PlcRx.Enums.CpuType.S71500, "PLC_IP_ADDRESS", 0, 5);
// Add Tag without Polling
plc.AddUpdateTagItem("Tag0", "DB500.DBD0").SetTagPollIng(false);
// Add Tag with Polling
plc.AddUpdateTagItem("Tag1", "DB500.DBD8");
plc.IsConnected
.Where(x => x)
.Take(1)
.Subscribe(async _ =>
{
Console.WriteLine("Connected");
// Read Tag Value manually
var tag0 = await plc.Value("Tag0");
});
// Subscribe to Tag Values
plc.Observe("Tag0").Subscribe(x => Console.WriteLine($"Tag0: {x}"));
plc.Observe("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
```csharp
plc.AddUpdateTagItem(typeof(double), "Tag0", "DB500.DBD0");
```
#### Add Tag with Chainable Options
```csharp
plc.AddUpdateTagItem("Tag0", "DB500.DBD0").SetTagPollIng(false)
.AddUpdateTagItem(typeof(double), "Tag1", "DB500.DBD8");
```
#### Remove Tag
```csharp
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.
```csharp
// Create a new Tag and with no Polling
plc.AddUpdateTagItem("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
```csharp
plc.Value("Tag0", 1.0);
```
#### Read PLC CPU Info
```csharp
// 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.
```csharp
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(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