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

Public Member Functions

None __init__ (self, HomeAssistant hass, state, config)
 
def can_execute (self, command, params)
 
def execute (self, command, data, params, challenge)
 
dict[str, Any] query_attributes (self)
 
dict[str, Any]|None query_notifications (self)
 
dict[str, Any] sync_attributes (self)
 
dict[str, Any] sync_options (self)
 

Static Public Member Functions

def might_2fa (domain, features, device_class)
 
def supported (domain, features, device_class, attributes)
 

Public Attributes

 config
 
 hass
 
 state
 

Detailed Description

Represents a Trait inside Google Assistant skill.

Definition at line 270 of file trait.py.

Constructor & Destructor Documentation

◆ __init__()

None homeassistant.components.google_assistant.trait._Trait.__init__ (   self,
HomeAssistant  hass,
  state,
  config 
)
Initialize a trait for a state.

Definition at line 286 of file trait.py.

Member Function Documentation

◆ can_execute()

def homeassistant.components.google_assistant.trait._Trait.can_execute (   self,
  command,
  params 
)
Test if command can be executed.

Definition at line 307 of file trait.py.

◆ execute()

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

Reimplemented in homeassistant.components.google_assistant.trait.ChannelTrait, homeassistant.components.google_assistant.trait.TransportControlTrait, homeassistant.components.google_assistant.trait.VolumeTrait, homeassistant.components.google_assistant.trait.OpenCloseTrait, homeassistant.components.google_assistant.trait.InputSelectorTrait, homeassistant.components.google_assistant.trait.ModesTrait, homeassistant.components.google_assistant.trait.FanSpeedTrait, homeassistant.components.google_assistant.trait.ArmDisArmTrait, homeassistant.components.google_assistant.trait.LockUnlockTrait, homeassistant.components.google_assistant.trait.HumiditySettingTrait, homeassistant.components.google_assistant.trait.TemperatureSettingTrait, homeassistant.components.google_assistant.trait.TemperatureControlTrait, homeassistant.components.google_assistant.trait.StartStopTrait, homeassistant.components.google_assistant.trait.EnergyStorageTrait, homeassistant.components.google_assistant.trait.LocatorTrait, homeassistant.components.google_assistant.trait.DockTrait, homeassistant.components.google_assistant.trait.SceneTrait, homeassistant.components.google_assistant.trait.ColorSettingTrait, homeassistant.components.google_assistant.trait.OnOffTrait, homeassistant.components.google_assistant.trait.ObjectDetection, homeassistant.components.google_assistant.trait.CameraStreamTrait, and homeassistant.components.google_assistant.trait.BrightnessTrait.

Definition at line 311 of file trait.py.

◆ might_2fa()

def homeassistant.components.google_assistant.trait._Trait.might_2fa (   domain,
  features,
  device_class 
)
static

◆ query_attributes()

dict[str, Any] homeassistant.components.google_assistant.trait._Trait.query_attributes (   self)
Return the attributes of this trait for this entity.

Reimplemented in homeassistant.components.google_assistant.trait.SensorStateTrait, homeassistant.components.google_assistant.trait.ChannelTrait, homeassistant.components.google_assistant.trait.MediaStateTrait, homeassistant.components.google_assistant.trait.TransportControlTrait, homeassistant.components.google_assistant.trait.VolumeTrait, homeassistant.components.google_assistant.trait.OpenCloseTrait, homeassistant.components.google_assistant.trait.InputSelectorTrait, homeassistant.components.google_assistant.trait.ModesTrait, homeassistant.components.google_assistant.trait.FanSpeedTrait, homeassistant.components.google_assistant.trait.ArmDisArmTrait, homeassistant.components.google_assistant.trait.LockUnlockTrait, homeassistant.components.google_assistant.trait.HumiditySettingTrait, homeassistant.components.google_assistant.trait.TemperatureSettingTrait, homeassistant.components.google_assistant.trait.TemperatureControlTrait, homeassistant.components.google_assistant.trait.StartStopTrait, homeassistant.components.google_assistant.trait.EnergyStorageTrait, homeassistant.components.google_assistant.trait.LocatorTrait, homeassistant.components.google_assistant.trait.DockTrait, homeassistant.components.google_assistant.trait.SceneTrait, homeassistant.components.google_assistant.trait.ColorSettingTrait, homeassistant.components.google_assistant.trait.OnOffTrait, homeassistant.components.google_assistant.trait.ObjectDetection, homeassistant.components.google_assistant.trait.CameraStreamTrait, and homeassistant.components.google_assistant.trait.BrightnessTrait.

Definition at line 300 of file trait.py.

◆ query_notifications()

dict[str, Any] | None homeassistant.components.google_assistant.trait._Trait.query_notifications (   self)
Return notifications payload.

Reimplemented in homeassistant.components.google_assistant.trait.ObjectDetection.

Definition at line 304 of file trait.py.

◆ supported()

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

Reimplemented in homeassistant.components.google_assistant.trait.ColorSettingTrait, homeassistant.components.google_assistant.trait.BrightnessTrait, homeassistant.components.google_assistant.trait.ChannelTrait, homeassistant.components.google_assistant.trait.MediaStateTrait, homeassistant.components.google_assistant.trait.TransportControlTrait, homeassistant.components.google_assistant.trait.VolumeTrait, homeassistant.components.google_assistant.trait.OpenCloseTrait, homeassistant.components.google_assistant.trait.InputSelectorTrait, homeassistant.components.google_assistant.trait.ModesTrait, homeassistant.components.google_assistant.trait.FanSpeedTrait, homeassistant.components.google_assistant.trait.ArmDisArmTrait, homeassistant.components.google_assistant.trait.LockUnlockTrait, homeassistant.components.google_assistant.trait.HumiditySettingTrait, homeassistant.components.google_assistant.trait.TemperatureSettingTrait, homeassistant.components.google_assistant.trait.TemperatureControlTrait, homeassistant.components.google_assistant.trait.StartStopTrait, homeassistant.components.google_assistant.trait.EnergyStorageTrait, homeassistant.components.google_assistant.trait.LocatorTrait, homeassistant.components.google_assistant.trait.DockTrait, homeassistant.components.google_assistant.trait.SceneTrait, homeassistant.components.google_assistant.trait.OnOffTrait, homeassistant.components.google_assistant.trait.ObjectDetection, and homeassistant.components.google_assistant.trait.CameraStreamTrait.

Definition at line 283 of file trait.py.

◆ sync_attributes()

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

Reimplemented in homeassistant.components.google_assistant.trait.SensorStateTrait, homeassistant.components.google_assistant.trait.ChannelTrait, homeassistant.components.google_assistant.trait.MediaStateTrait, homeassistant.components.google_assistant.trait.TransportControlTrait, homeassistant.components.google_assistant.trait.VolumeTrait, homeassistant.components.google_assistant.trait.OpenCloseTrait, homeassistant.components.google_assistant.trait.InputSelectorTrait, homeassistant.components.google_assistant.trait.ModesTrait, homeassistant.components.google_assistant.trait.FanSpeedTrait, homeassistant.components.google_assistant.trait.ArmDisArmTrait, homeassistant.components.google_assistant.trait.LockUnlockTrait, homeassistant.components.google_assistant.trait.HumiditySettingTrait, homeassistant.components.google_assistant.trait.TemperatureSettingTrait, homeassistant.components.google_assistant.trait.TemperatureControlTrait, homeassistant.components.google_assistant.trait.StartStopTrait, homeassistant.components.google_assistant.trait.EnergyStorageTrait, homeassistant.components.google_assistant.trait.LocatorTrait, homeassistant.components.google_assistant.trait.DockTrait, homeassistant.components.google_assistant.trait.SceneTrait, homeassistant.components.google_assistant.trait.ColorSettingTrait, homeassistant.components.google_assistant.trait.OnOffTrait, homeassistant.components.google_assistant.trait.ObjectDetection, homeassistant.components.google_assistant.trait.CameraStreamTrait, and homeassistant.components.google_assistant.trait.BrightnessTrait.

Definition at line 292 of file trait.py.

◆ sync_options()

dict[str, Any] homeassistant.components.google_assistant.trait._Trait.sync_options (   self)
Add options for the sync request.

Reimplemented in homeassistant.components.google_assistant.trait.ObjectDetection.

Definition at line 296 of file trait.py.

Member Data Documentation

◆ config

homeassistant.components.google_assistant.trait._Trait.config

Definition at line 290 of file trait.py.

◆ hass

homeassistant.components.google_assistant.trait._Trait.hass

Definition at line 288 of file trait.py.

◆ state

homeassistant.components.google_assistant.trait._Trait.state

Definition at line 289 of file trait.py.


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