diff --git a/README.md b/README.md index c509399..cfa32bb 100644 --- a/README.md +++ b/README.md @@ -8,6 +8,20 @@ Here are the following requirements: 4. Permissions be changed on the working directory 3. apache2 up and running +### Quick Start Guide + +To connect to a remote computer, connect to the remote master by replaceing the appropriate IP addresses as shown here: + + sudo route add 192.168.2.1 gw 192.168.0.103 + export ROS_MASTER_URI=http://192.168.0.103:11311 + export ROS_IP=192.168.0.101 + +Then run the bash file in the working directory. + + bash bashLaunchFile.bash + +If you are having troubles, make sure the .bash file's permissions permit execution and make sure the working directory ("rosbridge\_GUI\_example") and all it's sub folder's permissions for "others" permit "Create and delete files" for enlcosed files and folders. + ## ROS Core If you are either using a remote rosmaster or a local one, make sure on the computer that you are going to use to host the webpage can access and echo topics that you wish to display on the webpage. @@ -37,17 +51,17 @@ that indicates your configration file is in "/etc/apache2/sites-enabled/". vi /etc/apache2/sites-enabled/000-default In that file, you can find the "DocumentRoot" like below - DocumentRoot /home/glenturner/catkin_ws/src/rosbridge_GUI_example_pelican + DocumentRoot /home/glenturner/catkin\_ws/src/asctec\_pelican\_gui + And, modify that as you want. -4.Change in apache2.conf file to include: +4.Change in apa.conf file to include: - - AllowOverride All - Require all granted + + AllowOverride All + Require all granted - 3.Restart apache. service apache2 restart @@ -60,13 +74,14 @@ Basic ROS functionality of rosbridge: http://wiki.ros.org/roslibjs/Tutorials/Bas the launch command: roslaunch rosbridge_server rosbridge_websocket.launch -## TODO +# TODO By using ROSBridge, this GUI will attempt to display relevant information over the web for any device. TODO: -2. Display Network Information +1. Display Network Information 1. Display camera image 1. Move connection information to a new tab 1. Check why on iPad the default IP address doesn't load + diff --git a/README.md~ b/README.md~ new file mode 100644 index 0000000..3532323 --- /dev/null +++ b/README.md~ @@ -0,0 +1,85 @@ +# Asctec Pelican GUI + +The purpose of this project is an example of how to write a web page that can be accessed by any device on the same network as the host computer by accessing the IP of that host computer. + +Here are the following requirements: +1. A roscore running +2. The IP of the machine running ROS +4. Permissions be changed on the working directory +3. apache2 up and running + +### Quick Start Guide + +To connect to a remote computer, connect to the remote master by replaceing the appropriate IP addresses as shown here: + + sudo route add 192.168.2.1 gw 192.168.0.103 + export ROS_MASTER_URI=http://192.168.0.103:11311 + export ROS_IP=192.168.0.101 + +Then run the bash file in the working directory. + + bash bashLaunchFile.bash + +## ROS Core +If you are either using a remote rosmaster or a local one, make sure on the computer that you are going to use to host the webpage can access and echo topics that you wish to display on the webpage. + +## The IP of the machine running ROS +This is required when connecting using the rosbridge + +## Folder Permissions +This was a big problem for me. If you ever get errors on the page that permissions where denied, navigate to the directory above the working directory, right click on the directory that you are working in, change the permissions for all folders and sub folders so that everyone can access it. + +## apache2 up and running +apache2 is used to host the webpage on your computer. + +Google can help you find the install instructions which are straight forward. + +The only next trick is to change the host directory to the working directory. + +1.check where is configuration. Generally, apache2 configuration file is located in /etc/apache2/ folder. + +_vi /etc/apache2/apache2.conf_ +in that file, you can find out the location of "DocumentRoot" config + +Include sites-enabled/ +that indicates your configration file is in "/etc/apache2/sites-enabled/". + +2.Edit DocumentRoot config + +vi /etc/apache2/sites-enabled/000-default +In that file, you can find the "DocumentRoot" like below + + DocumentRoot /home/glenturner/catkin\_ws/src/asctec\_pelican\_gui + +And, modify that as you want. + +4.Change in apa.conf file to include: + + + AllowOverride All + Require all granted + + +3.Restart apache. + +service apache2 restart + +## Getting server up and running# + +Here the rosbridge\_suite that is used to link the websocket and ROS: http://wiki.ros.org/rosbridge_suite. + +Basic ROS functionality of rosbridge: http://wiki.ros.org/roslibjs/Tutorials/BasicRosFunctionality + +the launch command: roslaunch rosbridge_server rosbridge_websocket.launch + +# TODO + + +By using ROSBridge, this GUI will attempt to display relevant information over the web for any device. + +TODO: +1. Display Network Information +1. Display camera image +1. Move connection information to a new tab +1. Check why on iPad the default IP address doesn't load + diff --git a/bashLaunchFile.bash b/bashLaunchFile.bash new file mode 100755 index 0000000..a40c782 --- /dev/null +++ b/bashLaunchFile.bash @@ -0,0 +1,11 @@ +#! /bin/bash + + echo Opening Web Browser +IP_ADDR=$(hostname -I) + +echo $IP_ADDR +x-www-browser $IP_ADDR + +echo Launching ROSBridge +roslaunch rosbridge_server rosbridge_websocket.launch +