Monitorar o estado do dispositivo

Nas APIs Home, é possível observar mudanças de estado na casa usando fluxos em Kotlin. É possível observar mudanças em estruturas, cômodos, metadados do dispositivo e estado do dispositivo nas APIs Home com qualquer API que herda da interface HomeObjectsFlow. Isso é feito colhendo do fluxo. Consulte Introdução aos fluxos para mais informações.

Quando qualquer item de uma coleção é adicionado, excluído ou modificado, o snapshot mais recente da coleção é retornado.

Cabe ao desenvolvedor deduzir as mudanças específicas comparando esse instantâneo com uma cópia mais antiga. O campo id fornecido para cada tipo de objeto pai nas APIs Home pode ser usado para essa finalidade.

Como usar fluxos

Confira alguns exemplos básicos de coleta de fluxos nas APIs Home. Para os exemplos abaixo, uma instância do Home precisa ser criada antes de acessar as coleções na casa:

val context = LocalContext.current
val homeManager = Home.getClient(context)

Rastrear mudanças em uma estrutura

As seguintes mudanças em uma estrutura acionam essa coleção:

homeManager.structures().map { it.firstOrNull() }.collect {
  println("Structure ${it.id} updated to ${it}")
}

val structure =  homeManager.structures().list().firstOrNull()!!

Rastrear alterações em um dispositivo específico

As seguintes mudanças em um dispositivo acionam essa coleta:

structure
  .devices()
  .map { devices -> device.filter { it.name == "Bedroom Lamp" }.single() }
  .collect {
    println("The bedroom lamp has changed!")
  }

val device = structure.devices().list().firstOrNull { it.name == "Bedroom Lamp" }!!

Rastrear mudanças em um recurso específico em um dispositivo

Use qualquer atributo compatível com o dispositivo e as APIs Home. Para conferir a lista completa, consulte Trait.

device.trait(OnOff).collect {
  if (it != null) {
    println("Got new state update! ${it.onOff}")
  }
}

Acompanhar as mudanças em um tipo específico em um dispositivo

As seguintes mudanças em um tipo de dispositivo acionam essa coleta:

Use qualquer tipo de dispositivo Matter compatível com as APIs Home. Para ver uma lista completa, consulte DeviceType.

device.type(DimmableLightDevice).collect { type ->
    println("Got new state update! ${type.trait(LevelControl)?.currentLevel}")
}

Acompanhar as mudanças em uma sala de uma estrutura

As seguintes mudanças em uma sala acionam essa coleta:

Para acompanhar quando os dispositivos são adicionados ou removidos de um ambiente, use o fluxo devices().

structure.rooms().collect {
  println("Got a new updated set of rooms!")

  for (room in it) {
    println("Got room $room")
  }
}

Inscrever-se em eventos

Nas APIs Home, os eventos são usados para detectar mudanças no estado de um dispositivo.

Para assinar eventos em um dispositivo específico, chame uma das três HomeDevice.Funções events, cada uma retornando umFlow<Event>:

  1. events(event: EventFactory<T>) retorna um fluxo para um tipo específico de evento:

    val eventFlow = homeDevice.type(DoorLockDevice).first().events(DoorLock.DoorLockAlarmEvent)
    
  2. events(trait: TraitFactory<T>) retorna um fluxo de todos os eventos enviados por um atributo:

    val eventflow = homeDevice.type(DoorLockDevice).first().events(DoorLock)
    
  3. events() retorna um fluxo de eventos disponíveis para o objeto:

    val eventflow = homeDevice.type(DoorLockDevice).first().events()
    

Para consumir eventos de um fluxo, use a função flow.collect():

eventflow.collect { event ->
  if (event != null) {
    logger.atInfo().log("Received event %s", event)
    // do something
  }
}