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

Public Member Functions

None __init__ (self, HomeAssistant hass, ModbusHub hub, dict config)
 
str|None unpack_structure_result (self, list[int] registers)
 
- Public Member Functions inherited from homeassistant.components.modbus.entity.BasePlatform
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_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)
 
- Public Member Functions inherited from homeassistant.helpers.restore_state.RestoreEntity
ExtraStoredData|None async_get_last_extra_data (self)
 
State|None async_get_last_state (self)
 
None async_internal_added_to_hass (self)
 
None async_internal_will_remove_from_hass (self)
 
ExtraStoredData|None extra_restore_state_data (self)
 

Private Member Functions

str|None __process_raw_value (self, float|str|bytes entry)
 
list[int] _swap_registers (self, list[int] registers, int slave_count)
 

Private Attributes

 _count
 
 _data_type
 
 _offset
 
 _precision
 
 _scale
 
 _slave_count
 
 _slave_size
 
 _swap
 
 _value_is_int
 

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 class representing a sensor/climate.

Definition at line 153 of file entity.py.

Constructor & Destructor Documentation

◆ __init__()

None homeassistant.components.modbus.entity.BaseStructPlatform.__init__ (   self,
HomeAssistant  hass,
ModbusHub  hub,
dict  config 
)
Initialize the switch.

Definition at line 156 of file entity.py.

Member Function Documentation

◆ __process_raw_value()

str | None homeassistant.components.modbus.entity.BaseStructPlatform.__process_raw_value (   self,
float | str | bytes  entry 
)
private
Process value from sensor with NaN handling, scaling, offset, min/max etc.

Definition at line 205 of file entity.py.

◆ _swap_registers()

list[int] homeassistant.components.modbus.entity.BaseStructPlatform._swap_registers (   self,
list[int]  registers,
int  slave_count 
)
private
Do swap as needed.

Definition at line 183 of file entity.py.

◆ unpack_structure_result()

str | None homeassistant.components.modbus.entity.BaseStructPlatform.unpack_structure_result (   self,
list[int]  registers 
)
Convert registers to proper result.

Definition at line 225 of file entity.py.

Member Data Documentation

◆ _count

homeassistant.components.modbus.entity.BaseStructPlatform._count
private

Definition at line 167 of file entity.py.

◆ _data_type

homeassistant.components.modbus.entity.BaseStructPlatform._data_type
private

Definition at line 160 of file entity.py.

◆ _offset

homeassistant.components.modbus.entity.BaseStructPlatform._offset
private

Definition at line 163 of file entity.py.

◆ _precision

homeassistant.components.modbus.entity.BaseStructPlatform._precision
private

Definition at line 177 of file entity.py.

◆ _scale

homeassistant.components.modbus.entity.BaseStructPlatform._scale
private

Definition at line 162 of file entity.py.

◆ _slave_count

homeassistant.components.modbus.entity.BaseStructPlatform._slave_count
private

Definition at line 164 of file entity.py.

◆ _slave_size

homeassistant.components.modbus.entity.BaseStructPlatform._slave_size
private

Definition at line 167 of file entity.py.

◆ _swap

homeassistant.components.modbus.entity.BaseStructPlatform._swap
private

Definition at line 159 of file entity.py.

◆ _value_is_int

homeassistant.components.modbus.entity.BaseStructPlatform._value_is_int
private

Definition at line 181 of file entity.py.


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