using System; using System.Collections.Generic; using System.Linq; using AMWD.Protocols.Modbus.Common.Contracts; namespace AMWD.Protocols.Modbus.Common.Protocols { /// /// Default implementation of the Modbus TCP protocol. /// public class TcpProtocol : IModbusProtocol { #region Fields private readonly object _lock = new(); private ushort _transactionId = 0x0000; #endregion Fields #region Constants /// /// The minimum allowed unit id specified by the Modbus TCP protocol. /// public const byte MIN_UNIT_ID = 0x00; /// /// The maximum allowed unit id specified by the Modbus TCP protocol. /// public const byte MAX_UNIT_ID = 0xFF; /// /// The minimum allowed read count specified by the Modbus TCP protocol. /// public const ushort MIN_READ_COUNT = 0x01; /// /// The minimum allowed write count specified by the Modbus TCP protocol. /// public const ushort MIN_WRITE_COUNT = 0x01; /// /// The maximum allowed read count for discrete values specified by the Modbus TCP protocol. /// public const ushort MAX_DISCRETE_READ_COUNT = 0x07D0; // 2000 /// /// The maximum allowed write count for discrete values specified by the Modbus TCP protocol. /// public const ushort MAX_DISCRETE_WRITE_COUNT = 0x07B0; // 1968 /// /// The maximum allowed read count for registers specified by the Modbus TCP protocol. /// public const ushort MAX_REGISTER_READ_COUNT = 0x007D; // 125 /// /// The maximum allowed write count for registers specified by the Modbus TCP protocol. /// public const ushort MAX_REGISTER_WRITE_COUNT = 0x007B; // 123 /// /// The maximum allowed ADU length in bytes. /// /// /// A Modbus frame consists of a PDU (protcol data unit) and additional protocol addressing / error checks. /// The whole data frame is called ADU (application data unit). /// public const int MAX_ADU_LENGTH = 260; // bytes #endregion Constants /// public string Name => "TCP"; /// /// Gets or sets a value indicating whether to disable the transaction id usage. /// public bool DisableTransactionId { get; set; } #region Read /// public IReadOnlyList SerializeReadCoils(byte unitId, ushort startAddress, ushort count) { if (count < MIN_READ_COUNT || MAX_DISCRETE_READ_COUNT < count) throw new ArgumentOutOfRangeException(nameof(count)); if (ushort.MaxValue < (startAddress + count - 1)) throw new ArgumentOutOfRangeException(nameof(count), $"Combination of {nameof(startAddress)} and {nameof(count)} exceeds the addressation limit of {ushort.MaxValue}"); byte[] request = new byte[12]; byte[] header = GetHeader(unitId, 6); Array.Copy(header, 0, request, 0, header.Length); // Function code request[7] = (byte)ModbusFunctionCode.ReadCoils; // Starting address byte[] addrBytes = startAddress.ToNetworkBytes(); request[8] = addrBytes[0]; request[9] = addrBytes[1]; // Quantity byte[] countBytes = count.ToNetworkBytes(); request[10] = countBytes[0]; request[11] = countBytes[1]; return request; } /// public IReadOnlyList DeserializeReadCoils(IReadOnlyList response) { int baseOffset = 9; if (response[8] != response.Count - baseOffset) throw new ModbusException("Coil byte count does not match."); int count = response[8] * 8; var coils = new List(); for (int i = 0; i < count; i++) { int bytePosition = i / 8; int bitPosition = i % 8; int value = response[baseOffset + bytePosition] & (1 << bitPosition); coils.Add(new Coil { Address = (ushort)i, Value = value > 0 }); } return coils; } /// public IReadOnlyList SerializeReadDiscreteInputs(byte unitId, ushort startAddress, ushort count) { if (count < MIN_READ_COUNT || MAX_DISCRETE_READ_COUNT < count) throw new ArgumentOutOfRangeException(nameof(count)); if (ushort.MaxValue < (startAddress + count - 1)) throw new ArgumentOutOfRangeException(nameof(count), $"Combination of {nameof(startAddress)} and {nameof(count)} exceeds the addressation limit of {ushort.MaxValue}"); byte[] request = new byte[12]; byte[] header = GetHeader(unitId, 6); Array.Copy(header, 0, request, 0, header.Length); // Function code request[7] = (byte)ModbusFunctionCode.ReadDiscreteInputs; // Starting address byte[] addrBytes = startAddress.ToNetworkBytes(); request[8] = addrBytes[0]; request[9] = addrBytes[1]; // Quantity byte[] countBytes = count.ToNetworkBytes(); request[10] = countBytes[0]; request[11] = countBytes[1]; return request; } /// public IReadOnlyList DeserializeReadDiscreteInputs(IReadOnlyList response) { int baseOffset = 9; if (response[8] != response.Count - baseOffset) throw new ModbusException("Discrete input byte count does not match."); int count = response[8] * 8; var discreteInputs = new List(); for (int i = 0; i < count; i++) { int bytePosition = i / 8; int bitPosition = i % 8; int value = response[baseOffset + bytePosition] & (1 << bitPosition); discreteInputs.Add(new DiscreteInput { Address = (ushort)i, HighByte = (byte)(value > 0 ? 0xFF : 0x00) }); } return discreteInputs; } /// public IReadOnlyList SerializeReadHoldingRegisters(byte unitId, ushort startAddress, ushort count) { if (count < MIN_READ_COUNT || MAX_REGISTER_READ_COUNT < count) throw new ArgumentOutOfRangeException(nameof(count)); if (ushort.MaxValue < (startAddress + count - 1)) throw new ArgumentOutOfRangeException(nameof(count), $"Combination of {nameof(startAddress)} and {nameof(count)} exceeds the addressation limit of {ushort.MaxValue}"); byte[] request = new byte[12]; byte[] header = GetHeader(unitId, 6); Array.Copy(header, 0, request, 0, header.Length); // Function code request[7] = (byte)ModbusFunctionCode.ReadHoldingRegisters; // Starting address byte[] addrBytes = startAddress.ToNetworkBytes(); request[8] = addrBytes[0]; request[9] = addrBytes[1]; // Quantity byte[] countBytes = count.ToNetworkBytes(); request[10] = countBytes[0]; request[11] = countBytes[1]; return request; } /// public IReadOnlyList DeserializeReadHoldingRegisters(IReadOnlyList response) { int baseOffset = 9; if (response[8] != response.Count - baseOffset) throw new ModbusException("Holding register byte count does not match."); int count = response[8] / 2; var holdingRegisters = new List(); for (int i = 0; i < count; i++) { holdingRegisters.Add(new HoldingRegister { Address = (ushort)i, HighByte = response[baseOffset + i * 2], LowByte = response[baseOffset + i * 2 + 1] }); } return holdingRegisters; } /// public IReadOnlyList SerializeReadInputRegisters(byte unitId, ushort startAddress, ushort count) { if (count < MIN_READ_COUNT || MAX_REGISTER_READ_COUNT < count) throw new ArgumentOutOfRangeException(nameof(count)); if (ushort.MaxValue < (startAddress + count - 1)) throw new ArgumentOutOfRangeException(nameof(count), $"Combination of {nameof(startAddress)} and {nameof(count)} exceeds the addressation limit of {ushort.MaxValue}"); byte[] request = new byte[12]; byte[] header = GetHeader(unitId, 6); Array.Copy(header, 0, request, 0, header.Length); // Function code request[7] = (byte)ModbusFunctionCode.ReadInputRegisters; // Starting address byte[] addrBytes = startAddress.ToNetworkBytes(); request[8] = addrBytes[0]; request[9] = addrBytes[1]; // Quantity byte[] countBytes = count.ToNetworkBytes(); request[10] = countBytes[0]; request[11] = countBytes[1]; return request; } /// public IReadOnlyList DeserializeReadInputRegisters(IReadOnlyList response) { int baseOffset = 9; if (response[8] != response.Count - baseOffset) throw new ModbusException("Input register byte count does not match."); int count = response[8] / 2; var inputRegisters = new List(); for (int i = 0; i < count; i++) { inputRegisters.Add(new InputRegister { Address = (ushort)i, HighByte = response[baseOffset + i * 2], LowByte = response[baseOffset + i * 2 + 1] }); } return inputRegisters; } /// public IReadOnlyList SerializeReadDeviceIdentification(byte unitId, ModbusDeviceIdentificationCategory category, ModbusDeviceIdentificationObject objectId) { if (!Enum.IsDefined(typeof(ModbusDeviceIdentificationCategory), category)) throw new ArgumentOutOfRangeException(nameof(category)); byte[] request = new byte[11]; byte[] header = GetHeader(unitId, 5); Array.Copy(header, 0, request, 0, header.Length); // Function code request[7] = (byte)ModbusFunctionCode.EncapsulatedInterface; // Modbus Encapsulated Interface: Read Device Identification (MEI Type) request[8] = 0x0E; // The category type (basic, regular, extended, individual) request[9] = (byte)category; request[10] = (byte)objectId; return request; } /// public DeviceIdentificationRaw DeserializeReadDeviceIdentification(IReadOnlyList response) { if (response[8] != 0x0E) throw new ModbusException("The MEI type does not match"); if (!Enum.IsDefined(typeof(ModbusDeviceIdentificationCategory), response[9])) throw new ModbusException("The category type does not match"); var deviceIdentification = new DeviceIdentificationRaw { AllowsIndividualAccess = (response[10] & 0x80) == 0x80, MoreRequestsNeeded = response[11] == 0xFF, NextObjectIdToRequest = response[12], }; int baseOffset = 14; while (baseOffset < response.Count) { byte objectId = response[baseOffset]; byte length = response[baseOffset + 1]; byte[] data = response.Skip(baseOffset + 2).Take(length).ToArray(); deviceIdentification.Objects.Add(objectId, data); baseOffset += 2 + length; } return deviceIdentification; } #endregion Read #region Write /// public IReadOnlyList SerializeWriteSingleCoil(byte unitId, Coil coil) { #if NET8_0_OR_GREATER ArgumentNullException.ThrowIfNull(coil); #else if (coil == null) throw new ArgumentNullException(nameof(coil)); #endif byte[] request = new byte[12]; byte[] header = GetHeader(unitId, 6); Array.Copy(header, 0, request, 0, header.Length); // Function code request[7] = (byte)ModbusFunctionCode.WriteSingleCoil; byte[] addrBytes = coil.Address.ToNetworkBytes(); request[8] = addrBytes[0]; request[9] = addrBytes[1]; request[10] = coil.HighByte; request[11] = coil.LowByte; return request; } /// public Coil DeserializeWriteSingleCoil(IReadOnlyList response) { return new Coil { Address = response.ToArray().NetworkUInt16(8), HighByte = response[10], LowByte = response[11] }; } /// public IReadOnlyList SerializeWriteSingleHoldingRegister(byte unitId, HoldingRegister register) { #if NET8_0_OR_GREATER ArgumentNullException.ThrowIfNull(register); #else if (register == null) throw new ArgumentNullException(nameof(register)); #endif byte[] request = new byte[12]; byte[] header = GetHeader(unitId, 6); Array.Copy(header, 0, request, 0, header.Length); // Function code request[7] = (byte)ModbusFunctionCode.WriteSingleRegister; byte[] addrBytes = register.Address.ToNetworkBytes(); request[8] = addrBytes[0]; request[9] = addrBytes[1]; request[10] = register.HighByte; request[11] = register.LowByte; return request; } /// public HoldingRegister DeserializeWriteSingleHoldingRegister(IReadOnlyList response) { return new HoldingRegister { Address = response.ToArray().NetworkUInt16(8), HighByte = response[10], LowByte = response[11] }; } /// public IReadOnlyList SerializeWriteMultipleCoils(byte unitId, IReadOnlyList coils) { #if NET8_0_OR_GREATER ArgumentNullException.ThrowIfNull(coils); #else if (coils == null) throw new ArgumentNullException(nameof(coils)); #endif var orderedList = coils.OrderBy(c => c.Address).ToList(); if (orderedList.Count < MIN_WRITE_COUNT || MAX_DISCRETE_WRITE_COUNT < orderedList.Count) throw new ArgumentOutOfRangeException(nameof(coils), $"At least {MIN_WRITE_COUNT} or max. {MAX_DISCRETE_WRITE_COUNT} coils can be written at once."); int addrCount = coils.Select(c => c.Address).Distinct().Count(); if (orderedList.Count != addrCount) throw new ArgumentException("One or more duplicate coils found.", nameof(coils)); ushort firstAddress = orderedList.First().Address; ushort lastAddress = orderedList.Last().Address; if (firstAddress + orderedList.Count - 1 != lastAddress) throw new ArgumentException("Gap in coil list found.", nameof(coils)); byte byteCount = (byte)Math.Ceiling(orderedList.Count / 8.0); byte[] request = new byte[13 + byteCount]; byte[] header = GetHeader(unitId, byteCount + 7); Array.Copy(header, 0, request, 0, header.Length); request[7] = (byte)ModbusFunctionCode.WriteMultipleCoils; byte[] addrBytes = firstAddress.ToNetworkBytes(); request[8] = addrBytes[0]; request[9] = addrBytes[1]; byte[] countBytes = ((ushort)orderedList.Count).ToNetworkBytes(); request[10] = countBytes[0]; request[11] = countBytes[1]; request[12] = byteCount; int baseOffset = 13; for (int i = 0; i < orderedList.Count; i++) { int bytePosition = i / 8; int bitPosition = i % 8; if (orderedList[i].Value) { byte bitMask = (byte)(1 << bitPosition); request[baseOffset + bytePosition] |= bitMask; } } return request; } /// public (ushort FirstAddress, ushort NumberOfCoils) DeserializeWriteMultipleCoils(IReadOnlyList response) { ushort firstAddress = response.ToArray().NetworkUInt16(8); ushort numberOfCoils = response.ToArray().NetworkUInt16(10); return (firstAddress, numberOfCoils); } /// public IReadOnlyList SerializeWriteMultipleHoldingRegisters(byte unitId, IReadOnlyList registers) { #if NET8_0_OR_GREATER ArgumentNullException.ThrowIfNull(registers); #else if (registers == null) throw new ArgumentNullException(nameof(registers)); #endif var orderedList = registers.OrderBy(c => c.Address).ToList(); if (orderedList.Count < MIN_WRITE_COUNT || MAX_REGISTER_WRITE_COUNT < orderedList.Count) throw new ArgumentOutOfRangeException(nameof(registers), $"At least {MIN_WRITE_COUNT} or max. {MAX_REGISTER_WRITE_COUNT} holding registers can be written at once."); int addrCount = registers.Select(c => c.Address).Distinct().Count(); if (orderedList.Count != addrCount) throw new ArgumentException("One or more duplicate holding registers found.", nameof(registers)); ushort firstAddress = orderedList.First().Address; ushort lastAddress = orderedList.Last().Address; if (firstAddress + orderedList.Count - 1 != lastAddress) throw new ArgumentException("Gap in holding register list found.", nameof(registers)); byte byteCount = (byte)(orderedList.Count * 2); byte[] request = new byte[13 + byteCount]; byte[] header = GetHeader(unitId, byteCount + 7); Array.Copy(header, 0, request, 0, header.Length); request[7] = (byte)ModbusFunctionCode.WriteMultipleRegisters; byte[] addrBytes = firstAddress.ToNetworkBytes(); request[8] = addrBytes[0]; request[9] = addrBytes[1]; byte[] countBytes = ((ushort)orderedList.Count).ToNetworkBytes(); request[10] = countBytes[0]; request[11] = countBytes[1]; request[12] = byteCount; int baseOffset = 13; for (int i = 0; i < orderedList.Count; i++) { request[baseOffset + 2 * i] = orderedList[i].HighByte; request[baseOffset + 2 * i + 1] = orderedList[i].LowByte; } return request; } /// public (ushort FirstAddress, ushort NumberOfRegisters) DeserializeWriteMultipleHoldingRegisters(IReadOnlyList response) { ushort firstAddress = response.ToArray().NetworkUInt16(8); ushort numberOfRegisters = response.ToArray().NetworkUInt16(10); return (firstAddress, numberOfRegisters); } #endregion Write #region Validation /// public bool CheckResponseComplete(IReadOnlyList responseBytes) { // 2x Transaction Id // 2x Protocol Identifier // 2x Number of following bytes if (responseBytes.Count < 6) return false; ushort followingBytes = responseBytes.ToArray().NetworkUInt16(4); if (responseBytes.Count < followingBytes + 6) return false; return true; } /// public void ValidateResponse(IReadOnlyList request, IReadOnlyList response) { if (!DisableTransactionId) { if (request[0] != response[0] || request[1] != response[1]) throw new ModbusException("Transaction Id does not match."); } if (request[2] != response[2] || request[3] != response[3]) throw new ModbusException("Protocol Identifier does not match."); ushort count = response.ToArray().NetworkUInt16(4); if (count != response.Count - 6) throw new ModbusException("Number of following bytes does not match."); if (request[6] != response[6]) throw new ModbusException("Unit Identifier does not match."); byte fnCode = response[7]; bool isError = (fnCode & 0x80) == 0x80; if (isError) fnCode = (byte)(fnCode ^ 0x80); // === fnCode & 0x7F if (request[7] != fnCode) throw new ModbusException("Function code does not match."); if (isError) throw new ModbusException("Remote Error") { ErrorCode = (ModbusErrorCode)response[8] }; } #endregion Validation #region Private helpers private ushort GetNextTransacitonId() { if (DisableTransactionId) return 0x0000; lock (_lock) { if (_transactionId == ushort.MaxValue) _transactionId = 0x0000; else _transactionId++; return _transactionId; } } /// /// Generates the header for a Modbus request. /// /// The unit identifier. /// The number of following bytes. /// The header ready to copy to the request bytes. /// /// ATTENTION: Do not forget the . It is placed after the count information. /// private byte[] GetHeader(byte unitId, int followingBytes) { byte[] header = new byte[7]; // Transaction id ushort txId = GetNextTransacitonId(); byte[] txBytes = txId.ToNetworkBytes(); header[0] = txBytes[0]; header[1] = txBytes[1]; // Protocol identifier header[2] = 0x00; header[3] = 0x00; // Number of following bytes byte[] countBytes = ((ushort)followingBytes).ToNetworkBytes(); header[4] = countBytes[0]; header[5] = countBytes[1]; // Unit identifier header[6] = unitId; return header; } #endregion Private helpers } }