点击或拖拽改变大小

SerialBase 类

所有串行通信类的基类,提供了一些基础的服务,核心的通信实现
The base class of all serial communication classes provides some basic services for the core communication implementation
继承层次

命名空间:  HslCommunication.Serial
程序集:  HslCommunication (在 HslCommunication.dll 中) 版本:11.0.5.0 (11.0.5.0)
语法
public class SerialBase : IDisposable

SerialBase 类型公开以下成员。

构造函数
  名称说明
公共方法SerialBase
实例化一个无参的构造方法
Instantiate a parameterless constructor
Top
属性
  名称说明
公共属性BaudRate
当前连接串口信息的波特率
Baud rate of current connection serial port information
公共属性IsClearCacheBeforeRead
是否在发送数据前清空缓冲数据,默认是false
Whether to empty the buffer before sending data, the default is false
公共属性代码示例LogNet
组件的日志工具,支持日志记录,只要实例化后,当前网络的基本信息,就以DEBUG等级进行输出
The component's logging tool supports logging. As long as the instantiation of the basic network information, the output will be output at DEBUG
公共属性PortName
当前连接串口信息的端口号名称
The port name of the current connection serial port information
公共属性ReceiveEmptyDataCount
获取或设置连续接收空的数据次数,在数据接收完成时有效,每个单位消耗的时间为SleepTime,配合CheckReceiveDataComplete(MemoryStream)来更好的控制完整数据接收。
Get or set the number of consecutive empty data receptions, which is valid when data reception is completed. The time consumed by each unit is SleepTime, which is better with CheckReceiveDataComplete(MemoryStream) Control complete data reception.
公共属性ReceiveTimeout
接收数据的超时时间,默认5000ms
Timeout for receiving data, default is 5000ms
公共属性RtsEnable
获取或设置一个值,该值指示在串行通信中是否启用请求发送 (RTS) 信号。
Gets or sets a value indicating whether the request sending (RTS) signal is enabled in serial communication.
公共属性SleepTime
连续串口缓冲数据检测的间隔时间,默认20ms,该值越小,通信速度越快,但是越不稳定。
Continuous serial port buffer data detection interval, the default 20ms, the smaller the value, the faster the communication, but the more unstable.
Top
方法
  名称说明
受保护的方法CheckReceiveDataComplete
检查当前从串口接收的数据是否是完整的,如果是完整的,则需要返回 True,串口数据接收立即完成,默认返回 False
Check whether the data currently received from the serial port is complete. If it is complete, you need to return True. The serial port data reception is completed immediately, and the default returns False
公共方法ClearSerialCache
清除串口缓冲区的数据,并返回该数据,如果缓冲区没有数据,返回的字节数组长度为0
The number sent clears the data in the serial port buffer and returns that data, or if there is no data in the buffer, the length of the byte array returned is 0
公共方法Close
关闭当前的串口连接
Close the current serial connection
公共方法Dispose
释放当前的对象
受保护的方法Dispose(Boolean)
释放当前的对象
公共方法Equals (继承自 Object。)
受保护的方法代码示例ExtraOnClose
根据实际的协议选择是否重写本方法,有些协议在断开连接之前,需要发送一些报文来关闭当前的网络通道
Select whether to rewrite this method according to the actual protocol. Some protocols need to send some packets to close the current network channel before disconnecting.
受保护的方法Finalize (继承自 Object。)
公共方法GetHashCode (继承自 Object。)
公共方法GetType (继承自 Object。)
受保护的方法代码示例InitializationOnOpen
根据实际的协议选择是否重写本方法,有些协议在创建连接之后,需要进行一些初始化的信号握手,才能最终建立网络通道。
Whether to rewrite this method is based on the actual protocol. Some protocols require some initial signal handshake to establish a network channel after the connection is created.
公共方法IsOpen
获取一个值,指示串口是否处于打开状态
Gets a value indicating whether the serial port is open
受保护的方法MemberwiseClone (继承自 Object。)
公共方法Open
打开一个新的串行端口连接
Open a new serial port connection
公共方法PackCommandWithHeader
对当前的命令进行打包处理,通常是携带命令头内容,标记当前的命令的长度信息,需要进行重写,否则默认不打包
The current command is packaged, usually carrying the content of the command header, marking the length of the current command, and it needs to be rewritten, otherwise it is not packaged by default
公共方法ReadFromCoreServer(Byte)
将原始的字节数据发送到串口,然后从串口接收一条数据。
The raw byte data is sent to the serial port, and then a piece of data is received from the serial port.
公共方法ReadFromCoreServer(IEnumerableByte)
公共方法ReadFromCoreServer(Byte, Boolean, Boolean)
将原始的字节数据发送到串口,然后从串口接收一条数据。
The raw byte data is sent to the serial port, and then a piece of data is received from the serial port.
公共方法ReadFromCoreServer(SerialPort, Byte, Boolean, Boolean)
将数据发送到当前的串口通道上去,并且从串口通道接收一串原始的字节报文,默认对方必须返回数据,也可以手动修改不返回数据信息。
Send data to the current serial channel, and receive a string of original byte messages from the serial channel. By default, the other party must return data, or you can manually modify it to not return data information.
公共方法ReadFromCoreServerAsync(Byte)
将原始的字节数据发送到串口,然后从串口接收一条数据。
The raw byte data is sent to the serial port, and then a piece of data is received from the serial port.
公共方法ReadFromCoreServerAsync(IEnumerableByte)
公共方法SerialPortInni(ActionSerialPort)
根据自定义初始化方法进行初始化串口信息
Initialize the serial port information according to the custom initialization method
公共方法SerialPortInni(String)
初始化串口信息,9600波特率,8位数据位,1位停止位,无奇偶校验
Initial serial port information, 9600 baud rate, 8 data bits, 1 stop bit, no parity
公共方法SerialPortInni(String, Int32)
初始化串口信息,波特率,8位数据位,1位停止位,无奇偶校验
Initializes serial port information, baud rate, 8-bit data bit, 1-bit stop bit, no parity
公共方法SerialPortInni(String, Int32, Int32, StopBits, Parity)
初始化串口信息,波特率,数据位,停止位,奇偶校验需要全部自己来指定
Start serial port information, baud rate, data bit, stop bit, parity all need to be specified
公共方法SetPipeSerial
设置一个新的串口管道,一般来说不需要调用本方法,当多个串口设备共用一个COM口时才需要使用本方法进行设置共享的管道。
To set a new serial port pipe, generally speaking, you do not need to call this method. This method is only needed to set the shared pipe when multiple serial devices share the same COM port.
受保护的方法SPReceived
从串口接收一串字节数据信息,直到没有数据为止,如果参数awaitData为false, 第一轮接收没有数据则返回
Receives a string of bytes of data information from the serial port until there is no data, and returns if the parameter awaitData is false
受保护的方法SPSend
发送数据到串口去。
Send data to serial port.
公共方法ToString (重写 ObjectToString.)
公共方法UnpackResponseContent
根据对方返回的报文命令,对命令进行基本的拆包,例如各种Modbus协议拆包为统一的核心报文,还支持对报文的验证
According to the message command returned by the other party, the command is basically unpacked, for example, various Modbus protocols are unpacked into a unified core message, and the verification of the message is also supported
Top
字段
  名称说明
受保护的字段AtLeastReceiveLength
从串口中至少接收的字节长度信息
受保护的字段LogMsgFormatBinary
设置日志记录报文是否二进制,如果为False,那就使用ASCII码
Set whether the log message is binary, if it is False, then use ASCII code
受保护的字段pipeSerial
串口交互的核心
Top
扩展方法
  名称说明
公共扩展器方法ToJsonString
获取当前对象的JSON格式表示的字符串。
Gets the string represented by the JSON format of the current object.
(由 HslExtension 定义。)
Top
参见