EMQX Cloud

日本語

简体中文
English

日本語

简体中文
English

Appearance

お問い合わせ
お問い合わせ

EMQX Fleetsの始め方 ​

このガイドでは、デバイスモデルの定義、デバイスの登録、Device Shadowを使った状態同期、リアルタイムコマンドの送信までの一連のワークフローを説明します。最後まで進めることで、動作するFleetsのデプロイメントが完成し、コアコンセプトを理解できます。

前提条件 ​

  • 有効なプロジェクトを持つEMQX Cloudアカウント
  • Running状態のEMQX Fleetsデプロイメント。EMQX Fleetsは現在早期アクセス段階です。EMQX Fleetsデプロイメントの作成を参照してアクセスをリクエストしてください。
  • Fleetsデプロイメントと同じプロジェクト内にあるRunning状態のEMQX ブローカーのデプロイメント。EMQX Fleetsはすべてのデバイス通信を関連付けられたブローカー経由でルーティングします。
  • Fleetsデプロイメントと同じプロジェクト内にあるRunning状態のEMQX Tablesのデプロイメント。EMQX Fleetsはテレメトリイベントやシャドウ履歴などの時系列データを関連付けられたTablesに保存します。
  • MQTT経由でEMQX ブローカーに接続できるデバイスまたはアプリケーション

概要 ​

以下の手順を完了します。

  1. デバイススキーマを定義するThing Typeを作成
  2. Thing（デバイスインスタンス）を登録
  3. デバイスをEMQX ブローカーに接続
  4. コンソールからDesiredシャドウ状態を更新
  5. リアルタイムコマンドを送信し結果を確認

このガイドで使用する例のデバイスは、温度を報告しsetTemperatureコマンドを受け付けるスマートサーモスタットです。

ステップ1: Thing Typeの作成 ​

Thing Typeは、デバイスのカテゴリごとのスキーマを定義し、報告するプロパティや受け付けるコマンドを含みます。詳細はThing Typesを参照してください。

  1. EMQX CloudコンソールでFleetsデプロイメントを開きます。
  2. 左メニューのDevice Management > Thing Typesに移動します。
  3. + New Typeをクリックします。
  4. 名前にcom.example.thermostatを入力します。
  5. （任意）説明にThermostat device type for quick startを入力します。
  6. Confirmをクリックします。

新しいThing Typeがリストに表示されます。com.example.thermostat (default)という名前のデフォルトThing Groupが自動的に作成されます。

次に、ステップ5でコマンドを送信できるようにsetTemperatureコマンド定義を追加します。

  1. com.example.thermostatのエントリをクリックして開き、Edit Typeをクリックします。
  2. Commandsセクションで**+ Add**をクリックします。
  3. Add Commandダイアログで以下を入力します。
    • Name: setTemperature
    • Type: sync
    • Input: + Addをクリックし、名前value、タイプfloatのパラメータを追加します。
  4. Confirmをクリックしてダイアログを閉じ、Saveをクリックします。

ステップ2: Thingの登録 ​

ThingはFleetsに登録された個々のデバイスIDです。詳細はThingsを参照してください。

  1. 左メニューのDevice Management > Thingsに移動します。
  2. + Register Thingをクリックします。
  3. 以下の項目を入力します。
    • Name: thermostat-001
    • MQTT Client ID: thermostat-001
    • Thing Type: com.example.thermostat
  4. Confirmをクリックします。

デバイスは現在offline状態で登録されます。上記のMQTT Client IDを使ってデバイスが接続するとonline状態に変わります。

ステップ3: デバイスの接続 ​

Fleetsデプロイメントと同じプロジェクト内のEMQX ブローカーにデバイスを接続します。物理デバイスがない場合はクライアントツールでシミュレーション可能です。

  1. EMQX ブローカーのOverviewページに移動し、Connection Informationセクションで接続情報（ホスト、ポート、認証情報）を確認します。

  2. 以下のパラメータでデバイスを接続します。

    • Client ID: Thing登録時に設定した値（このガイドではthermostat-001）
    • Host / Port: ブローカーのMQTT Connection Informationから取得
    • Username / Password: ブローカーのAccess Control -> Authentication設定で構成されたもの

    broker_connection_info

  3. 接続後、以下のトピックをサブスクライブします。

    デバイスがDesired状態の変更を受信するためのシャドウデルタトピック:

    text
    $emqx/things/thermostat-001/shadow/update/delta

    デバイスがリアルタイムコマンドを受信するためのコマンドリクエストトピック:

    text
    $emqx/commands/things/thermostat-001/executions/+/request

接続とサブスクライブが完了すると、Thingsリストのデバイス状態がonlineに変わります。

必要なトピックサブスクリプションやメッセージ形式の詳細はMQTT Integrationを参照してください。

ステップ4: Desiredシャドウ状態の更新 ​

Device Shadowは、デバイスがオンラインでなくても目標状態を宣言できる仕組みです。詳細はDevice Shadowを参照してください。

  1. 左メニューのShadow Syncに移動します。

  2. Thingsリストからthermostat-001を選択します。

  3. **Target state (Desired)**パネルに以下を入力します。

    json
    {
  "targetTemperature": 22
}

  4. Update Desiredをクリックします。

    update_desired_state

Fleetsは現在のReported状態と新しいDesired状態の差分を計算し、以下のトピックにパブリッシュします。

text
$emqx/things/thermostat-001/shadow/update/delta

デバイスはデルタトピックでメッセージを受信します。

json
{
  "version": 1,
  "timestamp": 1780298203,
  "state": {
    "targetTemperature": 22
  },
  "metadata": {
    "targetTemperature": {
      "timestamp": 1780298203
    }
  }
}

デバイスはデルタを読み取り、変更を適用し、新しいReported状態を以下のトピックにパブリッシュします。MQTTクライアントで以下をパブリッシュしてください。

  • Topic: $emqx/things/thermostat-001/shadow/update
  • Payload:
    json
    {"state": {"reported": {"targetTemperature": 22, "temperature": 21.5}}}

パブリッシュ後、FleetsデプロイメントのShadow Syncに戻り、ページを更新すると**Current state (Reported)**が更新されているのを確認できます。

report_current_state

ステップ5: リアルタイムコマンドの送信 ​

コマンドは接続中のデバイスに直接送信されるリクエスト・レスポンス型のインタラクションです。詳細はCommands & Jobsを参照してください。

  1. 左メニューのCommands & Jobsに移動します。
  2. + Send Commandをクリックします。
  3. 以下の項目を入力します。
    • Thing: thermostat-001
    • Action: setTemperature
    • Parameters: valueに24を設定
  4. Send Commandをクリックします。

Fleetsは以下のトピックにコマンドをパブリッシュします。

text
$emqx/commands/things/thermostat-001/executions/{executionId}/request

デバイスはリクエストを受信し、アクションを実行後、以下のトピックにレスポンスをパブリッシュすることが期待されます。

text
$emqx/commands/things/thermostat-001/executions/{executionId}/response

このガイドではMQTTクライアントでデバイスをシミュレーションしているため、自動的にレスポンスは送信されません。レスポンスがパブリッシュされるまで実行ステータスはSENTのままです。実際のデバイス統合では、デバイスコードがレスポンスをパブリッシュし、ステータスはSUCCEEDEDまたはFAILEDに更新されます。

コマンドが送信されたことを確認するには、Commands & Jobs > Commandsタブに移動し、thermostat-001の実行レコードが表示されていることを確認します。実行IDをクリックすると詳細を確認できます。

command_job_list

次にやること ​

これで、登録済みデバイス、シャドウ状態、送信済みコマンドを持つ動作中のFleetsデプロイメントが完成しました。次のステップとして以下を検討してください。