Soracom

Users

ドキュメント

SORACOM Beam を有効化する

Beam を利用するには、グループ に Beam のエントリポイントを追加し、そのグループに IoT SIM や Sigfox デバイスなどを所属させます。

Beam の設定はグループに対して行います

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

  1. SIM グループ画面、LoRa グループ画面、Sigfox グループ画面、またはデバイスグループ画面で [SORACOM Beam 設定] をクリックします。

    各画面を表示する操作について詳しくは、グループの設定を変更する を参照してください。

  2. [+設定を追加する] をクリックして、エントリポイントの種類を選択し、各項目を設定します。

    選択できるエントリポイントは、グループの種類によって異なります。

    エントリポイント説明
    HTTP エントリポイントデバイスから HTTP リクエストを受け付け、HTTP もしくは HTTPS で転送先へリクエストを転送します。転送先としてパス (プロトコル、ホスト名、ポート番号、パス) を設定できます。任意の API エンドポイントに対して、リクエストを転送するユースケースに向いています。
    Web サイトエントリポイントデバイスから HTTP リクエストを受け付け、HTTP もしくは HTTPS で転送先へリクエストを転送します。転送先としてホスト (プロトコル、ホスト名、ポート番号) を設定して、すべてのパスに転送できます。デバイスの状況に応じて、転送先のパスを変更するユースケースに向いています。
    MQTT エントリポイントデバイスからの MQTT セッションを受け付け、指定の MQTT ブローカーへの MQTT もしくは MQTTS セッションをプロキシします。
    TCP → TCP/TCPS エントリポイントデバイスから TCP パケットを受け付け、TCP もしくは TCPS で転送先へパケットを転送します。
    TCP → HTTP/HTTPS エントリポイントデバイスから TCP パケットを受け付け、メッセージを HTTP もしくは HTTPS リクエストに変換して転送先に転送します。
    UDP → HTTP/HTTPS エントリポイントデバイスから UDP パケットを受け付け、メッセージを HTTP もしくは HTTPS リクエストに変換して転送先に転送します。
    SMS → HTTP/HTTPS エントリポイントデバイスから SMS を受け付け、メッセージを HTTP もしくは HTTPS リクエストに変換して転送先に転送します。
    USSD → HTTP/HTTPS エントリポイント (*1)デバイスから USSD を受け付け、メッセージを HTTP もしくは HTTPS リクエストに変換して転送先に転送します。
    • (*1) グローバルカバレッジの SIM グループにのみ設定できます。
    エントリポイント説明
    LoRaWAN → HTTP/HTTPS エントリポイントLoRaWAN で通信しているデバイスからの通信を受け、メッセージを HTTP もしくは HTTPS リクエストに変換して転送先に転送します。

    SORACOM Air for LoRaWAN は、日本カバレッジでのみ利用できるサービスです。

    エントリポイント説明
    Sigfox → HTTP/HTTPS エントリポイントSigfox デバイスからの通信を受け、メッセージを HTTP もしくは HTTPS リクエストに変換して転送先に転送します。
    エントリポイント説明
    Inventory → HTTP/HTTPS エントリポイントInventory で管理するデバイスからの更新通知 (Observe しているデータ) を受け、メッセージを HTTP もしくは HTTPS リクエストに変換して転送先に転送します。
  3. [保存] をクリックします。

  4. IoT SIM、LoRaWAN デバイス、Sigfox デバイス、Inventory デバイスが所属するグループを切り替えます。

    Beam の設定が完了しました。

SORACOM CLI / SORACOM API の場合

SORACOM CLI または SORACOM API を利用しても、Beam を有効化できます。

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

Beam を有効化する

soracom groups put-config (Group:putConfigurationParameters API) を使用して、enabledtrue のエントリポイントを追加すると、Beam が有効化されます。

HTTP エントリポイント を追加する場合:

$ soracom groups put-config --group-id {group_id} --namespace SoracomBeam \
--body '[
  {
    "key": "http://beam.soracom.io:8888/",
    "value": {
      "name": "test",
      "enabled": true,
      "destination": "https://beamtest.soracom.io/",
      "addSubscriberHeader": true,
      "addSimIdHeader": true,
      "addMsisdnHeader": true,
      "addEquipmentHeader": true,
      "addSignature": true,
      "psk": {
        "$credentialsId": "CredentialsID"
      },
      "customHeaders": {
        "X-GROUP-NAME": {
          "action": "replace",
          "headerKey": "X-GROUP-NAME",
          "headerValue": "TEST"
        }
      }
    }
  }
]'
  • SORACOM API を利用するには、API キーと API トークンが必要です。詳しくは、API キーと API トークンの取り扱いについて を参照してください。
  • {group_id} は、Group:listGroups API で取得できます。
  • {namespace} は、SoracomBeam です。
  • ボディで指定するプロパティは、使用するエントリポイントによって異なります。エントリポイントについては、SORACOM Beam を有効化する を参照してください。
  • ここでは、グループの設定を変更する操作のみを説明します。グループの仕組みやグループを作成する操作について詳しくは、グループ設定 を参照してください。

Beam を有効化する

Group:putConfigurationParameters API を使用して、enabledtrue のエントリポイントを追加すると、Beam が有効化されます。

HTTP エントリポイント を追加する場合:

$ curl -v -X PUT https://api.soracom.io/v1/groups/{group_id}/configuration/SoracomBeam \
-H "X-Soracom-API-Key: $X_SORACOM_API_KEY" \
-H "X-Soracom-Token: $X_SORACOM_TOKEN" \
-H "Content-Type: application/json" \
-d '[
  {
    "key": "http://beam.soracom.io:8888/",
    "value": {
      "name": "test",
      "enabled": true,
      "destination": "https://beamtest.soracom.io/",
      "addSubscriberHeader": true,
      "addSimIdHeader": true,
      "addMsisdnHeader": true,
      "addEquipmentHeader": true,
      "addSignature": true,
      "psk": {
        "$credentialsId": "CredentialsID"
      },
      "customHeaders": {
        "X-GROUP-NAME": {
          "action": "replace",
          "headerKey": "X-GROUP-NAME",
          "headerValue": "TEST"
        }
      }
    }
  }
]'