使用方法: バイナリパーサーを設定する | バイナリパーサー

バイナリパーサーの設定は、SIM グループ、LoRaWAN グループ、Sigfox グループに対して行います。ここでは、SIM グループにバイナリパーサーを設定する操作を説明しますが、そのほかのグループでも同様に操作できます。

バイナリパーサーの設定はグループに対して行います

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

SIM グループ画面で [SORACOM Air for セルラー設定] をクリックします。
SIM グループ画面を表示する操作について詳しくは、グループの設定を変更するを参照してください。
- LoRaWAN グループにバイナリパーサーを設定する場合は、LoRaWAN グループ画面で [SORACOM Air for LoRaWAN 設定] をクリックします。
- Sigfox グループにバイナリパーサーを設定する場合は、Sigfox グループ画面 [SORACOM Air for Sigfox 設定] をクリックします。
[バイナリパーサー] をクリックして「ON」にします。
[フォーマット] に定義済みフォーマットまたはカスタムフォーマットを入力して、[保存] をクリックします。
Sigfox デバイスの設定例については、以下のページを参照してください。
IoT SIM、LoRaWAN デバイス、Sigfox デバイスが所属するグループを切り替えます。
バイナリパーサーの設定が完了しました。

SORACOM CLI / SORACOM API の場合

SORACOM CLI または SORACOM API を利用しても、バイナリパーサーを設定できます。

SORACOM CLI
SORACOM API

SORACOM CLI を利用するには、あらかじめ SORACOM CLI をインストールし、認証情報を保存してください。詳しくは、SORACOM CLI をインストールするを参照してください。
{group_id} は、soracom groups list (Group:listGroups API) で取得できます。
{namespace} は、SoracomAir です。
ボディで指定するプロパティについては、ボディで指定するプロパティについてを参照してください。
ここでは、グループの設定を変更する操作のみを説明します。グループの仕組みやグループを作成する操作について詳しくは、グループ設定を参照してください。

バイナリパーサーを設定する

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

$ soracom groups put-config --group-id {group_id} --namespace SoracomAir \
--body '[
  {
    "key": "binaryParserEnabled",
    "value": true
  },
  {
    "key": "binaryParserFormat",
    "value": "@sensit.v3"
  }
]'

SORACOM API を利用するには、API キーと API トークンが必要です。詳しくは、API キーと API トークンの取り扱いについてを参照してください。
{group_id} は、Group:listGroups API で取得できます。
{namespace} は、SoracomAir です。
ボディで指定するプロパティについては、ボディで指定するプロパティについてを参照してください。
ここでは、グループの設定を変更する操作のみを説明します。グループの仕組みやグループを作成する操作について詳しくは、グループ設定を参照してください。

バイナリパーサーを設定する

Group:putConfigurationParameters API を使用します。

$ curl -v -X PUT https://api.soracom.io/v1/groups/{group_id}/configuration/SoracomAir \
-H "X-Soracom-API-Key: $X_SORACOM_API_KEY" \
-H "X-Soracom-Token: $X_SORACOM_TOKEN" \
-H "Content-Type: application/json" \
-d '[
  {
    "key": "binaryParserEnabled",
    "value": true
  },
  {
    "key": "binaryParserFormat",
    "value": "@sensit.v3"
  }
]'

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

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

key value の型 value

`key`	`value` の型	`value`
`binaryParserEnabled`	Boolean	バイナリパーサーの ON/OFF を設定します。 `true`: ON `false`: OFF
`binaryParserFormat`	String	定義済みフォーマットまたはカスタムフォーマットを指定します。

binaryParserEnabled

Boolean

バイナリパーサーの ON/OFF を設定します。

true: ON
false: OFF

binaryParserFormat String 定義済みフォーマットまたはカスタムフォーマットを指定します。

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