SORACOM GPS マルチユニットのデータを kintone に保存する #Node.js

概要

発表と同時に注文していた「GPS マルチユニット SORACOM Edition スターターキット」が届いたので早速 kintone へのデータ保存を試してみました。

SORACOMエンジニアブログによると、GPSマルチユニットは Unified Endpoint を経由して、Harbest Data や、Beame、Funnel、Funk で利用できます。

SORACOMエンジニアブログ（4 つのセンサーと省電力通信 LTE-M 内蔵「GPS マルチユニット SORACOM Edition」発売開始！）より引用

そこで、今回は以下のようにGPSマルチユニットから、Unified Endpoint、SORACOM Funk を経由して、AWS Lambda をキックして kintone にレコードを追加する方法を試してみました。
GPS マルチユニット－＞Unified Endpoint－＞SORACOM Funk－＞AWS Lambda－＞kintone

GPS マルチユニットの準備

「GPS マルチユニット SORACOM Edition スターターキット」には、GPS マルチユニット SORACOM Edition、SORACOM 特定地域向け IoT SIMカード (plan-D サイズ：ナノ / データ通信のみ) 、充電/給電用マイクロUSBケーブル 1本が同梱されています。

すでにSORACOMのサイトに一通りのドキュメントがあり、それを参考に本体にSIMを入れた後に前面にあるボタンを1秒以上押すか、同梱されているUSBケーブルで充電すると本体が起動します。

GPS マルチユニット SORACOM Edition 製品仕様
https://dev.soracom.io/jp/gps_multiunit/specification/
GPS マルチユニット SORACOM Edition デバイスの使い方
https://dev.soracom.io/jp/gps_multiunit/how-to-use/

kintone の準備

今回はGPS マルチユニットのデータをkintoneに保存しますので、以下のドキュメントを参考にGPSマルチユニットのデータを全て保管するkintoneのアプリを用意します。

GPS マルチユニット SORACOM Edition 機能の説明
https://dev.soracom.io/jp/gps_multiunit/how-it-works/

kintoneに以下のようなフォームを持つアプリを追加します。

フィールド名	タイプ	フィードコート・要素ID
日時	日時	datetime
緯度(Y)	数値（少数9桁）	lat
経度(X)	数値（少数9桁）	lon
電池残量	数値（少数0桁）	bat
アンテナ感度	数値（少数0桁）	rs
温度	数値（少数1桁）	temp
湿度	数値（少数1桁）	humi
加速度X	数値（少数1桁）	x
加速度Y	数値（少数1桁）	y
加速度Z	数値（少数1桁）	z
タイプ	数値（少数0桁）	type

あとアプリの設定画面で、レコード追加権限を持つAPIトークンを追加、控えておきます。
完成したアプリは以下です。

AWS アカウントの追加

次に、GPS マルチユニットからのデータを受信処理する AWS Lambda をキック（起動）するための、AWS アカウントを追加します。AWS コンソール IAM のユーザ画面で、ユーザを追加します。

ユーザの詳細設定で「ユーザ名」を入力し、「アクセスの種類」にプログラムによるアクセスを選択し、次のステップに移ります。

アクセス許可の設定で「既存ポリシーを直接アタッチ」を選択し、「ポリシーのフィルタ」に AWSLambdaFullAcess を選択して、次のステップに進みます。

本来は先に AWS Lambda 側の設定を行った後に以下のような「ポリシーの作成」を行った方が良いのですが、今回は試験的に試すだけですのでAWSLambdaFullAcessにしています。

ユーザの追加に成功したら、アクセスキーIDと、シークレットアクセスキーを控えておきます。

以上でアカウントの追加は完了です。

AWS Lambda の準備

続いて、GPS マルチユニットからのデータを受信処理する AWS Lambda の設定を行います。「関数の作成」で「関数名」を入力し、ランタイムが Node.js 12.x、その他の項目は変更せず関数を作成します。（写真はソースコード他の設定を終えた状態。）
画面右上の ARN（写真はグレーで消している）は、GPS マルチユニットの通信設定に必要なので控えておきます。

作成した関数の基本設定の「メモリ（MB）」を256MBに、「タイムアウト」を30秒に設定します。（メモリは初期値の128MBでも良いですが、タイムアウト初期値3秒は kintone API のレスポンスに遅延が発生する場合も想定して10秒以上に変更した方が良いでしょう。）

作成した関数の非同期呼び出しの「イベントの最大有効時間」は1分程度に、「再試行」は0で行なわないようにします。（今回は、通信のタイムアウトなどで処理が中断した場合は再実行しない設定にしています。）

GPS マルチユニット SORACOM Edition 機能の説明で紹介しているGPS マルチユニットから送信されるbase64をデコードしたフォーマットを参考に、関数のテストを追加します。

{
    "lat":35.000000,
    "lon":139.000000,
    "bat":3,
    "rs":4,
    "temp":16.0,
    "humi":32.4,
    "x":0.0,
    "y":-64.0,
    "z":-960.0,
    "type":0
}

最初うっかりGPS マルチユニット SORACOM Edition 機能の説明で紹介している base64 ペイロードデータを処理するプログラムを作成し、base64 ペイロードデータテストを設定していましたが、実際は SORACOM Funkから Lambda にデータが渡される時にはbase64デコードしているため上記の設定になります。

テスト実行後、kintone にレコードが追加されているのが確認できます。

AWS Lambda のプログラム

AWS Lambda のプログラムは、以下の node.js のパッケージ request-promise と moment を追加する必要があります。
https://www.npmjs.com/package/request-promise
https://www.npmjs.com/package/moment

Lambda で node.js のパッケージを使う説明は割愛しますが、以下などを参考に設定すると良いでしょう。
Lambda の Node.js でもっといろんなパッケージを使いたいとき
https://tech-lab.sios.jp/archives/9017
AWS Lambda Layersでnode_modulesを使う
https://xp-cloud.jp/blog/2019/01/12/4630/

Lambda ではGPS マルチユニットからのデータは Json 形式で簡単に受け取れるため、実装は kintone API の Json フォーマットに変換して POST するだけです。

index.js

'use strict';

const request = require('request-promise');
const moment  = require("moment");

const Domain     = "cybozu.com";
const Subdomain  = "SUBDOMAIN";
const Path       = "/k/v1/record.json";
const Protocol   = "https://";
let   Url        = Protocol + Subdomain + '.' + Domain + Path;

const AppId  = "KINTONE_APP_ID";
const Token  = "KINTONE_TOKEN";

exports.handler = async function(event, context, callback) {
    console.log('Function Start.');

    var dateTime = moment().format("YYYY-MM-DDTHH:mm:ssZ");
    var json = {
        "dateTime" : { "value" : dateTime },
        "lat"      : { "value" : event.lat },
        "lon"      : { "value" : event.lon },
        "bat"      : { "value" : event.bat },
        "rs"       : { "value" : event.rs },
        "temp"     : { "value" : event.temp },
        "humi"     : { "value" : event.humi },
        "x"        : { "value" : event.x },
        "y"        : { "value" : event.y },
        "z"        : { "value" : event.z },
        "type"     : { "value" : event.type },
    };
    await PostKintoneRecode(request, Url, AppId, Token, json);

    console.log('Function Stop.');
};

// kintone のデータを追加する
async function PostKintoneRecode(request, url, appId, token, json)
{
    try {
        var options = {
            url: url,
            method: 'POST',
            headers: {
                'Content-type': 'application/json',
                'X-Cybozu-API-Token': token
            },
            json: { app : appId, record: json },
        };
        await request(options);
        return true;
    } catch (err) {
        console.error(JSON.stringify(err));
        return false;
    }
}

GPS マルチユニットの設定

最後に、いよいよGPS マルチユニットの設定に入ります。（翌日気づいたのですが、すでにSORACOMさんの丁寧なドキュメントが公開されていましたので、以下を参考にすると良いでしょう。）
GPS マルチユニット SORACOM Editionを使用して、定期的に位置情報を送信する
https://dev.soracom.io/jp/start/gps_multiunit_location/

SIMの有効化

SORACOM のコンソールにログインして、以下の画面に遷移してGPS マルチユニットに付属していた SIM（plan-D ナノサイズ）を有効化します。
Menu－＞発注－＞注文履歴－＞「受け取り確認」ボタン

SIMグループの追加と設定

SIM 有効化後、SIM グループの画面でグループを追加します。

追加したグループの Unified Endpoint を設定します。今回は SORACOM Funk を利用しますので「フォーマット」に SORACOM Funk を選択します。

追加したグループの SORACOM Funk を以下のように設定します。「サービス」は AWS Lambda を選択、「送信データ作成」は JSON を選択、「認証情報」を追加（追加方法は後述）、「関数のARN」は先に控えておいた Lambda の ARN を入力します。

「認証情報」の追加は、「認証情報」の項目にマウスを移動すると以下が表示されるので、クリックすると追加画面が表示されます。

「認証情報」追加画面の「認証情報ID」と「概要」を入力し、「識別」はAWS 認証情報を選択、「AWS Access Key ID」と「AWS Secret Access Key」はAWS アカウントの追加で保管したアクセスキーIDとシークレットアクセスキーを入力し、登録します。

以上のグループの設定が完了したら SIM 管理画面に戻り、先に有効化した SIM にこのグループを紐づけます。

GPS マルチユニット本体の設定

SIM と SIMグループの登録・紐づけ後、以下の画面に遷移して GPS マルチユニット本体を設定します。
Menu－＞ガジェット管理－＞GPS マルチユニット
GPS マルチユニットの画面から、新規デバイス設定を行います。
使用するSIMを選択する画面で先に登録したSIMを選択し「次へ」遷移、設定を保存するグループを選択する画面で既存のグループを利用を選択し先ほど作成したグループを選択して「設定を編集」画面に遷移します。

GPS マルチユニットの設定画面で、送信内容を全てチェックします。

送信先の「SORACOM Harvest（Lagoon）」をチェックします。（SORACOM Funk は最初からチェックされて、こちらでは変更できません。）

送信モードは「定期送信 - 手動モード」を選択します。

定期送信 - 手動モード詳細設定は毎日10分毎に設定します。（最初のテスト時は最短の1分毎に設定していました。）

加速度割り込みはお好みで良いでしょう。

以上の設定を完了したら「保存」します。