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

Public Member Functions

def __init__ (self, tellcore_device, signal_repetitions)
 
def async_added_to_hass (self)
 
def is_on (self)
 
def turn_off (self, **kwargs)
 
def turn_on (self, **kwargs)
 
def update (self)
 
def update_from_callback (self, tellcore_id, tellcore_command, tellcore_data)
 
- 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)
 
str|None device_class (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)
 
StateType state (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)
 

Private Member Functions

def _change_device_state (self, new_state, data)
 
def _parse_ha_data (self, kwargs)
 
def _parse_tellcore_data (self, tellcore_data)
 
def _send_device_command (self, requested_state, requested_data)
 
def _send_repeated_command (self)
 
def _update_from_tellcore (self)
 
def _update_model (self, new_state, data)
 
def _update_model_from_command (self, tellcore_command, tellcore_data)
 

Private Attributes

 _attr_name
 
 _attr_unique_id
 
 _repeats_left
 
 _requested_data
 
 _requested_state
 
 _signal_repetitions
 
 _state
 
 _tellcore_device
 

Static Private Attributes

bool _attr_assumed_state = True
 
bool _attr_should_poll = False
 

Additional Inherited Members

- Public Attributes inherited from homeassistant.helpers.entity.Entity
 device_entry
 
 entity_id
 
 hass
 
 parallel_updates
 
 platform
 
 registry_entry
 
- Static Public Attributes inherited from homeassistant.helpers.entity.Entity
 bool
 
 EntityPlatform
 
 HomeAssistant
 
 None
 
 StateInfo
 
 StateType
 
 str
 

Detailed Description

Representation of a Tellstick device.

Contains the common logic for all Tellstick devices.

Definition at line 21 of file entity.py.

Constructor & Destructor Documentation

◆ __init__()

def homeassistant.components.tellstick.entity.TellstickDevice.__init__ (   self,
  tellcore_device,
  signal_repetitions 
)
Init the Tellstick device.

Reimplemented in homeassistant.components.tellstick.light.TellstickLight.

Definition at line 30 of file entity.py.

Member Function Documentation

◆ _change_device_state()

def homeassistant.components.tellstick.entity.TellstickDevice._change_device_state (   self,
  new_state,
  data 
)
private
Turn on or off the device.

Definition at line 85 of file entity.py.

◆ _parse_ha_data()

def homeassistant.components.tellstick.entity.TellstickDevice._parse_ha_data (   self,
  kwargs 
)
private

◆ _parse_tellcore_data()

def homeassistant.components.tellstick.entity.TellstickDevice._parse_tellcore_data (   self,
  tellcore_data 
)
private
Turn the value received from tellcore into something useful.

Reimplemented in homeassistant.components.tellstick.switch.TellstickSwitch, homeassistant.components.tellstick.light.TellstickLight, and homeassistant.components.tellstick.cover.TellstickCover.

Definition at line 60 of file entity.py.

◆ _send_device_command()

def homeassistant.components.tellstick.entity.TellstickDevice._send_device_command (   self,
  requested_state,
  requested_data 
)
private
Let tellcore update the actual device to the requested state.

Reimplemented in homeassistant.components.tellstick.switch.TellstickSwitch, and homeassistant.components.tellstick.light.TellstickLight.

Definition at line 68 of file entity.py.

◆ _send_repeated_command()

def homeassistant.components.tellstick.entity.TellstickDevice._send_repeated_command (   self)
private
Send a tellstick command once and decrease the repeat count.

Definition at line 72 of file entity.py.

◆ _update_from_tellcore()

def homeassistant.components.tellstick.entity.TellstickDevice._update_from_tellcore (   self)
private
Read the current state of the device from the tellcore library.

Definition at line 136 of file entity.py.

◆ _update_model()

def homeassistant.components.tellstick.entity.TellstickDevice._update_model (   self,
  new_state,
  data 
)
private

◆ _update_model_from_command()

def homeassistant.components.tellstick.entity.TellstickDevice._update_model_from_command (   self,
  tellcore_command,
  tellcore_data 
)
private
Update the model, from a sent tellcore command and data.

Definition at line 111 of file entity.py.

◆ async_added_to_hass()

def homeassistant.components.tellstick.entity.TellstickDevice.async_added_to_hass (   self)
Register callbacks.

Reimplemented from homeassistant.helpers.entity.Entity.

Definition at line 43 of file entity.py.

◆ is_on()

def homeassistant.components.tellstick.entity.TellstickDevice.is_on (   self)
Return true if the device is on.

Definition at line 52 of file entity.py.

◆ turn_off()

def homeassistant.components.tellstick.entity.TellstickDevice.turn_off (   self,
**  kwargs 
)
Turn the switch off.

Definition at line 107 of file entity.py.

◆ turn_on()

def homeassistant.components.tellstick.entity.TellstickDevice.turn_on (   self,
**  kwargs 
)
Turn the switch on.

Definition at line 103 of file entity.py.

◆ update()

def homeassistant.components.tellstick.entity.TellstickDevice.update (   self)
Poll the current state of the device.

Definition at line 149 of file entity.py.

◆ update_from_callback()

def homeassistant.components.tellstick.entity.TellstickDevice.update_from_callback (   self,
  tellcore_id,
  tellcore_command,
  tellcore_data 
)
Handle updates from the tellcore callback.

Definition at line 123 of file entity.py.

Member Data Documentation

◆ _attr_assumed_state

bool homeassistant.components.tellstick.entity.TellstickDevice._attr_assumed_state = True
staticprivate

Definition at line 27 of file entity.py.

◆ _attr_name

homeassistant.components.tellstick.entity.TellstickDevice._attr_name
private

Definition at line 40 of file entity.py.

◆ _attr_should_poll

bool homeassistant.components.tellstick.entity.TellstickDevice._attr_should_poll = False
staticprivate

Definition at line 28 of file entity.py.

◆ _attr_unique_id

homeassistant.components.tellstick.entity.TellstickDevice._attr_unique_id
private

Definition at line 41 of file entity.py.

◆ _repeats_left

homeassistant.components.tellstick.entity.TellstickDevice._repeats_left
private

Definition at line 36 of file entity.py.

◆ _requested_data

homeassistant.components.tellstick.entity.TellstickDevice._requested_data
private

Definition at line 35 of file entity.py.

◆ _requested_state

homeassistant.components.tellstick.entity.TellstickDevice._requested_state
private

Definition at line 34 of file entity.py.

◆ _signal_repetitions

homeassistant.components.tellstick.entity.TellstickDevice._signal_repetitions
private

Definition at line 32 of file entity.py.

◆ _state

homeassistant.components.tellstick.entity.TellstickDevice._state
private

Definition at line 33 of file entity.py.

◆ _tellcore_device

homeassistant.components.tellstick.entity.TellstickDevice._tellcore_device
private

Definition at line 39 of file entity.py.


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