NFC タグ ID 検知を、nfcpy の tagtool.py の標準出力から読み取るときにはまったこと

nfcpy と tagtool.py について復習

前回の投稿で触れた、Python で実装された NFC リーダーにアクセスするオープンソースプロダクト「nfcpy」。

この nfcpy に実装例として収録されている tagtool.py を使えば、例えば Raspberry Pi 上で、これに接続した NFC タグリーダー SONY RC-S380 を介した、NFC タグの検知とそのタグ ID のコンソール上への表示は容易に実行できる。

前回投稿のとおり環境構築が済んでいれば、tagtool.py が収録されているフォルダまでカレントフォルダを移動した上で、

$ ./tagtool.py show

を実行すると(※ tagtool.py に実行可能属性が付与されている前提)

** waiting for a tag **

と表示されて NFC タグを検出するまでの待機状態になり、この状態で NFC タグリーダーに NFC タグをかざすと、NFC タグが検出されて

Type3Tag IDm=0123456789abcdef PMm=000...

のような1行が表示されて tagtool.py が終了し、コマンド入力待ちに戻る。

さらに tagtool.py の show コマンド実行にあたり「-l」オプションを付けると tagtool.py が終了することなく

NFC タグ検知 ⇒ 検知したタグのID情報を表示 ⇒ タグ検知待ちに戻る、

という "無限ループ" モードでの動作となる。

これに加えて「-q」オプションを付けると動作上の追加の情報表示が抑制され、タグ検知に特化した表示となる。

nfcpy を利用して NFC タグの検出にからめたプログラムを作るには

さて、このように nfcpy とそれに収録されている tagtool.py を使えば、
「NFC タグを検出したら、そのタグの ID に基づいて何かアクションを起こす」
というプログラムを作ることができる。

インフィニットループ社がリリースしている「シュキーン」でやってるような、「かざしてシュキーン」の仕組みのところを（あちらは Android を活用されているが)、Raspberry Pi を使っても真似できそうだ。

そのような、Raspberry Pi 上で動作するプログラム開発にあたって、nfcpy は Python で実装されていることもあり、また、2.x 系列とはいえ Raspberry Pi には Python がはじめからインストールされていることも踏まえると (※ Raspbian Jessie LITE 版には pip 入ってなかったけど) 、Python で実装するのが本来は手ごろだと思う。

ところが自分は、Python については疎い。

とくに、サンプルコードというレベルを超えて、

• 外部設定ファイルによる半固定パラメータの読み込み、
• 集約的例外ハンドラの配線、
• ファイルサイズ上限設定に基づく循環ロギング、
• マルチスレッドプログラミング、

といったことを Python でどう実現するのかまるっきりわかっていない。

どうしよう?

C# で書きます。

そこで、勝手知ったる C# で実装することにした。

本ブログで以前にも取り上げているとおり、mono をインストールしておくことで、C# で書いた .exe ファイルがそのまま Raspberry Pi でも動く。

実際、自分は Visual Studio 上で開発をしているのだが、その C# プロジェクトにて、ビルド成功時のカスタムバッチに scp コマンド呼び出しを組むことで、ビルドした .exe や依存関係の .dll などを aspberry Pi 実機に自動的に送り込むようにしてたりする。

つまり、Windows PC 上の Visual Studio にて、カタカタと C# コードを書いて、Ctrl + Shift + B したら、ビルドされた .exe はじめ一式が、もう Raspberry Pi 実機上にコピー済んでて、そのまま実行できる状態である。

C# コードから tagtool.py を呼び出して標準出力を読み取る

ちょっと話が脱線したが、つまり、C# で書いたコンソールアプリ中から、nfcpy の tagtool.py を -l オプション付きの show コマンド指定で呼び出し、その標準出力を読み取ることで、

• NFC タグの検出とその検出したタグの ID 情報の取得、
• そうして取得した ID 情報に基づいて何かアクションする、

という動作を繰り返すアプリを作れるわけだ。

C# コードにて、外部プロセスの呼び出しとその標準出力の読み取りは典型的なタスクで、ネットで検索すれば、実装例が多々見つかる。

今回の場合は、具体的なコードとしては下記のとおり。

var process = Process.Start(new ProcessStartInfo

{

  FileName = "python",

  Arguments = "tagtool.py -q -l show",

  RedirectStandardOutput = true

});

process.OutputDataReceived += (sender, e) =>

{

  // tagtool.py の標準出力が行単位で発生するごとに

  // ここが呼び出される。

  // すなわち、タグが検出されるたびにここが呼び出され、

  // e.Data に tagtool.py の標準出力 = "Type3Tag ID=..."

  // といったタグの ID 情報が格納されている。

}

process.BeginOutputReadLine();

process.WaitForExit();

ところが動かない!

さてこれで OK と思い、実際にためしてみると...

nfcpy やデバイス類は正しく機能しているはずなのに、まったく OutputDataReceived イベントが発生しない事態に遭遇。

難しいことしてるわけでもないのに何故!?

やろうとしていることがシンプル過ぎて、そんなバグがどうして起こるのか、どうにも思い浮かばない。

また、「-l」オプション抜きで一回検出するのみを試してみると、なんと、ちゃんと OutputDataReceived イベントが発生して、タグの ID 情報が取得できた。

「-l」オプションの有無だけで、標準出力の読み取りが成功・失敗するとはますます訳がわからない...


...と悩み続けて、ようやく閃いた。


バッファだ。

きっと、tagtool.py の標準出力への書き込みがバッファに溜まってて、フラッシュされるまで C# コード側に流れてこないのだろう。
「-l」オプション抜きで一回実行だと、そのまま tagtool.py は終了してバッファフラッシュされるのだろうから、先の動作も合点がいく。

気が付いてみたら、なんとうことはない原因だ。
すぐに気づかなかったのが悔やまれる。

tagtool.py にモンキーパッチ

ということで早速 tagtool.py をテキストエディタで開き、show コマンドを実装している箇所を探す。

どうやら「def show_tag(self, tag)」で定義されているメソッドがそれらしい。
(※ということを漠然と嗅ぎ当てられる程度には、自分、Python のソースも読みます)

そこで show_tag メソッドを定義しているコードブロックの最後に、標準出力のバッファをフラッシュする「sys.stdout.flush()」を追記。
(※Python で標準出力のフラッシュをどう実装するのかは、ネットで検索して調べた。)

こうして書き換えた tagtool.py を保存して、改めて先の C# プログラムを実行してみると、今度はうまくいった!

NFC タグリーダーにタグをかざすたびに、C# プログラムが、nfcpy によるタグ検出の結果を読み取って反応してくれる。

まとめと補足

思わぬところでうっかり躓いてしまったが、それでも十分手軽に、勝手知ったる C# でお気楽に、Raspberry Pi 上で NFC タグを検知してアクションするプログラムを作り上げることができたのであった。

なお、Raspberry Pi 上の C# 製プログラムにて NFC タグリーダーを扱うには、今回投稿のような nfcpy と標準入出力で連携する以外にも、nfcpy は使わずに libnfc.so への P/Invoke で実装することもできるらしい。

自分は試してないが、以下にその参照先を記しておく。

SharpNFC
https://github.com/episage/SharpNFC

NFCTest (上記 SharpNFC のコードを転用した作例)
https://github.com/LuckyOpenU/NFCTest

※でも、念のため付け加えておきますと、C# 製 .exe を Raspberry Pi の mono の上で実行すると、起動するまでは秒単位で時間がかかったりします (プログラムの規模や利用するライブラリなどに左右される。HelloWorld ごときではそんなにかからない)