269 lines
10 KiB
Python
269 lines
10 KiB
Python
"""Methods and classes related to executing Z-Wave commands and publishing these to hass."""
|
|
from __future__ import annotations
|
|
|
|
import logging
|
|
|
|
import voluptuous as vol
|
|
from zwave_js_server.const import CommandStatus
|
|
from zwave_js_server.exceptions import SetValueFailed
|
|
from zwave_js_server.model.node import Node as ZwaveNode
|
|
from zwave_js_server.model.value import get_value_id
|
|
from zwave_js_server.util.node import (
|
|
async_bulk_set_partial_config_parameters,
|
|
async_set_config_parameter,
|
|
)
|
|
|
|
from homeassistant.const import ATTR_DEVICE_ID, ATTR_ENTITY_ID
|
|
from homeassistant.core import HomeAssistant, ServiceCall, callback
|
|
import homeassistant.helpers.config_validation as cv
|
|
from homeassistant.helpers.dispatcher import async_dispatcher_send
|
|
from homeassistant.helpers.entity_registry import EntityRegistry
|
|
|
|
from . import const
|
|
from .helpers import async_get_node_from_device_id, async_get_node_from_entity_id
|
|
|
|
_LOGGER = logging.getLogger(__name__)
|
|
|
|
|
|
def parameter_name_does_not_need_bitmask(
|
|
val: dict[str, int | str]
|
|
) -> dict[str, int | str]:
|
|
"""Validate that if a parameter name is provided, bitmask is not as well."""
|
|
if isinstance(val[const.ATTR_CONFIG_PARAMETER], str) and (
|
|
val.get(const.ATTR_CONFIG_PARAMETER_BITMASK)
|
|
):
|
|
raise vol.Invalid(
|
|
"Don't include a bitmask when a parameter name is specified",
|
|
path=[const.ATTR_CONFIG_PARAMETER, const.ATTR_CONFIG_PARAMETER_BITMASK],
|
|
)
|
|
return val
|
|
|
|
|
|
# Validates that a bitmask is provided in hex form and converts it to decimal
|
|
# int equivalent since that's what the library uses
|
|
BITMASK_SCHEMA = vol.All(
|
|
cv.string,
|
|
vol.Lower,
|
|
vol.Match(
|
|
r"^(0x)?[0-9a-f]+$",
|
|
msg="Must provide an integer (e.g. 255) or a bitmask in hex form (e.g. 0xff)",
|
|
),
|
|
lambda value: int(value, 16),
|
|
)
|
|
|
|
|
|
class ZWaveServices:
|
|
"""Class that holds our services (Zwave Commands) that should be published to hass."""
|
|
|
|
def __init__(self, hass: HomeAssistant, ent_reg: EntityRegistry):
|
|
"""Initialize with hass object."""
|
|
self._hass = hass
|
|
self._ent_reg = ent_reg
|
|
|
|
@callback
|
|
def async_register(self) -> None:
|
|
"""Register all our services."""
|
|
self._hass.services.async_register(
|
|
const.DOMAIN,
|
|
const.SERVICE_SET_CONFIG_PARAMETER,
|
|
self.async_set_config_parameter,
|
|
schema=vol.All(
|
|
{
|
|
vol.Optional(ATTR_DEVICE_ID): vol.All(cv.ensure_list, [cv.string]),
|
|
vol.Optional(ATTR_ENTITY_ID): cv.entity_ids,
|
|
vol.Required(const.ATTR_CONFIG_PARAMETER): vol.Any(
|
|
vol.Coerce(int), cv.string
|
|
),
|
|
vol.Optional(const.ATTR_CONFIG_PARAMETER_BITMASK): vol.Any(
|
|
vol.Coerce(int), BITMASK_SCHEMA
|
|
),
|
|
vol.Required(const.ATTR_CONFIG_VALUE): vol.Any(
|
|
vol.Coerce(int), cv.string
|
|
),
|
|
},
|
|
cv.has_at_least_one_key(ATTR_DEVICE_ID, ATTR_ENTITY_ID),
|
|
parameter_name_does_not_need_bitmask,
|
|
),
|
|
)
|
|
|
|
self._hass.services.async_register(
|
|
const.DOMAIN,
|
|
const.SERVICE_BULK_SET_PARTIAL_CONFIG_PARAMETERS,
|
|
self.async_bulk_set_partial_config_parameters,
|
|
schema=vol.All(
|
|
{
|
|
vol.Optional(ATTR_DEVICE_ID): vol.All(cv.ensure_list, [cv.string]),
|
|
vol.Optional(ATTR_ENTITY_ID): cv.entity_ids,
|
|
vol.Required(const.ATTR_CONFIG_PARAMETER): vol.Coerce(int),
|
|
vol.Required(const.ATTR_CONFIG_VALUE): vol.Any(
|
|
vol.Coerce(int),
|
|
{
|
|
vol.Any(
|
|
vol.Coerce(int), BITMASK_SCHEMA, cv.string
|
|
): vol.Any(vol.Coerce(int), cv.string)
|
|
},
|
|
),
|
|
},
|
|
cv.has_at_least_one_key(ATTR_DEVICE_ID, ATTR_ENTITY_ID),
|
|
),
|
|
)
|
|
|
|
self._hass.services.async_register(
|
|
const.DOMAIN,
|
|
const.SERVICE_REFRESH_VALUE,
|
|
self.async_poll_value,
|
|
schema=vol.Schema(
|
|
{
|
|
vol.Required(ATTR_ENTITY_ID): cv.entity_ids,
|
|
vol.Optional(const.ATTR_REFRESH_ALL_VALUES, default=False): bool,
|
|
}
|
|
),
|
|
)
|
|
|
|
self._hass.services.async_register(
|
|
const.DOMAIN,
|
|
const.SERVICE_SET_VALUE,
|
|
self.async_set_value,
|
|
schema=vol.Schema(
|
|
{
|
|
vol.Optional(ATTR_DEVICE_ID): vol.All(cv.ensure_list, [cv.string]),
|
|
vol.Optional(ATTR_ENTITY_ID): cv.entity_ids,
|
|
vol.Required(const.ATTR_COMMAND_CLASS): vol.Coerce(int),
|
|
vol.Required(const.ATTR_PROPERTY): vol.Any(vol.Coerce(int), str),
|
|
vol.Optional(const.ATTR_PROPERTY_KEY): vol.Any(
|
|
vol.Coerce(int), str
|
|
),
|
|
vol.Optional(const.ATTR_ENDPOINT): vol.Coerce(int),
|
|
vol.Required(const.ATTR_VALUE): vol.Any(
|
|
bool, vol.Coerce(int), vol.Coerce(float), cv.string
|
|
),
|
|
vol.Optional(const.ATTR_WAIT_FOR_RESULT): vol.Coerce(bool),
|
|
},
|
|
cv.has_at_least_one_key(ATTR_DEVICE_ID, ATTR_ENTITY_ID),
|
|
),
|
|
)
|
|
|
|
async def async_set_config_parameter(self, service: ServiceCall) -> None:
|
|
"""Set a config value on a node."""
|
|
nodes: set[ZwaveNode] = set()
|
|
if ATTR_ENTITY_ID in service.data:
|
|
nodes |= {
|
|
async_get_node_from_entity_id(self._hass, entity_id)
|
|
for entity_id in service.data[ATTR_ENTITY_ID]
|
|
}
|
|
if ATTR_DEVICE_ID in service.data:
|
|
nodes |= {
|
|
async_get_node_from_device_id(self._hass, device_id)
|
|
for device_id in service.data[ATTR_DEVICE_ID]
|
|
}
|
|
property_or_property_name = service.data[const.ATTR_CONFIG_PARAMETER]
|
|
property_key = service.data.get(const.ATTR_CONFIG_PARAMETER_BITMASK)
|
|
new_value = service.data[const.ATTR_CONFIG_VALUE]
|
|
|
|
for node in nodes:
|
|
zwave_value, cmd_status = await async_set_config_parameter(
|
|
node,
|
|
new_value,
|
|
property_or_property_name,
|
|
property_key=property_key,
|
|
)
|
|
|
|
if cmd_status == CommandStatus.ACCEPTED:
|
|
msg = "Set configuration parameter %s on Node %s with value %s"
|
|
else:
|
|
msg = (
|
|
"Added command to queue to set configuration parameter %s on Node "
|
|
"%s with value %s. Parameter will be set when the device wakes up"
|
|
)
|
|
|
|
_LOGGER.info(msg, zwave_value, node, new_value)
|
|
|
|
async def async_bulk_set_partial_config_parameters(
|
|
self, service: ServiceCall
|
|
) -> None:
|
|
"""Bulk set multiple partial config values on a node."""
|
|
nodes: set[ZwaveNode] = set()
|
|
if ATTR_ENTITY_ID in service.data:
|
|
nodes |= {
|
|
async_get_node_from_entity_id(self._hass, entity_id)
|
|
for entity_id in service.data[ATTR_ENTITY_ID]
|
|
}
|
|
if ATTR_DEVICE_ID in service.data:
|
|
nodes |= {
|
|
async_get_node_from_device_id(self._hass, device_id)
|
|
for device_id in service.data[ATTR_DEVICE_ID]
|
|
}
|
|
property_ = service.data[const.ATTR_CONFIG_PARAMETER]
|
|
new_value = service.data[const.ATTR_CONFIG_VALUE]
|
|
|
|
for node in nodes:
|
|
cmd_status = await async_bulk_set_partial_config_parameters(
|
|
node,
|
|
property_,
|
|
new_value,
|
|
)
|
|
|
|
if cmd_status == CommandStatus.ACCEPTED:
|
|
msg = "Bulk set partials for configuration parameter %s on Node %s"
|
|
else:
|
|
msg = (
|
|
"Added command to queue to bulk set partials for configuration "
|
|
"parameter %s on Node %s"
|
|
)
|
|
|
|
_LOGGER.info(msg, property_, node)
|
|
|
|
async def async_poll_value(self, service: ServiceCall) -> None:
|
|
"""Poll value on a node."""
|
|
for entity_id in service.data[ATTR_ENTITY_ID]:
|
|
entry = self._ent_reg.async_get(entity_id)
|
|
if entry is None or entry.platform != const.DOMAIN:
|
|
raise ValueError(
|
|
f"Entity {entity_id} is not a valid {const.DOMAIN} entity."
|
|
)
|
|
async_dispatcher_send(
|
|
self._hass,
|
|
f"{const.DOMAIN}_{entry.unique_id}_poll_value",
|
|
service.data[const.ATTR_REFRESH_ALL_VALUES],
|
|
)
|
|
|
|
async def async_set_value(self, service: ServiceCall) -> None:
|
|
"""Set a value on a node."""
|
|
nodes: set[ZwaveNode] = set()
|
|
if ATTR_ENTITY_ID in service.data:
|
|
nodes |= {
|
|
async_get_node_from_entity_id(self._hass, entity_id)
|
|
for entity_id in service.data[ATTR_ENTITY_ID]
|
|
}
|
|
if ATTR_DEVICE_ID in service.data:
|
|
nodes |= {
|
|
async_get_node_from_device_id(self._hass, device_id)
|
|
for device_id in service.data[ATTR_DEVICE_ID]
|
|
}
|
|
command_class = service.data[const.ATTR_COMMAND_CLASS]
|
|
property_ = service.data[const.ATTR_PROPERTY]
|
|
property_key = service.data.get(const.ATTR_PROPERTY_KEY)
|
|
endpoint = service.data.get(const.ATTR_ENDPOINT)
|
|
new_value = service.data[const.ATTR_VALUE]
|
|
wait_for_result = service.data.get(const.ATTR_WAIT_FOR_RESULT)
|
|
|
|
for node in nodes:
|
|
success = await node.async_set_value(
|
|
get_value_id(
|
|
node,
|
|
command_class,
|
|
property_,
|
|
endpoint=endpoint,
|
|
property_key=property_key,
|
|
),
|
|
new_value,
|
|
wait_for_result=wait_for_result,
|
|
)
|
|
|
|
if success is False:
|
|
raise SetValueFailed(
|
|
"Unable to set value, refer to "
|
|
"https://zwave-js.github.io/node-zwave-js/#/api/node?id=setvalue "
|
|
"for possible reasons"
|
|
)
|