homeassistant.components.overkiz.executor.OverkizExecutor Class Reference

Public Member Functions
None	__init__ (self, str device_url, OverkizDataUpdateCoordinator coordinator)
bool	async_cancel_command (self, list[OverkizCommand] commands_to_cancel)
None	async_cancel_execution (self, str exec_id)
None	async_execute_command (self, str command_name, *Any args, bool refresh_afterwards=True)
Device	device (self)
str	get_gateway_id (self)
bool	has_command (self, *str commands)
bool	has_state (self, *str states)
Device|None	linked_device (self, int index)
OverkizStateType	select_attribute (self, *str attributes)
str|None	select_command (self, *str commands)
StateDefinition|None	select_definition_state (self, *str states)
OverkizStateType	select_state (self, *str states)

Public Attributes
	base_device_url
	coordinator
	device_url

Detailed Description

Representation of an Overkiz device with execution handler.

Definition at line 28 of file executor.py.

Constructor & Destructor Documentation

__init__()

None homeassistant.components.overkiz.executor.OverkizExecutor.__init__	(		self,
		str	device_url,
		OverkizDataUpdateCoordinator	coordinator
	)

Initialize the executor.

Definition at line 31 of file executor.py.

Member Function Documentation

async_cancel_command()

bool homeassistant.components.overkiz.executor.OverkizExecutor.async_cancel_command	(		self,
		list[OverkizCommand]	commands_to_cancel
	)

Cancel running execution by command.

Definition at line 119 of file executor.py.

async_cancel_execution()

None homeassistant.components.overkiz.executor.OverkizExecutor.async_cancel_execution	(		self,
		str	exec_id
	)

Cancel running execution via execution id.

Definition at line 164 of file executor.py.

async_execute_command()

None homeassistant.components.overkiz.executor.OverkizExecutor.async_execute_command	(		self,
		str	command_name,
		*Any	args,
		bool	refresh_afterwards = True
	)

Execute device command in async context.

:param refresh_afterwards: Whether to refresh the device state after the command is executed.
If several commands are executed, it will be refreshed only once.

Definition at line 84 of file executor.py.

device()

Device homeassistant.components.overkiz.executor.OverkizExecutor.device

(

self

)

Return Overkiz device linked to this entity.

Definition at line 40 of file executor.py.

get_gateway_id()

str homeassistant.components.overkiz.executor.OverkizExecutor.get_gateway_id

(

self

)

Retrieve gateway id from device url.

device URL (<protocol>://<gatewayId>/<deviceAddress>[#<subsystemId>])

Definition at line 168 of file executor.py.

has_command()

bool homeassistant.components.overkiz.executor.OverkizExecutor.has_command	(		self,
		*str	commands
	)

Return True if a command exists in a list of commands.

Definition at line 53 of file executor.py.

has_state()

bool homeassistant.components.overkiz.executor.OverkizExecutor.has_state	(		self,
		*str	states
	)

Return True if a state exists in self.

Definition at line 72 of file executor.py.

linked_device()

Device | None homeassistant.components.overkiz.executor.OverkizExecutor.linked_device	(		self,
		int	index
	)

Return Overkiz device sharing the same base url.

Definition at line 44 of file executor.py.

select_attribute()

OverkizStateType homeassistant.components.overkiz.executor.OverkizExecutor.select_attribute	(		self,
		*str	attributes
	)

Select first existing active state in a list of states.

Definition at line 76 of file executor.py.

select_command()

str | None homeassistant.components.overkiz.executor.OverkizExecutor.select_command	(		self,
		*str	commands
	)

Select first existing command in a list of commands.

Definition at line 48 of file executor.py.

select_definition_state()

StateDefinition | None homeassistant.components.overkiz.executor.OverkizExecutor.select_definition_state	(		self,
		*str	states
	)

Select first existing definition state in a list of states.

Definition at line 57 of file executor.py.

select_state()

OverkizStateType homeassistant.components.overkiz.executor.OverkizExecutor.select_state	(		self,
		*str	states
	)

Select first existing active state in a list of states.

Definition at line 64 of file executor.py.

Member Data Documentation

base_device_url

homeassistant.components.overkiz.executor.OverkizExecutor.base_device_url

Definition at line 37 of file executor.py.

coordinator

homeassistant.components.overkiz.executor.OverkizExecutor.coordinator

Definition at line 36 of file executor.py.

device_url

homeassistant.components.overkiz.executor.OverkizExecutor.device_url

Definition at line 35 of file executor.py.

---

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

• core/homeassistant/components/overkiz/executor.py