Schéma de trait de volume pour la maison connectée

action.devices.traits.Volume : cette caractéristique appartient aux appareils qui peuvent régler le volume (par exemple, régler le volume à un certain niveau, couper ou réactiver le son).

ATTRIBUTS de l'appareil

Les appareils dotés de cette caractéristique peuvent signaler les attributs suivants dans le cadre de l'opération SYNC. Pour en savoir plus sur la gestion des intents SYNC, consultez la section Traitement des intents.

Attributs Type Description
volumeMaxLevel Entier

Obligatoire.

Niveau de volume maximal, en supposant un niveau de référence de 0 (coupure du son). L'Assistant ajustera les commandes adverbiales (par exemple, "Augmente un peu le volume du téléviseur") en conséquence.
volumeCanMuteAndUnmute Valeur booléenne

Obligatoire.

Indique si l'appareil peut couper ou réactiver le son. Le mode "sourdine" est une option distincte, car le comportement de la "sourdine" fait passer le volume à 0 tout en conservant le volume précédent, de sorte que la désactivation de la sourdine le rétablit. Cela se reflète dans l'état du volume. Si le volume est défini sur 5 et que l'utilisateur coupe le son, le volume reste à 5 et isMuted est défini sur "true".
volumeDefaultPercentage Entier

(Par défaut : 40)

Volume (en pourcentage) du volume par défaut défini par l'utilisateur ou le fabricant. L'échelle doit être comprise entre 0 et 100.
levelStepSize Entier

(Par défaut : 1)

Étape par défaut pour les requêtes de volume relatif telles que "Augmente le volume sur <nom_appareil>".
commandOnlyVolume Valeur booléenne

(Par défaut : false)

Indique si l'appareil fonctionne avec une communication à sens unique (vrai) ou à double sens (faux). Par exemple, si le contrôleur peut confirmer le nouvel état de l'appareil après l'envoi de la requête, ce champ est défini sur "false". Si vous ne pouvez pas confirmer si la requête est exécutée correctement ni obtenir l'état de l'appareil (par exemple, s'il s'agit d'une télécommande infrarouge classique), définissez ce champ sur "true".

Exemples

Haut-parleur qui peut être coupé et qui indique l'état actuel

{
  "volumeMaxLevel": 11,
  "volumeCanMuteAndUnmute": true,
  "levelStepSize": 2,
  "commandOnlyVolume": false,
  "volumeDefaultPercentage": 6
}

ÉTATS DE L'APPAREIL

Les entités présentant cette caractéristique peuvent signaler les états suivants dans le cadre de l'opération QUERY. Pour en savoir plus sur la gestion des intents QUERY, consultez la section Traitement des intents.

États Type Description
currentVolume Entier

Obligatoire.

Pourcentage du volume actuel. Il doit être compris entre >0 et volumeMaxLevel.
isMuted Valeur booléenne

Obligatoire si l'attribut volumeCanMuteAndUnmute est défini sur "true". "True" si l'appareil est mis en sourdine, "false" dans le cas contraire. Si isMuted est défini sur "true", l'appareil renvoie toujours currentVolume pour le point mémorisé.

Exemples

Appareil haut-parleur pouvant être coupé et qui indique l'état actuel

{
  "currentVolume": 5,
  "isMuted": false
}

COMMANDES DE L'APPAREIL

Les appareils dotés de cette caractéristique peuvent répondre aux commandes suivantes dans le cadre de l'opération EXECUTE. Pour en savoir plus sur la gestion des intents EXECUTE, consultez la section Traitement des intents.

action.devices.commands.mute

Coupe ou réactive le son de l'appareil.

Paramètres

Paramètres Type Description
mute Valeur booléenne

Obligatoire.

Indique si un appareil doit être coupé ou réactivé.

Exemples

Couper le son de l'enceinte

{
  "command": "action.devices.commands.mute",
  "params": {
    "mute": true
  }
}

action.devices.commands.setVolume

Définit le volume au niveau demandé, en fonction de volumeMaxLevel.

Paramètres

Paramètres Type Description
volumeLevel Entier

Obligatoire.

Nouveau volume, de 0 à volumeMaxLevel.

Exemples

Régler le volume absolu de l'enceinte

{
  "command": "action.devices.commands.setVolume",
  "params": {
    "volumeLevel": 6
  }
}

action.devices.commands.volumeRelative

Régler le volume à la hausse ou à la baisse sur n étapes, en fonction de volumeMaxLevel Pour les commandes qui utilisent une échelle relative, l'Assistant sélectionne n de manière appropriée pour adapter la valeur aux étapes disponibles. Par exemple, Augmenter le volume de la télévision définira un nombre d'étapes plus élevé que Augmenter légèrement le volume de la télévision.

Paramètres

Paramètres Type Description
relativeSteps Entier

Obligatoire.

négatif pour "baisse".

Exemples

Définir le volume relatif de l'appareil d'enceinte en mode commande uniquement

{
  "command": "action.devices.commands.volumeRelative",
  "params": {
    "relativeSteps": -1
  }
}

ERREURS de l'appareil

Consultez la liste complète des erreurs et exceptions.
  • volumeAlreadyMax: l'appareil reçoit la commande VolumeUp lorsqu'il est déjà au volume maximal.
  • volumeAlreadyMin : l'appareil reçoit la commande VolumeDown alors qu'il est déjà au volume le plus bas.