Notice: We're retiring Works with Nest. See the home page for more information.
Google は、黒人コミュニティのための人種的公平の促進に取り組んでいます。詳細をご覧ください。
このページは Cloud Translation API によって翻訳されました。
Switch to English

離れて& ETA

アウェイ

Nest APIでは、「ホーム」または「アウェイ」のコンセプトは、Nestのエネルギー節約と便利な機能の動作に強力な影響を与えます。

Home and Awayの仕組み

Nestはさまざまな信号を使用して、家の中の人間の存在を検出します。 Nestが長期間にわたって存在を検出しない場合、家は自動的に退席中に設定されます。人間の存在を検出すると、構造をホーム状態に戻します。

在宅/退席中のステータスの変化に対応することで、製品にさまざまな機会が生まれます。たとえば、製品で次のことができます。

  • 家を離れるときに電気を消して、エネルギーを節約する
  • 家が離れているときにガレージのドアが開いている場合に通知を送信します
  • 家がホームに切り替わったときに音楽を再生する

ETAの仕組み

場合によっては、ユーザーがGPSを使用してNest APIに到着予定時刻(ETA)データを提供するサードパーティアプリを持っていることがあります。また、ユーザーがアプリを使用して手動でETAを入力する場合もあります。または、ETAはユーザーの定期的なスケジュールに基づいて計算されます。

Nestサーモスタットと統合されたETAアプリは、ユーザーが到着する前にサーモスタットが家を暖めたり冷やしたりし始めます。

ETA / thermostat統合がユーザーのアカウントに存在する場合、ETAデータは他のWorks with Nest開発者がWorks with Nest統合で使用できます。

ETAがNestサービスに入力された後、別のWorks with Nest統合はそれを信号として使用して、ユーザーが到着する準備をすることができます。

  1. ETAは、Nest開発者が書き込み専用のPUT eta API呼び出しを使用して作成します
  2. Nest Thermostatはこのデータを使用します。
  3. 他の開発者もそれを使用したい場合は、読み取り専用のGET eta_begin API呼び出しを使用できます
ETAデータ

覚えておくべき重要な点は、ETAデータはサードパーティによって入力される必要があることです。 Nestは現在、ETAデータを提供していません。 ETAデータが書き込まれていない場合、Nest APIはデフォルトの「1970-01-01T00:00:00.000Z」値を返します。

たとえば、あなたが照明ベンダーであるとします。 ETA /サーモスタットの統合によって提供されるETAデータを取得し、それを信号として使用してライトをオンにすることができます。

このように、温度が快適であるだけでなく、ユーザーが家に到着したときにもライトが点灯します。

ETAステータスの変化に対応することで、製品に幅広い機会が生まれます。たとえば、製品で次のことができます。

  • ユーザーが家に近づいたらテレビをオンにします
  • ユーザーがほとんど家にいるときにガレージのドアを開けます
  • ユーザーが家に帰ったときに音楽を再生しておく

退席中の権限

次のアクセス許可レベルは、 退席中関連のデータ値に使用できます



アクセス

先読み
読み取り/書き込み

ETA読み取り

ETA読み取り/書き込み

Smoke + COアラーム読み取り
サーモスタットの読み取り
サーモスタットの読み取り/書き込み
away はいはいはい
eta_begin (読み取り専用) はいはい
etaオブジェクト(書き込みのみ) はい

詳細については、 権限の概要をご覧ください。

アウェイ機能

ホームアンドアウェイ

awayデータの値は、Nestが構造が占有されていると判断したかどうかを示します。可能な値は次のとおりです。

説明
home 構造内に誰かがいます。この状態は設定できます:
•モーションセンサーデータからの信頼度が高い場合はNest
•ユーザーがNestアプリ 、Nestサーモスタット、またはお使いの製品を使用して
•ETAを介したアルゴリズム
away 構造には誰もいません。ユーザーがNestアプリ 、Nestサーモスタット、または製品のいずれかを使用して、構造を明示的に離して設定しました。
unknown 構造に関連付けられているデバイスがない場合、不在状態はunknownです。

Nest APIは、HomeとAwayを直接設定したり、これらの状態の変更をリッスンしたりする機能を提供します。ただし、Home and Awayを設定する場合は、明示的なユーザーリクエストの結果として、 Nestアプリと同じように行う必要があります。この状態をアルゴリズムで設定しようとすると、混乱を招くユーザーエクスペリエンスが作成されるリスクがあり、 Nestの設計ポリシーでは禁止されています。

ユーザーは常にホーム/退席中状態を手動で設定できることに注意してください。

ユーザーが在宅と退去の状態を設定する方法の詳細をご覧ください。

ETA

アウェイ

ETAは、構造体に設定できるフィールドを持つオブジェクトです。これは、ユーザーが特定の時間に家に帰ることが期待されていることをNestに知らせるために使用されます。 ETAを設定すると、製品は一意のtrip_idを生成し、次の値で指定される予想される到着時間枠を提供します。

  • estimated_arrival_window_begin
  • estimated_arrival_window_end

旅行の状況は交通量、ユーザープランの変更、その他のイベントによって変化する可能性があるため、旅行が進むにつれて製品はETAを定期的に更新し、Nestに推定到着時間のストリームを提供する必要があります(5分が理想的な間隔です)。

受け取る情報が多いほど、ETA入力の信頼性に自信を持つことができるため、家を準備するための行動をとるときの自信が高まります。

ETAは本国から独立しています。 ETAの到着時間が他のETAと競合する場合は、最も早い到着時間が優先されます。

ETA書き込み呼び出しを行う

ETAロジックは、構造内のサーモスタットの存在に依存しています。構造内にサーモスタットが存在しない場合、ETAオブジェクトへの呼び出しは失敗し、 「ペアリングされたデバイスはありません」というエラーメッセージが表示されます。このエラーは、構造内に他のタイプのデバイス(Nest CamやNest Protectなど)が存在する場合でも発生します。

データ値

ETA呼び出しには、次のデータ値が必要です。

名前タイプ説明
trip_id ストリング一意のETAトリップ識別子
estimated_arrival_window_begin ストリングタイムスタンプ
ISO 8601形式でNOWより大きくなければなりません
estimated_arrival_window_end ストリングタイムスタンプ
ISO 8601形式でestimated_arrival_window_begin _arrival_window_beginより大きくなければなりません

GPS通信では接続が途切れる可能性があるため、サンプルのストリームをお勧めします。理想的には5分ごとに1回です。

すべてのETA呼び出しには、最初の呼び出しで定義した一意のtrip_id文字列を含める必要があります。他のパラメーターは、同じtrip_idを連続して呼び出すと変更される可能性があります。

ETA呼び出しは、成功すると200 OK HTTPステータスコードを返します。

カール
curl --location-trusted -X PUT -d \
  '{"trip_id":"sample-trip-id","estimated_arrival_window_begin":"2014-10-31T22:42:00.000Z","estimated_arrival_window_end":"2014-10-31T23:59:59.000Z"}' \
  "http://developer-api.nest.com/structures/5af48890-b516-11e3-9eff-123139166438/eta.json?auth=c.VG6bfzyOxAltaih6P4v..."

ETAをキャンセルする

etaをキャンセルするには、 estimated_arrival_window_begin = 0送信します。この呼び出しでは、文字列( "0")ではなく整数(0)を送信していることを確認してください。そうでない場合、呼び出しは失敗します。

エラーメッセージ

API呼び出しエラーの意味とその処理方法については、「 エラーメッセージ」を参照してください。