Home Assistant - SenseCAP Indicator

note

この文書は AI によって翻訳されています。内容に不正確な点や改善すべき点がございましたら、文書下部のコメント欄または以下の Issue ページにてご報告ください。
https://github.com/Seeed-Studio/wiki-documents/issues

SenseCAP Indicator - Home Assistant アプリケーション開発

はじめに

今すぐ購入 🖱️

SenseCAP Indicator を Home Assistant と統合することで、スマートホームの可能性を最大限に引き出しましょう。この強力な組み合わせにより、環境をこれまでにないほど簡単に監視および制御することができます。

この包括的なガイドでは、MQTT を使用して SenseCAP Indicator を Home Assistant にシームレスに統合する方法を学びます。

始める前に、Home Assistant のセットアップオプションを確認しましょう。Home Assistant は、以下の 2 つの専用ハードウェアオプションに簡単にインストールできます。

note

もちろん、Installation - Home Assistant (home-assistant.io) に従って、さまざまな方法で Home Assistant をインストールすることができます。

Home Assistant Green
Home Assistant Yellow

手頃な価格の Home Assistant Green は、Home Assistant を使い始める最も簡単な方法です。プラグアンドプレイで、Home Assistant がすでにインストールされています。

Home Assistant の機能を最大限に活用するには、Home Assistant OS または Home Assistant Supervised のいずれかを使用することをお勧めします。これらのオプションは高度な機能とカスタマイズオプションを提供し、スマートホーム体験を正確なニーズに合わせて調整することができます。

それでは、統合プロセスを始めましょう。以下の 3 つの主要なステップに従って、SenseCAP Indicator を Home Assistant で動作させましょう：

Home Assistant OS をインストール
1. アドオンをインストール
2. MQTT 統合を設定
ファームウェアをビルドしてフラッシュ
MQTT デバイスを追加
ダッシュボードを設定

前提条件

開始する前に、SenseCAP インジケーターボードのユーザーガイドを読んで、ソフトウェアおよびハードウェア情報に慣れておいてください。

Home Assistant OS のインストール

Home Assistant は、プライバシーとローカル制御に重点を置いた強力なオープンソースのホームオートメーションプラットフォームです。すべての家庭用デバイスを単一の統一されたプラットフォームから管理および自動化するためのカスタマイズ可能で柔軟なフレームワークを提供します。

Home Assistant Yellow を使用する場合は、こちらに記載されている手順に従ってください。また、Raspberry Pi の任意のタイプやローカルサーバーで実行する場合は、この手順に従って進めてください。

インストールが完了したら、このページに進むことができるので、次のステップに進みます。

Home Assistant のオンボーディング方法がわからない場合

Home Assistant をインストールした後、Onboarding Home Assistant - Home Assistant を確認してください。

ステップ 1: アドオンのインストール

アドオン機能が必要

Home Assistant Yellow は Home Assistant Operating System を搭載しており、アドオンを簡単にインストールできます。ただし、Home Assistant Container はアドオンをサポートしていないため、Home Assistant とは別に MQTT ブローカーアプリケーションをインストールする必要があります。詳細はインストール方法を確認してください。

次のステップでは、Mosquitto Broker と File Editor をインストールします。Mosquitto は MQTT プロトコルを実装するオープンソースのメッセージブローカーであり、File Editor はターミナルにアクセスせずに configuration.yaml ファイルを編集できるようにします。

Home Assistant Yellow では、アドオン機能を使用して Mosquitto Broker と File Editor をインストールできます。

tip

便利のために、サイドバーに「File Editor」を表示させます：

これで 2 つのアドオンがインストールされました。

ステップ 2: MQTT 統合の設定

MQTT (Message Queuing Telemetry Transport) は軽量なメッセージングプロトコルであり、SenseCAP インジケーターボードを Home Assistant に接続するために重要です。この機能を有効にするには、Home Assistant セットアップに MQTT 統合を追加する必要があります。

MQTT 統合を追加することで、Home Assistant は SenseCAP インジケーターボードとシームレスに通信できるようになり、リアルタイムのデータ交換と制御が可能になります。この双方向通信は、センサーデータの監視やデバイスへのコマンド送信に不可欠です。

MQTT 統合を設定するには：

Home Assistant ダッシュボードの「統合」ページ（Devices & Services -> Integrations）に移動します。
「MQTT」を検索してリストから選択します。（自動的に検出されない場合）
画面の指示に従って設定を完了します。

tip

公式以外の MQTT ブローカー（例えば EMQX Broker）を使用している場合、標準の Mosquitto ブローカーとは異なり、自動検出が機能しない場合があります。この場合、ブローカーの IP アドレスを手動で入力して接続を確立する必要があります。これにより、Home Assistant がカスタム MQTT 設定と通信できるようになります。

MQTT アドオンのユーザー追加

Home Assistant の公式 Mosquitto Broker アドオンを使用する場合、MQTT 接続のための認証情報を設定する必要があります。このステップは、デバイスと Home Assistant 間の安全な通信を確保するためのものです。以下の手順でユーザーを追加します：

Home Assistant インターフェースで Mosquitto Broker アドオンに移動します。
アドオン設定内の「ユーザー」セクションまたはタブを探します。
「ユーザーを追加」または「+」ボタンをクリックして新しいユーザーを作成します。

ユーザー作成フォームで:
- 任意のユーザー名を入力します。デフォルトは indicator-usr^ref です。
- 強力なパスワードを作成します。デフォルトは indicator-password です。
- 必要に応じて、特定の権限を設定することもできます。
新しいユーザー認証情報を保存します。

tip

これらの認証情報を使用して、SenseCAP Indicator または他の MQTT デバイスを Home Assistant に接続する際に設定してください。

ユーザーを追加した後、変更を有効にするために Mosquitto ブローカーアドオンを再起動する必要がある場合があります。これで、これらの認証情報を使用して安全な MQTT 接続を確立できるようになります。

SenseCAP Indicator の MQTT 設定を新しいユーザー名とパスワードで更新し、Home Assistant と通信できるようにすることを忘れないでください。

SenseCAP Indicator ESP32 プロジェクトのセットアップ

Home Assistant と SenseCAP Indicator を統合する前に、適切なファームウェアでデバイスをセットアップする必要があります。以下の手順に従って、プロジェクトをダウンロード、ビルド、フラッシュして SenseCAP Indicator にインストールしてください。

ステップ 1: プロジェクトをダウンロードする

SenseCAP Indicator を Home Assistant と統合するためのプロジェクトが 2 つあります。ニーズに最も適したものを選択してください。

sensecap-indicator-ha
SenseCAP_Indicator_ESP32

このプロジェクトは、Home Assistant との統合専用に設計されています。

ファームウェアを取得する

または Git を使用してリポジトリをクローンします:

git clone https://github.com/Love4yzp/sensecap-indicator-ha

このプロジェクトには、SenseCAP Indicator 用のより多くの例と機能が含まれています。

ファームウェアを取得する

または Git を使用してリポジトリをクローンします:

git clone https://github.com/Seeed-Solution/SenseCAP_Indicator_ESP32

ステップ 2: プロジェクトディレクトリに移動する

プロジェクトをダウンロードまたはクローンしたら、適切なディレクトリに移動します:

sensecap-indicator-ha
SenseCAP_Indicator_ESP32

cd sensecap-indicator-ha

cd SenseCAP_Indicator_ESP32/examples/indicator_ha

ステップ 3: プロジェクトをビルド、フラッシュ、モニターする

次に、ファームウェアをビルドし、SenseCAP Indicator にフラッシュし、デバイスの出力をモニターします。以下のコマンドを使用してください:

idf.py -p PORT build flash monitor

PORT をデバイスに適したポートに置き換えてください（例: Windows の場合は COM3、Linux の場合は /dev/ttyUSB0）。

tip

デバイスのポートが不明な場合:

Windows: デバイスマネージャーで「ポート (COM & LPT)」を確認
Linux/macOS: ターミナルで ls /dev/tty* を実行

このコマンドは以下を実行します:

プロジェクトをビルド
ファームウェアを SenseCAP Indicator にフラッシュ
シリアルモニターを開き、デバイスの出力を表示

シリアルモニターを終了するには、Ctrl-] を押してください。

ステップ 4: セットアップを確認する

ファームウェアをフラッシュした後、シリアルモニターに SenseCAP Indicator からの出力が表示されます。Wi-Fi ネットワークおよび MQTT ブローカーへの接続が成功したことを示すメッセージを確認してください。

caution

SenseCAP Indicator が Home Assistant インスタンスと同じネットワークに接続されていること、MQTT ブローカーが適切に設定されてアクセス可能であることを確認してください。

SenseCAP Indicator にファームウェアを正常にフラッシュして確認できたら、次は MQTT 統合を使用して Home Assistant に統合する準備が整いました。

次に、Home Assistant を設定して SenseCAP Indicator を認識し、通信できるようにします。

MQTTデバイスの追加

Home AssistantでMQTT統合を設定した後、次のステップはMQTTデバイスを追加することです。このプロセスでは、Home AssistantがSenseCAPインジケーターボードをMQTTを通じて認識し、通信できるように設定します。

ステップ1: インジケーターエンティティの追加

SenseCAPインジケーターエンティティをHome Assistantに追加するには、configuration.yamlファイルを編集する必要があります。このファイルは、Home Assistantがデバイスとどのようにやり取りするかを定義するために重要です。

tip

Home Assistant YellowやFile editorアドオンを備えたシステムを使用している場合、Webインターフェースを通じてconfiguration.yamlファイルを簡単に編集できます。他のセットアップ（例: Home Assistant Container）の場合、ターミナルアクセスを介してファイルを編集する必要があるかもしれません。

configuration.yamlファイルを編集する手順：

Home AssistantダッシュボードでFile editorアドオンに移動します。
ファイルリストからconfiguration.yamlファイルを選択します。
以下のMQTT設定をファイルに追加します：

クリックして展開し、SenseCAPインジケーター用のMQTT設定をコピー

# Example configuration.yaml entry | SenseCAP Indicator MQTT Configuration
mqtt:
  sensor:
    - unique_id: indicator_temperature
      name: "Indicator Temperature"
      state_topic: "indicator/sensor"
      suggested_display_precision: 1
      unit_of_measurement: "°C"
      value_template: "{{ value_json.temp }}"
    - unique_id: indicator_humidity
      name: "Indicator Humidity"
      state_topic: "indicator/sensor"
      unit_of_measurement: "%"
      value_template: "{{ value_json.humidity }}"
    - unique_id: indicator_co2
      name: "Indicator CO2"
      state_topic: "indicator/sensor"
      unit_of_measurement: "ppm"
      value_template: "{{ value_json.co2 }}"
    - unique_id: indicator_tvoc
      name: "Indicator tVOC"
      state_topic: "indicator/sensor"
      unit_of_measurement: ""
      value_template: "{{ value_json.tvoc }}"
  switch:
    - unique_id: indicator_switch1
      name: "Indicator Switch1"
      state_topic: "indicator/switch/state"
      command_topic: "indicator/switch/set"
      value_template: "{{ value_json.switch1 }}"
      payload_on: '{"switch1":1}'
      payload_off: '{"switch1":0}'
      state_on: 1
      state_off: 0
    - unique_id: indicator_switch2
      name: "Indicator Switch2"
      state_topic: "indicator/switch/state"
      command_topic: "indicator/switch/set"
      value_template: "{{ value_json.switch2 }}"
      payload_on: '{"switch2":1}'
      payload_off: '{"switch2":0}'
      state_on: 1
      state_off: 0
    - unique_id: indicator_switch3
      name: "Indicator Switch3"
      state_topic: "indicator/switch/state"
      command_topic: "indicator/switch/set"
      value_template: "{{ value_json.switch3 }}"
      payload_on: '{"switch3":1}'
      payload_off: '{"switch3":0}'
      state_on: 1
      state_off: 0
    - unique_id: indicator_switch4
      name: "Indicator Switch4"
      state_topic: "indicator/switch/state"
      command_topic: "indicator/switch/set"
      value_template: "{{ value_json.switch4 }}"
      payload_on: '{"switch4":1}'
      payload_off: '{"switch4":0}'
      state_on: 1
      state_off: 0
    - unique_id: indicator_switch6
      name: "Indicator Switch6"
      state_topic: "indicator/switch/state"
      command_topic: "indicator/switch/set"
      value_template: "{{ value_json.switch6 }}"
      payload_on: '{"switch6":1}'
      payload_off: '{"switch6":0}'
      state_on: 1
      state_off: 0
    - unique_id: indicator_switch7
      name: "Indicator Switch7"
      state_topic: "indicator/switch/state"
      command_topic: "indicator/switch/set"
      value_template: "{{ value_json.switch7 }}"
      payload_on: '{"switch7":1}'
      payload_off: '{"switch7":0}'
      state_on: 1
      state_off: 0
  number:
    - unique_id: indicator_switch5
      name: "Indicator Switch5"
      state_topic: "indicator/switch/state"
      command_topic: "indicator/switch/set"
      command_template: '{"switch5": {{ value }} }'
      value_template: "{{ value_json.switch5 }}"
    - unique_id: indicator_switch8
      name: "Indicator Switch8"
      state_topic: "indicator/switch/state"
      command_topic: "indicator/switch/set"
      command_template: '{"switch8": {{ value }} }'
      value_template: "{{ value_json.switch8 }}"

configuration.yamlファイルへの変更を保存します。

caution

Home Assistantのセットアップがアドオンをサポートしていない場合（例: Home Assistant Container）、ターミナルまたはSSH接続を介してconfiguration.yamlファイルを編集する必要があります。

ステップ2: 設定変更の適用

configuration.yamlファイルを編集した後、変更を適用する必要があります：

Home AssistantダッシュボードでDeveloper Toolsに移動します。
「YAML」タブを見つけてクリックします。
ALL YAML CONFIGURATIONをリロードします。

note

何か問題が発生した場合は、以下を試してください：

「Check Configuration」ボタンをクリックして変更を確認します。
設定チェックが成功した場合、「Restart」ボタンをクリックして新しい設定を適用します。

Home Assistantを再起動すると、SenseCAP Indicatorのエンティティが認識され、ダッシュボードに表示されるはずです。エンティティがすぐに表示されない場合は、MQTTのディスカバリプロセスが完了するまで数分待つ必要があるかもしれません。

SenseCAP Indicatorが正しく設定され、構成で定義された正しいMQTTトピックにデータを公開していることを確認してください。 :::

これらの手順を実行することで、SenseCAP IndicatorデバイスをMQTTを介してHome Assistantに追加することに成功しました。これで、これらのエンティティを自動化、スクリプト、ダッシュボードで使用し、より統合されたスマートホーム体験を楽しむことができます。

ダッシュボードの設定

Home AssistantでSenseCAP Indicatorを統合する最終ステップは、カスタムダッシュボードを設定することです。これにより、デバイスのデータや機能を簡単に視覚化および制御することができます。

新しいダッシュボードの作成（オプション）

SenseCAP Indicator専用のダッシュボードを作成したい場合は、以下の手順を実行してください：

Home Assistantのサイドバーで設定 -> ダッシュボードに移動します。
「ダッシュボードを追加」ボタンをクリックします。
タイトル（例：「SenseCAP Indicator」）を設定し、アイコンを選択します。
「作成」をクリックして新しいダッシュボードを完成させます。

ダッシュボードの設定

SenseCAP Indicatorのエンティティをダッシュボードに追加するには：

編集したいダッシュボードを開きます。
右上の三点メニューをクリックし、「ダッシュボードを編集」を選択します。
「制御を取得」ボタンをクリックして手動設定を有効にします。

ダッシュボードエディタで再度三点メニューをクリックし、「生の構成エディタ」を選択します。
以下の構成で既存のYAMLコンテンツを置き換えます：

UIを変更するためのダッシュボード YAMLをコピー

注意：これはConfiguration.YAML用ではありません。

views:
  - title: Indicator device
    icon: ''
    badges: []
    cards:
      - graph: line
        type: sensor
        detail: 1
        icon: mdi:molecule-co2
        unit: ppm
        entity: sensor.indicator_co2
      - graph: line
        type: sensor
        entity: sensor.indicator_temperature
        detail: 1
        icon: mdi:coolant-temperature
      - graph: line
        type: sensor
        detail: 1
        entity: sensor.indicator_humidity
      - graph: line
        type: sensor
        entity: sensor.indicator_tvoc
        detail: 1
        icon: mdi:air-filter
      - type: entities
        entities:
          - entity: switch.indicator_switch1
          - entity: switch.indicator_switch2
          - entity: switch.indicator_switch3
          - entity: switch.indicator_switch4
          - entity: number.indicator_switch5
          - entity: switch.indicator_switch6
          - entity: switch.indicator_switch7
          - entity: number.indicator_switch8
        title: Indicator control
        show_header_toggle: false
        state_color: true

caution

このYAML構成はダッシュボード専用であり、configuration.yamlファイルに追加しないでください。

「保存」をクリックして変更を適用します。

おめでとうございます！Home Assistantダッシュボードを正常に設定し、SenseCAP Indicatorを表示および制御できるようになりました。これで、CO2レベル、温度、湿度、TVOCを監視し、Home Assistantインターフェースからさまざまなスイッチを直接制御することができます。

リソース

デモ SDK: SenseCAP Indicator 用のデモ SDK は GitHub で利用可能です。
indicator_ha.c ファイル: このファイルには Home Assistant 統合の主要な関数が含まれています。こちらで閲覧できます。
ユーザーガイド: ユーザーガイドには SenseCAP Indicator ボードのソフトウェアとハードウェアに関する詳細情報が記載されています。こちらで読むことができます。
Home Assistant インストールガイド: Home Assistant を初めて使用する場合、このガイドがインストールとセットアップをサポートします。こちらで確認できます。
ESP-IDF の入門ガイド: このガイドは、ESP-IDF を使用してプロジェクトを構築するための完全な手順を提供します。こちらでアクセスできます。
Home Assistant の概念と用語

参考資料

🔗 [リンク] Home Assistant と MQTT: 構築できる 4 つのアイデア | EMQ (emqx.com)

技術サポート

SenseCAP Indicator に関するサポートが必要ですか？私たちがサポートします！

このチュートリアルを進める中で問題が発生したり質問がある場合は、ぜひ技術サポートにお問い合わせください。私たちはいつでもお手伝いします！

質問がある場合は Seeed Official Discord Channel を訪れるか、GitHub discussions で自由に共有してください！

MQTT デフォルト認証情報 - GitHub ↩

SenseCAP Indicator - Home Assistant アプリケーション開発

はじめに​

前提条件​

Home Assistant OS のインストール​

ステップ 1: アドオンのインストール​

ステップ 2: MQTT 統合の設定​

MQTT アドオンのユーザー追加​

SenseCAP Indicator ESP32 プロジェクトのセットアップ​

ステップ 1: プロジェクトをダウンロードする​

ステップ 2: プロジェクトディレクトリに移動する​

ステップ 3: プロジェクトをビルド、フラッシュ、モニターする​

ステップ 4: セットアップを確認する​

MQTTデバイスの追加​

ステップ1: インジケーターエンティティの追加​

ステップ2: 設定変更の適用​

ダッシュボードの設定​

新しいダッシュボードの作成（オプション）​

ダッシュボードの設定​

リソース​

参考資料​

技術サポート​

はじめに

前提条件

Home Assistant OS のインストール

ステップ 1: アドオンのインストール

ステップ 2: MQTT 統合の設定

MQTT アドオンのユーザー追加

SenseCAP Indicator ESP32 プロジェクトのセットアップ

ステップ 1: プロジェクトをダウンロードする

ステップ 2: プロジェクトディレクトリに移動する

ステップ 3: プロジェクトをビルド、フラッシュ、モニターする

ステップ 4: セットアップを確認する

MQTTデバイスの追加

ステップ1: インジケーターエンティティの追加

ステップ2: 設定変更の適用

ダッシュボードの設定

新しいダッシュボードの作成（オプション）

ダッシュボードの設定

リソース

参考資料

技術サポート