これは、SORACOM Advent Calendar 2021 の 8 日目の記事です。
作った物
こんなものを、3 つのパターンで作ってみた記事です。
本当は LINE の連携部分から解説したかったのですが、かなり分量が多くなってしまって、AWS Lambda (以後、Lambda) から Raspberry Pi を操作するところに限定した記事にしてみました。LINE 部分はまた追ってブログにしたいと思います。
構成
以下のような 3 つの構成で、どのように Lambda から Raspberry Pi を操作するか紹介しようと思います。
参考: 双方向通信の 3 パターン
デバイスを遠隔操作するための構成について、実は SORACOM 公式では「双方向通信の 3 パターン」として以下のようにまとめられています。
- IP アクセスパターン
- アプリケーションパターン
- デバイスリードパターン
公式の資料は こちらのページ からダウンロードできますし、同じ内容を SORACOM のイベントで紹介したときの 資料 や 動画 も公開されています。
この記事では、上記の「双方向通信の 3 パターン」を、「Lambda から Raspberry Pi の LED を遠隔操作する」というシナリオに落とし込んで試してみようと思います。この記事では「双方向の 3 パターンとは何か」の細かい解説はしませんが、実際に手を動かして実装していくことでどのようなものか感じてもらったり使いたいものを選ぶ参考にしてもらえればと思います。
準備するもの
以下を使いました。セットアップ方法について細かく解説しないものもあります。
- AWS アカウント
- SORACOM アカウント
- Raspberry Pi (3B や 4)
- 電子工作グッズ
- ブレッドボード
- 330Ω 抵抗
- LED
- ジャンパーワイヤー オス - オス 1 本
- ジャンパーワイヤー オス - メス 2 本
電子工作グッズについては単品で買えば 1000 円もしません。Amazon などでキットも探したのですが、ドンピシャ なのが在庫切れでした。少し値段が張りますが、ラズパイ４対応 Ｒａｓｐｂｅｒｒｙ Ｐｉで学ぶ電子工作 パーツセット などが良いのではないかと思います。LED やモーターなどを動かすのは楽しいですし、ふと何か作りたくなった時に持っておくと便利です。
費用
今回は少しの利用だったため AWS や SORACOM はすべて無料枠で収まったはずです。そのためかかった費用は Raspberry Pi と電子工作グッズだけでした。ちなみに、今回は初期費用も掛からないことから SIM なしで SORACOM サービスを使える SORACOM Arc を使いましたが、SIM と USB ドングルを使う場合はその分の費用も掛かります。
それでは、各パターンでの「共通手順」および各パターン別の構築手順を紹介していきます。
(共通手順) Raspberry Pi から LED を操作する
この記事では Raspberry Pi のセットアップ方法は解説しません。以下のドキュメントなどを参考にすると良いかと思います。以下のドキュメントを参考にする場合は「Raspberry Pi へのログイン」までで大丈夫です。
Raspberry Pi と LED の接続
はじめて、または久しぶりにフレットボードや LED を触る人は、まず以下の図のように配線して、プログラムを書くことなく LED が点灯することを確認してみると良いでしょう。LED の向きに注意してください。足の長い方が図中の右です。黒い線が GND、赤い線が 3.3V につながっているために、Raspberry Pi の電源が付いていれば、電気が流れて LED が点灯します。
LED が点灯することを確認したら、次は以下のように接続します。この接続では、Raspberry Pi 側から指示があった時 (赤い線につながった GPIO 18 がオンとなったとき) に LED が点灯します。
Raspberry Pi から LED の操作
Raspberry Pi 上で、以下のファイルを用意します。
from gpiozero import LED
from time import sleep
led = LED(18)
led.on()
print(led.value)
sleep(5)
led.off()
print(led.value)
ファイルを置いたディレクトリ上で、以下のコマンドを実行すると、3 秒ごとに LED のオン・オフを確認でき、コンソール上で LED のオン・オフを表示できるはずです。
python3 led.py
このように、各パターンにおいて、LED は以下のような方法で操作します。
- LED 状態の取得:
led_state = led.value - 点灯:
led.on() - 消灯:
led.off()
(共通手順) Lambda が利用する SAM ユーザーの認証情報を発行する
今回は Lambda から SORACOM API を呼び出してメタデータの読み書きをしたり、リモートアクセスのための一時的な IP アドレス・ポート番号を作成したりします。Lambda から SORACOM API を呼び出すため、SAM ユーザーおよび認証情報の作成をします。
Getting Started: SAM ユーザーを作成する | アクセス管理 (SORACOM Access Management: SAM) | SORACOM Users にしたがって SAM ユーザーを作成します。「認証キーの生成」で生成した認証キーと認証シークレットは次の手順で使うので保持しておいてください。
SAM ユーザーの権限設定 では、以下の権限を設定します。statements の配列中の 1 つ目の要素が IP アクセスパターンで利用する権限、2 つ目の要素がデバイスリードパターンで利用する権限です。
{
"statements": [
{
"api": [
"PortMapping:createPortMapping",
"PortMapping:deletePortMapping"
],
"effect": "allow"
},
{
"api": [
"Subscriber:putSubscriberTags",
"Subscriber:getSubscriber"
],
"effect": "allow"
}
]
}
(共通手順) Raspberry Pi を SORACOM に接続する
SORACOM のサービスを使うことで、遠隔操作がより簡単になります。SORACOM のサービスを使うために、Raspberry Pi を SORACOM へ接続しましょう。
今回は、SIM なしで SORACOM サービスを使える SORACOM Arc を用いました。以下の手順に則ってセットアップできます。
SORACOM の IoT SIM を使う場合は SORACMO Onyx LTE USB ドングルなどを使って、以下のドキュメントの手順でセットアップできます。
以下のように SORACOM 上の PING 疎通確認用エンドポイントへ PING を送信して、SORACOM へ接続できていることを確認しましょう。 各手順において、SORACOM へ接続できている必要があるので注意してください。
ping pong.soracom.io
(共通手順) Serverless の環境セットアップ
今回 Lambda は Serverless Framework を使ってデプロイします。デプロイをするための PC に Serverless を実行できるようにしてください。Serverless Framework のインストール方法などは 公式からの日本語ブログ もありましたので、こちらを参考に「インストール」と「サービスの作成」までできていれば、次の手順で紹介するサンプルプログラムをデプロイできます。
(共通手順) サンプルプログラムのダウンロード
サンプルプログラムは以下の GitHub リポジトリにあります。raspberry_pi 配下には Raspberry Pi にて実行するプログラム、Lambda 配下には Lambda にて実行するプログラムがあります。Serverless Framework をインストールした PC にてリポジトリのクローン、または zip ファイルのダウンロードと解凍をしてください。
それでは、それぞれのパターンを使って LED の遠隔操作をしてみましょう！
IP アクセスパターンの構築手順
IP アクセスパターンでは、Raspberry Pi 上で Flask を使って Web サーバーを建てます。HTTP GET リクエストが来たら LED の状態を返し、PUT リクエストが来たら Body に応じて LED をオンオフするというシンプルな構成です。Flask は Raspberry Pi 上で pip3 install flask を実行してインストールします。
Raspberry Pi 上の Web サーバーには、SORACOM Napter でアクセスします。SORACOM Napter は、SORACOM の SIM へインターネット越しにアクセスするため、一時的なグローバル IP アドレス・ポート番号をアクセス元を制限して払い出すオンデマンドでセキュアなリモートアクセスサービスです。一時的なアクセス情報は SORACOM API を呼び出して取得します。図にすると以下のとおりです。
Raspberry Pi の準備
Flask は Raspberry Pi 上で pip3 install flask を実行してインストールします。その後、以下のコマンドでサンプルプログラムを Raspberry Pi にダウンロードして、python3 ip_access.py で実行します。Flask が立ち上がり、IP アクセスを待ち受けます。
wget https://raw.githubusercontent.com/nmikuni/lambda-soracom-raspi-led/main/raspberry_pi/ip_access.py
AWS の準備
- ダウンロードしたサンプルコードの
lambda/ip_access_patternディレクトリ配下に移動します。 -
cp sample.env .envで ENV ファイルをコピーします。 -
.envに、これまでの手順で控えておいた認証情報や IMSI を記載します。 -
sls deployコマンドでデプロイします。
Raspberry Pi と AWS の準備ができたら、Lambda から LED を操作しましょう。以下のようなテストイベントを実行します (今後の全パターンで共通です)。
LED をつける
{
"message": "電気つけて"
}
LED を消す
{
"message": "電気消して"
}
LED の状態を確認する
{
"message": "電気ついてる？"
}
Raspberry Pi 側のコンソールログを見ても、アクセスが来ていることがわかるかと思います。
アプリケーションパターンの構築手順
アプリケーションパターンでは Raspberry Pi 上で paho-mqtt を使って MQTT クライアントとしてふるまいます。MQTT ブローカーには AWS IoT を用いて、LED オン・オフの指示を受けたり、自身の LED の状態を報告したりします。また、AWS IoT Shadow を利用することで、LED がとるべき状態 (desired)・現時点での LED の状態 (reported)・および desired と reported の差分 (delta) を管理します。SORACOM Beam を用いることで、AWS IoT の認証情報を Raspberry Pi に持たせることなく AWS IoT と接続できます。図にすると以下のとおりです。
AWS IoT と SORACOM Beam の準備
Raspberry Pi から SORACOM Beam 経由で AWS IoT Core へ接続します。以下のドキュメントを参照してください。
なおこの時、モノの名前は raspberry-pi、Device Shadow には名前付きシャドウ led を作成してください (別の名前を使った場合は、サンプルコードの修正が必要になります)。
また、SORACOM Beam の「ホスト名」に登録した AWS IoT Core の xxxxx-ats.iot.ap-northeast-1.amazonaws.com といったカスタムエンドポイントは後続の手順で使用するので控えておいてください。
Raspberry Pi から mosquitto_pub -d -h beam.soracom.io -t beamdemo -m "Hello, World" で AWS IoT へメッセージを送信できれば成功です。なお mosquitto_pub は sudo apt install mosquitto-clients でインストールできます。
AWS IoT Shadow の準備
AWS IoT Core のメニューよりサイドバーの「モノ」=> 「Device Shadow」タブ => 「led」(シャドウ名) を選択します。
「編集」をクリックして、以下のように Shadow の初期状態を更新します。
{
"state": {
"desired": {
"led": "0"
},
"reported": {
"led": "0"
}
}
}
Raspberry Pi の準備
paho-mqtt は Raspberry Pi 上で pip3 install paho-mqtt を実行してインストールします。以下のコマンドでサンプルプログラムを Raspberry Pi にダウンロードして、python3 application.py で実行します。成功すれば一定間隔で LED の状態を SORACOM Beam 経由で AWS IoT へ Publish します。
wget https://raw.githubusercontent.com/nmikuni/lambda-soracom-raspi-led/main/raspberry_pi/application.py
AWS の準備
- ダウンロードしたサンプルコードの
lambda/application_patternディレクトリ配下に移動します。 -
cp sample.env .envで ENV ファイルをコピーします。 -
.envに、これまでの手順で控えておいた認証情報や AWS IoT Core のカスタムエンドポイントを記載します。 -
sls deployコマンドでデプロイします。
Raspberry Pi と AWS の準備ができたら、Lambda から LED を操作しましょう。Raspberry Pi 側のコンソールログを見ても、MQTT の メッセージが来ていることがわかるかと思います。
なお、今回は SORACOM Beam + MQTT を使いましたが、他にも SORACOM Inventory (LwM2M) や SORACOM Krypton (認証情報を SORACOM から取ってきて用いる) を使った実装も考えられます。
デバイスリードパターンの構築手順
デバイスリードパターンでは Raspberry Pi の LED 状態を SIM のタグに保管します。Raspberry Pi は一定間隔でメタデータサービスを利用してタグの取得・更新をします。また Lambda から LED 情報の取得・更新をしたいときも SORACOM API を利用してSIM のタグへアクセスします。図にすると以下のとおりです。
SORACOM の準備
以下のドキュメントを参照してメタデータサービスを有効にします。書き込みもするため、「読み取り専用」のチェックは外して下さい。
Raspberry Pi の準備
以下のコマンドでサンプルプログラムを Raspberry Pi にダウンロードして、python3 device_lead.py で実行します。成功すれば一定間隔でタグに指定された LED の状態を取得して自身の LED へ反映し、自身の LED 状態をタグへ書き込みます。
wget https://raw.githubusercontent.com/nmikuni/lambda-soracom-raspi-led/main/raspberry_pi/device_lead.py
AWS の準備
- ダウンロードしたサンプルコードの
lambda/device_lead_patternディレクトリ配下に移動します。 -
cp sample.env .envで ENV ファイルをコピーします。 -
.envに、これまでの手順で控えておいた認証情報や IMSI を記載します。 -
sls deployコマンドでデプロイします。
Raspberry Pi と AWS の準備ができたら、Lambda から LED を操作しましょう。ほかのパターンと違って面白いのは、Raspberry Pi 側のコンソールログを見ると、Lambda から指示されたタイミングとは関係なく、自分のペースでタグの確認・LED の更新をしている点です。
なお、今回はタグを用いましたが、メタデータサービスのユーザーデータや、クラウド上の DB を使うことも考えられます。
おわりに
ここまでお付き合いくださりありがとうございました。Lambda で IoT デバイスを操作するときのヒントになれば幸いです。かなり長文になったにもかかわらずまとめ切れていないところや説明が十分でないところもありますので、疑問点などあればコメントや Twitter でご連絡ください。プログラムの解説や、LINE からの操作についてはまたどこかでブログに起こしたいです。