Schéma de trait de volume pour la maison connectée
action.devices.traits.Volume
: cette caractéristique appartient aux appareils capables de régler le volume (par exemple, de le régler sur un certain niveau, de le couper ou de le réactiver).
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 et réactiver le son. Le mode "Désactiver le son" est une option distincte, car le comportement de désactivation du son fait passer le volume à 0 tout en conservant 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 défini sur 5 et que l'utilisateur coupe le son, le volume reste à 5 et |
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 : É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 : 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
Appareil haut-parleur pouvant être coupé et qui indique son état actuel
{ "volumeMaxLevel": 11, "volumeCanMuteAndUnmute": true, "levelStepSize": 2, "commandOnlyVolume": false, "volumeDefaultPercentage": 6 }
ÉTATS DE L'APPAREIL
Les entités avec 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 |
isMuted |
Valeur booléenne |
Obligatoire si l'attribut |
Exemples
Appareil haut-parleur pouvant être coupé et qui indique son é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 |
Exemples
Définir le volume absolu de l'appareil d'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 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 commandeVolumeUp
alors qu'il est déjà au volume maximal.volumeAlreadyMin
: l'appareil reçoit la commandeVolumeDown
alors qu'il est déjà au volume le plus bas.