Files
revpipyload/doc/procimgserver.html
NaruX 9f7e3cc5a4 Wenn keine piCtory Konfiguration vorhanden ist, dennoch Modul laden
Bei RevPiModIO Instantiierung Rückgabewert False, sollte piCtory leer sein
description Text angepasst
2017-07-06 12:50:26 +02:00

207 lines
5.5 KiB
HTML

<!DOCTYPE html>
<html><head>
<title>procimgserver</title>
<meta charset="UTF-8">
</head>
<body style="background-color:#FFFFFF;color:#000000"><a NAME="top" ID="top"></a>
<h1 style="background-color:#FFFFFF;color:#0000FF">
procimgserver</h1>
<p>
Stellt Funktionen bereit um das Prozessabbild zu ueberwachen.
</p><p>
Bei ausreichend Rechten koennen Ausgaenge auch gesetzt werden um einen
IO-Check bei Inbetriebname durchzufuehren.
</p>
<h3 style="background-color:#FFFFFF;color:#FF0000">
Global Attributes</h3>
<table>
<tr><td>None</td></tr>
</table>
<h3 style="background-color:#FFFFFF;color:#FF0000">
Classes</h3>
<table>
<tr>
<td><a style="color:#0000FF" href="#ProcimgServer">ProcimgServer</a></td>
<td>Serverkomponente fuer zusaetzliche XML-RPC Funktionen.</td>
</tr>
</table>
<h3 style="background-color:#FFFFFF;color:#FF0000">
Functions</h3>
<table>
<tr><td>None</td></tr>
</table>
<hr /><hr />
<a NAME="ProcimgServer" ID="ProcimgServer"></a>
<h2 style="background-color:#FFFFFF;color:#0000FF">ProcimgServer</h2>
<p>
Serverkomponente fuer zusaetzliche XML-RPC Funktionen.
</p><p>
Diese Klasse registriert zusaetzliche Funktionen an einem besthenden
XML-RPC-Server. Der Funktionsumfang wird erweitert um zyklisch das
Prozessabbild zu empfangen und bei ausreichend Rechten Ausgaenge zu
setzen.
</p><p>
</p>
<h3 style="background-color:#FFFFFF;color:#FF0000">
Derived from</h3>
None
<h3 style="background-color:#FFFFFF;color:#FF0000">
Class Attributes</h3>
<table>
<tr><td>None</td></tr>
</table>
<h3 style="background-color:#FFFFFF;color:#FF0000">
Class Methods</h3>
<table>
<tr><td>None</td></tr>
</table>
<h3 style="background-color:#FFFFFF;color:#FF0000">
Methods</h3>
<table>
<tr>
<td><a style="color:#0000FF" href="#ProcimgServer.__init__">ProcimgServer</a></td>
<td>Instantiiert RevPiCheckServer()-Klasse.</td>
</tr><tr>
<td><a style="color:#0000FF" href="#ProcimgServer.devices">devices</a></td>
<td>Generiert Deviceliste mit Position und Namen.</td>
</tr><tr>
<td><a style="color:#0000FF" href="#ProcimgServer.ios">ios</a></td>
<td>Generiert ein dict() der Devices und IOs.</td>
</tr><tr>
<td><a style="color:#0000FF" href="#ProcimgServer.loadrevpimodio">loadrevpimodio</a></td>
<td>Instantiiert das RevPiModIO Modul.</td>
</tr><tr>
<td><a style="color:#0000FF" href="#ProcimgServer.setvalue">setvalue</a></td>
<td>Setzt einen Wert auf dem RevPi.</td>
</tr><tr>
<td><a style="color:#0000FF" href="#ProcimgServer.start">start</a></td>
<td>Registriert XML Funktionen.</td>
</tr><tr>
<td><a style="color:#0000FF" href="#ProcimgServer.stop">stop</a></td>
<td>Entfernt XML-Funktionen.</td>
</tr><tr>
<td><a style="color:#0000FF" href="#ProcimgServer.values">values</a></td>
<td>Liefert Prozessabbild an Client.</td>
</tr>
</table>
<h3 style="background-color:#FFFFFF;color:#FF0000">
Static Methods</h3>
<table>
<tr><td>None</td></tr>
</table>
<a NAME="ProcimgServer.__init__" ID="ProcimgServer.__init__"></a>
<h3 style="background-color:#FFFFFF;color:#FF0000">
ProcimgServer (Constructor)</h3>
<b>ProcimgServer</b>(<i>logger, xmlserver, configrsc, procimg, aclmode</i>)
<p>
Instantiiert RevPiCheckServer()-Klasse.
</p><dl>
<dt><i>xmlserver</i></dt>
<dd>
XML-RPC Server
</dd><dt><i>procimg</i></dt>
<dd>
Pfad zum Prozessabbild
</dd><dt><i>configrsc</i></dt>
<dd>
Pfad zur piCtory Konfigurationsdatei
</dd><dt><i>logger</i></dt>
<dd>
Loggerinstanz
</dd><dt><i>aclmode</i></dt>
<dd>
Zugriffsrechte
</dd>
</dl><a NAME="ProcimgServer.devices" ID="ProcimgServer.devices"></a>
<h3 style="background-color:#FFFFFF;color:#FF0000">
ProcimgServer.devices</h3>
<b>devices</b>(<i></i>)
<p>
Generiert Deviceliste mit Position und Namen.
</p><dl>
<dt>Returns:</dt>
<dd>
list() mit Tuple (pos, name)
</dd>
</dl><a NAME="ProcimgServer.ios" ID="ProcimgServer.ios"></a>
<h3 style="background-color:#FFFFFF;color:#FF0000">
ProcimgServer.ios</h3>
<b>ios</b>(<i>type</i>)
<p>
Generiert ein dict() der Devices und IOs.
</p><dl>
<dt><i>type</i></dt>
<dd>
IO Typ inp/out
</dd>
</dl><dl>
<dt>Returns:</dt>
<dd>
pickled dict()
</dd>
</dl><a NAME="ProcimgServer.loadrevpimodio" ID="ProcimgServer.loadrevpimodio"></a>
<h3 style="background-color:#FFFFFF;color:#FF0000">
ProcimgServer.loadrevpimodio</h3>
<b>loadrevpimodio</b>(<i></i>)
<p>
Instantiiert das RevPiModIO Modul.
</p><dl>
<dt>Returns:</dt>
<dd>
True, wenn erfolgreich, sonst False
</dd>
</dl><a NAME="ProcimgServer.setvalue" ID="ProcimgServer.setvalue"></a>
<h3 style="background-color:#FFFFFF;color:#FF0000">
ProcimgServer.setvalue</h3>
<b>setvalue</b>(<i>device, io, value</i>)
<p>
Setzt einen Wert auf dem RevPi.
</p><dl>
<dt><i>device</i></dt>
<dd>
Device Position oder Name
</dd><dt><i>io</i></dt>
<dd>
IO Name fuer neuen Wert
</dd><dt><i>value</i></dt>
<dd>
Neuer Wert
</dd>
</dl><dl>
<dt>Returns:</dt>
<dd>
list() [device, io, status, msg]
</dd>
</dl><a NAME="ProcimgServer.start" ID="ProcimgServer.start"></a>
<h3 style="background-color:#FFFFFF;color:#FF0000">
ProcimgServer.start</h3>
<b>start</b>(<i></i>)
<p>
Registriert XML Funktionen.
</p><dl>
<dt>Returns:</dt>
<dd>
True, wenn erfolgreich
</dd>
</dl><a NAME="ProcimgServer.stop" ID="ProcimgServer.stop"></a>
<h3 style="background-color:#FFFFFF;color:#FF0000">
ProcimgServer.stop</h3>
<b>stop</b>(<i></i>)
<p>
Entfernt XML-Funktionen.
</p><a NAME="ProcimgServer.values" ID="ProcimgServer.values"></a>
<h3 style="background-color:#FFFFFF;color:#FF0000">
ProcimgServer.values</h3>
<b>values</b>(<i></i>)
<p>
Liefert Prozessabbild an Client.
</p><dl>
<dt>Returns:</dt>
<dd>
Binary() bytes or None
</dd>
</dl>
<div align="right"><a style="color:#0000FF" href="#top">Up</a></div>
<hr />
</body></html>