Ats is a universal solution for the developer that is a basic need of creating taxi like application. This Library basically separates three main part related to tracking based application
-
Create you developer account and obtain App Id for the library to work [plugins/dropbox/README.md][PlDb]
-
Add jitpack server in youe project level .gradle file
allprojects { repositories { ... maven { url 'https://jitpack.io' } } }In app level gradle add the implementation
implementation 'com.github.samirapporio:Apporio-Tracking-System:1.0.10'Allow follwing permission in order to connect your app wtih socket server and fetching location.
<uses-permission android:name="android.permission.ACCESS_FINE_LOCATION" /> <uses-permission android:name="android.permission.INTERNET" />
-
In Your Main Application Class (Initial setup)
public class MainApplication extends Application { ATS.Builder ats ; String authToken = "APP ID GOES HERE" ; @Override public void onCreate() { super.onCreate(); ATS.startInit(this) .setAppId(""+authToken) .fetchLocationWhenVehicleIsStop(false) .enableLogs(true) .setLocationInterval(6000) .setDeveloperMode(true) .setNotificationTittle("Main Application Name") .setNotificationContent("Some Content that will run once the location service is started.") .setConnectedStateColor(Color.argb(0, 102, 0 , 204)) .setDisconnectedColor(Color.argb(0 , 255, 255, 102)) .setSocketEndPoint("http://192.168.1.33:3027") .setNotificationIcon(R.drawable.samll_notification_icon) .init(); } }Don't forget to register this applicaiton class i your manifest
<application android:allowBackup="true" android:icon="@mipmap/ic_launcher" android:label="@string/app_name" android:roundIcon="@mipmap/ic_launcher_round" android:supportsRtl="true" android:theme="@style/AppTheme" android:name=".MainApplication"> . . . </application>
Method Description fetchLocationWhenVehicleIsStop(boolean value) There are some situation where device stop emiting location when device(vehicle) is on same place (device generally do this in order to save battery). This library stores the last location in cashe and execute a different background thread that emit last saved location as per the configuread interval enableLogs(boolean value) ATS lib itself has own log mechanism , you can enable or disable it. Search "ATS:" in logact that will throw only. setLocationInterval(int value) - in miliseconds This will be the minimum time of interval for fetching location, it is recomended not to set less than 6 sec in order to save battery and internet usage setDeveloperMode(boolean value) There are lots of things going inside the library like fetching of location, creation of location stack and auto-synchronisation of stack. If developer mode is true you can visualise all things hapenning inside the library. This is usefull while the field testing like if you needs to know weather device is fetching location or not, location service is running or not , device is connected to server or not , app foregorund status and battery status. setNotificationTittle(String title) This works only in live mode of library. As per google service guidline it is mandatory to show a notification in status bar if you running a service for long time. eg. Like in taxi application you can set "Driver Name or application name" setNotificationContent(String title) This works only in live mode of library. e.g. in taxi like application you can set "Driver is on duty now." .setConnectedStateColor(int args) .setDisconnectedColor(int args) Library has two color for the background of notification showing in status bar. One when device is conncted to the server and one when it is disconnected. default color is green when device is connected and red when it is disconnected. you can set any colo here according to you applicaiton theme setNotificationIcon(int icon) This is just for setting icon when location service is running to show in status bar .setSocketEndPoint(String endpoint) By defualt after applying app id the application will get connect to the defualt server of application, but if you have server code as well you deploy it on any cloud instance and connect with that server by using this method -
Create you service that extends library location service "AtsLocationServiceClass"
public class MyService extends AtsLocationServiceClass { @Override public void onReceiveLocation(Location location) { // use location in your code } }Register this service in you manifest class
<?xml version="1.0" encoding="utf-8"?> <manifest xmlns:android="http://schemas.android.com/apk/res/android" package="com.apporioinfolabs.ats_tracking_sdk"> <uses-permission android:name="android.permission.ACCESS_FINE_LOCATION" /> <uses-permission android:name="android.permission.INTERNET" /> <uses-permission android:name="android.permission.CAMERA" /> <application . . . <service android:name=".MyService"/> </application> </manifest>
To start this service you can do:
if (Build.VERSION.SDK_INT >= Build.VERSION_CODES.O) { Toast.makeText(this, "starting foregorund service.", Toast.LENGTH_SHORT).show(); startForegroundService(new Intent(this, MyService.class)); } else { // normal Toast.makeText(this, "Starting normal service.", Toast.LENGTH_SHORT).show(); startService(new Intent(this, MyService.class)); }
-
Set your listeners and tag for tracking, methods list are as follows
ATS.getAtsid(); // unique id that will be sync over you backendATS.enableLogs(true); // enable disable library logs
ATS.setTag("AAAA", new AtsOnTagSetListener() { @Override public void onSuccess(String message) { Toast.makeText(MainActivity.this, ""+message, Toast.LENGTH_SHORT).show(); } @Override public void onFailed(String message) { Toast.makeText(MainActivity.this,""+message, Toast.LENGTH_SHORT).show(); } });
Toast.makeText(this, ""+ATS.getTag(), Toast.LENGTH_SHORT).show();
ATS.removeTag(new AtsOnTagSetListener() { @Override public void onSuccess(String message) { Toast.makeText(MainActivity.this, ""+message, Toast.LENGTH_SHORT).show(); } @Override public void onFailed(String message) { Toast.makeText(MainActivity.this, ""+message, Toast.LENGTH_SHORT).show(); } });
ATS.startListeningAtsID(""+TEST_ATS_ID,new AtsOnAddMessageListener() { @Override public void onRegistrationSuccess(String message) { Toast.makeText(MainActivity.this, ""+message, Toast.LENGTH_SHORT).show(); } @Override public void onRegistrationFailed(String message) { Toast.makeText(MainActivity.this, ""+message, Toast.LENGTH_SHORT).show(); } @Override public void onMessage(String message) { Toast.makeText(MainActivity.this, ""+message, Toast.LENGTH_SHORT).show(); } });
stopListeningAtsId(String targetAtsIdToRemove , AtsOnRemoveMessageListener atsOnRemoveMessageListener)
ATS.stopListeningAtsId(""+TEST_ATS_ID, new AtsOnRemoveMessageListener() { @Override public void onRemoveSuccess(String message) { Toast.makeText(MainActivity.this, ""+message, Toast.LENGTH_SHORT).show(); } @Override public void onRemoveFailed(String message) { Toast.makeText(MainActivity.this, ""+message, Toast.LENGTH_SHORT).show(); } });
ATS.removeAllListeners(new AtsOnRemoveMessageListener() { @Override public void onRemoveSuccess(String message) { LOGS.e(TAG , ""+message); Toast.makeText(MainActivity.this, ""+message, Toast.LENGTH_SHORT).show(); } @Override public void onRemoveFailed(String message) { Toast.makeText(MainActivity.this, ""+message, Toast.LENGTH_SHORT).show(); } });
listenTagAccordingToRadius(String tag, double latitude, double longitude, int radiusInMeter, AtsTagListener atsTagListener)
ATS.listenTagAccordingToRadius("AAAA", 28.411827, 77.042085, 5000, new AtsTagListener() { @Override public void onSuccess(String message) { Toast.makeText(MainActivity.this, ""+message, Toast.LENGTH_SHORT).show(); } @Override public void onFailed(String message) { Toast.makeText(MainActivity.this, ""+message, Toast.LENGTH_SHORT).show(); } @Override public void onAdd(String message) { Toast.makeText(MainActivity.this, ""+message, Toast.LENGTH_SHORT).show(); } @Override public void onChange(String message) { Toast.makeText(MainActivity.this, ""+message, Toast.LENGTH_SHORT).show(); } @Override public void onRemove(String message) { Toast.makeText(MainActivity.this, ""+message, Toast.LENGTH_SHORT).show(); } });
ATS.stopListeningTag(new AtsOnTagSetListener() { @Override public void onSuccess(String message) { Toast.makeText(MainActivity.this, ""+message, Toast.LENGTH_SHORT).show(); } @Override public void onFailed(String message) { Toast.makeText(MainActivity.this, ""+message, Toast.LENGTH_SHORT).show(); } });
ATS.startTrip("TRIP_ID_TWO", new AtsOnTripSetListener() { @Override public void onSuccess(String message) { Toast.makeText(MainActivity.this, ""+message, Toast.LENGTH_SHORT).show(); } @Override public void onFailed(String message) { Toast.makeText(MainActivity.this, ""+message, Toast.LENGTH_SHORT).show(); } });
ATS.endTrip("TRIP_ID_TWO", new AtsOnTripSetListener() { @Override public void onSuccess(String message) { Toast.makeText(MainActivity.this, ""+message, Toast.LENGTH_SHORT).show(); } @Override public void onFailed(String message) { Toast.makeText(MainActivity.this, ""+message, Toast.LENGTH_SHORT).show(); } });