platypush/platypush
platypush
/
platypush
2
2
Fork 4
Code Issues 38 Pull Requests Packages Projects 4 Releases Wiki Activity

`vl53l1x` plugin migrated to the new `SensorPlugin` interface.

This commit is contained in:
Fabio Manganiello 2023-04-01 19:31:13 +02:00
parent 6a5a5de03e
commit 7912a59ff8
Signed by: blacklight
GPG Key ID: D90FBA7F76362774
1 changed files with 4 additions and 46 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

50
platypush/plugins/sensor/distance/vl53l1x/__init__.py
View File

@ -3,16 +3,13 @@ from threading import RLock
from typing import List, Mapping from typing import List, Mapping
from typing_extensions import override from typing_extensions import override
from platypush.context import get_bus
from platypush.entities.managers.sensors import SensorEntityManager
from platypush.entities.devices import Device from platypush.entities.devices import Device
from platypush.entities.distance import DistanceSensor from platypush.entities.distance import DistanceSensor
from platypush.message.event.sensor import SensorDataChangeEvent from platypush.plugins.sensor import SensorPlugin
from platypush.plugins import RunnablePlugin, action
from platypush.utils import get_plugin_name_by_class
class SensorDistanceVl53l1xPlugin(RunnablePlugin, SensorEntityManager): # pylint: disable=too-many-ancestors
class SensorDistanceVl53l1xPlugin(SensorPlugin):
""" """
Plugin to interact with an `VL53L1x Plugin to interact with an `VL53L1x
<https://www.st.com/en/imaging-and-photonics-solutions/vl53l1x.html>`_ <https://www.st.com/en/imaging-and-photonics-solutions/vl53l1x.html>`_
@ -68,13 +65,8 @@ class SensorDistanceVl53l1xPlugin(RunnablePlugin, SensorEntityManager):
self._device.close() self._device.close()
self._device = None self._device = None
@action
@override @override
def status(self, *_, **__): def get_measurement(self, *_, short=True, medium=True, long=True, **__):
self.publish_entities(self._last_data)
return self._last_data
def _status(self, *_, short=True, medium=True, long=True, **__):
""" """
:param short: Enable short range measurement (default: True) :param short: Enable short range measurement (default: True)
:param medium: Enable medium range measurement (default: True) :param medium: Enable medium range measurement (default: True)
@ -117,20 +109,6 @@ class SensorDistanceVl53l1xPlugin(RunnablePlugin, SensorEntityManager):
return ret return ret
@action
def get_data(self, *args, **kwargs):
"""
(Deprecated) alias for :meth:`.status`.
"""
return self.status(*args, **kwargs)
@action
def get_measurement(self, *args, **kwargs):
"""
(Deprecated) alias for :meth:`.status`.
"""
return self.status(*args, **kwargs)
@override @override
def transform_entities(self, entities: Mapping[str, int]) -> List[Device]: def transform_entities(self, entities: Mapping[str, int]) -> List[Device]:
return super().transform_entities( # type: ignore return super().transform_entities( # type: ignore
@ -151,25 +129,5 @@ class SensorDistanceVl53l1xPlugin(RunnablePlugin, SensorEntityManager):
] ]
) )
@override
def publish_entities(self, entities: Mapping[str, int], *_, **__) -> List[Device]:
get_bus().post(
SensorDataChangeEvent(
data=entities,
source=get_plugin_name_by_class(self.__class__),
)
)
return super().publish_entities(entities) # type: ignore
@override
def main(self):
while not self.should_stop():
status = self._status()
if status != self._last_data:
self.publish_entities(status)
self._last_data = status
self.wait_stop(self.poll_interval)
# vim:sw=4:ts=4:et: # vim:sw=4:ts=4:et: