Differences

This shows you the differences between two versions of the page.

--- ros:matlab_custom_msgs [2019/10/03 14:28] – created typos
+++ ros:matlab_custom_msgs [2024/08/20 21:38] (current) – external edit 127.0.0.1
@@ Line 4: / Line 4: @@
 This tutorial will guide the reader through the steps needed to generate the artifacts necessary for Matlab to import and use custom-defined ROS messages (e.g. defined within packages in a catkin workspace).
-===== Pre-requisite(s)  =====
+**Note**: Instructions on this page apply for Matlab R2017b through Matlab R2020a. For R2020b onward, the ''rosgenmsg'' command and custom message support have been incorporated into ROS Toolbox; use [[https://www.mathworks.com/help/ros/ug/create-custom-messages-from-ros-package.html | these]] instructions instead.
+===== Pre-requisite(s):  =====
-. **ROS Toolbox for Matlab must be installed**
+**1.** ROS Toolbox for Matlab must be installed
-. **ROS Custom Message Support Add-On must be installed in the ROS Toolbox**
+**2.** ROS Custom Message Support Add-On must be installed in the ROS Toolbox
-For #2, attempting to run 'rosgenmsg' at the Matlab command line should indicate whether any Add-Ons need to be installed. If not installed, the resulting error text will direct how to install.
+For **#2**, attempting to run 'rosgenmsg' at the Matlab command line should indicate whether any Add-Ons need to be installed. If not installed, the resulting error text will direct how to install.
 ===== Create ROS Custom Message  =====
@@ Line 17: / Line 18: @@
 In the catkin workspace, make sure custom message packages are successfully built, e.g.
-<code>
+''catkin build''.
-catkin build
-<\code>
 ===== Compile Custom Message Artifacts for Matlab  =====
-. If have previously compiled custom messages and are now re-compiling (otherwise skip this step):
+**1.** If have previously compiled custom messages and are now re-compiling (if not, skip this step):
 In Ubuntu Terminal:
-a. Remove the matlab_gen/ directory from the catkin workspace src/ area:
+**a.** Remove the ''matlab_gen/'' directory from the catkin workspace ''src/'' area:
 <code>
 cd <CATKIN_WS>/src/custom_robo_msgs
 rm -rf matlab_gen
-<\code>
+</code>
-b. Remove or back-up javaclasspath.txt in the Matlab user area:
+**b.** Remove or back-up javaclasspath.txt in the Matlab user area:
 <code>
 cd ~/.matlab/<MATLAB_VERSION>
 rm javaclasspath.txt
-<\code>
+</code>
 or
 <code>
 cd ~/.matlab/<MATLAB_VERSION>
 mv javaclasspath.txt javaclasspath.txt.bak
-<\code>
+</code>
-. Restart Matlab
+**2.** Restart Matlab
-At Matlab command line, run '''rosgenmsg('<CATKIN_WS>/src/<TOP_LEVEL_DIR>');''', where <CATKIN_WS> is the path to the catkin workspace and <TOP_LEVEL_DIR> is the highest level directory, in the catkin workspace src/ area, that contains the custom message packages you would like Matlab to support.
+At Matlab command line, run
+<code>
+rosgenmsg('<CATKIN_WS>/src/<TOP_LEVEL_DIR>');
+</code>
+where ''<CATKIN_WS>'' is the path to the catkin workspace and ''<TOP_LEVEL_DIR>'' is the highest level directory, in the catkin workspace ''src/'' area, that contains the custom message packages you would like Matlab to support.
 At the Matlab command line, you should see something similar to this example output:
@@ Line 84: / Line 87: @@
    custom message types.
-<\code>
+</code>
-Here, <CATKIN_WS> is '''~/catkin_ws''' and <TOP_LEVEL_DIR> is '''custom_robo_msgs'''.  '''custom_robo_msgs/snake_gait_msgs''' is ROS package and contains ROS custom messages we would like Matlab to support. It contains definitions for the following message types:
+Here, ''<CATKIN_WS> = ~/catkin_ws'' and ''<TOP_LEVEL_DIR> = custom_robo_msgs''.  ''custom_robo_msgs/snake_gait_msgs'' is a ROS package and contains ROS custom messages we would like Matlab to support. It contains definitions for the following message types:
 - GaitCntrlCmd
 - HeadScanGaitParams
@@ Line 96: / Line 99: @@
 - TurnInPlaceGaitStatus
-. In an Ubuntu Terminal:
+**3.** In an Ubuntu Terminal:
 <code>
 cd ~/.matlab/<MATLAB_VERSION>
-<\code>
+</code>
-where <MATLAB_VERSION> is the version of Matlab which will be run and requires custom message support.
+where ''<MATLAB_VERSION>'' is the version of Matlab which will be run and requires custom message support.
-Then
+If re-compiling and no NEW message types have been created (i.e. no new .jar files need to be added to ''javaclasspath.txt''), you may restore the back-up from Step **#1**.
-<code>
-cd ~/.matlab/<MATLAB_VERSION>
-<\code>
-If re-compiling and no NEW message types have been created (i.e. no new .jar files need to be added to '''javaclasspath.txt'''), you may restore the back-up from Step #1.
 <code>
 mv javaclasspath.txt.bak javaclasspath.txt
-<\code>
+</code>
-Otherwise, create the file '''javaclasspath.txt''' according to the instructions in the text output from the Matlab '''rosgenmsg''' command (e.g. see example output above).
+Otherwise, create the file ''javaclasspath.txt'' according to the instructions in the text output from the Matlab ''rosgenmsg'' command (e.g. see example output above).
-. Restart Matlab
+**4.** Restart Matlab
 At Matlab  command line,
 <code>
 addpath('<CATKIN_WS>/src/<TOP_LEVEL_DIR>/matlab_gen/msggen');
-<\code>
+</code>
+Matlab should now be able to create/send/receive the compiled ROS custom messages. Run ''rosmsg list'' and verify that the custom message types are listed (alphabetical order).
+**CAUTION:** The ''addpath( ... )'' command, above, MUST be run after any Matlab restart and prior to running ANY Matlab ROS-related commands. If a ROS-related command is run in Matlab prior to the ''addpath( ... )'' command, custom messages may not be imported. You will have to restart Matlab and run the ''addpath( ... )'' command first.
+**References:**
-Matlab should now be able to create/send/receive the compiled ROS custom messages. Run '''rosmsg list''' and verify that the custom message types are listed (alphabetical order).
+[[ https://www.mathworks.com/help/ros/ug/ros-custom-message-support.html | https://www.mathworks.com/help/ros/ug/ros-custom-message-support.html ]]
-***CAUTION:*** The addpath( ... ) command, above, MUST be run after any Matlab restart and prior to running ANY Matlab ROS-related commands. If a ROS-related command is run in Matlab prior to the addpath( ... ) command, custom messages may not be imported. You will have to restart Matlab and run the addpath( ... ) command first.
+[[ https://www.mathworks.com/help/ros/ref/rosgenmsg.html | https://www.mathworks.com/help/ros/ref/rosgenmsg.html ]]
+[[ https://www.mathworks.com/help/ros/custom-message-support.html | https://www.mathworks.com/help/ros/custom-message-support.html ]]
-***References:***
+[[ https://www.mathworks.com/matlabcentral/fileexchange/49810-ros-toolbox-interface-for-ros-custom-messages | https://www.mathworks.com/matlabcentral/fileexchange/49810-ros-toolbox-interface-for-ros-custom-messages ]]
-- [[ https://www.mathworks.com/help/ros/ug/ros-custom-message-support.html | https://www.mathworks.com/help/ros/ug/ros-custom-message-support.html ]]
-- [[ https://www.mathworks.com/help/ros/ref/rosgenmsg.html | https://www.mathworks.com/help/ros/ref/rosgenmsg.html ]]
-- [[ https://www.mathworks.com/help/ros/custom-message-support.html | https://www.mathworks.com/help/ros/custom-message-support.html ]]
-- [[ https://www.mathworks.com/matlabcentral/fileexchange/49810-ros-toolbox-interface-for-ros-custom-messages | https://www.mathworks.com/matlabcentral/fileexchange/49810-ros-toolbox-interface-for-ros-custom-messages ]]