Skip to content

MQTTReader: make client_name optional and ensure client_id is unique #577

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
veggiemike wants to merge 1 commit into
base: master
Choose a base branch
from
+18 −4
Open

MQTTReader: make client_name optional and ensure client_id is unique #577

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
22 changes: 18 additions & 4 deletions logger/readers/mqtt_reader.py
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,8 @@
#!/usr/bin/env python3

import logging
import random
import string
from queue import Queue

# Don't barf if they don't have redis installed. Only complain if
Expand Down Expand Up @@ -28,7 +30,7 @@ class MQTTReader(Reader):
Read messages from an mqtt broker
"""

def __init__(self, broker, channel, client_name,
def __init__(self, broker, channel, client_name=None,
port=1883, clean_start=None,
qos=0, return_as_bytes=False, **kwargs):
"""
Expand All @@ -37,6 +39,10 @@ def __init__(self, broker, channel, client_name,

broker MQTT broker to connect, broker format[###.###.#.#]
channel MQTT channel to read from, channel format[@broker/path_of_subscripton]
client_name Prefix used for `client_id` when connecting to broker. The `client_id`
must be unique for each broker connection, so a random string will be
appended to the provided `client_name`. If None, a random ID is
generated for you.
port broker port, typically 1883
clean_start Request new session on first connection. Options: True, False,
or the default of mqtt.MQTT_CLEAN_START_FIRST_ONLY
Expand Down Expand Up @@ -96,7 +102,15 @@ def on_message(client, userdata, message):

self.broker = broker
self.channel = channel
self.client_name = client_name
if client_name:
# If user supplied `client_name`, append random chars to it to
# attempt to ensure we have a unique `client_id`.
rand_id = ''.join(random.choices(string.ascii_lowercase+string.digits, k=6))
self.client_id = f'{client_name}-{rand_id}'
else:
# If None is specified, the underlying mqtt library generates a
# unique id for you.
self.client_id = None
self.port = port
if clean_start is None:
clean_start = mqtt.MQTT_CLEAN_START_FIRST_ONLY
Expand All @@ -107,9 +121,9 @@ def on_message(client, userdata, message):

try:
if USE_VERSION_FLAG:
self.client = mqtt.Client(mqtt.CallbackAPIVersion.VERSION2, client_name)
self.client = mqtt.Client(mqtt.CallbackAPIVersion.VERSION2, self.client_id)
else:
self.client = mqtt.Client(client_name)
self.client = mqtt.Client(self.client_id)

self.client.on_connect = on_connect
self.client.on_message = on_message
Expand Down