すべてのプロダクト
Search
ドキュメントセンター

:通信にカスタムトピックを使用する

最終更新日:Feb 06, 2024

カスタムトピックカテゴリは、製品内のすべてのデバイスのトピックをカバーします。 このトピックでは、製品のカスタムトピックカテゴリを定義する方法と、通信にカスタムトピックを使用する方法について説明します。

背景情報

トピックの定義方法と使用方法については、「トピック」をご参照ください。

カスタムトピックカテゴリの追加

  1. IoT Platform コンソールにログインします。

  2. [概要] ページで、[すべての環境] をクリックします。 [すべての環境] タブで、管理するインスタンスを見つけ、インスタンスIDまたはインスタンス名をクリックします。

  3. 左側のナビゲーションウィンドウで、[デバイス] > [製品] を選択します。

  4. [製品] ページで、カスタムトピックカテゴリを追加する製品を見つけて、[表示] をクリックします。

  5. [製品の詳細] ページで、[トピックカテゴリ] > [トピックカテゴリ] > [トピックカテゴリの編集] を選択します。

  6. [トピックカテゴリの編集] ダイアログボックスでパラメーターを設定し、[OK] をクリックします。 下表に、各パラメーターを説明します。

    パラメーター

    説明

    デバイス操作権限

    トピックカテゴリのデバイスの権限。 有効な値: PublishSubscribePublish and Subscribe

    Topic カテゴリ

    トピックカテゴリは、複数のフィールドで構成されます。 フィールドをスラッシュ (/) で区切ります。 名前には、英数字、アンダースコア (_) を使用できます。 トピックカテゴリの各フィールドは空にすることはできません。

    • クラウドゲートウェイ製品を使用する場合、プレフィックスは自動的に指定されません。 パラメーターにカスタム値を指定する必要があります。 値には、プラス記号 (+) と数値記号 (#) を含むワイルドカード文字を含めることができます。 ${deviceName} 変数を使用して、DeviceNameを指定できます。

    • クラウドゲートウェイ以外の製品を使用する場合は、次の項目に注意してください。

      • トピックカテゴリの [Device Operation Authorizations] パラメーターを [Subscribe] に設定した場合、トピックカテゴリにプラス記号 + と数字記号 (#) のワイルドカード文字を指定して、デバイスが複数のトピックを同時にサブスクライブできるようにすることができます。

      • /${productKey}/${deviceName}/user/ は、パラメーターの値のプレフィックスとして自動的に指定されます。 トピックカテゴリのカスタム名のみを指定する必要があります。

    説明

    ワイルドカード文字の使用方法の詳細については、「ワイルドカード文字を使用したカスタムトピック」をご参照ください。

    委任サブスクリプションの有効化

    このパラメーターは、デバイス操作権限パラメーターを [サブスクライブ] または [パブリッシュおよびサブスクライブ] に設定した場合にのみ使用できます。

    委任されたサブスクリプションが有効になっている場合、IoT Platformは、製品のデバイスがIoT Platformに接続されているときにデバイスがサブスクリプションを完了するのを支援します。

    圧縮または解凍を有効にする

    Exclusive Enterprise Editionインスタンスのカスタムトピックのデータ圧縮と解凍を有効にできます。 この機能の詳細については、「データ圧縮」をご参照ください。

    説明

    トピックカテゴリの説明。 このパラメーターを設定して、さまざまなトピックカテゴリの機能を区別できます。

トピックカテゴリの管理

[トピックカテゴリ] タブで、カスタムトピックカテゴリを見つけます。 トピックカテゴリに対して複数の操作を実行できます。 次の表に操作を示します。

操作

手順

トピックカテゴリの変更

  1. [操作] 列の [編集] をクリックします。

  2. [トピックカテゴリの編集] ダイアログボックスで、[デバイス操作権限][トピックカテゴリ] 、および [説明] パラメーターを変更します。

  3. 表示されたメッセージボックスで、[OK] をクリックします。

トピックカテゴリの削除

警告

カスタムトピックカテゴリを削除すると、そのカスタムトピックカテゴリに関連する通信サービスが利用できなくなります。 これはあなたのビジネスを中断するかもしれません。 作業は慎重に行ってください。

  1. [アクション] 列の [削除] をクリックします。

  2. 表示されたメッセージボックスで、[OK] をクリックします。

委任サブスクリプションを有効にするかどうかを指定する

[デバイス操作許可] パラメーターが [サブスクライブ] または [パブリッシュとサブスクライブ] に設定されているトピックカテゴリを見つけ、image.pngをオフにするか、[委任サブスクリプションの有効化] をオンにしimage.png

ワイルドカード文字を使用したカスタムトピック

次の表に、IoT Platformコンソールでカスタムトピックカテゴリを設定するときに使用できるワイルドカード文字を示します。

説明

1つ以上のワイルドカード文字を含むトピックは、一連のトピックを表します。 トピックに対して公開またはサブスクライブ権限を付与し、デバイスがトピックをサブスクライブしている場合、トピックを使用してメッセージを送信することはできません。

デバイスの詳細ページの [トピックリスト] タブでは、[メッセージの発行] アクションはトピックに対して使用できません。 トピックを使用してデバイスにメッセージを送信することはできません。

ワイルドカード文字

説明

#

このワイルドカード文字は、トピックの最後のフィールドに指定する必要があり、現在のレベルとサブレベルのすべてのフィールド値と一致します。

たとえば、/a1aycMA ****/${deviceName}/user/# トピックカテゴリを作成します。 デバイス1が /a1aycMA ****/device1/user/# トピックをサブスクライブしている場合、デバイスは、/a1aycMA ****/device1/user/updateおよび /a1aycMA ****/device1/user/updateを含む、/a1aycMA ****/device1/user/ で始まるすべてのトピックをサブスクライブします。

+

このワイルドカード文字は、現在のレベルのすべてのフィールド値と一致します。

たとえば、/a1aycMA ****/${deviceName}/user/+/errorトピックカテゴリを作成します。 デバイス1が /a1aycMA ****/device1/user/+/errorトピックをサブスクライブする場合、デバイスは /a1aycMA ****/device1/user/get/error/a1aycMA ****/device1/user/update/errorなどの複数のトピックをサブスクライブします。

カスタムトピックに基づくコミュニケーション

  • IoT Platformからデバイスへ

    IoT PlatformはPub APIを呼び出して、メッセージをトピックにパブリッシュします。 デバイスは、トピックをサブスクライブすることにより、IoT Platformからメッセージを受信します。

  • デバイスからIoT Platformへ

    デバイスは、カスタムトピックにメッセージを発行します。 IoT Platformは、Advanced Message Queuing Protocol (AMQP) サーバー側サブスクリプションまたはデータ転送機能を使用して、デバイスからメッセージを受信できます。

カスタムトピックの使用方法の詳細については、「通信にカスタムトピックを使用する」をご参照ください。