バイナリパーサーの設定は、SIM グループ、LoRaWAN グループ、Sigfox グループに対して行います。ここでは、SIM グループにバイナリパーサーを設定する操作を説明しますが、そのほかのグループでも同様に操作できます。
バイナリパーサーの設定はグループに対して行います
ここでは、グループの設定を変更する操作のみを説明します。グループの仕組みやグループを作成する操作について詳しくは、グループ設定 を参照してください。
SIM グループ画面で をクリックします。
SIM グループ画面を表示する操作について詳しくは、グループの設定を変更する を参照してください。
- LoRaWAN グループに バイナリパーサーを設定する場合は、LoRaWAN グループ画面で をクリックします。
- Sigfox グループに バイナリパーサーを設定する場合は、Sigfox グループ画面 をクリックします。
をクリックして「ON」にします。
に 定義済みフォーマット または カスタムフォーマット を入力して、 をクリックします。
Sigfox デバイスの設定例については、以下のページを参照してください。
IoT SIM、LoRaWAN デバイス、Sigfox デバイスが所属するグループを切り替えます。
バイナリパーサーの設定が完了しました。
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 |
|---|---|---|
binaryParserEnabled | Boolean | バイナリパーサーの ON/OFF を設定します。
|
binaryParserFormat | String | 定義済みフォーマット または カスタムフォーマット を指定します。 |
想定していない値を指定した場合の動作は、定義されていません。SORACOM CLI / SORACOM API で設定を変更したあとで、SORACOM ユーザーコンソールで意図通りに設定されていることを確認してください。