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: 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

4
docs/quickstart.rst
View File

@@ -65,8 +65,6 @@ For continuous operation, use a cyclic loop:
import revpimodio2
rpi = revpimodio2.RevPiModIO(autorefresh=True)
def main_cycle(ct: revpimodio2.Cycletools):
"""Called every cycle (default: 20-50ms)."""
@@ -91,7 +89,7 @@ For continuous operation, use a cyclic loop:
print("Program stopped")
# Run cyclic loop
rpi.cycleloop(main_cycle)
revpimodio2.run_plc(main_cycle)
Event-Driven Program
--------------------