homeassistant.components.brunt.cover.BruntDevice Class Reference

Inheritance diagram for homeassistant.components.brunt.cover.BruntDevice:

Collaboration diagram for homeassistant.components.brunt.cover.BruntDevice:

Public Member Functions
None	__init__ (self, BruntCoordinator coordinator, str|None serial, Thing thing, str entry_id)
None	async_added_to_hass (self)
None	async_close_cover (self, **Any kwargs)
None	async_open_cover (self, **Any kwargs)
None	async_set_cover_position (self, **Any kwargs)
int|None	current_cover_position (self)
dict[str, Any]	extra_state_attributes (self)
bool	is_closed (self)
bool	is_closing (self)
bool	is_opening (self)
int|None	move_state (self)
int|None	request_cover_position (self)
Public Member Functions inherited from homeassistant.helpers.update_coordinator.CoordinatorEntity
None	__init__ (self, _DataUpdateCoordinatorT coordinator, Any context=None)
None	async_update (self)
bool	available (self)
Public Member Functions inherited from homeassistant.components.brunt.coordinator.BruntCoordinator
None	__init__ (self, HomeAssistant hass, BruntConfigEntry config_entry)
Public Member Functions inherited from homeassistant.helpers.update_coordinator.DataUpdateCoordinator
None	__init__ (self, HomeAssistant hass, logging.Logger logger, *config_entries.ConfigEntry|None|UndefinedType config_entry=UNDEFINED, str name, timedelta|None update_interval=None, Callable[[], Awaitable[_DataT]]|None update_method=None, Callable[[], Awaitable[None]]|None setup_method=None, Debouncer[Coroutine[Any, Any, None]]|None request_refresh_debouncer=None, bool always_update=True)
Callable[[], None]	async_add_listener (self, CALLBACK_TYPE update_callback, Any context=None)
None	async_config_entry_first_refresh (self)
Generator[Any]	async_contexts (self)
None	async_refresh (self)
None	async_register_shutdown (self)
None	async_request_refresh (self)
None	async_set_update_error (self, Exception err)
None	async_set_updated_data (self, _DataT data)
None	async_shutdown (self)
None	async_update_listeners (self)
timedelta|None	update_interval (self)
None	update_interval (self, timedelta|None value)
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_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_tilt_position (self)
CoverDeviceClass|None	device_class (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.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_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)
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)
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 Attributes
	current_cover_position
	move_state
Public Attributes inherited from homeassistant.components.brunt.coordinator.BruntCoordinator
	bapi
Public Attributes inherited from homeassistant.helpers.update_coordinator.DataUpdateCoordinator
	always_update
	config_entry
	data
	hass
	last_exception
	last_update_success
	logger
	name
	setup_method
	update_interval
	update_method
Public Attributes inherited from homeassistant.components.cover.CoverEntity
	current_cover_position
	current_cover_tilt_position
Public Attributes inherited from homeassistant.helpers.entity.Entity
	device_entry
	entity_id
	hass
	parallel_updates
	platform
	registry_entry

Private Member Functions
None	_async_update_cover (self, int position)
None	_brunt_update_listener (self)

Private Attributes
	_attr_device_info
	_attr_unique_id
	_entry_id
	_remove_update_listener
	_thing

Static Private Attributes
	_attr_attribution = ATTRIBUTION
	_attr_device_class = CoverDeviceClass.BLIND
bool	_attr_has_entity_name = True
	_attr_name = None
tuple	_attr_supported_features

Additional Inherited Members
Static Public Attributes inherited from homeassistant.components.cover.CoverEntity
	None
Static Public Attributes inherited from homeassistant.helpers.entity.Entity
	bool
	EntityPlatform
	HomeAssistant
	None
	StateInfo
	StateType
	str

Detailed Description

Representation of a Brunt cover device.

Contains the common logic for all Brunt devices.

Definition at line 48 of file cover.py.

Constructor & Destructor Documentation

__init__()

None homeassistant.components.brunt.cover.BruntDevice.__init__	(		self,
		BruntCoordinator	coordinator,
		str | None	serial,
		Thing	thing,
		str	entry_id
	)

Init the Brunt device.

Definition at line 64 of file cover.py.

Member Function Documentation

_async_update_cover()

None homeassistant.components.brunt.cover.BruntDevice._async_update_cover (   self, int  position  )

private

Set the cover to the new position and wait for the update to be reflected.

Definition at line 155 of file cover.py.

_brunt_update_listener()

None homeassistant.components.brunt.cover.BruntDevice._brunt_update_listener (   self )

private

Update the update interval after each refresh.

Definition at line 169 of file cover.py.

async_added_to_hass()

None homeassistant.components.brunt.cover.BruntDevice.async_added_to_hass

(

self

)

When entity is added to hass.

Reimplemented from homeassistant.helpers.entity.Entity.

Definition at line 88 of file cover.py.

async_close_cover()

None homeassistant.components.brunt.cover.BruntDevice.async_close_cover	(		self,
		**Any	kwargs
	)

Set the cover to the closed position.

Reimplemented from homeassistant.components.cover.CoverEntity.

Definition at line 147 of file cover.py.

async_open_cover()

None homeassistant.components.brunt.cover.BruntDevice.async_open_cover	(		self,
		**Any	kwargs
	)

Set the cover to the open position.

Reimplemented from homeassistant.components.cover.CoverEntity.

Definition at line 143 of file cover.py.

async_set_cover_position()

None homeassistant.components.brunt.cover.BruntDevice.async_set_cover_position	(		self,
		**Any	kwargs
	)

Set the cover to a specific position.

Reimplemented from homeassistant.components.cover.CoverEntity.

Definition at line 151 of file cover.py.

current_cover_position()

int | None homeassistant.components.brunt.cover.BruntDevice.current_cover_position

(

self

)

Return current position of cover.

None is unknown, 0 is closed, 100 is fully open.

Reimplemented from homeassistant.components.cover.CoverEntity.

Definition at line 96 of file cover.py.

extra_state_attributes()

dict[str, Any] homeassistant.components.brunt.cover.BruntDevice.extra_state_attributes

(

self

)

Return the detailed device state attributes.

Reimplemented from homeassistant.helpers.entity.Entity.

Definition at line 132 of file cover.py.

is_closed()

bool homeassistant.components.brunt.cover.BruntDevice.is_closed

(

self

)

Return true if cover is closed, else False.

Reimplemented from homeassistant.components.cover.CoverEntity.

Definition at line 139 of file cover.py.

is_closing()

bool homeassistant.components.brunt.cover.BruntDevice.is_closing

(

self

)

Return if the cover is closing or not.

Reimplemented from homeassistant.components.cover.CoverEntity.

Definition at line 127 of file cover.py.

is_opening()

bool homeassistant.components.brunt.cover.BruntDevice.is_opening

(

self

)

Return if the cover is opening or not.

Reimplemented from homeassistant.components.cover.CoverEntity.

Definition at line 122 of file cover.py.

move_state()

int | None homeassistant.components.brunt.cover.BruntDevice.move_state

(

self

)

Return current moving state of cover.

None is unknown, 0 when stopped, 1 when opening, 2 when closing

Definition at line 114 of file cover.py.

request_cover_position()

int | None homeassistant.components.brunt.cover.BruntDevice.request_cover_position

(

self

)

Return request position of cover.

The request position is the position of the last request
to Brunt, at times there is a diff of 1 to current
None is unknown, 0 is closed, 100 is fully open.

Definition at line 104 of file cover.py.

Member Data Documentation

_attr_attribution

homeassistant.components.brunt.cover.BruntDevice._attr_attribution = ATTRIBUTION

staticprivate

Definition at line 57 of file cover.py.

_attr_device_class

homeassistant.components.brunt.cover.BruntDevice._attr_device_class = CoverDeviceClass.BLIND

staticprivate

Definition at line 56 of file cover.py.

_attr_device_info

homeassistant.components.brunt.cover.BruntDevice._attr_device_info

private

Definition at line 79 of file cover.py.

_attr_has_entity_name

bool homeassistant.components.brunt.cover.BruntDevice._attr_has_entity_name = True

staticprivate

Definition at line 54 of file cover.py.

_attr_name

homeassistant.components.brunt.cover.BruntDevice._attr_name = None

staticprivate

Definition at line 55 of file cover.py.

_attr_supported_features

tuple homeassistant.components.brunt.cover.BruntDevice._attr_supported_features

staticprivate

Initial value:

=  (
        CoverEntityFeature.OPEN
        | CoverEntityFeature.CLOSE
        | CoverEntityFeature.SET_POSITION
    )

Definition at line 58 of file cover.py.

_attr_unique_id

homeassistant.components.brunt.cover.BruntDevice._attr_unique_id

private

Definition at line 73 of file cover.py.

_entry_id

homeassistant.components.brunt.cover.BruntDevice._entry_id

private

Definition at line 75 of file cover.py.

_remove_update_listener

homeassistant.components.brunt.cover.BruntDevice._remove_update_listener

private

Definition at line 77 of file cover.py.

_thing

homeassistant.components.brunt.cover.BruntDevice._thing

private

Definition at line 74 of file cover.py.

current_cover_position

homeassistant.components.brunt.cover.BruntDevice.current_cover_position

Definition at line 141 of file cover.py.

move_state

homeassistant.components.brunt.cover.BruntDevice.move_state

Definition at line 124 of file cover.py.

---

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

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