MQTT-SN ゲートウェイ

MQTT-SN（MQTT for Sensor Networks）は、ワイヤレスセンサーネットワーク向けの軽量なパブリッシュ／サブスクライブプロトコルです。EMQX MQTT-SN ゲートウェイは、これらのデバイスが EMQX に接続し通信できるようにし、MQTT-SN と標準 MQTT プロトコル間の橋渡しを行います。

本ページでは、EMQX における MQTT-SN ゲートウェイの設定および使用方法を紹介します。

TIP

MQTT-SN ゲートウェイは MQTT-SN v1.2 に基づいています。

MQTT-SN ゲートウェイの有効化

EMQX 5.0 では、MQTT-SN ゲートウェイはダッシュボード、REST API、設定ファイル base.hocon を通じて設定および有効化できます。本節では、ダッシュボードによる設定を例に操作手順を説明します。

EMQX ダッシュボードの左ナビゲーションメニューで Management -> Gateways をクリックします。Gateways ページにはサポートされているすべてのゲートウェイが一覧表示されます。MQTT-SN を探し、Actions 列の Setup をクリックすると、Initialize MQTT-SN ページに遷移します。

TIP

EMQX をクラスターで稼働している場合、ダッシュボードや REST API で行った設定はクラスター全体に影響します。特定のノードだけ設定を変更したい場合は、base.hocon で設定してください。

設定を簡略化するために、EMQX は Gateways ページのすべての必須フィールドにデフォルト値を用意しています。大幅なカスタマイズが不要な場合は、3クリックで MQTT-SN ゲートウェイを有効化できます。

1. Basic Configuration タブで Next をクリックし、すべてのデフォルト設定を受け入れます。
2. 続いて Listeners タブに遷移し、EMQX は UDP リスナーをポート 1884 で事前設定しています。再度 Next をクリックして設定を確認します。
3. 最後に Enable ボタンをクリックして MQTT-SN ゲートウェイを有効化します。

ゲートウェイの有効化が完了すると、Gateways ページに戻り、MQTT-SN ゲートウェイのステータスが Enabled と表示されていることを確認できます。

上記の設定は REST API でも実行可能です。

例:

curl -X 'PUT' 'http://127.0.0.1:18083/api/v5/gateways/mqttsn' \
  -u <your-application-key>:<your-security-key> \
  -H 'Content-Type: application/json' \
  -d '{
  "name": "mqttsn",
  "enable": true,
  "gateway_id": 1,
  "mountpoint": "mqttsn/",
  "listeners": [
    {
      "type": "udp",
      "bind": "1884",
      "name": "default",
      "max_conn_rate": 1000,
      "max_connections": 1024000
    }
  ]
}'

詳細な REST API の説明は REST API - Gateway を参照してください。

カスタマイズが必要で、リスナーの追加や認証ルールの設定を行いたい場合は、MQTT-SN ゲートウェイのカスタマイズ セクションをお読みください。

MQTT-SN クライアントとの連携

クライアントライブラリ

MQTT-SN ゲートウェイを構築した後は、MQTT-SN クライアントツールを使って接続テストを行い、正常に動作しているか確認できます。以下は推奨される MQTT-SN クライアントツールの一例です。

• paho.mqtt-sn.embedded-c
• mqtt-sn-tools

パブリッシュ／サブスクライブ

MQTT-SN プロトコルはすでにパブリッシュ／サブスクライブの動作を定義しています。例として：

• MQTT-SN プロトコルの PUBLISH メッセージはパブリッシュ操作に使用され、このメッセージでトピックと QoS が指定されます。
• SUBSCRIBE メッセージはサブスクライブ操作に使用され、トピックと QoS の両方がこのメッセージで指定されます。
• UNSUBSCRIBE メッセージはサブスクライブ解除操作に使用され、トピックがこのメッセージで指定されます。

MQTT-SN ゲートウェイのカスタマイズ

デフォルト設定に加え、EMQX はさまざまな設定オプションを提供し、特定のビジネス要件により適合させることができます。本節では、Gateways ページで利用可能な各種フィールドについて詳しく解説します。

基本設定

Basic Configuration タブでは、ゲートウェイ ID のカスタマイズ、事前定義トピックリストの設定、ゲートウェイの MountPoint 文字列の設定が可能です。以下のスクリーンショット下の説明を参照してください。

• Gateway ID：ゲートウェイの一意の識別子を設定します。例：1。

• Enable Broadcast：ゲートウェイがゲートウェイ広告をクライアントにブロードキャストするかどうかを設定します。ブロードキャストされるメッセージには先ほど指定した Gateway ID が含まれます。デフォルト：true。選択肢：true、false。

• Enable QoS 3：QoS -1 とも呼ばれ、確認応答やサブスクライブを必要としない基本的なクライアントが PUBLISH メッセージをゲートウェイに送信するための設定です。デフォルト：true。選択肢：true、false。

• Idle Timeout：非アクティブ状態が続いた後、MQTT-SN クライアントを切断済みとみなすまでの秒数を設定します。デフォルト：30s。

• Enable Statistics：ゲートウェイが統計情報を収集・報告するかどうかを設定します。デフォルト：true。選択肢：true、false。

• Predefined Topic List：事前定義されたトピック ID と対応するトピック名を設定します。Add をクリックして新しいエントリを追加できます。

  • Topic ID：トピック ID を設定します。1〜65535 の整数である必要があります。
  • Topic：トピック名を設定します。

• MountPoint：パブリッシュやサブスクライブ時にすべてのトピックの前に付加される文字列を設定します。これにより異なるプロトコル間でのメッセージルーティングの分離を実現できます。例：mqttsn/。

  注意：このトピックプレフィックスはゲートウェイによって管理されます。MQTT-SN クライアントはパブリッシュやサブスクライブ時に明示的にこのプレフィックスを付加する必要はありません。

リスナーの追加

デフォルトで、名前が default の UDP リスナーがポート 1884 に設定されており、1秒あたり最大1,000接続、同時最大1,024,000接続をサポートしています。Settings をクリックすると詳細設定が可能で、Delete でリスナーを削除、+ Add Listener で新規リスナーを追加できます。

Add Listener をクリックすると Add Listener ページが開き、以下の設定が行えます。

基本設定

• Name：リスナーの一意の識別子を設定します。
• Type：プロトコルタイプを選択します。MQTT-SN では udp または dtls が選択可能です。
• Bind：リスナーが接続を受け付けるポート番号を設定します。
• MountPoint（任意）：パブリッシュやサブスクライブ時にすべてのトピックの前に付加される文字列を設定し、異なるプロトコル間でのメッセージルーティング分離を実現します。

リスナー設定

• Acceptor（DTLS リスナーのみ）：アクセプタプールのサイズを設定します。デフォルト：16。
• Max Connections：リスナーが処理可能な同時接続の最大数を設定します。デフォルト：1024000。
• Max Connection Rate：リスナーが1秒あたりに受け入れ可能な新規接続の最大レートを設定します。デフォルト：1000。

UDP 設定

• ActiveN：ソケットの {active, N} オプションを設定します。これはソケットが能動的に処理できる受信パケット数を示します。詳細は Erlang Documentation - setopts/2 を参照してください。
• Buffer：送受信パケットを格納するバッファのサイズを KB 単位で設定します。
• Receive Buffer：受信バッファのサイズを KB 単位で設定します。
• Send Buffer：送信バッファのサイズを KB 単位で設定します。
• SO_REUSEADDR：ローカルでのポート番号再利用を許可するかどうかを設定します。

DTLS 設定（DTLS リスナーのみ）

TLS Verify の有効化はトグルスイッチで設定可能ですが、その前に関連する TLS Cert、TLS Key、CA Cert の情報をファイル内容の入力または Select File ボタンでアップロードして設定する必要があります。詳細は Enable SSL/TLS Connections を参照してください。

続いて以下の設定が可能です。

• DTLS Versions：サポートする DTLS バージョンを設定します。デフォルトは dtlsv1.2 と dtlsv1。
• Fail If No Peer Cert：クライアントが空の証明書を送信した場合に EMQX が接続を拒否するかどうかを設定します。デフォルト：false。選択肢：true、false。
• Intermediate Certificate Depth：ピア証明書に続く有効な認証パスに含まれる自己発行でない中間証明書の最大数を設定します。デフォルト：10。
• Key Password：プライベートキーがパスワード保護されている場合に使用するパスワードを設定します。

認証の設定

MQTT-SN プロトコルの接続メッセージはクライアントの Client ID のみを提供するため、MQTT-SN ゲートウェイは HTTP サーバ認証 のみをサポートしています。

クライアント情報の生成ルールは以下の通りです。

• Client ID：CONNECT メッセージの Client ID フィールドを使用。
• Username：未定義
• Password：未定義

ここではダッシュボードを例に認証設定方法を説明します。

Gateways ページで MQTT-SN を探し、Actions 列の Setup をクリックし、続けて Authentication タブに入ります。

Create Authentication をクリックし、Mechanism に Password-Based を選択、Backend に HTTP Server を選択します。続いて Configuration タブで認証ルールを設定します。

各フィールドの詳細は HTTP サーバ認証 を参照してください。

上記の設定は REST API でも実行可能です。

例:

curl -X 'POST' 'http://127.0.0.1:18083/api/v5/gateway/mqttsn/authentication' \
  -u <your-application-key>:<your-security-key> \
  -H 'Content-Type: application/json' \
  -d '{
  "method": "post",
  "url": "http://127.0.0.1:8080",
  "headers": {
    "content-type": "application/json"
  },
  "body": {
    "clientid": "${clientid}"
  },
  "pool_size": 8,
  "connect_timeout": "5s",
  "request_timeout": "5s",
  "enable_pipelining": 100,
  "ssl": {
    "enable": false,
    "verify": "verify_none"
  },
  "backend": "http",
  "mechanism": "password_based",
  "enable": true
}'