Schema für Smart-Home-Lautstärke

action.devices.traits.Volume: Diese Eigenschaft gilt für Geräte, die die Lautstärke ändern können (z. B. um die Lautstärke auf eine bestimmte Lautstärke einzustellen oder sie stummzuschalten oder die Stummschaltung aufzuheben).

Geräte-ATTRIBUTE

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

Attribute	Typ	Beschreibung
volumeMaxLevel	Ganzzahl	Erforderlich. Die maximale Lautstärke bei einem Ausgangswert von 0 (stumm). Assistant passt die adverbialen Befehle an (z.B. „Mach den Fernseher ein wenig lauter“).
volumeCanMuteAndUnmute	Boolesch	Erforderlich. Zeigt an, ob das Gerät die Lautstärke stumm schalten und die Stummschaltung aufheben kann. „Stummschalten“ ist eine separate Option, weil mit „Stummschalten“ die Lautstärke auf 0 gesetzt wird. Die vorherige Lautstärke wird beibehalten, sodass die Stummschaltung aufgehoben wird. Dies wird im Lautstärkestatus berücksichtigt: Wenn die Lautstärke 5 beträgt und der Nutzer stummgeschaltet wird, bleibt die Lautstärke 5 und isMuted ist wahr.
volumeDefaultPercentage	Ganzzahl	(Standard: 40) Die Lautstärke (in Prozent) für die vom Nutzer oder Hersteller definierte Standardlautstärke. Die Skala muss zwischen 0 und 100 liegen.
levelStepSize	Ganzzahl	(Standard: 1) Dies ist die Standardschrittgröße für relative Volumenabfragen wie „Lautstärke auf <Gerätename> erhöhen“.
commandOnlyVolume	Boolesch	(Standard: false) Gibt an, ob das Gerät über eine Einweg- (wahr) oder eine Zwei-Wege-Kommunikation (fälschlicherweise) betrieben wird. Wenn der Controller beispielsweise den neuen Gerätestatus bestätigen kann, nachdem er die Anfrage gesendet hat, ist dieses Feld „false“. Wenn es nicht möglich ist zu prüfen, ob die Anfrage erfolgreich ausgeführt wurde, oder den Status des Geräts abzurufen (z. B. bei einer herkömmlichen Infrarotfernbedienung), 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ätestatus

Entitäten mit diesem Merkmal können im Rahmen des QUERY-Vorgangs die folgenden Status melden: Weitere Informationen zum Verarbeiten von 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 Attribut volumeCanMuteAndUnmute auf „true“ gesetzt ist. Dieser Wert ist „true“, wenn das Gerät stummgeschaltet ist, andernfalls „false“. Wenn isMuted auf „true“ gesetzt 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
}

BEISPIELE für Geräte

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

action.devices.commands.mute

Aktiviert oder deaktiviert das Gerät.

Parameter

Parameter	Typ	Beschreibung
mute	Boolesch	Erforderlich. Gibt an, ob ein Gerät stummgeschaltet oder die Stummschaltung aufgehoben wird.

Beispiele

Lautsprecher stummschalten

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

action.devices.commands.setVolume

Legen Sie die Lautstärke auf der angeforderten Ebene basierend auf volumeMaxLevel fest.

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

Sie können die Lautstärke von n Schritten je nach volumeMaxLevel erhöhen oder verringern. Bei Befehlen mit einer relativen Skalierung wählt Assistant n entsprechend aus, um ihn auf die verfügbaren Schritte zu skalieren. Mit Fernseher viel lauter stellen wird beispielsweise eine höhere Anzahl von Schritten festgelegt als Fernseher etwas leiser stellen.

Parameter

Parameter	Typ	Beschreibung
relativeSteps	Ganzzahl	Erforderlich. negative Werte für „ nimmt ab“.

Beispiele

Relative Lautstärke des Lautsprechers im Modus „Nur Befehl“ festlegen

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

Gerät ERRORS

Hier finden Sie die vollständige Liste der Fehler und Ausnahmen.

• volumeAlreadyMax: Das Gerät empfängt den Befehl VolumeUp, wenn es bereits die höchste Lautstärke erreicht hat.
• volumeAlreadyMin: Das Gerät empfängt den Befehl VolumeDown, wenn es bereits die niedrigste Lautstärke hat.