36 Commits

Author SHA1 Message Date
Felix Weiß
43c7f72ac4 Added auto register reset to default typed value on disconnect 2022-10-21 11:56:58 +02:00
Felix Weiß
2e35ed87af Updated hyperlinks in readme 2022-10-20 10:16:11 +02:00
Felix Weiß
a7f97a72ea Package id change in readme 2022-10-20 10:11:13 +02:00
Felix Weiß
51870166e4 Update publish.yml 2022-10-20 10:04:49 +02:00
Felix Weiß
b43e9bd201 Package id 2022-10-20 10:02:59 +02:00
Felix Weiß
e313dbc3ec Changed package ID 2022-10-20 10:01:53 +02:00
Felix Weiß
bdf9f93f97 Update MewtocolNet.csproj 2022-10-20 09:50:58 +02:00
Felix Weiß
fe816ab78e Update publish.yml 2022-10-20 09:46:08 +02:00
Felix Weiß
48a5977185 Create publish.yml 2022-10-20 09:36:35 +02:00
Felix Weiß
c69f63c191 Update README.md 2022-09-27 10:21:37 +02:00
Felix Weiß
6a2f278dd1 Fixed negative queued msges
- version count up
2022-09-27 10:18:01 +02:00
Felix Weiß
19159ed183 Upcount version 2022-09-27 09:53:02 +02:00
Felix Weiß
635823a66f Made poller delay thread safe
- added property for currentlly queued messages
- added (optional) progress to ReadByteRange
2022-09-27 09:52:35 +02:00
Felix Weiß
c7a6559f97 Added methods to pause/resume the auto polling 2022-09-23 16:38:14 +02:00
Felix Weiß
88a453355c Merge branch 'master' of https://github.com/WOmed/MewtocolNet 2022-09-21 16:24:08 +02:00
Felix Weiß
6f8f891760 Added poller delay
- added downstream and upstream speeds
- refactored SerialQueue
- counted version up to 0.5.5
2022-09-21 16:24:00 +02:00
Felix Weiß
8fb8d4989d Update version in package ref 2022-08-04 11:53:20 +02:00
Felix Weiß
45a9fa0520 Version upcount 2022-08-04 11:48:04 +02:00
Felix Weiß
772f8b89a4 Fixed auto value string enum conversion 2022-08-04 11:47:37 +02:00
Felix Weiß
6c7c368b55 Bugfixes in host connection params setup 2022-07-19 17:37:10 +02:00
Felix Weiß
38f0f9f523 Counted up version number 2022-07-19 09:31:06 +02:00
Felix Weiß
c2aecb387a Merge branch 'master' of https://github.com/WOmed/MewtocolNet 2022-07-19 09:28:27 +02:00
Felix Weiß
0e1f5cd12b Added possiblity to connect over a certain host endpoint
- fixed missing docs and
- fixed accessing modifiers
2022-07-19 09:28:18 +02:00
Felix Weiß
f15d565029 Typos 2022-07-18 16:50:48 +02:00
Felix Weiß
0ac0198223 Update README.md 2022-07-18 16:49:53 +02:00
Felix Weiß
3c450eea97 Added method to change connection params 2022-07-18 16:47:43 +02:00
Felix Weiß
fe2d2b9fb9 Made the interface disposable and refactoring 2022-07-18 09:55:36 +02:00
Felix Weiß
6c411d7318 Heavily improved the overall performance and async handling
- added a queuing manager for all messages
- tcp now keeps the connection after the first handshake
- async tasks are now run by the time order they were added
- minor bugfixes
2022-07-15 15:53:26 +02:00
Felix Weiß
cdae9a60fb Merge branch 'master' of https://github.com/WOmed/MewtocolNet 2022-07-13 18:28:40 +02:00
Felix Weiß
b1c2cdb70e Fixed exception on duplicate memory adresses when the adress area was different
- counted up version number
2022-07-13 18:28:28 +02:00
Felix Weiß
95bfcf94de Update README.md 2022-07-04 16:57:42 +02:00
Felix Weiß
0a93df287d Fixed more exception handling and added the ability to close a running interface 2022-07-04 16:53:55 +02:00
Felix Weiß
18384ff964 Fixed not updating timespan auto propertys and thread blocking Wait() call for await 2022-07-01 15:12:24 +02:00
Felix Weiß
e4ddad685a Fixed exception handling on receive 2022-06-30 15:47:05 +02:00
Felix Weiß
e953938a65 Added support for auto enum casting
- counted up version number
- cleaned up register constructors that are used inernally only
2022-06-24 11:25:26 +02:00
Felix Weiß
83f17a4eae Fixed bug a bug where the writeregister method always returned false
- fixed a bug where the adress ToString of a register with a special adress was always ending with 0
- counted up version
2022-06-23 12:15:42 +02:00
21 changed files with 1152 additions and 373 deletions

57
.github/workflows/publish.yml vendored Normal file
View File

@@ -0,0 +1,57 @@
name: publish to nuget
on:
push:
branches:
- master # Default release branch, may also be named 'master' or 'develop'
jobs:
publish:
name: build, pack & publish
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v2
# - name: Setup dotnet
# uses: actions/setup-dotnet@v1
# with:
# dotnet-version: 3.1.200
# Publish
- name: publish on version change
id: publish_nuget
uses: brandedoutcast/publish-nuget@v2
with:
# Filepath of the project to be packaged, relative to root of repository
PROJECT_FILE_PATH: MewtocolNet/MewtocolNet.csproj
# Configuration to build and package
# BUILD_CONFIGURATION: Release
# Platform target to compile (default is empty/AnyCPU)
# BUILD_PLATFORM: x64
# NuGet package id, used for version detection & defaults to project name
PACKAGE_NAME: Mewtocol.NET
# Filepath with version info, relative to root of repository & defaults to PROJECT_FILE_PATH
# VERSION_FILE_PATH: Directory.Build.props
# Regex pattern to extract version info in a capturing group
# VERSION_REGEX: ^\s*<Version>(.*)<\/Version>\s*$
# Useful with external providers like Nerdbank.GitVersioning, ignores VERSION_FILE_PATH & VERSION_REGEX
# VERSION_STATIC: 1.0.0
# Flag to toggle git tagging, enabled by default
# TAG_COMMIT: true
# Format of the git tag, [*] gets replaced with actual version
# TAG_FORMAT: v*
# API key to authenticate with NuGet server
NUGET_KEY: ${{secrets.NUGET_KEY}}
# NuGet server uri hosting the packages, defaults to https://api.nuget.org
# NUGET_SOURCE: https://api.nuget.org
# Flag to toggle pushing symbols along with nuget package to the server, disabled by default
# INCLUDE_SYMBOLS: false

View File

@@ -2,69 +2,221 @@
using System.Threading.Tasks;
using MewtocolNet;
using MewtocolNet.Logging;
using MewtocolNet.Registers;
namespace Examples {
namespace Examples;
class Program {
class Program {
static void Main(string[] args) {
static void Main(string[] args) {
Task.Factory.StartNew(async () => {
Console.WriteLine("Enter your scenario number:\n" +
"1 = Permanent connection\n" +
"2 = Dispose connection");
//attaching the logger
Logger.LogLevel = LogLevel.Verbose;
Logger.OnNewLogMessage((date, msg) => {
Console.WriteLine($"{date.ToString("HH:mm:ss")} {msg}");
});
var line = Console.ReadLine();
//setting up a new PLC interface and register collection
MewtocolInterface interf = new MewtocolInterface("10.237.191.3");
TestRegisters registers = new TestRegisters();
if(line == "1") {
Scenario1();
}
//attaching the register collection and an automatic poller
interf.WithRegisterCollection(registers).WithPoller();
if (line == "2") {
Scenario2();
}
await interf.ConnectAsync(
(plcinf) => {
Console.ReadLine();
}
//reading a value from the register collection
Console.WriteLine($"BitValue is: {registers.BitValue}");
private static bool isProgressReadout = false;
interf.GetRegister(nameof(registers.TestBool1)).PropertyChanged += (s, e) => {
Console.ForegroundColor = ConsoleColor.Green;
Console.WriteLine(interf.GetRegister(nameof(registers.TestBool1)).StringValue);
Console.ResetColor();
};
static void Scenario1 () {
//writing a value to the registers
Task.Factory.StartNew(async () => {
//set plc to run mode if not already
await interf.SetOperationMode(OPMode.Run);
await Task.Delay(2000);
Console.WriteLine("Testregister was toggled");
//adds 10 each time the plc connects to the PLCs INT regíster
interf.SetRegister(nameof(registers.TestInt16), (short)(registers.TestInt16 + 10));
//adds 1 each time the plc connects to the PLCs DINT regíster
interf.SetRegister(nameof(registers.TestInt32), (registers.TestInt32 + 1));
//adds 11.11 each time the plc connects to the PLCs REAL regíster
interf.SetRegister(nameof(registers.TestFloat32), (float)(registers.TestFloat32 + 11.11));
//writes 'Hello' to the PLCs string register
interf.SetRegister(nameof(registers.TestString2), "Hello");
//set the current second to the PLCs TIME register
interf.SetRegister(nameof(registers.TestTime), TimeSpan.FromSeconds(DateTime.Now.Second));
});
}
);
Task.Factory.StartNew(async () => {
//attaching the logger
Logger.LogLevel = LogLevel.Verbose;
Logger.OnNewLogMessage((date, msg) => {
Console.WriteLine($"{date.ToString("HH:mm:ss")} {msg}");
});
Console.ReadLine();
}
//setting up a new PLC interface and register collection
MewtocolInterface interf = new MewtocolInterface("10.237.191.3");
TestRegisters registers = new TestRegisters();
//attaching the register collection and an automatic poller
interf.WithRegisterCollection(registers).WithPoller();
_ = Task.Factory.StartNew(async () => {
while (true) {
if (isProgressReadout) continue;
Console.Title = $"Polling Paused: {interf.PollingPaused}, " +
$"Poller active: {interf.PollerActive}, " +
$"Speed UP: {interf.BytesPerSecondUpstream} B/s, " +
$"Speed DOWN: {interf.BytesPerSecondDownstream} B/s, " +
$"Poll delay: {interf.PollerDelayMs} ms, " +
$"Queued MSGs: {interf.QueuedMessages}";
await Task.Delay(1000);
}
});
//await interf.ConnectAsync((plcinf) => AfterConnect(interf, registers));
bool flip = false;
while(true) {
if(!flip) {
await interf.ConnectAsync();
} else {
interf.Disconnect();
}
flip = !flip;
await Task.Delay(5000);
}
});
}
static void AfterConnect (MewtocolInterface interf, TestRegisters registers) {
//reading a value from the register collection
Console.WriteLine($"BitValue is: {registers.BitValue}");
Console.WriteLine($"TestEnum is: {registers.TestEnum}");
_ = Task.Factory.StartNew(async () => {
while(true) {
isProgressReadout = true;
await interf.ReadByteRange(1000, 2000, (p) => {
var totSteps = 10;
var cSteps = totSteps * p;
string progBar = "";
for (int i = 0; i < totSteps; i++) {
if(i < (int)cSteps) {
progBar += "⬛";
} else {
progBar += "⬜";
}
}
Console.Title = $"Prog read range: {(p * 100).ToString("N1")}% {progBar} Queued MSGs: {interf.QueuedMessages}";
});
isProgressReadout = false;
await Task.Delay(3000);
}
});
//writing a value to the registers
_ = Task.Factory.StartNew(async () => {
//set plc to run mode if not already
await interf.SetOperationMode(OPMode.Run);
int startAdress = 10000;
int entryByteSize = 20 * 20;
var bytes = await interf.ReadByteRange(startAdress, entryByteSize);
Console.WriteLine($"Bytes: {string.Join('-', bytes)}");
await Task.Delay(2000);
await interf.SetRegisterAsync(nameof(registers.TestInt32), 100);
//adds 10 each time the plc connects to the PLCs INT regíster
interf.SetRegister(nameof(registers.TestInt16), (short)(registers.TestInt16 + 10));
//adds 1 each time the plc connects to the PLCs DINT regíster
interf.SetRegister(nameof(registers.TestInt32), (registers.TestInt32 + 1));
//adds 11.11 each time the plc connects to the PLCs REAL regíster
interf.SetRegister(nameof(registers.TestFloat32), (float)(registers.TestFloat32 + 11.11));
//writes 'Hello' to the PLCs string register
interf.SetRegister(nameof(registers.TestString2), "Hello");
//set the current second to the PLCs TIME register
interf.SetRegister(nameof(registers.TestTime), TimeSpan.FromSeconds(DateTime.Now.Second));
//test pausing poller
bool pollerPaused = false;
while (true) {
await Task.Delay(5000);
pollerPaused = !pollerPaused;
if (pollerPaused) {
Console.WriteLine("Pausing poller");
await interf.PausePollingAsync();
//interf.PollerDelayMs += 10;
Console.WriteLine("Paused poller");
} else {
interf.ResumePolling();
Console.WriteLine("Resumed poller");
}
}
});
}
static void Scenario2 () {
Logger.LogLevel = LogLevel.Critical;
Logger.OnNewLogMessage((date, msg) => {
Console.WriteLine($"{date.ToString("HH:mm:ss")} {msg}");
});
Task.Factory.StartNew(async () => {
//automatic endpoint
using (var interf = new MewtocolInterface("10.237.191.3")) {
await interf.ConnectAsync();
if (interf.IsConnected) {
await Task.Delay(5000);
}
interf.Disconnect();
}
//manual endpoint
using (var interf = new MewtocolInterface("10.237.191.3")) {
interf.HostEndpoint = new System.Net.IPEndPoint(System.Net.IPAddress.Parse("10.237.191.77"), 0);
await interf.ConnectAsync();
if(interf.IsConnected) {
await Task.Delay(5000);
}
interf.Disconnect();
}
});
}
}

View File

@@ -10,16 +10,19 @@ namespace Examples {
[Register(1000, RegisterType.R)]
public bool TestBool1 { get; private set; }
[Register(1000)]
public int TestDuplicate { get; private set; }
//corresponds to a XD input of the PLC
[Register(RegisterType.X, SpecialAddress.D)]
public bool TestBoolInputXD { get; private set; }
//corresponds to a DT1101 - DT1104 string register in the PLC with (STRING[4])
[Register(1101, 4)]
public string TestString1 { get; private set; }
//[Register(1101, 4)]
//public string TestString1 { get; private set; }
//corresponds to a DT7000 16 bit int register in the PLC
[Register(7000)]
[Register(899)]
public short TestInt16 { get; private set; }
//corresponds to a DTD7001 - DTD7002 32 bit int register in the PLC
@@ -50,5 +53,23 @@ namespace Examples {
[Register(7012)]
public TimeSpan TestTime { get; private set; }
public enum CurrentState {
Undefined = 0,
State1 = 1,
State2 = 2,
//State3 = 3,
State4 = 4,
State5 = 5,
StateBetween = 100,
State6 = 6,
State7 = 7,
}
[Register(50)]
public CurrentState TestEnum { get; private set; }
[Register(100)]
public TimeSpan TsTest2 { get; private set; }
}
}

View File

@@ -1,14 +1,28 @@
using System;
namespace MewtocolNet.Registers {
/// <summary>
/// Contains information about the plc and its cpu
/// </summary>
public partial class CpuInfo {
/// <summary>
/// The cpu type of the plc
/// </summary>
public CpuType Cputype { get; set; }
/// <summary>
/// Program capacity in 1K steps
/// </summary>
public int ProgramCapacity { get; set; }
/// <summary>
/// Version of the cpu
/// </summary>
public string CpuVersion { get; set; }
public static CpuInfo BuildFromHexString (string _cpuType, string _cpuVersion, string _progCapacity) {
internal static CpuInfo BuildFromHexString (string _cpuType, string _cpuVersion, string _progCapacity) {
CpuInfo retInf = new CpuInfo();
@@ -47,8 +61,7 @@ namespace MewtocolNet.Registers {
return retInf;
}
}
}

View File

@@ -14,17 +14,69 @@ namespace MewtocolNet {
/// </summary>
public partial class MewtocolInterface {
/// <summary>
/// True if the auto poller is currently paused
/// </summary>
public bool PollingPaused => pollerIsPaused;
/// <summary>
/// True if the poller is actvice (can be paused)
/// </summary>
public bool PollerActive => !pollerTaskStopped;
internal event Action PolledCycle;
internal CancellationTokenSource cTokenAutoUpdater;
internal bool ContinousReaderRunning;
internal volatile bool pollerTaskRunning;
internal volatile bool pollerTaskStopped;
internal volatile bool pollerIsPaused;
internal volatile bool pollerFirstCycle = false;
internal bool usePoller = false;
#region Register Polling
/// <summary>
/// Kills the poller completely
/// </summary>
internal void KillPoller () {
ContinousReaderRunning = false;
cTokenAutoUpdater?.Cancel();
pollerTaskRunning = false;
pollerTaskStopped = true;
ClearRegisterVals();
}
/// <summary>
/// Pauses the polling and waits for the last message to be sent
/// </summary>
/// <returns></returns>
public async Task PausePollingAsync () {
if (!pollerTaskRunning)
return;
pollerTaskRunning = false;
while (!pollerIsPaused) {
if (pollerIsPaused)
break;
await Task.Delay(10);
}
pollerTaskRunning = false;
}
/// <summary>
/// Resumes the polling
/// </summary>
public void ResumePolling () {
pollerTaskRunning = true;
}
@@ -33,134 +85,111 @@ namespace MewtocolNet {
/// </summary>
internal void AttachPoller () {
if (ContinousReaderRunning) return;
if (pollerTaskRunning)
return;
cTokenAutoUpdater = new CancellationTokenSource();
pollerFirstCycle = true;
Logger.Log("Poller is attaching", LogLevel.Info, this);
Task.Factory.StartNew(async () => {
try {
Logger.Log("Poller is attaching", LogLevel.Info, this);
Task.Factory.StartNew(async () => {
int iteration = 0;
var plcinf = await GetPLCInfoAsync();
if (plcinf == null) {
Logger.Log("PLC not reachable, stopping logger", LogLevel.Info, this);
return;
}
pollerTaskStopped = false;
pollerTaskRunning = true;
pollerIsPaused = false;
PolledCycle += MewtocolInterface_PolledCycle;
void MewtocolInterface_PolledCycle () {
while (!pollerTaskStopped) {
StringBuilder stringBuilder = new StringBuilder();
foreach (var reg in GetAllRegisters()) {
string address = $"{reg.GetRegisterString()}{reg.GetStartingMemoryArea()}".PadRight(8, (char)32);
stringBuilder.AppendLine($"{address}{(reg.Name != null ? $" ({reg.Name})" : "")}: {reg.GetValueString()}");
while (pollerTaskRunning) {
if (iteration >= Registers.Count + 1) {
iteration = 0;
//invoke cycle polled event
InvokePolledCycleDone();
continue;
}
Logger.Log($"Registers loaded are: \n" +
$"--------------------\n" +
$"{stringBuilder.ToString()}" +
$"--------------------",
LogLevel.Verbose, this);
Logger.Log("Logger did its first cycle successfully", LogLevel.Info, this);
PolledCycle -= MewtocolInterface_PolledCycle;
}
ContinousReaderRunning = true;
int getPLCinfoCycleCount = 0;
while (ContinousReaderRunning) {
//do priority tasks first
if (PriorityTasks.Count > 0) {
await PriorityTasks.FirstOrDefault(x => !x.IsCompleted);
} else if (getPLCinfoCycleCount > 25) {
if (iteration >= Registers.Count) {
await GetPLCInfoAsync();
getPLCinfoCycleCount = 0;
iteration++;
continue;
}
foreach (var registerPair in Registers) {
var reg = Registers[iteration];
var reg = registerPair.Value;
if (reg is NRegister<short> shortReg) {
var lastVal = shortReg.Value;
var readout = (await ReadNumRegister(shortReg)).Register.Value;
if (lastVal != readout) {
InvokeRegisterChanged(shortReg);
}
if (reg is NRegister<short> shortReg) {
var lastVal = shortReg.Value;
var readout = (await ReadNumRegister(shortReg)).Register.Value;
if (lastVal != readout) {
InvokeRegisterChanged(shortReg);
}
if (reg is NRegister<ushort> ushortReg) {
var lastVal = ushortReg.Value;
var readout = (await ReadNumRegister(ushortReg)).Register.Value;
if (lastVal != readout) {
InvokeRegisterChanged(ushortReg);
}
}
if (reg is NRegister<ushort> ushortReg) {
var lastVal = ushortReg.Value;
var readout = (await ReadNumRegister(ushortReg)).Register.Value;
if (lastVal != readout) {
InvokeRegisterChanged(ushortReg);
}
if (reg is NRegister<int> intReg) {
var lastVal = intReg.Value;
var readout = (await ReadNumRegister(intReg)).Register.Value;
if (lastVal != readout) {
InvokeRegisterChanged(intReg);
}
}
if (reg is NRegister<int> intReg) {
var lastVal = intReg.Value;
var readout = (await ReadNumRegister(intReg)).Register.Value;
if (lastVal != readout) {
InvokeRegisterChanged(intReg);
}
if (reg is NRegister<uint> uintReg) {
var lastVal = uintReg.Value;
var readout = (await ReadNumRegister(uintReg)).Register.Value;
if (lastVal != readout) {
InvokeRegisterChanged(uintReg);
}
}
if (reg is NRegister<uint> uintReg) {
var lastVal = uintReg.Value;
var readout = (await ReadNumRegister(uintReg)).Register.Value;
if (lastVal != readout) {
InvokeRegisterChanged(uintReg);
}
if (reg is NRegister<float> floatReg) {
var lastVal = floatReg.Value;
var readout = (await ReadNumRegister(floatReg)).Register.Value;
if (lastVal != readout) {
InvokeRegisterChanged(floatReg);
}
}
if (reg is NRegister<float> floatReg) {
var lastVal = floatReg.Value;
var readout = (await ReadNumRegister(floatReg)).Register.Value;
if (lastVal != readout) {
InvokeRegisterChanged(floatReg);
}
if (reg is NRegister<TimeSpan> tsReg) {
var lastVal = tsReg.Value;
var readout = (await ReadNumRegister(tsReg)).Register.Value;
if (lastVal != readout) {
InvokeRegisterChanged(tsReg);
}
}
if (reg is NRegister<TimeSpan> tsReg) {
var lastVal = tsReg.Value;
var readout = (await ReadNumRegister(tsReg)).Register.Value;
if (lastVal != readout) {
InvokeRegisterChanged(tsReg);
}
if (reg is BRegister boolReg) {
var lastVal = boolReg.Value;
var readout = (await ReadBoolRegister(boolReg)).Register.Value;
if (lastVal != readout) {
InvokeRegisterChanged(boolReg);
}
}
if (reg is BRegister boolReg) {
var lastVal = boolReg.Value;
var readout = (await ReadBoolRegister(boolReg)).Register.Value;
if (lastVal != readout) {
InvokeRegisterChanged(boolReg);
}
if (reg is SRegister stringReg) {
var lastVal = stringReg.Value;
var readout = (await ReadStringRegister(stringReg)).Register.Value;
if (lastVal != readout) {
InvokeRegisterChanged(stringReg);
}
}
if (reg is SRegister stringReg) {
var lastVal = stringReg.Value;
var readout = (await ReadStringRegister(stringReg)).Register.Value;
if (lastVal != readout) {
InvokeRegisterChanged(stringReg);
}
}
getPLCinfoCycleCount++;
iteration++;
pollerFirstCycle = false;
//invoke cycle polled event
InvokePolledCycleDone();
await Task.Delay(pollerDelayMs);
}
}, cTokenAutoUpdater.Token);
pollerIsPaused = !pollerTaskRunning;
} catch (TaskCanceledException) { }
}
pollerIsPaused = false;
});
}
@@ -208,7 +237,7 @@ namespace MewtocolNet {
toAdd = new BRegister(_address, _type, _name);
}
Registers.Add(_address, toAdd);
Registers.Add(toAdd);
}
@@ -238,7 +267,7 @@ namespace MewtocolNet {
}
toAdd.collectionType = _colType;
Registers.Add(_address, toAdd);
Registers.Add(toAdd);
}
@@ -259,7 +288,7 @@ namespace MewtocolNet {
public void AddRegister (SpecialAddress _spAddress, RegisterType _type, string _name = null) {
//as bool registers
Registers.Add((int)_spAddress, new BRegister(_spAddress, _type, _name));
Registers.Add(new BRegister(_spAddress, _type, _name));
}
@@ -270,7 +299,7 @@ namespace MewtocolNet {
reg.collectionType = _colType;
//as bool registers
Registers.Add((int)_spAddress, reg);
Registers.Add(reg);
}
@@ -299,35 +328,38 @@ namespace MewtocolNet {
throw new NotSupportedException($"_lenght parameter only allowed for register of type string");
}
if (Registers.Any(x => x.Key == _address)) {
throw new NotSupportedException($"Cannot add a register multiple times, " +
$"make sure that all register attributes or AddRegister assignments have different adresses.");
}
Register toAdd;
if (regType == typeof(short)) {
Registers.Add(_address, new NRegister<short>(_address, _name));
toAdd = new NRegister<short>(_address, _name);
} else if (regType == typeof(ushort)) {
Registers.Add(_address, new NRegister<ushort>(_address, _name));
toAdd = new NRegister<ushort>(_address, _name);
} else if (regType == typeof(int)) {
Registers.Add(_address, new NRegister<int>(_address, _name));
toAdd = new NRegister<int>(_address, _name);
} else if (regType == typeof(uint)) {
Registers.Add(_address, new NRegister<uint>(_address, _name));
toAdd = new NRegister<uint>(_address, _name);
} else if (regType == typeof(float)) {
Registers.Add(_address, new NRegister<float>(_address, _name));
toAdd = new NRegister<float>(_address, _name);
} else if (regType == typeof(string)) {
Registers.Add(_address, new SRegister(_address, _length, _name));
toAdd = new SRegister(_address, _length, _name);
} else if (regType == typeof(TimeSpan)) {
Registers.Add(_address, new NRegister<TimeSpan>(_address, _name));
toAdd = new NRegister<TimeSpan>(_address, _name);
} else if (regType == typeof(bool)) {
Registers.Add(_address, new BRegister(_address, RegisterType.R, _name));
toAdd = new BRegister(_address, RegisterType.R, _name);
} else {
throw new NotSupportedException($"The type {regType} is not allowed for Registers \n" +
$"Allowed are: short, ushort, int, uint, float and string");
}
if (Registers.Any(x => x.GetRegisterPLCName() == toAdd.GetRegisterPLCName())) {
throw new NotSupportedException($"Cannot add a register multiple times, " +
$"make sure that all register attributes or AddRegister assignments have different adresses.");
}
}
internal void AddRegister<T> (Type _colType, int _address, int _length = 1, string _name = null, bool _isBitwise = false) {
internal void AddRegister<T> (Type _colType, int _address, int _length = 1, string _name = null, bool _isBitwise = false, Type _enumType = null) {
Type regType = typeof(T);
@@ -335,12 +367,7 @@ namespace MewtocolNet {
throw new NotSupportedException($"_lenght parameter only allowed for register of type string");
}
if (Registers.Any(x => x.Key == _address) && !_isBitwise) {
throw new NotSupportedException($"Cannot add a register multiple times, " +
$"make sure that all register attributes or AddRegister assignments have different adresses.");
}
if (Registers.Any(x => x.Key == _address) && _isBitwise) {
if (Registers.Any(x => x.MemoryAdress == _address) && _isBitwise) {
return;
}
@@ -351,7 +378,7 @@ namespace MewtocolNet {
} else if (regType == typeof(ushort)) {
reg = new NRegister<ushort>(_address, _name);
} else if (regType == typeof(int)) {
reg = new NRegister<int>(_address, _name, _isBitwise);
reg = new NRegister<int>(_address, _name, _isBitwise, _enumType);
} else if (regType == typeof(uint)) {
reg = new NRegister<uint>(_address, _name);
} else if (regType == typeof(float)) {
@@ -364,15 +391,19 @@ namespace MewtocolNet {
reg = new BRegister(_address, RegisterType.R, _name);
}
if (reg == null) {
throw new NotSupportedException($"The type {regType} is not allowed for Registers \n" +
$"Allowed are: short, ushort, int, uint, float and string");
} else {
reg.collectionType = _colType;
Registers.Add(_address, reg);
if (Registers.Any(x => x.GetRegisterPLCName() == reg.GetRegisterPLCName()) && !_isBitwise) {
throw new NotSupportedException($"Cannot add a register multiple times, " +
$"make sure that all register attributes or AddRegister assignments have different adresses.");
}
reg.collectionType = _colType;
Registers.Add(reg);
}
}
@@ -387,7 +418,7 @@ namespace MewtocolNet {
/// <returns></returns>
public Register GetRegister (string name) {
return Registers.FirstOrDefault(x => x.Value.Name == name).Value;
return Registers.FirstOrDefault(x => x.Name == name);
}
@@ -398,8 +429,8 @@ namespace MewtocolNet {
/// <returns>A casted register or the <code>default</code> value</returns>
public T GetRegister<T> (string name) where T : Register {
try {
var reg = Registers.FirstOrDefault(x => x.Value.Name == name);
return reg.Value as T;
var reg = Registers.FirstOrDefault(x => x.Name == name);
return reg as T;
} catch (InvalidCastException) {
return default(T);
}
@@ -414,7 +445,7 @@ namespace MewtocolNet {
/// </summary>
public List<Register> GetAllRegisters () {
return Registers.Values.ToList();
return Registers;
}

View File

@@ -75,7 +75,7 @@ namespace MewtocolNet {
var res = new Regex(@"\%([0-9]{2})\$RD.{8}(.*)...").Match(_onString);
if(res.Success) {
string val = res.Groups[2].Value;
return val.GetStringFromAsciiHex().Trim();
return val.GetStringFromAsciiHex()?.Trim();
}
return null;
}
@@ -143,7 +143,7 @@ namespace MewtocolNet {
internal static string GetStringFromAsciiHex (this string input) {
if (input.Length % 2 != 0)
throw new ArgumentException("input not a hex string");
return null;
byte[] bytes = new byte[input.Length / 2];
for (int i = 0; i < input.Length; i += 2) {
String hex = input.Substring(i, 2);
@@ -158,6 +158,8 @@ namespace MewtocolNet {
}
internal static byte[] HexStringToByteArray(this string hex) {
if (hex == null)
return null;
return Enumerable.Range(0, hex.Length)
.Where(x => x % 2 == 0)
.Select(x => Convert.ToByte(hex.Substring(x, 2), 16))

View File

@@ -12,13 +12,16 @@ using MewtocolNet.Logging;
using System.Collections;
using System.Diagnostics;
using System.ComponentModel;
using System.Net;
using System.Threading;
using MewtocolNet.Queue;
namespace MewtocolNet {
/// <summary>
/// The PLC com interface class
/// </summary>
public partial class MewtocolInterface : INotifyPropertyChanged {
public partial class MewtocolInterface : INotifyPropertyChanged, IDisposable {
/// <summary>
/// Gets triggered when the PLC connection was established
@@ -40,6 +43,40 @@ namespace MewtocolNet {
/// </summary>
public event PropertyChangedEventHandler PropertyChanged;
private int connectTimeout = 3000;
/// <summary>
/// The initial connection timeout in milliseconds
/// </summary>
public int ConnectTimeout {
get { return connectTimeout; }
set { connectTimeout = value; }
}
private volatile int pollerDelayMs = 0;
/// <summary>
/// Delay for each poller cycle in milliseconds, default = 0
/// </summary>
public int PollerDelayMs {
get => pollerDelayMs;
set {
pollerDelayMs = value;
PropertyChanged?.Invoke(this, new PropertyChangedEventArgs(nameof(PollerDelayMs)));
}
}
private volatile int queuedMessages;
/// <summary>
/// Currently queued Messages
/// </summary>
public int QueuedMessages {
get => queuedMessages;
}
/// <summary>
/// The host ip endpoint, leave it null to use an automatic interface
/// </summary>
public IPEndPoint HostEndpoint { get; set; }
private bool isConnected;
/// <summary>
/// The current connection state of the interface
@@ -52,6 +89,16 @@ namespace MewtocolNet {
}
}
private bool disposed;
/// <summary>
/// True if the current interface was disposed
/// </summary>
public bool Disposed {
get { return disposed; }
private set { disposed = value; }
}
private PLCInfo plcInfo;
/// <summary>
/// Generic information about the connected PLC
@@ -67,11 +114,15 @@ namespace MewtocolNet {
/// <summary>
/// The registered data registers of the PLC
/// </summary>
public Dictionary<int, Register> Registers { get; set; } = new Dictionary<int, Register>();
public List<Register> Registers { get; set; } = new List<Register>();
private string ip;
private int port;
private int stationNumber;
private int cycleTimeMs = 25;
private int bytesTotalCountedUpstream = 0;
private int bytesTotalCountedDownstream = 0;
/// <summary>
/// The current IP of the PLC connection
@@ -86,7 +137,6 @@ namespace MewtocolNet {
/// </summary>
public int StationNumber => stationNumber;
private int cycleTimeMs;
/// <summary>
/// The duration of the last message cycle
/// </summary>
@@ -98,8 +148,39 @@ namespace MewtocolNet {
}
}
private int bytesPerSecondUpstream = 0;
/// <summary>
/// The current transmission speed in bytes per second
/// </summary>
public int BytesPerSecondUpstream {
get { return bytesPerSecondUpstream; }
private set {
bytesPerSecondUpstream = value;
PropertyChanged?.Invoke(this, new PropertyChangedEventArgs(nameof(BytesPerSecondUpstream)));
}
}
internal List<Task> PriorityTasks { get; set; } = new List<Task>();
private int bytesPerSecondDownstream = 0;
/// <summary>
/// The current transmission speed in bytes per second
/// </summary>
public int BytesPerSecondDownstream {
get { return bytesPerSecondDownstream; }
private set {
bytesPerSecondDownstream = value;
PropertyChanged?.Invoke(this, new PropertyChangedEventArgs(nameof(BytesPerSecondDownstream)));
}
}
internal NetworkStream stream;
internal TcpClient client;
internal readonly SerialQueue queue = new SerialQueue();
private int RecBufferSize = 128;
internal int SendExceptionsInRow = 0;
internal bool ImportantTaskRunning = false;
private Stopwatch speedStopwatchUpstr;
private Stopwatch speedStopwatchDownstr;
#region Initialization
@@ -129,7 +210,6 @@ namespace MewtocolNet {
RegisterChanged += (o) => {
string address = $"{o.GetRegisterString()}{o.MemoryAdress}".PadRight(5, (char)32);
;
Logger.Log($"{address} " +
$"{(o.Name != null ? $"({o.Name}) " : "")}" +
@@ -193,6 +273,35 @@ namespace MewtocolNet {
}
/// <summary>
/// Changes the connections parameters of the PLC, only applyable when the connection is offline
/// </summary>
/// <param name="_ip">Ip adress</param>
/// <param name="_port">Port number</param>
/// <param name="_station">Station number</param>
public void ChangeConnectionSettings (string _ip, int _port, int _station = 1) {
if (IsConnected)
throw new Exception("Cannot change the connection settings while the PLC is connected");
ip = _ip;
port = _port;
stationNumber = _station;
}
/// <summary>
/// Closes the connection all cyclic polling
/// </summary>
public void Disconnect () {
if (!IsConnected)
return;
OnMajorSocketExceptionWhileConnected();
}
/// <summary>
/// Attaches a poller to the interface that continously
/// polls the registered data registers and writes the values to them
@@ -207,6 +316,98 @@ namespace MewtocolNet {
#endregion
#region TCP connection state handling
private async Task ConnectTCP () {
if (!IPAddress.TryParse(ip, out var targetIP)) {
throw new ArgumentException("The IP adress of the PLC was no valid format");
}
try {
if(HostEndpoint != null) {
client = new TcpClient(HostEndpoint) {
ReceiveBufferSize = RecBufferSize,
NoDelay = false,
};
var ep = (IPEndPoint)client.Client.LocalEndPoint;
Logger.Log($"Connecting [MAN] endpoint: {ep.Address}:{ep.Port}", LogLevel.Verbose, this);
} else {
client = new TcpClient() {
ReceiveBufferSize = RecBufferSize,
NoDelay = false,
ExclusiveAddressUse = true,
};
}
var result = client.BeginConnect(targetIP, port, null, null);
var success = result.AsyncWaitHandle.WaitOne(TimeSpan.FromMilliseconds(ConnectTimeout));
if(!success || !client.Connected) {
OnMajorSocketExceptionWhileConnecting();
return;
}
if(HostEndpoint == null) {
var ep = (IPEndPoint)client.Client.LocalEndPoint;
Logger.Log($"Connecting [AUTO] endpoint: {ep.Address.MapToIPv4()}:{ep.Port}", LogLevel.Verbose, this);
}
stream = client.GetStream();
stream.ReadTimeout = 1000;
await Task.CompletedTask;
} catch (SocketException) {
OnMajorSocketExceptionWhileConnecting();
}
}
private void OnMajorSocketExceptionWhileConnecting () {
Logger.Log("The PLC connection timed out", LogLevel.Error, this);
CycleTimeMs = 0;
IsConnected = false;
KillPoller();
}
private void OnMajorSocketExceptionWhileConnected () {
if (IsConnected) {
Logger.Log("The PLC connection was closed", LogLevel.Error, this);
CycleTimeMs = 0;
IsConnected = false;
Disconnected?.Invoke();
KillPoller();
client.Close();
}
}
private void ClearRegisterVals () {
for (int i = 0; i < Registers.Count; i++) {
var reg = Registers[i];
reg.ClearValue();
}
}
#endregion
#region Register Collection
/// <summary>
@@ -264,6 +465,10 @@ namespace MewtocolNet {
AddRegister<string>(collection.GetType(), cAttribute.MemoryArea, cAttribute.StringLength, _name: propName);
}
if (prop.PropertyType.IsEnum) {
AddRegister<int>(collection.GetType(), cAttribute.MemoryArea, _name: propName, _enumType: prop.PropertyType);
}
//read number as bit array
if (prop.PropertyType == typeof(BitArray)) {
@@ -278,18 +483,13 @@ namespace MewtocolNet {
//read number as bit array by invdividual properties
if (prop.PropertyType == typeof(bool) && cAttribute.AssignedBitIndex != -1) {
if (cAttribute.BitCount == BitCount.B16) {
AddRegister<short>(collection.GetType(), cAttribute.MemoryArea, _name: propName, _isBitwise: true);
} else {
AddRegister<int>(collection.GetType(), cAttribute.MemoryArea, _name: propName, _isBitwise: true);
}
//var bitwiseCount = Registers.Count(x => x.Value.isUsedBitwise);
//attach for bools to be read when bitregister
//RegisterChanged += (reg) => {
// if (reg.Name == propName) {
// prop.SetValue()
// }
//};
if (cAttribute.BitCount == BitCount.B16) {
AddRegister<short>(collection.GetType(), cAttribute.MemoryArea, _name: $"Auto_Bitwise_DT{cAttribute.MemoryArea}", _isBitwise: true);
} else {
AddRegister<int>(collection.GetType(), cAttribute.MemoryArea, _name: $"Auto_Bitwise_DDT{cAttribute.MemoryArea}", _isBitwise: true);
}
}
@@ -320,8 +520,11 @@ namespace MewtocolNet {
var bytes = BitConverter.GetBytes(reg16.Value);
BitArray bitAr = new BitArray(bytes);
prop.SetValue(collection, bitAr[bitIndex]);
collection.TriggerPropertyChanged(prop.Name);
if (bitIndex < bitAr.Length && bitIndex >= 0) {
prop.SetValue(collection, bitAr[bitIndex]);
collection.TriggerPropertyChanged(prop.Name);
}
} else if (bitWiseFound != null && reg is NRegister<int> reg32) {
var casted = (RegisterAttribute)bitWiseFound;
@@ -381,6 +584,14 @@ namespace MewtocolNet {
foundToUpdate.SetValue(collection, ((NRegister<float>)reg).Value);
}
if (foundToUpdate.PropertyType.IsEnum) {
foundToUpdate.SetValue(collection, ((NRegister<int>)reg).Value);
}
if (foundToUpdate.PropertyType == typeof(TimeSpan)) {
foundToUpdate.SetValue(collection, ((NRegister<TimeSpan>)reg).Value);
}
//setting back strings
if (foundToUpdate.PropertyType == typeof(string)) {
@@ -523,7 +734,6 @@ namespace MewtocolNet {
/// Calculates checksum and sends a command to the PLC then awaits results
/// </summary>
/// <param name="_msg">MEWTOCOL Formatted request string ex: %01#RT</param>
/// <param name="_close">Auto close of frame [true]%01#RT01\r [false]%01#RT</param>
/// <returns>Returns the result</returns>
public async Task<CommandResult> SendCommandAsync (string _msg) {
@@ -531,29 +741,47 @@ namespace MewtocolNet {
_msg += "\r";
//send request
try {
string response = null;
queuedMessages++;
if (ContinousReaderRunning) {
var response = await queue.Enqueue(() => SendSingleBlock(_msg));
//if the poller is active then add all messages to a qeueue
if (queuedMessages > 0)
queuedMessages--;
var awaittask = SendSingleBlock(_msg);
PriorityTasks.Add(awaittask);
awaittask.Wait();
if (response == null) {
return new CommandResult {
Success = false,
Error = "0000",
ErrorDescription = "null result"
};
}
PriorityTasks.Remove(awaittask);
response = awaittask.Result;
//error catching
Regex errorcheck = new Regex(@"\%[0-9]{2}\!([0-9]{2})", RegexOptions.IgnoreCase);
Match m = errorcheck.Match(response.ToString());
if (m.Success) {
string eCode = m.Groups[1].Value;
string eDes = Links.LinkedData.ErrorCodes[Convert.ToInt32(eCode)];
Console.ForegroundColor = ConsoleColor.Red;
Console.WriteLine($"Response is: {response}");
Logger.Log($"Error on command {_msg.Replace("\r", "")} the PLC returned error code: {eCode}, {eDes}", LogLevel.Error);
Console.ResetColor();
return new CommandResult {
Success = false,
Error = eCode,
ErrorDescription = eDes
};
}
} else {
return new CommandResult {
Success = true,
Error = "0000",
Response = response.ToString()
};
//poller not active let the user manage message timing
response = await SendSingleBlock(_msg);
}
if (response == null) {
} catch {
return new CommandResult {
Success = false,
Error = "0000",
@@ -561,87 +789,124 @@ namespace MewtocolNet {
};
}
//error catching
Regex errorcheck = new Regex(@"\%[0-9]{2}\!([0-9]{2})", RegexOptions.IgnoreCase);
Match m = errorcheck.Match(response.ToString());
if (m.Success) {
string eCode = m.Groups[1].Value;
string eDes = Links.LinkedData.ErrorCodes[Convert.ToInt32(eCode)];
Console.ForegroundColor = ConsoleColor.Red;
Console.WriteLine($"Response is: {response}");
Console.WriteLine($"Error on command {_msg.Replace("\r", "")} the PLC returned error code: {eCode}, {eDes}");
Console.ResetColor();
return new CommandResult {
Success = false,
Error = eCode,
ErrorDescription = eDes
};
}
return new CommandResult {
Success = true,
Error = "0000",
Response = response.ToString()
};
}
private async Task<string> SendSingleBlock (string _blockString) {
Stopwatch sw = Stopwatch.StartNew();
if (client == null || !client.Connected ) {
await ConnectTCP();
}
using (TcpClient client = new TcpClient() { ReceiveBufferSize = 64, NoDelay = true, ExclusiveAddressUse = true }) {
if (client == null || !client.Connected)
return null;
try {
var message = _blockString.ToHexASCIIBytes();
await client.ConnectAsync(ip, port);
//time measuring
if(speedStopwatchUpstr == null) {
speedStopwatchUpstr = Stopwatch.StartNew();
}
using (NetworkStream stream = client.GetStream()) {
var message = _blockString.ToHexASCIIBytes();
var messageAscii = BitConverter.ToString(message).Replace("-", " ");
//send request
using (var sendStream = new MemoryStream(message)) {
await sendStream.CopyToAsync(stream);
Logger.Log($"OUT MSG: {_blockString}", LogLevel.Critical, this);
//log message sent
ASCIIEncoding enc = new ASCIIEncoding();
string characters = enc.GetString(message);
if(speedStopwatchUpstr.Elapsed.TotalSeconds >= 1) {
speedStopwatchUpstr.Restart();
bytesTotalCountedUpstream = 0;
}
//send request
using (var sendStream = new MemoryStream(message)) {
await sendStream.CopyToAsync(stream);
Logger.Log($"[--------------------------------]", LogLevel.Critical, this);
Logger.Log($"--> OUT MSG: {_blockString}", LogLevel.Critical, this);
}
//calc upstream speed
bytesTotalCountedUpstream += message.Length;
var perSecUpstream = (double)((bytesTotalCountedUpstream / speedStopwatchUpstr.Elapsed.TotalMilliseconds) * 1000);
if (perSecUpstream <= 10000)
BytesPerSecondUpstream = (int)Math.Round(perSecUpstream, MidpointRounding.AwayFromZero);
//await result
StringBuilder response = new StringBuilder();
try {
byte[] responseBuffer = new byte[128 * 16];
bool endLineCode = false;
bool startMsgCode = false;
while (!endLineCode && !startMsgCode) {
do {
//time measuring
if (speedStopwatchDownstr == null) {
speedStopwatchDownstr = Stopwatch.StartNew();
}
//await result
StringBuilder response = new StringBuilder();
byte[] responseBuffer = new byte[256];
do {
int bytes = stream.Read(responseBuffer, 0, responseBuffer.Length);
response.Append(Encoding.UTF8.GetString(responseBuffer, 0, bytes));
if (speedStopwatchDownstr.Elapsed.TotalSeconds >= 1) {
speedStopwatchDownstr.Restart();
bytesTotalCountedDownstream = 0;
}
while (stream.DataAvailable);
sw.Stop();
var curCycle = (int)sw.ElapsedMilliseconds;
if (Math.Abs(CycleTimeMs - curCycle) > 2) {
CycleTimeMs = curCycle;
}
Logger.Log($"IN MSG ({(int)sw.Elapsed.TotalMilliseconds}ms): {_blockString}", LogLevel.Critical, this);
return response.ToString();
int bytes = await stream.ReadAsync(responseBuffer, 0, responseBuffer.Length);
endLineCode = responseBuffer.Any(x => x == 0x0D);
startMsgCode = responseBuffer.Count(x => x == 0x25) > 1;
if (!endLineCode && !startMsgCode) break;
response.Append(Encoding.UTF8.GetString(responseBuffer, 0, bytes));
}
} catch (Exception) {
if (IsConnected) {
CycleTimeMs = 0;
IsConnected = false;
Disconnected?.Invoke();
}
KillPoller();
Logger.Log("The PLC connection was closed", LogLevel.Error, this);
return null;
while (stream.DataAvailable);
}
} catch (IOException) {
OnMajorSocketExceptionWhileConnected();
return null;
} catch (SocketException) {
OnMajorSocketExceptionWhileConnected();
return null;
}
if(!string.IsNullOrEmpty(response.ToString())) {
Logger.Log($"<-- IN MSG: {response}", LogLevel.Critical, this);
bytesTotalCountedDownstream += Encoding.ASCII.GetByteCount(response.ToString());
var perSecDownstream = (double)((bytesTotalCountedDownstream / speedStopwatchDownstr.Elapsed.TotalMilliseconds) * 1000);
if(perSecUpstream <= 10000)
BytesPerSecondDownstream = (int)Math.Round(perSecUpstream, MidpointRounding.AwayFromZero);
return response.ToString();
} else {
return null;
}
}
#endregion
#region Disposing
/// <summary>
/// Disposes the current interface and clears all its members
/// </summary>
public void Dispose () {
if (Disposed) return;
Disconnect();
GC.SuppressFinalize(this);
Disposed = true;
}
#endregion
@@ -660,4 +925,5 @@ namespace MewtocolNet {
}
}

View File

@@ -112,29 +112,47 @@ namespace MewtocolNet {
/// </summary>
/// <param name="start">Start adress</param>
/// <param name="count">Number of bytes to get</param>
/// <param name="onProgress">Gets invoked when the progress changes, contains the progress as a double</param>
/// <returns>A byte array or null of there was an error</returns>
public async Task<byte[]> ReadByteRange (int start, int count) {
public async Task<byte[]> ReadByteRange (int start, int count, Action<double> onProgress = null) {
var byteList = new List<byte>();
string startStr = start.ToString().PadLeft(5, '0');
var wordLength = count / 2;
bool wasOdd = false;
if (count % 2 != 0)
wordLength++;
string endStr = (start + wordLength - 1).ToString().PadLeft(5, '0');
string requeststring = $"%{GetStationNumber()}#RDD{startStr}{endStr}";
var result = await SendCommandAsync(requeststring);
//read blocks of max 4 words per msg
for (int i = 0; i < wordLength; i+=8) {
if(result.Success && !string.IsNullOrEmpty(result.Response)) {
int curWordStart = start + i;
int curWordEnd = curWordStart + 7;
var bytes = result.Response.ParseDTByteString(wordLength * 4).HexStringToByteArray();
string startStr = curWordStart.ToString().PadLeft(5, '0');
string endStr = (curWordEnd).ToString().PadLeft(5, '0');
return bytes.BigToMixedEndian().Take(count).ToArray();
string requeststring = $"%{GetStationNumber()}#RDD{startStr}{endStr}";
var result = await SendCommandAsync(requeststring);
if (result.Success && !string.IsNullOrEmpty(result.Response)) {
var bytes = result.Response.ParseDTByteString(8 * 4).HexStringToByteArray();
if (bytes == null) {
return null;
}
byteList.AddRange(bytes.BigToMixedEndian().Take(count).ToArray());
}
if(onProgress != null)
onProgress((double)i / wordLength);
}
return null;
return byteList.ToArray();
}
@@ -176,6 +194,7 @@ namespace MewtocolNet {
/// Writes to the given bool register on the PLC
/// </summary>
/// <param name="_toWrite">The register to write to</param>
/// <param name="value">The value to write</param>
/// <returns>The success state of the write operation</returns>
public async Task<bool> WriteBoolRegister (BRegister _toWrite, bool value) {
@@ -183,7 +202,7 @@ namespace MewtocolNet {
var result = await SendCommandAsync(requeststring);
return result.Success && result.Response.StartsWith($"%{ GetStationNumber()}#WC");
return result.Success && result.Response.StartsWith($"%{ GetStationNumber()}$WC");
}
@@ -196,7 +215,6 @@ namespace MewtocolNet {
/// </summary>
/// <typeparam name="T">Type of number (short, ushort, int, uint, float)</typeparam>
/// <param name="_toRead">The register to read</param>
/// <param name="_stationNumber">Station number to access</param>
/// <returns>A result with the given NumberRegister containing the readback value and a result struct</returns>
public async Task<NRegisterResult<T>> ReadNumRegister<T> (NRegister<T> _toRead) {
@@ -205,40 +223,47 @@ namespace MewtocolNet {
string requeststring = $"%{GetStationNumber()}#RD{_toRead.BuildMewtocolIdent()}";
var result = await SendCommandAsync(requeststring);
if(!result.Success || string.IsNullOrEmpty(result.Response)) {
return new NRegisterResult<T> {
Result = result,
Register = _toRead
};
var failedResult = new NRegisterResult<T> {
Result = result,
Register = _toRead
};
if (!result.Success || string.IsNullOrEmpty(result.Response)) {
return failedResult;
}
if (numType == typeof(short)) {
var resultBytes = result.Response.ParseDTByteString(4).ReverseByteOrder();
if (resultBytes == null) return failedResult;
var val = short.Parse(resultBytes, NumberStyles.HexNumber);
_toRead.SetValueFromPLC(val);
} else if (numType == typeof(ushort)) {
var resultBytes = result.Response.ParseDTByteString(4).ReverseByteOrder();
if (resultBytes == null) return failedResult;
var val = ushort.Parse(resultBytes, NumberStyles.HexNumber);
_toRead.SetValueFromPLC(val);
} else if (numType == typeof(int)) {
var resultBytes = result.Response.ParseDTByteString(8).ReverseByteOrder();
if (resultBytes == null) return failedResult;
var val = int.Parse(resultBytes, NumberStyles.HexNumber);
_toRead.SetValueFromPLC(val);
} else if (numType == typeof(uint)) {
var resultBytes = result.Response.ParseDTByteString(8).ReverseByteOrder();
if (resultBytes == null) return failedResult;
var val = uint.Parse(resultBytes, NumberStyles.HexNumber);
_toRead.SetValueFromPLC(val);
} else if (numType == typeof(float)) {
var resultBytes = result.Response.ParseDTByteString(8).ReverseByteOrder();
if (resultBytes == null) return failedResult;
//convert to unsigned int first
var val = uint.Parse(resultBytes, NumberStyles.HexNumber);
@@ -250,6 +275,7 @@ namespace MewtocolNet {
} else if (numType == typeof(TimeSpan)) {
var resultBytes = result.Response.ParseDTByteString(8).ReverseByteOrder();
if (resultBytes == null) return failedResult;
//convert to unsigned int first
var vallong = long.Parse(resultBytes, NumberStyles.HexNumber);
var valMillis = vallong * 10;
@@ -273,7 +299,7 @@ namespace MewtocolNet {
/// </summary>
/// <typeparam name="T">Type of number (short, ushort, int, uint, float)</typeparam>
/// <param name="_toWrite">The register to write</param>
/// <param name="_stationNumber">Station number to access</param>
/// <param name="_value">The value to write</param>
/// <returns>The success state of the write operation</returns>
public async Task<bool> WriteNumRegister<T> (NRegister<T> _toWrite, T _value) {
@@ -313,7 +339,7 @@ namespace MewtocolNet {
var result = await SendCommandAsync(requeststring);
return result.Success && result.Response.StartsWith($"%{ GetStationNumber()}#WD");
return result.Success && result.Response.StartsWith($"%{ GetStationNumber()}$WD");
}
@@ -369,7 +395,7 @@ namespace MewtocolNet {
var result = await SendCommandAsync(requeststring);
return result.Success && result.Response.StartsWith($"%{ GetStationNumber()}#WD");
return result.Success && result.Response.StartsWith($"%{ GetStationNumber()}$WD");
}
#endregion

View File

@@ -6,13 +6,38 @@ namespace MewtocolNet.Registers {
/// All modes
/// </summary>
public class PLCMode {
/// <summary>
/// PLC is running
/// </summary>
public bool RunMode { get; set; }
/// <summary>
/// PLC is in test
/// </summary>
public bool TestRunMode { get; set; }
/// <summary>
/// BreakExcecuting
/// </summary>
public bool BreakExcecuting { get; set; }
/// <summary>
/// BreakValid
/// </summary>
public bool BreakValid { get; set; }
/// <summary>
/// PLC output is enabled
/// </summary>
public bool OutputEnabled { get; set; }
/// <summary>
/// PLC runs step per step
/// </summary>
public bool StepRunMode { get; set; }
/// <summary>
/// Message executing
/// </summary>
public bool MessageExecuting { get; set; }
/// <summary>
/// PLC is in remote mode
/// </summary>
public bool RemoteMode { get; set; }
/// <summary>

View File

@@ -6,22 +6,39 @@ using System.Threading.Tasks;
namespace MewtocolNet.RegisterAttributes {
/// <summary>
/// The size of the bitwise register
/// </summary>
public enum BitCount {
/// <summary>
/// 16 bit
/// </summary>
B16,
/// <summary>
/// 32 bit
/// </summary>
B32
}
/// <summary>
/// Defines the behavior of a register property
/// </summary>
[AttributeUsage(AttributeTargets.Property)]
public class RegisterAttribute : Attribute {
public int MemoryArea;
public int StringLength;
public RegisterType RegisterType;
public SpecialAddress SpecialAddress = SpecialAddress.None;
public BitCount BitCount;
public int AssignedBitIndex = -1;
internal int MemoryArea;
internal int StringLength;
internal RegisterType RegisterType;
internal SpecialAddress SpecialAddress = SpecialAddress.None;
internal BitCount BitCount;
internal int AssignedBitIndex = -1;
/// <summary>
/// Attribute for string type or numeric registers
/// </summary>
/// <param name="memoryArea">The area in the plcs memory</param>
/// <param name="stringLength">The max string length in the plc</param>
public RegisterAttribute (int memoryArea, int stringLength = 1) {
MemoryArea = memoryArea;
@@ -29,6 +46,11 @@ namespace MewtocolNet.RegisterAttributes {
}
/// <summary>
/// Attribute for boolean registers
/// </summary>
/// <param name="memoryArea">The area in the plcs memory</param>
/// <param name="type">The type of boolean register</param>
public RegisterAttribute (int memoryArea, RegisterType type) {
if (type.ToString().StartsWith("DT"))
@@ -40,6 +62,11 @@ namespace MewtocolNet.RegisterAttributes {
}
/// <summary>
/// Attribute for boolean registers
/// </summary>
/// <param name="spAdress">The special area in the plcs memory</param>
/// <param name="type">The type of boolean register</param>
public RegisterAttribute (RegisterType type, SpecialAddress spAdress) {
if (type.ToString().StartsWith("DT"))
@@ -50,7 +77,11 @@ namespace MewtocolNet.RegisterAttributes {
}
/// <summary>
/// Attribute to read numeric registers as bitwise
/// </summary>
/// <param name="memoryArea">The area in the plcs memory</param>
/// <param name="bitcount">The number of bits to parse</param>
public RegisterAttribute (int memoryArea, BitCount bitcount) {
MemoryArea = memoryArea;
@@ -59,6 +90,12 @@ namespace MewtocolNet.RegisterAttributes {
}
/// <summary>
/// Attribute to read numeric registers as bitwise
/// </summary>
/// <param name="memoryArea">The area in the plcs memory</param>
/// <param name="bitcount">The number of bits to parse</param>
/// <param name="assignBit">The index of the bit that gets linked to the bool</param>
public RegisterAttribute (int memoryArea, uint assignBit, BitCount bitcount) {
if(assignBit > 15 && bitcount == BitCount.B16) {

View File

@@ -34,8 +34,17 @@ namespace MewtocolNet.RegisterAttributes {
PropertyChanged?.Invoke(this, new PropertyChangedEventArgs(propertyName));
}
/// <summary>
/// Gets called when the register collection base was linked to its parent mewtocol interface
/// </summary>
/// <param name="plc">The parent interface</param>
public virtual void OnInterfaceLinked (MewtocolInterface plc) { }
/// <summary>
/// Gets called when the register collection base was linked to its parent mewtocol interface
/// and the plc connection is established
/// </summary>
/// <param name="plc">The parent interface</param>
public virtual void OnInterfaceLinkedAndOnline (MewtocolInterface plc) { }
}

View File

@@ -12,8 +12,7 @@ namespace MewtocolNet.Registers {
internal RegisterType RegType { get; private set; }
internal SpecialAddress SpecialAddress { get; private set; }
public bool NeedValue;
public bool LastValue;
internal bool LastValue;
/// <summary>
/// The value of the register
@@ -54,6 +53,9 @@ namespace MewtocolNet.Registers {
}
/// <summary>
/// Builds the register area name
/// </summary>
public override string BuildMewtocolIdent () {
//build area code from register type
@@ -73,9 +75,7 @@ namespace MewtocolNet.Registers {
TriggerChangedEvnt(this);
TriggerNotifyChange();
}
public override string ToString() {
return $"Adress: {MemoryAdress} Val: {Value}";
}
}
}

View File

@@ -1,13 +1,20 @@
namespace MewtocolNet.Registers {
/// <summary>
/// Result for a boolean register
/// </summary>
public class BRegisterResult {
/// <summary>
/// The command result
/// </summary>
public CommandResult Result { get; set; }
/// <summary>
/// The used register
/// </summary>
public BRegister Register { get; set; }
public override string ToString() {
string errmsg = Result.Success ? "" : $", Error [{Result.ErrorDescription}]";
return $"Result [{Result.Success}], Register [{Register.ToString()}]{errmsg}";
}
}
}

View File

@@ -7,8 +7,7 @@ namespace MewtocolNet.Registers {
/// <typeparam name="T">The type of the numeric value</typeparam>
public class NRegister<T> : Register {
public T NeedValue;
public T LastValue;
internal T LastValue;
/// <summary>
/// The value of the register
@@ -19,8 +18,33 @@ namespace MewtocolNet.Registers {
/// Defines a register containing a number
/// </summary>
/// <param name="_adress">Memory start adress max 99999</param>
/// <param name="_format">The format in which the variable is stored</param>
public NRegister(int _adress, string _name = null, bool isBitwise = false) {
/// <param name="_name">Name of the register</param>
public NRegister (int _adress, string _name = null) {
if (_adress > 99999)
throw new NotSupportedException("Memory adresses cant be greater than 99999");
memoryAdress = _adress;
name = _name;
Type numType = typeof(T);
if (numType == typeof(short)) {
memoryLength = 0;
} else if (numType == typeof(ushort)) {
memoryLength = 0;
} else if (numType == typeof(int)) {
memoryLength = 1;
} else if (numType == typeof(uint)) {
memoryLength = 1;
} else if (numType == typeof(float)) {
memoryLength = 1;
} else if (numType == typeof(TimeSpan)) {
memoryLength = 1;
} else {
throw new NotSupportedException($"The type {numType} is not allowed for Number Registers");
}
}
internal NRegister(int _adress, string _name = null, bool isBitwise = false, Type _enumType = null) {
if (_adress > 99999) throw new NotSupportedException("Memory adresses cant be greater than 99999");
memoryAdress = _adress;
@@ -43,6 +67,7 @@ namespace MewtocolNet.Registers {
}
isUsedBitwise = isBitwise;
enumType = _enumType;
}
@@ -52,10 +77,6 @@ namespace MewtocolNet.Registers {
TriggerNotifyChange();
}
public override string ToString() {
return $"Adress: {MemoryAdress} Val: {Value}";
}
}

View File

@@ -1,16 +1,34 @@
namespace MewtocolNet.Registers {
using System;
namespace MewtocolNet.Registers {
/// <summary>
/// Result for a read/write operation
/// </summary>
/// <typeparam name="T">The type of the numeric value</typeparam>
public class NRegisterResult<T> {
/// <summary>
/// Command result
/// </summary>
public CommandResult Result { get; set; }
/// <summary>
/// The used register
/// </summary>
public NRegister<T> Register { get; set; }
public override string ToString() {
string errmsg = Result.Success ? "" : $", Error [{Result.ErrorDescription}]";
return $"Result [{Result.Success}], Register [{Register.ToString()}]{errmsg}";
/// <summary>
/// Trys to get the value of there is one
/// </summary>
public bool TryGetValue (out T value) {
if(Result.Success) {
value = Register.Value;
return true;
}
value = default(T);
return false;
}
}

View File

@@ -67,6 +67,7 @@ namespace MewtocolNet.Registers {
public string ContainerName => GetContainerName();
internal bool isUsedBitwise { get; set; }
internal Type enumType { get; set; }
internal Register () {
ValueChanged += (obj) => {
@@ -74,6 +75,9 @@ namespace MewtocolNet.Registers {
};
}
/// <summary>
/// Builds the register area name
/// </summary>
public virtual string BuildMewtocolIdent() {
StringBuilder asciistring = new StringBuilder("D");
@@ -90,6 +94,38 @@ namespace MewtocolNet.Registers {
PropertyChanged?.Invoke(this, new PropertyChangedEventArgs("Value"));
}
internal void ClearValue () {
if (enumType != null && this is NRegister<int> intEnumReg) {
intEnumReg.SetValueFromPLC((int)0);
}
if (this is NRegister<short> shortReg) {
shortReg.SetValueFromPLC((short)0);
}
if (this is NRegister<ushort> ushortReg) {
ushortReg.SetValueFromPLC((ushort)0);
}
if (this is NRegister<int> intReg) {
intReg.SetValueFromPLC((int)0);
}
if (this is NRegister<uint> uintReg) {
uintReg.SetValueFromPLC((uint)0);
}
if (this is NRegister<float> floatReg) {
floatReg.SetValueFromPLC((float)0);
}
if (this is NRegister<TimeSpan> tsReg) {
tsReg.SetValueFromPLC(TimeSpan.Zero);
}
if (this is BRegister boolReg) {
boolReg.SetValueFromPLC(false);
}
if (this is SRegister stringReg) {
stringReg.SetValueFromPLC(null);
}
}
/// <summary>
/// Gets the starting memory are either numeric or A,B,C,D etc for special areas like inputs
/// </summary>
@@ -110,6 +146,24 @@ namespace MewtocolNet.Registers {
/// <returns></returns>
public string GetValueString () {
if (enumType != null && this is NRegister<int> intEnumReg) {
var dict = new Dictionary<int, string>();
foreach (var name in Enum.GetNames(enumType)) {
int enumKey = (int)Enum.Parse(enumType, name);
if(!dict.ContainsKey(enumKey)) {
dict.Add(enumKey, name);
}
}
if(dict.ContainsKey(intEnumReg.Value)) {
return $"{intEnumReg.Value} ({dict[intEnumReg.Value]})";
} else {
return $"{intEnumReg.Value} (Missing Enum)";
}
}
if (this is NRegister<short> shortReg) {
return $"{shortReg.Value}{(isUsedBitwise ? $" [{shortReg.GetBitwise().ToBitString()}]" : "")}";
}
@@ -132,8 +186,7 @@ namespace MewtocolNet.Registers {
return boolReg.Value.ToString();
}
if (this is SRegister stringReg) {
return stringReg.Value.ToString();
return stringReg.Value ?? "";
}
return "Type of the register is not supported.";
@@ -166,6 +219,9 @@ namespace MewtocolNet.Registers {
}
/// <summary>
/// Gets the register dataarea string DT for 16bit and DDT for 32 bit types
/// </summary>
public string GetRegisterString () {
if (this is NRegister<short> shortReg) {
@@ -212,6 +268,10 @@ namespace MewtocolNet.Registers {
internal string GetRegisterPLCName () {
if (this is BRegister bReg && bReg.SpecialAddress != SpecialAddress.None) {
return $"{GetRegisterString()}{bReg.SpecialAddress}";
}
return $"{GetRegisterString()}{MemoryAdress}";
}

View File

@@ -9,9 +9,12 @@ namespace MewtocolNet.Registers {
private string lastVal = "";
/// <summary>
/// The current value of the register
/// </summary>
public string Value => lastVal;
public short ReservedSize { get; set; }
internal short ReservedSize { get; set; }
/// <summary>
/// Defines a register containing a string
@@ -32,10 +35,9 @@ namespace MewtocolNet.Registers {
memoryLength = (int)Math.Round(wordsize + 1);
}
public override string ToString() {
return $"Adress: {MemoryAdress} Val: {Value}";
}
/// <summary>
/// Builds the register identifier for the mewotocol protocol
/// </summary>
public override string BuildMewtocolIdent() {
StringBuilder asciistring = new StringBuilder("D");
@@ -65,7 +67,6 @@ namespace MewtocolNet.Registers {
TriggerNotifyChange();
}
}
}

View File

@@ -1,15 +1,19 @@
namespace MewtocolNet.Registers {
/// <summary>
/// The results of a string register operation
/// </summary>
public class SRegisterResult {
/// <summary>
/// The command result
/// </summary>
public CommandResult Result { get; set; }
/// <summary>
/// The register definition used
/// </summary>
public SRegister Register { get; set; }
public override string ToString() {
string errmsg = Result.Success ? "" : $", Error [{Result.ErrorDescription}]";
return $"Result [{Result.Success}], Register [{Register.ToString()}]{errmsg}";
}
}
}

View File

@@ -1,8 +1,8 @@
<Project Sdk="Microsoft.NET.Sdk">
<PropertyGroup>
<TargetFramework>netstandard2.0</TargetFramework>
<PackageId>MewtocolNet</PackageId>
<Version>0.3.5</Version>
<PackageId>Mewtocol.NET</PackageId>
<Version>0.6.2</Version>
<Authors>Felix Weiss</Authors>
<Company>Womed</Company>
<GeneratePackageOnBuild>true</GeneratePackageOnBuild>

View File

@@ -0,0 +1,30 @@
using System;
using System.Threading.Tasks;
namespace MewtocolNet.Queue {
internal class SerialQueue {
readonly object _locker = new object();
readonly WeakReference<Task> _lastTask = new WeakReference<Task>(null);
internal Task<T> Enqueue<T> (Func<Task<T>> asyncFunction) {
lock (_locker) {
Task lastTask;
Task<T> resultTask;
if (_lastTask.TryGetTarget(out lastTask)) {
resultTask = lastTask.ContinueWith(_ => asyncFunction(), TaskContinuationOptions.ExecuteSynchronously).Unwrap();
} else {
resultTask = Task.Run(asyncFunction);
}
_lastTask.SetTarget(resultTask);
return resultTask;
}
}
}
}

View File

@@ -1,7 +1,6 @@
[![.NET Windows](https://github.com/WOmed/MewtocolNet/actions/workflows/dotnet-windows.yml/badge.svg)](https://github.com/WOmed/MewtocolNet/actions/workflows/dotnet-windows.yml)
![Nuget](https://img.shields.io/nuget/v/MewtocolNet)
[![Publish to Nuget](https://github.com/WOmed/MewtocolNet/actions/workflows/publish.yml/badge.svg)](https://github.com/WOmed/MewtocolNet/actions/workflows/publish.yml)
[![Nuget](https://img.shields.io/nuget/v/Mewtocol.NET)](https://www.nuget.org/packages/Mewtocol.NET)
![Lines of code](https://img.shields.io/tokei/lines/github/WOmed/MewtocolNet)
![Nuget](https://img.shields.io/nuget/dt/MewtocolNet)
![GitHub](https://img.shields.io/github/license/WOmed/MewtocolNet)
![Status](https://img.shields.io/badge/Status-In%20dev-orange)
@@ -28,7 +27,7 @@ This software was written by WOLF Medizintechnik GmbH (@WOmed/dev).
## .NET Support
This library was written in **netstandard2.0** and should by compatible with a lot of .NET environments.
This library was written in **netstandard2.0** and should be compatible with a lot of .NET environments.
For a full list of supported .NET clrs see [this page](https://docs.microsoft.com/de-de/dotnet/standard/net-standard?tabs=net-standard-2-0#select-net-standard-version)
@@ -51,14 +50,14 @@ Where is the RS232/Serial support?
# Installing
Install this package by using [Nuget](https://www.nuget.org/packages/MewtocolNet/) or reference
Install this package by using [Nuget](https://www.nuget.org/packages/Mewtocol.NET) or reference
```XML
<PackageReference Include="MewtocolNet" Version="0.3.0" />
<PackageReference Include="Mewtocol.NET" Version="0.6.1"/>
```
in your dependencies.
Alternatively use the dotnet CLI and run
```Shell
dotnet add package MewtocolNet
dotnet add package Mewtocol.NET
```
# Protocol description