homeassistant.components.modbus.modbus.ModbusHub Class Reference

Public Member Functions
None	__init__ (self, HomeAssistant hass, dict[str, Any] client_config)
None	async_close (self)
None	async_end_delay (self, Any args)
ModbusResponse|None	async_pb_call (self, int|None unit, int address, int|list[int] value, str use_call)
None	async_pb_connect (self)
None	async_restart (self)
bool	async_setup (self)
ModbusResponse|None	low_level_pb_call (self, int|None slave, int address, int|list[int] value, str use_call)

Public Attributes
	hass
	name

Private Member Functions
None	_log_error (self, str text, bool error_state=True)

Private Attributes
	_async_cancel_listener
	_client
	_config_delay
	_config_type
	_in_error
	_lock
	_msg_wait
	_pb_class
	_pb_params

Detailed Description

Thread safe wrapper class for pymodbus.

Definition at line 240 of file modbus.py.

Constructor & Destructor Documentation

__init__()

None homeassistant.components.modbus.modbus.ModbusHub.__init__	(		self,
		HomeAssistant	hass,
		dict[str, Any]	client_config
	)

Initialize the Modbus hub.

Definition at line 243 of file modbus.py.

Member Function Documentation

_log_error()

None homeassistant.components.modbus.modbus.ModbusHub._log_error (   self, str  text, bool   error_state = True  )

private

Definition at line 299 of file modbus.py.

async_close()

None homeassistant.components.modbus.modbus.ModbusHub.async_close

(

self

)

Disconnect client.

Definition at line 355 of file modbus.py.

async_end_delay()

None homeassistant.components.modbus.modbus.ModbusHub.async_end_delay	(		self,
		Any	args
	)

End startup delay.

Definition at line 343 of file modbus.py.

async_pb_call()

ModbusResponse | None homeassistant.components.modbus.modbus.ModbusHub.async_pb_call	(		self,
		int | None	unit,
		int	address,
		int | list[int]	value,
		str	use_call
	)

Convert async to sync pymodbus call.

Definition at line 400 of file modbus.py.

async_pb_connect()

None homeassistant.components.modbus.modbus.ModbusHub.async_pb_connect

(

self

)

Connect to device, async.

Definition at line 307 of file modbus.py.

async_restart()

None homeassistant.components.modbus.modbus.ModbusHub.async_restart

(

self

)

Reconnect client.

Definition at line 348 of file modbus.py.

async_setup()

bool homeassistant.components.modbus.modbus.ModbusHub.async_setup

(

self

)

Set up pymodbus client.

Definition at line 319 of file modbus.py.

low_level_pb_call()

ModbusResponse | None homeassistant.components.modbus.modbus.ModbusHub.low_level_pb_call	(		self,
		int | None	slave,
		int	address,
		int | list[int]	value,
		str	use_call
	)

Call sync. pymodbus.

Definition at line 371 of file modbus.py.

Member Data Documentation

_async_cancel_listener

homeassistant.components.modbus.modbus.ModbusHub._async_cancel_listener

private

Definition at line 337 of file modbus.py.

_client

homeassistant.components.modbus.modbus.ModbusHub._client

private

Definition at line 322 of file modbus.py.

_config_delay

homeassistant.components.modbus.modbus.ModbusHub._config_delay

private

Definition at line 256 of file modbus.py.

_config_type

homeassistant.components.modbus.modbus.ModbusHub._config_type

private

Definition at line 255 of file modbus.py.

_in_error

homeassistant.components.modbus.modbus.ModbusHub._in_error

private

Definition at line 251 of file modbus.py.

_lock

homeassistant.components.modbus.modbus.ModbusHub._lock

private

Definition at line 252 of file modbus.py.

_msg_wait

homeassistant.components.modbus.modbus.ModbusHub._msg_wait

private

Definition at line 293 of file modbus.py.

_pb_class

homeassistant.components.modbus.modbus.ModbusHub._pb_class

private

Definition at line 258 of file modbus.py.

_pb_params

homeassistant.components.modbus.modbus.ModbusHub._pb_params

private

Definition at line 264 of file modbus.py.

hass

homeassistant.components.modbus.modbus.ModbusHub.hass

Definition at line 253 of file modbus.py.

name

homeassistant.components.modbus.modbus.ModbusHub.name

Definition at line 254 of file modbus.py.

---

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

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