homeassistant.components.weatherkit.weather.WeatherKitWeather Class Reference

Inheritance diagram for homeassistant.components.weatherkit.weather.WeatherKitWeather:

Collaboration diagram for homeassistant.components.weatherkit.weather.WeatherKitWeather:

Public Member Functions
None	__init__ (self, WeatherKitDataUpdateCoordinator coordinator)
float|None	cloud_coverage (self)
str|None	condition (self)
dict[str, Any]	current_weather (self)
dict[str, Any]	data (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_visibility (self)
float|None	native_wind_gust_speed (self)
float|None	native_wind_speed (self)
WeatherEntityFeature	supported_features (self)
float|None	uv_index (self)
float|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)
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)
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)
str|None	translation_key (self)
Mapping[str, str]	translation_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.weatherkit.coordinator.WeatherKitDataUpdateCoordinator
None	__init__ (self, HomeAssistant hass, WeatherKitApiClient client)
def	update_supported_data_sets (self)
Public Member Functions inherited from homeassistant.components.weatherkit.entity.WeatherKitEntity
None	__init__ (self, WeatherKitDataUpdateCoordinator coordinator, str|None unique_id_suffix)

Private Member Functions
list[Forecast]|None	_async_forecast_daily (self)
list[Forecast]|None	_async_forecast_hourly (self)

Static Private Attributes
	_attr_attribution = ATTRIBUTION
	_attr_name = None
	_attr_native_precipitation_unit = UnitOfLength.MILLIMETERS
	_attr_native_pressure_unit = UnitOfPressure.MBAR
	_attr_native_temperature_unit = UnitOfTemperature.CELSIUS
	_attr_native_visibility_unit = UnitOfLength.KILOMETERS
	_attr_native_wind_speed_unit = UnitOfSpeed.KILOMETERS_PER_HOUR

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
Public Attributes inherited from homeassistant.components.weatherkit.coordinator.WeatherKitDataUpdateCoordinator
	client
	supported_data_sets
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
Static Public Attributes inherited from homeassistant.components.weatherkit.coordinator.WeatherKitDataUpdateCoordinator
	None

Detailed Description

Weather entity for Apple WeatherKit integration.

Definition at line 127 of file weather.py.

Constructor & Destructor Documentation

__init__()

None homeassistant.components.weatherkit.weather.WeatherKitWeather.__init__	(		self,
		WeatherKitDataUpdateCoordinator	coordinator
	)

Initialize the platform with a coordinator.

Definition at line 142 of file weather.py.

Member Function Documentation

_async_forecast_daily()

list[Forecast] | None homeassistant.components.weatherkit.weather.WeatherKitWeather._async_forecast_daily (   self )

private

Return the daily forecast.

Reimplemented from homeassistant.components.weather.CoordinatorWeatherEntity.

Definition at line 241 of file weather.py.

_async_forecast_hourly()

list[Forecast] | None homeassistant.components.weatherkit.weather.WeatherKitWeather._async_forecast_hourly (   self )

private

Return the hourly forecast.

Reimplemented from homeassistant.components.weather.CoordinatorWeatherEntity.

Definition at line 251 of file weather.py.

cloud_coverage()

float | None homeassistant.components.weatherkit.weather.WeatherKitWeather.cloud_coverage

(

self

)

Return the current cloud_coverage.

Reimplemented from homeassistant.components.weather.WeatherEntity.

Definition at line 211 of file weather.py.

condition()

str | None homeassistant.components.weatherkit.weather.WeatherKitWeather.condition

(

self

)

Return the current condition.

Reimplemented from homeassistant.components.weather.WeatherEntity.

Definition at line 175 of file weather.py.

current_weather()

dict[str, Any] homeassistant.components.weatherkit.weather.WeatherKitWeather.current_weather

(

self

)

Return current weather data.

Definition at line 170 of file weather.py.

data()

dict[str, Any] homeassistant.components.weatherkit.weather.WeatherKitWeather.data

(

self

)

Return coordinator data.

Definition at line 165 of file weather.py.

humidity()

float | None homeassistant.components.weatherkit.weather.WeatherKitWeather.humidity

(

self

)

Return the current humidity.

Reimplemented from homeassistant.components.weather.WeatherEntity.

Definition at line 206 of file weather.py.

native_apparent_temperature()

float | None homeassistant.components.weatherkit.weather.WeatherKitWeather.native_apparent_temperature

(

self

)

Return the current apparent_temperature.

Reimplemented from homeassistant.components.weather.WeatherEntity.

Definition at line 191 of file weather.py.

native_dew_point()

float | None homeassistant.components.weatherkit.weather.WeatherKitWeather.native_dew_point

(

self

)

Return the current dew_point.

Reimplemented from homeassistant.components.weather.WeatherEntity.

Definition at line 196 of file weather.py.

native_pressure()

float | None homeassistant.components.weatherkit.weather.WeatherKitWeather.native_pressure

(

self

)

Return the current pressure.

Reimplemented from homeassistant.components.weather.WeatherEntity.

Definition at line 201 of file weather.py.

native_temperature()

float | None homeassistant.components.weatherkit.weather.WeatherKitWeather.native_temperature

(

self

)

Return the current temperature.

Reimplemented from homeassistant.components.weather.WeatherEntity.

Definition at line 186 of file weather.py.

native_visibility()

float | None homeassistant.components.weatherkit.weather.WeatherKitWeather.native_visibility

(

self

)

Return the current visibility.

Reimplemented from homeassistant.components.weather.WeatherEntity.

Definition at line 221 of file weather.py.

native_wind_gust_speed()

float | None homeassistant.components.weatherkit.weather.WeatherKitWeather.native_wind_gust_speed

(

self

)

Return the current wind_gust_speed.

Reimplemented from homeassistant.components.weather.WeatherEntity.

Definition at line 226 of file weather.py.

native_wind_speed()

float | None homeassistant.components.weatherkit.weather.WeatherKitWeather.native_wind_speed

(

self

)

Return the current wind_speed.

Reimplemented from homeassistant.components.weather.WeatherEntity.

Definition at line 231 of file weather.py.

supported_features()

WeatherEntityFeature homeassistant.components.weatherkit.weather.WeatherKitWeather.supported_features

(

self

)

Determine supported features based on available data sets reported by WeatherKit.

Reimplemented from homeassistant.helpers.entity.Entity.

Definition at line 151 of file weather.py.

uv_index()

float | None homeassistant.components.weatherkit.weather.WeatherKitWeather.uv_index

(

self

)

Return the current uv_index.

Reimplemented from homeassistant.components.weather.WeatherEntity.

Definition at line 216 of file weather.py.

wind_bearing()

float | None homeassistant.components.weatherkit.weather.WeatherKitWeather.wind_bearing

(

self

)

Return the current wind_bearing.

Reimplemented from homeassistant.components.weather.WeatherEntity.

Definition at line 236 of file weather.py.

Member Data Documentation

_attr_attribution

homeassistant.components.weatherkit.weather.WeatherKitWeather._attr_attribution = ATTRIBUTION

staticprivate

Definition at line 132 of file weather.py.

_attr_name

homeassistant.components.weatherkit.weather.WeatherKitWeather._attr_name = None

staticprivate

Definition at line 134 of file weather.py.

_attr_native_precipitation_unit

homeassistant.components.weatherkit.weather.WeatherKitWeather._attr_native_precipitation_unit = UnitOfLength.MILLIMETERS

staticprivate

Definition at line 140 of file weather.py.

_attr_native_pressure_unit

homeassistant.components.weatherkit.weather.WeatherKitWeather._attr_native_pressure_unit = UnitOfPressure.MBAR

staticprivate

Definition at line 137 of file weather.py.

_attr_native_temperature_unit

homeassistant.components.weatherkit.weather.WeatherKitWeather._attr_native_temperature_unit = UnitOfTemperature.CELSIUS

staticprivate

Definition at line 136 of file weather.py.

_attr_native_visibility_unit

homeassistant.components.weatherkit.weather.WeatherKitWeather._attr_native_visibility_unit = UnitOfLength.KILOMETERS

staticprivate

Definition at line 138 of file weather.py.

_attr_native_wind_speed_unit

homeassistant.components.weatherkit.weather.WeatherKitWeather._attr_native_wind_speed_unit = UnitOfSpeed.KILOMETERS_PER_HOUR

staticprivate

Definition at line 139 of file weather.py.

---

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

• core/homeassistant/components/weatherkit/weather.py