altosdroid: initial implementation of telemetry logging.
[fw/altos] / altosdroid / src / org / altusmetrum / AltosDroid / TelemetryService.java
index a1c5fede10b668c395ebd1d90e6c46418432c02f..3cb498e8a1995c05ddc2edc954846016dfe83c79 100644 (file)
@@ -1,5 +1,5 @@
 /*
- * Copyright © 2012 Mike Beattie <mike@ethernal.org>
+ * Copyright Â© 2012 Mike Beattie <mike@ethernal.org>
  *
  * This program is free software; you can redistribute it and/or modify
  * it under the terms of the GNU General Public License as published by
 
 package org.altusmetrum.AltosDroid;
 
+import java.lang.ref.WeakReference;
+import java.util.ArrayList;
+import java.util.concurrent.TimeoutException;
+import java.util.Timer;
+import java.util.TimerTask;
+
 import android.app.Notification;
-import android.app.NotificationManager;
+//import android.app.NotificationManager;
 import android.app.PendingIntent;
 import android.app.Service;
+import android.bluetooth.BluetoothDevice;
 import android.content.Intent;
-import android.os.Binder;
+//import android.os.Bundle;
 import android.os.IBinder;
+import android.os.Handler;
+import android.os.Message;
+import android.os.Messenger;
+import android.os.RemoteException;
 import android.util.Log;
 import android.widget.Toast;
 
-// Need the following import to get access to the app resources, since this
-// class is in a sub-package.
-import org.altusmetrum.AltosDroid.R;
+import org.altusmetrum.AltosLib.*;
 
+public class TelemetryService extends Service {
 
+       private static final String TAG = "TelemetryService";
+       private static final boolean D = true;
 
-public class TelemetryService extends Service {
+       static final int MSG_REGISTER_CLIENT   = 1;
+       static final int MSG_UNREGISTER_CLIENT = 2;
+       static final int MSG_CONNECT           = 3;
+       static final int MSG_CONNECTED         = 4;
+       static final int MSG_CONNECT_FAILED    = 5;
+       static final int MSG_DISCONNECTED      = 6;
+       static final int MSG_TELEMETRY         = 7;
+       static final int MSG_SETFREQUENCY      = 8;
+
+       public static final int STATE_NONE       = 0;
+       public static final int STATE_READY      = 1;
+       public static final int STATE_CONNECTING = 2;
+       public static final int STATE_CONNECTED  = 3;
 
-    /**
-     * Class for clients to access.  Because we know this service always
-     * runs in the same process as its clients, we don't need to deal with
-     * IPC.
-     */
-    public class TelemetryBinder extends Binder {
-        TelemetryService getService() {
-            return TelemetryService.this;
-        }
-    }
        // Unique Identification Number for the Notification.
        // We use it on Notification start, and to cancel it.
        private int NOTIFICATION = R.string.telemetry_service_label;
-       private NotificationManager mNM;
+       //private NotificationManager mNM;
+
+       // Timer - we wake up every now and then to decide if the service should stop
+       private Timer timer = new Timer();
+
+       ArrayList<Messenger> mClients = new ArrayList<Messenger>(); // Keeps track of all current registered clients.
+       final Handler   mHandler   = new IncomingHandler(this);
+       final Messenger mMessenger = new Messenger(mHandler); // Target we publish for clients to send messages to IncomingHandler.
+
+       // Name of the connected device
+       private BluetoothDevice device           = null;
+       private AltosBluetooth  mAltosBluetooth  = null;
+       private AltosConfigData mConfigData      = null;
+       private TelemetryReader mTelemetryReader = null;
+       private TelemetryLogger mTelemetryLogger = null;
+
+       // internally track state of bluetooth connection
+       private int state = STATE_NONE;
+
+       // Handler of incoming messages from clients.
+       static class IncomingHandler extends Handler {
+               private final WeakReference<TelemetryService> service;
+               IncomingHandler(TelemetryService s) { service = new WeakReference<TelemetryService>(s); }
+
+               @Override
+               public void handleMessage(Message msg) {
+                       TelemetryService s = service.get();
+                       switch (msg.what) {
+                       case MSG_REGISTER_CLIENT:
+                               s.mClients.add(msg.replyTo);
+                               try {
+                                       // Now we try to send the freshly connected UI any relavant information about what
+                                       // we're talking to - Basically state and Config Data.
+                                       msg.replyTo.send(Message.obtain(null, AltosDroid.MSG_STATE_CHANGE, s.state, -1, s.mConfigData));
+                               } catch (RemoteException e) {
+                                       s.mClients.remove(msg.replyTo);
+                               }
+                               if (D) Log.d(TAG, "Client bound to service");
+                               break;
+                       case MSG_UNREGISTER_CLIENT:
+                               s.mClients.remove(msg.replyTo);
+                               if (D) Log.d(TAG, "Client unbound from service");
+                               break;
+                       case MSG_CONNECT:
+                               if (D) Log.d(TAG, "Connect command received");
+                               s.device = (BluetoothDevice) msg.obj;
+                               s.startAltosBluetooth();
+                               break;
+                       case MSG_CONNECTED:
+                               if (D) Log.d(TAG, "Connected to device");
+                               s.connected();
+                               break;
+                       case MSG_CONNECT_FAILED:
+                               if (D) Log.d(TAG, "Connection failed... retrying");
+                               s.startAltosBluetooth();
+                               break;
+                       case MSG_DISCONNECTED:
+                               // Only do the following if we haven't been shutdown elsewhere..
+                               if (s.device != null) {
+                                       if (D) Log.d(TAG, "Disconnected from " + s.device.getName());
+                                       s.stopAltosBluetooth();
+                               }
+                               break;
+                       case MSG_TELEMETRY:
+                               s.sendMessageToClients(Message.obtain(null, AltosDroid.MSG_TELEMETRY, msg.obj));
+                               break;
+                       case MSG_SETFREQUENCY:
+                               if (s.state == STATE_CONNECTED) {
+                                       try {
+                                               s.mAltosBluetooth.set_radio_frequency((Double) msg.obj);
+                                       } catch (InterruptedException e) {
+                                       } catch (TimeoutException e) {
+                                       }
+                               }
+                               break;
+                       default:
+                               super.handleMessage(msg);
+                       }
+               }
+       }
+
+       private void sendMessageToClients(Message m) {
+               for (int i=mClients.size()-1; i>=0; i--) {
+                       try {
+                               mClients.get(i).send(m);
+                       } catch (RemoteException e) {
+                               mClients.remove(i);
+                       }
+               }
+       }
+
+       private void stopAltosBluetooth() {
+               if (D) Log.d(TAG, "stopAltosBluetooth(): begin");
+               setState(STATE_READY);
+               if (mTelemetryReader != null) {
+                       if (D) Log.d(TAG, "stopAltosBluetooth(): stopping TelemetryReader");
+                       mTelemetryReader.interrupt();
+                       try {
+                               mTelemetryReader.join();
+                       } catch (InterruptedException e) {
+                       }
+                       mTelemetryReader = null;
+               }
+               if (mTelemetryLogger != null) {
+                       if (D) Log.d(TAG, "stopAltosBluetooth(): stopping TelemetryLogger");
+                       mTelemetryLogger.stop();
+                       mTelemetryLogger = null;
+               }
+               if (mAltosBluetooth != null) {
+                       if (D) Log.d(TAG, "stopAltosBluetooth(): stopping AltosBluetooth");
+                       mAltosBluetooth.close();
+                       mAltosBluetooth = null;
+               }
+               device = null;
+               mConfigData = null;
+       }
+
+       private void startAltosBluetooth() {
+               if (mAltosBluetooth == null) {
+                       if (D) Log.d(TAG, String.format("startAltosBluetooth(): Connecting to %s (%s)", device.getName(), device.getAddress()));
+                       mAltosBluetooth = new AltosBluetooth(device, mHandler);
+                       setState(STATE_CONNECTING);
+               } else {
+                       // This is a bit of a hack - if it appears we're still connected, we treat this as a restart.
+                       // So, to give a suitable delay to teardown/bringup, we just schedule a resend of a message
+                       // to ourselves in a few seconds time that will ultimately call this method again.
+                       // ... then we tear down the existing connection.
+                       // We do it this way around so that we don't lose a reference to the device when this method
+                       // is called on reception of MSG_CONNECT_FAILED in the handler above.
+                       mHandler.sendMessageDelayed(Message.obtain(null, MSG_CONNECT, device), 3000);
+                       stopAltosBluetooth();
+               }
+       }
+
+       private synchronized void setState(int s) {
+               if (D) Log.d(TAG, "setState(): " + state + " -> " + s);
+               state = s;
+
+               // This shouldn't be required - mConfigData should be null for any non-connected
+               // state, but to be safe and to reduce message size
+               AltosConfigData acd = (state == STATE_CONNECTED) ? mConfigData : null;
+
+               sendMessageToClients(Message.obtain(null, AltosDroid.MSG_STATE_CHANGE, state, -1, acd));
+       }
+
+       private void connected() {
+               try {
+                       mConfigData = mAltosBluetooth.config_data();
+               } catch (InterruptedException e) {
+               } catch (TimeoutException e) {
+                       // If this timed out, then we really want to retry it, but
+                       // probably safer to just retry the connection from scratch.
+                       mHandler.obtainMessage(MSG_CONNECT_FAILED).sendToTarget();
+                       return;
+               }
+
+               setState(STATE_CONNECTED);
+
+               mTelemetryReader = new TelemetryReader(mAltosBluetooth, mHandler);
+               mTelemetryReader.start();
+               
+               mTelemetryLogger = new TelemetryLogger(this, mAltosBluetooth);
+       }
+
+
+       private void onTimerTick() {
+               if (D) Log.d(TAG, "Timer wakeup");
+               try {
+                       if (mClients.size() <= 0 && state != STATE_CONNECTED) {
+                               stopSelf();
+                       }
+               } catch (Throwable t) {
+                       Log.e(TAG, "Timer failed: ", t);
+               }
+       }
+
 
        @Override
        public void onCreate() {
                // Create a reference to the NotificationManager so that we can update our notifcation text later
-               mNM = (NotificationManager)getSystemService(NOTIFICATION_SERVICE);
+               //mNM = (NotificationManager)getSystemService(NOTIFICATION_SERVICE);
+
+               setState(STATE_READY);
+
+               // Start our timer - first event in 10 seconds, then every 10 seconds after that.
+               timer.scheduleAtFixedRate(new TimerTask(){ public void run() {onTimerTick();}}, 10000L, 10000L);
+
        }
 
        @Override
@@ -67,7 +262,7 @@ public class TelemetryService extends Service {
 
                // The PendingIntent to launch our activity if the user selects this notification
                PendingIntent contentIntent = PendingIntent.getActivity(this, 0,
-                new Intent(this, TelemetryServiceActivities.Controller.class), 0);
+                               new Intent(this, AltosDroid.class), 0);
 
                // Set the info for the views that show in the notification panel.
                notification.setLatestEventInfo(this, getText(R.string.telemetry_service_label), text, contentIntent);
@@ -86,21 +281,23 @@ public class TelemetryService extends Service {
        @Override
        public void onDestroy() {
 
+               // Stop the bluetooth Comms threads
+               stopAltosBluetooth();
 
                // Demote us from the foreground, and cancel the persistent notification.
                stopForeground(true);
 
+               // Stop our timer
+               if (timer != null) {timer.cancel();}
+
                // Tell the user we stopped.
                Toast.makeText(this, R.string.telemetry_service_stopped, Toast.LENGTH_SHORT).show();
        }
 
        @Override
        public IBinder onBind(Intent intent) {
-        return mBinder;
+               return mMessenger.getBinder();
        }
 
-    // This is the object that receives interactions from clients.  See
-    // RemoteService for a more complete example.
-    private final IBinder mBinder = new TelemetryBinder();
 
 }