Schema für Smart-Home-Volume-Trait

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

Geräte-ATTRIBUTES

Auf Geräten mit diesem Trait kann Folgendes gemeldet werden im Rahmen des SYNC-Vorgangs verwenden. Weitere Informationen Weitere Informationen zum Umgang mit SYNC-Intents finden Sie unter Absichtliche Umsetzung.

Attribute	Typ	Beschreibung
volumeMaxLevel	Ganzzahl	Erforderlich. Der maximale Lautstärkepegel bei einem Basiswert von 0 (stumm). Assistant passt Adverbiale Befehle (z.B. „Mach den Fernseher etwas lauter“) entsprechend an.
volumeCanMuteAndUnmute	Boolesch	Erforderlich. Gibt an, ob das Gerät den Ton stummschalten und die Stummschaltung aufheben kann. „Stummschalten“ ist eine separate Option für „Stummschalten“. stellt die Lautstärke auf 0, während die vorherige Lautstärke gespeichert wird, sodass sie beim Aufheben der Stummschaltung wiederhergestellt wird. Dies spiegelt sich im Lautstärkestatus wider: Wenn der Nutzer es stummschaltet, bleibt die Lautstärke 5 und isMuted auf „true“.
volumeDefaultPercentage	Ganzzahl	(Standardeinstellung: 40) Die Lautstärke (in Prozent) der vom Nutzer oder Hersteller festgelegten Standardlautstärke. Die Skala muss zwischen 0 und 100 liegen.
levelStepSize	Ganzzahl	(Standardeinstellung: 1) Die Standardschrittgröße für Abfragen mit relativem Volumen wie „Lautstärke auf <device_name> erhöhen“.
commandOnlyVolume	Boolesch	(Standardeinstellung: false) Gibt an, ob das Gerät in eine Richtung (true) oder in beide Richtungen (false) kommuniziert wird. Wenn der Controller beispielsweise den neuen Gerätestatus nach dem Senden der Anfrage bestätigen kann, wäre dieses Feld „false“. Wenn nicht bestätigt werden kann, ob die Anfrage erfolgreich ausgeführt wurde, oder den Gerätestatus abzurufen (z. B. ob es sich bei dem Gerät 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 Merkmal melden möglicherweise Folgendes: QUERY-Bundesstaaten. Weitere Informationen Weitere Informationen zum Umgang mit QUERY-Intents finden Sie unter Absichtliche Umsetzung.

Bundesstaaten	Typ	Beschreibung
currentVolume	Ganzzahl	Erforderlich. Der aktuelle Prozentsatz der Lautstärke. Er muss zwischen >0 und volumeMaxLevel liegen.
isMuted	Boolesch	Erforderlich, wenn das Attribut volumeCanMuteAndUnmute auf „true“ gesetzt ist. „True“, wenn das Gerät stummgeschaltet ist Andernfalls „false“. Wenn isMuted „true“ ist, gibt das Gerät trotzdem currentVolume für den gemerkten Punkt zurück.

Beispiele

Lautsprecher, der stummgeschaltet werden kann und den aktuellen Status meldet

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

Gerät "COMMANDS"

Geräte mit diesem Merkmal können auf Folgendes reagieren im Rahmen des EXECUTE-Vorgangs ausgeführt. Weitere Informationen Weitere Informationen zum Umgang mit EXECUTE-Intents finden Sie unter Absichtliche Umsetzung.

action.devices.commands.mute

Schaltet das Gerät stumm bzw. 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 gewünschte Lautstärke basierend auf volumeMaxLevel ein.

Parameter

Parameter	Typ	Beschreibung
volumeLevel	Ganzzahl	Erforderlich. Neues Volume von 0 bis volumeMaxLevel.

Beispiele

Absolute Lautstärke des Lautsprechers festlegen

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

action.devices.commands.volumeRelative

Du kannst die Lautstärke je nach volumeMaxLevel n Schritte lauter oder leiser stellen. Bei Befehlen mit einer relativen Skala wählt Assistant n entsprechend aus, um die verfügbaren Schritte zu berücksichtigen. Mit der Option Fernseher deutlich lauter machen beispielsweise wird eine höhere Anzahl von Schritten festgelegt als mit Fernseher ein bisschen lauter machen.

Parameter

Parameter	Typ	Beschreibung
relativeSteps	Ganzzahl	Erforderlich. negativ für "decrease" ein.

Beispiele

Relative Lautstärke des Lautsprechers im Befehlsmodus festlegen

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

Gerätefehler

Vollständige Liste der Fehler und Ausnahmen.

• volumeAlreadyMax: Das Gerät empfängt den VolumeUp-Befehl, wenn es schon die höchste Lautstärke eingestellt ist.
• volumeAlreadyMin: Das Gerät empfängt den VolumeDown-Befehl, wenn es ist bereits auf der niedrigsten Lautstärke eingestellt.