Gazebo Subscribe

Receive custom messages from Gazebo server

Since R2020b

Libraries:
Robotics System Toolbox / Gazebo Co-Simulation

Description

The Gazebo Subscribe block receives custom messages from Gazebo server based on the topic and message type that the block specifies. The block outputs the latest message received as a bus signal, Msg, and a Boolean, IsNew, which indicates whether a message was received during the previous time step.

To receive custom messages, connect to a Gazebo simulation. Open the block mask and click Configure Gazebo network and simulation settings. For more information see Configure Gazebo Simulation.

This block is part of a co-simulation interface between MATLAB^® and Gazebo for exchanging data and sending commands.

Limitations

Models that use this block do not support Code Generation or Rapid Accelerator mode.

Ports

Output

expand all

IsNew — Status of custom messages in the previous time step
`0` (default) | `1`

Status of the custom message received, output as a Boolean, which indicates whether the block output Msg was received in the previous time step.

Data Types: Boolean

Msg — Gazebo custom message
bus

Gazebo custom message, output as a bus signal, with elements relevant to the specific Topic and Message type.

The Msg output always outputs the most recent message received.

Data Types: bus

Parameters

expand all

Topic source — Source for specifying topic
`From Gazebo` (default) | `Specify your own`

To get a topic from an existing Gazebo simulation, select From Gazebo. Click the Select button to see a list of available topics. To connect to a Gazebo simulation, click Configure Gazebo network and simulation settings in the block mask.

To enter a custom topic without an active Gazebo connection, select Specify your own. Use the Topic parameter to type the name of the message.

Topic — Topic name of custom message
`/my_topic` (default) | string

Topic name of custom message, specified as a string.

To specify a topic without connecting, select Specify your own.

Message type — Gazebo custom message type
`gazebo_msgs/TestPose` (default) | string

Click Select to get a list of message types available in Gazebo. If you choose your Topic from a connected Gazebo simulation, this parameter is set automatically.

Sample time — Sampling time of input
`0.001` (default) | positive

Sample time indicates the interval at which messages are received from the Gazebo simulator.

More About

expand all

Configure Gazebo Simulation

Click Configure Gazebo network and simulation settings in the block mask to launch the Configure Gazebo Simulation dialog box, which configures the synchronized stepping between Gazebo and Simulink^®. You can select the Network Address and specify Hostname/IP Address and Port of the computer running the Gazebo simulator with the Gazebo plugin installed. Then click Test to test the connection to the running Gazebo simulator. You can also specify the Response timeout in seconds. These settings apply to all Gazebo blocks for all open Simulink models.

Starting from R2022b, you can connect to multiple Gazebo simulations from one or more machines. You can now specify a cell array of IP addresses and a cell array of port numbers in the MATLAB workspace and then specify their variable names to the Hostname/IP Address and Port boxes, respectively.

To connect to a single Gazebo session from MATLAB, specify the port number and IP address of the computer running the Gazebo simulator.

portnum = 14580; 
ipaddress = '172.18.250.125';

To connect to multiple Gazebo sessions from MATLAB, specify the port numbers and IP addresses of the computers running the Gazebo simulator.

portnum = {14580,14581};
ipaddress = {'172.18.250.125','172.18.250.125'};

Version History

Introduced in R2020b

Gazebo Subscribe

Description

Limitations