add new example

Author: brentru

adafruit_minimqtt/adafruit_minimqtt.py

@@ -4,6 +4,7 @@
 #
 # Original Work Copyright (c) 2016 Paul Sokolovsky, uMQTT
 # Modified Work Copyright (c) 2019 Bradley Beach, esp32spi_mqtt
+# Modified Work Copyright (c) 2012-2019 Roger Light and others, Paho MQTT Python
 #
 # Permission is hereby granted, free of charge, to any person obtaining a copy
 # of this software and associated documentation files (the "Software"), to deal
@@ -257,10 +258,10 @@ def _handle_on_message(self, client, topic, message):
         matched = False
         if topic is not None:
             for callback in self._on_message_filtered.iter_match(topic):
-                callback(client, topic, message) # on_msg with callback
+                callback(client, topic, message)  # on_msg with callback
                 matched = True
 
-        if not matched and self.on_message: # regular on_message
+        if not matched and self.on_message:  # regular on_message
             self.on_message(client, topic, message)
 
     # pylint: disable=too-many-branches, too-many-statements, too-many-locals

adafruit_minimqtt/matcher.py

@@ -13,20 +13,26 @@
 * Author(s): Yotch (https://github.com/yoch)
 """
 
-class MQTTMatcher(object):
+
+class MQTTMatcher:
     """Intended to manage topic filters including wildcards.
 
-    Internally, MQTTMatcher use a prefix tree (trie) to store 
-    values associated with filters, and has an iter_match() 
-    method to iterate efficiently over all filters that match 
-    some topic name."""
+    Internally, MQTTMatcher use a prefix tree (trie) to store
+    values associated with filters, and has an iter_match()
+    method to iterate efficiently over all filters that match
+    some topic name.
+    """
+
+    # pylint: disable=too-few-public-methods
+    class Node:
+        """Individual node on the MQTT prefix tree.
+        """
 
-    class Node(object):
-        __slots__ = '_children', '_content'
+        __slots__ = "children", "content"
 
         def __init__(self):
-            self._children = {}
-            self._content = None
+            self.children = {}
+            self.content = None
 
     def __init__(self):
         self._root = self.Node()
@@ -35,19 +41,19 @@ def __setitem__(self, key, value):
         """Add a topic filter :key to the prefix tree
         and associate it to :value"""
         node = self._root
-        for sym in key.split('/'):
-            node = node._children.setdefault(sym, self.Node())
-        node._content = value
+        for sym in key.split("/"):
+            node = node.children.setdefault(sym, self.Node())
+        node.content = value
 
     def __getitem__(self, key):
         """Retrieve the value associated with some topic filter :key"""
         try:
             node = self._root
-            for sym in key.split('/'):
-                node = node._children[sym]
-            if node._content is None:
+            for sym in key.split("/"):
+                node = node.children[sym]
+            if node.content is None:
                 raise KeyError(key)
-            return node._content
+            return node.content
         except KeyError:
             raise KeyError(key)
 
@@ -56,38 +62,39 @@ def __delitem__(self, key):
         lst = []
         try:
             parent, node = None, self._root
-            for k in key.split('/'):
-                 parent, node = node, node._children[k]
-                 lst.append((parent, k, node))
-            # TODO
-            node._content = None
+            for k in key.split("/"):
+                parent, node = node, node.children[k]
+                lst.append((parent, k, node))
+            node.content = None
         except KeyError:
             raise KeyError(key)
         else:  # cleanup
             for parent, k, node in reversed(lst):
-                if node._children or node._content is not None:
-                     break
-                del parent._children[k]
+                if node.children or node.content is not None:
+                    break
+                del parent.children[k]
 
     def iter_match(self, topic):
-        """Return an iterator on all values associated with filters 
+        """Return an iterator on all values associated with filters
         that match the :topic"""
-        lst = topic.split('/')
-        normal = not topic.startswith('$')
+        lst = topic.split("/")
+        normal = not topic.startswith("$")
+
         def rec(node, i=0):
             if i == len(lst):
-                if node._content is not None:
-                    yield node._content
+                if node.content is not None:
+                    yield node.content
             else:
                 part = lst[i]
-                if part in node._children:
-                    for content in rec(node._children[part], i + 1):
+                if part in node.children:
+                    for content in rec(node.children[part], i + 1):
                         yield content
-                if '+' in node._children and (normal or i > 0):
-                    for content in rec(node._children['+'], i + 1):
+                if "+" in node.children and (normal or i > 0):
+                    for content in rec(node.children["+"], i + 1):
                         yield content
-            if '#' in node._children and (normal or i > 0):
-                content = node._children['#']._content
+            if "#" in node.children and (normal or i > 0):
+                content = node.children["#"].content
                 if content is not None:
                     yield content
-        return rec(self._root)
+
+        return rec(self._root)

examples/minimqtt_pub_sub_multiple_callbacks.py renamed to examples/minimqtt_pub_sub_blocking_topic_callbacks.py

@@ -17,9 +17,15 @@
     print("WiFi secrets are kept in secrets.py, please add them there!")
     raise
 
-esp32_cs = DigitalInOut(board.D13)
-esp32_ready = DigitalInOut(board.D11)
-esp32_reset = DigitalInOut(board.D12)
+# If you are using a board with pre-defined ESP32 Pins:
+esp32_cs = DigitalInOut(board.ESP_CS)
+esp32_ready = DigitalInOut(board.ESP_BUSY)
+esp32_reset = DigitalInOut(board.ESP_RESET)
+
+# If you have an externally connected ESP32:
+# esp32_cs = DigitalInOut(board.D9)
+# esp32_ready = DigitalInOut(board.D10)
+# esp32_reset = DigitalInOut(board.D5)
 
 spi = busio.SPI(board.SCK, board.MOSI, board.MISO)
 esp = adafruit_esp32spi.ESP_SPIcontrol(spi, esp32_cs, esp32_ready, esp32_reset)
@@ -38,30 +44,18 @@
 # status_light = adafruit_rgbled.RGBLED(RED_LED, BLUE_LED, GREEN_LED)
 wifi = adafruit_esp32spi_wifimanager.ESPSPI_WiFiManager(esp, secrets, status_light)
 
-### Topic Setup ###
-
-# MQTT Topic
-# Use this topic if you'd like to connect to a standard MQTT broker
-mqtt_topic = "test/topic"
-
-# Adafruit IO-style Topic
-# Use this topic if you'd like to connect to io.adafruit.com
-# mqtt_topic = 'aio_user/feeds/temperature'
-
 ### Code ###
 
 # Define callback methods which are called when events occur
 # pylint: disable=unused-argument, redefined-outer-name
-def connect(client, userdata, flags, rc):
+def connected(client, userdata, flags, rc):
     # This function will be called when the client is connected
     # successfully to the broker.
     print("Connected to MQTT Broker!")
-    print("Flags: {0}\n RC: {1}".format(flags, rc))
 
 
-def disconnect(client, userdata, rc):
-    # This method is called when the client disconnects
-    # from the broker.
+def disconnected(client, userdata, rc):
+    # This method is called when the client is disconnected
     print("Disconnected from MQTT Broker!")
 
 
@@ -75,19 +69,15 @@ def unsubscribe(client, userdata, topic, pid):
     print("Unsubscribed from {0} with PID {1}".format(topic, pid))
 
 
-def publish(client, userdata, topic, pid):
-    # This method is called when the client publishes data to a feed.
-    print("Published to {0} with PID {1}".format(topic, pid))
-
 def on_battery_msg(client, topic, message):
-    print("Battery Level: {}v".format(message))
+    # Method called when device/batteryLife has a new value
+    print("Battery level: {}v".format(message))
+
+    # client.remove_topic_callback("device/batteryLevel")
+
 
 def on_message(client, topic, message):
-    """Method callled when a client's subscribed feed has a new
-    value.
-    :param str topic: The topic of the feed with a new value.
-    :param str message: The new value
-    """
+    # Method callled when a client's subscribed feed has a new value.
     print("New message on topic {0}: {1}".format(topic, message))
 
 
@@ -96,32 +86,28 @@ def on_message(client, topic, message):
 wifi.connect()
 print("Connected!")
 
-# Initialize MQTT interface with the esp interface
 MQTT.set_socket(socket, esp)
 
 # Set up a MiniMQTT Client
-client = MQTT.MQTT(broker=secrets["broker"], port=1883)
+client = MQTT.MQTT(broker=secrets["broker"], port=secrets["broker_port"])
 
-# Connect callback handlers to client
-client.on_connect = connect
-client.on_disconnect = disconnect
+# Setup the callback methods above
+client.on_connect = connected
+client.on_disconnect = disconnected
 client.on_subscribe = subscribe
 client.on_unsubscribe = unsubscribe
-client.on_publish = publish
-
 client.on_message = on_message
-client.add_topic_callback("sensors/batteryLevel", on_battery_msg)
+client.add_topic_callback("device/batteryLevel", on_battery_msg)
 
 # Connect the client to the MQTT broker.
 print("Connecting to MQTT broker...")
 client.connect()
 
-# Subscribe to all notifications on the sensors/
-client.subscribe("sensors/#", 1)
+# Subscribe to all notifications on the device/ topic
+client.subscribe("device/#", 1)
 
 # Start a blocking message loop...
 # NOTE: NO code below this loop will execute
-# NOTE: Network reconnection is handled within this loop
 while True:
     try:
         client.loop()
@@ -131,5 +117,3 @@ def on_message(client, topic, message):
         client.reconnect()
         continue
     time.sleep(1)
-
-