serialportの受信に、ReadLineを使うか、ReadExistingを使うか

Question

###前提・実現したいこと
WindowsFormアプリを作成しています。

発信機から送信された文字列を、PCにCOMポートで接続されている受信機で
受け取り、受け取った文字列を処理したいと思っています。

###発生している問題・エラーメッセージ
SerialPort.ReadLineを使うと、文字列の送受信後に切断できなくなり、
SerialPort.ReadExistingを使うと、即時処理ができなくなってしまいます。

○ReadLine使用時は通信後、切断しようとすると以下のメッセージが出ます。

スレッドの終了またはアプリケーションの要求によって、I/O処理は中止されました。

○ReadExistingはmsdnの公式ページに「即座に使用できるすべてのバイトを読み取ります。」と説明があり、
実際の動作と受信したデータにズレが生じるようです。

例としては、
「値3」のデータが送信されたが、その段階では受信できず、
次の「値5」を送信したときに「値3」と「値5」の両方が
一緒に受信できる、といった様子です。

「値3」が送信されたらその段階で受信したいと考えています。

###聞きたいこと
通信後切断できるReadExistingを使用したいのですが、
即時処理できないのは困ります。

ReadExistingで即時処理する方法はありますでしょうか？
それともReadlineを使用し、エラーを発生させなくした方が良いでしょうか？
もしくは別のRead系関数を使った方が良いでしょうか？

###該当のソースコード
・ReadLine

        /// <summary>
        /// データ受信が発生した時のイベント
        /// </summary>
        /// <param name="sender"></param>
        /// <param name="e"></param>
        private void serialPortMain_DataReceived(object sender, SerialDataReceivedEventArgs e)
        {
            if (!serialPortMain.IsOpen)
            {
                // 接続していない場合は処理を行わない
                return;
            }
            else
            {
                string data = string.Empty;

                try
                {
                    data = serialPortMain.ReadLine();
                    data = data.Replace("\r", "").Replace("\n", "");
                }
                catch (Exception ex)
                {
                    MessageBox.Show(ex.Message);
                }

                AddRecievedDataDelegate add = new AddRecievedDataDelegate(AddRecievedData);
                textBoxInfo.Invoke(add, data);
            }
        }

        /// <summary>
        /// 
        /// </summary>
        /// <param name="data"></param>
        private delegate void AddRecievedDataDelegate(string data);
        /// <summary>
        /// 
        /// </summary>
        /// <param name="data"></param>
        private void AddRecievedData(string data)
        {
            textBoxInfo.Text += data + "\r\n";
            textBoxInfo.SelectionStart = textBoxInfo.Text.Length;
            textBoxInfo.ScrollToCaret();

            // 文字列調整
            StringPartition(data);            
        }

：
・ReadExisting

        /// <summary>
        /// データ受信が発生した時のイベント
        /// </summary>
        /// <param name="sender"></param>
        /// <param name="e"></param>
        private void serialPortMain_DataReceived(object sender, SerialDataReceivedEventArgs e)
        {
            if (!serialPortMain.IsOpen)
            {
                // 接続していない場合は処理を行わない
                return;
            }
            else
            {
                string data = string.Empty;

                try
                {
                    data = serialPortMain.ReadExisting();
                }
                catch (Exception ex)
                {
                    MessageBox.Show(ex.Message);
                }

                AddRecievedDataDelegate add = new AddRecievedDataDelegate(AddRecievedData);
                textBoxInfo.Invoke(add, data);
            }
        }

        // 受信データ
        private string TestStr = string.Empty;

        /// <summary>
        /// 
        /// </summary>
        /// <param name="data"></param>
        private delegate void AddRecievedDataDelegate(string data);
        /// <summary>
        /// 
        /// </summary>
        /// <param name="data"></param>
        private void AddRecievedData(string data)
        {
            textBoxInfo.Text += data;
            textBoxInfo.SelectionStart = textBoxInfo.Text.Length;
            textBoxInfo.ScrollToCaret();

            TestStr += data;
            if (TestStr.EndsWith("\r") || TestStr.EndsWith("\n"))
            {
                // 改行コードまできたら
                string[] str = TestStr.Split(new string[] { "\r\n" }, StringSplitOptions.None);

                for(int i = 0; i < str.Length;i++)
                {
                    if(str[i].Length == 0) { continue; }

                    // 改行コードが残っていたら
                    string str1 = str[i].Replace("\r", "").Replace("\n", "");

                    // 文字列調整
                    StringPartition(str1);
                }

                TestStr = string.Empty;
            }
        }

###補足情報(言語/FW/ツール等のバージョンなど)
C#、Visual Studio 2015

Answer 1

シリアルポートによる通信は、メッセージの区切りのもたせ方に大きく2つ方法があります。

1. メッセージ間で時間を置く
2. メッセージに構造に区切り情報を持たせる。

後者の場合、(例えば改行コードを区切り文字とするなど)

• 受信イベントごとにバッファ内の文字列をすべて読み出し、解析用のバッファに投げる
• メッセージの区切りを検出したら、メッセージ受信イベントを発火する。
• 検出した分のメッセージを適切に検出用バッファから削除する。

---

AddRecievedData()がうまく動いているのか確かめたほうがいいと思います。

ただ、いちいち実機でテストするのも面倒なので、
逐次解析をするためのクラスに抜き出して、

var buffer = new MessageSplitter();
buffer.MessageRecieved += (x => Console.WriteLine(x));
buffer.Add("値3");
buffer.Add("\r\n");
buffer.Add("値5\r\n");

みたいにすればデバッグしやすいです。

Comments

[ichi_goo]

通信方法としては改行コードを区切り文字にできます。
「受信イベントごとにバッファ内の〜」の受信イベントと「メッセージの区切りを〜」のメッセージ受信イベントは別物、ということでしょうか？
バッファ内の文字列を全て読み出すのはReadExistingで行うということでしょうか？

[ozwk]

イベントについては新たに発火してもいいし、単にメソッド呼び出しでもいいです。
大筋は質問文のReadExist版でいいです。
AddRecievedData内で多分私の回答のようなことをやろうとしていると思うんですが
にしてはなんだか処理が複雑になっている気がします。

AddRecievedData関係だけ抜き出して、適当な文字列を与えていって、
意図通りの動作になるか確認してみてはどうでしょう。

[ichi_goo]

たびたびすみません。
ReadExist版のTestStr += data;でozwkさんのおっしゃる「解析用のバッファに投げる」のと同じになりそうですね。
送られてくる文字列の改行コードが必ずしも"¥r¥n"ではないかもしれないので、複雑な書き方になってしまっています。。
しかしこのdataの中に例として"値:3¥r¥n値:5¥r¥n"みたいに前回のコマンドと今回のコマンドが一度に来てしまって、
「値3」を送信したときと受信したときのタイミングが実際の動作とずれてしまうのですが、そのあたりはいかがでしょうか……。

装置の方から「値:5¥r¥n」を送った時点でやっと受信側で一気に「値:3¥r¥n値:5¥r¥n」が受け取れる感じです。

[ozwk]

"値:3¥r¥n"
の後に時間を充分空けて
"値:5¥r¥n"を送ったのに、
"値:5¥r¥n"を送るまでDataReceivedが発火しないということですか?

[ozwk]

一回目の送信でDataReceivedがそもそも発火しない場合は、
ReceivedBytesThresholdプロパティが妙な値になっているか、
そもそも送信側が送っていないかです。

[ichi_goo]

来てますね。。。
どうやら、
AddRecievedDataDelegate add = new AddRecievedDataDelegate(AddRecievedData);
textBoxInfo.Invoke(add, data);
ここが悪さしているっぽいです。見直してみます。
ありがとうございました。
確認できましたら、またご連絡いたします。

[ichi_goo]

できました！
ありがとうございます。
AddRecievedDataは正常に動いていたのですが、
判定条件が間違っていました……。
改行コードの判定では不十分だったみたいです。
色々とアドバイスしていただきありがとうございました。