umqtt.simple: remove debug printing and add debug wrapper for MQTTClient which can optionally be used with examples

SpotlightKid · SpotlightKid · commit 65a29fec2257 · 2018-08-27T19:29:01.000+02:00
diff --git a/umqtt.simple/example_pub.py b/umqtt.simple/example_pub.py
@@ -1,13 +1,15 @@
 from umqtt.simple import MQTTClient
+#from umqtt_debug import DebugMQTTClient as MQTTClient
 
 # Test reception e.g. with:
 # mosquitto_sub -t foo_topic
 
-def main(server="localhost"):
+def main(server="localhost", topic="foo_topic", msg="hello", qos=0):
     c = MQTTClient("umqtt_client", server)
     c.connect()
-    c.publish(b"foo_topic", b"hello")
+    c.publish(topic.encode('utf-8'), msg.encode('utf-8'), qos=int(qos))
     c.disconnect()
 
 if __name__ == "__main__":
-    main()
+    import sys
+    main(*sys.argv[1:])
diff --git a/umqtt.simple/example_sub.py b/umqtt.simple/example_sub.py
@@ -1,20 +1,21 @@
 import time
 from umqtt.simple import MQTTClient
+#from umqtt_debug import DebugMQTTClient as MQTTClient
 
 # Publish test messages e.g. with:
 # mosquitto_pub -t foo_topic -m hello
 
 # Received messages from subscriptions will be delivered to this callback
 def sub_cb(topic, msg):
     print((topic, msg))
-
-def main(server="localhost"):
+    
+def main(server="localhost", topic="foo_topic", qos=0, blocking=True):
     c = MQTTClient("umqtt_client", server)
     c.set_callback(sub_cb)
     c.connect()
-    c.subscribe(b"foo_topic")
+    c.subscribe(topic.encode('utf-8'), int(qos))
     while True:
-        if True:
+        if blocking:
             # Blocking wait for message
             c.wait_msg()
         else:
@@ -27,4 +28,5 @@ def main(server="localhost"):
     c.disconnect()
 
 if __name__ == "__main__":
-    main()
+    import sys
+    main(*sys.argv[1:])
diff --git a/umqtt.simple/umqtt/simple.py b/umqtt.simple/umqtt/simple.py
@@ -1,5 +1,4 @@
 import usocket as socket
-#from ubinascii import hexlify
 
 class MQTTException(Exception):
     pass
@@ -89,9 +88,7 @@ def connect(self, clean_session=True):
             msg[7] |= self.lw_retain << 5
 
         plen = self._varlen_encode(sz, premsg, 1)
-        #print(hex(len(premsg[:plen])), hexlify(premsg[:plen], ":"))
         self.sock.write(premsg, plen)
-        #print(hex(len(msg)), hexlify(msg, ":"))
         self.sock.write(msg)
         self._send_str(self.client_id)
         if self.lw_topic:
@@ -121,7 +118,6 @@ def publish(self, topic, msg, retain=False, qos=0):
         if qos > 0:
             sz += 2
         plen = self._varlen_encode(sz, pkt, 1)
-        #print(hex(len(pkt[:plen])), hexlify(pkt[:plen], ":"))
         self.sock.write(pkt, plen)
         self._send_str(topic)
         if qos > 0:
@@ -148,15 +144,13 @@ def subscribe(self, topic, qos=0):
         sz = 2 + 2 + len(topic) + 1
         plen = self._varlen_encode(sz, pkt, 1)
         pkt[plen:plen + 2] = self.pid.to_bytes(2, 'big')
-        #print(hex(len(pkt[:plen + 2])), hexlify(pkt[:plen + 2], ":"))
         self.sock.write(pkt, plen + 2)
         self._send_str(topic)
         self.sock.write(qos.to_bytes(1, "little"))
         while 1:
             op = self.wait_msg()
             if op == 0x90:
                 resp = self.sock.read(4)
-                #print(resp)
                 assert resp[1] == pkt[plen] and resp[2] == pkt[plen + 1]
                 if resp[3] == 0x80:
                     raise MQTTException(resp[3])
diff --git a/umqtt.simple/umqtt_debug.py b/umqtt.simple/umqtt_debug.py
@@ -0,0 +1,38 @@
+from umqtt.simple import MQTTClient
+from ubinascii import hexlify
+
+
+class debug_socket:
+    def __init__(self, sock):
+        self.sock = sock
+    
+    def read(self, len):
+        data = self.sock.read(len)
+        print("RECV:", hexlify(data, ':').decode())
+        return data
+
+    def write(self, data, len=None):
+        print("SEND:", hexlify(data, ':').decode())
+        if len is None:
+            return self.sock.write(data)
+        else:
+            return self.sock.write(data, len)
+
+    def __getattr__(self, name):
+        return getattr(self.sock, name)
+
+
+class DebugMQTTClient(MQTTClient):
+    def __init__(self, *args, **kw):
+        super().__init__(*args, **kw)
+        self._sock = None
+
+    @property
+    def sock(self):
+        return self._sock
+
+    @sock.setter
+    def sock(self, val):
+        if val:
+            val = debug_socket(val)
+        self._sock = val
