semusi-android-sdk

Android SDK code of Semusi Context SDK. Use it to enrich your Android apps with the power of context.

Getting Started
In this tutorial we will guide you through the process of creating a hello world package that uses Semusi service to find out which activities are being performed by the user, what is the current context and how many calories are being burnt in this process. The Semusi service also tells you the user demographics - the gender, height and weight of the user, along with the current place e.g. work, home, in-transit. We also give you the option to take targetted action based on these contexts through our Semusi website.

The Semusi Service API consists of an Android service and a base API. The Service and API are available as an Android library project.

The Semusi service need to use a number of resources in order to be able to track the user’s activities under all conditions, and make sure that the service doesn’t get killed if the phone is under stress or due to other reasons. You don’t need to worry about its battery consumption as it is highly optimized and your users won’t complain.

Your application should have a minSdkVersion 9 and the targetSDKVersion may be 19.

Step 1

Add the semusi_sdk_lib_eclipse project as a library in your application along with the google-play-services_lib, and that's it.

Semusi SDK Directory Structure

Step 2

You need to add manifest merger flag into your project's 'project.properties' file.

```java # Project target. target=android-19 manifestmerger.enabled=true android.library.reference.1=../../../../android-sdk-macosx/extras/google/google_play_services/libproject/google-play-services_lib android.library.reference.2=../../semusi_sdk_lib_eclipse ```

You need to replace "YOUR.PACKAGE.NAME" with your application's package name.

Setting up user permissions – Modify the following permissions as required from our semusi_sdk_lib_eclipse AndroidManifest.xml file.

// WRITE_EXTERNAL STORAGE – Used to write logs.
// READ_LOGS – Read logs for ACRA.
// INTERNET – Used to upload/downlaod the data to and from the cloud.
// READ_PHONE_STATE - To read the user profile
// ACCESS_NETWORK_STATE – Allows the application to read network state, and check for internet availability.
// RECEIVE_BOOT_COMPLETED - Find out if the system has finished booting, and start our service.
// WAKE_LOCK – To keep processor from sleeping and optimizing algorithm vs battery use.
// ACCESS_COARSE_LOCATION – Used to find out location; required to find out in-vehicle activity and places detection.
// c2dm.permission.RECEIVE - Allow push messages for rules
// permission.C2D_MESSAGE - Allow executing rules
// VIBRATE - Used for push handling system
// READ_HISTORY_BOOKMARKS - Allows for better prediction
// READ_SMS - Allows for better prediction
// GET_ACCOUNTS - allows for better prediction


// Mandatory Permissions
    <!-- Mandatory for error Logging -->    
    <uses-permission android:name="android.permission.WRITE_EXTERNAL_STORAGE" />
    <uses-permission android:name="android.permission.READ_LOGS" />
    
    <!-- Mandatory for registering app to Semusi website, checking internet connectivity, 
    	getting Device ID and IMEI -->
    <uses-permission android:name="android.permission.INTERNET" />
    <uses-permission android:name="android.permission.ACCESS_NETWORK_STATE" />
    <uses-permission android:name="android.permission.READ_PHONE_STATE" />
    
    <!-- Mandatory for background functionality of app -->
    <uses-permission android:name="android.permission.WAKE_LOCK" />

    <!-- Mandatory for app start on boot -->
    <uses-permission android:name="android.permission.RECEIVE_BOOT_COMPLETED" />

    <!-- Mandatory for Rule Handling -->
    <uses-permission android:name="android.permission.INTERNET" />
    <uses-permission android:name="android.permission.GET_ACCOUNTS" />
    <uses-permission android:name="android.permission.WAKE_LOCK" />
    <uses-permission android:name="com.google.android.c2dm.permission.RECEIVE" />
    <uses-permission android:name="android.permission.VIBRATE" />
    
// Optional - Use as per desired functionality
    <!-- Mandatory only for Places detection and In-vehicle activity detection functionality -->
    <uses-permission android:name="android.permission.ACCESS_COARSE_LOCATION" />
    <uses-permission android:name="android.permission.ACCESS_FINE_LOCATION" />

    <!-- Optional for Places -->
    <uses-permission android:name="android.permission.CHANGE_WIFI_STATE" />
    <uses-permission android:name="android.permission.ACCESS_WIFI_STATE" />
    
    <!-- Optional for better prediction -->
    <uses-permission android:name="android.permission.READ_SMS" />
    <uses-permission android:name="android.permission.GET_ACCOUNTS" />
    <uses-permission android:name="com.android.browser.permission.READ_HISTORY_BOOKMARKS" />

Setting up C2D permissions – Replace YOUR.PACKAGE.NAME by your app package name in the semusi_sdk_lib AndroidManifest.xml file.

```java ```

Setting up services and recievers – Let us setup our services and recievers in the same AndroidManifest.xml

```java // The base API service, which is responsible for making sure that the core services collecting and analyzing the data keep running

// This is the core service, which is based on native sensor data processing and native c++ based machine learning algorithms

// This is the core service which is used to receive campaign events

// A receiver, for boot completed intent, which is majorly used by our services to know when the phone has been rebooted and finished booting, so we could restart our STICKY services.

// A receiver for rule execution.


```java
// Receivers to handle Push GCM Services from Semusi servers
<!-- PushHandling setup start -->
        <receiver
            android:name="semusi.ruleengine.pushmanager.GcmBroadcastReceiver"
            android:permission="com.google.android.c2dm.permission.SEND" >
            <intent-filter>
                <action android:name="com.google.android.c2dm.intent.RECEIVE" />
                <action android:name="com.google.android.c2dm.intent.REGISTRATION" />

                <category android:name="YOUR.PACKAGE.NAME" />
            </intent-filter>
        </receiver>
        <receiver android:name="semusi.ruleengine.pushmanager.NotificationEventReceiver" >
            <intent-filter>
                <action android:name="com.semusi.NotificationEvent" />
            </intent-filter>
        </receiver>

        <service android:name="semusi.ruleengine.pushmanager.GcmIntentService" />
        <!-- PushHandling Entry end -->

// Services and Reciver to handle Places updates
        <!-- Places setup start -->
        <service android:name="semusi.context.locationfinder.LocationBroadcastService" />

        <receiver android:name="semusi.context.locationfinder.StartupBroadcastReceiver" >
            <intent-filter>
                <action android:name="android.intent.action.BOOT_COMPLETED" />
            </intent-filter>
        </receiver>
        <receiver android:name="semusi.context.locationfinder.PassiveLocationChangedReceiver" />
        <!-- Places setup end -->

Here is the process for getting the AppID, AppKey, and APIKey -

Create a new campaign for your application. Click on the settings icon as highlighted to get your API Key, App Key, App ID -

// You need to login/register for Semusi SDK features. Use the keys provided, and add below.

<meta-data
    android:name="com.google.android.gms.version"
    android:value="@integer/google_play_services_version" />

<!-- Required Meta-Data keys for SemusiSDK -->
<meta-data
    android:name="com.semusi.analytics.appid"
    android:value="YOUR.APPLICATION.APPID" />
<meta-data
    android:name="com.semusi.analytics.appkey"
    android:value="YOUR.APPLICATION.APPKEY" />
<meta-data
    android:name="com.semusi.analytics.apikey"
    android:value="YOUR.APPLICATION.APIKEY" />
<!-- End of required meta-data -->

<!-- Events receivers from semusi sdk -->
        <receiver android:name="com.semusi.sample.CampaignEventReceiver" >
            <intent-filter>
                <action android:name="com.semusi.CampaignEvent" />
            </intent-filter>
        </receiver>
        <receiver android:name="com.semusi.sample.ContextEventReceiver" >
            <intent-filter>
                <action android:name="com.semusi.ContextEvent" />
            </intent-filter>
        </receiver>

Step 3

Sample code for application class. You need to override 'Application' class with 'ContextApplication'.

```java package YOUR.PACKAGE.NAME;

import semusi.activitysdk.ContextApplication;

public class MyApplication extends ContextApplication {

@Override
public void onCreate() {
	super.onCreate();
}

}


<ul>
<li>Setting up 'Application' class – Copy and paste this in your Application AndroidManifest.xml file.</li>
</ul>
```java
<application android:name="YOUR.PACKAGE.NAME.MyApplication" >

Import the packages – Import these packages, before we start using the SDK, rest of the imports we can resolve on the fly.

import semusi.activitysdk.Api;
import semusi.activitysdk.ContextData;
import semusi.activitysdk.ContextSdk;
import semusi.activitysdk.SdkConfig;
import semusi.util.constants.EnumConstants;
import semusi.util.constants.EnumConstants.ActivityAccuracyEnum.ActivityAccuracyLevel;
import semusi.util.constants.EnumConstants.PlacesAccuracyEnum.PlacesAccuracyLevel;

API Reference
PULL API

// Below code is used to initialize Semusi service
// This is NECESSARY to make Semusi SDK work

boolean isApiRunning = ContextSdk.isSemusiSensing(getApplicationContext());

if (isApiRunning)
    Api.stopContext();
else {
    // Config to handle enable-disable state
    SdkConfig config = new SdkConfig();
    config.setPlacesAccuracyLevel(PlacesAccuracyLevel.EAccuracyHigh);
    config.setActivityAccuracyLevel(ActivityAccuracyLevel.EAccuracyHigh);
    config.setActivityTrackingAllowedState(true);
    config.setAnalyticsTrackingAllowedState(true);
    config.setDemographicsTrackingAllowedState(true);
    config.setPedometerTrackingStateAllowed(true);
    config.setPlacesTrackingAllowedState(true);
    config.setRuleEngineEventStateAllowed(true);
    config.setDebuggingStateAllowed(true);
    config.setContinuousSensingAllowed(false);
    
    // start semusi context sensing with config
    // by default all setters are enabled and accuracy level to High
    // and continous sensing is set to false
    Api.startContext(getApplicationContext(), config);
}

Below code is used to initialize ContextSdk with context object, and get the current activity, current demographics (Gender,Weight,Height,Interest,and location).

	ContextSdk sdk = new ContextSdk(
				MainActivity.this.getApplicationContext());

	ContextData currentData = sdk.getCurrentContext();

        //Getting Gender type : Return will be of enum type 'EnumConstants.GenderEnum.GenderTypeString'
	EnumConstants.GenderEnum.GenderTypeString genderTypeData = currentData
				.getGenderType();

        //Getting Height type : Return will be of enum type 'EnumConstants.HeightEnum.HeightType'
	EnumConstants.HeightEnum.HeightTypeString heightTypeData = currentData
				.getHeightType();

        //Getting Weight type : Return will be of enum type 'EnumConstants.WeightEnum.WeightType'
	EnumConstants.WeightEnum.WeightTypeString weightTypeData = currentData
				.getWeightType();

        //Getting Current Activity type and return will be of enum type 'EnumConstants.ActivityEnum.ActivityTypeInt'
        EnumConstants.ActivityEnum.ActivityTypeInt actType = currentData.getActivityType();

        //Getting User Places Info and return will be of type 'String'
        String place = currentData.getLocationType();
        
        //Getting User Application based user interests
        List<String> userInterestCategory = currentData.getUserInterestData();

GetHistoryData API Below code is used to get the History Data of Acitvities for a given range of dates, and set of Activities for which data is to be fetched. For accessing data for a single date, use the same date epoch for fromDateEpoch and toDateEpoch.

// Getting data history - Returns array
// fromDate - epoch value at 00:00:00 hrs
// toDate - epoch value at 00:00:00 hrs

ContextData[] historyData = sdk.getActivityHistory(fromDateEpoch, toDateEpoch, 
				ActivityTypeInt.WalkingActivity.getActivityValue(),            
				ActivityTypeInt.StandingActivity.getActivityValue(),
				ActivityTypeInt.SittingActivity.getActivityValue(),
				ActivityTypeInt.SleepingActivity.getActivityValue(),
				ActivityTypeInt.RunningActivity.getActivityValue(),
				ActivityTypeInt.VehicleActivity.getActivityValue());

// Access history values
if(historyData[0] != null) 
{
    for(int i = 0; i < historyData.length; i++)
    {
        ActivityTypeInt activity = historyData[i].getActivityType();
        float duration = historyData[i].getActivityDuration(); // duration in minutes
        float calories = historyData[i].getActivityCalories();
        long date = historyData[i].getDate(); // date in epoch 00:00:00
    }
}

GetPedometerHistory API Below code is used to get Pedometer Data for a given range of dates. For accessing data for a single date, use the same date epoch for fromDateEpoch and toDateEpoch.

// Access pedometer history values
// fromDate - epoch value at 00:00:00 hrs
// toDate - epoch value at 00:00:00 hrs
ContextData[] pedometerData = sdk.getPedometerHistory(fromDateEpoch, toDateEpoch);

int pedometerCount = 0;
float pedometerCalories = 0;
		
if(pedometerData[0] != null) {
	for(int i = 0; i < pedometerData.length; i++)
	{
		pedometerCount = pedometerData[i].getPedometerCount();
		pedometerCalories = pedometerData[i].getPedometerCountCalories();
	}
}

Campaign Event Listener Below code is used to capture campaign events

public class CampaignEventReceiver extends BroadcastReceiver {

	@Override
	public void onReceive(Context context, Intent intent) {
		String extUrl = intent.getStringExtra("Exturl");
		String clicked = intent.getStringExtra("Clicked");

		System.out.println("CampaignEvent Recevied with ExtUrl : " + extUrl
				+ " , " + clicked);
	}
}

Context Event Listener Below code is used to capture every context events

public class ContextEventReceiver extends BroadcastReceiver {

	@Override
	public void onReceive(Context context, Intent intent) {
		String contextChangedType = intent.getStringExtra("EventType");
		String contextChangedVal = intent.getStringExtra("EventVal");

		System.out.println("ContextEvent Recevied with ExtUrl : "
				+ contextChangedType + " , " + contextChangedVal);
	}
}

ngertrudiz / semusi-android-sdk Goto Github PK

semusi-android-sdk's Introduction

semusi-android-sdk

semusi-android-sdk's People

Contributors

Watchers

Recommend Projects

React

Vue.js

Typescript

TensorFlow

Django

Laravel

D3

Recommend Topics

javascript

web

server

Machine learning

Visualization

Game

Recommend Org

Facebook

Microsoft

Google

Alibaba

D3

Tencent