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

Public Member Functions

None __init__ (self, NextBusDataUpdateCoordinator coordinator, str unique_id, str agency, str route, str stop, str name)
 
None async_added_to_hass (self)
 
- Public Member Functions inherited from homeassistant.helpers.update_coordinator.CoordinatorEntity
None __init__ (self, _DataUpdateCoordinatorT coordinator, Any context=None)
 
None async_update (self)
 
bool available (self)
 
- Public Member Functions inherited from homeassistant.components.nextbus.coordinator.NextBusDataUpdateCoordinator
None __init__ (self, HomeAssistant hass, str agency)
 
None add_stop_route (self, str stop_id, str route_id)
 
dict[str, Any]|None get_prediction_data (self, str stop_id, str route_id)
 
bool has_routes (self)
 
None remove_stop_route (self, str stop_id, str route_id)
 
- 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 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)
 
StateType|date|datetime|Decimal native_value (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)
 
Mapping[str, Any]|None extra_state_attributes (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)
 

Public Attributes

 agency
 
 route
 
 stop
 
- Public Attributes inherited from homeassistant.components.nextbus.coordinator.NextBusDataUpdateCoordinator
 client
 
- 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
 
- 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
 

Private Member Functions

None _handle_coordinator_update (self)
 
def _log_debug (self, message, *args)
 
def _log_err (self, message, *args)
 

Private Attributes

 _attr_name
 
 _attr_native_value
 
 _attr_unique_id
 

Static Private Attributes

 _attr_device_class = SensorDeviceClass.TIMESTAMP
 
string _attr_translation_key = "nextbus"
 

Additional Inherited Members

- 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

Sensor class that displays upcoming NextBus times.

To function, this requires knowing the agency tag as well as the tags for
both the route and the stop.

This is possibly a little convoluted to provide as it requires making a
request to the service to get these values. Perhaps it can be simplified in
the future using fuzzy logic and matching.

Definition at line 50 of file sensor.py.

Constructor & Destructor Documentation

◆ __init__()

None homeassistant.components.nextbus.sensor.NextBusDepartureSensor.__init__ (   self,
NextBusDataUpdateCoordinator  coordinator,
str  unique_id,
str  agency,
str  route,
str  stop,
str  name 
)
Initialize sensor with all required config.

Definition at line 66 of file sensor.py.

Member Function Documentation

◆ _handle_coordinator_update()

None homeassistant.components.nextbus.sensor.NextBusDepartureSensor._handle_coordinator_update (   self)
private
Update sensor with new departures times.

Definition at line 104 of file sensor.py.

◆ _log_debug()

def homeassistant.components.nextbus.sensor.NextBusDepartureSensor._log_debug (   self,
  message,
args 
)
private
Log debug message with prefix.

Definition at line 88 of file sensor.py.

◆ _log_err()

def homeassistant.components.nextbus.sensor.NextBusDepartureSensor._log_err (   self,
  message,
args 
)
private
Log error message with prefix.

Definition at line 93 of file sensor.py.

◆ async_added_to_hass()

None homeassistant.components.nextbus.sensor.NextBusDepartureSensor.async_added_to_hass (   self)
Read data from coordinator after adding to hass.

Reimplemented from homeassistant.helpers.entity.Entity.

Definition at line 98 of file sensor.py.

Member Data Documentation

◆ _attr_device_class

homeassistant.components.nextbus.sensor.NextBusDepartureSensor._attr_device_class = SensorDeviceClass.TIMESTAMP
staticprivate

Definition at line 63 of file sensor.py.

◆ _attr_name

homeassistant.components.nextbus.sensor.NextBusDepartureSensor._attr_name
private

Definition at line 86 of file sensor.py.

◆ _attr_native_value

homeassistant.components.nextbus.sensor.NextBusDepartureSensor._attr_native_value
private

Definition at line 112 of file sensor.py.

◆ _attr_translation_key

string homeassistant.components.nextbus.sensor.NextBusDepartureSensor._attr_translation_key = "nextbus"
staticprivate

Definition at line 64 of file sensor.py.

◆ _attr_unique_id

homeassistant.components.nextbus.sensor.NextBusDepartureSensor._attr_unique_id
private

Definition at line 85 of file sensor.py.

◆ agency

homeassistant.components.nextbus.sensor.NextBusDepartureSensor.agency

Definition at line 77 of file sensor.py.

◆ route

homeassistant.components.nextbus.sensor.NextBusDepartureSensor.route

Definition at line 78 of file sensor.py.

◆ stop

homeassistant.components.nextbus.sensor.NextBusDepartureSensor.stop

Definition at line 79 of file sensor.py.


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