Home Assistant Unofficial Reference 2024.12.1
homeassistant.components.google_assistant.trait.ModesTrait Class Reference
Inheritance diagram for homeassistant.components.google_assistant.trait.ModesTrait:
[legend]
Collaboration diagram for homeassistant.components.google_assistant.trait.ModesTrait:
[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_MODES]
 
 name = TRAIT_MODES
 
dictionary SYNONYMS
 

Private Member Functions

def _generate (self, name, settings)
 

Additional Inherited Members

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

Detailed Description

Trait to set modes.

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

Definition at line 1846 of file trait.py.

Member Function Documentation

◆ _generate()

def homeassistant.components.google_assistant.trait.ModesTrait._generate (   self,
  name,
  settings 
)
private
Generate a list of modes.

Definition at line 1890 of file trait.py.

◆ execute()

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

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

Definition at line 1971 of file trait.py.

◆ query_attributes()

dict[str, Any] homeassistant.components.google_assistant.trait.ModesTrait.query_attributes (   self)
Return current modes.

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

Definition at line 1938 of file trait.py.

◆ supported()

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

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

Definition at line 1862 of file trait.py.

◆ sync_attributes()

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

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

Definition at line 1914 of file trait.py.

Member Data Documentation

◆ commands

list homeassistant.components.google_assistant.trait.ModesTrait.commands = [COMMAND_SET_MODES]
static

Definition at line 1853 of file trait.py.

◆ name

homeassistant.components.google_assistant.trait.ModesTrait.name = TRAIT_MODES
static

Definition at line 1852 of file trait.py.

◆ SYNONYMS

dictionary homeassistant.components.google_assistant.trait.ModesTrait.SYNONYMS
static
Initial value:
= {
"preset mode": ["preset mode", "mode", "preset"],
"sound mode": ["sound mode", "effects"],
"option": ["option", "setting", "mode", "value"],
}

Definition at line 1855 of file trait.py.


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