開発者ガイド: 通信で WASM モジュールが使用されるように SIM グループを設定する | SORACOM Orbit

デバイスからのデータを Orbit で処理するため、そのデバイスが使用する SIM を Orbit を有効にしたグループに所属させます。ひとつの SIM グループで使用できる Soralet とそのバージョンは 1 つのみです。

ステップ 1: Orbit を有効化する

Orbit の設定はグループに対して行います

ここでは、グループの設定を変更する操作のみを説明します。グループの仕組みやグループを作成する操作について詳しくは、グループ設定を参照してください。

SIM グループ画面で [SORACOM Orbit 設定] をクリックします。
SIM グループ画面を表示する操作について詳しくは、グループの設定を変更するを参照してください。
スイッチをクリックして「ON」にします。
設定を変更します。
- Code SRN: soralets get コマンドなどで取得できる Soralet の SRN (SORACOM Resource Name) を指定します。
- Content Type: デバイスから送信するデータの Content Type を指定します。
- Soralet を利用する経路: Soralet を利用する経路 uplink / downlink を指定します。サービス開始時はこの設定を元に課金対象が決まりますのでご注意ください (たとえば downlink の処理が空だった場合も実行としてカウントされます)。
- メタデータサービス: メタデータを Soralet に連携します。タグやユーザーデータを使用する場合は有効にしてください。SORACOM Air for Cellular 設定セクションのメタデータ連携有効設定よりも優先されます。
- 簡易位置測位機能: 簡易位置測位機能による位置情報を使用する場合は有効にしてください。特定地域向け IoT SIM (plan-KM1) でのみ使用可能です。
[保存] をクリックします。
IoT SIM が所属するグループを切り替えます。
IoT SIM の Orbit が有効になりました。

SORACOM CLI / SORACOM API の場合

SORACOM CLI または SORACOM API を利用しても、Orbit の設定を変更できます。

SORACOM CLI
SORACOM API

SORACOM CLI を利用するには、あらかじめ SORACOM CLI をインストールし、認証情報を保存してください。詳しくは、SORACOM CLI をインストールするを参照してください。
{group_id} は、soracom groups list (Group:listGroups API) で取得できます。
{namespace} は、SoracomOrbit です。
ボディで指定するプロパティについては、ボディで指定するプロパティについてを参照してください。

Orbit を有効にする

soracom groups put-config (Group:putConfigurationParameters API) を使用します。

$ soracom groups put-config --group-id {group_id} --namespace SoracomOrbit \
--body '[
  {
    "key": "enabled",
    "value": true
  },
  {
    "key": "codeSrn",
    "value": "srn:soracom:OP0000000000:jp:Soralet:hello-soralet/$LATEST"
  },
  {
    "key": "useLocation",
    "value": true
  },
  {
    "key": "useMetadata",
    "value": true
  },
  {
    "key": "contentType",
    "value": "application/json"
  },
  {
    "key": "enabled",
    "value": true
  },
  {
    "key": "direction",
    "value": [
      "downlink",
      "uplink"
    ]
  }
]'

SORACOM API を利用するには、API キーと API トークンが必要です。詳しくは、API キーと API トークンの取り扱いについてを参照してください。
{group_id} は、Group:listGroups API で取得できます。
{namespace} は、SoracomOrbit です。
ボディで指定するプロパティについては、ボディで指定するプロパティについてを参照してください。

Orbit を有効化する

Group:putConfigurationParameters API を使用します。

$ curl -v -X PUT https://api.soracom.io/v1/groups/{group_id}/configuration/SoracomOrbit \
-H "X-Soracom-API-Key: $X_SORACOM_API_KEY" \
-H "X-Soracom-Token: $X_SORACOM_TOKEN" \
-H "Content-Type: application/json" \
-d '[
  {
    "key": "enabled",
    "value": true
  },
  {
    "key": "codeSrn",
    "value": "srn:soracom:OP0000000000:jp:Soralet:hello-soralet/$LATEST"
  },
  {
    "key": "useLocation",
    "value": true
  },
  {
    "key": "useMetadata",
    "value": true
  },
  {
    "key": "contentType",
    "value": "application/json"
  },
  {
    "key": "enabled",
    "value": true
  },
  {
    "key": "direction",
    "value": [
      "downlink",
      "uplink"
    ]
  }
]'

ボディで指定するプロパティについて

以下の key と value のペアを配列で指定します。

`key`	`value` の型	`value`
`enabled`	Boolean	Orbit の ON/OFF を設定します。 `true`: ON。Orbit を利用できます。 `false`: OFF
`codeSrn`	String	使用する WASM モジュールの SRN (SORACOM Resource Name) を設定します。
`useLocation`	Boolean	特定地域向け IoT SIM (plan-KM1) でのみ利用可能な簡易位置測位機能を使用するかを設定します。デフォルトは `false` です。plan-KM1 以外の SIM で true にしても位置情報は初得できません。 `true`: ON。簡易位置測位機能を使用します。 `false`: OFF
`useMetadata`	Boolean	リソースのメタデータ (タグなど) を使用するかを設定します。デフォルトは `false` です。 `true`: ON。リソースのメタデータ (タグなど) を使用します。 `false`: OFF
`contentType`	String	デバイスから送信するデータの Content Type を指定します。
`direction`	Array of strings	Soralet を利用する経路 (処理するデータの方向) を設定します。サービス開始時はこの設定を元に課金対象が決まりますのでご注意ください (たとえば `downlink` の処理が空だった場合も実行としてカウントされます)。 `uplink`: デバイスから SORACOM プラットフォーム方向のデータを処理します。 `downlink`: SORACOM プラットフォームからデバイス方向のデータを処理します。

想定していない値を指定した場合の動作は、定義されていません。SORACOM CLI / SORACOM API で設定を変更したあとで、SORACOM ユーザーコンソールで意図通りに設定されていることを確認してください。

ステップ 2: デバイスでデータを送受信してテストする

Unified Endpoint へデータを送信してください。

WASM モジュールのテストではデバイス発信ではないためリファレンスの WASM モジュールへの入力と同等のデータ (ただし body パラメータは payload) を指定していました。実機では body 部分のみ送信します。

curl コマンドの実行例は以下の通りです。

$ curl -v --header content-type:application/json http://uni.soracom.io \
    --data "{\"value\":23.54,\"name\":\"sorao\"}"

SORACOM Harvest を利用するとデバイスから送信したデータが uplink で想定通り変換されたかを容易に確認できます。

ログの確認

Orbit SDK の log 関数を利用すると WASM モジュールからログを出力できます。

ユーザーコンソール
SORACOM CLI
VS Code

ユーザーコンソールにログインし、[メニュー] → [SORACOM ORBIT] → [Soralet 管理] の順にクリックして、該当の Soralet を選択します。Logs タブで確認します。

ログの確認

soralets get-logs コマンドでを使用します。

$ soracom soralets get-logs --soralet-id my-soralet
[
        {
                "createdTime": 1592492659768,
                "message": "Hello from Soralet",
                "operatorId": "OP0000000000",
                "soraletId": "my-soralet",
                "version": 2
        },
        {
                "createdTime": 1592492685430,
                "message": "Hello from Soralet",
                "operatorId": "OP0000000000",
                "soraletId": "my-soralet",
                "version": 2
        }
]

引数

soralet-id: Soralet ID を指定します。

VS Code の Activity Bar の [] をクリックします。

SORACOM Orbit Tools ビューが表示されます。
Soralets パネルから対象の Soralet を展開します。
Soralet Logs パネルに最大 50 件のログが表示されます。Soralet Logs パネルのタイトルバーにある Open Current Logs as a New File ボタンをクリックすると新規ファイルとしてオープンできます。ログの形式は以下の通りです。

[yyyy-MM-dd hh:mm:ss] soralet-id/version: message