WayTodaySDK for Android

is not up to date! see https://github.com/s4ysolutions/itag for real life sample the class Waytoday, and methods MainActivity.onResume/onPause

Usage

Add the library to the list of dependencies

Services

WayToday SDK provides the services for requesting a personal track ID and upload the locations received from Android services to WayToday server.

Besides the services there's a helper package to wrap Android GPS provider with the convenient methods and and listeners

IDJobService

IDJobService extends Android JobIntentService and adds methods to initiate request to generate tracker id and to subscribe on the response(s).

 TrackIDJobService.init("password")
 ...
 TrackIDJobService.addOnTrackIDChangeListener(new ITrackIDChangeListener(){
       @Override
       public void onTrackID(@NonNull String trackID) {
           Log.d(LT, "onTrackID: " + trackID);
       }
 });
 ...
 TrackIDJobService.enqueueRetrieveId(this/*context*/);
 ...
 TrackIDJobService.removeOnTrackIDChangeListener(this/*context*/);

UploadJobService

UploadJobService extends Android JobIntentService and adds methods to initiate request to generate tracker id and to subscribe on the response(s).

 UploadJobService.init("secret","Some WT app");
 ...
 UploadJobService.enqueueUploadLocation(this/*context*/, location /*filtered or raw location*/);

GPS Helpers

Location updaters

There might be different updaters implementing ILocationUpdater interface, but currently WayToday SDK has the only LocationGPSUpdater for Android GPS provider. In the future there might be coarse GSM positioning added.

LocationGPSUpdater --(implements)--> ILocationUpdater
    |
    +---> requestLocationUpdates
    |
    +---> cancelLocationUpdates
    |
    +---(notifies 1:1)------> android.location.LocationListener (raw coordinates)
    |
    +---(notifies 1:1)------> IRequestListener (success, fail)
    |
    +---(notifies 1:many) --> IPermissionListener

Location tracker

The main purpose of Tracker class it to apply Kalman filter and to provide the unified interface to different Location updaters.

Tracker --(uses)--> ILocationUpdater
    |
    +---> start
    |
    +---> stop
    |
    +---> reset filter
    |
    +---> (notifies 1:many) --> ILocationListener (filtered coordinates)
    |
    +---> (notifies 1:many) --> ITrackingStateListener (isUpdating: true,false; isSuspended: true, false)