123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645 |
- using S7.Net.Types;
- using System;
- using System.Collections.Generic;
- using System.IO;
- using System.Linq;
- using System.Net.Sockets;
- using System.Threading.Tasks;
- using S7.Net.Protocol;
- using System.Threading;
- using S7.Net.Protocol.S7;
- namespace S7.Net
- {
- /// <summary>
- /// Creates an instance of S7.Net driver
- /// </summary>
- public partial class Plc
- {
- /// <summary>
- /// Connects to the PLC and performs a COTP ConnectionRequest and S7 CommunicationSetup.
- /// </summary>
- /// <param name="cancellationToken">The token to monitor for cancellation requests. The default value is None.
- /// Please note that the cancellation will not affect opening the socket in any way and only affects data transfers for configuring the connection after the socket connection is successfully established.
- /// Please note that cancellation is advisory/cooperative and will not lead to immediate cancellation in all cases.</param>
- /// <returns>A task that represents the asynchronous open operation.</returns>
- public async Task OpenAsync(CancellationToken cancellationToken = default)
- {
- var stream = await ConnectAsync(cancellationToken).ConfigureAwait(false);
- try
- {
- await queue.Enqueue(async () =>
- {
- cancellationToken.ThrowIfCancellationRequested();
- await EstablishConnection(stream, cancellationToken).ConfigureAwait(false);
- _stream = stream;
- return default(object);
- }).ConfigureAwait(false);
- }
- catch (Exception)
- {
- stream.Dispose();
- throw;
- }
- }
- private async Task<NetworkStream> ConnectAsync(CancellationToken cancellationToken)
- {
- tcpClient = new TcpClient();
- ConfigureConnection();
- #if NET5_0_OR_GREATER
- await tcpClient.ConnectAsync(IP, Port, cancellationToken).ConfigureAwait(false);
- #else
- await tcpClient.ConnectAsync(IP, Port).ConfigureAwait(false);
- #endif
- return tcpClient.GetStream();
- }
- private async Task EstablishConnection(Stream stream, CancellationToken cancellationToken)
- {
- await RequestConnection(stream, cancellationToken).ConfigureAwait(false);
- await SetupConnection(stream, cancellationToken).ConfigureAwait(false);
- }
- private async Task RequestConnection(Stream stream, CancellationToken cancellationToken)
- {
- var requestData = ConnectionRequest.GetCOTPConnectionRequest(TsapPair);
- var response = await NoLockRequestTpduAsync(stream, requestData, cancellationToken).ConfigureAwait(false);
- if (response.PDUType != COTP.PduType.ConnectionConfirmed)
- {
- throw new InvalidDataException("Connection request was denied", response.TPkt.Data, 1, 0x0d);
- }
- }
- private async Task SetupConnection(Stream stream, CancellationToken cancellationToken)
- {
- var setupData = GetS7ConnectionSetup();
- var s7data = await NoLockRequestTsduAsync(stream, setupData, 0, setupData.Length, cancellationToken)
- .ConfigureAwait(false);
- if (s7data.Length < 2)
- throw new WrongNumberOfBytesException("Not enough data received in response to Communication Setup");
- //Check for S7 Ack Data
- if (s7data[1] != 0x03)
- throw new InvalidDataException("Error reading Communication Setup response", s7data, 1, 0x03);
- if (s7data.Length < 20)
- throw new WrongNumberOfBytesException("Not enough data received in response to Communication Setup");
- // TODO: check if this should not rather be UInt16.
- MaxPDUSize = s7data[18] * 256 + s7data[19];
- }
- /// <summary>
- /// Reads a number of bytes from a DB starting from a specified index. This handles more than 200 bytes with multiple requests.
- /// If the read was not successful, check LastErrorCode or LastErrorString.
- /// </summary>
- /// <param name="dataType">Data type of the memory area, can be DB, Timer, Counter, Merker(Memory), Input, Output.</param>
- /// <param name="db">Address of the memory area (if you want to read DB1, this is set to 1). This must be set also for other memory area types: counters, timers,etc.</param>
- /// <param name="startByteAdr">Start byte address. If you want to read DB1.DBW200, this is 200.</param>
- /// <param name="count">Byte count, if you want to read 120 bytes, set this to 120.</param>
- /// <param name="cancellationToken">The token to monitor for cancellation requests. The default value is None.
- /// Please note that cancellation is advisory/cooperative and will not lead to immediate cancellation in all cases.</param>
- /// <returns>Returns the bytes in an array</returns>
- public async Task<byte[]> ReadBytesAsync(DataType dataType, int db, int startByteAdr, int count, CancellationToken cancellationToken = default)
- {
- var resultBytes = new byte[count];
- await ReadBytesAsync(resultBytes, dataType, db, startByteAdr, cancellationToken).ConfigureAwait(false);
- return resultBytes;
- }
- /// <summary>
- /// Reads a number of bytes from a DB starting from a specified index. This handles more than 200 bytes with multiple requests.
- /// If the read was not successful, check LastErrorCode or LastErrorString.
- /// </summary>
- /// <param name="buffer">Buffer to receive the read bytes. The <see cref="Memory{T}.Length"/> determines the number of bytes to read.</param>
- /// <param name="dataType">Data type of the memory area, can be DB, Timer, Counter, Merker(Memory), Input, Output.</param>
- /// <param name="db">Address of the memory area (if you want to read DB1, this is set to 1). This must be set also for other memory area types: counters, timers,etc.</param>
- /// <param name="startByteAdr">Start byte address. If you want to read DB1.DBW200, this is 200.</param>
- /// <param name="cancellationToken">The token to monitor for cancellation requests. The default value is None.
- /// Please note that cancellation is advisory/cooperative and will not lead to immediate cancellation in all cases.</param>
- /// <returns>Returns the bytes in an array</returns>
- public async Task ReadBytesAsync(Memory<byte> buffer, DataType dataType, int db, int startByteAdr, CancellationToken cancellationToken = default)
- {
- int index = 0;
- while (buffer.Length > 0)
- {
- //This works up to MaxPDUSize-1 on SNAP7. But not MaxPDUSize-0.
- var maxToRead = Math.Min(buffer.Length, MaxPDUSize - 18);
- await ReadBytesWithSingleRequestAsync(dataType, db, startByteAdr + index, buffer.Slice(0, maxToRead), cancellationToken).ConfigureAwait(false);
- buffer = buffer.Slice(maxToRead);
- index += maxToRead;
- }
- }
- /// <summary>
- /// Read and decode a certain number of bytes of the "VarType" provided.
- /// This can be used to read multiple consecutive variables of the same type (Word, DWord, Int, etc).
- /// If the read was not successful, check LastErrorCode or LastErrorString.
- /// </summary>
- /// <param name="dataType">Data type of the memory area, can be DB, Timer, Counter, Merker(Memory), Input, Output.</param>
- /// <param name="db">Address of the memory area (if you want to read DB1, this is set to 1). This must be set also for other memory area types: counters, timers,etc.</param>
- /// <param name="startByteAdr">Start byte address. If you want to read DB1.DBW200, this is 200.</param>
- /// <param name="varType">Type of the variable/s that you are reading</param>
- /// <param name="bitAdr">Address of bit. If you want to read DB1.DBX200.6, set 6 to this parameter.</param>
- /// <param name="varCount"></param>
- /// <param name="cancellationToken">The token to monitor for cancellation requests. The default value is None.
- /// Please note that cancellation is advisory/cooperative and will not lead to immediate cancellation in all cases.</param>
- public async Task<object?> ReadAsync(DataType dataType, int db, int startByteAdr, VarType varType, int varCount, byte bitAdr = 0, CancellationToken cancellationToken = default)
- {
- int cntBytes = VarTypeToByteLength(varType, varCount);
- byte[] bytes = await ReadBytesAsync(dataType, db, startByteAdr, cntBytes, cancellationToken).ConfigureAwait(false);
- return ParseBytes(varType, bytes, varCount, bitAdr);
- }
- /// <summary>
- /// Reads a single variable from the PLC, takes in input strings like "DB1.DBX0.0", "DB20.DBD200", "MB20", "T45", etc.
- /// If the read was not successful, check LastErrorCode or LastErrorString.
- /// </summary>
- /// <param name="variable">Input strings like "DB1.DBX0.0", "DB20.DBD200", "MB20", "T45", etc.</param>
- /// <param name="cancellationToken">The token to monitor for cancellation requests. The default value is None.
- /// Please note that cancellation is advisory/cooperative and will not lead to immediate cancellation in all cases.</param>
- /// <returns>Returns an object that contains the value. This object must be cast accordingly.</returns>
- public async Task<object?> ReadAsync(string variable, CancellationToken cancellationToken = default)
- {
- var adr = new PLCAddress(variable);
- return await ReadAsync(adr.DataType, adr.DbNumber, adr.StartByte, adr.VarType, 1, (byte)adr.BitNumber, cancellationToken).ConfigureAwait(false);
- }
- /// <summary>
- /// Reads all the bytes needed to fill a struct in C#, starting from a certain address, and return an object that can be casted to the struct.
- /// </summary>
- /// <param name="structType">Type of the struct to be readed (es.: TypeOf(MyStruct)).</param>
- /// <param name="db">Address of the DB.</param>
- /// <param name="startByteAdr">Start byte address. If you want to read DB1.DBW200, this is 200.</param>
- /// <param name="cancellationToken">The token to monitor for cancellation requests. The default value is None.
- /// Please note that cancellation is advisory/cooperative and will not lead to immediate cancellation in all cases.</param>
- /// <returns>Returns a struct that must be cast.</returns>
- public async Task<object?> ReadStructAsync(Type structType, int db, int startByteAdr = 0, CancellationToken cancellationToken = default)
- {
- int numBytes = Types.Struct.GetStructSize(structType);
- // now read the package
- var resultBytes = await ReadBytesAsync(DataType.DataBlock, db, startByteAdr, numBytes, cancellationToken).ConfigureAwait(false);
- // and decode it
- return Types.Struct.FromBytes(structType, resultBytes);
- }
- /// <summary>
- /// Reads all the bytes needed to fill a struct in C#, starting from a certain address, and returns the struct or null if nothing was read.
- /// </summary>
- /// <typeparam name="T">The struct type</typeparam>
- /// <param name="db">Address of the DB.</param>
- /// <param name="startByteAdr">Start byte address. If you want to read DB1.DBW200, this is 200.</param>
- /// <param name="cancellationToken">The token to monitor for cancellation requests. The default value is None.
- /// Please note that cancellation is advisory/cooperative and will not lead to immediate cancellation in all cases.</param>
- /// <returns>Returns a nulable struct. If nothing was read null will be returned.</returns>
- public async Task<T?> ReadStructAsync<T>(int db, int startByteAdr = 0, CancellationToken cancellationToken = default) where T : struct
- {
- return await ReadStructAsync(typeof(T), db, startByteAdr, cancellationToken).ConfigureAwait(false) as T?;
- }
- /// <summary>
- /// Reads all the bytes needed to fill a class in C#, starting from a certain address, and set all the properties values to the value that are read from the PLC.
- /// This reads only properties, it doesn't read private variable or public variable without {get;set;} specified.
- /// </summary>
- /// <param name="sourceClass">Instance of the class that will store the values</param>
- /// <param name="db">Index of the DB; es.: 1 is for DB1</param>
- /// <param name="startByteAdr">Start byte address. If you want to read DB1.DBW200, this is 200.</param>
- /// <param name="cancellationToken">The token to monitor for cancellation requests. The default value is None.
- /// Please note that cancellation is advisory/cooperative and will not lead to immediate cancellation in all cases.</param>
- /// <returns>The number of read bytes</returns>
- public async Task<Tuple<int, object>> ReadClassAsync(object sourceClass, int db, int startByteAdr = 0, CancellationToken cancellationToken = default)
- {
- int numBytes = (int)Class.GetClassSize(sourceClass);
- if (numBytes <= 0)
- {
- throw new Exception("The size of the class is less than 1 byte and therefore cannot be read");
- }
- // now read the package
- var resultBytes = await ReadBytesAsync(DataType.DataBlock, db, startByteAdr, numBytes, cancellationToken).ConfigureAwait(false);
- // and decode it
- Class.FromBytes(sourceClass, resultBytes);
- return new Tuple<int, object>(resultBytes.Length, sourceClass);
- }
- /// <summary>
- /// Reads all the bytes needed to fill a class in C#, starting from a certain address, and set all the properties values to the value that are read from the PLC.
- /// This reads only properties, it doesn't read private variable or public variable without {get;set;} specified. To instantiate the class defined by the generic
- /// type, the class needs a default constructor.
- /// </summary>
- /// <typeparam name="T">The class that will be instantiated. Requires a default constructor</typeparam>
- /// <param name="db">Index of the DB; es.: 1 is for DB1</param>
- /// <param name="startByteAdr">Start byte address. If you want to read DB1.DBW200, this is 200.</param>
- /// <param name="cancellationToken">The token to monitor for cancellation requests. The default value is None.
- /// Please note that cancellation is advisory/cooperative and will not lead to immediate cancellation in all cases.</param>
- /// <returns>An instance of the class with the values read from the PLC. If no data has been read, null will be returned</returns>
- public async Task<T?> ReadClassAsync<T>(int db, int startByteAdr = 0, CancellationToken cancellationToken = default) where T : class
- {
- return await ReadClassAsync(() => Activator.CreateInstance<T>(), db, startByteAdr, cancellationToken).ConfigureAwait(false);
- }
- /// <summary>
- /// Reads all the bytes needed to fill a class in C#, starting from a certain address, and set all the properties values to the value that are read from the PLC.
- /// This reads only properties, it doesn't read private variable or public variable without {get;set;} specified.
- /// </summary>
- /// <typeparam name="T">The class that will be instantiated</typeparam>
- /// <param name="classFactory">Function to instantiate the class</param>
- /// <param name="db">Index of the DB; es.: 1 is for DB1</param>
- /// <param name="startByteAdr">Start byte address. If you want to read DB1.DBW200, this is 200.</param>
- /// <param name="cancellationToken">The token to monitor for cancellation requests. The default value is None.
- /// Please note that cancellation is advisory/cooperative and will not lead to immediate cancellation in all cases.</param>
- /// <returns>An instance of the class with the values read from the PLC. If no data has been read, null will be returned</returns>
- public async Task<T?> ReadClassAsync<T>(Func<T> classFactory, int db, int startByteAdr = 0, CancellationToken cancellationToken = default) where T : class
- {
- var instance = classFactory();
- var res = await ReadClassAsync(instance, db, startByteAdr, cancellationToken).ConfigureAwait(false);
- int readBytes = res.Item1;
- if (readBytes <= 0)
- {
- return null;
- }
- return (T)res.Item2;
- }
- /// <summary>
- /// Reads multiple vars in a single request.
- /// You have to create and pass a list of DataItems and you obtain in response the same list with the values.
- /// Values are stored in the property "Value" of the dataItem and are already converted.
- /// If you don't want the conversion, just create a dataItem of bytes.
- /// The number of DataItems as well as the total size of the requested data can not exceed a certain limit (protocol restriction).
- /// </summary>
- /// <param name="dataItems">List of dataitems that contains the list of variables that must be read.</param>
- /// <param name="cancellationToken">The token to monitor for cancellation requests. The default value is None.
- /// Please note that cancellation is advisory/cooperative and will not lead to immediate cancellation in all cases.</param>
- public async Task<List<DataItem>> ReadMultipleVarsAsync(List<DataItem> dataItems, CancellationToken cancellationToken = default)
- {
- //Snap7 seems to choke on PDU sizes above 256 even if snap7
- //replies with bigger PDU size in connection setup.
- AssertPduSizeForRead(dataItems);
- try
- {
- var dataToSend = BuildReadRequestPackage(dataItems.Select(d => DataItem.GetDataItemAddress(d)).ToList());
- var s7data = await RequestTsduAsync(dataToSend, cancellationToken);
- ValidateResponseCode((ReadWriteErrorCode)s7data[14]);
- ParseDataIntoDataItems(s7data, dataItems);
- }
- catch (SocketException socketException)
- {
- throw new PlcException(ErrorCode.ReadData, socketException);
- }
- catch (OperationCanceledException)
- {
- throw;
- }
- catch (Exception exc)
- {
- throw new PlcException(ErrorCode.ReadData, exc);
- }
- return dataItems;
- }
- /// <summary>
- /// Read the PLC clock value.
- /// </summary>
- /// <param name="cancellationToken">The token to monitor for cancellation requests. The default value is None.
- /// Please note that cancellation is advisory/cooperative and will not lead to immediate cancellation in all cases.</param>
- /// <returns>A task that represents the asynchronous operation, with it's result set to the current PLC time on completion.</returns>
- public async Task<System.DateTime> ReadClockAsync(CancellationToken cancellationToken = default)
- {
- var request = BuildClockReadRequest();
- var response = await RequestTsduAsync(request, cancellationToken);
- return ParseClockReadResponse(response);
- }
- /// <summary>
- /// Write the PLC clock value.
- /// </summary>
- /// <param name="value">The date and time to set the PLC clock to</param>
- /// <param name="cancellationToken">The token to monitor for cancellation requests. The default value is None.
- /// Please note that cancellation is advisory/cooperative and will not lead to immediate cancellation in all cases.</param>
- /// <returns>A task that represents the asynchronous operation.</returns>
- public async Task WriteClockAsync(System.DateTime value, CancellationToken cancellationToken = default)
- {
- var request = BuildClockWriteRequest(value);
- var response = await RequestTsduAsync(request, cancellationToken);
- ParseClockWriteResponse(response);
- }
- /// <summary>
- /// Read the current status from the PLC. A value of 0x08 indicates the PLC is in run status, regardless of the PLC type.
- /// </summary>
- /// <param name="cancellationToken">The token to monitor for cancellation requests. The default value is None.
- /// Please note that cancellation is advisory/cooperative and will not lead to immediate cancellation in all cases.</param>
- /// <returns>A task that represents the asynchronous operation, with it's result set to the current PLC status on completion.</returns>
- public async Task<byte> ReadStatusAsync(CancellationToken cancellationToken = default)
- {
- var dataToSend = BuildSzlReadRequestPackage(0x0424, 0);
- var s7data = await RequestTsduAsync(dataToSend, cancellationToken);
- return (byte) (s7data[37] & 0x0f);
- }
- /// <summary>
- /// Write a number of bytes from a DB starting from a specified index. This handles more than 200 bytes with multiple requests.
- /// If the write was not successful, check LastErrorCode or LastErrorString.
- /// </summary>
- /// <param name="dataType">Data type of the memory area, can be DB, Timer, Counter, Merker(Memory), Input, Output.</param>
- /// <param name="db">Address of the memory area (if you want to read DB1, this is set to 1). This must be set also for other memory area types: counters, timers,etc.</param>
- /// <param name="startByteAdr">Start byte address. If you want to write DB1.DBW200, this is 200.</param>
- /// <param name="value">Bytes to write. If more than 200, multiple requests will be made.</param>
- /// <param name="cancellationToken">The token to monitor for cancellation requests. The default value is None.
- /// Please note that cancellation is advisory/cooperative and will not lead to immediate cancellation in all cases.</param>
- /// <returns>A task that represents the asynchronous write operation.</returns>
- public Task WriteBytesAsync(DataType dataType, int db, int startByteAdr, byte[] value, CancellationToken cancellationToken = default)
- {
- return WriteBytesAsync(dataType, db, startByteAdr, value.AsMemory(), cancellationToken);
- }
- /// <summary>
- /// Write a number of bytes from a DB starting from a specified index. This handles more than 200 bytes with multiple requests.
- /// If the write was not successful, check LastErrorCode or LastErrorString.
- /// </summary>
- /// <param name="dataType">Data type of the memory area, can be DB, Timer, Counter, Merker(Memory), Input, Output.</param>
- /// <param name="db">Address of the memory area (if you want to read DB1, this is set to 1). This must be set also for other memory area types: counters, timers,etc.</param>
- /// <param name="startByteAdr">Start byte address. If you want to write DB1.DBW200, this is 200.</param>
- /// <param name="value">Bytes to write. If more than 200, multiple requests will be made.</param>
- /// <param name="cancellationToken">The token to monitor for cancellation requests. The default value is None.
- /// Please note that cancellation is advisory/cooperative and will not lead to immediate cancellation in all cases.</param>
- /// <returns>A task that represents the asynchronous write operation.</returns>
- public async Task WriteBytesAsync(DataType dataType, int db, int startByteAdr, ReadOnlyMemory<byte> value, CancellationToken cancellationToken = default)
- {
- int localIndex = 0;
- while (value.Length > 0)
- {
- var maxToWrite = (int)Math.Min(value.Length, MaxPDUSize - 35);
- await WriteBytesWithASingleRequestAsync(dataType, db, startByteAdr + localIndex, value.Slice(0, maxToWrite), cancellationToken).ConfigureAwait(false);
- value = value.Slice(maxToWrite);
- localIndex += maxToWrite;
- }
- }
- /// <summary>
- /// Write a single bit from a DB with the specified index.
- /// </summary>
- /// <param name="dataType">Data type of the memory area, can be DB, Timer, Counter, Merker(Memory), Input, Output.</param>
- /// <param name="db">Address of the memory area (if you want to read DB1, this is set to 1). This must be set also for other memory area types: counters, timers,etc.</param>
- /// <param name="startByteAdr">Start byte address. If you want to write DB1.DBW200, this is 200.</param>
- /// <param name="bitAdr">The address of the bit. (0-7)</param>
- /// <param name="value">Bytes to write. If more than 200, multiple requests will be made.</param>
- /// <param name="cancellationToken">The token to monitor for cancellation requests. The default value is None.
- /// Please note that cancellation is advisory/cooperative and will not lead to immediate cancellation in all cases.</param>
- /// <returns>A task that represents the asynchronous write operation.</returns>
- public async Task WriteBitAsync(DataType dataType, int db, int startByteAdr, int bitAdr, bool value, CancellationToken cancellationToken = default)
- {
- if (bitAdr < 0 || bitAdr > 7)
- throw new InvalidAddressException(string.Format("Addressing Error: You can only reference bitwise locations 0-7. Address {0} is invalid", bitAdr));
- await WriteBitWithASingleRequestAsync(dataType, db, startByteAdr, bitAdr, value, cancellationToken).ConfigureAwait(false);
- }
- /// <summary>
- /// Write a single bit from a DB with the specified index.
- /// </summary>
- /// <param name="dataType">Data type of the memory area, can be DB, Timer, Counter, Merker(Memory), Input, Output.</param>
- /// <param name="db">Address of the memory area (if you want to read DB1, this is set to 1). This must be set also for other memory area types: counters, timers,etc.</param>
- /// <param name="startByteAdr">Start byte address. If you want to write DB1.DBW200, this is 200.</param>
- /// <param name="bitAdr">The address of the bit. (0-7)</param>
- /// <param name="value">Bytes to write. If more than 200, multiple requests will be made.</param>
- /// <param name="cancellationToken">The token to monitor for cancellation requests. The default value is None.
- /// Please note that cancellation is advisory/cooperative and will not lead to immediate cancellation in all cases.</param>
- /// <returns>A task that represents the asynchronous write operation.</returns>
- public async Task WriteBitAsync(DataType dataType, int db, int startByteAdr, int bitAdr, int value, CancellationToken cancellationToken = default)
- {
- if (value < 0 || value > 1)
- throw new ArgumentException("Value must be 0 or 1", nameof(value));
- await WriteBitAsync(dataType, db, startByteAdr, bitAdr, value == 1, cancellationToken).ConfigureAwait(false);
- }
- /// <summary>
- /// Takes in input an object and tries to parse it to an array of values. This can be used to write many data, all of the same type.
- /// You must specify the memory area type, memory are address, byte start address and bytes count.
- /// If the read was not successful, check LastErrorCode or LastErrorString.
- /// </summary>
- /// <param name="dataType">Data type of the memory area, can be DB, Timer, Counter, Merker(Memory), Input, Output.</param>
- /// <param name="db">Address of the memory area (if you want to read DB1, this is set to 1). This must be set also for other memory area types: counters, timers,etc.</param>
- /// <param name="startByteAdr">Start byte address. If you want to read DB1.DBW200, this is 200.</param>
- /// <param name="value">Bytes to write. The lenght of this parameter can't be higher than 200. If you need more, use recursion.</param>
- /// <param name="bitAdr">The address of the bit. (0-7)</param>
- /// <param name="cancellationToken">The token to monitor for cancellation requests. The default value is None.
- /// Please note that cancellation is advisory/cooperative and will not lead to immediate cancellation in all cases.</param>
- /// <returns>A task that represents the asynchronous write operation.</returns>
- public async Task WriteAsync(DataType dataType, int db, int startByteAdr, object value, int bitAdr = -1, CancellationToken cancellationToken = default)
- {
- if (bitAdr != -1)
- {
- //Must be writing a bit value as bitAdr is specified
- if (value is bool boolean)
- {
- await WriteBitAsync(dataType, db, startByteAdr, bitAdr, boolean, cancellationToken).ConfigureAwait(false);
- }
- else if (value is int intValue)
- {
- if (intValue < 0 || intValue > 7)
- throw new ArgumentOutOfRangeException(
- string.Format(
- "Addressing Error: You can only reference bitwise locations 0-7. Address {0} is invalid",
- bitAdr), nameof(bitAdr));
- await WriteBitAsync(dataType, db, startByteAdr, bitAdr, intValue == 1, cancellationToken).ConfigureAwait(false);
- }
- else throw new ArgumentException("Value must be a bool or an int to write a bit", nameof(value));
- }
- else await WriteBytesAsync(dataType, db, startByteAdr, Serialization.SerializeValue(value), cancellationToken).ConfigureAwait(false);
- }
- /// <summary>
- /// Writes a single variable from the PLC, takes in input strings like "DB1.DBX0.0", "DB20.DBD200", "MB20", "T45", etc.
- /// </summary>
- /// <param name="variable">Input strings like "DB1.DBX0.0", "DB20.DBD200", "MB20", "T45", etc.</param>
- /// <param name="value">Value to be written to the PLC</param>
- /// <param name="cancellationToken">The token to monitor for cancellation requests. The default value is None.
- /// Please note that cancellation is advisory/cooperative and will not lead to immediate cancellation in all cases.</param>
- /// <returns>A task that represents the asynchronous write operation.</returns>
- public async Task WriteAsync(string variable, object value, CancellationToken cancellationToken = default)
- {
- var adr = new PLCAddress(variable);
- await WriteAsync(adr.DataType, adr.DbNumber, adr.StartByte, value, adr.BitNumber, cancellationToken).ConfigureAwait(false);
- }
- /// <summary>
- /// Writes a C# struct to a DB in the PLC
- /// </summary>
- /// <param name="structValue">The struct to be written</param>
- /// <param name="db">Db address</param>
- /// <param name="startByteAdr">Start bytes on the PLC</param>
- /// <param name="cancellationToken">The token to monitor for cancellation requests. The default value is None.
- /// Please note that cancellation is advisory/cooperative and will not lead to immediate cancellation in all cases.</param>
- /// <returns>A task that represents the asynchronous write operation.</returns>
- public async Task WriteStructAsync(object structValue, int db, int startByteAdr = 0, CancellationToken cancellationToken = default)
- {
- var bytes = Struct.ToBytes(structValue).ToList();
- await WriteBytesAsync(DataType.DataBlock, db, startByteAdr, bytes.ToArray(), cancellationToken).ConfigureAwait(false);
- }
- /// <summary>
- /// Writes a C# class to a DB in the PLC
- /// </summary>
- /// <param name="classValue">The class to be written</param>
- /// <param name="db">Db address</param>
- /// <param name="startByteAdr">Start bytes on the PLC</param>
- /// <param name="cancellationToken">The token to monitor for cancellation requests. The default value is None.
- /// Please note that cancellation is advisory/cooperative and will not lead to immediate cancellation in all cases.</param>
- /// <returns>A task that represents the asynchronous write operation.</returns>
- public async Task WriteClassAsync(object classValue, int db, int startByteAdr = 0, CancellationToken cancellationToken = default)
- {
- byte[] bytes = new byte[(int)Class.GetClassSize(classValue)];
- Types.Class.ToBytes(classValue, bytes);
- await WriteBytesAsync(DataType.DataBlock, db, startByteAdr, bytes, cancellationToken).ConfigureAwait(false);
- }
- private async Task ReadBytesWithSingleRequestAsync(DataType dataType, int db, int startByteAdr, Memory<byte> buffer, CancellationToken cancellationToken)
- {
- var dataToSend = BuildReadRequestPackage(new[] { new DataItemAddress(dataType, db, startByteAdr, buffer.Length) });
- var s7data = await RequestTsduAsync(dataToSend, cancellationToken);
- AssertReadResponse(s7data, buffer.Length);
- s7data.AsSpan(18, buffer.Length).CopyTo(buffer.Span);
- }
- /// <summary>
- /// Write DataItem(s) to the PLC. Throws an exception if the response is invalid
- /// or when the PLC reports errors for item(s) written.
- /// </summary>
- /// <param name="dataItems">The DataItem(s) to write to the PLC.</param>
- /// <returns>Task that completes when response from PLC is parsed.</returns>
- public async Task WriteAsync(params DataItem[] dataItems)
- {
- AssertPduSizeForWrite(dataItems);
- var message = new ByteArray();
- var length = S7WriteMultiple.CreateRequest(message, dataItems);
- var response = await RequestTsduAsync(message.Array, 0, length).ConfigureAwait(false);
- S7WriteMultiple.ParseResponse(response, response.Length, dataItems);
- }
- /// <summary>
- /// Writes up to 200 bytes to the PLC. You must specify the memory area type, memory are address, byte start address and bytes count.
- /// </summary>
- /// <param name="dataType">Data type of the memory area, can be DB, Timer, Counter, Merker(Memory), Input, Output.</param>
- /// <param name="db">Address of the memory area (if you want to read DB1, this is set to 1). This must be set also for other memory area types: counters, timers,etc.</param>
- /// <param name="startByteAdr">Start byte address. If you want to read DB1.DBW200, this is 200.</param>
- /// <param name="value">Bytes to write. The lenght of this parameter can't be higher than 200. If you need more, use recursion.</param>
- /// <param name="cancellationToken">A cancellation token that can be used to cancel the asynchronous operation.</param>
- /// <returns>A task that represents the asynchronous write operation.</returns>
- private async Task WriteBytesWithASingleRequestAsync(DataType dataType, int db, int startByteAdr, ReadOnlyMemory<byte> value, CancellationToken cancellationToken)
- {
- try
- {
- var dataToSend = BuildWriteBytesPackage(dataType, db, startByteAdr, value.Span);
- var s7data = await RequestTsduAsync(dataToSend, cancellationToken).ConfigureAwait(false);
- ValidateResponseCode((ReadWriteErrorCode)s7data[14]);
- }
- catch (OperationCanceledException)
- {
- throw;
- }
- catch (Exception exc)
- {
- throw new PlcException(ErrorCode.WriteData, exc);
- }
- }
- private async Task WriteBitWithASingleRequestAsync(DataType dataType, int db, int startByteAdr, int bitAdr, bool bitValue, CancellationToken cancellationToken)
- {
- try
- {
- var dataToSend = BuildWriteBitPackage(dataType, db, startByteAdr, bitValue, bitAdr);
- var s7data = await RequestTsduAsync(dataToSend, cancellationToken).ConfigureAwait(false);
- ValidateResponseCode((ReadWriteErrorCode)s7data[14]);
- }
- catch (OperationCanceledException)
- {
- throw;
- }
- catch (Exception exc)
- {
- throw new PlcException(ErrorCode.WriteData, exc);
- }
- }
- private Task<byte[]> RequestTsduAsync(byte[] requestData, CancellationToken cancellationToken = default) =>
- RequestTsduAsync(requestData, 0, requestData.Length, cancellationToken);
- private Task<byte[]> RequestTsduAsync(byte[] requestData, int offset, int length, CancellationToken cancellationToken = default)
- {
- var stream = GetStreamIfAvailable();
- return queue.Enqueue(() =>
- NoLockRequestTsduAsync(stream, requestData, offset, length, cancellationToken));
- }
- private async Task<COTP.TPDU> NoLockRequestTpduAsync(Stream stream, byte[] requestData,
- CancellationToken cancellationToken = default)
- {
- cancellationToken.ThrowIfCancellationRequested();
- try
- {
- using var closeOnCancellation = cancellationToken.Register(Close);
- await stream.WriteAsync(requestData, 0, requestData.Length, cancellationToken).ConfigureAwait(false);
- return await COTP.TPDU.ReadAsync(stream, cancellationToken).ConfigureAwait(false);
- }
- catch (Exception exc)
- {
- if (exc is TPDUInvalidException || exc is TPKTInvalidException)
- {
- Close();
- }
- throw;
- }
- }
- private async Task<byte[]> NoLockRequestTsduAsync(Stream stream, byte[] requestData, int offset, int length,
- CancellationToken cancellationToken = default)
- {
- cancellationToken.ThrowIfCancellationRequested();
- try
- {
- using var closeOnCancellation = cancellationToken.Register(Close);
- await stream.WriteAsync(requestData, offset, length, cancellationToken).ConfigureAwait(false);
- return await COTP.TSDU.ReadAsync(stream, cancellationToken).ConfigureAwait(false);
- }
- catch (Exception exc)
- {
- if (exc is TPDUInvalidException || exc is TPKTInvalidException)
- {
- Close();
- }
- throw;
- }
- }
- }
- }
|