Home Assistant Unofficial Reference 2024.12.1
Namespaces | Classes | Functions | Variables
homeassistant.components.weather Namespace Reference

Namespaces

 const
 
 intent
 
 significant_change
 
 websocket_api
 

Classes

class  CoordinatorWeatherEntity
 
class  Forecast
 
class  PostInit
 
class  PostInitMeta
 
class  SingleCoordinatorWeatherEntity
 
class  WeatherEntity
 
class  WeatherEntityDescription
 

Functions

ServiceResponse async_get_forecasts_service (WeatherEntity weather, ServiceCall service_call)
 
bool async_setup (HomeAssistant hass, ConfigType config)
 
bool async_setup_entry (HomeAssistant hass, ConfigEntry entry)
 
bool async_unload_entry (HomeAssistant hass, ConfigEntry entry)
 
None raise_unsupported_forecast (str entity_id, str forecast_type)
 
float|None round_temperature (float|None temperature, float precision)
 

Variables

 _DailyForecastUpdateCoordinatorT
 
 _HourlyForecastUpdateCoordinatorT
 
 _ObservationUpdateCoordinatorT
 
 _TwiceDailyForecastUpdateCoordinatorT
 
 ATTR_CONDITION_CLASS
 
 ATTR_CONDITION_CLEAR_NIGHT
 
 ATTR_CONDITION_CLOUDY
 
 ATTR_CONDITION_EXCEPTIONAL
 
 ATTR_CONDITION_FOG
 
 ATTR_CONDITION_HAIL
 
 ATTR_CONDITION_LIGHTNING
 
 ATTR_CONDITION_LIGHTNING_RAINY
 
 ATTR_CONDITION_PARTLYCLOUDY
 
 ATTR_CONDITION_POURING
 
 ATTR_CONDITION_RAINY
 
 ATTR_CONDITION_SNOWY
 
 ATTR_CONDITION_SNOWY_RAINY
 
 ATTR_CONDITION_SUNNY
 
 ATTR_CONDITION_WINDY
 
 ATTR_CONDITION_WINDY_VARIANT
 
 bound = DataUpdateCoordinator[Any],
 
 CACHED_PROPERTIES_WITH_ATTR_
 
 default = DataUpdateCoordinator[dict[str, Any]],
 
 ENTITY_ID_FORMAT
 
 Final
 
 PLATFORM_SCHEMA
 
 PLATFORM_SCHEMA_BASE
 
 ROUNDING_PRECISION
 
 SCAN_INTERVAL
 
 seconds
 

Detailed Description

Weather component that handles meteorological data for your location.

Function Documentation

◆ async_get_forecasts_service()

ServiceResponse homeassistant.components.weather.async_get_forecasts_service ( WeatherEntity  weather,
ServiceCall   service_call 
) 
Get weather forecast.

Definition at line 997 of file __init__.py.

◆ async_setup()

bool homeassistant.components.weather.async_setup ( HomeAssistant  hass,
ConfigType  config 
) 
Set up the weather component.

Definition at line 199 of file __init__.py.

◆ async_setup_entry()

bool homeassistant.components.weather.async_setup_entry ( HomeAssistant  hass,
ConfigEntry  entry 
) 
Set up a config entry.

Definition at line 220 of file __init__.py.

◆ async_unload_entry()

bool homeassistant.components.weather.async_unload_entry ( HomeAssistant  hass,
ConfigEntry  entry 
) 
Unload a config entry.

Definition at line 225 of file __init__.py.

◆ raise_unsupported_forecast()

None homeassistant.components.weather.raise_unsupported_forecast ( str  entity_id,
str  forecast_type 
) 
Raise error on attempt to get an unsupported forecast.

Definition at line 990 of file __init__.py.

◆ round_temperature()

float | None homeassistant.components.weather.round_temperature ( float | None  temperature,
float  precision 
) 
Convert temperature into preferred precision for display.

Definition at line 152 of file __init__.py.

Variable Documentation

◆ _DailyForecastUpdateCoordinatorT

homeassistant.components.weather._DailyForecastUpdateCoordinatorT
private

Definition at line 133 of file __init__.py.

◆ _HourlyForecastUpdateCoordinatorT

homeassistant.components.weather._HourlyForecastUpdateCoordinatorT
private

Definition at line 138 of file __init__.py.

◆ _ObservationUpdateCoordinatorT

homeassistant.components.weather._ObservationUpdateCoordinatorT
private

Definition at line 127 of file __init__.py.

◆ _TwiceDailyForecastUpdateCoordinatorT

homeassistant.components.weather._TwiceDailyForecastUpdateCoordinatorT
private

Definition at line 143 of file __init__.py.

◆ ATTR_CONDITION_CLASS

homeassistant.components.weather.ATTR_CONDITION_CLASS

Definition at line 82 of file __init__.py.

◆ ATTR_CONDITION_CLEAR_NIGHT

homeassistant.components.weather.ATTR_CONDITION_CLEAR_NIGHT

Definition at line 83 of file __init__.py.

◆ ATTR_CONDITION_CLOUDY

homeassistant.components.weather.ATTR_CONDITION_CLOUDY

Definition at line 84 of file __init__.py.

◆ ATTR_CONDITION_EXCEPTIONAL

homeassistant.components.weather.ATTR_CONDITION_EXCEPTIONAL

Definition at line 85 of file __init__.py.

◆ ATTR_CONDITION_FOG

homeassistant.components.weather.ATTR_CONDITION_FOG

Definition at line 86 of file __init__.py.

◆ ATTR_CONDITION_HAIL

homeassistant.components.weather.ATTR_CONDITION_HAIL

Definition at line 87 of file __init__.py.

◆ ATTR_CONDITION_LIGHTNING

homeassistant.components.weather.ATTR_CONDITION_LIGHTNING

Definition at line 88 of file __init__.py.

◆ ATTR_CONDITION_LIGHTNING_RAINY

homeassistant.components.weather.ATTR_CONDITION_LIGHTNING_RAINY

Definition at line 89 of file __init__.py.

◆ ATTR_CONDITION_PARTLYCLOUDY

homeassistant.components.weather.ATTR_CONDITION_PARTLYCLOUDY

Definition at line 90 of file __init__.py.

◆ ATTR_CONDITION_POURING

homeassistant.components.weather.ATTR_CONDITION_POURING

Definition at line 91 of file __init__.py.

◆ ATTR_CONDITION_RAINY

homeassistant.components.weather.ATTR_CONDITION_RAINY

Definition at line 92 of file __init__.py.

◆ ATTR_CONDITION_SNOWY

homeassistant.components.weather.ATTR_CONDITION_SNOWY

Definition at line 93 of file __init__.py.

◆ ATTR_CONDITION_SNOWY_RAINY

homeassistant.components.weather.ATTR_CONDITION_SNOWY_RAINY

Definition at line 94 of file __init__.py.

◆ ATTR_CONDITION_SUNNY

homeassistant.components.weather.ATTR_CONDITION_SUNNY

Definition at line 95 of file __init__.py.

◆ ATTR_CONDITION_WINDY

homeassistant.components.weather.ATTR_CONDITION_WINDY

Definition at line 96 of file __init__.py.

◆ ATTR_CONDITION_WINDY_VARIANT

homeassistant.components.weather.ATTR_CONDITION_WINDY_VARIANT

Definition at line 97 of file __init__.py.

◆ bound

homeassistant.components.weather.bound = DataUpdateCoordinator[Any],

Definition at line 129 of file __init__.py.

◆ CACHED_PROPERTIES_WITH_ATTR_

homeassistant.components.weather.CACHED_PROPERTIES_WITH_ATTR_

Definition at line 252 of file __init__.py.

◆ default

homeassistant.components.weather.default = DataUpdateCoordinator[dict[str, Any]],

Definition at line 130 of file __init__.py.

◆ ENTITY_ID_FORMAT

homeassistant.components.weather.ENTITY_ID_FORMAT

Definition at line 77 of file __init__.py.

◆ Final

homeassistant.components.weather.Final

Definition at line 98 of file __init__.py.

◆ PLATFORM_SCHEMA

homeassistant.components.weather.PLATFORM_SCHEMA

Definition at line 78 of file __init__.py.

◆ PLATFORM_SCHEMA_BASE

homeassistant.components.weather.PLATFORM_SCHEMA_BASE

Definition at line 79 of file __init__.py.

◆ ROUNDING_PRECISION

homeassistant.components.weather.ROUNDING_PRECISION

Definition at line 123 of file __init__.py.

◆ SCAN_INTERVAL

homeassistant.components.weather.SCAN_INTERVAL

Definition at line 80 of file __init__.py.

◆ seconds

homeassistant.components.weather.seconds

Definition at line 80 of file __init__.py.