When Internet connectivity is available (usually via WiFi), data may be logged to the Adafruit IO data service.

See this guide to get started with Adafruit IO:

The following uses a PyPortal (M4 + ESP32) in writing a handler to send log messages to Adafruit IO.

Most of the code is in the constructor to set up the connection to the ESP32 and Adafruit IO. You pass a string to the constructor that is used to create the feed name which is -logging.

Line terminators don't need to be added, so we don't need a format method; we can directly use the inherited one.

"""
Adafruit IO based message handler for CircuitPython logging.

Adafruit invests time and resources providing this open source code.
Please support Adafruit and open source hardware by purchasing
products from Adafruit!

Written by Dave Astels for Adafruit Industries
Copyright (c) 2018 Adafruit Industries
Licensed under the MIT license.

All text above must be included in any redistribution.
"""

from adafruit_portalbase import PortalBase

# Example:
#
# from aio_handler import AIOHandler
# import adafruit_logging as logging
# l = logging.getLogger('aio')
# # Pass in the device object based on portal_base
# # (Funhouse, PyPortal, MagTag, etc) as the 2nd parameter
# l.addHandler(AIOHandler('test'), portal_device)
# l.level = logging.ERROR
# l.error("test")

from adafruit_logging import LoggingHandler

class AIOHandler(LoggingHandler):

    def __init__(self, name, portal_device):
        """Create an instance."""
        self._log_feed_name=f"{name}-logging"
        if not issubclass(type(portal_device), PortalBase):
            raise TypeError("portal_device must be a PortalBase or subclass of PortalBase")
        self._portal_device = portal_device


    def emit(self, level, msg):
        """Generate the message and write it to the AIO Feed.

        :param level: The level at which to log
        :param msg: The core message

        """
        self._portal_device.push_to_io(self._log_feed_name, self.format(level, msg))

You'll need a secrets.py file to hold your WiFi and Adafruit IO credentials. You will also need the required libraries for your board and an Adafruit IO account. See this guide for setting it all up on a PyPortal.

The example code to use the above handler on a PyPortal or M4 Express WiFi:

from aio_handler import AIOHandler
import adafruit_logging as logging

l = logging.getLogger('aio')
l.addHandler(AIOHandler('test'))
l.level = logging.ERROR
l.error("test")

This guide was first published on Mar 18, 2019. It was last updated on Mar 18, 2019.

This page (Log to Adafruit IO) was last updated on Nov 17, 2021.

Text editor powered by tinymce.