Added `Documentation` and `Source` links to `setup.py` under
`project_urls`. Updated README with a link to the official
documentation.
Signed-off-by: Sven Sager <akira@narux.de>
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>
The Read the Docs build fails because the "docs" extra is referenced in
.readthedocs.yaml but not defined in setup.py, so sphinx_rtd_theme is
never installed.
Signed-off-by: Nicolai Buchwitz <n.buchwitz@kunbus.com>
Cleaned up excessive indentation and unnecessary spacing in docstrings
and comments across multiple files to improve code readability and
maintain consistency.
Signed-off-by: Sven Sager <akira@narux.de>
Reformatted docstrings across device.py, helper.py, and io.py to honor
the 100 character line width limit, improving readability and
consistency with project formatting standards.
Added :inherited-members: to autodoc_default_options in conf.py
so all classes automatically show inherited methods and attributes
from their base classes. This makes Connect5 show members from
GatewayMixin and ModularBaseConnect_4_5, for example.
Replaced German terms with English equivalents:
- Zustand → state
- vom → of the
- Ausgang → output
- Sekunden → seconds
- toggeln → toggle
- from → off
- gruen → green
- rot/root → red
- blau → blue
Created topic-based documentation:
- basics.rst: core concepts and fundamental usage
- cyclic_programming.rst: PLC-style programming with Cycletools
- event_programming.rst: event-driven patterns and callbacks
- advanced.rst: gateway IOs, replace_io_file, watchdog management
- installation.rst and quickstart.rst: getting started guides
Added complete API reference in docs/api/:
- All device classes including ModularBaseConnect_4_5 and GatewayMixin
- I/O, helper, and main class documentation
Enhanced Sphinx configuration with RTD theme and improved autodoc settings.
Removed auto-generated modules.rst and revpimodio2.rst.
Translate all inline comments, docstrings, and documentation from German to English across the codebase to improve accessibility for international developers.
Fixes#27
Signed-off-by: Nicolai Buchwitz <n.buchwitz@kunbus.com>
The tests for the default path of the config.rsc are now performed
optionally. If write permission exists for the standard paths, the
tests are performed with the config.rsc.
This context manager can delete the entire instance of ModIO when using
`with rpi:` after creating an instance of ModIO by
`rpi = revpimodio.RevPiModIO(...)`.
On the Connect 4, the hardware watchdog was removed from the process
image by KUNBUS. To use the hardware watchdog, other functions must now
be used that are not implemented by RevPiModIO.
The LED colors for the A1-A5 objects of the .core class of the connect 4
did not match the values of the constants for GREEN and RED, as on all
other RevPi Devices. In addition, the color BLUE was added.
