Soracom

Users

ドキュメント
Home ドキュメント SORACOM Air for Sigfox リファレンス

SORACOM サービスへ連携されるデータのフォーマット

Sigfox デバイスからのデータは以下の SORACOM サービスへ連携できます。

このドキュメントでは、各サービスへ連携されるデータのフォーマットを説明します。

データのフォーマット

SORACOM Air for Sigfox では、Sigfox デバイスからのセンサーデータ (HEX 文字列。例: 895c2fb3) と、管理用データ (Sigfox デバイスの ID、データ送信時刻など) を上記のサービスに連携します。Sigfox デバイスからのデータ (HEX 文字列) を SORACOM プラットフォームでデコードするには、バイナリパーサー を有効にしてください。

たとえば、バイナリパーサーの定義済みフォーマット @unashield を利用した場合、以下のようなデータが送信されます。

{
  "device": "Sigfox デバイスの ID",
  "time": "1621401862",
  "data": "895c2fb3",
  "seqNumber": "2651",
  "lqi": "Average",
  "operatorName": "SIGFOX_Japan_KCCS",
  "countryCode": "392",
  "ctr":8,
  "tmp":28.5,
  "vlt":3.3,
  "binaryParserEnabled": true
}

各パラメータの意味は以下の通りです。

パラメータ意味
deviceSigfox デバイスの ID
timeデータ送信時刻 (UNIX 時間 (秒))
dataSigfox デバイスからのデータ (HEX 文字列)
seqNumberデータの通し番号
lqiLink Quality Indicator (通信品質の指標)。Excellent, Good, Average, Limit の 4 レベル。各レベルの基準は Sigfox 社のドキュメント を参照してください。
operatorNameSigfox オペレーター名。日本の場合は SIGFOX_Japan_KCCS
countryCode国コード (ISO 3166-1 の 3 桁)。日本の場合は 392。
ctr (*1)、tmp (*1)、vlt (*1)data をバイナリパーサーでデコードしたデータ。パラメータはバイナリパーサーの定義によって異なります。
binaryParserEnabled (*1)true
  • (*1) バイナリパーサーが有効の場合にのみ含まれます。

各 SORACOM サービスにおけるフォーマットの違い

SORACOM Beam へ連携する場合

データのフォーマット に記載されたデータがリクエストの Body になります。リクエストの Header (ヘッダー) については エントリポイントリファレンス: Sigfox → HTTP/HTTPS エントリポイント | SORACOM Beam を参照してください。

SORACOM Funnel へ連携する場合

データのフォーマット に記載されたデータが、Funnel から送信されるデータフォーマット に記載されたフォーマットの payloads に入ります。

SORACOM Funk へ連携する場合

AWS Lambda

データのフォーマット に記載されたデータが、リファレンス: 送信するデータフォーマット | SORACOM Funk に記載されたフォーマットの event へ 入ります。また、クライアントコンテキスト内に以下のフォーマットが設定されます。

"custom": {
  "operatorId": "OP00XXXXXXXX",
  "coverage": "jp|g",
  "resourceType": "SigfoxDevice",
  "resourceId": "XXXXXX",
  "sourceProtocol": "sigfox",
  "srn": "srn:soracom:OP00XXXXXXXX:jp:Subscriber:44052XXXXXXXXXXX",
  "deviceId": "XXXXXX"
}

Azure Functions / Google Cloud Functions

データのフォーマット に記載されたデータが、body へ入ります。

SORACOM Harvest Data へ連携する場合

データのフォーマット に記載されたデータが連携されます。