From 29691d0042ecc0e0c41c4f1dd3fc6918ff9d96eb Mon Sep 17 00:00:00 2001
From: Sergi Hernandez Juan <shernand@iri.upc.edu>
Date: Fri, 13 Jul 2018 08:27:40 +0200
Subject: [PATCH] Added the README file.
---
README.md | 61 +++++++++++++++++++++++++++++++++++++++++++++++++++++
package.xml | 8 +++----
2 files changed, 65 insertions(+), 4 deletions(-)
create mode 100644 README.md
diff --git a/README.md b/README.md
new file mode 100644
index 0000000..6bb6806
--- /dev/null
+++ b/README.md
@@ -0,0 +1,61 @@
+# Description
+
+This package is a Gazebo plugin to control the state of a single sempahores in the model car simulator. This package is part of the model car simulator used for the [ADC competition](http://autonomousdrivingchallenge.com/ "ADC competition").
+
+This package in intended to be used with ROS Kinetic under Linux Ubuntu 16.04, although it may work with other ROS versions and Linux variations.
+
+# Dependencies
+
+This node has the following dependencies:
+
+ * gazebo ros
+
+ * gazebo plugins
+
+All these dependencies can be installed with:
+
+```
+sudo apt-get install ros-kinetic-gazebo-ros ros-kinetic-gazebo-plugins
+```
+
+# How to use it
+
+## Install
+
+This package can be cloned to the active workspace with the following command:
+
+```
+roscd
+cd ../src
+git clone https://gitlab.iri.upc.edu/seat_adc/simulator/color_plugin.git
+```
+
+But it is recommended to follow the [instructions on how to install the model simulator](https://gitlab.iri.upc.edu/seat_adc/simulator/model_car_gazebo).
+
+## running
+
+Each semaphore will provide a service call to change its state. The namespace of the service call depend on the name given to the semaphore. The default model cal simulator provides the following services:
+
+ * /semaphore_intersection1_color_plugin/trigger
+
+ * /semaphore_intersection2_color_plugin/trigger
+
+ * /semaphore_intersection3_color_plugin/trigger
+
+ * /semaphore_parking1_color_plugin/trigger
+
+ * /semaphore_parking2_color_plugin/trigger
+
+ * /semaphore_roundabout1_color_plugin/trigger
+
+ * /semaphore_roundabout2_color_plugin/trigger
+
+ * /semaphore_start1_color_plugin/trigger
+
+ * /semaphore_start2_color_plugin/trigger
+
+To change the state of any of these semaphores, call the corresponding service:
+
+```
+rosservice call /semaphore_start1_color_plugin/trigger
+```
diff --git a/package.xml b/package.xml
index 0b5143e..85ec3c8 100644
--- a/package.xml
+++ b/package.xml
@@ -50,11 +50,11 @@
<build_depend>gazebo_plugins</build_depend>
<run_depend>gazebo_plugins</run_depend>
- <build_depend>message_runtime</build_depend>
- <run_depend>message_runtime</run_depend>
+ <build_depend>message_runtime</build_depend>
+ <run_depend>message_runtime</run_depend>
- <build_depend>message_generation</build_depend>
- <run_depend>message_generation</run_depend>
+ <build_depend>message_generation</build_depend>
+ <run_depend>message_generation</run_depend>
<build_depend>std_msgs</build_depend>
<run_depend>std_msgs</run_depend>
--
GitLab