diff --git a/README.rst b/README.rst index d8cce22c..95c01686 100644 --- a/README.rst +++ b/README.rst @@ -1,7 +1,7 @@ Description =========== -This is a NAOqi module that bridges with ROS. It publishes +This is a naoqi driver module that bridges with ROS. It publishes several sensor data as well as the robot position. On the other hand it enables ROS to call parts of the diff --git a/doc/Doxyfile b/doc/Doxyfile index 9b8dfa80..1d9bd00c 100644 --- a/doc/Doxyfile +++ b/doc/Doxyfile @@ -32,7 +32,7 @@ DOXYFILE_ENCODING = UTF-8 # title of most generated pages and in a few other places. # The default value is: My Project. -PROJECT_NAME = ALRosBridge +PROJECT_NAME = naoqi driver # The PROJECT_NUMBER tag can be used to enter a project or revision number. This # could be handy for archiving the generated documentation or if some version diff --git a/doc/source/api.rst b/doc/source/api.rst index bdcd6eae..4bbfb155 100644 --- a/doc/source/api.rst +++ b/doc/source/api.rst @@ -9,13 +9,13 @@ All the following calls must be performed from the robot. In order to get the module to connect to your roscore, you should send it your IP. -* ``void`` ALRosBridge:\:**setMasterURI** ( ``const std::string&`` **uri** ) +* ``void`` ROS-Driver:\:**setMasterURI** ( ``const std::string&`` **uri** ) Set current master URI. The IP adress given is from defauth *eth0* network interface. *param:* **uri** - string in form of ``http://:11311`` -* ``void`` ALRosBridge:\:**setMasterURINet** ( ``const std::string&`` **uri**, ``const std::string&`` **network_interface** ) +* ``void`` ROS-Driver:\:**setMasterURINet** ( ``const std::string&`` **uri**, ``const std::string&`` **network_interface** ) Set current master URI using a given network interface. @@ -23,7 +23,7 @@ In order to get the module to connect to your roscore, you should send it your I *param:* **network_interface** - string. For example ``tether``. -* ``const std::string&`` ALRosBridge:\:**getMasterURI** () +* ``const std::string&`` ROS-Driver:\:**getMasterURI** () Get current master URI using a given network interface. @@ -35,13 +35,13 @@ In order to get the module to connect to your roscore, you should send it your I The converters are responsible for operating conversion between NAOqi messages and ROS messages, in accordance with given frequency. -* ``const std::vector< std::string >&`` ALRosBridge:\:**getAvailableConverters** () +* ``const std::vector< std::string >&`` ROS-Driver:\:**getAvailableConverters** () Get all registered converters in the module. *return:* vector of string of all converter's topic name -* ``void`` ALRosBridge:\:**registerMemoryConverter** ( ``const std::string&`` **key**, ``float`` **frequency**, ``int`` **type** ) +* ``void`` ROS-Driver:\:**registerMemoryConverter** ( ``const std::string&`` **key**, ``float`` **frequency**, ``int`` **type** ) Register a new converter for the memory key given. @@ -60,7 +60,7 @@ The converters are responsible for operating conversion between NAOqi messages a * 3 - String * 4 - Bool -* ``void`` ALRosBridge:\:**addMemoryConverters** ( ``std::string`` **filePath** ) +* ``void`` ROS-Driver:\:**addMemoryConverters** ( ``std::string`` **filePath** ) Add some new converters for memory keys. This call requires as argument the path to a JSON file (stored on the robot) structured as the following one. memKeys and topic must be present and filled. Frequency is optional, and if not there, the default value is 10 Hz. @@ -82,15 +82,15 @@ The converters are responsible for operating conversion between NAOqi messages a **Publishers API** -* ``void`` ALRosBridge:\:**startPublishing** () +* ``void`` ROS-Driver:\:**startPublishing** () Start/enable publishing all registered publisher -* ``void`` ALRosBridge:\:**stopPublishing** () +* ``void`` ROS-Driver:\:**stopPublishing** () Stop/disable publishing all registered publisher -* ``const std::vector< std::string >&`` ALRosBridge:\:**getSubscribedPublishers** () +* ``const std::vector< std::string >&`` ROS-Driver:\:**getSubscribedPublishers** () Get all subscribed publishers. @@ -100,17 +100,17 @@ The converters are responsible for operating conversion between NAOqi messages a **Recorders API** -* ``void`` ALRosBridge:\:**startRecording** () +* ``void`` ROS-Driver:\:**startRecording** () Start/enable recording all registered recorder. - This will record all topics in one ROSbag, named after current date & time. The ROSbag is stored in the exact path where the **ALRosBridge** module is launched (meaning that it will be stored on the robot if it's launched from here). + This will record all topics in one ROSbag, named after current date & time. The ROSbag is stored in the exact path where the **ROS-Driver** module is launched (meaning that it will be stored on the robot if it's launched from here). -* ``void`` ALRosBridge:\:**stopRecording** () +* ``void`` ROS-Driver:\:**stopRecording** () Stop/disable recording all registered recorder. You can now have a look to the :ref:`list of available topics `, or you can go back to the :ref:`index
`. -If you want to know more about the API, you can look at the doxygen documentation `here <./api/index.html>`_ \ No newline at end of file +If you want to know more about the API, you can look at the doxygen documentation `here <./api/index.html>`_ diff --git a/doc/source/install.rst b/doc/source/install.rst index 987e7bb0..097a379b 100644 --- a/doc/source/install.rst +++ b/doc/source/install.rst @@ -90,7 +90,7 @@ How to install it qibuild configure -c qibuild make -c - Once compilation is over, the resulting binary will be in *~/qibuild_ws/naoqi_driver/build-/sdk/bin/alrosbridge_bin* + Once compilation is over, the resulting binary will be in *~/qibuild_ws/naoqi_driver/build-/sdk/bin/naoqi_driver_node* If you encounter any compilation issue, (unable to find some dependencies), you might need to install them (through *apt-get install* for instance) diff --git a/doc/source/other.rst b/doc/source/other.rst index b4028fd1..b5aedf9c 100644 --- a/doc/source/other.rst +++ b/doc/source/other.rst @@ -14,7 +14,7 @@ Android Teleop First, install the teleop app on your Android after installing rosjava and android_apps at http://wiki.ros.org/rosjava (or ask Karsten for the ``.apk``) -When starting your roscore and this bridge, make sure you export your ``ROS_IP`` and ``ROS_MASTER_URI`` to your IP. +When starting your roscore and this naoqi driver, make sure you export your ``ROS_IP`` and ``ROS_MASTER_URI`` to your IP. Then start motion on your robot: @@ -26,4 +26,4 @@ Then start motion on your robot: You can now control your robot with the app. -Go back to the :ref:`index
`. \ No newline at end of file +Go back to the :ref:`index
`. diff --git a/doc/source/start.rst b/doc/source/start.rst index 85e02be7..f47a52f7 100644 --- a/doc/source/start.rst +++ b/doc/source/start.rst @@ -20,24 +20,24 @@ Start the naoqi driver module Please execute the following steps on your local computer, not from the robot .. toggle_table:: - :arg1: ROS - :arg2: NAOqi + :arg1: catkin + :arg2: qibuild -.. toggle:: ROS +.. toggle:: catkin - In case you built via catkin, you can alternatively start the bridge via rosrun :: + In case you built via catkin, you can alternatively start the naoqi driver via rosrun :: - $ rosrun naoqi_driver alrosbridge_bin --qi-url= + $ rosrun naoqi_driver naoqi_driver_node --qi-url= The second parameter is available from version 1.2 (or compilation from source). Starting from version 1.2 (or compilation from source) you can alternatively start the bridge via a launch file :: $ roslaunch naoqi_driver naoqi_driver.launch nao_ip:= roscore_ip:= network_interface:= -.. toggle:: NAOqi +.. toggle:: qibuild In case you have a qibuild workspace, you can run the roscore by directly executing the binary :: - $ path/to/alrosbridge_bin --qi-url= + $ path/to/naoqi_driver_node --qi-url= The roscore IP is the IP of the computer where the roscore is running. This command is optional. If you don't specify, any ROS communication is disabled until you call setMasterURI. The second parameter ``network_interface`` specifies the network interface the bridge is connected. By default, this is set to ``eth0``. Changing this becomes important to establish a correct network connection between robot and computer, when you are connected via a different network device, such as wlan0 or vpn0 etc. In case you are not certain which device to use, verify with ``ifconfig`` and verify which network device has the correct IP. @@ -45,18 +45,18 @@ The roscore IP is the IP of the computer where the roscore is running. This comm Set the roscore IP manually --------------------------- -In case you started the bridge without ROS communication (saying without the roscore_ip parameter), you can do so while the bridge is running. +In case you started the naoqi driver without ROS communication (saying without the roscore_ip parameter), you can do so while the bridge is running. For this, open a SSH connection onto your robot and execute the following command **on** the robot :: - $ qicli call ALRosBridge.setMasterURI http://:11311 + $ qicli call ROS-Driver.setMasterURI http://:11311 -If the robot is not connected through ethernet, but an alternative interface such as wlan0, tethering or VPN, you need to specify the network interface :: +If you connect to the robot not through ethernet, but an alternative interface such as wlan0, tethering or VPN, you need to specify the network interface :: - $ qicli call ALRosBridge.setMasterURINet http://:11311 + $ qicli call ROS-Driver.setMasterURINet http://:11311 For instance, if the robot use tethering (and ``tether`` shows when doing ``ifconfig``), use :: - $ qicli call ALRosBridge.setMasterURINet http://:11311 tether + $ qicli call ROS-Driver.setMasterURINet http://:11311 tether Check that it is running correctly ----------------------------------