ha duke energy gateway

重要 - 非推奨

デュークエナジーは、2023年6月末にゲートウェイパイロットプログラムを閉鎖しました。この統合は機能を停止し、非推奨です。

デュークエネルギーゲートウェイ

これは、ホームアシスタント向けのカスタム統合です。デュークエネルギーゲートウェイパイロットプログラムを介して、デュークエネルギーからリアルタイムのエネルギー使用量を引き出します。

この統合は、私によって書かれたpyduke-energy Libraryを活用して、データを引き出します。このAPIは非常に非公式であり、いつでも作業を停止する可能性があります（免責事項を参照）。

前提条件！ （読んでください）

これが機能するには、スマートメーターにデュークエネルギーゲートウェイを接続する必要があります。これはスマートメーターとは別のデバイスであり、現時点での招待のみのプログラムによって提供されています。これが何であるかわからない場合は、おそらく持っていないでしょう。この統合は、データの取得方法をサポートしていません（ゲートウェイの要件を参照）。

センサー

このコンポーネントは、次のエンティティを設定します。

sensor.duke_energy_current_usage_w

• ワットでのリアルタイムの電力使用量を表します。
• このデータは、1〜3秒ごとにゲートウェイデバイスからプッシュされます。注：これにより、多くのデータが生成されます。この更新間隔があまりにも頻繁に行われている場合は、数秒でスロットル間隔を構成できます（以下の構成を参照）。
• これは電力使用量であるため、ホームアシスタントエネルギーダッシュボードには使用できないことに注意してください。代わりに、 sensor.duke_energy_usage_today_kwhセンサーを使用するか、Riemann Sum統合積分を介してこのリアルタイムセンサーをフィードする必要があります。
• メーターIDとゲートウェイIDを含む追加の属性が利用可能です。

sensor.duke_energy_usage_today_kwh

• キロワット時の今日のエネルギー消費量を表します（現地時間0:00から現地時間23:59、その後リセット）。
• このデータは60秒ごとに投票されますが、デュークエネルギーが報告しているデュークエネルギーの遅延により、データが最大15分遅れている可能性があります（ pyduke-energy Repoの制限を参照）。
• これは、ホームアシスタントエネルギー消費ダッシュボードで使用できます。
• メーターID、ゲートウェイID、および最後の測定のタイムスタンプを含む追加の属性が利用可能です。

インストール

HACSインストール

1. HACSの設定の下でカスタムリポジトリとして追加： mjmeli/ha-duke-energy-gatewayをカテゴリとしてIntegrationします。
2. HACSで「デュークエネルギーゲートウェイ」を検索すると、統合が検索結果として返されるようになりました。それをクリックし、[ダウンロード]ボタンをクリックし、プロンプトを通過してダウンロードします。
3. ホームアシスタントを再起動します
4. ha uiでは、「設定」 - >「デバイスとサービス」に移動し、[統合]タブに[統合]に[+]をクリックして、[デュークエネルギーゲートウェイ]を検索します。これにより、セットアップできます。

手動インストール

1. 選択のツールを使用して、ha構成（ configuration.yamlが見つかった場合）のディレクトリ（フォルダー）を開きます。
2. そこにcustom_componentsディレクトリ（フォルダー）がない場合は、作成する必要があります。
3. custom_componentsディレクトリ（フォルダー）で、 duke_energy_gatewayという新しいフォルダーを作成します。
4. このリポジトリに、 custom_components/duke_energy_gateway/ directory（folder）からすべてのファイルをダウンロードします。
5. ダウンロードしたファイルを、作成した新しいディレクトリ（フォルダー）に配置します。
6. ホームアシスタントを再起動します
7. ha uiでは、「設定」 - >「デバイスとサービス」に移動し、[統合]タブに[統合]に[+]をクリックして、[デュークエネルギーゲートウェイ]を検索します。これにより、セットアップできます。

構成

構成はUIで行われます。最初に、次のデータを提供する必要があります。

データ	説明
email	デュークエナジーへのログインメール。
password	デュークエナジーへのログインパスワード。

統合が設定された後、統合ページで「構成」をクリックすることで、さらに構成を実行できます。これにより、次のオプションを変更できます。

データ	説明
Real-time Usage Update Interval (sec)	デフォルトでは、読み取り値が入るたびにリアルタイムの使用センサーが更新されます。このデータがあまりにも頻繁になっている場合は、この値を構成してデータをスロットルすることができます。正の整数Xに設定すると、センサーはX秒ごとに1回のみ更新されます。言い換えれば、30に設定すると、30秒ごとに新しいリアルタイムの使用が取得されます。

メーターの選択

構成フローは、ゲートウェイとスマートメーターを自動的に識別しようとします。現在、アカウントごとにサポートされているのは1つだけです。特定された最初のものが使用されます。見つからない場合、構成プロセスが失敗するはずです。

メーターの選択が失敗した場合、最初のステップは、コンポーネントのログを有効にすることです（ロギングを参照）。これが問題について洞察を与えない場合は、GitHubの問題を開いてください。

ロギング

問題が発生し、ログを調べたい場合、この統合はデバッグレベルでの冗長ロギングを提供します。 configuration.yamlファイルに次のものを追加することで有効にできます。

 logger :
  default : info
  logs :
    custom_components.duke_energy_gateway : debug
    pyduke_energy.client : debug
    pyduke_energy.realtime : debug 

発達

code . DEVコンテナで再開するオプションをクリックします。 VSコードでは、「ポート9123でホームアシスタントを実行する」タスクを実行してから、http：// localhost：9123からアクセスできます。

手動でインストールしたい場合は、 pip install -r requirements_dev.txtを使用して開発者依存関係をインストールできます。

コミットする前に、 pre-commit run --all-files 。

開発中のpyduke-energyバージョンと協力しています

pyduke-energyからの新しい変更の実装に取り組んでいるが、そのライブラリのバージョンをリリースしたくない場合は、リモートワーキングブランチからインストールするために開発環境を設定できます。

1. requirements_dev.txtを更新して、 git+https://github.com/mjmeli/pyduke-energy@mainのmainを作業ブランチで置き換え、 git+https://github.com/notmjmeli/pyduke-energy@new-feature-dev-branch
2. pyduke-energyのローカルにキャッシュされたバージョン： pip uninstall -y pyduke-energy
3. 再実行要件インストール： pip install -r requirements_dev.txt

貢献は大歓迎です！

これに貢献したい場合は、貢献ガイドラインをお読みください

クレジット

このプロジェクトは、 @OnCleben31のホームアシスタントカスタムコンポーネントCookEiCutterテンプレートから生成されました。

コードテンプレートは、主に @ludeeusのIntegration_bluePrintテンプレートから取得されました

---