SORACOM Arc & IoTボタンシュミレータセットアップテキスト

前提

PCの準備 (Windows もしくは macOSで、ブラウザはChrome、もしくは Firefoxをインストールしておいてください)
SORACOMアカウントの準備 (SORACOMアカウントの作成手順はこちら )
こちらのテキストに従って、IoTボタンシュミレータをセットアップ
上記を完了してから「IoT初心者 SORACOM Button ハンズオン（ボタンを押してkintoneに記録しよう！）」を実施

構成図（但し、今回のハンズオンにAWSの部分は含みません）

SORACOM Arcについて

今回のハンズオンでは、「セキュアリンクサービス SORACOM Arc」(以下、Arc)を用いてみなさんのPCをSORACOMサービスに接続します。

Arcについて詳しくは以下の公式ページを参照ください。

https://soracom.jp/services/arc/

PCでArcを使うには以下の2つの方法があります。

公式ツール「soratun」を用いる(Linux/Mac)
WireGuardを用いる(Windows/Mac/Android/iOSなど)

今回は、WireGuardを用いて接続をします。

利用料金

Arcの利用料金は以下の通りです。

初期費用(契約事務手数料)
1 バーチャル SIM/Subscriber あたり 55 円
基本使用料(月額)
1 バーチャル SIM/Subscriber あたり
55 円 (SORACOM IoT SIM に追加する場合)
88 円 (バーチャル SIM/Subscriber 単独で利用する場合)
データ通信料
1 バーチャル SIM/Subscriber ごとに 1 GB あたり 22 円
SORACOM プラットフォームへのデータ通信量に応じて料金が発生します。
上り、下りの合計となります。ただし、毎月 1GB までは基本料金に含みます。
無料利用枠
1 アカウントあたりバーチャル SIM/Subscriber 1契約分の基本使用料(月額)、1GB 分のデータ通信料が無料枠として提供されます。
なお、1 アカウントあたり 1 回に限り、バーチャル SIM/Subscriber の初期費用が無料となります。

今回のハンズオンでは、ほとんどの方は初めてバーチャルSIMを作成することになりますので、無料枠の中でご利用いただけます。

また、ハンズオン終了後にバーチャルSIMを解約しないでも、翌月以降費用が発生することもありません。作成時の初期費用が無料になるのも最初の1回だけなので、そのまま残しておくのをお勧めします。

WireGuardについて

WireGuardはオープンソースのVPN実装です。OpenVPNやIPsec等に比べ、セットアップが非常に容易で、パフォーマンスにも優れているという特徴があります。

Linuxのカーネルモジュールでの実装の他に、アプリケーション(ユーザー空間)での実装があります。

詳細は公式ページをご覧ください。
https://www.wireguard.com/

SORACOM Beamについて

今回のハンズオンでは、「データ転送サービス SORACOM Beam」(以下、Beam)を用いてOrbitで加工した、ボタンシュミレータから受信データをLine Notifyに転送します。

Beamについて詳しくは以下の公式ページを参照ください。
https://soracom.jp/services/beam/

利用料金

Beamの利用料金は以下の通りです。

基本料金
無料
従量課金
1 リクエスト(*) あたり 0.00099 円
※エントリーポイント (Beam) へのリクエスト、Beamから転送先へのリクエスト、それぞれを個別に 1 リクエストとカウントします。

無料利用枠
SORACOM Beam は、無料利用枠をご提供しています。 1アカウントあたり月間 100,000 リクエストまで毎月無料とさせていただきます。なお、リクエスト数が 100,000 リクエストに満たない場合でも翌月に持ち越されることはありません。

今回のハンズオンでは、それぞれ個別のアカウントで作業を行い、リクエストも通常であれば100,000リクエストには達しませんので、無料枠の中でご利用いただけます。

SORACOM Harvestについて

今回のハンズオンでは、「データ収集・可視化サービス SORACOM Harvest」(以下Harvest)を用いてボタンシュミレータから受信したデータを可視化します。
Harvest自体は、データの蓄積(Harvest Data)とファイルの保存(Harvest Files)の2つがありますが、今回は、Harvest Dataのみ扱います。

アップロードされたデータは標準で40日間保存されます。

Harvestについて詳しくは以下の公式ページを参照ください。

https://soracom.jp/services/harvest/

利用料金

Harvestの利用料金は以下の通りです。

Harvest 利用オプション

Harvest を有効にしたグループに所属する 1 SIM カードまたは 1 デバイスあたり
1 日 5.5 円

従量課金

書き込みリクエスト: 1 リクエストあたり 0.0044 円
1 SIM カード / デバイスあたり 1 日 2,000 リクエストまでの料金は上記の「Harvest 利用オプション」の料金内に含まれます。
2,001 回目のリクエストから課金対象です。

無料利用枠

SORACOM Harvest は無料利用枠をご提供しています。
1 アカウントあたり毎月 31 日分の「Harvest 利用オプション」が無料です。（月末締めで自動で計算されます。）
2 つの SIM カード / デバイスで 15 日だけ利用した場合なども合計で 31 日以内なので無料利用枠の対象です。
無料利用枠内で利用している場合でも、書き込みが 1 日 2,000 リクエストを超えた分は従量課金が発生します。
月内の利用日の合計が 31 日以内でも無料利用枠が翌月に持ち越されることはありません。

今回のハンズオンでは、バーチャルSIM１つを用い、書き込みも通常であれば2,000リクエストには達しませんので、無料枠の中でご利用いただけます。

SORACOM Orbitについて

今回のハンズオンでは、「インラインプロセッシングサービス SORACOM Orbit」(以下Orbit)を用いてボタンシュミレータから受信したデータを加工します。

今回は、時間の都合上事前に用意したWASMを用います。

Appendixとして、開発環境構築、コード準備、ビルドを行う方法も記載しておりますので、興味がある方はそちらも合わせて行なってください。

Orbitについて詳しくは以下の公式ページを参照ください。

https://soracom.jp/services/orbit/

利用料金

Orbitの利用料金は以下の通りです。

利用料金

Orbitを利用したSIMの数に応じて、料金が発生します。
SIM 毎に 22 円/月

リクエスト料金

オペレーター単位にリクエスト数の合計数に応じて料金が発生します。
10,000 リクエストあたり 44 円

無料利用枠

1 アカウント、カバレッジごとに、以下の無料利用枠をご提供いたします。
無料利用枠: 1SIM分
リクエスト無料利用枠: 10,000リクエスト分

今回のハンズオンでは、バーチャルSIM１つを用い、リクエストも通常であれば10,000リクエストには達しませんので、無料枠の中でご利用いただけます。

PCからSORACOM Arcに接続するための必要な VPN ソフトウェア「WireGuard」をインストールします。OS 毎の解説を確認してください。

インストール / Windows 編

https://www.wireguard.com/install/ からをクリックして wireguard-installer.exe をダウンロードします。
ダウンロードした wireguard-installer.exe を実行します。
実行中に管理者権限を求められた場合は許可してください。
最終的に以下のような画面が表示されればインストール成功です。この画面は後で利用しますので、表示しておいてください。

インストール / macOS 編

https://www.wireguard.com/install/ からをクリックします。
ブラウザ上でApp Storeの画面が表示されますが、その際ダイアログで、「App Store を開きますか？」と表示されるので、[App Storeを開く]をクリックします。

App Store画面が表示されたら、右上のダウンロードをクリックします。

ダウンロードおよびインストールが終わったら、以下の画面になりますので[開く]をクリックします。

最終的に以下の画面が表示されれば、インストール完了です。

以下の画像や説明は最新と少し異なる部分もありますので、ご注意ください。

WireGuardに設定する接続情報をSORACOMから入手します。接続情報は「バーチャルSIM」をSORACOM上で作成することで生成されます。

バーチャルSIMの作成

次に、SORACOMのコンソールからArcのバーチャルSIMを作成します。

SORACOMのコンソールにログインします。
https://console.soracom.io にアクセスすると以下のような画面が表示されます。メールアドレスとパスワードを入れ、「ログイン」ボタンを押します。
普段SAMでログインしている場合は、そちらでログインしても問題ありません。
正常にログインできると、多くの方は最初に以下のようにSIM管理の画面が表示されます。まだSIMをお持ちで無い場合は、一覧の部分は空欄になります。

もしこの画面が表示されない場合は、左上の「Menu」から「SORACOM Air forセルラー」→「SIM管理」を選んでください。
「サブスクリプションコンテナに対応した新しい SIM 管理画面」に切り替えます。「切り替える」をクリックしてください。

以下のように「サブスクリプションコンテナに対応した新しい SIM 管理画面をご利用中です。」と表示されていることを確認してください。
※既に「新しい SIM 管理画面をご利用中です。」となっている場合は、次のステップに進んでください。
左上の「SIM登録」を押します。
以下のようにSIM登録画面が表示されるので、「バーチャルSIMを登録」を押します。
「登録」を押します。
「以下のWireGuard接続情報をデバイスに設定してください。」と表示されている内容を保存しておきます。
「コピー」ボタンを押すことでクリップボードにコピーすることができますので、テキストエディッタなどに貼り付けて保存しておきましょう。
発行されたバーチャルSIMに名前を付けて、管理しやすくします。一覧画面で「名前」の所の鉛筆ボタンをクリックします。

例えば「ArcSIM02」といった名前を入力して、リターンキーで確定します。

WireGuardの設定

インストールしていたWireGuardを起動し、「トンネルの追加」から「空のトンネルを追加」もしくは「設定が空のトンネルを追加」をクリックします。
[Windowsの場合] ［空のトンネルを追加］をクリック

[macOSの場合] ［設定が空のトンネルを追加］をクリック
トンネルの新規作成では、名前 (例: soracom-arc)を設定した後、テキストエリアにバーチャルSIMの作成時に保存しておいたWireGuard 接続情報上書きして「保存」を押します。

[Windowsの場合]

[macOS の場合]

保存時にダイアログが出た場合は、「許可」を押してください。
これで設定は完了です。

接続と動作確認

「有効化」を押して、SORACOMプラットホームに接続してみます。

[Windowsの場合]

[macOS の場合]
接続できたか、試験をします。
Windowsの場合はPowerShell (もしくはコマンドプロンプト)を起動します。スタートメニューを右クリックすると起動できます。
Macの場合は、Finderアプリで「/アプリケーション/ユーティリティ」フォルダを開いて、「ターミナル」をダブルクリックします。

[Windowsの場合PowerShell (もしくはコマンドプロンプト)を開く]

[macOS の場合「ターミナル」を開く]
PowerShell(コマンドプロンプト)またはターミナルの中で「ping pong.soracom.io」と入力し、リターンキーを押します。以下のように、pingへの応答があれば成功です。
pingコマンドが停止しない場合はコントロールキーを押しながら「c」を押すと停止します。
もし以下のように応答が無い場合は正常に接続できていないので、WireGuardの設定が間違っていないか、また接続が有効になっているかを確認してください。

トラブルシューティング

設定がうまく進まないときにご覧ください。ここまでの作業が出来ている場合は次に進んでください。

①バーチャルSIM登録時の情報を保存し忘れた

SIM管理画面から該当のSIM(「サブスクリプション」が「planArc01」のもの、または名前を付けている場合はその名前で)を探し、チェックボックスをクリックしてから左上の「詳細」を押します。

SIM詳細画面で、「バーチャルSIM」タブをクリック、「高度な設定」をクリック、「公開鍵の更新」をクリックします。

「認証情報を生成」を押します。

「クライアントピア秘密鍵」と「クライアントピア公開鍵」を保存しておきます。

「セッション」タブを押し、「バーチャルSIMセッションのリセット」を押します。

「バーチャルSIMセッションをリセット」を押します

一度画面をリロードします。リロードすると再度SIM管理画面が表示されるので、同じ手順でSIM詳細画面を開き、「バーチャルSIM」タブの「セッション」を確認します。
ここで表示される「クライアントピア公開鍵」が、先ほど保存した値と同じであることを確認します。
「クライアントピアIPアドレス」、「サーバーピア公開鍵」、「サーバーエンドポイント」の値を保存します。

テキストエディッタなどを開き、WireGuardの設定を以下の形で作成します。

[Interface]
PrivateKey = クライアントピア秘密鍵
Address = クライアントピアIPアドレス

[Peer]
PublicKey = サーバピア公開鍵
AllowedIPs = 100.127.0.0/16
Endpoint = サーバエンドポイント.

上記の値をWireGuardに設定します。

②WireGuardを有効にしても接続できない

SIM管理画面から該当のSIM(「サブスクリプション」が「planArc01」のもの)を探し、チェックボックスをクリックしてから左上の「詳細」を押します。

SIM詳細画面の「バーチャルSIM」タブの「高度な設定」に進みます。

「バーチャルSIMの再初期化」を押します。

以下のように、WireGuardの設定が表示されますので、WireGuardにこの情報を再設定します。
<YOUR_PRIVATE_KEY>の部分は最初に保存した設定の「PrivateKey」の値をそのまま使います。

「有効化」を押して接続できるかを試します

SIMグループの作成

SORACOMの各サービスを使うには、SIMをSIMグループへ登録する必要があります。

ここでは、まずSIMグループを作成します。

左上のMenuをクリックし、[SIMグループ]をクリックします。

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

グループ名として、以下を入力し、[グループ作成]をクリックします。

注意) 以下の画像ではグループ名表示は[handson-soratan-20210821]となっています。

SIMグループ設定画面が出てくれば完了です。

SIMグループへのSIM追加

作成したSIMグループに、Arc設定時に作成したバーチャルSIMを所属させます。

左上のMenuをクリックし、[SIM 管理]をクリックします。

作成したバーチャルSIMの左端のチェックボックスをクリックします。

画面上部の[操作 ▼]をクリックし、[所属グループ変更]をクリックします。

[新しい所属グループ]からさきほど作成したSIMグループを選択し[グループ変更]をクリックします。

グループのところに、選択したグループ名が表示されていれば完了です。

SORACOM Air for セルラー設定

ボタンシュミレータからのデータを適切なフォーマットに変換するバイナリパーサーの設定を行います。

左上のMenuをクリックし、[SIMグループ]をクリックします。

左の名前で、作成したSIMグループを選択します。

[SORACOM Air for セルラー設定]左の[>]をクリックします。設定セクションが表示されます。

[バイナリパーサー]横のボタンをクリックして、ONにし、フォーマットに[@button]と入力します。

最下部の[保存]をクリックします。
[SORACOM Air for セルラー設定]左の[>]をクリックし、設定セクションを閉じます。

動作環境

今回のハンズオンでは、SORACOM LTE-M Button for Enterprise(通称：しろボタン)の代わりに、シミュレータソフトを用います。
現在公式に配布しているバイナリーは、以下の環境で動作確認が取れています。

Windows 10 Professional (32bit/64bit)
Mac OS Big sur(Intel Mac/M1 Mac)、Catalina(Intel Mac)

これ以外の環境をお使いでバイナリが動かない場合は、Node.js + Electronが動く環境であればソースコードからビルドすることで動作すると思われますが、本テキストではビルド環境の構築については触れませんのでご了承ください。

ダウンロードしてインストールする

以下のURLから、ご自身の環境に合わせたバイナリをダウンロードしてください。

https://github.com/kenichiro-kimura/soracom-button/releases/tag/v0.2.0

起動する

Windowsの場合はスタートメニューから、Macの場合はFinderなどからクリックすると起動します(アプリケーション名：soracom-button)。
Macの場合、インストールしたアプリを実行しようとすると、開発元が不明なため開けないと警告が出る場合があります。
その場合は、Finderでアプリを表示して、Controlキーを押しながらアプリケーションアイコンをクリックして、ショートカットメニューから「開く」を選択します。

「"soracom-button"は、開発元を検証できないため開けませんと表示された場合

MacOSの設定によっては、起動時に、以下のようなメッセージが出て、起動できない場合があります。これは、セキュリティの設定で、App Storeや確認済みの開発元からのアプリケーション以外は起動できない設定になっているためです、

この画面が出た場合は、いったんキャンセルをクリックします。
その後、システム環境設定を開き、セキュリティとプライバシーをクリックします。

一般タブを表示し、下部にあるダウンロードしたアプリケーションの実行許可のところに「"soracom-iotbutton"は開発元を確認できないため、使用がブロックされました。」と表示されているので、その横の「そのまま開く」をクリックします。

確認ダイアログが出てくるので、[開く]をクリックします。

シュミレータが起動されればOKです。
また、次回以降はダイアログなく起動できるようになります。

起動すると以下のような画面が表示されます。

メニューの機能は以下の通りです。

メニュー名	サブメニュー名	機能
File	終了	アプリケーションを終了します
View	サイズ	ウインドウサイズを大/中/小から選択できます。デフォルトは「大」です
View	ステッカー	ボタンにステッカーを貼って見た目を変えられます。しろボタンとUGバージョンがあり、デフォルトは「しろボタン」です
Help	SORACOM LTE-M Button for Enterpriseユーザーガイド	SORACOMの公式ページが開きます。今回は利用しません。
Help	Open devTools for WebView	デバッグ用です。今回は利用しません。

Viewから見た目やサイズを好きな物に変えてみてください。動作自体は変わりません。

使い方

大きな丸が、ボタンになります。ここをシングルクリック・ダブルクリック・ロングクリックすることができます。クリックすると、SORACOMにデータが送信されます。
小さな丸が、LEDになります。通信中はオレンジに点滅し、5秒ほど点滅をしたあとに実際に通信が発生します。通信結果が成功であれば緑に、失敗であれば赤に1秒ほど点灯します。
「バッテリーレベル」のドロップボックスで、送信するバッテリーレベルを変更できます。バッテリーレベルは1.0/0.75/0.5/0.25から選べます。
「送信状況」の部分に現在の通信内容(例：シングルクリックでバッテリーレベル1.0を送信中)が表示され、通信終了後は通信結果(成功/失敗)が表示されます。
SORACOM Arcで作成したバーチャルSIMの通信状況を、次でセットアップするSORACOM Harvest Dataで見ながら、色々なタイプのクリック情報やバッテリーレベルを送ってみてください。