Home Assistant Unofficial Reference 2024.12.1
homeassistant.components.geonetnz_volcano.sensor.GeonetnzVolcanoSensor Class Reference
Inheritance diagram for homeassistant.components.geonetnz_volcano.sensor.GeonetnzVolcanoSensor:
[legend]
Collaboration diagram for homeassistant.components.geonetnz_volcano.sensor.GeonetnzVolcanoSensor:
[legend]

Public Member Functions

def __init__ (self, config_entry_id, feed_manager, external_id, unit_system)
 
None async_added_to_hass (self)
 
None async_update (self)
 
None async_will_remove_from_hass (self)
 
def extra_state_attributes (self)
 
def icon (self)
 
str|None name (self)
 
def native_unit_of_measurement (self)
 
def native_value (self)
 
- Public Member Functions inherited from homeassistant.components.sensor.SensorEntity
None add_to_platform_start (self, HomeAssistant hass, EntityPlatform platform, asyncio.Semaphore|None parallel_updates)
 
None async_internal_added_to_hass (self)
 
None async_registry_entry_updated (self)
 
dict[str, Any]|None capability_attributes (self)
 
SensorDeviceClass|None device_class (self)
 
er.EntityOptionsType|None get_initial_entity_options (self)
 
datetime|None last_reset (self)
 
list[str]|None options (self)
 
Any state (self)
 
dict[str, Any]|None state_attributes (self)
 
SensorStateClass|str|None state_class (self)
 
int|None suggested_display_precision (self)
 
str|None suggested_unit_of_measurement (self)
 
str|None unit_of_measurement (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)
 
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_write_ha_state (self)
 
str|None attribution (self)
 
bool available (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)
 
bool has_entity_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)
 
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

def _update_callback (self)
 
def _update_from_feed (self, feed_entry, last_update, last_update_successful)
 

Private Attributes

 _activity
 
 _alert_level
 
 _attr_attribution
 
 _attr_unique_id
 
 _attribution
 
 _config_entry_id
 
 _distance
 
 _external_id
 
 _feed_last_update
 
 _feed_last_update_successful
 
 _feed_manager
 
 _hazards
 
 _latitude
 
 _longitude
 
 _remove_signal_update
 
 _title
 
 _unit_system
 

Static Private Attributes

bool _attr_should_poll = False
 

Additional Inherited Members

- Public Attributes inherited from homeassistant.components.sensor.SensorEntity
 entity_category
 
 registry_entry
 
 unit_of_measurement
 
- 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.sensor.SensorEntity
 Decimal
 
 None
 
 UndefinedType
 
- 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 Volcano feed data.

Definition at line 57 of file sensor.py.

Constructor & Destructor Documentation

◆ __init__()

def homeassistant.components.geonetnz_volcano.sensor.GeonetnzVolcanoSensor.__init__ (   self,
  config_entry_id,
  feed_manager,
  external_id,
  unit_system 
)
Initialize entity with data from feed entry.

Definition at line 62 of file sensor.py.

Member Function Documentation

◆ _update_callback()

def homeassistant.components.geonetnz_volcano.sensor.GeonetnzVolcanoSensor._update_callback (   self)
private
Call update method.

Definition at line 95 of file sensor.py.

◆ _update_from_feed()

def homeassistant.components.geonetnz_volcano.sensor.GeonetnzVolcanoSensor._update_from_feed (   self,
  feed_entry,
  last_update,
  last_update_successful 
)
private
Update the internal state from the provided feed entry.

Definition at line 108 of file sensor.py.

◆ async_added_to_hass()

None homeassistant.components.geonetnz_volcano.sensor.GeonetnzVolcanoSensor.async_added_to_hass (   self)
Call when entity is added to hass.

Reimplemented from homeassistant.helpers.entity.Entity.

Definition at line 81 of file sensor.py.

◆ async_update()

None homeassistant.components.geonetnz_volcano.sensor.GeonetnzVolcanoSensor.async_update (   self)
Update this entity from the data held in the feed manager.

Definition at line 99 of file sensor.py.

◆ async_will_remove_from_hass()

None homeassistant.components.geonetnz_volcano.sensor.GeonetnzVolcanoSensor.async_will_remove_from_hass (   self)
Call when entity will be removed from hass.

Reimplemented from homeassistant.helpers.entity.Entity.

Definition at line 89 of file sensor.py.

◆ extra_state_attributes()

def homeassistant.components.geonetnz_volcano.sensor.GeonetnzVolcanoSensor.extra_state_attributes (   self)
Return the device state attributes.

Reimplemented from homeassistant.helpers.entity.Entity.

Definition at line 155 of file sensor.py.

◆ icon()

def homeassistant.components.geonetnz_volcano.sensor.GeonetnzVolcanoSensor.icon (   self)
Return the icon to use in the frontend, if any.

Reimplemented from homeassistant.helpers.entity.Entity.

Definition at line 140 of file sensor.py.

◆ name()

str | None homeassistant.components.geonetnz_volcano.sensor.GeonetnzVolcanoSensor.name (   self)
Return the name of the entity.

Reimplemented from homeassistant.helpers.entity.Entity.

Definition at line 145 of file sensor.py.

◆ native_unit_of_measurement()

def homeassistant.components.geonetnz_volcano.sensor.GeonetnzVolcanoSensor.native_unit_of_measurement (   self)
Return the unit of measurement.

Reimplemented from homeassistant.components.sensor.SensorEntity.

Definition at line 150 of file sensor.py.

◆ native_value()

def homeassistant.components.geonetnz_volcano.sensor.GeonetnzVolcanoSensor.native_value (   self)
Return the state of the sensor.

Reimplemented from homeassistant.components.sensor.SensorEntity.

Definition at line 135 of file sensor.py.

Member Data Documentation

◆ _activity

homeassistant.components.geonetnz_volcano.sensor.GeonetnzVolcanoSensor._activity
private

Definition at line 75 of file sensor.py.

◆ _alert_level

homeassistant.components.geonetnz_volcano.sensor.GeonetnzVolcanoSensor._alert_level
private

Definition at line 74 of file sensor.py.

◆ _attr_attribution

homeassistant.components.geonetnz_volcano.sensor.GeonetnzVolcanoSensor._attr_attribution
private

Definition at line 125 of file sensor.py.

◆ _attr_should_poll

bool homeassistant.components.geonetnz_volcano.sensor.GeonetnzVolcanoSensor._attr_should_poll = False
staticprivate

Definition at line 60 of file sensor.py.

◆ _attr_unique_id

homeassistant.components.geonetnz_volcano.sensor.GeonetnzVolcanoSensor._attr_unique_id
private

Definition at line 67 of file sensor.py.

◆ _attribution

homeassistant.components.geonetnz_volcano.sensor.GeonetnzVolcanoSensor._attribution
private

Definition at line 73 of file sensor.py.

◆ _config_entry_id

homeassistant.components.geonetnz_volcano.sensor.GeonetnzVolcanoSensor._config_entry_id
private

Definition at line 64 of file sensor.py.

◆ _distance

homeassistant.components.geonetnz_volcano.sensor.GeonetnzVolcanoSensor._distance
private

Definition at line 70 of file sensor.py.

◆ _external_id

homeassistant.components.geonetnz_volcano.sensor.GeonetnzVolcanoSensor._external_id
private

Definition at line 66 of file sensor.py.

◆ _feed_last_update

homeassistant.components.geonetnz_volcano.sensor.GeonetnzVolcanoSensor._feed_last_update
private

Definition at line 77 of file sensor.py.

◆ _feed_last_update_successful

homeassistant.components.geonetnz_volcano.sensor.GeonetnzVolcanoSensor._feed_last_update_successful
private

Definition at line 78 of file sensor.py.

◆ _feed_manager

homeassistant.components.geonetnz_volcano.sensor.GeonetnzVolcanoSensor._feed_manager
private

Definition at line 65 of file sensor.py.

◆ _hazards

homeassistant.components.geonetnz_volcano.sensor.GeonetnzVolcanoSensor._hazards
private

Definition at line 76 of file sensor.py.

◆ _latitude

homeassistant.components.geonetnz_volcano.sensor.GeonetnzVolcanoSensor._latitude
private

Definition at line 71 of file sensor.py.

◆ _longitude

homeassistant.components.geonetnz_volcano.sensor.GeonetnzVolcanoSensor._longitude
private

Definition at line 72 of file sensor.py.

◆ _remove_signal_update

homeassistant.components.geonetnz_volcano.sensor.GeonetnzVolcanoSensor._remove_signal_update
private

Definition at line 79 of file sensor.py.

◆ _title

homeassistant.components.geonetnz_volcano.sensor.GeonetnzVolcanoSensor._title
private

Definition at line 69 of file sensor.py.

◆ _unit_system

homeassistant.components.geonetnz_volcano.sensor.GeonetnzVolcanoSensor._unit_system
private

Definition at line 68 of file sensor.py.


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