rosactionclient

Создайте клиент действия ROS

Описание

Используйте rosactionclient связывать с сервером действия с помощью SimpleActionClient возразите и запросите выполнение целей действия. Можно получить обратную связь на процессе выполнения и отменить цель в любое время. SimpleActionClient объект инкапсулирует простой клиент действия и позволяет вам отследить одну цель за один раз.

Создание

Синтаксис

client = rosactionclient(actionname)

client = rosactionclient(actionname,actiontype)

[client,goalMsg]
= rosactionclient(___)

[___]
= rosactionclient(___,"DataFormat","struct")

client = ros.SimpleActionClient(node,actionname)

client = ros.SimpleActionClient(node,actionname,actiontype)

client = ros.SimpleActionClient(___,"DataFormat","struct")

Описание

пример

client = rosactionclient(actionname) создает клиент для заданного ROS ActionName. Клиент определяет тип действия автоматически. Если действие не доступно, эта функция отображает ошибку.

Используйте rosactionclient связывать с сервером действия и запрашивать выполнение целей действия. Можно получить обратную связь на прогрессе выполнения и отменить цель в любое время.

client = rosactionclient(actionname,actiontype) создает клиент действия с указанным именем и типом (ActionType). Если действие не доступно, или имя и тип не соответствуют, функция отображает ошибку.

[client,goalMsg] = rosactionclient(___) возвращает целевое сообщение, чтобы отправить, клиент действия создал использование любого из аргументов от предыдущих синтаксисов. Goal сообщение инициализируется значениями по умолчанию для того сообщения.

Если ActionFcn, FeedbackFcn, и ResultFcn коллбэки заданы, они называются, когда цель обрабатывает на сервере действия. Все коллбэки, сопоставленные с ранее отправленной целью, отключены, но предыдущая цель не отменяется.

[___] = rosactionclient(___,"DataFormat","struct") использование передает структуры вместо объектов. Для получения дополнительной информации смотрите, что ROS передает Структуры.

client = ros.SimpleActionClient(node,actionname) создает клиент для заданного имени действия ROS. node Node объект, который соединяется с сетью ROS. Клиент определяет тип действия автоматически. Если действие не доступно, функция отображает ошибку.

client = ros.SimpleActionClient(node,actionname,actiontype) создает клиент действия с указанным именем и типом. Можно получить тип использования действия rosaction введите actionname.

client = ros.SimpleActionClient(___,"DataFormat","struct") использование передает структуры вместо объектов. Для получения дополнительной информации смотрите, что ROS передает Структуры.

Свойства

развернуть все

`ActionName` — Имя действия ROS
символьный вектор

Имя действия ROS, возвращенное как вектор символов. Имя действия должно совпадать с одной из тем что rosaction("list") выходные параметры .

`ActionType` — Тип действия для действия ROS
строковый скаляр | вектор символов

Тип действия для действия ROS, возвращенного как строковый скаляр или вектор символов. Можно получить тип действия действия с помощью rosaction type <action_name>. Для получения дополнительной информации смотрите rosaction.

`IsServerConnected` — Указывает, соединяется ли клиент с сервером действия ROS
`false` (значение по умолчанию) | `true`

Индикатор того, соединяется ли клиент с сервером действия ROS, возвратился как false или trueИспользование waitForServer ожидать, пока сервер не соединяется при подготовке клиента действия.

`Goal` — Отслеженная цель
Сообщение ROS

Отслеженная цель, возвращенная как сообщение ROS. Это сообщение является последним целевым сообщением этот отправленный клиент. Целевое сообщение зависит от типа действия.

`GoalState` — Целевое состояние
символьный вектор

Целевое состояние, возвращенное как одно из следующего:

'pending' — Цель была получена, но еще не была принята или отклонена.
'active' — Цель была принята и работает на сервере.
'succeeded' — Цель выполняется успешно.
'preempted' — Клиент действия отменил цель, прежде чем она закончила выполняться.
'aborted' — Цель была прервана, прежде чем она закончила выполняться. Сервер действия обычно прерывает цель.
'rejected' — Цель не была принята будучи в 'pending' состояние. Сервер действия обычно инициировал это состояние.
'recalled' — Клиент отменил цель, в то время как это было в 'pending' состояние.
'lost' — Внутренняя ошибка произошла в клиенте действия.

`ActivationFcn` — Функция активации
`@(~) disp('Goal is active.')` (значение по умолчанию) | указатель на функцию

Функция активации, возвращенная как указатель на функцию. Эта функция выполняется когда GoalState установлен в 'active'. По умолчанию функция отображает 'Goal is active.'. Можно установить функцию на [] сделать, чтобы клиент действия ничего не сделал после активации.

`FeedbackFcn` — Функция обратной связи
`@(~,msg) disp(['Feedback: ', showdetails(msg)])` (значение по умолчанию) | указатель на функцию

Функция обратной связи, возвращенная как указатель на функцию. Эта функция выполняется, когда новое сообщение обратной связи получено от сервера действия. По умолчанию функция отображает детали сообщения. Можно установить функцию на [] чтобы иметь клиент действия не дают любую обратную связь.

`ResultFcn` — Функция результата
`@(~,msg,s,~) disp(['Result with state ' s ': ', showdetails(msg)])` (значение по умолчанию) | указатель на функцию

Функция результата, возвращенная как указатель на функцию. Эта функция выполняется, когда сервер закончил выполнять цель и возвращает состояние результата и сообщение. По умолчанию функция отображает состояние и детали сообщения. Можно установить функцию на [] чтобы сделать, чтобы клиент действия ничего не сделал однажды, цель завершается.

`DataFormat` — Формат сообщения
`"object"` (значение по умолчанию) | `"struct"`

Формат сообщения в виде "object" или "struct". Необходимо установить это свойство на создании с помощью входа значения имени. Для получения дополнительной информации смотрите, что ROS передает Структуры.

Функции объекта

`cancelGoal`	Отмените последнюю цель, отправленную клиентом
`cancelAllGoals`	Отмените все цели на сервере действия
`rosmessage`	Создайте сообщения ROS
`sendGoal`	Отправьте целевое сообщение в сервер действия
`sendGoalAndWait`	Отправьте целевое сообщение и ожидайте результата
`waitForServer`	Ожидайте сервера действия, чтобы запуститься

Примеры

свернуть все

Setup клиент действия ROS и выполняет действие

Скрипт Open Live Script

В этом примере показано, как создать клиент действия ROS и выполнить действие. Типы действия должны быть настроены заранее с выполнением сервера действия.

Вы, должно быть, настроили '/fibonacci' тип действия. Чтобы запустить этот сервер действия, используйте следующую команду в системе ROS:

rosrun actionlib_tutorials fibonacci_server

Соединитесь с сетью ROS. Вы должны быть соединены с сетью ROS, чтобы собрать информацию о том, какие действия доступны. Замените ipaddress с вашим сетевым адресом.

ipaddress = '192.168.203.133';
rosinit(ipaddress,11311)

Initializing global node /matlab_global_node_81947 with NodeURI http://192.168.203.1:54283/

Перечислите действия, доступные в сети. Единственным действием, настроенным в этой сети, является '/fibonacci' действие.

rosaction list

/fibonacci

Создайте клиент действия путем определения имени действия. Используйте структуры для сообщений ROS.

[actClient,goalMsg] = rosactionclient('/fibonacci','DataFormat','struct');

Ожидайте клиента действия, чтобы связать с сервером.

waitForServer(actClient);

fibonacci действие вычислит fibonacci последовательность для данного распоряжения, заданного в целевом сообщении. Целевое сообщение было возвращено при создании клиента действия и может быть изменено, чтобы отправить цели в сервер действия ROS. Установите порядок к int32 значение 8.

goalMsg.Order = int32(8);

Отправьте цель и ожидайте ее завершения. Задайте тайм-аут 10 секунд, чтобы завершить действие.

[resultMsg,resultState] = sendGoalAndWait(actClient,goalMsg,10);

rosShowDetails(resultMsg)

ans = 
    '
       MessageType :  actionlib_tutorials/FibonacciResult
       Sequence    :  [0, 1, 1, 2, 3, 5, 8, 13, 21]'

Отключитесь от сети ROS.

rosshutdown

Shutting down global node /matlab_global_node_81947 with NodeURI http://192.168.203.1:54283/

Отправьте и отмените цели действия ROS

Скрипт Open Live Script

В этом примере показано, как отправить и отменить цели по действиям ROS. Типы действия должны быть настройкой заранее с выполнением сервера действия.

rosrun actionlib_tutorials fibonacci_server

Во-первых, настройте клиент действия ROS. Затем отправьте целевое сообщение модифицированными параметрами. Наконец, отмените свою цель и все цели на сервере действия.

Соединитесь с сетью ROS с заданным IP-адресом. Создайте клиент действия ROS, соединенный с сетью ROS с помощью rosactionclient. Задайте имя действия. Ожидайте клиента, чтобы быть соединенными с сервером.

rosinit('192.168.203.133',11311)

Initializing global node /matlab_global_node_18287 with NodeURI http://192.168.203.1:55284/

[actClient,goalMsg] = rosactionclient('/fibonacci','DataFormat','struct');
waitForServer(actClient);

Отправьте целевое сообщение модифицированными параметрами. Ожидайте цели закончить выполняться.

goalMsg.Order = int32(4);
[resultMsg,resultState] = sendGoalAndWait(actClient,goalMsg)

resultMsg = struct with fields:
    MessageType: 'actionlib_tutorials/FibonacciResult'
       Sequence: [0 1 1 2 3]

resultState = 
'succeeded'

rosShowDetails(resultMsg)

ans = 
    '
       MessageType :  actionlib_tutorials/FibonacciResult
       Sequence    :  [0, 1, 1, 2, 3]'

Отправьте новое целевое сообщение без ожидания.

goalMsg.Order = int32(5);
sendGoal(actClient,goalMsg)

Отмените цель на клиенте действия ROS, actClient.

cancelGoal(actClient)

Отмените все цели на сервере действия что actClient соединяется с.

cancelAllGoals(actClient)

Удалите клиент действия.

delete(actClient)

Отключитесь от сети ROS.

rosshutdown

Shutting down global node /matlab_global_node_18287 with NodeURI http://192.168.203.1:55284/

Вопросы совместимости

развернуть все

Структуры сообщения ROS

Изменение поведения в будущем релизе

Можно теперь создать сообщения как структуры с полями, совпадающими со свойствами объекта сообщения. Используя структуры обычно улучшает производительность создания, обновления и использования сообщений ROS, но поля сообщения больше не подтверждаются, когда установлено. Типы сообщений и значения соответствующего поля от структур подтверждены, когда отправлено по сети.

Чтобы использовать сообщения ROS в качестве структур, используйте "DataFormat" аргумент значения имени при создании издателей, подписчиков или других объектов ROS. Любые сообщения, сгенерированные от этих объектов, используют структуры.

pub = rospublisher("/scan","sensor_msgs/LaserScan","DataFormat","struct")
msg = rosmessage(pub)

Можно также создать сообщения как структуры непосредственно, но убедиться, что задали формат данных как "struct" для издателя, подписчика или другого ROS возражает также. Объекты ROS все еще используют объекты сообщения по умолчанию.

msg = rosmessage("/scan","sensor_msgs/LaserScan","DataFormat","struct")
...
pub = rospublisher("/scan","sensor_msgs/LaserScan","DataFormat","struct")

В будущем релизе сообщения ROS будут использовать структуры по умолчанию, и объекты сообщения ROS будут удалены.

Для получения дополнительной информации смотрите, Улучшают Производительность ROS Используя Структуры сообщения.

Расширенные возможности

Генерация кода C/C++
Генерация кода C и C++ с помощью MATLAB® Coder™.

Указания и ограничения по применению:

Поддерживаемый только для struct сообщения.
ActionType аргумент должен быть задан.
Функции обратного вызова должны быть присвоены во время rosactionclient или ros.SimpleActionClient создание объекта, и не может быть изменено во время времени выполнения.
Для ros.SimpleActionClient, node входной параметр должен быть пустым.
Поддерживаемый только для Типа Сборки, Executable.
Использование в блоке MATLAB Function не поддерживается.

Документация

rosactionclient

Описание

Создание

Синтаксис

Описание

Свойства

`ActionName` — Имя действия ROS
символьный вектор

`ActionType` — Тип действия для действия ROS
строковый скаляр | вектор символов

`IsServerConnected` — Указывает, соединяется ли клиент с сервером действия ROS
`false` (значение по умолчанию) | `true`

`Goal` — Отслеженная цель
Сообщение ROS

`GoalState` — Целевое состояние
символьный вектор

`ActivationFcn` — Функция активации
`@(~) disp('Goal is active.')` (значение по умолчанию) | указатель на функцию

`FeedbackFcn` — Функция обратной связи
`@(~,msg) disp(['Feedback: ', showdetails(msg)])` (значение по умолчанию) | указатель на функцию

`ResultFcn` — Функция результата
`@(~,msg,s,~) disp(['Result with state ' s ': ', showdetails(msg)])` (значение по умолчанию) | указатель на функцию

`DataFormat` — Формат сообщения
`"object"` (значение по умолчанию) | `"struct"`

Функции объекта

Примеры

Setup клиент действия ROS и выполняет действие

Отправьте и отмените цели действия ROS

Вопросы совместимости

Структуры сообщения ROS

Расширенные возможности

Генерация кода C/C++
Генерация кода C и C++ с помощью MATLAB® Coder™.

Смотрите также

Темы

Внешние веб-сайты

Документация ROS Toolbox

Поддержка

Документация

rosactionclient

Описание

Создание

Синтаксис

Описание

Свойства

ActionName — Имя действия ROS символьный вектор

ActionType — Тип действия для действия ROS строковый скаляр | вектор символов

IsServerConnected — Указывает, соединяется ли клиент с сервером действия ROS false (значение по умолчанию) | true

Goal — Отслеженная цель Сообщение ROS

GoalState — Целевое состояние символьный вектор

ActivationFcn — Функция активации @(~) disp('Goal is active.') (значение по умолчанию) | указатель на функцию

FeedbackFcn — Функция обратной связи @(~,msg) disp(['Feedback: ', showdetails(msg)]) (значение по умолчанию) | указатель на функцию

ResultFcn — Функция результата @(~,msg,s,~) disp(['Result with state ' s ': ', showdetails(msg)]) (значение по умолчанию) | указатель на функцию

DataFormat — Формат сообщения "object" (значение по умолчанию) | "struct"

Функции объекта

Примеры

Setup клиент действия ROS и выполняет действие

Отправьте и отмените цели действия ROS

Вопросы совместимости

Структуры сообщения ROS

Расширенные возможности

Генерация кода C/C++ Генерация кода C и C++ с помощью MATLAB® Coder™.

Смотрите также

Темы

Внешние веб-сайты

Документация ROS Toolbox

Поддержка

`ActionName` — Имя действия ROS
символьный вектор

`ActionType` — Тип действия для действия ROS
строковый скаляр | вектор символов

`IsServerConnected` — Указывает, соединяется ли клиент с сервером действия ROS
`false` (значение по умолчанию) | `true`

`Goal` — Отслеженная цель
Сообщение ROS

`GoalState` — Целевое состояние
символьный вектор

`ActivationFcn` — Функция активации
`@(~) disp('Goal is active.')` (значение по умолчанию) | указатель на функцию

`FeedbackFcn` — Функция обратной связи
`@(~,msg) disp(['Feedback: ', showdetails(msg)])` (значение по умолчанию) | указатель на функцию

`ResultFcn` — Функция результата
`@(~,msg,s,~) disp(['Result with state ' s ': ', showdetails(msg)])` (значение по умолчанию) | указатель на функцию

`DataFormat` — Формат сообщения
`"object"` (значение по умолчанию) | `"struct"`

Генерация кода C/C++
Генерация кода C и C++ с помощью MATLAB® Coder™.