import contextlib
import json
import re
import threading
from queue import Empty, Queue
from typing import (
Any,
Collection,
Dict,
List,
Mapping,
Optional,
Tuple,
Type,
Union,
)
import paho.mqtt.client as mqtt
from platypush.bus import Bus
from platypush.context import get_bus
from platypush.entities import (
DimmerEntityManager,
Entity,
EnumSwitchEntityManager,
LightEntityManager,
SensorEntityManager,
SwitchEntityManager,
)
from platypush.entities.batteries import Battery
from platypush.entities.devices import Device
from platypush.entities.dimmers import Dimmer
from platypush.entities.electricity import (
CurrentSensor,
EnergySensor,
PowerSensor,
VoltageSensor,
)
from platypush.entities.humidity import HumiditySensor
from platypush.entities.illuminance import IlluminanceSensor
from platypush.entities.lights import Light
from platypush.entities.linkquality import LinkQuality
from platypush.entities.sensors import (
BinarySensor,
EnumSensor,
NumericSensor,
Sensor,
)
from platypush.entities.switches import Switch, EnumSwitch
from platypush.entities.temperature import TemperatureSensor
from platypush.message.event.zigbee.mqtt import (
ZigbeeMqttOnlineEvent,
ZigbeeMqttOfflineEvent,
ZigbeeMqttDevicePairingEvent,
ZigbeeMqttDeviceConnectedEvent,
ZigbeeMqttDeviceBannedEvent,
ZigbeeMqttDeviceRemovedEvent,
ZigbeeMqttDeviceRemovedFailedEvent,
ZigbeeMqttDeviceWhitelistedEvent,
ZigbeeMqttDeviceRenamedEvent,
ZigbeeMqttDeviceBindEvent,
ZigbeeMqttDevicePropertySetEvent,
ZigbeeMqttDeviceUnbindEvent,
ZigbeeMqttGroupAddedEvent,
ZigbeeMqttGroupAddedFailedEvent,
ZigbeeMqttGroupRemovedEvent,
ZigbeeMqttGroupRemovedFailedEvent,
ZigbeeMqttGroupRemoveAllEvent,
ZigbeeMqttGroupRemoveAllFailedEvent,
ZigbeeMqttErrorEvent,
)
from platypush.message.response import Response
from platypush.plugins.mqtt import DEFAULT_TIMEOUT, MqttClient, MqttPlugin, action
from ._state import BridgeState, ZigbeeState
# pylint: disable=too-many-ancestors
class ZigbeeMqttPlugin(
MqttPlugin,
DimmerEntityManager,
EnumSwitchEntityManager,
LightEntityManager,
SensorEntityManager,
SwitchEntityManager,
):
"""
Support for Zigbee devices using any Zigbee adapter compatible with
`zigbee2mqtt `_.
In order to get started you'll need:
- A Zigbee USB adapter/sniffer (in this example I'll use the
`CC2531 `_.
- A Zigbee debugger/emulator + downloader cable (only to flash the firmware).
Instructions:
- Install `cc-tool `_ either from
sources or from a package manager.
- Connect the Zigbee to your PC/RaspberryPi in this way: ::
USB -> CC debugger -> downloader cable -> CC2531 -> USB
- The debugger and the adapter should be connected *at the same time*.
If the later ``cc-tool`` command throws up an error, put the device in
sync while connected by pressing the _Reset_ button on the debugger.
- Check where the device is mapped. On Linux it will usually be ``/dev/ttyACM0``.
- Download the latest `Z-Stack firmware
`_
to your device. Instructions for a CC2531 device:
.. code-block:: shell
# Check out the latest version of the coordinator firmware at
# https://github.com/Koenkk/Z-Stack-firmware/tree/master/coordinator
wget https://github.com/Koenkk/Z-Stack-firmware/raw/master/coordinator//bin/default/.zip
unzip CC2531_DEFAULT_20201127.zip
[sudo] cc-tool -e -w CC2531ZNP-Prod.hex
- You can disconnect your debugger and downloader cable once the firmware is flashed.
- Install ``zigbee2mqtt``. First install a node/npm environment, then
either install ``zigbee2mqtt`` manually or through your package
manager. **NOTE**: many API breaking changes have occurred on
Zigbee2MQTT 1.17.0, therefore this integration will only be compatible
with the version 1.17.0 of the service or higher versions. Manual
instructions:
.. code-block:: shell
# Clone zigbee2mqtt repository
export ZIGBEE2MQTT_DIR="$HOME/zigbee2mqtt"
git clone https://github.com/Koenkk/zigbee2mqtt.git "$ZIGBEE2MQTT_DIR"
cd "$ZIGBEE2MQTT_DIR"
# Install dependencies
npm install
- You need to have an MQTT broker running somewhere. If not, you can
install `Mosquitto `_ through your package
manager on any device in your network.
- Edit ``$ZIGBEE2MQTT_DIR/data/configuration.yaml`` file to match the configuration of
your MQTT broker:
.. code-block:: yaml
# MQTT settings
mqtt:
# MQTT base topic for zigbee2mqtt MQTT messages
topic_prefix: zigbee2mqtt
# MQTT server URL
server: 'mqtt://localhost'
# MQTT server authentication, uncomment if required:
# user: my_user
# password: my_password
- Also make sure that ``permit_join`` is set to ``True``, in order to
allow Zigbee devices to join the network while you're configuring it.
It's equally important to set ``permit_join`` to ``False`` once you
have configured your network, to prevent accidental/malignant joins
from outer Zigbee devices.
- Start the ``zigbee2mqtt`` daemon on your device (the `official
documentation
`_
also contains instructions on how to configure it as a ``systemd``
service:
.. code-block:: shell
cd "$ZIGBEE2MQTT_DIR"
npm start
- If you have Zigbee devices that are paired to other bridges, unlink
them or do a factory reset to pair them to your new bridge.
- If it all goes fine, once the daemon is running and a new device is
found you should see traces like this in the output of
``zigbee2mqtt``::
zigbee2mqtt:info 2019-11-09T12:19:56: Successfully interviewed '0x00158d0001dc126a',
device has successfully been paired
- You are now ready to use this integration.
""" # noqa: E501
def __init__(
self,
host: str,
port: int = 1883,
topic_prefix: str = 'zigbee2mqtt',
base_topic: Optional[str] = None,
timeout: int = 10,
tls_certfile: Optional[str] = None,
tls_keyfile: Optional[str] = None,
tls_version: Optional[str] = None,
tls_ciphers: Optional[str] = None,
username: Optional[str] = None,
password: Optional[str] = None,
**kwargs,
):
"""
:param host: Default MQTT broker where ``zigbee2mqtt`` publishes its messages.
:param port: Broker listen port (default: 1883).
:param topic_prefix: Prefix for the published topics, as specified in
``ZIGBEE2MQTT_DIR/data/configuration.yaml`` (default: '``zigbee2mqtt``').
:param base_topic: Legacy alias for ``topic_prefix`` (default:
'``zigbee2mqtt``').
:param timeout: If the command expects from a response, then this
timeout value will be used (default: 60 seconds).
:param tls_cafile: If the connection requires TLS/SSL, specify the
certificate authority file (default: None)
:param tls_certfile: If the connection requires TLS/SSL, specify the
certificate file (default: None)
:param tls_keyfile: If the connection requires TLS/SSL, specify the key
file (default: None)
:param tls_version: If the connection requires TLS/SSL, specify the
minimum TLS supported version (default: None)
:param tls_ciphers: If the connection requires TLS/SSL, specify the
supported ciphers (default: None)
:param username: If the connection requires user authentication, specify
the username (default: None)
:param password: If the connection requires user authentication, specify
the password (default: None)
"""
if base_topic:
self.logger.warning(
'base_topic is deprecated, please use topic_prefix instead'
)
topic_prefix = base_topic
super().__init__(
host=host,
port=port,
topics=[
f'{topic_prefix}/{topic}'
for topic in [
'bridge/state',
'bridge/log',
'bridge/logging',
'bridge/devices',
'bridge/groups',
]
],
tls_certfile=tls_certfile,
tls_keyfile=tls_keyfile,
tls_version=tls_version,
tls_ciphers=tls_ciphers,
username=username,
password=password,
timeout=timeout,
**kwargs,
)
self.topic_prefix = topic_prefix
self._info = ZigbeeState()
@staticmethod
def _get_properties(device: dict) -> dict:
"""
Static method that parses the properties of a device from its received
definition.
"""
exposes = (device.get('definition') or {}).get('exposes', []).copy()
properties = {}
while exposes:
exposed = exposes.pop(0)
exposes += exposed.get('features', [])
if exposed.get('property'):
properties[exposed['property']] = exposed
return properties
@staticmethod
def _get_options(device: dict) -> dict:
"""
Static method that parses the options of a device from its received
definition.
"""
return {
option['property']: option
for option in (device.get('definition') or {}).get('options', [])
if option.get('property')
}
def transform_entities(self, entities: Collection[dict]) -> List[Entity]:
compatible_entities = []
for dev in entities:
if not dev:
continue
dev_def = dev.get('definition') or {}
dev_info = {
attr: dev.get(attr)
for attr in (
'type',
'date_code',
'ieee_address',
'network_address',
'power_source',
'software_build_id',
'model_id',
'model',
'vendor',
'supported',
)
}
exposed = self._get_properties(dev)
options = self._get_options(dev)
reachable = dev.get('supported', False) and not dev.get(
'interviewing', False
)
light_info = self._get_light_meta(dev)
dev_entities: List[Entity] = [
*self._get_sensors(dev, exposed, options),
*self._get_dimmers(dev, exposed, options),
*self._get_switches(dev, exposed, options),
*self._get_enum_switches(dev, exposed, options),
]
if light_info:
dev_entities.append(
Light(
id=f'{dev["ieee_address"]}:light',
name='Light',
on=dev.get('state', {}).get('state')
== light_info.get('value_on'),
brightness_min=light_info.get('brightness_min'),
brightness_max=light_info.get('brightness_max'),
temperature_min=light_info.get('temperature_min'),
temperature_max=light_info.get('temperature_max'),
hue_min=light_info.get('hue_min'),
hue_max=light_info.get('hue_max'),
saturation_min=light_info.get('saturation_min'),
saturation_max=light_info.get('saturation_max'),
brightness=(
dev.get('state', {}).get(
light_info.get('brightness_name', 'brightness')
)
),
temperature=(
dev.get('state', {}).get(
light_info.get('temperature_name', 'temperature')
)
),
hue=(
dev.get('state', {})
.get('color', {})
.get(light_info.get('hue_name', 'hue'))
),
saturation=(
dev.get('state', {})
.get('color', {})
.get(light_info.get('saturation_name', 'saturation'))
),
x=(
dev.get('state', {})
.get('color', {})
.get(light_info.get('x_name', 'x'))
),
y=(
dev.get('state', {})
.get('color', {})
.get(light_info.get('y_name', 'y'))
),
description=dev_def.get('description'),
data=dev_info,
)
)
if dev_entities:
parent = Device(
id=dev['ieee_address'],
name=dev.get('friendly_name'),
description=dev_def.get('description'),
external_url=self._get_device_url(dev),
image_url=self._get_image_url(dev),
reachable=reachable,
)
for entity in dev_entities:
entity.parent = parent
dev_entities.append(parent)
compatible_entities += dev_entities
return compatible_entities
@staticmethod
def _get_device_url(device_info: dict) -> Optional[str]:
"""
Static method that returns the zigbee2mqtt URL with the information
about a certain device, if the model is available in its definition.
"""
model = device_info.get('definition', {}).get('model')
if not model:
return None
return f'https://www.zigbee2mqtt.io/devices/{model}.html'
@staticmethod
def _get_image_url(device_info: dict) -> Optional[str]:
"""
Static method that returns the zigbee2mqtt URL of the image of a
certain device, if the model is available in its definition.
"""
model = device_info.get('definition', {}).get('model')
if not model:
return None
return f'https://www.zigbee2mqtt.io/images/devices/{model}.jpg'
def _get_network_info(self, **kwargs) -> dict:
"""
Refreshes the network information.
"""
self.logger.info('Fetching Zigbee network information')
client = None
mqtt_args = self._mqtt_args(**kwargs)
timeout = mqtt_args.pop('timeout', DEFAULT_TIMEOUT)
info: Dict[str, Any] = {
'state': None,
'info': {},
'config': {},
'devices': [],
'groups': [],
}
info_ready_events = {topic: threading.Event() for topic in info}
def msg_callback(_, __, msg):
topic = msg.topic.split('/')[-1]
if topic in info:
info[topic] = (
msg.payload.decode()
if topic == 'state'
else json.loads(msg.payload.decode())
)
info_ready_events[topic].set()
try:
client = self._get_client( # pylint: disable=unexpected-keyword-arg
**mqtt_args
)
client.on_message = msg_callback
client.connect()
client.subscribe(self.topic_prefix + '/bridge/#')
client.loop_start()
for event in info_ready_events.values():
info_ready = event.wait(timeout=timeout)
if not info_ready:
raise TimeoutError(
'A timeout occurred while fetching the Zigbee network information'
)
# Cache the new results
self._info.devices.by_name = {
self._preferred_name(device): device
for device in info.get('devices', [])
}
self._info.devices.by_address = {
device['ieee_address']: device for device in info.get('devices', [])
}
self._info.groups = {
group.get('name'): group for group in info.get('groups', [])
}
self.logger.info('Zigbee network configuration updated')
finally:
try:
if client:
client.loop_stop()
client.disconnect()
except Exception as e:
self.logger.warning('Error on MQTT client disconnection: %s', e)
return info
def _topic(self, topic: str) -> str:
"""
Utility method that construct a topic prefixed by the configured base
topic.
"""
return f'{self.topic_prefix}/{topic}'
@staticmethod
def _parse_response(response: Union[dict, Response]) -> dict:
"""
Utility method that flattens a response received on a zigbee2mqtt topic
into a dictionary.
"""
if isinstance(response, Response):
rs: dict = response.output # type: ignore
response = rs
if isinstance(response, dict):
assert response.get('status') != 'error', response.get(
'error', 'zigbee2mqtt error'
)
return response or {}
def _run_request(
self,
topic: str,
msg: Union[dict, str],
reply_topic: Optional[str] = None,
**kwargs,
) -> dict:
"""
Sends a request/message to the Zigbee2MQTT bridge and waits for a
response.
"""
return self._parse_response(
self.publish( # type: ignore
topic=topic,
msg=msg,
reply_topic=reply_topic,
**self._mqtt_args(**kwargs),
)
or {}
)
@action
def devices(self, **kwargs) -> List[Dict[str, Any]]:
"""
Get the list of devices registered to the service.
:param kwargs: Extra arguments to be passed to
:meth:`platypush.plugins.mqtt.MqttPlugin.publish`` (default: query
the default configured device).
:return: List of paired devices. Example output:
.. code-block:: json
[
{
"date_code": "20190608",
"friendly_name": "Coordinator",
"ieee_address": "0x00123456789abcde",
"network_address": 0,
"supported": false,
"type": "Coordinator",
"interviewing": false,
"interviewing_completed": true,
"definition": null,
"endpoints": {
"13": {
"bindings": [],
"clusters": {
"input": ["genOta"],
"output": []
},
"output": []
}
}
},
{
"date_code": "20180906",
"friendly_name": "My Light Bulb",
"ieee_address": "0x00123456789abcdf",
"network_address": 52715,
"power_source": "Mains (single phase)",
"software_build_id": "5.127.1.26581",
"model_id": "LCT001",
"supported": true,
"interviewing": false,
"interviewing_completed": true,
"type": "Router",
"definition": {
"description": "Hue white and color ambiance E26/E27/E14",
"model": "9290012573A",
"vendor": "Philips",
"exposes": [
{
"features": [
{
"access": 7,
"description": "On/off state of this light",
"name": "state",
"property": "state",
"type": "binary",
"value_off": "OFF",
"value_on": "ON",
"value_toggle": "TOGGLE"
},
{
"access": 7,
"description": "Brightness of this light",
"name": "brightness",
"property": "brightness",
"type": "numeric",
"value_max": 254,
"value_min": 0
},
{
"access": 7,
"description": "Color temperature of this light",
"name": "color_temp",
"property": "color_temp",
"type": "numeric",
"unit": "mired",
"value_max": 500,
"value_min": 150
},
{
"description": "Color of this light in the XY space",
"features": [
{
"access": 7,
"name": "x",
"property": "x",
"type": "numeric"
},
{
"access": 7,
"name": "y",
"property": "y",
"type": "numeric"
}
],
"name": "color_xy",
"property": "color",
"type": "composite"
}
],
"type": "light"
},
{
"access": 2,
"description": "Triggers an effect on the light",
"name": "effect",
"property": "effect",
"type": "enum",
"values": [
"blink",
"breathe",
"okay",
"channel_change",
"finish_effect",
"stop_effect"
]
},
{
"access": 1,
"description": "Link quality (signal strength)",
"name": "linkquality",
"property": "linkquality",
"type": "numeric",
"unit": "lqi",
"value_max": 255,
"value_min": 0
}
]
},
"endpoints": {
"11": {
"bindings": [],
"clusters": {
"input": [
"genBasic",
"genIdentify",
"genGroups",
"genScenes",
"genOnOff",
"genLevelCtrl",
"touchlink",
"lightingColorCtrl",
],
"output": [
"genOta"
]
},
"configured_reportings": []
},
"242": {
"bindings": [],
"clusters": {
"input": [
"greenPower"
],
"output": [
"greenPower"
]
},
"configured_reportings": []
}
}
}
]
"""
return self._get_network_info(**kwargs).get('devices', {})
@action
def permit_join(
self, permit: bool = True, timeout: Optional[float] = None, **kwargs
):
"""
Enable/disable devices from joining the network.
This is not persistent (it will not be saved to ``configuration.yaml``).
:param permit: Set to True to allow joins, False otherwise.
:param timeout: Allow/disallow joins only for this amount of time.
:param kwargs: Extra arguments to be passed to
:meth:`platypush.plugins.mqtt.MqttPlugin.publish`` (default: query
the default configured device).
"""
if timeout:
return self._run_request(
topic=self._topic('bridge/request/permit_join'),
msg={'value': permit, 'time': timeout},
reply_topic=self._topic('bridge/response/permit_join'),
**self._mqtt_args(**kwargs),
)
return self.publish(
topic=self._topic('bridge/request/permit_join'),
msg={'value': permit},
**self._mqtt_args(**kwargs),
)
@action
def factory_reset(self, **kwargs):
"""
Perform a factory reset of a device connected to the network, following
the procedure required by the particular device (for instance, Hue bulbs
require the Zigbee adapter to be close to the device while a button on
the back of the bulb is pressed).
:param kwargs: Extra arguments to be passed to
:meth:`platypush.plugins.mqtt.MqttPlugin.publish`` (default: query
the default configured device).
"""
self.publish(
topic=self._topic('bridge/request/touchlink/factory_reset'),
msg='',
**self._mqtt_args(**kwargs),
)
@action
def log_level(self, level: str, **kwargs):
"""
Change the log level at runtime.
This change will not be persistent.
:param level: Possible values: 'debug', 'info', 'warn', 'error'.
:param kwargs: Extra arguments to be passed to
:meth:`platypush.plugins.mqtt.MqttPlugin.publish`` (default: query
the default configured device).
"""
return self._run_request(
topic=self._topic('bridge/request/config/log_level'),
msg={'value': level},
reply_topic=self._topic('bridge/response/config/log_level'),
**self._mqtt_args(**kwargs),
)
@action
def device_set_option(self, device: str, option: str, value: Any, **kwargs):
"""
Change the options of a device.
Options can only be changed, not added or deleted.
:param device: Display name or IEEE address of the device.
:param option: Option name.
:param value: New value.
:param kwargs: Extra arguments to be passed to
:meth:`platypush.plugins.mqtt.MqttPlugin.publish`` (default: query
the default configured device).
"""
return self._run_request(
topic=self._topic('bridge/request/device/options'),
reply_topic=self._topic('bridge/response/device/options'),
msg={
'id': device,
'options': {
option: value,
},
},
**self._mqtt_args(**kwargs),
)
@action
def device_remove(self, device: str, force: bool = False, **kwargs):
"""
Remove a device from the network.
:param device: Display name of the device.
:param force: Force the remove also if the removal wasn't acknowledged
by the device. Note: a forced remove only removes the entry from the
internal database, but the device is likely to connect again when
restarted unless it's factory reset (default: False).
:param kwargs: Extra arguments to be passed to
:meth:`platypush.plugins.mqtt.MqttPlugin.publish`` (default: query
the default configured device).
"""
return self._run_request(
topic=self._topic('bridge/request/device/remove'),
msg={'id': device, 'force': force},
reply_topic=self._topic('bridge/response/device/remove'),
**self._mqtt_args(**kwargs),
)
@action
def device_ban(self, device: str, **kwargs):
"""
Ban a device from the network.
:param device: Display name of the device.
:param kwargs: Extra arguments to be passed to
:meth:`platypush.plugins.mqtt.MqttPlugin.publish`` (default: query
the default configured device).
"""
return self._run_request(
topic=self._topic('bridge/request/device/ban'),
reply_topic=self._topic('bridge/response/device/ban'),
msg={'id': device},
**self._mqtt_args(**kwargs),
)
@action
def device_whitelist(self, device: str, **kwargs):
"""
Whitelist a device on the network.
Note: once at least a device is whitelisted, all the other
non-whitelisted devices will be removed from the network.
:param device: Display name of the device.
:param kwargs: Extra arguments to be passed to
:meth:`platypush.plugins.mqtt.MqttPlugin.publish`` (default: query
the default configured device).
"""
return self._run_request(
topic=self._topic('bridge/request/device/whitelist'),
reply_topic=self._topic('bridge/response/device/whitelist'),
msg={'id': device},
**self._mqtt_args(**kwargs),
)
@action
def device_rename(self, name: str, device: Optional[str] = None, **kwargs):
"""
Rename a device on the network.
:param name: New name.
:param device: Current name of the device to rename. If no name is
specified then the rename will affect the last device that joined
the network.
:param kwargs: Extra arguments to be passed to
:meth:`platypush.plugins.mqtt.MqttPlugin.publish`` (default: query
the default configured device).
"""
if name == device:
self.logger.info('Old and new name are the same: nothing to do')
return None
devices: dict = self.devices().output # type: ignore
assert not [
dev for dev in devices if dev.get('friendly_name') == name
], f'A device named {name} already exists on the network'
if device:
req: Dict[str, Any] = {
'from': device,
'to': name,
}
else:
req = {
'last': True,
'to': name,
}
return self._run_request(
topic=self._topic('bridge/request/device/rename'),
msg=req,
reply_topic=self._topic('bridge/response/device/rename'),
**self._mqtt_args(**kwargs),
)
@staticmethod
def _build_device_get_request(values: List[Dict[str, Any]]) -> Dict[str, Any]:
"""
Prepares a ``device_get`` request, as a dictionary to be sent down to
the bridge.
This makes sure that the properties and options are properly mapped and
converted.
"""
def extract_value(val: dict, root: dict, depth: int = 0):
for feature in val.get('features', []):
new_root = root
if depth > 0:
new_root = root[val['property']] = root.get(val['property'], {})
extract_value(feature, new_root, depth=depth + 1)
if not val.get('access', 1) & 0x4:
# Property not readable/query-able
return
if 'features' not in val:
if 'property' in val:
root[val['property']] = 0 if val['type'] == 'numeric' else ''
return
if 'property' in val:
root[val['property']] = root.get(val['property'], {})
ret: Dict[str, Any] = {}
for value in values:
extract_value(value, root=ret)
return ret
def _get_device_info(self, device: str, **kwargs) -> dict:
"""
Get or retrieve the information about a device.
"""
device_info = self._info.devices.by_name.get(
# First: check by friendly name
device,
# Second: check by address
self._info.devices.by_address.get(device, {}),
)
if not device_info:
# Third: try and get the device from upstream
network_info = self._get_network_info(**kwargs)
next(
iter(
d
for d in network_info.get('devices', [])
if self._device_name_matches(device, d)
),
{},
)
return device_info
@staticmethod
def _preferred_name(device: dict) -> str:
"""
Utility method that returns the preferred name of a device, on the basis
of which attributes are exposed (friendly name or IEEE address).
"""
return device.get('friendly_name') or device.get('ieee_address') or ''
@classmethod
def _device_name_matches(cls, name: str, device: dict) -> bool:
"""
Utility method that checks if either the friendly name or IEEE address
of a device match a certain string.
"""
name = str(cls._ieee_address(name))
return name == device.get('friendly_name') or name == device.get('ieee_address')
@action
def device_get( # pylint: disable=redefined-builtin
self, device: str, property: Optional[str] = None, **kwargs
) -> Dict[str, Any]:
"""
Get the properties of a device.
The returned keys vary depending on the device. For example, a light
bulb may have the "``state``" and "``brightness``" properties, while an
environment sensor may have the "``temperature``" and "``humidity``"
properties, and so on.
:param device: Display name of the device.
:param property: Name of the property that should be retrieved (default:
all).
:param kwargs: Extra arguments to be passed to
:meth:`platypush.plugins.mqtt.MqttPlugin.publish`` (default: query
the default configured device).
:return: Key->value map of the device properties.
"""
kwargs = self._mqtt_args(**kwargs)
device_info = self._get_device_info(device, **kwargs)
assert device_info, f'No such device: {device}'
device = self._preferred_name(device_info)
if property:
properties = self._run_request(
topic=self._topic(device) + f'/get/{property}',
reply_topic=self._topic(device),
msg={property: ''},
**kwargs,
)
assert property in properties, f'No such property: {property}'
return {property: properties[property]}
exposes = (device_info.get('definition', {}) or {}).get('exposes', [])
if not exposes:
return {}
# If the device has no queryable properties, don't specify a reply
# topic to listen on
req = self._build_device_get_request(exposes)
reply_topic = self._topic(device) if req else None
return self._run_request(
topic=self._topic(device) + '/get',
reply_topic=reply_topic,
msg=req,
**kwargs,
)
@action
def devices_get(
self, devices: Optional[List[str]] = None, **kwargs
) -> Dict[str, dict]:
"""
Get the properties of the devices connected to the network.
:param devices: If set, then only the status of these devices (by
friendly name) will be retrieved (default: retrieve all).
:param kwargs: Extra arguments to be passed to
:meth:`platypush.plugins.mqtt.MqttPlugin.publish`` (default: query
the default configured device).
:return: Key->value map of the device properties:
.. code-block:: json
{
"Bulb": {
"state": "ON",
"brightness": 254
},
"Sensor": {
"temperature": 22.5
}
}
"""
kwargs = self._mqtt_args(**kwargs)
if not devices:
devices = list(
{
self._preferred_name(device)
for device in list(self.devices(**kwargs).output or [])
if self._preferred_name(device)
}
)
def worker(device: str, q: Queue):
q.put_nowait(self.device_get(device, **kwargs).output) # type: ignore
queues: Dict[str, Queue] = {}
workers = {}
response = {}
for device in devices:
queues[device] = Queue()
workers[device] = threading.Thread(
target=worker, args=(device, queues[device])
)
workers[device].start()
for device in devices:
timeout = kwargs.get('timeout')
try:
response[device] = queues[device].get(timeout=timeout)
workers[device].join(timeout=timeout)
except Empty:
self.logger.warning(
'Could not get the status of the device %s: timeout after %f seconds',
device,
timeout,
)
except Exception as e:
self.logger.warning(
'An error occurred while getting the status of the device %s: %s',
device,
e,
)
self.logger.exception(e)
return response
@action
def status(self, *args, device: Optional[str] = None, **kwargs):
"""
Get the status of a device (by friendly name) or of all the connected
devices (it wraps :meth:`.devices_get`).
:param device: Device friendly name (default: get all devices).
"""
return self.devices_get([device] if device else None, *args, **kwargs)
@action
def device_set( # pylint: disable=redefined-builtin
self,
device: str,
property: Optional[str] = None,
value: Optional[Any] = None,
values: Optional[Dict[str, Any]] = None,
**kwargs,
):
"""
Set a properties on a device.
The compatible properties vary depending on the device. For example, a
light bulb may have the "``state``" and "``brightness``" properties,
while an environment sensor may have the "``temperature``" and
"``humidity``" properties, and so on.
:param device: Display name of the device.
:param property: Name of the property that should be set.
:param value: New value of the property.
:param values: If you want to set multiple values, then pass this
mapping instead of ``property``+``value``.
:param kwargs: Extra arguments to be passed to
:meth:`platypush.plugins.mqtt.MqttPlugin.publish`` (default: query
the default configured device).
"""
msg = (values or {}).copy()
reply_topic = None
device_info = self._get_device_info(device, **kwargs)
assert device_info, f'No such device: {device}'
device = self._preferred_name(device_info)
if property:
# Check if we're trying to set an option
stored_option = self._get_options(device_info).get(property)
if stored_option:
return self.device_set_option(device, property, value, **kwargs)
# Check if it's a property
reply_topic = self._topic(device)
stored_property = self._get_properties(device_info).get(property)
assert stored_property, f'No such property: {property}'
# Set the new value on the message
msg[property] = value
# Don't wait for an update from a value that is not readable
if self._is_write_only(stored_property):
reply_topic = None
properties = self._run_request(
topic=self._topic(device + '/set'),
reply_topic=reply_topic,
msg=msg,
**self._mqtt_args(**kwargs),
)
if property and reply_topic:
assert (
property in properties
), f'Could not retrieve the new state for {property}'
return {property: properties[property]}
return properties
@action
# pylint: disable=redefined-builtin
def set_value(
self, device: str, property: Optional[str] = None, data=None, **kwargs
):
"""
Entity-compatible way of setting a value on a node.
:param device: Device friendly name, IEEE address or internal entity ID
in ``:`` format.
:param property: Name of the property to set. If not specified here, it
should be specified on ``device`` in ``:``
format.
:param data: Value to set for the property.
:param kwargs: Extra arguments to be passed to
:meth:`platypush.plugins.mqtt.MqttPlugin.publish`` (default: query
the default configured device).
"""
dev, prop = self._ieee_address_and_property(device)
if not property:
property = prop
self.device_set(dev, property, data, **kwargs)
@action
def set(self, entity: str, value: Any, attribute: Optional[str] = None, **kwargs):
return self.set_value(entity, data=value, property=attribute, **kwargs)
@action
def device_check_ota_updates(self, device: str, **kwargs) -> dict:
"""
Check if the specified device has any OTA updates available to install.
:param device: Address or friendly name of the device.
:param kwargs: Extra arguments to be passed to
:meth:`platypush.plugins.mqtt.MqttPlugin.publish`` (default: query
the default configured device).
:return:
.. code-block:: json
{
"id": "",
"update_available": true,
"status": "ok"
}
"""
ret = self._run_request(
topic=self._topic('bridge/request/device/ota_update/check'),
reply_topic=self._topic('bridge/response/device/ota_update/check'),
msg={'id': device},
**self._mqtt_args(**kwargs),
)
return {
'status': ret['status'],
'id': ret.get('data', {}).get('id'),
'update_available': ret.get('data', {}).get('update_available', False),
}
@action
def device_install_ota_updates(self, device: str, **kwargs):
"""
Install OTA updates for a device if available.
:param device: Address or friendly name of the device.
:param kwargs: Extra arguments to be passed to
:meth:`platypush.plugins.mqtt.MqttPlugin.publish`` (default: query
the default configured device).
"""
return self._run_request(
topic=self._topic('bridge/request/device/ota_update/update'),
reply_topic=self._topic('bridge/response/device/ota_update/update'),
msg={'id': device},
**self._mqtt_args(**kwargs),
)
@action
def groups(self, **kwargs) -> List[dict]:
"""
Get the groups registered on the device.
:param kwargs: Extra arguments to be passed to
:meth:`platypush.plugins.mqtt.MqttPlugin.publish`` (default: query
the default configured device).
"""
return self._get_network_info(**kwargs).get('groups', [])
@action
def info(self, **kwargs) -> dict:
"""
Get the information, configuration and state of the network.
:param kwargs: Extra arguments to be passed to
:meth:`platypush.plugins.mqtt.MqttPlugin.publish`` (default: query
the default configured device).
:return: Example:
.. code-block:: json
{
"state": "online",
"commit": "07cdc9d",
"config": {
"advanced": {
"adapter_concurrent": null,
"adapter_delay": null,
"availability_blacklist": [],
"availability_blocklist": [],
"availability_passlist": [],
"availability_timeout": 0,
"availability_whitelist": [],
"cache_state": true,
"cache_state_persistent": true,
"cache_state_send_on_startup": true,
"channel": 11,
"elapsed": false,
"ext_pan_id": [
221,
221,
221,
221,
221,
221,
221,
221
],
"homeassistant_discovery_topic": "homeassistant",
"homeassistant_legacy_triggers": true,
"homeassistant_status_topic": "hass/status",
"last_seen": "disable",
"legacy_api": true,
"log_directory": "/opt/zigbee2mqtt/data/log/%TIMESTAMP%",
"log_file": "log.txt",
"log_level": "debug",
"log_output": [
"console",
"file"
],
"log_rotation": true,
"log_syslog": {},
"pan_id": 6754,
"report": false,
"soft_reset_timeout": 0,
"timestamp_format": "YYYY-MM-DD HH:mm:ss"
},
"ban": [],
"blocklist": [],
"device_options": {},
"devices": {
"0x00123456789abcdf": {
"friendly_name": "My Light Bulb"
}
},
"experimental": {
"output": "json"
},
"external_converters": [],
"groups": {},
"homeassistant": false,
"map_options": {
"graphviz": {
"colors": {
"fill": {
"coordinator": "#e04e5d",
"enddevice": "#fff8ce",
"router": "#4ea3e0"
},
"font": {
"coordinator": "#ffffff",
"enddevice": "#000000",
"router": "#ffffff"
},
"line": {
"active": "#009900",
"inactive": "#994444"
}
}
}
},
"mqtt": {
"base_topic": "zigbee2mqtt",
"force_disable_retain": false,
"include_device_information": false,
"server": "mqtt://localhost"
},
"passlist": [],
"permit_join": true,
"serial": {
"disable_led": false,
"port": "/dev/ttyUSB0"
},
"whitelist": []
},
"coordinator": {
"meta": {
"maintrel": 3,
"majorrel": 2,
"minorrel": 6,
"product": 0,
"revision": 20190608,
"transportrev": 2
},
"type": "zStack12"
},
"log_level": "debug",
"network": {
"channel": 11,
"extended_pan_id": "0xdddddddddddddddd",
"pan_id": 6754
},
"permit_join": true,
"version": "1.17.0"
}
"""
info = self._get_network_info(**kwargs)
return {
'state': info.get('state'),
'info': info.get('info'),
}
@action
def group_add( # pylint: disable=redefined-builtin
self, name: str, id: Optional[int] = None, **kwargs
):
"""
Add a new group.
:param name: Display name of the group.
:param id: Optional numeric ID (default: auto-generated).
:param kwargs: Extra arguments to be passed to
:meth:`platypush.plugins.mqtt.MqttPlugin.publish`` (default: query
the default configured device).
"""
payload = (
name
if id is None
else {
'id': id,
'friendly_name': name,
}
)
return self._run_request(
topic=self._topic('bridge/request/group/add'),
reply_topic=self._topic('bridge/response/group/add'),
msg=payload,
**self._mqtt_args(**kwargs),
)
@action
def group_get( # pylint: disable=redefined-builtin
self, group: str, property: Optional[str] = None, **kwargs
) -> dict:
"""
Get one or more properties of a group.
The compatible properties vary depending on the devices on the group.
For example, a light bulb may have the "``state``" (with values ``"ON"``
and ``"OFF"``) and "``brightness``" properties, while an environment
sensor may have the "``temperature``" and "``humidity``" properties, and
so on.
:param group: Display name of the group.
:param property: Name of the property to retrieve (default: all
available properties)
:param kwargs: Extra arguments to be passed to
:meth:`platypush.plugins.mqtt.MqttPlugin.publish`` (default: query
the default configured device).
"""
msg = {}
if property:
msg = {property: ''}
properties = self._run_request(
topic=self._topic(group + '/get'),
reply_topic=self._topic(group),
msg=msg,
**self._mqtt_args(**kwargs),
)
if property:
assert property in properties, f'No such property: {property}'
return {property: properties[property]}
return properties
@action
def group_set( # pylint: disable=redefined-builtin
self, group: str, property: str, value: Any, **kwargs
):
"""
Set a properties on a group.
The compatible properties vary depending on the devices on the group.
For example, a light bulb may have the "``state``" (with values ``"ON"``
and ``"OFF"``) and "``brightness``" properties, while an environment
sensor may have the "``temperature``" and "``humidity``" properties, and
so on.
:param group: Display name of the group.
:param property: Name of the property that should be set.
:param value: New value of the property.
:param kwargs: Extra arguments to be passed to
:meth:`platypush.plugins.mqtt.MqttPlugin.publish`` (default: query
the default configured device).
"""
properties = self._run_request(
topic=self._topic(group + '/set'),
reply_topic=self._topic(group),
msg={property: value},
**self._mqtt_args(**kwargs),
)
if property:
assert property in properties, f'No such property: {property}'
return {property: properties[property]}
return properties
@action
def group_rename(self, name: str, group: str, **kwargs):
"""
Rename a group.
:param name: New name.
:param group: Current name of the group to rename.
:param kwargs: Extra arguments to be passed to
:meth:`platypush.plugins.mqtt.MqttPlugin.publish`` (default: query
the default configured device).
"""
if name == group:
self.logger.info('Old and new name are the same: nothing to do')
return None
groups = {
g.get('friendly_name'): g
for g in dict(self.groups().output) # type: ignore
}
assert name not in groups, f'A group named {name} already exists on the network'
return self._run_request(
topic=self._topic('bridge/request/group/rename'),
reply_topic=self._topic('bridge/response/group/rename'),
msg={'from': group, 'to': name} if group else name,
**self._mqtt_args(**kwargs),
)
@action
def group_remove(self, name: str, **kwargs):
"""
Remove a group.
:param name: Display name of the group.
:param kwargs: Extra arguments to be passed to
:meth:`platypush.plugins.mqtt.MqttPlugin.publish`` (default: query
the default configured device).
"""
return self._run_request(
topic=self._topic('bridge/request/group/remove'),
reply_topic=self._topic('bridge/response/group/remove'),
msg=name,
**self._mqtt_args(**kwargs),
)
@action
def group_add_device(self, group: str, device: str, **kwargs):
"""
Add a device to a group.
:param group: Display name of the group.
:param device: Display name of the device to be added.
:param kwargs: Extra arguments to be passed to
:meth:`platypush.plugins.mqtt.MqttPlugin.publish`` (default: query
the default configured device).
"""
return self._run_request(
topic=self._topic('bridge/request/group/members/add'),
reply_topic=self._topic('bridge/response/group/members/add'),
msg={
'group': group,
'device': device,
},
**self._mqtt_args(**kwargs),
)
@action
def group_remove_device(self, group: str, device: Optional[str] = None, **kwargs):
"""
Remove a device from a group.
:param group: Display name of the group.
:param device: Display name of the device to be removed. If none is
specified then all the devices registered to the specified group
will be removed.
:param kwargs: Extra arguments to be passed to
:meth:`platypush.plugins.mqtt.MqttPlugin.publish`` (default: query
the default configured device).
"""
remove_suffix = '_all' if device is None else ''
return self._run_request(
topic=self._topic(f'bridge/request/group/members/remove{remove_suffix}'),
reply_topic=self._topic(
f'bridge/response/group/members/remove{remove_suffix}'
),
msg={
'group': group,
'device': device,
},
**self._mqtt_args(**kwargs),
)
@action
def bind_devices(self, source: str, target: str, **kwargs):
"""
Bind two devices.
Binding makes it possible that devices can directly control each other
without the intervention of zigbee2mqtt or any home automation software.
You may want to use this feature to bind for example an IKEA/Philips Hue
dimmer switch to a light bulb, or a Zigbee remote to a thermostat. Read
more on the `zigbee2mqtt binding page
`_.
:param source: Name of the source device. It can also be a group name,
although the support is `still experimental
`_.
You can also bind a specific device endpoint - for example
``MySensor/temperature``.
:param target: Name of the target device. You can also bind a specific
device endpoint - for example ``MyLight/state``.
:param kwargs: Extra arguments to be passed to
:meth:`platypush.plugins.mqtt.MqttPlugin.publish`` (default: query
the default configured device).
"""
return self._run_request(
topic=self._topic('bridge/request/device/bind'),
reply_topic=self._topic('bridge/response/device/bind'),
msg={'from': source, 'to': target},
**self._mqtt_args(**kwargs),
)
@action
def unbind_devices(self, source: str, target: str, **kwargs):
"""
Remove a binding between two devices.
:param source: Name of the source device. You can also bind a specific
device endpoint - for example ``MySensor/temperature``.
:param target: Name of the target device. You can also bind a specific
device endpoint - for example ``MyLight/state``.
:param kwargs: Extra arguments to be passed to
:meth:`platypush.plugins.mqtt.MqttPlugin.publish`` (default: query
the default configured device).
"""
return self._run_request(
topic=self._topic('bridge/request/device/unbind'),
reply_topic=self._topic('bridge/response/device/unbind'),
msg={'from': source, 'to': target},
**self._mqtt_args(**kwargs),
)
@action
def on(self, device, *_, **__): # pylint: disable=arguments-differ
"""
Turn on/set to true a switch, a binary property or an option.
"""
device, prop_info = self._get_switch_info(device)
return self.device_set(
device, prop_info['property'], prop_info.get('value_on', 'ON')
)
@action
def off(self, device, *_, **__): # pylint: disable=arguments-differ
"""
Turn off/set to false a switch, a binary property or an option.
"""
device, prop_info = self._get_switch_info(device)
return self.device_set(
device, prop_info['property'], prop_info.get('value_off', 'OFF')
)
@action
def toggle(self, device, *_, **__): # pylint: disable=arguments-differ
"""
Toggles the state of a switch, a binary property or an option.
"""
device, prop_info = self._get_switch_info(device)
prop = prop_info['property']
device_state: dict = self.device_get(device).output # type: ignore
return self.device_set(
device,
prop,
prop_info.get(
'value_toggle',
'OFF'
if device_state.get(prop) == prop_info.get('value_on', 'ON')
else 'ON',
),
)
def _get_switch_info(self, name: str) -> Tuple[str, dict]:
"""
Get the information about a switch or switch-like device by name or
address.
"""
name, prop = self._ieee_address_and_property(name)
if not prop or prop == 'light':
prop = 'state'
device_info = self._get_device_info(name)
assert device_info, f'No such device: {name}'
name = self._preferred_name(device_info)
prop_info = self._get_properties(device_info).get(prop)
option = self._get_options(device_info).get(prop)
if option:
return name, option
assert prop_info, f'No such property on device {name}: {prop}'
return name, prop_info
@staticmethod
def _is_read_only(feature: dict) -> bool:
"""
Utility method that checks if a feature is read-only on the basis of its
access flags.
"""
return bool(feature.get('access', 0) & 2) == 0 and (
bool(feature.get('access', 0) & 1) == 1
or bool(feature.get('access', 0) & 4) == 1
)
@staticmethod
def _is_write_only(feature: dict) -> bool:
"""
Utility method that checks if a feature is write-only on the basis of
its access flags.
"""
return bool(feature.get('access', 0) & 2) == 1 and (
bool(feature.get('access', 0) & 1) == 0
or bool(feature.get('access', 0) & 4) == 0
)
@staticmethod
def _is_query_disabled(feature: dict) -> bool:
"""
Utility method that checks if a feature doesn't support programmatic
querying (i.e. it will only broadcast its state when available) on the
basis of its access flags.
"""
return bool(feature.get('access', 0) & 4) == 0
@staticmethod
def _ieee_address_and_property(
device: Union[dict, str]
) -> Tuple[str, Optional[str]]:
"""
Given a device property, as a dictionary containing the full device
definition or a string containing the device address and property,
return a tuple in the format ``(device_address, property_name)``.
"""
# Entity value IDs are stored in the `:`
# format. Therefore, we need to split by `:` if we want to
# retrieve the original address.
if isinstance(device, dict):
dev = device['ieee_address']
else:
dev = device
# IEEE address + property format
if re.search(r'^0x[0-9a-fA-F]{16}:', dev):
parts = dev.split(':')
return parts[0], parts[1] if len(parts) > 1 else None
return dev, None
@classmethod
def _ieee_address(cls, device: Union[dict, str]) -> str:
"""
:return: The IEEE address of a device, given its full definition or
common name.
"""
return cls._ieee_address_and_property(device)[0]
@classmethod
def _get_switches(
cls, device_info: dict, props: dict, options: dict
) -> List[Switch]:
"""
A utility method that parses the properties of a device that can be
mapped to switches (or switch-like entities).
"""
return [
cls._to_entity(
Switch,
device_info,
prop,
options=options,
state=device_info.get('state', {}).get(prop['property'])
== prop['value_on'],
data={
'value_on': prop['value_on'],
'value_off': prop['value_off'],
'value_toggle': prop.get('value_toggle'),
},
)
for prop in [*props.values(), *options.values()]
if (
prop.get('type') == 'binary'
and 'value_on' in prop
and 'value_off' in prop
and not cls._is_read_only(prop)
)
]
@classmethod
def _get_sensors( # pylint: disable=too-many-branches
cls, device_info: dict, props: dict, options: dict
) -> List[Sensor]:
"""
A utility method that parses the properties of a device that can be
mapped to sensors (or sensor-like entities).
"""
sensors = []
properties = [
prop
for prop in [*props.values(), *options.values()]
if cls._is_read_only(prop)
]
for prop in properties:
entity_type = None
sensor_args = {
'value': device_info.get('state', {}).get(prop['property']),
}
if prop.get('type') == 'numeric':
sensor_args.update(
{
'min': prop.get('value_min'),
'max': prop.get('value_max'),
'unit': prop.get('unit'),
}
)
if prop.get('property') == 'battery':
entity_type = Battery
elif prop.get('property') == 'linkquality':
entity_type = LinkQuality
elif prop.get('property') == 'current':
entity_type = CurrentSensor
elif prop.get('property') == 'energy':
entity_type = EnergySensor
elif prop.get('property') == 'power':
entity_type = PowerSensor
elif prop.get('property') == 'voltage':
entity_type = VoltageSensor
elif prop.get('property', '').endswith('temperature'):
entity_type = TemperatureSensor
elif re.search(r'(humidity|moisture)$', prop.get('property' '')):
entity_type = HumiditySensor
elif re.search(r'(illuminance|luminosity)$', prop.get('property' '')):
entity_type = IlluminanceSensor
elif prop.get('type') == 'binary':
entity_type = BinarySensor
sensor_args['value'] = sensor_args['value'] == prop.get(
'value_on', True
)
elif prop.get('type') == 'enum':
entity_type = EnumSensor
sensor_args['values'] = prop.get('values', [])
elif prop.get('type') == 'numeric':
entity_type = NumericSensor
if entity_type:
sensors.append(
cls._to_entity(
entity_type, device_info, prop, options=options, **sensor_args
)
)
return sensors
@classmethod
def _get_dimmers(
cls, device_info: dict, props: dict, options: dict
) -> List[Dimmer]:
"""
A utility method that parses the properties of a device that can be
mapped to dimmers (or dimmer-like entities).
"""
return [
cls._to_entity(
Dimmer,
device_info,
prop,
options=options,
value=device_info.get('state', {}).get(prop['property']),
min=prop.get('value_min'),
max=prop.get('value_max'),
unit=prop.get('unit'),
)
for prop in [*props.values(), *options.values()]
if (
prop.get('property')
and prop.get('type') == 'numeric'
and not cls._is_read_only(prop)
)
]
@classmethod
def _get_enum_switches(
cls, device_info: dict, props: dict, options: dict
) -> List[EnumSwitch]:
"""
A utility method that parses the properties of a device that can be
mapped to switches with enum values.
"""
return [
cls._to_entity(
EnumSwitch,
device_info,
prop,
options=options,
value=device_info.get('state', {}).get(prop['property']),
values=prop.get('values', []),
)
for prop in [*props.values(), *options.values()]
if (
prop.get('access', 0) & 2
and prop.get('type') == 'enum'
and prop.get('values')
)
]
@classmethod
def _to_entity( # pylint: disable=redefined-builtin
cls,
entity_type: Type[Entity],
device_info: dict,
property: dict,
options: dict,
**kwargs,
) -> Entity:
"""
Give the information about a device and its properties and options, it
builds an entity of the right type.
"""
return entity_type(
id=f'{device_info["ieee_address"]}:{property["property"]}',
name=property.get('description', ''),
is_read_only=cls._is_read_only(property),
is_write_only=cls._is_write_only(property),
is_query_disabled=cls._is_query_disabled(property),
is_configuration=property['property'] in options,
**kwargs,
)
@classmethod
def _get_light_meta(cls, device_info: dict) -> dict:
"""
Parse the attributes of a device that can be mapped to lights (or
light-like entities).
"""
# pylint: disable=too-many-nested-blocks
for exposed in (device_info.get('definition', {}) or {}).get('exposes', []):
if exposed.get('type') == 'light':
features = exposed.get('features', [])
switch = {}
brightness = {}
temperature = {}
color = {}
for feature in features:
data = {
'is_read_only': cls._is_read_only(feature),
'is_write_only': cls._is_write_only(feature),
'is_query_disabled': cls._is_query_disabled(feature),
}
if (
feature.get('property') == 'state'
and feature.get('type') == 'binary'
and 'value_on' in feature
and 'value_off' in feature
):
switch = {
'value_on': feature['value_on'],
'value_off': feature['value_off'],
'state_name': feature['name'],
'value_toggle': feature.get('value_toggle'),
**data,
}
elif (
feature.get('property') == 'brightness'
and feature.get('type') == 'numeric'
and 'value_min' in feature
and 'value_max' in feature
):
brightness = {
'brightness_name': feature['name'],
'brightness_min': feature['value_min'],
'brightness_max': feature['value_max'],
**data,
}
elif (
feature.get('property') == 'color_temp'
and feature.get('type') == 'numeric'
and 'value_min' in feature
and 'value_max' in feature
):
temperature = {
'temperature_name': feature['name'],
'temperature_min': feature['value_min'],
'temperature_max': feature['value_max'],
**data,
}
elif (
feature.get('property') == 'color'
and feature.get('type') == 'composite'
):
color_features = feature.get('features', [])
for color_feature in color_features:
if color_feature.get('property') == 'hue':
color.update(
{
'hue_name': color_feature['name'],
'hue_min': color_feature.get('value_min', 0),
'hue_max': color_feature.get(
'value_max', 65535
),
**data,
}
)
elif color_feature.get('property') == 'saturation':
color.update(
{
'saturation_name': color_feature['name'],
'saturation_min': color_feature.get(
'value_min', 0
),
'saturation_max': color_feature.get(
'value_max', 255
),
**data,
}
)
elif color_feature.get('property') == 'x':
color.update(
{
'x_name': color_feature['name'],
'x_min': color_feature.get('value_min', 0.0),
'x_max': color_feature.get('value_max', 1.0),
**data,
}
)
elif color_feature.get('property') == 'y':
color.update(
{
'y_name': color_feature['name'],
'y_min': color_feature.get('value_min', 0),
'y_max': color_feature.get('value_max', 255),
**data,
}
)
return {
'friendly_name': device_info.get('friendly_name'),
'ieee_address': device_info.get('friendly_name'),
**switch,
**brightness,
**temperature,
**color,
}
return {}
@action
def set_lights(self, *_, lights, **kwargs):
"""
Set the state for one or more Zigbee lights.
"""
lights = [lights] if isinstance(lights, str) else lights
lights = [str(self._ieee_address(light)) for light in lights]
devices = [self._get_device_info(light) for light in lights]
for i, dev in enumerate(devices):
assert dev, f'No such device: {lights[i]}'
light_meta = self._get_light_meta(dev)
assert light_meta, f'{dev["name"]} is not a light'
data = {}
for attr, value in kwargs.items():
if attr == 'on':
data[light_meta['state_name']] = value
elif attr in {'brightness', 'bri'}:
data[light_meta['brightness_name']] = int(value)
elif attr in {'temperature', 'ct'}:
data[light_meta['temperature_name']] = int(value)
elif attr in {'saturation', 'sat'}:
data['color'] = {
**data.get('color', {}),
light_meta['saturation_name']: int(value),
}
elif attr == 'hue':
data['color'] = {
**data.get('color', {}),
light_meta['hue_name']: int(value),
}
elif attr == 'xy':
data['color'] = {
**data.get('color', {}),
light_meta['x_name']: float(value[0]),
light_meta['y_name']: float(value[1]),
}
elif attr == 'x':
data['color'] = {
**data.get('color', {}),
light_meta['x_name']: float(value),
}
elif attr == 'y':
data['color'] = {
**data.get('color', {}),
light_meta['y_name']: float(value),
}
else:
data[attr] = value
self.device_set(self._preferred_name(dev), values=data)
def on_mqtt_message(self):
"""
Overrides :meth:`platypush.plugins.mqtt.MqttPlugin.on_mqtt_message` to
handle messages from the zigbee2mqtt integration.
"""
def handler(client: MqttClient, _, msg: mqtt.MQTTMessage):
topic_idx = len(self.topic_prefix) + 1
topic = msg.topic[topic_idx:]
data = msg.payload.decode()
if not data:
return
with contextlib.suppress(ValueError, TypeError):
data = json.loads(data)
if topic == 'bridge/state':
self._process_state_message(client, data)
elif topic in ['bridge/log', 'bridge/logging']:
self._process_log_message(client, data)
elif topic == 'bridge/devices':
self._process_devices(client, data)
elif topic == 'bridge/groups':
self._process_groups(client, data)
elif isinstance(data, dict):
name = topic.split('/')[-1]
if name not in self._info.devices:
self.logger.debug('Skipping unknown topic: %s', topic)
return
dev = self._info.devices.get(name)
assert dev is not None, f'No such device: {name}'
changed_props = {
k: v for k, v in data.items() if v != dev.get('state', {}).get(k)
}
if changed_props:
self._process_property_update(name, data)
self._bus.post(
ZigbeeMqttDevicePropertySetEvent(
host=client.host,
port=client.port,
device=name,
properties=changed_props,
)
)
dev = self._info.devices.get(name)
if dev:
self._info.devices.set_state(
dev.get('friendly_name') or dev.get('ieee_address'), data
)
return handler
@property
def _bus(self) -> Bus:
"""
Utility property for the bus.
"""
return get_bus()
def _process_state_message(self, client: MqttClient, msg: str):
"""
Process a state message.
"""
if msg == self._info.bridge_state:
return
if msg == 'online':
evt = ZigbeeMqttOnlineEvent
self._info.bridge_state = BridgeState.ONLINE
elif msg == 'offline':
evt = ZigbeeMqttOfflineEvent
self._info.bridge_state = BridgeState.OFFLINE
self.logger.warning('The zigbee2mqtt service is offline')
else:
return
self._bus.post(evt(host=client.host, port=client.port))
# pylint: disable=too-many-branches
def _process_log_message(self, client, msg):
"""
Process a log event.
"""
msg_type = msg.get('type')
text = msg.get('message')
args = {'host': client._host, 'port': client._port}
if msg_type == 'devices':
devices = {}
for dev in text or []:
devices[dev['friendly_name']] = dev
client.subscribe(self.topic_prefix + '/' + dev['friendly_name'])
elif msg_type == 'pairing':
self._bus.post(ZigbeeMqttDevicePairingEvent(device=text, **args))
elif msg_type in ['device_ban', 'device_banned']:
self._bus.post(ZigbeeMqttDeviceBannedEvent(device=text, **args))
elif msg_type in ['device_removed_failed', 'device_force_removed_failed']:
force = msg_type == 'device_force_removed_failed'
self._bus.post(
ZigbeeMqttDeviceRemovedFailedEvent(device=text, force=force, **args)
)
elif msg_type == 'device_whitelisted':
self._bus.post(ZigbeeMqttDeviceWhitelistedEvent(device=text, **args))
elif msg_type == 'device_renamed':
self._bus.post(ZigbeeMqttDeviceRenamedEvent(device=text, **args))
elif msg_type == 'device_bind':
self._bus.post(ZigbeeMqttDeviceBindEvent(device=text, **args))
elif msg_type == 'device_unbind':
self._bus.post(ZigbeeMqttDeviceUnbindEvent(device=text, **args))
elif msg_type == 'device_group_add':
self._bus.post(ZigbeeMqttGroupAddedEvent(group=text, **args))
elif msg_type == 'device_group_add_failed':
self._bus.post(ZigbeeMqttGroupAddedFailedEvent(group=text, **args))
elif msg_type == 'device_group_remove':
self._bus.post(ZigbeeMqttGroupRemovedEvent(group=text, **args))
elif msg_type == 'device_group_remove_failed':
self._bus.post(ZigbeeMqttGroupRemovedFailedEvent(group=text, **args))
elif msg_type == 'device_group_remove_all':
self._bus.post(ZigbeeMqttGroupRemoveAllEvent(group=text, **args))
elif msg_type == 'device_group_remove_all_failed':
self._bus.post(ZigbeeMqttGroupRemoveAllFailedEvent(group=text, **args))
elif msg_type == 'zigbee_publish_error':
self.logger.error('zigbee2mqtt error: {}'.format(text))
self._bus.post(ZigbeeMqttErrorEvent(error=text, **args))
elif msg.get('level') in ['warning', 'error']:
log = getattr(self.logger, msg['level'])
log(
'zigbee2mqtt {}: {}'.format(
msg['level'], text or msg.get('error', msg.get('warning'))
)
)
def _process_devices(self, client: MqttClient, msg):
"""
Process a list of devices received on the zigbee2mqtt bridge.
"""
devices_info = {
device.get('friendly_name', device.get('ieee_address')): device
for device in msg
}
# Subscribe to updates from all the known devices
event_args = {'host': client.host, 'port': client.port}
client.subscribe(
*[self.topic_prefix + '/' + device for device in devices_info.keys()]
)
for name, device in devices_info.items():
# If we haven't cached this device yet, then notify about the
# connection of a new device.
if not self._info.devices.get(name):
self._bus.post(
ZigbeeMqttDeviceConnectedEvent(device=name, **event_args)
)
# Send a request to fetch all the known properties of this device
exposes = (device.get('definition', {}) or {}).get('exposes', [])
payload = self._build_device_get_request(exposes)
if payload:
client.publish(
self.topic_prefix + '/' + name + '/get',
json.dumps(payload),
)
# Send a request to fetch all the known properties of this device
for name in self._info.devices.by_name.copy():
if name not in devices_info:
self._bus.post(ZigbeeMqttDeviceRemovedEvent(device=name, **event_args))
self._info.devices.remove(name)
for dev in devices_info.values():
self._info.devices.add(dev)
def _process_groups(self, client: MqttClient, msg):
"""
Process an MQTT message containing an updated list of groups.
"""
event_args = {'host': client.host, 'port': client.port}
groups_info = {
group.get('friendly_name', group.get('id')): group for group in msg
}
# Trigger ZigbeeMqttGroupAddedEvent for each new group
for name in groups_info.keys():
if name not in self._info.groups:
self._bus.post(ZigbeeMqttGroupAddedEvent(group=name, **event_args))
# Trigger ZigbeeMqttGroupRemovedEvent for each removed group
for name in self._info.groups.copy():
if name not in groups_info:
self._bus.post(ZigbeeMqttGroupRemovedEvent(group=name, **event_args))
del self._info.groups[name]
# Reset the groups cache
self._info.groups = {group: {} for group in groups_info.keys()}
def _process_property_update(self, device_name: str, properties: Mapping):
"""
Process an MQTT message containing a device property update.
It will appropriately forward an
:class:`platypush.message.event.entities.EntityUpdateEvent` to the bus.
"""
device_info = self._info.devices.get(device_name)
if not (device_info and properties):
return
self.publish_entities(
[
{
**device_info,
'state': properties,
}
]
)
# vim:sw=4:ts=4:et: