Skip to content
Snippets Groups Projects
Commit 8b208a1f authored by Alejandro Lopez Gestoso's avatar Alejandro Lopez Gestoso
Browse files

Added ReadMe.md file

parent 60016442
No related branches found
No related tags found
No related merge requests found
Scripts-catkin
==============
## Description
Set of scripts to easily generate driver and algorithm packages in ROS, and also a set of scripts to add publishers, subscribers, service clients an servers and action clients and servers to an existing package.
## Installation
- Clone this repository: `git clone ssh://git@gitlab.iri.upc.edu:2202/labrobotica/ros/iri_core/scripts-catkin.git -b kinetic_migration scripts`
- Install realpath:`sudo apt-get install realpath`
- ``echo "source `pwd`/scripts/setup.bash" >> ~/.bashrc``
- `source ~/.bashrc`
## How to use it
### create_algorithm_package.sh and create_driver_package.sh
These scripts have the following arguments:
- -n node\_name: The node's name. It has a default 'iri\_' prefix.
- -i : (optional) Avoid adding the default iri_ prefix to the provided node name.
- -p prefix: (optional) Replaces default 'iri\_' prefix with specified 'prefix\_'.
### add_topic_publisher_subscriber.sh
This script has the following parameters:
- -o \[publisher, subscriber\]: To add a publisher or a subscriber.
- -p ros\_pkg\_name: The target ros package.
- -t topic\_name: The topic's name. It musn't have a backslash (\\).
- -m message: The topic's message.msg.
- -b buffer\_length: The buffer's length (usually 1).
### add_service_server_client.sh
This script has the following parameters:
- -o \[server, client\]: To add a service server or client.
- -p ros\_pkg\_name: The target ros package.
- -s service\_name: The service's name. It musn't have a backslash (\\).
- -m service: The service's service.srv.
### add_action_server_client.sh
- -o \[server, client\]: To add aaction server or client.
- -p ros\_pkg\_name: The target ros package.
- -a action\_name: The action's name. It musn't have a backslash (\\).
- -m message: The action's message.action.
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment