Home Assistant Unofficial Reference 2024.12.1
homeassistant.components.traccar_server.entity.TraccarServerEntity Class Reference
Inheritance diagram for homeassistant.components.traccar_server.entity.TraccarServerEntity:
[legend]
Collaboration diagram for homeassistant.components.traccar_server.entity.TraccarServerEntity:
[legend]

Public Member Functions

None __init__ (self, TraccarServerCoordinator coordinator, DeviceModel device)
 
None async_added_to_hass (self)
 
bool available (self)
 
dict[str, Any] traccar_attributes (self)
 
DeviceModel traccar_device (self)
 
GeofenceModel|None traccar_geofence (self)
 
PositionModel traccar_position (self)
 
- Public Member Functions inherited from homeassistant.helpers.update_coordinator.CoordinatorEntity
None __init__ (self, _DataUpdateCoordinatorT coordinator, Any context=None)
 
None async_update (self)
 
- Public Member Functions inherited from homeassistant.components.traccar_server.coordinator.TraccarServerCoordinator
None __init__ (self, HomeAssistant hass, ApiClient client, *list[str] events, float max_accuracy, list[str] skip_accuracy_filter_for, list[str] custom_attributes)
 
None handle_subscription_data (self, SubscriptionData data)
 
None import_events (self, datetime _)
 
None subscribe (self)
 
- 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 Attributes

 device_id
 
- Public Attributes inherited from homeassistant.components.traccar_server.coordinator.TraccarServerCoordinator
 client
 
 custom_attributes
 
 events
 
 max_accuracy
 
 skip_accuracy_filter_for
 
- 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
 

Private Attributes

 _attr_device_info
 
 _attr_unique_id
 

Detailed Description

Base entity for Traccar Server.

Definition at line 17 of file entity.py.

Constructor & Destructor Documentation

◆ __init__()

None homeassistant.components.traccar_server.entity.TraccarServerEntity.__init__ (   self,
TraccarServerCoordinator  coordinator,
DeviceModel  device 
)
Initialize the Traccar Server entity.

Definition at line 20 of file entity.py.

Member Function Documentation

◆ async_added_to_hass()

None homeassistant.components.traccar_server.entity.TraccarServerEntity.async_added_to_hass (   self)
Entity added to hass.

Definition at line 60 of file entity.py.

◆ available()

bool homeassistant.components.traccar_server.entity.TraccarServerEntity.available (   self)
Return True if entity is available.

Reimplemented from homeassistant.helpers.update_coordinator.CoordinatorEntity.

Definition at line 36 of file entity.py.

◆ traccar_attributes()

dict[str, Any] homeassistant.components.traccar_server.entity.TraccarServerEntity.traccar_attributes (   self)
Return the attributes.

Definition at line 56 of file entity.py.

◆ traccar_device()

DeviceModel homeassistant.components.traccar_server.entity.TraccarServerEntity.traccar_device (   self)
Return the device.

Definition at line 41 of file entity.py.

◆ traccar_geofence()

GeofenceModel | None homeassistant.components.traccar_server.entity.TraccarServerEntity.traccar_geofence (   self)
Return the geofence.

Definition at line 46 of file entity.py.

◆ traccar_position()

PositionModel homeassistant.components.traccar_server.entity.TraccarServerEntity.traccar_position (   self)
Return the position.

Definition at line 51 of file entity.py.

Member Data Documentation

◆ _attr_device_info

homeassistant.components.traccar_server.entity.TraccarServerEntity._attr_device_info
private

Definition at line 28 of file entity.py.

◆ _attr_unique_id

homeassistant.components.traccar_server.entity.TraccarServerEntity._attr_unique_id
private

Definition at line 33 of file entity.py.

◆ device_id

homeassistant.components.traccar_server.entity.TraccarServerEntity.device_id

Definition at line 27 of file entity.py.


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