iOS のデバイスとデバイスのメタデータにアクセスする

デバイス API には、iOS 向け Google Home API を介してアクセスできます。次のパッケージをアプリにインポートします。

import GoogleHomeSDK
import GoogleHomeTypes

詳細については、iOS のデータモデルをご覧ください。

エラー処理

Google Home API の一部のメソッドは HomeError をスローするため、do-catch ブロックを使用して、これらの呼び出しで HomeError をキャッチすることをおすすめします。

HomeError を処理する際は、code フィールドと message フィールドをチェックして、問題の内容を確認します。

処理されないエラーがあると、アプリがクラッシュします。

詳細については、エラー処理をご覧ください。

例については、デバイスにコマンドを送信するをご覧ください。

通話のサンプル

デバイスのリストを取得する

Home オブジェクトへの参照を使用して devices() を呼び出し、アクセス可能なデバイスの Query を取得します。Query の batched() メソッドを呼び出します。このメソッドは、デバイスのメタデータが変更されるたびに、ホームの現在の状態を反映した Set を出力します。または、Query.list() を呼び出して、使用可能なデバイスのスナップショットを取得します。これは、batched() ストリームに登録して、最初に出力された値を返す便利なメソッドです。Query.stream() は、デバイスのメタデータ(名前、部屋、ストラクチャなど)が変更されたときに新しい値を出力するストリームを生成します。内部的には、これは batched() を使用し、変更されたプロパティのみを出力します。

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

そこから、各デバイスの状態にアクセスして、デバイスにコマンドを送信できます。

Google Home API のリリース 1.8 では、devices() メソッドの enableMultipartDevices パラメータを true に設定することで、API が各マルチパート デバイスを単一のデバイスとして表すようにできます。詳しくは、iOS のマルチパート デバイスをご覧ください。

デバイスのタイプを取得する

デバイスに関連付けられているデバイスタイプを取得するには、デバイスの types プロパティを読み取ります。これにより、DeviceTypeController が返されます。

DeviceTypeController.subscribe(_:) を呼び出して、特定のデバイスタイプの更新を登録します。

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

デバイスが指定されたデバイスタイプをサポートしていない場合は、すぐに完了する Empty Publisher を返します。

デバイスが特定のデバイスタイプをサポートしている場合は、get() を呼び出すことで、そのタイプのハンドルを取得できます。

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

デバイスが指定されたタイプをサポートしていない場合は、nil を返します。

DeviceTypeController.subscribeAll() を呼び出して、DeviceTypeCollection の Publisher を取得します。このクラスを使用すると、デバイスに特定のデバイスタイプがあるかどうかを確認できます。

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]
    }
}

デバイスタイプのトレイトを取得する

デバイスタイプは、デバイスを機能的な部分(Matter のエンドポイントなど)に分解するため、トレイトを読み取るためのエントリ ポイントです。

また、デバイスに 2 つのデバイスタイプがあり、両方に同じトレイトがある場合のトレイトの競合も考慮されます。たとえば、デバイスがスピーカーと調光ライトの両方である場合、2 つのオン/オフ トレイトと 2 つのレベル コントロール トレイトがあります。

別の種類のトレイトの競合は、デバイスに同じ名前のトレイトが 2 つある場合に発生することがあります。たとえば、onOff は標準の OnOff トレイトのインスタンスを参照することも、メーカー定義の OnOff トレイトのインスタンスを参照することもできます。どのトレイトが意図されているかについて、潜在的なあいまいさを排除するには、各デバイスタイプの 2 つのトレイト コレクションのいずれかを使用してトレイトを参照します。

標準トレイト(Matter 標準クラスタに類似するトレイト)の場合は、matterTraits を使用します。たとえば、調光ライトのデバイスタイプに固有のトレイトを取得するには、次のようにします。

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

Google のトレイトの場合は、googleTraits を使用します。

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

メーカー固有のトレイトにアクセスするには、traits プロパティを介して参照しますが、その前にメーカーのパッケージ名を付けます。

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
}

デバイスの状態を読み取る

デバイスのオン/オフ トレイトから OnOff 属性を確認する例を次に示します。

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
}

特定のトレイトを持つデバイスのリストを取得する

特定のトレイトを持つデバイスのリストを取得するには、デバイス、各デバイスのデバイスタイプ、各デバイスタイプのトレイトを反復処理する必要があります。たとえば、家にあるデバイスのうち、オン/オフ トレイトを持つすべてのデバイスのリストを取得するには、次のようにします。

// 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)
    }
  }
}

Google Home API で使用可能なトレイトの一覧については、iOS のトレイト インデックスをご覧ください。

類似するデバイスタイプのデバイスのリストを取得する

家にあるすべての照明を表すデバイスのリストを取得するには:

// 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)
  }

Home API には、コアデバイス タイプを表す複数のデバイスタイプがあります。たとえば、「ライト」というデバイスタイプはありません。代わりに、前述の例に示すように、ライトを表す 4 つの異なるデバイスタイプがあります。そのため、家にある上位タイプのデバイスを包括的に把握するには、複数のデバイスタイプを含める必要があります。

Google Home API で利用可能なデバイスタイプと特性の一覧については、iOS でサポートされているデバイスタイプをご覧ください。

デバイスのベンダー名、ベンダー ID、プロダクト ID を取得する

BasicInformationTrait トレイトには、デバイスのベンダー ID、プロダクト ID、商品名、シリアル番号などの情報が含まれます。

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

デバイス メーカー向けのクラウドツークラウド デバイス識別

デバイス メーカーが Cloud-to-cloud デバイスをビルドする場合、BasicInformation トレイトを介して Cloud-to-cloud デバイスを識別するには、SYNC レスポンスに次の文字列フィールドを含めます。

  • Connectivity Standards Alliance (Alliance) が発行したベンダー ID: "matterOriginalVendorId": "0xfff1",

  • ベンダーの商品を一意に識別する商品 ID: "matterOriginalProductId": "0x1234",

  • デバイスの固有識別子。メーカー固有の方法で作成されます。 "matterUniqueId": "matter-device-id",

これらの文字列フィールドを入力するときは、Matter ベンダー ID とプロダクト ID があれば、それらを使用します。Alliance メンバーではなく、これらの ID が割り当てられていない場合は、matterOriginalVendorId フィールドと matterOriginalProductId フィールドを空白のままにして、matterUniqueId を識別子として指定できます。

SYNC レスポンスの例では、これらのフィールドの使用方法を示しています。

{
  "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",
          }
        ]
      }
    ]
  }
}

詳細については、Cloud-to-cloud SYNC のドキュメントをご覧ください。

デバイスとトレイトのメタデータ

Google Home API のデバイスとトレイトには、アプリでのユーザー エクスペリエンスの管理に役立つメタデータが関連付けられています。

Google Home API の各トレイトには sourceConnectivity プロパティが含まれています。このプロパティには、トレイトのオンライン ステータスとローカリティ(ローカルまたはリモート ルーティング)に関する情報が含まれています。

デバイスのプライマリ タイプを取得する

一部のデバイスは、Google Home API を通じて複数のデバイスタイプを提示することがあります。アプリでユーザーにデバイスの適切なオプション(デバイス コントロールやおすすめの自動化など)が表示されるようにするには、デバイスタイプがデバイスのプライマリ タイプかどうかを確認すると便利です。

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.")
  }
}

トレイトがオンラインかどうかを確認する

connectivityState プロパティを読み取って、トレイトの接続性を確認します。

let levelControlConnectivity =
  levelControlTrait.metadata.sourceConnectivity
  .connectivityState

一部のトレイト(通常は Google smart home トレイト)は、デバイスがインターネットに接続されていない場合、オフラインと表示されることがあります。これは、これらのトレイトがクラウドベースであり、ローカル ルーティングがないためです。

デバイスの接続性を確認する

デバイスの接続性は、実際にはデバイスタイプ レベルで確認されます。これは、一部のデバイスが複数のデバイスタイプをサポートしているためです。返される状態は、そのデバイスのすべてのトレイトの接続状態を組み合わせたものです。

let lightConnectivity =
  dimmableLightDeviceType.metadata.sourceConnectivity
  .connectivityState

インターネット接続がない場合、デバイスタイプが混在していると、partiallyOnline の状態が観察されることがあります。Matter 標準トレイトは、ローカル ルーティングによりオンラインのままになることがありますが、クラウドベースのトレイトはオフラインになります。

デバイスの IP アドレスを取得する

デバイスの IP アドレスを確認するには、GeneralDiagnosticsTrait の networkInterfaces 属性を使用します。アドレスは Data オブジェクトとして返されます。Network フレームワークを使用して、標準の IPv4 または IPv6 文字列にフォーマットできます。

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
}

トレイトのネットワーク ルーティングを確認する

特性のローカリティは、Google Home API でも利用できます。dataSourceLocality は、トレイトがリモート(クラウド経由)、ローカル(ローカルハブ経由)、ピアツーピア(デバイスからデバイスへの直接、ハブなし)のいずれでルーティングされるかを示します。

不明なローカリティ値 unspecified は、たとえば、アプリが起動中で、デバイス接続用のハブまたはサーバーにまだ到達していない場合に発生する可能性があります。これらのデバイスはアクセスできず、コマンドやイベントからのインタラクション リクエストは失敗します。このようなデバイスの処理方法は、クライアントが決定します。

let levelControlLocality =
  levelControlTrait.metadata.sourceConnectivity
  .dataSourceLocality

デバイスのネットワーク ルーティングを確認する

接続性と同様に、ローカリティはデバイスタイプ レベルでチェックされます。返される状態は、そのデバイスのすべてのトレイトのローカリティを組み合わせたものです。

let lightLocality =
  dimmableLightDeviceType.metadata.sourceConnectivity.dataSourceLocality

mixed の状態は、partiallyOnline 接続と同様のシナリオで観察されることがあります。一部の特性はクラウドベースですが、他の特性はローカルです。

デバイスの名前を変更する

setName(_:) メソッドを呼び出して、デバイスの名前を変更します。

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

デバイスの名前を変更しても、元の HomeDevice 構造体は変更されず、変更は返された更新済みの HomeDevice オブジェクトに反映されます。

名前が 60 Unicode コードポイント(文字)の上限を超えると、切り捨てられます。エラーはスローされません。長い名前の処理はデベロッパーの責任であり、たとえば、名前が切り捨てられることをユーザーに通知するかどうかを決定できます。

デバイスのグループ メンバーシップを確認する

1 台の実機を複数のデバイス グループに登録できます。デバイスが属するグループを調べるには、デバイスの GroupMembershipTrait を確認します。

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

DeviceGroup でサポートされているデバイスタイプを検査し、グループにコマンドを単一のエンティティとして送信するには、デバイス グループを制御するをご覧ください。