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

Public Member Functions

None __init__ (self, OneWireEntityDescription description, str device_id, DeviceInfo device_info, str device_file, protocol._Proxy owproxy)
 
dict[str, Any]|None extra_state_attributes (self)
 
None update (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_added_to_hass (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)
 
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)
 

Public Attributes

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

Private Member Functions

str _read_value (self)
 
None _write_value (self, bytes value)
 

Private Attributes

 _attr_device_info
 
 _attr_unique_id
 
 _device_file
 
 _last_update_success
 
 _owproxy
 
 _state
 
 _value_raw
 

Static Private Attributes

bool _attr_has_entity_name = True
 

Additional Inherited Members

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

Detailed Description

Implementation of a 1-Wire entity.

Definition at line 28 of file entity.py.

Constructor & Destructor Documentation

◆ __init__()

None homeassistant.components.onewire.entity.OneWireEntity.__init__ (   self,
OneWireEntityDescription  description,
str  device_id,
DeviceInfo  device_info,
str  device_file,
protocol._Proxy  owproxy 
)
Initialize the entity.

Definition at line 34 of file entity.py.

Member Function Documentation

◆ _read_value()

str homeassistant.components.onewire.entity.OneWireEntity._read_value (   self)
private
Read a value from the server.

Definition at line 60 of file entity.py.

◆ _write_value()

None homeassistant.components.onewire.entity.OneWireEntity._write_value (   self,
bytes  value 
)
private
Write a value to the server.

Definition at line 65 of file entity.py.

◆ extra_state_attributes()

dict[str, Any] | None homeassistant.components.onewire.entity.OneWireEntity.extra_state_attributes (   self)
Return the state attributes of the entity.

Reimplemented from homeassistant.helpers.entity.Entity.

Definition at line 53 of file entity.py.

◆ update()

None homeassistant.components.onewire.entity.OneWireEntity.update (   self)
Get the latest data from the device.

Definition at line 69 of file entity.py.

Member Data Documentation

◆ _attr_device_info

homeassistant.components.onewire.entity.OneWireEntity._attr_device_info
private

Definition at line 46 of file entity.py.

◆ _attr_has_entity_name

bool homeassistant.components.onewire.entity.OneWireEntity._attr_has_entity_name = True
staticprivate

Definition at line 32 of file entity.py.

◆ _attr_unique_id

homeassistant.components.onewire.entity.OneWireEntity._attr_unique_id
private

Definition at line 45 of file entity.py.

◆ _device_file

homeassistant.components.onewire.entity.OneWireEntity._device_file
private

Definition at line 47 of file entity.py.

◆ _last_update_success

homeassistant.components.onewire.entity.OneWireEntity._last_update_success
private

Definition at line 44 of file entity.py.

◆ _owproxy

homeassistant.components.onewire.entity.OneWireEntity._owproxy
private

Definition at line 50 of file entity.py.

◆ _state

homeassistant.components.onewire.entity.OneWireEntity._state
private

Definition at line 77 of file entity.py.

◆ _value_raw

homeassistant.components.onewire.entity.OneWireEntity._value_raw
private

Definition at line 72 of file entity.py.

◆ entity_description

homeassistant.components.onewire.entity.OneWireEntity.entity_description

Definition at line 43 of file entity.py.


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