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

Public Member Functions

None __init__ (self, HomeAssistant hass, ModbusHub hub, dict[str, Any] entry)
 
None async_base_added_to_hass (self)
 
None async_hold (self, bool update=True)
 
None async_run (self)
 
None async_update (self, datetime|None now=None)
 
- 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)
 
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 Attributes

 _address
 
 _attr_available
 
 _attr_device_class
 
 _attr_name
 
 _attr_should_poll
 
 _attr_unique_id
 
 _attr_unit_of_measurement
 
 _call_active
 
 _cancel_call
 
 _cancel_timer
 
 _hub
 
 _input_type
 
 _max_value
 
 _min_value
 
 _nan_value
 
 _scan_interval
 
 _slave
 
 _zero_suppress
 

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

Base for readonly platforms.

Definition at line 73 of file entity.py.

Constructor & Destructor Documentation

◆ __init__()

None homeassistant.components.modbus.entity.BasePlatform.__init__ (   self,
HomeAssistant  hass,
ModbusHub  hub,
dict[str, Any]   entry 
)

Member Function Documentation

◆ async_base_added_to_hass()

None homeassistant.components.modbus.entity.BasePlatform.async_base_added_to_hass (   self)
Handle entity which will be added.

Definition at line 142 of file entity.py.

◆ async_hold()

None homeassistant.components.modbus.entity.BasePlatform.async_hold (   self,
bool   update = True 
)
Remote stop entity.

Definition at line 130 of file entity.py.

◆ async_run()

None homeassistant.components.modbus.entity.BasePlatform.async_run (   self)
Remote start entity.

Definition at line 116 of file entity.py.

◆ async_update()

None homeassistant.components.modbus.entity.BasePlatform.async_update (   self,
datetime | None   now = None 
)

Member Data Documentation

◆ _address

homeassistant.components.modbus.entity.BasePlatform._address
private

Definition at line 83 of file entity.py.

◆ _attr_available

homeassistant.components.modbus.entity.BasePlatform._attr_available
private

Definition at line 95 of file entity.py.

◆ _attr_device_class

homeassistant.components.modbus.entity.BasePlatform._attr_device_class
private

Definition at line 94 of file entity.py.

◆ _attr_name

homeassistant.components.modbus.entity.BasePlatform._attr_name
private

Definition at line 92 of file entity.py.

◆ _attr_should_poll

homeassistant.components.modbus.entity.BasePlatform._attr_should_poll
private

Definition at line 93 of file entity.py.

◆ _attr_unique_id

homeassistant.components.modbus.entity.BasePlatform._attr_unique_id
private

Definition at line 91 of file entity.py.

◆ _attr_unit_of_measurement

homeassistant.components.modbus.entity.BasePlatform._attr_unit_of_measurement
private

Definition at line 96 of file entity.py.

◆ _call_active

homeassistant.components.modbus.entity.BasePlatform._call_active
private

Definition at line 87 of file entity.py.

◆ _cancel_call

homeassistant.components.modbus.entity.BasePlatform._cancel_call
private

Definition at line 119 of file entity.py.

◆ _cancel_timer

homeassistant.components.modbus.entity.BasePlatform._cancel_timer
private

Definition at line 123 of file entity.py.

◆ _hub

homeassistant.components.modbus.entity.BasePlatform._hub
private

Definition at line 81 of file entity.py.

◆ _input_type

homeassistant.components.modbus.entity.BasePlatform._input_type
private

Definition at line 84 of file entity.py.

◆ _max_value

homeassistant.components.modbus.entity.BasePlatform._max_value
private

Definition at line 107 of file entity.py.

◆ _min_value

homeassistant.components.modbus.entity.BasePlatform._min_value
private

Definition at line 106 of file entity.py.

◆ _nan_value

homeassistant.components.modbus.entity.BasePlatform._nan_value
private

Definition at line 108 of file entity.py.

◆ _scan_interval

homeassistant.components.modbus.entity.BasePlatform._scan_interval
private

Definition at line 86 of file entity.py.

◆ _slave

homeassistant.components.modbus.entity.BasePlatform._slave
private

Definition at line 82 of file entity.py.

◆ _zero_suppress

homeassistant.components.modbus.entity.BasePlatform._zero_suppress
private

Definition at line 109 of file entity.py.


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