SerialPort

[C#] SerialPortでのデータ読み取り方法

2025-01-18更新日: 2025-01-18

C#でSerialPortクラスを使用してデータを読み取るには、まずSystem.IO.Ports名前空間をインポートします。

次に、SerialPortオブジェクトを作成し、ポート名、ボーレート、パリティ、データビット、ストップビットなどの通信設定を行います。

Openメソッドでポートを開き、ReadLineやReadメソッドを使用してデータを読み取ります。

データの読み取りは同期的に行うことも、DataReceivedイベントを使用して非同期的に行うことも可能です。

読み取りが完了したら、Closeメソッドでポートを閉じます。

エラー処理やリソース管理も重要です。

目次から探す

データの読み取り方法
- 同期的なデータ読み取り
- 非同期的なデータ読み取り
エラー処理と例外管理
- よくあるエラーとその対処法
- 例外処理の実装
リソース管理
- ポートのオープンとクローズ
- IDisposableの実装
応用例
まとめ

データの読み取り方法

C#のSerialPortクラスを使用して、シリアルポートからデータを読み取る方法には、主に同期的な方法と非同期的な方法があります。

それぞれの方法について詳しく解説します。

同期的なデータ読み取り

同期的なデータ読み取りでは、データが到着するまでプログラムが待機します。

この方法は、データの受信が確実である場合に適しています。

以下は、同期的にデータを読み取るサンプルコードです。

using System;
using System.IO.Ports;
class Program
{
    static void Main()
    {
        SerialPort port = new SerialPort("COM1", 9600);
        
        try
        {
            port.Open(); // ポートをオープンする
            
            string data = port.ReadLine(); // データを読み取る
            
            Console.WriteLine("受信データ: " + data); // 受信データを表示する
        }
        catch (Exception ex)
        {
            Console.WriteLine("エラー: " + ex.Message); // エラーメッセージを表示する
        }
        finally
        {
            port.Close(); // ポートをクローズする
        }
    }
}

受信データ: ここに受信したデータが表示されます

このコードでは、指定したCOMポートからデータを読み取り、受信したデータをコンソールに表示します。

エラーが発生した場合は、そのメッセージを表示します。

非同期的なデータ読み取り

非同期的なデータ読み取りでは、データが到着するのを待たずにプログラムが他の処理を続けることができます。

この方法は、リアルタイムでデータを処理する必要がある場合に便利です。

以下は、非同期的にデータを読み取るサンプルコードです。

using System;
using System.IO.Ports;
class Program
{
    static void Main()
    {
        SerialPort port = new SerialPort("COM1", 9600);
        
        port.DataReceived += new SerialDataReceivedEventHandler(DataReceivedHandler); // イベントハンドラを登録
        
        try
        {
            port.Open(); // ポートをオープンする
            
            Console.WriteLine("データ受信待機中...");
            Console.ReadLine(); // ユーザーの入力を待つ
        }
        catch (Exception ex)
        {
            Console.WriteLine("エラー: " + ex.Message); // エラーメッセージを表示する
        }
        finally
        {
            port.Close(); // ポートをクローズする
        }
    }
    private static void DataReceivedHandler(object sender, SerialDataReceivedEventArgs e)
    {
        SerialPort sp = (SerialPort)sender;
        string data = sp.ReadLine(); // データを読み取る
        
        Console.WriteLine("受信データ: " + data); // 受信データを表示する
    }
}

データ受信待機中...
受信データ: ここに受信したデータが表示されます

このコードでは、DataReceivedイベントを使用して、データが到着した際に自動的に呼び出されるイベントハンドラを設定しています。

これにより、データを非同期的に受信し、受信したデータをコンソールに表示します。

エラー処理と例外管理

シリアルポートを使用する際には、さまざまなエラーが発生する可能性があります。

これらのエラーを適切に処理することは、プログラムの安定性を保つために重要です。

ここでは、よくあるエラーとその対処法、さらに例外処理の実装方法について解説します。

よくあるエラーとその対処法

以下は、シリアルポートを使用する際によく発生するエラーとその対処法をまとめた表です。

エラーの種類	説明	対処法
ポートが開けない	指定したポートが使用中または存在しない	ポート名を確認し、他のアプリケーションが使用していないか確認する
タイムアウトエラー	データの受信がタイムアウトした	タイムアウト設定を見直し、データ送信側の状態を確認する
データフォーマットエラー	受信したデータが期待した形式でない	データの送信側のフォーマットを確認し、適切な形式で送信する

これらのエラーは、シリアルポートの設定や接続状況に依存するため、事前に確認しておくことが重要です。

例外処理の実装

C#では、例外処理を使用してエラーを管理することができます。

try-catchブロックを使用することで、エラーが発生した際にプログラムがクラッシュするのを防ぎ、適切なエラーメッセージを表示することができます。

以下は、例外処理を実装したサンプルコードです。

using System;
using System.IO.Ports;
class Program
{
    static void Main()
    {
        SerialPort port = new SerialPort("COM1", 9600);
        
        try
        {
            port.Open(); // ポートをオープンする
            
            string data = port.ReadLine(); // データを読み取る
            Console.WriteLine("受信データ: " + data); // 受信データを表示する
        }
        catch (UnauthorizedAccessException ex)
        {
            Console.WriteLine("エラー: ポートにアクセスできません。 " + ex.Message); // アクセスエラーを表示
        }
        catch (IOException ex)
        {
            Console.WriteLine("エラー: 入出力エラーが発生しました。 " + ex.Message); // 入出力エラーを表示
        }
        catch (TimeoutException ex)
        {
            Console.WriteLine("エラー: タイムアウトが発生しました。 " + ex.Message); // タイムアウトエラーを表示
        }
        catch (Exception ex)
        {
            Console.WriteLine("エラー: " + ex.Message); // その他のエラーを表示
        }
        finally
        {
            if (port.IsOpen)
            {
                port.Close(); // ポートをクローズする
            }
        }
    }
}

このコードでは、tryブロック内でポートをオープンし、データを読み取ります。

エラーが発生した場合は、特定の例外に応じたメッセージを表示し、最後にポートをクローズします。

これにより、エラーが発生してもプログラムが適切に動作し続けることができます。

リソース管理

シリアルポートを使用する際には、リソース管理が非常に重要です。

特に、ポートのオープンとクローズを適切に行うことで、他のアプリケーションとの競合を避け、システムの安定性を保つことができます。

また、IDisposableインターフェースを実装することで、リソースの解放を自動化することができます。

ポートのオープンとクローズ

シリアルポートを使用する際は、必ずポートをオープンし、使用が終わったらクローズする必要があります。

これにより、他のアプリケーションがポートを使用できるようになります。

以下は、ポートのオープンとクローズを適切に行うサンプルコードです。

using System;
using System.IO.Ports;
class Program
{
    static void Main()
    {
        SerialPort port = new SerialPort("COM1", 9600);
        
        try
        {
            port.Open(); // ポートをオープンする
            Console.WriteLine("ポートがオープンしました。");
            // データの読み取りや書き込み処理をここに記述
            
        }
        catch (Exception ex)
        {
            Console.WriteLine("エラー: " + ex.Message); // エラーメッセージを表示する
        }
        finally
        {
            if (port.IsOpen)
            {
                port.Close(); // ポートをクローズする
                Console.WriteLine("ポートがクローズしました。");
            }
        }
    }
}

このコードでは、ポートをオープンした後、エラーが発生した場合でも必ずポートをクローズするようにしています。

これにより、リソースの無駄遣いを防ぎます。

IDisposableの実装

IDisposableインターフェースを実装することで、オブジェクトが不要になった際にリソースを自動的に解放することができます。

これにより、メモリリークやリソースの競合を防ぐことができます。

以下は、IDisposableを実装したサンプルコードです。

using System;
using System.IO.Ports;
class SerialPortManager : IDisposable
{
    private SerialPort port;
    private bool disposed = false; // 破棄済みフラグ
    public SerialPortManager(string portName, int baudRate)
    {
        port = new SerialPort(portName, baudRate);
        port.Open(); // ポートをオープンする
    }
    public void ReadData()
    {
        // データの読み取り処理をここに記述
        string data = port.ReadLine();
        Console.WriteLine("受信データ: " + data);
    }
    public void Dispose()
    {
        Dispose(true);
        GC.SuppressFinalize(this); // ガベージコレクションを抑制
    }
    protected virtual void Dispose(bool disposing)
    {
        if (!disposed)
        {
            if (disposing)
            {
                // マネージドリソースの解放
                if (port != null)
                {
                    port.Close(); // ポートをクローズする
                    port.Dispose(); // ポートのリソースを解放
                }
            }
            // アンマネージドリソースの解放(必要に応じて)
            disposed = true; // 破棄済みフラグを設定
        }
    }
}
class Program
{
    static void Main()
    {
        using (SerialPortManager spManager = new SerialPortManager("COM1", 9600))
        {
            spManager.ReadData(); // データを読み取る
        } // usingブロックを抜けると自動的にDisposeが呼ばれる
    }
}

このコードでは、SerialPortManagerクラスがIDisposableを実装しています。

usingブロックを使用することで、オブジェクトがスコープを抜ける際に自動的にDisposeメソッドが呼ばれ、リソースが解放されます。

これにより、リソース管理が簡素化され、プログラムの安定性が向上します。

応用例

C#のSerialPortクラスを使用することで、さまざまな応用が可能です。

ここでは、複数ポートの同時管理、データのリアルタイム処理、そしてGUIアプリケーションでの使用例について解説します。

複数ポートの同時管理

複数のシリアルポートを同時に管理することで、異なるデバイスからのデータを同時に受信することができます。

以下は、複数のポートを管理するサンプルコードです。

using System;
using System.IO.Ports;
class Program
{
    static void Main()
    {
        string[] ports = { "COM1", "COM2" }; // 管理するポートの配列
        SerialPort[] serialPorts = new SerialPort[ports.Length];
        for (int i = 0; i < ports.Length; i++)
        {
            serialPorts[i] = new SerialPort(ports[i], 9600);
            serialPorts[i].DataReceived += DataReceivedHandler; // イベントハンドラを登録
            serialPorts[i].Open(); // ポートをオープンする
        }
        Console.WriteLine("複数ポートのデータ受信待機中...");
        Console.ReadLine(); // ユーザーの入力を待つ
        foreach (var port in serialPorts)
        {
            if (port.IsOpen)
            {
                port.Close(); // ポートをクローズする
            }
        }
    }
    private static void DataReceivedHandler(object sender, SerialDataReceivedEventArgs e)
    {
        SerialPort sp = (SerialPort)sender;
        string data = sp.ReadLine(); // データを読み取る
        Console.WriteLine($"ポート {sp.PortName} から受信データ: {data}"); // 受信データを表示する
    }
}

このコードでは、COM1とCOM2の2つのポートを同時にオープンし、それぞれのポートからデータを受信します。

受信したデータは、どのポートからのものかを示して表示されます。

データのリアルタイム処理

リアルタイムでデータを処理する場合、非同期的なデータ読み取りが有効です。

以下は、受信したデータをリアルタイムで処理するサンプルコードです。

using System;
using System.IO.Ports;
class Program
{
    static void Main()
    {
        SerialPort port = new SerialPort("COM1", 9600);
        port.DataReceived += DataReceivedHandler; // イベントハンドラを登録
        try
        {
            port.Open(); // ポートをオープンする
            Console.WriteLine("データ受信待機中...");
            Console.ReadLine(); // ユーザーの入力を待つ
        }
        catch (Exception ex)
        {
            Console.WriteLine("エラー: " + ex.Message); // エラーメッセージを表示する
        }
        finally
        {
            if (port.IsOpen)
            {
                port.Close(); // ポートをクローズする
            }
        }
    }
    private static void DataReceivedHandler(object sender, SerialDataReceivedEventArgs e)
    {
        SerialPort sp = (SerialPort)sender;
        string data = sp.ReadLine(); // データを読み取る
        ProcessData(data); // データを処理する
    }
    private static void ProcessData(string data)
    {
        // データの処理をここに記述
        Console.WriteLine("リアルタイム処理: " + data); // 受信データを表示する
    }
}

このコードでは、受信したデータをProcessDataメソッドでリアルタイムに処理します。

データが到着するたびに、即座に処理が行われます。

GUIアプリケーションでの使用

C#のWindows FormsやWPFを使用して、GUIアプリケーションでシリアルポートを管理することも可能です。

以下は、簡単なWindows Formsアプリケーションの例です。

using System;
using System.IO.Ports;
using System.Windows.Forms;
public class SerialPortForm : Form
{
    private SerialPort port;
    private TextBox textBox;
    private Button openButton;
    public SerialPortForm()
    {
        textBox = new TextBox { Multiline = true, Dock = DockStyle.Fill };
        openButton = new Button { Text = "ポートをオープン", Dock = DockStyle.Top };
        openButton.Click += OpenButton_Click;
        Controls.Add(textBox);
        Controls.Add(openButton);
    }
    private void OpenButton_Click(object sender, EventArgs e)
    {
        port = new SerialPort("COM1", 9600);
        port.DataReceived += DataReceivedHandler; // イベントハンドラを登録
        try
        {
            port.Open(); // ポートをオープンする
            textBox.AppendText("ポートがオープンしました。\n");
        }
        catch (Exception ex)
        {
            textBox.AppendText("エラー: " + ex.Message + "\n"); // エラーメッセージを表示する
        }
    }
    private void DataReceivedHandler(object sender, SerialDataReceivedEventArgs e)
    {
        SerialPort sp = (SerialPort)sender;
        string data = sp.ReadLine(); // データを読み取る
        Invoke(new Action(() => textBox.AppendText("受信データ: " + data + "\n"))); // UIスレッドで更新
    }
    [STAThread]
    public static void Main()
    {
        Application.EnableVisualStyles();
        Application.Run(new SerialPortForm());
    }
}