Partilhar via


Philips HUE (Editora Independente)

O Philips HUE permite-lhe controlar dispositivos domésticos inteligentes, como luzes, interruptores, fichas e muito mais construídos pela Philips.

Este conector está disponível nos seguintes produtos e regiões:

Serviço Class Regiões
Estúdio Copiloto Premium Todas as regiões do Power Automatic , exceto as seguintes:
     - Governo dos EUA (CCG)
     - Governo dos EUA (GCC High)
     - China Cloud operado pela 21Vianet
     - Departamento de Defesa dos EUA (DoD)
Aplicações Lógicas Standard Todas as regiões do Logic Apps , exceto as seguintes:
     - Regiões do Azure Government
     - Regiões do Azure China
     - Departamento de Defesa dos EUA (DoD)
Aplicações Power Premium Todas as regiões do Power Apps , exceto as seguintes:
     - Governo dos EUA (CCG)
     - Governo dos EUA (GCC High)
     - China Cloud operado pela 21Vianet
     - Departamento de Defesa dos EUA (DoD)
Automatize o poder Premium Todas as regiões do Power Automatic , exceto as seguintes:
     - Governo dos EUA (CCG)
     - Governo dos EUA (GCC High)
     - China Cloud operado pela 21Vianet
     - Departamento de Defesa dos EUA (DoD)
Contato
Nome Tomasz Poszytek
URL https://aka.ms/poszytek
Email tomasz@poszytek.eu
Metadados do conector
Editora Tomasz Poszytek
Sítio Web https://www.philips-hue.com/
Política de privacidade https://www.philips-hue.com/en-us/support/legal/privacy-policy
Categorias Internet das Coisas; Estilo de vida e entretenimento

A criar uma ligação

O conector suporta os seguintes tipos de autenticação:

Predefinição Parâmetros para criar conexão. Todas as regiões Não compartilhável

Padrão

Aplicável: Todas as regiões

Parâmetros para criar conexão.

Esta conexão não é compartilhável. Se o aplicativo avançado for compartilhado com outro usuário, outro usuário será solicitado a criar uma nova conexão explicitamente.

Nome Tipo Description Obrigatório
Chave de aplicação HUE securestring A chave de API que é retornada após a execução de chamadas de autorização PUT e POST. Verdade

Limites de Limitação

Name Chamadas Período de Renovação
Chamadas de API por conexão 100 60 segundos

Ações

Excluir cena

Excluir cena específica.

Executar dispositivo

Execute um dispositivo específico.

Execute a luz

Execute um dispositivo com recursos de relâmpago.

Obter cena

Obtenha detalhes de uma cena específica.

Obter cenas

Obtenha uma lista de todas as cenas. As cenas são usadas para armazenar e recuperar configurações para um grupo de luzes.

Obter dispositivo

Obtenha detalhes de um dispositivo específico.

Obter dispositivos

Obtenha uma lista de todos os seus dispositivos.

Obter luzes

Obtenha uma lista dos seus dispositivos com capacidades lightning.

Obter quartos

Obter lista de quartos (grupos).

Receba luz

Obtenha detalhes de um dispositivo específico com recursos de relâmpago.

Excluir cena

Excluir cena específica.

Parâmetros

Name Chave Necessário Tipo Description
ID da cena
SceneId True string

Id de uma cena a ser excluída.

Devoluções

Name Caminho Tipo Description
dados
data array of object

Cenas atualizadas.

livrar-se
data.rid string

O id exclusivo da cena excluída.

tipo rtype
data.rtype string

O tipo de cena excluída.

erros
errors array of object

Erros que ocorreram durante a chamada.

Descrição do erro
errors.description string

Uma explicação legível por humanos específica para esta ocorrência do problema.

Executar dispositivo

Execute um dispositivo específico.

Parâmetros

Name Chave Necessário Tipo Description
ID do dispositivo
DeviceId True string

Id de um dispositivo para atualizar metadados.

Arquétipo
archetype string

Por padrão, arquétipo dado pelo fabricante.

Nome
name string

Nome legível por humanos de um recurso (máx. 32 caracteres).

Ação
action string

Digite "identificar" para acionar a identificação. O Bridge realiza ciclos de identificação de LED Zigbee por 5 segundos. As luzes realizam um ciclo de respiração. Os sensores realizam ciclos de identificação de LED por 15 segundos.

Devoluções

Name Caminho Tipo Description
dados
data array of object

Dispositivos atualizados.

livrar-se
data.rid string

A id exclusiva do recurso referenciado.

tipo rtype
data.rtype string

O tipo do recurso referenciado.

erros
errors array of object

Erros que ocorreram durante a chamada.

Descrição do erro
errors.description string

Uma explicação legível por humanos específica para esta ocorrência do problema.

Execute a luz

Execute um dispositivo com recursos de relâmpago.

Parâmetros

Name Chave Necessário Tipo Description
ID do dispositivo
DeviceId True string

Id de um dispositivo para atualizar propriedades.

Nome
name string

MinLength: 1 - maxLength: 32. Nome legível por humanos de um recurso.

On
on boolean

Estado ligado/desligado da luz ligado=verdadeiro, desligado=falso.

Brilho
brightness float

Máximo: 100. Percentagem de brilho. Escrever 0 muda para o menor brilho possível.

Mirek
mirek integer

Mínimo: 153 - máximo: 500. Temperatura de cor em mirek ou nula quando a cor clara não está no espectro ct.

X
x float

Mínimo: 0 - máximo: 1. Posição X na gama de cores.

Y
y float

Mínimo: 0 - máximo: 1. Posição Y na gama de cores.

Velocidade
speed float

Mínimo: 0 - máximo: 1. Velocidade da paleta dinâmica. A velocidade é válida para a paleta dinâmica se o status for dynamic_palette ou para o efeito correspondente listado em status. Em caso de status nenhum, a velocidade não é válida.

Duração
duration integer

Máximo: 6000000. Duração de uma transição ligeira em ms. A precisão está em passos de 100ms.

Ação
action string

Uma das ações disponíveis para executar em um dispositivo. Ou seja, "respirar".

X
x float

Mínimo: 0 - máximo: 1. Posição X na gama de cores.

Y
y float

Mínimo: 0 - máximo: 1. Posição Y na gama de cores.

Devoluções

Name Caminho Tipo Description
dados
data array of object

dados

livrar-se
data.rid string

livrar-se

tipo rtype
data.rtype string

tipo rtype

erros
errors array of object

Erros que ocorreram durante a chamada.

Descrição do erro
errors.description string

Uma explicação legível por humanos específica para esta ocorrência do problema.

Obter cena

Obtenha detalhes de uma cena específica.

Parâmetros

Name Chave Necessário Tipo Description
ID da cena
SceneId True string

Id de uma cena para exibir detalhes.

Devoluções

Name Caminho Tipo Description
erros
errors array of object

Erros que ocorreram durante a chamada.

Descrição do erro
errors.description string

Uma explicação legível por humanos específica para esta ocorrência do problema.

dados
data array of object

Dados.

Ações
data.actions array of object

Lista de ações executadas em cena.

X
data.actions.action.color.xy.x float

Mínimo: 0 - máximo: 1. Posição X na gama de cores.

Y
data.actions.action.color.xy.y float

Mínimo: 0 - máximo: 1. Posição Y na gama de cores.

Brilho
data.actions.action.dimming.brightness float

Máximo: 100. Percentagem de brilho. Escrever 0 muda para o menor brilho possível.

On
data.actions.action.on.on boolean

Estado ligado/desligado da luz ligado=verdadeiro, desligado=falso.

Mirek
data.actions.action.color_temperature.mirek integer

Mínimo: 153 - máximo: 500. Temperatura de cor em mirek ou nula quando a cor clara não está no espectro ct.

livrar-se
data.actions.target.rid string

A id exclusiva do recurso referenciado.

tipo rtype
data.actions.target.rtype string

O tipo do recurso referenciado.

livrar-se
data.group.rid string

A id exclusiva do recurso referenciado.

tipo rtype
data.group.rtype string

O tipo do recurso referenciado.

Id
data.id string

Identificador exclusivo que representa uma instância de recurso específica.

ID v1
data.id_v1 string

Identificador de recurso Clip v1 (a ser usado na API v1).

livrar-se
data.metadata.image.rid string

A id exclusiva do recurso referenciado.

tipo rtype
data.metadata.image.rtype string

O tipo do recurso referenciado.

Nome
data.metadata.name string

Nome legível por humanos de um recurso.

Cor
data.palette.color array of object
X
data.palette.color.color.xy.x float

Mínimo: 0 - máximo: 1. Posição X na gama de cores.

Y
data.palette.color.color.xy.y float

Mínimo: 0 - máximo: 1. Posição Y na gama de cores.

Brilho
data.palette.color.dimming.brightness float

Máximo: 100. Percentagem de brilho. Escrever 0 muda para o menor brilho possível.

Temperatura de cor
data.palette.color_temperature array of object
Mirek
data.palette.color_temperature.color_temperature.mirek integer

Mínimo: 153 - máximo: 500. Temperatura de cor em mirek ou nula quando a cor clara não está no espectro ct.

Brilho
data.palette.color_temperature.dimming.brightness float

Máximo: 100. Percentagem de brilho. Escrever 0 muda para o menor brilho possível.

Escurecimento
data.palette.dimming array of object
Brilho
data.palette.dimming.brightness float

Máximo: 100. Percentagem de brilho. Escrever 0 muda para o menor brilho possível.

Velocidade
data.speed float

Velocidade da paleta dinâmica para esta cena.

Tipo
data.type string

Tipo de recursos suportados.

Obter cenas

Obtenha uma lista de todas as cenas. As cenas são usadas para armazenar e recuperar configurações para um grupo de luzes.

Devoluções

Name Caminho Tipo Description
erros
errors array of object

Erros que ocorreram durante a chamada.

Descrição do erro
errors.description string

Uma explicação legível por humanos específica para esta ocorrência do problema.

dados
data array of object

Dados.

Ações
data.actions array of object

Lista de ações executadas em cena.

X
data.actions.action.color.xy.x float

Mínimo: 0 - máximo: 1. Posição X na gama de cores.

Y
data.actions.action.color.xy.y float

Mínimo: 0 - máximo: 1. Posição Y na gama de cores.

Brilho
data.actions.action.dimming.brightness float

Máximo: 100. Percentagem de brilho. Escrever 0 muda para o menor brilho possível.

On
data.actions.action.on.on boolean

Estado ligado/desligado da luz ligado=verdadeiro, desligado=falso.

Mirek
data.actions.action.color_temperature.mirek integer

Mínimo: 153 - máximo: 500. Temperatura de cor em mirek ou nula quando a cor clara não está no espectro ct.

livrar-se
data.actions.target.rid string

A id exclusiva do recurso referenciado.

tipo rtype
data.actions.target.rtype string

O tipo do recurso referenciado.

livrar-se
data.group.rid string

A id exclusiva do recurso referenciado.

tipo rtype
data.group.rtype string

O tipo do recurso referenciado.

Id
data.id string

Identificador exclusivo que representa uma instância de recurso específica.

ID v1
data.id_v1 string

Identificador de recurso Clip v1 (a ser usado na API v1).

livrar-se
data.metadata.image.rid string

A id exclusiva do recurso referenciado.

tipo rtype
data.metadata.image.rtype string

O tipo do recurso referenciado.

Nome
data.metadata.name string

Nome legível por humanos de um recurso.

Cor
data.palette.color array of object
X
data.palette.color.color.xy.x float

Mínimo: 0 - máximo: 1. Posição X na gama de cores.

Y
data.palette.color.color.xy.y float

Mínimo: 0 - máximo: 1. Posição Y na gama de cores.

Brilho
data.palette.color.dimming.brightness float

Máximo: 100. Percentagem de brilho. Escrever 0 muda para o menor brilho possível.

Temperatura de cor
data.palette.color_temperature array of object
Mirek
data.palette.color_temperature.color_temperature.mirek integer

Mínimo: 153 - máximo: 500. Temperatura de cor em mirek ou nula quando a cor clara não está no espectro ct.

Brilho
data.palette.color_temperature.dimming.brightness float

Máximo: 100. Percentagem de brilho. Escrever 0 muda para o menor brilho possível.

Escurecimento
data.palette.dimming array of object
Brilho
data.palette.dimming.brightness float

Máximo: 100. Percentagem de brilho. Escrever 0 muda para o menor brilho possível.

Velocidade
data.speed float

Velocidade da paleta dinâmica para esta cena.

Tipo
data.type string

Tipo de recursos suportados.

Obter dispositivo

Obtenha detalhes de um dispositivo específico.

Parâmetros

Name Chave Necessário Tipo Description
ID do dispositivo
DeviceId True string

Id de um dispositivo para exibir detalhes.

Devoluções

Name Caminho Tipo Description
erros
errors array of object

Erros que ocorreram durante a chamada.

Descrição do erro
errors.description string

Uma explicação legível por humanos específica para esta ocorrência do problema.

dados
data array of object

Dispositivos que correspondem a um determinado ID.

Id
data.id string

Identificador exclusivo que representa uma instância de recurso específica.

ID v1
data.id_v1 string

Identificador de recurso Clip v1 (a ser usado na API v1).

Arquétipo
data.metadata.archetype string

Arquétipo padrão dado pelo fabricante.

Nome
data.metadata.name string

Nome legível por humanos de um recurso.

Certificado
data.product_data.certified boolean

Este dispositivo é certificado HUE.

Nome do fabricante
data.product_data.manufacturer_name string

Nome do fabricante do dispositivo.

ID do modelo
data.product_data.model_id string

identificação única do modelo do dispositivo.

Arquétipo do produto
data.product_data.product_archetype string

Arquétipo do produto.

Nome do produto
data.product_data.product_name string

Nome do produto.

Versão de software
data.product_data.software_version string

Versão do software do produto.

Services
data.services array of object

Referencia todos os serviços agregando controle e estado das crianças no grupo.

livrar-se
data.services.rid string

A id exclusiva do recurso referenciado.

tipo rtype
data.services.rtype string

O tipo do recurso referenciado.

Tipo
data.type string

Tipo do recurso suportado.

Obter dispositivos

Obtenha uma lista de todos os seus dispositivos.

Devoluções

Name Caminho Tipo Description
erros
errors array of object

Erros que ocorreram durante a chamada.

Descrição do erro
errors.description string

Uma explicação legível por humanos específica para esta ocorrência do problema.

dados
data array of object

Dispositivos do usuário.

Id
data.id string

Identificador exclusivo que representa uma instância de recurso específica.

ID v1
data.id_v1 string

Identificador de recurso Clip v1 (a ser usado na API v1).

Arquétipo
data.metadata.archetype string

Arquétipo padrão dado pelo fabricante.

Nome
data.metadata.name string

Nome legível por humanos de um recurso.

Certificado
data.product_data.certified boolean

Este dispositivo é certificado HUE.

Nome do fabricante
data.product_data.manufacturer_name string

Nome do fabricante do dispositivo.

ID do modelo
data.product_data.model_id string

identificação única do modelo do dispositivo.

Arquétipo do produto
data.product_data.product_archetype string

Arquétipo do produto.

Nome do produto
data.product_data.product_name string

Nome do produto.

Versão de software
data.product_data.software_version string

Versão do software do produto.

Services
data.services array of object

Referencia todos os serviços agregando controle e estado das crianças no grupo.

livrar-se
data.services.rid string

A id exclusiva do recurso referenciado.

tipo rtype
data.services.rtype string

O tipo do recurso referenciado.

Tipo
data.type string

Tipo do recurso suportado.

Obter luzes

Obtenha uma lista dos seus dispositivos com capacidades lightning.

Devoluções

Name Caminho Tipo Description
erros
errors array of object

Erros que ocorreram durante a chamada.

Descrição do erro
errors.description string

Uma explicação legível por humanos específica para esta ocorrência do problema.

dados
data array of object

Luzes do usuário.

Valores de ação
data.alert.action_values array of string

Lista de efeitos de alerta suportados pela luz.

Azul X
data.color.gamut.blue.x float

Posição X na gama de cores.

Azul Y
data.color.gamut.blue.y float

Posição Y na gama de cores.

Verde X
data.color.gamut.green.x float

Posição X na gama de cores.

Verde Y
data.color.gamut.green.y float

Posição X na gama de cores.

Vermelho X
data.color.gamut.red.x float

Posição X na gama de cores.

Vermelho Y
data.color.gamut.red.y float

Posição X na gama de cores.

Tipo de gama
data.color.gamut_type string

Os tipos de gama suportados pela tonalidade: A - Gamut dos primeiros produtos Philips apenas de cor, B - Gama limitada dos primeiros produtos de cor Hue, C - Gama de cores mais rica de produtos de ambiente de cor e branco Hue, outros - Gama de cores de produtos sem matiz.

X
data.color.xy.x float

Posição X na gama de cores.

Y
data.color.xy.y float

Posição Y na gama de cores.

Mirek
data.color_temperature.mirek integer

Temperatura de cor em mirek ou nula quando a cor clara não está no espectro ct.

Mirek máximo
data.color_temperature.mirek_schema.mirek_maximum integer

Temperatura máxima de cor suportada por esta luz.

Mirek mínimo
data.color_temperature.mirek_schema.mirek_minimum integer

Temperatura de cor mínima suportada por esta luz.

Mirek válido
data.color_temperature.mirek_valid boolean

Indicação se o valor apresentado em mirek é válido.

Brilho
data.dimming.brightness float

Percentagem de brilho. valor não pode ser 0, escrever 0 altera-o para o menor brilho possível.

Nível mínimo de escurecimento
data.dimming.min_dim_level float

Porcentagem do lúmen máximo que o dispositivo emite no brilho mínimo.

Velocidade
data.dynamics.speed float

Velocidade da paleta dinâmica ou efeito. A velocidade é válida para a paleta dinâmica se o status for dynamic_palette ou para o efeito correspondente listado em status. Em caso de status nenhum, a velocidade não é válida.

Velocidade válida
data.dynamics.speed_valid boolean

Indica se o valor apresentado em velocidade é válido.

Situação
data.dynamics.status string

Estado atual da lâmpada com dinâmica.

Valores de status
data.dynamics.status_values array of string

Status em que uma lâmpada pode estar ao jogar dinâmicas.

ID do recurso
data.id string

Identificador exclusivo que representa uma instância de recurso específica.

ID do recurso do Clip v1
data.id_v1 string

Identificador de recurso do Clip v1 (versão da API v1).

Arquétipo
data.metadata.archetype string

Arquétipo de luz. Preterido: use o arquétipo no nível do dispositivo.

Nome próprio do dispositivo
data.metadata.name string

Nome legível por humanos de um recurso.

Mode
data.mode string

Um dos: normal ou streaming.

Estado de luz
data.on.on boolean

Estado ligado/desligado da luz: on=true, off=false.

RID
data.owner.rid string

A id exclusiva do recurso referenciado.

Rtype
data.owner.rtype string

O tipo do recurso referenciado.

Tipo
data.type string

Tipo de recursos suportados.

Obter quartos

Obter lista de quartos (grupos).

Devoluções

Name Caminho Tipo Description
erros
errors array of object

Erros que ocorreram durante a chamada.

Descrição do erro
errors.description string

Uma explicação legível por humanos específica para esta ocorrência do problema.

dados
data array of object

Dados.

Subordinados
data.children array of object

Dispositivos para agrupar pela sala. São permitidas as seguintes crianças: "dispositivo".

livrar-se
data.children.rid string

O id único da cena criada.

tipo rtype
data.children.rtype string

O tipo de cena criada.

Serviços agrupados
data.grouped_services array of object

Referências a serviços de controlo agregados. Preterido: use serviços.

livrar-se
data.grouped_services.rid string

O id único da cena criada.

tipo rtype
data.grouped_services.rtype string

O tipo de cena criada.

Id
data.id string

Identificador exclusivo que representa uma instância de recurso específica.

ID v1
data.id_v1 string

Identificador de recurso Clip v1 (a ser usado na API v1).

Arquétipo
data.metadata.archetype string

Arquétipo padrão dado pelo fabricante.

Nome
data.metadata.name string

Nome legível por humanos de um recurso.

Services
data.services array of object

Referencia todos os serviços agregando controle e estado das crianças no grupo. A agregação é por tipo de serviço, ou seja, cada tipo de serviço que pode ser agrupado tem uma definição correspondente de tipo agrupado. Tipos suportados: "light".

livrar-se
data.services.rid string

O id único da cena criada.

tipo rtype
data.services.rtype string

O tipo de cena criada.

Tipo
data.type string

Tipo de recursos suportados.

Receba luz

Obtenha detalhes de um dispositivo específico com recursos de relâmpago.

Parâmetros

Name Chave Necessário Tipo Description
ID do dispositivo
DeviceId True string

Id de um dispositivo para exibir detalhes.

Devoluções

Name Caminho Tipo Description
erros
errors array of object

Erros que ocorreram durante a chamada.

Descrição do erro
errors.description string

Uma explicação legível por humanos específica para esta ocorrência do problema.

dados
data array of object

Luzes correspondentes a determinado ID.

Valores de ação
data.alert.action_values array of string

Lista de efeitos de alerta suportados pela luz.

Azul X
data.color.gamut.blue.x float

Posição X na gama de cores.

Azul Y
data.color.gamut.blue.y float

Posição Y na gama de cores.

Verde X
data.color.gamut.green.x float

Posição X na gama de cores.

Verde Y
data.color.gamut.green.y float

Posição X na gama de cores.

Vermelho X
data.color.gamut.red.x float

Posição X na gama de cores.

Vermelho Y
data.color.gamut.red.y float

Posição X na gama de cores.

Tipo de gama
data.color.gamut_type string

Os tipos de gama suportados pela tonalidade: A - Gamut dos primeiros produtos Philips apenas de cor, B - Gama limitada dos primeiros produtos de cor Hue, C - Gama de cores mais rica de produtos de ambiente de cor e branco Hue, outros - Gama de cores de produtos sem matiz.

X
data.color.xy.x float

Posição X na gama de cores.

Y
data.color.xy.y float

Posição Y na gama de cores.

Mirek
data.color_temperature.mirek integer

Temperatura de cor em mirek ou nula quando a cor clara não está no espectro ct.

Mirek máximo
data.color_temperature.mirek_schema.mirek_maximum integer

Temperatura máxima de cor suportada por esta luz.

Mirek mínimo
data.color_temperature.mirek_schema.mirek_minimum integer

Temperatura de cor mínima suportada por esta luz.

Mirek válido
data.color_temperature.mirek_valid boolean

Indicação se o valor apresentado em mirek é válido.

Brilho
data.dimming.brightness float

Percentagem de brilho. valor não pode ser 0, escrever 0 altera-o para o menor brilho possível.

Nível mínimo de escurecimento
data.dimming.min_dim_level float

Porcentagem do lúmen máximo que o dispositivo emite no brilho mínimo.

Velocidade
data.dynamics.speed float

Velocidade da paleta dinâmica ou efeito. A velocidade é válida para a paleta dinâmica se o status for dynamic_palette ou para o efeito correspondente listado em status. Em caso de status nenhum, a velocidade não é válida.

Velocidade válida
data.dynamics.speed_valid boolean

Indica se o valor apresentado em velocidade é válido.

Situação
data.dynamics.status string

Estado atual da lâmpada com dinâmica.

Valores de status
data.dynamics.status_values array of string

Status em que uma lâmpada pode estar ao jogar dinâmicas.

ID do recurso
data.id string

Identificador exclusivo que representa uma instância de recurso específica.

ID do recurso do Clip v1
data.id_v1 string

Identificador de recurso do Clip v1 (versão da API v1).

Arquétipo
data.metadata.archetype string

Arquétipo de luz. Preterido: use o arquétipo no nível do dispositivo.

Nome próprio do dispositivo
data.metadata.name string

Nome legível por humanos de um recurso.

Mode
data.mode string

Um dos: normal ou streaming.

Estado de luz
data.on.on boolean

Estado ligado/desligado da luz: on=true, off=false.

RID
data.owner.rid string

A id exclusiva do recurso referenciado.

Rtype
data.owner.rtype string

O tipo do recurso referenciado.

Tipo
data.type string

Tipo de recursos suportados.