Contrôler les appareils sur iOS

Ce guide fait suite à Accéder aux appareils et aux métadonnées des appareils sur iOS et présente d'autres exemples de contrôle et d'accès aux appareils.

Pour utiliser des types ou des caractéristiques d'appareil spécifiques, tels que le Matter OnOffTrait utilisé dans de nombreux exemples ici, vous devez les importer:

import GoogleHomeSDK
import GoogleHomeTypes

Vérifier si une caractéristique est compatible avec une commande

Utilisez la fonction supports au niveau des traits pour vérifier si une commande est compatible avec un appareil particulier.

Par exemple, pour vérifier si un appareil est compatible avec la commande toggle de la caractéristique Marche/Arrêt:

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

Envoyer une commande à un appareil

L'envoi d'une commande est semblable à la lecture d'un attribut d'état à partir d'un trait. Pour allumer ou éteindre l'appareil, utilisez la commande d'activation/de désactivation OnOffTrait, qui est définie dans le modèle de données de l'écosystème Google Home comme toggle(). Cette méthode remplace onOff par false s'il s'agit de true, ou par true s'il s'agit de false:

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

Les commandes peuvent renvoyer une exception si un problème est détecté avec le flux d'exécution. En tant que développeur, vous devez utiliser un bloc do-catch pour gérer correctement ces exceptions et fournir des informations détaillées aux utilisateurs dans les cas où les erreurs sont exploitables. Les exceptions non gérées arrêtent l'environnement d'exécution de l'application et peuvent entraîner des plantages.

Vous pouvez également utiliser les commandes off() ou on() pour définir explicitement l'état:

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

Une fois la commande envoyée pour modifier l'état, vous pouvez lire l'état comme décrit dans la section Lire l'état d'un appareil pour le gérer dans votre application.

Envoyer une commande avec des paramètres

Certaines commandes peuvent utiliser des paramètres, comme ceux de OnOffTrait ou LevelControlTrait:

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

Vérifier si une caractéristique est compatible avec un attribut

Certains appareils peuvent prendre en charge un trait Matter, mais pas un attribut spécifique. Par exemple, un appareil Cloud-to-cloud mappé sur Matter peut ne pas prendre en charge tous les attributs Matter. Pour gérer ce type de cas, utilisez la propriété isSupported au niveau des traits pour vérifier si l'attribut est compatible avec un appareil particulier.

Par exemple, pour vérifier si un appareil est compatible avec l'attribut onOff de la caractéristique Marche/Arrêt:

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

Certains attributs sont nullables dans la spécification Matter ou le schéma smart home Cloud-to-cloud. Pour ces attributs, vous pouvez déterminer si une valeur nil renvoyée par l'attribut est due au fait que l'appareil ne signale pas cette valeur, ou si la valeur de l'attribut est réellement nil, en utilisant isNullable en plus de isSupported:

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

Mettre à jour les attributs des traits

Si vous souhaitez modifier la valeur d'un attribut donné et qu'aucune des commandes de la caractéristique ne le fait, il est possible que l'attribut puisse être défini explicitement.

La possibilité de modifier la valeur d'un attribut dépend de deux facteurs:

  • L'attribut est-il en écriture ?
  • La valeur de l'attribut peut-elle changer en tant qu'effet secondaire de l'envoi d'une commande de trait ?

La documentation de référence sur les traits et leurs attributs fournit ces informations.

Par conséquent, les combinaisons de propriétés qui déterminent comment la valeur d'un attribut peut être modifiée sont les suivantes:

  • En lecture seule et non affecté par les autres commandes. Cela signifie que la valeur de l'attribut ne change pas. Par exemple, l'attribut currentPosition de l'élément SwitchTrait.

  • En lecture seule et affecté par d'autres commandes. Cela signifie que la valeur de l'attribut ne peut changer que suite à l'envoi d'une commande. Par exemple, l'attribut currentLevel de LevelControlTrait est en lecture seule, mais sa valeur peut être modifiée par des commandes telles que moveToLevel.

  • Il peut être écrit et n'est pas affecté par les autres commandes. Cela signifie que vous pouvez modifier directement la valeur de l'attribut à l'aide de la fonction update du trait, mais aucune commande n'affectera la valeur de l'attribut. Par exemple, l'attribut WrongCodeEntryLimit de l'élément DoorLockTrait.

  • Peut être écrit et est affecté par d'autres commandes. Cela signifie que vous pouvez modifier directement la valeur de l'attribut à l'aide de la fonction update du trait, et que la valeur de l'attribut peut changer en raison de l'envoi d'une commande. Par exemple, l'attribut occupiedCoolingSetpoint de ThermostatTrait peut être écrit, mais aussi mis à jour à l'aide de la commande setpointRaiseLower.

Exemple d'utilisation de la fonction update pour modifier la valeur d'un attribut

Cet exemple montre comment définir explicitement la valeur de l'attribut DoorLockTrait.wrongCodeEntryLimit.

Pour définir une valeur d'attribut, appelez la fonction update du trait et transmettez-lui une fonction de mise à jour qui définit la nouvelle valeur. Nous vous recommandons de commencer par vérifier que la caractéristique accepte un attribut.

Exemple :

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