SoracomのAPIを介してSIMの通信状況を監視する

はじめに

IoT的なものを作ろうと思ってモバイルネットワークを使うとき、機器の監視は大変頭を悩ませるポイントだと思っています。
クラウドと端末を閉域で結ぶサービス(Soracom Canal等)もありますが、個人でやるにはちょっと高いですね。
今回はSoracom Airを使うことを前提に、Soracom APIを叩くことによりSIMの通信状態の監視を行います。

やったこと

こんな感じにしてみました。
今回センサーはSensorTagを使っているので、Bluetoothが切れたときは直接SES空メールを送信していますが、そちらは本稿では割愛します。
赤い線で繋いでいる側を解説します。

詳解

Soracom APIの叩き方

まずはSoracom APIを叩いてみましょう。
何にせよ、Soracomが提供しているAPIドキュメントが良い感じです。
APIキーの入手もテストもここからできます。

Soracom APIリファレンス

まずはAPIキーを入手します。
認証キーによる認証とユーザコンソールのアカウントによる認証の2種類がありますが、認証キーによる認証は多分僕の場合関係ないので、右側を入力して、認証を押します。
そうすると、API キーが入手できます。

この認証をかけたあとは、下側にあるサンプルが使い放題です。
とりあえず今回は、Subscriber内のGET /subscriber/{imsi}を利用します。

その前に、imsiの値はSoracom管理コンソールの下記を見て控えておいてください。

それでは試してみましょう。
Parameters内にimsiを入力するBOXがあるので、そこに値を入力したあと、「Try it out!」ををクリックします。

そうすると、response以外にもcurlだったらこうすればいいといったようなサンプルも表示されます。大変親切でこう書かれると文書よりもわかりやすくていいですね。

認証のパラメータとしてX-Soracom-API-Key, X-Soracom-Tokenの2つを渡してやればいいようですね。あと、Accept: application/json。

そしてResponseですが、今回はその中のsessionStatus.onlineに注目します。

いま接続状態なのでtrueですが、切れるとfalseになります。
これを利用して監視します。

Lambdaのコード

僕はプログラマーではないのであまり得意な言語はないので、正直なんでもいいんですが、とりあえずnode.jsを使います。多少慣れてるので。

色々とハードコートされててあれですが、サンプルですのでご容赦を。
実際にはKMSとか使ってますが、ここでそれを書くと長くなるので短縮版にしてます。

index.js

exports.handler = function (event, context, callback) {
    var https = require('https');
    var AWS = require('aws-sdk');

    var imsi = 'PUT YOUR IMSI';
    var to_mail_addr = 'PUT YOUR MAIL ADDRESS YOU RECIEVED ALERT MAIL';
    var from_mail_addr = 'PUT YOUR MAIL ADDRESS YOU SEND ALERT MAIL(SES)';

    var soracom_key = 'PUT YOUR SORACOM API KEY'
    var soracom_token = 'PUT YOUR SORACOM API TOKEN'

    var aws_key = 'PUT YOUR AWS API KEY TO SEND MAIL FROM SES'
    var aws_sec = 'PUT YOUR AWS API SECRET KEY TO SEND MAIL FROM SES'

    var options = {
        hostname: 'api.soracom.io',
        path: '/v1/subscribers/' + imsi,
        method: 'GET',
        headers: {
          'X-Soracom-API-Key': soracom_key,
          'X-Soracom-Token': soracom_token
        }
    };
    var req = https.request(options, (response) => {
        var buf = "";
        response.on('data', (chunk) => {
            buf = buf + chunk;
        })
        response.on('end', () => {
            const body = JSON.parse(buf);
            if (body.sessionStatus.online != true) {
                var ses = new AWS.SES({apiVersion: '2010-12-01',
                    accessKeyId: aws_key,
                    secretAccesskey: aws_token,
                    region: 'us-east-1'
                });
                var params = {
                    Destination: {
                        ToAddresses: [ to_mail_addr ]
                    },
                    Message: {
                        Body: {
                            Text: {
                                Data: 'SIM(' + body.imsi + ') is offline',
                                Charset: 'utf-8'
                            }
                        },
                        Subject: {
                            Data: 'SIM error occured',
                            Charset: 'utf-8'
                        }
                    },
                    Source: from_mail_addr
                };
                ses.sendEmail(params, function (err, data) {
                    if (err) { callback ('e', err); }
                    else { callback(null, data); }
                });
            }
        });
    });
    req.end();
}

たぶんプログラマの諸兄なら読めるでしょうが、やってることは単純で、Soracom APIを叩いて、結果次第でSES経由でメールを出しているだけです。

外部ライブラリはaws-sdkのみなので、このコードをそのまま貼り付ければOKですね。

Lambda関数への登録

Lambda関数への設定は至極一般的なものなので、サクッと説明します。

Create Lambda functionをクリック

BluePrintはBlank

triggerはCloudWatch　Events - Schedule

ここはなんとなく良い感じのスケジュールを選べば良いと思います。

コードは適当に貼り付ければOKです。

外部APIを叩くので、タイムアウト値は長めに。
ユーザは前に作っていたものを使ってしまったのであまり良く覚えていないですが、たしかこの画面で新規ロールを作って、IAMの画面からSESのFull権限を追加しました。

以上です。

問題点

この方法の問題点はきれいに切れた場合はちゃんと検知できるものの、ブチッといくとうまくいかない点ですね。。。
(たまたまブチッと切ってみたらうまくいかないことに気づいた)

そんなわけで問題を解決してみます。

問題解決

問題解決版で使うAPI

便利なもので、5分単位の通信量が見れるAPIがあるのでそれを利用します。

まず試しにこんなパラメータで投げてみます。
これは2016/11/3の日本時間19:15-19:30くらいを指定しています。

その時のレスポンスです。
このときは通信していたので、何となくそれらしい値が返ってます。

では、直近で切れている2016/11/3の日本時間23:00 - 23:15で取得してみましょう。

[]が返ってきますね！
これを利用すれば通信の有無が見れそうです。

問題解決版のコード

index.js

exports.handler = function (event, context, callback) {
    var https = require('https');
    var AWS = require('aws-sdk');

    var imsi = 'PUT YOUR IMSI';
    var to_mail_addr = 'PUT YOUR MAIL ADDRESS YOU RECIEVED ALERT MAIL';
    var from_mail_addr = 'PUT YOUR MAIL ADDRESS YOU SEND ALERT MAIL(SES)';

    var soracom_key = 'PUT YOUR SORACOM API KEY'
    var soracom_token = 'PUT YOUR SORACOM API TOKEN'

    var aws_key = 'PUT YOUR AWS API KEY TO SEND MAIL FROM SES'
    var aws_sec = 'PUT YOUR AWS API SECRET KEY TO SEND MAIL FROM SES'

    var to = new Date().getTime();
    var from = to - 1000 * 15 * 60;
    console.log(from, to);
    var options = {
        hostname: 'api.soracom.io',
        path: '/v1/stats/air/subscribers/' + imsi + '?from=' + from + '&to=' + to + '&period=minutes',
        method: 'GET',
        headers: {
          'X-Soracom-API-Key': soracom_key,
          'X-Soracom-Token': soracom_token
        }
    };
    var req = https.request(options, (response) => {
        var buf = "";
        response.on('data', (chunk) => {
            buf = buf + chunk;
        })
        response.on('end', () => {
            const body = JSON.parse(buf);
            if (body.length == 0) {
                var ses = new AWS.SES({apiVersion: '2010-12-01',
                    accessKeyId: aws_key,
                    secretAccesskey: aws_key,
                    region: 'us-east-1'
                });
                var params = {
                    Destination: {
                        ToAddresses: [ to_mail_addr ]
                    },
                    Message: {
                        Body: {
                            Text: {
                                Data: 'SIM(' + imsi + ') is offline',
                                Charset: 'utf-8'
                            }
                        },
                        Subject: {
                            Data: 'SIM error occured',
                            Charset: 'utf-8'
                        }
                    },
                    Source: from_mail_addr
                };
                ses.sendEmail(params, function (err, data) {
                    if (err) { callback ('e', err); }
                    else { callback(null, data); }
                });
            }
        });
    });
    req.end();
}

基本は一緒ですね。

まとめ

今回はSoracomのAPIを使ったSIMの監視についてまとめてみました。
まぁ、とりあえずこれでできますよというアイディアレベルで作ってみたので、ちょっと今後運用してみて、何か思う所があれば再度考えます笑

機器自体のステータスなんかは見れませんが、とりあえず通信できている/できていないレベルであればこんな見方もできます、というところでいかがでしょうか。