From 11ceb6f4a2990f6a17e8e4d60e80f14127d13799 Mon Sep 17 00:00:00 2001 From: Akira Naru Takizawa Date: Sun, 20 Oct 2019 14:30:36 +0200 Subject: [PATCH] Added Cycletools to __init__ and Switched VCS and IDE Switched from Mercurial to GIT Switched from eric6 to pyCharm --- .gitignore | 118 ++ .hgignore | 23 - .idea/$CACHE_FILE$ | 17 + .idea/.gitignore | 2 + .../inspectionProfiles/profiles_settings.xml | 6 + .idea/misc.xml | 7 + .idea/modules.xml | 8 + .idea/revpimodio2.iml | 11 + .idea/vcs.xml | 6 + doc/index-revpimodio2.html | 53 - doc/index.html | 20 - doc/revpimodio2.__init__.html | 116 -- doc/revpimodio2.app.html | 76 - doc/revpimodio2.device.html | 1304 ----------------- doc/revpimodio2.helper.html | 578 -------- doc/revpimodio2.io.html | 1116 -------------- doc/revpimodio2.modio.html | 799 ---------- doc/revpimodio2.netio.html | 806 ---------- doc/revpimodio2.summary.html | 76 - docs/Makefile | 20 + docs/conf.py | 174 +++ docs/index.rst | 20 + docs/modules.rst | 7 + docs/revpimodio2.rst | 70 + eric-revpimodio2.api | 232 --- eric-revpimodio2.bas | 21 - revpimodio2.e4p | 428 ------ revpimodio2/__init__.py | 4 +- revpimodio2/modio.py | 2 +- 29 files changed, 470 insertions(+), 5650 deletions(-) create mode 100644 .gitignore delete mode 100644 .hgignore create mode 100644 .idea/$CACHE_FILE$ create mode 100644 .idea/.gitignore create mode 100644 .idea/inspectionProfiles/profiles_settings.xml create mode 100644 .idea/misc.xml create mode 100644 .idea/modules.xml create mode 100644 .idea/revpimodio2.iml create mode 100644 .idea/vcs.xml delete mode 100644 doc/index-revpimodio2.html delete mode 100644 doc/index.html delete mode 100644 doc/revpimodio2.__init__.html delete mode 100644 doc/revpimodio2.app.html delete mode 100644 doc/revpimodio2.device.html delete mode 100644 doc/revpimodio2.helper.html delete mode 100644 doc/revpimodio2.io.html delete mode 100644 doc/revpimodio2.modio.html delete mode 100644 doc/revpimodio2.netio.html delete mode 100644 doc/revpimodio2.summary.html create mode 100644 docs/Makefile create mode 100644 docs/conf.py create mode 100644 docs/index.rst create mode 100644 docs/modules.rst create mode 100644 docs/revpimodio2.rst delete mode 100644 eric-revpimodio2.api delete mode 100644 eric-revpimodio2.bas delete mode 100644 revpimodio2.e4p diff --git a/.gitignore b/.gitignore new file mode 100644 index 0000000..a5114a4 --- /dev/null +++ b/.gitignore @@ -0,0 +1,118 @@ +# ---> Python +# Byte-compiled / optimized / DLL files +__pycache__/ +*.py[cod] +*$py.class + +# C extensions +*.so + +# Distribution / packaging +.Python +build/ +develop-eggs/ +dist/ +downloads/ +eggs/ +.eggs/ +lib/ +lib64/ +parts/ +sdist/ +var/ +wheels/ +*.egg-info/ +.installed.cfg +*.egg +MANIFEST + +# PyInstaller +# Usually these files are written by a python script from a template +# before PyInstaller builds the exe, so as to inject date/other infos into it. +*.manifest +*.spec + +# Installer logs +pip-log.txt +pip-delete-this-directory.txt + +# Unit test / coverage reports +htmlcov/ +.tox/ +.nox/ +.coverage +.coverage.* +.cache +nosetests.xml +coverage.xml +*.cover +.hypothesis/ +.pytest_cache/ + +# Translations +*.mo +*.pot + +# Django stuff: +*.log +local_settings.py +db.sqlite3 + +# Flask stuff: +instance/ +.webassets-cache + +# Scrapy stuff: +.scrapy + +# Sphinx documentation +docs/_build/ + +# PyBuilder +target/ + +# Jupyter Notebook +.ipynb_checkpoints + +# IPython +profile_default/ +ipython_config.py + +# pyenv +.python-version + +# celery beat schedule file +celerybeat-schedule + +# SageMath parsed files +*.sage.py + +# Environments +.env +.venv +env/ +venv/ +ENV/ +env.bak/ +venv.bak/ + +# Spyder project settings +.spyderproject +.spyproject + +# Rope project settings +.ropeproject + +# mkdocs documentation +/site + +# mypy +.mypy_cache/ +.dmypy.json +dmypy.json + +# Pyre type checker +.pyre/ + +/test/ +/make.conf diff --git a/.hgignore b/.hgignore deleted file mode 100644 index daf4e13..0000000 --- a/.hgignore +++ /dev/null @@ -1,23 +0,0 @@ -glob:.eric6project -glob:_eric6project -glob:.eric5project -glob:_eric5project -glob:.eric4project -glob:_eric4project -glob:.ropeproject -glob:_ropeproject -glob:.directory -glob:**.pyc -glob:**.pyo -glob:**.orig -glob:**.bak -glob:**.rej -glob:**~ -glob:cur -glob:tmp -glob:__pycache__ -glob:**.DS_Store -syntax: glob -test/* -deb/* -dist/* diff --git a/.idea/$CACHE_FILE$ b/.idea/$CACHE_FILE$ new file mode 100644 index 0000000..3a1e22c --- /dev/null +++ b/.idea/$CACHE_FILE$ @@ -0,0 +1,17 @@ + + + + + + + + + + + Angular + + + + + + \ No newline at end of file diff --git a/.idea/.gitignore b/.idea/.gitignore new file mode 100644 index 0000000..5c98b42 --- /dev/null +++ b/.idea/.gitignore @@ -0,0 +1,2 @@ +# Default ignored files +/workspace.xml \ No newline at end of file diff --git a/.idea/inspectionProfiles/profiles_settings.xml b/.idea/inspectionProfiles/profiles_settings.xml new file mode 100644 index 0000000..105ce2d --- /dev/null +++ b/.idea/inspectionProfiles/profiles_settings.xml @@ -0,0 +1,6 @@ + + + + \ No newline at end of file diff --git a/.idea/misc.xml b/.idea/misc.xml new file mode 100644 index 0000000..3999087 --- /dev/null +++ b/.idea/misc.xml @@ -0,0 +1,7 @@ + + + + + + \ No newline at end of file diff --git a/.idea/modules.xml b/.idea/modules.xml new file mode 100644 index 0000000..bedb953 --- /dev/null +++ b/.idea/modules.xml @@ -0,0 +1,8 @@ + + + + + + + + \ No newline at end of file diff --git a/.idea/revpimodio2.iml b/.idea/revpimodio2.iml new file mode 100644 index 0000000..c8efcbb --- /dev/null +++ b/.idea/revpimodio2.iml @@ -0,0 +1,11 @@ + + + + + + + + + + \ No newline at end of file diff --git a/.idea/vcs.xml b/.idea/vcs.xml new file mode 100644 index 0000000..94a25f7 --- /dev/null +++ b/.idea/vcs.xml @@ -0,0 +1,6 @@ + + + + + + \ No newline at end of file diff --git a/doc/index-revpimodio2.html b/doc/index-revpimodio2.html deleted file mode 100644 index f3bc051..0000000 --- a/doc/index-revpimodio2.html +++ /dev/null @@ -1,53 +0,0 @@ - - -revpimodio2 - - - -

-revpimodio2

-

-Stellt alle Klassen fuer den RevolutionPi zur Verfuegung. -

-Webpage: https://revpimodio.org/ -

-Stellt Klassen fuer die einfache Verwendung des Revolution Pis der -Kunbus GmbH (https://revolution.kunbus.de/) zur Verfuegung. Alle I/Os werden -aus der piCtory Konfiguration eingelesen und mit deren Namen direkt zugreifbar -gemacht. Fuer Gateways sind eigene IOs ueber mehrere Bytes konfigurierbar -Mit den definierten Namen greift man direkt auf die gewuenschten Daten zu. -Auf alle IOs kann der Benutzer Funktionen als Events registrieren. Diese -fuehrt das Modul bei Datenaenderung aus. -

- - -

-Modules

- - - - - - - - - - - - - - - - - - - - - - - - - - -
revpimodio2Stellt alle Klassen fuer den RevolutionPi zur Verfuegung.
appBildet die App Sektion von piCtory ab.
deviceModul fuer die Verwaltung der Devices.
helperRevPiModIO Helperklassen und Tools.
ioRevPiModIO Modul fuer die Verwaltung der IOs.
modioRevPiModIO Hauptklasse fuer piControl0 Zugriff.
netioRevPiModIO Hauptklasse fuer Netzwerkzugriff.
summaryBildet die Summary-Sektion von piCtory ab.
- \ No newline at end of file diff --git a/doc/index.html b/doc/index.html deleted file mode 100644 index 2e6711c..0000000 --- a/doc/index.html +++ /dev/null @@ -1,20 +0,0 @@ - - -Table of contents - - - -

-Table of contents

- - -

-Packages

- - - - - -
revpimodio2Stellt alle Klassen fuer den RevolutionPi zur Verfuegung.
- - \ No newline at end of file diff --git a/doc/revpimodio2.__init__.html b/doc/revpimodio2.__init__.html deleted file mode 100644 index 1554d3c..0000000 --- a/doc/revpimodio2.__init__.html +++ /dev/null @@ -1,116 +0,0 @@ - - -revpimodio2.__init__ - - - -

-revpimodio2.__init__

-

-Stellt alle Klassen fuer den RevolutionPi zur Verfuegung. -

-Webpage: https://revpimodio.org/ -

-Stellt Klassen fuer die einfache Verwendung des Revolution Pis der -Kunbus GmbH (https://revolution.kunbus.de/) zur Verfuegung. Alle I/Os werden -aus der piCtory Konfiguration eingelesen und mit deren Namen direkt zugreifbar -gemacht. Fuer Gateways sind eigene IOs ueber mehrere Bytes konfigurierbar -Mit den definierten Namen greift man direkt auf die gewuenschten Daten zu. -Auf alle IOs kann der Benutzer Funktionen als Events registrieren. Diese -fuehrt das Modul bei Datenaenderung aus. -

-

-Global Attributes

- - -
BOTH
FALLING
GREEN
INP
MEM
OFF
OUT
RED
RISING
__all__
__author__
__copyright__
__license__
__name__
__version__
-

-Classes

- - - - - -
DeviceNotFoundErrorFehler wenn ein Device nicht gefunden wird.
-

-Functions

- - - - - - - - -
acheckCheck type of given arguments.
consttostrGibt fuer Konstanten zurueck.
-
- -

DeviceNotFoundError

-

-Fehler wenn ein Device nicht gefunden wird. -

-

-Derived from

-Exception -

-Class Attributes

- - -
None
-

-Class Methods

- - -
None
-

-Methods

- - -
None
-

-Static Methods

- - -
None
- -
Up
-
- -

acheck

-acheck(check_type, **kwargs) -

-Check type of given arguments. -

- Use the argument name as keyword and the argument itself as value. -

-
check_type
-
-Type to check -
kwargs
-
-Arguments to check -
-
-
Up
-
- -

consttostr

-consttostr(value) -

-Gibt fuer Konstanten zurueck. -

- Diese Funktion ist erforderlich, da enum in Python 3.2 nicht existiert. -

-
value
-
-Konstantenwert -
-
-
Returns:
-
- Name der Konstanten -
-
-
Up
-
- \ No newline at end of file diff --git a/doc/revpimodio2.app.html b/doc/revpimodio2.app.html deleted file mode 100644 index e96c636..0000000 --- a/doc/revpimodio2.app.html +++ /dev/null @@ -1,76 +0,0 @@ - - -revpimodio2.app - - - -

-revpimodio2.app

-

-Bildet die App Sektion von piCtory ab. -

-

-Global Attributes

- - -
__author__
__copyright__
__license__
-

-Classes

- - - - - -
AppBildet die App Sektion der config.rsc ab.
-

-Functions

- - -
None
-
- -

App

-

-Bildet die App Sektion der config.rsc ab. -

-

-Derived from

-object -

-Class Attributes

- - -
__slots__
-

-Class Methods

- - -
None
-

-Methods

- - - - - -
AppInstantiiert die App-Klasse.
-

-Static Methods

- - -
None
- -

-App (Constructor)

-App(app) -

-Instantiiert die App-Klasse. -

-
app
-
-piCtory Appinformationen -
-
-
Up
-
- \ No newline at end of file diff --git a/doc/revpimodio2.device.html b/doc/revpimodio2.device.html deleted file mode 100644 index 7927204..0000000 --- a/doc/revpimodio2.device.html +++ /dev/null @@ -1,1304 +0,0 @@ - - -revpimodio2.device - - - -

-revpimodio2.device

-

-Modul fuer die Verwaltung der Devices. -

-

-Global Attributes

- - -
__author__
__copyright__
__license__
-

-Classes

- - - - - - - - - - - - - - - - - - - - - - - - - - -
BaseKlasse fuer alle Base-Devices wie Core / Connect usw.
ConnectKlasse fuer den RevPi Connect.
CoreKlasse fuer den RevPi Core.
DeviceBasisklasse fuer alle Device-Objekte.
DeviceListBasisklasse fuer direkten Zugriff auf Device Objekte.
DioModuleStellt ein DIO / DI / DO Modul dar.
GatewayKlasse fuer die RevPi Gateway-Devices.
VirtualKlasse fuer die RevPi Virtual-Devices.
-

-Functions

- - -
None
-
- -

Base

-

-Klasse fuer alle Base-Devices wie Core / Connect usw. -

-

-Derived from

-Device -

-Class Attributes

- - -
__slots__
-

-Class Methods

- - -
None
-

-Methods

- - -
None
-

-Static Methods

- - -
None
- -
Up
-
- -

Connect

-

-Klasse fuer den RevPi Connect. -

- Stellt Funktionen fuer die LEDs, Watchdog und den Status zur Verfuegung. -

- -

-

-Derived from

-Core -

-Class Attributes

- - -
A3
__slots__
wdautotoggle
-

-Class Methods

- - -
None
-

-Methods

- - - - - - - - - - - - - - - - - - - - - - - -
__setattr__Verhindert Ueberschreibung der LEDs.
__wdtoggleWD Ausgang alle 10 Sekunden automatisch toggeln.
_devconfigureConnect-Klasse vorbereiten.
_get_leda3Gibt den Zustand der LED A3 vom Connect zurueck.
_get_wdtoggleRuft den Wert fuer Autowatchdog ab.
_set_leda3Setzt den Zustand der LED A3 vom Connect.
_set_wdtoggleSetzt den Wert fuer Autowatchdog.
-

-Static Methods

- - -
None
- -

-Connect.__setattr__

-__setattr__(key, value) -

-Verhindert Ueberschreibung der LEDs. -

-

-Connect.__wdtoggle

-__wdtoggle() -

-WD Ausgang alle 10 Sekunden automatisch toggeln. -

-

-Connect._devconfigure

-_devconfigure() -

-Connect-Klasse vorbereiten. -

-

-Connect._get_leda3

-_get_leda3() -

-Gibt den Zustand der LED A3 vom Connect zurueck. -

-
Returns:
-
-0=aus, 1=gruen, 2=rot -
-
-

-Connect._get_wdtoggle

-_get_wdtoggle() -

-Ruft den Wert fuer Autowatchdog ab. -

-
Returns:
-
-True, wenn Autowatchdog aktiv ist -
-
-

-Connect._set_leda3

-_set_leda3(value) -

-Setzt den Zustand der LED A3 vom Connect. -

-
value
-
-0=aus, 1=gruen, 2=rot -
-
-

-Connect._set_wdtoggle

-_set_wdtoggle(value) -

-Setzt den Wert fuer Autowatchdog. -

- Wird dieser Wert auf True gesetzt, wechselt im Hintergrund das noetige - Bit zum toggeln des Watchdogs alle 10 Sekunden zwichen True und False. - Dieses Bit wird bei autorefresh=True natuerlich automatisch in das - Prozessabbild geschrieben. -

- WICHTIG: Sollte autorefresh=False sein, muss zyklisch - .writeprocimg() aufgerufen werden, um den Wert in das - Prozessabbild zu schreiben!!! -

-
value
-
-True zum aktivieren, Fals zum beenden -
-
-
Up
-
- -

Core

-

-Klasse fuer den RevPi Core. -

- Stellt Funktionen fuer die LEDs und den Status zur Verfuegung. -

- -

-

-Derived from

-Base -

-Class Attributes

- - -
A1
A2
__slots__
status
-

-Class Methods

- - -
None
-

-Methods

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
__errorlimitVerwaltet das Schreiben der ErrorLimits.
__setattr__Verhindert Ueberschreibung der LEDs.
_devconfigureCore-Klasse vorbereiten.
_get_leda1Gibt den Zustand der LED A1 vom Core zurueck.
_get_leda2Gibt den Zustand der LED A2 vom Core zurueck.
_get_statusGibt den RevPi Core Status zurueck.
_set_calculatedledBerechnet und setzt neuen Bytewert fuer LED byte.
_set_leda1Setzt den Zustand der LED A1 vom Core.
_set_leda2Setzt den Zustand der LED A2 vom Core.
errorlimit1Setzt RS485 ErrorLimit1 auf neuen Wert.
errorlimit2Setzt RS485 ErrorLimit2 auf neuen Wert.
frequencyGibt CPU Taktfrequenz zurueck.
iocycleGibt Zykluszeit der Prozessabbildsynchronisierung zurueck.
ioerrorcountGibt Fehleranzahl auf RS485 piBridge Bus zurueck.
leftgateStatusbit links vom RevPi ist ein piGate Modul angeschlossen.
missingdeviceorgateStatusbit fuer ein IO-Modul fehlt oder piGate konfiguriert.
overunderflowStatusbit Modul belegt mehr oder weniger Speicher als konfiguriert.
picontrolrunningStatusbit fuer piControl-Treiber laeuft.
rightgateStatusbit rechts vom RevPi ist ein piGate Modul angeschlossen.
temperatureGibt CPU-Temperatur zurueck.
unconfdeviceStatusbit fuer ein IO-Modul nicht mit PiCtory konfiguriert.
-

-Static Methods

- - -
None
- -

-Core.__errorlimit

-__errorlimit(slc_io, errorlimit) -

-Verwaltet das Schreiben der ErrorLimits. -

-
slc_io
-
-Byte Slice vom ErrorLimit -
-
-
Returns:
-
-Aktuellen ErrorLimit oder None wenn nicht verfuegbar -
-
-

-Core.__setattr__

-__setattr__(key, value) -

-Verhindert Ueberschreibung der LEDs. -

-

-Core._devconfigure

-_devconfigure() -

-Core-Klasse vorbereiten. -

-

-Core._get_leda1

-_get_leda1() -

-Gibt den Zustand der LED A1 vom Core zurueck. -

-
Returns:
-
-0=aus, 1=gruen, 2=rot -
-
-

-Core._get_leda2

-_get_leda2() -

-Gibt den Zustand der LED A2 vom Core zurueck. -

-
Returns:
-
-0=aus, 1=gruen, 2=rot -
-
-

-Core._get_status

-_get_status() -

-Gibt den RevPi Core Status zurueck. -

-
Returns:
-
-Status als -
-
-

-Core._set_calculatedled

-_set_calculatedled(addresslist, shifted_value) -

-Berechnet und setzt neuen Bytewert fuer LED byte. -

-
addresslist
-
-Liste der Vergleicher -
shifed_value
-
-Bits vergleichen -
-
-

-Core._set_leda1

-_set_leda1(value) -

-Setzt den Zustand der LED A1 vom Core. -

-
value
-
-0=aus, 1=gruen, 2=rot -
-
-

-Core._set_leda2

-_set_leda2(value) -

-Setzt den Zustand der LED A2 vom Core. -

-
value
-
-0=aus, 1=gruen, 2=rot -
-
-

-Core.errorlimit1

-errorlimit1(value) -

-Setzt RS485 ErrorLimit1 auf neuen Wert. -

-
value
-
-Neuer ErrorLimit1 Wert -
-
-

-Core.errorlimit2

-errorlimit2(value) -

-Setzt RS485 ErrorLimit2 auf neuen Wert. -

-
value
-
-Neuer ErrorLimit2 Wert -
-
-

-Core.frequency

-frequency() -

-Gibt CPU Taktfrequenz zurueck. -

-
Returns:
-
-CPU Taktfrequenz in MHz -
-
-

-Core.iocycle

-iocycle() -

-Gibt Zykluszeit der Prozessabbildsynchronisierung zurueck. -

-
Returns:
-
-Zykluszeit in ms -
-
-

-Core.ioerrorcount

-ioerrorcount() -

-Gibt Fehleranzahl auf RS485 piBridge Bus zurueck. -

-
Returns:
-
-Fehleranzahl der piBridge -
-
-

-Core.leftgate

-leftgate() -

-Statusbit links vom RevPi ist ein piGate Modul angeschlossen. -

-
Returns:
-
-True, wenn piGate links existiert -
-
-

-Core.missingdeviceorgate

-missingdeviceorgate() -

-Statusbit fuer ein IO-Modul fehlt oder piGate konfiguriert. -

-
Returns:
-
-True, wenn IO-Modul fehlt oder piGate konfiguriert -
-
-

-Core.overunderflow

-overunderflow() -

-Statusbit Modul belegt mehr oder weniger Speicher als konfiguriert. -

-
Returns:
-
-True, wenn falscher Speicher belegt ist -
-
-

-Core.picontrolrunning

-picontrolrunning() -

-Statusbit fuer piControl-Treiber laeuft. -

-
Returns:
-
-True, wenn Treiber laeuft -
-
-

-Core.rightgate

-rightgate() -

-Statusbit rechts vom RevPi ist ein piGate Modul angeschlossen. -

-
Returns:
-
-True, wenn piGate rechts existiert -
-
-

-Core.temperature

-temperature() -

-Gibt CPU-Temperatur zurueck. -

-
Returns:
-
-CPU-Temperatur in Celsius -
-
-

-Core.unconfdevice

-unconfdevice() -

-Statusbit fuer ein IO-Modul nicht mit PiCtory konfiguriert. -

-
Returns:
-
-True, wenn IO Modul nicht konfiguriert -
-
-
Up
-
- -

Device

-

-Basisklasse fuer alle Device-Objekte. -

- Die Basisfunktionalitaet generiert bei Instantiierung alle IOs und - erweitert den Prozessabbildpuffer um die benoetigten Bytes. Sie verwaltet - ihren Prozessabbildpuffer und sorgt fuer die Aktualisierung der IO-Werte. -

- -

-

-Derived from

-object -

-Class Attributes

- - -
__slots__
length
name
offset
position
producttype
-

-Class Methods

- - -
None
-

-Methods

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
DeviceInstantiierung der Device-Klasse.
__bytes__Gibt alle Daten des Devices als zurueck.
__contains__Prueft ob IO auf diesem Device liegt.
__getioiterGibt mit allen IOs zurueck.
__getitem__Gibt IO an angegebener Stelle zurueck.
__int__Gibt die Positon im RevPi Bus zurueck.
__iter__Gibt Iterator aller IOs zurueck.
__len__Gibt Anzahl der Bytes zurueck, die dieses Device belegt.
__str__Gibt den Namen des Devices zurueck.
_buildioErstellt aus der piCtory-Liste die IOs fuer dieses Device.
_devconfigureFunktion zum ueberschreiben von abgeleiteten Klassen.
_get_offsetGibt den Deviceoffset im Prozessabbild zurueck.
_get_producttypeGibt den Produkttypen des device zurueck.
_update_my_io_listErzeugt eine neue IO Liste fuer schnellen Zugriff.
autorefreshRegistriert dieses Device fuer die automatische Synchronisierung.
get_alliosGibt eine Liste aller Inputs und Outputs zurueck, keine MEMs.
get_inputsGibt eine Liste aller Inputs zurueck.
get_memoriesGibt eine Liste aller Memoryobjekte zurueck.
get_outputsGibt eine Liste aller Outputs zurueck.
readprocimgAlle Inputs fuer dieses Device vom Prozessabbild einlesen.
setdefaultvaluesAlle Outputbuffer fuer dieses Device auf default Werte setzen.
syncoutputsLesen aller Outputs im Prozessabbild fuer dieses Device.
writeprocimgSchreiben aller Outputs dieses Devices ins Prozessabbild.
-

-Static Methods

- - -
None
- -

-Device (Constructor)

-Device(parentmodio, dict_device, simulator=False) -

-Instantiierung der Device-Klasse. -

-
parent
-
-RevpiModIO parent object -
dict_device
-
- fuer dieses Device aus piCotry -
simulator:
-
-Laedt das Modul als Simulator und vertauscht IOs -
-
-

-Device.__bytes__

-__bytes__() -

-Gibt alle Daten des Devices als zurueck. -

-
Returns:
-
-Devicedaten als -
-
-

-Device.__contains__

-__contains__(key) -

-Prueft ob IO auf diesem Device liegt. -

-
key
-
-IO-Name / IO-Bytenummer -
-
-
Returns:
-
-True, wenn IO auf Device vorhanden -
-
-

-Device.__getioiter

-__getioiter(ioslc, export) -

-Gibt mit allen IOs zurueck. -

-
ioslc
-
-IO Abschnitt -
export
-
-Filter fuer 'Export' Flag in piCtory -
-
-
Returns:
-
-IOs als Iterator -
-
-

-Device.__getitem__

-__getitem__(key) -

-Gibt IO an angegebener Stelle zurueck. -

-
key
-
-Index des IOs auf dem device als -
-
-
Returns:
-
-Gefundenes IO-Objekt -
-
-

-Device.__int__

-__int__() -

-Gibt die Positon im RevPi Bus zurueck. -

-
Returns:
-
-Positionsnummer -
-
-

-Device.__iter__

-__iter__() -

-Gibt Iterator aller IOs zurueck. -

-
Returns:
-
- aller IOs -
-
-

-Device.__len__

-__len__() -

-Gibt Anzahl der Bytes zurueck, die dieses Device belegt. -

-
Returns:
-
- -
-
-

-Device.__str__

-__str__() -

-Gibt den Namen des Devices zurueck. -

-
Returns:
-
-Devicename -
-
-

-Device._buildio

-_buildio(dict_io, iotype) -

-Erstellt aus der piCtory-Liste die IOs fuer dieses Device. -

-
dict_io
-
--Objekt aus piCtory Konfiguration -
iotype
-
- Wert -
-
-
Returns:
-
- mit Start und Stop Position dieser IOs -
-
-

-Device._devconfigure

-_devconfigure() -

-Funktion zum ueberschreiben von abgeleiteten Klassen. -

-

-Device._get_offset

-_get_offset() -

-Gibt den Deviceoffset im Prozessabbild zurueck. -

-
Returns:
-
-Deviceoffset -
-
-

-Device._get_producttype

-_get_producttype() -

-Gibt den Produkttypen des device zurueck. -

-
Returns:
-
-Deviceprodukttyp -
-
-

-Device._update_my_io_list

-_update_my_io_list() -

-Erzeugt eine neue IO Liste fuer schnellen Zugriff. -

-

-Device.autorefresh

-autorefresh(activate=True) -

-Registriert dieses Device fuer die automatische Synchronisierung. -

-
activate
-
-Default True fuegt Device zur Synchronisierung hinzu -
-
-

-Device.get_allios

-get_allios(export=None) -

-Gibt eine Liste aller Inputs und Outputs zurueck, keine MEMs. -

- Bleibt Parameter 'export' auf None werden alle Inputs und Outputs - zurueckgegeben. Wird 'export' auf True/False gesetzt, werden nur Inputs - und Outputs zurueckgegeben, bei denen der Wert 'Export' in piCtory - uebereinstimmt. -

-
export
-
-Nur In-/Outputs mit angegebenen 'Export' Wert in piCtory -
-
-
Returns:
-
- Input und Output, keine MEMs -
-
-

-Device.get_inputs

-get_inputs(export=None) -

-Gibt eine Liste aller Inputs zurueck. -

- Bleibt Parameter 'export' auf None werden alle Inputs zurueckgegeben. - Wird 'export' auf True/False gesetzt, werden nur Inputs zurueckgegeben, - bei denen der Wert 'Export' in piCtory uebereinstimmt. -

-
export
-
-Nur Inputs mit angegebenen 'Export' Wert in piCtory -
-
-
Returns:
-
- Inputs -
-
-

-Device.get_memories

-get_memories(export=None) -

-Gibt eine Liste aller Memoryobjekte zurueck. -

- Bleibt Parameter 'export' auf None werden alle Mems zurueckgegeben. - Wird 'export' auf True/False gesetzt, werden nur Mems zurueckgegeben, - bei denen der Wert 'Export' in piCtory uebereinstimmt. -

-
export
-
-Nur Mems mit angegebenen 'Export' Wert in piCtory -
-
-
Returns:
-
- Mems -
-
-

-Device.get_outputs

-get_outputs(export=None) -

-Gibt eine Liste aller Outputs zurueck. -

- Bleibt Parameter 'export' auf None werden alle Outputs zurueckgegeben. - Wird 'export' auf True/False gesetzt, werden nur Outputs - zurueckgegeben, bei denen der Wert 'Export' in piCtory uebereinstimmt. -

-
export
-
-Nur Outputs mit angegebenen 'Export' Wert in piCtory -
-
-
Returns:
-
- Outputs -
-
-

-Device.readprocimg

-readprocimg() -

-Alle Inputs fuer dieses Device vom Prozessabbild einlesen. -

-
Returns:
-
-True, wenn erfolgreich ausgefuehrt -
-
-
See Also:
-
-RevPiModIO.readprocimg() -
-
-

-Device.setdefaultvalues

-setdefaultvalues() -

-Alle Outputbuffer fuer dieses Device auf default Werte setzen. -

-
Returns:
-
-True, wenn erfolgreich ausgefuehrt -
-
-
See Also:
-
-RevPiModIO.setdefaultvalues() -
-
-

-Device.syncoutputs

-syncoutputs() -

-Lesen aller Outputs im Prozessabbild fuer dieses Device. -

-
Returns:
-
-True, wenn erfolgreich ausgefuehrt -
-
-
See Also:
-
-RevPiModIO.syncoutputs() -
-
-

-Device.writeprocimg

-writeprocimg() -

-Schreiben aller Outputs dieses Devices ins Prozessabbild. -

-
Returns:
-
-True, wenn erfolgreich ausgefuehrt -
-
-
See Also:
-
-RevPiModIO.writeprocimg() -
-
-
Up
-
- -

DeviceList

-

-Basisklasse fuer direkten Zugriff auf Device Objekte. -

-

-Derived from

-object -

-Class Attributes

- - -
None
-

-Class Methods

- - -
None
-

-Methods

- - - - - - - - - - - - - - - - - - - - - - - - - - -
DeviceListInit DeviceList class.
__contains__Prueft ob Device existiert.
__delattr__Entfernt angegebenes Device.
__delitem__Entfernt Device an angegebener Position.
__getitem__Gibt angegebenes Device zurueck.
__iter__Gibt Iterator aller Devices zurueck.
__len__Gibt Anzahl der Devices zurueck.
__setattr__Setzt Attribute nur wenn Device.
-

-Static Methods

- - -
None
- -

-DeviceList (Constructor)

-DeviceList() -

-Init DeviceList class. -

-

-DeviceList.__contains__

-__contains__(key) -

-Prueft ob Device existiert. -

-
key
-
-DeviceName / Positionsnummer -
-
-
Returns:
-
-True, wenn Device vorhanden -
-
-

-DeviceList.__delattr__

-__delattr__(key, delcomplete=True) -

-Entfernt angegebenes Device. -

-
key
-
-Device zum entfernen -
delcomplete
-
-Wenn True wird Device komplett entfernt -
-
-

-DeviceList.__delitem__

-__delitem__(key) -

-Entfernt Device an angegebener Position. -

-
key
-
-Deviceposition zum entfernen -
-
-

-DeviceList.__getitem__

-__getitem__(key) -

-Gibt angegebenes Device zurueck. -

-
key
-
-DeviceName / Positionsnummer -
-
-
Returns:
-
-Gefundenes -Objekt -
-
-

-DeviceList.__iter__

-__iter__() -

-Gibt Iterator aller Devices zurueck. -

- Die Reihenfolge ist nach Position im Prozessabbild sortiert und nicht - nach Positionsnummer (Dies entspricht der Positionierung aus piCtory)! -

-
Returns:
-
- aller Devices -
-
-

-DeviceList.__len__

-__len__() -

-Gibt Anzahl der Devices zurueck. - return Anzahl der Devices -

-

-DeviceList.__setattr__

-__setattr__(key, value) -

-Setzt Attribute nur wenn Device. -

-
key
-
-Attributname -
value
-
-Attributobjekt -
-
-
Up
-
- -

DioModule

-

-Stellt ein DIO / DI / DO Modul dar. -

-

-Derived from

-Device -

-Class Attributes

- - -
__slots__
-

-Class Methods

- - -
None
-

-Methods

- - - - - -
DioModuleErweitert Device-Klasse zum Erkennen von IntIOCounter.
-

-Static Methods

- - -
None
- -

-DioModule (Constructor)

-DioModule(parentmodio, dict_device, simulator=False) -

-Erweitert Device-Klasse zum Erkennen von IntIOCounter. -

-
See Also:
-
-Device.__init__(...) -
-
-
Up
-
- -

Gateway

-

-Klasse fuer die RevPi Gateway-Devices. -

- Stellt neben den Funktionen von RevPiDevice weitere Funktionen fuer die - Gateways bereit. IOs auf diesem Device stellen die replace_io Funktion - zur verfuegung, ueber die eigene IOs definiert werden, die ein - RevPiStructIO-Objekt abbilden. - Dieser IO-Typ kann Werte ueber mehrere Bytes verarbeiten und zurueckgeben. -

-
See Also:
-
-replace_io(...) -
-
-

-Derived from

-Device -

-Class Attributes

- - -
__slots__
-

-Class Methods

- - -
None
-

-Methods

- - - - - - - - -
GatewayErweitert Device-Klasse um get_rawbytes-Funktionen.
get_rawbytesGibt die Bytes aus, die dieses Device verwendet.
-

-Static Methods

- - -
None
- -

-Gateway (Constructor)

-Gateway(parent, dict_device, simulator=False) -

-Erweitert Device-Klasse um get_rawbytes-Funktionen. -

-
See Also:
-
-Device.__init__(...) -
-
-

-Gateway.get_rawbytes

-get_rawbytes() -

-Gibt die Bytes aus, die dieses Device verwendet. -

-
Returns:
-
- des Devices -
-
-
Up
-
- -

Virtual

-

-Klasse fuer die RevPi Virtual-Devices. -

- Stellt die selben Funktionen wie Gateway zur Verfuegung. Es koennen - ueber die reg_*-Funktionen eigene IOs definiert werden, die ein - RevPiStructIO-Objekt abbilden. - Dieser IO-Typ kann Werte ueber mehrere Bytes verarbeiten und zurueckgeben. -

-
See Also:
-
-Gateway -
-
-

-Derived from

-Gateway -

-Class Attributes

- - -
__slots__
-

-Class Methods

- - -
None
-

-Methods

- - - - - -
writeinputdefaultsSchreibt fuer ein virtuelles Device piCtory Defaultinputwerte.
-

-Static Methods

- - -
None
- -

-Virtual.writeinputdefaults

-writeinputdefaults() -

-Schreibt fuer ein virtuelles Device piCtory Defaultinputwerte. -

- Sollten in piCtory Defaultwerte fuer Inputs eines virtuellen Devices - angegeben sein, werden diese nur beim Systemstart oder einem piControl - Reset gesetzt. Sollte danach das Prozessabbild mit NULL ueberschrieben, - gehen diese Werte verloren. - Diese Funktion kann nur auf virtuelle Devices angewendet werden! -

-
Returns:
-
-True, wenn Arbeiten am virtuellen Device erfolgreich waren -
-
-
Up
-
- \ No newline at end of file diff --git a/doc/revpimodio2.helper.html b/doc/revpimodio2.helper.html deleted file mode 100644 index 83b157c..0000000 --- a/doc/revpimodio2.helper.html +++ /dev/null @@ -1,578 +0,0 @@ - - -revpimodio2.helper - - - -

-revpimodio2.helper

-

-RevPiModIO Helperklassen und Tools. -

-

-Global Attributes

- - -
__author__
__copyright__
__license__
-

-Classes

- - - - - - - - - - - - - - -
CycletoolsWerkzeugkasten fuer Cycleloop-Funktion.
EventCallbackThread fuer das interne Aufrufen von Event-Funktionen.
ProcimgWriterKlasse fuer Synchroniseriungs-Thread.
Var
-

-Functions

- - -
None
-
- -

Cycletools

-

-Werkzeugkasten fuer Cycleloop-Funktion. -

- Diese Klasse enthaelt Werkzeuge fuer Zyklusfunktionen, wie Taktmerker - und Flankenmerker. - Zu beachten ist, dass die Flankenmerker beim ersten Zyklus alle den Wert - True haben! Ueber den Merker Cycletools.first kann ermittelt werden, - ob es sich um den ersten Zyklus handelt. -

- Taktmerker flag1c, flag5c, flag10c, usw. haben den als Zahl angegebenen - Wert an Zyklen jeweils False und True. - Beispiel: flag5c hat 5 Zyklen den Wert False und in den naechsten 5 Zyklen - den Wert True. -

- Flankenmerker flank5c, flank10c, usw. haben immer im, als Zahl angebenen - Zyklus fuer einen Zyklusdurchlauf den Wert True, sonst False. - Beispiel: flank5c hat immer alle 5 Zyklen den Wert True. -

- Diese Merker koennen z.B. verwendet werden um, an Outputs angeschlossene, - Lampen synchron blinken zu lassen. -

- -

-

-Derived from

-None -

-Class Attributes

- - -
__slots__
-

-Class Methods

- - -
None
-

-Methods

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
CycletoolsInit Cycletools class.
_docycleZyklusarbeiten.
get_tofWert der Ausschaltverzoegerung.
get_tofcWert der Ausschaltverzoegerung.
get_tonEinschaltverzoegerung.
get_toncEinschaltverzoegerung.
get_tpImpulstimer.
get_tpcImpulstimer.
set_tofStartet bei Aufruf einen ausschaltverzoegerten Timer.
set_tofcStartet bei Aufruf einen ausschaltverzoegerten Timer.
set_tonStartet einen einschaltverzoegerten Timer.
set_toncStartet einen einschaltverzoegerten Timer.
set_tpStartet einen Impuls Timer.
set_tpcStartet einen Impuls Timer.
-

-Static Methods

- - -
None
- -

-Cycletools (Constructor)

-Cycletools(cycletime) -

-Init Cycletools class. -

-

-Cycletools._docycle

-_docycle() -

-Zyklusarbeiten. -

-

-Cycletools.get_tof

-get_tof(name) -

-Wert der Ausschaltverzoegerung. -

-
name
-
-Eindeutiger Name des Timers -
-
-
Returns:
-
-Wert der Ausschaltverzoegerung -
-
-

-Cycletools.get_tofc

-get_tofc(name) -

-Wert der Ausschaltverzoegerung. -

-
name
-
-Eindeutiger Name des Timers -
-
-
Returns:
-
-Wert der Ausschaltverzoegerung -
-
-

-Cycletools.get_ton

-get_ton(name) -

-Einschaltverzoegerung. -

-
name
-
-Eindeutiger Name des Timers -
-
-
Returns:
-
-Wert der Einschaltverzoegerung -
-
-

-Cycletools.get_tonc

-get_tonc(name) -

-Einschaltverzoegerung. -

-
name
-
-Eindeutiger Name des Timers -
-
-
Returns:
-
-Wert der Einschaltverzoegerung -
-
-

-Cycletools.get_tp

-get_tp(name) -

-Impulstimer. -

-
name
-
-Eindeutiger Name des Timers -
-
-
Returns:
-
-Wert des Impulses -
-
-

-Cycletools.get_tpc

-get_tpc(name) -

-Impulstimer. -

-
name
-
-Eindeutiger Name des Timers -
-
-
Returns:
-
-Wert des Impulses -
-
-

-Cycletools.set_tof

-set_tof(name, milliseconds) -

-Startet bei Aufruf einen ausschaltverzoegerten Timer. -

-
name
-
-Eindeutiger Name fuer Zugriff auf Timer -
milliseconds
-
-Verzoegerung in Millisekunden -
-
-

-Cycletools.set_tofc

-set_tofc(name, cycles) -

-Startet bei Aufruf einen ausschaltverzoegerten Timer. -

-
name
-
-Eindeutiger Name fuer Zugriff auf Timer -
cycles
-
-Zyklusanzahl, der Verzoegerung wenn nicht neu gestartet -
-
-

-Cycletools.set_ton

-set_ton(name, milliseconds) -

-Startet einen einschaltverzoegerten Timer. -

-
name
-
-Eindeutiger Name fuer Zugriff auf Timer -
milliseconds
-
-Millisekunden, der Verzoegerung wenn neu gestartet -
-
-

-Cycletools.set_tonc

-set_tonc(name, cycles) -

-Startet einen einschaltverzoegerten Timer. -

-
name
-
-Eindeutiger Name fuer Zugriff auf Timer -
cycles
-
-Zyklusanzahl, der Verzoegerung wenn neu gestartet -
-
-

-Cycletools.set_tp

-set_tp(name, milliseconds) -

-Startet einen Impuls Timer. -

-
name
-
-Eindeutiger Name fuer Zugriff auf Timer -
milliseconds
-
-Millisekunden, die der Impuls anstehen soll -
-
-

-Cycletools.set_tpc

-set_tpc(name, cycles) -

-Startet einen Impuls Timer. -

-
name
-
-Eindeutiger Name fuer Zugriff auf Timer -
cycles
-
-Zyklusanzahl, die der Impuls anstehen soll -
-
-
Up
-
- -

EventCallback

-

-Thread fuer das interne Aufrufen von Event-Funktionen. -

- Der Eventfunktion, welche dieser Thread aufruft, wird der Thread selber - als Parameter uebergeben. Darauf muss bei der definition der Funktion - geachtet werden z.B. "def event(th):". Bei umfangreichen Funktionen kann - dieser ausgewertet werden um z.B. doppeltes Starten zu verhindern. - Ueber EventCallback.ioname kann der Name des IO-Objekts abgerufen werden, - welches das Event ausgeloest hast. EventCallback.iovalue gibt den Wert des - IO-Objekts zum Ausloesezeitpunkt zurueck. - Der Thread stellt das EventCallback.exit Event als Abbruchbedingung fuer - die aufgerufene Funktion zur Verfuegung. - Durch Aufruf der Funktion EventCallback.stop() wird das exit-Event gesetzt - und kann bei Schleifen zum Abbrechen verwendet werden. - Mit dem .exit() Event auch eine Wartefunktion realisiert - werden: "th.exit.wait(0.5)" - Wartet 500ms oder bricht sofort ab, wenn - fuer den Thread .stop() aufgerufen wird. -

- while not th.exit.is_set(): - # IO-Arbeiten - th.exit.wait(0.5) -

- -

-

-Derived from

-Thread -

-Class Attributes

- - -
__slots__
-

-Class Methods

- - -
None
-

-Methods

- - - - - - - - - - - -
EventCallbackInit EventCallback class.
runRuft die registrierte Funktion auf.
stopSetzt das exit-Event mit dem die Funktion beendet werden kann.
-

-Static Methods

- - -
None
- -

-EventCallback (Constructor)

-EventCallback(func, name, value) -

-Init EventCallback class. -

-
func
-
-Funktion die beim Start aufgerufen werden soll -
name
-
-IO-Name -
value
-
-IO-Value zum Zeitpunkt des Events -
-
-

-EventCallback.run

-run() -

-Ruft die registrierte Funktion auf. -

-

-EventCallback.stop

-stop() -

-Setzt das exit-Event mit dem die Funktion beendet werden kann. -

-
Up
-
- -

ProcimgWriter

-

-Klasse fuer Synchroniseriungs-Thread. -

- Diese Klasse wird als Thread gestartet, wenn das Prozessabbild zyklisch - synchronisiert werden soll. Diese Funktion wird hauptsaechlich fuer das - Event-Handling verwendet. -

- -

-

-Derived from

-Thread -

-Class Attributes

- - -
__slots__
refresh
-

-Class Methods

- - -
None
-

-Methods

- - - - - - - - - - - - - - - - - - - - - - - - - - -
ProcimgWriterInit ProcimgWriter class.
__check_changeFindet Aenderungen fuer die Eventueberwachung.
__exec_thLaeuft als Thread, der Events als Thread startet.
_collect_eventsAktiviert oder Deaktiviert die Eventueberwachung.
get_refreshGibt Zykluszeit zurueck.
runStartet die automatische Prozessabbildsynchronisierung.
set_refreshSetzt die Zykluszeit in Millisekunden.
stopBeendet die automatische Prozessabbildsynchronisierung.
-

-Static Methods

- - -
None
- -

-ProcimgWriter (Constructor)

-ProcimgWriter(parentmodio) -

-Init ProcimgWriter class. -

-
parentmodio
-
-Parent Object -
-
-

-ProcimgWriter.__check_change

-__check_change(dev) -

-Findet Aenderungen fuer die Eventueberwachung. -

-

-ProcimgWriter.__exec_th

-__exec_th() -

-Laeuft als Thread, der Events als Thread startet. -

-

-ProcimgWriter._collect_events

-_collect_events(value) -

-Aktiviert oder Deaktiviert die Eventueberwachung. -

-
value
-
-True aktiviert / False deaktiviert -
-
-
Returns:
-
-True, wenn Anforderung erfolgreich war -
-
-

-ProcimgWriter.get_refresh

-get_refresh() -

-Gibt Zykluszeit zurueck. -

-
Returns:
-
- Zykluszeit in Millisekunden -
-
-

-ProcimgWriter.run

-run() -

-Startet die automatische Prozessabbildsynchronisierung. -

-

-ProcimgWriter.set_refresh

-set_refresh(value) -

-Setzt die Zykluszeit in Millisekunden. -

-
value
-
- Millisekunden -
-
-

-ProcimgWriter.stop

-stop() -

-Beendet die automatische Prozessabbildsynchronisierung. -

-
Up
-
- -

Var

- -

-Derived from

-None -

-Class Attributes

- - -
None
-

-Class Methods

- - -
None
-

-Methods

- - -
None
-

-Static Methods

- - -
None
- -
Up
-
- \ No newline at end of file diff --git a/doc/revpimodio2.io.html b/doc/revpimodio2.io.html deleted file mode 100644 index 673584e..0000000 --- a/doc/revpimodio2.io.html +++ /dev/null @@ -1,1116 +0,0 @@ - - -revpimodio2.io - - - -

-revpimodio2.io

-

-RevPiModIO Modul fuer die Verwaltung der IOs. -

-

-Global Attributes

- - -
__author__
__copyright__
__license__
-

-Classes

- - - - - - - - - - - - - - - - - - - - - - - - - - -
DeadIOKlasse, mit der ersetzte IOs verwaltet werden.
IOBaseBasisklasse fuer alle IO-Objekte.
IOEventBasisklasse fuer IO-Events.
IOListBasisklasse fuer direkten Zugriff auf IO Objekte.
IntIOKlasse fuer den Zugriff auf die Daten mit Konvertierung in int.
IntIOCounterErweitert die IntIO-Klasse um die .reset() Funktion fuer Counter.
IntIOReplaceableErweitert die IntIO-Klasse um die .replace_io Funktion.
StructIOKlasse fuer den Zugriff auf Daten ueber ein definierten struct.
-

-Functions

- - -
None
-
- -

DeadIO

-

-Klasse, mit der ersetzte IOs verwaltet werden. -

-

-Derived from

-object -

-Class Attributes

- - -
__slots__
_parentdevice
-

-Class Methods

- - -
None
-

-Methods

- - - - - - - - -
DeadIOInstantiierung der DeadIO-Klasse.
replace_ioStellt Funktion fuer weiter Bit-Ersetzungen bereit.
-

-Static Methods

- - -
None
- -

-DeadIO (Constructor)

-DeadIO(deadio) -

-Instantiierung der DeadIO-Klasse. -

-
deadio
-
-IO, der ersetzt wurde -
-
-

-DeadIO.replace_io

-replace_io(name, frm, **kwargs) -

-Stellt Funktion fuer weiter Bit-Ersetzungen bereit. -

-
See Also:
-
-replace_io(...) -
-
-
Up
-
- -

IOBase

-

-Basisklasse fuer alle IO-Objekte. -

- Die Basisfunktionalitaet ermoeglicht das Lesen und Schreiben der Werte - als oder . Dies entscheidet sich bei der - Instantiierung. - Wenn eine Bittadresse angegeben wird, werden -Werte erwartet - und zurueckgegeben, ansonsten . -

- Diese Klasse dient als Basis fuer andere IO-Klassen mit denen die Werte - auch als verwendet werden koennen. -

- -

-

-Derived from

-object -

-Class Attributes

- - -
__slots__
address
byteorder
defaultvalue
length
name
type
value
-

-Class Methods

- - -
None
-

-Methods

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
IOBaseInstantiierung der IOBase-Klasse.
__bool__-Wert der Klasse.
__len__Gibt die Bytelaenge des IO zurueck.
__reg_xeventVerwaltet reg_event und reg_timerevent.
__str__-Wert der Klasse.
_get_addressGibt die absolute Byteadresse im Prozessabbild zurueck.
_get_byteorderGibt konfigurierte Byteorder zurueck.
_get_iotypeGibt io type zurueck.
get_defaultvalueGibt die Defaultvalue von piCtory zurueck.
get_valueGibt den Wert des IOs zurueck.
reg_eventRegistriert fuer IO ein Event bei der Eventueberwachung.
reg_timereventRegistriert fuer IO einen Timer, welcher nach delay func ausfuehrt.
set_valueSetzt den Wert des IOs.
unreg_eventEntfernt ein Event aus der Eventueberwachung.
waitWartet auf Wertaenderung eines IOs.
-

-Static Methods

- - -
None
- -

-IOBase (Constructor)

-IOBase(parentdevice, valuelist, iotype, byteorder, signed) -

-Instantiierung der IOBase-Klasse. -

-
parentdevice
-
-Parentdevice auf dem der IO liegt -
valuelist
-
-Datenliste fuer Instantiierung - ["name","defval","bitlen","startaddrdev",exp,"idx","bmk","bitaddr"] -
iotype
-
- Wert -
byteorder
-
-Byteorder 'little'/'big' fuer Berechnung -
sigend
-
-Intberechnung mit Vorzeichen durchfuehren -
-
-

-IOBase.__bool__

-__bool__() -

--Wert der Klasse. -

-
Returns:
-
- Nur False wenn False oder 0 sonst True -
-
-

-IOBase.__len__

-__len__() -

-Gibt die Bytelaenge des IO zurueck. -

-
Returns:
-
-Bytelaenge des IO - 0 bei BITs -
-
-

-IOBase.__reg_xevent

-__reg_xevent(func, delay, edge, as_thread, overwrite, prefire) -

-Verwaltet reg_event und reg_timerevent. -

-
func
-
-Funktion die bei Aenderung aufgerufen werden soll -
delay
-
-Verzoegerung in ms zum Ausloesen - auch bei Wertaenderung -
edge
-
-Ausfuehren bei RISING, FALLING or BOTH Wertaenderung -
as_thread
-
-Bei True, Funktion als EventCallback-Thread ausfuehren -
overwrite
-
-Wenn True, wird Event bei ueberschrieben -
prefire
-
-Ausloesen mit aktuellem Wert, wenn mainloop startet -
-
-

-IOBase.__str__

-__str__() -

--Wert der Klasse. -

-
Returns:
-
-Namen des IOs -
-
-

-IOBase._get_address

-_get_address() -

-Gibt die absolute Byteadresse im Prozessabbild zurueck. -

-
Returns:
-
-Absolute Byteadresse -
-
-

-IOBase._get_byteorder

-_get_byteorder() -

-Gibt konfigurierte Byteorder zurueck. -

-
Returns:
-
- Byteorder -
-
-

-IOBase._get_iotype

-_get_iotype() -

-Gibt io type zurueck. -

-
Returns:
-
- io type -
-
-

-IOBase.get_defaultvalue

-get_defaultvalue() -

-Gibt die Defaultvalue von piCtory zurueck. -

-
Returns:
-
-Defaultvalue als oder -
-
-

-IOBase.get_value

-get_value() -

-Gibt den Wert des IOs zurueck. -

-
Returns:
-
-IO-Wert als oder -
-
-

-IOBase.reg_event

-reg_event(func, delay=0, edge=BOTH, as_thread=False, prefire=False) -

-Registriert fuer IO ein Event bei der Eventueberwachung. -

- Die uebergebene Funktion wird ausgefuehrt, wenn sich der IO Wert - aendert. Mit Angabe von optionalen Parametern kann das - Ausloeseverhalten gesteuert werden. -

- HINWEIS: Die delay-Zeit muss in die .cycletime passen, ist dies nicht - der Fall, wird IMMER aufgerundet! -

-
func
-
-Funktion die bei Aenderung aufgerufen werden soll -
delay
-
-Verzoegerung in ms zum Ausloesen wenn Wert gleich bleibt -
edge
-
-Ausfuehren bei RISING, FALLING or BOTH Wertaenderung -
as_thread
-
-Bei True, Funktion als EventCallback-Thread ausfuehren -
prefire
-
-Ausloesen mit aktuellem Wert, wenn mainloop startet -
-
-

-IOBase.reg_timerevent

-reg_timerevent(func, delay, edge=BOTH, as_thread=False) -

-Registriert fuer IO einen Timer, welcher nach delay func ausfuehrt. -

- Der Timer wird gestartet, wenn sich der IO Wert aendert und fuehrt die - uebergebene Funktion aus - auch wenn sich der IO Wert in der - zwischenzeit geaendert hat. Sollte der Timer nicht abelaufen sein und - die Bedingugn erneut zutreffen, wird der Timer NICHT auf den delay Wert - zurueckgesetzt oder ein zweites Mal gestartet. Fuer dieses Verhalten - kann .reg_event(..., delay=wert) verwendet werden. -

- HINWEIS: Die delay-Zeit muss in die .cycletime passen, ist dies nicht - der Fall, wird IMMER aufgerundet! -

-
func
-
-Funktion die bei Aenderung aufgerufen werden soll -
delay
-
-Verzoegerung in ms zum Ausloesen - auch bei Wertaenderung -
edge
-
-Ausfuehren bei RISING, FALLING or BOTH Wertaenderung -
as_thread
-
-Bei True, Funktion als EventCallback-Thread ausfuehren -
-
-

-IOBase.set_value

-set_value(value) -

-Setzt den Wert des IOs. -

-
value
-
-IO-Wert als oder -
-
-

-IOBase.unreg_event

-unreg_event(func=None, edge=None) -

-Entfernt ein Event aus der Eventueberwachung. -

-
func
-
-Nur Events mit angegebener Funktion -
edge
-
-Nur Events mit angegebener Funktion und angegebener Edge -
-
-

-IOBase.wait

-wait(edge=BOTH, exitevent=None, okvalue=None, timeout=0) -

-Wartet auf Wertaenderung eines IOs. -

- Die Wertaenderung wird immer uerberprueft, wenn fuer Devices - mit aktiviertem autorefresh neue Daten gelesen wurden. -

- Bei Wertaenderung, wird das Warten mit 0 als Rueckgabewert beendet. -

- HINWEIS: Wenn keine neuen Daten liefert, wird - bis in die Ewigkeit gewartet (nicht bei Angabe von "timeout"). -

- Wenn edge mit RISING oder FALLING angegeben wird, muss diese Flanke - ausgeloest werden. Sollte der Wert 1 sein beim Eintritt mit Flanke - RISING, wird das Warten erst bei Aenderung von 0 auf 1 beendet. -

- Als exitevent kann ein -Objekt uebergeben - werden, welches das Warten bei is_set() sofort mit 1 als Rueckgabewert - beendet. -

- Wenn der Wert okvalue an dem IO fuer das Warten anliegt, wird - das Warten sofort mit -1 als Rueckgabewert beendet. -

- Der Timeoutwert bricht beim Erreichen das Warten sofort mit - Wert 2 Rueckgabewert ab. (Das Timeout wird ueber die Zykluszeit - der autorefresh Funktion berechnet, entspricht also nicht exakt den - angegeben Millisekunden! Es wird immer nach oben gerundet!) -

-
edge
-
-Flanke RISING, FALLING, BOTH die eintreten muss -
exitevent
-
- fuer vorzeitiges Beenden -
okvalue
-
-IO-Wert, bei dem das Warten sofort beendet wird -
timeout
-
-Zeit in ms nach der abgebrochen wird -
-
-
Returns:
-
- erfolgreich Werte <= 0 - - Erfolgreich gewartet - Wert 0: IO hat den Wert gewechselt - Wert -1: okvalue stimmte mit IO ueberein - - Fehlerhaft gewartet - Wert 1: exitevent wurde gesetzt - Wert 2: timeout abgelaufen - Wert 100: Devicelist.exit() wurde aufgerufen -
-
-
Up
-
- -

IOEvent

-

-Basisklasse fuer IO-Events. -

-

-Derived from

-object -

-Class Attributes

- - -
__slots__
-

-Class Methods

- - -
None
-

-Methods

- - - - - -
IOEventInit IOEvent class.
-

-Static Methods

- - -
None
- -

-IOEvent (Constructor)

-IOEvent(func, edge, as_thread, delay, overwrite, prefire) -

-Init IOEvent class. -

-
Up
-
- -

IOList

-

-Basisklasse fuer direkten Zugriff auf IO Objekte. -

-

-Derived from

-object -

-Class Attributes

- - -
None
-

-Class Methods

- - -
None
-

-Methods

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
IOListInit IOList class.
__contains__Prueft ob IO existiert.
__delattr__Entfernt angegebenen IO.
__getattr__Verwaltet geloeschte IOs (Attribute, die nicht existieren).
__getitem__Ruft angegebenen IO ab.
__iter__Gibt Iterator aller IOs zurueck.
__len__Gibt die Anzahl aller IOs zurueck.
__private_replace_oldio_with_newioErsetzt bestehende IOs durch den neu Registrierten.
__setattr__Verbietet aus Leistungsguenden das direkte Setzen von Attributen.
_private_register_new_io_objectRegistriert neues IO Objekt unabhaenging von __setattr__.
-

-Static Methods

- - -
None
- -

-IOList (Constructor)

-IOList() -

-Init IOList class. -

-

-IOList.__contains__

-__contains__(key) -

-Prueft ob IO existiert. -

-
key
-
-IO-Name oder Bytenummer -
-
-
Returns:
-
-True, wenn IO vorhanden / Byte belegt -
-
-

-IOList.__delattr__

-__delattr__(key) -

-Entfernt angegebenen IO. -

-
key
-
-IO zum entfernen -
-
-

-IOList.__getattr__

-__getattr__(key) -

-Verwaltet geloeschte IOs (Attribute, die nicht existieren). -

-
key
-
-Name oder Byte eines alten IOs -
-
-
Returns:
-
-Alten IO, wenn in Ref-Listen -
-
-

-IOList.__getitem__

-__getitem__(key) -

-Ruft angegebenen IO ab. -

- Wenn der Key ist, wird ein einzelner IO geliefert. Wird - der Key als uebergeben, wird eine - geliefert mit 0, 1 oder 8 Eintraegen. - Wird als Key gegeben, werden die Listen in einer Liste - zurueckgegeben. -

-
key
-
-IO Name als oder Byte als . -
-
-
Returns:
-
-IO Objekt oder Liste der IOs -
-
-

-IOList.__iter__

-__iter__() -

-Gibt Iterator aller IOs zurueck. -

-
Returns:
-
-Iterator aller IOs -
-
-

-IOList.__len__

-__len__() -

-Gibt die Anzahl aller IOs zurueck. -

-
Returns:
-
-Anzahl aller IOs -
-
-

-IOList.__private_replace_oldio_with_newio

-__private_replace_oldio_with_newio(io) -

-Ersetzt bestehende IOs durch den neu Registrierten. -

-
io
-
-Neuer IO der eingefuegt werden soll -
-
-

-IOList.__setattr__

-__setattr__(key, value) -

-Verbietet aus Leistungsguenden das direkte Setzen von Attributen. -

-

-IOList._private_register_new_io_object

-_private_register_new_io_object(new_io) -

-Registriert neues IO Objekt unabhaenging von __setattr__. -

-
new_io
-
-Neues IO Objekt -
-
-
Up
-
- -

IntIO

-

-Klasse fuer den Zugriff auf die Daten mit Konvertierung in int. -

- Diese Klasse erweitert die Funktion von um Funktionen, - ueber die mit Werten gearbeitet werden kann. Fuer die - Umwandlung koennen 'Byteorder' (Default 'little') und 'signed' (Default - False) als Parameter gesetzt werden. -

-
See Also:
-
-IOBase -
-
-

-Derived from

-IOBase -

-Class Attributes

- - -
__slots__
byteorder
defaultvalue
signed
value
-

-Class Methods

- - -
None
-

-Methods

- - - - - - - - - - - - - - - - - - - - - - - -
__int__Gibt IO-Wert zurueck mit Beachtung byteorder/signed.
_get_signedRuft ab, ob der Wert Vorzeichenbehaftet behandelt werden soll.
_set_byteorderSetzt Byteorder fuer Umwandlung.
_set_signedLeft fest, ob der Wert Vorzeichenbehaftet behandelt werden soll.
get_intdefaultvalueGibt die Defaultvalue als zurueck.
get_intvalueGibt IO-Wert zurueck mit Beachtung byteorder/signed.
set_intvalueSetzt IO mit Beachtung byteorder/signed.
-

-Static Methods

- - -
None
- -

-IntIO.__int__

-__int__() -

-Gibt IO-Wert zurueck mit Beachtung byteorder/signed. -

-
Returns:
-
-IO-Wert als -
-
-

-IntIO._get_signed

-_get_signed() -

-Ruft ab, ob der Wert Vorzeichenbehaftet behandelt werden soll. -

-
Returns:
-
-True, wenn Vorzeichenbehaftet -
-
-

-IntIO._set_byteorder

-_set_byteorder(value) -

-Setzt Byteorder fuer Umwandlung. -

-
value
-
- 'little' or 'big' -
-
-

-IntIO._set_signed

-_set_signed(value) -

-Left fest, ob der Wert Vorzeichenbehaftet behandelt werden soll. -

-
value
-
-True, wenn mit Vorzeichen behandel -
-
-

-IntIO.get_intdefaultvalue

-get_intdefaultvalue() -

-Gibt die Defaultvalue als zurueck. -

-
Returns:
-
- Defaultvalue -
-
-

-IntIO.get_intvalue

-get_intvalue() -

-Gibt IO-Wert zurueck mit Beachtung byteorder/signed. -

-
Returns:
-
-IO-Wert als -
-
-

-IntIO.set_intvalue

-set_intvalue(value) -

-Setzt IO mit Beachtung byteorder/signed. -

-
value
-
- Wert -
-
-
Up
-
- -

IntIOCounter

-

-Erweitert die IntIO-Klasse um die .reset() Funktion fuer Counter. -

-

-Derived from

-IntIO -

-Class Attributes

- - -
__slots__
-

-Class Methods

- - -
None
-

-Methods

- - - - - - - - -
IntIOCounterInstantiierung der IntIOCounter-Klasse.
resetSetzt den Counter des Inputs zurueck.
-

-Static Methods

- - -
None
- -

-IntIOCounter (Constructor)

-IntIOCounter(counter_id, parentdevice, valuelist, iotype, byteorder, signed) -

-Instantiierung der IntIOCounter-Klasse. -

-
counter_id
-
-ID fuer den Counter, zu dem der IO gehoert (0-15) -
-
-
See Also:
-
-IOBase.__init__(...) -
-
-

-IntIOCounter.reset

-reset() -

-Setzt den Counter des Inputs zurueck. -

-
Up
-
- -

IntIOReplaceable

-

-Erweitert die IntIO-Klasse um die .replace_io Funktion. -

-

-Derived from

-IntIO -

-Class Attributes

- - -
__slots__
-

-Class Methods

- - -
None
-

-Methods

- - - - - -
replace_ioErsetzt bestehenden IO mit Neuem.
-

-Static Methods

- - -
None
- -

-IntIOReplaceable.replace_io

-replace_io(name, frm, **kwargs) -

-Ersetzt bestehenden IO mit Neuem. -

- Wenn die kwargs fuer byteorder und defaultvalue nicht angegeben werden, - uebernimmt das System die Daten aus dem ersetzten IO. -

- Es darf nur ein einzelnes Formatzeichen 'frm' uebergeben werden. Daraus - wird dann die benoetigte Laenge an Bytes berechnet und der Datentyp - festgelegt. Moeglich sind: - Bits / Bytes: ?, c, s - Integer : bB, hH, iI, lL, qQ - Float : e, f, d -

- Eine Ausnahme ist die Formatierung 's'. Hier koennen mehrere Bytes - zu einem langen IO zusammengefasst werden. Die Formatierung muss - '8s' fuer z.B. 8 Bytes sein - NICHT 'ssssssss'! -

- Wenn durch die Formatierung mehr Bytes benoetigt werden, als - der urspruenglige IO hat, werden die nachfolgenden IOs ebenfalls - verwendet und entfernt. -

-
name
-
-Name des neuen Inputs -
frm
-
-struct formatierung (1 Zeichen) oder 'ANZAHLs' z.B. '8s' -
kwargs
-
-Weitere Parameter: - - bmk: interne Bezeichnung fuer IO - - bit: Registriert IO als am angegebenen Bit im Byte - - byteorder: Byteorder fuer den IO, Standardwert=little - - defaultvalue: Standardwert fuer IO - - event: Funktion fuer Eventhandling registrieren - - delay: Verzoegerung in ms zum Ausloesen wenn Wert gleich bleibt - - edge: Event ausfuehren bei RISING, FALLING or BOTH Wertaenderung - - as_thread: Fuehrt die event-Funktion als RevPiCallback-Thread aus - - prefire: Ausloesen mit aktuellem Wert, wenn mainloop startet -
-
-
See Also:
-
-Python3 struct -
-
-
Up
-
- -

StructIO

-

-Klasse fuer den Zugriff auf Daten ueber ein definierten struct. -

- Sie stellt ueber struct die Werte in der gewuenschten Formatierung - bereit. Der struct-Formatwert wird bei der Instantiierung festgelegt. -

-
See Also:
-
-IOBase -
-
-

-Derived from

-IOBase -

-Class Attributes

- - -
__slots__
defaultvalue
frm
signed
value
-

-Class Methods

- - -
None
-

-Methods

- - - - - - - - - - - - - - - - - - - - -
StructIOErstellt einen IO mit struct-Formatierung.
_get_frmRuft die struct Formatierung ab.
_get_signedRuft ab, ob der Wert Vorzeichenbehaftet behandelt werden soll.
get_structdefaultvalueGibt die Defaultvalue mit struct Formatierung zurueck.
get_structvalueGibt den Wert mit struct Formatierung zurueck.
set_structvalueSetzt den Wert mit struct Formatierung.
-

-Static Methods

- - -
None
- -

-StructIO (Constructor)

-StructIO(parentio, name, frm, **kwargs) -

-Erstellt einen IO mit struct-Formatierung. -

-
parentio
-
-ParentIO Objekt, welches ersetzt wird -
name
-
-Name des neuen IO -
frm
-
-struct formatierung (1 Zeichen) oder 'ANZAHLs' z.B. '8s' -
kwargs
-
-Weitere Parameter: - - bmk: Bezeichnung fuer IO - - bit: Registriert IO als am angegebenen Bit im Byte - - byteorder: Byteorder fuer IO, Standardwert vom ersetzten IO - - defaultvalue: Standardwert fuer IO, Standard vom ersetzten IO -
-
-

-StructIO._get_frm

-_get_frm() -

-Ruft die struct Formatierung ab. -

-
Returns:
-
-struct Formatierung -
-
-

-StructIO._get_signed

-_get_signed() -

-Ruft ab, ob der Wert Vorzeichenbehaftet behandelt werden soll. -

-
Returns:
-
-True, wenn Vorzeichenbehaftet -
-
-

-StructIO.get_structdefaultvalue

-get_structdefaultvalue() -

-Gibt die Defaultvalue mit struct Formatierung zurueck. -

-
Returns:
-
-Defaultvalue vom Typ der struct-Formatierung -
-
-

-StructIO.get_structvalue

-get_structvalue() -

-Gibt den Wert mit struct Formatierung zurueck. -

-
Returns:
-
-Wert vom Typ der struct-Formatierung -
-
-

-StructIO.set_structvalue

-set_structvalue(value) -

-Setzt den Wert mit struct Formatierung. -

-
value
-
-Wert vom Typ der struct-Formatierung -
-
-
Up
-
- \ No newline at end of file diff --git a/doc/revpimodio2.modio.html b/doc/revpimodio2.modio.html deleted file mode 100644 index 0ef4b11..0000000 --- a/doc/revpimodio2.modio.html +++ /dev/null @@ -1,799 +0,0 @@ - - -revpimodio2.modio - - - -

-revpimodio2.modio

-

-RevPiModIO Hauptklasse fuer piControl0 Zugriff. -

-

-Global Attributes

- - -
__author__
__copyright__
__license__
-

-Classes

- - - - - - - - - - - -
RevPiModIOKlasse fuer die Verwaltung der piCtory Konfiguration.
RevPiModIODriverKlasse um eigene Treiber fuer die virtuellen Devices zu erstellen.
RevPiModIOSelectedKlasse fuer die Verwaltung einzelner Devices aus piCtory.
-

-Functions

- - -
None
-
- -

RevPiModIO

-

-Klasse fuer die Verwaltung der piCtory Konfiguration. -

- Diese Klasse uebernimmt die gesamte Konfiguration aus piCtory und bilded - die Devices und IOs ab. Sie uebernimmt die exklusive Verwaltung des - Prozessabbilds und stellt sicher, dass die Daten synchron sind. - Sollten nur einzelne Devices gesteuert werden, verwendet man - RevPiModIOSelected() und uebergibt bei Instantiierung eine Liste mit - Device Positionen oder Device Namen. -

- -

-

-Derived from

-object -

-Class Attributes

- - -
__slots__
configrsc
cycletime
debug
ioerrors
length
maxioerrors
monitoring
procimg
replace_io_file
simulator
-

-Class Methods

- - -
None
-

-Methods

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
RevPiModIOInstantiiert die Grundfunktionen.
__del__Zerstoert alle Klassen um aufzuraeumen.
__evt_exitEventhandler fuer Programmende.
_configureVerarbeitet die piCtory Konfigurationsdatei.
_configure_replace_ioImportiert ersetzte IOs in diese Instanz.
_create_myfhErstellt FileObject mit Pfad zum procimg.
_get_configrscGetter function.
_get_cpreplaceioLaed die replace_io_file Konfiguration und verarbeitet sie.
_get_cycletimeGibt Aktualisierungsrate in ms der Prozessabbildsynchronisierung aus.
_get_debugGibt Status des Debugflags zurueck.
_get_ioerrorsGetter function.
_get_lengthGetter function.
_get_maxioerrorsGetter function.
_get_monitoringGetter function.
_get_procimgGetter function.
_get_replace_io_fileGibt Pfad zur verwendeten replace IO Datei aus.
_get_simulatorGetter function.
_gotioerrorIOError Verwaltung fuer Prozessabbildzugriff.
_set_cycletimeSetzt Aktualisierungsrate der Prozessabbild-Synchronisierung.
_set_debugSetzt debugging Status um mehr Meldungen zu erhalten oder nicht.
_set_maxioerrorsSetzt Anzahl der maximal erlaubten Fehler bei Prozessabbildzugriff.
_simulate_ioctlSimuliert IOCTL Funktionen auf procimg Datei.
autorefresh_allSetzt alle Devices in autorefresh Funktion.
cleanupBeendet autorefresh und alle Threads.
cycleloopStartet den Cycleloop.
exitBeendet mainloop() und optional autorefresh.
export_replaced_iosExportiert ersetzte IOs dieser Instanz.
get_jconfigrscLaedt die piCtory Konfiguration und erstellt ein .
handlesignalendSignalhandler fuer Programmende verwalten.
mainloopStartet den Mainloop mit Eventueberwachung.
readprocimgEinlesen aller Inputs aller/eines Devices vom Prozessabbild.
resetioerrorsSetzt aktuellen IOError-Zaehler auf 0 zurueck.
setdefaultvaluesAlle Outputbuffer werden auf die piCtory default Werte gesetzt.
syncoutputsLesen aller aktuell gesetzten Outputs im Prozessabbild.
writeprocimgSchreiben aller Outputs aller Devices ins Prozessabbild.
-

-Static Methods

- - -
None
- -

-RevPiModIO (Constructor)

-RevPiModIO(autorefresh=False, monitoring=False, syncoutputs=True, procimg=None, configrsc=None, simulator=False, debug=True, replace_io_file=None, direct_output=False) -

-Instantiiert die Grundfunktionen. -

-
autorefresh
-
-Wenn True, alle Devices zu autorefresh hinzufuegen -
monitoring
-
-In- und Outputs werden gelesen, niemals geschrieben -
syncoutputs
-
-Aktuell gesetzte Outputs vom Prozessabbild einlesen -
procimg
-
-Abweichender Pfad zum Prozessabbild -
configrsc
-
-Abweichender Pfad zur piCtory Konfigurationsdatei -
simulator
-
-Laedt das Modul als Simulator und vertauscht IOs -
debug
-
-Gibt alle Warnungen inkl. Zyklusprobleme aus -
replace_io_file
-
-Replace IO Konfiguration aus Datei laden -
direct_output
-
-Write outputs immediately to process image (slow) -
-
-

-RevPiModIO.__del__

-__del__() -

-Zerstoert alle Klassen um aufzuraeumen. -

-

-RevPiModIO.__evt_exit

-__evt_exit(signum, sigframe) -

-Eventhandler fuer Programmende. -

-
signum
-
-Signalnummer -
sigframe
-
-Signalframe -
-
-

-RevPiModIO._configure

-_configure(jconfigrsc) -

-Verarbeitet die piCtory Konfigurationsdatei. -

-
jconfigrsc:
-
-Data to build IOs as of JSON -
-
-

-RevPiModIO._configure_replace_io

-_configure_replace_io(creplaceio) -

-Importiert ersetzte IOs in diese Instanz. -

- Importiert ersetzte IOs, welche vorher mit .export_replaced_ios(...) - in eine Datei exportiert worden sind. Diese IOs werden in dieser - Instanz wiederhergestellt. -

-
ireplaceio:
-
-Data to replace ios as -
-
-

-RevPiModIO._create_myfh

-_create_myfh() -

-Erstellt FileObject mit Pfad zum procimg. - return FileObject -

-

-RevPiModIO._get_configrsc

-_get_configrsc() -

-Getter function. -

-
Returns:
-
-Pfad der verwendeten piCtory Konfiguration -
-
-

-RevPiModIO._get_cpreplaceio

-_get_cpreplaceio() -

-Laed die replace_io_file Konfiguration und verarbeitet sie. -

-
Returns:
-
- der replace io daten -
-
-

-RevPiModIO._get_cycletime

-_get_cycletime() -

-Gibt Aktualisierungsrate in ms der Prozessabbildsynchronisierung aus. -

-
Returns:
-
-Millisekunden -
-
-

-RevPiModIO._get_debug

-_get_debug() -

-Gibt Status des Debugflags zurueck. -

-
Returns:
-
-Status des Debugflags -
-
-

-RevPiModIO._get_ioerrors

-_get_ioerrors() -

-Getter function. -

-
Returns:
-
-Aktuelle Anzahl gezaehlter Fehler -
-
-

-RevPiModIO._get_length

-_get_length() -

-Getter function. -

-
Returns:
-
-Laenge in Bytes der Devices -
-
-

-RevPiModIO._get_maxioerrors

-_get_maxioerrors() -

-Getter function. -

-
Returns:
-
-Anzahl erlaubte Fehler -
-
-

-RevPiModIO._get_monitoring

-_get_monitoring() -

-Getter function. -

-
Returns:
-
-True, wenn als Monitoring gestartet -
-
-

-RevPiModIO._get_procimg

-_get_procimg() -

-Getter function. -

-
Returns:
-
-Pfad des verwendeten Prozessabbilds -
-
-

-RevPiModIO._get_replace_io_file

-_get_replace_io_file() -

-Gibt Pfad zur verwendeten replace IO Datei aus. -

-
Returns:
-
-Pfad zur replace IO Datei -
-
-

-RevPiModIO._get_simulator

-_get_simulator() -

-Getter function. -

-
Returns:
-
-True, wenn als Simulator gestartet -
-
-

-RevPiModIO._gotioerror

-_gotioerror(action, e=None, show_warn=True) -

-IOError Verwaltung fuer Prozessabbildzugriff. -

-
action
-
-Zusatzinformationen zum loggen -
e
-
-Exception to log if debug is enabled -
show_warn
-
-Warnung anzeigen -
-
-

-RevPiModIO._set_cycletime

-_set_cycletime(milliseconds) -

-Setzt Aktualisierungsrate der Prozessabbild-Synchronisierung. -

-
milliseconds
-
- in Millisekunden -
-
-

-RevPiModIO._set_debug

-_set_debug(value) -

-Setzt debugging Status um mehr Meldungen zu erhalten oder nicht. -

-
value
-
-Wenn True, werden umfangreiche Medungen angezeigt -
-
-

-RevPiModIO._set_maxioerrors

-_set_maxioerrors(value) -

-Setzt Anzahl der maximal erlaubten Fehler bei Prozessabbildzugriff. -

-
value
-
-Anzahl erlaubte Fehler -
-
-

-RevPiModIO._simulate_ioctl

-_simulate_ioctl(request, arg=b'') -

-Simuliert IOCTL Funktionen auf procimg Datei. -

-
request
-
-IO Request -
arg:
-
-Request argument -
-
-

-RevPiModIO.autorefresh_all

-autorefresh_all() -

-Setzt alle Devices in autorefresh Funktion. -

-

-RevPiModIO.cleanup

-cleanup() -

-Beendet autorefresh und alle Threads. -

-

-RevPiModIO.cycleloop

-cycleloop(func, cycletime=50) -

-Startet den Cycleloop. -

- Der aktuelle Programmthread wird hier bis Aufruf von - .exit() "gefangen". Er fuehrt nach jeder Aktualisierung - des Prozessabbilds die uebergebene Funktion "func" aus und arbeitet sie - ab. Waehrend der Ausfuehrung der Funktion wird das Prozessabbild nicht - weiter aktualisiert. Die Inputs behalten bis zum Ende den aktuellen - Wert. Gesetzte Outputs werden nach Ende des Funktionsdurchlaufs in das - Prozessabbild geschrieben. -

- Verlassen wird der Cycleloop, wenn die aufgerufene Funktion einen - Rueckgabewert nicht gleich None liefert (z.B. return True), oder durch - Aufruf von .exit(). -

- HINWEIS: Die Aktualisierungszeit und die Laufzeit der Funktion duerfen - die eingestellte autorefresh Zeit, bzw. uebergebene cycletime nicht - ueberschreiten! -

- Ueber den Parameter cycletime wird die gewuenschte Zukluszeit der - uebergebenen Funktion gesetzt. Der Standardwert betraegt - 50 Millisekunden, in denen das Prozessabild eingelesen, die uebergebene - Funktion ausgefuert und das Prozessabbild geschrieben wird. -

-
func
-
-Funktion, die ausgefuehrt werden soll -
cycletime
-
-Zykluszeit in Millisekunden - Standardwert 50 ms -
-
-
Returns:
-
-None -
-
-

-RevPiModIO.exit

-exit(full=True) -

-Beendet mainloop() und optional autorefresh. -

- Wenn sich das Programm im mainloop() befindet, wird durch Aufruf - von exit() die Kontrolle wieder an das Hauptprogramm zurueckgegeben. -

- Der Parameter full ist mit True vorbelegt und entfernt alle Devices aus - dem autorefresh. Der Thread fuer die Prozessabbildsynchronisierung - wird dann gestoppt und das Programm kann sauber beendet werden. -

-
full
-
-Entfernt auch alle Devices aus autorefresh -
-
-

-RevPiModIO.export_replaced_ios

-export_replaced_ios(filename="replace_ios.conf") -

-Exportiert ersetzte IOs dieser Instanz. -

- Exportiert alle ersetzten IOs, welche mit .replace_io(...) angelegt - wurden. Die Datei kann z.B. fuer RevPiPyLoad verwndet werden um Daten - in den neuen Formaten per MQTT zu uebertragen oder mit RevPiPyControl - anzusehen. -

-
filename
-
-Dateiname fuer Exportdatei -
-
-

-RevPiModIO.get_jconfigrsc

-get_jconfigrsc() -

-Laedt die piCtory Konfiguration und erstellt ein . -

-
Returns:
-
- der piCtory Konfiguration -
-
-

-RevPiModIO.handlesignalend

-handlesignalend(cleanupfunc=None) -

-Signalhandler fuer Programmende verwalten. -

- Wird diese Funktion aufgerufen, uebernimmt RevPiModIO die SignalHandler - fuer SIGINT und SIGTERM. Diese werden Empfangen, wenn das - Betriebssystem oder der Benutzer das Steuerungsprogramm sauber beenden - will. -

- Die optionale Funktion "cleanupfunc" wird als letztes nach dem letzten - Einlesen der Inputs ausgefuehrt. Dort gesetzte Outputs werden nach - Ablauf der Funktion ein letztes Mal geschrieben. - Gedacht ist dies fuer Aufraeumarbeiten, wie z.B. das abschalten der - LEDs am RevPi-Core. -

- Nach einmaligem Empfangen eines der Signale und dem Beenden der - RevPiModIO Thrads / Funktionen werden die SignalHandler wieder - freigegeben. -

-
cleanupfunc
-
-Funktion wird nach dem letzten Lesen der Inputs - ausgefuehrt, gefolgt vom letzten Schreiben der Outputs -
-
-

-RevPiModIO.mainloop

-mainloop(blocking=True) -

-Startet den Mainloop mit Eventueberwachung. -

- Der aktuelle Programmthread wird hier bis Aufruf von - RevPiDevicelist.exit() "gefangen" (es sei denn blocking=False). Er - durchlaeuft die Eventueberwachung und prueft Aenderungen der, mit - einem Event registrierten, IOs. Wird eine Veraenderung erkannt, - fuert das Programm die dazugehoerigen Funktionen der Reihe nach aus. -

- Wenn der Parameter "blocking" mit False angegeben wird, aktiviert - dies die Eventueberwachung und blockiert das Programm NICHT an der - Stelle des Aufrufs. Eignet sich gut fuer die GUI Programmierung, wenn - Events vom RevPi benoetigt werden, aber das Programm weiter ausgefuehrt - werden soll. -

-
blocking
-
-Wenn False, blockiert das Programm hier NICHT -
-
-
Returns:
-
-None -
-
-

-RevPiModIO.readprocimg

-readprocimg(device=None) -

-Einlesen aller Inputs aller/eines Devices vom Prozessabbild. -

- Devices mit aktiverem autorefresh werden ausgenommen! -

-
device
-
-nur auf einzelnes Device anwenden -
-
-
Returns:
-
-True, wenn Arbeiten an allen Devices erfolgreich waren -
-
-

-RevPiModIO.resetioerrors

-resetioerrors() -

-Setzt aktuellen IOError-Zaehler auf 0 zurueck. -

-

-RevPiModIO.setdefaultvalues

-setdefaultvalues(device=None) -

-Alle Outputbuffer werden auf die piCtory default Werte gesetzt. -

-
device
-
-nur auf einzelnes Device anwenden -
-
-

-RevPiModIO.syncoutputs

-syncoutputs(device=None) -

-Lesen aller aktuell gesetzten Outputs im Prozessabbild. -

- Devices mit aktiverem autorefresh werden ausgenommen! -

-
device
-
-nur auf einzelnes Device anwenden -
-
-
Returns:
-
-True, wenn Arbeiten an allen Devices erfolgreich waren -
-
-

-RevPiModIO.writeprocimg

-writeprocimg(device=None) -

-Schreiben aller Outputs aller Devices ins Prozessabbild. -

- Devices mit aktiverem autorefresh werden ausgenommen! -

-
device
-
-nur auf einzelnes Device anwenden -
-
-
Returns:
-
-True, wenn Arbeiten an allen Devices erfolgreich waren -
-
-
Up
-
- -

RevPiModIODriver

-

-Klasse um eigene Treiber fuer die virtuellen Devices zu erstellen. -

- Mit dieser Klasse werden nur angegebene Virtuelle Devices mit RevPiModIO - verwaltet. Bei Instantiierung werden automatisch die Inputs und Outputs - verdreht, um das Schreiben der Inputs zu ermoeglichen. Die Daten koennen - dann ueber logiCAD an den Devices abgerufen werden. -

- -

-

-Derived from

-RevPiModIOSelected -

-Class Attributes

- - -
__slots__
-

-Class Methods

- - -
None
-

-Methods

- - - - - -
RevPiModIODriverInstantiiert die Grundfunktionen.
-

-Static Methods

- - -
None
- -

-RevPiModIODriver (Constructor)

-RevPiModIODriver(virtdev, autorefresh=False, monitoring=False, syncoutputs=True, procimg=None, configrsc=None, debug=True, replace_io_file=None, direct_output=False) -

-Instantiiert die Grundfunktionen. -

- Parameter 'monitoring' und 'simulator' stehen hier nicht zur - Verfuegung, da diese automatisch gesetzt werden. -

-
virtdev
-
-Virtuelles Device oder mehrere als -
-
-
See Also:
-
-RevPiModIO.__init__(...) -
-
-
Up
-
- -

RevPiModIOSelected

-

-Klasse fuer die Verwaltung einzelner Devices aus piCtory. -

- Diese Klasse uebernimmt nur angegebene Devices der piCtory Konfiguration - und bilded sie inkl. IOs ab. Sie uebernimmt die exklusive Verwaltung des - Adressbereichs im Prozessabbild an dem sich die angegebenen Devices - befinden und stellt sicher, dass die Daten synchron sind. -

- -

-

-Derived from

-RevPiModIO -

-Class Attributes

- - -
__slots__
-

-Class Methods

- - -
None
-

-Methods

- - - - - -
RevPiModIOSelectedInstantiiert nur fuer angegebene Devices die Grundfunktionen.
-

-Static Methods

- - -
None
- -

-RevPiModIOSelected (Constructor)

-RevPiModIOSelected(deviceselection, autorefresh=False, monitoring=False, syncoutputs=True, procimg=None, configrsc=None, simulator=False, debug=True, replace_io_file=None, direct_output=False) -

-Instantiiert nur fuer angegebene Devices die Grundfunktionen. -

- Der Parameter deviceselection kann eine einzelne - Device Position / einzelner Device Name sein oder eine Liste mit - mehreren Positionen / Namen -

-
deviceselection
-
-Positionsnummer oder Devicename -
-
-
See Also:
-
-RevPiModIO.__init__(...) -
-
-
Up
-
- \ No newline at end of file diff --git a/doc/revpimodio2.netio.html b/doc/revpimodio2.netio.html deleted file mode 100644 index 356e041..0000000 --- a/doc/revpimodio2.netio.html +++ /dev/null @@ -1,806 +0,0 @@ - - -revpimodio2.netio - - - -

-revpimodio2.netio

-

-RevPiModIO Hauptklasse fuer Netzwerkzugriff. -

-

-Global Attributes

- - -
HASH_FAIL
__author__
__copyright__
__license__
_sysdeldirty
_sysexit
_sysflush
_syspictory
_syspictoryh
_sysreplaceio
_sysreplaceioh
_syssync
-

-Classes

- - - - - - - - - - - - - - - - - - - - -
AclExceptionProbleme mit Berechtigungen.
ConfigChangedAenderung der piCtory oder replace_ios Datei.
NetFHNetzwerk File Handler fuer das Prozessabbild.
RevPiNetIOKlasse fuer die Verwaltung der piCtory Konfiguration ueber das Netzwerk.
RevPiNetIODriverKlasse um eigene Treiber fuer die virtuellen Devices zu erstellen.
RevPiNetIOSelectedKlasse fuer die Verwaltung einzelner Devices aus piCtory.
-

-Functions

- - -
None
-
- -

AclException

-

-Probleme mit Berechtigungen. -

-

-Derived from

-Exception -

-Class Attributes

- - -
None
-

-Class Methods

- - -
None
-

-Methods

- - -
None
-

-Static Methods

- - -
None
- -
Up
-
- -

ConfigChanged

-

-Aenderung der piCtory oder replace_ios Datei. -

-

-Derived from

-Exception -

-Class Attributes

- - -
None
-

-Class Methods

- - -
None
-

-Methods

- - -
None
-

-Static Methods

- - -
None
- -
Up
-
- -

NetFH

-

-Netzwerk File Handler fuer das Prozessabbild. -

- Dieses FileObject-like Object verwaltet das Lesen und Schriben des - Prozessabbilds ueber das Netzwerk. Ein entfernter Revolution Pi kann - so gesteuert werden. -

- -

-

-Derived from

-Thread -

-Class Attributes

- - -
__slots__
closed
config_changed
name
reconnecting
timeout
-

-Class Methods

- - -
None
-

-Methods

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
NetFHInit NetFH-class.
__check_aclPueft ob ACL auf RevPi den Vorgang erlaubt oder wirft exception.
__del__NetworkFileHandler beenden.
__set_systimeoutSystemfunktion fuer Timeoutberechnung.
_connectStellt die Verbindung zu einem RevPiSlave her.
_direct_sendFuer debugging direktes Senden von Daten.
clear_dirtybytesEntfernt die konfigurierten Dirtybytes vom RevPi Slave.
closeVerbindung trennen.
flushSchreibpuffer senden.
get_closedPruefen ob Verbindung geschlossen ist.
get_config_changedPruefen ob RevPi Konfiguration geaendert wurde.
get_nameVerbindugnsnamen zurueckgeben.
get_reconnectingInterner reconnect aktiv wegen Netzwerkfehlern.
get_timeoutGibt aktuellen Timeout zurueck.
ioctlIOCTL Befehle ueber das Netzwerk senden.
readDaten ueber das Netzwerk lesen.
readpictoryRuft die piCtory Konfiguration ab.
readreplaceioRuft die replace_io Konfiguration ab.
runHandler fuer Synchronisierung.
seekSpringt an angegebene Position.
set_dirtybytesKonfiguriert Dirtybytes fuer Prozessabbild bei Verbindungsfehler.
set_timeoutSetzt Timeoutwert fuer Verbindung.
tellGibt aktuelle Position zurueck.
writeDaten ueber das Netzwerk schreiben.
-

-Static Methods

- - -
None
- -

-NetFH (Constructor)

-NetFH(address, check_replace_ios, timeout=500) -

-Init NetFH-class. -

-
address
-
-IP Adresse, Port des RevPi als -
check_replace_ios
-
-Prueft auf Veraenderungen der Datei -
timeout
-
-Timeout in Millisekunden der Verbindung -
-
-

-NetFH.__check_acl

-__check_acl(bytecode) -

-Pueft ob ACL auf RevPi den Vorgang erlaubt oder wirft exception. -

-

-NetFH.__del__

-__del__() -

-NetworkFileHandler beenden. -

-

-NetFH.__set_systimeout

-__set_systimeout(value) -

-Systemfunktion fuer Timeoutberechnung. -

-
value
-
-Timeout in Millisekunden 100 - 60000 -
-
-

-NetFH._connect

-_connect() -

-Stellt die Verbindung zu einem RevPiSlave her. -

-

-NetFH._direct_send

-_direct_send(send_bytes, recv_count) -

-Fuer debugging direktes Senden von Daten. -

-
send_bytes
-
-Bytes, die gesendet werden sollen -
recv_count
-
-Anzahl der Empfangsbytes -
-
-
Returns:
-
-Empfangende Bytes -
-
-

-NetFH.clear_dirtybytes

-clear_dirtybytes(position=None) -

-Entfernt die konfigurierten Dirtybytes vom RevPi Slave. -

-
position
-
-Startposition der Dirtybytes -
-
-

-NetFH.close

-close() -

-Verbindung trennen. -

-

-NetFH.flush

-flush() -

-Schreibpuffer senden. -

-

-NetFH.get_closed

-get_closed() -

-Pruefen ob Verbindung geschlossen ist. -

-
Returns:
-
-True, wenn Verbindung geschlossen ist -
-
-

-NetFH.get_config_changed

-get_config_changed() -

-Pruefen ob RevPi Konfiguration geaendert wurde. -

-
Returns:
-
-True, wenn RevPi Konfiguration geaendert ist -
-
-

-NetFH.get_name

-get_name() -

-Verbindugnsnamen zurueckgeben. -

-
Returns:
-
- IP:PORT -
-
-

-NetFH.get_reconnecting

-get_reconnecting() -

-Interner reconnect aktiv wegen Netzwerkfehlern. -

-
Returns:
-
-True, wenn reconnect aktiv -
-
-

-NetFH.get_timeout

-get_timeout() -

-Gibt aktuellen Timeout zurueck. -

-
Returns:
-
- in Millisekunden -
-
-

-NetFH.ioctl

-ioctl(request, arg=b'') -

-IOCTL Befehle ueber das Netzwerk senden. -

-
request
-
-Request as -
arg
-
-Argument as -
-
-

-NetFH.read

-read(length) -

-Daten ueber das Netzwerk lesen. -

-
length
-
-Anzahl der Bytes -
-
-
Returns:
-
-Gelesene -
-
-

-NetFH.readpictory

-readpictory() -

-Ruft die piCtory Konfiguration ab. -

-
Returns:
-
- piCtory Datei -
-
-

-NetFH.readreplaceio

-readreplaceio() -

-Ruft die replace_io Konfiguration ab. -

-
Returns:
-
- replace_io_file -
-
-

-NetFH.run

-run() -

-Handler fuer Synchronisierung. -

-

-NetFH.seek

-seek(position) -

-Springt an angegebene Position. -

-
position
-
-An diese Position springen -
-
-

-NetFH.set_dirtybytes

-set_dirtybytes(position, dirtybytes) -

-Konfiguriert Dirtybytes fuer Prozessabbild bei Verbindungsfehler. -

-
positon
-
-Startposition zum Schreiben -
dirtybytes
-
- die geschrieben werden sollen -
-
-

-NetFH.set_timeout

-set_timeout(value) -

-Setzt Timeoutwert fuer Verbindung. -

-
value
-
-Timeout in Millisekunden -
-
-

-NetFH.tell

-tell() -

-Gibt aktuelle Position zurueck. -

-
Returns:
-
-int aktuelle Position -
-
-

-NetFH.write

-write(bytebuff) -

-Daten ueber das Netzwerk schreiben. -

-
bytebuff
-
-Bytes zum schreiben -
-
-
Returns:
-
- Anzahl geschriebener bytes -
-
-
Up
-
- -

RevPiNetIO

-

-Klasse fuer die Verwaltung der piCtory Konfiguration ueber das Netzwerk. -

- Diese Klasse uebernimmt die gesamte Konfiguration aus piCtory und bilded - die Devices und IOs ab. Sie uebernimmt die exklusive Verwaltung des - Prozessabbilds und stellt sicher, dass die Daten synchron sind. - Sollten nur einzelne Devices gesteuert werden, verwendet man - RevPiModIOSelected() und uebergibt bei Instantiierung eine Liste mit - Device Positionen oder Device Namen. -

- -

-

-Derived from

-_RevPiModIO -

-Class Attributes

- - -
__slots__
config_changed
reconnecting
-

-Class Methods

- - -
None
-

-Methods

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
RevPiNetIOInstantiiert die Grundfunktionen.
_create_myfhErstellt NetworkFileObject.
_get_cpreplaceioLaed die replace_io Konfiguration ueber das Netzwerk.
disconnectTrennt Verbindungen und beendet autorefresh inkl.
exitBeendet mainloop() und optional autorefresh.
get_config_changedPruefen ob RevPi Konfiguration geaendert wurde.
get_jconfigrscLaedt die piCotry Konfiguration und erstellt ein .
get_reconnectingInterner reconnect aktiv wegen Netzwerkfehlern.
net_cleardefaultvaluesLoescht Defaultwerte vom PLC Slave.
net_setdefaultvaluesKonfiguriert den PLC Slave mit den piCtory Defaultwerten.
-

-Static Methods

- - -
None
- -

-RevPiNetIO (Constructor)

-RevPiNetIO(address, autorefresh=False, monitoring=False, syncoutputs=True, simulator=False, debug=True, replace_io_file=None, direct_output=False) -

-Instantiiert die Grundfunktionen. -

-
address:
-
-IP-Adresse / (IP, Port) -
autorefresh
-
-Wenn True, alle Devices zu autorefresh hinzufuegen -
monitoring
-
-In- und Outputs werden gelesen, niemals geschrieben -
syncoutputs
-
-Aktuell gesetzte Outputs vom Prozessabbild einlesen -
simulator
-
-Laedt das Modul als Simulator und vertauscht IOs -
debug
-
-Gibt bei allen Fehlern komplette Meldungen aus -
replace_io_file
-
-Replace IO Konfiguration aus Datei laden -
direct_output
-
-Write outputs immediately to process image (slow) -
-
-

-RevPiNetIO._create_myfh

-_create_myfh() -

-Erstellt NetworkFileObject. - return FileObject -

-

-RevPiNetIO._get_cpreplaceio

-_get_cpreplaceio() -

-Laed die replace_io Konfiguration ueber das Netzwerk. -

-
Returns:
-
- der replace io daten -
-
-

-RevPiNetIO.disconnect

-disconnect() -

-Trennt Verbindungen und beendet autorefresh inkl. alle Threads. -

-

-RevPiNetIO.exit

-exit(full=True) -

-Beendet mainloop() und optional autorefresh. -

-
See Also:
-
-#RevPiModIO.exit(...) -
-
-

-RevPiNetIO.get_config_changed

-get_config_changed() -

-Pruefen ob RevPi Konfiguration geaendert wurde. -

- In diesem Fall ist die Verbindung geschlossen und RevPiNetIO muss - neu instanziert werden. -

-
Returns:
-
-True, wenn RevPi Konfiguration geaendert ist -
-
-

-RevPiNetIO.get_jconfigrsc

-get_jconfigrsc() -

-Laedt die piCotry Konfiguration und erstellt ein . -

-
Returns:
-
- der piCtory Konfiguration -
-
-

-RevPiNetIO.get_reconnecting

-get_reconnecting() -

-Interner reconnect aktiv wegen Netzwerkfehlern. -

- Das Modul versucht intern die Verbindung neu herzustellen. Es ist - kein weiteres Zutun noetig. -

-
Returns:
-
-True, wenn reconnect aktiv -
-
-

-RevPiNetIO.net_cleardefaultvalues

-net_cleardefaultvalues(device=None) -

-Loescht Defaultwerte vom PLC Slave. -

-
device
-
-nur auf einzelnes Device anwenden, sonst auf Alle -
-
-

-RevPiNetIO.net_setdefaultvalues

-net_setdefaultvalues(device=None) -

-Konfiguriert den PLC Slave mit den piCtory Defaultwerten. -

-
device
-
-nur auf einzelnes Device anwenden, sonst auf Alle -
-
-
Up
-
- -

RevPiNetIODriver

-

-Klasse um eigene Treiber fuer die virtuellen Devices zu erstellen. -

- Mit dieser Klasse werden nur angegebene Virtuelle Devices mit RevPiModIO - verwaltet. Bei Instantiierung werden automatisch die Inputs und Outputs - verdreht, um das Schreiben der Inputs zu ermoeglichen. Die Daten koennen - dann ueber logiCAD an den Devices abgerufen werden. -

- -

-

-Derived from

-RevPiNetIOSelected -

-Class Attributes

- - -
__slots__
-

-Class Methods

- - -
None
-

-Methods

- - - - - -
RevPiNetIODriverInstantiiert die Grundfunktionen.
-

-Static Methods

- - -
None
- -

-RevPiNetIODriver (Constructor)

-RevPiNetIODriver(address, virtdev, autorefresh=False, monitoring=False, syncoutputs=True, debug=True, replace_io_file=None, direct_output=False) -

-Instantiiert die Grundfunktionen. -

- Parameter 'monitoring' und 'simulator' stehen hier nicht zur - Verfuegung, da diese automatisch gesetzt werden. -

-
address:
-
-IP-Adresse / (IP, Port) -
virtdev
-
-Virtuelles Device oder mehrere als -
-
-
See Also:
-
-RevPiModIO.__init__(...) -
-
-
Up
-
- -

RevPiNetIOSelected

-

-Klasse fuer die Verwaltung einzelner Devices aus piCtory. -

- Diese Klasse uebernimmt nur angegebene Devices der piCtory Konfiguration - und bilded sie inkl. IOs ab. Sie uebernimmt die exklusive Verwaltung des - Adressbereichs im Prozessabbild an dem sich die angegebenen Devices - befinden und stellt sicher, dass die Daten synchron sind. -

- -

-

-Derived from

-RevPiNetIO -

-Class Attributes

- - -
__slots__
-

-Class Methods

- - -
None
-

-Methods

- - - - - -
RevPiNetIOSelectedInstantiiert nur fuer angegebene Devices die Grundfunktionen.
-

-Static Methods

- - -
None
- -

-RevPiNetIOSelected (Constructor)

-RevPiNetIOSelected(address, deviceselection, autorefresh=False, monitoring=False, syncoutputs=True, simulator=False, debug=True, replace_io_file=None, direct_output=False) -

-Instantiiert nur fuer angegebene Devices die Grundfunktionen. -

- Der Parameter deviceselection kann eine einzelne - Device Position / einzelner Device Name sein oder eine Liste mit - mehreren Positionen / Namen -

-
address:
-
-IP-Adresse / (IP, Port) -
deviceselection
-
-Positionsnummer oder Devicename -
-
-
See Also:
-
-RevPiNetIO.__init__(...) -
-
-
Up
-
- \ No newline at end of file diff --git a/doc/revpimodio2.summary.html b/doc/revpimodio2.summary.html deleted file mode 100644 index dd61e6e..0000000 --- a/doc/revpimodio2.summary.html +++ /dev/null @@ -1,76 +0,0 @@ - - -revpimodio2.summary - - - -

-revpimodio2.summary

-

-Bildet die Summary-Sektion von piCtory ab. -

-

-Global Attributes

- - -
__author__
__copyright__
__license__
-

-Classes

- - - - - -
SummaryBildet die Summary-Sektion der config.rsc ab.
-

-Functions

- - -
None
-
- -

Summary

-

-Bildet die Summary-Sektion der config.rsc ab. -

-

-Derived from

-object -

-Class Attributes

- - -
__slots__
-

-Class Methods

- - -
None
-

-Methods

- - - - - -
SummaryInstantiiert die RevPiSummary-Klasse.
-

-Static Methods

- - -
None
- -

-Summary (Constructor)

-Summary(summary) -

-Instantiiert die RevPiSummary-Klasse. -

-
summary
-
-piCtory Summaryinformationen -
-
-
Up
-
- \ No newline at end of file diff --git a/docs/Makefile b/docs/Makefile new file mode 100644 index 0000000..c35888f --- /dev/null +++ b/docs/Makefile @@ -0,0 +1,20 @@ +# Minimal makefile for Sphinx documentation +# + +# You can set these variables from the command line. +SPHINXOPTS = +SPHINXBUILD = sphinx-build +SPHINXPROJ = RevPiModIO2 +SOURCEDIR = . +BUILDDIR = _build + +# Put it first so that "make" without argument is like "make help". +help: + @$(SPHINXBUILD) -M help "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O) + +.PHONY: help Makefile + +# Catch-all target: route all unknown targets to Sphinx using the new +# "make mode" option. $(O) is meant as a shortcut for $(SPHINXOPTS). +%: Makefile + @$(SPHINXBUILD) -M $@ "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O) \ No newline at end of file diff --git a/docs/conf.py b/docs/conf.py new file mode 100644 index 0000000..2c735de --- /dev/null +++ b/docs/conf.py @@ -0,0 +1,174 @@ +#!/usr/bin/env python3 +# -*- coding: utf-8 -*- +# +# RevPiModIO2 documentation build configuration file, created by +# sphinx-quickstart on Sun Oct 20 12:38:53 2019. +# +# This file is execfile()d with the current directory set to its +# containing dir. +# +# Note that not all possible configuration values are present in this +# autogenerated file. +# +# All configuration values have a default; values that are commented out +# serve to show the default. + +# If extensions (or modules to document with autodoc) are in another directory, +# add these directories to sys.path here. If the directory is relative to the +# documentation root, use os.path.abspath to make it absolute, like shown here. +# +import os +import sys +sys.path.insert(0, os.path.abspath('../')) + +from revpimodio2 import __version__ + +# -- General configuration ------------------------------------------------ + +# If your documentation needs a minimal Sphinx version, state it here. +# +# needs_sphinx = '1.0' + +# Add any Sphinx extension module names here, as strings. They can be +# extensions coming with Sphinx (named 'sphinx.ext.*') or your custom +# ones. +extensions = [ + 'sphinx.ext.autodoc', + 'sphinx.ext.todo', + 'sphinx.ext.viewcode' +] + +# Add any paths that contain templates here, relative to this directory. +templates_path = ['_templates'] + +# The suffix(es) of source filenames. +# You can specify multiple suffix as a list of string: +# +# source_suffix = ['.rst', '.md'] +source_suffix = '.rst' + +# The master toctree document. +master_doc = 'index' + +# General information about the project. +project = 'RevPiModIO2' +copyright = '2019, Sven Sager (NaruX)' +author = 'Sven Sager (NaruX)' + +# The version info for the project you're documenting, acts as replacement for +# |version| and |release|, also used in various other places throughout the +# built documents. +# +# The short X.Y version. +version = __version__ +# The full version, including alpha/beta/rc tags. +# release = '' + +# The language for content autogenerated by Sphinx. Refer to documentation +# for a list of supported languages. +# +# This is also used if you do content translation via gettext catalogs. +# Usually you set "language" from the command line for these cases. +language = None + +# List of patterns, relative to source directory, that match files and +# directories to ignore when looking for source files. +# This patterns also effect to html_static_path and html_extra_path +exclude_patterns = ['_build', 'Thumbs.db', '.DS_Store'] + +# The name of the Pygments (syntax highlighting) style to use. +pygments_style = 'sphinx' + +# If true, `todo` and `todoList` produce output, else they produce nothing. +todo_include_todos = True + + +# -- Options for HTML output ---------------------------------------------- + +# The theme to use for HTML and HTML Help pages. See the documentation for +# a list of builtin themes. +# +html_theme = 'alabaster' + +# Theme options are theme-specific and customize the look and feel of a theme +# further. For a list of options available for each theme, see the +# documentation. +# +# html_theme_options = {} + +# Add any paths that contain custom static files (such as style sheets) here, +# relative to this directory. They are copied after the builtin static files, +# so a file named "default.css" will overwrite the builtin "default.css". +html_static_path = ['_static'] + +# Custom sidebar templates, must be a dictionary that maps document names +# to template names. +# +# This is required for the alabaster theme +# refs: http://alabaster.readthedocs.io/en/latest/installation.html#sidebars +html_sidebars = { + '**': [ + 'relations.html', # needs 'show_related': True theme option to display + 'searchbox.html', + ] +} + + +# -- Options for HTMLHelp output ------------------------------------------ + +# Output file base name for HTML help builder. +htmlhelp_basename = 'RevPiModIO2doc' + + +# -- Options for LaTeX output --------------------------------------------- + +latex_elements = { + # The paper size ('letterpaper' or 'a4paper'). + # + # 'papersize': 'letterpaper', + + # The font size ('10pt', '11pt' or '12pt'). + # + # 'pointsize': '10pt', + + # Additional stuff for the LaTeX preamble. + # + # 'preamble': '', + + # Latex figure (float) alignment + # + # 'figure_align': 'htbp', +} + +# Grouping the document tree into LaTeX files. List of tuples +# (source start file, target name, title, +# author, documentclass [howto, manual, or own class]). +latex_documents = [ + (master_doc, 'RevPiModIO2.tex', 'RevPiModIO2 Documentation', + 'Sven Sager (NaruX)', 'manual'), +] + + +# -- Options for manual page output --------------------------------------- + +# One entry per manual page. List of tuples +# (source start file, name, description, authors, manual section). +man_pages = [ + (master_doc, 'revpimodio2', 'RevPiModIO2 Documentation', + [author], 1) +] + + +# -- Options for Texinfo output ------------------------------------------- + +# Grouping the document tree into Texinfo files. List of tuples +# (source start file, target name, title, author, +# dir menu entry, description, category) +texinfo_documents = [ + (master_doc, 'RevPiModIO2', 'RevPiModIO2 Documentation', + author, 'RevPiModIO2', 'One line description of project.', + 'Miscellaneous'), +] + + + diff --git a/docs/index.rst b/docs/index.rst new file mode 100644 index 0000000..7762839 --- /dev/null +++ b/docs/index.rst @@ -0,0 +1,20 @@ +.. RevPiModIO2 documentation master file, created by + sphinx-quickstart on Sun Oct 20 12:38:53 2019. + You can adapt this file completely to your liking, but it should at least + contain the root `toctree` directive. + +Welcome to RevPiModIO2's documentation! +======================================= + +.. toctree:: + :maxdepth: 2 + :caption: Contents: + + + +Indices and tables +================== + +* :ref:`genindex` +* :ref:`modindex` +* :ref:`search` diff --git a/docs/modules.rst b/docs/modules.rst new file mode 100644 index 0000000..c622db6 --- /dev/null +++ b/docs/modules.rst @@ -0,0 +1,7 @@ +revpimodio2 +=========== + +.. toctree:: + :maxdepth: 4 + + revpimodio2 diff --git a/docs/revpimodio2.rst b/docs/revpimodio2.rst new file mode 100644 index 0000000..6668bf0 --- /dev/null +++ b/docs/revpimodio2.rst @@ -0,0 +1,70 @@ +revpimodio2 package +=================== + +Submodules +---------- + +revpimodio2\.app module +----------------------- + +.. automodule:: revpimodio2.app + :members: + :undoc-members: + :show-inheritance: + +revpimodio2\.device module +-------------------------- + +.. automodule:: revpimodio2.device + :members: + :undoc-members: + :show-inheritance: + +revpimodio2\.helper module +-------------------------- + +.. automodule:: revpimodio2.helper + :members: + :undoc-members: + :show-inheritance: + +revpimodio2\.io module +---------------------- + +.. automodule:: revpimodio2.io + :members: + :undoc-members: + :show-inheritance: + +revpimodio2\.modio module +------------------------- + +.. automodule:: revpimodio2.modio + :members: + :undoc-members: + :show-inheritance: + +revpimodio2\.netio module +------------------------- + +.. automodule:: revpimodio2.netio + :members: + :undoc-members: + :show-inheritance: + +revpimodio2\.summary module +--------------------------- + +.. automodule:: revpimodio2.summary + :members: + :undoc-members: + :show-inheritance: + + +Module contents +--------------- + +.. automodule:: revpimodio2 + :members: + :undoc-members: + :show-inheritance: diff --git a/eric-revpimodio2.api b/eric-revpimodio2.api deleted file mode 100644 index 7625b79..0000000 --- a/eric-revpimodio2.api +++ /dev/null @@ -1,232 +0,0 @@ -revpimodio2.BOTH?7 -revpimodio2.FALLING?7 -revpimodio2.GREEN?7 -revpimodio2.INP?7 -revpimodio2.MEM?7 -revpimodio2.OFF?7 -revpimodio2.OUT?7 -revpimodio2.RED?7 -revpimodio2.RISING?7 -revpimodio2.acheck?4(check_type, **kwargs) -revpimodio2.app.App?1(app) -revpimodio2.consttostr?4(value) -revpimodio2.device.Connect.A3?7 -revpimodio2.device.Connect._devconfigure?5() -revpimodio2.device.Connect._get_leda3?5() -revpimodio2.device.Connect._get_wdtoggle?5() -revpimodio2.device.Connect._set_leda3?5(value) -revpimodio2.device.Connect._set_wdtoggle?5(value) -revpimodio2.device.Connect.wdautotoggle?7 -revpimodio2.device.Core.A1?7 -revpimodio2.device.Core.A2?7 -revpimodio2.device.Core._devconfigure?5() -revpimodio2.device.Core._get_leda1?5() -revpimodio2.device.Core._get_leda2?5() -revpimodio2.device.Core._get_status?5() -revpimodio2.device.Core._set_calculatedled?5(addresslist, shifted_value) -revpimodio2.device.Core._set_leda1?5(value) -revpimodio2.device.Core._set_leda2?5(value) -revpimodio2.device.Core.errorlimit1?4(value) -revpimodio2.device.Core.errorlimit2?4(value) -revpimodio2.device.Core.frequency?4() -revpimodio2.device.Core.iocycle?4() -revpimodio2.device.Core.ioerrorcount?4() -revpimodio2.device.Core.leftgate?4() -revpimodio2.device.Core.missingdeviceorgate?4() -revpimodio2.device.Core.overunderflow?4() -revpimodio2.device.Core.picontrolrunning?4() -revpimodio2.device.Core.rightgate?4() -revpimodio2.device.Core.status?7 -revpimodio2.device.Core.temperature?4() -revpimodio2.device.Core.unconfdevice?4() -revpimodio2.device.Device._buildio?5(dict_io, iotype) -revpimodio2.device.Device._devconfigure?5() -revpimodio2.device.Device._get_offset?5() -revpimodio2.device.Device._get_producttype?5() -revpimodio2.device.Device._update_my_io_list?5() -revpimodio2.device.Device.autorefresh?4(activate=True) -revpimodio2.device.Device.get_allios?4(export=None) -revpimodio2.device.Device.get_inputs?4(export=None) -revpimodio2.device.Device.get_memories?4(export=None) -revpimodio2.device.Device.get_outputs?4(export=None) -revpimodio2.device.Device.length?7 -revpimodio2.device.Device.name?7 -revpimodio2.device.Device.offset?7 -revpimodio2.device.Device.position?7 -revpimodio2.device.Device.producttype?7 -revpimodio2.device.Device.readprocimg?4() -revpimodio2.device.Device.setdefaultvalues?4() -revpimodio2.device.Device.syncoutputs?4() -revpimodio2.device.Device.writeprocimg?4() -revpimodio2.device.Device?1(parentmodio, dict_device, simulator=False) -revpimodio2.device.DeviceList?1() -revpimodio2.device.DioModule?1(parentmodio, dict_device, simulator=False) -revpimodio2.device.Gateway.get_rawbytes?4() -revpimodio2.device.Gateway?1(parent, dict_device, simulator=False) -revpimodio2.device.Virtual.writeinputdefaults?4() -revpimodio2.helper.Cycletools._docycle?5() -revpimodio2.helper.Cycletools.get_tof?4(name) -revpimodio2.helper.Cycletools.get_tofc?4(name) -revpimodio2.helper.Cycletools.get_ton?4(name) -revpimodio2.helper.Cycletools.get_tonc?4(name) -revpimodio2.helper.Cycletools.get_tp?4(name) -revpimodio2.helper.Cycletools.get_tpc?4(name) -revpimodio2.helper.Cycletools.set_tof?4(name, milliseconds) -revpimodio2.helper.Cycletools.set_tofc?4(name, cycles) -revpimodio2.helper.Cycletools.set_ton?4(name, milliseconds) -revpimodio2.helper.Cycletools.set_tonc?4(name, cycles) -revpimodio2.helper.Cycletools.set_tp?4(name, milliseconds) -revpimodio2.helper.Cycletools.set_tpc?4(name, cycles) -revpimodio2.helper.Cycletools?1(cycletime) -revpimodio2.helper.EventCallback.run?4() -revpimodio2.helper.EventCallback.stop?4() -revpimodio2.helper.EventCallback?1(func, name, value) -revpimodio2.helper.ProcimgWriter._collect_events?5(value) -revpimodio2.helper.ProcimgWriter.get_refresh?4() -revpimodio2.helper.ProcimgWriter.refresh?7 -revpimodio2.helper.ProcimgWriter.run?4() -revpimodio2.helper.ProcimgWriter.set_refresh?4(value) -revpimodio2.helper.ProcimgWriter.stop?4() -revpimodio2.helper.ProcimgWriter?1(parentmodio) -revpimodio2.io.DeadIO._parentdevice?8 -revpimodio2.io.DeadIO.replace_io?4(name, frm, **kwargs) -revpimodio2.io.DeadIO?1(deadio) -revpimodio2.io.IOBase._get_address?5() -revpimodio2.io.IOBase._get_byteorder?5() -revpimodio2.io.IOBase._get_iotype?5() -revpimodio2.io.IOBase.address?7 -revpimodio2.io.IOBase.byteorder?7 -revpimodio2.io.IOBase.defaultvalue?7 -revpimodio2.io.IOBase.get_defaultvalue?4() -revpimodio2.io.IOBase.get_value?4() -revpimodio2.io.IOBase.length?7 -revpimodio2.io.IOBase.name?7 -revpimodio2.io.IOBase.reg_event?4(func, delay=0, edge=BOTH, as_thread=False, prefire=False) -revpimodio2.io.IOBase.reg_timerevent?4(func, delay, edge=BOTH, as_thread=False) -revpimodio2.io.IOBase.set_value?4(value) -revpimodio2.io.IOBase.type?7 -revpimodio2.io.IOBase.unreg_event?4(func=None, edge=None) -revpimodio2.io.IOBase.value?7 -revpimodio2.io.IOBase.wait?4(edge=BOTH, exitevent=None, okvalue=None, timeout=0) -revpimodio2.io.IOBase?1(parentdevice, valuelist, iotype, byteorder, signed) -revpimodio2.io.IOEvent?1(func, edge, as_thread, delay, overwrite, prefire) -revpimodio2.io.IOList._private_register_new_io_object?5(new_io) -revpimodio2.io.IOList?1() -revpimodio2.io.IntIO._get_signed?5() -revpimodio2.io.IntIO._set_byteorder?5(value) -revpimodio2.io.IntIO._set_signed?5(value) -revpimodio2.io.IntIO.byteorder?7 -revpimodio2.io.IntIO.defaultvalue?7 -revpimodio2.io.IntIO.get_intdefaultvalue?4() -revpimodio2.io.IntIO.get_intvalue?4() -revpimodio2.io.IntIO.set_intvalue?4(value) -revpimodio2.io.IntIO.signed?7 -revpimodio2.io.IntIO.value?7 -revpimodio2.io.IntIOCounter.reset?4() -revpimodio2.io.IntIOCounter?1(counter_id, parentdevice, valuelist, iotype, byteorder, signed) -revpimodio2.io.IntIOReplaceable.replace_io?4(name, frm, **kwargs) -revpimodio2.io.StructIO._get_frm?5() -revpimodio2.io.StructIO._get_signed?5() -revpimodio2.io.StructIO.defaultvalue?7 -revpimodio2.io.StructIO.frm?7 -revpimodio2.io.StructIO.get_structdefaultvalue?4() -revpimodio2.io.StructIO.get_structvalue?4() -revpimodio2.io.StructIO.set_structvalue?4(value) -revpimodio2.io.StructIO.signed?7 -revpimodio2.io.StructIO.value?7 -revpimodio2.io.StructIO?1(parentio, name, frm, **kwargs) -revpimodio2.modio.RevPiModIO._configure?5(jconfigrsc) -revpimodio2.modio.RevPiModIO._configure_replace_io?5(creplaceio) -revpimodio2.modio.RevPiModIO._create_myfh?5() -revpimodio2.modio.RevPiModIO._get_configrsc?5() -revpimodio2.modio.RevPiModIO._get_cpreplaceio?5() -revpimodio2.modio.RevPiModIO._get_cycletime?5() -revpimodio2.modio.RevPiModIO._get_debug?5() -revpimodio2.modio.RevPiModIO._get_ioerrors?5() -revpimodio2.modio.RevPiModIO._get_length?5() -revpimodio2.modio.RevPiModIO._get_maxioerrors?5() -revpimodio2.modio.RevPiModIO._get_monitoring?5() -revpimodio2.modio.RevPiModIO._get_procimg?5() -revpimodio2.modio.RevPiModIO._get_replace_io_file?5() -revpimodio2.modio.RevPiModIO._get_simulator?5() -revpimodio2.modio.RevPiModIO._gotioerror?5(action, e=None, show_warn=True) -revpimodio2.modio.RevPiModIO._set_cycletime?5(milliseconds) -revpimodio2.modio.RevPiModIO._set_debug?5(value) -revpimodio2.modio.RevPiModIO._set_maxioerrors?5(value) -revpimodio2.modio.RevPiModIO._simulate_ioctl?5(request, arg=b'') -revpimodio2.modio.RevPiModIO.autorefresh_all?4() -revpimodio2.modio.RevPiModIO.cleanup?4() -revpimodio2.modio.RevPiModIO.configrsc?7 -revpimodio2.modio.RevPiModIO.cycleloop?4(func, cycletime=50) -revpimodio2.modio.RevPiModIO.cycletime?7 -revpimodio2.modio.RevPiModIO.debug?7 -revpimodio2.modio.RevPiModIO.exit?4(full=True) -revpimodio2.modio.RevPiModIO.export_replaced_ios?4(filename="replace_ios.conf") -revpimodio2.modio.RevPiModIO.get_jconfigrsc?4() -revpimodio2.modio.RevPiModIO.handlesignalend?4(cleanupfunc=None) -revpimodio2.modio.RevPiModIO.ioerrors?7 -revpimodio2.modio.RevPiModIO.length?7 -revpimodio2.modio.RevPiModIO.mainloop?4(blocking=True) -revpimodio2.modio.RevPiModIO.maxioerrors?7 -revpimodio2.modio.RevPiModIO.monitoring?7 -revpimodio2.modio.RevPiModIO.procimg?7 -revpimodio2.modio.RevPiModIO.readprocimg?4(device=None) -revpimodio2.modio.RevPiModIO.replace_io_file?7 -revpimodio2.modio.RevPiModIO.resetioerrors?4() -revpimodio2.modio.RevPiModIO.setdefaultvalues?4(device=None) -revpimodio2.modio.RevPiModIO.simulator?7 -revpimodio2.modio.RevPiModIO.syncoutputs?4(device=None) -revpimodio2.modio.RevPiModIO.writeprocimg?4(device=None) -revpimodio2.modio.RevPiModIO?1(autorefresh=False, monitoring=False, syncoutputs=True, procimg=None, configrsc=None, simulator=False, debug=True, replace_io_file=None, direct_output=False) -revpimodio2.modio.RevPiModIODriver?1(virtdev, autorefresh=False, monitoring=False, syncoutputs=True, procimg=None, configrsc=None, debug=True, replace_io_file=None, direct_output=False) -revpimodio2.modio.RevPiModIOSelected?1(deviceselection, autorefresh=False, monitoring=False, syncoutputs=True, procimg=None, configrsc=None, simulator=False, debug=True, replace_io_file=None, direct_output=False) -revpimodio2.netio.HASH_FAIL?7 -revpimodio2.netio.NetFH._connect?5() -revpimodio2.netio.NetFH._direct_send?5(send_bytes, recv_count) -revpimodio2.netio.NetFH.clear_dirtybytes?4(position=None) -revpimodio2.netio.NetFH.close?4() -revpimodio2.netio.NetFH.closed?7 -revpimodio2.netio.NetFH.config_changed?7 -revpimodio2.netio.NetFH.flush?4() -revpimodio2.netio.NetFH.get_closed?4() -revpimodio2.netio.NetFH.get_config_changed?4() -revpimodio2.netio.NetFH.get_name?4() -revpimodio2.netio.NetFH.get_reconnecting?4() -revpimodio2.netio.NetFH.get_timeout?4() -revpimodio2.netio.NetFH.ioctl?4(request, arg=b'') -revpimodio2.netio.NetFH.name?7 -revpimodio2.netio.NetFH.read?4(length) -revpimodio2.netio.NetFH.readpictory?4() -revpimodio2.netio.NetFH.readreplaceio?4() -revpimodio2.netio.NetFH.reconnecting?7 -revpimodio2.netio.NetFH.run?4() -revpimodio2.netio.NetFH.seek?4(position) -revpimodio2.netio.NetFH.set_dirtybytes?4(position, dirtybytes) -revpimodio2.netio.NetFH.set_timeout?4(value) -revpimodio2.netio.NetFH.tell?4() -revpimodio2.netio.NetFH.timeout?7 -revpimodio2.netio.NetFH.write?4(bytebuff) -revpimodio2.netio.NetFH?1(address, check_replace_ios, timeout=500) -revpimodio2.netio.RevPiNetIO._create_myfh?5() -revpimodio2.netio.RevPiNetIO._get_cpreplaceio?5() -revpimodio2.netio.RevPiNetIO.config_changed?7 -revpimodio2.netio.RevPiNetIO.disconnect?4() -revpimodio2.netio.RevPiNetIO.exit?4(full=True) -revpimodio2.netio.RevPiNetIO.get_config_changed?4() -revpimodio2.netio.RevPiNetIO.get_jconfigrsc?4() -revpimodio2.netio.RevPiNetIO.get_reconnecting?4() -revpimodio2.netio.RevPiNetIO.net_cleardefaultvalues?4(device=None) -revpimodio2.netio.RevPiNetIO.net_setdefaultvalues?4(device=None) -revpimodio2.netio.RevPiNetIO.reconnecting?7 -revpimodio2.netio.RevPiNetIO?1(address, autorefresh=False, monitoring=False, syncoutputs=True, simulator=False, debug=True, replace_io_file=None, direct_output=False) -revpimodio2.netio.RevPiNetIODriver?1(address, virtdev, autorefresh=False, monitoring=False, syncoutputs=True, debug=True, replace_io_file=None, direct_output=False) -revpimodio2.netio.RevPiNetIOSelected?1(address, deviceselection, autorefresh=False, monitoring=False, syncoutputs=True, simulator=False, debug=True, replace_io_file=None, direct_output=False) -revpimodio2.netio._sysdeldirty?8 -revpimodio2.netio._sysexit?8 -revpimodio2.netio._sysflush?8 -revpimodio2.netio._syspictory?8 -revpimodio2.netio._syspictoryh?8 -revpimodio2.netio._sysreplaceio?8 -revpimodio2.netio._sysreplaceioh?8 -revpimodio2.netio._syssync?8 -revpimodio2.summary.Summary?1(summary) diff --git a/eric-revpimodio2.bas b/eric-revpimodio2.bas deleted file mode 100644 index 19333b7..0000000 --- a/eric-revpimodio2.bas +++ /dev/null @@ -1,21 +0,0 @@ -AclException Exception -Base Device -ConfigChanged Exception -Connect Core -Core Base -DeviceNotFoundError Exception -DioModule Device -EventCallback Thread -Gateway Device -IntIO IOBase -IntIOCounter IntIO -IntIOReplaceable IntIO -NetFH Thread -ProcimgWriter Thread -RevPiModIODriver RevPiModIOSelected -RevPiModIOSelected RevPiModIO -RevPiNetIO _RevPiModIO -RevPiNetIODriver RevPiNetIOSelected -RevPiNetIOSelected RevPiNetIO -StructIO IOBase -Virtual Gateway diff --git a/revpimodio2.e4p b/revpimodio2.e4p deleted file mode 100644 index 43a50dc..0000000 --- a/revpimodio2.e4p +++ /dev/null @@ -1,428 +0,0 @@ - - - - - - - en_US - 7ea159534ad3516e9069331120048abf9b00151e - Python3 - Console - Das Modul stellt alle Devices und IOs aus der piCtory Konfiguration in Python3 zur Verfügung. Es ermöglicht den direkten Zugriff auf die Werte über deren vergebenen Namen. Lese- und Schreibaktionen mit dem Prozessabbild werden von dem Modul selbst verwaltet, ohne dass sich der Programmierer um Offsets und Adressen kümmern muss. Für die Gatewaymodule wie ModbusTCP oder Profinet sind eigene 'Inputs' und 'Outputs' über einen bestimmten Adressbereich definierbar. Auf diese IOs kann mit Python3 über den Namen direkt auf die Werte zugegriffen werden. - 2.4.2 - Sven Sager - akira@narux.de - - - revpimodio2/__init__.py - revpimodio2/app.py - revpimodio2/device.py - revpimodio2/devicecon.py - revpimodio2/helper.py - revpimodio2/io.py - revpimodio2/modio.py - revpimodio2/netio.py - revpimodio2/summary.py - setup.py - test/test_dio_cycleloop.py - test/test_dio_mainloop.py - test/test_dio_while2.py - test/test_net_leistung.py - test/test_netio_brett.py - test/test_unit.py - test/test_unit_fh.py - test/test_unitnet.py - test/web_benniesrun.py - test/web_benniesrunxxl.py - test/web_cycleloop.py - test/web_mainloop.py - test/web_rpidaten.py - test/web_rpii2c.py - test/web_startseite.py - test/web_virtdevdriver.py - - - - - - - .hgignore - LICENSE.txt - MANIFEST.in - README.md - doc - eric-revpimodio2.api - - test/test_unit.py - - Mercurial - - - - add - - - - - - - - checkout - - - - - - - - commit - - - - - - - - diff - - - - - - - - export - - - - - - - - global - - - - - - - - history - - - - - - - - log - - - - - - - - remove - - - - - - - - status - - - - - - - - tag - - - - - - - - update - - - - - - - - - - - - - - - - - - - - - ERIC4API - - - - - ignoreDirectories - - - - deb - dist - doc - test - - - - ignoreFilePatterns - - - - setup.py - devicecon.py - - - - languages - - - - Python3 - - - - outputFile - - - eric-revpimodio2.api - - - useRecursion - - - True - - - - - ERIC4DOC - - - - - ignoreDirectories - - - - deb - dist - doc - test - - - - ignoreFilePatterns - - - - setup.py - devicecon.py - - - - outputDirectory - - - doc - - - qtHelpEnabled - - - False - - - useRecursion - - - True - - - - - - - - - - - Pep8Checker - - - - - BuiltinsChecker - - - - - chr - - - - unichr - - - - str - - - - unicode - - - - - - CopyrightAuthor - - - - - - CopyrightMinFileSize - - - 0 - - - DocstringType - - - pep257 - - - ExcludeFiles - - - */test/* - - - ExcludeMessages - - - E123,E226,E24,C101,E402,C111 - - - FixCodes - - - - - - FixIssues - - - False - - - FutureChecker - - - - - - HangClosing - - - False - - - IncludeMessages - - - - - - LineComplexity - - - 15 - - - LineComplexityScore - - - 10 - - - MaxCodeComplexity - - - 10 - - - MaxLineLength - - - 79 - - - NoFixCodes - - - E501 - - - RepeatMessages - - - True - - - ShowIgnored - - - False - - - ValidEncodings - - - latin-1, utf-8 - - - - - - - - - - - CodeMetrics - - - - - ExcludeFiles - - - */test/*,*/setup.py,*/test_unit.py - - - - - - - diff --git a/revpimodio2/__init__.py b/revpimodio2/__init__.py index 53f556f..4ea6607 100644 --- a/revpimodio2/__init__.py +++ b/revpimodio2/__init__.py @@ -14,7 +14,8 @@ fuehrt das Modul bei Datenaenderung aus. """ __all__ = [ "RevPiModIO", "RevPiModIOSelected", "RevPiModIODriver", - "RevPiNetIO", "RevPiNetIOSelected", "RevPiNetIODriver" + "RevPiNetIO", "RevPiNetIOSelected", "RevPiNetIODriver", + "Cycletools", ] __author__ = "Sven Sager " __copyright__ = "Copyright (C) 2018 Sven Sager" @@ -95,5 +96,6 @@ def consttostr(value): # Benötigte Klassen importieren +from .helper import Cycletools from .modio import RevPiModIO, RevPiModIOSelected, RevPiModIODriver from .netio import RevPiNetIO, RevPiNetIOSelected, RevPiNetIODriver diff --git a/revpimodio2/modio.py b/revpimodio2/modio.py index d7dfa88..75e0c9c 100644 --- a/revpimodio2/modio.py +++ b/revpimodio2/modio.py @@ -605,7 +605,7 @@ class RevPiModIO(object): @param func Funktion, die ausgefuehrt werden soll @param cycletime Zykluszeit in Millisekunden - Standardwert 50 ms - @return None + @return None or the return value of the cycle function """ # Prüfen ob ein Loop bereits läuft