diff --git a/platypush/message/event/zigbee/mqtt.py b/platypush/message/event/zigbee/mqtt.py
index 8a473ab9af..e3179407f6 100644
--- a/platypush/message/event/zigbee/mqtt.py
+++ b/platypush/message/event/zigbee/mqtt.py
@@ -1,4 +1,4 @@
-from typing import Optional, Dict, Any
+from typing import Dict, Any
from platypush.message.event import Event
@@ -108,7 +108,7 @@ class ZigbeeMqttGroupAddedEvent(ZigbeeMqttEvent):
Triggered when a group is added.
"""
def __init__(self, host: str, port: int, group=None, *args, **kwargs):
- super().__init__(*args, host=host, port=port, device=device, **kwargs)
+ super().__init__(*args, host=host, port=port, group=group, **kwargs)
class ZigbeeMqttGroupAddedFailedEvent(ZigbeeMqttEvent):
@@ -116,7 +116,7 @@ class ZigbeeMqttGroupAddedFailedEvent(ZigbeeMqttEvent):
Triggered when a request to add a group fails.
"""
def __init__(self, host: str, port: int, group=None, *args, **kwargs):
- super().__init__(*args, host=host, port=port, device=device, **kwargs)
+ super().__init__(*args, host=host, port=port, group=group, **kwargs)
class ZigbeeMqttGroupRemovedEvent(ZigbeeMqttEvent):
@@ -124,7 +124,7 @@ class ZigbeeMqttGroupRemovedEvent(ZigbeeMqttEvent):
Triggered when a group is removed.
"""
def __init__(self, host: str, port: int, group=None, *args, **kwargs):
- super().__init__(*args, host=host, port=port, device=device, **kwargs)
+ super().__init__(*args, host=host, port=port, group=group, **kwargs)
class ZigbeeMqttGroupRemovedFailedEvent(ZigbeeMqttEvent):
@@ -132,7 +132,7 @@ class ZigbeeMqttGroupRemovedFailedEvent(ZigbeeMqttEvent):
Triggered when a request to remove a group fails.
"""
def __init__(self, host: str, port: int, group=None, *args, **kwargs):
- super().__init__(*args, host=host, port=port, device=device, **kwargs)
+ super().__init__(*args, host=host, port=port, group=group, **kwargs)
class ZigbeeMqttGroupRemoveAllEvent(ZigbeeMqttEvent):
@@ -140,7 +140,7 @@ class ZigbeeMqttGroupRemoveAllEvent(ZigbeeMqttEvent):
Triggered when all the devices are removed from a group.
"""
def __init__(self, host: str, port: int, group=None, *args, **kwargs):
- super().__init__(*args, host=host, port=port, device=device, **kwargs)
+ super().__init__(*args, host=host, port=port, group=group, **kwargs)
class ZigbeeMqttGroupRemoveAllFailedEvent(ZigbeeMqttEvent):
@@ -148,7 +148,7 @@ class ZigbeeMqttGroupRemoveAllFailedEvent(ZigbeeMqttEvent):
Triggered when a request to remove all the devices from a group fails.
"""
def __init__(self, host: str, port: int, group=None, *args, **kwargs):
- super().__init__(*args, host=host, port=port, device=device, **kwargs)
+ super().__init__(*args, host=host, port=port, group=group, **kwargs)
class ZigbeeMqttErrorEvent(ZigbeeMqttEvent):
diff --git a/platypush/message/response/__init__.py b/platypush/message/response/__init__.py
index 67629e0d86..7488dc4b7e 100644
--- a/platypush/message/response/__init__.py
+++ b/platypush/message/response/__init__.py
@@ -66,7 +66,7 @@ class Response(Message):
Overrides the str() operator and converts
the message into a UTF-8 JSON string
"""
- output = self.output if self.output is not None and self.output != {} else {
+ output = self.output if self.output is not None else {
'success': True if not self.errors else False
}
diff --git a/platypush/plugins/zigbee/mqtt.py b/platypush/plugins/zigbee/mqtt.py
index 180a413a13..6df4ebf87f 100644
--- a/platypush/plugins/zigbee/mqtt.py
+++ b/platypush/plugins/zigbee/mqtt.py
@@ -92,12 +92,12 @@ class ZigbeeMqttPlugin(MqttPlugin):
"""
- def __init__(self, host: str, port: int = 1883, base_topic: str = 'zigbee2mqtt', timeout: int = 60,
+ def __init__(self, host: str = 'localhost', port: int = 1883, base_topic: str = 'zigbee2mqtt', timeout: int = 60,
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 host: Default MQTT broker where ``zigbee2mqtt`` publishes its messages (default: ``localhost``).
:param port: Broker listen port (default: 1883).
:param base_topic: Topic prefix, as specified in ``/opt/zigbee2mqtt/data/configuration.yaml``
(default: '``base_topic``').
@@ -305,6 +305,15 @@ class ZigbeeMqttPlugin(MqttPlugin):
: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
+
+ # noinspection PyUnresolvedReferences
+ devices = self.devices().output
+ assert not [dev for dev in devices if dev.get('friendly_name') == name], \
+ 'A device named {} already exists on the network'.format(name)
+
self.publish(
topic=self._topic('bridge/config/rename{}'.format('_last' if not device else '')),
msg={'old': device, 'new': name} if device else name,
@@ -333,7 +342,7 @@ class ZigbeeMqttPlugin(MqttPlugin):
return properties
- # noinspection PyShadowingBuiltins
+ # noinspection PyShadowingBuiltins,DuplicatedCode
@action
def device_set(self, device: str, property: str, value: Any, **kwargs):
"""
@@ -372,6 +381,37 @@ class ZigbeeMqttPlugin(MqttPlugin):
reply_topic=self._topic(device), msg=device, **self._mqtt_args(**kwargs)).\
output.get('group_list', [])
+ @action
+ def groups(self, **kwargs):
+ """
+ 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).
+ """
+ groups = self.publish(topic=self._topic('bridge/config/groups'), msg={},
+ reply_topic=self._topic('bridge/log'),
+ **self._mqtt_args(**kwargs)).output.get('message', [])
+
+ # noinspection PyUnresolvedReferences
+ devices = {
+ device['ieeeAddr']: device
+ for device in self.devices(**kwargs).output
+ }
+
+ return [
+ {
+ 'id': group['ID'],
+ 'friendly_name': group['friendly_name'],
+ 'optimistic': group.get('optimistic', False),
+ 'devices': [
+ devices[device.split('/')[0]]
+ for device in group.get('devices', [])
+ ]
+ }
+ for group in groups
+ ]
+
@action
def group_add(self, name: str, id: Optional[int] = None, **kwargs):
"""
@@ -388,6 +428,53 @@ class ZigbeeMqttPlugin(MqttPlugin):
self.publish(topic=self._topic('bridge/config/add_group'), msg=args, **self._mqtt_args(**kwargs))
+ # noinspection PyShadowingBuiltins,DuplicatedCode
+ @action
+ def group_set(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.publish(topic=self._topic(group + '/set'),
+ reply_topic=self._topic(group),
+ msg={property: value}, **self._mqtt_args(**kwargs)).output
+
+ if property:
+ assert property in properties, '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
+
+ # noinspection PyUnresolvedReferences
+ groups = {group.get('friendly_name'): group for group in self.groups().output}
+ assert name not in groups, 'A group named {} already exists on the network'.format(name)
+
+ self.publish(
+ topic=self._topic('bridge/config/rename'),
+ msg={'old': group, 'new': name} if group else name,
+ **self._mqtt_args(**kwargs))
+
@action
def group_remove(self, name: str, **kwargs):
"""