Merge branch 'master' of ssh://git.gag.com/scm/git/fw/altos
[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.bluetooth.BluetoothAdapter;
32 import android.content.Intent;
33 import android.content.Context;
34 import android.os.Bundle;
35 import android.os.IBinder;
36 import android.os.Handler;
37 import android.os.Message;
38 import android.os.Messenger;
39 import android.os.RemoteException;
40 import android.os.Looper;
41 import android.util.Log;
42 import android.widget.Toast;
43 import android.location.Location;
44 import android.location.LocationManager;
45 import android.location.LocationListener;
46 import android.location.Criteria;
47
48 import org.altusmetrum.altoslib_5.*;
49
50
51 public class TelemetryService extends Service implements LocationListener {
52
53         private static final String TAG = "TelemetryService";
54         private static final boolean D = true;
55
56         static final int MSG_REGISTER_CLIENT   = 1;
57         static final int MSG_UNREGISTER_CLIENT = 2;
58         static final int MSG_CONNECT           = 3;
59         static final int MSG_CONNECTED         = 4;
60         static final int MSG_CONNECT_FAILED    = 5;
61         static final int MSG_DISCONNECTED      = 6;
62         static final int MSG_TELEMETRY         = 7;
63         static final int MSG_SETFREQUENCY      = 8;
64         static final int MSG_CRC_ERROR         = 9;
65         static final int MSG_SETBAUD           = 10;
66
67         // Unique Identification Number for the Notification.
68         // We use it on Notification start, and to cancel it.
69         private int NOTIFICATION = R.string.telemetry_service_label;
70         //private NotificationManager mNM;
71
72         // Timer - we wake up every now and then to decide if the service should stop
73         private Timer timer = new Timer();
74
75         ArrayList<Messenger> mClients = new ArrayList<Messenger>(); // Keeps track of all current registered clients.
76         final Handler   mHandler   = new IncomingHandler(this);
77         final Messenger mMessenger = new Messenger(mHandler); // Target we publish for clients to send messages to IncomingHandler.
78
79         // Name of the connected device
80         String address;
81         private AltosBluetooth  mAltosBluetooth  = null;
82         private TelemetryReader mTelemetryReader = null;
83         private TelemetryLogger mTelemetryLogger = null;
84         // Local Bluetooth adapter
85         private BluetoothAdapter mBluetoothAdapter = null;
86
87         private TelemetryState  telemetry_state;
88
89         // Last data seen; send to UI when it starts
90
91         // Handler of incoming messages from clients.
92         static class IncomingHandler extends Handler {
93                 private final WeakReference<TelemetryService> service;
94                 IncomingHandler(TelemetryService s) { service = new WeakReference<TelemetryService>(s); }
95
96                 @Override
97                 public void handleMessage(Message msg) {
98                         TelemetryService s = service.get();
99                         if (s == null)
100                                 return;
101                         switch (msg.what) {
102                         case MSG_REGISTER_CLIENT:
103                                 s.mClients.add(msg.replyTo);
104                                 try {
105                                         // Now we try to send the freshly connected UI any relavant information about what
106                                         // we're talking to
107                                         msg.replyTo.send(s.message());
108                                 } catch (RemoteException e) {
109                                         s.mClients.remove(msg.replyTo);
110                                 }
111                                 if (D) Log.d(TAG, "Client bound to service");
112                                 break;
113                         case MSG_UNREGISTER_CLIENT:
114                                 s.mClients.remove(msg.replyTo);
115                                 if (D) Log.d(TAG, "Client unbound from service");
116                                 break;
117                         case MSG_CONNECT:
118                                 if (D) Log.d(TAG, "Connect command received");
119                                 String address = (String) msg.obj;
120                                 AltosDroidPreferences.set_active_device(address);
121                                 s.startAltosBluetooth(address);
122                                 break;
123                         case MSG_CONNECTED:
124                                 if (D) Log.d(TAG, "Connected to device");
125                                 try {
126                                         s.connected();
127                                 } catch (InterruptedException ie) {
128                                 }
129                                 break;
130                         case MSG_CONNECT_FAILED:
131                                 if (D) Log.d(TAG, "Connection failed... retrying");
132                                 if (s.address != null)
133                                         s.startAltosBluetooth(s.address);
134                                 break;
135                         case MSG_DISCONNECTED:
136                                 Log.d(TAG, "MSG_DISCONNECTED");
137                                 s.stopAltosBluetooth();
138                                 break;
139                         case MSG_TELEMETRY:
140                                 // forward telemetry messages
141                                 s.telemetry_state.state = (AltosState) msg.obj;
142                                 if (D) Log.d(TAG, "MSG_TELEMETRY");
143                                 s.sendMessageToClients();
144                                 break;
145                         case MSG_CRC_ERROR:
146                                 // forward crc error messages
147                                 s.telemetry_state.crc_errors = (Integer) msg.obj;
148                                 if (D) Log.d(TAG, "MSG_CRC_ERROR");
149                                 s.sendMessageToClients();
150                                 break;
151                         case MSG_SETFREQUENCY:
152                                 if (D) Log.d(TAG, "MSG_SETFREQUENCY");
153                                 s.telemetry_state.frequency = (Double) msg.obj;
154                                 if (s.telemetry_state.connect == TelemetryState.CONNECT_CONNECTED) {
155                                         try {
156                                                 s.mAltosBluetooth.set_radio_frequency(s.telemetry_state.frequency);
157                                                 s.mAltosBluetooth.save_frequency();
158                                         } catch (InterruptedException e) {
159                                         } catch (TimeoutException e) {
160                                         }
161                                 }
162                                 s.sendMessageToClients();
163                                 break;
164                         case MSG_SETBAUD:
165                                 if (D) Log.d(TAG, "MSG_SETBAUD");
166                                 s.telemetry_state.telemetry_rate = (Integer) msg.obj;
167                                 if (s.telemetry_state.connect == TelemetryState.CONNECT_CONNECTED) {
168                                         s.mAltosBluetooth.set_telemetry_rate(s.telemetry_state.telemetry_rate);
169                                         s.mAltosBluetooth.save_telemetry_rate();
170                                 }
171                                 s.sendMessageToClients();
172                                 break;
173                         default:
174                                 super.handleMessage(msg);
175                         }
176                 }
177         }
178
179         private Message message() {
180                 if (telemetry_state == null)
181                         Log.d(TAG, "telemetry_state null!");
182                 return Message.obtain(null, AltosDroid.MSG_STATE, telemetry_state);
183         }
184
185         private void sendMessageToClients() {
186                 Message m = message();
187                 if (D) Log.d(TAG, String.format("Send message to %d clients", mClients.size()));
188                 for (int i=mClients.size()-1; i>=0; i--) {
189                         try {
190                                 if (D) Log.d(TAG, String.format("Send message to client %d", i));
191                                 mClients.get(i).send(m);
192                         } catch (RemoteException e) {
193                                 mClients.remove(i);
194                         }
195                 }
196         }
197
198         private void stopAltosBluetooth() {
199                 if (D) Log.d(TAG, "stopAltosBluetooth(): begin");
200                 telemetry_state.connect = TelemetryState.CONNECT_READY;
201                 if (mTelemetryReader != null) {
202                         if (D) Log.d(TAG, "stopAltosBluetooth(): stopping TelemetryReader");
203                         mTelemetryReader.interrupt();
204                         try {
205                                 mTelemetryReader.join();
206                         } catch (InterruptedException e) {
207                         }
208                         mTelemetryReader = null;
209                 }
210                 if (mTelemetryLogger != null) {
211                         if (D) Log.d(TAG, "stopAltosBluetooth(): stopping TelemetryLogger");
212                         mTelemetryLogger.stop();
213                         mTelemetryLogger = null;
214                 }
215                 if (mAltosBluetooth != null) {
216                         if (D) Log.d(TAG, "stopAltosBluetooth(): stopping AltosBluetooth");
217                         mAltosBluetooth.close();
218                         mAltosBluetooth = null;
219                 }
220                 telemetry_state.config = null;
221                 if (D) Log.d(TAG, "stopAltosBluetooth(): send message to clients");
222                 sendMessageToClients();
223         }
224
225         private void startAltosBluetooth(String address) {
226                 // Get the BLuetoothDevice object
227                 BluetoothDevice device = mBluetoothAdapter.getRemoteDevice(address);
228
229                 this.address = address;
230                 if (mAltosBluetooth == null) {
231                         if (D) Log.d(TAG, String.format("startAltosBluetooth(): Connecting to %s (%s)", device.getName(), device.getAddress()));
232                         mAltosBluetooth = new AltosBluetooth(device, mHandler);
233                         telemetry_state.connect = TelemetryState.CONNECT_CONNECTING;
234                         sendMessageToClients();
235                 } else {
236                         // This is a bit of a hack - if it appears we're still connected, we treat this as a restart.
237                         // So, to give a suitable delay to teardown/bringup, we just schedule a resend of a message
238                         // to ourselves in a few seconds time that will ultimately call this method again.
239                         // ... then we tear down the existing connection.
240                         // We do it this way around so that we don't lose a reference to the device when this method
241                         // is called on reception of MSG_CONNECT_FAILED in the handler above.
242                         mHandler.sendMessageDelayed(Message.obtain(null, MSG_CONNECT, address), 3000);
243                         stopAltosBluetooth();
244                 }
245         }
246
247         private void connected() throws InterruptedException {
248                 if (D) Log.d(TAG, "connected top");
249                 try {
250                         if (mAltosBluetooth == null)
251                                 throw new InterruptedException("no bluetooth");
252                         telemetry_state.config = mAltosBluetooth.config_data();
253                         mAltosBluetooth.set_radio_frequency(telemetry_state.frequency);
254                         mAltosBluetooth.set_telemetry_rate(telemetry_state.telemetry_rate);
255                 } catch (TimeoutException e) {
256                         // If this timed out, then we really want to retry it, but
257                         // probably safer to just retry the connection from scratch.
258                         mHandler.obtainMessage(MSG_CONNECT_FAILED).sendToTarget();
259                         return;
260                 }
261
262                 if (D) Log.d(TAG, "connected bluetooth configured");
263                 telemetry_state.connect = TelemetryState.CONNECT_CONNECTED;
264
265                 mTelemetryReader = new TelemetryReader(mAltosBluetooth, mHandler);
266                 mTelemetryReader.start();
267
268                 if (D) Log.d(TAG, "connected TelemetryReader started");
269
270                 mTelemetryLogger = new TelemetryLogger(this, mAltosBluetooth);
271
272                 if (D) Log.d(TAG, "Notify UI of connection");
273
274                 sendMessageToClients();
275         }
276
277         private void onTimerTick() {
278                 if (D) Log.d(TAG, "Timer wakeup");
279                 try {
280                         if (mClients.size() <= 0 && telemetry_state.connect != TelemetryState.CONNECT_CONNECTED) {
281                                 stopSelf();
282                         }
283                 } catch (Throwable t) {
284                         Log.e(TAG, "Timer failed: ", t);
285                 }
286         }
287
288
289         @Override
290         public void onCreate() {
291                 // Get local Bluetooth adapter
292                 mBluetoothAdapter = BluetoothAdapter.getDefaultAdapter();
293
294                 // If the adapter is null, then Bluetooth is not supported
295                 if (mBluetoothAdapter == null) {
296                         Toast.makeText(this, "Bluetooth is not available", Toast.LENGTH_LONG).show();
297                 }
298
299                 // Initialise preferences
300                 AltosDroidPreferences.init(this);
301
302                 telemetry_state = new TelemetryState();
303
304                 // Create a reference to the NotificationManager so that we can update our notifcation text later
305                 //mNM = (NotificationManager)getSystemService(NOTIFICATION_SERVICE);
306
307                 telemetry_state.connect = TelemetryState.CONNECT_READY;
308
309                 // Start our timer - first event in 10 seconds, then every 10 seconds after that.
310                 timer.scheduleAtFixedRate(new TimerTask(){ public void run() {onTimerTick();}}, 10000L, 10000L);
311
312                 // Listen for GPS and Network position updates
313                 LocationManager locationManager = (LocationManager) this.getSystemService(Context.LOCATION_SERVICE);
314
315                 locationManager.requestLocationUpdates(LocationManager.GPS_PROVIDER, 1000, 1, this);
316
317                 String address = AltosDroidPreferences.active_device();
318                 if (address != null)
319                         startAltosBluetooth(address);
320         }
321
322         @Override
323         public int onStartCommand(Intent intent, int flags, int startId) {
324                 Log.i("TelemetryService", "Received start id " + startId + ": " + intent);
325
326                 CharSequence text = getText(R.string.telemetry_service_started);
327
328                 // Create notification to be displayed while the service runs
329                 Notification notification = new Notification(R.drawable.am_status_c, text, 0);
330
331                 // The PendingIntent to launch our activity if the user selects this notification
332                 PendingIntent contentIntent = PendingIntent.getActivity(this, 0,
333                                 new Intent(this, AltosDroid.class), 0);
334
335                 // Set the info for the views that show in the notification panel.
336                 notification.setLatestEventInfo(this, getText(R.string.telemetry_service_label), text, contentIntent);
337
338                 // Set the notification to be in the "Ongoing" section.
339                 notification.flags |= Notification.FLAG_ONGOING_EVENT;
340
341                 // Move us into the foreground.
342                 startForeground(NOTIFICATION, notification);
343
344                 // We want this service to continue running until it is explicitly
345                 // stopped, so return sticky.
346                 return START_STICKY;
347         }
348
349         @Override
350         public void onDestroy() {
351
352                 // Stop listening for location updates
353                 ((LocationManager) getSystemService(Context.LOCATION_SERVICE)).removeUpdates(this);
354
355                 // Stop the bluetooth Comms threads
356                 stopAltosBluetooth();
357
358                 // Demote us from the foreground, and cancel the persistent notification.
359                 stopForeground(true);
360
361                 // Stop our timer
362                 if (timer != null) {timer.cancel();}
363
364                 // Tell the user we stopped.
365                 Toast.makeText(this, R.string.telemetry_service_stopped, Toast.LENGTH_SHORT).show();
366         }
367
368         @Override
369         public IBinder onBind(Intent intent) {
370                 return mMessenger.getBinder();
371         }
372
373
374         public void onLocationChanged(Location location) {
375                 telemetry_state.location = location;
376                 if (D) Log.d(TAG, "location changed");
377                 sendMessageToClients();
378         }
379
380         public void onStatusChanged(String provider, int status, Bundle extras) {
381         }
382
383         public void onProviderEnabled(String provider) {
384         }
385
386         public void onProviderDisabled(String provider) {
387         }
388
389 }