Soracom

MQTT エントリポイント URL (beam.soracom.io:1883) で MQTT で受けた通信を、MQTT または MQTTS で転送を行う設定です。

MQTT の Publish、Subscribe を、転送先となる MQTT ブローカーに転送します。MQTT ブローカーからのメッセージの Publish もデバイスに対して転送します。

MQTT エントリポイントを設定する

設定画面を表示する操作については、SORACOM Beam のエントリポイントを設定する を参照してください。MQTT エントリポイントで設定できる項目は以下のとおりです。

[認証情報]

転送先へのリクエストで利用する認証情報を設定します。

[オプション]

SORACOM CLI / SORACOM API の場合

グループ設定に Beam のエントリポイントを追加するコマンドについては、SORACOM Beam のエントリポイントを設定する の SORACOM CLI / SORACOM API の場合 を参照してください。

ここでは、HTTP エントリポイントを追加する場合のリクエストボディに指定する key と value のペアを説明します。

SORACOM CLI のコマンド例:

$ soracom groups put-config --group-id {group_id} --namespace SoracomBeam \
--body '[
  {
    "key": "mqtt://beam.soracom.io:1883",
    "value": {
      "name": "test",
      "enabled": true,
      "destination": "mqtts://mqtt.example.com/topicname",
      "username": "USERNAME",
      "password": "PASSWORD",
      "useClientCredentials": false,
      "useClientCert": true,
      "clientCerts": {
        "default": {
          "$credentialsId": "x509"
        }
      },
      "addSubscriberHeader": true,
      "replaceTopic": true,
      "version": "201912"
    }
  }
]'

MQTT エントリポイントの Object

以下の key と value を指定します。なお、この key と value のペアは、通常の JSON Object として指定します。

MQTT エントリポイントにリクエストする

Publish

ここでは、オープンソースとして提供されている MQTT メッセージブローカーである mosquitto-clients の mosquitto_pub を使用して Publish します。

$ sudo apt install mosquitto-clients

デバイスから Publish します。

$ mosquitto_pub -d -h beam.soracom.io -p 1883 -t test -m "Hello, World"

Client mosqpub/82534-MBP sending CONNECT
Client mosqpub/82534-MBP received CONNACK
Client mosqpub/82534-MBP sending PUBLISH (d0, q0, r0, m1, 'test', ... (12 bytes))
Client mosqpub/82534-MBP sending DISCONNECT

転送先の MQTT ブローカーで、以下のように表示されます。

1482290763: New connection from 52.198.xxx.xxx on port 8080.
1482290763: New client connected from 52.198.xxx.xxx as mosqpub/82534-MBP (c1, k60).
1482290763: Sending CONNACK to mosqpub/82534-MBP (0, 0)
1482290767: Received PUBLISH from mosqpub/82534-MBP (d0, q0, r0, m0, 'test/4401031********', ... (12 bytes))
1482290767: Received DISCONNECT from mosqpub/82534-MBP
1482290767: Client mosqpub/82534-MBP disconnected.

ここでは [IMSI 付与] をオンにしているため、トピックに IMSI が付与されています (test/4401031********)。

Subscribe

mosquitto-clients の mosquitto_sub を使ってデバイスから Beam へ Subscribe し、転送先の MQTT ブローカーからメッセージを Publish してみます。

1. デバイスで Subscribe します。

   $ mosquitto_sub -d -h beam.soracom.io -p 1883 -t test
   

   Client mosqsub/82586-MBP sending CONNECT
   Client mosqsub/82586-MBP received CONNACK
   Client mosqsub/82586-MBP sending SUBSCRIBE (Mid: 1, Topic: test, QoS: 0)
   Client mosqsub/82586-MBP received SUBACK
   Subscribed (mid: 1): 0
   

   Subscribe を受ける転送先 MQTT ブローカーで、以下のように表示されます。

   1482291094: New connection from 52.198.xxx.xxx on port 8080.
   1482291094: New client connected from 52.198.xxx.xxx as mosqsub/82586-MBP (c1, k60).
   1482291094: Sending CONNACK to mosqsub/82586-MBP (0, 0)
   1482291094: Received SUBSCRIBE from mosqsub/82586-MBP
   1482291094:     test (QoS 0)
   1482291094: mosqsub/82586-MBP 0 test
   1482291094: Sending SUBACK to mosqsub/82586-MBP
   

2. MQTT ブローカーに別のクライアントからメッセージを Publish します。

   1482291169: New connection from 127.0.0.1 on port 8080.
   1482291169: New client connected from 127.0.0.1 as mosqpub/3516-ip-10-0-0- (c1, k60).
   1482291169: Sending CONNACK to mosqpub/3516-ip-10-0-0- (0, 0)
   1482291169: Received PUBLISH from mosqpub/3516-ip-10-0-0- (d0, q0, r0, m0, 'test', ... (12 bytes))
   1482291169: Sending PUBLISH to mosqsub/82586-MBP (d0, q0, r0, m0, 'test', ... (12 bytes))
   1482291169: Received DISCONNECT from mosqpub/3516-ip-10-0-0-
   1482291169: Client mosqpub/3516-ip-10-0-0- disconnected.
   

   Publish されたメッセージを Beam 経由でデバイスが受け取り、以下のように表示されます。

   Client mosqsub/82586-MBP received PUBLISH (d0, q0, r0, m0, 'test', ... (12 bytes))
   Hello, World
   

MQTT エントリポイントに関する制限事項と注意事項

MQTT エントリポイントには以下の制限事項や注意事項があります。

• MQTT 接続時 (connect コマンド) のオプションについて
  • connect の keepalive に設定できる値は、0 または 5 以上 から 1200 以下の整数です。それ以外の値を設定した場合、connect リクエストに NOT_AUTHORIZED コードを返却します。
  • Beam では session の状態の保存を行っていませんが、MQTT ブローカーには clean session のパラメータをそのまま転送します。
• Beam は、無通信時 (一定時間通信がない場合) に TCP コネクションを切断します。
  • keepalive に 0 以外の値が設定されているとき、Beam は keepalive の 1.5 倍の時間、通信がない場合に TCP コネクションを切断します。
  • keepalive が 0 に設定されている場合、Beam は 30 分間通信がない場合に TCP コネクションを切断します。
• MQTT 接続中にセルラー通信のセッションが切断された場合、Beam との TCP セッションは不通になりますが、Beam ではそれを検知できません。

  • 端末側で常時接続するユースケースの場合は、keepalive を有効化するか、クライアント側でセルラー通信のセッション断を検知して再接続する仕組みの導入を強く推奨します。

    keepalive に 5 以上 1200 以下の整数を指定すると、keepalive が有効となり、セッション断を検知できます。keepalive を有効化するとクライアントが指定された間隔で PINGREQ パケットを送出します。

  • セルラー通信の切断は、SORACOM ユーザーコンソールまたは SORACOM API で IoT SIM のセッションを再確立する と再現できます。

• Beam 設定で種別を「Azure IoT Hub」または「Google Cloud IoT Core」 にして接続する場合は、トークンの有効期限が 1 時間で失効します。Azure を利用する場合は X.509 証明書で認証した接続 の利用も検討してください。

プラットフォームバージョン 201509 と 201912 の違い

MQTT エントリポイントの動作はプラットフォームバージョンによって異なります。 プラットフォームバージョンには 201912 (推奨) と 201509 (サポート終了予定) の 2 つがあります。

プラットフォームバージョン 201912 は、接続先ブローカーとの互換性・信頼性が向上しています。新たに MQTT エントリポイントを利用する場合は、201912 を選択してください。

課金対象メッセージ

デバイスと Beam、Beam と MQTT ブローカーの間でメッセージをやり取りしたときに、それぞれを個別に 1 リクエストとカウントし、リクエスト数に応じて課金されます (*1)。たとえば、クライアントからメッセージを 1 通 PUBLISH した場合、2 リクエストとカウントされます。

MQTT のバージョンおよび仕様に関する違い

転送先に接続するプロトコル

MQTT エントリポイントのプラットフォームバージョン変更時の注意事項

たとえば、以下のようなケースで、201912 へ変更後に接続エラーが発生することが報告されています。

クライアントが接続時に MQTT バージョンの指定をしていない場合 (特に Azure IoT Hub、Google IoT Core を利用している場合)

プラットフォームバージョン 201509 においては、クライアントが指定している MQTT バージョンに関わらず、ソラコムプラットフォームが MQTT バージョン 3.1.1 を使用して MQTT ブローカーに接続していました。

プラットフォームバージョン 201912 においては、アーキテクチャの変更によって、常にクライアントが指定する MQTT バージョンを使用して接続するように変更されました。そのため、クライアントが MQTT ブローカーが対応していない MQTT バージョン (3.1) を指定して接続した場合、接続エラーが発生します。また、デフォルトの MQTT バージョンが 3.1 になっている MQTT クライアントやデバイスが複数確認されています。

なお、MQTT バージョンの変更方法については MQTT クライアントやデバイスの取扱説明書を参照してください。

転送先に接続するプロトコルに MQTT を指定した状態で証明書を利用していた場合

プラットフォームバージョン 201509 においては、証明書 (key と cert) を利用している場合、転送先に接続するプロトコルの設定に関わらず MQTTS プロトコルで転送先に接続されます。

プラットフォームバージョン 201912 においては、証明書の利用有無に関わらず、転送先に指定されたプロトコルで接続します。

転送先のプロトコルが正しく設定されているかを事前に確認ください。