Cómo acceder a dispositivos y metadatos de dispositivos para iOS

Se puede acceder a las APIs de dispositivos a través de las APIs de Home para iOS. Importa los siguientes paquetes a tu app:

import GoogleHomeSDK
import GoogleHomeTypes

Para obtener más información, consulta Modelo de datos en iOS.

Manejo de errores

Algunos métodos de las APIs de Home arrojan una HomeError, por lo que te recomendamos que uses un bloque do-catch para detectar HomeError en esas llamadas.

Cuando manejes HomeError, verifica sus campos code y message para saber qué salió mal.

Cualquier error no controlado hará que tu app falle.

Para obtener más información, consulta Manejo de errores.

Consulta Envía un comando a un dispositivo para ver un ejemplo.

Llamadas de muestra

Obtén una lista de dispositivos

Con una referencia al objeto Home, invoca devices() para obtener un Query de dispositivos accesibles. Llama al método batched() de Query, que emite un conjunto que refleja el estado actual de la casa con cada cambio en los metadatos del dispositivo. O llama a Query.list() para obtener una instantánea de los dispositivos disponibles. Este es un método de conveniencia que se suscribe al flujo batched() y devuelve el primer valor emitido. Query.stream() produce un flujo que emite valores nuevos cuando se producen cambios en los metadatos del dispositivo, como su nombre, habitación o estructura. De forma interna, se usa batched() y solo se emiten las propiedades modificadas.

// Get a list of all devices accessible to the user
let homeDevices = try await self.home.devices().list()

Desde allí, puedes acceder a los estados de cada dispositivo y enviarles comandos.

Con la versión 1.8 de las APIs de Home, tienes la opción de que la API represente cada dispositivo de varias partes como un solo dispositivo configurando el parámetro enableMultipartDevices del método devices() en true. Consulta Dispositivos de varias partes en iOS para obtener más información.

Obtén los tipos de dispositivos

Para obtener los tipos de dispositivos asociados con un dispositivo, lee la propiedad types del dispositivo, que devuelve un DeviceTypeController.

Llama a DeviceTypeController.subscribe(_:) para suscribirte a las actualizaciones de un tipo de dispositivo en particular:

let devices = try await self.home.devices().list()
if let device = devices.first(where: { $0.id == myDeviceId }) {
  var receivedUpdate1 = false
  var receivedUpdate2 = false
  device.types.subscribe(OnOffLightDeviceType.self)
    .assertNoFailure()
    .sink { device in
      if !receivedUpdate1 {
        receivedUpdate1 = true
        Task {
          try await device.matterTraits.onOffTrait?.on()
        }
        return
      }
      if !receivedUpdate2 {
        receivedUpdate2 = true
        return
      }
      fatalError("Received unexpected update")
    }
}

Si el dispositivo no admite el tipo de dispositivo especificado, muestra un Empty Publisher que se completa de inmediato.

Si el dispositivo admite un tipo de dispositivo específico, puedes obtener un controlador para ese tipo llamando a get():

if let device = devices.first(where: { $0.id == myDeviceId }) {
  let _ = await device.types.get(OnOffLightDeviceType.self)
}

Si el dispositivo no admite el tipo especificado, se devuelve nil.

Llama a DeviceTypeController.subscribeAll() para obtener un Publisher de DeviceTypeCollection. Esta clase te permite verificar si el dispositivo tiene un tipo de dispositivo en particular:

if let device = devices.first(where: { $0.id == myDeviceId }) {
  device.types.subscribeAll()
    .assertNoFailure()
    .sink { types in
      let lightDeviceType = types[OnOffLightDeviceType.self]
      let fanDeviceType = types[FanDeviceType.self]
    }
}

Obtén un atributo de tipo de dispositivo

Los tipos de dispositivos son el punto de entrada para leer los rasgos, ya que descomponen un dispositivo en sus partes funcionales (como los extremos en Matter).

También tienen en cuenta las colisiones de rasgos en caso de que un dispositivo tenga dos tipos de dispositivos, los cuales podrían tener el mismo rasgo. Por ejemplo, si un dispositivo es una bocina y una luz regulable, tendrá dos rasgos de encendido/apagado y dos de control de nivel.

Otro tipo de colisión de rasgos puede ocurrir cuando un dispositivo tiene dos rasgos con el mismo nombre. Por ejemplo, onOff podría hacer referencia a una instancia de la característica OnOff estándar o a una instancia de una característica OnOff definida por el fabricante. Para eliminar cualquier ambigüedad potencial en cuanto al rasgo que se pretende, haz referencia a un rasgo a través de una de las dos colecciones de rasgos en cada tipo de dispositivo.

Para los rasgos estándar, es decir, aquellos que son análogos a los clústeres estándar de Matter, usa matterTraits. Por ejemplo, para obtener un atributo específico del tipo de dispositivo Luz regulable, haz lo siguiente:

if let dimmableLightDeviceType =
  await device.types.get(DimmableLightDeviceType.self)
{
  // Accessing standard trait on the type.
  let levelControlTrait =
    dimmableLightDeviceType.matterTraits.levelControlTrait.self
}

Para los atributos de Google, usa googleTraits:

if let doorbellDeviceType = await device.types.get(GoogleDoorbellDeviceType.self) {
  // Accessing Google trait on the type.
  let doorbellPressTrait =
    doorbellDeviceType.traits[Google.DoorbellPressTrait.self]
}

Para acceder a un atributo específico del fabricante, haz referencia a él a través de la propiedad traits, pero anteponiendo el nombre del paquete del fabricante:

let deviceType = await device1?.types.get(OnOffLightDeviceType.self)
// Accessing custom trait on the type.
if let spinnerTrait = deviceType?.traits[ExampleOrganization.SpinnerTrait.self] {
  let rpmVal = spinnerTrait.attributes.rpm
}

Lee el estado de un dispositivo

Observa este ejemplo de verificación del atributo OnOff del rasgo de encendido/apagado del dispositivo:

let lightDevices = devices.filter {
  $0.types.contains(OnOffLightDeviceType.self)
}
let light1 = lightDevices.first
let lightDeviceTypeOptional = await light1?.types.get(OnOffLightDeviceType.self)
if let onOffTrait = lightDeviceTypeOptional?.matterTraits.onOffTrait {
  let onOffVal = onOffTrait.attributes.onOff
}

Obtén una lista de dispositivos con un atributo específico

Para obtener una lista de los dispositivos que tienen un atributo específico, debes iterar por los dispositivos, los tipos de dispositivos de cada dispositivo y los atributos de cada tipo de dispositivo. Por ejemplo, para obtener una lista de los dispositivos de la casa que tienen el rasgo On/Off, haz lo siguiente:

// Get all light devices that support levelControl
var levelControlDevices: [HomeDevice] = []
let allDevices = try await home.devices().list()
for device in allDevices {
  if let deviceType = await device.types.get(OnOffLightDeviceType.self) {
    if deviceType.traits.contains(Matter.LevelControlTrait.self) {
      levelControlDevices.append(device)
    }
  }
}

Consulta el índice de rasgos en iOS para obtener una lista completa de los rasgos disponibles en las APIs de Home.

Obtén una lista de dispositivos con tipos similares

Para obtener una lista de los dispositivos que representan todas las luces de una casa, haz lo siguiente:

// Get a list of devices with similar device types (lights)
let lightDevices =
  try await self.home.devices().list().compactMap {
    $0.types.contains(DimmableLightDeviceType.self)
      || $0.types.contains(OnOffLightDeviceType.self)
      || $0.types.contains(ColorTemperatureLightDeviceType.self)
      || $0.types.contains(ExtendedColorLightDeviceType.self)
  }

Existen varios tipos de dispositivos en las APIs de Home que podrían representar un tipo de dispositivo principal. Por ejemplo, no existe el tipo de dispositivo "Luz". En su lugar, hay cuatro tipos de dispositivos diferentes que podrían representar una luz, como se muestra en el ejemplo anterior. Por lo tanto, para obtener una vista integral del tipo de dispositivo de nivel superior en una casa, se deben incluir varios tipos de dispositivos.

Consulta los tipos de dispositivos compatibles con iOS para obtener una lista completa de los tipos de dispositivos y sus características que están disponibles en las APIs de Home.

Cómo obtener el nombre del proveedor, el ID del proveedor o el ID del producto de un dispositivo

La característica BasicInformationTrait incluye información como el ID del proveedor, el ID del producto, el nombre del producto y el número de serie de un dispositivo:

guard
  let vendorName =
    basicInfoTrait.attributes.vendorName
else {
  fatalError("Failed to get vendorName")
}
guard
  let vendorID =
    basicInfoTrait.attributes.vendorID
else {
  fatalError("Failed to get vendorID")
}
guard
  let productID =
    basicInfoTrait.attributes.productID
else {
  fatalError("Failed to get productID")
}

Identificación de dispositivos de nube a nube para fabricantes de dispositivos

Si eres fabricante de dispositivos y creas dispositivos Cloud-to-cloud, para identificar tus dispositivos Cloud-to-cloud a través del rasgo BasicInformation, puedes incluir estos campos de cadena en su respuesta SYNC:

• El ID de proveedor emitido por Connectivity Standards Alliance (Alliance): "matterOriginalVendorId": "0xfff1",

• Es un identificador de producto que identifica de forma única un producto de un proveedor: "matterOriginalProductId": "0x1234",

• Es un identificador único para el dispositivo, que se construye de una manera específica del fabricante: "matterUniqueId": "matter-device-id",

Cuando ingreses estos campos de cadena, usa tus IDs de proveedor y de producto de Matter, si los tienes. Si no eres miembro de Alliance y no se te asignaron estos IDs, puedes dejar los campos matterOriginalVendorId y matterOriginalProductId en blanco y proporcionar el matterUniqueId como identificador.

En el ejemplo de respuesta de SYNC, se muestra el uso de estos campos:

{
  "requestId": "ff36a3cc-ec34-11e6-b1a0-64510650abcf",
  "payload": {
    "agentUserId": "1836.15267389",
    "devices": [
      {
        "id": "456",
        "type": "action.devices.types.LIGHT",
        "traits": [
          "action.devices.traits.OnOff",
          "action.devices.traits.Brightness",
          "action.devices.traits.ColorSetting",
        ],
        "willReportState": true,
        "deviceInfo": { ... },
        "matterOriginalVendorId": "0xfff1",
        "matterOriginalProductId": "0x1234",
        "matterUniqueId": "matter-device-id",
        "otherDeviceIds": [
          {
            "deviceId": "local-device-id",
          }
        ]
      }
    ]
  }
}

Para obtener más información, consulta la documentación de Cloud-to-cloud de SYNC.

Metadatos de dispositivos y rasgos

Los dispositivos y los atributos de las APIs de Home tienen metadatos asociados, que pueden ayudar a administrar la experiencia del usuario en una app.

Cada atributo de las APIs de Home contiene una propiedad sourceConnectivity, que tiene información sobre el estado en línea y la localidad de un atributo (enrutamiento local o remoto).

Obtén el tipo principal de un dispositivo

Algunos dispositivos pueden presentar varios tipos de dispositivos a través de las APIs de Home. Para garantizar que los usuarios vean las opciones adecuadas en una app (como el control de dispositivos y las automatizaciones sugeridas) para sus dispositivos, es útil verificar si un tipo de dispositivo es el tipo principal del dispositivo.

if let deviceType =
  await device?.types.get(HumiditySensorDeviceType.self)
{
  if deviceType.metadata.isPrimaryType {
    print("Humidity Sensor is the primary type on this device.")
  } else {
    print("Humidity Sensor isn't the primary type on this device.")
  }
}

Verifica si un rasgo está en línea

Lee la propiedad connectivityState para verificar la conectividad de un atributo:

let levelControlConnectivity =
  levelControlTrait.metadata.sourceConnectivity
  .connectivityState

Algunos atributos, por lo general, los de Google smart home, pueden mostrarse sin conexión si el dispositivo no tiene conectividad a Internet. Esto se debe a que estos rasgos se basan en la nube y no tienen enrutamiento local.

Verifica la conectividad de un dispositivo

La conectividad de un dispositivo se verifica a nivel del tipo de dispositivo, ya que algunos dispositivos admiten varios tipos. El estado que se devuelve es una combinación de los estados de conectividad de todos los rasgos de ese dispositivo.

let lightConnectivity =
  dimmableLightDeviceType.metadata.sourceConnectivity
  .connectivityState

Se puede observar un estado de partiallyOnline en el caso de tipos de dispositivos mixtos cuando no hay conectividad a Internet. Es posible que los atributos estándar de Matter sigan en línea debido al enrutamiento local, pero los atributos basados en la nube estarán sin conexión.

Obtén la dirección IP del dispositivo

Para encontrar la dirección IP del dispositivo, usa el atributo networkInterfaces de GeneralDiagnosticsTrait. Las direcciones se devuelven como objetos Data, a los que puedes dar formato de strings IPv4 o IPv6 estándar con el framework Network:

func getIpAddresses(trait: Matter.GeneralDiagnosticsTrait) -> [String] {
  let interfaces = trait.attributes.networkInterfaces ?? []
  var ipAddresses: [String] = []

  for interface in interfaces {
    for data in interface.iPv4Addresses {
      if let ipv4 = IPv4Address(data) {
        ipAddresses.append(String(describing: ipv4))
      }
    }
    for data in interface.iPv6Addresses {
      if let ipv6 = IPv6Address(data) {
        ipAddresses.append(String(describing: ipv6))
      }
    }
  }

  return ipAddresses
}

Verifica el enrutamiento de red de un atributo

La localidad de un atributo también está disponible en las APIs de Home. El dataSourceLocality indica si el atributo se enruta de forma remota (a través de la nube), de forma local (a través de un concentrador local) o de par a par (directamente de un dispositivo a otro, sin concentrador).

El valor de localidad desconocido unspecified es posible, por ejemplo, mientras se inicia una app y aún no se llega a un concentrador o servidor para la conectividad del dispositivo. No se puede acceder a estos dispositivos y fallarán las solicitudes de interacción de comandos o eventos. Depende del cliente determinar cómo controlar esos dispositivos.

let levelControlLocality =
  levelControlTrait.metadata.sourceConnectivity
  .dataSourceLocality

Cómo verificar el enrutamiento de red de un dispositivo

Al igual que la conectividad, la localidad se verifica a nivel del tipo de dispositivo. El estado que se devuelve es una combinación de la localidad de todos los rasgos de ese dispositivo.

let lightLocality =
  dimmableLightDeviceType.metadata.sourceConnectivity.dataSourceLocality

Se puede observar un estado de mixed en una situación similar a la de la conectividad partiallyOnline: algunos atributos se basan en la nube, mientras que otros son locales.

Cómo cambiar el nombre de un dispositivo

Llama al método setName(_:) para cambiar el nombre de un dispositivo:

let updatedDevice = try await theDevice.setName("new device name")

Cuando se cambia el nombre de un dispositivo, el struct HomeDevice original sigue siendo el mismo, y el cambio se refleja en el objeto HomeDevice actualizado que se devuelve.

Los nombres se truncarán si superan el límite de 60 puntos de código Unicode (caracteres) y no se arrojarán errores. Los desarrolladores son responsables de controlar los nombres largos y, por ejemplo, pueden decidir si quieren informar a los usuarios que se truncarán los nombres.

Cómo verificar la pertenencia a un grupo de un dispositivo

Un dispositivo físico puede pertenecer a uno o más grupos de dispositivos. Para inspeccionar a qué grupos pertenece un dispositivo, verifica el GroupMembershipTrait en el dispositivo:

if let trait = await device.traits.get(Google.GroupMembershipTrait.self) {
  for groupId in trait.attributes.groupObjectIdsArray {
    print("Device belongs to group: \(groupId)")
  }
}

Para inspeccionar los tipos de dispositivos compatibles con un DeviceGroup y enviar comandos al grupo como una sola entidad, consulta Controla un grupo de dispositivos.