MQTT wrapper to help make it easier to use + a Tkinter example

mqtt_helper.py

"""
  Library for making MQTT easier to use.
"""

import json
import paho.mqtt.client as mqtt

class MqttClient(object):
  """Helper class to make it easier to work with MQTT subscriptions and publications."""

  def __init__(self):
    self.client = mqtt.Client(mqtt.CallbackAPIVersion.VERSION1) # For newer paho-mqtt version use this
    # self.client = mqtt.Client() # For older paho-mqtt versions use this
    self.subscription_topic_name = None
    self.publish_topic_name = None
    self.callback = None

  def connect(self, subscription_topic_name, publish_topic_name,
              mqtt_broker_ip_address="mosquitto.csse.rose-hulman.edu",
              use_off_campus_broker=False):
    if mqtt_broker_ip_address == "mosquitto.csse.rose-hulman.edu" and use_off_campus_broker:
      print("Using broker.hivemq.com instead of mosquitto.csse.rose-hulman.edu")
      mqtt_broker_ip_address = "broker.hivemq.com"
    self.subscription_topic_name = subscription_topic_name
    self.publish_topic_name = publish_topic_name

    # Callback for when the connection to the broker is complete.
    self.client.on_connect = self._on_connect
    self.client.message_callback_add(self.subscription_topic_name, self._on_message)

    print("Connecting to mqtt broker {}".format(mqtt_broker_ip_address), end="")
    self.client.connect(mqtt_broker_ip_address)
    # self.client.connect(mqtt_broker_ip_address, 1883, 60)
    self.client.loop_start()

  def send_message(self, type_name, payload=None):
    message_dict = {"type": type_name}
    if payload is not None:
      message_dict["payload"] = payload
    message = json.dumps(message_dict)
    self.client.publish(self.publish_topic_name, message)

  # noinspection PyUnusedLocal
  def _on_connect(self, client, userdata, flags, rc):
    if rc == 0:
        print(" ... Connected!")
    else:
        print(" ... Error!!!")
        exit()

    print("Publishing to topic:", self.publish_topic_name)
    self.client.on_subscribe = self._on_subscribe

    # Subscribe to topic(s)
    self.client.subscribe(self.subscription_topic_name)

  # noinspection PyUnusedLocal
  def _on_subscribe(self, client, userdata, mid, granted_qos):
    print("Subscribed to topic:", self.subscription_topic_name)

  # noinspection PyUnusedLocal
  def _on_message(self, client, userdata, msg):
    message = msg.payload.decode()
    print("Received message:", message)
    if not self.callback:
        print("Missing a callback")
        return

    # Attempt to parse the message and call the appropriate function.
    try:
        message_dict = json.loads(message)
    except ValueError:
        print("Unable to decode the received message as JSON")
        return

    if "type" not in message_dict:
        print("Received a messages without a 'type' parameter.")
        return
    message_type = message_dict["type"]
    message_payload = None
    if "payload" in message_dict:
        message_payload = message_dict["payload"]        

    self.callback(message_type, message_payload)

  def close(self):
    self.callback = None
    self.client.loop_stop()
    self.client.disconnect()


if __name__ == "__main__":
  print("Running an MQTT test via Tkinter")
  import tkinter
  from tkinter import ttk

  # MQTT on_message callback (use via a lambda function below)
  def example_mqtt_callback(type_name, payload, chat_window):
    print("Received message type: ", type_name)
    print("Received message payload: ", payload)
    chat_window["text"] += "\nFrom MQTT: " + payload

  # Tkinter callbacks
  def send_message(mqtt_client, chat_window, msg_entry):
    msg = msg_entry.get()
    msg_entry.delete(0, 'end')
    chat_window["text"] += "\nMe: " + msg
    mqtt_client.send_message("chat", msg) # Sending MQTT message

  def quit_program(mqtt_client):
    mqtt_client.close()
    exit()

  root = tkinter.Tk()
  root.title = "MQTT PyChat"

  main_frame = ttk.Frame(root, padding=20, relief='raised')
  main_frame.grid()

  label = ttk.Label(main_frame, justify=tkinter.LEFT, text="Send a message")
  label.grid(columnspan=2)

  msg_entry = ttk.Entry(main_frame, width=60)
  msg_entry.grid(row=2, column=0)

  msg_button = ttk.Button(main_frame, text="Send")
  msg_button.grid(row=2, column=1)
  msg_button['command'] = lambda: send_message(mqtt_client, chat_window, msg_entry)
  root.bind('<Return>', lambda event: send_message(mqtt_client, chat_window, msg_entry))

  chat_window = ttk.Label(main_frame, justify=tkinter.LEFT, text="", width=60, wraplength="500p")
  # chat_window.pack(fill="x")
  chat_window.grid(columnspan=2)

  q_button = ttk.Button(main_frame, text="Quit")
  q_button.grid(row=4, column=1)
  q_button['command'] = (lambda: quit_program(mqtt_client))

  mqtt_client = MqttClient() # note, use "mqtt_helper.MqttClient" in other files
  mqtt_client.callback = lambda type, payload: example_mqtt_callback(type, payload, chat_window)
  mqtt_client.connect("my_messages", "my_messages", use_off_campus_broker=True)  # "Send to" and "listen to" the same topic

  root.mainloop()

thnks for this code!