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

Public Member Functions

None __init__ (self, GeonetnzQuakesFeedEntityManager feed_manager, str integration_id, str external_id)
 
None async_added_to_hass (self)
 
None async_update (self)
 
None async_will_remove_from_hass (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_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, GeonetnzQuakesFeedEntry feed_entry)
 

Private Attributes

 _attr_attribution
 
 _attr_distance
 
 _attr_latitude
 
 _attr_longitude
 
 _attr_name
 
 _attr_unique_id
 
 _attr_unit_of_measurement
 
 _depth
 
 _external_id
 
 _feed_manager
 
 _locality
 
 _magnitude
 
 _mmi
 
 _quality
 
 _remove_signal_delete
 
 _remove_signal_update
 
 _time
 

Static Private Attributes

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

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 GeoNet NZ Quakes feed data.

Definition at line 68 of file geo_location.py.

Constructor & Destructor Documentation

◆ __init__()

None homeassistant.components.geonetnz_quakes.geo_location.GeonetnzQuakesEvent.__init__ (   self,
GeonetnzQuakesFeedEntityManager  feed_manager,
str  integration_id,
str  external_id 
)
Initialize entity with data from feed entry.

Definition at line 75 of file geo_location.py.

Member Function Documentation

◆ _delete_callback()

None homeassistant.components.geonetnz_quakes.geo_location.GeonetnzQuakesEvent._delete_callback (   self)
private
Remove this entity.

Definition at line 120 of file geo_location.py.

◆ _update_callback()

None homeassistant.components.geonetnz_quakes.geo_location.GeonetnzQuakesEvent._update_callback (   self)
private
Call update method.

Definition at line 125 of file geo_location.py.

◆ _update_from_feed()

None homeassistant.components.geonetnz_quakes.geo_location.GeonetnzQuakesEvent._update_from_feed (   self,
GeonetnzQuakesFeedEntry  feed_entry 
)
private
Update the internal state from the provided feed entry.

Definition at line 136 of file geo_location.py.

◆ async_added_to_hass()

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

Reimplemented from homeassistant.helpers.entity.Entity.

Definition at line 95 of file geo_location.py.

◆ async_update()

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

Definition at line 129 of file geo_location.py.

◆ async_will_remove_from_hass()

None homeassistant.components.geonetnz_quakes.geo_location.GeonetnzQuakesEvent.async_will_remove_from_hass (   self)
Call when entity will be removed from hass.

Reimplemented from homeassistant.helpers.entity.Entity.

Definition at line 110 of file geo_location.py.

◆ extra_state_attributes()

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

Reimplemented from homeassistant.helpers.entity.Entity.

Definition at line 157 of file geo_location.py.

Member Data Documentation

◆ _attr_attribution

homeassistant.components.geonetnz_quakes.geo_location.GeonetnzQuakesEvent._attr_attribution
private

Definition at line 148 of file geo_location.py.

◆ _attr_distance

homeassistant.components.geonetnz_quakes.geo_location.GeonetnzQuakesEvent._attr_distance
private

Definition at line 141 of file geo_location.py.

◆ _attr_icon

string homeassistant.components.geonetnz_quakes.geo_location.GeonetnzQuakesEvent._attr_icon = "mdi:pulse"
staticprivate

Definition at line 71 of file geo_location.py.

◆ _attr_latitude

homeassistant.components.geonetnz_quakes.geo_location.GeonetnzQuakesEvent._attr_latitude
private

Definition at line 146 of file geo_location.py.

◆ _attr_longitude

homeassistant.components.geonetnz_quakes.geo_location.GeonetnzQuakesEvent._attr_longitude
private

Definition at line 147 of file geo_location.py.

◆ _attr_name

homeassistant.components.geonetnz_quakes.geo_location.GeonetnzQuakesEvent._attr_name
private

Definition at line 138 of file geo_location.py.

◆ _attr_should_poll

bool homeassistant.components.geonetnz_quakes.geo_location.GeonetnzQuakesEvent._attr_should_poll = False
staticprivate

Definition at line 72 of file geo_location.py.

◆ _attr_source

homeassistant.components.geonetnz_quakes.geo_location.GeonetnzQuakesEvent._attr_source = SOURCE
staticprivate

Definition at line 73 of file geo_location.py.

◆ _attr_unique_id

homeassistant.components.geonetnz_quakes.geo_location.GeonetnzQuakesEvent._attr_unique_id
private

Definition at line 84 of file geo_location.py.

◆ _attr_unit_of_measurement

homeassistant.components.geonetnz_quakes.geo_location.GeonetnzQuakesEvent._attr_unit_of_measurement
private

Definition at line 85 of file geo_location.py.

◆ _depth

homeassistant.components.geonetnz_quakes.geo_location.GeonetnzQuakesEvent._depth
private

Definition at line 86 of file geo_location.py.

◆ _external_id

homeassistant.components.geonetnz_quakes.geo_location.GeonetnzQuakesEvent._external_id
private

Definition at line 83 of file geo_location.py.

◆ _feed_manager

homeassistant.components.geonetnz_quakes.geo_location.GeonetnzQuakesEvent._feed_manager
private

Definition at line 82 of file geo_location.py.

◆ _locality

homeassistant.components.geonetnz_quakes.geo_location.GeonetnzQuakesEvent._locality
private

Definition at line 87 of file geo_location.py.

◆ _magnitude

homeassistant.components.geonetnz_quakes.geo_location.GeonetnzQuakesEvent._magnitude
private

Definition at line 88 of file geo_location.py.

◆ _mmi

homeassistant.components.geonetnz_quakes.geo_location.GeonetnzQuakesEvent._mmi
private

Definition at line 89 of file geo_location.py.

◆ _quality

homeassistant.components.geonetnz_quakes.geo_location.GeonetnzQuakesEvent._quality
private

Definition at line 90 of file geo_location.py.

◆ _remove_signal_delete

homeassistant.components.geonetnz_quakes.geo_location.GeonetnzQuakesEvent._remove_signal_delete
private

Definition at line 99 of file geo_location.py.

◆ _remove_signal_update

homeassistant.components.geonetnz_quakes.geo_location.GeonetnzQuakesEvent._remove_signal_update
private

Definition at line 104 of file geo_location.py.

◆ _time

homeassistant.components.geonetnz_quakes.geo_location.GeonetnzQuakesEvent._time
private

Definition at line 91 of file geo_location.py.


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