Home Assistant Unofficial Reference 2024.12.1
homeassistant.components.schedule.Schedule Class Reference
Inheritance diagram for homeassistant.components.schedule.Schedule:
[legend]
Collaboration diagram for homeassistant.components.schedule.Schedule:
[legend]

Public Member Functions

None __init__ (self, ConfigType config, bool editable)
 
frozenset[strall_custom_data_keys (self)
 
None async_added_to_hass (self)
 
None async_update_config (self, ConfigType config)
 
Schedule from_storage (cls, ConfigType config)
 
Schedule from_yaml (cls, ConfigType config)
 
- 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_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)
 
bool available (self)
 
dict[str, Any]|None capability_attributes (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)
 
StateType state (self)
 
dict[str, Any]|None state_attributes (self)
 
str|None suggested_object_id (self)
 
int|None supported_features (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)
 

Static Public Attributes

 None
 
- Static Public Attributes inherited from homeassistant.helpers.entity.Entity
 bool
 
 EntityPlatform
 
 HomeAssistant
 
 None
 
 StateInfo
 
 StateType
 
 str
 

Private Member Functions

None _clean_up_listener (self)
 
None _update (self, datetime|None _=None)
 

Private Attributes

 _attr_capability_attributes
 
 _attr_extra_state_attributes
 
 _attr_icon
 
 _attr_name
 
 _attr_state
 
 _attr_unique_id
 
 _config
 
 _Entity__combined_unrecorded_attributes
 
 _unrecorded_attributes
 
 _unsub_update
 

Static Private Attributes

bool _attr_has_entity_name = True
 
bool _attr_should_poll = False
 
 _entity_component_unrecorded_attributes
 

Additional Inherited Members

- Public Attributes inherited from homeassistant.helpers.entity.Entity
 device_entry
 
 entity_id
 
 hass
 
 parallel_updates
 
 platform
 
 registry_entry
 

Detailed Description

Schedule entity.

Definition at line 239 of file __init__.py.

Constructor & Destructor Documentation

◆ __init__()

None homeassistant.components.schedule.Schedule.__init__ (   self,
ConfigType  config,
bool  editable 
)
Initialize a schedule.

Definition at line 253 of file __init__.py.

Member Function Documentation

◆ _clean_up_listener()

None homeassistant.components.schedule.Schedule._clean_up_listener (   self)
private
Remove the update timer.

Definition at line 288 of file __init__.py.

◆ _update()

None homeassistant.components.schedule.Schedule._update (   self,
datetime | None   _ = None 
)
private
Update the states of the schedule.

Definition at line 300 of file __init__.py.

◆ all_custom_data_keys()

frozenset[str] homeassistant.components.schedule.Schedule.all_custom_data_keys (   self)
Return the set of all currently used custom data attribute keys.

Definition at line 374 of file __init__.py.

◆ async_added_to_hass()

None homeassistant.components.schedule.Schedule.async_added_to_hass (   self)
Run when entity about to be added to hass.

Reimplemented from homeassistant.helpers.entity.Entity.

Definition at line 294 of file __init__.py.

◆ async_update_config()

None homeassistant.components.schedule.Schedule.async_update_config (   self,
ConfigType  config 
)
Handle when the config is updated.

Reimplemented from homeassistant.helpers.collection.CollectionEntity.

Definition at line 279 of file __init__.py.

◆ from_storage()

Schedule homeassistant.components.schedule.Schedule.from_storage (   cls,
ConfigType  config 
)
Return entity instance initialized from storage.

Reimplemented from homeassistant.helpers.collection.CollectionEntity.

Definition at line 268 of file __init__.py.

◆ from_yaml()

Schedule homeassistant.components.schedule.Schedule.from_yaml (   cls,
ConfigType  config 
)
Return entity instance initialized from yaml.

Reimplemented from homeassistant.helpers.collection.CollectionEntity.

Definition at line 273 of file __init__.py.

Member Data Documentation

◆ _attr_capability_attributes

homeassistant.components.schedule.Schedule._attr_capability_attributes
private

Definition at line 256 of file __init__.py.

◆ _attr_extra_state_attributes

homeassistant.components.schedule.Schedule._attr_extra_state_attributes
private

Definition at line 357 of file __init__.py.

◆ _attr_has_entity_name

bool homeassistant.components.schedule.Schedule._attr_has_entity_name = True
staticprivate

Definition at line 246 of file __init__.py.

◆ _attr_icon

homeassistant.components.schedule.Schedule._attr_icon
private

Definition at line 257 of file __init__.py.

◆ _attr_name

homeassistant.components.schedule.Schedule._attr_name
private

Definition at line 258 of file __init__.py.

◆ _attr_should_poll

bool homeassistant.components.schedule.Schedule._attr_should_poll = False
staticprivate

Definition at line 247 of file __init__.py.

◆ _attr_state

homeassistant.components.schedule.Schedule._attr_state
private

Definition at line 313 of file __init__.py.

◆ _attr_unique_id

homeassistant.components.schedule.Schedule._attr_unique_id
private

Definition at line 259 of file __init__.py.

◆ _config

homeassistant.components.schedule.Schedule._config
private

Definition at line 255 of file __init__.py.

◆ _Entity__combined_unrecorded_attributes

homeassistant.components.schedule.Schedule._Entity__combined_unrecorded_attributes
private

Definition at line 263 of file __init__.py.

◆ _entity_component_unrecorded_attributes

homeassistant.components.schedule.Schedule._entity_component_unrecorded_attributes
staticprivate
Initial value:
= frozenset(
{ATTR_EDITABLE, ATTR_NEXT_EVENT}
)

Definition at line 242 of file __init__.py.

◆ _unrecorded_attributes

homeassistant.components.schedule.Schedule._unrecorded_attributes
private

Definition at line 262 of file __init__.py.

◆ _unsub_update

homeassistant.components.schedule.Schedule._unsub_update
private

Definition at line 292 of file __init__.py.

◆ None

homeassistant.components.schedule.Schedule.None
static

Definition at line 251 of file __init__.py.


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