点击或拖拽改变大小

SAMSerial 类

基于SAM协议的Tcp实现的网络类,支持读取身份证的数据信息,详细参见API文档
Network class implemented by Tcp based on the SAM protocol, which supports reading ID card data information, see API documentation for details
继承层次
SystemObject
  HslCommunication.SerialSerialBase
    HslCommunication.Profinet.IDCardSAMSerial

命名空间:  HslCommunication.Profinet.IDCard
程序集:  HslCommunication (在 HslCommunication.dll 中) 版本:9.1.3.0 (9.1.3.0)
语法
public class SAMSerial : SerialBase

SAMSerial 类型公开以下成员。

构造函数
  名称说明
公共方法SAMSerial
实例化一个默认的对象
Instantiate a default object
Top
属性
  名称说明
公共属性BaudRate
当前连接串口信息的波特率
Baud rate of current connection serial port information
(继承自 SerialBase。)
公共属性IsClearCacheBeforeRead
是否在发送数据前清空缓冲数据,默认是false
Whether to empty the buffer before sending data, the default is false
(继承自 SerialBase。)
公共属性代码示例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
(继承自 SerialBase。)
公共属性PortName
当前连接串口信息的端口号名称
The port name of the current connection serial port information
(继承自 SerialBase。)
公共属性ReceiveTimeout
接收数据的超时时间,默认5000ms
Timeout for receiving data, default is 5000ms
(继承自 SerialBase。)
公共属性RtsEnable
获取或设置一个值,该值指示在串行通信中是否启用请求发送 (RTS) 信号。
Gets or sets a value indicating whether the request sending (RTS) signal is enabled in serial communication.
(继承自 SerialBase。)
公共属性SleepTime
连续串口缓冲数据检测的间隔时间,默认20ms,该值越小,通信速度越快,但是越不稳定。
Continuous serial port buffer data detection interval, the default 20ms, the smaller the value, the faster the communication, but the more unstable.
(继承自 SerialBase。)
Top
方法
  名称说明
公共方法静态成员BuildReadCommand
根据SAM的实际的指令,来生成实际的指令信息
公共方法静态成员CheckADSCommandAndSum
检查当前的指令是否是正确的
公共方法静态成员CheckADSCommandCompletion
检查当前的接收数据信息是否一条完整的数据信息
公共方法CheckSafeModuleStatus
公共方法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
(继承自 SerialBase。)
公共方法Close
关闭当前的串口连接
Close the current serial connection
(继承自 SerialBase。)
公共方法Dispose
释放当前的对象
(继承自 SerialBase。)
受保护的方法Dispose(Boolean)
释放当前的对象
(继承自 SerialBase。)
公共方法Equals
Determines whether the specified object is equal to the current object.
(继承自 Object。)
公共方法静态成员ExtractIdentityCard
从数据中提取出真实的身份证信息
公共方法静态成员ExtractSafeModuleNumber
提炼安全的模块数据信息
受保护的方法代码示例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.
(继承自 SerialBase。)
受保护的方法Finalize
Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection.
(继承自 Object。)
公共方法静态成员GetErrorDescription
获取错误的文本信息
公共方法GetHashCode
Serves as the default hash function.
(继承自 Object。)
公共方法静态成员GetNationEnumerator
枚举当前的所有的民族信息,共计五十六个民族
公共方法静态成员GetNationText
根据民族的代号来获取到民族的文本描述信息
公共方法GetType
Gets the Type of the current instance.
(继承自 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.
(继承自 SerialBase。)
公共方法IsOpen
获取一个值,指示串口是否处于打开状态
Gets a value indicating whether the serial port is open
(继承自 SerialBase。)
受保护的方法MemberwiseClone
Creates a shallow copy of the current Object.
(继承自 Object。)
公共方法Open
打开一个新的串行端口连接
Open a new serial port connection
(继承自 SerialBase。)
公共方法静态成员PackToSAMCommand
将指令进行打包成可以发送的数据对象
公共方法ReadBase
将原始的字节数据发送到串口,然后从串口接收一条数据。
The raw byte data is sent to the serial port, and then a piece of data is received from the serial port.
(继承自 SerialBase。)
公共方法ReadCard
公共方法ReadSafeModuleNumber
公共方法SearchCard
公共方法SelectCard
公共方法SerialPortInni(ActionSerialPort)
根据自定义初始化方法进行初始化串口信息
Initialize the serial port information according to the custom initialization method
(继承自 SerialBase。)
公共方法SerialPortInni(String)
初始化串口信息,9600波特率,8位数据位,1位停止位,无奇偶校验
Initial serial port information, 9600 baud rate, 8 data bits, 1 stop bit, no parity
(继承自 SerialBase。)
公共方法SerialPortInni(String, Int32)
初始化串口信息,波特率,8位数据位,1位停止位,无奇偶校验
Initializes serial port information, baud rate, 8-bit data bit, 1-bit stop bit, no parity
(继承自 SerialBase。)
公共方法SerialPortInni(String, Int32, Int32, StopBits, Parity)
初始化串口信息,波特率,数据位,停止位,奇偶校验需要全部自己来指定
Start serial port information, baud rate, data bit, stop bit, parity all need to be specified
(继承自 SerialBase。)
受保护的方法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
(重写 SerialBaseSPReceived(SerialPort, Boolean).)
受保护的方法SPSend
发送数据到串口去。
Send data to serial port.
(继承自 SerialBase。)
公共方法ToString
Returns a string that represents the current object.
(重写 SerialBaseToString.)
Top
字段
  名称说明
受保护的字段sP_ReadData
串口交互的核心
(继承自 SerialBase。)
Top
扩展方法
  名称说明
公共扩展器方法ToJsonString
获取当前对象的JSON格式表示的字符串。
Gets the string represented by the JSON format of the current object.
(由 HslExtension 定义。)
Top
示例
在使用之前需要实例化当前的对象,然后根据实际的情况填写好串口的信息,否则连接不上去。
实例化操作
private SAMSerial sAMSerial = new SAMSerial( );

public void Open( )
{
    // 下面是初始化连接的代码,在读取身份证信息之前需要被调用一次
    // The following is the code to initialize the connection. It needs to be called once before reading the ID information.
    try
    {
        sAMSerial.SerialPortInni( sp =>
        {
            sp.PortName = "COM1";
            sp.BaudRate = 115200;
            sp.DataBits = 0;
            sp.StopBits = System.IO.Ports.StopBits.None;
            sp.Parity = System.IO.Ports.Parity.None;
        } );

        sAMSerial.Open( );

    }
    catch (Exception ex)
    {
        Console.WriteLine( ex.Message );
    }
}
在实际的读取,我们一般放在后台进行循环扫描的操作,参见下面的代码
基本的读取操作
// 通常是放到后台进行循环扫描,此处举例开了一个线程的操作,实际上你在开发的时候需要注意GC回收垃圾的事
// Usually it is placed in the background for circular scanning. Here is an example of a thread operation. In fact, you need to pay attention to GC garbage collection when you develop
public void StartRead( )
{
    new Thread( new ThreadStart( ThreadBackgroundReadCard ) ) { IsBackground = true }.Start( );
}

private void ThreadBackgroundReadCard( )
{
    while (true)
    {
        Thread.Sleep( 100 );
        // 首先进行寻卡,成功才进行下一步
        // Find the card first, then proceed to the next step
        OperateResult search = sAMSerial.SearchCard( );
        {
            if (!search.IsSuccess)
            {
                continue;
            }
        }

        Thread.Sleep( 100 );
        // 寻卡成功后开始选卡,选卡成功才进行下一步
        // Select card after successful card search, then proceed to the next step after successful card selection
        if (sAMSerial.SelectCard( ).IsSuccess)
        {
            OperateResult<IdentityCard> read = sAMSerial.ReadCard( );
            if (read.IsSuccess)
            {
                // read.Content,详细的身份证信息,需要查看 IdentityCard 类型的定义,包含身份的名字,
                Console.WriteLine( read.Content.ToString( ) );
            }
            else
            {
                Console.WriteLine( $"读卡失败:{read.Message}" );
            }
        }
    }
}
参见