Notice: We're retiring Works with Nest. See the home page for more information.
O Google tem o compromisso de promover a igualdade racial para as comunidades negras. Saiba como.
Esta página foi traduzida pela API Cloud Translation.
Switch to English

Estrutura

estruturas

estruturas ninho representam estruturas físicas do mundo real. Normalmente home do usuário, eles servem como um ponto organizando para dispositivos e irá armazenar os dados que se aplica 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 estrutura e dispositivo "onde o nome" (localização na casa)
  • A lista de dispositivos em casa
  • Status do evento de energia ( energia hora do rush )
  • estado afastado
  • ETA usuário
  • estado de segurança
  • Postal ou código postal

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

permissões de estrutura

Para acesso a ... Escolha ...
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 dos padrões de estrutura para "Home", mas pode ser qualquer cadeia os escolhe usuário. 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 apresentação do dispositivo; Pode ser qualquer nome quarto de uma lista que oferecemos, 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, salvo indicação em contrário.

dados do Valor Descrição
structure_id A cadeia que representa com exclusividade esta estrutura. Todo desenvolvedor verá um ID diferente para a mesma estrutura, mas vários produtos do mesmo desenvolvedor vai ver o mesmo ID
country_code Um ISO 3166-1 alpha-2 do país que mapeia para a localização registrada da estrutura
postal_code Postal ou CEP, dependendo do país
time_zone Um IANA fuso horário cadeia que mapeia para o fuso horário do estrutura

características de estrutura

Fumaça e CO estados de alarme

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.

Muitos valores de dados trabalhar juntos para determinar como os dispositivos se comportar de 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 de ETA (id set viagem e janela da 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 tem mais de uma estrutura ligados à sua Conta Nest, para que o seu produto deve oferecer um meio para que o usuário escolha a partir das estruturas disponíveis (um seletor de estrutura).

picker estrutura

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

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

máximos de dispositivos

Há limites para quantos suportes dispositivos ninho em uma estrutura.

Tipo de dispositivo Max por estrutura
Nest Thermostat 20
Câmeras ninho 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 .