ros2genmsg

Сгенерируйте пользовательские сообщения из определений ROS 2

Описание

ros2genmsg(folderpath) генерирует MATLAB® интерфейсы к пользовательским сообщениям ROS 2. Укажите путь к родительской папке, содержащей определения пользовательских сообщений следующим .msg файлы.

пример

ros2genmsg(folderpath,Name,Value) задает дополнительные опции, используя один или несколько аргументы пары "имя-значение".

Примечание

При создании пользовательских сообщений для ROS 2 необходимо создать пакеты ROS. Это требует, чтобы у вас были CMake и компилятор C++ для вашей платформы. Для получения дополнительной информации смотрите Системные требования ROS

В системе необходимо установить следующее:

Примеры

свернуть все

Пользовательские сообщения являются пользовательскими сообщениями, которые можно использовать для расширения набора типов сообщений, поддерживаемых в настоящее время в ROS 2. При отправке и получении поддерживаемых типов сообщений использовать пользовательские сообщения не требуется. Чтобы просмотреть список поддерживаемых типов сообщений, вызовите ros2 msg list в Командном окне MATLAB ®. Дополнительные сведения о поддерживаемых сообщениях ROS 2 см. в разделе Работа с базовыми сообщениями ROS 2 .

Если вы впервые работаете с пользовательскими сообщениями ROS 2, проверьте системные требования ROS.

Пользовательские сообщения Содержимое

Пользовательские сообщения ROS 2 заданы в папках пакета ROS 2, которые содержат msg директория. The msg папка содержит все пользовательские определения типов сообщений. Для примера, пакет example_b_msgs, в пределах custom папка, имеет нижеследующие папку и структуру файла.

Пакет содержит один пользовательский тип сообщения, Standalone.msg. MATLAB использует эти файлы, чтобы сгенерировать необходимые файлы для использования пользовательских сообщений, содержащихся в пакете. Для получения дополнительной информации о соглашениях об именовании сообщений смотрите Определение интерфейса ROS 2.

В этом примере выполняется процедура создания пользовательских сообщений ROS 2 в MATLAB ®. У вас должен быть пакет ROS 2, содержащий необходимую msgфайл.

Убедившись, что ваш пользовательский пакет сообщений верен, обратите внимание на расположение пути к папке, а затем позвоните ros2genmsg с заданным путем. В следующем примере представлены три сообщения example_package_a, example_package_b, и example_package_c которые имеют зависимости. Этот пример также иллюстрирует, что можно использовать папку, содержащую несколько сообщений, и генерировать их все одновременно.

Чтобы настроить пользовательские сообщения в MATLAB, откройте MATLAB в новом сеансе. Поместите пользовательскую папку сообщений в место и отметьте путь к папке. В этом примере пользовательская папка интерфейса сообщений присутствует в текущей директории. Если вы создаете пользовательские пакеты сообщений в отдельном месте, укажите подходящий путь к папке, содержащей пользовательские пакеты сообщений.

folderPath = fullfile(pwd,"custom");
copyfile("example_*_msgs",folderPath);

Укажите путь к папке для пользовательских файлов сообщений и вызовите ros2genmsg для создания пользовательских сообщений для MATLAB.

ros2genmsg(folderPath)
Identifying message files in folder 'U:/Documents/MATLAB/Examples/ros-ex44405863/custom'.Done.
Validating message files in folder 'U:/Documents/MATLAB/Examples/ros-ex44405863/custom'.Done.
[3/3] Generating MATLAB interfaces for custom message packages... Done.
Running colcon build in folder 'U:/Documents/MATLAB/Examples/ros-ex44405863/custom/matlab_msg_gen/win64'.
Build in progress. This may take several minutes...
Build succeeded.build log

Функции ros2 msg list для проверки создания новых пользовательских сообщений.

Теперь в качестве стандартных сообщений можно использовать созданное выше пользовательское сообщение. Для получения дополнительной информации об отправке и получении сообщений см. раздел Обмен данными с издателями и подписчиками ROS 2.

Создайте издателя, который будет использовать example_package_b/Standalone сообщение.

node = ros2node("/node_1");
pub = ros2publisher(node,"/example_topic","example_b_msgs/Standalone");

Создайте абонента на ту же тему.

sub = ros2subscriber(node,"/example_topic");

Создайте сообщение и отправьте сообщение.

custom_msg = ros2message("example_b_msgs/Standalone");
custom_msg.int_property = uint32(12);
custom_msg.string_property='This is ROS 2 custom message example';
send(pub,custom_msg);
pause(3)    % Allow a few seconds for the message to arrive

Использование LatestMessage поле, чтобы знать недавнее сообщение, полученное абонентом.

sub.LatestMessage
ans = struct with fields:
       int_property: 12
    string_property: 'This is ROS 2 custom message example'

Удалите созданные объекты ROS.

clear node pub sub

Входные параметры

свернуть все

Путь к папке интерфейсов ROS, которая является родительской папкой пакетов сообщений ROS, задается как строковый скаляр или вектор символов. Родительская папка должна содержать package.xml папки с файлами и пакетами. Эти папки содержат /msg папка с .msg файлы для определений сообщений. Дополнительные сведения см. в разделе Об интерфейсах ROS 2.

Пример: "/opt/ros2/dashing/share"

Типы данных: char | string

Аргументы в виде пар имя-значение

Задайте необязательные разделенные разделенными запятой парами Name,Value аргументы. Name - имя аргумента и Value - соответствующее значение. Name должны находиться внутри кавычек. Можно задать несколько аргументов в виде пар имен и значений в любом порядке Name1,Value1,...,NameN,ValueN.

Пример: 'BuildConfiguration','fasterruns'

Построение строения, заданное как разделенная запятой пара, состоящее из 'BuildConfiguration' и вектор символов или строковый скаляр, содержащий 'fasterbuilds' или 'fasterruns'.

  • 'fasterbuilds' - Создайте библиотеки сообщений с оптимизацией компилятора для более коротких времен сборки.

  • 'fasterruns' - Создайте библиотеки сообщений с оптимизацией компилятора для более быстрого выполнения.

Пример: ros2genmsg("/opt/ros2/dashing/share",'BuildConfiguration','fasterruns')

Типы данных: char | string

Ограничения

Перезапуск узлов

  • После генерации пользовательских сообщений перезапустите все существующие узлы ROS 2.

Генерация кода с пользовательскими сообщениями:

  • Пользовательские типы сообщений и услуг могут использоваться с функциями ROS 2 для генерации кода С++ для автономного узла ROS 2. Сгенерированный код (архив .tgz) будет включать определения для пользовательских сообщений, но не будет включать пользовательские пакеты сообщений ROS 2. Когда сгенерированный код создается в месте назначения, он ожидает, что пользовательские пакеты сообщений будут доступны в рабочую область colcon, которая должна быть вашей текущей рабочей директорией. Перед созданием сгенерированного кода убедитесь, что вы либо установили, либо скопировали в систему пользовательский пакет сообщений.

MATLAB Compiler

  • Пользовательские сообщения ROS 2 и ros2genmsg функция не поддерживается с помощью MATLAB Compiler™.

Введенный в R2019b