Wnlab

User Tools

Site Tools

You are here: start » giraffplus » android-middleware
Trace:
giraffplus:android-middleware

Differences

This shows you the differences between two versions of the page.

Link to this comparison view

Both sides previous revisionPrevious revision
Next revision		Previous revision
giraffplus:android-middleware [2013-08-06 16:04] – [One-time setup] Add middleware configuration details andreagiraffplus:android-middleware [2014-05-30 16:10] (current) – [GiraffPlus packages] davide
Line 1: Line 1:
 ====== GiraffPlus on Android ====== ====== GiraffPlus on Android ======
 Make sure you’ve obtained the archive interfaces.middleware.zip (it is in the Android\giraff.android folder from the svn checkout). This file contains the AIDL interface needed to communicate with the middleware. In order to setup your application you need to extract this file to the src/ directory of the project. Make sure you’ve obtained the archive interfaces.middleware.zip (it is in the Android\giraff.android folder from the svn checkout). This file contains the AIDL interface needed to communicate with the middleware. In order to setup your application you need to extract this file to the src/ directory of the project.
 +
 +
 +===== GiraffPlus packages ====
 +
 +Middleware:
 +  * https://www.dropbox.com/s/zfcqrvcqtlz934v/gp-communicationconnector-1.0.2.apk (last update on 15-May-2014)
 +  * https://www.dropbox.com/s/pwet4ise2ta3k46/gp-middleware-1.0.2.apk (last update on 15-May-2014)
 +  
 +  Previous versions:
 +  * https://www.dropbox.com/s/gmnlbcx3gb2gn6v/communicationconnector.mqtt.apk (last update on 06-Feb-2014 15.30)
 +  * https://www.dropbox.com/s/8wh3o1km1g61j0i/middleware.apk (last update on 06-Feb-2014 15.30)
 ===== One-time setup ===== ===== One-time setup =====
 Applications that use this infrastructure require that the middleware application (Android/giraff.android/middleware folder from the svn checkout) and at least one communication connector application (there is only one by now in the communicationconnector.mqtt Android/giraff.android/ folder from the svn checkout) are previously installed to the device. Applications that use this infrastructure require that the middleware application (Android/giraff.android/middleware folder from the svn checkout) and at least one communication connector application (there is only one by now in the communicationconnector.mqtt Android/giraff.android/ folder from the svn checkout) are previously installed to the device.
  
 Also, the middleware needs to be configured **before** using any of the clients applications, this can be done using the middleware launcher icon. The configuration includes the mandatory parameters: Also, the middleware needs to be configured **before** using any of the clients applications, this can be done using the middleware launcher icon. The configuration includes the mandatory parameters:
-  * URI of the MQTT broker ("<nowiki>tcp://xxx.yyy.zzz.www</nowiki>"); +  * URI of the MQTT broker ("<nowiki>ssl://xxx.yyy.zzz.www</nowiki>"); 
-  * user of the MQTT broker; +  * Trust keystore password 
-  * password of the MQTT broker; +  * Client keystore password 
-  * location string.+  * Path to the trust keystore file (bks format) 
 +  * Path to the client keystore file (bks format) 
 + 
 +**Notice.** In order to convert a jks keystore to a bks keystore: 
 +  - Download the utility Portecle (http://portecle.sourceforge.net/) 
 +  - Open the *.jks keystore 
 +  - Select //Tools// -> //Change Keystore Type// -> //BKS// 
 +  - Enter the password if asked and save the newly created bks keystore. If during the process an exception like “Illegal key size or default parameters” occurs, the Java Cryptography Extension (JCE) unlimited strength jurisdiction policy files has to be installed. In case, follow this steps: 
 +    * On the Oracle Java Downloads webpage (http://www.oracle.com/technetwork/java/javase/downloads/index.html), at the bottom of the page under “Additional Resources” download the JCE package. 
 +    * Unzip the archive and copy the local_policy.jar and US_export_policy.jar files to the $JAVA_HOME/jre/lib/security overwriting those already present. 
 +    * Restart Portecle
  
 Make sure to kill the "middleware" Android process after further changes. Note that these parameters may change in the future. Refer to the [[middleware|wiki]] for more information on the Giraff+ system. Make sure to kill the "middleware" Android process after further changes. Note that these parameters may change in the future. Refer to the [[middleware|wiki]] for more information on the Giraff+ system.
Line 54: Line 75:
 {{:giraffplus:screenshot_2013-07-24-15-11-27.png?direct&300|}} {{:giraffplus:screenshot_2013-07-24-15-30-53.png?direct&300|}} {{:giraffplus:screenshot_2013-07-24-15-11-27.png?direct&300|}} {{:giraffplus:screenshot_2013-07-24-15-30-53.png?direct&300|}}
  
-The SensorsService class initializes sensors (creating for each sensors present on the device a descriptor by means of android Bundle done in the SensorsDescriptors class), than calls methods of the middleware to announce sensors and publish data to the context bus. To do this the SensorsService follows these steps: +The SensorsService class initializes the accelerometer sensor (creating a descriptor by means of android Bundle done in the SensorsDescriptors class), then calls methods of the middleware to announce it and publishes data to the context bus. To do this the SensorsService follows these steps: 
-  - Import middleware clsses+  - Import middleware classes
   - Implement a service connection    - Implement a service connection 
   - Implement the callback logic (optional)   - Implement the callback logic (optional)
Line 127: Line 148:
 ==== Implement an error callback ==== ==== Implement an error callback ====
 ---- ----
-Each method in the API takes an optional (can be null) errorListener parameter used to asynchronously report errors:+Each method in the API takes an optional (can be null) resultListener parameter used to asynchronously report successes or errors:
 <code java> <code java>
-private IMiddlewareErrorCallback.Stub errorCallback = new IMiddlewareErrorCallback.Stub() {+private IMiddlewareResultCallback.Stub resultCallback = new IMiddlewareResultCallback.Stub() {
          
     @Override     @Override
     public void error(Bundle info) throws RemoteException {     public void error(Bundle info) throws RemoteException {
         // ...         // ...
 +    }
 +    
 +    @Override
 +    public void success () throws RemoteException {
 +       // ...
     }     }
 }; };
Line 177: Line 203:
 </code> </code>
  
-The SensorsDescriptors constructor creates a descriptor for each sensor present on the device (for sake of consistency with the GiraffPlus ecosystem we choose to publish data on the subtree **sensor/** of the context bus, please respect this constraint):+We called the method sensorsDescriptors.initialize(middleware) in the SensorsService class when we implemented the service connection. This method calls the method to create the sensor descriptors, announces them and then register a listener to be notified about the sensor changes:
  
 <code java> <code java>
-private final static int SENSORS_DELAY = SensorManager.SENSOR_DELAY_NORMAL; +public void initialize(IMiddleware middleware) { 
-private final static SparseArray<String> SENSORS = new SparseArray<String>() +    this.middleware = middleware; 
-private SparseArray<Pair<Sensor, Bundle>> SERVICE_DESCRIPTORS = new SparseArray<Pair<Sensor, Bundle>>(); +    try { 
-private SensorManager sensorManager; +        createSensorDescriptors (); 
-static { +        announce(); 
-    // desirable sensors +        register(); 
-    SENSORS.append(Sensor.TYPE_ACCELEROMETER, "TYPE_ACCELEROMETER"); +    } catch (RemoteException e) { 
-    SENSORS.append(Sensor.TYPE_AMBIENT_TEMPERATURE, "TYPE_AMBIENT_TEMPERATURE"); +        Log.e(TAG, "cannot announce");
-    SENSORS.append(Sensor.TYPE_GRAVITY, "TYPE_GRAVITY"); +
-    SENSORS.append(Sensor.TYPE_GYROSCOPE, "TYPE_GYROSCOPE"); +
-    SENSORS.append(Sensor.TYPE_LIGHT, "TYPE_LIGHT"); +
-    SENSORS.append(Sensor.TYPE_LINEAR_ACCELERATION, "TYPE_LINEAR_ACCELERATION"); +
-    SENSORS.append(Sensor.TYPE_MAGNETIC_FIELD, "TYPE_MAGNETIC_FIELD"); +
-    SENSORS.append(Sensor.TYPE_PRESSURE, "TYPE_PRESSURE"); +
-    SENSORS.append(Sensor.TYPE_PROXIMITY, "TYPE_PROXIMITY"); +
-    SENSORS.append(Sensor.TYPE_RELATIVE_HUMIDITY, "TYPE_RELATIVE_HUMIDITY"); +
-    SENSORS.append(Sensor.TYPE_ROTATION_VECTOR, "TYPE_ROTATION_VECTOR"); +
-} +
- +
-public SensorsDescriptors(Context context) { +
-    Sensor sensor; +
-    Bundle serviceDescriptor; +
- +
-    sensorManager = (SensorManager) context.getSystemService(Context.SENSOR_SERVICE); +
- +
-    // get device id +
-    TelephonyManager telephonyManager = (TelephonyManager) context.getSystemService(Context.TELEPHONY_SERVICE); +
-    String id = telephonyManager.getDeviceId(); +
- +
-    // for each desirable sensor +
-    for (int i = 0; i < SENSORS.size(); i++) { +
-        int sensorType = SENSORS.keyAt(i); +
- String sensorName = SENSORS.get(sensorType); +
- +
- // probe sensor and add to the list +
- sensor = sensorManager.getDefaultSensor(sensorType); +
- if (sensor != null) { +
-     serviceDescriptor = new Bundle(); +
-     serviceDescriptor.putString("serviceBusTopic", id + "/" + sensorName); +
-     serviceDescriptor.putString("id", id + "/" + sensorName); +
-     serviceDescriptor.putString("type", "sensor"); +
-     serviceDescriptor.putString("category", sensorName); +
-     serviceDescriptor.putString("contextBusTopic", "sensor/" + id + "/" + sensorName); +
-     serviceDescriptor.putString("description", sensor.toString()); +
-     SERVICE_DESCRIPTORS.put(sensorType, new Pair<Sensor, Bundle>(sensor, serviceDescriptor)); +
- }+
     }     }
 } }
 </code> </code>
  
-We called the method sensorsDescriptors.initialize(middleware) in the SensorsService class when we implemented the service connection. This method announce the descriptors created before and register to sensors changes:+The createSensorDescriptors() creates a descriptor for the accelerometer sensor present on the device using the **id** taken directly from the database (for sake of consistency with the GiraffPlus ecosystem we choose to publish data on the subtree **sensor/** of the context bus, please respect this constraint):
  
 <code java> <code java>
-public void initialize(IMiddleware middleware) {+private void createSensorDescriptors () throws RemoteException { 
 +    Sensor sensor; 
     try {     try {
- announce(middleware); +        // Gets all the local sensors in a JSON array 
- register(); +        JSONArray localSensors = new JSONArray (middleware.getSensorsByManufacturer ("ISTI-CNR")); 
-    } catch (RemoteException e) { +  
- Log.e(TAG, "cannot announce");+        // for each desirable sensor 
 +        for (int i = 0; i < sensors.size(); i++) 
 +        { 
 +            int sensorCode = sensors.keyAt (i); 
 +            String sensorType = sensors.get (sensorCode); 
 +  
 +            // probe sensor and add to the list 
 +            sensor = sensorManager.getDefaultSensor (sensorCode); 
 +            if (sensor != null) { 
 +                JSONObject sensDesc = null; 
 +  
 +                Log.d(TAG, "found: " + sensorType); 
 +  
 +                for (int j = 0; j < localSensors.length (); j++) 
 +                    if (((String)((JSONObject) localSensors.get (j)).get ("type")).toString ().equals (sensorType)) { 
 +                        sensDesc = (JSONObject) localSensors.get (j); 
 +                        break; 
 +                    } 
 +  
 +                if (sensDesc != null) { // The sensor descriptor exists in the database 
 +                    Bundle serviceDescriptor = new Bundle (); 
 +                    serviceDescriptor.putString ("serviceBusTopic", "sensor/" + sensDesc.getString ("id")); 
 +                    serviceDescriptor.putString ("id", sensDesc.getString ("id")); 
 +                    serviceDescriptor.putString ("type", sensDesc.getString ("type")); 
 +                    serviceDescriptor.putString ("category", "sensor"); 
 +                    serviceDescriptor.putString ("contextBusTopic", "sensor/" + sensDesc.getString ("id")); 
 +                    serviceDescriptor.putString ("description", sensor.toString()); 
 +                     
 +                    JSONArray params = sensDesc.getJSONArray ("messageFormat"); 
 +                    Bundle[] messageFormat = new Bundle[params.length ()]; 
 +                    for (int j = 0; j < params.length (); j++) { 
 +                        messageFormat[j] = new Bundle (); 
 +                        messageFormat[j].putString ("name", ((JSONObject) params.get (j)).getString ("name")); 
 +                        messageFormat[j].putString ("unit", ((JSONObject) params.get (j)).getString ("unit")); 
 +                    } 
 + 
 +                    serviceDescriptor.putParcelableArray ("messageFormat", messageFormat); 
 +                    serviceDescriptor.putParcelableArray ("recipient", new Bundle[] {}); 
 +                    serviceDescriptors.put(sensorCode, new Pair<Sensor, Bundle>(sensor, serviceDescriptor)); 
 +                } 
 +            } 
 +        } 
 +    } 
 +    catch (JSONException ex) { 
 +        Log.e (TAG,  ex.getMessage ());
     }     }
 } }
Line 249: Line 283:
  Bundle serviceDescriptor = SERVICE_DESCRIPTORS.get(SERVICE_DESCRIPTORS.keyAt(i)).second;  Bundle serviceDescriptor = SERVICE_DESCRIPTORS.get(SERVICE_DESCRIPTORS.keyAt(i)).second;
         // CALL TO THE MIDDLEWARE API - ANNOUNCE         // CALL TO THE MIDDLEWARE API - ANNOUNCE
- middleware.announce(serviceDescriptor, errorCallbackImpl);+ middleware.announce(serviceDescriptor, new IMiddlewareResultCallback.Stub() 
 +        { 
 +            @Override 
 +            public void success () throws RemoteException { 
 +                Log.d (TAG, "Announce successful"); 
 +            } 
 +  
 +            @Override 
 +            public void error (Bundle info) throws RemoteException { 
 +                Log.e (TAG, "Announce failed"); 
 +            } 
 +        });
     }     }
 } }
Line 276: Line 321:
  payload.put("sensor_id", serviceDescriptor.getString("id"));  payload.put("sensor_id", serviceDescriptor.getString("id"));
  payload.put("timestamp", event.timestamp);  payload.put("timestamp", event.timestamp);
- JSONArray values = new JSONArray(); + JSONObject values = new JSONObject(); 
- JSONObject array_value = new JSONObject(); + values.put("Acc_X", event.values[0]); 
- array_value.put("x", event.values[0]); + values.put("Acc_Y", event.values[1]); 
- array_value.put("y", event.values[1]); + values.put("Acc_z", event.values[2]);
- array_value.put("z", event.values[2]); +
- values.put(array_value);+
  payload.put("values", values);  payload.put("values", values);
     } catch (JSONException e) {     } catch (JSONException e) {
Line 289: Line 332:
     // publish message     // publish message
     try {     try {
- middleware.publish(topic, payload.toString(), false, errorCallbackImpl);+ middleware.publish(topic, payload.toString(), false, resultCallbackImpl);
     } catch (RemoteException e) {     } catch (RemoteException e) {
  Log.e(TAG, "cannot publish");  Log.e(TAG, "cannot publish");
Line 314: Line 357:
     for (int i = 0; i < SERVICE_DESCRIPTORS.size(); i++) {     for (int i = 0; i < SERVICE_DESCRIPTORS.size(); i++) {
  Bundle serviceDescriptor = SERVICE_DESCRIPTORS.get(SERVICE_DESCRIPTORS.keyAt(i)).second;  Bundle serviceDescriptor = SERVICE_DESCRIPTORS.get(SERVICE_DESCRIPTORS.keyAt(i)).second;
- middleware.remove(serviceDescriptor, errorCallbackImpl);+ middleware.remove(serviceDescriptor, new IMiddlewareResultCallback.Stub() 
 +        { 
 +            @Override 
 +            public void success () throws RemoteException { 
 +                Log.d (TAG, "Remove successful"); 
 +            } 
 +  
 +            @Override 
 +            public void error (Bundle info) throws RemoteException { 
 +                Log.e (TAG, "Remove failed"); 
 +            } 
 +        });
     }     }
 } }
giraffplus/android-middleware.1375805056.txt.gz · Last modified: 2013-08-06 16:04 by andrea
Donate Powered by PHP Valid HTML5 Valid CSS Run on Debian Driven by DokuWiki