Mercurial Repositories > MQTT Monitor / file comparison

comparison: MqttMonitor/Documentation/source/Plugin_Mqtt_Monitor.MqttMonitor.MqttClient.html

MqttMonitor/Documentation/source/Plugin_Mqtt_Monitor.MqttMonitor.MqttClient.html

branch
eric7
changeset 123
3d7e63ed4fd1
parent 115
357257ad48d2
child 132
b4fde9ee3d83
equal deleted inserted replaced
122:28d69b9e1b6a 123:3d7e63ed4fd1
151 <tr> 151 <tr>
152 <td><a href="#MqttClient.__initCallbacks">__initCallbacks</a></td> 152 <td><a href="#MqttClient.__initCallbacks">__initCallbacks</a></td>
153 <td>Private method to initialize the MQTT callback methods.</td> 153 <td>Private method to initialize the MQTT callback methods.</td>
154 </tr> 154 </tr>
155 <tr> 155 <tr>
156 <td><a href="#MqttClient.__onConnectV3">__onConnectV3</a></td>
157 <td>Private method to handle the connect to the broker (MQTT v3.1 and v3.1.1).</td>
158 </tr>
159 <tr>
160 <td><a href="#MqttClient.__onConnectV5">__onConnectV5</a></td>
161 <td>Private method to handle the connect to the broker (MQTT v5.0).</td>
162 </tr>
163 <tr>
164 <td><a href="#MqttClient.__onDisconnectedV3">__onDisconnectedV3</a></td>
165 <td>Private method to handle the disconnect from the broker (MQTT v3.1 and v3.1.1).</td>
166 </tr>
167 <tr>
156 <td><a href="#MqttClient.__onDisconnectedV5">__onDisconnectedV5</a></td> 168 <td><a href="#MqttClient.__onDisconnectedV5">__onDisconnectedV5</a></td>
157 <td>Private method to handle the disconnect from the broker.</td> 169 <td>Private method to handle the disconnect from the broker (MQTT v5.0).</td>
170 </tr>
171 <tr>
172 <td><a href="#MqttClient.__onLog">__onLog</a></td>
173 <td>Private method to handle a log event (MQTT v3.1, v3.1.1 and v5.0).</td>
174 </tr>
175 <tr>
176 <td><a href="#MqttClient.__onMessageV3">__onMessageV3</a></td>
177 <td>Private method to handle a new message received from the broker (MQTT v3.1 and v3.1.1).</td>
178 </tr>
179 <tr>
180 <td><a href="#MqttClient.__onMessageV5">__onMessageV5</a></td>
181 <td>Private method to handle a new message received from the broker (MQTT v5.0).</td>
182 </tr>
183 <tr>
184 <td><a href="#MqttClient.__onPublish">__onPublish</a></td>
185 <td>Private method to handle the publishing of a message (MQTT v3.1, v3.1.1 and v5.0).</td>
186 </tr>
187 <tr>
188 <td><a href="#MqttClient.__onSubscribeV3">__onSubscribeV3</a></td>
189 <td>Private method to handle a subscribe event (MQTT v3.1 and v3.1.1).</td>
190 </tr>
191 <tr>
192 <td><a href="#MqttClient.__onSubscribeV5">__onSubscribeV5</a></td>
193 <td>Private method to handle a subscribe event (MQTT v5.0).</td>
194 </tr>
195 <tr>
196 <td><a href="#MqttClient.__onUnsubscribeV3">__onUnsubscribeV3</a></td>
197 <td>Private method to handle an unsubscribe event (MQTT v3.1 and v3.1.1).</td>
198 </tr>
199 <tr>
200 <td><a href="#MqttClient.__onUnsubscribeV5">__onUnsubscribeV5</a></td>
201 <td>Private method to handle an unsubscribe event (MQTT v5.0).</td>
158 </tr> 202 </tr>
159 <tr> 203 <tr>
160 <td><a href="#MqttClient.clearLastWill">clearLastWill</a></td> 204 <td><a href="#MqttClient.clearLastWill">clearLastWill</a></td>
161 <td>Public method to remove a will that was previously configured with setLastWill().</td> 205 <td>Public method to remove a will that was previously configured with setLastWill().</td>
162 </tr> 206 </tr>
259 dict 303 dict
260 </dd> 304 </dd>
261 </dl> 305 </dl>
262 <a NAME="MqttClient.__init__" ID="MqttClient.__init__"></a> 306 <a NAME="MqttClient.__init__" ID="MqttClient.__init__"></a>
263 <h4>MqttClient (Constructor)</h4> 307 <h4>MqttClient (Constructor)</h4>
264 <b>MqttClient</b>(<i>clientId="", cleanSession=True, userdata=None, protocol=mqtt.MQTTv311, transport="tcp", parent=None</i>) 308 <b>MqttClient</b>(<i>clientId="", cleanSession=True, userdata=None, protocol=mqtt.MQTTv311, transport="tcp", parent=None, </i>)
265 309
266 <p> 310 <p>
267 Constructor 311 Constructor
268 </p> 312 </p>
269 <dl> 313 <dl>
342 <dt><i>protocol</i> (MqttProtocols)</dt> 386 <dt><i>protocol</i> (MqttProtocols)</dt>
343 <dd> 387 <dd>
344 MQTT protocol version 388 MQTT protocol version
345 </dd> 389 </dd>
346 </dl> 390 </dl>
391 <a NAME="MqttClient.__onConnectV3" ID="MqttClient.__onConnectV3"></a>
392 <h4>MqttClient.__onConnectV3</h4>
393 <b>__onConnectV3</b>(<i>client, userdata, flags, rc, properties=None</i>)
394
395 <p>
396 Private method to handle the connect to the broker (MQTT v3.1 and v3.1.1).
397 </p>
398 <dl>
399
400 <dt><i>client</i> (paho.mqtt.Client)</dt>
401 <dd>
402 reference to the client object
403 </dd>
404 <dt><i>userdata</i> (Any)</dt>
405 <dd>
406 user data
407 </dd>
408 <dt><i>flags</i> (dict)</dt>
409 <dd>
410 dictionary containing the response flags sent by the broker
411 </dd>
412 <dt><i>rc</i> (int)</dt>
413 <dd>
414 result code
415 </dd>
416 <dt><i>properties</i> (dict (optional))</dt>
417 <dd>
418 optional properties (defaults to None)
419 </dd>
420 </dl>
421 <a NAME="MqttClient.__onConnectV5" ID="MqttClient.__onConnectV5"></a>
422 <h4>MqttClient.__onConnectV5</h4>
423 <b>__onConnectV5</b>(<i>client, userdata, flags, rc, properties=None</i>)
424
425 <p>
426 Private method to handle the connect to the broker (MQTT v5.0).
427 </p>
428 <dl>
429
430 <dt><i>client</i> (paho.mqtt.Client)</dt>
431 <dd>
432 reference to the client object
433 </dd>
434 <dt><i>userdata</i> (Any)</dt>
435 <dd>
436 user data
437 </dd>
438 <dt><i>flags</i> (dict)</dt>
439 <dd>
440 dictionary containing the response flags sent by the broker
441 </dd>
442 <dt><i>rc</i> (paho.mqtt.ReasonCodes)</dt>
443 <dd>
444 reason code
445 </dd>
446 <dt><i>properties</i> (dict (optional))</dt>
447 <dd>
448 optional properties (defaults to None)
449 </dd>
450 </dl>
451 <a NAME="MqttClient.__onDisconnectedV3" ID="MqttClient.__onDisconnectedV3"></a>
452 <h4>MqttClient.__onDisconnectedV3</h4>
453 <b>__onDisconnectedV3</b>(<i>client, userdata, rc</i>)
454
455 <p>
456 Private method to handle the disconnect from the broker (MQTT v3.1 and v3.1.1).
457 </p>
458 <dl>
459
460 <dt><i>client</i> (paho.mqtt.Client)</dt>
461 <dd>
462 reference to the client object
463 </dd>
464 <dt><i>userdata</i> (Any)</dt>
465 <dd>
466 user data
467 </dd>
468 <dt><i>rc</i> (int)</dt>
469 <dd>
470 result code
471 </dd>
472 </dl>
347 <a NAME="MqttClient.__onDisconnectedV5" ID="MqttClient.__onDisconnectedV5"></a> 473 <a NAME="MqttClient.__onDisconnectedV5" ID="MqttClient.__onDisconnectedV5"></a>
348 <h4>MqttClient.__onDisconnectedV5</h4> 474 <h4>MqttClient.__onDisconnectedV5</h4>
349 <b>__onDisconnectedV5</b>(<i>client, userdata, rc, properties=None</i>) 475 <b>__onDisconnectedV5</b>(<i>client, userdata, rc, properties=None</i>)
350 476
351 <p> 477 <p>
352 Private method to handle the disconnect from the broker. 478 Private method to handle the disconnect from the broker (MQTT v5.0).
353 </p> 479 </p>
354 <dl> 480 <dl>
355 481
356 <dt><i>client</i> (paho.mqtt.Client)</dt> 482 <dt><i>client</i> (paho.mqtt.Client)</dt>
357 <dd> 483 <dd>
359 </dd> 485 </dd>
360 <dt><i>userdata</i> (Any)</dt> 486 <dt><i>userdata</i> (Any)</dt>
361 <dd> 487 <dd>
362 user data 488 user data
363 </dd> 489 </dd>
364 <dt><i>rc</i> (int or ReasonCodes)</dt> 490 <dt><i>rc</i> (int or paho.mqtt.ReasonCodes)</dt>
365 <dd> 491 <dd>
366 result code or reason code 492 result code or reason code
367 </dd> 493 </dd>
368 <dt><i>properties</i> (dict (optional))</dt> 494 <dt><i>properties</i> (dict (optional))</dt>
369 <dd> 495 <dd>
370 optional properties (defaults to None) 496 optional properties (defaults to None)
497 </dd>
498 </dl>
499 <a NAME="MqttClient.__onLog" ID="MqttClient.__onLog"></a>
500 <h4>MqttClient.__onLog</h4>
501 <b>__onLog</b>(<i>client, userdata, level, buf</i>)
502
503 <p>
504 Private method to handle a log event (MQTT v3.1, v3.1.1 and v5.0).
505 </p>
506 <dl>
507
508 <dt><i>client</i> (paho.mqtt.Client)</dt>
509 <dd>
510 reference to the client object
511 </dd>
512 <dt><i>userdata</i> (Any)</dt>
513 <dd>
514 user data
515 </dd>
516 <dt><i>level</i> (int)</dt>
517 <dd>
518 severity of the log message
519 </dd>
520 <dt><i>buf</i> (str)</dt>
521 <dd>
522 log message
523 </dd>
524 </dl>
525 <a NAME="MqttClient.__onMessageV3" ID="MqttClient.__onMessageV3"></a>
526 <h4>MqttClient.__onMessageV3</h4>
527 <b>__onMessageV3</b>(<i>client, userdata, message</i>)
528
529 <p>
530 Private method to handle a new message received from the broker (MQTT v3.1
531 and v3.1.1).
532 </p>
533 <dl>
534
535 <dt><i>client</i> (paho.mqtt.Client)</dt>
536 <dd>
537 reference to the client object
538 </dd>
539 <dt><i>userdata</i> (Any)</dt>
540 <dd>
541 user data
542 </dd>
543 <dt><i>message</i> (paho.mqtt.MQTTMessage)</dt>
544 <dd>
545 received message object
546 </dd>
547 </dl>
548 <a NAME="MqttClient.__onMessageV5" ID="MqttClient.__onMessageV5"></a>
549 <h4>MqttClient.__onMessageV5</h4>
550 <b>__onMessageV5</b>(<i>client, userdata, message</i>)
551
552 <p>
553 Private method to handle a new message received from the broker (MQTT v5.0).
554 </p>
555 <dl>
556
557 <dt><i>client</i> (paho.mqtt.Client)</dt>
558 <dd>
559 reference to the client object
560 </dd>
561 <dt><i>userdata</i> (Any)</dt>
562 <dd>
563 user data
564 </dd>
565 <dt><i>message</i> (paho.mqtt.MQTTMessage)</dt>
566 <dd>
567 received message object
568 </dd>
569 </dl>
570 <a NAME="MqttClient.__onPublish" ID="MqttClient.__onPublish"></a>
571 <h4>MqttClient.__onPublish</h4>
572 <b>__onPublish</b>(<i>client, userdata, mid</i>)
573
574 <p>
575 Private method to handle the publishing of a message (MQTT v3.1, v3.1.1
576 and v5.0).
577 </p>
578 <dl>
579
580 <dt><i>client</i> (paho.mqtt.Client)</dt>
581 <dd>
582 reference to the client object
583 </dd>
584 <dt><i>userdata</i> (Any)</dt>
585 <dd>
586 user data
587 </dd>
588 <dt><i>mid</i> (int)</dt>
589 <dd>
590 message ID
591 </dd>
592 </dl>
593 <a NAME="MqttClient.__onSubscribeV3" ID="MqttClient.__onSubscribeV3"></a>
594 <h4>MqttClient.__onSubscribeV3</h4>
595 <b>__onSubscribeV3</b>(<i>client, userdata, mid, grantedQos</i>)
596
597 <p>
598 Private method to handle a subscribe event (MQTT v3.1 and v3.1.1).
599 </p>
600 <dl>
601
602 <dt><i>client</i> (paho.mqtt.Client)</dt>
603 <dd>
604 reference to the client object
605 </dd>
606 <dt><i>userdata</i> (Any)</dt>
607 <dd>
608 user data
609 </dd>
610 <dt><i>mid</i> (int)</dt>
611 <dd>
612 message ID
613 </dd>
614 <dt><i>grantedQos</i> (list of int)</dt>
615 <dd>
616 list of granted QoS for each subscription request
617 </dd>
618 </dl>
619 <a NAME="MqttClient.__onSubscribeV5" ID="MqttClient.__onSubscribeV5"></a>
620 <h4>MqttClient.__onSubscribeV5</h4>
621 <b>__onSubscribeV5</b>(<i>client, userdata, mid, reasonCodes, properties=None</i>)
622
623 <p>
624 Private method to handle a subscribe event (MQTT v5.0).
625 </p>
626 <dl>
627
628 <dt><i>client</i> (paho.mqtt.Client)</dt>
629 <dd>
630 reference to the client object
631 </dd>
632 <dt><i>userdata</i> (Any)</dt>
633 <dd>
634 user data
635 </dd>
636 <dt><i>mid</i> (int)</dt>
637 <dd>
638 message ID
639 </dd>
640 <dt><i>reasonCodes</i> (list of paho.mqtt.ReasonCodes)</dt>
641 <dd>
642 list of reason code for each subscribed topic
643 </dd>
644 <dt><i>properties</i> (dict (optional))</dt>
645 <dd>
646 optional properties (defaults to None)
647 </dd>
648 </dl>
649 <a NAME="MqttClient.__onUnsubscribeV3" ID="MqttClient.__onUnsubscribeV3"></a>
650 <h4>MqttClient.__onUnsubscribeV3</h4>
651 <b>__onUnsubscribeV3</b>(<i>client, userdata, mid</i>)
652
653 <p>
654 Private method to handle an unsubscribe event (MQTT v3.1 and v3.1.1).
655 </p>
656 <dl>
657
658 <dt><i>client</i> (paho.mqtt.Client)</dt>
659 <dd>
660 reference to the client object
661 </dd>
662 <dt><i>userdata</i> (Any)</dt>
663 <dd>
664 user data
665 </dd>
666 <dt><i>mid</i> (int)</dt>
667 <dd>
668 message ID
669 </dd>
670 </dl>
671 <a NAME="MqttClient.__onUnsubscribeV5" ID="MqttClient.__onUnsubscribeV5"></a>
672 <h4>MqttClient.__onUnsubscribeV5</h4>
673 <b>__onUnsubscribeV5</b>(<i>client, userdata, mid, properties, reasonCodes</i>)
674
675 <p>
676 Private method to handle an unsubscribe event (MQTT v5.0).
677 </p>
678 <dl>
679
680 <dt><i>client</i> (paho.mqtt.Client)</dt>
681 <dd>
682 reference to the client object
683 </dd>
684 <dt><i>userdata</i> (Any)</dt>
685 <dd>
686 user data
687 </dd>
688 <dt><i>mid</i> (int)</dt>
689 <dd>
690 message ID
691 </dd>
692 <dt><i>properties</i> (dict (optional))</dt>
693 <dd>
694 optional properties (defaults to None)
695 </dd>
696 <dt><i>reasonCodes</i> (list of paho.mqtt.ReasonCodes)</dt>
697 <dd>
698 list of reason code for each unsubscribed topic
371 </dd> 699 </dd>
372 </dl> 700 </dl>
373 <a NAME="MqttClient.clearLastWill" ID="MqttClient.clearLastWill"></a> 701 <a NAME="MqttClient.clearLastWill" ID="MqttClient.clearLastWill"></a>
374 <h4>MqttClient.clearLastWill</h4> 702 <h4>MqttClient.clearLastWill</h4>
375 <b>clearLastWill</b>(<i></i>) 703 <b>clearLastWill</b>(<i></i>)
378 Public method to remove a will that was previously configured with 706 Public method to remove a will that was previously configured with
379 setLastWill(). 707 setLastWill().
380 </p> 708 </p>
381 <a NAME="MqttClient.connectToServer" ID="MqttClient.connectToServer"></a> 709 <a NAME="MqttClient.connectToServer" ID="MqttClient.connectToServer"></a>
382 <h4>MqttClient.connectToServer</h4> 710 <h4>MqttClient.connectToServer</h4>
383 <b>connectToServer</b>(<i>host, port=1883, keepalive=60, bindAddress="", properties=None, clearWill=False</i>) 711 <b>connectToServer</b>(<i>host, port=1883, keepalive=60, bindAddress="", properties=None, clearWill=False, </i>)
384 712
385 <p> 713 <p>
386 Public method to connect to a remote MQTT broker. 714 Public method to connect to a remote MQTT broker.
387 </p> 715 </p>
388 <dl> 716 <dl>

Mercurial Repository: MQTT Monitor

eric ide

mercurial