Home Assistant Unofficial Reference 2024.12.1
homeassistant.components.sun.entity.Sun Class Reference
Inheritance diagram for homeassistant.components.sun.entity.Sun:
[legend]
Collaboration diagram for homeassistant.components.sun.entity.Sun:
[legend]

Public Member Functions

None __init__ (self, HomeAssistant hass)
 
dict[str, Any] extra_state_attributes (self)
 
None remove_listeners (self)
 
str state (self)
 
None update_events (self, datetime|None now=None)
 
None update_location (self, Event|None _=None, bool initial=False)
 
None update_sun_position (self, datetime|None now=None)
 
- 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)
 
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)
 
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)
 

Public Attributes

 elevation
 
 hass
 
 location
 
 next_dawn
 
 next_dusk
 
 next_midnight
 
 next_noon
 
 next_rising
 
 next_setting
 
 phase
 
 rising
 
 solar_azimuth
 
 solar_elevation
 
- Public Attributes inherited from homeassistant.helpers.entity.Entity
 device_entry
 
 entity_id
 
 hass
 
 parallel_updates
 
 platform
 
 registry_entry
 

Static Public Attributes

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

Private Member Functions

datetime _check_event (self, datetime utc_point_in_time, str sun_event, str|None before)
 

Private Attributes

 _config_listener
 
 _next_change
 
 _state_info
 
 _update_events_listener
 
 _update_sun_position_listener
 

Static Private Attributes

string _attr_name = "Sun"
 
bool _no_platform_reported = True
 
 _unrecorded_attributes
 

Detailed Description

Representation of the Sun.

Definition at line 84 of file entity.py.

Constructor & Destructor Documentation

◆ __init__()

None homeassistant.components.sun.entity.Sun.__init__ (   self,
HomeAssistant  hass 
)
Initialize the sun.

Definition at line 120 of file entity.py.

Member Function Documentation

◆ _check_event()

datetime homeassistant.components.sun.entity.Sun._check_event (   self,
datetime  utc_point_in_time,
str  sun_event,
str | None   before 
)
private

Definition at line 185 of file entity.py.

◆ extra_state_attributes()

dict[str, Any] homeassistant.components.sun.entity.Sun.extra_state_attributes (   self)
Return the state attributes of the sun.

Reimplemented from homeassistant.helpers.entity.Entity.

Definition at line 171 of file entity.py.

◆ remove_listeners()

None homeassistant.components.sun.entity.Sun.remove_listeners (   self)
Remove listeners.

Definition at line 152 of file entity.py.

◆ state()

str homeassistant.components.sun.entity.Sun.state (   self)
Return the state of the sun.

Reimplemented from homeassistant.helpers.entity.Entity.

Definition at line 162 of file entity.py.

◆ update_events()

None homeassistant.components.sun.entity.Sun.update_events (   self,
datetime | None   now = None 
)
Update the attributes containing solar events.

Definition at line 197 of file entity.py.

◆ update_location()

None homeassistant.components.sun.entity.Sun.update_location (   self,
Event | None   _ = None,
bool   initial = False 
)
Update location.

Definition at line 140 of file entity.py.

◆ update_sun_position()

None homeassistant.components.sun.entity.Sun.update_sun_position (   self,
datetime | None   now = None 
)
Calculate the position of the sun.

Definition at line 268 of file entity.py.

Member Data Documentation

◆ _attr_name

string homeassistant.components.sun.entity.Sun._attr_name = "Sun"
staticprivate

Definition at line 101 of file entity.py.

◆ _config_listener

homeassistant.components.sun.entity.Sun._config_listener
private

Definition at line 134 of file entity.py.

◆ _next_change

homeassistant.components.sun.entity.Sun._next_change
private

Definition at line 192 of file entity.py.

◆ _no_platform_reported

bool homeassistant.components.sun.entity.Sun._no_platform_reported = True
staticprivate

Definition at line 105 of file entity.py.

◆ _state_info

homeassistant.components.sun.entity.Sun._state_info
private

Definition at line 127 of file entity.py.

◆ _unrecorded_attributes

homeassistant.components.sun.entity.Sun._unrecorded_attributes
staticprivate
Initial value:
= frozenset(
{
STATE_ATTR_AZIMUTH,
STATE_ATTR_ELEVATION,
STATE_ATTR_RISING,
STATE_ATTR_NEXT_DAWN,
STATE_ATTR_NEXT_DUSK,
STATE_ATTR_NEXT_MIDNIGHT,
STATE_ATTR_NEXT_NOON,
STATE_ATTR_NEXT_RISING,
STATE_ATTR_NEXT_SETTING,
}
)

Definition at line 87 of file entity.py.

◆ _update_events_listener

homeassistant.components.sun.entity.Sun._update_events_listener
private

Definition at line 262 of file entity.py.

◆ _update_sun_position_listener

homeassistant.components.sun.entity.Sun._update_sun_position_listener
private

Definition at line 295 of file entity.py.

◆ elevation

homeassistant.components.sun.entity.Sun.elevation

Definition at line 146 of file entity.py.

◆ entity_id

homeassistant.components.sun.entity.Sun.entity_id = ENTITY_ID
static

Definition at line 102 of file entity.py.

◆ hass

homeassistant.components.sun.entity.Sun.hass

Definition at line 122 of file entity.py.

◆ location

homeassistant.components.sun.entity.Sun.location

Definition at line 145 of file entity.py.

◆ next_dawn

homeassistant.components.sun.entity.Sun.next_dawn

Definition at line 210 of file entity.py.

◆ next_dusk

homeassistant.components.sun.entity.Sun.next_dusk

Definition at line 224 of file entity.py.

◆ next_midnight

homeassistant.components.sun.entity.Sun.next_midnight

Definition at line 229 of file entity.py.

◆ next_noon

homeassistant.components.sun.entity.Sun.next_noon

Definition at line 218 of file entity.py.

◆ next_rising

homeassistant.components.sun.entity.Sun.next_rising

Definition at line 213 of file entity.py.

◆ next_setting

homeassistant.components.sun.entity.Sun.next_setting

Definition at line 220 of file entity.py.

◆ phase

homeassistant.components.sun.entity.Sun.phase

Definition at line 193 of file entity.py.

◆ rising

homeassistant.components.sun.entity.Sun.rising

Definition at line 251 of file entity.py.

◆ solar_azimuth

homeassistant.components.sun.entity.Sun.solar_azimuth

Definition at line 272 of file entity.py.

◆ solar_elevation

homeassistant.components.sun.entity.Sun.solar_elevation

Definition at line 275 of file entity.py.


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