Home Assistant Unofficial Reference 2024.12.1
homeassistant.components.tractive.switch.TractiveSwitch Class Reference
Inheritance diagram for homeassistant.components.tractive.switch.TractiveSwitch:
[legend]
Collaboration diagram for homeassistant.components.tractive.switch.TractiveSwitch:
[legend]

Public Member Functions

None __init__ (self, TractiveClient client, Trackables item, TractiveSwitchEntityDescription description)
 
dict[str, Any] async_set_buzzer (self, bool active)
 
dict[str, Any] async_set_led (self, bool active)
 
dict[str, Any] async_set_live_tracking (self, bool active)
 
None async_turn_off (self, **Any kwargs)
 
None async_turn_on (self, **Any kwargs)
 
None handle_status_update (self, dict[str, Any] event)
 
- Public Member Functions inherited from homeassistant.components.tractive.entity.TractiveEntity
None __init__ (self, TractiveClient client, dict[str, Any] trackable, dict[str, Any] tracker_details, str dispatcher_signal)
 
None async_added_to_hass (self)
 
None handle_server_unavailable (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)
 
None add_to_platform_start (self, HomeAssistant hass, EntityPlatform platform, asyncio.Semaphore|None parallel_updates)
 
bool assumed_state (self)
 
None async_device_update (self, bool warning=True)
 
None async_internal_added_to_hass (self)
 
None async_internal_will_remove_from_hass (self)
 
None async_on_remove (self, CALLBACK_TYPE func)
 
None async_registry_entry_updated (self)
 
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)
 
dict[str, Any]|None capability_attributes (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)
 
er.EntityOptionsType|None get_initial_entity_options (self)
 
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)
 
dict[str, Any]|None state_attributes (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)
 
str|None unit_of_measurement (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 Member Functions inherited from homeassistant.components.switch.SwitchEntity
SwitchDeviceClass|None device_class (self)
 
- Public Member Functions inherited from homeassistant.helpers.entity.ToggleEntity
None async_toggle (self, **Any kwargs)
 
bool|None is_on (self)
 
Literal["on", "off"]|None state (self)
 
None toggle (self, **Any kwargs)
 
None turn_off (self, **Any kwargs)
 
None turn_on (self, **Any kwargs)
 

Public Attributes

 entity_description
 
- Public Attributes inherited from homeassistant.helpers.entity.Entity
 device_entry
 
 entity_id
 
 hass
 
 parallel_updates
 
 platform
 
 registry_entry
 

Private Attributes

 _attr_available
 
 _attr_is_on
 
 _attr_unique_id
 
 _method
 
 _tracker
 

Additional Inherited Members

- Static Public Attributes inherited from homeassistant.helpers.entity.Entity
 bool
 
 EntityPlatform
 
 HomeAssistant
 
 None
 
 StateInfo
 
 StateType
 
 str
 
- Static Public Attributes inherited from homeassistant.helpers.entity.ToggleEntity
 None
 

Detailed Description

Tractive switch.

Definition at line 75 of file switch.py.

Constructor & Destructor Documentation

◆ __init__()

None homeassistant.components.tractive.switch.TractiveSwitch.__init__ (   self,
TractiveClient  client,
Trackables  item,
TractiveSwitchEntityDescription  description 
)
Initialize switch entity.

Definition at line 80 of file switch.py.

Member Function Documentation

◆ async_set_buzzer()

dict[str, Any] homeassistant.components.tractive.switch.TractiveSwitch.async_set_buzzer (   self,
bool  active 
)
Set the buzzer on/off.

Definition at line 136 of file switch.py.

◆ async_set_led()

dict[str, Any] homeassistant.components.tractive.switch.TractiveSwitch.async_set_led (   self,
bool  active 
)
Set the LED on/off.

Definition at line 140 of file switch.py.

◆ async_set_live_tracking()

dict[str, Any] homeassistant.components.tractive.switch.TractiveSwitch.async_set_live_tracking (   self,
bool  active 
)
Set the live tracking on/off.

Definition at line 144 of file switch.py.

◆ async_turn_off()

None homeassistant.components.tractive.switch.TractiveSwitch.async_turn_off (   self,
**Any  kwargs 
)
Turn off a switch.

Reimplemented from homeassistant.helpers.entity.ToggleEntity.

Definition at line 124 of file switch.py.

◆ async_turn_on()

None homeassistant.components.tractive.switch.TractiveSwitch.async_turn_on (   self,
**Any  kwargs 
)
Turn on a switch.

Reimplemented from homeassistant.helpers.entity.ToggleEntity.

Definition at line 112 of file switch.py.

◆ handle_status_update()

None homeassistant.components.tractive.switch.TractiveSwitch.handle_status_update (   self,
dict[str, Any]  event 
)
Handle status update.

Reimplemented from homeassistant.components.tractive.entity.TractiveEntity.

Definition at line 100 of file switch.py.

Member Data Documentation

◆ _attr_available

homeassistant.components.tractive.switch.TractiveSwitch._attr_available
private

Definition at line 107 of file switch.py.

◆ _attr_is_on

homeassistant.components.tractive.switch.TractiveSwitch._attr_is_on
private

Definition at line 108 of file switch.py.

◆ _attr_unique_id

homeassistant.components.tractive.switch.TractiveSwitch._attr_unique_id
private

Definition at line 94 of file switch.py.

◆ _method

homeassistant.components.tractive.switch.TractiveSwitch._method
private

Definition at line 96 of file switch.py.

◆ _tracker

homeassistant.components.tractive.switch.TractiveSwitch._tracker
private

Definition at line 95 of file switch.py.

◆ entity_description

homeassistant.components.tractive.switch.TractiveSwitch.entity_description

Definition at line 97 of file switch.py.


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