From a1cf671334b492528dbf5d6cb2b3f6dd81c67007 Mon Sep 17 00:00:00 2001 From: Fabio Manganiello Date: Sun, 30 Oct 2022 11:03:22 +0100 Subject: [PATCH] Added support for link_quality entities to `zigbee.mqtt` --- .../panels/Entities/LinkQuality.vue | 64 +++++++++++++++++++ .../src/components/panels/Entities/meta.json | 8 +++ platypush/entities/batteries.py | 14 +--- platypush/entities/linkquality.py | 27 ++++++++ platypush/entities/sensors.py | 1 + platypush/plugins/zigbee/mqtt/__init__.py | 61 ++++++++++++++++-- 6 files changed, 158 insertions(+), 17 deletions(-) create mode 100644 platypush/backend/http/webapp/src/components/panels/Entities/LinkQuality.vue create mode 100644 platypush/entities/linkquality.py diff --git a/platypush/backend/http/webapp/src/components/panels/Entities/LinkQuality.vue b/platypush/backend/http/webapp/src/components/panels/Entities/LinkQuality.vue new file mode 100644 index 000000000..4d9d76b7b --- /dev/null +++ b/platypush/backend/http/webapp/src/components/panels/Entities/LinkQuality.vue @@ -0,0 +1,64 @@ + + + + + diff --git a/platypush/backend/http/webapp/src/components/panels/Entities/meta.json b/platypush/backend/http/webapp/src/components/panels/Entities/meta.json index 42c32de6d..7e90c5670 100644 --- a/platypush/backend/http/webapp/src/components/panels/Entities/meta.json +++ b/platypush/backend/http/webapp/src/components/panels/Entities/meta.json @@ -39,6 +39,14 @@ } }, + "link_quality": { + "name": "Link Quality", + "name_plural": "Link Qualities", + "icon": { + "class": "fas fa-signal" + } + }, + "switch": { "name": "Switch", "name_plural": "Switches", diff --git a/platypush/entities/batteries.py b/platypush/entities/batteries.py index 3eaacc54b..4c806f32d 100644 --- a/platypush/entities/batteries.py +++ b/platypush/entities/batteries.py @@ -10,19 +10,9 @@ if not entity_types_registry.get('Battery'): __tablename__ = 'battery' def __init__( - self, - *args, - value, - unit: str = '%', - min: float = 0, - max: float = 100, - **kwargs + self, *args, unit: str = '%', min: float = 0, max: float = 100, **kwargs ): - super().__init__(*args, **kwargs) - self.value = float(value) - self.unit = unit - self.min = min - self.max = max + super().__init__(*args, min=min, max=max, unit=unit, **kwargs) id = Column( Integer, ForeignKey(NumericSensor.id, ondelete='CASCADE'), primary_key=True diff --git a/platypush/entities/linkquality.py b/platypush/entities/linkquality.py new file mode 100644 index 000000000..c314940a5 --- /dev/null +++ b/platypush/entities/linkquality.py @@ -0,0 +1,27 @@ +from sqlalchemy import Column, Integer, ForeignKey + +from .devices import entity_types_registry +from .sensors import NumericSensor + + +if not entity_types_registry.get('LinkQuality'): + + class LinkQuality(NumericSensor): + __tablename__ = 'link_quality' + + def __init__( + self, *args, unit: str = '%', min: float = 0, max: float = 100, **kwargs + ): + super().__init__(*args, min=min, max=max, unit=unit, **kwargs) + + id = Column( + Integer, ForeignKey(NumericSensor.id, ondelete='CASCADE'), primary_key=True + ) + + __mapper_args__ = { + 'polymorphic_identity': __tablename__, + } + + entity_types_registry['LinkQuality'] = LinkQuality +else: + LinkQuality = entity_types_registry['LinkQuality'] diff --git a/platypush/entities/sensors.py b/platypush/entities/sensors.py index 16e3f33cc..abc998d9c 100644 --- a/platypush/entities/sensors.py +++ b/platypush/entities/sensors.py @@ -33,6 +33,7 @@ if not entity_types_registry.get('NumericSensor'): value = Column(Numeric) min = Column(Numeric) max = Column(Numeric) + unit = Column(String) __mapper_args__ = { 'polymorphic_identity': __tablename__, diff --git a/platypush/plugins/zigbee/mqtt/__init__.py b/platypush/plugins/zigbee/mqtt/__init__.py index ff495666a..c1818c83b 100644 --- a/platypush/plugins/zigbee/mqtt/__init__.py +++ b/platypush/plugins/zigbee/mqtt/__init__.py @@ -7,13 +7,14 @@ from typing import Optional, List, Any, Dict, Union from platypush.entities import manages from platypush.entities.batteries import Battery from platypush.entities.lights import Light +from platypush.entities.linkquality import LinkQuality from platypush.entities.switches import Switch from platypush.message import Mapping from platypush.message.response import Response from platypush.plugins.mqtt import MqttPlugin, action -@manages(Light, Switch, Battery) +@manages(Light, Switch, LinkQuality, Battery) class ZigbeeMqttPlugin(MqttPlugin): # lgtm [py/missing-call-to-init] """ This plugin allows you to interact with Zigbee devices over MQTT through any Zigbee sniffer and @@ -187,6 +188,7 @@ class ZigbeeMqttPlugin(MqttPlugin): # lgtm [py/missing-call-to-init] light_info = self._get_light_meta(dev) switch_info = self._get_switch_meta(dev) battery_info = self._get_battery_meta(dev) + link_quality_info = self._get_link_quality_meta(dev) if light_info: converted_entities.append( @@ -246,6 +248,8 @@ class ZigbeeMqttPlugin(MqttPlugin): # lgtm [py/missing-call-to-init] == switch_info['value_on'], description=dev_def.get("description"), data=dev_info, + is_read_only=link_quality_info['is_read_only'], + is_write_only=link_quality_info['is_write_only'], ) ) @@ -254,10 +258,28 @@ class ZigbeeMqttPlugin(MqttPlugin): # lgtm [py/missing-call-to-init] Battery( id=dev['ieee_address'], name=battery_info.get('friendly_name'), - value=dev.get('battery'), + value=dev.get('state', {}).get('battery'), description=battery_info.get('description'), min=battery_info['min'], max=battery_info['max'], + is_read_only=battery_info['is_read_only'], + is_write_only=battery_info['is_write_only'], + data=dev_info, + ) + ) + + if link_quality_info: + converted_entities.append( + LinkQuality( + id=dev['ieee_address'], + name=link_quality_info.get('friendly_name'), + value=dev.get('state', {}).get('linkquality'), + description=link_quality_info.get('description'), + min=link_quality_info['min'], + max=link_quality_info['max'], + unit=link_quality_info['unit'], + is_read_only=link_quality_info['is_read_only'], + is_write_only=link_quality_info['is_write_only'], data=dev_info, ) ) @@ -1455,13 +1477,15 @@ class ZigbeeMqttPlugin(MqttPlugin): # lgtm [py/missing-call-to-init] return { 'friendly_name': ( device_info.get('friendly_name', '[Unnamed device]') - + ' [Battery]' + + ' [' + + feature.get('description', 'Battery') + + ']' ), 'ieee_address': device_info.get('friendly_name'), 'property': feature['property'], 'description': feature.get('description'), - 'value_min': feature.get('value_min', 0), - 'value_max': feature.get('value_max', 100), + 'min': feature.get('value_min', 0), + 'max': feature.get('value_max', 100), 'unit': feature.get('unit', '%'), 'is_read_only': not bool(feature.get('access', 0) & 2), 'is_write_only': not bool(feature.get('access', 0) & 1), @@ -1469,6 +1493,33 @@ class ZigbeeMqttPlugin(MqttPlugin): # lgtm [py/missing-call-to-init] return {} + @staticmethod + def _get_link_quality_meta(device_info: dict) -> dict: + exposes = (device_info.get('definition', {}) or {}).get('exposes', []) + for exposed in exposes: + if ( + exposed.get('property') == 'linkquality' + and exposed.get('type') == 'numeric' + ): + return { + 'friendly_name': ( + device_info.get('friendly_name', '[Unnamed device]') + + ' [' + + exposed.get('description', 'Link Quality') + + ']' + ), + 'ieee_address': device_info.get('friendly_name'), + 'property': exposed['property'], + 'description': exposed.get('description'), + 'min': exposed.get('value_min', 0), + 'max': exposed.get('value_max', 100), + 'unit': exposed.get('unit', '%'), + 'is_read_only': not bool(exposed.get('access', 0) & 2), + 'is_write_only': not bool(exposed.get('access', 0) & 1), + } + + return {} + @staticmethod def _get_light_meta(device_info: dict) -> dict: exposes = (device_info.get('definition', {}) or {}).get('exposes', [])