mirror of
https://github.com/naruxde/revpipyload.git
synced 2025-12-28 18:08:02 +01:00
Prozessabbildübertragung per MQTT begonnen
This commit is contained in:
145
doc/mqttserver.html
Normal file
145
doc/mqttserver.html
Normal file
@@ -0,0 +1,145 @@
|
||||
<!DOCTYPE html>
|
||||
<html><head>
|
||||
<title>mqttserver</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">
|
||||
mqttserver</h1>
|
||||
<p>
|
||||
Stellt die MQTT Uebertragung fuer IoT-Zwecke bereit.
|
||||
</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="#MqttServer">MqttServer</a></td>
|
||||
<td>Server fuer die Uebertragung des Prozessabbilds per MQTT.</td>
|
||||
</tr>
|
||||
</table>
|
||||
<h3 style="background-color:#FFFFFF;color:#FF0000">
|
||||
Functions</h3>
|
||||
<table>
|
||||
<tr><td>None</td></tr>
|
||||
</table>
|
||||
<hr /><hr />
|
||||
<a NAME="MqttServer" ID="MqttServer"></a>
|
||||
<h2 style="background-color:#FFFFFF;color:#0000FF">MqttServer</h2>
|
||||
<p>
|
||||
Server fuer die Uebertragung des Prozessabbilds per MQTT.
|
||||
</p>
|
||||
<h3 style="background-color:#FFFFFF;color:#FF0000">
|
||||
Derived from</h3>
|
||||
Thread
|
||||
<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="#MqttServer.__init__">MqttServer</a></td>
|
||||
<td>Init MqttServer class.</td>
|
||||
</tr><tr>
|
||||
<td><a style="color:#0000FF" href="#MqttServer._on_connect">_on_connect</a></td>
|
||||
<td>Verbindung zu MQTT Broker.</td>
|
||||
</tr><tr>
|
||||
<td><a style="color:#0000FF" href="#MqttServer._on_message">_on_message</a></td>
|
||||
<td>Sendet piCtory Konfiguration.</td>
|
||||
</tr><tr>
|
||||
<td><a style="color:#0000FF" href="#MqttServer.newlogfile">newlogfile</a></td>
|
||||
<td>Konfiguriert die FileHandler auf neue Logdatei.</td>
|
||||
</tr><tr>
|
||||
<td><a style="color:#0000FF" href="#MqttServer.run">run</a></td>
|
||||
<td>Startet die Uebertragung per MQTT.</td>
|
||||
</tr><tr>
|
||||
<td><a style="color:#0000FF" href="#MqttServer.stop">stop</a></td>
|
||||
<td>Stoppt die Uebertragung per MQTT.</td>
|
||||
</tr>
|
||||
</table>
|
||||
<h3 style="background-color:#FFFFFF;color:#FF0000">
|
||||
Static Methods</h3>
|
||||
<table>
|
||||
<tr><td>None</td></tr>
|
||||
</table>
|
||||
<a NAME="MqttServer.__init__" ID="MqttServer.__init__"></a>
|
||||
<h3 style="background-color:#FFFFFF;color:#FF0000">
|
||||
MqttServer (Constructor)</h3>
|
||||
<b>MqttServer</b>(<i>basetopic, sendinterval, host, port=1883, tls_set=False, username="", password=None, client_id=""</i>)
|
||||
<p>
|
||||
Init MqttServer class.
|
||||
</p><dl>
|
||||
<dt><i>basetopic</i></dt>
|
||||
<dd>
|
||||
Basis-Topic fuer Datenaustausch
|
||||
</dd><dt><i>sendinterval</i></dt>
|
||||
<dd>
|
||||
Prozessabbild alle n Sekunden senden
|
||||
</dd><dt><i>host</i></dt>
|
||||
<dd>
|
||||
Adresse <class 'str'> des MQTT-Servers
|
||||
</dd><dt><i>port</i></dt>
|
||||
<dd>
|
||||
Portnummer <class 'int'> des MQTT-Servers
|
||||
</dd><dt><i>keepalive</i></dt>
|
||||
<dd>
|
||||
MQTT Ping bei leerlauf
|
||||
</dd><dt><i>tls_set</i></dt>
|
||||
<dd>
|
||||
TLS fuer Verbindung zum MQTT-Server verwenden
|
||||
</dd><dt><i>username</i></dt>
|
||||
<dd>
|
||||
Optional Benutzername fuer MQTT-Server
|
||||
</dd><dt><i>password</i></dt>
|
||||
<dd>
|
||||
Optional Password fuer MQTT-Server
|
||||
</dd><dt><i>client_id</i></dt>
|
||||
<dd>
|
||||
MQTT ClientID, wenn leer automatisch random erzeugung
|
||||
</dd>
|
||||
</dl><a NAME="MqttServer._on_connect" ID="MqttServer._on_connect"></a>
|
||||
<h3 style="background-color:#FFFFFF;color:#FF0000">
|
||||
MqttServer._on_connect</h3>
|
||||
<b>_on_connect</b>(<i>client, userdata, flags, rc</i>)
|
||||
<p>
|
||||
Verbindung zu MQTT Broker.
|
||||
</p><a NAME="MqttServer._on_message" ID="MqttServer._on_message"></a>
|
||||
<h3 style="background-color:#FFFFFF;color:#FF0000">
|
||||
MqttServer._on_message</h3>
|
||||
<b>_on_message</b>(<i>client, userdata, msg</i>)
|
||||
<p>
|
||||
Sendet piCtory Konfiguration.
|
||||
</p><a NAME="MqttServer.newlogfile" ID="MqttServer.newlogfile"></a>
|
||||
<h3 style="background-color:#FFFFFF;color:#FF0000">
|
||||
MqttServer.newlogfile</h3>
|
||||
<b>newlogfile</b>(<i></i>)
|
||||
<p>
|
||||
Konfiguriert die FileHandler auf neue Logdatei.
|
||||
</p><a NAME="MqttServer.run" ID="MqttServer.run"></a>
|
||||
<h3 style="background-color:#FFFFFF;color:#FF0000">
|
||||
MqttServer.run</h3>
|
||||
<b>run</b>(<i></i>)
|
||||
<p>
|
||||
Startet die Uebertragung per MQTT.
|
||||
</p><a NAME="MqttServer.stop" ID="MqttServer.stop"></a>
|
||||
<h3 style="background-color:#FFFFFF;color:#FF0000">
|
||||
MqttServer.stop</h3>
|
||||
<b>stop</b>(<i></i>)
|
||||
<p>
|
||||
Stoppt die Uebertragung per MQTT.
|
||||
</p>
|
||||
<div align="right"><a style="color:#0000FF" href="#top">Up</a></div>
|
||||
<hr />
|
||||
</body></html>
|
||||
Reference in New Issue
Block a user