vaillant netatmo apiダウンロードvaillant netatmo apiソースコードダウンロード

vaillant netatmo api

AI ソースコード

v0.11.0

ダウンロード

vaillant-netatmo-api

一般的な

Netatmo APIを使用して、Vaillantサーモスタットを管理するためのPython 3ライブラリ。 VaillantのNetatmo APIで1対1のマッピングを提供し、公式のVaillant VSmart/Erelaxアプリと同様の機能を提供します。

注：このライブラリはまだプレレリーズステータスにあり、v1.0.0までになります。 V0.xyバージョンのいずれかで、パブリックAPIに壊れた変更がある可能性があります。

インストール

ライブラリは、PIPを使用して単純にインストールできます。

pip install vaillant-netatmo-api

ライブラリにはPython 3が必要で、粘り強さとHTTPXの依存関係があります。

注：HTTPXは現在、PrerEleaseソフトウェアです。 requirements.txtで概説されているバージョンは適切に動作する必要がありますが、いくつかの壊れた変更がある場合は、既知の問題についてはGitHub Issueトラッカーを確認してください。

使用法

OAuth APIからトークンを取得します

すべてのNetatmo APIは保護されており、認証するためにベアラートークンが必要です。このトークンを取得するために、NetatmoはOAuth APIを提供します。

Vaillantはリソース所有者のパスワード資格認証助成金を使用しているため、 AuthClient APIには1つの方法しかありません。

async_token ：ベアラーのトークンを取得してトークンストアに保存する

 from vaillant_netatmo_api import auth_client

CLIENT_ID = ""
CLIENT_SECRET = ""

def handle_token_update ( token ):
    token_string = token . serialize ()
    write_to_storage ( token_string )

async with auth_client ( CLIENT_ID , CLIENT_SECRET , handle_token_update ) as client :
    await client . async_token (
        username ,
        password ,
        user_prefix ,
        app_version ,
    )

サーモスタットAPIへのアクセス

ThermostatClientに使用可能な3つのAPIがあり、そのすべてが認証のためにベアラートークンを必要とします。

async_get_thermostats_data ：ユーザーアカウントに関連付けられているすべてのデバイスを取得する
async_set_system_mode ：デバイスとモジュールのシステムモードの変更（すなわち、夏、冬、またはフロストガード）
async_set_minor_mode ：デバイスとモジュールのマイナーモードの変更（すなわち、マニュアルモード、アウェイモード、または温水モード）
async_sync_schedule ：デバイスとモジュールのスケジュールデータを更新する
async_switch_schedule ：デバイスとモジュールのアクティブなスケジュールを変更する

 from vaillant_netatmo_api import thermostat_client , SystemMode , Token

CLIENT_ID = ""
CLIENT_SECRET = ""

token_string = read_from_storage ()
token = Token . deserialize ( token_string )

def handle_token_update ( token ):
    token_string = token . serialize ()
    write_to_storage ( token_string )

async with thermostat_client ( CLIENT_ID , CLIENT_SECRET , token , handle_token_update ) as client :
    devices = await client . async_get_thermostats_data ()

    d_id = devices [ 0 ]. id
    m_id = devices [ 0 ]. modules [ 0 ]. id

    await client . async_set_system_mode ( d_id , m_id , SystemMode . WINTER )

クライアントをシングルトンとして使用します

ライブラリは、 AuthClientおよびThermostatClient使用するためのコンテキストマネージャーを提供しますが、これは開発中または非常にまれな使用シナリオでのみ行う必要があります。

両方のクライアントは、接続プーリングと接続の再利用を実装する、基礎となるHTTP通信ライブラリとしてhttpx.AsyncClient使用します。これは、 AuthClientまたはThermostatClient auth_client同じインスタンスを使用して複数の同意リクエストthermostat_client実行する必要があることを意味します。これは、Context Manager APIを使用して不可能です。

接続プーリングと接続の再利用を利用する最適な使用法を実現するには、クライアントをインスタンス化し、コンストラクターでhttpx.AsyncClientインスタンスを提供することにより、 AuthClientとThermostatClient両方を使用する必要があります。これにより、クライアントはシングルトンとして、または他のコンテキスト管理メカニズムを使用して使用する必要があります。コンテキストは、コードの1ブロックまたは1つのインバウンドリクエストよりも広くなっています。

これは、ホームアシスタントの使用の例です。

 # When setting up integration with all the devices of one account, instantiate and store the client in a configuration memory store
async def async_setup_entry ( hass : HomeAssistant , entry : ConfigEntry ) -> bool :
    client = get_async_client ( hass )
    token_store = TokenStore (
        entry . data [ CONF_CLIENT_ID ],
        entry . data [ CONF_CLIENT_SECRET ],
        token ,
        handle_token_update ,
    )

    hass . data [ DOMAIN ][ entry . entry_id ] = ThermostatClient ( client , token_store )
    hass . config_entries . async_setup_platforms ( entry , PLATFORMS )

    return True

# When unloading the integration of this same account, read the client and close it manually
async def async_unload_entry ( hass : HomeAssistant , entry : ConfigEntry ) -> bool :
    unload_ok = await hass . config_entries . async_unload_platforms ( entry , PLATFORMS )
    if unload_ok :
        hass . data [ DOMAIN ]. pop ( entry . entry_id )

    return unload_ok