Schéma de traitement de volume de 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 D'appareils

Les appareils présentant cette caractéristique peuvent signaler les éléments suivants : dans le cadre de l'opération SYNC. Pour apprendre Pour en savoir plus sur la gestion des intents SYNC, consultez Traitement des intents.

Attributs	Type	Description
volumeMaxLevel	Entier	Obligatoire. Niveau de volume maximal, en supposant une valeur de référence de 0 (silencieux). L'Assistant ajuste les commandes adverbiales (par exemple, "Augmente légèrement 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 son est une option distincte règle le volume sur 0 tout en mémorisant le volume précédent, de sorte que la réactivation du son le restaure. Cela se reflète dans l'état du volume : si le volume est 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 du volume par défaut défini par l'utilisateur ou le fabricant (en pourcentage). L'échelle doit être comprise entre 0 et 100.
levelStepSize	Entier	(Par défaut : 1) Taille de pas par défaut pour les requêtes avec volume relatif comme "augmenter le volume sur <device_name>".
commandOnlyVolume	Valeur booléenne	(Par défaut : false) Indique si l'appareil fonctionne avec une communication unidirectionnelle (vrai) ou bidirectionnelle (faux). Par exemple, si le contrôleur peut confirmer le nouvel état de l'appareil après l'envoi de la requête, la valeur du champ est "false". S'il n'est pas possible de confirmer si la requête a bien été exécutée ou d'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

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

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

STATES de l'appareil

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

États	Type	Description
currentVolume	Entier	Obligatoire. Pourcentage du volume actuel. Elle doit être comprise entre >0 et volumeMaxLevel.
isMuted	Valeur booléenne	Obligatoire si l'attribut volumeCanMuteAndUnmute est défini sur "true". "True" si le son de l'appareil est coupé. "false" dans le cas contraire. Si isMuted est défini sur "true", l'appareil renvoie toujours currentVolume pour le point mémorisé.

Exemples

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

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

COMMANDS d'appareils

Les appareils présentant cette caractéristique peuvent répondre aux éléments suivants : dans le cadre de l'opération EXECUTE. Pour apprendre Pour en savoir plus sur la gestion des intents EXECUTE, consultez 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. Couper ou réactiver le son d'un appareil.

Exemples

Couper le son du haut-parleur

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

action.devices.commands.setVolume

Réglez le volume sur le 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électionnera n de manière appropriée pour tenir compte des pas disponibles. Par exemple, Augmenter le volume du téléviseur permet de définir un nombre de pas plus élevé que l'option Augmenter légèrement le volume du téléviseur.

Paramètres

Paramètres	Type	Description
relativeSteps	Entier	Obligatoire. négative de "diminuer".

Exemples

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

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

Erreurs d'appareil

Voir la liste complète les erreurs et les exceptions.

• volumeAlreadyMax: l'appareil reçoit la commande VolumeUp lorsqu'il le volume est déjà au maximum.
• volumeAlreadyMin: l'appareil reçoit la commande VolumeDown lorsqu'il au volume le plus bas.