1  Device Shadow とは

1.1 なぜ「影」が必要か

クラウドからデバイスを操作するとき、いちばん素朴な方法は「デバイスに直接メッセージを送る」ことです。しかし家電の IoT デバイスには、次のような事情があります。

  • いつも接続しているとは限らない:Wi-Fi が切れる、電源が抜ける、再起動中
  • すぐに返事ができるとは限らない:赤外線の送信に時間がかかる、処理中
  • 今の状態を聞かれることがある:「エアコンは今何度?」にクラウドだけで答えたい

そこで AWS IoT Core は、デバイスごとに Shadow(影) という JSON をクラウドに置きます。 クラウド側のプログラムは、デバイスではなく Shadow とやり取りし、デバイスは接続しているときに Shadow と同期します。

sequenceDiagram
  participant C as クラウド(Lambda など)
  participant S as Shadow
  participant D as デバイス
  C->>S: desired: {power: true}
  S-->>D: delta: {power: true}
  Note over D: エアコンに赤外線を送信
  D->>S: reported: {power: true}
  Note over S: desired と reported が一致 → delta なし

1.2 Shadow の中身

Shadow は次のような JSON です(send.py get で表示される形)。

{
  "version": 12,
  "state": {
    "desired":  { "power": true,  "temp": 24 },
    "reported": { "power": false, "temp": 24, "mode": "cool" },
    "delta":    { "power": true }
  }
}

desired(望ましい状態)

クラウドが「こうしてほしい」と書く。Alexa の Lambda や、このハンズオンの send.py が更新する

reported(報告された状態)

デバイスが「今こうなっている」と書く。デバイスが処理を終えたら更新する

delta(食い違い)

desired のうち、reported と 違う フィールドだけ。AWS が自動で計算し、デバイスに配信する

version(版)

Shadow が更新されるたびに 1 ずつ増える番号。更新の回数を数えるメーター として、事故の発見に使える(第 5 章)

1.3 delta の規則(実験で確かめたもの)

delta がいつ・何を含んで配信されるかが、このハンズオンの中心です。AWS IoT Core で実験して確かめた規則を先にまとめます。

  1. 更新は「上書き」ではなく「マージ」。送ったフィールドだけが変わり、ほかはそのまま残る
  2. 値に null を送ると、そのフィールドは 削除 される。"desired": null で desired 全体が消える
  3. delta = desired のうち、reported と「値と型」が違うフィールド。reported に無いフィールドも delta に入る。"1700"(文字列)と 1700(数値)は別の値
  4. 受け付けた更新のたびに version は 1 増える(値が変わらなくても増える)
  5. 更新を受け付けた後、delta が空でなければ、delta 全体をデバイスに配信 する。これは desired の更新だけでなく、reported の更新でも、関係ないフィールドの更新でも 起こる
  6. デバイスが 切断中に配信された delta は届かない(MQTT の永続セッションを除く、第 6 章)。get すれば、そのときの delta を取り出せる

規則 5 は、ドキュメントを読んだだけでは見落としやすいところで、第 5 章の無限ループの原因になります。

1.4 Shadow のトピック

デバイスは MQTT で、次のトピックを使って Shadow とやり取りします(<thing> は Thing の名前)。

トピック 向き 使い方
$aws/things/<thing>/shadow/update デバイス → AWS reported(や desired)を更新する
$aws/things/<thing>/shadow/update/delta AWS → デバイス delta が配信される。デバイスが購読する
$aws/things/<thing>/shadow/update/accepted AWS → デバイス 更新を受け付けた
$aws/things/<thing>/shadow/update/rejected AWS → デバイス 更新を拒否した(形式エラー、version の衝突など)
$aws/things/<thing>/shadow/update/documents AWS → デバイス 更新前後の Shadow 全体
$aws/things/<thing>/shadow/get デバイス → AWS 今の Shadow を要求する(空のメッセージを送る)
$aws/things/<thing>/shadow/get/accepted AWS → デバイス 今の Shadow(delta を含む)。デバイスが購読する

クラウド側のプログラム(Lambda など)は MQTT ではなく、AWS SDK の UpdateThingShadow / GetThingShadow(HTTPS)を使うのが一般的です。どちらで更新しても、Shadow の動きは同じです。

1.5 シミュレータで触ってみる

ブラウザ上で Shadow と仮想デバイスを動かします。ボタンを押して、desired・reported・delta・version がどう変わるかを見てください。

ノート試してみよう
  1. 「照明ボタン」を押す:desired → delta → デバイスが送信 → reported、の順に進み、delta が消える。version は 2 増える
  2. 「エアコン ON 24℃」を押してから「温度だけ 27℃」を押す:2 回目の delta には temp と cmdId だけ が入り、power は入らない(規則 1・3)
  3. 「デバイスを切断」してから照明ボタンを押し、「デバイスを接続」する:切断中の delta は届かないが、接続直後の get で取りに行く(規則 6)
重要この章のまとめ
  • Shadow は、クラウドの desired とデバイスの reported をまとめた JSON。食い違いが delta
  • 更新は マージ、null は 削除、version は 更新のたびに増える
  • delta が残っていると、どんな更新の後でも delta 全体が配信される