Skip to content

Latest commit

 

History

History
executable file
·
92 lines (67 loc) · 4.01 KB

README.md

File metadata and controls

executable file
·
92 lines (67 loc) · 4.01 KB
Raw

Sense for Android apps

Library project for Android apps that use the Sense platform and communicate with CommonSense.

Documentation

For information about the used concepts and implementation details visit the GitHub pages.

Tutorial

Please read the tutorial on the Sense Developer Portal.

Maven

When using Maven (3.0.5+), you can add this project as an APKLIB into your local Maven repository as follows.

First add some dependencies to your local Maven repository that are not available in Maven central:

Dependency 1: compatibility-v4 library (rev 21.0.3)

Note that you need the compatibility-v4 library, revision 21.0.3. Google didn't put that into Maven central. If your local Maven repository does not contain it, install it locally by using the maven-android-sdk-deployer.

Dependency 2: cordova 3.6.4

Navigate to the Library's libs/ folder and execute the following command:

mvn install:install-file \
  -Dfile=cordova-3.6.4.jar \
  -DgroupId=org.apache.cordova \
  -DartifactId=cordova \
  -Dversion=3.6.4 \
  -Dpackaging=jar \
  -DgeneratePom=true

Now put the Sense Library to your local Maven repository:

git clone https://github.com/senseobservationsystems/sense-android-library
cd sense-android-library/sense-android-library/
mvn install

which should result in a BUILD SUCCESS.

After that, you can reference the Sense Library in a Maven-flavoured Android App by adding the following dependency to your POM:

<dependency> 
    <groupId>nl.sense_os</groupId> 
    <artifactId>sense-android-library</artifactId> 
    <version>1.0-SNAPSHOT</version> 
    <type>apklib</type>
</dependency>

Dependency 3: Google Play services client library

Starting from version 3.4 the Google Play services client library is a requirement because there is a new implementation of the position sensor which uses the Fused Location Provider. To setup Google Play services follow these instructions: https://developer.android.com/google/play-services/setup.html

Pre-build commands

The build/ folder contains scripts that need to be executed right before every build. In Eclipse, they can be added by going to Properties > Builders > New... and selecting the script in the "Location" field.

setAppVersion.sh

Copy the contents of setAppVerionExample.sh into this file, and update the paths for your own system. (Do not modify the example file!) If it does not work, try the following solutions:

  • Change the first line to #!/bin/sh if using sh instead of dash.
  • Use only absolute paths (so no $(pwd)).

Local Storage Encryption

The Sense Android Library uses the sqlcipher for Android library for encrypting the local sqlite database. The native files of the library for each architecture are included in the lib folder. An aditional required file is located in the assets folder which should be copied to the assets folder of your application. Optionally the unused native library folders can be removed if the application is only available for a specific architecture. Please make sure that you use senseService.getPref... for accessing the decrypted SensePrefs.Main.Auth preferences.

Encryption can be turned on or off for the sqlite database via the preference: senseService.setPrefBool(SensePrefs.Main.Advanced.ENCRYPT_DATABASE, true);

An app specific salt key can be provided via: senseService.setPrefString(SensePrefs.Main.Advanced.ENCRYPT_DATABASE_SALT, "1tD#V4#%6BT!@#$%XCBCV");

The encryption for the shared authentication preferences file can be turned on or off via: senseService.setPrefBool(SensePrefs.Main.Advanced.ENCRYPT_CREDENTIAL, true);

And an app specific salt key kan be provided via: senseService.setPrefString(SensePrefs.Main.Advanced.ENCRYPT_CREDENTIAL_SALT, "1tD#V4#%6BT!@#$%XCBCV");