Schema dei tratti del volume per la smart home

action.devices.traits.Volume - Questa trait appartiene ai dispositivi in grado di regolare il volume (ad esempio, impostare il volume a un determinato livello oppure disattivare o riattivare l'audio).

ATTRIBUTES del dispositivo

I dispositivi con questo trait potrebbero segnalare i seguenti attributi nell'ambito dell'operazione SYNC. Per scoprire di più sulla gestione degli intent SYNC, consulta fulfillment dell'intent.

Attributi Tipo Descrizione
volumeMaxLevel Intero

Obbligatorio.

Il livello di volume massimo, presupponendo una base di 0 (audio disattivato). L'assistente regolerà i comandi avvverbi (ad es. "alza un po' la TV") di conseguenza.
volumeCanMuteAndUnmute Booleano

Obbligatorio.

Indica se il dispositivo può disattivare e riattivare l'audio del volume. La disattivazione dell'audio è un'opzione separata, dato che con l'opzione "Disattiva l'audio" il volume è impostato su 0 mantenendo il volume precedente, in modo che la riattivazione dell'audio lo ripristini. Questo si riflette nello stato del volume: se il volume è impostato su 5 e l'utente disattiva l'audio, il volume rimane 5 e isMuted è true.
volumeDefaultPercentage Intero

(Valore predefinito: 40)

Il volume (in percentuale) del volume predefinito definito dall'utente o dal produttore. La scala deve essere da 0 a 100.
levelStepSize Intero

(Valore predefinito: 1)

La dimensione predefinita del passaggio per le query di volume relativo, ad esempio "Alza il volume su <device_name>".
commandOnlyVolume Booleano

(Valore predefinito: false)

Indica se il dispositivo funziona utilizzando una comunicazione unidirezionale (true) o bidirezionale (false). Ad esempio, se il controller è in grado di confermare il nuovo stato del dispositivo dopo l'invio della richiesta, questo campo è false. Se non è possibile confermare se la richiesta è stata eseguita correttamente o per recuperare lo stato del dispositivo (ad esempio, se il dispositivo è un tradizionale telecomando a infrarossi), imposta questo campo su true.

Esempi

Speaker speaker che può essere disattivato e segnala lo stato attuale

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

Dispositivo STATES

Le entità con questo trait possono segnalare i seguenti stati nell'ambito dell'operazione QUERY. Per scoprire di più sulla gestione degli intent QUERY, consulta fulfillment dell'intent.

Stati Tipo Descrizione
currentVolume Intero

Obbligatorio.

La percentuale del volume attuale. Il valore deve essere compreso tra >0 e volumeMaxLevel.
isMuted Booleano

Obbligatorio se l'attributo volumeCanMuteAndUnmute è impostato su true. True se l'audio del dispositivo è disattivato; false in caso contrario. Se isMuted è true, il dispositivo restituisce comunque currentVolume per il punto memorizzato.

Esempi

Speaker speaker che può essere disattivato e segnala lo stato attuale

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

COMMANDS dispositivo

I dispositivi con questa caratteristica potrebbero rispondere ai seguenti comandi nell'ambito dell'operazione EXECUTE. Per scoprire di più sulla gestione degli intent EXECUTE, consulta fulfillment dell'intent.

action.devices.commands.mute

Disattiva o riattiva l'audio del dispositivo.

Parametri

Parametri Tipo Descrizione
mute Booleano

Obbligatorio.

Indica se disattivare o riattivare l'audio di un dispositivo.

Esempi

Disattivare l'audio dello speaker

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

action.devices.commands.setVolume

Imposta il volume al livello richiesto, in base a volumeMaxLevel.

Parametri

Parametri Tipo Descrizione
volumeLevel Intero

Obbligatorio.

Nuovo volume, da 0 a volumeMaxLevel.

Esempi

Impostare il volume assoluto dello speaker

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

action.devices.commands.volumeRelative

Imposta n passi per alzare o abbassare il volume, in base a volumeMaxLevel. Per i comandi che utilizzano una scala relativa, l'assistente selezionerà n in modo appropriato per scalare i passaggi disponibili. Ad esempio, se selezioni Aumenta il volume della TV, verrà impostato un numero di passi superiore rispetto a Alza il volume della TV un po' di meno.

Parametri

Parametri Tipo Descrizione
relativeSteps Intero

Obbligatorio.

negativo per "diminuisci".

Esempi

Impostare il volume relativo dello speaker in modalità di solo comando

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

ERRORS dispositivo

Consulta l'elenco completo di errori ed eccezioni.
  • volumeAlreadyMax: il dispositivo riceve il comando VolumeUp quando è già al massimo volume.
  • volumeAlreadyMin: il dispositivo riceve il comando VolumeDown quando è già al minimo.