Home Assistant Unofficial Reference 2024.12.1
homeassistant.components.philips_js.light.PhilipsTVLightEntity Class Reference
Inheritance diagram for homeassistant.components.philips_js.light.PhilipsTVLightEntity:
[legend]
Collaboration diagram for homeassistant.components.philips_js.light.PhilipsTVLightEntity:
[legend]

Public Member Functions

None __init__ (self, PhilipsTVDataUpdateCoordinator coordinator)
 
None async_turn_off (self, **Any kwargs)
 
None async_turn_on (self, **Any kwargs)
 
bool available (self)
 
ColorMode color_mode (self)
 
def is_on (self)
 
- Public Member Functions inherited from homeassistant.helpers.update_coordinator.CoordinatorEntity
None __init__ (self, _DataUpdateCoordinatorT coordinator, Any context=None)
 
None async_update (self)
 
- Public Member Functions inherited from homeassistant.components.philips_js.coordinator.PhilipsTVDataUpdateCoordinator
None __init__ (self, HomeAssistant hass, PhilipsTV api, Mapping[str, Any] options)
 
DeviceInfo device_info (self)
 
SystemType system (self)
 
str unique_id (self)
 
- Public Member Functions inherited from homeassistant.helpers.update_coordinator.DataUpdateCoordinator
None __init__ (self, HomeAssistant hass, logging.Logger logger, *config_entries.ConfigEntry|None|UndefinedType config_entry=UNDEFINED, str name, timedelta|None update_interval=None, Callable[[], Awaitable[_DataT]]|None update_method=None, Callable[[], Awaitable[None]]|None setup_method=None, Debouncer[Coroutine[Any, Any, None]]|None request_refresh_debouncer=None, bool always_update=True)
 
Callable[[], None] async_add_listener (self, CALLBACK_TYPE update_callback, Any context=None)
 
None async_config_entry_first_refresh (self)
 
Generator[Any] async_contexts (self)
 
None async_refresh (self)
 
None async_register_shutdown (self)
 
None async_request_refresh (self)
 
None async_set_update_error (self, Exception err)
 
None async_set_updated_data (self, _DataT data)
 
None async_shutdown (self)
 
None async_update_listeners (self)
 
timedelta|None update_interval (self)
 
None update_interval (self, timedelta|None value)
 
- Public Member Functions inherited from homeassistant.components.light.LightEntity
int|None brightness (self)
 
dict[str, Any] capability_attributes (self)
 
int|None color_temp (self)
 
int|None color_temp_kelvin (self)
 
str|None effect (self)
 
list[str]|None effect_list (self)
 
tuple[float, float]|None hs_color (self)
 
int max_color_temp_kelvin (self)
 
int max_mireds (self)
 
int min_color_temp_kelvin (self)
 
int min_mireds (self)
 
tuple[int, int, int]|None rgb_color (self)
 
tuple[int, int, int, int]|None rgbw_color (self)
 
tuple[int, int, int, int, int]|None rgbww_color (self)
 
dict[str, Any]|None state_attributes (self)
 
set[ColorMode]|set[str]|None supported_color_modes (self)
 
LightEntityFeature supported_features (self)
 
LightEntityFeature supported_features_compat (self)
 
tuple[float, float]|None xy_color (self)
 
- Public Member Functions inherited from homeassistant.helpers.entity.ToggleEntity
None async_toggle (self, **Any kwargs)
 
Literal["on", "off"]|None state (self)
 
None toggle (self, **Any kwargs)
 
None turn_off (self, **Any kwargs)
 
None turn_on (self, **Any kwargs)
 
- Public Member Functions inherited from homeassistant.helpers.entity.Entity
None __init_subclass__ (cls, **Any kwargs)
 
str __repr__ (self)
 
None add_to_platform_abort (self)
 
None add_to_platform_finish (self)
 
None add_to_platform_start (self, HomeAssistant hass, EntityPlatform platform, asyncio.Semaphore|None parallel_updates)
 
bool assumed_state (self)
 
None async_added_to_hass (self)
 
None async_device_update (self, bool warning=True)
 
None async_internal_added_to_hass (self)
 
None async_internal_will_remove_from_hass (self)
 
None async_on_remove (self, CALLBACK_TYPE func)
 
None async_registry_entry_updated (self)
 
None async_remove (self, *bool force_remove=False)
 
None async_removed_from_registry (self)
 
None async_schedule_update_ha_state (self, bool force_refresh=False)
 
None async_set_context (self, Context context)
 
None async_update_ha_state (self, bool force_refresh=False)
 
None async_will_remove_from_hass (self)
 
None async_write_ha_state (self)
 
str|None attribution (self)
 
str|None device_class (self)
 
DeviceInfo|None device_info (self)
 
bool enabled (self)
 
EntityCategory|None entity_category (self)
 
str|None entity_picture (self)
 
bool entity_registry_enabled_default (self)
 
bool entity_registry_visible_default (self)
 
Mapping[str, Any]|None extra_state_attributes (self)
 
bool force_update (self)
 
HassJobType get_hassjob_type (self, str function_name)
 
er.EntityOptionsType|None get_initial_entity_options (self)
 
bool has_entity_name (self)
 
str|None icon (self)
 
str|UndefinedType|None name (self)
 
None schedule_update_ha_state (self, bool force_refresh=False)
 
bool should_poll (self)
 
str|None suggested_object_id (self)
 
str|None translation_key (self)
 
Mapping[str, strtranslation_placeholders (self)
 
str|None unique_id (self)
 
str|None unit_of_measurement (self)
 
bool use_device_name (self)
 
- Public Member Functions inherited from homeassistant.helpers.entity.CachedProperties
None __init__ (cls, str name, tuple[type,...] bases, dict[Any, Any] namespace, **Any kwargs)
 
Any __new__ (mcs, str name, tuple[type,...] bases, dict[Any, Any] namespace, set[str]|None cached_properties=None, **Any kwargs)
 

Private Member Functions

AmbilightEffect _calculate_effect (self)
 
def _calculate_effect_list (self)
 
None _handle_coordinator_update (self)
 
def _set_ambilight_cached (self, AmbilightEffect effect, tuple[float, float] hs_color, int brightness)
 
def _set_ambilight_config (self, AmbilightEffect effect)
 
def _set_ambilight_expert_config (self, AmbilightEffect effect, tuple[float, float] hs_color, int brightness)
 
def _update_from_coordinator (self)
 

Private Attributes

 _attr_brightness
 
 _attr_effect
 
 _attr_effect_list
 
 _attr_hs_color
 
 _attr_supported_color_modes
 
 _attr_supported_features
 
 _attr_unique_id
 
 _brightness
 
 _cache_keys
 
 _hs
 
 _last_selected_effect
 
 _tv
 

Static Private Attributes

string _attr_translation_key = "ambilight"
 

Additional Inherited Members

- Public Attributes inherited from homeassistant.components.philips_js.coordinator.PhilipsTVDataUpdateCoordinator
 api
 
 options
 
- Public Attributes inherited from homeassistant.helpers.update_coordinator.DataUpdateCoordinator
 always_update
 
 config_entry
 
 data
 
 hass
 
 last_exception
 
 last_update_success
 
 logger
 
 name
 
 setup_method
 
 update_interval
 
 update_method
 
- Public Attributes inherited from homeassistant.helpers.entity.Entity
 device_entry
 
 entity_id
 
 hass
 
 parallel_updates
 
 platform
 
 registry_entry
 
- Static Public Attributes inherited from homeassistant.components.light.LightEntity
 int
 
 LightEntityFeature
 
 None
 
- Static Public Attributes inherited from homeassistant.helpers.entity.ToggleEntity
 None
 
- Static Public Attributes inherited from homeassistant.helpers.entity.Entity
 bool
 
 EntityPlatform
 
 HomeAssistant
 
 None
 
 StateInfo
 
 StateType
 
 str
 

Detailed Description

Representation of a Philips TV exposing the JointSpace API.

Definition at line 136 of file light.py.

Constructor & Destructor Documentation

◆ __init__()

None homeassistant.components.philips_js.light.PhilipsTVLightEntity.__init__ (   self,
PhilipsTVDataUpdateCoordinator  coordinator 
)
Initialize light.

Reimplemented from homeassistant.components.philips_js.entity.PhilipsJsEntity.

Definition at line 141 of file light.py.

Member Function Documentation

◆ _calculate_effect()

AmbilightEffect homeassistant.components.philips_js.light.PhilipsTVLightEntity._calculate_effect (   self)
private
Return the current effect.

Definition at line 187 of file light.py.

◆ _calculate_effect_list()

def homeassistant.components.philips_js.light.PhilipsTVLightEntity._calculate_effect_list (   self)
private
Calculate an effect list based on current status.

Definition at line 159 of file light.py.

◆ _handle_coordinator_update()

None homeassistant.components.philips_js.light.PhilipsTVLightEntity._handle_coordinator_update (   self)
private
Handle updated data from the coordinator.

Definition at line 259 of file light.py.

◆ _set_ambilight_cached()

def homeassistant.components.philips_js.light.PhilipsTVLightEntity._set_ambilight_cached (   self,
AmbilightEffect  effect,
tuple[float, float]  hs_color,
int   brightness 
)
private
Set ambilight via the manual or expert mode.

Definition at line 264 of file light.py.

◆ _set_ambilight_config()

def homeassistant.components.philips_js.light.PhilipsTVLightEntity._set_ambilight_config (   self,
AmbilightEffect  effect 
)
private
Set ambilight via current configuration.

Definition at line 317 of file light.py.

◆ _set_ambilight_expert_config()

def homeassistant.components.philips_js.light.PhilipsTVLightEntity._set_ambilight_expert_config (   self,
AmbilightEffect  effect,
tuple[float, float]  hs_color,
int   brightness 
)
private
Set ambilight via current configuration.

Definition at line 283 of file light.py.

◆ _update_from_coordinator()

def homeassistant.components.philips_js.light.PhilipsTVLightEntity._update_from_coordinator (   self)
private

Definition at line 225 of file light.py.

◆ async_turn_off()

None homeassistant.components.philips_js.light.PhilipsTVLightEntity.async_turn_off (   self,
**Any  kwargs 
)
Turn of ambilight.

Reimplemented from homeassistant.helpers.entity.ToggleEntity.

Definition at line 369 of file light.py.

◆ async_turn_on()

None homeassistant.components.philips_js.light.PhilipsTVLightEntity.async_turn_on (   self,
**Any  kwargs 
)
Turn the bulb on.

Reimplemented from homeassistant.helpers.entity.ToggleEntity.

Definition at line 328 of file light.py.

◆ available()

bool homeassistant.components.philips_js.light.PhilipsTVLightEntity.available (   self)
Return true if entity is available.

Reimplemented from homeassistant.helpers.update_coordinator.CoordinatorEntity.

Definition at line 384 of file light.py.

◆ color_mode()

ColorMode homeassistant.components.philips_js.light.PhilipsTVLightEntity.color_mode (   self)
Return the current color mode.

Reimplemented from homeassistant.components.light.LightEntity.

Definition at line 205 of file light.py.

◆ is_on()

def homeassistant.components.philips_js.light.PhilipsTVLightEntity.is_on (   self)
Return if the light is turned on.

Reimplemented from homeassistant.helpers.entity.ToggleEntity.

Definition at line 217 of file light.py.

Member Data Documentation

◆ _attr_brightness

homeassistant.components.philips_js.light.PhilipsTVLightEntity._attr_brightness
private

Definition at line 247 of file light.py.

◆ _attr_effect

homeassistant.components.philips_js.light.PhilipsTVLightEntity._attr_effect
private

Definition at line 232 of file light.py.

◆ _attr_effect_list

homeassistant.components.philips_js.light.PhilipsTVLightEntity._attr_effect_list
private

Definition at line 231 of file light.py.

◆ _attr_hs_color

homeassistant.components.philips_js.light.PhilipsTVLightEntity._attr_hs_color
private

Definition at line 243 of file light.py.

◆ _attr_supported_color_modes

homeassistant.components.philips_js.light.PhilipsTVLightEntity._attr_supported_color_modes
private

Definition at line 153 of file light.py.

◆ _attr_supported_features

homeassistant.components.philips_js.light.PhilipsTVLightEntity._attr_supported_features
private

Definition at line 154 of file light.py.

◆ _attr_translation_key

string homeassistant.components.philips_js.light.PhilipsTVLightEntity._attr_translation_key = "ambilight"
staticprivate

Definition at line 139 of file light.py.

◆ _attr_unique_id

homeassistant.components.philips_js.light.PhilipsTVLightEntity._attr_unique_id
private

Definition at line 155 of file light.py.

◆ _brightness

homeassistant.components.philips_js.light.PhilipsTVLightEntity._brightness
private

Definition at line 148 of file light.py.

◆ _cache_keys

homeassistant.components.philips_js.light.PhilipsTVLightEntity._cache_keys
private

Definition at line 149 of file light.py.

◆ _hs

homeassistant.components.philips_js.light.PhilipsTVLightEntity._hs
private

Definition at line 147 of file light.py.

◆ _last_selected_effect

homeassistant.components.philips_js.light.PhilipsTVLightEntity._last_selected_effect
private

Definition at line 240 of file light.py.

◆ _tv

homeassistant.components.philips_js.light.PhilipsTVLightEntity._tv
private

Definition at line 146 of file light.py.


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