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

Public Member Functions

None __init__ (self, _ObservationUpdateCoordinatorT observation_coordinator, *Any context=None, _DailyForecastUpdateCoordinatorT|None daily_coordinator=None, _HourlyForecastUpdateCoordinatorT|None hourly_coordinator=None, _TwiceDailyForecastUpdateCoordinatorT|None twice_daily_coordinator=None, timedelta|None daily_forecast_valid=None, timedelta|None hourly_forecast_valid=None, timedelta|None twice_daily_forecast_valid=None)
 
None async_added_to_hass (self)
 
list[Forecast]|None async_forecast_daily (self)
 
list[Forecast]|None async_forecast_hourly (self)
 
list[Forecast]|None async_forecast_twice_daily (self)
 
- Public Member Functions inherited from homeassistant.helpers.update_coordinator.CoordinatorEntity
None __init__ (self, _DataUpdateCoordinatorT coordinator, Any context=None)
 
None async_update (self)
 
bool available (self)
 
- Public Member Functions inherited from homeassistant.components.weather.WeatherEntity
None __post_init__ (self, *Any args, **Any kwargs)
 
None async_internal_added_to_hass (self)
 
None async_registry_entry_updated (self)
 
CALLBACK_TYPE async_subscribe_forecast (self, Literal["daily", "hourly", "twice_daily"] forecast_type, Callable[[list[JsonValueType]|None], None] forecast_listener)
 
None async_update_listeners (self, Iterable[Literal["daily", "hourly", "twice_daily"]]|None forecast_types)
 
float|None cloud_coverage (self)
 
str|None condition (self)
 
float|None humidity (self)
 
float|None native_apparent_temperature (self)
 
float|None native_dew_point (self)
 
str|None native_precipitation_unit (self)
 
float|None native_pressure (self)
 
str|None native_pressure_unit (self)
 
float|None native_temperature (self)
 
str|None native_temperature_unit (self)
 
float|None native_visibility (self)
 
str|None native_visibility_unit (self)
 
float|None native_wind_gust_speed (self)
 
float|None native_wind_speed (self)
 
str|None native_wind_speed_unit (self)
 
float|None ozone (self)
 
float precision (self)
 
str|None state (self)
 
dict[str, Any] state_attributes (self)
 
float|None uv_index (self)
 
float|str|None wind_bearing (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_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)
 
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 Member Functions inherited from homeassistant.components.weather.PostInitMeta
Any __call__ (cls, *Any args, **Any kwargs)
 

Public Attributes

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

Private Member Functions

list[Forecast]|None _async_forecast (self, Literal["daily", "hourly", "twice_daily"] forecast_type)
 
list[Forecast]|None _async_forecast_daily (self)
 
list[Forecast]|None _async_forecast_hourly (self)
 
list[Forecast]|None _async_forecast_twice_daily (self)
 
bool _async_refresh_forecast (self, TimestampDataUpdateCoordinator[Any] coordinator, timedelta|None forecast_valid_time)
 
None _async_subscription_ended (self, Literal["daily", "hourly", "twice_daily"] forecast_type)
 
None _async_subscription_started (self, Literal["daily", "hourly", "twice_daily"] forecast_type)
 
None _handle_daily_forecast_coordinator_update (self)
 
None _handle_forecast_update (self, Literal["daily", "hourly", "twice_daily"] forecast_type)
 
None _handle_hourly_forecast_coordinator_update (self)
 
None _handle_twice_daily_forecast_coordinator_update (self)
 
None _remove_forecast_listener (self, Literal["daily", "hourly", "twice_daily"] forecast_type)
 

Additional Inherited Members

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

Detailed Description

A class for weather entities using DataUpdateCoordinators.

Definition at line 1024 of file __init__.py.

Constructor & Destructor Documentation

◆ __init__()

None homeassistant.components.weather.CoordinatorWeatherEntity.__init__ (   self,
_ObservationUpdateCoordinatorT  observation_coordinator,
*Any   context = None,
_DailyForecastUpdateCoordinatorT | None   daily_coordinator = None,
_HourlyForecastUpdateCoordinatorT | None   hourly_coordinator = None,
_TwiceDailyForecastUpdateCoordinatorT | None   twice_daily_coordinator = None,
timedelta | None   daily_forecast_valid = None,
timedelta | None   hourly_forecast_valid = None,
timedelta | None   twice_daily_forecast_valid = None 
)
Initialize.

Definition at line 1036 of file __init__.py.

Member Function Documentation

◆ _async_forecast()

list[Forecast] | None homeassistant.components.weather.CoordinatorWeatherEntity._async_forecast (   self,
Literal["daily", "hourly", "twice_daily"]   forecast_type 
)
private
Return the forecast in native units.

Definition at line 1166 of file __init__.py.

◆ _async_forecast_daily()

◆ _async_forecast_hourly()

◆ _async_forecast_twice_daily()

list[Forecast] | None homeassistant.components.weather.CoordinatorWeatherEntity._async_forecast_twice_daily (   self)
private
Return the twice daily forecast in native units.

Reimplemented in homeassistant.components.nws.weather.NWSWeather.

Definition at line 1161 of file __init__.py.

◆ _async_refresh_forecast()

bool homeassistant.components.weather.CoordinatorWeatherEntity._async_refresh_forecast (   self,
TimestampDataUpdateCoordinator[Any]  coordinator,
timedelta | None  forecast_valid_time 
)
private
Refresh stale forecast if needed.

Definition at line 1128 of file __init__.py.

◆ _async_subscription_ended()

None homeassistant.components.weather.CoordinatorWeatherEntity._async_subscription_ended (   self,
Literal["daily", "hourly", "twice_daily"]  forecast_type 
)
private
End subscription to forecast_type.

Reimplemented from homeassistant.components.weather.WeatherEntity.

Definition at line 1120 of file __init__.py.

◆ _async_subscription_started()

None homeassistant.components.weather.CoordinatorWeatherEntity._async_subscription_started (   self,
Literal["daily", "hourly", "twice_daily"]  forecast_type 
)
private
Start subscription to forecast_type.

Reimplemented from homeassistant.components.weather.WeatherEntity.

Definition at line 1082 of file __init__.py.

◆ _handle_daily_forecast_coordinator_update()

None homeassistant.components.weather.CoordinatorWeatherEntity._handle_daily_forecast_coordinator_update (   self)
private
Handle updated data from the daily forecast coordinator.

Definition at line 1094 of file __init__.py.

◆ _handle_forecast_update()

None homeassistant.components.weather.CoordinatorWeatherEntity._handle_forecast_update (   self,
Literal["daily", "hourly", "twice_daily"]   forecast_type 
)
private
Update forecast data.

Definition at line 1107 of file __init__.py.

◆ _handle_hourly_forecast_coordinator_update()

None homeassistant.components.weather.CoordinatorWeatherEntity._handle_hourly_forecast_coordinator_update (   self)
private
Handle updated data from the hourly forecast coordinator.

Definition at line 1098 of file __init__.py.

◆ _handle_twice_daily_forecast_coordinator_update()

None homeassistant.components.weather.CoordinatorWeatherEntity._handle_twice_daily_forecast_coordinator_update (   self)
private
Handle updated data from the twice daily forecast coordinator.

Definition at line 1102 of file __init__.py.

◆ _remove_forecast_listener()

None homeassistant.components.weather.CoordinatorWeatherEntity._remove_forecast_listener (   self,
Literal["daily", "hourly", "twice_daily"]   forecast_type 
)
private
Remove weather forecast listener.

Definition at line 1073 of file __init__.py.

◆ async_added_to_hass()

None homeassistant.components.weather.CoordinatorWeatherEntity.async_added_to_hass (   self)
When entity is added to hass.

Reimplemented from homeassistant.helpers.entity.Entity.

Reimplemented in homeassistant.components.nws.weather.NWSWeather.

Definition at line 1066 of file __init__.py.

◆ async_forecast_daily()

list[Forecast] | None homeassistant.components.weather.CoordinatorWeatherEntity.async_forecast_daily (   self)
Return the daily forecast in native units.

Reimplemented from homeassistant.components.weather.WeatherEntity.

Definition at line 1180 of file __init__.py.

◆ async_forecast_hourly()

list[Forecast] | None homeassistant.components.weather.CoordinatorWeatherEntity.async_forecast_hourly (   self)
Return the hourly forecast in native units.

Reimplemented from homeassistant.components.weather.WeatherEntity.

Definition at line 1185 of file __init__.py.

◆ async_forecast_twice_daily()

list[Forecast] | None homeassistant.components.weather.CoordinatorWeatherEntity.async_forecast_twice_daily (   self)
Return the twice daily forecast in native units.

Reimplemented from homeassistant.components.weather.WeatherEntity.

Definition at line 1190 of file __init__.py.

Member Data Documentation

◆ forecast_coordinators

homeassistant.components.weather.CoordinatorWeatherEntity.forecast_coordinators

Definition at line 1050 of file __init__.py.

◆ forecast_valid

homeassistant.components.weather.CoordinatorWeatherEntity.forecast_valid

Definition at line 1055 of file __init__.py.


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