root / trunk / code / projects / colonet / ColonetGUI / ColonetServerInterface.java @ 402
History | View | Annotate | Download (17.9 KB)
1 |
/*
|
---|---|
2 |
* ColonetServerInterface.java
|
3 |
* Gregory Tress
|
4 |
*/
|
5 |
|
6 |
import java.net.*; |
7 |
import java.io.*; |
8 |
import javax.swing.JOptionPane; |
9 |
import javax.swing.JTextArea; |
10 |
|
11 |
/**
|
12 |
* The Colonet server interface class. This class handles direct communication with the Colonet server. The general
|
13 |
* contract is that this class will encapsulate the process of sending commands and requests to the server and
|
14 |
* receiving responses. This class should provide methods to send specific commands and requests so that the
|
15 |
* Colonet can easily communicate with the server. When data is received from the server, the ColonetServerInterface
|
16 |
* decides how to handle it and in many cases this means simply passing it to the Colonet.
|
17 |
* <p>
|
18 |
* The motivation is that any number of Colonet-type classes could be designed for different purposes if needed, with
|
19 |
* this class being used by each one for communication.
|
20 |
* For instance, if an application is designed which only monitors sensor data, or that only has access to
|
21 |
* the task queue, etc., the application could easily plug in to this interface.
|
22 |
* The Colonet should generally not contain communication-specific code or Strings of command and request data.
|
23 |
* If additional commands and requests are needed for permanent implementation, it is suggested that convenience
|
24 |
* classes be created in the ColonetServerInterface and called from the Colonet.
|
25 |
*
|
26 |
* @author Gregory Tress
|
27 |
*/
|
28 |
public class ColonetServerInterface |
29 |
{ |
30 |
|
31 |
/* STATIC FIELDS
|
32 |
* Eugene Marinelli, Fan
|
33 |
* 10/27/06
|
34 |
*
|
35 |
* Colonet Definitions - common definitions and structs used in all colonet
|
36 |
* applications
|
37 |
|
38 |
Old packet structure:
|
39 |
|
40 |
COMMAND PACKET STRUCTURE
|
41 |
1: SEND_TO_ROBOT
|
42 |
2: # of robot, or GLOBAL_DEST
|
43 |
3: COLONET_COMMMAND
|
44 |
4: message code (i.e. ORB_SET)
|
45 |
5: any data, as many that fit in the packet
|
46 |
|
47 |
REQUEST PACKET STRUCTURE
|
48 |
1: REQUEST_FROM_SERVER
|
49 |
2: # of robot
|
50 |
3: COLONET_REQUEST
|
51 |
4: ???
|
52 |
|
53 |
9/12/07 New server interface structure
|
54 |
Client will no longer send full robot packets to the server.
|
55 |
Commands will be defined as necessary.
|
56 |
*/
|
57 |
|
58 |
//General Colonet Interface
|
59 |
public static final String SEND_TO_ROBOT = "0"; |
60 |
public static final String REQUEST_FROM_SERVER = "1"; |
61 |
public static final String RESPONSE_TO_CLIENT_REQUEST = "2"; |
62 |
public static final String REQUEST_BOM_MATRIX = "144"; |
63 |
public static final String REQUEST_XBEE_IDS = "145"; |
64 |
|
65 |
public static final String COLONET_COMMAND = "13"; //0x0D |
66 |
public static final String COLONET_REQUEST = "14"; //0x0E |
67 |
public static final String CORONET_RESPONSE = "15"; //0x0F |
68 |
public static final String GLOBAL_DEST = "200"; |
69 |
|
70 |
//Queue instructions
|
71 |
public static final String COLONET_QUEUE = "100"; |
72 |
public static final String QUEUE_UPDATE = "101"; |
73 |
public static final String QUEUE_ADD = "102"; |
74 |
public static final String QUEUE_REMOVE = "103"; |
75 |
public static final String QUEUE_REORDER = "104"; |
76 |
|
77 |
//Use BATTERY to request battery level
|
78 |
public static final String BATTERY = "56"; //0x38 |
79 |
|
80 |
//MOTORS
|
81 |
public static final String MOTORS_INIT = "23"; //0x17 |
82 |
public static final String MOTOR1_SET = "24"; //0x18 |
83 |
public static final String MOTOR2_SET = "25"; //0x19 |
84 |
public static final String MOTORS_OFF = "26"; //0x1A |
85 |
public static final String MOVE = "27"; //0x1B |
86 |
public static final String MOVE_AVOID = "28"; //0x1C |
87 |
|
88 |
//BUZZER
|
89 |
public static final String BUZZER_INIT = "0"; //0x00 |
90 |
public static final String BUZZER_SET_VAL = "1"; //0x01 |
91 |
public static final String BUZZER_SET_FREQ = "2"; //0x02 |
92 |
public static final String BUZZER_CHIRP = "3"; //0x03 |
93 |
public static final String BUZZER_OFF = "4"; //0x04 |
94 |
|
95 |
//ORB
|
96 |
public static final String ORB_INIT = "12"; //0x0C |
97 |
public static final String ORB_SET = "13"; //0x0D |
98 |
public static final String ORB_SET_COLOR = "14"; //0x0E |
99 |
public static final String ORB_DISABLE = "15"; //0x0F |
100 |
public static final String ORB_ENABLE = "16"; //0x10 |
101 |
public static final String ORB_SET_DIO = "17"; //0x11 |
102 |
public static final String LED_INIT = "18"; //0x12 |
103 |
public static final String LED_USER = "19"; //0x13 |
104 |
public static final String ORB_SET_NUM_NS = "20"; //0x14 |
105 |
public static final String ORB_SET_NUM = "21"; //0x15 |
106 |
public static final String ORB_SEND = "22"; //0x16 |
107 |
|
108 |
|
109 |
Colonet colonet; //save reference to the entire applet locally
|
110 |
Socket socket;
|
111 |
OutputStreamWriter out;
|
112 |
BufferedReader reader;
|
113 |
DataListener dataListener; |
114 |
JTextArea log, txtMatrix;
|
115 |
|
116 |
|
117 |
/*
|
118 |
* FUNCTION IMPLEMENTATIONS
|
119 |
*/
|
120 |
|
121 |
/**
|
122 |
* Constructs a new ColonetServerInterface. When constructing a ColonetServerInterface, a valid Colonet object
|
123 |
* reference must be provided to ensure that data is routed correctly.
|
124 |
*
|
125 |
* @param colonet The Colonet object to save locally. This reference cannot be changed once the
|
126 |
* ColonetSreverInterface has been contsructed.
|
127 |
* @throws NullPointerException if colonet is null
|
128 |
*
|
129 |
*/
|
130 |
public ColonetServerInterface (Colonet colonet) {
|
131 |
this.colonet = colonet;
|
132 |
this.log = colonet.getLog();
|
133 |
this.txtMatrix = colonet.getMatrixInput();
|
134 |
dataListener = new DataListener();
|
135 |
} |
136 |
|
137 |
public Socket getSocket () { |
138 |
return socket;
|
139 |
} |
140 |
|
141 |
public OutputStreamWriter getOutputStreamWriter () { |
142 |
return out;
|
143 |
} |
144 |
|
145 |
public BufferedReader getBufferedReader () { |
146 |
return reader;
|
147 |
} |
148 |
|
149 |
public boolean isReady () { |
150 |
if (socket == null || out == null || reader == null) |
151 |
return false; |
152 |
if (!socket.isConnected() || socket.isClosed() || socket.isInputShutdown() || socket.isOutputShutdown())
|
153 |
return false; |
154 |
return true; |
155 |
} |
156 |
|
157 |
public boolean isInputReady () { |
158 |
try {
|
159 |
if (reader.ready()) return true; |
160 |
} catch (Exception e) { |
161 |
return false; |
162 |
} |
163 |
return false; |
164 |
} |
165 |
|
166 |
public String getLine () { |
167 |
if (this.isReady()) { |
168 |
try {
|
169 |
return reader.readLine();
|
170 |
} catch (IOException e) { |
171 |
return null; |
172 |
} |
173 |
} else {
|
174 |
return null; |
175 |
} |
176 |
} |
177 |
|
178 |
/**
|
179 |
* Create socket connection to Colonet server.
|
180 |
* If successful, start thread for listening for incoming data.
|
181 |
*/
|
182 |
public void connect (String strHost, String strPort) { |
183 |
//make sure hostname and port are valid
|
184 |
if (strHost.equals("") || strPort.equals("")) { |
185 |
err("Please enter a hostname and port.");
|
186 |
return;
|
187 |
} |
188 |
int port = 0; |
189 |
try {
|
190 |
port = Integer.parseInt(strPort);
|
191 |
} catch (Exception e) { |
192 |
err("Invalid port");
|
193 |
return;
|
194 |
} |
195 |
|
196 |
//make sure we aren't already connected.
|
197 |
if (socket != null && socket.isConnected()) { |
198 |
return;
|
199 |
} |
200 |
|
201 |
try {
|
202 |
socket = new Socket(strHost, port); |
203 |
} catch (UnknownHostException e) { |
204 |
log.append("Unknown host exception.\n");
|
205 |
err("Unknown Host Exception");
|
206 |
return;
|
207 |
} catch (IOException e) { |
208 |
log.append("IO Exception.\n");
|
209 |
err("Could not create socket to " + strHost + ".\n" + e); |
210 |
return;
|
211 |
} catch (java.security.AccessControlException e) {
|
212 |
log.append("Access Control Exception.\n");
|
213 |
err("Permission denied by java.security.AccessControlException.\n\n"
|
214 |
+"You may only connect to the server from which this applet was loaded.");
|
215 |
return;
|
216 |
} |
217 |
if (socket == null || !socket.isConnected()) { |
218 |
log.append("Connection is not ready. Try connecting again.\n");
|
219 |
return;
|
220 |
} |
221 |
try {
|
222 |
out = new OutputStreamWriter(socket.getOutputStream()); |
223 |
reader = new BufferedReader(new InputStreamReader(socket.getInputStream())); |
224 |
} catch (IOException e) { |
225 |
warn("Could not get transfer streams from socket connection.");
|
226 |
} |
227 |
dataListener.start(); |
228 |
|
229 |
} |
230 |
|
231 |
/*
|
232 |
* sendString - only this method should actually write data to the output stream
|
233 |
*/
|
234 |
private void sendString (String s) { |
235 |
//make sure we can send
|
236 |
if (!this.isReady()) { |
237 |
log.append("Could not send data.\n");
|
238 |
return;
|
239 |
} |
240 |
//send packet
|
241 |
try {
|
242 |
Thread.sleep(50); //pause to be safe |
243 |
out.write(s); |
244 |
out.flush(); |
245 |
//log.append("Sent: " + s + "\n");
|
246 |
} catch (IOException e) { |
247 |
log.setText("Could not send data.\n");
|
248 |
} catch (InterruptedException e) { |
249 |
log.setText("Thread InterruptedException in sendData\n");
|
250 |
} |
251 |
} |
252 |
|
253 |
/**
|
254 |
* General send-to-server method. This method is used by other command methods, which are usually convenience
|
255 |
* methods that simply specify arguments to this method. A command consists of a String which holds integers
|
256 |
* separated by spaces. This method should not be used directly unless you know the format of the particular
|
257 |
* command you are sending. If implementing a particular command for permanent use, it is recommended that
|
258 |
* you create a new wrapper method specific to that command in the ColonetServerInterface file.
|
259 |
*
|
260 |
* Note that no checking is performed in this method to ensure the correct formatting of the String arguments.
|
261 |
* If malformed commands or robot numbers are specified, the behavior of the request at the server will be
|
262 |
* undefined and could result in server failure.
|
263 |
*
|
264 |
* @param s The command String in its correct format. The format of a command String is ultimately specified
|
265 |
* by the Colonet server application and may change.
|
266 |
* @param robotNumber The number of the robot that is the subject of the command, if any. The robot number
|
267 |
* is specified as a single integer in a String. If the command does not have a single robot subject, this
|
268 |
* argument can be null or an empty String, whichever is convenient.
|
269 |
*/
|
270 |
public void sendData (String s, String robotNumber) { |
271 |
//create packet
|
272 |
String packet = ""; |
273 |
packet += ColonetServerInterface.SEND_TO_ROBOT; |
274 |
if (robotNumber != null) |
275 |
packet += " " + robotNumber;
|
276 |
packet += " " + ColonetServerInterface.COLONET_COMMAND;
|
277 |
packet += " " + s; //add the command code here |
278 |
packet += "\n";
|
279 |
sendString(packet); |
280 |
} |
281 |
|
282 |
/**
|
283 |
* General request-from-server method. This method is used by other request methods, which are usually convenience
|
284 |
* methods that simply specify arguments to this method. A request consists of a String which holds integers
|
285 |
* separated by spaces. This method should not be used directly unless you know the format of the particular
|
286 |
* request you are making. If implementing a particular request, it is recommended that you create a new method
|
287 |
* specific to that request in the ColonetServerInterface file.
|
288 |
*
|
289 |
*/
|
290 |
private void sendRequest (String s, String robotNumber) { |
291 |
//create packet
|
292 |
String packet = ""; |
293 |
packet += ColonetServerInterface.REQUEST_FROM_SERVER; |
294 |
packet += " " + robotNumber;
|
295 |
//packet += " " + ColonetServerInterface.COLONET_REQUEST;
|
296 |
packet += " " + s; //add the command code here |
297 |
packet += "\n";
|
298 |
sendString(packet); |
299 |
} |
300 |
|
301 |
/**
|
302 |
* Sends a request to the server to report the entire BOM sensor matrix. The server will reply at its convenience.
|
303 |
* No guarantee is made (end-to-end or otherwise) that the server will respond in a timely manner or at all
|
304 |
* to any individual request.
|
305 |
*/
|
306 |
public void sendSensorDataRequest () { |
307 |
sendRequest(ColonetServerInterface.REQUEST_BOM_MATRIX, "");
|
308 |
} |
309 |
|
310 |
/**
|
311 |
* Sends a request to the server to report a list of XBee IDs. The server will reply at its convenience.
|
312 |
* The purpose of having this list is to ensure that robots are properly identified for control purposes.
|
313 |
* This keeps robot identification consistent between sessions and prevents arbitrary assignment.
|
314 |
* No guarantee is made (end-to-end or otherwise) that the server will respond in a timely manner or at all
|
315 |
* to any individual request.
|
316 |
*
|
317 |
* @see Colonet#parseXBeeIDs(String)
|
318 |
*/
|
319 |
public void sendXBeeIDRequest () { |
320 |
sendRequest(ColonetServerInterface.REQUEST_XBEE_IDS, "");
|
321 |
} |
322 |
|
323 |
/**
|
324 |
* Sends a battery request for a specific robot to the server. The server will reply at its convenience.
|
325 |
* Behavior is undefined if an invalid robot number is specified. The server will probably not respond in
|
326 |
* this case.
|
327 |
* No guarantee is made (end-to-end or otherwise) that the server will respond in a timely manner or at all
|
328 |
* to any individual request.
|
329 |
*
|
330 |
* @param robotNum The number of the robot for which we are requesting the battery. Note that this value
|
331 |
* is sent as-is to the server. No mapping to or from XBee IDs is performed. The contract for this is
|
332 |
* currently undefined.
|
333 |
* @see Colonet#parseBattery(String)
|
334 |
*/
|
335 |
public void sendBatteryRequest (int robotNum) { |
336 |
sendData(ColonetServerInterface.BATTERY, "" + robotNum);
|
337 |
} |
338 |
|
339 |
/*
|
340 |
* Queue management
|
341 |
*/
|
342 |
private void sendQueueInstruction (String inst) { |
343 |
String packet = ""; |
344 |
packet += ColonetServerInterface.COLONET_QUEUE; |
345 |
packet += " " + inst;
|
346 |
packet += "\n";
|
347 |
sendString(packet); |
348 |
} |
349 |
|
350 |
/**
|
351 |
* Notifies the Colonet server to add a task to the current task queue. The Colonet server holds the canonical
|
352 |
* task queue. Any applet can send tasks to add to the queue. Local copies of the queue in the applet are for
|
353 |
* display purposes only, and are not authoritative when adding tasks. All clients send additions asynchronously,
|
354 |
* and as a result no guarantee is made that a task will be added in the specificed location in the queue or at
|
355 |
* all. If an invalid position is specified, the task will probably not be added to the queue and may cause
|
356 |
* server failure. Due to the asynchronous nature of the queue, we cannot easily account for concurrent
|
357 |
* modification failures on the client side.
|
358 |
*
|
359 |
* @param pos The position in the queue at which we would like the task to be placed. Note that this is not
|
360 |
* guaranteed. Invalid positions may cause the task to be discarded at the server.
|
361 |
* @param data The String containing the command code(s) for the task and any arguments necessary to fully
|
362 |
* define the behavior of the task. This format is currently not specified. In the future, the canonical format
|
363 |
* of the data String will ultimately be defined by the Colonet server.
|
364 |
* @param description A String that contains a description of the task. This will be the message displayed to
|
365 |
* the user when information about the task is requested.
|
366 |
*/
|
367 |
public void sendQueueAdd (int pos, String data, String description) { |
368 |
String packet = ""; |
369 |
packet += ColonetServerInterface.QUEUE_ADD; |
370 |
packet += " " + pos;
|
371 |
packet += " " + data;
|
372 |
packet += " [" + description + "]"; |
373 |
packet += "\n";
|
374 |
sendQueueInstruction(packet); |
375 |
} |
376 |
|
377 |
/**
|
378 |
* Notifies the Colonet server to remove a task from the current task queue. The Colonet server holds the canonical
|
379 |
* task queue. Any applet can remove a task from the queue. Local copies of the queue in the applet are for
|
380 |
* display purposes only, and are not authoritative when removing tasks. All clients remove tasks asynchronously,
|
381 |
* and as a result no guarantee is made that the correct task will actually be removed.
|
382 |
* If an invalid position is specified, the state of the queue is undefined and server failure may result.
|
383 |
* Due to the asynchronous nature of the queue, we cannot easily account for concurrent
|
384 |
* modification failures on the client side.
|
385 |
*
|
386 |
* @param pos The position in the queue at which we would like the task to be removed. Note that this is not
|
387 |
* guaranteed. Invalid positions may result in a corrupted queue.
|
388 |
*/
|
389 |
public void sendQueueRemove (int pos) { |
390 |
String packet = ""; |
391 |
packet += ColonetServerInterface.QUEUE_REMOVE; |
392 |
packet += " " + pos;
|
393 |
packet += "\n";
|
394 |
sendQueueInstruction(packet); |
395 |
} |
396 |
|
397 |
/**
|
398 |
* Notifies the Colonet server to reorder tasks in the current task queue. The Colonet server holds the canonical
|
399 |
* task queue. Any applet can reorder tasks in the queue. Local copies of the queue in the applet are for
|
400 |
* display purposes only, and are not authoritative when reordering tasks. All clients reorder tasks asynchronously,
|
401 |
* and as a result no guarantee is made that the correct tasks will actually be reordered.
|
402 |
* If an invalid position is specified, the state of the queue is undefined and server failure may result.
|
403 |
* Due to the asynchronous nature of the queue, we cannot easily account for concurrent
|
404 |
* modification failures on the client side.
|
405 |
*
|
406 |
* @param pos1 The queue position of a task which we would like to reorder.
|
407 |
* @param pos2 The queue position of a task which we would like to reorder.
|
408 |
*/
|
409 |
public void sendQueueReorder (int pos1, int pos2) { |
410 |
String packet = ""; |
411 |
packet += ColonetServerInterface.QUEUE_REORDER; |
412 |
packet += " " + pos1;
|
413 |
packet += " " + pos2;
|
414 |
packet += "\n";
|
415 |
sendQueueInstruction(packet); |
416 |
} |
417 |
|
418 |
public void sendQueueUpdate () { |
419 |
sendQueueInstruction(ColonetServerInterface.QUEUE_UPDATE); |
420 |
} |
421 |
|
422 |
/**
|
423 |
* Display informational message box on the screen. Used for casual communicaton to the user.
|
424 |
* @param text Text to display
|
425 |
*/
|
426 |
public void msg (String text) { |
427 |
JOptionPane.showMessageDialog(null, text, "Colonet", JOptionPane.INFORMATION_MESSAGE); |
428 |
} |
429 |
|
430 |
/**
|
431 |
* Display warning message box on the screen. Used for minor alerts or exceptions.
|
432 |
* @param text Text to display
|
433 |
*/
|
434 |
public void warn (String text) { |
435 |
JOptionPane.showMessageDialog(null, text, "Colonet", JOptionPane.WARNING_MESSAGE); |
436 |
} |
437 |
|
438 |
/**
|
439 |
* Display error message box on the screen. Used for major errors or exceptions in the program.
|
440 |
* @param text Text to display
|
441 |
*/
|
442 |
public void err (String text) { |
443 |
JOptionPane.showMessageDialog(null, text, "Colonet", JOptionPane.ERROR_MESSAGE); |
444 |
} |
445 |
|
446 |
|
447 |
/*
|
448 |
* DataListener thread.
|
449 |
*
|
450 |
*/
|
451 |
class DataListener extends Thread { |
452 |
final int DATALISTENER_DELAY = 222; |
453 |
|
454 |
public DataListener () {
|
455 |
super("Colonet DataListener"); |
456 |
} |
457 |
|
458 |
public void run () { |
459 |
String line;
|
460 |
while (true) { |
461 |
try {
|
462 |
line = getLine(); |
463 |
if (line != null) { |
464 |
parseData(line); |
465 |
} |
466 |
Thread.sleep(DATALISTENER_DELAY);
|
467 |
} catch (InterruptedException e) { |
468 |
return;
|
469 |
} |
470 |
} |
471 |
} |
472 |
|
473 |
public void parseData (String line) { |
474 |
// Sensor Matrix
|
475 |
if (line.startsWith(ColonetServerInterface.RESPONSE_TO_CLIENT_REQUEST + " " + |
476 |
ColonetServerInterface.REQUEST_BOM_MATRIX)) |
477 |
colonet.parseMatrix(line); |
478 |
// Task Queue
|
479 |
else if (line.startsWith(ColonetServerInterface.COLONET_QUEUE)) |
480 |
colonet.parseQueue(line); |
481 |
// XBee IDs
|
482 |
else if (line.startsWith(ColonetServerInterface.RESPONSE_TO_CLIENT_REQUEST + " " + |
483 |
ColonetServerInterface.REQUEST_XBEE_IDS)) |
484 |
colonet.parseXBeeIDs(line); |
485 |
// Battery
|
486 |
else if (line.charAt(0) == Integer.parseInt(ColonetServerInterface.RESPONSE_TO_CLIENT_REQUEST) |
487 |
&& line.charAt(2) == Integer.parseInt(ColonetServerInterface.BATTERY)) |
488 |
colonet.parseBattery(line); |
489 |
/*
|
490 |
else if (line.startsWith(ColonetServerInterface.RESPONSE_TO_CLIENT_REQUEST + " " +
|
491 |
ColonetServerInterface.BATTERY))
|
492 |
colonet.parseBattery(line);
|
493 |
*/
|
494 |
// Unknown type
|
495 |
else
|
496 |
System.out.println("Got data:" + line); |
497 |
|
498 |
} |
499 |
|
500 |
} |
501 |
|
502 |
} |