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

Public Member Functions

None __init__ (self, IPMA_API api, Location location, ConfigEntry config_entry)
 
list[Forecastasync_forecast_daily (self)
 
list[Forecastasync_forecast_hourly (self)
 
None async_update (self)
 
def condition (self)
 
def humidity (self)
 
def native_pressure (self)
 
def native_temperature (self)
 
def native_wind_speed (self)
 
def wind_bearing (self)
 
- Public Member Functions inherited from homeassistant.components.weather.WeatherEntity
None __post_init__ (self, *Any args, **Any kwargs)
 
list[Forecast]|None async_forecast_twice_daily (self)
 
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)
 
float|None native_visibility (self)
 
str|None native_visibility_unit (self)
 
float|None native_wind_gust_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)
 
- 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_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.components.ipma.entity.IPMADevice
None __init__ (self, IPMA_API api, Location location)
 

Private Member Functions

def _condition_conversion (self, identifier, forecast_dt)
 
list[Forecast_forecast (self, list[IPMAForecast]|None forecast)
 
None _try_update_forecast (self, Literal["daily", "hourly"] forecast_type, int period)
 
None _update_forecast (self, Literal["daily", "hourly"] forecast_type, int period, bool update_listeners)
 

Private Attributes

 _attr_unique_id
 
 _daily_forecast
 
 _mode
 
 _observation
 
 _period
 

Static Private Attributes

 _attr_attribution = ATTRIBUTION
 
 _attr_name = None
 
 _attr_native_pressure_unit = UnitOfPressure.HPA
 
 _attr_native_temperature_unit = UnitOfTemperature.CELSIUS
 
 _attr_native_wind_speed_unit = UnitOfSpeed.KILOMETERS_PER_HOUR
 
tuple _attr_supported_features
 

Additional Inherited Members

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

Detailed Description

Representation of a weather condition.

Definition at line 62 of file weather.py.

Constructor & Destructor Documentation

◆ __init__()

None homeassistant.components.ipma.weather.IPMAWeather.__init__ (   self,
IPMA_API  api,
Location  location,
ConfigEntry   config_entry 
)
Initialise the platform with a data instance and station name.

Definition at line 74 of file weather.py.

Member Function Documentation

◆ _condition_conversion()

def homeassistant.components.ipma.weather.IPMAWeather._condition_conversion (   self,
  identifier,
  forecast_dt 
)
private
Convert from IPMA weather_type id to HA.

Definition at line 131 of file weather.py.

◆ _forecast()

list[Forecast] homeassistant.components.ipma.weather.IPMAWeather._forecast (   self,
list[IPMAForecast] | None  forecast 
)
private
Return the forecast array.

Definition at line 188 of file weather.py.

◆ _try_update_forecast()

None homeassistant.components.ipma.weather.IPMAWeather._try_update_forecast (   self,
Literal["daily", "hourly"]  forecast_type,
int  period 
)
private
Try to update weather forecast.

Definition at line 208 of file weather.py.

◆ _update_forecast()

None homeassistant.components.ipma.weather.IPMAWeather._update_forecast (   self,
Literal["daily", "hourly"]  forecast_type,
int  period,
bool  update_listeners 
)
private
Update weather forecast.

Definition at line 116 of file weather.py.

◆ async_forecast_daily()

list[Forecast] homeassistant.components.ipma.weather.IPMAWeather.async_forecast_daily (   self)
Return the daily forecast in native units.

Reimplemented from homeassistant.components.weather.WeatherEntity.

Definition at line 218 of file weather.py.

◆ async_forecast_hourly()

list[Forecast] homeassistant.components.ipma.weather.IPMAWeather.async_forecast_hourly (   self)
Return the hourly forecast in native units.

Reimplemented from homeassistant.components.weather.WeatherEntity.

Definition at line 223 of file weather.py.

◆ async_update()

None homeassistant.components.ipma.weather.IPMAWeather.async_update (   self)
Update Condition and Forecast.

Definition at line 92 of file weather.py.

◆ condition()

def homeassistant.components.ipma.weather.IPMAWeather.condition (   self)
Return the current condition which is only available on the hourly forecast data.

Reimplemented from homeassistant.components.weather.WeatherEntity.

Definition at line 139 of file weather.py.

◆ humidity()

def homeassistant.components.ipma.weather.IPMAWeather.humidity (   self)
Return the name of the sensor.

Reimplemented from homeassistant.components.weather.WeatherEntity.

Definition at line 165 of file weather.py.

◆ native_pressure()

def homeassistant.components.ipma.weather.IPMAWeather.native_pressure (   self)
Return the current pressure.

Reimplemented from homeassistant.components.weather.WeatherEntity.

Definition at line 157 of file weather.py.

◆ native_temperature()

def homeassistant.components.ipma.weather.IPMAWeather.native_temperature (   self)
Return the current temperature.

Reimplemented from homeassistant.components.weather.WeatherEntity.

Definition at line 149 of file weather.py.

◆ native_wind_speed()

def homeassistant.components.ipma.weather.IPMAWeather.native_wind_speed (   self)
Return the current windspeed.

Reimplemented from homeassistant.components.weather.WeatherEntity.

Definition at line 173 of file weather.py.

◆ wind_bearing()

def homeassistant.components.ipma.weather.IPMAWeather.wind_bearing (   self)
Return the current wind bearing (degrees).

Reimplemented from homeassistant.components.weather.WeatherEntity.

Definition at line 181 of file weather.py.

Member Data Documentation

◆ _attr_attribution

homeassistant.components.ipma.weather.IPMAWeather._attr_attribution = ATTRIBUTION
staticprivate

Definition at line 65 of file weather.py.

◆ _attr_name

homeassistant.components.ipma.weather.IPMAWeather._attr_name = None
staticprivate

Definition at line 66 of file weather.py.

◆ _attr_native_pressure_unit

homeassistant.components.ipma.weather.IPMAWeather._attr_native_pressure_unit = UnitOfPressure.HPA
staticprivate

Definition at line 67 of file weather.py.

◆ _attr_native_temperature_unit

homeassistant.components.ipma.weather.IPMAWeather._attr_native_temperature_unit = UnitOfTemperature.CELSIUS
staticprivate

Definition at line 68 of file weather.py.

◆ _attr_native_wind_speed_unit

homeassistant.components.ipma.weather.IPMAWeather._attr_native_wind_speed_unit = UnitOfSpeed.KILOMETERS_PER_HOUR
staticprivate

Definition at line 69 of file weather.py.

◆ _attr_supported_features

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

Definition at line 70 of file weather.py.

◆ _attr_unique_id

homeassistant.components.ipma.weather.IPMAWeather._attr_unique_id
private

Definition at line 85 of file weather.py.

◆ _daily_forecast

homeassistant.components.ipma.weather.IPMAWeather._daily_forecast
private

Definition at line 105 of file weather.py.

◆ _mode

homeassistant.components.ipma.weather.IPMAWeather._mode
private

Definition at line 79 of file weather.py.

◆ _observation

homeassistant.components.ipma.weather.IPMAWeather._observation
private

Definition at line 81 of file weather.py.

◆ _period

homeassistant.components.ipma.weather.IPMAWeather._period
private

Definition at line 80 of file weather.py.


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