altosdroid: Mike was right -- only need one LocationListener
[fw/altos] / altosdroid / src / org / altusmetrum / AltosDroid / TelemetryService.java
1 /*
2  * Copyright © 2012 Mike Beattie <mike@ethernal.org>
3  *
4  * This program is free software; you can redistribute it and/or modify
5  * it under the terms of the GNU General Public License as published by
6  * the Free Software Foundation; version 2 of the License.
7  *
8  * This program is distributed in the hope that it will be useful, but
9  * WITHOUT ANY WARRANTY; without even the implied warranty of
10  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
11  * General Public License for more details.
12  *
13  * You should have received a copy of the GNU General Public License along
14  * with this program; if not, write to the Free Software Foundation, Inc.,
15  * 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA.
16  */
17
18 package org.altusmetrum.AltosDroid;
19
20 import java.lang.ref.WeakReference;
21 import java.util.ArrayList;
22 import java.util.concurrent.TimeoutException;
23 import java.util.Timer;
24 import java.util.TimerTask;
25
26 import android.app.Notification;
27 //import android.app.NotificationManager;
28 import android.app.PendingIntent;
29 import android.app.Service;
30 import android.bluetooth.BluetoothDevice;
31 import android.content.Intent;
32 import android.content.Context;
33 import android.os.Bundle;
34 import android.os.IBinder;
35 import android.os.Handler;
36 import android.os.Message;
37 import android.os.Messenger;
38 import android.os.RemoteException;
39 import android.util.Log;
40 import android.widget.Toast;
41 import android.location.Location;
42 import android.location.LocationManager;
43 import android.location.LocationListener;
44
45 import org.altusmetrum.altoslib_1.*;
46
47 class AltosLocationListener implements LocationListener {
48         TelemetryService service;
49
50         public void onLocationChanged(Location location) {
51                 service.sendLocation(location);
52         }
53
54         public void onStatusChanged(String provider, int status, Bundle extras) {
55         }
56
57         public void onProviderEnabled(String provider) {
58         }
59
60         public void onProviderDisabled(String provider) {
61         }
62
63         public AltosLocationListener(TelemetryService service) {
64                 this.service = service;
65         }
66 }
67
68 public class TelemetryService extends Service {
69
70         private static final String TAG = "TelemetryService";
71         private static final boolean D = true;
72
73         static final int MSG_REGISTER_CLIENT   = 1;
74         static final int MSG_UNREGISTER_CLIENT = 2;
75         static final int MSG_CONNECT           = 3;
76         static final int MSG_CONNECTED         = 4;
77         static final int MSG_CONNECT_FAILED    = 5;
78         static final int MSG_DISCONNECTED      = 6;
79         static final int MSG_TELEMETRY         = 7;
80         static final int MSG_SETFREQUENCY      = 8;
81         static final int MSG_LOCATION          = 9;
82         static final int MSG_CRC_ERROR         = 10;
83
84         public static final int STATE_NONE       = 0;
85         public static final int STATE_READY      = 1;
86         public static final int STATE_CONNECTING = 2;
87         public static final int STATE_CONNECTED  = 3;
88
89         // Unique Identification Number for the Notification.
90         // We use it on Notification start, and to cancel it.
91         private int NOTIFICATION = R.string.telemetry_service_label;
92         //private NotificationManager mNM;
93
94         // Timer - we wake up every now and then to decide if the service should stop
95         private Timer timer = new Timer();
96
97         ArrayList<Messenger> mClients = new ArrayList<Messenger>(); // Keeps track of all current registered clients.
98         final Handler   mHandler   = new IncomingHandler(this);
99         final Messenger mMessenger = new Messenger(mHandler); // Target we publish for clients to send messages to IncomingHandler.
100
101         // Name of the connected device
102         private BluetoothDevice device           = null;
103         private AltosBluetooth  mAltosBluetooth  = null;
104         private AltosConfigData mConfigData      = null;
105         private TelemetryReader mTelemetryReader = null;
106         private TelemetryLogger mTelemetryLogger = null;
107
108         // internally track state of bluetooth connection
109         private int state = STATE_NONE;
110
111         // location listeners
112
113         private AltosLocationListener locationListener;
114         
115         // Last data seen; send to UI when it starts
116
117         private AltosState last_state;
118         private Location last_location;
119         private int last_crc_errors;
120
121         // Handler of incoming messages from clients.
122         static class IncomingHandler extends Handler {
123                 private final WeakReference<TelemetryService> service;
124                 IncomingHandler(TelemetryService s) { service = new WeakReference<TelemetryService>(s); }
125
126                 @Override
127                 public void handleMessage(Message msg) {
128                         TelemetryService s = service.get();
129                         switch (msg.what) {
130                         case MSG_REGISTER_CLIENT:
131                                 s.mClients.add(msg.replyTo);
132                                 try {
133                                         // Now we try to send the freshly connected UI any relavant information about what
134                                         // we're talking to - Basically state and Config Data.
135                                         msg.replyTo.send(Message.obtain(null, AltosDroid.MSG_STATE_CHANGE, s.state, -1, s.mConfigData));
136                                 } catch (RemoteException e) {
137                                         s.mClients.remove(msg.replyTo);
138                                 }
139                                 if (D) Log.d(TAG, "Client bound to service");
140                                 if (s.last_state != null)
141                                         s.sendTelemetry(s.last_state);
142                                 if (s.last_location != null)
143                                         s.sendLocation(s.last_location);
144                                 if (s.last_crc_errors != 0)
145                                         s.sendCrcErrors(s.last_crc_errors);
146                                 break;
147                         case MSG_UNREGISTER_CLIENT:
148                                 s.mClients.remove(msg.replyTo);
149                                 if (D) Log.d(TAG, "Client unbound from service");
150                                 break;
151                         case MSG_CONNECT:
152                                 if (D) Log.d(TAG, "Connect command received");
153                                 s.device = (BluetoothDevice) msg.obj;
154                                 s.startAltosBluetooth();
155                                 break;
156                         case MSG_CONNECTED:
157                                 if (D) Log.d(TAG, "Connected to device");
158                                 s.connected();
159                                 break;
160                         case MSG_CONNECT_FAILED:
161                                 if (D) Log.d(TAG, "Connection failed... retrying");
162                                 s.startAltosBluetooth();
163                                 break;
164                         case MSG_DISCONNECTED:
165                                 // Only do the following if we haven't been shutdown elsewhere..
166                                 if (s.device != null) {
167                                         if (D) Log.d(TAG, "Disconnected from " + s.device.getName());
168                                         s.stopAltosBluetooth();
169                                 }
170                                 break;
171                         case MSG_TELEMETRY:
172                                 s.sendMessageToClients(Message.obtain(null, AltosDroid.MSG_TELEMETRY, msg.obj));
173                                 break;
174                         case MSG_SETFREQUENCY:
175                                 if (s.state == STATE_CONNECTED) {
176                                         try {
177                                                 s.mAltosBluetooth.set_radio_frequency((Double) msg.obj);
178                                         } catch (InterruptedException e) {
179                                         } catch (TimeoutException e) {
180                                         }
181                                 }
182                                 break;
183                         default:
184                                 super.handleMessage(msg);
185                         }
186                 }
187         }
188
189         public void sendTelemetry(AltosState state) {
190                 last_state = state;
191                 mHandler.obtainMessage(MSG_TELEMETRY, state).sendToTarget();
192         }
193
194         public void sendLocation(Location location) {
195                 last_location = location;
196                 mHandler.obtainMessage(MSG_LOCATION, location).sendToTarget();
197         }
198
199         public void sendCrcErrors(int crc_errors) {
200                 last_crc_errors = crc_errors;
201                 mHandler.obtainMessage(MSG_CRC_ERROR, new Integer(crc_errors)).sendToTarget();
202         }
203
204         private void sendMessageToClients(Message m) {
205                 for (int i=mClients.size()-1; i>=0; i--) {
206                         try {
207                                 mClients.get(i).send(m);
208                         } catch (RemoteException e) {
209                                 mClients.remove(i);
210                         }
211                 }
212         }
213
214         private void stopAltosBluetooth() {
215                 if (D) Log.d(TAG, "stopAltosBluetooth(): begin");
216                 setState(STATE_READY);
217                 if (mTelemetryReader != null) {
218                         if (D) Log.d(TAG, "stopAltosBluetooth(): stopping TelemetryReader");
219                         mTelemetryReader.interrupt();
220                         try {
221                                 mTelemetryReader.join();
222                         } catch (InterruptedException e) {
223                         }
224                         mTelemetryReader = null;
225                 }
226                 if (mTelemetryLogger != null) {
227                         if (D) Log.d(TAG, "stopAltosBluetooth(): stopping TelemetryLogger");
228                         mTelemetryLogger.stop();
229                         mTelemetryLogger = null;
230                 }
231                 if (mAltosBluetooth != null) {
232                         if (D) Log.d(TAG, "stopAltosBluetooth(): stopping AltosBluetooth");
233                         mAltosBluetooth.close();
234                         mAltosBluetooth = null;
235                 }
236                 device = null;
237                 mConfigData = null;
238         }
239
240         private void startAltosBluetooth() {
241                 if (mAltosBluetooth == null) {
242                         if (D) Log.d(TAG, String.format("startAltosBluetooth(): Connecting to %s (%s)", device.getName(), device.getAddress()));
243                         mAltosBluetooth = new AltosBluetooth(device, mHandler);
244                         setState(STATE_CONNECTING);
245                 } else {
246                         // This is a bit of a hack - if it appears we're still connected, we treat this as a restart.
247                         // So, to give a suitable delay to teardown/bringup, we just schedule a resend of a message
248                         // to ourselves in a few seconds time that will ultimately call this method again.
249                         // ... then we tear down the existing connection.
250                         // We do it this way around so that we don't lose a reference to the device when this method
251                         // is called on reception of MSG_CONNECT_FAILED in the handler above.
252                         mHandler.sendMessageDelayed(Message.obtain(null, MSG_CONNECT, device), 3000);
253                         stopAltosBluetooth();
254                 }
255         }
256
257         private synchronized void setState(int s) {
258                 if (D) Log.d(TAG, "setState(): " + state + " -> " + s);
259                 state = s;
260
261                 // This shouldn't be required - mConfigData should be null for any non-connected
262                 // state, but to be safe and to reduce message size
263                 AltosConfigData acd = (state == STATE_CONNECTED) ? mConfigData : null;
264
265                 sendMessageToClients(Message.obtain(null, AltosDroid.MSG_STATE_CHANGE, state, -1, acd));
266         }
267
268         private void connected() {
269                 try {
270                         mConfigData = mAltosBluetooth.config_data();
271                 } catch (InterruptedException e) {
272                 } catch (TimeoutException e) {
273                         // If this timed out, then we really want to retry it, but
274                         // probably safer to just retry the connection from scratch.
275                         mHandler.obtainMessage(MSG_CONNECT_FAILED).sendToTarget();
276                         return;
277                 }
278
279                 setState(STATE_CONNECTED);
280
281                 mTelemetryReader = new TelemetryReader(this, mAltosBluetooth, mHandler);
282                 mTelemetryReader.start();
283                 
284                 mTelemetryLogger = new TelemetryLogger(this, mAltosBluetooth);
285         }
286
287
288         private void onTimerTick() {
289                 if (D) Log.d(TAG, "Timer wakeup");
290                 try {
291                         if (mClients.size() <= 0 && state != STATE_CONNECTED) {
292                                 stopSelf();
293                         }
294                 } catch (Throwable t) {
295                         Log.e(TAG, "Timer failed: ", t);
296                 }
297         }
298
299
300         @Override
301         public void onCreate() {
302                 // Create a reference to the NotificationManager so that we can update our notifcation text later
303                 //mNM = (NotificationManager)getSystemService(NOTIFICATION_SERVICE);
304
305                 setState(STATE_READY);
306
307                 // Start our timer - first event in 10 seconds, then every 10 seconds after that.
308                 timer.scheduleAtFixedRate(new TimerTask(){ public void run() {onTimerTick();}}, 10000L, 10000L);
309
310                 // Listen for GPS and Network position updates
311                 locationListener = new AltosLocationListener(this);
312
313                 LocationManager locationManager = (LocationManager) this.getSystemService(Context.LOCATION_SERVICE);
314                 
315                 locationManager.requestLocationUpdates(LocationManager.GPS_PROVIDER, 0, 0, locationListener);
316                 locationManager.requestLocationUpdates(LocationManager.NETWORK_PROVIDER, 0, 0, locationListener);
317         }
318
319         @Override
320         public int onStartCommand(Intent intent, int flags, int startId) {
321                 Log.i("TelemetryService", "Received start id " + startId + ": " + intent);
322
323                 CharSequence text = getText(R.string.telemetry_service_started);
324
325                 // Create notification to be displayed while the service runs
326                 Notification notification = new Notification(R.drawable.am_status_c, text, 0);
327
328                 // The PendingIntent to launch our activity if the user selects this notification
329                 PendingIntent contentIntent = PendingIntent.getActivity(this, 0,
330                                 new Intent(this, AltosDroid.class), 0);
331
332                 // Set the info for the views that show in the notification panel.
333                 notification.setLatestEventInfo(this, getText(R.string.telemetry_service_label), text, contentIntent);
334
335                 // Set the notification to be in the "Ongoing" section.
336                 notification.flags |= Notification.FLAG_ONGOING_EVENT;
337
338                 // Move us into the foreground.
339                 startForeground(NOTIFICATION, notification);
340
341                 // We want this service to continue running until it is explicitly
342                 // stopped, so return sticky.
343                 return START_STICKY;
344         }
345
346         @Override
347         public void onDestroy() {
348
349                 // Stop listening for location updates
350                 LocationManager locationManager = (LocationManager) this.getSystemService(Context.LOCATION_SERVICE);
351                 locationManager.removeUpdates(locationListener);
352
353                 // Stop the bluetooth Comms threads
354                 stopAltosBluetooth();
355
356                 // Demote us from the foreground, and cancel the persistent notification.
357                 stopForeground(true);
358
359                 // Stop our timer
360                 if (timer != null) {timer.cancel();}
361
362                 // Tell the user we stopped.
363                 Toast.makeText(this, R.string.telemetry_service_stopped, Toast.LENGTH_SHORT).show();
364         }
365
366         @Override
367         public IBinder onBind(Intent intent) {
368                 return mMessenger.getBinder();
369         }
370
371
372 }