Soracom

Users

ドキュメント
Home ドキュメント SORACOM Orbit リファレンス

WASM モジュールへの入力

uplink() と downlink() ともに WASM モジュールには以下の情報が渡されます。

{
  "codeSrn": "srn:soracom:<operator_id>:<coverage type>:Soralet:<soralet id>/<version>",
  "direction": "uplink",
  "contentType": "application/json",
  "encodingType": "plain", // or "base64"
  "body": "{\"value\":23.54,\"name\":\"test\"}", // soralets exec でテストする場合は body ではなく payload となります。
  "source": {
    "resourceType": "Subscriber",
    "resourceId": "0010100000000",
    "iccid": "xxxxx",
    "imei": "xxxxx",
    "ipAddress": "10.142.209.79",
    "msisdn": "8190xxxxxxxx",
    "operatorId": "OP0000000000"
  },
  "tags": {
    "name": "test1",
    "org": "soracom"
  },
  "location": {
    "lat": 43.12345,
    "lon": 138.112233
  },
  "timestamp": 1587532201856
}
  • codeSrn: 使用する WASM モジュールの SORACOM Resource Name (SRN)。

  • contentType: 入力の Content Type。

  • encodingType: (オプション) データのエンコーディング (plain または base64)。

  • source: デバイスの種類に応じた情報が渡されます。SORACOM Air for セルラーの IoT SIM にのみ対応しています。

    name戻り値
    resourceTypeリソースタイプ。IoT SIM の場合は Subscriber です。
    resourceIdリソース ID。resourceType が Subscriber の場合は、サブスクライバーの IMSI です。
    iccidICCID (Integrated Circuit Card ID)。IoT SIM を識別するための識別子です。
    imeiIMEI (International Mobile Equipment Identity)。
    ipAddressIoT SIM の IP アドレス。
    msisdnIoT SIM の MSISDN (Mobile Station International Subscriber Directory Number)。
    operatorIdオペレーター ID。
  • tags: データ送信元のリソースに付与されたタグ。WASM モジュールにタグの情報を渡すには、SIM グループ設定の [SORACOM Orbit 設定] → [メタデータ] にチェックを入れます。詳しくは、通信で WASM モジュールが使用されるように SIM グループを設定する を参照してください。

  • location: 簡易位置測位機能が利用可能な IoT SIM (plan-KM1) を利用している場合は緯度と経度。WASM モジュールに位置情報を渡すには、SIM グループ設定の [SORACOM Orbit 設定] → [簡易位置測位機能] にチェックを入れます。詳しくは、通信で WASM モジュールが使用されるように SIM グループを設定する を参照してください。

  • timestamp: SORACOM がデータを受信した UNIX 時間 (ミリ秒)。Sigfox と LoRaWAN デバイスについては body に含まれる時刻を使用してください。