Getting Started: ボタンクリック時のデータを SORACOM Beam でサーバーへ転送する | SORACOM LTE-M Button for Enterprise ユーザーガイド

Enterprise ボタンのボタンをクリックしたときに、クリック種別、バッテリ残量などのデータを SORACOM Beam (以降、Beam) を利用して任意のサーバーに転送できます。ここでは、Mockbin に転送します。Mockbin は、URL を発行して、その URL に送信した HTTP リクエストをブラウザで確認できる Web サービスです。

Mockbin はソラコムが提供するサービスではありません

ソラコムは、Mockbin に関するサポートを行いません。
Mockbin に転送されたデータの取り扱いを含むサービスの利用にあたってのプライバシーポリシーは Mockbin に準じます。ご不明な点は Mockbin の運営会社へお問い合わせください。

SORACOM Beam の利用料金が発生します

SORACOM Beam の利用には料金が発生します。詳細は SORACOM Beam のご利用料金を参照してください。

Enterprise ボタンのデータを連携するパターンについて

Amazone Web Services (AWS) や、Microsoft Azure、Google Cloud、IBM Cloud にデータを連携することもできます。詳しくは、SORACOM LTE-M Button と各種クラウドサービスを連携するを参照してください。

SORACOM LTE-M Button Plus でも同様に設定すると、ボタンクリック時のデータを Mockbin へ転送できます。

準備

あらかじめ、ユーザーコンソールに SORACOM LTE-M Button for Enterprise を登録してください。

ステップ 1: 転送先として Mockbin を構成する

https://mockbin.org/ にアクセスし、[Create Bin] をクリックします。

Bin Builder 画面が表示されます。
設定を変更せずに、[Create Bin] をクリックします。

URL が発行されます。この URL には、ステップ 3: ボタンをクリックして Mockbin でデータを確認するでアクセスします。ブックマークなどに保存してください。
ブラウザのアドレスバーに表示されている /bin/XXXXX/ (先頭の https://mockbin.org および末尾の view を除く) をコピーして、テキストエディタなどに控えます。
この値は、ステップ 2: Beam を設定するで使用します。

ステップ 2: Beam を設定する

ユーザーコンソールにアクセスし、[メニュー] → [ガジェット管理] → [LTE-M Button for Enterprise] の順にクリックします。
Beam を設定する Enterprise ボタンにチェックを入れ、[SIM グループを編集] をクリックします。
[SORACOM Beam 設定] → [＋設定を追加する] → [UDP → HTTP/HTTPS エントリポイント] の順にクリックします。

以下の項目を設定し、[保存] をクリックします。

指示がない項目は変更しないでください。

項目	値	説明
[ホスト名]	`mockbin.org`
[パス]	`/bin/XXXXX/` (末尾の `view` を除く)	ステップ 1: 転送先として Mockbin を構成するの最後の手順でコピーした文字列をペーストします
[IMSI ヘッダ]	ON	どの Enterprise ボタンが押されたかを、転送先のサーバー (Mockbin) で識別するために利用します
[ステータスコードを省略]	OFF	サーバーからのレスポンスを Enterprise ボタンに返すかどうかを設定する項目です。Enterprise ボタンはレスポンスボディが `2` で始まると成功とみなし、それ以外を失敗とみなすため、OFF のまま使用してください

ステップ 3: ボタンをクリックして Mockbin でデータを確認する

ボタンをシングルクリックします。
LED が約 10 秒間オレンジで点滅したあと、約 3 秒間緑色に点灯します。
緑色に点灯しない場合は
- 約 5 秒間赤色に点灯した場合は、基地局との接続に失敗しています。電波状況の良いところで再度試してください。
- 約 5 秒間赤色に点滅した場合は、電池残量が不足しています。電池を交換してください。
緑色に点灯した場合は、Mockbin のページで [View History] をクリックします。
Mocbin のページは、ステップ 1: 転送先として Mockbin を構成するでブックマークに保存したページです。

確認するデータのをクリックします。

[Request Details] および [Request Body] に、Mockbin に転送されたデータが表示されます。

特に、以下のデータを確認してください。

データ	説明
`x-soracom-imsi` ヘッダー ([Request Details] の `headers[].name` = `x-soracom-imsi`)	Enterprise ボタンの IoT SIM の IMSI。
`x-soracom-geo-position` ヘッダー ([Request Details] の `headers[].name` = `x-soracom-geo-position`)	緯度および経度 (簡易位置測位機能を有効にした場合)。 `緯度;経度`。緯度は `-90` ~ `90`、経度は `-180` ~ `180` です。
`clickType` ([Request Body] を参照)	クリックの 3 つのタイプ (数値)。 `1`: シングルクリック、`2`: ダブルクリック、`3`: 長押しのいずれか
`clickTypeName` ([Request Body] を参照)	クリックの 3 つのタイプ (文字列)。 `SINGLE`: シングルクリック、`DOUBLE`: ダブルクリック、`LONG`: 長押しのいずれか
`batteryLevel` ([Request Body] を参照)	バッテリーレベル。 `0.25`、`0.5`、`0.75`、`1.0` の四段階
`binaryParserEnabled` ([Request Body] を参照)	バイナリパーサーの有効/無効。 `true`: 有効、`false`: 無効

ステップ 4: (任意) 位置情報を送信する

簡易位置測位機能を有効にすると、x-soracom-geo-position ヘッダーに 緯度;経度 の形式で Enterprise ボタンの緯度と経度が挿入されます。

簡易位置測位機能は、ボタンをシングルクリック、ダブルクリック、長押ししたときの Enterprise ボタンの位置が 1 回だけ送信される機能です。Enterprise ボタンが移動した経路を取得するには、定期的にボタンを操作してください。
簡易位置測位機能の利用には料金が発生します。詳しくは、簡易位置測位機能を参照してください。

LTE-M Button for Enterprise/Plus 画面を表示します。
位置情報を送信する Enterprise ボタンにチェックを入れ、[デバイス設定変更] をクリックします。
[位置情報を付与する (簡易位置測位機能)] にチェックを入れ、[保存] → [デバイス一覧に戻る] の順にクリックします。
ステップ 3: ボタンをクリックして Mockbin でデータを確認するの手順を行い、データを確認します。
Mockbin の [Request Details] に x-soracom-geo-position が挿入されます。
```
  ...
  "headers": [
    ...
    {
      "name": "x-soracom-geo-position",
      "value": "35.6697898;139.744167845935"
    }, ...
  }
  ...
```

Beam では位置情報はヘッダーに含まれます

簡易位置測位機能のデータフォーマットは、送信に利用するサービスによって異なります。詳しくは、簡易位置測位機能のデータフォーマットを参照してください。

Soracom

Users

ボタンクリック時のデータを SORACOM Beam でサーバーへ転送する