UARTモニター

はじめに
XIAO Debug Mate UARTモニターのドキュメントへようこそ。
このページでは、Debug Mateをシリアルデータモニタリングに使用する方法について明確なガイダンスを提供します。ハードウェアセットアップの手順、推奨ソフトウェアツール、および開発・デバッグシナリオでUARTモニタリング機能を最大限に活用するための関連概念の説明をご覧いただけます。
シリアルモニターを使用する前に理解すべき概念
詳細に入る前に、シリアル通信を扱う上で不可欠な2つの基本概念を明確にしましょう。
シリアル通信
シリアル通信は、単一の通信チャネルを通じて、一度に1ビットずつ順次データを送信する方法です。これは、車が一車線の道路を一台ずつ走行するようなものと考えてください。マイクロコントローラーの世界では、これは最も一般的にUART(Universal Asynchronous Receiver-Transmitter)と呼ばれるプロトコルを使用して実装されます。これは、開発者がデバイスからデバッグメッセージ、センサー読み取り値、ステータス更新を取得する主要な方法です。
RX/TX
これらは、シリアル通信を実現する2つのピンです:
- TX(Transmit): これは「送信」ピンです。マイクロコントローラーはこのピンを使用してデータを送信します。
- RX(Receive): これは「受信」ピンです。マイクロコントローラーはこのピンを使用して受信データを待機します。
UART通信ロジック
覚えておくべき最も重要なルールは、デバイス間でこれらのピンをクロス接続する必要があることです。一方のデバイスのTXピンは他方のRXピンに接続し、その逆も同様です。これは会話のようなものです:一人の口(TX)が他の人の耳(RX)に話しかけるのです。
入門ガイド
XIAO Debug Mateは、内蔵LCDスクリーンで直接、またはコンピューターにデータを転送することで、2つの方法でシリアルデータをモニターできます。このガイドでは両方の方法を説明します。
ソフトウェア準備(PCモニタリング用)
コンピューターでシリアルデータを表示する場合は、「シリアルターミナル」または「シリアルモニター」アプリケーションが必要です。XIAO Debug MateはPC上で標準のCOMポートとして表示されます。以下は人気のあるソフトウェア選択肢です:
- PlatformIO Serial Monitor: VS CodeでPlatformIOを使用している場合は、ステータスバーの "Serial Monitor" ボタンをクリックするだけです。
- Arduino IDE Serial Monitor: Arduino IDEに組み込まれたクラシックでシンプルなモニター。
- PuTTY: Windows用の軽量で非常に人気のあるターミナルエミュレーター。
- CoolTerm: Windows、macOS、Linux用のユーザーフレンドリーで機能豊富なシリアルターミナル。
- minicom / screen: LinuxおよびmacOSユーザー向けの強力なコマンドラインベースのツール。

ハードウェア準備
XIAO Debug Mateは、シリアルモニタリング用にターゲットデバイスを接続する3つの柔軟な方法を提供します。
XIAOボード用(プラグアンドプレイ)
これはXIAOボードをモニタリングする最も簡単な方法です。Debug Mateは、デフォルトでXIAOのSerial1ポート(D6とD7)を監視するように設計されています。
- XIAOボードをXIAO Debug Mate前面の雌ヘッダーに直接差し込むだけです。
- 接続は自動的に行われます。追加の配線は必要ありません。

UART Grove デバイス用
専用の Grove コネクタにより、任意の UART ベースの Grove モジュールとのクリーンで安全な接続が可能です。
- Grove UART デバイス(例:Grove GPS や Grove MP3 V4)を用意します。
- 標準の Grove ケーブルを使用して、XIAO Debug Mate の右側にある Grove ポートに接続します。

その他の UART デバイス用
2つの開発ボードの3.3V電源ピンを接続する必要があるかどうかは、他のデバイスがDebug Mateから電源供給されているかどうかによります。他のデバイスが独自のUSB接続で電源供給されている場合は、デバイスとDebug Mateの3.3Vピンを接続しないでください。接続するとデバイスが損傷する可能性があります。
他の開発ボードやカスタム回路など、アクセス可能な TX および RX ピンを持つ任意のデバイスを監視できます。
これを行う主な方法は2つあります:
-
オプション1:メインヘッダーの使用: デュポンワイヤーを使用して、デバイスの TX および RX ピンを XIAO Debug Mate のメスヘッダーに接続します。クロス接続を忘れずに:デバイス TX -> Debug Mate RX(ヘッダーのピン D7)、デバイス RX -> Debug Mate TX(ヘッダーのピン D6)。
-
オプション2:Grove ポートの使用: Grove to デュポン変換ケーブルを使用します。Grove コネクタを Debug Mate に差し込み、個別のデュポン端子をデバイスの TX、RX、VCC、GND ピンに接続します。これはより安定で信頼性の高い接続方法です。

以下の図は Grove インターフェースのピン定義を示しています。

デバイスの TX ピンが Debug Mate の受信ピンに接続され、デバイスの RX ピンが送信ピンに接続されていることを常に確認してください。
多用途な設計により、XIAO Debug Mate では最大2つの UART デバイスを同時に接続できます:1つは XIAO ソケット経由、もう1つは Grove ポート経由です。その後、画面上のメニューを使用して各デバイスの監視を切り替えることができます。
この強力な機能により、複数のシリアルデバイスを含む複雑なシステムをデバッグする際の繰り返し配線の面倒なプロセスが不要になります。
シリアルモニターの操作
XIAO Debug Mate は、デバイス上および PC ベースの監視の両方に使用できる多用途なシリアルツールを備えています。このガイドでは、ナビゲーションと機能について説明します。
基本的なナビゲーションとコントロール
機能を探索する前に、インターフェースのナビゲーション方法を理解することが重要です。すべての操作はスクロールホイールとボタンを使用して実行されます。
-
メニューへの入り方: メイン画面から、スクロールホイールを使用してシリアルツールアイコン(左下)をハイライトします。ボタンを押してシリアルメニューに入ります。
-
基本コントロール:
- スクロールホイール: カーソルの移動や主要モード間の切り替えに使用します。
- ボタン短押し: 選択の確認や設定カーソルの有効化に使用します。
- ボタン長押し: メニューの終了や戻るために使用します。
主な操作状態は2つあります:
- カーソル非アクティブ: この状態では、スクロールホイールを回すと主要機能間(例:パススルーモード vs モニターモード)を切り替えます。
- カーソルアクティブ: 短押し後、画面上部にカーソルが表示されます。この時、スクロールホイールでカーソルを移動し、変更する設定を選択できます。
クイックナビゲーションガイド
| 操作 | 機能 |
|---|---|
| スクロールホイール(カーソルなし) | パススルーモードとモニターモード間の切り替え。 |
| ボタン短押し | ソース/ボーレート用の選択カーソルを有効化。 |
| ボタン長押し | 前のメニューに戻る。 |
2つの監視モード
基本コントロールを理解したら、2つの主要な動作モード間を簡単に切り替えることができます。スクロールホイールを回すだけで(カーソルが非アクティブの間)切り替えられます。
1. パススルーモード(PC へ)

これはデフォルトモードで、選択されたソースからのすべてのシリアルデータを PC ベースのシリアルターミナルで表示するために、コンピューターに直接転送するように設計されています。
- 画面表示: 画面にはデータ自体ではなく、ステータス情報が表示されます。
- 左上: アクティブなシリアルソース(例:
XIAO)。 - 右上: 現在のボーレート(例:
9600)。 - 中央:
RXおよびTXインジケーター(Debug Mate の視点から)が PC との間のデータフローを示すためにアニメーションします。
- 左上: アクティブなシリアルソース(例:
2. モニターモード(LCD 上)

このモードは Debug Mate の LCD 画面上でシリアルデータを直接キャプチャして表示します。このモードではデータは PC に転送されません。
- 画面表示: 画面は2つのウィンドウに分割されてデータトラフィックを表示します。
RX ウィンドウ: XIAO ソケットから受信したデータを表示します。TX ウィンドウ: Grove ポートから受信したデータを表示します。
Debug Mate は両方のソースからのデータを同時に表示することはできません。設定メニューを使用してアクティブなソースを選択する必要があります。
ソースとボーレートの設定
データソースやボーレートを変更するには、まず設定カーソルを有効にする必要があります。
- カーソルの有効化: どちらのモードからでも、ボタンを一度押します。画面上部にカーソルが表示されます。

- 設定の選択: ボタンを使用してソース(
XIAO/Grove)とボーレート間でカーソルを移動します。

ソースを切り替えた後、新しいソースからのコンテンツがすぐに表示されない場合があります。これは、プリンターが新しい入力ソースからの情報を受信する前に、前の入力ソースのデータの印刷が完了するのを待つ必要があるためです。
- メニューへの入り方: ボーレートオプションについて、希望する設定がハイライトされた状態で、ボタンを押して設定メニューを開きます。

- 値の変更: スクロールホイールを使用してボーレートを選択し、ボタンを押して確認します。
ボーレートメニューと視覚的インジケーター
ボーレートメニューでは、9つの一般的なレート(4800から921600)から選択できます。独特な視覚的演出として、このメニューに入るとデバイス背面の36個のLEDマトリックスも有効になり、選択されたレートを反映して光のパターンが変化します。

重要な概念と制限事項
- デバッガーであり、ブリッジではない: Debug Mate は診断ツールであり、通信ブリッジではありません。XIAO ポートから Grove ポートへのデータの自動転送は行いません。
- 固定シリアルパラメーター: コアシリアルパラメーター(8-N-1)はファームウェアで固定されています。上級ユーザーはオープンソースコードを変更してこれらを変更できます。
- 単一ソース監視: 一度に1つのソース(XIAO または Grove)のみをアクティブに監視できます。
特別な謝辞
LED マトリックスの設計インスピレーションを提供してくださった**啊猫啊狗晒太阳 (Ah Mao Ah Gou Shai Tai Yang)**に特別な感謝を申し上げます。Debug Mate のオンボード LED インジケーターの設計は、彼らの優れたオープンソースプロジェクトを参考にしています。オリジナルの設計は非常に創造的で実用的です。
オリジナルの設計をご覧になりたい場合は、以下のリンクからデモンストレーション動画と作者のホームページをご確認いただけます。