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

Public Member Functions

None __init__ (self, MappingProxyType[str, Any] entry_data, NWSData nws_data)
 
None async_added_to_hass (self)
 
ServiceResponse async_get_forecasts_extra_service (self, type)
 
None async_update (self)
 
str|None condition (self)
 
float|None humidity (self)
 
int|None native_pressure (self)
 
float|None native_temperature (self)
 
int|None native_visibility (self)
 
float|None native_wind_speed (self)
 
int|None wind_bearing (self)
 
- 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)
 
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)
 
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)
 
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|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 Attributes

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

Private Member Functions

list[Forecast]|None _async_forecast_hourly (self)
 
list[Forecast]|None _async_forecast_twice_daily (self)
 
list[Forecast_forecast (self, list[dict[str, Any]] nws_forecast, str mode)
 
list[ExtraForecast_forecast_extra (self, list[dict[str, Any]]|None nws_forecast, str mode)
 

Private Attributes

 _attr_device_info
 
 _attr_name
 
 _attr_unique_id
 

Static Private Attributes

 _attr_attribution = ATTRIBUTION
 
 _attr_native_pressure_unit = UnitOfPressure.PA
 
 _attr_native_temperature_unit = UnitOfTemperature.CELSIUS
 
 _attr_native_visibility_unit = UnitOfLength.METERS
 
 _attr_native_wind_speed_unit = UnitOfSpeed.KILOMETERS_PER_HOUR
 
bool _attr_should_poll = False
 
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

Representation of a weather condition.

Definition at line 134 of file weather.py.

Constructor & Destructor Documentation

◆ __init__()

None homeassistant.components.nws.weather.NWSWeather.__init__ (   self,
MappingProxyType[str, Any]  entry_data,
NWSData  nws_data 
)
Initialise the platform with a data instance and station name.

Definition at line 147 of file weather.py.

Member Function Documentation

◆ _async_forecast_hourly()

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

Reimplemented from homeassistant.components.weather.CoordinatorWeatherEntity.

Definition at line 321 of file weather.py.

◆ _async_forecast_twice_daily()

list[Forecast] | None homeassistant.components.nws.weather.NWSWeather._async_forecast_twice_daily (   self)
private
Return the twice daily forecast in native units.

Reimplemented from homeassistant.components.weather.CoordinatorWeatherEntity.

Definition at line 326 of file weather.py.

◆ _forecast()

list[Forecast] homeassistant.components.nws.weather.NWSWeather._forecast (   self,
list[dict[str, Any]]  nws_forecast,
str  mode 
)
private
Return forecast.

Definition at line 240 of file weather.py.

◆ _forecast_extra()

list[ExtraForecast] homeassistant.components.nws.weather.NWSWeather._forecast_extra (   self,
list[dict[str, Any]] | None  nws_forecast,
str  mode 
)
private
Return forecast.

Definition at line 296 of file weather.py.

◆ async_added_to_hass()

None homeassistant.components.nws.weather.NWSWeather.async_added_to_hass (   self)
When entity is added to hass.

Reimplemented from homeassistant.components.weather.CoordinatorWeatherEntity.

Definition at line 170 of file weather.py.

◆ async_get_forecasts_extra_service()

ServiceResponse homeassistant.components.nws.weather.NWSWeather.async_get_forecasts_extra_service (   self,
  type 
)
Get extra weather forecast.

Definition at line 341 of file weather.py.

◆ async_update()

None homeassistant.components.nws.weather.NWSWeather.async_update (   self)
Update the entity.

Only used by the generic entity update service.

Reimplemented from homeassistant.helpers.update_coordinator.CoordinatorEntity.

Definition at line 330 of file weather.py.

◆ condition()

str | None homeassistant.components.nws.weather.NWSWeather.condition (   self)
Return current condition.

Reimplemented from homeassistant.components.weather.WeatherEntity.

Definition at line 222 of file weather.py.

◆ humidity()

float | None homeassistant.components.nws.weather.NWSWeather.humidity (   self)
Return the name of the sensor.

Reimplemented from homeassistant.components.weather.WeatherEntity.

Definition at line 201 of file weather.py.

◆ native_pressure()

int | None homeassistant.components.nws.weather.NWSWeather.native_pressure (   self)
Return the current pressure.

Reimplemented from homeassistant.components.weather.WeatherEntity.

Definition at line 194 of file weather.py.

◆ native_temperature()

float | None homeassistant.components.nws.weather.NWSWeather.native_temperature (   self)
Return the current temperature.

Reimplemented from homeassistant.components.weather.WeatherEntity.

Definition at line 187 of file weather.py.

◆ native_visibility()

int | None homeassistant.components.nws.weather.NWSWeather.native_visibility (   self)
Return visibility.

Reimplemented from homeassistant.components.weather.WeatherEntity.

Definition at line 234 of file weather.py.

◆ native_wind_speed()

float | None homeassistant.components.nws.weather.NWSWeather.native_wind_speed (   self)
Return the current windspeed.

Reimplemented from homeassistant.components.weather.WeatherEntity.

Definition at line 208 of file weather.py.

◆ wind_bearing()

int | None homeassistant.components.nws.weather.NWSWeather.wind_bearing (   self)
Return the current wind bearing (degrees).

Reimplemented from homeassistant.components.weather.WeatherEntity.

Definition at line 215 of file weather.py.

Member Data Documentation

◆ _attr_attribution

homeassistant.components.nws.weather.NWSWeather._attr_attribution = ATTRIBUTION
staticprivate

Definition at line 137 of file weather.py.

◆ _attr_device_info

homeassistant.components.nws.weather.NWSWeather._attr_device_info
private

Definition at line 167 of file weather.py.

◆ _attr_name

homeassistant.components.nws.weather.NWSWeather._attr_name
private

Definition at line 168 of file weather.py.

◆ _attr_native_pressure_unit

homeassistant.components.nws.weather.NWSWeather._attr_native_pressure_unit = UnitOfPressure.PA
staticprivate

Definition at line 143 of file weather.py.

◆ _attr_native_temperature_unit

homeassistant.components.nws.weather.NWSWeather._attr_native_temperature_unit = UnitOfTemperature.CELSIUS
staticprivate

Definition at line 142 of file weather.py.

◆ _attr_native_visibility_unit

homeassistant.components.nws.weather.NWSWeather._attr_native_visibility_unit = UnitOfLength.METERS
staticprivate

Definition at line 145 of file weather.py.

◆ _attr_native_wind_speed_unit

homeassistant.components.nws.weather.NWSWeather._attr_native_wind_speed_unit = UnitOfSpeed.KILOMETERS_PER_HOUR
staticprivate

Definition at line 144 of file weather.py.

◆ _attr_should_poll

bool homeassistant.components.nws.weather.NWSWeather._attr_should_poll = False
staticprivate

Definition at line 138 of file weather.py.

◆ _attr_supported_features

tuple homeassistant.components.nws.weather.NWSWeather._attr_supported_features
staticprivate
Initial value:
= (
WeatherEntityFeature.FORECAST_HOURLY | WeatherEntityFeature.FORECAST_TWICE_DAILY
)

Definition at line 139 of file weather.py.

◆ _attr_unique_id

homeassistant.components.nws.weather.NWSWeather._attr_unique_id
private

Definition at line 166 of file weather.py.

◆ nws

homeassistant.components.nws.weather.NWSWeather.nws

Definition at line 160 of file weather.py.

◆ station

homeassistant.components.nws.weather.NWSWeather.station

Definition at line 164 of file weather.py.


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