SORACOM IoT レシピ：IoTで在席状況の自動更新

GPS マルチユニット SORACOM Edition の加速度センサーを使った「在席状況の自動更新システム」

公開日: 2020年6月

レシピ難易度：★★★☆☆

IoTシステム構築には様々なセンサー活用がポイントになりますが、その中でも加速度センサーの活用は応用力の幅が広くアイディアによって様々な活用シーンの広がりがあります。

このレシピでは、加速度センサーのデータを取得して活用するIoTシステムのサンプルとして、「在席状況の自動更新システム」を作ります。利用するデバイスは、「位置情報（GPS）」「温度」「湿度」「加速度」の4つのセンサーと充電式バッテリーを内蔵し、LTE-M通信による低消費電力で安定したセルラー通信ができる IoTデバイス「GPS マルチユニット SORACOM Edition」を活用します。

IoTシステムの技術要素として、セルラーLPWAであるLTE-M通信の活用、SORACOM IoT SIM による通信管理、IoTに特化したデータ蓄積サービス SORACOM Harvest 、クラウドファンクションアダプタ SORACOM Funk を使ったSlack への通知連携設定が（AWS Lambdaの機能を利用）体験できます。

システムの構成

今回作成するシステムは以下のような構成となっています。

使用する SORACOM サービス

• データ通信サービス SORACOM Air
• クラウドファンクションサービス SORACOM Funk

本レシピを紹介した動画もご覧ください。

本レシピを行うのに必要な時間、概算費用

本レシピは以下の通りです。

• 必要な時間: 約90分
• 概算費用: 約12,500円

※ 概算費用: ハードウェアや SORACOM を始めとした各種サービスの概ねの費用 (送料などの付帯費用や無料枠適用は考慮しないものとしています)

このコンテンツの進め方

上から内容を読み進みながら作業を行なっていきます。また左サイドに追従する目次からページ内の移動が可能です。

準備

本レシピを行うためには以下のものをご用意ください。

ハードウェア

※ 金額はレシピ作成時となります。金額は税込み・送料別です。

ご購入について

ハードウェアは以下よりご購入いただけます。

• GPSマルチユニットSORACOM Edition（バッテリー内蔵タイプ）スターターキット

その他必要なもの

※ アカウント作成・維持の費用の料金です。

Slack および AWS の手順について
当レシピでは Slack アプリを作成し、AWS Lambda、AWS IAM の設定をします。これらの利用経験があるとスムーズです。なお、わかりやすさのため当社で検証した内容をスクリーンショット付きで掲載しておりますが、公式な手順は各社のドキュメントをご確認ください。

すでに AWS アカウントを持っている場合の確認事項

• ルートアカウントを利用する場合：特に確認すべき事項はありません。先に進んでください。
• IAM アカウントを利用する場合：AWS Lambda の関数作成および実行権限の有無を確認してください。また、必要権限の解説およびサポートは致しかねますが、AdministratorAccess ポリシーが割り当てられていれば当レシピは完遂可能です (同ポリシーを割り当てたことによる影響については IAM アカウント管理者にご相談ください)

すでに Slack アカウントを持っている場合の確認事項

• 職場の Slack ワークスペースなどを利用する場合、アプリのインストールが制限されている可能性があります。インストールできない場合は、個人用のワークスペースを作成してお試しいただくか、管理者の方に相談してください。

GPS マルチユニットが届いたら

GPS マルチユニットは SIM を挿入することでセルラー通信 (LTE-M) を通じて、クラウドと連携できるようになります。そのため、まず GPS マルチユニットに同梱されている SIM を SORACOM へ登録をしましょう。
※ すでに登録済み、もしくは登録済みの別の SIM を利用する場合は次へお進みください。

登録の方法は発注済みの SIM を登録する(JP)をご覧ください。約5分で完了します。

登録が完了すると SIM 管理の一覧に表示されますので、確認ください。

SIM を GPS マルチユニットに取り付ける

SORACOM 特定地域向け IoT SIM (以下 SIM) をカードから切り離し、GPS マルチユニットの側面に挿入します。

GPS マルチユニットの側面を開け、SIM トレイ (赤色) を取り出す。

爪で引っ掛けるようにして取り出します。

SIM を SIM トレイに乗せる。

SIM トレイに収まるように SIM を乗せます。SIM の方向に気をつけてください。また、SIM トレイは無くさないようにしてください。

SIM トレイごと GPS マルチユニットに挿入する。

元々入ってた向きで SIM トレイごと SIM を GPS マルチユニットに挿入します。このとき、SIM トレイから SIM が飛び出ないように気をつけてください。

最後に側面を閉じて終了です。

GPS マルチユニットに挿入した SIM の IMSI (クレジットカードサイズのカードの裏面に記載されている15桁の番号) を使用しますので、すぐ取り出せるようにしておいてください。

ここでの作業は動画 (約1分) でもご覧いただけます。

GPS マルチユニットの設定を行う

GPS マルチユニットの設定は SORACOM ユーザコンソール上で行います。

SORACOM ユーザーコンソールにログインした後［Menu］>［ガジェット管理］>［GPS マルチユニット］とクリックします。

GPS マルチユニット管理画面が表示されます。ここには、GPS マルチユニットとして利用している SIM 一覧が表示されます。初めて利用する場合は「データが見つかりません」と表示されますが、正常です。

［新規デバイス設定］をクリックします。

GPS マルチユニットに挿入した SIM にチェックをつけてから［次へ：グループを選択］をクリックします。

複数 SIM を持っている場合は IMSI で見つけ出すようにしてください。
※図では「名前」を登録してあるため、見つけやすくなっています。

“新規グループを作成” をクリックし、グループ名入力してから［次へ：設定を編集］をクリックします。

グループ名は任意です。日本語も利用可能です。ここでは「GPSマルチユニット」としています。

GPS マルチユニットの設定を行います。

送信内容

「加速度」にチェックがついているようにします。(その他のチェックは外します)

送信先

「SORACOM Harvest (Lagoon)」 にチェックをつけます。

送信モード

「定期送信 ― 手動モード」にチェックをつけます。

定期送信 ― 手動モード 詳細設定

以下の通り設定します。

ここまで入力が完了したら、最後に［保存］をクリックします。

すると以下のダイアログが表示されるので［デバイス一覧に戻る］をクリックします。

GPS マルチユニット管理画面に戻りますが、先ほど設定した SIM が一覧に表示されていることが確認できます。

設定を GPS マルチユニット本体に反映させる。

GPS マルチユニットのファンクションボタン（本体表面の四角のボタン）を1秒ほど押します。すると LED が緑色に点灯します。

GPS マルチユニット本体から SORACOM に保存されている設定情報を取得して設定が反映されます。また、設定が反映された GPS マルチユニットは新たな設定で動き続けるようになります。

以上で GPS マルチユニットの設定は終了となります。

SORACOM Harvest Data で設定の確認を行う

SORACOM Harvest Data を利用して、設定が正しく反映されているか確認します。

GPS マルチユニット管理画面で、先ほど設定した SIM にチェックを付けて［データを確認］をクリックします。

SIM 管理画面からチェックをつけて［操作］>［データを確認］でも同様のことができます。

以下のようにグラフが確認できます。SORACOM Harvest Data の操作として、画面左側のグラフ種類を選んだり、画面中央の「自動更新」で自動的に新たなデータを表示できたり、画面右側の表示する値を選択できたりします。

「bat(電池残量)」「rs電波強度)」「x (短辺方向の加速度)」「y (長辺方向の加速度)」「z (高さ方向の加速度)」「type(送信モード)」の 6つの値が1分間隔で送信されていれば、設定成功です。デバイスをひっくり返してみて、z の値が変わることを確認してみてください。

静止しているのに加速度加速度 x, y, z の値がある理由
SORACOM カラーのシールを上向きにマルチユニットを置くと、z が約 -1000 となります。これは重力加速度によって下方向に -1000mG (ミリ G。G は加速度の単位) の加速度が生じているためです。今回のレシピではこれを利用し、デバイスの置き方によって x, y, z の値を変化させ、それに応じて Slack のステータスを変更します。

rs, bat, type について
これらの値は必ず送信されてくるようになっています。値の意味についてはGPS マルチユニット SORACOM Edition 機能の説明をご覧ください。

Slack アプリを作成し、アクセストークンを発行する

アプリの作成

Slack の「App」メニューを開き、右上のをクリックします。すると、ブラウザーが立ち上がります。

右上の [ビルド] をクリックします。

「ワークスペース」に注意！
複数の Slack チームに所属している場合は［ビルド］をクリックする前に、その右にあるワークスペース名を確認するようにしてください。

[Start Building] をクリックします。

アプリケーション作成画面にて App Name と Development Slack Workspace を設定し [Create App] を選択します。

ステータスを更新する権限を付与する

OAuth & Permissions タブへ移動します。

Scopes > User Token Scopes > [Add an OAuth Scope] をクリックしてドロップダウンメニューから users.profile:write 権限を選択します。なおこの権限はステータスだけでなく自身の氏名や電話番号といった情報も変更できてしまうので、次にコピーするトークンの取り扱いには十分注意してください。以下の画像のようになっていれば権限を付与できています。

トークンをコピーする

OAuth Tokens & Redirect URLs タブの上部より [Install App to Workspace] をクリックします。

権限がリクエストされたら [許可する] クリックしてください。

OAuth Access Token が発行されるので [Copy] をクリックして控えます。

トークンの取り扱いに注意！
users.profile:write 権限が付与されているこのトークンは、ステータスだけでなく自身の氏名や電話番号といった情報も変更できてしまうので取り扱いには注意しましょう。もし不審な動作を確認したら、即座に［Revoke All OAuth Tokens］をして、権限を解除するようにしてください。

Slack のステータスを変更する AWS Lambda を設定する

AWS Lambda 関数を作成する

AWS マネジメントコンソールのサービス一覧より Lambda を選択し、[関数の作成] をクリックします。

関数名やランタイムを指定して [関数の作成] をクリックします。

環境変数に Slack のトークンを設定する

環境変数 > [環境変数を管理] をクリックします

[環境変数の追加] をクリックして各キーと値を設定します。その後、[保存] をクリックします。

以下のようにキー・値が見られれば環境変数の設定は完了です。(以下の画像では一部値をマスクしています)

関数のコードを設定する

関数コードにて、以下の内容で上書きします。上書きしたら [保存] をクリックして Lambda の設定は完了です。

const https = require('https');
const url = require('url');
const slackToken = process.env.SLACK_TOKEN;
const slackUrl = "https://slack.com/api/users.profile.set";

exports.handler = function(e, ctx, cb) {
    console.log('event: %j', e);
    console.log('context: %j', ctx);

    var slackReqOptions = url.parse(slackUrl);
    slackReqOptions.method = 'POST';
    
    var payload = 
      e.type == 1 ? { "profile":{"status_text": "", "status_emoji": ""}}
    : e.z > 900 ? { "profile":{"status_text": "lunch break", "status_emoji": ":rice:"}}
    : e.x > 900 ? { "profile":{"status_text": "coffee break", "status_emoji": ":coffee:"}}
    : e.x < -900 ? { "profile":{"status_text": "concentrating", "status_emoji": ":male-technologist:"}}
    : { "profile":""}
    ;
    
    var body = JSON.stringify(payload);
    console.log("body: %j", body);
    var auth = "Bearer " + slackToken; 
    slackReqOptions.headers = { 
        "Authorization": auth,
        'Content-Type': 'application/json; charset=utf-8',
        'Content-Length': Buffer.byteLength(body),
        };
    var req = https.request(slackReqOptions, function(res) {
        if (res.statusCode === 200) {
            console.log('Posted to slack');
            console.log('res: %s',res);
            cb(null, {"result":"ok"});
        } else {
            cb(false, {"result":"ng", "reason":'Failed to post slack ' + res.statusCode});
        }
        return res;
    });
    req.write(body);
    req.end();
};

作成した AWS Lambda のテスト

マルチユニットからの実データを送信する前に、AWS Lambda 単体でテストしてみましょう。[テストイベントの選択] > [テストイベントの設定] をクリックします。

イベント名を任意に指定し、以下のテストイベントを入力し [作成] をクリックします。

{
  "bat": 3,
  "rs": 4,
  "x": 0,
  "y": 64,
  "z": 960,
  "type": 0
}

作成したテスト名が選択されていることを確認して、[テスト] をクリックしてください。

Slack のステータス表示が変更されていたら、テスト成功です。

(参考) コードの解説

コードの以下の部分で、置き方に応じてステータスを変更しています。

    var payload = 
      e.type == 1 ? { "profile":{"status_text": "", "status_emoji": ""}}
    : e.z > 900 ? { "profile":{"status_text": "lunch break", "status_emoji": ":rice:"}}
    : e.x > 900 ? { "profile":{"status_text": "coffee break", "status_emoji": ":coffee:"}}
    : e.x < -900 ? { "profile":{"status_text": "concentrating", "status_emoji": ":male-technologist:"}}
    : { "profile":""}
    ;

それぞれ、以下のような条件を表しています。status_textやstatus_emojiを自分の好きなものに変えてみてください。Slackの絵文字コードはこちらのリファレンスを参考にしてください。

AWS Lambda の ARN をコピーする

SORACOM Funk から AWS Lambda へ連携できるよう、ARN (Amazon Resource Name) をコピーし、控えておきます。

AWS IAM ユーザーを作成し、認証情報を取得する

SORACOM Funk から AWS Lambda を呼び出すためには、IAM ユーザーの認証情報が必要となります。ここでは IAM ユーザーを作成し、認証情報を取得します。

IAM ポリシーを作成する

IAM ユーザーには AWS 上のリソースに対する権限である IAM ポリシーを付与します。セキュリティリスクを極小化するために、先ほど作成した Lambda を実行する権限だけを持つ IAM ポリシーを作成します。

AWS コンソールより Identity andAccess Management (IAM) メニューを開き、[ポリシー] をクリックします。

[ポリシーの作成] をクリックします。

新しくポリシーの作成画面が表示されるので、それぞれ設定していきます。まず、「サービスの選択」では今回連携したい Lambda を選択します。 次の「アクション」では、検索ウィンドウに InvokeFunction と入力してそれを選択します。 3つ目の「リソース」では、[ARN の追加] をクリックして ARN の指定で先ほどコピーした ARN を貼り付けます。

以上の設定が終わったら、[ポリシーの確認] ボタンをクリックします。

ポリシー名を指定して [ポリシーの作成] をクリックします。

IAM ユーザーを作成する

AWS コンソールより Identity andAccess Management (IAM) メニューを開き、[ユーザー] をクリックします。

[ユーザーを追加] をクリックします。

任意のユーザー名を設定しアクセスの種類にて [プログラムによるアクセス] にチェックを入れ、[次のステップ : アクセス権限] をクリックします。

アクセス許可の設定では、既存のポリシーを直接アタッチを選択したあと、先ほど作成したポリシー名で検索します。ポリシーをチェックして、[次のステップ : タグ] をクリックします。

タグは特に不要なので何も入力せず [次のステップ : 確認] をクリックします。

以下の項目を確認して [ユーザーを作成] をクリックします。

IAM 認証情報をコピーする

IAM ユーザーが作成されると、認証情報が発行されます。アクセスキー ID やシークレットアクセスキーを控えておきます。これらは再発行できないので、[.csv のダウンロード] をクリックして csv ファイル形式でダウンロードしておくと良いでしょう。

アクセス制御の重要性
IAM 設定によるアクセス制御は一見手順が多く、煩雑に感じるかもしれません。またこの部分の設定を誤ると、正しく Lambda を実行できません。しかしながら、適切なユーザーが適切なリソースにのみアクセスできるよう制御することは万が一の事故を防ぐためにもとても重要です。SORACOM プラットフォームでもSORACOM Access Management(SAM)というアクセス制御機能を提供しています。 SAM は今回のレシピでは取り扱いませんが、今後さらなる応用にご活用ください。

AWS Lambda と連携する SORACOM Funk を設定する

SORACOM Funk から AWS Lambda を呼び出すための設定をおこなっていきます。

作成したIAMユーザ情報をソラコムの認証情報ストアへ登録する

認証情報ストアとは？
ソラコムからの連携先サーバーやクラウドサービスへの接続設定や認証情報をソラコムプラットフォームに保存することができる機能です。 認証情報ストアに保存した認証情報を利用してソラコムの各種サービスは接続ができるため、デバイス側に認証情報を保持する必要がなくなります。また認証情報ストアは一度保存した証明書などの機密情報は取り出せないようになっており情報流出のリスクを軽減します。

ユーザーコンソールの右上にあるユーザー名をクリックし ［セキュリティ］をクリックします。

［認証情報ストア］> ［認証情報を登録］をクリックします。

下記の情報を認証情報として登録します。

SORACOM Funk の設定をする

GPS マルチユニット管理画面から、設定するマルチユニットをクリックして [グループ設定変更] をクリックします。

[基本設定］ >［SORACOM Funk 設定］をクリックして設定ができるように開き情報を設定します。

設定後にマルチユニットのファンクションボタンを押す必要がないのはなぜ？
マルチユニットの設定で送信間隔などを設定した際は最後にファンクションボタンを押しました。これは、デバイスへ設定を反映するためです。一方で SORACOM Funk を設定してもファンクションボタンを押す必要はありません。これは、SORACOM Funk の送り先や認証情報といった内容がデバイスに意識されないためです。このように、SORACOM サービスを利用するとデバイス側の設定を変更することなく柔軟に送信されるデータを活用できます。

動作確認

マルチユニットを裏返したり立てたりすることで Slack のステータスが変わることを確認しましょう。また、ファンクションボタンを押すことでステータスがリセットされることを確認しましょう。このレシピで提供したサンプルコードではそれぞれの置き方に応じて Slack 上では以下のようなステータスになることを想定しています。

ファンクションボタン（本体表面の四角のボタン）は1秒ほど押す必要があります。LED が緑色に点灯すれば送信できています。

他の人から見ると Slack のステータスが更新されていないように見える？
Slack のステータスは、自分から見るとリアルタイムで更新されますが、他の方には “そこそこのタイミング” で更新されるため、頻繁な更新には向かない事をご留意ください。(ドキュメントには記載されていませんが、当方でのチェック中に確認された挙動です)

トラブルシューティング

Slack 上のステータスが更新されない場合は、以下のポイントを確認してください。

時間が十分に経過しているか

マルチユニットの「デバイス設定」にて設定した送信間隔分のタイムラグがあります。送信間隔は最短で1分です。設定した内容を確認して、時間をおいてみてください。

SORACOM Harvest Data にデータが格納されているか

マルチユニットは SORACOM Unified Endpoint を経由して SORACOM Harvest Data と SORACOM Funk との両方にデータを送信しています。SORACOM Harvest Data 上にデータが格納されているかをもとに、以下を切り分けてください。

• 時間が十分に経過しているにもかかわらず SORACOM Harvest Data 上でデータが確認できない場合は、電波状況などでマルチユニットからデータが送信できていないことが考えられます。場所を移動し、ファンクションボタンを押してみてください。
• SORACOM Harvest Data 上でデータが確認できるものの Slack のステータスが変わっていない場合は SORACOM Funk や AWS Labmda の設定が原因と考えられます。AWS Lambda のログが出力されているかを確認してください。

AWS Lambda のログが出力されているか

AWS Lambda では関数の編集画面にて「モニタリング」タブの「CloudWatch Logs Insights」より関数の実行ログを確認できます。このログをもとに、以下を切り分けてください。

• ログが出力されていない場合、SORACOM Funk から AWS Lambda にデータが送信できていないことが考えられます。SORACOM Funk が有効になっているか、認証情報の設定が正しいか確認してください。
• ログが出力されているにもかかわらず Slack のステータスが更新されていない場合は、何かログにエラーなど出力されていないか確認してください。

あとかたづけと注意事項

本レシピでは費用がかかるサービスを利用しています。
本項をよく読み、必要な操作や解除作業を行うようにして、想定外の費用が掛からないようにしてください。

費用について

ここで記載している金額は全て税込み、送料別となります。

SORACOM プラットフォームの利用料金

※ 費用詳細はリンク先をご確認ください。

無料利用枠について
SORACOM サービスでは一部サービスにおいて無料枠が設定されています。たとえば SORACOM Air for セルラーであればアカウント毎で30円/月の通信分や、SORACOM Harvest Data であれば31日分の書込みリクエストなどです。料金詳細に「無料利用枠」として掲載されていますので、ご確認ください。

今回の目安

加速度センサーの値のみで1分毎に送信し、Unified Endpoint 経由で SORACOM Harvest Data と SORACOM Funk 両方に送信した場合、1時間当たりのデータ通信量は上り 約11.5 KiB、下り 約13.0 KiB となります。(SORACOM Funk のみにした場合、上りは11.5KiBとほとんど変わりませんが、下りは4.0KiB と削減できます。)

今回はデバイスの送信設定を「一日あたり 8:00 ～ 18:00 の10時間」と「月～金の週5日」としています。

これらを基に1日あたりのデータ通信に係る費用は、以下のようになります。

• ※ 1日(10時間)あたりのデータ通信量は上りが 115 KiB、下りが 130 KiB としています。
• ※ 土日はデータ送信は行いませんが、基本料金は発生します。

これに加えて、SORACOM Harvest Data や SORACOM Funk 、そして AWS 費用が発生することになります。SORACOMやAWSの各種サービスはオンラインでお見積りが可能となっています。SORACOM 料金見積もりツール / AWS Pricing Calculator

GPS マルチユニット SORACOM Edition に適している通信速度は？
SORACOM は通信速度に応じて費用が設定されており、最も低速な s1.minimum は最も安価となっています。一方、GPS マルチユニット SORACOM Edition から送信されるデータは小さく、また、送信間隔も最小で1分と長いため通信速度は必要としません。

GPS マルチユニット SORACOM Edition を安価に運用する方法として、通信速度を s1.minimum にすることをお勧めいたします。

SORACOM Harvest Data と SORACOM Funk は同時に使う必要があるの？
SORACOM のサービスは、必要な機能を選んでお使いいただけます。データ収集・蓄積は SORACOM Harvest Data で、Slack ステータスの変更は SORACOM Funk で実現されています。ステータス変更を実行するだけでばあれば SORACOM Harvest Data は OFF にすることで費用(5.5円/日/SIM)も抑えることができるため、より一層安価に運用することが可能です。もちろん、必要になったタイミングで ON にできます。

グループ解除

SORACOM Harvest Data 等、「機能が有効になっているグループに所属している SIM × 費用」となっているサービスにおいては、「機能を OFF にする」することで費用の発生を抑えることができます。またもう1つの方法として「グループに所属している SIM の数を減らす(= 解除する)」事でも費用を抑える事ができます。

グループ解除の方法はグループからの解除 (JP)をご覧ください。

SORACOM Harvest Data のデータ削除

SORACOM Harvest Data は基本的にはデータ保管料は無料※です。そのため、保存しておいても害はありませんが、デモ等で利用する際にはデータを綺麗にしておく必要が出てくるため、データ削除について解説します。

※発生から40日を超えたデータは削除されます。40日以上データを保管したい場合はデータ保持期間延長オプション利用料金をご利用ください。

SORACOM Harvest Data 画面 (［操作］>［データを確認］) のデータテーブルで、削除したいデータのチェックボックスを付けた後に［削除］をクリックします。表示されたダイアログで改めて［削除］をクリックすると、削除されます。
※ 複数のデータにチェックをつければ一括で削除可能です。

データの復元はできませんのでご注意ください。

次のステップ

本レシピでは、GPS マルチユニット SORACOM Edition が持つ「加速度センサー」で置かれ方をセンシングし、その情報を「自分の状態」として意味を持たせました。このように、センサーは意味付けによって幅広い活用の仕方ができる例として紹介いたしました。SORACOM Funk の利用で各種クラウドの FaaS と連携による自分だけのアプリケーション構築も、サーバの構築などせずとも実現できる事が体感いただければ幸いです。

商品ページへ戻る

ここからの発展アイデア

• 状態の履歴を Google Spreadsheet へ記録 (参考: AWS IoT Enterprise ButtonのデータをGoogle Spreadsheetに記録する)