Home Assistant Unofficial Reference 2024.12.1
homeassistant.components.philips_js.light.AmbilightEffect Class Reference

Public Member Functions

str __str__ (self)
 
bool is_on (self, powerstate)
 
bool is_valid (self)
 

Static Public Member Functions

AmbilightEffect from_str (str effect_string)
 

Public Attributes

 mode
 
 style
 

Static Public Attributes

 None
 

Detailed Description

Data class describing the ambilight effect.

Definition at line 55 of file light.py.

Member Function Documentation

◆ __str__()

str homeassistant.components.philips_js.light.AmbilightEffect.__str__ (   self)
Get a string representation of the effect.

Definition at line 95 of file light.py.

◆ from_str()

AmbilightEffect homeassistant.components.philips_js.light.AmbilightEffect.from_str ( str  effect_string)
static
Create AmbilightEffect object from string.

Definition at line 85 of file light.py.

◆ is_on()

bool homeassistant.components.philips_js.light.AmbilightEffect.is_on (   self,
  powerstate 
)
Check whether the ambilight is considered on.

Definition at line 62 of file light.py.

◆ is_valid()

bool homeassistant.components.philips_js.light.AmbilightEffect.is_valid (   self)
Validate the effect configuration.

Definition at line 78 of file light.py.

Member Data Documentation

◆ mode

homeassistant.components.philips_js.light.AmbilightEffect.mode

Definition at line 71 of file light.py.

◆ None

homeassistant.components.philips_js.light.AmbilightEffect.None
static

Definition at line 60 of file light.py.

◆ style

homeassistant.components.philips_js.light.AmbilightEffect.style

Definition at line 67 of file light.py.


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