9  設計チェックリストと確認問題

9.1 Shadow 同期の設計チェックリスト

Shadow(や、desired と reported の差分を配信する同種のしくみ)を使うときに確かめることです。

# 確かめること 章
1 ポリシーは その Thing の Shadow のトピックだけ に絞ったか。秘密鍵をコミットしていないか 2
2 命令を コマンド型(毎回実行)と 状態型(その状態にする)に分けたか 4
3 コマンド型は 値そのものに毎回変わる要素 を入れたか("5-時刻") 4
4 状態型は、同じ状態の送り直しのために 毎回変わる cmdId を足したか 4
5 処理した値を 同じ値・同じ型で reported に書き戻しているか。null で消していないか 5
6 複数のフィールドの書き戻しを 1 回の publish にまとめたか 5
7 デバイスが 実現できない desired(範囲外の温度など)が残り続けないか 5
8 delta の 届かなかったフィールドを、既定値で埋めていない か(今の状態に上書き) 6
9 接続直後に get して、切断中の delta を拾っているか 6
10 同じ delta が 2 回届いても 1 回しか実行しない(冪等)か 6
11 本番機の前に、1 回だけ送って version を監視 したか。緊急停止(desired を null)の手順を用意したか 5

9.2 確認問題

ノート問 1

desired が {"power": true}、reported が {"power": true} のとき、クラウドがもう一度 desired に {"power": true} を書きました。version と delta はどうなりますか?

version は 1 増えますが、delta は出ません(デバイスには何も届かない)。値が同じフィールドは delta に入らないためです(第 4 章)。送り直したいときは、毎回変わる cmdId を一緒に送ります。

ノート問 2

desired に {"sendSlot": "5-100"} が残ったまま、デバイスが 温度センサの値 を reported に 1 分ごとに書いています。何が起きますか?

温度センサの値を書くたびに、{"sendSlot": "5-100"} の delta が再配信されます。関係ないフィールドの更新でも、食い違いが残っていれば delta 全体が配信されるからです(第 5 章、実測)。 デバイスが重複チェックをしていなければ、1 分ごとに照明が切り替わります。sendSlot を正しく書き戻して食い違いを消すこと、重複チェックを入れることが対策です。

ノート問 3

デバイスが reported に {"cmdId": 1791382616543} と書き戻しました。desired の cmdId は "1791382616543" です。何が起きますか?

数値と文字列は別の値なので食い違いが残り、書き戻しのたびに delta が再配信される 無限ループ になります(実測で 0.4 秒に 8 回)。desired と同じ型(文字列)で書き戻します(第 5 章)。

ノート問 4

エアコンが「ON・冷房・24℃」のとき、delta {"temp": 26} が届きました。デバイスは何を送信すべきですか?

「ON・冷房・26℃」です。delta には変わったフィールドしか入らないので、今の状態に temp だけを上書きします。power を既定値(false)で埋めると、電源が切れてしまいます(第 6 章)。

ノート問 5

変更したファームウェアを書き込んだら、照明が点いたり消えたりし続けています。最初にすることは何ですか?

desired を null にする({"state": {"desired": null}}、このハンズオンでは send.py stop)。delta がなくなり、デバイスのコードに関係なくクラウド側から止められます。 電源を抜いて再起動しても、desired が残っていれば、接続直後の get で同じ delta を受け取ってしまいます(第 5 章)。

ノート問 6

デバイスが Wi-Fi の切断から復帰しました。切断中に Alexa で「エアコンつけて」と言われていた場合、何をすればその命令を実行できますか?

接続直後に get を送り、応答の state.delta を処理します。clean session の MQTT 接続では、切断中に配信された delta は届きません。永続セッション(QoS 1)なら一定時間は保持されますが、get は設定に関係なく確実です(第 6 章)。

9.3 片付け

ハンズオンで作った AWS のリソースを削除します(第 2 章)。

python device/send.py stop       # 念のため desired を消す
bash setup/cleanup.sh            # Shadow・証明書・ポリシー・Thing を削除

9.4 おわりに

Device Shadow のしくみ自体はシンプルですが、「delta は、食い違いが残っている限り、どんな更新の後にも配信される」というひとつの規則から、届かない・止まらない・2 回動く、といった事故が生まれます。

  • 命令を コマンド型と状態型 に分け、毎回変わる値を混ぜる
  • 同じ値・同じ型・1 回の publish で書き戻して、食い違いを残さない
  • 届かないこと(取りこぼし)と、2 回届くこと(重複)の 両方 に備える
  • 本番機の前に 1 回だけ送って version を見る。止めるときは desired を null に

自分のデバイスでも、このチェックリストで確かめてから、家族に「アレクサ、照明つけて」と頼んでみてください。