robot.mqtt package

Submodules

robot.mqtt.mqtt_msg module

class robot.mqtt.mqtt_msg.MqttMsg(topic, message, qos=0)

Bases: object

robot.mqtt.robot_mqtt_client module

class robot.mqtt.robot_mqtt_client.RobotMqttClient(server, port, user_name, password, channel)

Bases: object

MQTT client wrapper mirroring Java’s RobotMqttClient.

  • Maintains in_queue and out_queue of MqttMsg.

  • Prefixes publish/subscribe topics with MQTTSettings.channel externally.

in_queue_pop()
Return type:

MqttMsg | None

out_queue_pop()
Return type:

MqttMsg | None

publish(topic, body, qos=0, retained=False)
Return type:

None

subscribe(topic)
Return type:

None

Module contents

class robot.mqtt.MqttMsg(topic, message, qos=0)

Bases: object

class robot.mqtt.RobotMqttClient(server, port, user_name, password, channel)

Bases: object

MQTT client wrapper mirroring Java’s RobotMqttClient.

  • Maintains in_queue and out_queue of MqttMsg.

  • Prefixes publish/subscribe topics with MQTTSettings.channel externally.

in_queue_pop()
Return type:

MqttMsg | None

out_queue_pop()
Return type:

MqttMsg | None

publish(topic, body, qos=0, retained=False)
Return type:

None

subscribe(topic)
Return type:

None