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

action.devices.traits.Volume : ce trait appartient aux appareils capables de modifier le volume (par exemple, en le réglant sur un certain niveau, en le coupant ou en le réactivant).

ATTRIBUTS de l'appareil

Les appareils dotés de ce trait peuvent signaler les attributs suivants dans le cadre de l'opération SYNC. Pour en savoir plus sur la gestion des intents SYNC, consultez Fulfillment d'intent.

Attributs Type Description
volumeMaxLevel Entier

Obligatoire.

Niveau de volume maximal, en partant d'une base de 0 (mode silencieux). L'Assistant ajustera les commandes adverbiales (par exemple, "mets le son de la télé un peu plus fort") en conséquence.
volumeCanMuteAndUnmute Valeur booléenne

Obligatoire.

Indique si l'appareil peut couper et réactiver le son. La désactivation du son est une option distincte, car elle met le volume à 0 tout en mémorisant le volume précédent, de sorte que la réactivation du son le rétablit. Cela se reflète dans l'état du volume : si le volume est à 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.

La valeur doit être comprise entre 0 et 100.
levelStepSize Entier

(Par défaut : 1)

Taille de pas par défaut pour les requêtes de volume relatif telles que "Augmente le volume sur <nom_de_l'appareil>".
commandOnlyVolume Valeur booléenne

(Par défaut : false)

Indique si l'appareil fonctionne avec une communication unidirectionnelle (true) ou bidirectionnelle (false). 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 que la requête a été exécutée ou obtenir l'état de l'appareil (par exemple, s'il s'agit d'une télécommande infrarouge traditionnelle), définissez ce champ sur "true".

Exemples

Appareil audio pouvant être mis en mode silencieux et qui indique l'état actuel

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

ÉTATS des appareils

Les entités dotées de ce trait peuvent signaler les états suivants dans le cadre de l'opération QUERY. Pour en savoir plus sur la gestion des intents QUERY, consultez Fulfillment d'intent.

États Type Description
currentVolume Entier

Obligatoire.

Pourcentage du volume actuel. Il doit être compris entre >0 et volumeMaxLevel.

Valeur minimale : 0.
isMuted Valeur booléenne

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

Exemples

Appareil audio pouvant être mis en mode silencieux et qui indique l'état actuel

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

COMMANDES de l'appareil

Les appareils dotés de ce trait 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 Fulfillment d'intent.

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 mis en sourdine ou non.

Exemples

Couper le son de l'enceinte

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

action.devices.commands.setVolume

Règle le volume sur le niveau demandé, en fonction de volumeMaxLevel.

Paramètres

Paramètres Type Description
volumeLevel Entier

Obligatoire.

Nouveau volume : de 0 à volumeMaxLevel.

Valeur minimale : 0.

Exemples

Définir le volume absolu de l'enceinte

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

action.devices.commands.volumeRelative

Augmente ou diminue le volume de n niveaux, en fonction de volumeMaxLevel. Pour les commandes qui utilisent une échelle relative, l'Assistant sélectionne n de manière appropriée pour s'adapter aux étapes disponibles. Par exemple, Mets le son de la télé beaucoup plus fort définira un nombre de niveaux plus élevé que Mets le son de la télé un peu plus fort.

Paramètres

Paramètres Type Description
relativeSteps Entier

Obligatoire.

négatif pour "diminuer".

Exemples

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

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

ERREURS liées à l'appareil

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