You cannot select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.

682 lines
27 KiB
C#

This file contains ambiguous Unicode characters!

This file contains ambiguous Unicode characters that may be confused with others in your current locale. If your use case is intentional and legitimate, you can safely ignore this warning. Use the Escape button to highlight these characters.

using System;
using System.Collections.Generic;
using System.Linq;
using System.Text;
using HslCommunication.BasicFramework;
using HslCommunication.Core;
using HslCommunication.Core.IMessage;
using HslCommunication.Core.Net;
using HslCommunication.Core.Address;
using System.Net.Sockets;
namespace HslCommunication.ModBus
{
/// <summary>
/// Modbus-Tcp协议的客户端通讯类方便的和服务器进行数据交互
/// </summary>
/// <remarks>
/// 本客户端支持的标准的modbus-tcp协议内置的消息号会进行自增地址格式采用富文本表示形式
/// <note type="important">
/// 地址共可以携带3个信息最完整的表示方式"s=2;x=3;100"对应的modbus报文是 02 03 00 64 00 01 的前四个字节,站号,功能码,起始地址,下面举例
/// <list type="definition">
/// <item>
/// <term>读取线圈</term>
/// <description>ReadCoil("100")表示读取线圈100的值ReadCoil("s=2;100")表示读取站号为2线圈地址为100的值</description>
/// </item>
/// <item>
/// <term>读取离散输入</term>
/// <description>ReadDiscrete("100")表示读取离散输入100的值ReadDiscrete("s=2;100")表示读取站号为2离散地址为100的值</description>
/// </item>
/// <item>
/// <term>读取寄存器</term>
/// <description>ReadInt16("100")表示读取寄存器100的值ReadInt16("s=2;100")表示读取站号为2寄存器100的值</description>
/// </item>
/// <item>
/// <term>读取输入寄存器</term>
/// <description>ReadInt16("x=4;100")表示读取输入寄存器100的值ReadInt16("s=2;x=4;100")表示读取站号为2输入寄存器100的值</description>
/// </item>
/// </list>
/// 对于写入来说也是一致的
/// <list type="definition">
/// <item>
/// <term>写入线圈</term>
/// <description>WriteCoil("100",true)表示读取线圈100的值WriteCoil("s=2;100",true)表示读取站号为2线圈地址为100的值</description>
/// </item>
/// <item>
/// <term>写入寄存器</term>
/// <description>Write("100",(short)123)表示写寄存器100的值123Write("s=2;100",(short)123)表示写入站号为2寄存器100的值123</description>
/// </item>
/// </list>
/// </note>
/// </remarks>
/// <example>
/// 基本的用法请参照下面的代码示例
/// <code lang="cs" source="HslCommunication_Net45.Test\Documentation\Samples\Modbus\Modbus.cs" region="Example1" title="Modbus示例" />
/// </example>
public class ModbusTcpNet : NetworkDeviceBase<ModbusTcpMessage, ReverseWordTransform>
{
#region Constructor
/// <summary>
/// 实例化一个MOdbus-Tcp协议的客户端对象
/// </summary>
public ModbusTcpNet( )
{
softIncrementCount = new SoftIncrementCount( ushort.MaxValue );
WordLength = 1;
station = 1;
}
/// <summary>
/// 指定服务器地址,端口号,客户端自己的站号来初始化
/// </summary>
/// <param name="ipAddress">服务器的Ip地址</param>
/// <param name="port">服务器的端口号</param>
/// <param name="station">客户端自身的站号</param>
public ModbusTcpNet( string ipAddress, int port = 502, byte station = 0x01 )
{
softIncrementCount = new SoftIncrementCount( ushort.MaxValue );
IpAddress = ipAddress;
Port = port;
WordLength = 1;
this.station = station;
}
#endregion
#region Private Member
private byte station = 0x01; // 本客户端的站号
private SoftIncrementCount softIncrementCount; // 自增消息的对象
private bool isAddressStartWithZero = true; // 线圈值的地址值是否从零开始
#endregion
#region Override Method
/// <summary>
/// 重写网络连接时的初始化,如果配置了账户信息,就强制启动登录操作
/// </summary>
/// <param name="socket">套接字</param>
/// <returns>是否初始化成功</returns>
protected override OperateResult InitializationOnConnect( Socket socket )
{
if (isUseAccountCertificate)
{
return AccountCertificate( socket );
}
return base.InitializationOnConnect( socket );
}
#endregion
#region Public Member
/// <summary>
/// 获取或设置起始的地址是否从0开始默认为True
/// </summary>
/// <remarks>
/// <note type="warning">因为有些设备的起始地址是从1开始的就要设置本属性为<c>True</c></note>
/// </remarks>
public bool AddressStartWithZero
{
get { return isAddressStartWithZero; }
set { isAddressStartWithZero = value; }
}
/// <summary>
/// 获取或者重新修改服务器的默认站号信息,当然,你可以再读写的时候动态指定,参见备注
/// </summary>
/// <remarks>
/// 当你调用 ReadCoil("100") 时,对应的站号就是本属性的值,当你调用 ReadCoil("s=2;100") 时,就忽略本属性的值,读写寄存器的时候同理
/// </remarks>
public byte Station
{
get { return station; }
set { station = value; }
}
/// <summary>
/// 获取或设置数据解析的格式默认ABCD可选BADCCDABDCBA格式
/// </summary>
/// <remarks>
/// 对于Int32,UInt32,float,double,Int64,UInt64类型来说存在多地址的电脑情况需要和服务器进行匹配
/// </remarks>
public DataFormat DataFormat
{
get { return ByteTransform.DataFormat; }
set { ByteTransform.DataFormat = value; }
}
/// <summary>
/// 字符串数据是否按照字来反转
/// </summary>
/// <remarks>
/// 字符串按照2个字节的排列进行颠倒根据实际情况进行设置
/// </remarks>
public bool IsStringReverse
{
get { return ByteTransform.IsStringReverse; }
set { ByteTransform.IsStringReverse = value; }
}
/// <summary>
/// 获取modbus协议自增的消息号你可以自定义消息的细节。
/// </summary>
public SoftIncrementCount MessageId
{
get { return softIncrementCount; }
}
#endregion
#region Build Command
/// <summary>
/// 生成一个读取线圈的指令头
/// </summary>
/// <param name="address">地址</param>
/// <param name="length">长度</param>
/// <returns>包含结果对象的报文</returns>
public OperateResult<byte[]> BuildReadCoilCommand( string address, ushort length )
{
// 解析富地址
OperateResult<ModbusAddress> analysis = ModbusInfo.AnalysisAddress( address, isAddressStartWithZero, ModbusInfo.ReadCoil );
if (!analysis.IsSuccess) return OperateResult.CreateFailedResult<byte[]>( analysis );
// 获取消息号
ushort messageId = (ushort)softIncrementCount.GetCurrentValue( );
// 生成最终tcp指令
byte[] buffer = ModbusInfo.PackCommandToTcp( analysis.Content.CreateReadCoils( station, length ), messageId );
return OperateResult.CreateSuccessResult( buffer );
}
/// <summary>
/// 生成一个读取离散信息的指令头
/// </summary>
/// <param name="address">地址</param>
/// <param name="length">长度</param>
/// <returns>包含结果对象的报文</returns>
public OperateResult<byte[]> BuildReadDiscreteCommand( string address, ushort length )
{
// 解析富地址
OperateResult<ModbusAddress> analysis = ModbusInfo.AnalysisAddress( address, isAddressStartWithZero, ModbusInfo.ReadDiscrete );
if (!analysis.IsSuccess) return OperateResult.CreateFailedResult<byte[]>( analysis );
// 获取消息号
ushort messageId = (ushort)softIncrementCount.GetCurrentValue( );
// 生成最终tcp指令
byte[] buffer = ModbusInfo.PackCommandToTcp( analysis.Content.CreateReadDiscrete( station, length ), messageId );
return OperateResult.CreateSuccessResult( buffer );
}
/// <summary>
/// 生成一个读取寄存器的指令头
/// </summary>
/// <param name="address">地址</param>
/// <param name="length">长度</param>
/// <returns>包含结果对象的报文</returns>
public OperateResult<byte[]> BuildReadRegisterCommand( string address, ushort length )
{
// 解析富地址
OperateResult<ModbusAddress> analysis = ModbusInfo.AnalysisAddress( address, isAddressStartWithZero, ModbusInfo.ReadRegister );
if (!analysis.IsSuccess) return OperateResult.CreateFailedResult<byte[]>( analysis );
// 获取消息号
ushort messageId = (ushort)softIncrementCount.GetCurrentValue( );
// 生成最终tcp指令
byte[] buffer = ModbusInfo.PackCommandToTcp( analysis.Content.CreateReadRegister( station, length ), messageId );
return OperateResult.CreateSuccessResult( buffer );
}
/// <summary>
/// 生成一个读取寄存器的指令头
/// </summary>
/// <param name="address">地址</param>
/// <param name="length">长度</param>
/// <returns>包含结果对象的报文</returns>
private OperateResult<byte[]> BuildReadRegisterCommand( ModbusAddress address, ushort length )
{
// 获取消息号
ushort messageId = (ushort)softIncrementCount.GetCurrentValue( );
// 生成最终tcp指令
byte[] buffer = ModbusInfo.PackCommandToTcp( address.CreateReadRegister( station, length ), messageId );
return OperateResult.CreateSuccessResult( buffer );
}
/// <summary>
/// 生成一个写入单线圈的指令头
/// </summary>
/// <param name="address">地址</param>
/// <param name="value">长度</param>
/// <returns>包含结果对象的报文</returns>
public OperateResult<byte[]> BuildWriteOneCoilCommand( string address, bool value )
{
// 解析富地址
OperateResult<ModbusAddress> analysis = ModbusInfo.AnalysisAddress( address, isAddressStartWithZero, ModbusInfo.WriteOneCoil );
if (!analysis.IsSuccess) return OperateResult.CreateFailedResult<byte[]>( analysis );
// 获取消息号
ushort messageId = (ushort)softIncrementCount.GetCurrentValue( );
// 生成最终tcp指令
byte[] buffer = ModbusInfo.PackCommandToTcp( analysis.Content.CreateWriteOneCoil( station, value ), messageId );
return OperateResult.CreateSuccessResult( buffer );
}
/// <summary>
/// 生成一个写入单个寄存器的报文
/// </summary>
/// <param name="address">地址</param>
/// <param name="values">长度</param>
/// <returns>包含结果对象的报文</returns>
public OperateResult<byte[]> BuildWriteOneRegisterCommand( string address, byte[] values )
{
// 解析富地址
OperateResult<ModbusAddress> analysis = ModbusInfo.AnalysisAddress( address, isAddressStartWithZero, ModbusInfo.WriteOneRegister );
if (!analysis.IsSuccess) return OperateResult.CreateFailedResult<byte[]>( analysis );
// 获取消息号
ushort messageId = (ushort)softIncrementCount.GetCurrentValue( );
// 生成最终tcp指令
byte[] buffer = ModbusInfo.PackCommandToTcp( analysis.Content.CreateWriteOneRegister( station, values ), messageId );
return OperateResult.CreateSuccessResult( buffer );
}
/// <summary>
/// 生成批量写入单个线圈的报文信息
/// </summary>
/// <param name="address">地址</param>
/// <param name="values">实际数据值</param>
/// <returns>包含结果对象的报文</returns>
public OperateResult<byte[]> BuildWriteCoilCommand( string address, bool[] values )
{
// 解析富地址
OperateResult<ModbusAddress> analysis = ModbusInfo.AnalysisAddress( address, isAddressStartWithZero, ModbusInfo.WriteCoil );
if (!analysis.IsSuccess) return OperateResult.CreateFailedResult<byte[]>( analysis );
// 获取消息号
ushort messageId = (ushort)softIncrementCount.GetCurrentValue( );
// 生成最终tcp指令
byte[] buffer = ModbusInfo.PackCommandToTcp( analysis.Content.CreateWriteCoil( station, values ), messageId );
return OperateResult.CreateSuccessResult( buffer );
}
/// <summary>
/// 生成批量写入寄存器的报文信息
/// </summary>
/// <param name="address">地址</param>
/// <param name="values">实际值</param>
/// <returns>包含结果对象的报文</returns>
public OperateResult<byte[]> BuildWriteRegisterCommand( string address, byte[] values )
{
// 解析富地址
OperateResult<ModbusAddress> analysis = ModbusInfo.AnalysisAddress( address, isAddressStartWithZero, ModbusInfo.WriteRegister );
if (!analysis.IsSuccess) return OperateResult.CreateFailedResult<byte[]>( analysis );
// 获取消息号
ushort messageId = (ushort)softIncrementCount.GetCurrentValue( );
// 生成最终tcp指令
byte[] buffer = ModbusInfo.PackCommandToTcp( analysis.Content.CreateWriteRegister( station, values ), messageId );
return OperateResult.CreateSuccessResult( buffer );
}
#endregion
#region Core Interative
/// <summary>
/// 检查当前的Modbus-Tcp响应是否是正确的
/// </summary>
/// <param name="send">发送的数据信息</param>
/// <returns>带是否成功的结果数据</returns>
private OperateResult<byte[]> CheckModbusTcpResponse( byte[] send )
{
OperateResult<byte[]> resultBytes = ReadFromCoreServer( send );
if (resultBytes.IsSuccess)
{
if ((send[7] + 0x80) == resultBytes.Content[7])
{
// 发生了错误
resultBytes.IsSuccess = false;
resultBytes.Message = ModbusInfo.GetDescriptionByErrorCode( resultBytes.Content[8] );
resultBytes.ErrorCode = resultBytes.Content[8];
}
}
return resultBytes;
}
#endregion
#region Read Support
/// <summary>
/// 读取服务器的数据,需要指定不同的功能码
/// </summary>
/// <param name="code">指令</param>
/// <param name="address">地址</param>
/// <param name="length">长度</param>
/// <returns>带是否成功的结果数据</returns>
private OperateResult<byte[]> ReadModBusBase( byte code, string address, ushort length )
{
OperateResult<byte[]> command = null;
switch (code)
{
case ModbusInfo.ReadCoil:
{
command = BuildReadCoilCommand( address, length );
break;
}
case ModbusInfo.ReadDiscrete:
{
command = BuildReadDiscreteCommand( address, length );
break;
}
case ModbusInfo.ReadRegister:
{
command = BuildReadRegisterCommand( address, length );
break;
}
default:command = new OperateResult<byte[]>( StringResources.Language.ModbusTcpFunctionCodeNotSupport );break;
}
if (!command.IsSuccess) return OperateResult.CreateFailedResult<byte[]>( command );
OperateResult<byte[]> resultBytes = CheckModbusTcpResponse( command.Content );
if (resultBytes.IsSuccess)
{
// 二次数据处理
if (resultBytes.Content?.Length >= 9)
{
byte[] buffer = new byte[resultBytes.Content.Length - 9];
Array.Copy( resultBytes.Content, 9, buffer, 0, buffer.Length );
resultBytes.Content = buffer;
}
}
return resultBytes;
}
/// <summary>
/// 读取服务器的数据,需要指定不同的功能码
/// </summary>
/// <param name="address">地址</param>
/// <param name="length">长度</param>
/// <returns>带是否成功的结果数据</returns>
private OperateResult<byte[]> ReadModBusBase( ModbusAddress address, ushort length )
{
OperateResult<byte[]> command = BuildReadRegisterCommand( address, length );
if (!command.IsSuccess) return OperateResult.CreateFailedResult<byte[]>( command );
OperateResult<byte[]> resultBytes = CheckModbusTcpResponse( command.Content );
if (resultBytes.IsSuccess)
{
// 二次数据处理
if (resultBytes.Content?.Length >= 9)
{
byte[] buffer = new byte[resultBytes.Content.Length - 9];
Array.Copy( resultBytes.Content, 9, buffer, 0, buffer.Length );
resultBytes.Content = buffer;
}
}
return resultBytes;
}
/// <summary>
/// 读取线圈,需要指定起始地址
/// </summary>
/// <param name="address">起始地址,格式为"1234"</param>
/// <returns>带有成功标志的bool对象</returns>
public OperateResult<bool> ReadCoil( string address )
{
var read = ReadCoil( address, 1 );
if (!read.IsSuccess) return OperateResult.CreateFailedResult<bool>( read );
return OperateResult.CreateSuccessResult( read.Content[0] );
}
/// <summary>
/// 批量的读取线圈,需要指定起始地址,读取长度
/// </summary>
/// <param name="address">起始地址,格式为"1234"</param>
/// <param name="length">读取长度</param>
/// <returns>带有成功标志的bool数组对象</returns>
public OperateResult<bool[]> ReadCoil( string address, ushort length )
{
var read = ReadModBusBase( ModbusInfo.ReadCoil, address, length );
if (!read.IsSuccess) return OperateResult.CreateFailedResult<bool[]>( read );
return OperateResult.CreateSuccessResult( SoftBasic.ByteToBoolArray( read.Content, length ) );
}
/// <summary>
/// 读取输入线圈,需要指定起始地址
/// </summary>
/// <param name="address">起始地址,格式为"1234"</param>
/// <returns>带有成功标志的bool对象</returns>
public OperateResult<bool> ReadDiscrete( string address )
{
var read = ReadDiscrete( address, 1 );
if (!read.IsSuccess) return OperateResult.CreateFailedResult<bool>( read );
return OperateResult.CreateSuccessResult( read.Content[0] );
}
/// <summary>
/// 批量的读取输入点,需要指定起始地址,读取长度
/// </summary>
/// <param name="address">起始地址,格式为"1234"</param>
/// <param name="length">读取长度</param>
/// <returns>带有成功标志的bool数组对象</returns>
public OperateResult<bool[]> ReadDiscrete( string address, ushort length )
{
var read = ReadModBusBase( ModbusInfo.ReadDiscrete, address, length );
if (!read.IsSuccess) return OperateResult.CreateFailedResult<bool[]>( read );
return OperateResult.CreateSuccessResult( SoftBasic.ByteToBoolArray( read.Content, length ) );
}
/// <summary>
/// 从Modbus服务器批量读取寄存器的信息需要指定起始地址读取长度
/// </summary>
/// <param name="address">起始地址,格式为"1234"或者是带功能码格式x=3;1234</param>
/// <param name="length">读取的数量</param>
/// <returns>带有成功标志的字节信息</returns>
/// <remarks>
/// 富地址格式,支持携带站号信息,功能码信息,具体参照类的示例代码
/// </remarks>
/// <example>
/// 此处演示批量读取的示例
/// <code lang="cs" source="HslCommunication_Net45.Test\Documentation\Samples\Modbus\Modbus.cs" region="ReadExample1" title="Read示例" />
/// </example>
public override OperateResult<byte[]> Read( string address, ushort length )
{
OperateResult<ModbusAddress> analysis = ModbusInfo.AnalysisAddress( address, isAddressStartWithZero, ModbusInfo.ReadRegister );
if (!analysis.IsSuccess) return OperateResult.CreateFailedResult<byte[]>( analysis );
List<byte> lists = new List<byte>( );
ushort alreadyFinished = 0;
while (alreadyFinished < length)
{
ushort lengthTmp = (ushort)Math.Min( (length - alreadyFinished), 120 );
OperateResult<byte[]> read = ReadModBusBase( analysis.Content.AddressAdd( alreadyFinished ), lengthTmp );
if (!read.IsSuccess) return OperateResult.CreateFailedResult<byte[]>( read );
lists.AddRange( read.Content );
alreadyFinished += lengthTmp;
}
return OperateResult.CreateSuccessResult( lists.ToArray( ) );
}
#endregion
#region Write One Register
/// <summary>
/// 写一个寄存器数据
/// </summary>
/// <param name="address">起始地址</param>
/// <param name="high">高位</param>
/// <param name="low">地位</param>
/// <returns>返回写入结果</returns>
public OperateResult WriteOneRegister( string address, byte high, byte low )
{
OperateResult<byte[]> command = BuildWriteOneRegisterCommand( address, new byte[] { high, low } );
if (!command.IsSuccess) return command;
return CheckModbusTcpResponse( command.Content );
}
/// <summary>
/// 写一个寄存器数据
/// </summary>
/// <param name="address">起始地址</param>
/// <param name="value">写入值</param>
/// <returns>返回写入结果</returns>
public OperateResult WriteOneRegister( string address, short value )
{
byte[] buffer = BitConverter.GetBytes( value );
return WriteOneRegister( address, buffer[1], buffer[0] );
}
/// <summary>
/// 写一个寄存器数据
/// </summary>
/// <param name="address">起始地址</param>
/// <param name="value">写入值</param>
/// <returns>返回写入结果</returns>
public OperateResult WriteOneRegister( string address, ushort value )
{
byte[] buffer = BitConverter.GetBytes( value );
return WriteOneRegister( address, buffer[1], buffer[0] );
}
#endregion
#region Write Base
/// <summary>
/// 将数据写入到Modbus的寄存器上去需要指定起始地址和数据内容
/// </summary>
/// <param name="address">起始地址,格式为"1234"</param>
/// <param name="value">写入的数据长度根据data的长度来指示</param>
/// <returns>返回写入结果</returns>
/// <remarks>
/// 富地址格式,支持携带站号信息,功能码信息,具体参照类的示例代码
/// </remarks>
/// <example>
/// 此处演示批量写入的示例
/// <code lang="cs" source="HslCommunication_Net45.Test\Documentation\Samples\Modbus\Modbus.cs" region="WriteExample1" title="Write示例" />
/// </example>
public override OperateResult Write( string address, byte[] value )
{
OperateResult<byte[]> command = BuildWriteRegisterCommand( address, value );
if (!command.IsSuccess) return command;
return CheckModbusTcpResponse( command.Content );
}
#endregion
#region Write Coil
/// <summary>
/// 写一个线圈信息,指定是否通断
/// </summary>
/// <param name="address">起始地址</param>
/// <param name="value">写入值</param>
/// <returns>返回写入结果</returns>
public OperateResult WriteCoil( string address, bool value )
{
OperateResult<byte[]> command = BuildWriteOneCoilCommand( address, value );
if (!command.IsSuccess) return command;
return CheckModbusTcpResponse( command.Content );
}
/// <summary>
/// 批量写线圈信息,指定是否通断
/// </summary>
/// <param name="address">起始地址</param>
/// <param name="values">写入值</param>
/// <returns>返回写入结果</returns>
public OperateResult WriteCoil( string address, bool[] values )
{
OperateResult<byte[]> command = BuildWriteCoilCommand( address, values );
if (!command.IsSuccess) return command;
return CheckModbusTcpResponse( command.Content );
}
#endregion
#region Write bool[]
/// <summary>
/// 向寄存器中写入bool数组返回值说明比如你写入M100,那么data[0]对应M100.0
/// </summary>
/// <param name="address">要写入的数据地址</param>
/// <param name="values">要写入的实际数据长度为8的倍数</param>
/// <returns>返回写入结果</returns>
public OperateResult Write( string address, bool[] values )
{
return Write( address, SoftBasic.BoolArrayToByte( values ) );
}
#endregion
#region Object Override
/// <summary>
/// 返回表示当前对象的字符串
/// </summary>
/// <returns>字符串信息</returns>
public override string ToString( )
{
return $"ModbusTcpNet[{IpAddress}:{Port}]";
}
#endregion
}
}