Home Assistant Unofficial Reference 2024.12.1
homeassistant.components.tod.binary_sensor.TodSensor Class Reference
Inheritance diagram for homeassistant.components.tod.binary_sensor.TodSensor:
[legend]
Collaboration diagram for homeassistant.components.tod.binary_sensor.TodSensor:
[legend]

Public Member Functions

None __init__ (self, str name, time after, timedelta after_offset, time before, timedelta before_offset, str|None unique_id)
 
None async_added_to_hass (self)
 
dict[str, Any]|None extra_state_attributes (self)
 
bool is_on (self)
 
- Public Member Functions inherited from homeassistant.components.binary_sensor.BinarySensorEntity
None async_internal_added_to_hass (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)
 
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_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)
 
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)
 

Private Member Functions

datetime _add_one_dst_aware_day (self, datetime a_date, time target_time)
 
None _calculate_boundary_time (self)
 
None _calculate_next_update (self)
 
datetime _naive_time_to_utc_datetime (self, time naive_time)
 
None _point_in_time_listener (self, datetime now)
 
None _turn_to_next_day (self)
 

Private Attributes

 _after
 
 _after_offset
 
 _attr_name
 
 _attr_unique_id
 
 _before
 
 _before_offset
 
 _next_update
 
 _time_after
 
 _time_before
 
 _unsub_update
 

Static Private Attributes

bool _attr_should_poll = False
 

Additional Inherited Members

- Public Attributes inherited from homeassistant.components.binary_sensor.BinarySensorEntity
 entity_category
 
- 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.binary_sensor.BinarySensorEntity
 None
 
- Static Public Attributes inherited from homeassistant.helpers.entity.Entity
 bool
 
 EntityPlatform
 
 HomeAssistant
 
 None
 
 StateInfo
 
 StateType
 
 str
 

Detailed Description

Time of the Day Sensor.

Definition at line 108 of file binary_sensor.py.

Constructor & Destructor Documentation

◆ __init__()

None homeassistant.components.tod.binary_sensor.TodSensor.__init__ (   self,
str  name,
time  after,
timedelta  after_offset,
time  before,
timedelta  before_offset,
str | None  unique_id 
)
Init the ToD Sensor...

Definition at line 116 of file binary_sensor.py.

Member Function Documentation

◆ _add_one_dst_aware_day()

datetime homeassistant.components.tod.binary_sensor.TodSensor._add_one_dst_aware_day (   self,
datetime  a_date,
time  target_time 
)
private
Add 24 hours (1 day) but account for DST.

Definition at line 223 of file binary_sensor.py.

◆ _calculate_boundary_time()

None homeassistant.components.tod.binary_sensor.TodSensor._calculate_boundary_time (   self)
private
Calculate internal absolute time boundaries.

Definition at line 161 of file binary_sensor.py.

◆ _calculate_next_update()

None homeassistant.components.tod.binary_sensor.TodSensor._calculate_next_update (   self)
private
Datetime when the next update to the state.

Definition at line 279 of file binary_sensor.py.

◆ _naive_time_to_utc_datetime()

datetime homeassistant.components.tod.binary_sensor.TodSensor._naive_time_to_utc_datetime (   self,
time  naive_time 
)
private
Convert naive time from config to utc_datetime with current day.

Definition at line 152 of file binary_sensor.py.

◆ _point_in_time_listener()

None homeassistant.components.tod.binary_sensor.TodSensor._point_in_time_listener (   self,
datetime  now 
)
private
Run when the state of the sensor should be updated.

Definition at line 292 of file binary_sensor.py.

◆ _turn_to_next_day()

None homeassistant.components.tod.binary_sensor.TodSensor._turn_to_next_day (   self)
private
Turn to to the next day.

Definition at line 238 of file binary_sensor.py.

◆ async_added_to_hass()

None homeassistant.components.tod.binary_sensor.TodSensor.async_added_to_hass (   self)
Call when entity about to be added to Home Assistant.

Reimplemented from homeassistant.helpers.entity.Entity.

Definition at line 262 of file binary_sensor.py.

◆ extra_state_attributes()

dict[str, Any] | None homeassistant.components.tod.binary_sensor.TodSensor.extra_state_attributes (   self)
Return the state attributes of the sensor.

Reimplemented from homeassistant.helpers.entity.Entity.

Definition at line 142 of file binary_sensor.py.

◆ is_on()

bool homeassistant.components.tod.binary_sensor.TodSensor.is_on (   self)
Return True is sensor is on.

Definition at line 135 of file binary_sensor.py.

Member Data Documentation

◆ _after

homeassistant.components.tod.binary_sensor.TodSensor._after
private

Definition at line 131 of file binary_sensor.py.

◆ _after_offset

homeassistant.components.tod.binary_sensor.TodSensor._after_offset
private

Definition at line 128 of file binary_sensor.py.

◆ _attr_name

homeassistant.components.tod.binary_sensor.TodSensor._attr_name
private

Definition at line 127 of file binary_sensor.py.

◆ _attr_should_poll

bool homeassistant.components.tod.binary_sensor.TodSensor._attr_should_poll = False
staticprivate

Definition at line 111 of file binary_sensor.py.

◆ _attr_unique_id

homeassistant.components.tod.binary_sensor.TodSensor._attr_unique_id
private

Definition at line 126 of file binary_sensor.py.

◆ _before

homeassistant.components.tod.binary_sensor.TodSensor._before
private

Definition at line 130 of file binary_sensor.py.

◆ _before_offset

homeassistant.components.tod.binary_sensor.TodSensor._before_offset
private

Definition at line 129 of file binary_sensor.py.

◆ _next_update

homeassistant.components.tod.binary_sensor.TodSensor._next_update
private

Definition at line 283 of file binary_sensor.py.

◆ _time_after

homeassistant.components.tod.binary_sensor.TodSensor._time_after
private

Definition at line 178 of file binary_sensor.py.

◆ _time_before

homeassistant.components.tod.binary_sensor.TodSensor._time_before
private

Definition at line 201 of file binary_sensor.py.

◆ _unsub_update

homeassistant.components.tod.binary_sensor.TodSensor._unsub_update
private

Definition at line 271 of file binary_sensor.py.


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