Os usuários podem adicionar no máximo três estruturas , com vários dispositivos por estrutura.
Todos os valores abaixo são encontrados em cada structures/ structure_id
no documento JSON.
structure_id
Número de identificação da estrutura. Ao fazer uma chamada para este local de dados, você pode acessar os valores dos dados nesta estrutura.
Detalhes | |
---|---|
https://developer-api.nest.com/structures/ structure_id /structure_id | |
Devoluções | string Exemplo: "VqFabWH21nw ..." |
Acesso | somente leitura |
Disponível em | Leitura do termostato / v1-v6 Leitura / gravação do termostato / v1-v6 Leitura de fumaça + CO / v1-v5 Leitura ausente / v1-v2 Leitura / gravação ausente / v1-v2 Gravação ETA / v1-v2 Código postal lido / v2 Leitura da câmera / v1-v3 Leitura da câmera + imagens / v1-v4 Leitura / gravação da câmera / v1-v3 Leitura / gravação da câmera + imagens / v1-v4 Energia lida / v2 |
termostatos
Lista dos termostatos da estrutura, por identificador único do dispositivo. Esta é uma matriz de objetos 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 | Leitura do termostato / v1-v6 Leitura / gravação do termostato / v1-v6 Leitura de fumaça + CO / v1-v5 Leitura ausente / v1-v2 Leitura / gravação ausente / v1-v2 Gravação ETA / v1-v2 Leitura da câmera / v2-v3 Leitura da câmera + imagens / v2-v4 Leitura / gravação da câmera / v2-v3 Leitura / gravação da câmera + imagens / v2-v4 |
smoke_co_alarms
Lista de alarmes de fumaça + CO na estrutura, por identificador único do dispositivo. Este é um array de objetos JSON que inclui todos os alarmes de fumaça + 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 | Leitura do termostato / v1-v6 Leitura / gravação do termostato / v1-v6 Leitura de fumaça + CO / v1-v5 Leitura ausente / v1-v2 Leitura / gravação ausente / v1-v2 Gravação ETA / v1-v2 Leitura da câmera / v2-v3 Leitura da câmera + imagens / v2-v4 Leitura / gravação da câmera / v2-v3 Leitura / gravação da câmera + imagens / v2-v4 |
máquinas fotográficas
Lista das câmeras da estrutura, por identificador único do dispositivo. Esta é uma matriz de objetos JSON que inclui todas as câmeras na estrutura.
Detalhes | |
---|---|
https://developer-api.nest.com/structures/ structure_id /cameras | |
Devoluções | array Exemplo: [ "awJo6rH...",... ] |
Acesso | somente leitura |
Disponível em | Termostato lido / v4-v6 Leitura / gravação do termostato / v4-v6 Leitura de fumaça + CO / v4-v5 Leitura ausente / v2 Leitura / gravação ausente / v2 Gravação ETA / v2 Leitura da câmera / v1-v3 Leitura da câmera + imagens / v1-v4 Leitura / gravação da câmera / v1-v3 Leitura / gravação + imagens da câmera / v1-v4 |
longe
Indica o estado de ocupação da estrutura.
As estruturas têm dois estados relacionados à presença: em home
ou away
. Quando nenhum movimento é detectado na casa, a estrutura mudará de home
para away
.
Detalhes | |
---|---|
https://developer-api.nest.com/structures/ structure_id /away | |
Devoluções | string Valores: "home", "away" |
Acesso | ler escrever |
Disponível em | Ler: Leitura do termostato / v1-v6 Leitura / gravação do termostato / v1-v6 Leitura de fumaça + CO / v1-v5 Leitura ausente / v1-v2 Leitura / gravação ausente / v1-v2 Gravação ETA / v1-v2 Escrever: Leitura / gravação ausente / v1-v2 |
nome
Nome de exibição da estrutura definido pelo usuário.
Detalhes | |
---|---|
https://developer-api.nest.com/structures/ structure_id /name | |
Devoluções | string Exemplos: "Minha casa", "Casa na praia", "Casa na montanha" |
Acesso | ler escrever |
Disponível em | Ler: Leitura do termostato / v1-v6 Leitura / gravação do termostato / v1-v6 Leitura de fumaça + CO / v1-v5 Leitura ausente / v1-v2 Leitura / gravação ausente / v1-v2 Gravação ETA / v1-v2 Código postal lido / v2 Leitura da câmera / v1-v3 Leitura da câmera + imagens / v1-v4 Leitura / gravação da câmera / v1-v3 Leitura / gravação da câmera + imagens / v1-v4 Energia lida / v2 Estrutura de leitura / gravação / v1 Escrever: Estrutura de leitura / gravação / v1 |
Código do país
Código do país, no formato ISO 3166 alfa-2 .
Detalhes | |
---|---|
https://developer-api.nest.com/structures/ structure_id /country_code | |
Devoluções | string Exemplos: "US", "CA", "UK" |
Acesso | somente leitura |
Disponível em | Leitura do termostato / v1-v6 Leitura / gravação do termostato / v1-v6 Leitura de fumaça + CO / v1-v5 Leitura ausente / v1-v2 Leitura / gravação ausente / v1-v2 Gravação ETA / v1-v2 |
Código postal
Código 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 | Código postal lido / v1-v2 |
Peak_period_start_time
Hora de início do evento de hora de pico de energia , no formato ISO 8601 .
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 | Leitura do termostato / v1-v6 Leitura / gravação do termostato / v1-v6 Leitura de energia / v1-v2 |
peak_period_end_time
Hora de término do evento de hora de pico de energia , no formato ISO 8601 .
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 | Leitura do termostato / v1-v6 Leitura / gravação do termostato / v1-v6 Leitura de energia / v1-v2 |
fuso horário
Fuso horário na estrutura, no formato de fuso horário da IANA .
Detalhes | |
---|---|
https://developer-api.nest.com/structures/ structure_id /time_zone | |
Devoluções | string Exemplo: "America / Los_Angeles" |
Acesso | somente leitura |
Disponível em | Leitura do termostato / v1-v6 Leitura / gravação do termostato / v1-v6 Leitura de fumaça + CO / v1-v5 Leitura ausente / v1-v2 Leitura / gravação ausente / v2 Gravação ETA / v1-v2 |
eta
ETA (tempo estimado de chegada) é um objeto que pode ser definido em uma estrutura. Ele é usado para informar à Nest que o usuário deve voltar para casa em um horário específico. Para obter informações sobre como fazer uma chamada ETA, consulte o Guia de Ausência .
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 escrita | ||||||
Disponível em | Gravação ETA / v1-v2 |
eta_begin
Carimbo de data / hora da primeira hora de chegada esperada no formato ISO 8601 . Usado para acionar ações ou eventos.
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 lido / v1 |
rhr_enrollment
Status de inscrição no Rush Hour Rewards .
Detalhes | |
---|---|
https://developer-api.nest.com/structures/ structure_id /rhr_enrollment | |
Devoluções | boolean Valores: verdadeiro, falso |
Acesso | somente leitura |
Disponível em | Leitura de energia / v1-v2 |
wwn_security_state
Estado de segurança da 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 | Leitura do estado de segurança / v1 |
Onde está a
Um objeto contendo identificadores where_id
( where_id
e name
) para dispositivos na estrutura. name
é o nome de exibição do dispositivo. Pode ser qualquer nome de sala de uma lista que fornecemos ou um nome personalizado.
Para obter mais informações sobre wheres
, consulte o Guia de Estrutura .
Saiba mais sobre os nomes dos termostatosNest ,Nest Protects e Nest Cams .
Detalhes | |
---|---|
https://developer-api.nest.com/structures/ structure_id /wheres | |
Devoluções | object |
Acesso | somente leitura |
Disponível em | Ler: Leitura do termostato / v3-v6 Leitura / gravação do termostato / v3-v6 Leitura de fumaça + CO / v3-v5 Leitura da câmera / v1-v3 Leitura da câmera + imagens / v1-v4 Leitura / gravação da câmera / v1-v3 Leitura / gravação + imagens da câmera / v1-v4 |
where_id
Um identificador exclusivo gerado pelo Nest que representa o name
.
where_id
é criado automaticamente 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: Leitura do termostato / v3-v6 Leitura / gravação do termostato / v3-v6 Leitura de fumaça + CO / v3-v5 Leitura da câmera / v1-v3 Leitura da câmera + imagens / v1-v4 Leitura / gravação da câmera / v1-v3 Leitura / gravação + imagens da câmera / 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 lido / v3-v6 Leitura / gravação do termostato / v3-v6 Leitura de fumaça + CO / v3-v5 Leitura da câmera / v1-v3 Leitura da câmera + imagens / v1-v4 Leitura / gravação da câmera / v1-v3 Leitura / gravação + imagens da câmera / v1-v4 |
co_alarm_state
Status de alarme de CO.
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 | Leitura de fumaça + CO / v5 |
smoke_alarm_state
Status do alarme de fumaça.
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 | Leitura de fumaça + CO / v5 |