【コピペで簡単！】Unityシリアルポート自動検索通信の実装方法

Edit → Project Setting → Player → Other Setting → Configuration → API Compatibility Level を .NET Frameworkに変更します。これによりSystem.IO.Ports.SerialPortクラスが使用可能になります。

using System.Collections.Generic;
using UnityEngine;
using System.IO.Ports;
using System.Threading;
using System.Threading.Tasks;

MonoBehaviourを継承したSerialHandlerクラスを作成します。

public class SerialHandler : MonoBehaviour

シリアルポート通信に必要なフィールドを定義します。

[SerializeField] private List<string> DeviceList = new List<string>();
private static SerialHandler instance;
[SerializeField] string[] activePorts = null;
public string portName = null;
public int baudRate = 9600;
private SerialPort serialPort;
private Thread thread;
private string message;
public string Message;
private bool isPortOpen;

• DeviceList は接続されたデバイスのリストを保持します。
• instance はシングルトンパターンのインスタンスを保持します。
• activePorts は利用可能なシリアルポートのリストです。
• portName は接続するポートの名前です。
• baudRate は通信速度を設定します。
• serialPort はシリアルポートのインスタンスです。
• thread はデータ読み取り用のスレッドです。
• message は読み取ったメッセージを保持します。
• Message は他のスクリプトからアクセスするためのプロパティです。
• isPortOpen はポートが開かれているかどうかを示すフラグです。

シングルトンパターンを実装し、DontDestroyOnLoadでシーン遷移時も破棄されないようにします。

public static SerialHandler Instance
{
    get
    {
        if (instance == null)
        {
            instance = FindObjectOfType<SerialHandler>();
            if (instance == null)
            {
                Debug.LogError("MySerialHandler instance not found in the scene. Please ensure MySerialHandler is attached to a GameObject in the scene.");
            }
        }
        return instance;
    }
}

SearchPortメソッドでSerialPort.GetPortNames()を使用して利用可能なポートを取得。各ポートに”areyouDevice”を送信し、”iamDevice”の返答があるポートを特定します。

private async Task<string> SearchPort()
{
        Debug.Log("SearchPort Start");
        activePorts = SerialPort.GetPortNames();

        foreach (string port in activePorts)
        {
            Debug.Log(port + " is active");

        }

        for (int i = 0; i < activePorts.Length; i++)
        {
            //Debug.Log(activePorts[i] + " is active");
            portName = activePorts[i]; // activePortの名前をportNameに代入する

            message = null; // メッセージをクリアする
            try
            {
                OpenToSearch();

                Thread.Sleep(2000);

                Write("areyouDevice");//デバイスにシリアル通信で文字列を送信する

                await ReadAreYouDevice();// 非同期にデータを読み取る

                Close();

                if (message != null && message.Contains("iamDevice"))
                {
                    Debug.Log(portName + " is Device!");

                    DeviceList.Add(portName);// Deviceのリストに追加

                    Debug.Log(portName);

                    return portName;// Deviceのポート名を返す
                }
                else
                {
                    Debug.Log(portName + " is not Device");
                    Close();

                    Thread.Sleep(1000);
                }
            }
            catch (System.Exception e)
            {
                Debug.Log(e);
                Close();
            }
        }

        Debug.Log("Device is not found in active ports");
        return null;
    }

OpenToSearch メソッドでデバイスを検索するためにシリアルポートを開きます。

private void OpenToSearch()
{
        Debug.Log(portName + " will be opened to search");
        serialPort = new SerialPort(portName, baudRate, Parity.None, 8, StopBits.One)
        {
            ReadTimeout = 500//タイムアウトの設定
        };
        
        serialPort.Open();//ポートを開く
        isPortOpen = true; // ポートが開かれたことを示す
    }

デバイスから返答があった場合データを読み取るためにシリアルポートを再度開きます。

private void OpenToRead()
{
        Debug.Log(portName + " will be opened to read");
        serialPort = new SerialPort(portName, baudRate, Parity.None, 8, StopBits.One)
        {
        };
        serialPort.Open();//ポートを開く
        isPortOpen = true; // ポートが開かれたことを示す
    }

OpenToSearch メソッドでシリアルポートとスレッドを閉じ、リソースを解放します。ReadAreYouDevice メソッド

public void Close()
{
        if (thread != null && thread.IsAlive)//もしスレッドがあったら
        {
            thread.Join();//リードの処理が終わるまで待つ
            thread = null; // スレッドをクリアする
        }
        if (serialPort != null && serialPort.IsOpen)//もしシリアルポートが開いていたら
        {
            serialPort.Close();//ポートを閉じる
            Debug.Log(portName + " is closed");
            serialPort.Dispose();//リソースの解放
            Debug.Log("Resource is cleared");
            serialPort = null; // シリアルポートをクリアする
            isPortOpen = false; // ポートが閉じられたことを示す
        }
    }

ReadAreYouDevice メソッドでデバイスへ送ったデバイス判定メッセージを非同期で読み取ります。

private async Task<string> ReadAreYouDevice()
{
        message = null;
        await Task.Run(() =>
        {
                if (serialPort != null && serialPort.IsOpen)
                {
                    try
                    {
                        message = serialPort.ReadLine();
                    }
                    catch (System.Exception e)
                    {
                        Debug.LogWarning("1:" + e.Message);
                        Close();
                    }
                }
        });
        return message; // 読み取ったメッセージを返す       
    }

ReadAsyncメソッドでTask.Runを使用して非同期でデータを読み取ります。whileループで継続的にシリアルポートからのデータを監視し、受信したメッセージをMessageプロパティに格納します。

public async Task<string> ReadAsync()
{
        message = null;
        await Task.Run(() =>
        {
            while (true)
            {
                if (serialPort != null && serialPort.IsOpen)
                {
                    try
                    {
                        message = serialPort.ReadLine();
                        //Debug.Log(message + " is received");
                    }
                    catch (System.Exception e)
                    {
                        Debug.LogWarning("2:" + e.Message);
                        Close();
                        break;
                    }
                }
                else
                {
                    break;
                }
            }
        });
        Message = message;
        return message;
    }

Writeメソッドでデバイスにメッセージを送信します。

public void Write(string message)
{
        try
        {
            serialPort.Write(message);
            serialPort.Write("\n");
            Debug.Log(message + " is sent");

        }
        catch (System.Exception e)
        {

            Debug.LogWarning("3:" + e.Message);
        }
    }

OnApplicationQuit メソッドでアプリケーション終了時にシリアルポートを閉じます。

private void OnApplicationQuit()
    private void OnApplicationQuit()
    {
        Write("exit");
        Close();
    }

manualOpen メソッドでポート名が設定されていない場合に指定したポートを開きます。

private void manualOpen()
   {
        if(portName == null)
        {
            portName = "COM~";//任意のポート名
            OpenToRead();
        }
    }

SendToAnotherScript メソッドでシリアル通信で受信したデータを別のスクリプトからも使用できるようにします。

public string SendToAnotherScript()
    {
        return message;
    }

こうしてwhileループで継続的にシリアルポートからのデータを監視し、受信したメッセージをMessageプロパティに格納します。

checkConnected関数でSerial.available()を確認し、”areyouDevice”を受信したら”iamDevice”を返答します。

bool checkConnected() {
    if (Serial.available() > 0) { // シリアルバッファにデータがあるか確認
        SerialString = readStringUntil('¥n'); // 改行が送られてくるまでシリアルを読み取る
        if (SerialString == "areyouDevice") { // シリアルからデバイス確認文が送られてきたら
            Serial.println("iamDevice"); // 返答を行う
            return true; // trueを返す
        }
    }
    return false; // デフォルトで false を返す
}

setup関数内でconnectingStatusがtrueになるまで接続を待機します。

void setup() {
    Serial.begin(9600); // シリアル通信を9600ボーレートで開始
    
    while (!connectingStatus) {  // シリアルポートに接続されているかどうか確認
        connectingStatus = checkConnected(); // 接続状態を確認
    }
}

loop関数の メインループで、ここに任意の処理を追加できます。

void loop() {
    // 任意の処理
}

シリアル通信を受信するArduino側のスクリプトの完成

String SerialString = "";       // シリアル通信で受信する文字列
String Commands[3] = { "\0" };  // 分割された文字列を格納する配列
unsigned long searchStartTime = 0;//ポート検索の
unsigned long searchEndTime = 0;

bool connectingStatus = false;//接続状態

void setup() {
	Serial.begin(9600);
	
	  while (!connectingStatus) {  // シリアルポートに接続されているかどうか確認
    connectingStatus = checkConnected();
  }
}

void loop() {

	//任意の処理

}

bool checkConnected() {
	if (Serial.available() > 0) { // シリアルバッファにデータがあるか確認
		SerialString = readStringUntil('¥n');//改行が送られてくるまでシリアルを読み取る
		if (SerialString == "areyouDevice")//シリアルからデバイス確認文が送られてきたら
		{
			Serial.println("iamDevice");//返答を行う
			return true;//trueを返す
		}
	}
	return false;// デフォルトでfalseを返す
}