Esses métodos estão disponíveis para uso no código do driver.
DICA: consulte também Métodos comuns, que inclui métodos disponíveis para aplicativos e drivers.
Cria um novo dispositivo filho e retorna esse dispositivo da chamada de método.
ChildDeviceWrapper addChildDevice(String namespace, String typeName, String deviceNetworkId, Propriedades do mapa = [:])
ChildDeviceWrapper addChildDevice(String typeName, String deviceNetworkId, Propriedades do mapa = [:])
namespace - O namespace do driver filho a ser adicionado como um dispositivo filho (opcional, se não for especificado, o padrão será o namespace do pai)
typeName - O nome do driver filho a ser adicionado como dispositivo filho
deviceNetworkId - identificador exclusivo para este dispositivo
properties - parâmetros opcionais para este dispositivo filho. Valores possíveis:
boolean isComponent - verdadeiro ou falso, se verdadeiro, o dispositivo ainda aparecerá na lista de dispositivos, mas não poderá ser excluído ou editado na UI. Se for falso, o dispositivo pode ser modificado/excluído na UI.
String name - nome do dispositivo filho, se não for especificado, o nome do driver será usado.
String label - rótulo do dispositivo filho, se não for especificado, será deixado em branco.
ChildDeviceWrapper
##getChildDevices
Obtém uma lista de todos os dispositivos filhos deste dispositivo.
List<ChildDeviceWrapper> getChildDevices()Nenhum
Lista<ChildDeviceWrapper>
Obtém um dispositivo filho específico com o ID de rede do dispositivo especificado.
ChildDeviceWrapper getChildDevice(String deviceNetworkId)deviceNetworkId - O identificador exclusivo do dispositivoChildDeviceWrapper
Exclui um dispositivo filho específico com o ID de rede do dispositivo especificado.
void deleteChildDevice(String deviceNetworkId)deviceNetworkId - O identificador exclusivo do dispositivoNenhum
Retorna o dispositivo pai (ParentDeviceWrapper) ou aplicativo (InstalledAppWrapper) quando chamado de um dispositivo filho.
Objeto getParent()O ParentDeviceWrapper ou InstalledAppWrapper
Obtenha um valor de dados que foi definido para este dispositivo.
String getDataValue(String nome)name - O valor String do item de dados.String - O valor dos dados.
DESCONTINUADO: Veja getDataValue; este método é um wrapper para getDataValue.
Retorna o nome especificado pelo usuário da Room à qual o usuário atribuiu este dispositivo ou null se nenhuma sala foi atribuída.
String getRoomName()Nenhum
String - O nome da sala atribuída, ou null se nenhuma sala atribuída.
##getRoomId
Retorna o ID exclusivo da Room à qual o usuário atribuiu este dispositivo.
String getRoomId()Nenhum
Long - O ID exclusivo da sala atribuída
Atualize ou crie um valor de dados para este dispositivo.
void updateDataValue (nome da string, valor da string)name - O nome do item de dados a ser armazenado.
value - O valor do item de dados a ser armazenado.
Nenhum
Remova um valor de dados de um dispositivo.
void removeDataValue(String name) (Desde 2.2.1)name - O nome do item de dados a ser removido.Nenhum.
Use este método para enviar um HubAction imediatamente.
void sendHubCommand(HubAction hubAction)hubAction - O objeto HubAction a ser enviado.nenhum
Cria um mapa que representa dados de um evento. Isso não disparará um evento por conta própria; o Map resultante (ou uma Lista de tais objetos Map) deve ser retornado do método parse() no driver. Alternativamente, use sendEvent() para criar e disparar um evento (nossa recomendação). Esses métodos são idênticos.
Mapa createEvent (Opções do mapa)options idênticas às de sendEvent() (veja abaixo)createEvent(nome: "switch", valor: "off")Mapa com dados do eventoDispara um evento, ou seja, define o valor de um atributo com base nos valores do mapa fornecido. (Os atributos podem ser vistos em Estados atuais na página de detalhes do dispositivo na interface regular do hub.)
void sendEvent (propriedades do mapa)properties - um Mapa de propriedades para o evento. As chaves válidas são:
String name (obrigatório) - nome do evento (normalmente o nome de um atributo do dispositivo)value (obrigatório) - valor do evento (o tipo de dados deve ser match o tipo definido para o atributo conforme definido pelo recurso ou pelo tipo de atributo personalizado)String unit - unidades correspondentes ao valor (por exemplo, pode ser "%" para level ou omitida para switch)String descriptionText - uma descrição amigável do evento, opcional, mas geralmente fornecida em um formato como "[Nome do dispositivo] [nome do evento] é [valor do evento]", possivelmente com informações adicionais, por exemplo, " O nível de dimmer da sala de estar é 50%" ou "O botão do quarto pressionado é 1 [phyiscal]".Boolean isStateChange - definido como true para forçar a geração de um evento mesmo se o novo valor for igual ao valor antigo (opcional e geralmente omitido em favor da filtragem padrão por plataforma; eventos de botão são um caso em que muitas vezes é necessário)sendEvent(nome: "colorTemperature", valor: 2700, unidade: "K")nenhum
Para métodos de retorno de chamada — executados em resposta a determinadas ações no ambiente Hubitat — e mais informações sobre o código do driver, consulte: Código do dispositivo.
Mapa getState()Zwave getZwave()Zigbee getZigbee()Resposta HubAction (String cmd)Resposta HubAction (hubitat.zwave.Command cmd)Resposta HubMultiAction (Lista cmds)GetZwaveHubNodeId curto()List eventsSince(Data inícioData, Opções do mapa = null)void telnetConnect(Opções de mapa, String ip, porta int, String nome de usuário, String senha)void telnetConnect(String ip, porta int, String nome de usuário, String senha)void telnetClose()List delayBetween(List cmds, Longo atraso)List delayBetween(List cmds)