Мониторинг состояния устройства на Android

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

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

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

Как использовать потоки

Ниже приведены несколько базовых примеров сбора данных из потоков в API Home. В следующих примерах необходимо создать экземпляр Home перед доступом к коллекциям в 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" }!!

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

Используйте любые свойства, поддерживаемые устройством и API Home. Полный список см. в 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")
  }
}

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

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

Чтобы подписаться на события на определенном устройстве, вызовите одну из трех 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:

Таблица: Потоки событий
Сущность Интерфейс Метод потока
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 -> {}
  }
}