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

Public Member Functions

None __init__ (self, ConfigEntry config_entry, TomorrowioDataUpdateCoordinator coordinator, int api_version, str forecast_type)
 
def condition (self)
 
def humidity (self)
 
def native_pressure (self)
 
def native_temperature (self)
 
def native_visibility (self)
 
def native_wind_speed (self)
 
def ozone (self)
 
def wind_bearing (self)
 
- Public Member Functions inherited from homeassistant.components.tomorrowio.entity.TomorrowioEntity
None __init__ (self, ConfigEntry config_entry, TomorrowioDataUpdateCoordinator coordinator, int api_version)
 
- 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.tomorrowio.coordinator.TomorrowioDataUpdateCoordinator
None __init__ (self, HomeAssistant hass, TomorrowioV4 api)
 
None add_entry_to_location_dict (self, ConfigEntry entry)
 
None async_setup_entry (self, ConfigEntry entry)
 
bool|None async_unload_entry (self, ConfigEntry entry)
 
- Public Member Functions inherited from homeassistant.helpers.update_coordinator.DataUpdateCoordinator
None __init__ (self, HomeAssistant hass, logging.Logger logger, *config_entries.ConfigEntry|None|UndefinedType config_entry=UNDEFINED, str name, timedelta|None update_interval=None, Callable[[], Awaitable[_DataT]]|None update_method=None, Callable[[], Awaitable[None]]|None setup_method=None, Debouncer[Coroutine[Any, Any, None]]|None request_refresh_debouncer=None, bool always_update=True)
 
Callable[[], None] async_add_listener (self, CALLBACK_TYPE update_callback, Any context=None)
 
None async_config_entry_first_refresh (self)
 
Generator[Any] async_contexts (self)
 
None async_refresh (self)
 
None async_register_shutdown (self)
 
None async_request_refresh (self)
 
None async_set_update_error (self, Exception err)
 
None async_set_updated_data (self, _DataT data)
 
None async_shutdown (self)
 
None async_update_listeners (self)
 
timedelta|None update_interval (self)
 
None update_interval (self, timedelta|None value)
 
- Public Member Functions inherited from homeassistant.components.weather.SingleCoordinatorWeatherEntity
None __init__ (self, _ObservationUpdateCoordinatorT coordinator, Any context=None)
 
- Public Member Functions inherited from homeassistant.components.weather.CoordinatorWeatherEntity
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.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)
 
float|None native_apparent_temperature (self)
 
float|None native_dew_point (self)
 
str|None native_precipitation_unit (self)
 
str|None native_pressure_unit (self)
 
str|None native_temperature_unit (self)
 
str|None native_visibility_unit (self)
 
float|None native_wind_gust_speed (self)
 
str|None native_wind_speed_unit (self)
 
float precision (self)
 
str|None state (self)
 
dict[str, Any] state_attributes (self)
 
float|None uv_index (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_type
 
- Public Attributes inherited from homeassistant.components.tomorrowio.entity.TomorrowioEntity
 api_version
 
- Public Attributes inherited from homeassistant.components.tomorrowio.coordinator.TomorrowioDataUpdateCoordinator
 data
 
 update_interval
 
- Public Attributes inherited from homeassistant.helpers.update_coordinator.DataUpdateCoordinator
 always_update
 
 config_entry
 
 data
 
 hass
 
 last_exception
 
 last_update_success
 
 logger
 
 name
 
 setup_method
 
 update_interval
 
 update_method
 
- Public Attributes inherited from homeassistant.components.weather.CoordinatorWeatherEntity
 forecast_coordinators
 
 forecast_valid
 
- Public Attributes inherited from homeassistant.helpers.entity.Entity
 device_entry
 
 entity_id
 
 hass
 
 parallel_updates
 
 platform
 
 registry_entry
 
- Public Attributes inherited from homeassistant.helpers.update_coordinator.TimestampDataUpdateCoordinator
 last_update_success_time
 

Private Member Functions

list[Forecast]|None _async_forecast_daily (self)
 
list[Forecast]|None _async_forecast_hourly (self)
 
list[Forecast]|None _forecast (self, str forecast_type)
 
Forecast _forecast_dict (self, datetime forecast_dt, bool use_datetime, int condition, float|None precipitation, int|None precipitation_probability, float|None temp, float|None temp_low, float|None humidity, float|None dew_point, float|None wind_direction, float|None wind_speed)
 

Static Private Member Functions

str|None _translate_condition (int|None condition, bool sun_is_up=True)
 

Private Attributes

 _attr_entity_registry_enabled_default
 
 _attr_name
 
 _attr_unique_id
 

Static Private Attributes

 _attr_native_precipitation_unit = UnitOfPrecipitationDepth.MILLIMETERS
 
 _attr_native_pressure_unit = UnitOfPressure.HPA
 
 _attr_native_temperature_unit = UnitOfTemperature.CELSIUS
 
 _attr_native_visibility_unit = UnitOfLength.KILOMETERS
 
 _attr_native_wind_speed_unit = UnitOfSpeed.METERS_PER_SECOND
 
tuple _attr_supported_features
 

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
 
- Static Public Attributes inherited from homeassistant.helpers.update_coordinator.TimestampDataUpdateCoordinator
 None
 

Detailed Description

Entity that talks to Tomorrow.io v4 API to retrieve weather data.

Definition at line 97 of file weather.py.

Constructor & Destructor Documentation

◆ __init__()

None homeassistant.components.tomorrowio.weather.TomorrowioWeatherEntity.__init__ (   self,
ConfigEntry  config_entry,
TomorrowioDataUpdateCoordinator  coordinator,
int  api_version,
str  forecast_type 
)
Initialize Tomorrow.io Weather Entity.

Definition at line 109 of file weather.py.

Member Function Documentation

◆ _async_forecast_daily()

list[Forecast] | None homeassistant.components.tomorrowio.weather.TomorrowioWeatherEntity._async_forecast_daily (   self)
private
Return the daily forecast in native units.

Reimplemented from homeassistant.components.weather.CoordinatorWeatherEntity.

Definition at line 303 of file weather.py.

◆ _async_forecast_hourly()

list[Forecast] | None homeassistant.components.tomorrowio.weather.TomorrowioWeatherEntity._async_forecast_hourly (   self)
private
Return the hourly forecast in native units.

Reimplemented from homeassistant.components.weather.CoordinatorWeatherEntity.

Definition at line 308 of file weather.py.

◆ _forecast()

list[Forecast] | None homeassistant.components.tomorrowio.weather.TomorrowioWeatherEntity._forecast (   self,
str  forecast_type 
)
private
Return the forecast.

Definition at line 220 of file weather.py.

◆ _forecast_dict()

Forecast homeassistant.components.tomorrowio.weather.TomorrowioWeatherEntity._forecast_dict (   self,
datetime  forecast_dt,
bool  use_datetime,
int  condition,
float | None  precipitation,
int | None  precipitation_probability,
float | None  temp,
float | None  temp_low,
float | None  humidity,
float | None  dew_point,
float | None  wind_direction,
float | None  wind_speed 
)
private
Return formatted Forecast dict from Tomorrow.io forecast data.

Definition at line 127 of file weather.py.

◆ _translate_condition()

str | None homeassistant.components.tomorrowio.weather.TomorrowioWeatherEntity._translate_condition ( int | None  condition,
bool   sun_is_up = True 
)
staticprivate
Translate Tomorrow.io condition into an HA condition.

Definition at line 163 of file weather.py.

◆ condition()

def homeassistant.components.tomorrowio.weather.TomorrowioWeatherEntity.condition (   self)
Return the condition.

Reimplemented from homeassistant.components.weather.WeatherEntity.

Definition at line 208 of file weather.py.

◆ humidity()

def homeassistant.components.tomorrowio.weather.TomorrowioWeatherEntity.humidity (   self)
Return the humidity.

Reimplemented from homeassistant.components.weather.WeatherEntity.

Definition at line 188 of file weather.py.

◆ native_pressure()

def homeassistant.components.tomorrowio.weather.TomorrowioWeatherEntity.native_pressure (   self)
Return the raw pressure.

Reimplemented from homeassistant.components.weather.WeatherEntity.

Definition at line 183 of file weather.py.

◆ native_temperature()

def homeassistant.components.tomorrowio.weather.TomorrowioWeatherEntity.native_temperature (   self)
Return the platform temperature.

Reimplemented from homeassistant.components.weather.WeatherEntity.

Definition at line 178 of file weather.py.

◆ native_visibility()

def homeassistant.components.tomorrowio.weather.TomorrowioWeatherEntity.native_visibility (   self)
Return the raw visibility.

Reimplemented from homeassistant.components.weather.WeatherEntity.

Definition at line 216 of file weather.py.

◆ native_wind_speed()

def homeassistant.components.tomorrowio.weather.TomorrowioWeatherEntity.native_wind_speed (   self)
Return the raw wind speed.

Reimplemented from homeassistant.components.weather.WeatherEntity.

Definition at line 193 of file weather.py.

◆ ozone()

def homeassistant.components.tomorrowio.weather.TomorrowioWeatherEntity.ozone (   self)
Return the O3 (ozone) level.

Reimplemented from homeassistant.components.weather.WeatherEntity.

Definition at line 203 of file weather.py.

◆ wind_bearing()

def homeassistant.components.tomorrowio.weather.TomorrowioWeatherEntity.wind_bearing (   self)
Return the wind bearing.

Reimplemented from homeassistant.components.weather.WeatherEntity.

Definition at line 198 of file weather.py.

Member Data Documentation

◆ _attr_entity_registry_enabled_default

homeassistant.components.tomorrowio.weather.TomorrowioWeatherEntity._attr_entity_registry_enabled_default
private

Definition at line 119 of file weather.py.

◆ _attr_name

homeassistant.components.tomorrowio.weather.TomorrowioWeatherEntity._attr_name
private

Definition at line 122 of file weather.py.

◆ _attr_native_precipitation_unit

homeassistant.components.tomorrowio.weather.TomorrowioWeatherEntity._attr_native_precipitation_unit = UnitOfPrecipitationDepth.MILLIMETERS
staticprivate

Definition at line 100 of file weather.py.

◆ _attr_native_pressure_unit

homeassistant.components.tomorrowio.weather.TomorrowioWeatherEntity._attr_native_pressure_unit = UnitOfPressure.HPA
staticprivate

Definition at line 101 of file weather.py.

◆ _attr_native_temperature_unit

homeassistant.components.tomorrowio.weather.TomorrowioWeatherEntity._attr_native_temperature_unit = UnitOfTemperature.CELSIUS
staticprivate

Definition at line 102 of file weather.py.

◆ _attr_native_visibility_unit

homeassistant.components.tomorrowio.weather.TomorrowioWeatherEntity._attr_native_visibility_unit = UnitOfLength.KILOMETERS
staticprivate

Definition at line 103 of file weather.py.

◆ _attr_native_wind_speed_unit

homeassistant.components.tomorrowio.weather.TomorrowioWeatherEntity._attr_native_wind_speed_unit = UnitOfSpeed.METERS_PER_SECOND
staticprivate

Definition at line 104 of file weather.py.

◆ _attr_supported_features

tuple homeassistant.components.tomorrowio.weather.TomorrowioWeatherEntity._attr_supported_features
staticprivate
Initial value:
= (
WeatherEntityFeature.FORECAST_DAILY | WeatherEntityFeature.FORECAST_HOURLY
)

Definition at line 105 of file weather.py.

◆ _attr_unique_id

homeassistant.components.tomorrowio.weather.TomorrowioWeatherEntity._attr_unique_id
private

Definition at line 123 of file weather.py.

◆ forecast_type

homeassistant.components.tomorrowio.weather.TomorrowioWeatherEntity.forecast_type

Definition at line 118 of file weather.py.


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