在 iOS 设备上控制设备

本指南接续了在 iOS 上访问设备和设备元数据，并介绍了更多设备控制和访问示例。

如需使用特定的设备类型或 trait（例如此处许多示例中使用的 Matter OnOffTrait），必须导入它们：

import GoogleHomeSDK
import GoogleHomeTypes

检查 trait 是否支持某个命令

使用 trait 级 supports 函数检查特定设备是否支持某个命令。

例如，如需检查设备是否支持开/关 trait 的 toggle 命令，请执行以下操作：

// Check if the OnOff trait supports the toggle command.
if onOffTraitTest.supportsToggleCommand {
  print("onOffTrait supports toggle command")
} else {
  print("onOffTrait does not support stateful toggle command")
}

向设备发送命令

发送命令与从 trait 读取状态属性类似。如需开启或关闭设备，请使用 OnOffTrait 切换命令，该命令在 Google Home 生态系统数据模型中定义为 toggle()。如果 onOff 为 true，则此方法会将其更改为 false；如果 onOff 为 false，则会将其更改为 true：

// Calling a command on a trait.
do {
  try await onOffTraitTest.toggle()
} catch let error as HomeError {
  // Code for handling the exception
}

如果命令检测到执行流程存在问题，则可能会返回异常。作为开发者，您应使用 do-catch 块来妥善处理这些异常，并在错误可供用户采取行动时向用户显示详细信息。未处理的异常会停止应用运行时，并可能导致应用崩溃。

或者，使用 off() 或 on() 命令明确设置状态：

do {
  try await onOffTraitTest.off()
  try await onOffTraitTest.on()
} catch let error as HomeError {
  // Code for handling the exception
}

发送用于更改状态的命令后，命令完成后，您可以按照读取设备状态中所述的方式读取状态，以便在应用中进行处理。

发送带参数的命令

某些命令可能会使用参数，例如 OnOffTrait 或 LevelControlTrait 中的参数：

offWithEffect

// Turn off the light using the DyingLight effect.
do {
  try await onOffTraitTest.offWithEffect(
    effectIdentifier: Matter.OnOffTrait.EffectIdentifierEnum.dyingLight,
    effectVariant: 0
  )
} catch let error as HomeError {
  // Code for handling the exception
}

moveToLevel

// Change the brightness of the light to 50%
do {
  try await levelControlTraitTest.moveToLevel(
    level: UInt8(127),
    transitionTime: 0,
    optionsMask: Matter.LevelControlTrait.OptionsBitmap(),
    optionsOverride: Matter.LevelControlTrait.OptionsBitmap()
  )
} catch let error as HomeError {
  // Code for handling the exception
}

检查 trait 是否支持属性

某些设备可能支持 Matter trait，但不支持特定属性。例如，映射到 Matter 的 Cloud-to-cloud 设备可能不支持所有 Matter 属性。如需处理此类情况，请使用 trait 级 isSupported 属性检查特定设备是否支持该属性。

例如，如需检查设备是否支持开/关 trait 的 onOff 属性，请执行以下操作：

// Check if the OnOff trait supports the onOff attribute.
if onOffTrait.attributes.$onOff.isSupported {
  print("onOffTrait supports onOff state")
} else {
  print("onOffTrait is for a command only device!")
}

Matter 规范或 Cloud-to-cloud smart home 架构中的某些属性是可为 null 的。对于这些属性，您可以通过使用 isNullable 和 isSupported，确定属性返回的 nil 是由于设备未报告该值，还是属性的值实际上为 nil：

// Check if a nullable attribute is set or is not supported.
if let deviceType = await device.types.get(OnOffLightDeviceType.self) {
  if let onOffTrait = deviceType.traits[Matter.OnOffTrait.self] {
    if onOffTrait.attributes.startUpOnOff == nil {
      if onOffTrait.attributes.$startUpOnOff.isSupported {
        print(
          "onOffTrait supports startUpOnOff and it is nil. Check the spec for the contextual meaning."
        )
      } else {
        print("onOffTrait does not support startUpOnOff!")
      }
    } else {
      print(
        "onOffTrait supports startUpOnOff and it is set to \(onOffTrait.attributes.startUpOnOff)"
      )
    }
  }
}

更新 trait 属性

如果您想更改给定属性的值，但 trait 的任何命令都无法执行此操作，则该属性可能支持显式设置其值。

属性的值能否更改取决于以下两个因素：

  • 该属性是否可写入？
  • 发送 trait 命令会导致属性值发生变化吗？

有关 trait 及其属性的参考文档提供了此类信息。

因此，决定属性值可能如何更改的属性组合如下：

  • 只读，不受其他命令的影响。这意味着该属性的值不会发生变化。例如，SwitchTrait 的 currentPosition 属性。

  • 只读，且会受其他命令影响。这意味着，属性值的唯一更改方式是发送命令。例如，LevelControlTrait 的 currentLevel 属性是只读的，但其值可以通过 moveToLevel 等命令进行更改。

  • 可写入，且不受其他命令的影响。这意味着，您可以使用 trait 的 update 函数直接更改属性的值，但没有任何命令会影响属性的值。例如，DoorLockTrait 的 WrongCodeEntryLimit 属性。

  • 可写入，并受其他命令影响。这意味着，您可以使用 trait 的 update 函数直接更改属性的值，并且属性的值可能会因发送命令而发生变化。例如，可以写入 ThermostatTrait 的 occupiedCoolingSetpoint 属性，也可以使用 setpointRaiseLower 命令更新该属性。

使用 update 函数更改属性值的示例

以下示例展示了如何显式设置 DoorLockTrait.wrongCodeEntryLimit 属性的值。

如需设置属性值，请调用 trait 的 update 函数，并向其传递用于设置新值的更新函数。最好先验证 trait 是否支持某个属性。

例如：

if doorLockTraitTest.attributes.$wrongCodeEntryLimit.isSupported {
  let _ = try await doorLockTraitTest.update {
    $0.setWrongCodeEntryLimit(3)
  }
}