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

autodoc fixes

This commit is contained in:
Fabio Manganiello 2021-05-08 21:38:32 +02:00
parent 5ca15937e3
commit 46aef7c8b5
1 changed files with 148 additions and 146 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

10
platypush/plugins/zwave/mqtt.py
View File

@ -448,6 +448,7 @@ class ZwaveMqttPlugin(MqttPlugin, ZwaveBasePlugin):
def status(self, **kwargs) -> Dict[str, Any]: def status(self, **kwargs) -> Dict[str, Any]:
""" """
Get the status of the controller. Get the status of the controller.
:param kwargs: Extra arguments to be passed to :meth:`platypush.plugins.mqtt.MqttPlugin.publish`` :param kwargs: Extra arguments to be passed to :meth:`platypush.plugins.mqtt.MqttPlugin.publish``
(default: query the default configured device). (default: query the default configured device).
:return: dict with the following fields: ``device`` and ``state``. :return: dict with the following fields: ``device`` and ``state``.
@ -973,7 +974,7 @@ class ZwaveMqttPlugin(MqttPlugin, ZwaveBasePlugin):
def node_update_neighbours(self, node_id: Optional[int] = None, node_name: Optional[str] = None, **kwargs): def node_update_neighbours(self, node_id: Optional[int] = None, node_name: Optional[str] = None, **kwargs):
""" """
Ask a node to update its neighbours table Ask a node to update its neighbours table
(same as :method:`platypush.plugins.zwave.mqtt.ZwaveMqttPlugin.node_heal`). (same as :meth:`platypush.plugins.zwave.mqtt.ZwaveMqttPlugin.node_heal`).
:param node_id: Select node by node_id. :param node_id: Select node by node_id.
:param node_name: Select node by label. :param node_name: Select node by label.
@ -986,7 +987,7 @@ class ZwaveMqttPlugin(MqttPlugin, ZwaveBasePlugin):
def node_network_update(self, node_id: Optional[int] = None, node_name: Optional[str] = None, **kwargs): def node_network_update(self, node_id: Optional[int] = None, node_name: Optional[str] = None, **kwargs):
""" """
Update the controller with network information Update the controller with network information
(same as :method:`platypush.plugins.zwave.mqtt.ZwaveMqttPlugin.node_heal`). (same as :meth:`platypush.plugins.zwave.mqtt.ZwaveMqttPlugin.node_heal`).
:param node_id: Select node by node_id. :param node_id: Select node by node_id.
:param node_name: Select node by label. :param node_name: Select node by label.
@ -1171,6 +1172,7 @@ class ZwaveMqttPlugin(MqttPlugin, ZwaveBasePlugin):
def get_groups(self, **kwargs) -> Dict[str, dict]: def get_groups(self, **kwargs) -> Dict[str, dict]:
""" """
Get the groups on the network. Get the groups on the network.
:param kwargs: Extra arguments to be passed to :meth:`platypush.plugins.mqtt.MqttPlugin.publish`` :param kwargs: Extra arguments to be passed to :meth:`platypush.plugins.mqtt.MqttPlugin.publish``
(default: query the default configured device). (default: query the default configured device).
@ -1183,7 +1185,7 @@ class ZwaveMqttPlugin(MqttPlugin, ZwaveBasePlugin):
"label": "Motion", "label": "Motion",
"multichannel": true, "multichannel": true,
"max_associations": 10, "max_associations": 10,
'group_id': '2-2', "group_id": "2-2",
"node_id": 2, "node_id": 2,
"index": 2, "index": 2,
"associations": [ "associations": [
@ -1195,7 +1197,7 @@ class ZwaveMqttPlugin(MqttPlugin, ZwaveBasePlugin):
"label": "Tamper", "label": "Tamper",
"multichannel": true, "multichannel": true,
"max_associations": 10, "max_associations": 10,
'group_id': '5-3', "group_id": "5-3",
"node_id": 5, "node_id": 5,
"index": 3, "index": 3,
"associations": [ "associations": [