O Google está comprometido em promover a equidade racial para as comunidades negras. Veja como.
Esta página foi traduzida pela API Cloud Translation.
Switch to English

Estrutura

Estruturas

As estruturas de ninhos 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 do Nest fornece acesso aos seguintes dados no nível da estrutura, dependendo do nível de permissões concedidas:

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

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

Permissões de estrutura

Para acessar ... Selecione ...
A maioria dos valores de dados no objeto de structures Permissões ausente , ETA , Energia ou código postal
O valor dos dados do name no objeto de structures Estrutura de permissão de leitura / gravação

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

Identificadores de estrutura

Nome

O nome da estrutura é padronizado como "Início", mas pode ser qualquer sequência que o usuário escolher. Ao escolher a permissão de leitura / gravação da estrutura, você pode alterar o name da estrutura.

Onde está a

wheres é um objeto definido em uma estrutura, contendo identificadores where_id ( where_id e name ). Use wheres para criar nomes de locais personalizados ou acessar nomes de locais padrão.

O acesso ao objeto wheres requer permissões de Câmera , Fumaça + Alarme de CO ou Termostato .

where_id

  • Um identificador exclusivo gerado pelo Nest que representa o name
  • where_id é somente leitura e é criado automaticamente na chamada para criar um name where personalizado

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 name local personalizado, faça uma chamada POST para escrever um novo name local personalizado; o where_id é retornado na chamada
  • Considerações
    • name não pode ser editado ou excluído após a criação
    • name deve ser exclusivo dentro da estrutura
    • Se um dispositivo estiver emparelhado com uma estrutura, o name personalizado do local associado ao dispositivo poderá ser acessado a partir do caminho /structures/
    • Para mover um dispositivo com um name where personalizado para uma estrutura diferente, desemparelhe o dispositivo e emparelhe novamente o dispositivo com o nome desejado

Saiba mais sobre os nomes de termostatos Nest , Nest Protects e Nest Cams .

Outros metadados

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

Valor dos dados Descrição
structure_id Uma sequência que representa exclusivamente essa estrutura. Todo 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 Uma sequência de fuso horário da IANA que é mapeada para o fuso horário da estrutura

Recursos da estrutura

Estados de alarme de fumaça e CO

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

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

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

  • Quando um estado away estrutura é definido como away a palavra "ECO" é exibida no Nest Thermostat, no idioma preferido do usuário
  • Quando um estado away estrutura é definido como away , você pode:
    • definir fan_timer_active
    • alterar target_temperature_f ou target_temperature_c
  • Quando um estado away estrutura é definido como home , você pode:
    • faça uma chamada ETA (defina o ID da viagem e a janela de chegada)
  • Quando o Desligamento de emergência está ativo, você não pode definir fan_timer_active
  • Quando o Calor de Emergência está ativado, você não pode definir a estrutura como away

Estruturas múltiplas

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

Seletor de estrutura

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

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

Máximos do dispositivo

Existem limites para quantos dispositivos o Nest suporta em uma estrutura.

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

Mensagens de erro

Para obter informações sobre o significado dos erros de chamada da API e como lidar com eles, consulte Mensagens de erro .