AWS IoT TwinMakerで自分の部屋のデジタルツインを作ってみた

今回のハンズオンでは以下のデバイスを使用します。

• マイコン : M5StickC (購入先 : スイッチサイエンス)
• センサー：M5StickC PIR Hat (購入先 : スイッチサイエンス)

なお、本記事内では 1 センサーだと面白くないため、M5StickC と人感センサーは 2 セット用いています。もちろん 1 セットでも本内容を実施し、実現したいことを確認できます。複数セットを用いる方はその数分だけ手順を実施ください。

また、使用するサービスは以下のとおりです。

• AWS IoT Core : デバイスをクラウドに安全かつ簡単に接続し、センサデータをクラウドへアップロード、そしてAWS IoT SiteWise に転送するために用います。
• AWS IoT SiteWise : 今回はデータを収集・保存するために用います。その他にも産業機器を接続し、収集・集計・保存・可視化することも可能です。
• AWS IoT TwinMaker : 自分の部屋を仮想空間内で 3 次元的に可視化するために使います。デジタルツインを実現するサービスとして産業用途などで活用いただけます。
  
• Amazon Managed Service for Grafana : デジタルツインを表示するために用います。それだけでなく様々な種類のグラフでの可視化が可能です。
• AWS Single Sign-on : Amazon Managed Service for Grafana でのユーザー認証を担います。他にも多くのサービスやアプリとの連携が可能です。

本記事のハンズオンは、2022 年 2 月時点の以下の環境で行なっています。

• ブラウザ : Google Chrome
• リージョン : us-east-1
• AWS コンソールの表示言語 : English (US) 

まず、デバイス側の実装をしていきましょう。下記の手順で 2 セット分実施ください。

こちらの手順 の IoT ポリシーの作成 から 証明書とキーをダウンロード までを実施して、下記の名前で 2 つのモノを作成し、証明書と秘密鍵を PC にダウンロードしてください。この手順では東京リージョンでの作業となっていますが、AWS IoT TwinMaker が使用可能なリージョンで確実に作成ください。

1. モノの名前 : PIR1
   1. 証明書  : PIR1.pem.crt
   2. 秘密鍵 : PIR1.pem.key
2. モノの名前 : PIR2
   
   1. 証明書 : PIR2.pem.crt
   2. 秘密鍵 : PIR2.pem.key
      

UIFlow 公式の手順 の Driver Installation から API KEY pairing までを実施してください。

Firmware burning では、左のデバイス種類から STICKC を選択し、その画面で UIFLOW(StickC) を選択してください。

1. サンプルコード : PIR.m5f.zip をダウンロードします。
2. ダウンロードした圧縮ファイルを解凍して、右上の「フォルダを開く」ボタンから PIR.m5f をアップロードします。
3. 証明書と秘密鍵を M5StickC にアップロードします。
   1. keyFile と certFile の下にあるファイルの追加ボタンからファイルをそれぞれ追加します。
   2. これもデバイス毎に実施する必要があります。
      

右下の Run ボタンを押してサンプルコードをデバイスへ転送してください。
複数台分書き込む必要があります。

メッセージが正しく送信されるか確認します。AWS IoT のテスト画面 を開いて、以下のように設定、確認を行います。

ここからは、複数のサービスが利用する共通のロールを作成します。今回はお試しなので、複数サービス向け & 管理者権限を付与するロールを作成しています。本番では、各サービス毎に最小権限でロールを作成してください。

後述の「4-2. AWS IoT : ルールの作成」 で使用するロールについては こちら が、「4-5. AWS IoT TwinMaker : ワークスペースの作成」で使用するロールについては こちら、「4-11. Amazon Managed Grafana : ワークスペースの作成」使用するロールについては こちら が最小権限の参考になります。

AWS IoT Core のルールの作成を行なっていきます。

ルールの作成画面 を開き、以下のように設定していきます。

1. Name : Smart_3D_Home と入力します。
2. Rule query statement : SELECT * FROM 'room/#' と入力します。
3. Set one or more actions : Add action ボタンをクリックします。(Error action の箇所ではありませんので注意してください)
4. SiteWise アクションを選択し、Configure action ボタンをクリックします。
5. Configure action の画面で画像のように以下を設定します。
   1. By property alias を選択
   2. Property alias :  ${propertyAlias}
   3. Time in seconds : ${timestamp()/1000}
   4. Value : ${status}
   5. Data type : Boolean
   6. Role (Requires AWS IoT SiteWise access) : Smart_3D_Home
6. 上記以外は設定せず、Add action ボタンをクリックします。
7. Create rule ボタンをクリックします。
8. ルールの一覧に作成したルールができていて、Enable になっていることを確認してください。
   

次に、AWS IoT SiteWise でアセットモデルの作成を行います。モデルの作成画面 を開き、アセットモデルを以下のように作成します。

アセットモデルの作成が完了したら、アセットを作成します。

アセットの作成画面 を開いて、以下のようにアセットを作成していきます。アセットは PIR1 と PIR2 の 2 つを作成します。

AWS IoT TwinMaker でワークスペースを作成します。

ワークスペースの作成画面 を開き、以下のように設定します。

次にエンティティを作成していきます。作成したワークスペースのエンティティの画面 を開いて、以下のように設定します。

ここから、3D モデルを作成していきます。
本記事では既に GLB ファイルを用意しています。それをお使いいただいても良いですし、ご自身で用意いただいたものをお使いいただいても大丈夫です。

シーンを作成していきます。作成したワークスペースのシーンの作成画面 を開いて、Create scene ボタンをクリックします。

1. ID : Smart_3D_Home を入力して、Create scene ボタンをクリックします。
2. シーンが作成され、作成されたシーンの画面に遷移します。
3. 左上の Settings タブを選択します。
4. Environment Preset : Neutral を選択します。
5. 中央のシーンビュー左上の十字ボタンから Add 3D model をクリックします。
6. room.glbを選択し、Add ボタンをクリックします。
7. 左上の Hierarchy タブを選択します。
8. 左のサイドバー内の room を選択します。
9. 右の Inspector 内の Transform の Rotation の Y のみを -90 に設定します。
10. 左上の Rules タブを選択
11. 左のサイドバー内の Rule id に PIR と入力し、Add New Rule ボタンを押す。
12. 作成された PIR を展開します。
13. Add new statement ボタンをクリックして、以下のように設定します。
    1. Expression : status
    2. Target : Icon、Error
14. Add new statement ボタンをクリックして、以下のように設定します。
    1. Expression : !status
    2. Target : Icon、Info
15. 中央のシーンビュー左上の十字ボタンから Add tag を選択して画像のように設定します。
    1. Name : PIR1 または PIR2
    2. Default Icon : Info
    3. EntityId : PIR
    4. ComponentName : PIR1 または PIR2
    5. PropertyName : status
    6. Rule Id : PIR
16. 上記を繰り返し、2 つのタグを追加します。
17. タグの位置は好きな位置へ配置していただいた大丈夫です。

AWS SSO もしくは SAML での認証方法が提供されています。
今回はこの手順の説明は省略します。既にあるユーザーを使用するか、新規にユーザーを作成しておいてください。

Amazon Managed Grafana のワークスペースを作成していきます。
今回は、SSO での認証で進めていきます。

ワークスペースの作成画面 を開いて以下のように設定します。

作成したワークスペースの画面の Authentication タブでユーザーの追加や SAML の設定を実施してください。SSO の場合は AWS Managed Grafana ワークスペースの画面で以下の手順を進めていきます。

1. Assign users and groups ボタンをクリックします。
2. ユーザーを選択し、Assign users and groups をクリックします。
3. Assigned users の画面でユーザーを選択します。
4. Make admin ボタンをクリックします。
5. User Type が Admin に変更になったことを確認します。

Admin にすることで後述の AWS Managed Grafana でダッシュボードが作成できるようになります。

次にデータソースを追加します。ここではデータソースは AWS IoT TwinMaker となります。

Amazon Managed Grafana に既にインストール済みの AWS IoT TwinMaker プラグインを使用して、AWS IoT TwinMaker をデータソースとして以下の手順で設定します。

最後にダッシュボードの作成を行なっていきます。以下の手順で進めてください。

1. 左のサイドバー内の十字ボタン上で、Import を選択します。
2. Import 画面で、Upload JSON file ボタンをクリックします。
3. こちら から Grafana_Dashboard.json.zip ファイルをダウンロード後、解凍し、Grafana_Dashboard.json ファイルを選択し、Import ボタンをクリックします。
4. Smart 3D Home というダッシュボードの画面が開きます。
5. 上部にある Time Series History パネルの名前の右のプルダウンを開き、Edit ボタンをクリックします。
6. 編集画面下部の Entity、Component Name、Selected Properties を選択し直します。(2 種類あるので、PIR1 と PIR2 それぞれ選択し直します)
7. 画面右上の Apply ボタンをクリックします。
8. ダッシュボードの画面で、下部にある TwinMaker Scene Viewer パネルの名前の右のプルダウンを開き、Edit ボタンをクリックします。
9. 画面右側の Scene から Smart_3D_Home を選択し直します。
10. 編集画面下部の Entity、Component Name、Selected Properties を選択し直します。(2 種類あるので、PIR1 と PIR2 それぞれ選択し直します）
11. 画面右上の Apply ボタンをクリックします。
12. ダッシュボードの画面上の Save dashboard ボタンをクリックします。
13. Save ボタンをクリックします。
    

これで全て完成です。動画でダッシュボードの動きを見てみましょう。

現実世界と仮想世界がつながり、自身の部屋の状態を 3 次元的かつリアルタイムに同期し可視化することができました。これにより場所ごとの状態や状況の把握が可能となり、自宅環境の改善や見守り、防犯などに役に立つかもしれません。

また今回は非常にシンプルなセンサーを用いていますが、他にも温度や湿度、環境光センサーなどの情報を同期させることも可能です。M5StickC の場合であれば多くの種類のハットが販売されているため、今回のように簡単にセンサーを接続することができます。ぜひ本記事の構成をカスタムして、お好きなデータをぜひ同期させてみてください。