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

Public Member Functions

def __init__ (self, planner, name, departure, heading, lines, delay)
 
def extra_state_attributes (self)
 
def get_station_id (self, location)
 
def name (self)
 
def native_value (self)
 
None update (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)
 
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)
 
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

 _attributes
 
 _delay
 
 _departure
 
 _departureboard
 
 _heading
 
 _lines
 
 _name
 
 _planner
 
 _state
 

Static Private Attributes

string _attr_attribution = "Data provided by Västtrafik"
 
string _attr_icon = "mdi:train"
 

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

Implementation of a Vasttrafik Departure Sensor.

Definition at line 87 of file sensor.py.

Constructor & Destructor Documentation

◆ __init__()

def homeassistant.components.vasttrafik.sensor.VasttrafikDepartureSensor.__init__ (   self,
  planner,
  name,
  departure,
  heading,
  lines,
  delay 
)
Initialize the sensor.

Definition at line 93 of file sensor.py.

Member Function Documentation

◆ extra_state_attributes()

def homeassistant.components.vasttrafik.sensor.VasttrafikDepartureSensor.extra_state_attributes (   self)
Return the state attributes.

Reimplemented from homeassistant.helpers.entity.Entity.

Definition at line 120 of file sensor.py.

◆ get_station_id()

def homeassistant.components.vasttrafik.sensor.VasttrafikDepartureSensor.get_station_id (   self,
  location 
)
Get the station ID.

Definition at line 105 of file sensor.py.

◆ name()

def homeassistant.components.vasttrafik.sensor.VasttrafikDepartureSensor.name (   self)
Return the name of the sensor.

Reimplemented from homeassistant.helpers.entity.Entity.

Definition at line 115 of file sensor.py.

◆ native_value()

def homeassistant.components.vasttrafik.sensor.VasttrafikDepartureSensor.native_value (   self)
Return the next departure time.

Reimplemented from homeassistant.components.sensor.SensorEntity.

Definition at line 125 of file sensor.py.

◆ update()

None homeassistant.components.vasttrafik.sensor.VasttrafikDepartureSensor.update (   self)
Get the departure board.

Definition at line 130 of file sensor.py.

Member Data Documentation

◆ _attr_attribution

string homeassistant.components.vasttrafik.sensor.VasttrafikDepartureSensor._attr_attribution = "Data provided by Västtrafik"
staticprivate

Definition at line 90 of file sensor.py.

◆ _attr_icon

string homeassistant.components.vasttrafik.sensor.VasttrafikDepartureSensor._attr_icon = "mdi:train"
staticprivate

Definition at line 91 of file sensor.py.

◆ _attributes

homeassistant.components.vasttrafik.sensor.VasttrafikDepartureSensor._attributes
private

Definition at line 103 of file sensor.py.

◆ _delay

homeassistant.components.vasttrafik.sensor.VasttrafikDepartureSensor._delay
private

Definition at line 100 of file sensor.py.

◆ _departure

homeassistant.components.vasttrafik.sensor.VasttrafikDepartureSensor._departure
private

Definition at line 97 of file sensor.py.

◆ _departureboard

homeassistant.components.vasttrafik.sensor.VasttrafikDepartureSensor._departureboard
private

Definition at line 101 of file sensor.py.

◆ _heading

homeassistant.components.vasttrafik.sensor.VasttrafikDepartureSensor._heading
private

Definition at line 98 of file sensor.py.

◆ _lines

homeassistant.components.vasttrafik.sensor.VasttrafikDepartureSensor._lines
private

Definition at line 99 of file sensor.py.

◆ _name

homeassistant.components.vasttrafik.sensor.VasttrafikDepartureSensor._name
private

Definition at line 96 of file sensor.py.

◆ _planner

homeassistant.components.vasttrafik.sensor.VasttrafikDepartureSensor._planner
private

Definition at line 95 of file sensor.py.

◆ _state

homeassistant.components.vasttrafik.sensor.VasttrafikDepartureSensor._state
private

Definition at line 102 of file sensor.py.


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