Home Assistant Unofficial Reference 2024.12.1
homeassistant.components.google_assistant.trait.VolumeTrait Class Reference
Inheritance diagram for homeassistant.components.google_assistant.trait.VolumeTrait:
[legend]
Collaboration diagram for homeassistant.components.google_assistant.trait.VolumeTrait:
[legend]

Public Member Functions

def execute (self, command, data, params, challenge)
 
dict[str, Any] query_attributes (self)
 
dict[str, Any] sync_attributes (self)
 
- Public Member Functions inherited from homeassistant.components.google_assistant.trait._Trait
None __init__ (self, HomeAssistant hass, state, config)
 
def can_execute (self, command, params)
 
dict[str, Any]|None query_notifications (self)
 
dict[str, Any] sync_options (self)
 

Static Public Member Functions

def supported (domain, features, device_class, _)
 
- Static Public Member Functions inherited from homeassistant.components.google_assistant.trait._Trait
def might_2fa (domain, features, device_class)
 

Static Public Attributes

list commands = [COMMAND_SET_VOLUME, COMMAND_VOLUME_RELATIVE, COMMAND_MUTE]
 
 name = TRAIT_VOLUME
 

Private Member Functions

def _execute_mute (self, data, params)
 
def _execute_set_volume (self, data, params)
 
def _execute_volume_relative (self, data, params)
 
def _set_volume_absolute (self, data, level)
 

Additional Inherited Members

- Public Attributes inherited from homeassistant.components.google_assistant.trait._Trait
 config
 
 hass
 
 state
 

Detailed Description

Trait to control volume of a device.

https://developers.google.com/actions/smarthome/traits/volume

Definition at line 2308 of file trait.py.

Member Function Documentation

◆ _execute_mute()

def homeassistant.components.google_assistant.trait.VolumeTrait._execute_mute (   self,
  data,
  params 
)
private

Definition at line 2410 of file trait.py.

◆ _execute_set_volume()

def homeassistant.components.google_assistant.trait.VolumeTrait._execute_set_volume (   self,
  data,
  params 
)
private

Definition at line 2372 of file trait.py.

◆ _execute_volume_relative()

def homeassistant.components.google_assistant.trait.VolumeTrait._execute_volume_relative (   self,
  data,
  params 
)
private

Definition at line 2383 of file trait.py.

◆ _set_volume_absolute()

def homeassistant.components.google_assistant.trait.VolumeTrait._set_volume_absolute (   self,
  data,
  level 
)
private

Definition at line 2360 of file trait.py.

◆ execute()

def homeassistant.components.google_assistant.trait.VolumeTrait.execute (   self,
  command,
  data,
  params,
  challenge 
)
Execute a volume command.

Reimplemented from homeassistant.components.google_assistant.trait._Trait.

Definition at line 2430 of file trait.py.

◆ query_attributes()

dict[str, Any] homeassistant.components.google_assistant.trait.VolumeTrait.query_attributes (   self)
Return volume query attributes.

Reimplemented from homeassistant.components.google_assistant.trait._Trait.

Definition at line 2345 of file trait.py.

◆ supported()

def homeassistant.components.google_assistant.trait.VolumeTrait.supported (   domain,
  features,
  device_class,
  _ 
)
static
Test if trait is supported.

Reimplemented from homeassistant.components.google_assistant.trait._Trait.

Definition at line 2318 of file trait.py.

◆ sync_attributes()

dict[str, Any] homeassistant.components.google_assistant.trait.VolumeTrait.sync_attributes (   self)
Return volume attributes for a sync request.

Reimplemented from homeassistant.components.google_assistant.trait._Trait.

Definition at line 2328 of file trait.py.

Member Data Documentation

◆ commands

list homeassistant.components.google_assistant.trait.VolumeTrait.commands = [COMMAND_SET_VOLUME, COMMAND_VOLUME_RELATIVE, COMMAND_MUTE]
static

Definition at line 2315 of file trait.py.

◆ name

homeassistant.components.google_assistant.trait.VolumeTrait.name = TRAIT_VOLUME
static

Definition at line 2314 of file trait.py.


The documentation for this class was generated from the following file: