FT232Rモジュール活用 ＃1 ドライバのインストールからソフト開発まで

ドライバの入手とインストール

FT232Rを使うにはPCにドライバをインストールする必要があります。FTDI社のサイトで無償公開されています。 VCP動作には「VCPドライバ」が、ビットバンモードには「D2XXダイレクトドライバ」が必要です。 ドライバ ダウンロードページ（2011/09現在） http://www.ftdichip.com/Drivers/VCP.htm　または http://www.ftdichip.com/Drivers/D2XX.htm　※どちらも全く同じものが用意されています。 ZIP版よりインストーラ版(xxxxx_setup.exe)をお勧めします。一度に両方インストールできます。xxxxx_setup.exeを実行するとコマンドプロンプトが2回パカパカ開き、インストールが完了します。※WindowsXP/SP3の例。 FT232RモジュールをUSBコネクタに挿し、デバイスマネージャで確認すると「USB Serial Port」が出現しています。 この状態でFT232Rモジュールはもうシリアルポート（COMポート）として使えます。 COMポート何番になるかはPC環境によります。※「通信ポート(COM1)」は、もともとこのPCが備えている本物のCOMポート。

ソフト開発に必要なもの

VCPとビットバンモードのソフト開発について、以降、次の開発環境として話を進めます。 ・WindowsXP(32bit)/SP3 ・Visual Studio 2008 Express Edition - C# VCPとビットバンモードにおけるソフト開発の違い VCP（仮想COMポート）のソフトを開発する際、FT232Rの存在を意識する必要はありません。C#ではSerialPortクラスを使い、あくまでもCOMポートを操作するプログラムとして組みます。 一方で専用APIも用意されています。SerialPortクラスと同等の処理の他、製造番号などデバイス固有情報を取得することができます。例えばPCに接続した複数のデバイスを判別するのに使ったりします。 まとめると、 ◆COMポート制御のソフトを開発するにはSerialPortクラスを使う。基本的に専用APIは使わなくてよい。 ◆ビットバンモードのソフトを開発するには専用APIを使う。SerialPortクラスは動作内容が違うので使えない。 C#で専用APIを使うために必要なもの 専用APIはDLLの形で提供されています(FTD2XX.dll)。中身はC/C++用の関数群なのでC#から呼び出すのは面倒くさそうです。ところが嬉しいことにC#用ラッパーDLLが用意されていて、簡単に専用APIが利用できます。 C#用ラッパーDLLとサンプルプログラム ダウンロードページ（2011/09現在） http://www.ftdichip.com/Support/SoftwareExamples/CodeExamples/CSharp.htm ラッパーDLL →FTD2XX_NET_nnnn.zip nnnnはバージョン番号。 他のリンクも同じファイルを指している。 ラッパーDLLのソースコード →FTD2XX_NETclass.zip 「click here」のリンク。 解凍したファイルの説明 【FTD2XX_NET_xxxx.zip】　→　FTD2XX_NET.dll, FTD2XX_NET.XML FTD2XX_NET.dll FTD2XX.dllをC#から使うためのラッパーDLL。任意のフォルダに配置します。 C#アプリ作成ごとに（新規プロジェクトごとに）、プロジェクトの「参照設定」へ追加します。 ※FTD2XX.dllの方はドライバインストール時に配置されている。WindowsXPの場合 C:\Windows\system32\FTD2XX.dll FTD2XX_NET.XML FTD2XX_NET.dllのドキュメント。アプリ開発には不要です。別途XMLリーダー（Visual Studioのオブジェクトリーダー）で見てDLL内関数のリファレンス代わりにどうぞ、というものです。※ちなみにVisual Studioの機能を使って自動生成されている。 【FTD2XX_NETclass.zip】　→　FTD2XX_NETclass.cs FTD2XX_NETclass.cs FTD2XX_NET.dllのソースコード。アプリ開発には不要です。※FTD2XX_NETclass.csをプロジェクトに加える必要はない。 「XMLファイルよりむしろこちらがドキュメント」くらいのつもりで利用するので（ソースを読む）、あると便利です。

仮想COMポートのソフト開発について

VCP（仮想COMポート）のソフト開発は、通常のSerialPortクラスを使ったソフト開発と同じです。 Visual Studioのプロジェクト上、VCPのためにインポートしたり参照を追加するモジュールはありません。 ですが、サンプルコード「Example3」のようにデバイス固有の情報を取得するには専用APIが必要です。 ※専用APIの使い方は次節「ビットバンモードのソフト開発について」で説明します。 専用APIはSerialPortクラスと同等の機能を備えています。ゆえに… どうせ専用APIを使うことになるなら、SerialPortクラスを使わずに専用APIだけで組んでしまおうか？ それとも、なるべく標準的なSerialPortクラスを使い、足りない機能だけ専用APIを使おうか？ 悩むかもしれませんが、開発者が好きに決めてください。 両方を使うときは注意が必要です。SerialPortオブジェクトからデバイスをOpen()した状態で、FTDIオブジェクトからも同じデバイスをOpen()することはできません。もちろん逆の手順でもダメです。 ※FTDIオブジェクト…専用APIをまとめたFTDIクラスのオブジェクト。 デバイス固有情報を取得するときは、SerialPortオブジェクトでデバイスをOpen()していたらそれをClose()して、FTDIオブジェクトから改めてOpen()して、目的の情報を取得して、FTDIオブジェクトでClose()します。 取得した情報自体は文字列や整数なのでプログラム内で自由に使えます。 サンプルコード「Example3」の実行例 エコーバックの入出力処理はカットしてビルド／実行しています。専用APIによるデバイス情報の取得例です。 例外発生の対策をする FT232Rモジュールを使用した仮想COMポートならではの、アプリケーションの例外エラーが発生し得ます。 それは、「Open()した状態のデバイスをPCから引っこ抜いて、Close()またはアプリを終了した」場合です。 発生する例外 SerialPortをOpen()したあと、デバイス（FT232Rに限らずどのUSB-シリアル変換モジュールでも）を引っこ抜くと、その後挿し直そうが、アプリ終了時に（Main()を抜けるときに）UnauthorizedAccessException例外が発生します。Open()したBaseStreamがClose()されていないので実行環境がClose()/Dispose()しに行きますが、デバイスが無くなってそのBaseStreamにアクセスできないので例外発生、というメカニズムです。 System.UnauthorizedAccessException はハンドルされませんでした。 Message="ポートへのアクセスが拒否されました。" Source="System" StackTrace: 場所 System.IO.Ports.InternalResources.WinIOError(Int32 errorCode, String str) 場所 System.IO.Ports.InternalResources.WinIOError() 場所 System.IO.Ports.SerialStream.Dispose(Boolean disposing) 場所 System.IO.Ports.SerialStream.Finalize() InnerException: 対策案 その1 Main()を抜けるときに実行環境からSerialPort.Dispose()が呼ばれる。そのタイミングで例外をキャッチする方法。 ※詳細は「ThreadException」「UnhandledException」で検索してください。 ・例外キャッチ後、ダイアログを表示するなど何らかの処理が必須。例外発生を「無かったこと」にできない。 ・ダイアログを表示しても、Main()終了時のことなので結局アプリはそのまま終了するしかない。 対策案 その2 SerialPort.Dispose()をオーバーライドし、そこでキャッチする方法。 ソースファイル：　MySerialPort.cs　←拡張子を.txtにしてあります。 7行目 SerialPortの派生クラスを作り、それを使うようにします。 9行目 デバイス引っこ抜き対策のために一時保存しておくBaseStream。コンストラクタ（11-14行目）で初期化しています。 16-20行目 デバイス引っこ抜き対策のため、オープンしたストリームを保存しておきます。 22-29行目 この対策のポイントとなるDispose()のoverrideです。 24-28行目のtry。デバイスをオープンしていなければopenedBaseStreamはnullなので素通りします。 デバイスをオープンしても引っこ抜いていなければ26行目で正しくClose()され、例外は発生しません。 デバイスをオープンして、それを引っこ抜いていると26行目のClose()でUnauthorizedAccessException例外発生、29行目でcatchされます。特に後始末の処理はありません。※「デバイスを抜きましたね？」などとダイアログを表示してもしょうがない。 31行目 MySerialPort.Dispose()は実行環境がオブジェクトを破棄するときだけでなく、MySerialPort.Close()からも呼ばれます。その判定のためのフラグ処理を無視してはいけません。

ビットバンモードのソフト開発について：送信処理

ビットバンモードで接続機器を制御するコンソールアプリの開発例です。専用APIを使います。 例としたアプリは、8bitのI/O各線に接続したLEDを点灯させる内容です。 【注意】説明は全てVisual Studio 2008 Express Edition - C# におけるものです。 準備 「ソリューションエクスプローラー」で「参照設定」を右クリックし、「参照の追加」を選択します。 参照の追加ダイアログが開くので、「参照」タブからFTD2XX_NET.dllを指定します。 FTD2XX_NET.dllは任意のフォルダに配置してあって構いません。ビルド時にプロジェクトのフォルダにコピーされます。 ソースファイル：　Program.cs　←拡張子を.1.txtにしてあります。 5行目 名前空間「FTD2XX_NET」を追加します。専用APIは全てこの名前空間にまとめられています。 13行目 デバイスを操作するためのFTDIオブジェクトを生成します。 14行目 デバイスをオープンします。 オープン方法はいくつかあり、自動的に割り振られたインデックスや、デバイスに埋め込まれている固有番号を指定します。例はインデックスを指定する方法です。PCにデバイスが1つしか接続されていない場合はインデックス0番に確定しているので、このオープン方法が簡単です。 15行目 8bit I/Oの入出力方向（第1引数）と、通信制御の方法（第2引数）を指定します。 方向は出力:1、入力:0として1byteの値で指定します。例は全部出力方向にしています。bit:7〜0 = 11111111 = 0xFF 通信制御は「ビットバンモード」を指定するのですが、さらに同期制御／非同期制御の区別があります。例では非同期制御（Asynchronous Bit Bang mode）を指定しています。 16行目 ボーレートを設定します。デフォルトは9600bpsです。 デフォルト値でよければ記述を省略できますが、明示的に設定した方がよいでしょう。 17-19行目 送信するデータを準備し（18行目）、送信処理を実行しています（19行目）。 例では3個の8bitパラレルデータを出力します。出力タイミング（通信速度）は設定したボーレートの通りです。 入出力方向が入力に指定された線にはマスクがかかり、Write()関数を実行してもその線の電圧状態は変化しません。送信データを作るときに入力線のビット位置を意識しなくてよいので楽です。※今回の例では入力方向の線はありませんが。 何らかの影響により、引数のデータが途中までしか送信できないことが起こり得ます。そのため第3引数に、実際に送信されたバイト数が返されてきます。この値を見て全部のデータが送信されたかどうか判断します。送信バッファがあふれるような通信内容でなければ大丈夫のハズです。※FT232R内蔵の送信バッファは256byte. ドライバ側では4096byte持てる。 Write()関数の戻り値は、関数の実行自体が成功したかどうかです。通信事情により送信されなかったデータがあったとしても、関数内部でDLL呼び出しエラーなどが発生していなければ、戻り値は「成功」となります。 20行目 デバイスをクローズします。 入力方向を設定する場合 例では15行目で8bit I/O線を全て出力方向に設定しました。ここで仮に上位4bitを入力方向に設定するとしましょう。 出力ビット:1、入力ビット:0なので、第1引数は0x0Fとなります。 ftdev.SetBitMode(0x0F, FTDI.FT_BIT_MODES.FT_BIT_MODE_ASYNC_BITBANG); これで上位4bitの線にはマスクがかかり、仮に送信データをセットしてもビットの状態は変化しません。従って上位4bitの線からデータは送信されません。 入出力方向の設定 8bit I/O 受信線 送信線 7 6 5 4 3 2 1 0 入出力方向に 0x0Fを設定した例。 (0000 : 1111) データ'0xAA'を送信しようとすると…（0xAA → 10101010） 8bit I/O 受信線 送信線 7 6 5 4 3 2 1 0 0xAAをセットすると… 0 0 0 0 1 0 1 0 受信線はマスクされているので、そこだけ送信データはセットされない。 Write()関数の動作 Write()関数の動作は、厳密には「デバイスに対する送信要求」です。具体的には送信データをデバイス内蔵の送信バッファに書き込み、デバイスに送信実行を要求します。デバイスはアプリケーションから送信要求を受け、送信バッファ内のデータを実際に送出し始めます。※それでSend()ではなくWrite()と名付けられたのでしょう。 もしこの瞬間にデバイスの送信準備ができていなかったら、デバイスは送信バッファの内容を保留し、準備完了してから送出し始めます。このような状況でさらに次々と送信要求が繰り返されると送信実行が追いつかなくなり…、というわけでWrite()関数の引数のデータと実際に送信されたデータのバイト数にズレが生じることが起こり得るのです。 デバイスの送信準備とは、I/Oポートの状態確認や、直前の送信処理が完了しているかの確認といったことです。 データ送信の勘違いに注意 18行目で挙げた値（0xF0, 0x0F, 0xAA）について、1つの値は8bit I/O線全体の1回分の出力データを表します。 つまり例では、1回目の出力で通信線8本の電圧状態が「11110000」になり、2回目の出力で「00001111」になり、3回目の出力で「10101010」となります。（○の説明表） 勘違い例：3本の線でそれぞれの値（0xF0, 0x0F, 0xAA）を1ビットずつ8回出力し、残り5本の線は出力0で待ち状態、という動作ではありません。（×の説明表） ○このように出力される 8bit I/O 出力順 7 6 5 4 3 2 1 0 (1) 0xF0 1 1 1 1 0 0 0 0 (2) 0x0F 0 0 0 0 1 1 1 1 (3) 0xAA 1 0 1 0 1 0 1 0 ×このような出力ではない 8bit I/O 出力順 7 6 5 4 3 2 1 0 (1) 1 0 1 0 0 0 0 0 (2) 1 0 0 0 0 0 0 0 (3) 1 0 1 0 0 0 0 0 (4) 1 0 0 0 0 0 0 0 (5) 0 1 1 0 0 0 0 0 (6) 0 1 0 0 0 0 0 0 (7) 0 1 1 0 0 0 0 0 (8) 0 1 0 0 0 0 0 0 0xF0,0x0F,0xAA？？ もし、左図のように出力するとしたら… 8bit I/O 出力順 7 6 5 4 3 2 1 0 (1) 0xA0 1 0 1 0 0 0 0 0 (2) 0x80 1 0 0 0 0 0 0 0 (3) 0xA0 1 0 1 0 0 0 0 0 (4) 0x80 1 0 0 0 0 0 0 0 (5) 0x60 0 1 1 0 0 0 0 0 (6) 0x40 0 1 0 0 0 0 0 0 (7) 0x60 0 1 1 0 0 0 0 0 (8) 0x40 0 1 0 0 0 0 0 0 ↑8個の1byteデータをWrite()する。 シリアル通信（TXD/RXDの制御）では、1byteのデータを指定すると1本の送信線(TXD)から1byte分のビット列（8個の0/1）がズラララッと出力されます。そのイメージで勘違いしそうになるのですが、ビットバンモードは違います。こちらはパラレル線なのです。1byteのデータを指定すると8本の通信線にビット（0/1）がセットされ、同時にバッと1回出力してお終いです。

参考（プログラム改造）

LEDが変化する様子が目で見て分かるよう改造しました。0.5秒間隔でLEDの点灯が変化します。 1回に送信するデータが1byteでも、Write()関数にはbyte型で送信データを与える書式がありません。byte配列の形に合わせるため、要素が1個だけの配列を用意します。 ソースファイル：　Program.cs　←拡張子を.2.txtにしてあります。

補足説明

同期制御／非同期制御 FT232Rの動作モードはVCPとビットバンモードがあり、ビットバンモードはさらに同期制御と非同期制御の区別があります。詳細は「AN_232R-01_Bit_Bang_Mode_Available_For_FT232R_and_Ft245R.pdf」を読んでください（下記ドキュメントリンク）。一般的な通信制御の仕組みについては適当な参考書を読んでください。 同期制御 Write()でbyte配列を送信するとき、1byte送信するごとにその瞬間のI/Oポートの電圧状態をデバイス内蔵の受信バッファへ格納します。送受信のタイミングはボーレートの設定によります。 こちらが1byte送信すると、相手機器が受信して応答を返してきます。こちらが次の1byteを送信するとき、直前の送信に対する相手の応答を受信するわけです。と同時にこちらからの1byteは送信されています。この繰り返し動作です。 注意点として、相手機器が何個データを送ってきても、こちらは送信した瞬間のデータしか受け取れません。こちらが1byte送信するごとに、受信バッファに格納されるデータは常に1byteずつです。 ※送信を実行するまで受信データは無視。受信バッファは勝手にオーバーフローしません。 非同期制御 Write()実行のタイミングとは関係なく、相手機器が送ってきたデータをデバイス内蔵の受信バッファに格納して行く動作です。送受信のタイミングはボーレートの設定によります。 注意点として、こちらと相手機器の通信速度（ボーレート）が一致していないと、データの送受信が互いに失敗します。 また、受信バッファがオーバーフローする前に受信データを読み込まなくてはなりません。 I/Oポートの状態は維持される SetBitMode()で送信方向に設定した線では、Write()した最後の値が、次にWrite()するまで維持されます。 例えば8bit全部送信方向として、Write({0xAA, 0xBB})→1秒待機→Write(0xCC) と実行すると、この1秒間、I/Oポートの電圧状態は0xBBのままです。勝手に0x00にリセットされたりしません。 I/Oポートの状態を取得する方法 Read()は受信データを読み取りますが、あくまでデバイス内蔵の受信バッファから読み出すのであり、I/Oポートの電圧状態を直接見ているわけではありません。現在のI/Oポートの電圧状態を取得するにはGetPinStates()関数を使います。もちろん受信バッファの中身は影響を受けません。 GetPinStates()は、I/Oポートの特定のビットを、他のビットに影響を与えず変更したいときに役立ちます。 【例】bit:76543210のうちbit:3を'1'にする（他のbitの値を変化させてはならない） → byte pinState = GetPinStates(); pinState |= 0x08; Write(pinState); レイテンシ デバイスは関数がコールされた瞬間に実行するわけではありません。安定動作のためにレイテンシ（応答遅延時間）が設けられています。デフォルトで16msです。通常はボーレートの設定値に隠れてレイテンシは気になりません。 しかし実行速度がシビアに求められるような内容のソフト開発では、レイテンシの影響が無視できなくなります。 レイテンシはSetLatency()関数で設定できます。FT232Rは0msにまで設定できますが、無闇に小さくすると動作が不安定になる可能性があります。FT232Rと同じシリーズの別ICでは「2ms以上であること」といったものもありますし、カツカツに切り詰めるなら動作テストで安定性をよく確認しましょう。 FT232R ビットバンモードの信号名 bit MSB 7 6 5 4 3 2 1 0 LSB 信号名 D7 D6 D5 D4 D3 D2 D1 D0 秋月電子FT232Rモジュールのピンアサイン D0 D4 D2 D1 D7 D5 D6 D3 TXD GND DTR# CB0 RTS# CB1 VIO VCC RXD RST RI# 3V3 GND CB3 DSR# PU1 DCD# PU2 CTS# VCC CB4 USB CB2 SLD (5V) (GND) ↓↓ USBコネクタ側 ドキュメント　（画像と下記リンクは 2011/09現在） サイト左メニュー Support→Documents→ [Data Sheets] FT232R USB UART IC Data Sheet http://www.ftdichip.com/Support/Documents/DataSheets/ICs/DS_FT232R.pdf [Application Notes] AN232R-01 Bit Bang Modes for the FT232R and FT245R 2.02 FT232R, FT245R http://www.ftdichip.com/Support/Documents/AppNotes/ AN_232R-01_Bit_Bang_Mode_Available_For_FT232R_and_Ft245R.pdf [Programming Guides] D2XX Programmer's Guide http://www.ftdichip.com/Support/Documents/ProgramGuides/D2XX_Programmer's_Guide(FT_000071).pdf

◆　◆　◆

COMポートがないPCでも、USB-シリアル変換モジュールを使えば シリアル通信による機器の制御が簡単にできるようになります。 さらにFT232R ビットバンモードを使えば、シリアル通信にとらわれず より様々な機器を制御できるようになります。 今回はそれらのソフト開発について解説し、サンプルコードを示しました。 次回は具体的な活用例として、ビットバンモードでLCDモジュールを制御します。