Skip to content

Commit

Permalink
Merge pull request #3 from kavyadevd/Week10_HW
Browse files Browse the repository at this point in the history
Week9_HW_Release
  • Loading branch information
kavyadevd authored Nov 5, 2021
2 parents a3efa25 + 576bc64 commit 27c137f
Show file tree
Hide file tree
Showing 59 changed files with 6,800 additions and 13 deletions.
5 changes: 4 additions & 1 deletion CMakeLists.txt
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,10 @@ cmake_minimum_required(VERSION 2.8.3)
project(beginner_tutorials)

## Find catkin and any catkin packages
find_package(catkin REQUIRED COMPONENTS roscpp rospy std_msgs genmsg)
find_package(catkin REQUIRED COMPONENTS roscpp rospy std_msgs genmsg message_generation)

## Generate services in the 'srv' folder
add_service_files(FILES ServiceFile.srv)

## Generate added messages and services
generate_messages(DEPENDENCIES std_msgs)
Expand Down
2,494 changes: 2,494 additions & 0 deletions Doxyfile

Large diffs are not rendered by default.

Binary file added Results/RQT_Output.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
2 changes: 1 addition & 1 deletion Results/cppcheckoutput.txt
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
Checking src/listener.cpp ...
1/2 files checked 47% done
1/2 files checked 38% done
Checking src/talker.cpp ...
2/2 files checked 100% done
73 changes: 73 additions & 0 deletions docs/html/README_8md_source.html
Original file line number Diff line number Diff line change
@@ -0,0 +1,73 @@
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
<meta name="generator" content="Doxygen 1.8.13"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>Ros beginner tutorials: README.md Source File</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="dynsections.js"></script>
<link href="search/search.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="search/searchdata.js"></script>
<script type="text/javascript" src="search/search.js"></script>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
</head>
<body>
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
<tbody>
<tr style="height: 56px;">
<td id="projectalign" style="padding-left: 0.5em;">
<div id="projectname">Ros beginner tutorials
</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.13 -->
<script type="text/javascript">
var searchBox = new SearchBox("searchBox", "search",false,'Search');
</script>
<script type="text/javascript" src="menudata.js"></script>
<script type="text/javascript" src="menu.js"></script>
<script type="text/javascript">
$(function() {
initMenu('',true,false,'search.php','Search');
$(document).ready(function() { init_search(); });
});
</script>
<div id="main-nav"></div>
</div><!-- top -->
<!-- window showing the filter options -->
<div id="MSearchSelectWindow"
onmouseover="return searchBox.OnSearchSelectShow()"
onmouseout="return searchBox.OnSearchSelectHide()"
onkeydown="return searchBox.OnSearchSelectKey(event)">
</div>

<!-- iframe showing the search results (closed by default) -->
<div id="MSearchResultsWindow">
<iframe src="javascript:void(0)" frameborder="0"
name="MSearchResults" id="MSearchResults">
</iframe>
</div>

<div class="header">
<div class="headertitle">
<div class="title">README.md</div> </div>
</div><!--header-->
<div class="contents">
<a href="README_8md.html">Go to the documentation of this file.</a><div class="fragment"><div class="line"><a name="l00001"></a><span class="lineno"> 1</span>&#160;[![License: MIT](https://img.shields.io/badge/License-MIT-blue.svg)](https://opensource.org/licenses/MIT)</div><div class="line"><a name="l00002"></a><span class="lineno"> 2</span>&#160;# ROS Beginner Tutorials</div><div class="line"><a name="l00003"></a><span class="lineno"> 3</span>&#160;</div><div class="line"><a name="l00004"></a><span class="lineno"> 4</span>&#160;A beginner ROS package that implements simple publisher-subscriber nodes in ROS</div><div class="line"><a name="l00005"></a><span class="lineno"> 5</span>&#160;</div><div class="line"><a name="l00006"></a><span class="lineno"> 6</span>&#160;</div><div class="line"><a name="l00007"></a><span class="lineno"> 7</span>&#160;## Installations</div><div class="line"><a name="l00008"></a><span class="lineno"> 8</span>&#160;</div><div class="line"><a name="l00009"></a><span class="lineno"> 9</span>&#160;To install ROS refer [this link](http://wiki.ros.org/ROS/Installation).</div><div class="line"><a name="l00010"></a><span class="lineno"> 10</span>&#160;</div><div class="line"><a name="l00011"></a><span class="lineno"> 11</span>&#160;Preferred Ubuntu 18.04, ROS Melodic</div><div class="line"><a name="l00012"></a><span class="lineno"> 12</span>&#160;</div><div class="line"><a name="l00013"></a><span class="lineno"> 13</span>&#160;</div><div class="line"><a name="l00014"></a><span class="lineno"> 14</span>&#160;### Step 1. Clone repository and build the package</div><div class="line"><a name="l00015"></a><span class="lineno"> 15</span>&#160;```bash</div><div class="line"><a name="l00016"></a><span class="lineno"> 16</span>&#160;git clone --recursive https://github.com/kavyadevd/beginner_tutorials.git</div><div class="line"><a name="l00017"></a><span class="lineno"> 17</span>&#160;cp &lt;repository_path&gt; &lt;catkin_workspace_path/src/&gt;</div><div class="line"><a name="l00018"></a><span class="lineno"> 18</span>&#160;cd &lt;catkin_workspace&gt;</div><div class="line"><a name="l00019"></a><span class="lineno"> 19</span>&#160;source ./devel/setup.bash</div><div class="line"><a name="l00020"></a><span class="lineno"> 20</span>&#160;catkin_make</div><div class="line"><a name="l00021"></a><span class="lineno"> 21</span>&#160;```</div><div class="line"><a name="l00022"></a><span class="lineno"> 22</span>&#160;</div><div class="line"><a name="l00023"></a><span class="lineno"> 23</span>&#160;### Step 2. Make sure that a roscore is up and running</div><div class="line"><a name="l00024"></a><span class="lineno"> 24</span>&#160;```bash</div><div class="line"><a name="l00025"></a><span class="lineno"> 25</span>&#160;roscore</div><div class="line"><a name="l00026"></a><span class="lineno"> 26</span>&#160;```</div><div class="line"><a name="l00027"></a><span class="lineno"> 27</span>&#160;### Step 3. In new terminal run publisher node </div><div class="line"><a name="l00028"></a><span class="lineno"> 28</span>&#160;```bash</div><div class="line"><a name="l00029"></a><span class="lineno"> 29</span>&#160;rosrun beginner_tutorials talker</div><div class="line"><a name="l00030"></a><span class="lineno"> 30</span>&#160;```</div><div class="line"><a name="l00031"></a><span class="lineno"> 31</span>&#160;### Step 4. In new terminal run subscriber node </div><div class="line"><a name="l00032"></a><span class="lineno"> 32</span>&#160;```bash</div><div class="line"><a name="l00033"></a><span class="lineno"> 33</span>&#160;rosrun beginner_tutorials listener</div><div class="line"><a name="l00034"></a><span class="lineno"> 34</span>&#160;```</div><div class="line"><a name="l00035"></a><span class="lineno"> 35</span>&#160;</div><div class="line"><a name="l00036"></a><span class="lineno"> 36</span>&#160;#### To run launch file</div><div class="line"><a name="l00037"></a><span class="lineno"> 37</span>&#160;</div><div class="line"><a name="l00038"></a><span class="lineno"> 38</span>&#160;```bash</div><div class="line"><a name="l00039"></a><span class="lineno"> 39</span>&#160;roslaunch beginner_tutorials LaunchTalkerListener.launch frequency:=&lt;desired-frequency&gt;</div><div class="line"><a name="l00040"></a><span class="lineno"> 40</span>&#160;```</div><div class="line"><a name="l00041"></a><span class="lineno"> 41</span>&#160;This command will launch published and subscriber.</div><div class="line"><a name="l00042"></a><span class="lineno"> 42</span>&#160;</div><div class="line"><a name="l00043"></a><span class="lineno"> 43</span>&#160;#### To run service</div><div class="line"><a name="l00044"></a><span class="lineno"> 44</span>&#160;```bash</div><div class="line"><a name="l00045"></a><span class="lineno"> 45</span>&#160;rosservice call /ServiceFile &quot;&lt;desired-custom-message&gt;&quot;</div><div class="line"><a name="l00046"></a><span class="lineno"> 46</span>&#160;```</div><div class="line"><a name="l00047"></a><span class="lineno"> 47</span>&#160;</div><div class="line"><a name="l00048"></a><span class="lineno"> 48</span>&#160;#### To invoke rqt logger and console on separate terminals run the following two commands</div><div class="line"><a name="l00049"></a><span class="lineno"> 49</span>&#160;```bash</div><div class="line"><a name="l00050"></a><span class="lineno"> 50</span>&#160;rosrun rqt_console rqt_console</div><div class="line"><a name="l00051"></a><span class="lineno"> 51</span>&#160;rosrun rqt_logger_level rqt_logger_level</div><div class="line"><a name="l00052"></a><span class="lineno"> 52</span>&#160;```</div><div class="line"><a name="l00053"></a><span class="lineno"> 53</span>&#160;</div><div class="line"><a name="l00054"></a><span class="lineno"> 54</span>&#160;</div><div class="line"><a name="l00055"></a><span class="lineno"> 55</span>&#160;## Plugins</div><div class="line"><a name="l00056"></a><span class="lineno"> 56</span>&#160;</div><div class="line"><a name="l00057"></a><span class="lineno"> 57</span>&#160;</div><div class="line"><a name="l00058"></a><span class="lineno"> 58</span>&#160;- CppCheckEclipse</div><div class="line"><a name="l00059"></a><span class="lineno"> 59</span>&#160;</div><div class="line"><a name="l00060"></a><span class="lineno"> 60</span>&#160; To install and run cppcheck in Eclipse</div><div class="line"><a name="l00061"></a><span class="lineno"> 61</span>&#160;</div><div class="line"><a name="l00062"></a><span class="lineno"> 62</span>&#160; 1. In Eclipse, go to Window -&gt; Preferences -&gt; C/C++ -&gt; cppcheclipse.</div><div class="line"><a name="l00063"></a><span class="lineno"> 63</span>&#160; Set cppcheck binary path to &quot;/usr/bin/cppcheck&quot;.</div><div class="line"><a name="l00064"></a><span class="lineno"> 64</span>&#160;</div><div class="line"><a name="l00065"></a><span class="lineno"> 65</span>&#160; 2. To run CPPCheck on a project, right-click on the project name in the Project Explorer </div><div class="line"><a name="l00066"></a><span class="lineno"> 66</span>&#160; and choose cppcheck -&gt; Run cppcheck.</div><div class="line"><a name="l00067"></a><span class="lineno"> 67</span>&#160; </div><div class="line"><a name="l00068"></a><span class="lineno"> 68</span>&#160; 3. To run on terminal</div><div class="line"><a name="l00069"></a><span class="lineno"> 69</span>&#160; ```bash</div><div class="line"><a name="l00070"></a><span class="lineno"> 70</span>&#160; cppcheck --enable=all --std=c++11 -I include/ --suppress=missingIncludeSystem $( find . -name *.cpp -or -name *.h | grep -vE -e &quot;^./build/&quot; -e &quot;^./vendor/&quot;) &gt; Results/cppcheckoutput.xml</div><div class="line"><a name="l00071"></a><span class="lineno"> 71</span>&#160; ```</div><div class="line"><a name="l00072"></a><span class="lineno"> 72</span>&#160; Results are present at Results/cppcheckoutput.xml</div><div class="line"><a name="l00073"></a><span class="lineno"> 73</span>&#160; </div><div class="line"><a name="l00074"></a><span class="lineno"> 74</span>&#160;- Cpplint</div><div class="line"><a name="l00075"></a><span class="lineno"> 75</span>&#160; 1. To run cpplint on terminal</div><div class="line"><a name="l00076"></a><span class="lineno"> 76</span>&#160; ```bash</div><div class="line"><a name="l00077"></a><span class="lineno"> 77</span>&#160; cpplint $( find . -name *.cpp | grep -vE -e &quot;^./build/&quot; -e &quot;^./vendor/&quot;) $( find . -name *.hpp | grep -vE -e &quot;^./build/&quot; -e &quot;^./vendor/&quot;) &gt; Results/cpplintoutput.txt</div><div class="line"><a name="l00078"></a><span class="lineno"> 78</span>&#160; ```</div><div class="line"><a name="l00079"></a><span class="lineno"> 79</span>&#160; Results are present at Results/cpplintoutput.xml</div><div class="line"><a name="l00080"></a><span class="lineno"> 80</span>&#160;</div><div class="line"><a name="l00081"></a><span class="lineno"> 81</span>&#160;- Google C++ Style</div><div class="line"><a name="l00082"></a><span class="lineno"> 82</span>&#160;</div><div class="line"><a name="l00083"></a><span class="lineno"> 83</span>&#160; To include and use Google C++ Style formatter in Eclipse</div><div class="line"><a name="l00084"></a><span class="lineno"> 84</span>&#160;</div><div class="line"><a name="l00085"></a><span class="lineno"> 85</span>&#160; 1. In Eclipse, go to Window -&gt; Preferences -&gt; C/C++ -&gt; Code Style -&gt; Formatter. </div><div class="line"><a name="l00086"></a><span class="lineno"> 86</span>&#160; Import [eclipse-cpp-google-style][reference-id-for-eclipse-cpp-google-style] and apply.</div><div class="line"><a name="l00087"></a><span class="lineno"> 87</span>&#160;</div><div class="line"><a name="l00088"></a><span class="lineno"> 88</span>&#160; 2. To use Google C++ style formatter, right-click on the source code or folder in </div><div class="line"><a name="l00089"></a><span class="lineno"> 89</span>&#160; Project Explorer and choose Source -&gt; Format</div><div class="line"><a name="l00090"></a><span class="lineno"> 90</span>&#160;</div><div class="line"><a name="l00091"></a><span class="lineno"> 91</span>&#160;[reference-id-for-eclipse-cpp-google-style]: https://raw.githubusercontent.com/google/styleguide/gh-pages/eclipse-cpp-google-style.xml</div><div class="line"><a name="l00092"></a><span class="lineno"> 92</span>&#160;</div><div class="line"><a name="l00093"></a><span class="lineno"> 93</span>&#160;- Doxygen</div><div class="line"><a name="l00094"></a><span class="lineno"> 94</span>&#160;</div><div class="line"><a name="l00095"></a><span class="lineno"> 95</span>&#160; The HTML page for project outlines can be generated using the following commands</div><div class="line"><a name="l00096"></a><span class="lineno"> 96</span>&#160;</div><div class="line"><a name="l00097"></a><span class="lineno"> 97</span>&#160; 1. doxygen -g</div><div class="line"><a name="l00098"></a><span class="lineno"> 98</span>&#160; 2. doxygen Doxyfile</div><div class="line"><a name="l00099"></a><span class="lineno"> 99</span>&#160;</div><div class="line"><a name="l00100"></a><span class="lineno"> 100</span>&#160;</div><div class="line"><a name="l00101"></a><span class="lineno"> 101</span>&#160;## Licensing</div><div class="line"><a name="l00102"></a><span class="lineno"> 102</span>&#160;The project is licensed under [MIT License](https://opensource.org/licenses/MIT). Click [here](https://github.com/kavyadevd/beginner_tutorials/blob/main/LICENSE) to know more</div></div><!-- fragment --></div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated by &#160;<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/>
</a> 1.8.13
</small></address>
</body>
</html>
Binary file added docs/html/bc_s.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/html/bdwn.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/html/closed.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/html/doc.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading

0 comments on commit 27c137f

Please sign in to comment.