ITQC/pydase
24
0
Fork 0
mirror of https://github.com/tiqi-group/pydase.git synced 2025-04-20 08:20:02 +02:00
Code Issues Packages Projects Releases Wiki Activity

updates DeviceConnection docstring

Browse Source
This commit is contained in:
Mose Müller 2024-01-23 16:49:34 +01:00
parent e78dc2defb
commit 71b84525dd
1 changed files with 7 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

8
src/pydase/components/device_connection/device_connection.py
View File

@ -15,7 +15,13 @@ class DeviceConnection(pydase.DataService, ABC):
connection status.
An instance of this class automatically starts a task that periodically checks the
device's availability and attempts reconnection if necessary.
device's availability and attempts reconnection if necessary. The periodicity can be
controlled by setting `self._handle_connection_wait_time`, e.g.
>>> class MyConnection(pydase.components.DeviceConnection):
... def __init__(self) -> None:
... self._handle_connection_wait_time = 20.0 # only check every 20 seconds
... ...
In the frontend, this class is represented without directly exposing the `connect`
method and `connected` attribute. Instead, it displays user-defined attributes,