【入門編】【上級者向け】VB.NETのWPFアプリにおけるSystem.IO.Ports(シリアル通信)やUSBデバイス連携とUIスレッドの統合 – Visual Basic (VB / VB.NET)解析バイブル

スポンサーリンク

【上級者向け】VB.NETのWPFアプリにおけるシリアル通信・USBデバイス連携とUIスレッドの統合:リアルタイムデータ表示の極意

皆さん、こんにちは!VB.NETの世界へようこそ。今回は、製造業や計測器との連携で避けては通れない、シリアル通信やUSBデバイスからの非同期データを、WPFのUIスレッド安全に処理し、リアルタイムでグラフやテキストボックスに反映させるための、ちょっと踏み込んだアーキテクチャ設計について、じっくりと紐解いていきましょう。

「マクロの記録から一歩進んで、もっとパワフルなアプリケーションを作りたい!」
「ハードウェアからのデータって、どうやってUIに表示するの?同期処理でアプリが固まっちゃう…」

そんな悩みを抱えるあなたへ。ここでは、表面的なコードのコピペではなく、その背後にある「なぜそうするのか」という本質を、優しく、そして丁寧に解説していきます。ここをクリアすれば、VB.NETでの高度なUI構築の扉が、きっと開きますよ!

なぜUIスレッド安全な処理が重要なのか? – UIの「固まる」現象の正体

さて、まず最初に、なぜUIスレッド安全な処理が重要なのか、その理由を理解しましょう。

WPFアプリケーションでは、ユーザーインターフェース(UI)の描画や操作は、UIスレッドと呼ばれる特別なスレッドで行われています。このUIスレッドは、ユーザーのクリックやキー入力などのイベントを受け取り、画面の描画を更新する、いわば「顔」となる部分です。

一方、シリアル通信やUSBデバイスからのデータ受信は、時間がかかる場合や、予期せぬタイミングで発生することがあります。もし、これらの重い処理をUIスレッドで直接実行してしまうと、どうなるでしょうか?

「UIスレッドが、重い処理に占有されてしまう」

これにより、UIスレッドはユーザーからのイベントを受け取ることができなくなり、画面がフリーズしたように見えてしまいます。これが、皆さんが経験する「UIが固まる」現象の正体です。

![](https://via.placeholder.com/600×300.png?text=UIスレッド+vs+バックグラウンドスレッド)
*UIスレッドは、ユーザー操作と画面描画を担当。重い処理はバックグラウンドスレッドで!*

では、どうすればこの問題を解決できるのでしょうか?

非同期処理の力:バックグラウンドスレッドでのデータ取得

解決策は、重い処理をUIスレッドから切り離し、バックグラウンドスレッドで実行することです。これにより、UIスレッドは常にユーザー操作に応答できるようになり、アプリ全体の応答性が向上します。

VB.NETでは、非同期処理を実現するための強力なメカニズムが用意されています。今回は、`System.IO.Ports` を使ったシリアル通信を例に、具体的な方法を見ていきましょう。

# `SerialPort` クラスと非同期イベント

`System.IO.Ports.SerialPort` クラスは、シリアルポート通信を簡単に行うためのクラスです。このクラスには、データ受信時に発生する `DataReceived` イベントがあります。

![](https://via.placeholder.com/600×200.png?text=SerialPort+DataReceived+イベント)
*DataReceivedイベントは、データ受信時に非同期で発生します。*

この `DataReceived` イベントは、UIスレッドとは別のスレッドで発生する ことがあります。これは、アプリケーションの実行環境や設定によって異なりますが、一般的にはバックグラウンドスレッドで処理されると考えるのが安全です。

# UIスレッドへの「Marshaler」:`Dispatcher.Invoke` / `Dispatcher.BeginInvoke`

ここで問題となるのが、バックグラウンドスレッドで受信したデータを、UIスレッドのコントロール(例えば `TextBox` や `DataGrid`)に直接書き込もうとした場合です。前述の通り、これはUIスレッドの排他制御に反するため、エラーが発生したり、最悪の場合アプリがクラッシュしたりする可能性があります。

そこで登場するのが、UIスレッドへの「Marshaler」 という概念です。これは、バックグラウンドスレッドで実行された処理の結果を、安全にUIスレッドに渡すための仕組みです。

WPFでは、`Dispatcher` オブジェクトがこの役割を担います。`Dispatcher` には、以下の2つの主要なメソッドがあります。

  • `Dispatcher.Invoke(Action)`: 指定した処理を、UIスレッドで同期的に実行します。処理が完了するまで、呼び出し元のスレッドは待機します。
  • `Dispatcher.BeginInvoke(Action)`: 指定した処理を、UIスレッドで非同期的に実行します。処理の完了を待たずに、呼び出し元のスレッドは処理を続行します。

どちらを使うべきかは、状況によります。

  • UIを即座に更新したい場合: `Dispatcher.Invoke` を使うと、処理が完了した直後にUIが更新されるため、よりリアルタイム感が出ます。
  • UIの更新をバックグラウンドで行い、アプリの応答性を最優先したい場合: `Dispatcher.BeginInvoke` を使うと、UIスレッドをブロックせずに処理が進むため、アプリ全体の応答性がより高まります。

今回は、リアルタイム性を重視するため、`Dispatcher.Invoke` を使ってUIの更新を行いましょう。

実践:VB.NET WPFでのシリアル通信とUI統合サンプル

それでは、具体的なコード例を見ていきましょう。ここでは、簡単なWPFアプリケーションを作成し、シリアルポートから受信したデータを `TextBox` に表示する例を示します。

# XAML(View)の準備

まず、UIの定義となるXAMLファイル(例: `MainWindow.xaml`)を編集します。

<Window x:Class="WpfSerialApp.MainWindow"
        xmlns="http://schemas.microsoft.com/winfx/2006/xaml/presentation"
        xmlns:x="http://schemas.microsoft.com/winfx/2006/xaml"
        xmlns:d="http://schemas.microsoft.com/expression/blend/2008"
        xmlns:mc="http://schemas.openxmlformats.org/markup-compatibility/2006"
        xmlns:local="clr-namespace:WpfSerialApp"
        mc:Ignorable="d"
        Title="Serial Port Monitor" Height="300" Width="500">
    <Grid Margin="10">
        <Grid.RowDefinitions>
            <RowDefinition Height="Auto"/>
            <RowDefinition Height="*"/>
        </Grid.RowDefinitions>

        <StackPanel Orientation="Horizontal" Grid.Row="0" Margin="0,0,0,10">
            <TextBlock Text="Port:" VerticalAlignment="Center" Margin="0,0,5,0"/>
            <ComboBox x:Name="cmbPorts" Width="100" Margin="0,0,10,0"/>
            <Button Content="Connect" Click="ConnectButton_Click" Width="80" Margin="0,0,5,0"/>
            <Button Content="Disconnect" Click="DisconnectButton_Click" Width="80" IsEnabled="False"/>
        </StackPanel>

        <TextBox x:Name="txtReceivedData" Grid.Row="1" TextWrapping="Wrap" VerticalScrollBarVisibility="Auto" IsReadOnly="True"/>
    </Grid>
</Window>

コード解説:

  • `ComboBox x:Name=”cmbPorts”`: 利用可能なシリアルポートを選択するためのコンボボックスです。
  • `Button x:Name=”Connect”` / `Disconnect`: シリアルポートへの接続・切断ボタンです。
  • `TextBox x:Name=”txtReceivedData”`: シリアルポートから受信したデータを表示するためのテキストボックスです。`IsReadOnly=”True”` で、ユーザーが直接編集できないようにしています。

# VB.NET(Code-behind)の実装

次に、コードビハインドファイル(例: `MainWindow.xaml.vb`)に、シリアル通信のロジックを実装します。

“`vb.net
Imports System.IO.Ports
Imports System.Threading

Public Class MainWindow
Private serialPort As SerialPort
Private isConnected As Boolean = False

‘ UIスレッド安全にデータを更新するためのデリゲート
Delegate Sub UpdateUIDelegate(ByVal text As String)

‘ ウィンドウがロードされたときの処理
Private Sub MainWindow_Loaded(sender As Object, e As RoutedEventArgs) Handles Me.Loaded
LoadAvailablePorts()
End Sub

‘ 利用可能なシリアルポートをロードするメソッド
Private Sub LoadAvailablePorts()
Dim ports() As String = SerialPort.GetPortNames()
cmbPorts.ItemsSource = ports
If ports.Length > 0 Then
cmbPorts.SelectedIndex = 0 ‘ デフォルトで最初のポートを選択
End If
End Sub

‘ 接続ボタンがクリックされたときの処理
Private Sub ConnectButton_Click(sender As Object, e As RoutedEventArgs)
If cmbPorts.SelectedItem Is Nothing Then
MessageBox.Show(“Please select a port.”, “Error”, MessageBoxButton.OK, MessageBoxImage.Error)
Return
End If

Dim portName As String = cmbPorts.SelectedItem.ToString()

Try
‘ SerialPortオブジェクトの初期化
serialPort = New SerialPort(portName, 9600, Parity.None, 8, StopBits.One) ‘ ボーレートなどは適宜変更
AddHandler serialPort.DataReceived, AddressOf SerialPort_DataReceived ‘ データ受信イベントハンドラを追加

‘ シリアルポートを開く
serialPort.Open()
isConnected = True

‘ UIコントロールの状態を更新
cmbPorts.IsEnabled = False
CType(sender, Button).IsEnabled = False ‘ Connectボタンを無効化
Dim disconnectButton As Button = CType(sender, Button).Parent.FindName(“DisconnectButton”, CType(sender, Button))
If disconnectButton IsNot Nothing Then
disconnectButton.IsEnabled = True
End If

txtReceivedData.Text = $”Connected to {portName}.” & Environment.NewLine

Catch ex As Exception
MessageBox.Show($”Error connecting to port {portName}: {ex.Message}”, “Error”, MessageBoxButton.OK, MessageBoxImage.Error)
End Try
End Sub

‘ 切断ボタンがクリックされたときの処理
Private Sub DisconnectButton_Click(sender As Object, e As RoutedEventArgs)
DisconnectSerialPort()
End Sub

‘ シリアルポートを切断するメソッド
Private Sub DisconnectSerialPort()
If serialPort IsNot Nothing AndAlso serialPort.IsOpen Then
‘ イベントハンドラを削除 (重要!)
RemoveHandler serialPort.DataReceived, AddressOf SerialPort_DataReceived
serialPort.Close()
serialPort.Dispose() ‘ リソースを解放
serialPort = Nothing
isConnected = False

‘ UIコントロールの状態を更新
cmbPorts.IsEnabled = True
Dim connectButton As Button = CType(Me.FindName(“ConnectButton”), Button)
If connectButton IsNot Nothing Then
connectButton.IsEnabled = True
End If
CType(sender, Button).IsEnabled = False ‘ Disconnectボタンを無効化

txtReceivedData.AppendText(“Disconnected.” & Environment.NewLine)
End If
End Sub

‘ シリアルポートからデータを受信したときのイベントハンドラ
Private Sub SerialPort_DataReceived(sender As Object, e As SerialDataReceivedEventArgs)
‘ ★★★ ここが重要!UIスレッド安全な処理 ★★★
‘ UIコントロールの更新は、必ずUIスレッドで行う必要がある
‘ Dispatcher.Invoke を使用して、UIスレッドで処理を実行する
If serialPort IsNot Nothing AndAlso serialPort.IsOpen Then
Try
‘ 受信したデータを読み込む (改行コードなどを区切りにすることが多い)
Dim receivedString As String = serialPort.ReadExisting()

‘ UIスレッドに処理を委譲してTextBoxを更新
‘ BeginInvokeではなくInvokeを使うことで、UIの更新が確実に行われる
Dispatcher.Invoke(Sub()
‘ 複数行のデータが一度に来る場合もあるのでAppendTextを使用
txtReceivedData.AppendText(receivedString)
‘ テキストボックスのスクロールを一番下にする
txtReceivedData.ScrollToEnd()
End Sub)
Catch ex As Exception
‘ エラーが発生しても、UIスレッドをブロックしないように注意
‘ 必要であれば、エラーログなどを記録する
System.Diagnostics.Debug.WriteLine($”Error in DataReceived: {ex.Message}”)
End Try
End If
End Sub

‘ ウィンドウが閉じられるときの処理
Private Sub MainWindow_Closing(sender As Object, e As System.ComponentModel.CancelEventArgs) Handles Me.Closing
‘ アプリケーション終了時にシリアルポートを確実に切断する
DisconnectSerialPort()
End Sub

End Class
“`

コード解説(特に重要な部分):

1. `Imports System.IO.Ports`: `SerialPort` クラスを使用するために必要です。
2. `Private serialPort As SerialPort`: `SerialPort` オブジェクトをクラスメンバーとして宣言します。これにより、アプリケーションのライフサイクル全体でオブジェクトを保持できます。
3. `AddHandler serialPort.DataReceived, AddressOf SerialPort_DataReceived`: `DataReceived` イベントが発生したときに `SerialPort_DataReceived` メソッドが呼び出されるようにイベントハンドラを登録します。
4. `SerialPort_DataReceived` メソッド:

  • `Dispatcher.Invoke(Sub() … End Sub)`: この部分が、このコードの心臓部です。
  • `Dispatcher.Invoke` は、指定された `Action`(ここでは匿名メソッド `Sub() … End Sub`)を、必ずUIスレッドで実行 させます。
  • `serialPort.ReadExisting()` で受信したデータを読み込みます。
  • その読み込んだデータを `txtReceivedData.AppendText()` で `TextBox` に追記します。`AppendText` を使うことで、新しいデータが追加されても、既存のテキストが消えません。
  • `txtReceivedData.ScrollToEnd()` は、新しいデータが表示されるように、テキストボックスを自動的にスクロールさせます。
  • `Try…Catch` ブロック: シリアル通信は、予期せぬエラー(ポートが閉じられた、デバイスが外されたなど)が発生する可能性があります。`Try…Catch` で囲むことで、エラーが発生してもアプリケーション全体がクラッシュするのを防ぎ、デバッグ情報を出力するなど、適切な処理を行えるようにします。

5. `RemoveHandler serialPort.DataReceived, AddressOf SerialPort_DataReceived`: `DisconnectSerialPort` メソッドや `MainWindow_Closing` メソッドで、必ずイベントハンドラを解除 します。これを怠ると、`serialPort` オブジェクトが解放された後も、古いハンドラがメモリに残り、予期せぬエラー(`NullReferenceException` など)の原因となることがあります。これは、リソースリークやクラッシュの典型的な原因の一つです。
6. `serialPort.Dispose()`: `SerialPort` オブジェクトはアンマネージドリソース(COMポートなど)を使用するため、不要になったら `Dispose()` メソッドを呼び出してリソースを解放することが推奨されます。`Close()` メソッドも内部で `Dispose()` を呼び出すことがありますが、明示的に呼び出すことで、リソース解放の意図を明確にできます。

陥りやすいエラーとその対策

  • `System.InvalidOperationException`: 「`This type of operation cannot be performed while another operation that affects the same object is in progress.`」のようなエラー。これは、UIコントロールへのアクセスが、UIスレッド以外から行われている典型的なサインです。必ず `Dispatcher.Invoke` または `Dispatcher.BeginInvoke` を使用してください。
  • `NullReferenceException`: `serialPort` オブジェクトが `Nothing` の状態、または `IsOpen` でない状態でアクセスしようとした場合に発生します。接続状態を常に確認し、`serialPort` オブジェクトが有効な場合にのみ操作を行うようにしてください。
  • イベントハンドラの解除漏れ: 前述の通り、`RemoveHandler` を忘れると、アプリケーションの終了時や再接続時に予期せぬ動作を引き起こします。`DisconnectSerialPort` メソッドとウィンドウの `Closing` イベントで、必ず解除処理を実装しましょう。
  • ボーレートや通信設定の不一致: シリアル通信では、デバイス側とアプリケーション側のボーレート、パリティ、データビット、ストップビットの設定が一致している必要があります。一致しない場合、データが文字化けしたり、全く受信できなかったりします。デバイスのマニュアルを確認し、正確な設定を行ってください。
  • UIのフリーズ: `DataReceived` イベントハンドラ内で、重い処理(ファイル書き込み、複雑な計算など)を直接実行してしまうと、再びUIがフリーズします。これらの処理も、別途バックグラウンドスレッド(`Task.Run` など)に切り出すことを検討してください。

より高度な連携:グラフ表示やUSBデバイス

今回の例は `TextBox` への表示でしたが、このアーキテクチャはグラフ表示や他のUSBデバイス連携にも応用できます。

  • グラフ表示: 受信したデータを数値データとしてパースし、WPFの `LineSeries` や `DataGrid` などに `Dispatcher.Invoke` を使って追加していきます。大量のデータを扱う場合は、パフォーマンスを考慮して、一定数ごとにデータをまとめて更新するなどの工夫も有効です。
  • USBデバイス(HIDなど): HIDデバイスからのレポート受信なども、非同期イベントとして扱える場合が多いです。受信したレポートデータをパースし、同様に `Dispatcher.Invoke` を使ってUIに反映させます。

まとめ:安定したリアルタイムUI構築のために

Visual Basic .NETのWPFアプリケーションで、シリアル通信やUSBデバイスからの非同期データを扱うことは、一見難しそうに感じるかもしれません。しかし、UIスレッドの概念を理解し、`Dispatcher.Invoke` を適切に使うことで、安定したリアルタイムUIを構築することが可能です。

今回解説した内容は、VB.NETでより高度なデスクトップアプリケーションを開発するための、まさに「本質」の部分です。これらの知識をしっかりと身につければ、製造現場の制御システム、計測データのリアルタイムモニタリング、カスタムハードウェアとの連携など、様々な分野で活躍できるアプリケーションを開発できるようになるでしょう。

「ここをクリアすれば、Visual Basic (VB.NET)の基本はバッチリですよ」という温かい言葉を胸に、ぜひこの知識をあなたの開発に活かしてみてください。応援しています!

タイトルとURLをコピーしました