mqtt_bridge provides a functionality to bridge between ROS and MQTT in bidirectional.
mqtt_bridge is not actively maintained now. Feel free to check out mqtt_client, a high-performance C++ ROS nodelet with recent development!
mqtt_bridge uses ROS message as its protocol. Messages from ROS are serialized by json (or messagepack) for MQTT, and messages from MQTT are deserialized for ROS topic. So MQTT messages should be ROS message compatible. (We use rosbridge_library.internal.message_conversion for message conversion.)
This limitation can be overcome by defining custom bridge class, though.
$ sudo apt install python3-pip
$ sudo apt install ros-noetic-rosbridge-library
$ sudo apt install mosquitto mosquitto-clients
$ pip3 install -r requirements.txt$ roslaunch mqtt_bridge demo.launchPublish to /ping,
$ rostopic pub /ping std_msgs/Bool "data: true"
and see response to /pong.
$ rostopic echo /pong
data: True
---
Publish "hello" to /echo,
$ rostopic pub /echo std_msgs/String "data: 'hello'"
and see response to /back.
$ rostopic echo /back
data: hello
---
You can also see MQTT messages using mosquitto_sub
$ mosquitto_sub -t '#'
parameter file (config.yaml):
mqtt:
client:
protocol: 4 # MQTTv311
connection:
host: localhost
port: 1883
keepalive: 60
bridge:
# ping pong
- factory: mqtt_bridge.bridge:RosToMqttBridge
msg_type: std_msgs.msg:Bool
topic_from: /ping
topic_to: ping
- factory: mqtt_bridge.bridge:MqttToRosBridge
msg_type: std_msgs.msg:Bool
topic_from: ping
topic_to: /pongyou can use any msg types like sensor_msgs.msg:Imu.
launch file:
<launch>
<node name="mqtt_bridge" pkg="mqtt_bridge" type="mqtt_bridge_node.py" output="screen">
<rosparam file="/path/to/config.yaml" command="load" />
</node>
</launch>Parameters under mqtt section are used for creating paho's mqtt.Client and its configuration.
client: used formqtt.Clientconstructortls: used for tls configurationaccount: used for username and password configurationmessage: used for MQTT message configurationuserdata: used for MQTT userdata configurationwill: used for MQTT's will configuration
See mqtt_bridge.mqtt_client for detail.
If mqtt/private_path parameter is set, leading ~/ in MQTT topic path will be replaced by this value. For example, if mqtt/pivate_path is set as "device/001", MQTT path "~/value" will be converted to "device/001/value".
mqtt_bridge uses msgpack as a serializer by default. But you can also configure other serializers. For example, if you want to use json for serialization, add following configuration.
serializer: json:dumps
deserializer: json:loadsYou can list ROS <--> MQTT tranfer specifications in following format.
bridge:
# ping pong
- factory: mqtt_bridge.bridge:RosToMqttBridge
msg_type: std_msgs.msg:Bool
topic_from: /ping
topic_to: ping
- factory: mqtt_bridge.bridge:MqttToRosBridge
msg_type: std_msgs.msg:Bool
topic_from: ping
topic_to: /pongfactory: bridge class for transfering message from ROS to MQTT, and vise versa.msg_type: ROS Message type transfering through the bridge.topic_from: topic incoming from (ROS or MQTT)topic_to: topic outgoing to (ROS or MQTT)
Also, you can create custom bridge class by inheriting mqtt_brige.bridge.Bridge.
This software is released under the MIT License, see LICENSE.txt.