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

Public Member Functions

None __init__ (self, str unique_id, str name, str origin, str destination, WazeTravelTimeData waze_data)
 
None async_added_to_hass (self)
 
None async_update (self)
 
dict[str, Any]|None extra_state_attributes (self)
 
None first_update (self, _=None)
 
float|None 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)
 
str|None native_unit_of_measurement (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_will_remove_from_hass (self)
 
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)
 
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)
 
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 Attributes

 _attr_name
 
 _attr_unique_id
 
 _destination
 
 _origin
 
 _state
 
 _waze_data
 

Static Private Attributes

string _attr_attribution = "Powered by Waze"
 
 _attr_device_class = SensorDeviceClass.DURATION
 
 _attr_device_info
 
 _attr_native_unit_of_measurement = UnitOfTime.MINUTES
 
 _attr_state_class = SensorStateClass.MEASUREMENT
 
string _attr_translation_key = "waze_travel_time"
 

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

Representation of a Waze travel time sensor.

Definition at line 82 of file sensor.py.

Constructor & Destructor Documentation

◆ __init__()

None homeassistant.components.waze_travel_time.sensor.WazeTravelTime.__init__ (   self,
str  unique_id,
str  name,
str  origin,
str  destination,
WazeTravelTimeData  waze_data 
)
Initialize the Waze travel time sensor.

Definition at line 97 of file sensor.py.

Member Function Documentation

◆ async_added_to_hass()

None homeassistant.components.waze_travel_time.sensor.WazeTravelTime.async_added_to_hass (   self)
Handle when entity is added.

Reimplemented from homeassistant.helpers.entity.Entity.

Definition at line 113 of file sensor.py.

◆ async_update()

None homeassistant.components.waze_travel_time.sensor.WazeTravelTime.async_update (   self)
Fetch new state data for the sensor.

Definition at line 149 of file sensor.py.

◆ extra_state_attributes()

dict[str, Any] | None homeassistant.components.waze_travel_time.sensor.WazeTravelTime.extra_state_attributes (   self)
Return the state attributes of the last update.

Reimplemented from homeassistant.helpers.entity.Entity.

Definition at line 131 of file sensor.py.

◆ first_update()

None homeassistant.components.waze_travel_time.sensor.WazeTravelTime.first_update (   self,
  _ = None 
)
Run first update and write state.

Definition at line 144 of file sensor.py.

◆ native_value()

float | None homeassistant.components.waze_travel_time.sensor.WazeTravelTime.native_value (   self)
Return the state of the sensor.

Reimplemented from homeassistant.components.sensor.SensorEntity.

Definition at line 123 of file sensor.py.

Member Data Documentation

◆ _attr_attribution

string homeassistant.components.waze_travel_time.sensor.WazeTravelTime._attr_attribution = "Powered by Waze"
staticprivate

Definition at line 85 of file sensor.py.

◆ _attr_device_class

homeassistant.components.waze_travel_time.sensor.WazeTravelTime._attr_device_class = SensorDeviceClass.DURATION
staticprivate

Definition at line 87 of file sensor.py.

◆ _attr_device_info

homeassistant.components.waze_travel_time.sensor.WazeTravelTime._attr_device_info
staticprivate
Initial value:
= DeviceInfo(
entry_type=DeviceEntryType.SERVICE,
name="Waze",
identifiers={(DOMAIN, DOMAIN)},
configuration_url="https://www.waze.com",
)

Definition at line 89 of file sensor.py.

◆ _attr_name

homeassistant.components.waze_travel_time.sensor.WazeTravelTime._attr_name
private

Definition at line 108 of file sensor.py.

◆ _attr_native_unit_of_measurement

homeassistant.components.waze_travel_time.sensor.WazeTravelTime._attr_native_unit_of_measurement = UnitOfTime.MINUTES
staticprivate

Definition at line 86 of file sensor.py.

◆ _attr_state_class

homeassistant.components.waze_travel_time.sensor.WazeTravelTime._attr_state_class = SensorStateClass.MEASUREMENT
staticprivate

Definition at line 88 of file sensor.py.

◆ _attr_translation_key

string homeassistant.components.waze_travel_time.sensor.WazeTravelTime._attr_translation_key = "waze_travel_time"
staticprivate

Definition at line 95 of file sensor.py.

◆ _attr_unique_id

homeassistant.components.waze_travel_time.sensor.WazeTravelTime._attr_unique_id
private

Definition at line 106 of file sensor.py.

◆ _destination

homeassistant.components.waze_travel_time.sensor.WazeTravelTime._destination
private

Definition at line 110 of file sensor.py.

◆ _origin

homeassistant.components.waze_travel_time.sensor.WazeTravelTime._origin
private

Definition at line 109 of file sensor.py.

◆ _state

homeassistant.components.waze_travel_time.sensor.WazeTravelTime._state
private

Definition at line 111 of file sensor.py.

◆ _waze_data

homeassistant.components.waze_travel_time.sensor.WazeTravelTime._waze_data
private

Definition at line 107 of file sensor.py.


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