Estrutura

Estruturas de ninho representam estruturas físicas no mundo real. Normalmente, a casa de um usuário, eles servem como um ponto de organização para dispositivos e armazenam dados que se aplicam a toda a casa.

A API Nest fornece acesso aos seguintes dados em nível de estrutura, dependendo do nível de permissões concedidas:

• Nome da estrutura e dispositivo "onde nome" (localização na casa)
• A lista de dispositivos em casa
• Status do evento de energia ( energia hora do rush )
• Estado ausente
• ETA do usuário
• Estado de segurança
• CEP ou código postal

Alguns recursos de nível de estrutura são abordados em guias de API mais detalhados e separados:

• Longe & ETA estado -Away, ETA usuário
• Energia status do evento -Energy
• Segurança -Segurança e dissuasão

Permissões de estrutura

Para acesso a ...	Selecione ...
A maioria dos valores de dados na structures objecto	Distância , ETA , Energia , ou Código postal permissões
O name valor de dados no structures objecto	Leia estrutura / gravação permissão

Veja como as permissões funcionam na Referência API interativa .

Identificadores de estrutura

Nome

O nome da estrutura é padronizado como "Home", mas pode ser qualquer string que o usuário escolher. Quando você escolhe Estrutura de leitura / gravação permissão, você pode alterar a estrutura name .

Onde está a

wheres é um conjunto objecto numa estrutura, onde contendo identificadores ( where_id e name ). Use wheres para criar personalizado onde os nomes, ou padrão de acesso onde os nomes.

O acesso ao wheres objeto requer Camera , Smoke + CO Alarm , ou Termostato permissões.

where_id

• Um identificador exclusivo, gerado-Nest que representa name
• where_id é só de leitura, e é criado automaticamente na chamada para criar um personalizado, onde name

name

• O nome de exibição do dispositivo; pode ser qualquer nome de sala de uma lista que fornecemos ou um nome personalizado
• Para criar um personalizado, onde name , fazer uma chamada POST para escrever um novo, costume, onde name ; o where_id é devolvido na chamada
• Considerações
  • name não pode ser editados ou apagados após a criação
  • name deve ser exclusivo dentro da estrutura
  • Se um dispositivo for emparelhado a uma estrutura, o costume em name associado ao dispositivo é acessível a partir do /structures/ caminho
  • Para mover um dispositivo com um costume onde name de uma estrutura diferente, desemparelhar o dispositivo, e em seguida re-emparelhar o dispositivo com o nome pretendido

Saiba mais sobre nomes para termostatos Ninho , Ninho Protege e ninho de webcams .

Outros metadados

Todos os valores de dados são somente leitura, a menos que seja especificado de outra forma.

Valor de Dados	Descrição
structure_id	Uma string que representa com exclusividade essa estrutura. Cada desenvolvedor verá um ID diferente para a mesma estrutura, mas vários produtos do mesmo desenvolvedor verão o mesmo ID
country_code	Um código de país ISO 3166-1 alfa-2 que mapeia para o local registrado da estrutura
postal_code	CEP ou código postal, dependendo do país
time_zone	Um IANA fuso horário cadeia que mapeia para o fuso horário do estrutura

Recursos de estrutura

Estados de alarme de fumaça e CO

Quando você escolhe Smoke + CO permissão de leitura , você pode acessar smoke_alarm_state e co_alarm_state no structures objeto. Estes mesmos valores de dados também estão disponíveis no objecto dispositivo ( devices/smoke_co_alarms ).

Veja o Smoke + guia de alarme de CO para mais informações sobre esses estados.

Restrições relacionadas à estrutura

Muitos valores de dados trabalham juntos para determinar como os dispositivos se comportam em uma estrutura.

• Quando uma estrutura away do estado está definido para away a palavra "ECO" é exibido no Ninho termostato, no idioma de preferência do usuário
• Quando uma estrutura away do estado está definido para away , você pode:
  • conjunto fan_timer_active
  • mudança target_temperature_f ou target_temperature_c
• Quando uma estrutura away do estado está definido para home , você pode:
  • fazer uma chamada ETA (definir id de viagem e janela de chegada)
• Quando Emergency Shutoff está ativo, você não pode definir fan_timer_active
• Quando Calor de emergência estiver habilitado, você não pode pode definir estrutura para away

Estruturas múltiplas

É possível que um usuário tenha mais de uma estrutura anexada à sua conta Nest, então seu produto deve oferecer um meio para o usuário escolher entre as estruturas disponíveis (um seletor de estrutura).

Por exemplo, ao configurar o ETA, é importante que o usuário possa escolher uma estrutura para o destino do ETA. De maneira semelhante, um usuário poderia ter dois detectores de fumaça na "sala de estar" de duas casas diferentes. Se você precisar fazer correlação de estrutura com seu próprio conceito de casa, recomendamos que faça isso durante o processo de autorização.

Saiba como os usuários a gerenciar dispositivos em várias estruturas .

Máximo do dispositivo

Existem limites para o número de dispositivos que o Nest suporta em uma estrutura.

Tipo de dispositivo	Máx. Por estrutura
Nest Thermostat	20
Câmeras Nest	10
Nest Protect	18

Mensagens de erro

Para obter informações sobre o que os erros de chamadas API significa e como lidar com eles, ver mensagens de erro .