diff --git a/doc/revpimodio2.modio.html b/doc/revpimodio2.modio.html index b3e68b9..8d26ae8 100644 --- a/doc/revpimodio2.modio.html +++ b/doc/revpimodio2.modio.html @@ -86,6 +86,9 @@ Methods _get_configrsc Getter function. +_get_cpreplaceio +Laed die replace_io_file Konfiguration und verarbeitet sie. + _get_cycletime Gibt Aktualisierungsrate in ms der Prozessabbildsynchronisierung aus. @@ -231,19 +234,27 @@ RevPiModIO._configure _configure(jconfigrsc)

Verarbeitet die piCtory Konfigurationsdatei. -

+

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

RevPiModIO._configure_replace_io

-_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() @@ -261,6 +272,17 @@ Getter function.
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

@@ -483,7 +505,7 @@ Entfernt auch alle Devices aus autorefresh

RevPiModIO.export_replaced_ios

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

Exportiert ersetzte IOs dieser Instanz.

diff --git a/doc/revpimodio2.netio.html b/doc/revpimodio2.netio.html index 48b8224..33a96e6 100644 --- a/doc/revpimodio2.netio.html +++ b/doc/revpimodio2.netio.html @@ -12,12 +12,18 @@ RevPiModIO Hauptklasse fuer Netzwerkzugriff.

Global Attributes

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

Classes

+ + + + + + @@ -37,6 +43,68 @@ Functions
AclExceptionProbleme mit Berechtigungen.
ConfigChangedAenderung der piCtory oder replace_ios Datei.
NetFH Netzwerk File Handler fuer das Prozessabbild.
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

@@ -54,7 +122,7 @@ Thread

Class Attributes

- +
__slots__
closed
name
timeout
__slots__
closed
config_changed
name
reconnecting
timeout

Class Methods

@@ -95,9 +163,15 @@ Methods get_closed Pruefen ob Verbindung geschlossen ist. +get_config_changed +Pruefen ob RevPi Konfiguration geaendert wurde. + get_name Verbindugnsnamen zurueckgeben. +get_reconnecting +Interner reconnect aktiv wegen Netzwerkfehlern. + get_timeout Gibt aktuellen Timeout zurueck. @@ -110,6 +184,9 @@ Methods readpictory Ruft die piCtory Konfiguration ab. +readreplaceio +Ruft die replace_io Konfiguration ab. + run Handler fuer Synchronisierung. @@ -137,13 +214,16 @@ Static Methods

NetFH (Constructor)

-NetFH(address, timeout=500) +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 @@ -230,6 +310,17 @@ Pruefen ob Verbindung geschlossen ist.
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

@@ -241,6 +332,17 @@ Verbindugnsnamen zurueckgeben.
IP:PORT
+ +

+NetFH.get_reconnecting

+get_reconnecting() +

+Interner reconnect aktiv wegen Netzwerkfehlern. +

+
Returns:
+
+True, wenn reconnect aktiv +

NetFH.get_timeout

@@ -293,6 +395,17 @@ Ruft die piCtory Konfiguration ab.
piCtory Datei
+ +

+NetFH.readreplaceio

+readreplaceio() +

+Ruft die replace_io Konfiguration ab. +

+
Returns:
+
+ replace_io_file +

NetFH.run

@@ -385,7 +498,7 @@ _RevPiModIO

Class Attributes

- +
__slots__
__slots__
config_changed
reconnecting

Class Methods

@@ -402,12 +515,24 @@ Methods _create_myfh Erstellt NetworkFileObject. +_get_cpreplaceio +Laed die replace_io Konfiguration ueber das Netzwerk. + disconnect Trennt Verbindungen und beendet autorefresh inkl. +exit +Beendet mainloop() und optional autorefresh. + +get_config_changed +Pruefen ob RevPi Konfiguration geaendert wurde. + get_jconfigrsc Laedt die piCotry Konfiguration und erstellt ein . +get_reconnecting +Interner reconnect aktiv wegen Netzwerkfehlern. + net_cleardefaultvalues Loescht Defaultwerte vom PLC Slave. @@ -459,13 +584,49 @@ RevPiNetIO._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() @@ -476,6 +637,20 @@ Laedt die piCotry Konfiguration und erstellt ein .
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

diff --git a/eric-revpimodio2.api b/eric-revpimodio2.api index 6572765..28da249 100644 --- a/eric-revpimodio2.api +++ b/eric-revpimodio2.api @@ -142,9 +142,10 @@ 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() +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() @@ -165,7 +166,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) +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 @@ -184,19 +185,25 @@ revpimodio2.modio.RevPiModIO.writeprocimg?4(device=None) revpimodio2.modio.RevPiModIO?1(autorefresh=False, monitoring=False, syncoutputs=True, procimg=None, configrsc=None, simulator=False, debug=False, replace_io_file=None, direct_output=False) revpimodio2.modio.RevPiModIODriver?1(virtdev, autorefresh=False, monitoring=False, syncoutputs=True, procimg=None, configrsc=None, debug=False, 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=False, 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) @@ -204,12 +211,18 @@ 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, timeout=500) +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=False, replace_io_file=None, direct_output=False) revpimodio2.netio.RevPiNetIODriver?1(address, virtdev, autorefresh=False, monitoring=False, syncoutputs=True, debug=False, replace_io_file=None, direct_output=False) revpimodio2.netio.RevPiNetIOSelected?1(address, deviceselection, autorefresh=False, monitoring=False, syncoutputs=True, simulator=False, debug=False, replace_io_file=None, direct_output=False) @@ -217,5 +230,8 @@ 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 index 3eda7c3..19333b7 100644 --- a/eric-revpimodio2.bas +++ b/eric-revpimodio2.bas @@ -1,4 +1,6 @@ +AclException Exception Base Device +ConfigChanged Exception Connect Core Core Base DeviceNotFoundError Exception diff --git a/revpimodio2.e4p b/revpimodio2.e4p index ff6c635..1c11c87 100644 --- a/revpimodio2.e4p +++ b/revpimodio2.e4p @@ -1,7 +1,7 @@ - + en_US @@ -9,7 +9,7 @@ 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.0 + 2.4.1 Sven Sager akira@narux.de diff --git a/revpimodio2/__init__.py b/revpimodio2/__init__.py index 95f8679..c1d6aa2 100644 --- a/revpimodio2/__init__.py +++ b/revpimodio2/__init__.py @@ -22,7 +22,7 @@ __author__ = "Sven Sager " __copyright__ = "Copyright (C) 2018 Sven Sager" __license__ = "LGPLv3" __name__ = "revpimodio2" -__version__ = "2.4.0" +__version__ = "2.4.1" # Global package values OFF = 0 diff --git a/revpimodio2/helper.py b/revpimodio2/helper.py index 0197694..abb8bcc 100644 --- a/revpimodio2/helper.py +++ b/revpimodio2/helper.py @@ -289,7 +289,7 @@ class ProcimgWriter(Thread): """ - __slots__ = "__dict_delay", "__eventth", "__eventqth", "__eventwork", \ + __slots__ = "__dict_delay", "__eventth", "_eventqth", "__eventwork", \ "_adjwait", "_eventq", "_ioerror", "_maxioerrors", "_modio", \ "_refresh", "_work", "daemon", "lck_refresh", "newdata" @@ -299,7 +299,7 @@ class ProcimgWriter(Thread): super().__init__() self.__dict_delay = {} self.__eventth = Thread(target=self.__exec_th) - self.__eventqth = queue.Queue() + self._eventqth = queue.Queue() self.__eventwork = False self._adjwait = 0 self._eventq = queue.Queue() @@ -340,7 +340,7 @@ class ProcimgWriter(Thread): or regfunc.edge == FALLING and not boolor: if regfunc.delay == 0: if regfunc.as_thread: - self.__eventqth.put( + self._eventqth.put( (regfunc, io_event._name, io_event.value), False ) @@ -363,7 +363,7 @@ class ProcimgWriter(Thread): for regfunc in dev._dict_events[io_event]: if regfunc.delay == 0: if regfunc.as_thread: - self.__eventqth.put( + self._eventqth.put( (regfunc, io_event._name, io_event.value), False ) @@ -390,7 +390,7 @@ class ProcimgWriter(Thread): """Laeuft als Thread, der Events als Thread startet.""" while self.__eventwork: try: - tup_fireth = self.__eventqth.get(timeout=1) + tup_fireth = self._eventqth.get(timeout=1) th = EventCallback( tup_fireth[0].func, tup_fireth[1], tup_fireth[2] ) @@ -415,7 +415,7 @@ class ProcimgWriter(Thread): self.__eventwork = value if not value: # Nur leeren beim deaktivieren - self.__eventqth = queue.Queue() + self._eventqth = queue.Queue() self._eventq = queue.Queue() self.__dict_delay = {} @@ -533,7 +533,7 @@ class ProcimgWriter(Thread): if self.__dict_delay[tup_fire] <= 0: # Verzögertes Event übernehmen und löschen if tup_fire[0].as_thread: - self.__eventqth.put(tup_fire, False) + self._eventqth.put(tup_fire, False) else: self._eventq.put(tup_fire, False) del self.__dict_delay[tup_fire] diff --git a/revpimodio2/io.py b/revpimodio2/io.py index 0ca6e7d..b5e766d 100644 --- a/revpimodio2/io.py +++ b/revpimodio2/io.py @@ -1000,13 +1000,6 @@ class IntIOReplaceable(IntIO): >Python3 struct """ - # Sperre prüfen - if self._parentdevice._modio._lck_replace_io: - raise RuntimeError( - "can not use this function while using an external " - "replace_io_file" - ) - # StructIO erzeugen io_new = StructIO( self, diff --git a/revpimodio2/modio.py b/revpimodio2/modio.py index b80f101..a87a661 100644 --- a/revpimodio2/modio.py +++ b/revpimodio2/modio.py @@ -37,7 +37,7 @@ class RevPiModIO(object): "_maxioerrors", "_myfh", "_myfh_lck", "_monitoring", "_procimg", \ "_simulator", "_syncoutputs", "_th_mainloop", "_waitexit", \ "core", "app", "device", "exitsignal", "io", "summary", "_debug", \ - "_lck_replace_io", "_replace_io_file", "_run_on_pi" + "_replace_io_file", "_run_on_pi" def __init__( self, autorefresh=False, monitoring=False, syncoutputs=True, @@ -85,7 +85,6 @@ class RevPiModIO(object): self._imgwriter = None self._ioerror = 0 self._length = 0 - self._lck_replace_io = False self._looprunning = False self._lst_devselect = [] self._lst_refresh = [] @@ -116,6 +115,7 @@ class RevPiModIO(object): # Nur Konfigurieren, wenn nicht vererbt if type(self) == RevPiModIO: self._configure(self.get_jconfigrsc()) + self._configure_replace_io(self._get_cpreplaceio()) def __del__(self): """Zerstoert alle Klassen um aufzuraeumen.""" @@ -138,7 +138,8 @@ class RevPiModIO(object): self.writeprocimg() def _configure(self, jconfigrsc): - """Verarbeitet die piCtory Konfigurationsdatei.""" + """Verarbeitet die piCtory Konfigurationsdatei. + @param jconfigrsc: Data to build IOs as of JSON""" # Filehandler konfigurieren, wenn er noch nicht existiert if self._myfh is None: @@ -262,11 +263,6 @@ class RevPiModIO(object): Warning ) - # Replace IO aus Datei verarbeiten - if self._replace_io_file is not None: - self._configure_replace_io() - self._lck_replace_io = True - # ImgWriter erstellen self._imgwriter = helpermodule.ProcimgWriter(self) @@ -301,85 +297,74 @@ class RevPiModIO(object): # Summary Klasse instantiieren self.summary = summarymodule.Summary(jconfigrsc["Summary"]) - def _configure_replace_io(self): + def _configure_replace_io(self, 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. + @param ireplaceio: Data to replace ios as + """ - cp = ConfigParser() - - try: - with open(self._replace_io_file, "r") as fh: - cp.read_file(fh) - except Exception as e: - raise RuntimeError( - "replace_io_file: could not read file '{0}' | {1}" - "".format(self._replace_io_file, e) - ) - - for io in cp: + for io in creplaceio: if io == "DEFAULT": continue # IO prüfen - parentio = cp[io].get("replace", "") + parentio = creplaceio[io].get("replace", "") # Funktionsaufruf vorbereiten dict_replace = { - "frm": cp[io].get("frm"), + "frm": creplaceio[io].get("frm"), + "byteorder": creplaceio[io].get("byteorder", "little"), + "bmk": creplaceio[io].get("bmk", ""), } - # Convert defaultvalue from config file - if "defaultvalue" in cp[io]: - if dict_replace["frm"] == "?": - try: - dict_replace["defaultvalue"] = \ - cp[io].getboolean("defaultvalue") - except Exception: - raise ValueError( - "replace_io_file: could not convert '{0}' " - "defaultvalue '{1}' to boolean" - "".format(io, cp[io].get("defaultvalue")) - ) - else: - try: - dict_replace["defaultvalue"] = \ - cp[io].getint("defaultvalue") - except Exception: - raise ValueError( - "replace_io_file: could not convert '{0}' " - "defaultvalue '{1}' to integer" - "".format(io, cp[io].get("bit")) - ) - # Get bitaddress from config file - if "bit" in cp[io]: + if "bit" in creplaceio[io]: try: - dict_replace["bit"] = cp[io].getint("bit", 0) + dict_replace["bit"] = creplaceio[io].getint("bit") except Exception: raise ValueError( "replace_io_file: could not convert '{0}' " "bit '{1}' to integer" - "".format(io, cp[io].get("bit")) + "".format(io, creplaceio[io]["bit"]) ) - # Sonstige Werte laden, wenn vorhanden - if "bmk" in cp[io]: - dict_replace["bmk"] = cp[io].get("bmk") - if "byteorder" in cp[io]: - dict_replace["byteorder"] = cp[io].get("byteorder") + # Convert defaultvalue from config file + if "defaultvalue" in creplaceio[io]: + if dict_replace["frm"] == "?": + try: + dict_replace["defaultvalue"] = \ + creplaceio[io].getboolean("defaultvalue") + except Exception: + raise ValueError( + "replace_io_file: could not convert '{0}' " + "defaultvalue '{1}' to boolean" + "".format(io, creplaceio[io]["defaultvalue"]) + ) + else: + try: + dict_replace["defaultvalue"] = \ + creplaceio[io].getint("defaultvalue") + except Exception: + raise ValueError( + "replace_io_file: could not convert '{0}' " + "defaultvalue '{1}' to integer" + "".format(io, creplaceio[io]["defaultvalue"]) + ) # IO ersetzen try: self.io[parentio].replace_io(name=io, **dict_replace) except Exception as e: - raise RuntimeError( - "replace_io_file: can not replace '{0}' with '{1}' " - "| RevPiModIO message: {2}".format(parentio, io, e) - ) + # NOTE: Bei Selected/Driver kann nicht geprüft werden + if len(self._lst_devselect) == 0: + raise RuntimeError( + "replace_io_file: can not replace '{0}' with '{1}' " + "| RevPiModIO message: {2}".format(parentio, io, e) + ) def _create_myfh(self): """Erstellt FileObject mit Pfad zum procimg. @@ -392,6 +377,25 @@ class RevPiModIO(object): @return Pfad der verwendeten piCtory Konfiguration""" return self._configrsc + def _get_cpreplaceio(self): + """Laed die replace_io_file Konfiguration und verarbeitet sie. + @return der replace io daten""" + cp = ConfigParser() + + # TODO: verfeinern! + + if self._replace_io_file: + try: + with open(self._replace_io_file, "r") as fh: + cp.read_file(fh) + except Exception as e: + raise RuntimeError( + "replace_io_file: could not read/parse file '{0}' | {1}" + "".format(self._replace_io_file, e) + ) + + return cp + def _get_cycletime(self): """Gibt Aktualisierungsrate in ms der Prozessabbildsynchronisierung aus. @return Millisekunden""" @@ -681,7 +685,7 @@ class RevPiModIO(object): if not self._monitoring: self.writeprocimg(dev) - def export_replaced_ios(self, filename): + def export_replaced_ios(self, filename="replace_ios.conf"): """Exportiert ersetzte IOs dieser Instanz. Exportiert alle ersetzten IOs, welche mit .replace_io(...) angelegt @@ -704,8 +708,10 @@ class RevPiModIO(object): # Optional values if io._bitaddress >= 0: cp[io.name]["bit"] = str(io._bitaddress) - cp[io.name]["byteorder"] = io._byteorder - cp[io.name]["defaultvalue"] = str(io.defaultvalue) + if io._byteorder != "little": + cp[io.name]["byteorder"] = io._byteorder + if io.defaultvalue != 0: + cp[io.name]["defaultvalue"] = str(io.defaultvalue) if io.bmk != "": cp[io.name]["bmk"] = io.bmk @@ -846,7 +852,7 @@ class RevPiModIO(object): or regfunc.edge == RISING and io.value \ or regfunc.edge == FALLING and not io.value: if regfunc.as_thread: - self._imgwriter.__eventqth.put( + self._imgwriter._eventqth.put( (regfunc, io._name, io.value), False ) else: @@ -1141,6 +1147,7 @@ class RevPiModIOSelected(RevPiModIO): ) self._configure(self.get_jconfigrsc()) + self._configure_replace_io(self._get_cpreplaceio()) if len(self.device) == 0: if type(self) == RevPiModIODriver: diff --git a/revpimodio2/netio.py b/revpimodio2/netio.py index c2da6a4..d307d3d 100644 --- a/revpimodio2/netio.py +++ b/revpimodio2/netio.py @@ -5,6 +5,7 @@ __copyright__ = "Copyright (C) 2018 Sven Sager" __license__ = "LGPLv3" import socket import warnings +from configparser import ConfigParser from json import loads as jloads from re import compile from revpimodio2 import DeviceNotFoundError @@ -21,8 +22,28 @@ _sysexit = b'\x01EX\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x17' _sysdeldirty = b'\x01EY\x00\x00\x00\x00\xFF\x00\x00\x00\x00\x00\x00\x00\x17' # piCtory Konfiguration laden _syspictory = b'\x01PI\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x17' +_syspictoryh = b'\x01PH\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x17' +# ReplaceIO Konfiguration laden +_sysreplaceio = b'\x01RP\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x17' +_sysreplaceioh = b'\x01RH\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x17' # Übertragene Bytes schreiben _sysflush = b'\x01SD\x00\x00\x00\x00\x1c\x00\x00\x00\x00\x00\x00\x00\x17' +# Hashvalues +HASH_FAIL = b'\xff' * 16 + + +class AclException(Exception): + + """Probleme mit Berechtigungen.""" + + pass + + +class ConfigChanged(Exception): + + """Aenderung der piCtory oder replace_ios Datei.""" + + pass class NetFH(Thread): @@ -35,26 +56,34 @@ class NetFH(Thread): """ - __slots__ = "__by_buff", "__int_buff", "__dictdirty", "__flusherr", \ - "__position", "__sockact", "__sockerr", "__sockend", "__socklock", \ - "__timeout", "__trigger", "__waitsync", \ - "_address", "_slavesock", \ - "daemon" + __slots__ = "__by_buff", "__check_replace_ios", "__config_changed", \ + "__int_buff", "__dictdirty", "__flusherr", "__replace_ios_h", \ + "__pictory_h", "__position", "__sockact", "__sockerr", "__sockend", \ + "__socklock", "__timeout", "__trigger", "__waitsync", "_address", \ + "_slavesock", "daemon" - def __init__(self, address, timeout=500): + def __init__(self, address, check_replace_ios, timeout=500): """Init NetFH-class. + @param address IP Adresse, Port des RevPi als - @param timeout Timeout in Millisekunden der Verbindung""" + @param check_replace_ios Prueft auf Veraenderungen der Datei + @param timeout Timeout in Millisekunden der Verbindung + + """ super().__init__() self.daemon = True self.__by_buff = b'' + self.__check_replace_ios = check_replace_ios + self.__config_changed = False self.__int_buff = 0 self.__dictdirty = {} self.__flusherr = False + self.__replace_ios_h = b'' + self.__pictory_h = b'' self.__sockact = False self.__sockerr = Event() - self.__sockend = False + self.__sockend = Event() self.__socklock = Lock() self.__timeout = None self.__trigger = False @@ -90,10 +119,10 @@ class NetFH(Thread): if bytecode == b'\x18': # Alles beenden, wenn nicht erlaubt - self.__sockend = True + self.__sockend.set() self.__sockerr.set() self._slavesock.close() - raise RuntimeError( + raise AclException( "write access to the process image is not permitted - use " "monitoring=True or check aclplcslave.conf on RevPi and " "reload revpipyload!" @@ -124,6 +153,45 @@ class NetFH(Thread): so = socket.socket(socket.AF_INET, socket.SOCK_STREAM) try: so.connect(self._address) + + # Hashwerte anfordern + recv_len = 16 + so.sendall(_syspictoryh) + if self.__check_replace_ios: + so.sendall(_sysreplaceioh) + recv_len += 16 + + # Hashwerte empfangen + byte_buff = bytearray() + zero_byte = 0 + while not self.__sockend.is_set() and zero_byte < 100 \ + and len(byte_buff) < recv_len: + data = so.recv(recv_len) + if data == b'': + zero_byte += 1 + byte_buff += data + + # Änderung an piCtory prüfen + if self.__pictory_h and byte_buff[:16] != self.__pictory_h: + self.__config_changed = True + self.close() + raise ConfigChanged( + "configuration on revolution pi was changed") + else: + self.__pictory_h = byte_buff[:16] + + # Änderung an replace_ios prüfen + if self.__check_replace_ios and self.__replace_ios_h \ + and byte_buff[16:] != self.__replace_ios_h: + self.__config_changed = True + self.close() + raise ConfigChanged( + "configuration on revolution pi was changed") + else: + self.__replace_ios_h = byte_buff[16:] + except ConfigChanged: + so.close() + raise except Exception: so.close() else: @@ -151,11 +219,12 @@ class NetFH(Thread): @returns Empfangende Bytes """ - if self.__sockend: + if self.__sockend.is_set(): raise ValueError("I/O operation on closed file") with self.__socklock: self._slavesock.sendall(send_bytes) + # FIXME: Schleife bis Daten empfangen sind einbauen recv = self._slavesock.recv(recv_count) self.__trigger = True return recv @@ -163,10 +232,15 @@ class NetFH(Thread): def clear_dirtybytes(self, position=None): """Entfernt die konfigurierten Dirtybytes vom RevPi Slave. @param position Startposition der Dirtybytes""" - if self.__sockend: + if self.__config_changed: + raise ConfigChanged("configuration on revolution pi was changed") + if self.__sockend.is_set(): raise ValueError("I/O operation on closed file") - with self.__socklock: + error = False + try: + self.__socklock.acquire() + if position is None: # Alle Dirtybytes löschen self._slavesock.sendall(_sysdeldirty) @@ -184,40 +258,54 @@ class NetFH(Thread): # ACL prüfen und ggf Fehler werfen self.__check_acl(check) - self.__sockerr.set() raise IOError("clear dirtybytes error on network") + except AclException: + raise + except Exception: + error = True + finally: + self.__socklock.release() - # Daten bei Erfolg übernehmen + # Daten immer übernehmen if position is None: self.__dictdirty = {} elif position in self.__dictdirty: del self.__dictdirty[position] + if error: + # Fehler nach übernahme der Daten auslösen um diese zu setzen + self.__sockerr.set() + self.__trigger = True def close(self): """Verbindung trennen.""" - if self.__sockend: + if self.__sockend.is_set(): return - self.__sockend = True + self.__sockend.set() self.__sockerr.set() # Vom Socket sauber trennen if self._slavesock is not None: - with self.__socklock: - try: - if self.__sockend: - self._slavesock.send(_sysexit) - else: - self._slavesock.shutdown(socket.SHUT_RDWR) - except Exception: - pass + try: + self.__socklock.acquire() + self._slavesock.send(_sysexit) + + # NOTE: Wird das benötigt? + self._slavesock.shutdown(socket.SHUT_RDWR) + except Exception: + pass + finally: + self.__socklock.release() + self._slavesock.close() def flush(self): """Schreibpuffer senden.""" - if self.__sockend: + if self.__config_changed: + raise ConfigChanged("configuration on revolution pi was changed") + if self.__sockend.is_set(): raise ValueError("flush of closed file") with self.__socklock: @@ -248,13 +336,23 @@ class NetFH(Thread): def get_closed(self): """Pruefen ob Verbindung geschlossen ist. @return True, wenn Verbindung geschlossen ist""" - return self.__sockend + return self.__sockend.is_set() + + def get_config_changed(self): + """Pruefen ob RevPi Konfiguration geaendert wurde. + @return True, wenn RevPi Konfiguration geaendert ist""" + return self.__config_changed def get_name(self): """Verbindugnsnamen zurueckgeben. @return IP:PORT""" return "{0}:{1}".format(*self._address) + def get_reconnecting(self): + """Interner reconnect aktiv wegen Netzwerkfehlern. + @return True, wenn reconnect aktiv""" + return self.__sockerr.is_set() + def get_timeout(self): """Gibt aktuellen Timeout zurueck. @return in Millisekunden""" @@ -264,7 +362,9 @@ class NetFH(Thread): """IOCTL Befehle ueber das Netzwerk senden. @param request Request as @param arg Argument as """ - if self.__sockend: + if self.__config_changed: + raise ConfigChanged("configuration on revolution pi was changed") + if self.__sockend.is_set(): raise ValueError("read of closed file") if not (isinstance(arg, bytes) and len(arg) <= 1024): @@ -295,7 +395,9 @@ class NetFH(Thread): """Daten ueber das Netzwerk lesen. @param length Anzahl der Bytes @return Gelesene """ - if self.__sockend: + if self.__config_changed: + raise ConfigChanged("configuration on revolution pi was changed") + if self.__sockend.is_set(): raise ValueError("read of closed file") with self.__socklock: @@ -307,8 +409,8 @@ class NetFH(Thread): ) bytesbuff = bytearray() - while not self.__sockend and len(bytesbuff) < length: - rbytes = self._slavesock.recv(1024) + while not self.__sockend.is_set() and len(bytesbuff) < length: + rbytes = self._slavesock.recv(256) if rbytes == b'': self.__sockerr.set() @@ -323,33 +425,75 @@ class NetFH(Thread): def readpictory(self): """Ruft die piCtory Konfiguration ab. @return piCtory Datei""" - if self.__sockend: + if self.__sockend.is_set(): raise ValueError("read of closed file") + if self.__pictory_h == HASH_FAIL: + raise RuntimeError( + "could not read/parse piCtory configuration over network" + ) + with self.__socklock: self._slavesock.send(_syspictory) byte_buff = bytearray() - while not self.__sockend: - data = self._slavesock.recv(1024) + zero_byte = 0 + while not self.__sockend.is_set() and zero_byte < 100: + data = self._slavesock.recv(128) + if data == b'': + zero_byte += 1 byte_buff += data if data.find(b'\x04') >= 0: + self.__trigger = True + # NOTE: Nur suchen oder Ende prüfen? - return byte_buff[:-1] + return bytes(byte_buff[:-1]) self.__sockerr.set() raise IOError("readpictory error on network") - self.__trigger = True + def readreplaceio(self): + """Ruft die replace_io Konfiguration ab. + @return replace_io_file""" + if self.__sockend.is_set(): + raise ValueError("read of closed file") + + if self.__replace_ios_h == HASH_FAIL: + raise RuntimeError( + "replace_io_file: could not read/parse over network" + ) + + with self.__socklock: + self._slavesock.send(_sysreplaceio) + + byte_buff = bytearray() + zero_byte = 0 + while not self.__sockend.is_set() and zero_byte < 100: + data = self._slavesock.recv(128) + if data == b'': + zero_byte += 1 + + byte_buff += data + if data.find(b'\x04') >= 0: + self.__trigger = True + + # NOTE: Nur suchen oder Ende prüfen? + return bytes(byte_buff[:-1]) + + self.__sockerr.set() + raise IOError("readreplaceio error on network") def run(self): """Handler fuer Synchronisierung.""" - while not self.__sockend: + while not self.__sockend.is_set(): # Bei Fehlermeldung neu verbinden if self.__sockerr.is_set(): self._connect() + if self.__sockerr.is_set(): + # Verhindert bei Scheitern 100% CPU last + self.__sockend.wait(self.__waitsync) else: # Kein Fehler aufgetreten, sync durchführen wenn socket frei @@ -380,7 +524,9 @@ class NetFH(Thread): def seek(self, position): """Springt an angegebene Position. @param position An diese Position springen""" - if self.__sockend: + if self.__config_changed: + raise ConfigChanged("configuration on revolution pi was changed") + if self.__sockend.is_set(): raise ValueError("seek of closed file") self.__position = int(position) @@ -388,10 +534,15 @@ class NetFH(Thread): """Konfiguriert Dirtybytes fuer Prozessabbild bei Verbindungsfehler. @param positon Startposition zum Schreiben @param dirtybytes die geschrieben werden sollen""" - if self.__sockend: + if self.__config_changed: + raise ConfigChanged("configuration on revolution pi was changed") + if self.__sockend.is_set(): raise ValueError("I/O operation on closed file") - with self.__socklock: + error = False + try: + self.__socklock.acquire() + self._slavesock.sendall( b'\x01EY' + position.to_bytes(length=2, byteorder="little") + @@ -406,24 +557,35 @@ class NetFH(Thread): # ACL prüfen und ggf Fehler werfen self.__check_acl(check) - self.__sockerr.set() raise IOError("set dirtybytes error on network") + except AclException: + raise + except Exception: + error = True + finally: + self.__socklock.release() - # Daten erfolgreich übernehmen - self.__dictdirty[position] = dirtybytes + # Daten immer übernehmen + self.__dictdirty[position] = dirtybytes - self.__trigger = True + if error: + # Fehler nach übernahme der Daten auslösen um diese zu setzen + self.__sockerr.set() + + self.__trigger = True def set_timeout(self, value): """Setzt Timeoutwert fuer Verbindung. @param value Timeout in Millisekunden""" - if self.__sockend: + if self.__sockend.is_set(): raise ValueError("I/O operation on closed file") # Timeoutwert verarbeiten (könnte Exception auslösen) self.__set_systimeout(value) - with self.__socklock: + try: + self.__socklock.acquire() + self._slavesock.send( b'\x01CF' + value.to_bytes(length=2, byteorder="little") + @@ -431,15 +593,20 @@ class NetFH(Thread): ) check = self._slavesock.recv(1) if check != b'\x1e': - self.__sockerr.set() raise IOError("set timeout error on network") + except Exception: + self.__sockerr.set() + finally: + self.__socklock.release() - self.__trigger = True + self.__trigger = True def tell(self): """Gibt aktuelle Position zurueck. @return int aktuelle Position""" - if self.__sockend: + if self.__config_changed: + raise ConfigChanged("configuration on revolution pi was changed") + if self.__sockend.is_set(): raise ValueError("I/O operation on closed file") return self.__position @@ -447,7 +614,9 @@ class NetFH(Thread): """Daten ueber das Netzwerk schreiben. @param bytebuff Bytes zum schreiben @return Anzahl geschriebener bytes""" - if self.__sockend: + if self.__config_changed: + raise ConfigChanged("configuration on revolution pi was changed") + if self.__sockend.is_set(): raise ValueError("write to closed file") if self.__flusherr: @@ -468,7 +637,9 @@ class NetFH(Thread): return len(bytebuff) closed = property(get_closed) + config_changed = property(get_config_changed) name = property(get_name) + reconnecting = property(get_reconnecting) timeout = property(get_timeout, set_timeout) @@ -543,15 +714,15 @@ class RevPiNetIO(_RevPiModIO): # Vererben super().__init__( - autorefresh, - monitoring, - syncoutputs, - "{0}:{1}".format(*self._address), - None, - simulator, - debug, - replace_io_file, - direct_output + autorefresh=autorefresh, + monitoring=monitoring, + syncoutputs=syncoutputs, + procimg="{0}:{1}".format(*self._address), + configrsc=None, + simulator=simulator, + debug=debug, + replace_io_file=replace_io_file, + direct_output=direct_output, ) # Netzwerkfilehandler anlegen @@ -560,25 +731,73 @@ class RevPiNetIO(_RevPiModIO): # Nur Konfigurieren, wenn nicht vererbt if type(self) == RevPiNetIO: self._configure(self.get_jconfigrsc()) + self._configure_replace_io(self._get_cpreplaceio()) def _create_myfh(self): """Erstellt NetworkFileObject. return FileObject""" self._buffedwrite = True - return NetFH(self._address) + return NetFH(self._address, self._replace_io_file == ":network:") + + def _get_cpreplaceio(self): + """Laed die replace_io Konfiguration ueber das Netzwerk. + @return der replace io daten""" + + # Normale Verwendung über Elternklasse erledigen + if self._replace_io_file != ":network:": + return super()._get_cpreplaceio() + + # Replace IO Daten über das Netzwerk beziehen + byte_buff = self._myfh.readreplaceio() + + cp = ConfigParser() + try: + cp.read_string(byte_buff.decode("utf-8")) + except Exception as e: + raise RuntimeError( + "replace_io_file: could not read/parse network data | {0}" + "".format(e) + ) + return cp def disconnect(self): """Trennt Verbindungen und beendet autorefresh inkl. alle Threads.""" self.cleanup() + def exit(self, full=True): + """Beendet mainloop() und optional autorefresh. + @see #RevPiModIO.exit(...)""" + try: + super().exit(full) + except ConfigChanged: + pass + + def get_config_changed(self): + """Pruefen ob RevPi Konfiguration geaendert wurde. + + In diesem Fall ist die Verbindung geschlossen und RevPiNetIO muss + neu instanziert werden. + + @return True, wenn RevPi Konfiguration geaendert ist""" + return self._myfh.config_changed + def get_jconfigrsc(self): """Laedt die piCotry Konfiguration und erstellt ein . @return der piCtory Konfiguration""" - mynh = NetFH(self._address) + mynh = NetFH(self._address, False) byte_buff = mynh.readpictory() mynh.close() return jloads(byte_buff.decode("utf-8")) + def get_reconnecting(self): + """Interner reconnect aktiv wegen Netzwerkfehlern. + + Das Modul versucht intern die Verbindung neu herzustellen. Es ist + kein weiteres Zutun noetig. + + @return True, wenn reconnect aktiv""" + return self._myfh.reconnecting + def net_cleardefaultvalues(self, device=None): """Loescht Defaultwerte vom PLC Slave. @param device nur auf einzelnes Device anwenden, sonst auf Alle""" @@ -646,6 +865,9 @@ class RevPiNetIO(_RevPiModIO): dev._offset + dev._slc_out.start, dirtybytes ) + config_changed = property(get_config_changed) + reconnecting = property(get_reconnecting) + class RevPiNetIOSelected(RevPiNetIO): @@ -695,6 +917,7 @@ class RevPiNetIOSelected(RevPiNetIO): ) self._configure(self.get_jconfigrsc()) + self._configure_replace_io(self._get_cpreplaceio()) if len(self.device) == 0: if type(self) == RevPiNetIODriver: diff --git a/setup.py b/setup.py index d17ee21..43f9371 100644 --- a/setup.py +++ b/setup.py @@ -17,7 +17,7 @@ setup( license="LGPLv3", name="revpimodio2", - version="2.4.0", + version="2.4.1", packages=["revpimodio2"], python_requires="~=3.2",