Skip to content

Commit 360c8e1

Browse files
NuwanJNuwanJ
authored
Release 1.0.2 (#6)
* Added the Release badge * Entry Point update * VS Code Launch Template added * Implemented the minimum execution time for loop() cycle of 1 second * Added JavaDocs Annotations * Implemented new control methods on MotionController
1 parent fc8268d commit 360c8e1

File tree

158 files changed

+10051
-965
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

158 files changed

+10051
-965
lines changed

‎docs/Robots/MyTestRobot.html‎

Lines changed: 20 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -2,9 +2,9 @@
22
<!-- NewPage -->
33
<html lang="en">
44
<head>
5-
<!-- Generated by javadoc (1.8.0_77) on Fri Jul 28 22:47:34 IST 2023 -->
5+
<!-- Generated by javadoc (1.8.0_77) on Fri Aug 04 19:59:39 IST 2023 -->
66
<title>MyTestRobot</title>
7-
<meta name="date" content="2023-07-28">
7+
<meta name="date" content="2023-08-04">
88
<link rel="stylesheet" type="text/css" href="../stylesheet.css" title="Style">
99
<script type="text/javascript" src="../script.js"></script>
1010
</head>
@@ -40,6 +40,7 @@
4040
<li><a href="../overview-summary.html">Overview</a></li>
4141
<li><a href="package-summary.html">Package</a></li>
4242
<li class="navBarCell1Rev">Class</li>
43+
<li><a href="class-use/MyTestRobot.html">Use</a></li>
4344
<li><a href="package-tree.html">Tree</a></li>
4445
<li><a href="../deprecated-list.html">Deprecated</a></li>
4546
<li><a href="../index-files/index-1.html">Index</a></li>
@@ -194,23 +195,29 @@ <h3>Method Summary</h3>
194195
</tr>
195196
<tr id="i0" class="altColor">
196197
<td class="colFirst"><code>void</code></td>
197-
<td class="colLast"><code><span class="memberNameLink"><a href="../Robots/MyTestRobot.html#communicationInterrupt-java.lang.String-">communicationInterrupt</a></span>(java.lang.String&nbsp;msg)</code>&nbsp;</td>
198+
<td class="colLast"><code><span class="memberNameLink"><a href="../Robots/MyTestRobot.html#communicationInterrupt-java.lang.String-">communicationInterrupt</a></span>(java.lang.String&nbsp;msg)</code>
199+
<div class="block">Handle communicationInterrupt triggers of the robot</div>
200+
</td>
198201
</tr>
199202
<tr id="i1" class="rowColor">
200203
<td class="colFirst"><code>void</code></td>
201-
<td class="colLast"><code><span class="memberNameLink"><a href="../Robots/MyTestRobot.html#loop--">loop</a></span>()</code>&nbsp;</td>
204+
<td class="colLast"><code><span class="memberNameLink"><a href="../Robots/MyTestRobot.html#loop--">loop</a></span>()</code>
205+
<div class="block">Handles the event loop of the robot</div>
206+
</td>
202207
</tr>
203208
<tr id="i2" class="altColor">
204209
<td class="colFirst"><code>void</code></td>
205-
<td class="colLast"><code><span class="memberNameLink"><a href="../Robots/MyTestRobot.html#setup--">setup</a></span>()</code>&nbsp;</td>
210+
<td class="colLast"><code><span class="memberNameLink"><a href="../Robots/MyTestRobot.html#setup--">setup</a></span>()</code>
211+
<div class="block">Setup the modules, emulators and indicators</div>
212+
</td>
206213
</tr>
207214
</table>
208215
<ul class="blockList">
209216
<li class="blockList"><a name="methods.inherited.from.class.swarm.robot.VirtualRobot">
210217
<!-- -->
211218
</a>
212219
<h3>Methods inherited from class&nbsp;swarm.robot.<a href="../swarm/robot/VirtualRobot.html" title="class in swarm.robot">VirtualRobot</a></h3>
213-
<code><a href="../swarm/robot/VirtualRobot.html#interrupt--">interrupt</a>, <a href="../swarm/robot/VirtualRobot.html#sensorInterrupt-java.lang.String-java.lang.String-">sensorInterrupt</a></code></li>
220+
<code><a href="../swarm/robot/VirtualRobot.html#sensorInterrupt-java.lang.String-java.lang.String-">sensorInterrupt</a></code></li>
214221
</ul>
215222
<ul class="blockList">
216223
<li class="blockList"><a name="methods.inherited.from.class.swarm.robot.Robot">
@@ -267,6 +274,8 @@ <h3>Method Detail</h3>
267274
<li class="blockList">
268275
<h4>setup</h4>
269276
<pre>public&nbsp;void&nbsp;setup()</pre>
277+
<div class="block"><span class="descfrmTypeLabel">Description copied from class:&nbsp;<code><a href="../swarm/robot/Robot.html#setup--">Robot</a></code></span></div>
278+
<div class="block">Setup the modules, emulators and indicators</div>
270279
<dl>
271280
<dt><span class="overrideSpecifyLabel">Overrides:</span></dt>
272281
<dd><code><a href="../swarm/robot/Robot.html#setup--">setup</a></code>&nbsp;in class&nbsp;<code><a href="../swarm/robot/Robot.html" title="class in swarm.robot">Robot</a></code></dd>
@@ -281,6 +290,8 @@ <h4>setup</h4>
281290
<h4>loop</h4>
282291
<pre>public&nbsp;void&nbsp;loop()
283292
throws java.lang.Exception</pre>
293+
<div class="block"><span class="descfrmTypeLabel">Description copied from class:&nbsp;<code><a href="../swarm/robot/VirtualRobot.html#loop--">VirtualRobot</a></code></span></div>
294+
<div class="block">Handles the event loop of the robot</div>
284295
<dl>
285296
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
286297
<dd><code><a href="../swarm/Interfaces/IRobotState.html#loop--">loop</a></code>&nbsp;in interface&nbsp;<code><a href="../swarm/Interfaces/IRobotState.html" title="interface in swarm.Interfaces">IRobotState</a></code></dd>
@@ -298,6 +309,8 @@ <h4>loop</h4>
298309
<li class="blockList">
299310
<h4>communicationInterrupt</h4>
300311
<pre>public&nbsp;void&nbsp;communicationInterrupt(java.lang.String&nbsp;msg)</pre>
312+
<div class="block"><span class="descfrmTypeLabel">Description copied from class:&nbsp;<code><a href="../swarm/robot/VirtualRobot.html#communicationInterrupt-java.lang.String-">VirtualRobot</a></code></span></div>
313+
<div class="block">Handle communicationInterrupt triggers of the robot</div>
301314
<dl>
302315
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
303316
<dd><code><a href="../swarm/Interfaces/IRobotState.html#communicationInterrupt-java.lang.String-">communicationInterrupt</a></code>&nbsp;in interface&nbsp;<code><a href="../swarm/Interfaces/IRobotState.html" title="interface in swarm.Interfaces">IRobotState</a></code></dd>
@@ -325,6 +338,7 @@ <h4>communicationInterrupt</h4>
325338
<li><a href="../overview-summary.html">Overview</a></li>
326339
<li><a href="package-summary.html">Package</a></li>
327340
<li class="navBarCell1Rev">Class</li>
341+
<li><a href="class-use/MyTestRobot.html">Use</a></li>
328342
<li><a href="package-tree.html">Tree</a></li>
329343
<li><a href="../deprecated-list.html">Deprecated</a></li>
330344
<li><a href="../index-files/index-1.html">Index</a></li>

‎docs/Robots/class-use/MyTestRobot.html‎

Lines changed: 124 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,124 @@
1+
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
2+
<!-- NewPage -->
3+
<html lang="en">
4+
<head>
5+
<!-- Generated by javadoc (1.8.0_77) on Fri Aug 04 19:59:40 IST 2023 -->
6+
<title>Uses of Class Robots.MyTestRobot</title>
7+
<meta name="date" content="2023-08-04">
8+
<link rel="stylesheet" type="text/css" href="../../stylesheet.css" title="Style">
9+
<script type="text/javascript" src="../../script.js"></script>
10+
</head>
11+
<body>
12+
<script type="text/javascript"><!--
13+
try {
14+
if (location.href.indexOf('is-external=true') == -1) {
15+
parent.document.title="Uses of Class Robots.MyTestRobot";
16+
}
17+
}
18+
catch(err) {
19+
}
20+
//-->
21+
</script>
22+
<noscript>
23+
<div>JavaScript is disabled on your browser.</div>
24+
</noscript>
25+
<!-- ========= START OF TOP NAVBAR ======= -->
26+
<div class="topNav"><a name="navbar.top">
27+
<!-- -->
28+
</a>
29+
<div class="skipNav"><a href="#skip.navbar.top" title="Skip navigation links">Skip navigation links</a></div>
30+
<a name="navbar.top.firstrow">
31+
<!-- -->
32+
</a>
33+
<ul class="navList" title="Navigation">
34+
<li><a href="../../overview-summary.html">Overview</a></li>
35+
<li><a href="../package-summary.html">Package</a></li>
36+
<li><a href="../../Robots/MyTestRobot.html" title="class in Robots">Class</a></li>
37+
<li class="navBarCell1Rev">Use</li>
38+
<li><a href="../../overview-tree.html">Tree</a></li>
39+
<li><a href="../../deprecated-list.html">Deprecated</a></li>
40+
<li><a href="../../index-files/index-1.html">Index</a></li>
41+
<li><a href="../../help-doc.html">Help</a></li>
42+
</ul>
43+
</div>
44+
<div class="subNav">
45+
<ul class="navList">
46+
<li>Prev</li>
47+
<li>Next</li>
48+
</ul>
49+
<ul class="navList">
50+
<li><a href="../../index.html?Robots/class-use/MyTestRobot.html" target="_top">Frames</a></li>
51+
<li><a href="MyTestRobot.html" target="_top">No&nbsp;Frames</a></li>
52+
</ul>
53+
<ul class="navList" id="allclasses_navbar_top">
54+
<li><a href="../../allclasses-noframe.html">All&nbsp;Classes</a></li>
55+
</ul>
56+
<div>
57+
<script type="text/javascript"><!--
58+
allClassesLink = document.getElementById("allclasses_navbar_top");
59+
if(window==top) {
60+
allClassesLink.style.display = "block";
61+
}
62+
else {
63+
allClassesLink.style.display = "none";
64+
}
65+
//-->
66+
</script>
67+
</div>
68+
<a name="skip.navbar.top">
69+
<!-- -->
70+
</a></div>
71+
<!-- ========= END OF TOP NAVBAR ========= -->
72+
<div class="header">
73+
<h2 title="Uses of Class Robots.MyTestRobot" class="title">Uses of Class<br>Robots.MyTestRobot</h2>
74+
</div>
75+
<div class="classUseContainer">No usage of Robots.MyTestRobot</div>
76+
<!-- ======= START OF BOTTOM NAVBAR ====== -->
77+
<div class="bottomNav"><a name="navbar.bottom">
78+
<!-- -->
79+
</a>
80+
<div class="skipNav"><a href="#skip.navbar.bottom" title="Skip navigation links">Skip navigation links</a></div>
81+
<a name="navbar.bottom.firstrow">
82+
<!-- -->
83+
</a>
84+
<ul class="navList" title="Navigation">
85+
<li><a href="../../overview-summary.html">Overview</a></li>
86+
<li><a href="../package-summary.html">Package</a></li>
87+
<li><a href="../../Robots/MyTestRobot.html" title="class in Robots">Class</a></li>
88+
<li class="navBarCell1Rev">Use</li>
89+
<li><a href="../../overview-tree.html">Tree</a></li>
90+
<li><a href="../../deprecated-list.html">Deprecated</a></li>
91+
<li><a href="../../index-files/index-1.html">Index</a></li>
92+
<li><a href="../../help-doc.html">Help</a></li>
93+
</ul>
94+
</div>
95+
<div class="subNav">
96+
<ul class="navList">
97+
<li>Prev</li>
98+
<li>Next</li>
99+
</ul>
100+
<ul class="navList">
101+
<li><a href="../../index.html?Robots/class-use/MyTestRobot.html" target="_top">Frames</a></li>
102+
<li><a href="MyTestRobot.html" target="_top">No&nbsp;Frames</a></li>
103+
</ul>
104+
<ul class="navList" id="allclasses_navbar_bottom">
105+
<li><a href="../../allclasses-noframe.html">All&nbsp;Classes</a></li>
106+
</ul>
107+
<div>
108+
<script type="text/javascript"><!--
109+
allClassesLink = document.getElementById("allclasses_navbar_bottom");
110+
if(window==top) {
111+
allClassesLink.style.display = "block";
112+
}
113+
else {
114+
allClassesLink.style.display = "none";
115+
}
116+
//-->
117+
</script>
118+
</div>
119+
<a name="skip.navbar.bottom">
120+
<!-- -->
121+
</a></div>
122+
<!-- ======== END OF BOTTOM NAVBAR ======= -->
123+
</body>
124+
</html>

‎docs/Robots/package-frame.html‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -2,9 +2,9 @@
22
<!-- NewPage -->
33
<html lang="en">
44
<head>
5-
<!-- Generated by javadoc (1.8.0_77) on Fri Jul 28 22:47:34 IST 2023 -->
5+
<!-- Generated by javadoc (1.8.0_77) on Fri Aug 04 19:59:39 IST 2023 -->
66
<title>Robots</title>
7-
<meta name="date" content="2023-07-28">
7+
<meta name="date" content="2023-08-04">
88
<link rel="stylesheet" type="text/css" href="../stylesheet.css" title="Style">
99
<script type="text/javascript" src="../script.js"></script>
1010
</head>

‎docs/Robots/package-summary.html‎

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -2,9 +2,9 @@
22
<!-- NewPage -->
33
<html lang="en">
44
<head>
5-
<!-- Generated by javadoc (1.8.0_77) on Fri Jul 28 22:47:34 IST 2023 -->
5+
<!-- Generated by javadoc (1.8.0_77) on Fri Aug 04 19:59:39 IST 2023 -->
66
<title>Robots</title>
7-
<meta name="date" content="2023-07-28">
7+
<meta name="date" content="2023-08-04">
88
<link rel="stylesheet" type="text/css" href="../stylesheet.css" title="Style">
99
<script type="text/javascript" src="../script.js"></script>
1010
</head>
@@ -34,6 +34,7 @@
3434
<li><a href="../overview-summary.html">Overview</a></li>
3535
<li class="navBarCell1Rev">Package</li>
3636
<li>Class</li>
37+
<li><a href="package-use.html">Use</a></li>
3738
<li><a href="package-tree.html">Tree</a></li>
3839
<li><a href="../deprecated-list.html">Deprecated</a></li>
3940
<li><a href="../index-files/index-1.html">Index</a></li>
@@ -102,6 +103,7 @@ <h1 title="Package" class="title">Package&nbsp;Robots</h1>
102103
<li><a href="../overview-summary.html">Overview</a></li>
103104
<li class="navBarCell1Rev">Package</li>
104105
<li>Class</li>
106+
<li><a href="package-use.html">Use</a></li>
105107
<li><a href="package-tree.html">Tree</a></li>
106108
<li><a href="../deprecated-list.html">Deprecated</a></li>
107109
<li><a href="../index-files/index-1.html">Index</a></li>

‎docs/Robots/package-tree.html‎

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -2,9 +2,9 @@
22
<!-- NewPage -->
33
<html lang="en">
44
<head>
5-
<!-- Generated by javadoc (1.8.0_77) on Fri Jul 28 22:47:34 IST 2023 -->
5+
<!-- Generated by javadoc (1.8.0_77) on Fri Aug 04 19:59:39 IST 2023 -->
66
<title>Robots Class Hierarchy</title>
7-
<meta name="date" content="2023-07-28">
7+
<meta name="date" content="2023-08-04">
88
<link rel="stylesheet" type="text/css" href="../stylesheet.css" title="Style">
99
<script type="text/javascript" src="../script.js"></script>
1010
</head>
@@ -34,6 +34,7 @@
3434
<li><a href="../overview-summary.html">Overview</a></li>
3535
<li><a href="package-summary.html">Package</a></li>
3636
<li>Class</li>
37+
<li>Use</li>
3738
<li class="navBarCell1Rev">Tree</li>
3839
<li><a href="../deprecated-list.html">Deprecated</a></li>
3940
<li><a href="../index-files/index-1.html">Index</a></li>
@@ -105,6 +106,7 @@ <h2 title="Class Hierarchy">Class Hierarchy</h2>
105106
<li><a href="../overview-summary.html">Overview</a></li>
106107
<li><a href="package-summary.html">Package</a></li>
107108
<li>Class</li>
109+
<li>Use</li>
108110
<li class="navBarCell1Rev">Tree</li>
109111
<li><a href="../deprecated-list.html">Deprecated</a></li>
110112
<li><a href="../index-files/index-1.html">Index</a></li>

0 commit comments

Comments
 (0)