11 Commits

Author SHA1 Message Date
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
10 changed files with 585 additions and 321 deletions

View File

@@ -4,16 +4,35 @@ using MewtocolNet;
using MewtocolNet.Logging; using MewtocolNet.Logging;
using MewtocolNet.Registers; using MewtocolNet.Registers;
namespace Examples { namespace Examples;
class Program { class Program {
static void Main(string[] args) { static void Main(string[] args) {
Console.WriteLine("Enter your scenario number:\n" +
"1 = Permanent connection\n" +
"2 = Dispose connection");
var line = Console.ReadLine();
if(line == "1") {
Scenario1();
}
if (line == "2") {
Scenario2();
}
Console.ReadLine();
}
static void Scenario1 () {
Task.Factory.StartNew(async () => { Task.Factory.StartNew(async () => {
//attaching the logger //attaching the logger
Logger.LogLevel = LogLevel.Verbose; Logger.LogLevel = LogLevel.Critical;
Logger.OnNewLogMessage((date, msg) => { Logger.OnNewLogMessage((date, msg) => {
Console.WriteLine($"{date.ToString("HH:mm:ss")} {msg}"); Console.WriteLine($"{date.ToString("HH:mm:ss")} {msg}");
}); });
@@ -38,9 +57,16 @@ namespace Examples {
//set plc to run mode if not already //set plc to run mode if not already
await interf.SetOperationMode(OPMode.Run); 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 Task.Delay(2000);
Console.WriteLine("Testregister was toggled"); await interf.SetRegisterAsync(nameof(registers.TestInt32), 100);
//adds 10 each time the plc connects to the PLCs INT regíster //adds 10 each time the plc connects to the PLCs INT regíster
interf.SetRegister(nameof(registers.TestInt16), (short)(registers.TestInt16 + 10)); interf.SetRegister(nameof(registers.TestInt16), (short)(registers.TestInt16 + 10));
@@ -60,7 +86,51 @@ namespace Examples {
}); });
Console.ReadLine();
} }
static void Scenario2 () {
Logger.LogLevel = LogLevel.Critical;
Logger.OnNewLogMessage((date, msg) => {
Console.WriteLine($"{date.ToString("HH:mm:ss")} {msg}");
});
Task.Factory.StartNew(async () => {
using(var interf = new MewtocolInterface("10.237.191.3")) {
await interf.ConnectAsync();
if(interf.IsConnected) {
var plcInf = await interf.GetPLCInfoAsync();
Console.WriteLine(plcInf);
} }
interf.Disconnect();
}
using (var interf = new MewtocolInterface("10.237.191.3")) {
await interf.ConnectAsync();
if (interf.IsConnected) {
var plcInf = await interf.GetPLCInfoAsync();
Console.WriteLine(plcInf);
}
interf.Disconnect();
}
});
}
} }

View File

@@ -10,16 +10,19 @@ namespace Examples {
[Register(1000, RegisterType.R)] [Register(1000, RegisterType.R)]
public bool TestBool1 { get; private set; } public bool TestBool1 { get; private set; }
[Register(1000)]
public int TestDuplicate { get; private set; }
//corresponds to a XD input of the PLC //corresponds to a XD input of the PLC
[Register(RegisterType.X, SpecialAddress.D)] [Register(RegisterType.X, SpecialAddress.D)]
public bool TestBoolInputXD { get; private set; } public bool TestBoolInputXD { get; private set; }
//corresponds to a DT1101 - DT1104 string register in the PLC with (STRING[4]) //corresponds to a DT1101 - DT1104 string register in the PLC with (STRING[4])
[Register(1101, 4)] //[Register(1101, 4)]
public string TestString1 { get; private set; } //public string TestString1 { get; private set; }
//corresponds to a DT7000 16 bit int register in the PLC //corresponds to a DT7000 16 bit int register in the PLC
[Register(7000)] [Register(899)]
public short TestInt16 { get; private set; } public short TestInt16 { get; private set; }
//corresponds to a DTD7001 - DTD7002 32 bit int register in the PLC //corresponds to a DTD7001 - DTD7002 32 bit int register in the PLC

View File

@@ -15,7 +15,6 @@ namespace MewtocolNet {
public partial class MewtocolInterface { public partial class MewtocolInterface {
internal event Action PolledCycle; internal event Action PolledCycle;
internal CancellationTokenSource cTokenAutoUpdater;
internal bool ContinousReaderRunning; internal bool ContinousReaderRunning;
internal bool usePoller = false; internal bool usePoller = false;
@@ -24,7 +23,6 @@ namespace MewtocolNet {
internal void KillPoller () { internal void KillPoller () {
ContinousReaderRunning = false; ContinousReaderRunning = false;
cTokenAutoUpdater?.Cancel();
} }
@@ -33,63 +31,32 @@ namespace MewtocolNet {
/// </summary> /// </summary>
internal void AttachPoller () { internal void AttachPoller () {
if (ContinousReaderRunning) return; if (ContinousReaderRunning)
return;
cTokenAutoUpdater = new CancellationTokenSource();
Logger.Log("Poller is attaching", LogLevel.Info, this);
try {
Task.Factory.StartNew(async () => { Task.Factory.StartNew(async () => {
var plcinf = await GetPLCInfoAsync(); Logger.Log("Poller is attaching", LogLevel.Info, this);
if (plcinf == null) {
Logger.Log("PLC not reachable, stopping logger", LogLevel.Info, this);
return;
}
PolledCycle += MewtocolInterface_PolledCycle;
void MewtocolInterface_PolledCycle () {
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()}");
}
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;
}
int it = 0;
ContinousReaderRunning = true; ContinousReaderRunning = true;
int getPLCinfoCycleCount = 0;
while (ContinousReaderRunning) { while (ContinousReaderRunning) {
//do priority tasks first if (it >= Registers.Count + 1) {
if (PriorityTasks.Count > 0) { it = 0;
//invoke cycle polled event
await PriorityTasks.FirstOrDefault(x => !x.IsCompleted); InvokePolledCycleDone();
continue;
} else if (getPLCinfoCycleCount > 25) {
await GetPLCInfoAsync();
getPLCinfoCycleCount = 0;
} }
foreach (var registerPair in Registers) { if (it >= Registers.Count) {
await GetPLCInfoAsync();
it++;
continue;
}
var reg = registerPair.Value; var reg = Registers[it];
if (reg is NRegister<short> shortReg) { if (reg is NRegister<short> shortReg) {
var lastVal = shortReg.Value; var lastVal = shortReg.Value;
@@ -146,21 +113,13 @@ namespace MewtocolNet {
if (lastVal != readout) { if (lastVal != readout) {
InvokeRegisterChanged(stringReg); InvokeRegisterChanged(stringReg);
} }
}
it++;
} }
} });
getPLCinfoCycleCount++;
//invoke cycle polled event
InvokePolledCycleDone();
}
}, cTokenAutoUpdater.Token);
} catch (TaskCanceledException) { }
} }
@@ -208,7 +167,7 @@ namespace MewtocolNet {
toAdd = new BRegister(_address, _type, _name); toAdd = new BRegister(_address, _type, _name);
} }
Registers.Add(_address, toAdd); Registers.Add(toAdd);
} }
@@ -238,7 +197,7 @@ namespace MewtocolNet {
} }
toAdd.collectionType = _colType; toAdd.collectionType = _colType;
Registers.Add(_address, toAdd); Registers.Add(toAdd);
} }
@@ -259,7 +218,7 @@ namespace MewtocolNet {
public void AddRegister (SpecialAddress _spAddress, RegisterType _type, string _name = null) { public void AddRegister (SpecialAddress _spAddress, RegisterType _type, string _name = null) {
//as bool registers //as bool registers
Registers.Add((int)_spAddress, new BRegister(_spAddress, _type, _name)); Registers.Add(new BRegister(_spAddress, _type, _name));
} }
@@ -270,7 +229,7 @@ namespace MewtocolNet {
reg.collectionType = _colType; reg.collectionType = _colType;
//as bool registers //as bool registers
Registers.Add((int)_spAddress, reg); Registers.Add(reg);
} }
@@ -299,32 +258,35 @@ namespace MewtocolNet {
throw new NotSupportedException($"_lenght parameter only allowed for register of type string"); throw new NotSupportedException($"_lenght parameter only allowed for register of type string");
} }
if (Registers.Any(x => x.Key == _address)) { Register toAdd;
throw new NotSupportedException($"Cannot add a register multiple times, " +
$"make sure that all register attributes or AddRegister assignments have different adresses.");
}
if (regType == typeof(short)) { if (regType == typeof(short)) {
Registers.Add(_address, new NRegister<short>(_address, _name)); toAdd = new NRegister<short>(_address, _name);
} else if (regType == typeof(ushort)) { } else if (regType == typeof(ushort)) {
Registers.Add(_address, new NRegister<ushort>(_address, _name)); toAdd = new NRegister<ushort>(_address, _name);
} else if (regType == typeof(int)) { } else if (regType == typeof(int)) {
Registers.Add(_address, new NRegister<int>(_address, _name)); toAdd = new NRegister<int>(_address, _name);
} else if (regType == typeof(uint)) { } else if (regType == typeof(uint)) {
Registers.Add(_address, new NRegister<uint>(_address, _name)); toAdd = new NRegister<uint>(_address, _name);
} else if (regType == typeof(float)) { } else if (regType == typeof(float)) {
Registers.Add(_address, new NRegister<float>(_address, _name)); toAdd = new NRegister<float>(_address, _name);
} else if (regType == typeof(string)) { } else if (regType == typeof(string)) {
Registers.Add(_address, new SRegister(_address, _length, _name)); toAdd = new SRegister(_address, _length, _name);
} else if (regType == typeof(TimeSpan)) { } else if (regType == typeof(TimeSpan)) {
Registers.Add(_address, new NRegister<TimeSpan>(_address, _name)); toAdd = new NRegister<TimeSpan>(_address, _name);
} else if (regType == typeof(bool)) { } else if (regType == typeof(bool)) {
Registers.Add(_address, new BRegister(_address, RegisterType.R, _name)); toAdd = new BRegister(_address, RegisterType.R, _name);
} else { } else {
throw new NotSupportedException($"The type {regType} is not allowed for Registers \n" + throw new NotSupportedException($"The type {regType} is not allowed for Registers \n" +
$"Allowed are: short, ushort, int, uint, float and string"); $"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, Type _enumType = null) { internal void AddRegister<T> (Type _colType, int _address, int _length = 1, string _name = null, bool _isBitwise = false, Type _enumType = null) {
@@ -335,12 +297,7 @@ namespace MewtocolNet {
throw new NotSupportedException($"_lenght parameter only allowed for register of type string"); throw new NotSupportedException($"_lenght parameter only allowed for register of type string");
} }
if (Registers.Any(x => x.Key == _address) && !_isBitwise) { if (Registers.Any(x => x.MemoryAdress == _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) {
return; return;
} }
@@ -364,15 +321,19 @@ namespace MewtocolNet {
reg = new BRegister(_address, RegisterType.R, _name); reg = new BRegister(_address, RegisterType.R, _name);
} }
if (reg == null) { if (reg == null) {
throw new NotSupportedException($"The type {regType} is not allowed for Registers \n" + throw new NotSupportedException($"The type {regType} is not allowed for Registers \n" +
$"Allowed are: short, ushort, int, uint, float and string"); $"Allowed are: short, ushort, int, uint, float and string");
} else { } 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 +348,7 @@ namespace MewtocolNet {
/// <returns></returns> /// <returns></returns>
public Register GetRegister (string name) { public Register GetRegister (string name) {
return Registers.FirstOrDefault(x => x.Value.Name == name).Value; return Registers.FirstOrDefault(x => x.Name == name);
} }
@@ -398,8 +359,8 @@ namespace MewtocolNet {
/// <returns>A casted register or the <code>default</code> value</returns> /// <returns>A casted register or the <code>default</code> value</returns>
public T GetRegister<T> (string name) where T : Register { public T GetRegister<T> (string name) where T : Register {
try { try {
var reg = Registers.FirstOrDefault(x => x.Value.Name == name); var reg = Registers.FirstOrDefault(x => x.Name == name);
return reg.Value as T; return reg as T;
} catch (InvalidCastException) { } catch (InvalidCastException) {
return default(T); return default(T);
} }
@@ -414,7 +375,7 @@ namespace MewtocolNet {
/// </summary> /// </summary>
public List<Register> GetAllRegisters () { 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); var res = new Regex(@"\%([0-9]{2})\$RD.{8}(.*)...").Match(_onString);
if(res.Success) { if(res.Success) {
string val = res.Groups[2].Value; string val = res.Groups[2].Value;
return val.GetStringFromAsciiHex().Trim(); return val.GetStringFromAsciiHex()?.Trim();
} }
return null; return null;
} }
@@ -143,7 +143,7 @@ namespace MewtocolNet {
internal static string GetStringFromAsciiHex (this string input) { internal static string GetStringFromAsciiHex (this string input) {
if (input.Length % 2 != 0) if (input.Length % 2 != 0)
throw new ArgumentException("input not a hex string"); return null;
byte[] bytes = new byte[input.Length / 2]; byte[] bytes = new byte[input.Length / 2];
for (int i = 0; i < input.Length; i += 2) { for (int i = 0; i < input.Length; i += 2) {
String hex = input.Substring(i, 2); String hex = input.Substring(i, 2);
@@ -158,6 +158,8 @@ namespace MewtocolNet {
} }
internal static byte[] HexStringToByteArray(this string hex) { internal static byte[] HexStringToByteArray(this string hex) {
if (hex == null)
return null;
return Enumerable.Range(0, hex.Length) return Enumerable.Range(0, hex.Length)
.Where(x => x % 2 == 0) .Where(x => x % 2 == 0)
.Select(x => Convert.ToByte(hex.Substring(x, 2), 16)) .Select(x => Convert.ToByte(hex.Substring(x, 2), 16))

View File

@@ -12,13 +12,16 @@ using MewtocolNet.Logging;
using System.Collections; using System.Collections;
using System.Diagnostics; using System.Diagnostics;
using System.ComponentModel; using System.ComponentModel;
using System.Net;
using System.Threading;
using MewtocolNet.Queue;
namespace MewtocolNet { namespace MewtocolNet {
/// <summary> /// <summary>
/// The PLC com interface class /// The PLC com interface class
/// </summary> /// </summary>
public partial class MewtocolInterface : INotifyPropertyChanged { public partial class MewtocolInterface : INotifyPropertyChanged, IDisposable {
/// <summary> /// <summary>
/// Gets triggered when the PLC connection was established /// Gets triggered when the PLC connection was established
@@ -40,6 +43,15 @@ namespace MewtocolNet {
/// </summary> /// </summary>
public event PropertyChangedEventHandler PropertyChanged; public event PropertyChangedEventHandler PropertyChanged;
private int connectTimeout = 1000;
/// <summary>
/// The initial connection timeout in milliseconds
/// </summary>
public int ConnectTimeout {
get { return connectTimeout; }
set { connectTimeout = value; }
}
private bool isConnected; private bool isConnected;
/// <summary> /// <summary>
/// The current connection state of the interface /// The current connection state of the interface
@@ -52,6 +64,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; private PLCInfo plcInfo;
/// <summary> /// <summary>
/// Generic information about the connected PLC /// Generic information about the connected PLC
@@ -67,11 +89,12 @@ namespace MewtocolNet {
/// <summary> /// <summary>
/// The registered data registers of the PLC /// The registered data registers of the PLC
/// </summary> /// </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 string ip;
private int port; private int port;
private int stationNumber; private int stationNumber;
private int cycleTimeMs = 25;
/// <summary> /// <summary>
/// The current IP of the PLC connection /// The current IP of the PLC connection
@@ -86,7 +109,6 @@ namespace MewtocolNet {
/// </summary> /// </summary>
public int StationNumber => stationNumber; public int StationNumber => stationNumber;
private int cycleTimeMs;
/// <summary> /// <summary>
/// The duration of the last message cycle /// The duration of the last message cycle
/// </summary> /// </summary>
@@ -98,8 +120,12 @@ namespace MewtocolNet {
} }
} }
internal NetworkStream stream;
internal List<Task> PriorityTasks { get; set; } = new List<Task>(); internal TcpClient client;
internal readonly SerialQueue queue = new SerialQueue();
private int RecBufferSize = 128;
internal int SendExceptionsInRow = 0;
internal bool ImportantTaskRunning = false;
#region Initialization #region Initialization
@@ -129,7 +155,6 @@ namespace MewtocolNet {
RegisterChanged += (o) => { RegisterChanged += (o) => {
string address = $"{o.GetRegisterString()}{o.MemoryAdress}".PadRight(5, (char)32); string address = $"{o.GetRegisterString()}{o.MemoryAdress}".PadRight(5, (char)32);
;
Logger.Log($"{address} " + Logger.Log($"{address} " +
$"{(o.Name != null ? $"({o.Name}) " : "")}" + $"{(o.Name != null ? $"({o.Name}) " : "")}" +
@@ -193,6 +218,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> /// <summary>
/// Attaches a poller to the interface that continously /// Attaches a poller to the interface that continously
/// polls the registered data registers and writes the values to them /// polls the registered data registers and writes the values to them
@@ -207,6 +261,70 @@ namespace MewtocolNet {
#endregion #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 {
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) {
OnMajorSocketExceptionWhileConnecting();
return;
}
stream = client.GetStream();
stream.ReadTimeout = 1000;
Console.WriteLine($"Connected {client.Connected}");
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();
}
}
#endregion
#region Register Collection #region Register Collection
/// <summary> /// <summary>
@@ -319,8 +437,11 @@ namespace MewtocolNet {
var bytes = BitConverter.GetBytes(reg16.Value); var bytes = BitConverter.GetBytes(reg16.Value);
BitArray bitAr = new BitArray(bytes); BitArray bitAr = new BitArray(bytes);
if (bitIndex < bitAr.Length && bitIndex >= 0) {
prop.SetValue(collection, bitAr[bitIndex]); prop.SetValue(collection, bitAr[bitIndex]);
collection.TriggerPropertyChanged(prop.Name); collection.TriggerPropertyChanged(prop.Name);
}
} else if (bitWiseFound != null && reg is NRegister<int> reg32) { } else if (bitWiseFound != null && reg is NRegister<int> reg32) {
var casted = (RegisterAttribute)bitWiseFound; var casted = (RegisterAttribute)bitWiseFound;
@@ -384,6 +505,10 @@ namespace MewtocolNet {
foundToUpdate.SetValue(collection, ((NRegister<int>)reg).Value); foundToUpdate.SetValue(collection, ((NRegister<int>)reg).Value);
} }
if (foundToUpdate.PropertyType == typeof(TimeSpan)) {
foundToUpdate.SetValue(collection, ((NRegister<TimeSpan>)reg).Value);
}
//setting back strings //setting back strings
if (foundToUpdate.PropertyType == typeof(string)) { if (foundToUpdate.PropertyType == typeof(string)) {
@@ -526,7 +651,6 @@ namespace MewtocolNet {
/// Calculates checksum and sends a command to the PLC then awaits results /// Calculates checksum and sends a command to the PLC then awaits results
/// </summary> /// </summary>
/// <param name="_msg">MEWTOCOL Formatted request string ex: %01#RT</param> /// <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> /// <returns>Returns the result</returns>
public async Task<CommandResult> SendCommandAsync (string _msg) { public async Task<CommandResult> SendCommandAsync (string _msg) {
@@ -534,27 +658,9 @@ namespace MewtocolNet {
_msg += "\r"; _msg += "\r";
//send request //send request
try {
string response = null; var response = await queue.Enqueue(() => SendSingleBlock(_msg));
if (ContinousReaderRunning) {
//if the poller is active then add all messages to a qeueue
var awaittask = SendSingleBlock(_msg);
PriorityTasks.Add(awaittask);
awaittask.Wait();
PriorityTasks.Remove(awaittask);
response = awaittask.Result;
} else {
//poller not active let the user manage message timing
response = await SendSingleBlock(_msg);
}
if (response == null) { if (response == null) {
return new CommandResult { return new CommandResult {
@@ -572,7 +678,7 @@ namespace MewtocolNet {
string eDes = Links.LinkedData.ErrorCodes[Convert.ToInt32(eCode)]; string eDes = Links.LinkedData.ErrorCodes[Convert.ToInt32(eCode)];
Console.ForegroundColor = ConsoleColor.Red; Console.ForegroundColor = ConsoleColor.Red;
Console.WriteLine($"Response is: {response}"); Console.WriteLine($"Response is: {response}");
Console.WriteLine($"Error on command {_msg.Replace("\r", "")} the PLC returned error code: {eCode}, {eDes}"); Logger.Log($"Error on command {_msg.Replace("\r", "")} the PLC returned error code: {eCode}, {eDes}", LogLevel.Error);
Console.ResetColor(); Console.ResetColor();
return new CommandResult { return new CommandResult {
Success = false, Success = false,
@@ -587,64 +693,93 @@ namespace MewtocolNet {
Response = response.ToString() Response = response.ToString()
}; };
} catch {
return new CommandResult {
Success = false,
Error = "0000",
ErrorDescription = "null result"
};
}
} }
private async Task<string> SendSingleBlock (string _blockString) { private async Task<string> SendSingleBlock (string _blockString) {
Stopwatch sw = Stopwatch.StartNew(); if (client == null || !client.Connected ) {
await ConnectTCP();
if (!client.Connected)
return null;
}
using (TcpClient client = new TcpClient() { ReceiveBufferSize = 64, NoDelay = true, ExclusiveAddressUse = true }) {
try {
await client.ConnectAsync(ip, port);
using (NetworkStream stream = client.GetStream()) {
var message = _blockString.ToHexASCIIBytes(); var message = _blockString.ToHexASCIIBytes();
var messageAscii = BitConverter.ToString(message).Replace("-", " ");
//send request //send request
using (var sendStream = new MemoryStream(message)) { using (var sendStream = new MemoryStream(message)) {
await sendStream.CopyToAsync(stream); await sendStream.CopyToAsync(stream);
Logger.Log($"OUT MSG: {_blockString}", LogLevel.Critical, this); Logger.Log($"[--------------------------------]", LogLevel.Critical, this);
//log message sent Logger.Log($"--> OUT MSG: {_blockString}", LogLevel.Critical, this);
ASCIIEncoding enc = new ASCIIEncoding();
string characters = enc.GetString(message);
} }
//await result //await result
StringBuilder response = new StringBuilder(); StringBuilder response = new StringBuilder();
byte[] responseBuffer = new byte[256]; try {
byte[] responseBuffer = new byte[128 * 16];
bool endLineCode = false;
bool startMsgCode = false;
while (!endLineCode && !startMsgCode) {
do { do {
int bytes = stream.Read(responseBuffer, 0, responseBuffer.Length); 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)); response.Append(Encoding.UTF8.GetString(responseBuffer, 0, bytes));
} }
while (stream.DataAvailable); 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();
} }
} catch (Exception) { } catch (IOException) {
Logger.Log($"Critical IO exception on receive", LogLevel.Critical, this);
if (IsConnected) {
CycleTimeMs = 0;
IsConnected = false;
Disconnected?.Invoke();
}
KillPoller();
Logger.Log("The PLC connection was closed", LogLevel.Error, this);
return null; return null;
} catch (SocketException) {
OnMajorSocketExceptionWhileConnected();
return null;
}
if(!string.IsNullOrEmpty(response.ToString())) {
Logger.Log($"<-- IN MSG: {response}", LogLevel.Critical, this);
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 #endregion
@@ -663,4 +798,5 @@ namespace MewtocolNet {
} }
} }

View File

@@ -115,26 +115,40 @@ namespace MewtocolNet {
/// <returns>A byte array or null of there was an error</returns> /// <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) {
string startStr = start.ToString().PadLeft(5, '0'); var byteList = new List<byte>();
var wordLength = count / 2; var wordLength = count / 2;
bool wasOdd = false;
if (count % 2 != 0) if (count % 2 != 0)
wordLength++; wordLength++;
string endStr = (start + wordLength - 1).ToString().PadLeft(5, '0');
//read blocks of max 4 words per msg
for (int i = 0; i < wordLength; i+=8) {
int curWordStart = start + i;
int curWordEnd = curWordStart + 7;
string startStr = curWordStart.ToString().PadLeft(5, '0');
string endStr = (curWordEnd).ToString().PadLeft(5, '0');
string requeststring = $"%{GetStationNumber()}#RDD{startStr}{endStr}"; string requeststring = $"%{GetStationNumber()}#RDD{startStr}{endStr}";
var result = await SendCommandAsync(requeststring); var result = await SendCommandAsync(requeststring);
if(result.Success && !string.IsNullOrEmpty(result.Response)) { if (result.Success && !string.IsNullOrEmpty(result.Response)) {
var bytes = result.Response.ParseDTByteString(wordLength * 4).HexStringToByteArray(); var bytes = result.Response.ParseDTByteString(8 * 4).HexStringToByteArray();
return bytes.BigToMixedEndian().Take(count).ToArray(); if (bytes == null) {
return null;
}
byteList.AddRange(bytes.BigToMixedEndian().Take(count).ToArray());
} }
return null; }
return byteList.ToArray();
} }
@@ -196,7 +210,6 @@ namespace MewtocolNet {
/// </summary> /// </summary>
/// <typeparam name="T">Type of number (short, ushort, int, uint, float)</typeparam> /// <typeparam name="T">Type of number (short, ushort, int, uint, float)</typeparam>
/// <param name="_toRead">The register to read</param> /// <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> /// <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) { public async Task<NRegisterResult<T>> ReadNumRegister<T> (NRegister<T> _toRead) {
@@ -205,40 +218,47 @@ namespace MewtocolNet {
string requeststring = $"%{GetStationNumber()}#RD{_toRead.BuildMewtocolIdent()}"; string requeststring = $"%{GetStationNumber()}#RD{_toRead.BuildMewtocolIdent()}";
var result = await SendCommandAsync(requeststring); var result = await SendCommandAsync(requeststring);
if(!result.Success || string.IsNullOrEmpty(result.Response)) { var failedResult = new NRegisterResult<T> {
return new NRegisterResult<T> {
Result = result, Result = result,
Register = _toRead Register = _toRead
}; };
if (!result.Success || string.IsNullOrEmpty(result.Response)) {
return failedResult;
} }
if (numType == typeof(short)) { if (numType == typeof(short)) {
var resultBytes = result.Response.ParseDTByteString(4).ReverseByteOrder(); var resultBytes = result.Response.ParseDTByteString(4).ReverseByteOrder();
if (resultBytes == null) return failedResult;
var val = short.Parse(resultBytes, NumberStyles.HexNumber); var val = short.Parse(resultBytes, NumberStyles.HexNumber);
_toRead.SetValueFromPLC(val); _toRead.SetValueFromPLC(val);
} else if (numType == typeof(ushort)) { } else if (numType == typeof(ushort)) {
var resultBytes = result.Response.ParseDTByteString(4).ReverseByteOrder(); var resultBytes = result.Response.ParseDTByteString(4).ReverseByteOrder();
if (resultBytes == null) return failedResult;
var val = ushort.Parse(resultBytes, NumberStyles.HexNumber); var val = ushort.Parse(resultBytes, NumberStyles.HexNumber);
_toRead.SetValueFromPLC(val); _toRead.SetValueFromPLC(val);
} else if (numType == typeof(int)) { } else if (numType == typeof(int)) {
var resultBytes = result.Response.ParseDTByteString(8).ReverseByteOrder(); var resultBytes = result.Response.ParseDTByteString(8).ReverseByteOrder();
if (resultBytes == null) return failedResult;
var val = int.Parse(resultBytes, NumberStyles.HexNumber); var val = int.Parse(resultBytes, NumberStyles.HexNumber);
_toRead.SetValueFromPLC(val); _toRead.SetValueFromPLC(val);
} else if (numType == typeof(uint)) { } else if (numType == typeof(uint)) {
var resultBytes = result.Response.ParseDTByteString(8).ReverseByteOrder(); var resultBytes = result.Response.ParseDTByteString(8).ReverseByteOrder();
if (resultBytes == null) return failedResult;
var val = uint.Parse(resultBytes, NumberStyles.HexNumber); var val = uint.Parse(resultBytes, NumberStyles.HexNumber);
_toRead.SetValueFromPLC(val); _toRead.SetValueFromPLC(val);
} else if (numType == typeof(float)) { } else if (numType == typeof(float)) {
var resultBytes = result.Response.ParseDTByteString(8).ReverseByteOrder(); var resultBytes = result.Response.ParseDTByteString(8).ReverseByteOrder();
if (resultBytes == null) return failedResult;
//convert to unsigned int first //convert to unsigned int first
var val = uint.Parse(resultBytes, NumberStyles.HexNumber); var val = uint.Parse(resultBytes, NumberStyles.HexNumber);
@@ -250,6 +270,7 @@ namespace MewtocolNet {
} else if (numType == typeof(TimeSpan)) { } else if (numType == typeof(TimeSpan)) {
var resultBytes = result.Response.ParseDTByteString(8).ReverseByteOrder(); var resultBytes = result.Response.ParseDTByteString(8).ReverseByteOrder();
if (resultBytes == null) return failedResult;
//convert to unsigned int first //convert to unsigned int first
var vallong = long.Parse(resultBytes, NumberStyles.HexNumber); var vallong = long.Parse(resultBytes, NumberStyles.HexNumber);
var valMillis = vallong * 10; var valMillis = vallong * 10;

View File

@@ -145,7 +145,7 @@ namespace MewtocolNet.Registers {
return boolReg.Value.ToString(); return boolReg.Value.ToString();
} }
if (this is SRegister stringReg) { if (this is SRegister stringReg) {
return stringReg.Value.ToString(); return stringReg.Value ?? "";
} }
return "Type of the register is not supported."; return "Type of the register is not supported.";

View File

@@ -2,7 +2,7 @@
<PropertyGroup> <PropertyGroup>
<TargetFramework>netstandard2.0</TargetFramework> <TargetFramework>netstandard2.0</TargetFramework>
<PackageId>MewtocolNet</PackageId> <PackageId>MewtocolNet</PackageId>
<Version>0.4.0</Version> <Version>0.5.0</Version>
<Authors>Felix Weiss</Authors> <Authors>Felix Weiss</Authors>
<Company>Womed</Company> <Company>Womed</Company>
<GeneratePackageOnBuild>true</GeneratePackageOnBuild> <GeneratePackageOnBuild>true</GeneratePackageOnBuild>

View File

@@ -0,0 +1,71 @@
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 Enqueue (Action action) {
return Enqueue<bool>(() => {
action();
return true;
});
}
internal Task<T> Enqueue<T> (Func<T> function) {
lock (_locker) {
Task lastTask;
Task<T> resultTask;
if (_lastTask.TryGetTarget(out lastTask)) {
resultTask = lastTask.ContinueWith(_ => function(), TaskContinuationOptions.ExecuteSynchronously);
} else {
resultTask = Task.Run(function);
}
_lastTask.SetTarget(resultTask);
return resultTask;
}
}
internal Task Enqueue (Func<Task> asyncAction) {
lock (_locker) {
Task lastTask;
Task resultTask;
if (_lastTask.TryGetTarget(out lastTask)) {
resultTask = lastTask.ContinueWith(_ => asyncAction(), TaskContinuationOptions.ExecuteSynchronously).Unwrap();
} else {
resultTask = Task.Run(asyncAction);
}
_lastTask.SetTarget(resultTask);
return resultTask;
}
}
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

@@ -28,7 +28,7 @@ This software was written by WOLF Medizintechnik GmbH (@WOmed/dev).
## .NET Support ## .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) 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)
@@ -53,7 +53,7 @@ Where is the RS232/Serial support?
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/MewtocolNet/) or reference
```XML ```XML
<PackageReference Include="MewtocolNet" Version="0.3.0" /> <PackageReference Include="MewtocolNet" Version="0.5.0" />
``` ```
in your dependencies. in your dependencies.
Alternatively use the dotnet CLI and run Alternatively use the dotnet CLI and run