Update examples following breaking change of #802

examples/aws_iot.py

@@ -6,7 +6,7 @@
 import os
 import uuid
 
-from paho.mqtt.client import Client
+from paho.mqtt.client import Client, CallbackAPIVersion
 
 
 def get_amazon_auth_headers(access_key, secret_key, region, host, port, headers=None):
@@ -122,7 +122,7 @@ def example_use():
         port,
     )
 
-    client = Client(transport="websockets")
+    client = Client(CallbackAPIVersion.VERSION2, transport="websockets")
 
     client.ws_set_options(headers=extra_headers)
 

examples/client_logger.py

@@ -27,7 +27,7 @@
 # mqttc = mqtt.Client("client-id")
 # but note that the client id must be unique on the broker. Leaving the client
 # id parameter empty will generate a random id for you.
-mqttc = mqtt.Client()
+mqttc = mqtt.Client(mqtt.CallbackAPIVersion.VERSION2)
 
 logger = logging.getLogger(__name__)
 mqttc.enable_logger(logger)

examples/client_mqtt_clear_retain.py

@@ -27,9 +27,9 @@
 final_mid = 0
 
 
-def on_connect(mqttc, userdata, flags, rc):
+def on_connect(mqttc, userdata, flags, reason_code, properties):
     if userdata:
-        print("rc: " + str(rc))
+        print(f"reason_code: {reason_code}")
 
 
 def on_message(mqttc, userdata, msg):
@@ -43,7 +43,7 @@ def on_message(mqttc, userdata, msg):
         (rc, final_mid) = mqttc.publish(msg.topic, None, 1, True)
 
 
-def on_publish(mqttc, userdata, mid):
+def on_publish(mqttc, userdata, mid, reason_code, properties):
     global final_mid
     if mid == final_mid:
         sys.exit()
@@ -101,7 +101,7 @@ def main(argv):
         print_usage()
         sys.exit(2)
 
-    mqttc = mqtt.Client(client_id)
+    mqttc = mqtt.Client(mqtt.CallbackAPIVersion.VERSION2, client_id)
     mqttc._userdata = verbose
     mqttc.on_message = on_message
     mqttc.on_publish = on_publish

examples/client_pub-wait.py

@@ -22,21 +22,16 @@
 import paho.mqtt.client as mqtt
 
 
-def on_connect(mqttc, obj, flags, rc):
-    print("rc: " + str(rc))
+def on_connect(mqttc, obj, flags, reason_code, properties):
+    print("reason_code: " + str(reason_code))
 
 
 def on_message(mqttc, obj, msg):
     print(msg.topic + " " + str(msg.qos) + " " + str(msg.payload))
 
 
-def on_publish(mqttc, obj, mid):
+def on_publish(mqttc, obj, mid, reason_code, properties):
     print("mid: " + str(mid))
-    pass
-
-
-def on_subscribe(mqttc, obj, mid, granted_qos):
-    print("Subscribed: " + str(mid) + " " + str(granted_qos))
 
 
 def on_log(mqttc, obj, level, string):
@@ -47,11 +42,10 @@ def on_log(mqttc, obj, level, string):
 # mqttc = mqtt.Client("client-id")
 # but note that the client id must be unique on the broker. Leaving the client
 # id parameter empty will generate a random id for you.
-mqttc = mqtt.Client()
+mqttc = mqtt.Client(mqtt.CallbackAPIVersion.VERSION2)
 mqttc.on_message = on_message
 mqttc.on_connect = on_connect
 mqttc.on_publish = on_publish
-mqttc.on_subscribe = on_subscribe
 # Uncomment to enable debug messages
 # mqttc.on_log = on_log
 mqttc.connect("mqtt.eclipseprojects.io", 1883, 60)

examples/client_pub_opts.py

@@ -44,22 +44,18 @@
 args, unknown = parser.parse_known_args()
 
 
-def on_connect(mqttc, obj, flags, rc):
-    print("connect rc: " + str(rc))
+def on_connect(mqttc, obj, flags, reason_code, properties):
+    print("connect reason_code: " + str(reason_code))
 
 
 def on_message(mqttc, obj, msg):
     print(msg.topic + " " + str(msg.qos) + " " + str(msg.payload))
 
 
-def on_publish(mqttc, obj, mid):
+def on_publish(mqttc, obj, mid, reason_code, properties):
     print("mid: " + str(mid))
 
 
-def on_subscribe(mqttc, obj, mid, granted_qos):
-    print("Subscribed: " + str(mid) + " " + str(granted_qos))
-
-
 def on_log(mqttc, obj, level, string):
     print(string)
 
@@ -75,7 +71,7 @@ def on_log(mqttc, obj, level, string):
     else:
         port = 1883
 
-mqttc = mqtt.Client(args.clientid,clean_session = not args.disable_clean_session)
+mqttc = mqtt.Client(mqtt.CallbackAPIVersion.VERSION2, args.clientid, clean_session = not args.disable_clean_session)
 
 if usetls:
     if args.tls_version == "tlsv1.2":
@@ -106,7 +102,6 @@ def on_log(mqttc, obj, level, string):
 mqttc.on_message = on_message
 mqttc.on_connect = on_connect
 mqttc.on_publish = on_publish
-mqttc.on_subscribe = on_subscribe
 
 if args.debug:
     mqttc.on_log = on_log

examples/client_rpc_math.py

@@ -16,6 +16,8 @@
 #
 
 # This shows an example of an MQTTv5 Remote Procedure Call (RPC) client.
+# You should run the server_rpc_math.py before.
+
 
 import json
 import sys
@@ -37,10 +39,10 @@
 reply = None
 
 # The MQTTv5 callback takes the additional 'props' parameter.
-def on_connect(mqttc, userdata, flags, rc, props):
+def on_connect(mqttc, userdata, flags, reason_code, props):
     global client_id, reply_to
 
-    print("Connected: '"+str(flags)+"', '"+str(rc)+"', '"+str(props))
+    print(f"Connected: '{flags}', '{reason_code}',  '{props}'")
     if hasattr(props, 'AssignedClientIdentifier'):
         client_id = props.AssignedClientIdentifier
     reply_to = "replies/math/" + client_id
@@ -65,11 +67,11 @@ def on_message(mqttc, userdata, msg):
     print("USAGE: client_rpc_math.py [add|mult] n1 n2 ...")
     sys.exit(1)
 
-mqttc = mqtt.Client(client_id="", protocol=mqtt.MQTTv5)
+mqttc = mqtt.Client(mqtt.CallbackAPIVersion.VERSION2, client_id="", protocol=mqtt.MQTTv5)
 mqttc.on_message = on_message
 mqttc.on_connect = on_connect
 
-mqttc.connect(host='localhost', clean_start=True)
+mqttc.connect(host="mqtt.eclipseprojects.io", clean_start=True)
 mqttc.loop_start()
 
 # Wait for connection to set `client_id`, etc.

examples/client_session_present.py

@@ -22,19 +22,19 @@
 import paho.mqtt.client as mqtt
 
 
-def on_connect(mqttc, obj, flags, rc):
+def on_connect(mqttc, obj, flags, reason_code, properties):
     if obj == 0:
         print("First connection:")
     elif obj == 1:
         print("Second connection:")
     elif obj == 2:
         print("Third connection (with clean session=True):")
-    print("    Session present: " + str(flags['session present']))
-    print("    Connection result: " + str(rc))
+    print("    Session present: " + str(flags.session_present))
+    print("    Connection result: " + str(reason_code))
     mqttc.disconnect()
 
 
-def on_disconnect(mqttc, obj, rc):
+def on_disconnect(mqttc, obj, flags, reason_code, properties):
     mqttc.user_data_set(obj + 1)
     if obj == 0:
         mqttc.reconnect()
@@ -44,7 +44,7 @@ def on_log(mqttc, obj, level, string):
     print(string)
 
 
-mqttc = mqtt.Client(client_id="asdfj", clean_session=False)
+mqttc = mqtt.Client(mqtt.CallbackAPIVersion.VERSION2, client_id="asdfj", clean_session=False)
 mqttc.on_connect = on_connect
 mqttc.on_disconnect = on_disconnect
 # Uncomment to enable debug messages
@@ -55,7 +55,7 @@ def on_log(mqttc, obj, level, string):
 mqttc.loop_forever()
 
 # Clear session
-mqttc = mqtt.Client(client_id="asdfj", clean_session=True)
+mqttc = mqtt.Client(mqtt.CallbackAPIVersion.VERSION2, client_id="asdfj", clean_session=True)
 mqttc.on_connect = on_connect
 mqttc.user_data_set(2)
 mqttc.connect("mqtt.eclipseprojects.io", 1883, 60)

examples/client_sub-class.py

@@ -22,20 +22,20 @@
 
 class MyMQTTClass(mqtt.Client):
 
-    def on_connect(self, mqttc, obj, flags, rc):
-        print("rc: "+str(rc))
+    def on_connect(self, mqttc, obj, flags, reason_code, properties):
+        print("rc: "+str(reason_code))
 
     def on_connect_fail(self, mqttc, obj):
         print("Connect failed")
 
     def on_message(self, mqttc, obj, msg):
         print(msg.topic+" "+str(msg.qos)+" "+str(msg.payload))
 
-    def on_publish(self, mqttc, obj, mid):
+    def on_publish(self, mqttc, obj, mid, reason_codes, properties):
         print("mid: "+str(mid))
 
-    def on_subscribe(self, mqttc, obj, mid, granted_qos):
-        print("Subscribed: "+str(mid)+" "+str(granted_qos))
+    def on_subscribe(self, mqttc, obj, mid, reason_code_list, properties):
+        print("Subscribed: "+str(mid)+" "+str(reason_code_list))
 
     def on_log(self, mqttc, obj, level, string):
         print(string)
@@ -54,7 +54,7 @@ def run(self):
 # mqttc = MyMQTTClass("client-id")
 # but note that the client id must be unique on the broker. Leaving the client
 # id parameter empty will generate a random id for you.
-mqttc = MyMQTTClass()
+mqttc = MyMQTTClass(mqtt.CallbackAPIVersion.VERSION2)
 rc = mqttc.run()
 
 print("rc: "+str(rc))

examples/client_sub-multiple-callback.py

@@ -41,7 +41,7 @@ def on_message(mosq, obj, msg):
     print(msg.topic + " " + str(msg.qos) + " " + str(msg.payload))
 
 
-mqttc = mqtt.Client()
+mqttc = mqtt.Client(mqtt.CallbackAPIVersion.VERSION2)
 
 # Add message callbacks that will only trigger on a specific subscription match.
 mqttc.message_callback_add("$SYS/broker/messages/#", on_message_msgs)

examples/client_sub-srv.py

@@ -22,17 +22,14 @@
 import paho.mqtt.client as mqtt
 
 
-def on_connect(mqttc, obj, flags, rc):
-    print("Connected to %s:%s" % (mqttc._host, mqttc._port))
+def on_connect(mqttc, obj, flags, reason_code, properties):
+    print("Connected to %s:%s" % (mqttc.host, mqttc.port))
 
 def on_message(mqttc, obj, msg):
     print(msg.topic+" "+str(msg.qos)+" "+str(msg.payload))
 
-def on_publish(mqttc, obj, mid):
-    print("mid: "+str(mid))
-
-def on_subscribe(mqttc, obj, mid, granted_qos):
-    print("Subscribed: "+str(mid)+" "+str(granted_qos))
+def on_subscribe(mqttc, obj, mid, reason_code_list, properties):
+    print("Subscribed: "+str(mid)+" "+str(reason_code_list))
 
 def on_log(mqttc, obj, level, string):
     print(string)
@@ -41,14 +38,13 @@ def on_log(mqttc, obj, level, string):
 # mqttc = mqtt.Client("client-id")
 # but note that the client id must be unique on the broker. Leaving the client
 # id parameter empty will generate a random id for you.
-mqttc = mqtt.Client()
+mqttc = mqtt.Client(mqtt.CallbackAPIVersion.VERSION2)
 mqttc.on_message = on_message
 mqttc.on_connect = on_connect
-mqttc.on_publish = on_publish
 mqttc.on_subscribe = on_subscribe
 # Uncomment to enable debug messages
 #mqttc.on_log = on_log
-mqttc.connect_srv("mosquitto.org", 60)
+mqttc.connect_srv("eclipseprojects.io", 60)
 mqttc.subscribe("$SYS/broker/version", 0)
 
 

examples/client_sub-ws.py

@@ -22,17 +22,14 @@
 import paho.mqtt.client as mqtt
 
 
-def on_connect(mqttc, obj, flags, rc):
-    print("rc: "+str(rc))
+def on_connect(mqttc, obj, flags, reason_code, properties):
+    print("reason_code: "+str(reason_code))
 
 def on_message(mqttc, obj, msg):
     print(msg.topic+" "+str(msg.qos)+" "+str(msg.payload))
 
-def on_publish(mqttc, obj, mid):
-    print("mid: "+str(mid))
-
-def on_subscribe(mqttc, obj, mid, granted_qos):
-    print("Subscribed: "+str(mid)+" "+str(granted_qos))
+def on_subscribe(mqttc, obj, mid, reason_code_list, properties):
+    print("Subscribed: "+str(mid)+" "+str(reason_code_list))
 
 def on_log(mqttc, obj, level, string):
     print(string)
@@ -41,14 +38,13 @@ def on_log(mqttc, obj, level, string):
 # mqttc = mqtt.Client("client-id")
 # but note that the client id must be unique on the broker. Leaving the client
 # id parameter empty will generate a random id for you.
-mqttc = mqtt.Client(transport="websockets")
+mqttc = mqtt.Client(mqtt.CallbackAPIVersion.VERSION2, transport="websockets")
 mqttc.on_message = on_message
 mqttc.on_connect = on_connect
-mqttc.on_publish = on_publish
 mqttc.on_subscribe = on_subscribe
 # Uncomment to enable debug messages
 mqttc.on_log = on_log
-mqttc.connect("test.mosquitto.org", 8080, 60)
+mqttc.connect("mqtt.eclipseprojects.io", 80, 60)
 mqttc.subscribe("$SYS/broker/version", 0)
 
 mqttc.loop_forever()

examples/client_sub.py

@@ -22,20 +22,16 @@
 import paho.mqtt.client as mqtt
 
 
-def on_connect(mqttc, obj, flags, rc):
-    print("rc: " + str(rc))
+def on_connect(mqttc, obj, flags, reason_code, properties):
+    print("reason_code: " + str(reason_code))
 
 
 def on_message(mqttc, obj, msg):
     print(msg.topic + " " + str(msg.qos) + " " + str(msg.payload))
 
 
-def on_publish(mqttc, obj, mid):
-    print("mid: " + str(mid))
-
-
-def on_subscribe(mqttc, obj, mid, granted_qos):
-    print("Subscribed: " + str(mid) + " " + str(granted_qos))
+def on_subscribe(mqttc, obj, mid, reason_code_list, properties):
+    print("Subscribed: " + str(mid) + " " + str(reason_code_list))
 
 
 def on_log(mqttc, obj, level, string):
@@ -46,10 +42,9 @@ def on_log(mqttc, obj, level, string):
 # mqttc = mqtt.Client("client-id")
 # but note that the client id must be unique on the broker. Leaving the client
 # id parameter empty will generate a random id for you.
-mqttc = mqtt.Client()
+mqttc = mqtt.Client(mqtt.CallbackAPIVersion.VERSION2)
 mqttc.on_message = on_message
 mqttc.on_connect = on_connect
-mqttc.on_publish = on_publish
 mqttc.on_subscribe = on_subscribe
 # Uncomment to enable debug messages
 # mqttc.on_log = on_log