Home Assistant Unofficial Reference 2024.12.1
homeassistant.components.usgs_earthquakes_feed.geo_location.UsgsEarthquakesEvent Class Reference
Inheritance diagram for homeassistant.components.usgs_earthquakes_feed.geo_location.UsgsEarthquakesEvent:
[legend]
Collaboration diagram for homeassistant.components.usgs_earthquakes_feed.geo_location.UsgsEarthquakesEvent:
[legend]

Public Member Functions

None __init__ (self, UsgsEarthquakesFeedEntityManager feed_manager, str external_id)
 
None async_added_to_hass (self)
 
None async_update (self)
 
dict[str, Any] extra_state_attributes (self)
 
- Public Member Functions inherited from homeassistant.components.geo_location.GeolocationEvent
float|None distance (self)
 
float|None latitude (self)
 
float|None longitude (self)
 
str source (self)
 
float|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_added_to_hass (self)
 
None async_internal_will_remove_from_hass (self)
 
None async_on_remove (self, CALLBACK_TYPE func)
 
None async_registry_entry_updated (self)
 
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)
 
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)
 

Private Member Functions

None _delete_callback (self)
 
None _update_callback (self)
 
None _update_from_feed (self, UsgsEarthquakeHazardsProgramFeedEntry feed_entry)
 

Private Attributes

 _alert
 
 _attr_attribution
 
 _attr_distance
 
 _attr_latitude
 
 _attr_longitude
 
 _attr_name
 
 _external_id
 
 _feed_manager
 
 _magnitude
 
 _place
 
 _remove_signal_delete
 
 _remove_signal_update
 
 _status
 
 _time
 
 _type
 
 _updated
 

Static Private Attributes

string _attr_icon = "mdi:pulse"
 
bool _attr_should_poll = False
 
 _attr_source = SOURCE
 
 _attr_unit_of_measurement = DEFAULT_UNIT_OF_MEASUREMENT
 

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

Detailed Description

Represents an external event with USGS Earthquake data.

Definition at line 203 of file geo_location.py.

Constructor & Destructor Documentation

◆ __init__()

None homeassistant.components.usgs_earthquakes_feed.geo_location.UsgsEarthquakesEvent.__init__ (   self,
UsgsEarthquakesFeedEntityManager  feed_manager,
str   external_id 
)
Initialize entity with data from feed entry.

Definition at line 211 of file geo_location.py.

Member Function Documentation

◆ _delete_callback()

None homeassistant.components.usgs_earthquakes_feed.geo_location.UsgsEarthquakesEvent._delete_callback (   self)
private
Remove this entity.

Definition at line 241 of file geo_location.py.

◆ _update_callback()

None homeassistant.components.usgs_earthquakes_feed.geo_location.UsgsEarthquakesEvent._update_callback (   self)
private
Call update method.

Definition at line 248 of file geo_location.py.

◆ _update_from_feed()

None homeassistant.components.usgs_earthquakes_feed.geo_location.UsgsEarthquakesEvent._update_from_feed (   self,
UsgsEarthquakeHazardsProgramFeedEntry   feed_entry 
)
private
Update the internal state from the provided feed entry.

Definition at line 259 of file geo_location.py.

◆ async_added_to_hass()

None homeassistant.components.usgs_earthquakes_feed.geo_location.UsgsEarthquakesEvent.async_added_to_hass (   self)
Call when entity is added to hass.

Reimplemented from homeassistant.helpers.entity.Entity.

Definition at line 227 of file geo_location.py.

◆ async_update()

None homeassistant.components.usgs_earthquakes_feed.geo_location.UsgsEarthquakesEvent.async_update (   self)
Update this entity from the data held in the feed manager.

Definition at line 252 of file geo_location.py.

◆ extra_state_attributes()

dict[str, Any] homeassistant.components.usgs_earthquakes_feed.geo_location.UsgsEarthquakesEvent.extra_state_attributes (   self)
Return the device state attributes.

Reimplemented from homeassistant.helpers.entity.Entity.

Definition at line 277 of file geo_location.py.

Member Data Documentation

◆ _alert

homeassistant.components.usgs_earthquakes_feed.geo_location.UsgsEarthquakesEvent._alert
private

Definition at line 223 of file geo_location.py.

◆ _attr_attribution

homeassistant.components.usgs_earthquakes_feed.geo_location.UsgsEarthquakesEvent._attr_attribution
private

Definition at line 267 of file geo_location.py.

◆ _attr_distance

homeassistant.components.usgs_earthquakes_feed.geo_location.UsgsEarthquakesEvent._attr_distance
private

Definition at line 264 of file geo_location.py.

◆ _attr_icon

string homeassistant.components.usgs_earthquakes_feed.geo_location.UsgsEarthquakesEvent._attr_icon = "mdi:pulse"
staticprivate

Definition at line 206 of file geo_location.py.

◆ _attr_latitude

homeassistant.components.usgs_earthquakes_feed.geo_location.UsgsEarthquakesEvent._attr_latitude
private

Definition at line 265 of file geo_location.py.

◆ _attr_longitude

homeassistant.components.usgs_earthquakes_feed.geo_location.UsgsEarthquakesEvent._attr_longitude
private

Definition at line 266 of file geo_location.py.

◆ _attr_name

homeassistant.components.usgs_earthquakes_feed.geo_location.UsgsEarthquakesEvent._attr_name
private

Definition at line 263 of file geo_location.py.

◆ _attr_should_poll

bool homeassistant.components.usgs_earthquakes_feed.geo_location.UsgsEarthquakesEvent._attr_should_poll = False
staticprivate

Definition at line 207 of file geo_location.py.

◆ _attr_source

homeassistant.components.usgs_earthquakes_feed.geo_location.UsgsEarthquakesEvent._attr_source = SOURCE
staticprivate

Definition at line 208 of file geo_location.py.

◆ _attr_unit_of_measurement

homeassistant.components.usgs_earthquakes_feed.geo_location.UsgsEarthquakesEvent._attr_unit_of_measurement = DEFAULT_UNIT_OF_MEASUREMENT
staticprivate

Definition at line 209 of file geo_location.py.

◆ _external_id

homeassistant.components.usgs_earthquakes_feed.geo_location.UsgsEarthquakesEvent._external_id
private

Definition at line 216 of file geo_location.py.

◆ _feed_manager

homeassistant.components.usgs_earthquakes_feed.geo_location.UsgsEarthquakesEvent._feed_manager
private

Definition at line 215 of file geo_location.py.

◆ _magnitude

homeassistant.components.usgs_earthquakes_feed.geo_location.UsgsEarthquakesEvent._magnitude
private

Definition at line 218 of file geo_location.py.

◆ _place

homeassistant.components.usgs_earthquakes_feed.geo_location.UsgsEarthquakesEvent._place
private

Definition at line 217 of file geo_location.py.

◆ _remove_signal_delete

homeassistant.components.usgs_earthquakes_feed.geo_location.UsgsEarthquakesEvent._remove_signal_delete
private

Definition at line 229 of file geo_location.py.

◆ _remove_signal_update

homeassistant.components.usgs_earthquakes_feed.geo_location.UsgsEarthquakesEvent._remove_signal_update
private

Definition at line 234 of file geo_location.py.

◆ _status

homeassistant.components.usgs_earthquakes_feed.geo_location.UsgsEarthquakesEvent._status
private

Definition at line 221 of file geo_location.py.

◆ _time

homeassistant.components.usgs_earthquakes_feed.geo_location.UsgsEarthquakesEvent._time
private

Definition at line 219 of file geo_location.py.

◆ _type

homeassistant.components.usgs_earthquakes_feed.geo_location.UsgsEarthquakesEvent._type
private

Definition at line 222 of file geo_location.py.

◆ _updated

homeassistant.components.usgs_earthquakes_feed.geo_location.UsgsEarthquakesEvent._updated
private

Definition at line 220 of file geo_location.py.


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