Home Assistant Unofficial Reference 2024.12.1
homeassistant.components.time_date.sensor.TimeDateSensor Class Reference
Inheritance diagram for homeassistant.components.time_date.sensor.TimeDateSensor:
[legend]
Collaboration diagram for homeassistant.components.time_date.sensor.TimeDateSensor:
[legend]

Public Member Functions

None __init__ (self, str option_type, str|None entry_id=None)
 
None async_added_to_hass (self)
 
CALLBACK_TYPE async_start_preview (self, Callable[[str, Mapping[str, Any]], None] preview_callback)
 
None async_will_remove_from_hass (self)
 
datetime get_next_interval (self, datetime time_date)
 
str icon (self)
 
str|None native_value (self)
 
None point_in_time_listener (self, datetime time_date)
 
- Public Member Functions inherited from homeassistant.components.sensor.SensorEntity
None add_to_platform_start (self, HomeAssistant hass, EntityPlatform platform, asyncio.Semaphore|None parallel_updates)
 
None async_internal_added_to_hass (self)
 
None async_registry_entry_updated (self)
 
dict[str, Any]|None capability_attributes (self)
 
SensorDeviceClass|None device_class (self)
 
er.EntityOptionsType|None get_initial_entity_options (self)
 
datetime|None last_reset (self)
 
str|None native_unit_of_measurement (self)
 
list[str]|None options (self)
 
Any state (self)
 
dict[str, Any]|None state_attributes (self)
 
SensorStateClass|str|None state_class (self)
 
int|None suggested_display_precision (self)
 
str|None suggested_unit_of_measurement (self)
 
str|None unit_of_measurement (self)
 
- 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)
 
bool assumed_state (self)
 
None async_device_update (self, bool warning=True)
 
None async_internal_will_remove_from_hass (self)
 
None async_on_remove (self, CALLBACK_TYPE func)
 
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_write_ha_state (self)
 
str|None attribution (self)
 
bool available (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)
 
bool has_entity_name (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)
 
int|None supported_features (self)
 
str|None translation_key (self)
 
Mapping[str, strtranslation_placeholders (self)
 
str|None unique_id (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)
 

Public Attributes

 entity_id
 
 type
 
 unsub
 
- Public Attributes inherited from homeassistant.components.sensor.SensorEntity
 entity_category
 
 registry_entry
 
 unit_of_measurement
 
- Public Attributes inherited from homeassistant.helpers.entity.Entity
 device_entry
 
 entity_id
 
 hass
 
 parallel_updates
 
 platform
 
 registry_entry
 

Static Public Attributes

 None
 
- Static Public Attributes inherited from homeassistant.components.sensor.SensorEntity
 Decimal
 
 None
 
 UndefinedType
 
- Static Public Attributes inherited from homeassistant.helpers.entity.Entity
 bool
 
 EntityPlatform
 
 HomeAssistant
 
 None
 
 StateInfo
 
 StateType
 
 str
 

Private Member Functions

None _update_internal_state (self, datetime time_date)
 
None _update_state_and_setup_listener (self)
 

Private Attributes

 _attr_translation_key
 
 _attr_unique_id
 
 _state
 

Static Private Attributes

bool _attr_has_entity_name = True
 
bool _attr_should_poll = False
 

Detailed Description

Implementation of a Time and Date sensor.

Definition at line 68 of file sensor.py.

Constructor & Destructor Documentation

◆ __init__()

None homeassistant.components.time_date.sensor.TimeDateSensor.__init__ (   self,
str  option_type,
str | None   entry_id = None 
)
Initialize the sensor.

Definition at line 76 of file sensor.py.

Member Function Documentation

◆ _update_internal_state()

None homeassistant.components.time_date.sensor.TimeDateSensor._update_internal_state (   self,
datetime  time_date 
)
private

Definition at line 162 of file sensor.py.

◆ _update_state_and_setup_listener()

None homeassistant.components.time_date.sensor.TimeDateSensor._update_state_and_setup_listener (   self)
private
Update state and setup listener for next interval.

Definition at line 185 of file sensor.py.

◆ async_added_to_hass()

None homeassistant.components.time_date.sensor.TimeDateSensor.async_added_to_hass (   self)
Set up first update.

Reimplemented from homeassistant.helpers.entity.Entity.

Definition at line 128 of file sensor.py.

◆ async_start_preview()

CALLBACK_TYPE homeassistant.components.time_date.sensor.TimeDateSensor.async_start_preview (   self,
Callable[[str, Mapping[str, Any]], None preview_callback 
)
Render a preview.

Definition at line 100 of file sensor.py.

◆ async_will_remove_from_hass()

None homeassistant.components.time_date.sensor.TimeDateSensor.async_will_remove_from_hass (   self)
Cancel next update.

Reimplemented from homeassistant.helpers.entity.Entity.

Definition at line 141 of file sensor.py.

◆ get_next_interval()

datetime homeassistant.components.time_date.sensor.TimeDateSensor.get_next_interval (   self,
datetime  time_date 
)
Compute next time an update should occur.

Definition at line 147 of file sensor.py.

◆ icon()

str homeassistant.components.time_date.sensor.TimeDateSensor.icon (   self)
Icon to use in the frontend, if any.

Reimplemented from homeassistant.helpers.entity.Entity.

Definition at line 91 of file sensor.py.

◆ native_value()

str | None homeassistant.components.time_date.sensor.TimeDateSensor.native_value (   self)
Return the state of the sensor.

Reimplemented from homeassistant.components.sensor.SensorEntity.

Definition at line 86 of file sensor.py.

◆ point_in_time_listener()

None homeassistant.components.time_date.sensor.TimeDateSensor.point_in_time_listener (   self,
datetime  time_date 
)
Get the latest data and update state.

Definition at line 194 of file sensor.py.

Member Data Documentation

◆ _attr_has_entity_name

bool homeassistant.components.time_date.sensor.TimeDateSensor._attr_has_entity_name = True
staticprivate

Definition at line 72 of file sensor.py.

◆ _attr_should_poll

bool homeassistant.components.time_date.sensor.TimeDateSensor._attr_should_poll = False
staticprivate

Definition at line 71 of file sensor.py.

◆ _attr_translation_key

homeassistant.components.time_date.sensor.TimeDateSensor._attr_translation_key
private

Definition at line 78 of file sensor.py.

◆ _attr_unique_id

homeassistant.components.time_date.sensor.TimeDateSensor._attr_unique_id
private

Definition at line 81 of file sensor.py.

◆ _state

homeassistant.components.time_date.sensor.TimeDateSensor._state
private

Definition at line 169 of file sensor.py.

◆ entity_id

homeassistant.components.time_date.sensor.TimeDateSensor.entity_id

Definition at line 80 of file sensor.py.

◆ None

homeassistant.components.time_date.sensor.TimeDateSensor.None
static

Definition at line 73 of file sensor.py.

◆ type

homeassistant.components.time_date.sensor.TimeDateSensor.type

Definition at line 79 of file sensor.py.

◆ unsub

homeassistant.components.time_date.sensor.TimeDateSensor.unsub

Definition at line 112 of file sensor.py.


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