串口通信封装 - 一定时间内等待关键字

以下是常用的串口通信的封装，主要调用了System.IO.Ports里面的方法。

串口接收字符串或者字节数组时，根据在一定时间内是否接收到关键字符串判断串口接收完成。

 

    public class SerialPortOperation
    {
        SerialPort serialPort = null;
        string strBufferLeft = string.Empty;

        public SerialPortOperation(string strComPort, int nBaudRate)
        {
            serialPort = new SerialPort(strComPort, nBaudRate);
            serialPort.DataReceived += comm_DataReceived;
        }

        void comm_DataReceived(object sender, SerialDataReceivedEventArgs e)
        {
            string strBufferTemp = string.Empty;
            int bufferLen = serialPort.BytesToRead;
            byte[] tmp = new byte[bufferLen];
            int curRcv = 0;
            //int flag = 0;

            //tmp.Initialize();
            lock (Global.SerialLock)
            {
                curRcv = serialPort.Read(tmp, curRcv, bufferLen);

                strBufferTemp = Encoding.UTF8.GetString(tmp);

                //委托打印至窗体
                Global.frmATOSM.Invoke(Global.frmATOSM.appendText, Global.frmATOSM.rtxtCOM, strBufferTemp);

                //Global.Buffer = strBufferTemp;
                strBufferLeft += strBufferTemp;
            }
        }

        public bool Open(out string strErrorInfo)
        {
            strErrorInfo = string.Empty;

            try
            {
                serialPort.Open();
                return true;
            }
            catch (Exception ex)
            {
                strErrorInfo = "Open serial port occurs Ex:" + ex.ToString();
                return false;
            }
        }

        public bool Close(out string strErrorInfo)
        {
            strErrorInfo = string.Empty;

            try
            {
                if (serialPort != null)
                {
                    serialPort.Close();
                    serialPort = null;
                }
                return true;
            }
            catch (Exception ex)
            {
                strErrorInfo = "Close serial port occurs Ex:" + ex.ToString();
                return false;
            }
        }

        public bool SendCmd(string strCmd, out string strErrorInfo)
        {
            strErrorInfo = string.Empty;
            Byte[] bytes = new byte[] { };

            try
            {
                strBufferLeft = string.Empty;

                if (string.IsNullOrEmpty(strCmd))
                {
                    strErrorInfo = "Command can't be null or empty.";
                    return false;
                }
                bytes = Encoding.UTF8.GetBytes(strCmd);
                serialPort.Write(bytes, 0, bytes.Length);
                return true;
            }
            catch (Exception ex)
            {
                strErrorInfo = "Send command occurs Ex:" + ex.ToString();
                return false;
            }
        }

        public bool SendCmd(Byte[] bytes, out string strErrorInfo)
        {
            strErrorInfo = string.Empty;

            try
            {
                strBufferLeft = string.Empty;

                if (null == bytes)
                {
                    strErrorInfo = "Command can't be null or empty.";
                    return false;
                }
                serialPort.Write(bytes, 0, bytes.Length);
                return true;
            }
            catch (Exception ex)
            {
                strErrorInfo = "Send command occurs Ex:" + ex.ToString();
                return false;
            }
        }

        public bool WaitReply(string strWaitString, out string strBuffer, TimeSpan timeout, out string strErrorInfo)
        {
            strBuffer = string.Empty;
            string strBufferTemp = string.Empty;
            strErrorInfo = string.Empty;
            int bufferLen = 10240;
            byte[] tmp = new byte[bufferLen];
            int left = 0;
            int curRcv = 0;
            //int flag = 0;

            int BeginTick = Environment.TickCount;
            int EndTick = Environment.TickCount;

            bool IsContainWaitString = false;

            try
            {
                if (null == serialPort || !serialPort.IsOpen)
                {
                    strErrorInfo = "Serial port is null or not open.";
                    return false;
                }

                tmp.Initialize();
                left = tmp.Length;
                //strBuffer = strBufferLeft;

                while (true)
                {

                    EndTick = Environment.TickCount;
                    if (timeout.TotalSeconds * 1000 > (EndTick - BeginTick))
                    {
                        lock (Global.SerialLock)
                        {
                            strBufferTemp = strBufferLeft;

                            //strBuffer = strBuffer.Trim('\0');

                            //strBuffer += strBufferTemp;

                            foreach (string strWaitStringTemp in strWaitString.Split('|'))
                            {
                                if (strBufferTemp.Contains(strWaitStringTemp))
                                {
                                    IsContainWaitString = true;
                                    break;
                                }
                            }
                            if (IsContainWaitString)
                            {
                                //strBufferLeft = strBuffer.Substring(strBuffer.IndexOf(strWaitString) + strWaitString.Length);
                                //strBuffer = strBuffer.Substring(0, strBuffer.IndexOf(strWaitString) + strWaitString.Length);
                                //System.Windows.Forms.MessageBox.Show("strBufferLeft+:" + strBufferLeft);
                                //System.Windows.Forms.MessageBox.Show("strBuffer+:" + strBuffer);
                                strBuffer = strBufferTemp;
                                break;
                            }
                        }
                    }
                    else
                    {
                        strBuffer = strBufferTemp;// 超时退出  
                        //flag = -1;
                        strErrorInfo = string.Format("Receive buffer \"{0}\" out of {1} seconds.", strWaitString, timeout.TotalSeconds);
                        return false;
                    }

                }

                return true;
            }
            catch (Exception ex)
            {
                strErrorInfo = "Wait reply occurs Ex: " + ex.Message;
                return false;
            }
        }

        //public bool WaitReply(string strWaitString, out string strBuffer, TimeSpan timeout, out string strErrorInfo)
        //{
        //    strBuffer = string.Empty;
        //    string strBufferTemp = string.Empty;
        //    strErrorInfo = string.Empty;
        //    int bufferLen = 10240;
        //    byte[] tmp = new byte[bufferLen];
        //    int left = 0;
        //    int curRcv = 0;
        //    //int flag = 0;

        //    int BeginTick = Environment.TickCount;
        //    int EndTick = Environment.TickCount;

        //    bool IsContainWaitString = false;

        //    try
        //    {
        //        if (null == serialPort || !serialPort.IsOpen)
        //        {
        //            strErrorInfo = "Serial port is null or not open.";
        //            return false;
        //        }

        //        tmp.Initialize();
        //        left = tmp.Length;
        //        strBuffer = strBufferLeft;

        //        while (true)
        //        {
        //            EndTick = Environment.TickCount;
        //            if (timeout.TotalSeconds * 1000 > (EndTick - BeginTick))
        //            {
        //                curRcv = serialPort.Read(tmp, curRcv, left);

        //                strBufferTemp = Encoding.UTF8.GetString(tmp);

        //                strBuffer = strBuffer.Trim('\0');

        //                strBuffer += strBufferTemp;

        //                foreach (string strWaitStringTemp in strWaitString.Split('|'))
        //                {
        //                    if (strBuffer.Contains(strWaitStringTemp))
        //                    {
        //                        IsContainWaitString = true;
        //                        break;
        //                    }
        //                }
        //                if (IsContainWaitString)
        //                {
        //                    strBufferLeft = strBuffer.Substring(strBuffer.IndexOf(strWaitString) + strWaitString.Length);
        //                    strBuffer = strBuffer.Substring(0, strBuffer.IndexOf(strWaitString) + strWaitString.Length);
        //                    break;
        //                }
        //            }
        //            else
        //            {                                                    // 超时退出  
        //                //flag = -1;
        //                strErrorInfo = "Receive buffer timeout.";
        //                return false;
        //            }
        //        }

        //        return true;
        //    }
        //    catch (Exception ex)
        //    {
        //        strErrorInfo = "Wait reply occurs Ex: " + ex.Message;
        //        return false;
        //    }
        //}

        public bool SendAndReceive(string strCmd, string strWaitString, out string strBuffer, TimeSpan timeout, out string strErrorInfo)
        {
            strErrorInfo = string.Empty;
            strBuffer = string.Empty;

            try
            {
                if (!SendCmd(strCmd, out strErrorInfo))
                {
                    return false;
                }
                if (!WaitReply(strWaitString, out strBuffer, timeout, out strErrorInfo))
                {
                    return false;
                }

                return true;
            }
            catch (Exception ex)
            {
                strErrorInfo = "Send command and Receive buffer occurs Ex:" + ex.ToString();
                return false;
            }
        }
    }