10  設計のコツとよくある落とし穴

イベント駆動と状態遷移テーブルは、それだけで多くの問題を防いでくれますが、使い方を誤ると別の問題が出てきます。この章では、実際のプロジェクトでよく出会うポイントをまとめます。

10.1 1. ハンドラの中で待たない

ハンドラの中の delay()、フラッシュの消去、長い I²C 通信などは、その間 すべてのイベントの処理を止めます。

症状 原因の例
ボタンの反応が遅い、取りこぼす ハンドラの中で LED を delay() で点滅させている
測定データの間隔が乱れる 測定開始のハンドラで、外部フラッシュの広い領域を一度に消去している
dropped が増える 上記のためにキューがあふれた

対策:

  • 点滅などの見た目 は millis() から計算する(第 8 章)
  • 時間のかかる処理は分割 する。例えばフラッシュの消去は 1 ブロックずつ、タイマーイベントのたびに少しずつ進める(そのための状態を作る)
  • どうしても長い処理は 別のタスク に任せ、終わったら完了イベントを積んでもらう

10.2 2. 割り込み・コールバックでは積むだけ

場所 動くコンテキスト ここでやること
attachInterrupt のコールバック ISR 時刻を記録してイベントを積む
SoftwareTimer のコールバック タイマータスク イベントを積む
Bluefruit のコールバック BLE タスク 解釈してイベントを積む
ハンドラ loop タスク ここで処理する

ISR の中で Serial.print() を呼ぶとハングすることがあります。デバッグ出力は、ハンドラの中か、main.cpp の状態遷移ログのように 1 か所 で出します。

10.3 3. キューに入れるのは値、ポインタは入れない

// 危険: BLE のバッファへのポインタを積む
event_post_ptr(EVT_BLE_CMD, data);  // data は on_rx_write を抜けると無効になりうる

キューから取り出すときには、元のバッファは再利用・解放されているかもしれません。必要なバイトをペイロードにコピー します。ペイロードの最大長を超える引数はキューに入らないので、event_post() で長さを切り詰め、プロトコル側でも上限を決めておきます。

10.4 4. 初期化の順番

event_init()(キューの作成)は、イベントを積む可能性のあるモジュールより先に 呼びます。BLE の初期化やタイマーの開始の直後に、もうコールバックが呼ばれることがあるからです。

10.5 5. ヘッダ名の衝突

ble.h、timer.h、event.h のような一般的な名前は、フレームワークやライブラリのヘッダと衝突しがちです。build_flags の -I はライブラリのコンパイルにも効くので、ライブラリの中の #include "ble.h" が自作のヘッダを読む という、原因のわかりにくいエラーになります(第 1 章)。接頭辞 を付けましょう。

10.6 6. 状態ごとに同じコードをコピーしない

テーブルのセルごとにハンドラ関数を作ると、

State wait_on_get_latest(const Event &ev) { /* 30 行の送信処理 */ return STATE_WAIT; }
State meas_on_get_latest(const Event &ev) { /* 同じ 30 行 */       return STATE_MEAS; }

のような コピペ が生まれがちです。片方だけ直してバグになります。処理本体は共通関数(reply_latest())にして、ハンドラは「呼んで、次の状態を返す」だけにします。

送信データの組み立ても、val[6] = acc[0] >> 0; val[7] = acc[0] >> 8; … と 1 バイトずつ書くより、ループや小さなヘルパー関数(例: put_u16le(buf, offset, value))にすると読みやすく、間違いにくくなります。

10.7 7. 状態の数が増えてきたら

規模 方法
状態 2〜5、イベント 10〜20 このハンズオンの 2 次元テーブル で十分
状態が多く、ほとんどのセルが nullptr 状態ごとに switch (ev.id) を書く方式や、(状態, イベント, ハンドラ) の リスト にする方式
「接続中」の中に「測定中」があるなど、入れ子がある 階層型状態機械(親の状態が共通のイベントを処理する)
複数の独立した振る舞い(測定と通信と電源管理) 状態機械を複数 持つ、またはタスクを分ける

10.8 8. PC 上でテストする

app/ のコードは、ハードウェアに直接触らない(ハードウェアは drivers/ の関数を通す)ように書いてあります。そのため、drivers/ の関数を 偽物(スタブ) に差し替えれば、PC 上で状態遷移のテスト ができます。PlatformIO には pio test -e native で PC 上でユニットテストを動かす仕組みがあります。

// テストのイメージ
void test_long_press_stops_measurement() {
  Event ev = {};
  ev.id = EVT_BUTTON_LONG;
  TEST_ASSERT_EQUAL(STATE_WAIT, dispatch(STATE_MEAS, ev));
}
void test_long_press_is_ignored_while_waiting() {
  Event ev = {};
  ev.id = EVT_BUTTON_LONG;
  TEST_ASSERT_EQUAL(STATE_WAIT, dispatch(STATE_WAIT, ev));
}

状態遷移テーブルは「表」なので、表の各セルがテストケース になります。

10.9 9. メモリとスタック

  • loop() が動く loop タスクのスタックは、このコアでは 1024 ワード(4 KB)。ハンドラの中で大きな配列をローカル変数に取ると、スタックがあふれて、原因のわかりにくいクラッシュになる
  • 大きなバッファは static にするか、グローバルに置く
  • キューのメモリは sizeof(Event) × 長さ。ペイロードを 64 バイト、長さを 100 にすると、それだけで約 7 KB になる

10.10 まとめ:チェックリスト