homeassistant.components.zwave_js.services Namespace Reference

Classes
class	ZWaveServices

Functions
None	_async_invoke_cc_api (Collection[_NodeOrEndpointType] nodes_or_endpoints, CommandClass command_class, str method_name, *Any args)
def	_T
dict[str, Any]	broadcast_command (dict[str, Any] val)
int	check_base_2 (int val)
dict[str, int|str|list[str]]	parameter_name_does_not_need_bitmask (dict[str, int|str|list[str]] val)
None	raise_exceptions_from_results (Sequence[_NodeOrEndpointType] zwave_objects, Sequence[Any] results)

Variables
	_LOGGER = logging.getLogger(__name__)
	_NodeOrEndpointType
dictionary	TARGET_VALIDATORS

Detailed Description

Methods and classes related to executing Z-Wave commands.

Function Documentation

_async_invoke_cc_api()

None homeassistant.components.zwave_js.services._async_invoke_cc_api ( Collection[_NodeOrEndpointType]  nodes_or_endpoints, CommandClass  command_class, str  method_name, *Any  args  )

private

Invoke the CC API on a node endpoint.

Definition at line 120 of file services.py.

_T()

def homeassistant.components.zwave_js.services._T

private

Definition at line 90 of file services.py.

broadcast_command()

dict[str, Any] homeassistant.components.zwave_js.services.broadcast_command

(

dict[str, Any]

val

)

Validate that the service call is for a broadcast command.

Definition at line 80 of file services.py.

check_base_2()

int homeassistant.components.zwave_js.services.check_base_2

(

int

val

)

Check if value is a power of 2.

Definition at line 73 of file services.py.

parameter_name_does_not_need_bitmask()

dict[str, int | str | list[str]] homeassistant.components.zwave_js.services.parameter_name_does_not_need_bitmask

(

dict[str, int | str | list[str]]

val

)

Validate that if a parameter name is provided, bitmask is not as well.

Definition at line 58 of file services.py.

raise_exceptions_from_results()

None homeassistant.components.zwave_js.services.raise_exceptions_from_results	(	Sequence[_NodeOrEndpointType]	zwave_objects,
		Sequence[Any]	results
	)

Raise list of exceptions from a list of results.

Definition at line 99 of file services.py.

Variable Documentation

_LOGGER

homeassistant.components.zwave_js.services._LOGGER = logging.getLogger(__name__)

private

Definition at line 47 of file services.py.

_NodeOrEndpointType

homeassistant.components.zwave_js.services._NodeOrEndpointType

private

Definition at line 49 of file services.py.

TARGET_VALIDATORS

dictionary homeassistant.components.zwave_js.services.TARGET_VALIDATORS

Initial value:

=  {
    vol.Optional(ATTR_AREA_ID): vol.All(cv.ensure_list, [cv.string]),
    vol.Optional(ATTR_DEVICE_ID): vol.All(cv.ensure_list, [cv.string]),
    vol.Optional(ATTR_ENTITY_ID): cv.entity_ids,
}

Definition at line 51 of file services.py.