Google is committed to advancing racial equity for Black communities. See how.

Struttura

Strutture

Le strutture nido rappresentano strutture fisiche nel mondo reale. In genere la casa di un utente, fungono da punto di organizzazione per i dispositivi e memorizzeranno i dati validi per l'intera casa.

L' API Nest consente di accedere ai seguenti dati a livello di struttura, dipendenti dal livello di autorizzazioni concesse:

  • Nome struttura e dispositivo "where name" (posizione in casa)
  • L'elenco dei dispositivi in ​​casa
  • Stato evento Energy ( energia ore di punta )
  • Stato assente
  • ETA utente
  • Stato di sicurezza
  • CAP o CAP

Alcune funzionalità a livello di struttura sono trattate in guide API separate e più dettagliate:

Permessi della struttura

Per l'accesso a... Selezionare...
La maggior parte dei valori dei dati nel structures oggetto Lontano , ETA , energia , o codice postale permessi
Il name valore dei dati in structures oggetto Struttura di lettura / scrittura il permesso

Vedere come i permessi di lavoro nel Riferimento API interattivo .

Identificatori di struttura

Nome

Il nome predefinito della struttura è "Home" ma può essere qualsiasi stringa scelta dall'utente. Quando si sceglie Struttura di lettura / scrittura il permesso, è possibile modificare la struttura di name .

Dov 'è

wheres è una serie oggetto su una struttura, contenente dove identificatori ( where_id e name ). Utilizzare wheres per creare su misura in cui i nomi, o l'accesso standard in cui i nomi.

L'accesso al wheres oggetto richiede Camera , fumo + CO allarme , o termostato permessi.

where_id

  • Un unico, identificatore Nest-generato che rappresenta name
  • where_id è di sola lettura, e viene creato automaticamente nella chiamata per creare un costume in cui name

name

  • Il nome visualizzato del dispositivo; può essere qualsiasi nome di stanza da un elenco che forniamo o un nome personalizzato
  • Per creare un costume in cui name , effettuare una chiamata POST per scrivere una nuova, personalizzata in cui name ; il where_id viene restituito nella chiamata
  • Considerazioni
    • name non può essere modificato o eliminato dopo la creazione
    • name deve essere univoco all'interno della struttura
    • Se un dispositivo è accoppiato ad una struttura, il personalizzata in cui name associato al dispositivo è accessibile dal /structures/ percorso
    • Per spostare un dispositivo con un personalizzata in cui name di una struttura diversa, Disaccoppia il dispositivo, e quindi ri-accoppiare il dispositivo con il nome desiderato

Scopri di più su nomi per Termostato Nest ,Nest Protect e Nest erotiche .

Altri metadati

Tutti i valori dei dati sono di sola lettura, se non diversamente specificato.

Valore dei dati Descrizione
structure_id Una stringa che rappresenta in modo univoco questa struttura. Ogni sviluppatore vedrà un ID diverso per la stessa struttura, ma più prodotti dello stesso sviluppatore vedranno lo stesso ID
country_code Un codice paese ISO 3166-1 alpha-2 che mappa la posizione registrata della struttura
postal_code CAP o CAP, a seconda del paese
time_zone Un IANA fuso orario stringa che mappa il fuso orario della struttura

Caratteristiche della struttura

Stati di allarme fumo e CO

Quando si sceglie di fumo + CO permesso di lettura , è possibile accedere smoke_alarm_state e co_alarm_state in structures oggetto. Questi stessi valori di dati sono disponibili nel dispositivo oggetto (anche devices/smoke_co_alarms ).

Vedere il fumo + guida allarme CO per ulteriori informazioni su questi stati.

Molti valori dei dati interagiscono per determinare il comportamento dei dispositivi in ​​una struttura.

  • Quando una struttura away lo stato è impostato su away viene visualizzata la parola "ECO" sul termostato Nest, nella lingua preferita dell'utente
  • Quando una struttura away lo stato è impostato su away , è possibile:
    • set fan_timer_active
    • cambiamento target_temperature_f o target_temperature_c
  • Quando una struttura away lo stato è impostato home , è possibile:
    • effettuare una chiamata ETA (impostare l'ID del viaggio e la finestra di arrivo)
  • Quando emergenza di arresto è attiva, non è possibile impostare fan_timer_active
  • Quando calore emergenza è abilitata, non è possibile è possibile impostare la struttura di away

Strutture multiple

È possibile che un utente abbia più di una struttura collegata al proprio Account Nest, quindi il tuo prodotto dovrebbe offrire all'utente un mezzo per scegliere tra le strutture disponibili (un selettore di strutture).

Selettore struttura

Ad esempio, quando si imposta l'ETA, è importante che l'utente possa scegliere una struttura per la destinazione dell'ETA. In modo simile, un utente potrebbe avere due rilevatori di fumo nel "salotto" di due case diverse. Se hai bisogno di correlare la struttura con il tuo concetto di casa, ti consigliamo di farlo durante il processo di autorizzazione.

Ulteriori informazioni su come agli utenti di gestire i dispositivi in più strutture .

Dispositivi massimi Device

Esistono limiti al numero di dispositivi supportati da Nest in una struttura.

Tipo di dispositivo Max per struttura
Termostato Nest 20
Videocamere Nest 10
Nest Protect 18

Messaggio di errore

Per informazioni su quali errori chiamata API significano e come gestirli, vedere Messaggi di errore .