Os usuários podem adicionar um máximo de três estruturas , com múltiplos dispositivos por estrutura.
Toda a valores abaixo são encontradas em cada uma structures/ structure_id no documento JSON.
structure_id
número de identificação da estrutura. Quando você faz uma chamada para este local de dados, você pode acessar os valores de dados nessa estrutura.
| detalhes | |
|---|---|
https://developer-api.nest.com/structures/ structure_id /structure_id | |
| Devoluções | string Exemplo: "VqFabWH21nw ..." |
| Acesso | somente leitura |
| Disponível em | Termostato de leitura / v1-v6 Termostato de leitura / gravação / v1-v6 Fuma + CO ler / V1-V5 Longe de leitura / v1-v2 Longe de leitura / gravação / v1-v2 ETA gravação / v1-v2 Código postal de leitura / v2 Câmera de leitura / v1-v3 Camera leia + images / v1-v4 Câmera de leitura / gravação / v1-v3 Câmera de leitura / gravação + images / v1-v4 Energia leitura / v2 |
termostatos
Lista de termostatos na estrutura, por identificador de dispositivo único. Esta é uma disposição de objectos JSON que inclui todos os termostatos na estrutura.
| detalhes | |
|---|---|
https://developer-api.nest.com/structures/ structure_id /thermostats | |
| Devoluções | array Exemplo: [ "peyiJNo0IldT2YlIVtYaGQ",... ] |
| Acesso | somente leitura |
| Disponível em | Termostato de leitura / v1-v6 Termostato de leitura / gravação / v1-v6 Fuma + CO ler / V1-V5 Longe de leitura / v1-v2 Longe de leitura / gravação / v1-v2 ETA gravação / v1-v2 Câmera de leitura / v2-v3 Camera leia + images / v2-v4 Câmera de leitura / gravação / v2-v3 Câmera de leitura / gravação + images / v2-v4 |
smoke_co_alarms
Lista de fumaça + alarmes de CO na estrutura, por identificador de dispositivo único. Esta é uma disposição de objectos JSON que inclui todos os alarmes de fumo + CO na estrutura.
| detalhes | |
|---|---|
https://developer-api.nest.com/structures/ structure_id /smoke_co_alarms | |
| Devoluções | array Exemplo: [ "RTMTKxsQTCxzVcsySOHPxKoF4OyCifrs",... ] |
| Acesso | somente leitura |
| Disponível em | Termostato de leitura / v1-v6 Termostato de leitura / gravação / v1-v6 Fuma + CO ler / V1-V5 Longe de leitura / v1-v2 Longe de leitura / gravação / v1-v2 ETA gravação / v1-v2 Câmera de leitura / v2-v3 Camera leia + images / v2-v4 Câmera de leitura / gravação / v2-v3 Câmera de leitura / gravação + images / v2-v4 |
máquinas fotográficas
Lista de câmeras na estrutura, por identificador de dispositivo único. Esta é uma disposição de objectos JSON que inclui todas as câmaras da estrutura.
| detalhes | |
|---|---|
https://developer-api.nest.com/structures/ structure_id /cameras | |
| Devoluções | array Exemplo: [ "awJo6rH...",... ] |
| Acesso | somente leitura |
| Disponível em | Termostato de leitura / v4-v6 Termostato de leitura / gravação / v4-v6 Fuma + CO ler / v4-v5 Longe de leitura / v2 Longe de leitura / gravação / v2 ETA gravação / v2 Câmera de leitura / v1-v3 Camera leia + images / v1-v4 Câmera de leitura / gravação / v1-v3 Câmera de leitura / gravação + images / v1-v4 |
longe
Indica o estado de ocupação da estrutura.
Estruturas têm dois estados relacionados com a presença: home ou away . Quando nenhum movimento é detectado na casa, a estrutura vai mudar de home para away .
| detalhes | |
|---|---|
https://developer-api.nest.com/structures/ structure_id /away | |
| Devoluções | string Valores: "casa", "ausente" |
| Acesso | ler escrever |
| Disponível em | Ler: Termostato de leitura / v1-v6 Termostato de leitura / gravação / v1-v6 Fuma + CO ler / V1-V5 Longe de leitura / v1-v2 Longe de leitura / gravação / v1-v2 ETA gravação / v1-v2 Escrever: Longe de leitura / gravação / v1-v2 |
nome
nome de exibição definida pelo usuário da estrutura.
| detalhes | |
|---|---|
https://developer-api.nest.com/structures/ structure_id /name | |
| Devoluções | string Exemplos: "My Home", "Beach House", "Mountain House" |
| Acesso | ler escrever |
| Disponível em | Ler: Termostato de leitura / v1-v6 Termostato de leitura / gravação / v1-v6 Fuma + CO ler / V1-V5 Longe de leitura / v1-v2 Longe de leitura / gravação / v1-v2 ETA gravação / v1-v2 Código postal de leitura / v2 Câmera de leitura / v1-v3 Camera leia + images / v1-v4 Câmera de leitura / gravação / v1-v3 Câmera de leitura / gravação + images / v1-v4 Energia leitura / v2 Leia estrutura / gravação / v1 Escrever: Leia estrutura / gravação / v1 |
Código do país
O código do país, em ISO 3166 alfa-2 formato.
| detalhes | |
|---|---|
https://developer-api.nest.com/structures/ structure_id /country_code | |
| Devoluções | string Exemplos: "US", "CA", "UK" |
| Acesso | somente leitura |
| Disponível em | Termostato de leitura / v1-v6 Termostato de leitura / gravação / v1-v6 Fuma + CO ler / V1-V5 Longe de leitura / v1-v2 Longe de leitura / gravação / v1-v2 ETA gravação / v1-v2 |
Código postal
Postal ou CEP, dependendo do país.
| detalhes | |
|---|---|
https://developer-api.nest.com/structures/ structure_id /postal_code | |
| Devoluções | string Exemplos: "94304", "94304-1027", "EC1A 1BB" |
| Acesso | somente leitura |
| Disponível em | Leia código postal / v1-v2 |
peak_period_start_time
Hora de início do horário de pico de energia evento, na ISO 8601 formato.
| detalhes | |
|---|---|
https://developer-api.nest.com/structures/ structure_id /peak_period_start_time | |
| Devoluções | string Exemplo: "2016-12-31T23: 59: 59.000Z" |
| Acesso | somente leitura |
| Disponível em | Termostato de leitura / v1-v6 Termostato de leitura / gravação / v1-v6 Energia leitura / v1-v2 |
peak_period_end_time
Acabar época da hora do rush energia evento, na ISO 8601 formato.
| detalhes | |
|---|---|
https://developer-api.nest.com/structures/ structure_id /peak_period_end_time | |
| Devoluções | string Exemplo: "2016-12-31T23: 59: 59.000Z" |
| Acesso | somente leitura |
| Disponível em | Termostato de leitura / v1-v6 Termostato de leitura / gravação / v1-v6 Energia leitura / v1-v2 |
fuso horário
Fuso horário na estrutura, no fuso horário IANA formato.
| detalhes | |
|---|---|
https://developer-api.nest.com/structures/ structure_id /time_zone | |
| Devoluções | string Exemplo: "América / Los_Angeles" |
| Acesso | somente leitura |
| Disponível em | Termostato de leitura / v1-v6 Termostato de leitura / gravação / v1-v6 Fuma + CO ler / V1-V5 Longe de leitura / v1-v2 Longe de leitura / gravação / v2 ETA gravação / v1-v2 |
eta
ETA (tempo estimado de chegada) é um objecto que pode ser ajustado sobre uma estrutura. Ele é usado para deixar Nest sabe que um usuário é esperado para voltar para casa em um momento específico. Para obter informações sobre como fazer uma chamada de ETA, consulte o Longe Guia .
| detalhes | |||||||
|---|---|---|---|---|---|---|---|
https://developer-api.nest.com/structures/ structure_id /eta | |||||||
| Devoluções | object Exemplo: "myTripID1024", "2014-10-31T22: 42: 00.000Z", "2016-12-31T23: 59: 59.000Z" | ||||||
| parâmetros |
| ||||||
| Acesso | somente gravação | ||||||
| Disponível em | ETA gravação / v1-v2 | ||||||
eta_begin
Timestamp da primeira hora prevista de chegada na ISO 8601 formato. Usado para ações ou eventos de disparo.
| detalhes | |
|---|---|
https://developer-api.nest.com/structures/ structure_id /eta_begin | |
| Devoluções | string Exemplo: "2016-12-31T23: 59: 59.000Z" |
| Acesso | somente leitura |
| Disponível em | ETA leitura / v1 |
rhr_enrollment
Rush Hour Recompensas status de inscrição.
| detalhes | |
|---|---|
https://developer-api.nest.com/structures/ structure_id /rhr_enrollment | |
| Devoluções | boolean Valores: verdadeiro, falso |
| Acesso | somente leitura |
| Disponível em | Energia leitura / v1-v2 |
wwn_security_state
Estado de segurança estrutura.
| detalhes | |
|---|---|
https://developer-api.nest.com/structures/ structure_id /wwn_security_state | |
| Tipo | string enum Valores: "ok", "deter" |
| Acesso | somente leitura |
| Disponível em | estado de segurança de leitura / v1 |
Onde está a
Um objecto contendo onde identificadores ( where_id e name ) para dispositivos na estrutura. name é o nome do dispositivo de exibição. Pode ser qualquer nome da sala a partir de uma lista que oferecemos, ou um nome personalizado.
Para mais informações sobre wheres , consulte a Estrutura Guia .
Saiba mais sobre onde nomes para termostatos Ninho , Ninho Protege e ninho de webcams .
| detalhes | |
|---|---|
https://developer-api.nest.com/structures/ structure_id /wheres | |
| Devoluções | object |
| Acesso | somente leitura |
| Disponível em | Ler: Termostato de leitura / v3-v6 Termostato de leitura / gravação / v3-v6 Fuma + CO ler / V3-V5 Câmera de leitura / v1-v3 Camera leia + images / v1-v4 Câmera de leitura / gravação / v1-v3 Câmera de leitura / gravação + images / v1-v4 |
where_id
Um identificador exclusivo, gerado-Nest que representa name .
where_id é automaticamente criado e retornado durante a chamada para criar name .
| detalhes | |
|---|---|
https://developer-api.nest.com/structures/ structure_id /wheres/ where_id /where_id | |
| Devoluções | string Exemplo: "Fqp6wJI ..." |
| Acesso | somente leitura |
| Disponível em | Ler: Termostato de leitura / v3-v6 Termostato de leitura / gravação / v3-v6 Fuma + CO ler / V3-V5 Câmera de leitura / v1-v3 Camera leia + images / v1-v4 Câmera de leitura / gravação / v1-v3 Câmera de leitura / gravação + images / v1-v4 |
nome
O nome de exibição do dispositivo.
| detalhes | |
|---|---|
https://developer-api.nest.com/structures/ structure_id /wheres/ where_id /name | |
| Devoluções | string Exemplo: "Quarto" |
| Acesso | ler escrever |
| Disponível em | Ler: Termostato de leitura / v3-v6 Termostato de leitura / gravação / v3-v6 Fuma + CO ler / V3-V5 Câmera de leitura / v1-v3 Camera leia + images / v1-v4 Câmera de leitura / gravação / v1-v3 Câmera de leitura / gravação + images / v1-v4 |
co_alarm_state
CO estado de alarme.
| detalhes | |
|---|---|
https://developer-api.nest.com/structures/ structure_id /co_alarm_state | |
| Devoluções | string enum Valores: "ok", "aviso", "emergência" |
| Acesso | somente leitura |
| Disponível em | Fuma + CO ler / v5 |
smoke_alarm_state
Fumaça estado de alarme.
| detalhes | |
|---|---|
https://developer-api.nest.com/structures/ structure_id /smoke_alarm_state | |
| Devoluções | string enum Valores: "ok", "aviso", "emergência" |
| Acesso | somente leitura |
| Disponível em | Fuma + CO ler / v5 |