Schéma de traitement du volume pour la maison connectée
action.devices.traits.Volume
: cette caractéristique appartient aux appareils capables de régler le volume (par exemple, régler le volume à un certain niveau, couper ou réactiver le son).
Attributs d'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 que la température de référence est de 0 (son coupé). L'Assistant ajustera les commandes adverbiales (par exemple, "Augmente un peu le volume de la télé") en conséquence. |
volumeCanMuteAndUnmute |
Booléen |
Obligatoire. Indique si l'appareil peut couper et réactiver le son. Le son est une option distincte, car il met le volume à 0 tout en gardant en mémoire le volume précédent. Il est alors rétabli. Cela se reflète dans l'état du volume : si le volume est défini sur 5 et que l'utilisateur coupe le son, il reste défini sur 5 et la valeur |
volumeDefaultPercentage |
Entier |
(Par défaut : 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 : Taille de pas par défaut pour les requêtes de volume relatif telles que "augmente le volume sur <device_name>". |
commandOnlyVolume |
Booléen |
(Par défaut : Indique si l'appareil fonctionne à l'aide d'une communication unidirectionnelle (vrai) ou bidirectionnelle (faux). Par exemple, si la manette peut confirmer le nouvel état de l'appareil après l'envoi de la requête, la valeur de ce champ est "false". Si vous ne pouvez pas vérifier si la requête a bien été exécutée ni 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 pouvant être mis en mode silencieux et signale l'état actuel
{ "volumeMaxLevel": 11, "volumeCanMuteAndUnmute": true, "levelStepSize": 2, "commandOnlyVolume": false, "volumeDefaultPercentage": 6 }
Device STATES
Les entités dotées de 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. Elle doit être comprise entre |
isMuted |
Booléen |
Obligatoire si l'attribut |
Exemples
Haut-parleur pouvant être mis en mode silencieux et signale l'état actuel
{ "currentVolume": 5, "isMuted": false }
COMMANDS d'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
Désactive ou réactive le son de l'appareil.
Paramètres
Paramètres | Type | Description |
---|---|---|
mute |
Booléen |
Obligatoire. Permet de spécifier si le son d'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
Réglez le volume au niveau demandé, en fonction de volumeMaxLevel
.
Paramètres
Paramètres | Type | Description |
---|---|---|
volumeLevel |
Entier |
Obligatoire. Nouveau volume, de |
Exemples
Régler le volume absolu de l'enceinte
{ "command": "action.devices.commands.setVolume", "params": { "volumeLevel": 6 } }
action.devices.commands.volumeRelative
Augmentez ou baissez le volume sur n étapes, en fonction du volumeMaxLevel
. Pour les commandes qui utilisent une échelle relative, l'Assistant sélectionne n de manière appropriée pour s'adapter aux pas disponibles. Par exemple, Augmenter le volume du téléviseur définira un nombre de pas plus élevé que Augmenter le volume du téléviseur.
Paramètres
Paramètres | Type | Description |
---|---|---|
relativeSteps |
Entier |
Obligatoire. négative pour "diminution". |
Exemples
Définir le volume relatif du haut-parleur en mode commande uniquement
{ "command": "action.devices.commands.volumeRelative", "params": { "relativeSteps": -1 } }
ERREURS sur l'appareil
Consultez la liste complète des erreurs et exceptions.volumeAlreadyMax
: l'appareil reçoit la commandeVolumeUp
lorsque le volume est déjà au maximum.volumeAlreadyMin
: l'appareil reçoit la commandeVolumeDown
lorsque le volume est déjà au plus bas.