O objeto de dispositivo (tecnicamente com.hubitat.app.DeviceWrapper
, com.hubitat.app.ChildDeviceWrapper
e com.hubitat.app.ParentDeviceWrapper
) é composto de métodos que permitem interagir com as configurações e valores de um dispositivo. Este objeto está disponível para aplicativos que receberam acesso por meio de uma entrada de seleção de dispositivo, como dispositivos filhos de aplicativos e outros dispositivos, e um driver também tem acesso a isso por meio do objeto de dispositivo.
Recuperar o valor atual de um atributo. Por padrão, esse valor é armazenado em cache durante uma única execução do driver.
Objeto valoratual(String nome do atributo)
Object currentValue(String atributoName, boolean skipCache)
attributeName
- O atributo do qual obter o valor atual.skipCache
- Opcional, não use o valor armazenado em cache do atributo, em vez disso, force o sistema a ler o mais recente do banco de dados.O valor atual de um atributo.
Recuperar uma lista de eventos para o dispositivo. Por padrão, o número máximo de eventos retornados na lista é 10, que pode ser substituído pela opção max.
Listar<Evento> eventos()
Listar<Evento> eventos(Opções do mapa)
options
- Valores opcionais para obter a lista de eventos. Valores possíveis:
max
- O número máximo de eventos a serem recuperados.Lista de objetos Event para o dispositivo
##eventosDesde
Recuperar uma lista de eventos desde uma data/hora.
List<Event> eventsSince(Data startDate)
List<Event> eventsSince(Data startDate, Opções do mapa)
startDate
- A data/hora para listar os eventos desde então.options
- Valores opcionais para obter a lista de eventos. Valores possíveis:
max
O número máximo de eventos a serem recuperados.Uma lista de eventos (o padrão é 10 eventos, a menos que especificado de outra forma nas opções)
// Recebe eventos desde as 8h de hoje
def eventos = eventsSince(timeToday("08:00"))
//Obtém no máximo 5 eventos
def eventos = eventsSince(timeToday("08:00"), [máx:5])
Recuperar o nome do dispositivo.
String getNome()
nenhum
String
- O nome do dispositivo
Atualize o nome do dispositivo.
void setName(Nome da string)
name
- o novo nome do dispositivo.
nenhum
Recupere a etiqueta do dispositivo.
String getLabel()
nenhum
String
- O rótulo do dispositivo
Atualize o rótulo do dispositivo.
void setLabel (Rótulo de string)
label
- o novo rótulo do dispositivo.
nenhum
Determina se o dispositivo possui o atributo especificado. Isso funciona para atributos integrados e personalizados.
Boolean hasAttribute (atributo String)
atributo
- O atributo a ser verificado.
Verdadeiro se o atributo existir; caso contrário, falso.
Determina se o dispositivo tem a capacidade especificada.
Boolean hasCapability (capacidade de string)
capability
- A capacidade de verificação.
Verdadeiro se a capacidade existir; caso contrário, falso.
Determina se o dispositivo possui o comando especificado. Isso funciona para comandos integrados e personalizados.
Boolean hasCommand (comando String)
command
- O comando a ser verificado.
Verdadeiro se o comando existir; caso contrário, falso.
Objeto getSetting (nome da string)
String name
: nome da configuraçãoValor da configuração com o nome especificado
Atualiza o valor de uma configuração (preferência) para o valor especificado. Se a configuração não existir, este método irá criá-la.
void updateSetting(Nome da string, opções do mapa)
options
- Map
com as chaves type
e value
, por exemplo,[tipo: "número", valor: 5]
void updateSetting (nome da string, valor longo)
void updateSetting(Nome da string, valor booleano)
void updateSetting (nome da string, valor da string)
void updateSetting (nome da string, valor duplo)
void updateSetting (nome da string, valor da data)
void updateSetting (nome da string, valor da lista)
name
- O nome da configuração a ser atualizadavalue
- O valor a ser armazenado na configuraçãoNenhum
Remove a configuração especificada das configurações salvas (preferências do dispositivo)
void removeSetting(Nome da string)
String name
- nome da configuração a ser removidaNenhum
Obtenha todos os valores de dados deste dispositivo.
Mapa getData()
Nenhum
Mapa
- Todos os valores de dados.
Obtenha um valor de dados que foi definido para este dispositivo.
String getDataValue (nome da string)
DEPRECADO: Consulte getDataValue
; este método é um wrapper para getDataValue.
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 nome)
(Desde 2.2.1)
name
- O nome do item de dados a ser removido.
Nenhum.
List<Evento> eventsBetween(Data inícioData, Data fimData)
List<Event> eventsBetween(Data startDate, Date endDate, Opções de mapa = null)
List<State> statesSince(String atributoName, Date startDate)
List<State> statesSince(String atributoName, Date startDate, Map options = null)
void sendEvent (propriedades do mapa)
void clearSetting(Nome da string)
Long getIdAsLong()
String getId()
String getEndpointId()
String getZigbeeId()
Hub getHub()
String getStatus()
String getDisplayName()
void setDisplayName(String displayName)
String getDeviceNetworkId()
void setDeviceNetworkId(String dni)
Estado estadoatual(String nome do atributo)
Estado currentState(String atributoName, boolean skipCache)
Objeto últimoValor(String nome do atributo)
Objeto lastValue (String atributoName, boolean skipCache)
Estado estadoúltimo(String nome do atributo)
Estado lastState(String atributoName, boolean skipCache)
List<Estado> getCurrentStates()
List<Command> getSupportedCommands()
List<Atributo> getSupportedAttributes()
List<Capabilidade> getCapabilities()
Data getLastActivity()
GetParentDeviceId longo()
GetParentAppId longo()
Booleano getIsComponent()
booleano isDisabled()