Schema für Volumenmerkmale von Smart-Home-Geräten

action.devices.traits.Volume: Diese Eigenschaft gehört zu Geräten, mit denen die Lautstärke geändert werden kann (z. B. auf eine bestimmte Lautstärke einstellen, stummschalten oder die Stummschaltung aufheben).

Geräte-ATTRIBUTE

Geräte mit dieser Eigenschaft melden möglicherweise die folgenden Attribute im Rahmen des SYNC-Vorgangs. Weitere Informationen zum Umgang mit SYNC-Intents finden Sie unter Intent-Auftragsausführung.

Attribute Typ Beschreibung
volumeMaxLevel Ganzzahl

Erforderlich.

Die maximale Lautstärke bei einem Normalbereich von 0 (stumm). Assistant passt Adverbiale Befehle entsprechend an (z.B. „Mach den Fernseher etwas lauter“).
volumeCanMuteAndUnmute Boolesch

Erforderlich.

Gibt an, ob das Gerät den Ton stummschalten und die Stummschaltung aufheben kann. „Stummschalten“ ist eine separate Option, da die Lautstärke bei „Stummschalten“ auf 0 gesetzt wird, während die vorherige Lautstärke beibehalten wird. Durch das Aufheben der Stummschaltung wird sie wiederhergestellt. Das spiegelt sich im Lautstärkestatus wider. Wenn die Lautstärke auf 5 eingestellt ist und der Nutzer sie stummschaltet, bleibt sie bei 5 und isMuted ist „true“.
volumeDefaultPercentage Ganzzahl

(Standard: 40)

Die Lautstärke der Standardlautstärke in Prozent, die vom Nutzer oder Hersteller festgelegt wurde. Die Skala muss zwischen 0 und 100 liegen.
levelStepSize Ganzzahl

(Standard: 1)

Die Standardschrittgröße für Abfragen von relativen Volumen wie „Lautstärke auf <device_name> erhöhen“.
commandOnlyVolume Boolesch

(Standard: false)

Gibt an, ob das Gerät in einer Richtung (wahr) oder in beide Richtungen (falsch) betrieben wird. Wenn der Controller beispielsweise nach dem Senden der Anfrage den neuen Gerätestatus bestätigen kann, lautet das Feld „false“. Wenn es nicht möglich ist, zu bestätigen, ob die Anfrage erfolgreich ausgeführt wurde, oder den Status des Geräts abzurufen (z. B. wenn es sich um eine herkömmliche Infrarotfernbedienung handelt), setzen Sie dieses Feld auf „true“.

Beispiele

Lautsprecher, der stummgeschaltet werden kann und den aktuellen Status meldet

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

Gerät STATES

Entitäten mit diesem Trait können die folgenden Status im Rahmen des QUERY-Vorgangs melden. Weitere Informationen zum Umgang mit QUERY-Intents finden Sie unter Intent-Auftragsausführung.

Bundesstaaten Typ Beschreibung
currentVolume Ganzzahl

Erforderlich.

Die aktuelle Lautstärke in Prozent. Er muss zwischen >0 und volumeMaxLevel liegen.
isMuted Boolesch

Erforderlich, wenn das volumeCanMuteAndUnmute-Attribut auf „true“ gesetzt ist. „True“, wenn das Gerät stummgeschaltet ist, andernfalls „false“. Wenn isMuted „true“ ist, gibt das Gerät weiterhin currentVolume für den gespeicherten Punkt zurück.

Beispiele

Lautsprecher, der stummgeschaltet werden kann und den aktuellen Status meldet

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

BEFEHLUNGEN auf dem Gerät

Geräte mit dieser Eigenschaft können im Rahmen des EXECUTE-Vorgangs auf die folgenden Befehle reagieren. Weitere Informationen zum Umgang mit EXECUTE-Intents finden Sie unter Intent-Auftragsausführung.

action.devices.commands.mute

Schaltet das Gerät stumm oder hebt die Stummschaltung auf.

Parameter

Parameter Typ Beschreibung
mute Boolesch

Erforderlich.

Gibt an, ob ein Gerät stummgeschaltet oder die Stummschaltung aufgehoben werden soll.

Beispiele

Lautsprecher stummschalten

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

action.devices.commands.setVolume

Stelle die Lautstärke auf die gewünschte Stufe ein, basierend auf volumeMaxLevel.

Parameter

Parameter Typ Beschreibung
volumeLevel Ganzzahl

Erforderlich.

Neue Lautstärke, von 0 bis volumeMaxLevel.

Beispiele

Absolute Lautstärkeregelung des Lautsprechers festlegen

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

action.devices.commands.volumeRelative

Du kannst die Lautstärke n Schritte auf Grundlage von volumeMaxLevel erhöhen oder verringern. Bei Befehlen, die eine relative Skala verwenden, wählt Assistant n entsprechend aus, um auf die verfügbaren Schritte zu skalieren. Wenn Sie beispielsweise Fernseher deutlich lauter machen auswählen, ist die Anzahl der Schritte höher als bei Fernseher ein bisschen lauter machen.

Parameter

Parameter Typ Beschreibung
relativeSteps Ganzzahl

Erforderlich.

negativ auf „Verringerung“ aus.

Beispiele

Relative Lautstärke des Lautsprechers im Befehlsmodus festlegen

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

Gerät ERRORS

Sehen Sie sich die vollständige Liste der Fehler und Ausnahmen an.
  • volumeAlreadyMax: Das Gerät empfängt den Befehl VolumeUp, wenn bereits die höchste Lautstärke erreicht ist.
  • volumeAlreadyMin: Das Gerät empfängt den Befehl VolumeDown, wenn es bereits auf der niedrigsten Lautstärke ist.