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

docs: Update documentation for improved clarity and consistency

Browse Source 
Revised various sections across multiple documentation files to reflect
updated methods (`run_plc` replacing manual setup with `cycleloop`) and
adjust for new default parameters (e.g., `autorefresh`). Enhanced
descriptions for timers, Cycletools usage, and new method explanations.
Removed outdated or redundant examples and updated system requirements.

Signed-off-by: Sven Sager <akira@narux.de>
This commit is contained in:
Sven Sager
2026-02-17 12:05:58 +01:00
parent bae85e1b09
commit 3294c5e980
7 changed files with 71 additions and 314 deletions
Download Patch File Download Diff File Expand all files Collapse all files

9
docs/basics.rst
View File

@@ -78,10 +78,11 @@ Adjust cycle time to match your needs:
.. code-block:: python
rpi = revpimodio2.RevPiModIO(autorefresh=True)
rpi = revpimodio2.RevPiModIO()
rpi.cycletime = 100 # Set to 100ms
rpi.autorefresh_all()
**Important:** Faster cycle times consume more CPU. Choose the slowest cycle time that meets your requirements.
**Important:** Faster cycle times consume more CPU. Choose the slowest cycle time that meets your requirements. Default values will fit most needs.
Error Handling
--------------
@@ -90,10 +91,10 @@ Configure I/O error threshold:
.. code-block:: python
rpi.maxioerrors = 10 # Raise exception after 10 errors
maxioerrors = 10 # Raise exception after 10 errors
# Check error count
if rpi.ioerrors > 5:
if rpi.core.ioerrorcount > maxioerrors:
print("Warning: I/O errors detected")
Core Objects