def gen_publish(topic,
qos,
payload=None,
retain=False,
dup=False,
mid=0,
proto_ver=4,
properties=b""):
if isinstance(topic, str):
topic = topic.encode("utf-8")
rl = 2 + len(topic)
pack_format = "H" + str(len(topic)) + "s"
if qos > 0:
rl = rl + 2
pack_format = pack_format + "H"
if proto_ver == 5:
properties = mqtt5_props.prop_finalise(properties)
rl += len(properties)
# This will break if len(properties) > 127
pack_format = pack_format + "%ds" % (len(properties))
if payload is not None:
payload = payload.encode("utf-8")
rl = rl + len(payload)
pack_format = pack_format + str(len(payload)) + "s"
else:
payload = b""
pack_format = pack_format + "0s"
rlpacked = pack_remaining_length(rl)
cmd = 48 | (qos << 1)
if retain:
cmd = cmd + 1
if dup:
cmd = cmd + 8
if proto_ver == 5:
if qos > 0:
return struct.pack("!B" + str(len(rlpacked)) + "s" + pack_format,
cmd, rlpacked, len(topic), topic, mid,
properties, payload)
else:
return struct.pack("!B" + str(len(rlpacked)) + "s" + pack_format,
cmd, rlpacked, len(topic), topic, properties,
payload)
else:
if qos > 0:
return struct.pack("!B" + str(len(rlpacked)) + "s" + pack_format,
cmd, rlpacked, len(topic), topic, mid, payload)
else:
return struct.pack("!B" + str(len(rlpacked)) + "s" + pack_format,
cmd, rlpacked, len(topic), topic, payload)
def gen_connack(flags=0, rc=0, proto_ver=4, properties=""):
if proto_ver == 5:
properties += mqtt5_props.gen_byte_prop(
mqtt5_props.PROP_SHARED_SUB_AVAILABLE, 0)
properties = mqtt5_props.prop_finalise(properties)
packet = struct.pack('!BBBB', 32, 2 + len(properties), flags,
rc) + properties
else:
packet = struct.pack('!BBBB', 32, 2, flags, rc)
return packet
def gen_subscribe(mid, topic, qos, proto_ver=4, properties=b""):
topic = topic.encode("utf-8")
if proto_ver == 5:
if properties == b"":
pack_format = "!BBHBH"+str(len(topic))+"sB"
return struct.pack(pack_format, 130, 2+1+2+len(topic)+1, mid, 0, len(topic), topic, qos)
else:
properties = mqtt5_props.prop_finalise(properties)
pack_format = "!BBH"+str(len(properties))+"s"+"H"+str(len(topic))+"sB"
return struct.pack(pack_format, 130, 2+1+2+len(topic)+len(properties), mid, properties, len(topic), topic, qos)
else:
pack_format = "!BBHH"+str(len(topic))+"sB"
return struct.pack(pack_format, 130, 2+2+len(topic)+1, mid, len(topic), topic, qos)
def gen_connack(flags=0, rc=0, proto_ver=4, properties=b""):
if proto_ver == 5:
if properties is not None:
properties = mqtt5_props.gen_uint16_prop(mqtt5_props.PROP_TOPIC_ALIAS_MAXIMUM, 10) + properties
else:
properties = b""
properties = mqtt5_props.prop_finalise(properties)
packet = struct.pack('!BBBB', 32, 2+len(properties), flags, rc) + properties
else:
packet = struct.pack('!BBBB', 32, 2, flags, rc);
return packet
def gen_connack(flags=0, rc=0, proto_ver=4, properties=b""):
if proto_ver == 5:
if properties is not None:
properties = mqtt5_props.gen_uint16_prop(mqtt5_props.PROP_TOPIC_ALIAS_MAXIMUM, 10) + properties
else:
properties = b""
properties = mqtt5_props.prop_finalise(properties)
packet = struct.pack('!BBBB', 32, 2+len(properties), flags, rc) + properties
else:
packet = struct.pack('!BBBB', 32, 2, flags, rc);
return packet
def _gen_short(cmd, reason_code=-1, proto_ver=5, properties=None):
if proto_ver == 5 and (reason_code != -1 or properties is not None):
if reason_code == -1:
reason_code = 0
if properties is None:
return struct.pack('!BBB', cmd, 1, reason_code)
elif properties == "":
return struct.pack('!BBBB', cmd, 2, reason_code, 0)
else:
properties = mqtt5_props.prop_finalise(properties)
return struct.pack("!BBB", cmd, 1+len(properties), reason_code) + properties
else:
return struct.pack('!BB', cmd, 0)
def _gen_short(cmd, reason_code=-1, proto_ver=5, properties=None):
if proto_ver == 5 and (reason_code != -1 or properties is not None):
if reason_code == -1:
reason_code = 0
if properties is None:
return struct.pack('!BBB', cmd, 1, reason_code)
elif properties == "":
return struct.pack('!BBBB', cmd, 2, reason_code, 0)
else:
properties = mqtt5_props.prop_finalise(properties)
return struct.pack("!BBB", cmd, 1+len(properties), reason_code) + properties
else:
return struct.pack('!BB', cmd, 0)
def _gen_command_with_mid(cmd, mid, proto_ver=4, reason_code=-1, properties=None):
if proto_ver == 5 and (reason_code != -1 or properties is not None):
if reason_code == -1:
reason_code = 0
if properties is None:
return struct.pack('!BBHB', cmd, 3, mid, reason_code)
elif properties == "":
return struct.pack('!BBHBB', cmd, 4, mid, reason_code, 0)
else:
properties = mqtt5_props.prop_finalise(properties)
pack_format = "!BBHB"+str(len(properties))+"s"
return struct.pack(pack_format, cmd, 2+1+len(properties), mid, reason_code, properties)
else:
return struct.pack('!BBH', cmd, 2, mid)
def _gen_command_with_mid(cmd, mid, proto_ver=4, reason_code=-1, properties=None):
if proto_ver == 5 and (reason_code != -1 or properties is not None):
if reason_code == -1:
reason_code = 0
if properties is None:
return struct.pack('!BBHB', cmd, 3, mid, reason_code)
elif properties == "":
return struct.pack('!BBHBB', cmd, 4, mid, reason_code, 0)
else:
properties = mqtt5_props.prop_finalise(properties)
pack_format = "!BBHB"+str(len(properties))+"s"
return struct.pack(pack_format, cmd, 2+1+len(properties), mid, reason_code, properties)
else:
return struct.pack('!BBH', cmd, 2, mid)
def gen_disconnect(reason_code=-1, proto_ver=4, properties=None):
if proto_ver == 5 and (reason_code != -1 or properties is not None):
if reason_code == -1:
reason_code = 0
if properties is None:
return struct.pack('!BBB', 224, 1, reason_code)
elif properties == "":
return struct.pack('!BBBB', 224, 2, reason_code, 0)
else:
properties = mqtt5_props.prop_finalise(properties)
return struct.pack("!BBB", 224, 1 + len(properties),
reason_code) + properties
else:
return struct.pack('!BB', 224, 0)
def gen_subscribe(mid, topic, qos, proto_ver=4, properties=b""):
topic = topic.encode("utf-8")
packet = struct.pack("!B", 130)
if proto_ver == 5:
if properties == b"":
packet += pack_remaining_length(2+1+2+len(topic)+1)
pack_format = "!HBH"+str(len(topic))+"sB"
return packet + struct.pack(pack_format, mid, 0, len(topic), topic, qos)
else:
properties = mqtt5_props.prop_finalise(properties)
packet += pack_remaining_length(2+1+2+len(topic)+len(properties))
pack_format = "!H"+str(len(properties))+"s"+"H"+str(len(topic))+"sB"
return packet + struct.pack(pack_format, mid, properties, len(topic), topic, qos)
else:
packet += pack_remaining_length(2+2+len(topic)+1)
pack_format = "!HH"+str(len(topic))+"sB"
return packet + struct.pack(pack_format, mid, len(topic), topic, qos)
def gen_subscribe(mid, topic, qos, proto_ver=4, properties=""):
if proto_ver == 5:
if properties == "":
pack_format = "!BBHBH" + str(len(topic)) + "sB"
return struct.pack(pack_format, 130, 2 + 1 + 2 + len(topic) + 1,
mid, 0, len(topic), topic, qos)
else:
properties = mqtt5_props.prop_finalise(properties)
pack_format = "!BBH" + str(len(properties)) + "s" + "H" + str(
len(topic)) + "sB"
return struct.pack(pack_format, 130,
2 + 1 + 2 + len(topic) + len(properties), mid,
properties, len(topic), topic, qos)
else:
pack_format = "!BBHH" + str(len(topic)) + "sB"
return struct.pack(pack_format, 130, 2 + 2 + len(topic) + 1, mid,
len(topic), topic, qos)
def gen_unsubscribe(mid, topic, cmd=162, proto_ver=4, properties=b""):
topic = topic.encode("utf-8")
if proto_ver == 5:
if properties == b"":
pack_format = "!BBHBH" + str(len(topic)) + "s"
return struct.pack(pack_format, cmd, 2 + 2 + len(topic) + 1, mid,
0, len(topic), topic)
else:
properties = mqtt5_props.prop_finalise(properties)
packet = struct.pack("!B", cmd)
l = 2 + 2 + len(topic) + 1 + len(properties)
packet += pack_remaining_length(l)
pack_format = "!HB" + str(len(properties)) + "sH" + str(
len(topic)) + "s"
packet += struct.pack(pack_format, mid, len(properties),
properties, len(topic), topic)
return packet
else:
pack_format = "!BBHH" + str(len(topic)) + "s"
return struct.pack(pack_format, cmd, 2 + 2 + len(topic), mid,
len(topic), topic)
def gen_publish(topic, qos, payload=None, retain=False, dup=False, mid=0, proto_ver=4, properties=b""):
topic = topic.encode("utf-8")
rl = 2+len(topic)
pack_format = "H"+str(len(topic))+"s"
if qos > 0:
rl = rl + 2
pack_format = pack_format + "H"
if proto_ver == 5:
properties = mqtt5_props.prop_finalise(properties)
rl += len(properties)
# This will break if len(properties) > 127
pack_format = pack_format + "%ds"%(len(properties))
if payload != None:
payload = payload.encode("utf-8")
rl = rl + len(payload)
pack_format = pack_format + str(len(payload))+"s"
else:
payload = b""
pack_format = pack_format + "0s"
rlpacked = pack_remaining_length(rl)
cmd = 48 | (qos<<1)
if retain:
cmd = cmd + 1
if dup:
cmd = cmd + 8
if proto_ver == 5:
if qos > 0:
return struct.pack("!B" + str(len(rlpacked))+"s" + pack_format, cmd, rlpacked, len(topic), topic, mid, properties, payload)
else:
return struct.pack("!B" + str(len(rlpacked))+"s" + pack_format, cmd, rlpacked, len(topic), topic, properties, payload)
else:
if qos > 0:
return struct.pack("!B" + str(len(rlpacked))+"s" + pack_format, cmd, rlpacked, len(topic), topic, mid, payload)
else:
return struct.pack("!B" + str(len(rlpacked))+"s" + pack_format, cmd, rlpacked, len(topic), topic, payload)
def gen_connect(client_id, clean_session=True, keepalive=60, username=None, password=None, will_topic=None, will_qos=0, will_retain=False, will_payload=b"", proto_ver=4, connect_reserved=False, properties=b"", will_properties=b""):
if (proto_ver&0x7F) == 3 or proto_ver == 0:
remaining_length = 12
elif (proto_ver&0x7F) == 4 or proto_ver == 5:
remaining_length = 10
else:
raise ValueError
if client_id != None:
client_id = client_id.encode("utf-8")
remaining_length = remaining_length + 2+len(client_id)
else:
remaining_length = remaining_length + 2
connect_flags = 0
if connect_reserved:
connect_flags = connect_flags | 0x01
if clean_session:
connect_flags = connect_flags | 0x02
if proto_ver == 5:
if properties == b"":
properties += mqtt5_props.gen_uint16_prop(mqtt5_props.PROP_RECEIVE_MAXIMUM, 20)
properties = mqtt5_props.prop_finalise(properties)
remaining_length += len(properties)
if will_topic != None:
will_topic = will_topic.encode("utf-8")
remaining_length = remaining_length + 2+len(will_topic) + 2+len(will_payload)
connect_flags = connect_flags | 0x04 | ((will_qos&0x03) << 3)
if will_retain:
connect_flags = connect_flags | 32
if proto_ver == 5:
will_properties = mqtt5_props.prop_finalise(will_properties)
remaining_length += len(will_properties)
if username != None:
username = username.encode("utf-8")
remaining_length = remaining_length + 2+len(username)
connect_flags = connect_flags | 0x80
if password != None:
password = password.encode("utf-8")
connect_flags = connect_flags | 0x40
remaining_length = remaining_length + 2+len(password)
rl = pack_remaining_length(remaining_length)
packet = struct.pack("!B"+str(len(rl))+"s", 0x10, rl)
if (proto_ver&0x7F) == 3 or proto_ver == 0:
packet = packet + struct.pack("!H6sBBH", len(b"MQIsdp"), b"MQIsdp", proto_ver, connect_flags, keepalive)
elif (proto_ver&0x7F) == 4 or proto_ver == 5:
packet = packet + struct.pack("!H4sBBH", len(b"MQTT"), b"MQTT", proto_ver, connect_flags, keepalive)
if proto_ver == 5:
packet += properties
if client_id != None:
packet = packet + struct.pack("!H"+str(len(client_id))+"s", len(client_id), bytes(client_id))
else:
packet = packet + struct.pack("!H", 0)
if will_topic != None:
packet += will_properties
packet = packet + struct.pack("!H"+str(len(will_topic))+"s", len(will_topic), will_topic)
if len(will_payload) > 0:
packet = packet + struct.pack("!H"+str(len(will_payload))+"s", len(will_payload), will_payload)
else:
packet = packet + struct.pack("!H", 0)
if username != None:
packet = packet + struct.pack("!H"+str(len(username))+"s", len(username), username)
if password != None:
packet = packet + struct.pack("!H"+str(len(password))+"s", len(password), password)
return packet
def gen_connect(client_id, clean_session=True, keepalive=60, username=None, password=None, will_topic=None, will_qos=0, will_retain=False, will_payload=b"", proto_ver=4, connect_reserved=False, properties=b"", will_properties=b""):
if (proto_ver&0x7F) == 3 or proto_ver == 0:
remaining_length = 12
elif (proto_ver&0x7F) == 4 or proto_ver == 5:
remaining_length = 10
else:
raise ValueError
if client_id != None:
client_id = client_id.encode("utf-8")
remaining_length = remaining_length + 2+len(client_id)
else:
remaining_length = remaining_length + 2
connect_flags = 0
if connect_reserved:
connect_flags = connect_flags | 0x01
if clean_session:
connect_flags = connect_flags | 0x02
if proto_ver == 5:
if properties == b"":
properties += mqtt5_props.gen_uint16_prop(mqtt5_props.PROP_RECEIVE_MAXIMUM, 20)
properties = mqtt5_props.prop_finalise(properties)
remaining_length += len(properties)
if will_topic != None:
will_topic = will_topic.encode("utf-8")
remaining_length = remaining_length + 2+len(will_topic) + 2+len(will_payload)
connect_flags = connect_flags | 0x04 | ((will_qos&0x03) << 3)
if will_retain:
connect_flags = connect_flags | 32
if proto_ver == 5:
will_properties = mqtt5_props.prop_finalise(will_properties)
remaining_length += len(will_properties)
if username != None:
username = username.encode("utf-8")
remaining_length = remaining_length + 2+len(username)
connect_flags = connect_flags | 0x80
if password != None:
password = password.encode("utf-8")
connect_flags = connect_flags | 0x40
remaining_length = remaining_length + 2+len(password)
rl = pack_remaining_length(remaining_length)
packet = struct.pack("!B"+str(len(rl))+"s", 0x10, rl)
if (proto_ver&0x7F) == 3 or proto_ver == 0:
packet = packet + struct.pack("!H6sBBH", len(b"MQIsdp"), b"MQIsdp", proto_ver, connect_flags, keepalive)
elif (proto_ver&0x7F) == 4 or proto_ver == 5:
packet = packet + struct.pack("!H4sBBH", len(b"MQTT"), b"MQTT", proto_ver, connect_flags, keepalive)
if proto_ver == 5:
packet += properties
if client_id != None:
packet = packet + struct.pack("!H"+str(len(client_id))+"s", len(client_id), bytes(client_id))
else:
packet = packet + struct.pack("!H", 0)
if will_topic != None:
packet += will_properties
packet = packet + struct.pack("!H"+str(len(will_topic))+"s", len(will_topic), will_topic)
if len(will_payload) > 0:
packet = packet + struct.pack("!H"+str(len(will_payload))+"s", len(will_payload), will_payload)
else:
packet = packet + struct.pack("!H", 0)
if username != None:
packet = packet + struct.pack("!H"+str(len(username))+"s", len(username), username)
if password != None:
packet = packet + struct.pack("!H"+str(len(password))+"s", len(password), password)
return packet
