Как отслеживать состояние устройства на Android

В Home API для Android отслеживать изменения состояния дома можно с помощью потоков в Kotlin. Отслеживать изменения в домах, комнатах, метаданных и состоянии устройств в Home API можно с помощью любого API, наследующего интерфейс HomeObjectsFlow. Для этого используется метод collect.

При добавлении, удалении или изменении любого элемента в коллекции возвращается последний снимок коллекции.

Разработчик должен сам определить, что именно изменилось, сравнив этот снимок со старой копией. Для этого можно использовать поле id, которое есть в каждом родительском объекте в Home API.

Как использовать процессы

Ниже приведены некоторые базовые примеры сбора данных из потоков в Home API. В примерах ниже экземпляр Home должен быть создан до получения доступа к коллекциям в доме.

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

Как отслеживать изменения в доме

Эта коллекция запускается при следующих изменениях в структуре:

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

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

Как отслеживать изменения на определенном устройстве

Сбор данных запускается при следующих изменениях на устройстве:

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" }!!

Отслеживание изменений определенного свойства на устройстве

Используйте любые характеристики, поддерживаемые устройством и Home API. Полный список приведен в статье Trait.

    val trait = device.type(DimmableLightDevice)?.map { it.trait(OnOff)}.first()

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

Как отслеживать изменения определенного типа на устройстве

Сбор данных запускается при следующих изменениях типа устройства:

Используйте любой тип устройства Matter, поддерживаемый Home API. Полный список приведен в статье DeviceType.

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

Как отслеживать изменения в комнате в доме

Эта коллекция активируется при следующих изменениях в чат-группе:

Чтобы отслеживать, когда устройства добавляются в комнату или удаляются из нее, используйте процесс devices().

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

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

Подписка на события

В Home API события используются для обнаружения изменений в состоянии устройства.

Чтобы подписаться на события на определенном устройстве, вызовите один из трех методов HomeDevice.Функции events, каждая из которых возвращает Flow<Event>:

  1. events(event: EventFactory<T>) возвращает поток для определенного типа события:

    val eventFlow = homeDevice.type(DoorLockDevice).first().events(DoorLock.DoorLockAlarmEvent)
    
  2. events(trait: TraitFactory<T>) возвращает поток всех событий, отправленных типажом:

    val eventflow = homeDevice.type(DoorLockDevice).first().events(DoorLock)
    
  3. events() возвращает поток событий, доступных для объекта:

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

Чтобы использовать события из потока, используйте функцию flow.collect():

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

Подписка на события, связанные с объектами

Вы можете отслеживать события, которые генерируются каждый раз, когда добавляется, удаляется или обновляется объект (например, дом, комната, устройство или автоматизация). Эти события являются экземплярами HomeObjectChangeEvent и содержат идентификатор измененного объекта.

Чтобы получить поток, который создает нужные вам события, вызовите метод stream() для объекта HomeObjectsFlow<T>, созданного соответствующим методом Flow:

Таблица: потоки событий
Объект Интерфейс Метод Flow
Structure HasStructures structures()
Room HasRooms rooms()
HomeDevice HasHomeDevices devices()
Automation HasAutomations automations()

Например, вот как можно обрабатывать изменения на устройствах:

val devicesStream = home.devices().stream()

// Collect and react to device changes.
devicesStream.collect { deviceEvent ->
  when (deviceEvent) {
    is HomeObjectAddedEvent ->
      println("New device now available with id: ${deviceEvent.id}")
    is HomeObjectUpdatedEvent -> println("Device ${deviceEvent.id} has been updated")
    is HomeObjectRemovedEvent -> println("Device is removed from your account")
    else -> {}
  }
}