串口通信与NJH框架

NJH框架

    public class BaseSerialPort {

        #region 字段
        private const int msgMaxLength = 512;//通信协议中最长的指令的字节数目，制定的通信协议最长指令不得超过msgMaxLength
        private object locker = new object();//在串口接收数据的线程中使用，保证数据接收正确
        
        private byte[] byteMsgRecv;//使用字节协议时，用于接收数据
        private string strMsgRecv;//使用字符协议时，用于接收数据

        private AutoResetEvent waiterForRsp = new AutoResetEvent(false);//用于同步用户的Logic线程和串口的DataReceived线程
        private int usingSource = 0;//保证一条指令的交互完整性，或多条指令组成的模块的交互完整性

        public SerialPort _device {
            get; private set;
        }
        private Encoding encoding;//字符编码
        #endregion

        #region 构造函数
        /// <summary>
        /// 使用字节型通信协议调用此构造函数
        /// </summary>
        /// <param name="portName">串口名</param>
        /// <param name="baudRate">波特率</param>
        /// <param name="dataBits">数据位</param>
        /// <param name="stopBits">停止位</param>
        /// <param name="parity">奇偶校验</param>
        public BaseSerialPort(string portName, int baudRate, int dataBits, StopBits stopBits, Parity parity) {
            this._device = new SerialPort();
            this._device.PortName = portName;
            this._device.BaudRate = baudRate;
            this._device.DataBits = dataBits;
            this._device.StopBits = stopBits;
            this._device.Parity = parity;
            this._device.DataReceived += Device_DataReceived;
            this.encoding = null;
        }
        /// <summary>
        /// 使用字符串型通信协议调用此构造函数
        /// </summary>
        /// <param name="portName">串口名</param>
        /// <param name="baudRate">波特率</param>
        /// <param name="dataBits">数据位</param>
        /// <param name="stopBits">停止位</param>
        /// <param name="parity">奇偶校验</param>
        public BaseSerialPort(string portName, int baudRate, int dataBits, StopBits stopBits, Parity parity, Encoding encoding) {
            this._device = new SerialPort();
            this._device.PortName = portName;
            this._device.BaudRate = baudRate;
            this._device.DataBits = dataBits;
            this._device.StopBits = stopBits;
            this._device.Parity = parity;
            this._device.DataReceived += Device_DataReceived;
            this.encoding = encoding;
        }
        #endregion

        #region 连接设备
        public void Connect() {
            try {
                if (!this._device.IsOpen) {
                    this._device.Open();
                }
            }
            catch {
                throw new Exception(string.Format("端口{0}已被占用或被拒绝访问",this._device.PortName));
            }
        }
        #endregion

        #region 关闭连接
        public void Close() {
            if (this._device.IsOpen) {
                this._device.Close();
            }
        }
        #endregion

        #region 接收数据
        public void Device_DataReceived(object sender, SerialDataReceivedEventArgs e) {
            lock (locker) {
                if (_device.BytesToRead > 0) {
                    byte[] buff = new byte[msgMaxLength];
                    int startIndex = 0;
                    while (_device.BytesToRead > 0) {
                        int count = _device.Read(buff, startIndex, _device.BytesToRead);
                        startIndex += count;
                        Thread.Sleep(10);
                    }

                    byte[] msg = new byte[startIndex];
                    Array.Copy(buff, msg, startIndex);

                    if (this.encoding == null) {
                        this.byteMsgRecv = msg;
                    }
                    else {
                        string strMsg = this.encoding.GetString(msg);
                        this.strMsgRecv = strMsg;
                    }
                    waiterForRsp.Set();
                }
            }
        }
        #endregion

        #region 发送消息
        public void SendMsg(byte[] msg) {
            this.Connect();
            this._device.Write(msg, 0, msg.Length);
        }

        public void SendMsg(string msg) {
            this.Connect();
            byte[] msgToByte = this.encoding.GetBytes(msg);
            this._device.Write(msgToByte, 0, msgToByte.Length);
        }
        #endregion

        #region 原子操作
        /// <summary>
        /// 接收设备的响应消息(字节型通信协议)
        /// </summary>
        /// <param name="timeOut">等待设备回复的最大时长</param>
        /// <param name="msg">收到的设备的回复</param>
        /// <returns></returns>
        public bool RecvRsp(int timeOut, out byte[] msg) {
            bool isInTime = waiterForRsp.WaitOne(timeOut);
            byte[] buff = new byte[byteMsgRecv.Length];
            Array.Copy(byteMsgRecv, buff, byteMsgRecv.Length);
            msg = buff;
            return isInTime;
        }
        /// <summary>
        /// 接收设备的响应消息(字符型通信协议)
        /// </summary>
        /// <param name="timeOut">等待设备回复的最大时长</param>
        /// <param name="msg">收到的设备的回复</param>
        /// <returns></returns>
        public bool RecvRsp(int timeOut, out string msg) {
            bool isInTime = waiterForRsp.WaitOne(timeOut);
            msg = strMsgRecv;
            return isInTime;
        }

        public void OccupyRoute() {
            while (Interlocked.Exchange(ref usingSource, 1) == 1)
                ;
        }

        public void AbandonRoute() {
            Interlocked.Exchange(ref usingSource, 0);
        }
        #endregion
    }

使用方法：

1，适用场景

上位机和设备通过协议发送和接收数据交互，从而达到上位机控制设备的目的。

2，使用方法

（1）示例

现在有个需求：上位机软件包括一个点胶机控制器，用来控制点胶机的开始吐胶，停止吐胶，真空压力值等行为。

/// <summary>
    /// 点胶机控制器
    /// </summary>
    class DispenserControler {
        //串口
        private BaseSerialPort port = new BaseSerialPort("COM1", 9600, 8, StopBits.One, Parity.None,Encoding.ASCII);

        public void Init() {
            port.Connect();
        }
        //吐胶
        public void TuJiao() {
            port.OccupyRoute();
            port.SendMsg("tu jiao");
            string msg;
            bool res = port.RecvRsp(20000, out msg);
            if (res == false) {
                Console.WriteLine("OVER TIME");
            }
            else {
                Console.WriteLine(msg);
            }
             port.AbandonRoute();
        }
        public void ShutDown() {
            port.Close();
        }
    }

 （2）首先创建一个“控制器”类。

（3）创建一个BaseSerialPort实例，作为控制器的通信工具。

（4）根据通信协议是字节型还是字符串型，选用不同的构造函数创建BaseSerialPort实例。

（5）public void OccupyRoute()     public void AbandonRoute() 两个函数极为重要；

一.保证一个由若干指令组合而成的交互过程的连贯性

OccupyRoute();

Send();//不需要回复的指令

Send();//需要回复的指令

RecvRsp();//处理回复

AbandonRoute()；

二，每条指令的开头和结尾

OccupyRoute();

Send();//需要回复的指令

RecvRsp();//处理回复

AbandonRoute()；

含义：发送完指令，处理设备的回复，然后让出 串口接收数据的唯一缓存，允许其他指令和设备交互。

三，RecvRsp()的使用方法

检查返回值，若false，表示规定时间内未收到设备的回复，Rsp超时。

检查返回值，若true，则使用RecvRsp()传出的接收到的数据。