受信 MQTT アダプタと送信 MQTT アダプタの設定
ここでは、MQTT の受信および送信アダプタの設定に関するリファレンス情報を提供します。
"プロダクションの管理" の “すべてのプロダクションに含まれる設定” も参照してください。
まとめ
MQTT アダプタには以下の設定があります。
グループ | 設定 |
---|---|
MQTT | [クリーン・セッション]、[認証情報名]、[クライアント ID]、[接続タイムアウト]、[キープ・アライブ]、[LWT トピック]、[LWT メッセージ]、[QOS]、[保持]、[SSL 構成名]、[タイムアウト]、[トピック]、[トレース]、[トレース・レベル]、[URL] |
残りの設定はすべてのビジネス・サービスに共通のものです。詳細は、“すべてのビジネス・サービスに含まれる設定” を参照してください。
クリーン・セッション
ブローカに対するセッションでクリーン・セッションを使用するかどうかを決定します。
クライアント ID
ブローカに対してこのクライアントを特定する文字列です。ASCII でエンコードされ、長さが 1 ~ 23 文字である必要があります。
これを指定しないと、クライアントによって一意の ID が作成されます。
接続タイムアウト
接続タイムアウトです。ビジー・サーバに接続すると時間がかかり、このタイムアウトを使用して、早期接続障害を回避できます。接続の試行が失敗となるまでの待機秒数を指定します。
認証情報名
MQTT ブローカへのアクセスに使用される認証情報の値セットの ID 名です。認証情報項目で定義されるユーザ名とパスワードは ASCII でエンコードされる必要があります。ブローカでログイン認証情報が不要な場合、これは必要ありません。
キープ・アライブ
クライアントからブローカへのメッセージの最大間隔 (秒数) を指定します。
LWT トピック
LWT (Last Will and Testament、遺言) トピックです。指定する場合、ASCII でエンコードする必要があります。ネットワーク・エラーによりクライアントが切断された場合、LWTMessage は LWTTopic のサブスクライバに配信されます。
LWT メッセージ
LWT (Last Will and Testament、遺言) メッセージです。指定する場合、ASCII でエンコードする必要があります。
QOS
必要なサービス品質を特定します。以下の 2 つの値のいずれかとなります。
-
0 — QOSFireAndForget、ブローカからの応答を待機しません。
-
1 — QOSWaitForDelivery、ブローカからの応答を待機し、応答がなければエラーを発行します。
保持
ブローカに、メッセージを保持する必要があるかどうかを示すフラグです。
SSL 構成名
ブローカとの通信に使用する TLS 構成の ID 名です。TLS 通信が必要な場合にのみ使用されます。
TLS の使用時は、証明書ファイルへの相対パスではなく、絶対パスを使用する必要があります。詳細は、"セキュリティ管理ガイド" の “TLS 構成の作成または編集” を参照してください。
タイムアウト
メッセージの送信 (確認応答) または受信を待機する秒数で表されるタイムアウト値です。
トピック
発行または購読するトピックの名前です。トピックは ASCII でエンコードする必要があります。トピックは通常、サブトピックのレベルが / (スラッシュ) で区切られた階層文字列です。サブスクリプションでは、トピックにトピック・レベルとしてワイルドカードを含めることができます。
-
+ (プラス記号) — そのレベルのすべての文字列に一致します。例えば、"/temperatures/+/highest" は、トピック "temperatures/Paris/highest" や "temperatures/Bangkok/highest" に一致しますが、"temperatures/Paris/highest/today" には一致しません。プラス記号は、同じレベル内の他の文字と組み合わせることはできません。
-
# (シャープ記号) — 最後のレベルのみで、任意の文字列および任意のサブトピックに一致します。例えば、"temperatures/Paris/#" は、"temperatures/Paris/highest"、"temperatures/Paris/highest/today"、"temperatures/Paris/lowest/record/thiscentury" のトピックすべてに一致します。
トレース
MQTT トレース機能を有効または無効にします。MQTT トレース・メッセージは、ビジネス・サービスまたはオペレーションのプロダクション・ログに書き込まれます。
トレース・レベル
MQTT ライブラリのトレース・レベルです。これを設定すると、トレース情報の必要な詳細がログに記録されます。トレース・レベルでは以下の値を扱うことができます。これらは %Net.MQTT インクルード・ファイルで定義されます。
-
0 — MQTTCLIENTTRACEMAXIMUM、最大レベルのトレース。
-
1 — MQTTCLIENTTRACEMEDIUM、中レベルのトレース。
-
2 — MQTTCLIENTTRACEMINIMUM、最小レベルのトレース。
-
3 — MQTTCLIENTTRACEPROTOCOL、プロトコル・レベルのトレース。
-
4 — MQTTCLIENTTRACEERROR、エラーのみのトレース。
-
5 — MQTTCLIENTTRACESEVERE、サーバ・エラーのみのトレース。
-
6 — MQTTCLIENTTRACEFATAL、致命的なエラーのみのトレース。
URL
通信するブローカの URL です。“tcp” または “ssl” の後にドメイン名とポートを “:” で区切って続けます (例 : “tcp://BIGBADAPPLE.local:1883”)。通常、TLS 対応のエンド・ポイントは 8883 のポートを使用して構成されますが、これは必須ではありません。URL は ASCII でエンコードする必要があります。