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

Public Member Functions

None __init__ (self, Any gtfs, Any|None name, Any origin, Any destination, datetime.timedelta offset, bool include_tomorrow)
 
None append_keys (self, dict resource, str|None prefix=None)
 
bool available (self)
 
dict[str, Any] extra_state_attributes (self)
 
str icon (self)
 
str name (self)
 
datetime.datetime|None native_value (self)
 
None remove_keys (self, str prefix)
 
None update (self)
 
None update_attributes (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_added_to_hass (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)
 
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)
 

Static Public Member Functions

dict dict_for_table (Any resource)
 

Public Attributes

 destination
 
 lock
 
 origin
 
- 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 Attributes

 _agency
 
 _attr_attribution
 
 _attributes
 
 _available
 
 _custom_name
 
 _departure
 
 _destination
 
 _icon
 
 _include_tomorrow
 
 _name
 
 _offset
 
 _origin
 
 _pygtfs
 
 _route
 
 _state
 
 _trip
 

Static Private Attributes

 _attr_device_class = SensorDeviceClass.TIMESTAMP
 

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

Implementation of a GTFS departure sensor.

Definition at line 517 of file sensor.py.

Constructor & Destructor Documentation

◆ __init__()

None homeassistant.components.gtfs.sensor.GTFSDepartureSensor.__init__ (   self,
Any  gtfs,
Any | None  name,
Any  origin,
Any  destination,
datetime.timedelta  offset,
bool  include_tomorrow 
)
Initialize the sensor.

Definition at line 522 of file sensor.py.

Member Function Documentation

◆ append_keys()

None homeassistant.components.gtfs.sensor.GTFSDepartureSensor.append_keys (   self,
dict  resource,
str | None   prefix = None 
)
Properly format key val pairs to append to attributes.

Definition at line 815 of file sensor.py.

◆ available()

bool homeassistant.components.gtfs.sensor.GTFSDepartureSensor.available (   self)
Return True if entity is available.

Reimplemented from homeassistant.helpers.entity.Entity.

Definition at line 566 of file sensor.py.

◆ dict_for_table()

dict homeassistant.components.gtfs.sensor.GTFSDepartureSensor.dict_for_table ( Any  resource)
static
Return a dictionary for the SQLAlchemy resource given.

Definition at line 808 of file sensor.py.

◆ extra_state_attributes()

dict[str, Any] homeassistant.components.gtfs.sensor.GTFSDepartureSensor.extra_state_attributes (   self)
Return the state attributes.

Reimplemented from homeassistant.helpers.entity.Entity.

Definition at line 571 of file sensor.py.

◆ icon()

str homeassistant.components.gtfs.sensor.GTFSDepartureSensor.icon (   self)
Icon to use in the frontend, if any.

Reimplemented from homeassistant.helpers.entity.Entity.

Definition at line 576 of file sensor.py.

◆ name()

str homeassistant.components.gtfs.sensor.GTFSDepartureSensor.name (   self)
Return the name of the sensor.

Reimplemented from homeassistant.helpers.entity.Entity.

Definition at line 556 of file sensor.py.

◆ native_value()

datetime.datetime | None homeassistant.components.gtfs.sensor.GTFSDepartureSensor.native_value (   self)
Return the state of the sensor.

Reimplemented from homeassistant.components.sensor.SensorEntity.

Definition at line 561 of file sensor.py.

◆ remove_keys()

None homeassistant.components.gtfs.sensor.GTFSDepartureSensor.remove_keys (   self,
str  prefix 
)
Remove attributes whose key starts with prefix.

Definition at line 826 of file sensor.py.

◆ update()

None homeassistant.components.gtfs.sensor.GTFSDepartureSensor.update (   self)
Get the latest data from GTFS and update the states.

Definition at line 580 of file sensor.py.

◆ update_attributes()

None homeassistant.components.gtfs.sensor.GTFSDepartureSensor.update_attributes (   self)
Update state attributes.

Definition at line 676 of file sensor.py.

Member Data Documentation

◆ _agency

homeassistant.components.gtfs.sensor.GTFSDepartureSensor._agency
private

Definition at line 545 of file sensor.py.

◆ _attr_attribution

homeassistant.components.gtfs.sensor.GTFSDepartureSensor._attr_attribution
private

Definition at line 659 of file sensor.py.

◆ _attr_device_class

homeassistant.components.gtfs.sensor.GTFSDepartureSensor._attr_device_class = SensorDeviceClass.TIMESTAMP
staticprivate

Definition at line 520 of file sensor.py.

◆ _attributes

homeassistant.components.gtfs.sensor.GTFSDepartureSensor._attributes
private

Definition at line 828 of file sensor.py.

◆ _available

homeassistant.components.gtfs.sensor.GTFSDepartureSensor._available
private

Definition at line 539 of file sensor.py.

◆ _custom_name

homeassistant.components.gtfs.sensor.GTFSDepartureSensor._custom_name
private

Definition at line 537 of file sensor.py.

◆ _departure

homeassistant.components.gtfs.sensor.GTFSDepartureSensor._departure
private

Definition at line 605 of file sensor.py.

◆ _destination

homeassistant.components.gtfs.sensor.GTFSDepartureSensor._destination
private

Definition at line 547 of file sensor.py.

◆ _icon

homeassistant.components.gtfs.sensor.GTFSDepartureSensor._icon
private

Definition at line 540 of file sensor.py.

◆ _include_tomorrow

homeassistant.components.gtfs.sensor.GTFSDepartureSensor._include_tomorrow
private

Definition at line 535 of file sensor.py.

◆ _name

homeassistant.components.gtfs.sensor.GTFSDepartureSensor._name
private

Definition at line 541 of file sensor.py.

◆ _offset

homeassistant.components.gtfs.sensor.GTFSDepartureSensor._offset
private

Definition at line 536 of file sensor.py.

◆ _origin

homeassistant.components.gtfs.sensor.GTFSDepartureSensor._origin
private

Definition at line 548 of file sensor.py.

◆ _pygtfs

homeassistant.components.gtfs.sensor.GTFSDepartureSensor._pygtfs
private

Definition at line 532 of file sensor.py.

◆ _route

homeassistant.components.gtfs.sensor.GTFSDepartureSensor._route
private

Definition at line 549 of file sensor.py.

◆ _state

homeassistant.components.gtfs.sensor.GTFSDepartureSensor._state
private

Definition at line 645 of file sensor.py.

◆ _trip

homeassistant.components.gtfs.sensor.GTFSDepartureSensor._trip
private

Definition at line 550 of file sensor.py.

◆ destination

homeassistant.components.gtfs.sensor.GTFSDepartureSensor.destination

Definition at line 534 of file sensor.py.

◆ lock

homeassistant.components.gtfs.sensor.GTFSDepartureSensor.lock

Definition at line 552 of file sensor.py.

◆ origin

homeassistant.components.gtfs.sensor.GTFSDepartureSensor.origin

Definition at line 533 of file sensor.py.


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