Soracom

GPS マルチユニットの 動作モード は、ユーザーコンソールだけでなく、SORACOM CLI や SORACOM API でも設定できます。動作モードは、グループ設定と IoT SIM のタグに保存されます。このページでは、動作モードが保存されるしくみと、SORACOM CLI で動作モードを設定する手順を説明します。

動作モードが保存されるしくみ

ユーザーコンソールの [GPS マルチユニットの設定変更] 画面で [保存] をクリックすると、以下の設定が保存されます。SORACOM CLI / SORACOM API で同じ設定を保存すると、ユーザーコンソールで動作モードを設定した場合と同じように GPS マルチユニットを利用できます。

SORACOM CLI で動作モードを設定する

1. グループを作成します。

   soracom groups create (Group:createGroup API) を使用します。既存のグループを利用する場合は、この手順は不要です。

   $ soracom groups create --body '{"tags": {"name": "gps-multiunit-group"}}'
   

   レスポンスに含まれる groupId を控えます。以降の手順では、{group_id} と記載します。

   動作モードはグループに保存されます

   同じグループに所属する IoT SIM を利用する GPS マルチユニットは、すべて同じ動作モードで動作します。複数の GPS マルチユニットを異なる動作モードで利用する場合は、GPS マルチユニットごとにグループを作成してください。

2. グループに、動作モードとメタデータサービスの設定を保存します。

   soracom groups put-config (Group:putConfigurationParameters API) を使用します。以下は、次の動作モードを設定する例です。

   • [送信内容]: [位置情報（GPS）]、[温度]、[湿度]、[バッテリー残量]
   • [送信モード]: [定期送信 - 手動モード] (月曜日から金曜日の 9:00 から 17:00 まで、30 分間隔で送信)
   • [設定取得モード]: [定期設定取得 - あり] (毎日 2:00 から 3:00 までの間に取得)
   • [加速度割り込み]: あり (しきい値: 1240)

   $ soracom groups put-config --group-id {group_id} --namespace SoracomAir \
   --body '[
     {
       "key": "userdata",
       "value": {
         "SensorData": {
           "acc": { "i1": "OFF" },
           "loc": { "i1": "ON" },
           "tem": { "i1": "ON" },
           "hum": { "i1": "ON" },
           "bat": { "i1": "ON" }
         },
         "Setting": { "itr": { "i2": 1240 } },
         "Common": {
           "C1": ["null", "null", "null", "null", "null", "1981/04/01", "1981/04/01", "1981/04/01", "null", "null"],
           "C2": ["null", "null", "null", "null", "null", "2059/12/31", "2059/12/31", "2059/12/31", "null", "null"],
           "C3": ["null", "null", "null", "null", "null", "09:00", "02:00", "00:00", "null", "null"],
           "C4": ["null", "null", "null", "null", "null", "17:00", "03:00", "23:59", "null", "null"],
           "C5": [-20000, -20000, -20000, -20000, -20000, 30, 1440, 2160, -20000, -20000],
           "C6": ["null", "null", "null", "null", "null",
             ["null", "MON", "TUE", "WED", "THU", "FRI", "null"],
             ["SUN", "MON", "TUE", "WED", "THU", "FRI", "SAT"],
             ["SUN", "MON", "TUE", "WED", "THU", "FRI", "SAT"],
             "null", "null"],
           "C7": "5,6,7"
         }
       }
     },
     {
       "key": "metadata",
       "value": {
         "enabled": true,
         "minimizeResponseBody": false,
         "allowOrigin": "",
         "readonly": true
       }
     }
   ]'
   

   userdata に指定する JSON について詳しくは、userdata の仕様 を参照してください。

   既存のメタデータサービス設定を上書きしないでください

   すでにメタデータサービスを設定しているグループでは、metadata の enabled 以外のプロパティ (minimizeResponseBody、allowOrigin、readonly) は、既存の設定に合わせてください。既存の設定は、soracom groups get (Group:getGroup API) で確認できます。

3. Harvest Data にデータを保存するかどうかに応じて、グループの SORACOM Harvest Data 設定を変更します。

   soracom groups put-config (Group:putConfigurationParameters API) を使用します。Harvest Data にデータを保存する場合は enabled に true を、保存しない場合は false を指定します。

   $ soracom groups put-config --group-id {group_id} --namespace SoracomHarvest \
   --body '[{"key": "enabled", "value": true}]'
   

   Harvest Data を有効にすると利用料金が発生します

   Harvest Data は、利用料金が発生します。詳しくは、SORACOM Harvest を参照してください。既存のグループを利用する場合は、Harvest Data にデータを保存しないときも enabled の値を確認し、意図せず true のままにならないようにしてください。

4. GPS マルチユニットで利用する IoT SIM を、グループに所属させます。

   soracom subscribers set-group (Subscriber:setGroup API) を使用します。

   $ soracom subscribers set-group --imsi {imsi} --group-id {group_id}
   

5. IoT SIM に soracom.gadgets タグを設定します。

   soracom subscribers put-tags (Subscriber:putSubscriberTags API) を使用します。

   $ soracom subscribers put-tags --imsi {imsi} \
   --body '[{"tagName": "soracom.gadgets", "tagValue": "GPS-Multiunit"}]'
   

   SIM ID を指定してタグを設定する場合は、soracom sims put-tags (Sim:putSimTags API) も利用できます。詳しくは、IoT SIM にタグを設定する を参照してください。

6. 設定内容を GPS マルチユニットにダウンロードします。

   動作モードは、GPS マルチユニットが設定内容をダウンロードしたときに反映されます。詳しくは、ステップ 2: 設定内容を GPS マルチユニットにダウンロードする を参照してください。

userdata の仕様

userdata には、GPS マルチユニットが解釈する動作モードの設定データを JSON で指定します。userdata に保存した設定データは、ユーザーコンソールのグループの設定画面 ([SORACOM Air for セルラー設定] の [ユーザーデータ]) でも確認できます。詳しくは、メタデータサービスを設定する を参照してください。

設定データは、以下の 3 つのプロパティで構成されます。

SensorData

センサーデータの種類ごとに、送信の有効 / 無効を、文字列 "ON" / "OFF" で指定します。

Setting

加速度割り込みのしきい値を指定します。

加速度割り込みを利用するには、しきい値の指定に加えて、Common の C7 に 7 を含めます。

Common

GPS マルチユニットは、データの送信や設定の取得のスケジュールを「シナリオ」という単位で管理します。シナリオには 0 から 9 の番号が割り当てられていて、それぞれの用途は以下のとおりです。

Common の C1 から C6 は、要素数 10 の配列です。配列のインデックス (0～9) がシナリオ番号に対応します。たとえば、C5 の 6 番目の要素 (インデックス 5) は、シナリオ 5 (定期送信 - 手動モード) の送信間隔です。C7 には、有効化するシナリオ番号を指定します。

C7 に指定する値

C7 には、ユーザーコンソールの設定項目に応じて、以下の値をカンマで連結した文字列を指定します。

指定例:

設定例

ユーザーコンソールで、以下の動作モード (初期設定) を保存した場合の userdata は、以下のとおりです。

• [送信内容]: [位置情報（GPS）]、[温度]、[湿度]、[バッテリー残量]
• [送信モード]: [定期送信 - 手動モード] (常に、10 分間隔で送信)
• [設定取得モード]: [定期設定取得 - あり] (毎日 2:00 から 3:00 までの間に取得)
• [加速度割り込み]: なし

{
  "SensorData": {
    "acc": { "i1": "OFF" },
    "loc": { "i1": "ON" },
    "tem": { "i1": "ON" },
    "hum": { "i1": "ON" },
    "bat": { "i1": "ON" }
  },
  "Setting": { "itr": { "i2": 2048 } },
  "Common": {
    "C1": ["null", "null", "null", "null", "null", "1981/04/01", "1981/04/01", "1981/04/01", "null", "null"],
    "C2": ["null", "null", "null", "null", "null", "2059/12/31", "2059/12/31", "2059/12/31", "null", "null"],
    "C3": ["null", "null", "null", "null", "null", "00:00", "02:00", "00:00", "null", "null"],
    "C4": ["null", "null", "null", "null", "null", "23:59", "03:00", "23:59", "null", "null"],
    "C5": [-20000, -20000, -20000, -20000, -20000, 10, 1440, 2160, -20000, -20000],
    "C6": ["null", "null", "null", "null", "null",
      ["SUN", "MON", "TUE", "WED", "THU", "FRI", "SAT"],
      ["SUN", "MON", "TUE", "WED", "THU", "FRI", "SAT"],
      ["SUN", "MON", "TUE", "WED", "THU", "FRI", "SAT"],
      "null", "null"],
    "C7": "5,6"
  }
}

動作モードの設定を解除する

ユーザーコンソールの [設定削除] と同じ操作を、SORACOM CLI で行うには、IoT SIM の soracom.gadgets タグを削除して、IoT SIM をグループから解除します。

$ soracom subscribers delete-tag --imsi {imsi} --tag-name soracom.gadgets
$ soracom subscribers unset-group --imsi {imsi}

SORACOM API を利用する場合は、Subscriber:deleteSubscriberTag API と Subscriber:unsetGroup API を使用します。