rosactionclient

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

Описание

Используйте rosactionclient для подключения к серверу действий с помощью SimpleActionClient объект и запросить выполнение целей действий. Вы можете получить обратную связь о процессе выполнения и отменить цель в любое время. The 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(___) возвращает сообщение цели для отправки клиента действия, созданного с использованием любого из аргументов из предыдущих синтаксисов. The Goal сообщение инициализируется значениями по умолчанию для этого сообщения.

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

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

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

client = ros.SimpleActionClient(node,actionname,actiontype) создает клиент действий с заданным именем и типом. Тип действия можно получить используя rosaction type 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". Вы должны задать это свойство при создании с помощью входов name-value. Для получения дополнительной информации см. раздел Структуры сообщений ROS.

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

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

Примеры

свернуть все

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

Открыть 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

Открыть 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 с использованием структур сообщений.

См. также

cancelGoal | rosaction | rosmessage | sendGoal | waitForServer

Темы

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

Действия ROS

Введенный в R2019b

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

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

См. также

Темы

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

Документация 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

См. также

Темы

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

Документация 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"`