revpi/revpimodio2
1
0
Fork 0
mirror of https://github.com/naruxde/revpimodio2.git synced 2026-03-31 15:08:09 +02:00
Code Issues Packages Releases Wiki Activity

docs: improve watchdog toggle terminology and formatting

Browse Source 
Changed 'Autowatchdog' to 'automatic watchdog toggle' for clarity.
Fixed inconsistent indentation in _set_wdtoggle docstring.
This commit is contained in:
Nicolai Buchwitz
2026-02-03 16:18:47 +01:00
committed by Sven Sager
parent e7d5bd9fdf
commit 4892adaeff
1 changed files with 5 additions and 5 deletions
Download Patch File Download Diff File Expand all files Collapse all files

10
src/revpimodio2/device.py
View File

@@ -1013,9 +1013,9 @@ class Connect(Core):
def _get_wdtoggle(self) -> bool:
"""
Retrieves the value for Autowatchdog.
Retrieves the automatic watchdog toggle status.
:return: True if autowatchdog is active
:return: True if automatic watchdog toggle is active
"""
return self.__th_wdtoggle is not None and self.__th_wdtoggle.is_alive()
@@ -1033,14 +1033,14 @@ class Connect(Core):
def _set_wdtoggle(self, value: bool) -> None:
"""
Sets the value for autowatchdog.
Sets the automatic watchdog toggle.
If this value is set to True, the necessary bit to toggle the watchdog is switched between True and False every 10 seconds in the background.
If this value is set to True, the necessary bit to toggle the watchdog is switched between True and False every 10 seconds in the background.
This bit is automatically written to the process image with autorefresh=True.
IMPORTANT: If autorefresh=False, .writeprocimg() must be called cyclically to write the value to the process image!!!
:param value: True to activate, False to terminate
:param value: True to activate, False to terminate
"""
if self._modio._monitoring:
raise RuntimeError("can not toggle watchdog, while system is in monitoring mode")