Smart-Home-Lautstärkeattribut-Schema

action.devices.traits.Volume: Diese Eigenschaft gehört zu Geräten, die die Lautstärke ändern können, z. B. die Lautstärke auf eine bestimmte Stufe stellen, stummschalten oder die Stummschaltung aufheben.

Geräteattribute

Geräte mit diesem Merkmal können die folgenden Attribute im Rahmen des Vorgangs SYNC melden. Weitere Informationen zum Umgang mit SYNC-Intents finden Sie unter Intent-Ausführung.

Attribute Typ Beschreibung
volumeMaxLevel Ganzzahl

Erforderlich.

Die maximale Lautstärkestufe, vorausgesetzt, die Grundeinstellung ist 0 (Stummschaltung). Assistant passt adverbiale Befehle (z.B. „Mach den Fernseher etwas lauter“) entsprechend an.
volumeCanMuteAndUnmute Boolesch

Erforderlich.

Gibt an, ob das Gerät die Lautstärke stummschalten und die Stummschaltung aufheben kann. Die Stummschaltung ist eine separate Option, da die Lautstärke bei der Stummschaltung auf 0 gesetzt wird, während die vorherige Lautstärke gespeichert wird. Wenn Sie die Stummschaltung aufheben, wird die vorherige Lautstärke wiederhergestellt. Das wird im Lautstärkestatus berücksichtigt: Wenn die Lautstärke auf 5 steht und der Nutzer die Lautstärke stummschaltet, bleibt die Lautstärke bei 5 und isMuted ist „wahr“.
volumeDefaultPercentage Ganzzahl

(Standardeinstellung: 40)

Die Lautstärke (in Prozent) für die vom Nutzer oder Hersteller festgelegte Standardlautstärke. Die Skala muss zwischen 0 und 100 liegen.
levelStepSize Ganzzahl

(Standardeinstellung: 1)

Die Standardschrittweite für relative Lautstärkeanfragen wie „Mach <device_name> lauter“.
commandOnlyVolume Boolesch

(Standardeinstellung: false)

Gibt an, ob das Gerät eine Einweg- (wahr) oder Zwei-Wege-Kommunikation (falsch) verwendet. Wenn der Controller beispielsweise den neuen Gerätestatus nach dem Senden der Anfrage bestätigen kann, ist dieses Feld auf „false“ (falsch) gesetzt. Wenn nicht bestätigt werden kann, ob die Anfrage erfolgreich ausgeführt wurde, oder der Status des Geräts nicht abgerufen werden kann (z. B. bei einer herkömmlichen Infrarotfernbedienung), setzen Sie dieses Feld auf „wahr“.

Beispiele

Lautsprecher, der stummgeschaltet werden kann und den aktuellen Status meldet

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

GERÄTESTATUS

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

Bundesstaaten Typ Beschreibung
currentVolume Ganzzahl

Erforderlich.

Der aktuelle Prozentsatz der Lautstärke. Er muss zwischen >0 und volumeMaxLevel liegen.
isMuted Boolesch

Erforderlich, wenn das volumeCanMuteAndUnmute-Attribut auf „wahr“ festgelegt ist. „True“, wenn das Gerät stummgeschaltet ist, andernfalls „False“. Wenn isMuted „wahr“ 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
}

Gerätebefehle

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

action.devices.commands.mute

Stummschaltung des Geräts

Parameter

Parameter Typ Beschreibung
mute Boolesch

Erforderlich.

Gibt an, ob ein Gerät stummgeschaltet werden soll oder nicht.

Beispiele

Lautsprecher stummschalten

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

action.devices.commands.setVolume

Die Lautstärke wird auf die angeforderte Stufe festgelegt, basierend auf volumeMaxLevel.

Parameter

Parameter Typ Beschreibung
volumeLevel Ganzzahl

Erforderlich.

Neue Lautstärke, von 0 auf volumeMaxLevel.

Beispiele

Absolute Lautstärke des Lautsprechers einstellen

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

action.devices.commands.volumeRelative

Lautstärke um n Stufen erhöhen oder verringern, basierend auf volumeMaxLevel. Bei Befehlen mit einer relativen Skala wählt Assistant n entsprechend aus, um die verfügbaren Schritte zu skalieren. Für Fernseher viel lauter machen wird beispielsweise eine höhere Anzahl von Schritten festgelegt als für Fernseher ein bisschen lauter machen.

Parameter

Parameter Typ Beschreibung
relativeSteps Ganzzahl

Erforderlich.

negativ für „Rückgang“.

Beispiele

Relative Lautstärke des Lautsprechers im reinen Befehlsmodus festlegen

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

GERÄTEFEHLER

Eine vollständige Liste der Fehler und Ausnahmen
  • volumeAlreadyMax: Das Gerät empfängt den Befehl VolumeUp, wenn es bereits die höchste Lautstärke hat.
  • volumeAlreadyMin: Das Gerät empfängt den Befehl VolumeDown, wenn es bereits auf die niedrigste Lautstärke eingestellt ist.