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

Public Member Functions

None __init__ (self, str name, str unique_id, str mode, WeatherUpdateCoordinator weather_coordinator)
 
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)
 
float|None native_pressure (self)
 
float|None native_temperature (self)
 
float|None native_wind_gust_speed (self)
 
float|None native_wind_speed (self)
 
float|str|None visibility (self)
 
float|str|None wind_bearing (self)
 
- 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.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)
 
str|None native_precipitation_unit (self)
 
str|None native_pressure_unit (self)
 
str|None native_temperature_unit (self)
 
float|None native_visibility (self)
 
str|None native_visibility_unit (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)
 
- 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 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.openweathermap.coordinator.WeatherUpdateCoordinator
None __init__ (self, OWMClient owm_client, latitude, longitude, HomeAssistant hass)
 

Private Member Functions

list[Forecast]|None _async_forecast_daily (self)
 
list[Forecast]|None _async_forecast_hourly (self)
 

Private Attributes

 _attr_device_info
 
 _attr_name
 
 _attr_supported_features
 
 _attr_unique_id
 

Static Private Attributes

 _attr_attribution = ATTRIBUTION
 
 _attr_native_precipitation_unit = UnitOfPrecipitationDepth.MILLIMETERS
 
 _attr_native_pressure_unit = UnitOfPressure.HPA
 
 _attr_native_temperature_unit = UnitOfTemperature.CELSIUS
 
 _attr_native_visibility_unit = UnitOfLength.METERS
 
 _attr_native_wind_speed_unit = UnitOfSpeed.METERS_PER_SECOND
 
bool _attr_should_poll = False
 

Additional Inherited Members

- 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
 
- 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
 
- 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

Implementation of an OpenWeatherMap sensor.

Definition at line 65 of file weather.py.

Constructor & Destructor Documentation

◆ __init__()

None homeassistant.components.openweathermap.weather.OpenWeatherMapWeather.__init__ (   self,
str  name,
str  unique_id,
str  mode,
WeatherUpdateCoordinator  weather_coordinator 
)
Initialize the sensor.

Definition at line 77 of file weather.py.

Member Function Documentation

◆ _async_forecast_daily()

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

Reimplemented from homeassistant.components.weather.CoordinatorWeatherEntity.

Definition at line 161 of file weather.py.

◆ _async_forecast_hourly()

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

Reimplemented from homeassistant.components.weather.CoordinatorWeatherEntity.

Definition at line 166 of file weather.py.

◆ cloud_coverage()

float | None homeassistant.components.openweathermap.weather.OpenWeatherMapWeather.cloud_coverage (   self)
Return the Cloud coverage in %.

Reimplemented from homeassistant.components.weather.WeatherEntity.

Definition at line 109 of file weather.py.

◆ condition()

str | None homeassistant.components.openweathermap.weather.OpenWeatherMapWeather.condition (   self)
Return the current condition.

Reimplemented from homeassistant.components.weather.WeatherEntity.

Definition at line 104 of file weather.py.

◆ humidity()

float | None homeassistant.components.openweathermap.weather.OpenWeatherMapWeather.humidity (   self)
Return the humidity.

Reimplemented from homeassistant.components.weather.WeatherEntity.

Definition at line 131 of file weather.py.

◆ native_apparent_temperature()

float | None homeassistant.components.openweathermap.weather.OpenWeatherMapWeather.native_apparent_temperature (   self)
Return the apparent temperature.

Reimplemented from homeassistant.components.weather.WeatherEntity.

Definition at line 114 of file weather.py.

◆ native_dew_point()

float | None homeassistant.components.openweathermap.weather.OpenWeatherMapWeather.native_dew_point (   self)
Return the dew point.

Reimplemented from homeassistant.components.weather.WeatherEntity.

Definition at line 136 of file weather.py.

◆ native_pressure()

float | None homeassistant.components.openweathermap.weather.OpenWeatherMapWeather.native_pressure (   self)
Return the pressure.

Reimplemented from homeassistant.components.weather.WeatherEntity.

Definition at line 126 of file weather.py.

◆ native_temperature()

float | None homeassistant.components.openweathermap.weather.OpenWeatherMapWeather.native_temperature (   self)
Return the temperature.

Reimplemented from homeassistant.components.weather.WeatherEntity.

Definition at line 121 of file weather.py.

◆ native_wind_gust_speed()

float | None homeassistant.components.openweathermap.weather.OpenWeatherMapWeather.native_wind_gust_speed (   self)
Return the wind gust speed.

Reimplemented from homeassistant.components.weather.WeatherEntity.

Definition at line 141 of file weather.py.

◆ native_wind_speed()

float | None homeassistant.components.openweathermap.weather.OpenWeatherMapWeather.native_wind_speed (   self)
Return the wind speed.

Reimplemented from homeassistant.components.weather.WeatherEntity.

Definition at line 146 of file weather.py.

◆ visibility()

float | str | None homeassistant.components.openweathermap.weather.OpenWeatherMapWeather.visibility (   self)
Return visibility.

Definition at line 156 of file weather.py.

◆ wind_bearing()

float | str | None homeassistant.components.openweathermap.weather.OpenWeatherMapWeather.wind_bearing (   self)
Return the wind bearing.

Reimplemented from homeassistant.components.weather.WeatherEntity.

Definition at line 151 of file weather.py.

Member Data Documentation

◆ _attr_attribution

homeassistant.components.openweathermap.weather.OpenWeatherMapWeather._attr_attribution = ATTRIBUTION
staticprivate

Definition at line 68 of file weather.py.

◆ _attr_device_info

homeassistant.components.openweathermap.weather.OpenWeatherMapWeather._attr_device_info
private

Definition at line 88 of file weather.py.

◆ _attr_name

homeassistant.components.openweathermap.weather.OpenWeatherMapWeather._attr_name
private

Definition at line 86 of file weather.py.

◆ _attr_native_precipitation_unit

homeassistant.components.openweathermap.weather.OpenWeatherMapWeather._attr_native_precipitation_unit = UnitOfPrecipitationDepth.MILLIMETERS
staticprivate

Definition at line 71 of file weather.py.

◆ _attr_native_pressure_unit

homeassistant.components.openweathermap.weather.OpenWeatherMapWeather._attr_native_pressure_unit = UnitOfPressure.HPA
staticprivate

Definition at line 72 of file weather.py.

◆ _attr_native_temperature_unit

homeassistant.components.openweathermap.weather.OpenWeatherMapWeather._attr_native_temperature_unit = UnitOfTemperature.CELSIUS
staticprivate

Definition at line 73 of file weather.py.

◆ _attr_native_visibility_unit

homeassistant.components.openweathermap.weather.OpenWeatherMapWeather._attr_native_visibility_unit = UnitOfLength.METERS
staticprivate

Definition at line 75 of file weather.py.

◆ _attr_native_wind_speed_unit

homeassistant.components.openweathermap.weather.OpenWeatherMapWeather._attr_native_wind_speed_unit = UnitOfSpeed.METERS_PER_SECOND
staticprivate

Definition at line 74 of file weather.py.

◆ _attr_should_poll

bool homeassistant.components.openweathermap.weather.OpenWeatherMapWeather._attr_should_poll = False
staticprivate

Definition at line 69 of file weather.py.

◆ _attr_supported_features

homeassistant.components.openweathermap.weather.OpenWeatherMapWeather._attr_supported_features
private

Definition at line 96 of file weather.py.

◆ _attr_unique_id

homeassistant.components.openweathermap.weather.OpenWeatherMapWeather._attr_unique_id
private

Definition at line 87 of file weather.py.


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