homeassistant.components.modbus.sensor.ModbusRegisterSensor Class Reference

Inheritance diagram for homeassistant.components.modbus.sensor.ModbusRegisterSensor:

Collaboration diagram for homeassistant.components.modbus.sensor.ModbusRegisterSensor:

Public Member Functions
None	__init__ (self, HomeAssistant hass, ModbusHub hub, dict[str, Any] entry, int slave_count)
None	async_added_to_hass (self)
list[SlaveSensor]	async_setup_slaves (self, HomeAssistant hass, int slave_count, dict[str, Any] entry)
None	async_update (self, datetime|None now=None)
Public Member Functions inherited from homeassistant.components.modbus.entity.BaseStructPlatform
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)
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)
bool	assumed_state (self)
None	async_device_update (self, bool warning=True)
None	async_on_remove (self, CALLBACK_TYPE func)
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)
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)
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)
str|None	suggested_object_id (self)
int|None	supported_features (self)
str|None	translation_key (self)
Mapping[str, str]	translation_placeholders (self)
str|None	unique_id (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)
Public Member Functions inherited from homeassistant.components.sensor.RestoreSensor
SensorExtraStoredData|None	async_get_last_sensor_data (self)
SensorExtraStoredData	extra_restore_state_data (self)
Public Member Functions inherited from homeassistant.components.sensor.SensorEntity
None	add_to_platform_start (self, HomeAssistant hass, EntityPlatform platform, asyncio.Semaphore|None parallel_updates)
None	async_internal_added_to_hass (self)
None	async_registry_entry_updated (self)
dict[str, Any]|None	capability_attributes (self)
SensorDeviceClass|None	device_class (self)
er.EntityOptionsType|None	get_initial_entity_options (self)
datetime|None	last_reset (self)
str|None	native_unit_of_measurement (self)
StateType|date|datetime|Decimal	native_value (self)
list[str]|None	options (self)
Any	state (self)
dict[str, Any]|None	state_attributes (self)
SensorStateClass|str|None	state_class (self)
int|None	suggested_display_precision (self)
str|None	suggested_unit_of_measurement (self)
str|None	unit_of_measurement (self)

Private Attributes
	_attr_available
	_attr_device_class
	_attr_native_unit_of_measurement
	_attr_native_value
	_attr_state_class
	_cancel_call
	_coordinator
	_count

Additional Inherited Members
Public Attributes inherited from homeassistant.helpers.entity.Entity
	device_entry
	entity_id
	hass
	parallel_updates
	platform
	registry_entry
Public Attributes inherited from homeassistant.components.sensor.SensorEntity
	entity_category
	registry_entry
	unit_of_measurement
Static Public Attributes inherited from homeassistant.helpers.entity.Entity
	bool
	EntityPlatform
	HomeAssistant
	None
	StateInfo
	StateType
	str
Static Public Attributes inherited from homeassistant.components.sensor.SensorEntity
	Decimal
	None
	UndefinedType

Detailed Description

Modbus register sensor.

Definition at line 63 of file sensor.py.

Constructor & Destructor Documentation

__init__()

None homeassistant.components.modbus.sensor.ModbusRegisterSensor.__init__	(		self,
		HomeAssistant	hass,
		ModbusHub	hub,
		dict[str, Any]	entry,
		int	slave_count
	)

Initialize the modbus register sensor.

Definition at line 66 of file sensor.py.

Member Function Documentation

async_added_to_hass()

None homeassistant.components.modbus.sensor.ModbusRegisterSensor.async_added_to_hass

(

self

)

Handle entity which will be added.

Reimplemented from homeassistant.helpers.entity.Entity.

Definition at line 102 of file sensor.py.

async_setup_slaves()

list[SlaveSensor] homeassistant.components.modbus.sensor.ModbusRegisterSensor.async_setup_slaves	(		self,
		HomeAssistant	hass,
		int	slave_count,
		dict[str, Any]	entry
	)

Add slaves as needed (1 read for multiple sensors).

Definition at line 82 of file sensor.py.

async_update()

None homeassistant.components.modbus.sensor.ModbusRegisterSensor.async_update	(		self,
		datetime | None	now = None
	)

Update the state of the sensor.

Reimplemented from homeassistant.components.modbus.entity.BasePlatform.

Definition at line 109 of file sensor.py.

Member Data Documentation

_attr_available

homeassistant.components.modbus.sensor.ModbusRegisterSensor._attr_available

private

Definition at line 118 of file sensor.py.

_attr_device_class

homeassistant.components.modbus.sensor.ModbusRegisterSensor._attr_device_class

private

Definition at line 80 of file sensor.py.

_attr_native_unit_of_measurement

homeassistant.components.modbus.sensor.ModbusRegisterSensor._attr_native_unit_of_measurement

private

Definition at line 78 of file sensor.py.

_attr_native_value

homeassistant.components.modbus.sensor.ModbusRegisterSensor._attr_native_value

private

Definition at line 107 of file sensor.py.

_attr_state_class

homeassistant.components.modbus.sensor.ModbusRegisterSensor._attr_state_class

private

Definition at line 79 of file sensor.py.

_cancel_call

homeassistant.components.modbus.sensor.ModbusRegisterSensor._cancel_call

private

Definition at line 113 of file sensor.py.

_coordinator

homeassistant.components.modbus.sensor.ModbusRegisterSensor._coordinator

private

Definition at line 91 of file sensor.py.

_count

homeassistant.components.modbus.sensor.ModbusRegisterSensor._count

private

Definition at line 76 of file sensor.py.

---

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

• core/homeassistant/components/modbus/sensor.py