From 055554eccf048afcada5c5ec736c543924a7b168 Mon Sep 17 00:00:00 2001 From: Nuwan Jaliyagoda Date: Fri, 8 Sep 2023 19:44:24 +0530 Subject: [PATCH] Documentation updates --- docs/Robots/MyTestRobot.html | 4 +- docs/Robots/class-use/MyTestRobot.html | 4 +- docs/Robots/package-frame.html | 4 +- docs/Robots/package-summary.html | 4 +- docs/Robots/package-tree.html | 4 +- docs/Robots/package-use.html | 4 +- docs/allclasses-frame.html | 4 +- docs/allclasses-noframe.html | 4 +- docs/constant-values.html | 4 +- docs/deprecated-list.html | 4 +- docs/help-doc.html | 4 +- docs/index-files/index-1.html | 4 +- docs/index-files/index-10.html | 4 +- docs/index-files/index-11.html | 16 +- docs/index-files/index-12.html | 4 +- docs/index-files/index-13.html | 16 +- docs/index-files/index-14.html | 20 ++- docs/index-files/index-15.html | 12 +- docs/index-files/index-16.html | 4 +- docs/index-files/index-17.html | 4 +- docs/index-files/index-2.html | 12 +- docs/index-files/index-3.html | 6 +- docs/index-files/index-4.html | 20 ++- docs/index-files/index-5.html | 4 +- docs/index-files/index-6.html | 4 +- docs/index-files/index-7.html | 4 +- docs/index-files/index-8.html | 4 +- docs/index-files/index-9.html | 4 +- docs/index.html | 2 +- docs/overview-frame.html | 4 +- docs/overview-summary.html | 4 +- docs/overview-tree.html | 4 +- docs/serialized-form.html | 4 +- docs/swarm/App.html | 4 +- docs/swarm/AppTest.html | 4 +- docs/swarm/Interfaces/IMqttHandler.html | 4 +- docs/swarm/Interfaces/IRobotState.html | 4 +- .../Interfaces/IRobotState.robotState.html | 4 +- .../Interfaces/class-use/IMqttHandler.html | 4 +- .../Interfaces/class-use/IRobotState.html | 4 +- .../class-use/IRobotState.robotState.html | 4 +- docs/swarm/Interfaces/package-frame.html | 4 +- docs/swarm/Interfaces/package-summary.html | 4 +- docs/swarm/Interfaces/package-tree.html | 4 +- docs/swarm/Interfaces/package-use.html | 4 +- docs/swarm/class-use/App.html | 4 +- docs/swarm/class-use/AppTest.html | 4 +- docs/swarm/configs/MQTTSettings.html | 4 +- docs/swarm/configs/MQTTSettingsTest.html | 4 +- docs/swarm/configs/RobotSettings.html | 4 +- .../swarm/configs/class-use/MQTTSettings.html | 4 +- .../configs/class-use/MQTTSettingsTest.html | 4 +- .../configs/class-use/RobotSettings.html | 4 +- docs/swarm/configs/package-frame.html | 4 +- docs/swarm/configs/package-summary.html | 4 +- docs/swarm/configs/package-tree.html | 4 +- docs/swarm/configs/package-use.html | 4 +- docs/swarm/mqtt/MqttMsg.html | 4 +- docs/swarm/mqtt/RobotMqttClient.html | 44 ++++- docs/swarm/mqtt/class-use/MqttMsg.html | 4 +- .../swarm/mqtt/class-use/RobotMqttClient.html | 11 +- docs/swarm/mqtt/package-frame.html | 4 +- docs/swarm/mqtt/package-summary.html | 4 +- docs/swarm/mqtt/package-tree.html | 4 +- docs/swarm/mqtt/package-use.html | 4 +- docs/swarm/package-frame.html | 4 +- docs/swarm/package-summary.html | 4 +- docs/swarm/package-tree.html | 4 +- docs/swarm/package-use.html | 4 +- docs/swarm/robot/Robot.html | 4 +- docs/swarm/robot/VirtualRobot.html | 4 +- docs/swarm/robot/class-use/Robot.html | 11 +- docs/swarm/robot/class-use/VirtualRobot.html | 4 +- .../robot/communication/Communication.html | 4 +- .../communication/DirectedCommunication.html | 4 +- .../communication/SimpleCommunication.html | 4 +- .../class-use/Communication.html | 4 +- .../class-use/DirectedCommunication.html | 4 +- .../class-use/SimpleCommunication.html | 4 +- .../robot/communication/package-frame.html | 4 +- .../robot/communication/package-summary.html | 4 +- .../robot/communication/package-tree.html | 4 +- .../robot/communication/package-use.html | 4 +- .../exception/MotionControllerException.html | 4 +- .../robot/exception/MqttClientException.html | 4 +- .../robot/exception/ProximityException.html | 4 +- .../robot/exception/RGBColorException.html | 4 +- .../robot/exception/SensorException.html | 4 +- .../class-use/MotionControllerException.html | 4 +- .../class-use/MqttClientException.html | 4 +- .../class-use/ProximityException.html | 7 +- .../class-use/RGBColorException.html | 4 +- .../exception/class-use/SensorException.html | 4 +- docs/swarm/robot/exception/package-frame.html | 4 +- .../robot/exception/package-summary.html | 4 +- docs/swarm/robot/exception/package-tree.html | 4 +- docs/swarm/robot/exception/package-use.html | 4 +- docs/swarm/robot/helpers/Coordinate.html | 4 +- .../swarm/robot/helpers/MotionController.html | 4 +- docs/swarm/robot/helpers/RobotMQTT.html | 4 +- .../robot/helpers/class-use/Coordinate.html | 4 +- .../helpers/class-use/MotionController.html | 4 +- .../robot/helpers/class-use/RobotMQTT.html | 4 +- docs/swarm/robot/helpers/package-frame.html | 4 +- docs/swarm/robot/helpers/package-summary.html | 4 +- docs/swarm/robot/helpers/package-tree.html | 4 +- docs/swarm/robot/helpers/package-use.html | 4 +- .../robot/indicator/AbstractIndicator.html | 4 +- docs/swarm/robot/indicator/NeoPixel.html | 8 +- .../class-use/AbstractIndicator.html | 4 +- .../robot/indicator/class-use/NeoPixel.html | 4 +- docs/swarm/robot/indicator/package-frame.html | 4 +- .../robot/indicator/package-summary.html | 4 +- docs/swarm/robot/indicator/package-tree.html | 4 +- docs/swarm/robot/indicator/package-use.html | 4 +- docs/swarm/robot/package-frame.html | 4 +- docs/swarm/robot/package-summary.html | 4 +- docs/swarm/robot/package-tree.html | 4 +- docs/swarm/robot/package-use.html | 4 +- docs/swarm/robot/sensors/AbstractSensor.html | 4 +- docs/swarm/robot/sensors/ColorSensor.html | 4 +- docs/swarm/robot/sensors/DistanceSensor.html | 4 +- docs/swarm/robot/sensors/ProximitySensor.html | 51 +++++- .../sensors/class-use/AbstractSensor.html | 4 +- .../robot/sensors/class-use/ColorSensor.html | 4 +- .../sensors/class-use/DistanceSensor.html | 4 +- .../sensors/class-use/ProximitySensor.html | 4 +- docs/swarm/robot/sensors/package-frame.html | 4 +- docs/swarm/robot/sensors/package-summary.html | 4 +- docs/swarm/robot/sensors/package-tree.html | 4 +- docs/swarm/robot/sensors/package-use.html | 4 +- .../robot/types/ProximityReadingType.html | 62 ++++--- docs/swarm/robot/types/RGBColorType.html | 160 ++++++++++++++++-- .../types/class-use/ProximityReadingType.html | 4 +- .../robot/types/class-use/RGBColorType.html | 21 ++- docs/swarm/robot/types/package-frame.html | 4 +- docs/swarm/robot/types/package-summary.html | 4 +- docs/swarm/robot/types/package-tree.html | 4 +- docs/swarm/robot/types/package-use.html | 4 +- 139 files changed, 631 insertions(+), 336 deletions(-) diff --git a/docs/Robots/MyTestRobot.html b/docs/Robots/MyTestRobot.html index eb0d059..dfd64e0 100644 --- a/docs/Robots/MyTestRobot.html +++ b/docs/Robots/MyTestRobot.html @@ -2,9 +2,9 @@ - + MyTestRobot - + diff --git a/docs/Robots/class-use/MyTestRobot.html b/docs/Robots/class-use/MyTestRobot.html index 889c91f..3454af2 100644 --- a/docs/Robots/class-use/MyTestRobot.html +++ b/docs/Robots/class-use/MyTestRobot.html @@ -2,9 +2,9 @@ - + Uses of Class Robots.MyTestRobot - + diff --git a/docs/Robots/package-frame.html b/docs/Robots/package-frame.html index 08327d0..3618cd6 100644 --- a/docs/Robots/package-frame.html +++ b/docs/Robots/package-frame.html @@ -2,9 +2,9 @@ - + Robots - + diff --git a/docs/Robots/package-summary.html b/docs/Robots/package-summary.html index 1f5be0b..d5f5b30 100644 --- a/docs/Robots/package-summary.html +++ b/docs/Robots/package-summary.html @@ -2,9 +2,9 @@ - + Robots - + diff --git a/docs/Robots/package-tree.html b/docs/Robots/package-tree.html index 3d63b60..5da9257 100644 --- a/docs/Robots/package-tree.html +++ b/docs/Robots/package-tree.html @@ -2,9 +2,9 @@ - + Robots Class Hierarchy - + diff --git a/docs/Robots/package-use.html b/docs/Robots/package-use.html index 490892f..e465060 100644 --- a/docs/Robots/package-use.html +++ b/docs/Robots/package-use.html @@ -2,9 +2,9 @@ - + Uses of Package Robots - + diff --git a/docs/allclasses-frame.html b/docs/allclasses-frame.html index ff3b97d..3bacdc4 100644 --- a/docs/allclasses-frame.html +++ b/docs/allclasses-frame.html @@ -2,9 +2,9 @@ - + All Classes - + diff --git a/docs/allclasses-noframe.html b/docs/allclasses-noframe.html index 996343a..c74e69b 100644 --- a/docs/allclasses-noframe.html +++ b/docs/allclasses-noframe.html @@ -2,9 +2,9 @@ - + All Classes - + diff --git a/docs/constant-values.html b/docs/constant-values.html index 799f1cd..6b720ce 100644 --- a/docs/constant-values.html +++ b/docs/constant-values.html @@ -2,9 +2,9 @@ - + Constant Field Values - + diff --git a/docs/deprecated-list.html b/docs/deprecated-list.html index f36b52c..4de544d 100644 --- a/docs/deprecated-list.html +++ b/docs/deprecated-list.html @@ -2,9 +2,9 @@ - + Deprecated List - + diff --git a/docs/help-doc.html b/docs/help-doc.html index dc23f63..a386891 100644 --- a/docs/help-doc.html +++ b/docs/help-doc.html @@ -2,9 +2,9 @@ - + API Help - + diff --git a/docs/index-files/index-1.html b/docs/index-files/index-1.html index 02f06e1..92d2e48 100644 --- a/docs/index-files/index-1.html +++ b/docs/index-files/index-1.html @@ -2,9 +2,9 @@ - + A-Index - + diff --git a/docs/index-files/index-10.html b/docs/index-files/index-10.html index 7dc0f9d..b264e42 100644 --- a/docs/index-files/index-10.html +++ b/docs/index-files/index-10.html @@ -2,9 +2,9 @@ - + O-Index - + diff --git a/docs/index-files/index-11.html b/docs/index-files/index-11.html index 3e73956..e65217e 100644 --- a/docs/index-files/index-11.html +++ b/docs/index-files/index-11.html @@ -2,9 +2,9 @@ - + P-Index - + @@ -90,9 +90,7 @@

P

 
ProximityReadingType - Class in swarm.robot.types
 
-
ProximityReadingType(String) - Constructor for class swarm.robot.types.ProximityReadingType
-
 
-
ProximityReadingType(int, int, int, int, int) - Constructor for class swarm.robot.types.ProximityReadingType
+
ProximityReadingType(int[], String) - Constructor for class swarm.robot.types.ProximityReadingType
 
proximitySensor - Variable in class swarm.robot.Robot
 
@@ -104,10 +102,18 @@

P

ProximitySensor class
+
ProximitySensor(Robot, int[], RobotMqttClient) - Constructor for class swarm.robot.sensors.ProximitySensor
+
+
ProximitySensor class
+
publish(String, String) - Method in class swarm.mqtt.RobotMqttClient
 
publish(String, String, int) - Method in class swarm.mqtt.RobotMqttClient
 
+
publish(String, String, boolean) - Method in class swarm.mqtt.RobotMqttClient
+
 
+
publish(String, String, int, boolean) - Method in class swarm.mqtt.RobotMqttClient
+
 
publishCoordinate() - Method in class swarm.robot.helpers.Coordinate
Publish current (x,y,heading) values to the MQTT channel
diff --git a/docs/index-files/index-12.html b/docs/index-files/index-12.html index 8b36279..36e5adb 100644 --- a/docs/index-files/index-12.html +++ b/docs/index-files/index-12.html @@ -2,9 +2,9 @@ - + Q-Index - + diff --git a/docs/index-files/index-13.html b/docs/index-files/index-13.html index 82057c0..05120cc 100644 --- a/docs/index-files/index-13.html +++ b/docs/index-files/index-13.html @@ -2,9 +2,9 @@ - + R-Index - + @@ -93,7 +93,17 @@

R

RGBColorType - Class in swarm.robot.types
 
RGBColorType(int, int, int) - Constructor for class swarm.robot.types.RGBColorType
-
 
+
+
RGBColorType class
+
+
RGBColorType(int[]) - Constructor for class swarm.robot.types.RGBColorType
+
+
RGBColorType class
+
+
RGBColorType(String) - Constructor for class swarm.robot.types.RGBColorType
+
+
RGBColorType class
+
robot - Variable in class swarm.robot.indicator.AbstractIndicator
 
Robot - Class in swarm.robot
diff --git a/docs/index-files/index-14.html b/docs/index-files/index-14.html index e7419f4..12b21a4 100644 --- a/docs/index-files/index-14.html +++ b/docs/index-files/index-14.html @@ -2,9 +2,9 @@ - + S-Index - + @@ -117,10 +117,22 @@

S

 
serverIPTest() - Method in class swarm.configs.MQTTSettingsTest
 
+
setAngles(int[]) - Method in class swarm.robot.sensors.ProximitySensor
+
+
Set the proximity sensor angles
+
setColor(String) - Method in class swarm.robot.types.RGBColorType
-
 
+
+
Set a color
+
setColor(int, int, int) - Method in class swarm.robot.types.RGBColorType
-
 
+
+
Set a color
+
+
setColorFromHexCode(String) - Method in class swarm.robot.types.RGBColorType
+
+
Set a color using hexadecimal code
+
setCoordinate(double, double) - Method in class swarm.robot.helpers.Coordinate
Set robot's current (x,y) coordinate
diff --git a/docs/index-files/index-15.html b/docs/index-files/index-15.html index 03ef3f7..fd5db03 100644 --- a/docs/index-files/index-15.html +++ b/docs/index-files/index-15.html @@ -2,9 +2,9 @@ - + T-Index - + @@ -85,9 +85,13 @@

T

toString() - Method in class swarm.robot.types.ProximityReadingType
 
toString() - Method in class swarm.robot.types.RGBColorType
-
 
+
+
return color components as a string
+
toStringColor() - Method in class swarm.robot.types.RGBColorType
-
 
+
+
return color components as a string
+
A C D G H I L M N O P Q R S T U V  diff --git a/docs/index-files/index-16.html b/docs/index-files/index-16.html index 50b6a64..a94a5e6 100644 --- a/docs/index-files/index-16.html +++ b/docs/index-files/index-16.html @@ -2,9 +2,9 @@ - + U-Index - + diff --git a/docs/index-files/index-17.html b/docs/index-files/index-17.html index 9b58979..eee17ef 100644 --- a/docs/index-files/index-17.html +++ b/docs/index-files/index-17.html @@ -2,9 +2,9 @@ - + V-Index - + diff --git a/docs/index-files/index-2.html b/docs/index-files/index-2.html index 1f3d1c9..808d460 100644 --- a/docs/index-files/index-2.html +++ b/docs/index-files/index-2.html @@ -2,9 +2,9 @@ - + C-Index - + @@ -76,10 +76,12 @@

C

changeColor(int, int, int) - Method in class swarm.robot.indicator.NeoPixel
-
Change the color of the NeoPixel Ring
+
Change the color of the NeoPixel Ring (inform the server and GUI)
channel - Static variable in class swarm.configs.MQTTSettings
 
+
colors() - Method in class swarm.robot.types.ProximityReadingType
+
 
colorSensor - Variable in class swarm.robot.Robot
 
ColorSensor - Class in swarm.robot.sensors
@@ -105,7 +107,9 @@

C

compareTo(MqttMsg) - Method in class swarm.mqtt.MqttMsg
 
compareTo(RGBColorType) - Method in class swarm.robot.types.RGBColorType
-
 
+
+
compare the color with another RGBColorType object
+
connect() - Method in class swarm.mqtt.RobotMqttClient
 
connectionLost(Throwable) - Method in class swarm.mqtt.RobotMqttClient
diff --git a/docs/index-files/index-3.html b/docs/index-files/index-3.html index 8dc05da..8580add 100644 --- a/docs/index-files/index-3.html +++ b/docs/index-files/index-3.html @@ -2,9 +2,9 @@ - + D-Index - + @@ -86,6 +86,8 @@

D

 
DirectedCommunication(int, RobotMqttClient) - Constructor for class swarm.robot.communication.DirectedCommunication
 
+
distances() - Method in class swarm.robot.types.ProximityReadingType
+
 
DistanceSensor - Class in swarm.robot.sensors
Distance Sensors Emulator class
diff --git a/docs/index-files/index-4.html b/docs/index-files/index-4.html index 60ce238..9b9289e 100644 --- a/docs/index-files/index-4.html +++ b/docs/index-files/index-4.html @@ -2,9 +2,9 @@ - + G-Index - + @@ -75,19 +75,25 @@

G

getB() - Method in class swarm.robot.types.RGBColorType
-
 
+
+
get G component of the color
+
getColor() - Method in class swarm.robot.sensors.ColorSensor
Get the emulated color sensor reading from the simulator
getColor() - Method in class swarm.robot.types.RGBColorType
-
 
+
+
get color as an array of R,G,B components
+
getDistance() - Method in class swarm.robot.sensors.DistanceSensor
Get the emulated distance sensor reading from the simulator
getG() - Method in class swarm.robot.types.RGBColorType
-
 
+
+
get B component of the color
+
getHeading() - Method in class swarm.robot.helpers.Coordinate
Get robot's current heading direction
@@ -105,7 +111,9 @@

G

Get the emulated proximity sensor reading from the simulator
getR() - Method in class swarm.robot.types.RGBColorType
-
 
+
+
get R component of the color
+
getX() - Method in class swarm.robot.helpers.Coordinate
Get robot's current X coordinate
diff --git a/docs/index-files/index-5.html b/docs/index-files/index-5.html index ec23494..4090014 100644 --- a/docs/index-files/index-5.html +++ b/docs/index-files/index-5.html @@ -2,9 +2,9 @@ - + H-Index - + diff --git a/docs/index-files/index-6.html b/docs/index-files/index-6.html index 83d3f4a..771493a 100644 --- a/docs/index-files/index-6.html +++ b/docs/index-files/index-6.html @@ -2,9 +2,9 @@ - + I-Index - + diff --git a/docs/index-files/index-7.html b/docs/index-files/index-7.html index 05b9a9d..43b4d34 100644 --- a/docs/index-files/index-7.html +++ b/docs/index-files/index-7.html @@ -2,9 +2,9 @@ - + L-Index - + diff --git a/docs/index-files/index-8.html b/docs/index-files/index-8.html index 2dcee32..dc8063a 100644 --- a/docs/index-files/index-8.html +++ b/docs/index-files/index-8.html @@ -2,9 +2,9 @@ - + M-Index - + diff --git a/docs/index-files/index-9.html b/docs/index-files/index-9.html index 9392cdb..e4a3214 100644 --- a/docs/index-files/index-9.html +++ b/docs/index-files/index-9.html @@ -2,9 +2,9 @@ - + N-Index - + diff --git a/docs/index.html b/docs/index.html index 643d2c7..e659651 100644 --- a/docs/index.html +++ b/docs/index.html @@ -2,7 +2,7 @@ - + Generated Documentation (Untitled) diff --git a/docs/overview-summary.html b/docs/overview-summary.html index 61a8555..9624d5e 100644 --- a/docs/overview-summary.html +++ b/docs/overview-summary.html @@ -2,9 +2,9 @@ - + Overview - + diff --git a/docs/overview-tree.html b/docs/overview-tree.html index 066166e..bc79746 100644 --- a/docs/overview-tree.html +++ b/docs/overview-tree.html @@ -2,9 +2,9 @@ - + Class Hierarchy - + diff --git a/docs/serialized-form.html b/docs/serialized-form.html index 5cea1f7..b7b9f20 100644 --- a/docs/serialized-form.html +++ b/docs/serialized-form.html @@ -2,9 +2,9 @@ - + Serialized Form - + diff --git a/docs/swarm/App.html b/docs/swarm/App.html index 5a0e2db..1940ca4 100644 --- a/docs/swarm/App.html +++ b/docs/swarm/App.html @@ -2,9 +2,9 @@ - + App - + diff --git a/docs/swarm/AppTest.html b/docs/swarm/AppTest.html index 8b16902..7635fac 100644 --- a/docs/swarm/AppTest.html +++ b/docs/swarm/AppTest.html @@ -2,9 +2,9 @@ - + AppTest - + diff --git a/docs/swarm/Interfaces/IMqttHandler.html b/docs/swarm/Interfaces/IMqttHandler.html index 3519749..0fd5818 100644 --- a/docs/swarm/Interfaces/IMqttHandler.html +++ b/docs/swarm/Interfaces/IMqttHandler.html @@ -2,9 +2,9 @@ - + IMqttHandler - + diff --git a/docs/swarm/Interfaces/IRobotState.html b/docs/swarm/Interfaces/IRobotState.html index c695ec7..0adfca6 100644 --- a/docs/swarm/Interfaces/IRobotState.html +++ b/docs/swarm/Interfaces/IRobotState.html @@ -2,9 +2,9 @@ - + IRobotState - + diff --git a/docs/swarm/Interfaces/IRobotState.robotState.html b/docs/swarm/Interfaces/IRobotState.robotState.html index a1e6003..ff36c00 100644 --- a/docs/swarm/Interfaces/IRobotState.robotState.html +++ b/docs/swarm/Interfaces/IRobotState.robotState.html @@ -2,9 +2,9 @@ - + IRobotState.robotState - + diff --git a/docs/swarm/Interfaces/class-use/IMqttHandler.html b/docs/swarm/Interfaces/class-use/IMqttHandler.html index 7922227..18831a3 100644 --- a/docs/swarm/Interfaces/class-use/IMqttHandler.html +++ b/docs/swarm/Interfaces/class-use/IMqttHandler.html @@ -2,9 +2,9 @@ - + Uses of Interface swarm.Interfaces.IMqttHandler - + diff --git a/docs/swarm/Interfaces/class-use/IRobotState.html b/docs/swarm/Interfaces/class-use/IRobotState.html index 9c5c94c..673bbdd 100644 --- a/docs/swarm/Interfaces/class-use/IRobotState.html +++ b/docs/swarm/Interfaces/class-use/IRobotState.html @@ -2,9 +2,9 @@ - + Uses of Interface swarm.Interfaces.IRobotState - + diff --git a/docs/swarm/Interfaces/class-use/IRobotState.robotState.html b/docs/swarm/Interfaces/class-use/IRobotState.robotState.html index 61b117e..9f5ab45 100644 --- a/docs/swarm/Interfaces/class-use/IRobotState.robotState.html +++ b/docs/swarm/Interfaces/class-use/IRobotState.robotState.html @@ -2,9 +2,9 @@ - + Uses of Class swarm.Interfaces.IRobotState.robotState - + diff --git a/docs/swarm/Interfaces/package-frame.html b/docs/swarm/Interfaces/package-frame.html index a837a70..9f00264 100644 --- a/docs/swarm/Interfaces/package-frame.html +++ b/docs/swarm/Interfaces/package-frame.html @@ -2,9 +2,9 @@ - + swarm.Interfaces - + diff --git a/docs/swarm/Interfaces/package-summary.html b/docs/swarm/Interfaces/package-summary.html index a5b8912..d25f382 100644 --- a/docs/swarm/Interfaces/package-summary.html +++ b/docs/swarm/Interfaces/package-summary.html @@ -2,9 +2,9 @@ - + swarm.Interfaces - + diff --git a/docs/swarm/Interfaces/package-tree.html b/docs/swarm/Interfaces/package-tree.html index dc911d3..c7001dc 100644 --- a/docs/swarm/Interfaces/package-tree.html +++ b/docs/swarm/Interfaces/package-tree.html @@ -2,9 +2,9 @@ - + swarm.Interfaces Class Hierarchy - + diff --git a/docs/swarm/Interfaces/package-use.html b/docs/swarm/Interfaces/package-use.html index 70dd757..b3ac707 100644 --- a/docs/swarm/Interfaces/package-use.html +++ b/docs/swarm/Interfaces/package-use.html @@ -2,9 +2,9 @@ - + Uses of Package swarm.Interfaces - + diff --git a/docs/swarm/class-use/App.html b/docs/swarm/class-use/App.html index 963ce49..985ad70 100644 --- a/docs/swarm/class-use/App.html +++ b/docs/swarm/class-use/App.html @@ -2,9 +2,9 @@ - + Uses of Class swarm.App - + diff --git a/docs/swarm/class-use/AppTest.html b/docs/swarm/class-use/AppTest.html index 44ac711..783fa5a 100644 --- a/docs/swarm/class-use/AppTest.html +++ b/docs/swarm/class-use/AppTest.html @@ -2,9 +2,9 @@ - + Uses of Class swarm.AppTest - + diff --git a/docs/swarm/configs/MQTTSettings.html b/docs/swarm/configs/MQTTSettings.html index b8aace4..f32f989 100644 --- a/docs/swarm/configs/MQTTSettings.html +++ b/docs/swarm/configs/MQTTSettings.html @@ -2,9 +2,9 @@ - + MQTTSettings - + diff --git a/docs/swarm/configs/MQTTSettingsTest.html b/docs/swarm/configs/MQTTSettingsTest.html index 4fce4be..cf04f9d 100644 --- a/docs/swarm/configs/MQTTSettingsTest.html +++ b/docs/swarm/configs/MQTTSettingsTest.html @@ -2,9 +2,9 @@ - + MQTTSettingsTest - + diff --git a/docs/swarm/configs/RobotSettings.html b/docs/swarm/configs/RobotSettings.html index 9b5f9e8..9965697 100644 --- a/docs/swarm/configs/RobotSettings.html +++ b/docs/swarm/configs/RobotSettings.html @@ -2,9 +2,9 @@ - + RobotSettings - + diff --git a/docs/swarm/configs/class-use/MQTTSettings.html b/docs/swarm/configs/class-use/MQTTSettings.html index 2095934..6dfdbd7 100644 --- a/docs/swarm/configs/class-use/MQTTSettings.html +++ b/docs/swarm/configs/class-use/MQTTSettings.html @@ -2,9 +2,9 @@ - + Uses of Class swarm.configs.MQTTSettings - + diff --git a/docs/swarm/configs/class-use/MQTTSettingsTest.html b/docs/swarm/configs/class-use/MQTTSettingsTest.html index 17e23ff..c72e7da 100644 --- a/docs/swarm/configs/class-use/MQTTSettingsTest.html +++ b/docs/swarm/configs/class-use/MQTTSettingsTest.html @@ -2,9 +2,9 @@ - + Uses of Class swarm.configs.MQTTSettingsTest - + diff --git a/docs/swarm/configs/class-use/RobotSettings.html b/docs/swarm/configs/class-use/RobotSettings.html index 1c08222..61ff57d 100644 --- a/docs/swarm/configs/class-use/RobotSettings.html +++ b/docs/swarm/configs/class-use/RobotSettings.html @@ -2,9 +2,9 @@ - + Uses of Class swarm.configs.RobotSettings - + diff --git a/docs/swarm/configs/package-frame.html b/docs/swarm/configs/package-frame.html index 783523b..27bd8da 100644 --- a/docs/swarm/configs/package-frame.html +++ b/docs/swarm/configs/package-frame.html @@ -2,9 +2,9 @@ - + swarm.configs - + diff --git a/docs/swarm/configs/package-summary.html b/docs/swarm/configs/package-summary.html index 6c304ab..0a617a4 100644 --- a/docs/swarm/configs/package-summary.html +++ b/docs/swarm/configs/package-summary.html @@ -2,9 +2,9 @@ - + swarm.configs - + diff --git a/docs/swarm/configs/package-tree.html b/docs/swarm/configs/package-tree.html index 2184d79..9dd6746 100644 --- a/docs/swarm/configs/package-tree.html +++ b/docs/swarm/configs/package-tree.html @@ -2,9 +2,9 @@ - + swarm.configs Class Hierarchy - + diff --git a/docs/swarm/configs/package-use.html b/docs/swarm/configs/package-use.html index a683025..3eaa6d6 100644 --- a/docs/swarm/configs/package-use.html +++ b/docs/swarm/configs/package-use.html @@ -2,9 +2,9 @@ - + Uses of Package swarm.configs - + diff --git a/docs/swarm/mqtt/MqttMsg.html b/docs/swarm/mqtt/MqttMsg.html index f72ee8a..d8d28da 100644 --- a/docs/swarm/mqtt/MqttMsg.html +++ b/docs/swarm/mqtt/MqttMsg.html @@ -2,9 +2,9 @@ - + MqttMsg - + diff --git a/docs/swarm/mqtt/RobotMqttClient.html b/docs/swarm/mqtt/RobotMqttClient.html index c79392d..699aed9 100644 --- a/docs/swarm/mqtt/RobotMqttClient.html +++ b/docs/swarm/mqtt/RobotMqttClient.html @@ -2,9 +2,9 @@ - + RobotMqttClient - + @@ -18,7 +18,7 @@ catch(err) { } //--> -var methods = {"i0":10,"i1":10,"i2":10,"i3":10,"i4":10,"i5":10,"i6":10,"i7":10,"i8":10}; +var methods = {"i0":10,"i1":10,"i2":10,"i3":10,"i4":10,"i5":10,"i6":10,"i7":10,"i8":10,"i9":10,"i10":10}; var tabs = {65535:["t0","All Methods"],2:["t2","Instance Methods"],8:["t4","Concrete Methods"]}; var altColor = "altColor"; var rowColor = "rowColor"; @@ -210,11 +210,24 @@

Method Summary

void +publish(java.lang.String topic, + java.lang.String body, + boolean retained)  + + +void publish(java.lang.String topic, java.lang.String body, int qos)  - + +void +publish(java.lang.String topic, + java.lang.String body, + int qos, + boolean retained)  + + void subscribe(java.lang.String topic)  @@ -317,6 +330,29 @@

publish

int qos) + + + +
    +
  • +

    publish

    +
    public void publish(java.lang.String topic,
+                    java.lang.String body,
+                    boolean retained)
    +
    • +
+ + + +
    +
  • +

    publish

    +
    public void publish(java.lang.String topic,
+                    java.lang.String body,
+                    int qos,
+                    boolean retained)
    +
    • +
diff --git a/docs/swarm/mqtt/class-use/MqttMsg.html b/docs/swarm/mqtt/class-use/MqttMsg.html index 01f76d6..f46c090 100644 --- a/docs/swarm/mqtt/class-use/MqttMsg.html +++ b/docs/swarm/mqtt/class-use/MqttMsg.html @@ -2,9 +2,9 @@ - + Uses of Class swarm.mqtt.MqttMsg - + diff --git a/docs/swarm/mqtt/class-use/RobotMqttClient.html b/docs/swarm/mqtt/class-use/RobotMqttClient.html index f0d2d80..8a9d2c6 100644 --- a/docs/swarm/mqtt/class-use/RobotMqttClient.html +++ b/docs/swarm/mqtt/class-use/RobotMqttClient.html @@ -2,9 +2,9 @@ - + Uses of Class swarm.mqtt.RobotMqttClient - + @@ -289,6 +289,13 @@

Uses of +ProximitySensor(Robot robot, + int[] angles, + RobotMqttClient m) +
ProximitySensor class
+ + + ProximitySensor(Robot robot, RobotMqttClient m)
ProximitySensor class
diff --git a/docs/swarm/mqtt/package-frame.html b/docs/swarm/mqtt/package-frame.html index 265597b..87d44e8 100644 --- a/docs/swarm/mqtt/package-frame.html +++ b/docs/swarm/mqtt/package-frame.html @@ -2,9 +2,9 @@ - + swarm.mqtt - + diff --git a/docs/swarm/mqtt/package-summary.html b/docs/swarm/mqtt/package-summary.html index 03641ab..e8da8b9 100644 --- a/docs/swarm/mqtt/package-summary.html +++ b/docs/swarm/mqtt/package-summary.html @@ -2,9 +2,9 @@ - + swarm.mqtt - + diff --git a/docs/swarm/mqtt/package-tree.html b/docs/swarm/mqtt/package-tree.html index 62f8102..da0d2a1 100644 --- a/docs/swarm/mqtt/package-tree.html +++ b/docs/swarm/mqtt/package-tree.html @@ -2,9 +2,9 @@ - + swarm.mqtt Class Hierarchy - + diff --git a/docs/swarm/mqtt/package-use.html b/docs/swarm/mqtt/package-use.html index 664537b..e01ae31 100644 --- a/docs/swarm/mqtt/package-use.html +++ b/docs/swarm/mqtt/package-use.html @@ -2,9 +2,9 @@ - + Uses of Package swarm.mqtt - + diff --git a/docs/swarm/package-frame.html b/docs/swarm/package-frame.html index d5ce9d7..f1e1b03 100644 --- a/docs/swarm/package-frame.html +++ b/docs/swarm/package-frame.html @@ -2,9 +2,9 @@ - + swarm - + diff --git a/docs/swarm/package-summary.html b/docs/swarm/package-summary.html index 797e946..ff7a306 100644 --- a/docs/swarm/package-summary.html +++ b/docs/swarm/package-summary.html @@ -2,9 +2,9 @@ - + swarm - + diff --git a/docs/swarm/package-tree.html b/docs/swarm/package-tree.html index 35ca7e3..cdada46 100644 --- a/docs/swarm/package-tree.html +++ b/docs/swarm/package-tree.html @@ -2,9 +2,9 @@ - + swarm Class Hierarchy - + diff --git a/docs/swarm/package-use.html b/docs/swarm/package-use.html index 55d3f9a..0ac9404 100644 --- a/docs/swarm/package-use.html +++ b/docs/swarm/package-use.html @@ -2,9 +2,9 @@ - + Uses of Package swarm - + diff --git a/docs/swarm/robot/Robot.html b/docs/swarm/robot/Robot.html index ad73848..1d5eec2 100644 --- a/docs/swarm/robot/Robot.html +++ b/docs/swarm/robot/Robot.html @@ -2,9 +2,9 @@ - + Robot - + diff --git a/docs/swarm/robot/VirtualRobot.html b/docs/swarm/robot/VirtualRobot.html index 35f81b5..4e670a9 100644 --- a/docs/swarm/robot/VirtualRobot.html +++ b/docs/swarm/robot/VirtualRobot.html @@ -2,9 +2,9 @@ - + VirtualRobot - + diff --git a/docs/swarm/robot/class-use/Robot.html b/docs/swarm/robot/class-use/Robot.html index 8c7b4fc..41fc233 100644 --- a/docs/swarm/robot/class-use/Robot.html +++ b/docs/swarm/robot/class-use/Robot.html @@ -2,9 +2,9 @@ - + Uses of Class swarm.robot.Robot - + @@ -364,6 +364,13 @@

Uses of +ProximitySensor(Robot robot, + int[] angles, + RobotMqttClient m) +
ProximitySensor class
+ + + ProximitySensor(Robot robot, RobotMqttClient m)
ProximitySensor class
diff --git a/docs/swarm/robot/class-use/VirtualRobot.html b/docs/swarm/robot/class-use/VirtualRobot.html index cf3a35f..a6a0e14 100644 --- a/docs/swarm/robot/class-use/VirtualRobot.html +++ b/docs/swarm/robot/class-use/VirtualRobot.html @@ -2,9 +2,9 @@ - + Uses of Class swarm.robot.VirtualRobot - + diff --git a/docs/swarm/robot/communication/Communication.html b/docs/swarm/robot/communication/Communication.html index 54aef48..dbc7b99 100644 --- a/docs/swarm/robot/communication/Communication.html +++ b/docs/swarm/robot/communication/Communication.html @@ -2,9 +2,9 @@ - + Communication - + diff --git a/docs/swarm/robot/communication/DirectedCommunication.html b/docs/swarm/robot/communication/DirectedCommunication.html index 529a704..b27d2d6 100644 --- a/docs/swarm/robot/communication/DirectedCommunication.html +++ b/docs/swarm/robot/communication/DirectedCommunication.html @@ -2,9 +2,9 @@ - + DirectedCommunication - + diff --git a/docs/swarm/robot/communication/SimpleCommunication.html b/docs/swarm/robot/communication/SimpleCommunication.html index c30edd5..c509349 100644 --- a/docs/swarm/robot/communication/SimpleCommunication.html +++ b/docs/swarm/robot/communication/SimpleCommunication.html @@ -2,9 +2,9 @@ - + SimpleCommunication - + diff --git a/docs/swarm/robot/communication/class-use/Communication.html b/docs/swarm/robot/communication/class-use/Communication.html index 02e5b79..12d38ca 100644 --- a/docs/swarm/robot/communication/class-use/Communication.html +++ b/docs/swarm/robot/communication/class-use/Communication.html @@ -2,9 +2,9 @@ - + Uses of Class swarm.robot.communication.Communication - + diff --git a/docs/swarm/robot/communication/class-use/DirectedCommunication.html b/docs/swarm/robot/communication/class-use/DirectedCommunication.html index af7784a..28007a5 100644 --- a/docs/swarm/robot/communication/class-use/DirectedCommunication.html +++ b/docs/swarm/robot/communication/class-use/DirectedCommunication.html @@ -2,9 +2,9 @@ - + Uses of Class swarm.robot.communication.DirectedCommunication - + diff --git a/docs/swarm/robot/communication/class-use/SimpleCommunication.html b/docs/swarm/robot/communication/class-use/SimpleCommunication.html index f93081b..5bbfa5d 100644 --- a/docs/swarm/robot/communication/class-use/SimpleCommunication.html +++ b/docs/swarm/robot/communication/class-use/SimpleCommunication.html @@ -2,9 +2,9 @@ - + Uses of Class swarm.robot.communication.SimpleCommunication - + diff --git a/docs/swarm/robot/communication/package-frame.html b/docs/swarm/robot/communication/package-frame.html index 5d26d63..b8ee1e6 100644 --- a/docs/swarm/robot/communication/package-frame.html +++ b/docs/swarm/robot/communication/package-frame.html @@ -2,9 +2,9 @@ - + swarm.robot.communication - + diff --git a/docs/swarm/robot/communication/package-summary.html b/docs/swarm/robot/communication/package-summary.html index 8e6e0d9..8c96088 100644 --- a/docs/swarm/robot/communication/package-summary.html +++ b/docs/swarm/robot/communication/package-summary.html @@ -2,9 +2,9 @@ - + swarm.robot.communication - + diff --git a/docs/swarm/robot/communication/package-tree.html b/docs/swarm/robot/communication/package-tree.html index c04812f..53c406f 100644 --- a/docs/swarm/robot/communication/package-tree.html +++ b/docs/swarm/robot/communication/package-tree.html @@ -2,9 +2,9 @@ - + swarm.robot.communication Class Hierarchy - + diff --git a/docs/swarm/robot/communication/package-use.html b/docs/swarm/robot/communication/package-use.html index cd79115..927f6cf 100644 --- a/docs/swarm/robot/communication/package-use.html +++ b/docs/swarm/robot/communication/package-use.html @@ -2,9 +2,9 @@ - + Uses of Package swarm.robot.communication - + diff --git a/docs/swarm/robot/exception/MotionControllerException.html b/docs/swarm/robot/exception/MotionControllerException.html index 1ae0f99..64bbf41 100644 --- a/docs/swarm/robot/exception/MotionControllerException.html +++ b/docs/swarm/robot/exception/MotionControllerException.html @@ -2,9 +2,9 @@ - + MotionControllerException - + diff --git a/docs/swarm/robot/exception/MqttClientException.html b/docs/swarm/robot/exception/MqttClientException.html index 8fbed76..b70d83d 100644 --- a/docs/swarm/robot/exception/MqttClientException.html +++ b/docs/swarm/robot/exception/MqttClientException.html @@ -2,9 +2,9 @@ - + MqttClientException - + diff --git a/docs/swarm/robot/exception/ProximityException.html b/docs/swarm/robot/exception/ProximityException.html index 01caa71..ad75729 100644 --- a/docs/swarm/robot/exception/ProximityException.html +++ b/docs/swarm/robot/exception/ProximityException.html @@ -2,9 +2,9 @@ - + ProximityException - + diff --git a/docs/swarm/robot/exception/RGBColorException.html b/docs/swarm/robot/exception/RGBColorException.html index 529defd..fe5b10b 100644 --- a/docs/swarm/robot/exception/RGBColorException.html +++ b/docs/swarm/robot/exception/RGBColorException.html @@ -2,9 +2,9 @@ - + RGBColorException - + diff --git a/docs/swarm/robot/exception/SensorException.html b/docs/swarm/robot/exception/SensorException.html index 71558cc..ee10022 100644 --- a/docs/swarm/robot/exception/SensorException.html +++ b/docs/swarm/robot/exception/SensorException.html @@ -2,9 +2,9 @@ - + SensorException - + diff --git a/docs/swarm/robot/exception/class-use/MotionControllerException.html b/docs/swarm/robot/exception/class-use/MotionControllerException.html index e00096d..ce6c242 100644 --- a/docs/swarm/robot/exception/class-use/MotionControllerException.html +++ b/docs/swarm/robot/exception/class-use/MotionControllerException.html @@ -2,9 +2,9 @@ - + Uses of Class swarm.robot.exception.MotionControllerException - + diff --git a/docs/swarm/robot/exception/class-use/MqttClientException.html b/docs/swarm/robot/exception/class-use/MqttClientException.html index 55cfe91..f265ff3 100644 --- a/docs/swarm/robot/exception/class-use/MqttClientException.html +++ b/docs/swarm/robot/exception/class-use/MqttClientException.html @@ -2,9 +2,9 @@ - + Uses of Class swarm.robot.exception.MqttClientException - + diff --git a/docs/swarm/robot/exception/class-use/ProximityException.html b/docs/swarm/robot/exception/class-use/ProximityException.html index dbb2e1f..74051e1 100644 --- a/docs/swarm/robot/exception/class-use/ProximityException.html +++ b/docs/swarm/robot/exception/class-use/ProximityException.html @@ -2,9 +2,9 @@ - + Uses of Class swarm.robot.exception.ProximityException - + @@ -102,7 +102,8 @@

Uses of -ProximityReadingType(java.lang.String str)  +ProximityReadingType(int[] angles, + java.lang.String str)  diff --git a/docs/swarm/robot/exception/class-use/RGBColorException.html b/docs/swarm/robot/exception/class-use/RGBColorException.html index 305ce2e..718f2b7 100644 --- a/docs/swarm/robot/exception/class-use/RGBColorException.html +++ b/docs/swarm/robot/exception/class-use/RGBColorException.html @@ -2,9 +2,9 @@ - + Uses of Class swarm.robot.exception.RGBColorException - + diff --git a/docs/swarm/robot/exception/class-use/SensorException.html b/docs/swarm/robot/exception/class-use/SensorException.html index 82cce32..453c769 100644 --- a/docs/swarm/robot/exception/class-use/SensorException.html +++ b/docs/swarm/robot/exception/class-use/SensorException.html @@ -2,9 +2,9 @@ - + Uses of Class swarm.robot.exception.SensorException - + diff --git a/docs/swarm/robot/exception/package-frame.html b/docs/swarm/robot/exception/package-frame.html index 880312e..9d3bfd9 100644 --- a/docs/swarm/robot/exception/package-frame.html +++ b/docs/swarm/robot/exception/package-frame.html @@ -2,9 +2,9 @@ - + swarm.robot.exception - + diff --git a/docs/swarm/robot/exception/package-summary.html b/docs/swarm/robot/exception/package-summary.html index de9fa20..f105998 100644 --- a/docs/swarm/robot/exception/package-summary.html +++ b/docs/swarm/robot/exception/package-summary.html @@ -2,9 +2,9 @@ - + swarm.robot.exception - + diff --git a/docs/swarm/robot/exception/package-tree.html b/docs/swarm/robot/exception/package-tree.html index c4f119c..0360da2 100644 --- a/docs/swarm/robot/exception/package-tree.html +++ b/docs/swarm/robot/exception/package-tree.html @@ -2,9 +2,9 @@ - + swarm.robot.exception Class Hierarchy - + diff --git a/docs/swarm/robot/exception/package-use.html b/docs/swarm/robot/exception/package-use.html index 4b015c3..53bfdc3 100644 --- a/docs/swarm/robot/exception/package-use.html +++ b/docs/swarm/robot/exception/package-use.html @@ -2,9 +2,9 @@ - + Uses of Package swarm.robot.exception - + diff --git a/docs/swarm/robot/helpers/Coordinate.html b/docs/swarm/robot/helpers/Coordinate.html index 001c26a..7057e6b 100644 --- a/docs/swarm/robot/helpers/Coordinate.html +++ b/docs/swarm/robot/helpers/Coordinate.html @@ -2,9 +2,9 @@ - + Coordinate - + diff --git a/docs/swarm/robot/helpers/MotionController.html b/docs/swarm/robot/helpers/MotionController.html index 7d9e18a..d986599 100644 --- a/docs/swarm/robot/helpers/MotionController.html +++ b/docs/swarm/robot/helpers/MotionController.html @@ -2,9 +2,9 @@ - + MotionController - + diff --git a/docs/swarm/robot/helpers/RobotMQTT.html b/docs/swarm/robot/helpers/RobotMQTT.html index e8a0ffb..059590b 100644 --- a/docs/swarm/robot/helpers/RobotMQTT.html +++ b/docs/swarm/robot/helpers/RobotMQTT.html @@ -2,9 +2,9 @@ - + RobotMQTT - + diff --git a/docs/swarm/robot/helpers/class-use/Coordinate.html b/docs/swarm/robot/helpers/class-use/Coordinate.html index 864b152..6100673 100644 --- a/docs/swarm/robot/helpers/class-use/Coordinate.html +++ b/docs/swarm/robot/helpers/class-use/Coordinate.html @@ -2,9 +2,9 @@ - + Uses of Class swarm.robot.helpers.Coordinate - + diff --git a/docs/swarm/robot/helpers/class-use/MotionController.html b/docs/swarm/robot/helpers/class-use/MotionController.html index 56b5453..25bd3d2 100644 --- a/docs/swarm/robot/helpers/class-use/MotionController.html +++ b/docs/swarm/robot/helpers/class-use/MotionController.html @@ -2,9 +2,9 @@ - + Uses of Class swarm.robot.helpers.MotionController - + diff --git a/docs/swarm/robot/helpers/class-use/RobotMQTT.html b/docs/swarm/robot/helpers/class-use/RobotMQTT.html index 0c9f188..bde7505 100644 --- a/docs/swarm/robot/helpers/class-use/RobotMQTT.html +++ b/docs/swarm/robot/helpers/class-use/RobotMQTT.html @@ -2,9 +2,9 @@ - + Uses of Class swarm.robot.helpers.RobotMQTT - + diff --git a/docs/swarm/robot/helpers/package-frame.html b/docs/swarm/robot/helpers/package-frame.html index 91d1fcf..a48a77d 100644 --- a/docs/swarm/robot/helpers/package-frame.html +++ b/docs/swarm/robot/helpers/package-frame.html @@ -2,9 +2,9 @@ - + swarm.robot.helpers - + diff --git a/docs/swarm/robot/helpers/package-summary.html b/docs/swarm/robot/helpers/package-summary.html index bcf2737..a728145 100644 --- a/docs/swarm/robot/helpers/package-summary.html +++ b/docs/swarm/robot/helpers/package-summary.html @@ -2,9 +2,9 @@ - + swarm.robot.helpers - + diff --git a/docs/swarm/robot/helpers/package-tree.html b/docs/swarm/robot/helpers/package-tree.html index 356aae1..3c8af1e 100644 --- a/docs/swarm/robot/helpers/package-tree.html +++ b/docs/swarm/robot/helpers/package-tree.html @@ -2,9 +2,9 @@ - + swarm.robot.helpers Class Hierarchy - + diff --git a/docs/swarm/robot/helpers/package-use.html b/docs/swarm/robot/helpers/package-use.html index 1c867f1..977be30 100644 --- a/docs/swarm/robot/helpers/package-use.html +++ b/docs/swarm/robot/helpers/package-use.html @@ -2,9 +2,9 @@ - + Uses of Package swarm.robot.helpers - + diff --git a/docs/swarm/robot/indicator/AbstractIndicator.html b/docs/swarm/robot/indicator/AbstractIndicator.html index 5e81d8f..891e311 100644 --- a/docs/swarm/robot/indicator/AbstractIndicator.html +++ b/docs/swarm/robot/indicator/AbstractIndicator.html @@ -2,9 +2,9 @@ - + AbstractIndicator - + diff --git a/docs/swarm/robot/indicator/NeoPixel.html b/docs/swarm/robot/indicator/NeoPixel.html index 77b4013..0bbaa76 100644 --- a/docs/swarm/robot/indicator/NeoPixel.html +++ b/docs/swarm/robot/indicator/NeoPixel.html @@ -2,9 +2,9 @@ - + NeoPixel - + @@ -179,7 +179,7 @@

Method Summary

changeColor(int red, int green, int blue) -
Change the color of the NeoPixel Ring
+
Change the color of the NeoPixel Ring (inform the server and GUI)
@@ -288,7 +288,7 @@

changeColor

public void changeColor(int red,
                         int green,
                         int blue)
-
Change the color of the NeoPixel Ring
+
Change the color of the NeoPixel Ring (inform the server and GUI)
Parameters:
red - Red intensity, [0,255]
diff --git a/docs/swarm/robot/indicator/class-use/AbstractIndicator.html b/docs/swarm/robot/indicator/class-use/AbstractIndicator.html index 9de0bac..15ebc95 100644 --- a/docs/swarm/robot/indicator/class-use/AbstractIndicator.html +++ b/docs/swarm/robot/indicator/class-use/AbstractIndicator.html @@ -2,9 +2,9 @@ - + Uses of Class swarm.robot.indicator.AbstractIndicator - + diff --git a/docs/swarm/robot/indicator/class-use/NeoPixel.html b/docs/swarm/robot/indicator/class-use/NeoPixel.html index 7d8a615..8fc39f5 100644 --- a/docs/swarm/robot/indicator/class-use/NeoPixel.html +++ b/docs/swarm/robot/indicator/class-use/NeoPixel.html @@ -2,9 +2,9 @@ - + Uses of Class swarm.robot.indicator.NeoPixel - + diff --git a/docs/swarm/robot/indicator/package-frame.html b/docs/swarm/robot/indicator/package-frame.html index fe18f59..f557dfa 100644 --- a/docs/swarm/robot/indicator/package-frame.html +++ b/docs/swarm/robot/indicator/package-frame.html @@ -2,9 +2,9 @@ - + swarm.robot.indicator - + diff --git a/docs/swarm/robot/indicator/package-summary.html b/docs/swarm/robot/indicator/package-summary.html index 82c679b..baa4ee4 100644 --- a/docs/swarm/robot/indicator/package-summary.html +++ b/docs/swarm/robot/indicator/package-summary.html @@ -2,9 +2,9 @@ - + swarm.robot.indicator - + diff --git a/docs/swarm/robot/indicator/package-tree.html b/docs/swarm/robot/indicator/package-tree.html index 22f27d2..42ba790 100644 --- a/docs/swarm/robot/indicator/package-tree.html +++ b/docs/swarm/robot/indicator/package-tree.html @@ -2,9 +2,9 @@ - + swarm.robot.indicator Class Hierarchy - + diff --git a/docs/swarm/robot/indicator/package-use.html b/docs/swarm/robot/indicator/package-use.html index 38aaf16..6de4587 100644 --- a/docs/swarm/robot/indicator/package-use.html +++ b/docs/swarm/robot/indicator/package-use.html @@ -2,9 +2,9 @@ - + Uses of Package swarm.robot.indicator - + diff --git a/docs/swarm/robot/package-frame.html b/docs/swarm/robot/package-frame.html index 39d24a3..bae739e 100644 --- a/docs/swarm/robot/package-frame.html +++ b/docs/swarm/robot/package-frame.html @@ -2,9 +2,9 @@ - + swarm.robot - + diff --git a/docs/swarm/robot/package-summary.html b/docs/swarm/robot/package-summary.html index 030ccc7..d0edc77 100644 --- a/docs/swarm/robot/package-summary.html +++ b/docs/swarm/robot/package-summary.html @@ -2,9 +2,9 @@ - + swarm.robot - + diff --git a/docs/swarm/robot/package-tree.html b/docs/swarm/robot/package-tree.html index de3fc01..88e2453 100644 --- a/docs/swarm/robot/package-tree.html +++ b/docs/swarm/robot/package-tree.html @@ -2,9 +2,9 @@ - + swarm.robot Class Hierarchy - + diff --git a/docs/swarm/robot/package-use.html b/docs/swarm/robot/package-use.html index 61dc60b..a539295 100644 --- a/docs/swarm/robot/package-use.html +++ b/docs/swarm/robot/package-use.html @@ -2,9 +2,9 @@ - + Uses of Package swarm.robot - + diff --git a/docs/swarm/robot/sensors/AbstractSensor.html b/docs/swarm/robot/sensors/AbstractSensor.html index 87c6810..e4e6130 100644 --- a/docs/swarm/robot/sensors/AbstractSensor.html +++ b/docs/swarm/robot/sensors/AbstractSensor.html @@ -2,9 +2,9 @@ - + AbstractSensor - + diff --git a/docs/swarm/robot/sensors/ColorSensor.html b/docs/swarm/robot/sensors/ColorSensor.html index 390b39c..9d48447 100644 --- a/docs/swarm/robot/sensors/ColorSensor.html +++ b/docs/swarm/robot/sensors/ColorSensor.html @@ -2,9 +2,9 @@ - + ColorSensor - + diff --git a/docs/swarm/robot/sensors/DistanceSensor.html b/docs/swarm/robot/sensors/DistanceSensor.html index e2db7f2..5db2b25 100644 --- a/docs/swarm/robot/sensors/DistanceSensor.html +++ b/docs/swarm/robot/sensors/DistanceSensor.html @@ -2,9 +2,9 @@ - + DistanceSensor - + diff --git a/docs/swarm/robot/sensors/ProximitySensor.html b/docs/swarm/robot/sensors/ProximitySensor.html index b65d46b..ec98bb3 100644 --- a/docs/swarm/robot/sensors/ProximitySensor.html +++ b/docs/swarm/robot/sensors/ProximitySensor.html @@ -2,9 +2,9 @@ - + ProximitySensor - + @@ -18,7 +18,7 @@ catch(err) { } //--> -var methods = {"i0":10,"i1":10,"i2":10}; +var methods = {"i0":10,"i1":10,"i2":10,"i3":10}; var tabs = {65535:["t0","All Methods"],2:["t2","Instance Methods"],8:["t4","Concrete Methods"]}; var altColor = "altColor"; var rowColor = "rowColor"; @@ -158,6 +158,13 @@

Constructor Summary

Constructor and Description +ProximitySensor(Robot robot, + int[] angles, + RobotMqttClient m) +
ProximitySensor class
+ + + ProximitySensor(Robot robot, RobotMqttClient m)
ProximitySensor class
@@ -198,6 +205,12 @@

Method Summary

virtual robots will not invoke this. + +void +setAngles(int[] proximityAngles) +
Set the proximity sensor angles
+ +
  • @@ -223,15 +236,33 @@

    Constructor Detail

     +
      +
    • +

      ProximitySensor

      +
      public ProximitySensor(Robot robot,
+                       RobotMqttClient m)
      +
      ProximitySensor class
      +
      +
      Parameters:
      +
      robot - robot object
      +
      mqttClient - mqttClient object
      +
      +
      • +
    + + +

    • ProximitySensor

      public ProximitySensor(Robot robot,
+                       int[] angles,
                        RobotMqttClient m)
      ProximitySensor class
      Parameters:
      robot - robot object
      +
      angles[] - proximity sensor angles as int array
      mqttClient - mqttClient object
      • @@ -264,6 +295,20 @@

      handleSubscription

+ + + +
    +
  • +

    setAngles

    +
    public void setAngles(int[] proximityAngles)
    +
    Set the proximity sensor angles
    +
    +
    Parameters:
    +
    proximityAngles - angles as an int array
    +
    +
    • +
diff --git a/docs/swarm/robot/sensors/class-use/AbstractSensor.html b/docs/swarm/robot/sensors/class-use/AbstractSensor.html index ce3ad2d..04b8abc 100644 --- a/docs/swarm/robot/sensors/class-use/AbstractSensor.html +++ b/docs/swarm/robot/sensors/class-use/AbstractSensor.html @@ -2,9 +2,9 @@ - + Uses of Class swarm.robot.sensors.AbstractSensor - + diff --git a/docs/swarm/robot/sensors/class-use/ColorSensor.html b/docs/swarm/robot/sensors/class-use/ColorSensor.html index 06b1a6f..7d57619 100644 --- a/docs/swarm/robot/sensors/class-use/ColorSensor.html +++ b/docs/swarm/robot/sensors/class-use/ColorSensor.html @@ -2,9 +2,9 @@ - + Uses of Class swarm.robot.sensors.ColorSensor - + diff --git a/docs/swarm/robot/sensors/class-use/DistanceSensor.html b/docs/swarm/robot/sensors/class-use/DistanceSensor.html index 8831139..bc3269f 100644 --- a/docs/swarm/robot/sensors/class-use/DistanceSensor.html +++ b/docs/swarm/robot/sensors/class-use/DistanceSensor.html @@ -2,9 +2,9 @@ - + Uses of Class swarm.robot.sensors.DistanceSensor - + diff --git a/docs/swarm/robot/sensors/class-use/ProximitySensor.html b/docs/swarm/robot/sensors/class-use/ProximitySensor.html index bd9046f..3c0c935 100644 --- a/docs/swarm/robot/sensors/class-use/ProximitySensor.html +++ b/docs/swarm/robot/sensors/class-use/ProximitySensor.html @@ -2,9 +2,9 @@ - + Uses of Class swarm.robot.sensors.ProximitySensor - + diff --git a/docs/swarm/robot/sensors/package-frame.html b/docs/swarm/robot/sensors/package-frame.html index f0d70ce..3661870 100644 --- a/docs/swarm/robot/sensors/package-frame.html +++ b/docs/swarm/robot/sensors/package-frame.html @@ -2,9 +2,9 @@ - + swarm.robot.sensors - + diff --git a/docs/swarm/robot/sensors/package-summary.html b/docs/swarm/robot/sensors/package-summary.html index 60e5545..61621a0 100644 --- a/docs/swarm/robot/sensors/package-summary.html +++ b/docs/swarm/robot/sensors/package-summary.html @@ -2,9 +2,9 @@ - + swarm.robot.sensors - + diff --git a/docs/swarm/robot/sensors/package-tree.html b/docs/swarm/robot/sensors/package-tree.html index d6e5ee8..26ca79b 100644 --- a/docs/swarm/robot/sensors/package-tree.html +++ b/docs/swarm/robot/sensors/package-tree.html @@ -2,9 +2,9 @@ - + swarm.robot.sensors Class Hierarchy - + diff --git a/docs/swarm/robot/sensors/package-use.html b/docs/swarm/robot/sensors/package-use.html index 06e7238..0692d87 100644 --- a/docs/swarm/robot/sensors/package-use.html +++ b/docs/swarm/robot/sensors/package-use.html @@ -2,9 +2,9 @@ - + Uses of Package swarm.robot.sensors - + diff --git a/docs/swarm/robot/types/ProximityReadingType.html b/docs/swarm/robot/types/ProximityReadingType.html index 120879b..cd6c660 100644 --- a/docs/swarm/robot/types/ProximityReadingType.html +++ b/docs/swarm/robot/types/ProximityReadingType.html @@ -2,9 +2,9 @@ - + ProximityReadingType - + @@ -18,7 +18,7 @@ catch(err) { } //--> -var methods = {"i0":10}; +var methods = {"i0":10,"i1":10,"i2":10}; var tabs = {65535:["t0","All Methods"],2:["t2","Instance Methods"],8:["t4","Concrete Methods"]}; var altColor = "altColor"; var rowColor = "rowColor"; @@ -129,14 +129,8 @@

Constructor Summary

Constructor and Description -ProximityReadingType(int LB, - int L, - int F, - int R, - int RB)  - - -ProximityReadingType(java.lang.String str)  +ProximityReadingType(int[] angles, + java.lang.String str)  @@ -154,6 +148,14 @@

Method Summary

Method and Description +RGBColorType[] +colors()  + + +int[] +distances()  + + java.lang.String toString()  @@ -179,13 +181,14 @@

Methods inherited from class java.lang.Object

Constructor Detail

- + -
    +

    • ProximityReadingType

      -
      public ProximityReadingType(java.lang.String str)
+
      public ProximityReadingType(int[] angles,
+                            java.lang.String str)
                      throws ProximityException
      
 
      
 
      Throws:
      
@@ -193,19 +196,6 @@ 
      ProximityReadingType
    - - - -
      -
    • -

      ProximityReadingType

      -
      public ProximityReadingType(int LB,
-                            int L,
-                            int F,
-                            int R,
-                            int RB)
      -
      • -
@@ -214,6 +204,24 @@

ProximityReadingType

Method Detail

+ + + +
    +
  • +

    distances

    +
    public int[] distances()
    +
    • +
+ + + + diff --git a/docs/swarm/robot/types/RGBColorType.html b/docs/swarm/robot/types/RGBColorType.html index f44a82a..0131106 100644 --- a/docs/swarm/robot/types/RGBColorType.html +++ b/docs/swarm/robot/types/RGBColorType.html @@ -2,9 +2,9 @@ - + RGBColorType - + @@ -18,7 +18,7 @@ catch(err) { } //--> -var methods = {"i0":10,"i1":10,"i2":10,"i3":10,"i4":10,"i5":10,"i6":10,"i7":10,"i8":10}; +var methods = {"i0":10,"i1":10,"i2":10,"i3":10,"i4":10,"i5":10,"i6":10,"i7":10,"i8":10,"i9":10}; var tabs = {65535:["t0","All Methods"],2:["t2","Instance Methods"],8:["t4","Concrete Methods"]}; var altColor = "altColor"; var rowColor = "rowColor"; @@ -129,9 +129,21 @@

Constructor Summary

Constructor and Description +RGBColorType(int[] color) +
RGBColorType class
+ + + RGBColorType(int R, int G, - int B)  + int B) +
RGBColorType class
+ + + +RGBColorType(java.lang.String str) +
RGBColorType class
+ @@ -150,41 +162,65 @@

Method Summary

boolean -compareTo(RGBColorType color)  +compareTo(RGBColorType color) +
compare the color with another RGBColorType object
+ int -getB()  +getB() +
get G component of the color
+ int[] -getColor()  +getColor() +
get color as an array of R,G,B components
+ int -getG()  +getG() +
get B component of the color
+ int -getR()  +getR() +
get R component of the color
+ void setColor(int R, int G, - int B)  + int B) +
Set a color
+ void -setColor(java.lang.String str)  +setColor(java.lang.String str) +
Set a color
+ -java.lang.String -toString()  +void +setColorFromHexCode(java.lang.String hexCode) +
Set a color using hexadecimal code
+ java.lang.String -toStringColor()  +toString() +
return color components as a string
+ + + +java.lang.String +toStringColor() +
return color components as a string
+
    @@ -211,12 +247,47 @@

    Constructor Detail

    -
      +

      • RGBColorType

        public RGBColorType(int R,
                     int G,
                     int B)
        +
        RGBColorType class
        +
        +
        Parameters:
        +
        R - Red intensity, [0,255]
        +
        G - Green intensity, [0,255]
        +
        B - Blue intensity, [0,255]
        +
        +
        • +
      + + + +
        +
      • +

        RGBColorType

        +
        public RGBColorType(int[] color)
        +
        RGBColorType class
        +
        +
        Parameters:
        +
        color - int[3], where colors are in order {R,G,B}
        +
        +
        • +
      + + + +
        +
      • +

        RGBColorType

        +
        public RGBColorType(java.lang.String str)
        +
        RGBColorType class
        +
        +
        Parameters:
        +
        str - string, where colors are in order "R G B"
        +
      @@ -234,6 +305,25 @@

      Method Detail

    • setColor

      public void setColor(java.lang.String str)
      +
      Set a color
      +
      +
      Parameters:
      +
      str - string, where colors are in order "R G B"
      +
      +
      • +
    + + + +
      +
    • +

      setColorFromHexCode

      +
      public void setColorFromHexCode(java.lang.String hexCode)
      +
      Set a color using hexadecimal code
      +
      +
      Parameters:
      +
      hexCode - string, where colors are in format like "#00AAFF"
      +
    @@ -245,6 +335,11 @@

    setColor

    public void setColor(int R,
                      int G,
                      int B)
    +
    Set a color
    +
    +
    Parameters:
    +
    str - string, where colors are in order {R,G,B}
    +
@@ -254,6 +349,11 @@

setColor

  • getR

    public int getR()
    +
    get R component of the color
    +
    +
    Returns:
    +
    R component
    +
    •  @@ -263,6 +363,11 @@

    getR

  • getB

    public int getB()
    +
    get G component of the color
    +
    +
    Returns:
    +
    G component
    +
    •  @@ -272,6 +377,11 @@

    getB

  • getG

    public int getG()
    +
    get B component of the color
    +
    +
    Returns:
    +
    B component
    +
    •  @@ -281,6 +391,11 @@

    getG

  • getColor

    public int[] getColor()
    +
    get color as an array of R,G,B components
    +
    +
    Returns:
    +
    int[] {R, G, B}
    +
    •  @@ -290,9 +405,12 @@

    getColor

  • toString

    public java.lang.String toString()
    +
    return color components as a string
    Overrides:
    toString in class java.lang.Object
    +
    Returns:
    +
    string "R:#, G:#, B:#"
    • @@ -303,6 +421,11 @@

    toString

  • toStringColor

    public java.lang.String toStringColor()
    +
    return color components as a string
    +
    +
    Returns:
    +
    string with format "# # #"
    +
    •  @@ -312,6 +435,13 @@

    toStringColor

  • compareTo

    public boolean compareTo(RGBColorType color)
    +
    compare the color with another RGBColorType object
    +
    +
    Parameters:
    +
    color - RGBColorType
    +
    Returns:
    +
    boolean
    +
    • diff --git a/docs/swarm/robot/types/class-use/ProximityReadingType.html b/docs/swarm/robot/types/class-use/ProximityReadingType.html index deec860..fc7cb80 100644 --- a/docs/swarm/robot/types/class-use/ProximityReadingType.html +++ b/docs/swarm/robot/types/class-use/ProximityReadingType.html @@ -2,9 +2,9 @@ - + Uses of Class swarm.robot.types.ProximityReadingType - + diff --git a/docs/swarm/robot/types/class-use/RGBColorType.html b/docs/swarm/robot/types/class-use/RGBColorType.html index ffcbd02..1fffbcd 100644 --- a/docs/swarm/robot/types/class-use/RGBColorType.html +++ b/docs/swarm/robot/types/class-use/RGBColorType.html @@ -2,9 +2,9 @@ - + Uses of Class swarm.robot.types.RGBColorType - + @@ -120,6 +120,19 @@

    Uses of RGBColorType in swarm.robot.types

    + + + + + + + + + + + +
    Methods in swarm.robot.types that return RGBColorType 
    Modifier and TypeMethod and Description
    RGBColorType[]ProximityReadingType.colors() 
    + @@ -128,7 +141,9 @@

    Uses of

    - +
    Methods in swarm.robot.types with parameters of type RGBColorType 
    Modifier and TypebooleanRGBColorType.compareTo(RGBColorType color) RGBColorType.compareTo(RGBColorType color) +
    compare the color with another RGBColorType object
    +
    diff --git a/docs/swarm/robot/types/package-frame.html b/docs/swarm/robot/types/package-frame.html index 65b0b01..4a0b421 100644 --- a/docs/swarm/robot/types/package-frame.html +++ b/docs/swarm/robot/types/package-frame.html @@ -2,9 +2,9 @@ - + swarm.robot.types - + diff --git a/docs/swarm/robot/types/package-summary.html b/docs/swarm/robot/types/package-summary.html index 2ed51db..37cff37 100644 --- a/docs/swarm/robot/types/package-summary.html +++ b/docs/swarm/robot/types/package-summary.html @@ -2,9 +2,9 @@ - + swarm.robot.types - + diff --git a/docs/swarm/robot/types/package-tree.html b/docs/swarm/robot/types/package-tree.html index c3a7c4c..7465784 100644 --- a/docs/swarm/robot/types/package-tree.html +++ b/docs/swarm/robot/types/package-tree.html @@ -2,9 +2,9 @@ - + swarm.robot.types Class Hierarchy - + diff --git a/docs/swarm/robot/types/package-use.html b/docs/swarm/robot/types/package-use.html index 8811bee..0af3b67 100644 --- a/docs/swarm/robot/types/package-use.html +++ b/docs/swarm/robot/types/package-use.html @@ -2,9 +2,9 @@ - + Uses of Package swarm.robot.types - +