Adding publishing location/metadata via csv topic, add example

Author: brentru

adafruit_io/adafruit_io.py

@@ -148,7 +148,6 @@ def _on_message_mqtt(self, client, topic, payload):
         if self.on_message is not None:
             # Parse the MQTT topic string
             topic_name = topic.split("/")
-            print(topic_name)
             if topic_name[1] == "groups":
                 # Adafruit IO Group Feed(s)
                 feeds = []
@@ -256,7 +255,7 @@ def subscribe_to_time(self, time_type):
         Information about these topics can be found on the Adafruit IO MQTT API Docs.:
         https://io.adafruit.com/api/docs/mqtt.html#time-topics
         """
-        if "seconds" or "millis" in time_type:
+        if "seconds" or "millis" or "hours" in time_type:
             self._client.subscribe("time/" + time_type)
         elif time_type == "iso":
             self._client.subscribe("time/ISO-8601")
@@ -319,12 +318,13 @@ def publish_multiple(self, feeds_and_data, timeout=3, is_group=False):
                 self.publish(t, d)
             time.sleep(timeout)
 
-    def publish(self, feed_key, data, shared_user=None, is_group=False):
+    def publish(self, feed_key, data, metadata = None, shared_user=None, is_group=False):
         """Publishes to an An Adafruit IO Feed.
         :param str feed_key: Adafruit IO Feed key.
         :param str data: Data to publish to the feed or group.
         :param int data: Data to publish to the feed or group.
         :param float data: Data to publish to the feed or group.
+        :param str metadata: Optional metadata associated with the data.
         :param str shared_user: Owner of the Adafruit IO feed, required for
                                 feed sharing.
         :param bool is_group: Set True if publishing to an Adafruit IO Group.
@@ -353,16 +353,29 @@ def publish(self, feed_key, data, shared_user=None, is_group=False):
         ..code-block:: python
 
             client.publish('temperature', shared_user='myfriend')
+        
+        Example of publishing a value along with locational metadata to a feed.
+        ..code-block:: python
+
+            data = 42
+            # format: "lat, lon, ele"
+            metadata = "40.726190, -74.005334, -6"
+            io.publish("location-feed", data, metadata)
 
         """
         if is_group:
             self._client.publish("{0}/groups/{1}".format(self._user, feed_key), data)
-            return
         if shared_user is not None:
             self._client.publish("{0}/feeds/{1}".format(shared_user, feed_key), data)
+        if metadata is not None:
+            if isinstance(data, int or float):
+                data = str(data)
+            csv_string = data + "," + metadata
+            self._client.publish("{0}/feeds/{1}/csv".format(self._user, feed_key), csv_string)
         else:
             self._client.publish("{0}/feeds/{1}".format(self._user, feed_key), data)
 
+
     def get(self, feed_key):
         """Calling this method will make Adafruit IO publish the most recent
         value on feed_key.

examples/mqtt/adafruit_io_mqtt_location.py

@@ -0,0 +1,114 @@
+# Example of tagging data with location values
+# and sending it to an Adafruit IO feed.
+
+from random import randint
+import board
+import neopixel
+import busio
+from digitalio import DigitalInOut
+from adafruit_esp32spi import adafruit_esp32spi
+from adafruit_esp32spi import adafruit_esp32spi_wifimanager
+import adafruit_esp32spi.adafruit_esp32spi_socket as socket
+
+from adafruit_minimqtt import MQTT
+from adafruit_io.adafruit_io import IO_MQTT
+
+### WiFi ###
+
+# Get wifi details and more from a secrets.py file
+try:
+    from secrets import secrets
+except ImportError:
+    print("WiFi secrets are kept in secrets.py, please add them there!")
+    raise
+
+# 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)
+"""Use below for Most Boards"""
+status_light = neopixel.NeoPixel(
+    board.NEOPIXEL, 1, brightness=0.2
+)  # Uncomment for Most Boards
+"""Uncomment below for ItsyBitsy M4"""
+# status_light = dotstar.DotStar(board.APA102_SCK, board.APA102_MOSI, 1, brightness=0.2)
+# Uncomment below for an externally defined RGB LED
+# import adafruit_rgbled
+# from adafruit_esp32spi import PWMOut
+# RED_LED = PWMOut.PWMOut(esp, 26)
+# GREEN_LED = PWMOut.PWMOut(esp, 27)
+# BLUE_LED = PWMOut.PWMOut(esp, 25)
+# status_light = adafruit_rgbled.RGBLED(RED_LED, BLUE_LED, GREEN_LED)
+wifi = adafruit_esp32spi_wifimanager.ESPSPI_WiFiManager(esp, secrets, status_light)
+
+# Define callback functions which will be called when certain events happen.
+def connected(client):
+    # Connected function will be called when the client is connected to Adafruit IO.
+    # This is a good place to subscribe to feed changes.  The client parameter
+    # passed to this function is the Adafruit IO MQTT client so you can make
+    # calls against it easily.
+    print("Connected to Adafruit IO!")
+
+    # Subscribe to a location feed!
+    io.subscribe("location")
+
+
+def disconnected(client):
+    # Disconnected function will be called when the client disconnects.
+    print("Disconnected from Adafruit IO!")
+
+
+def message(client, feed_id, payload):
+    # Message function will be called when a subscribed feed has a new value.
+    # The feed_id parameter identifies the feed, and the payload parameter has
+    # the new value.
+    print("Feed {0} received new value: {1}".format(feed_id, payload))
+
+
+# Connect to WiFi
+wifi.connect()
+
+# Initialize a new MQTT Client object
+client = MQTT(
+    socket=socket,
+    broker="io.adafruit.com",
+    username=secrets["aio_user"],
+    password=secrets["aio_key"],
+    network_manager=wifi,
+    log=True,
+)
+
+# Initialize an Adafruit IO MQTT Client
+io = IO_MQTT(client)
+
+# Connect the callback methods defined above to Adafruit IO
+io.on_connect = connected
+io.on_disconnect = disconnected
+io.on_message = message
+
+# Connect to Adafruit IO
+io.connect()
+
+# Set data
+data_value = 42
+
+# Set up metadata associated with data_value
+# lat, lon, ele
+metadata = "40.726190, -74.005334, -6"
+
+# Send data and location metadata to the 'location' feed
+print("Sending data and location metadata to IO...")
+io.publish("location", data_value, metadata)
+print("Data sent!")
+
+
+# Listen forever...
+io.loop_blocking()