homeassistant.components.modbus.cover.ModbusCover Class Reference

Inheritance diagram for homeassistant.components.modbus.cover.ModbusCover:

Collaboration diagram for homeassistant.components.modbus.cover.ModbusCover:

Public Member Functions
None	__init__ (self, HomeAssistant hass, ModbusHub hub, dict[str, Any] config)
None	async_added_to_hass (self)
None	async_close_cover (self, **Any kwargs)
None	async_open_cover (self, **Any kwargs)
None	async_update (self, datetime|None now=None)
Public Member Functions inherited from homeassistant.components.modbus.entity.BasePlatform
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)
None	add_to_platform_start (self, HomeAssistant hass, EntityPlatform platform, asyncio.Semaphore|None parallel_updates)
bool	assumed_state (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)
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)
str|None	suggested_object_id (self)
str|None	translation_key (self)
Mapping[str, str]	translation_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.components.cover.CoverEntity
None	async_close_cover_tilt (self, **Any kwargs)
None	async_open_cover_tilt (self, **Any kwargs)
None	async_set_cover_position (self, **Any kwargs)
None	async_set_cover_tilt_position (self, **Any kwargs)
None	async_stop_cover (self, **Any kwargs)
None	async_stop_cover_tilt (self, **Any kwargs)
None	async_toggle (self, **Any kwargs)
None	async_toggle_tilt (self, **Any kwargs)
None	close_cover (self, **Any kwargs)
None	close_cover_tilt (self, **Any kwargs)
int|None	current_cover_position (self)
int|None	current_cover_tilt_position (self)
CoverDeviceClass|None	device_class (self)
bool|None	is_closed (self)
bool|None	is_closing (self)
bool|None	is_opening (self)
None	open_cover (self, **Any kwargs)
None	open_cover_tilt (self, **Any kwargs)
None	set_cover_position (self, **Any kwargs)
None	set_cover_tilt_position (self, **Any kwargs)
str|None	state (self)
dict[str, Any]	state_attributes (self)
None	stop_cover (self, **Any kwargs)
None	stop_cover_tilt (self, **Any kwargs)
CoverEntityFeature	supported_features (self)
None	toggle (self, **Any kwargs)
None	toggle_tilt (self, **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
None	_set_attr_state (self, str|bool|int value)

Private Attributes
	_address
	_attr_available
	_attr_is_closed
	_attr_is_closing
	_attr_is_opening
	_input_type
	_state_closed
	_state_closing
	_state_open
	_state_opening
	_status_register
	_status_register_type
	_write_address
	_write_type

Static Private Attributes
	_attr_supported_features = CoverEntityFeature.OPEN | CoverEntityFeature.CLOSE

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.cover.CoverEntity
	current_cover_position
	current_cover_tilt_position
Static Public Attributes inherited from homeassistant.helpers.entity.Entity
	bool
	EntityPlatform
	HomeAssistant
	None
	StateInfo
	StateType
	str
Static Public Attributes inherited from homeassistant.components.cover.CoverEntity
	None

Detailed Description

Representation of a Modbus cover.

Definition at line 51 of file cover.py.

Constructor & Destructor Documentation

__init__()

None homeassistant.components.modbus.cover.ModbusCover.__init__	(		self,
		HomeAssistant	hass,
		ModbusHub	hub,
		dict[str, Any]	config
	)

Initialize the modbus cover.

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

Definition at line 56 of file cover.py.

Member Function Documentation

_set_attr_state()

None homeassistant.components.modbus.cover.ModbusCover._set_attr_state (   self, str | bool | int  value  )

private

Convert received value to HA state.

Definition at line 108 of file cover.py.

async_added_to_hass()

None homeassistant.components.modbus.cover.ModbusCover.async_added_to_hass

(

self

)

Handle entity which will be added.

Reimplemented from homeassistant.helpers.entity.Entity.

Definition at line 94 of file cover.py.

async_close_cover()

None homeassistant.components.modbus.cover.ModbusCover.async_close_cover	(		self,
		**Any	kwargs
	)

Close cover.

Reimplemented from homeassistant.components.cover.CoverEntity.

Definition at line 122 of file cover.py.

async_open_cover()

None homeassistant.components.modbus.cover.ModbusCover.async_open_cover	(		self,
		**Any	kwargs
	)

Open cover.

Reimplemented from homeassistant.components.cover.CoverEntity.

Definition at line 114 of file cover.py.

async_update()

None homeassistant.components.modbus.cover.ModbusCover.async_update	(		self,
		datetime | None	now = None
	)

Update the state of the cover.

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

Definition at line 130 of file cover.py.

Member Data Documentation

_address

homeassistant.components.modbus.cover.ModbusCover._address

private

Definition at line 91 of file cover.py.

_attr_available

homeassistant.components.modbus.cover.ModbusCover._attr_available

private

Definition at line 119 of file cover.py.

_attr_is_closed

homeassistant.components.modbus.cover.ModbusCover._attr_is_closed

private

Definition at line 71 of file cover.py.

_attr_is_closing

homeassistant.components.modbus.cover.ModbusCover._attr_is_closing

private

Definition at line 111 of file cover.py.

_attr_is_opening

homeassistant.components.modbus.cover.ModbusCover._attr_is_opening

private

Definition at line 110 of file cover.py.

_attr_supported_features

homeassistant.components.modbus.cover.ModbusCover._attr_supported_features = CoverEntityFeature.OPEN | CoverEntityFeature.CLOSE

staticprivate

Definition at line 54 of file cover.py.

_input_type

homeassistant.components.modbus.cover.ModbusCover._input_type

private

Definition at line 76 of file cover.py.

_state_closed

homeassistant.components.modbus.cover.ModbusCover._state_closed

private

Definition at line 64 of file cover.py.

_state_closing

homeassistant.components.modbus.cover.ModbusCover._state_closing

private

Definition at line 65 of file cover.py.

_state_open

homeassistant.components.modbus.cover.ModbusCover._state_open

private

Definition at line 66 of file cover.py.

_state_opening

homeassistant.components.modbus.cover.ModbusCover._state_opening

private

Definition at line 67 of file cover.py.

_status_register

homeassistant.components.modbus.cover.ModbusCover._status_register

private

Definition at line 68 of file cover.py.

_status_register_type

homeassistant.components.modbus.cover.ModbusCover._status_register_type

private

Definition at line 69 of file cover.py.

_write_address

homeassistant.components.modbus.cover.ModbusCover._write_address

private

Definition at line 78 of file cover.py.

_write_type

homeassistant.components.modbus.cover.ModbusCover._write_type

private

Definition at line 77 of file cover.py.

---

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

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