Controlar dispositivos

Verificar se um trait oferece suporte a um comando

O suporte também pode ser verificado para um comando de traço. Use também a função supports no nível do atributo para verificar se um comando tem suporte para um dispositivo específico.

Por exemplo, para verificar se um dispositivo oferece suporte ao comando toggle da característica Ligado/Desligado:

// Check if the OnOff trait supports the toggle command.
if (onOffTrait.supports(OnOff.Command.Toggle)) {
  println("onOffTrait supports toggle command")
} else {
  println("onOffTrait does not support stateful toggle command")
}

Enviar um comando para um dispositivo

Enviar um comando é semelhante a ler um atributo de estado de um recurso. Para ligar ou desligar o dispositivo, use o comando de alternância do traço OnOff, que é definido no modelo de dados do ecossistema do Google Home como toggle(). Esse método muda onOff para false se for true ou para true se for false:

// Calling a command on a trait.
try {
  onOffTrait.toggle()
} catch (e: HomeException) {
  // Code for handling the exception
}

Todos os comandos de atributo são funções suspend e só são concluídos quando uma resposta é retornada pela API, como confirmar que o estado do dispositivo mudou. Os comandos podem retornar uma exceção se um problema for detectado no fluxo de execução. Como desenvolvedor, use um bloco try-catch para processar corretamente essas exceções e mostrar informações detalhadas aos usuários nos casos em que os erros podem ser úteis. Exceções não tratadas vão interromper o tempo de execução do app e poderão causar falhas nele.

Como alternativa, use os comandos off() ou on() para definir explicitamente o estado:

onOffTrait.off()
onOffTrait.on()

Depois de enviar um comando para mudar o estado, quando ele for concluído, você poderá ler o estado conforme descrito em Ler o estado de um dispositivo para processá-lo no app. Como alternativa, use fluxos conforme descrito em Observar o estado, que é o método preferido.

Enviar um comando com parâmetros

Alguns comandos podem usar parâmetros, como aqueles nos atributos OnOff ou LevelControl:

// Turn off the light using the DyingLight effect.
onOffTrait.offWithEffect(
  effectIdentifier = OnOffTrait.EffectIdentifierEnum.DyingLight,
  effectVariant = 0u,
)

// Change the brightness of the light to 50%
levelControlTrait.moveToLevel(
  level = 127u.toUByte(),
  transitionTime = null,
  optionsMask = LevelControlTrait.OptionsBitmap(),
  optionsOverride = LevelControlTrait.OptionsBitmap(),
)

Alguns comandos têm argumentos opcionais, que vêm depois dos argumentos obrigatórios.

Por exemplo, o comando step para o atributo FanControl tem dois argumentos opcionais:

val fanControlTraitFlow: Flow<FanControl?> =
  device.type(FanDevice).map { it.standardTraits.fanControl }.distinctUntilChanged()

val fanControl = fanControlTraitFlow.firstOrNull()

// Calling a command with optional parameters not set.
fanControl?.step(direction = FanControlTrait.StepDirectionEnum.Increase)

// Calling a command with optional parameters.
fanControl?.step(direction = FanControlTrait.StepDirectionEnum.Increase) { wrap = true }

Verificar se um atributo é compatível com um atributo

Alguns dispositivos podem oferecer suporte a uma característica Matter, mas não a um atributo específico. Por exemplo, um dispositivo Cloud-to-cloud que foi mapeado para Matter pode não oferecer suporte a todos os atributos Matter. Para lidar com casos como esses, use a função supports no nível do atributo e o tipo enumerado Attribute do atributo para verificar se o atributo tem suporte para um dispositivo específico.

Por exemplo, para verificar se um dispositivo oferece suporte ao atributo onOff da característica Ligado/Desligado:

// Check if the OnOff trait supports the onOff attribute.
if (onOffTrait.supports(OnOff.Attribute.onOff)) {
  println("onOffTrait supports onOff state")
} else {
  println("onOffTrait is for a command only device!")
}

Alguns atributos são anuláveis na especificação Matter ou no esquema smart home Cloud-to-cloud. Para esses atributos, é possível determinar se um null retornado pelo atributo é devido ao dispositivo não informar esse valor ou se o valor do atributo realmente é null, usando isNullable além de supports:

// Check if a nullable attribute is set or is not supported.
if (onOffTrait.supports(OnOff.Attribute.startUpOnOff)) {
  // The device supports startupOnOff, it is safe to expect this value in the trait.
  if (OnOff.Attribute.startUpOnOff.isNullable && onOffTrait.startUpOnOff == null) {
    // This value is nullable and set to null. Check the specification as to
    // what null in this case means
    println("onOffTrait supports startUpOnOff and it is null")
  } else {
    // This value is nullable and set to a value.
    println("onOffTrait supports startUpOnOff and it is set to ${onOffTrait.startUpOnOff}")
  }
} else {
  println("onOffTrait does not support startUpOnOff!")
}

Atualizar atributos de traço

Se você quiser mudar o valor de um determinado atributo e nenhum dos comandos da característica fizer isso, o atributo poderá ter o valor definido explicitamente.

A possibilidade de mudar o valor de um atributo depende de dois fatores:

• O atributo pode ser gravado?
• O valor do atributo pode mudar como um efeito colateral do envio de um comando de atributo?

A documentação de referência de traits e atributos fornece essas informações.

Portanto, as combinações de propriedades que determinam como o valor de um atributo pode ser alterado são:

• Somente leitura e não afetado por outros comandos. Isso significa que o valor do atributo não muda. Por exemplo, o atributo currentPosition do atributo Switch.

• Somente leitura e afetado por outros comandos. Isso significa que a única maneira de mudar o valor do atributo é como resultado do envio de um comando. Por exemplo, o atributo currentLevel da característica Matter LevelControl é somente leitura, mas o valor dela pode ser modificado por comandos como moveToLevel.

• Gravável e não afetado por outros comandos. Isso significa que você pode mudar diretamente o valor do atributo usando a função update do atributo, mas não há comandos que afetem o valor do atributo. Por exemplo, o atributo WrongCodeEntryLimit do atributo DoorLock.

• Podem ser gravados e afetados por outros comandos. Isso significa que você pode mudar diretamente o valor do atributo usando a função update do atributo, e o valor do atributo pode mudar como resultado do envio de um comando. Por exemplo, o atributo occupiedCoolingSetpoint do atributo Thermostat pode ser gravado, mas também atualizado com o comando setpointRaiseLower.

Exemplo de uso da função de atualização para mudar o valor de um atributo

Este exemplo mostra como definir explicitamente o valor do atributo DoorLockTrait.WrongCodeEntryLimit.

Para definir um valor de atributo, chame a função update do atributo e transmita uma função de mutador que defina o novo valor. É uma boa prática verificar se o atributo é compatível com o atributo.

Exemplo:

    var doorLockDevice = home.devices().list().first { device -> device.has(DoorLock) }

    val traitFlow: Flow<DoorLock?> =
      doorLockDevice.type(DoorLockDevice).map { it.standardTraits.doorLock }.distinctUntilChanged()

    val doorLockTrait: DoorLock = traitFlow.first()!!

    if (doorLockTrait.supports(DoorLock.Attribute.wrongCodeEntryLimit)) {
      val unused = doorLockTrait.update { setWrongCodeEntryLimit(3u) }
    }