You will need an API key for the WiFire SDK service to work. Please email wifire.bizdev@mobstac.com to get an API key.
- The WiFire SDK has Google Play Services 10.2.6 pre-included. If you are also on the same version you can just include this line
dependencies {
...
compile 'com.mobstac.wifire:WiFireSDK:1.1'
}- If you want to use a specific version of Google Play Services, you will need to add dependencies as following
dependencies {
...
def GMS_LIB_VERSION = 'YOUR_GOOGLE_PLAY_SERVICES_VERSION'
compile 'com.mobstac.wifire:WiFireSDK:1.1@aar'
compile 'com.google.android.gms:play-services-analytics:' + GMS_LIB_VERSION
compile 'com.google.android.gms:play-services-location:' + GMS_LIB_VERSION
compile 'com.google.firebase:firebase-database:' + GMS_LIB_VERSION
compile 'com.google.firebase:firebase-auth:' + GMS_LIB_VERSION
compile 'com.google.firebase:firebase-storage:' + GMS_LIB_VERSION
compile 'com.firebase:geofire-android:2.1.1'
compile 'com.amazonaws:aws-android-sdk-core:2.4.2'
compile 'com.amazonaws:aws-android-sdk-s3:2.4.2'
} 
Add the following lines to proguard-rules.pro
-keep class com.amazonaws.** { *; }
-dontwarn com.fasterxml.jackson.**
-keep class com.mobstac.wifire.** { *; }
<uses-permission android:name="android.permission.ACCESS_WIFI_STATE" />
<uses-permission android:name="android.permission.CHANGE_WIFI_STATE" />
<uses-permission android:name="android.permission.INTERNET" />
<uses-permission android:name="android.permission.ACCESS_NETWORK_STATE" />
<uses-permission android:name="android.permission.ACCESS_FINE_LOCATION" />
<uses-permission android:name="android.permission.ACCESS_COARSE_LOCATION" />
<uses-permission android:name="android.permission.READ_SMS" />
<uses-permission android:name="android.permission.RECEIVE_SMS" />
<uses-permission android:name="android.permission.WRITE_SETTINGS" />It is not necessary to explicitly add these permissions to your app. They will be added automatically when you include the SDK
These permissions are optional and can be removed
-
WRITE_SETTINGS
Usage -
Required to better manage saved WiFi networks in the android system starting Android 6.0.Consequence -
WiFire won't be able to delete or modify a saved network on the user's device -
READ_SMS
-
RECEIVE_SMS
Usage -
Required to autofill the one time password (OTP) from service provider's SMSConsequence -
The user will have to manually fill in the OTP during the network login
Add this line to your AndroidManifest.xml
<uses-permission android:name="android.permission.WRITE_SETTINGS"
tools:node="remove" />Since Android 6.0 Android has introduced the concept of runtime permissions. WiFire SDK requires two runtime permissions -
WiFire requires the location permission to sync nearby Hotspots. WiFire SDKs enableSync() method will fail if location permission is denied.
WiFire requires the SMS permission to read SMS messages and extract the one time password (OTP) for logging in to a captive network. The user will have to manually fill in the OTP if this permission is denied.
WiFire.initialise(getApplicationContext(), "MY_API_KEY", new AuthListener() {
@Override
public void onSuccess() {
Log.d("WiFire", "Authentication successful");
}
@Override
public void onFailure(WiFireException e) {
Log.d("WiFire", "Authentication failed");
}
});WiFire wiFire = WiFire.getInstance();//Starting sync
@Override
public void onResume() {
super.onResume();
if (wiFire != null)
wiFire.enableSync(new WiFireErrorListener() {
@Override
public void onError(WiFireException e) {
Log.e("WiFireSDK", e.getMessage());
}
});
}
//To sync within a required radius, pass an argument which is the radius in metres
wiFire.enableSync(1000, new WiFireErrorListener() {
@Override
public void onError(WiFireException e) {
Log.e("WiFireSDK", e.getMessage());
}
});
//Stopping sync
@Override
public void onPause() {
super.onPause();
if (wiFire != null)
wiFire.disableSync();
}Since syncing can be resource intensive onResume() and onPause() would be ideal places to enable and disable sync respectively. While sync is enabled WiFire will both perform WiFire scanning and sync WiFire hotspots in the vicinity when the user's location changes
Also read - Prerequisites for WiFi scanning and syncing
WiFire can sync when the app is in the background. To achieve this you can omit the disableSync() call when the app goes to the background.
To optimise battery usage for sync while in background you can use
wiFire.setPassiveScanningMode(true);This will decrease the scan cycle frequency to minimise battery usage in the background.
Make sure to call wiFire.setPassiveScanningMode(false); when the app comes to the foreground to make sure your scan list gets updated correctly in time.
5. Getting a list of WiFireHotspot objects
wiFire.setHotSpotListener(new HotSpotListener() {
@Override
public void onScanComplete(ArrayList<WiFireHotspot> wiFireHotSpots) {
//Populate your listView or recyclerView here
}
});WiFire will perform WiFi scans and will return a list of all the hotspots that are in range and can connect to. A list will be delivered every ~10 seconds.
try {
wiFire.connectToNetwork(hotspot, new ConnectionListener() {
@Override
public void onSuccess() {
Log.d("WiFire", "Connected");
}
@Override
public void onFailure(WiFireException wiFireException) {
Log.d("WiFire", wiFireException.getMessage());
}
});
} catch (WiFireInitException e) {
Log.e("WiFire", e.getMessage());
// This is to catch errors which can stop WiFi connection from initiating or completing
// Possible errors
// - User details have not been provided
// - Another connection in progress
// - An OEM level permission manager is blocking WiFi access
// - Invalid hotspot, if a null WiFireHotspot object was passed
// - Hotspot is out of range
}To listen to WiFi connection/state changes you can create a BroadcastReceiver which extends com.mobstac.wifire.WiFireReceiver
This listener can work even when the app is in the background. Location and sync must be enabled for onWiFiNetworkInRange to work.
This allows for the following functionality
- Show notifications when a WiFi network is available for connection
- Recognise the business establishment the user is currently at
- Show notifications for network login, when the user connects to a captive network
- Clear older notifications when the user leaves a place
- Get updates about WiFi connectivity changes
public class MyWiFireReceiver extends WiFireReceiver {
@Override
public void onReceive(Context context, Intent intent) {
super.onReceive(context, intent);
}
@Override
public void onWiFiStateChange(WiFiState wiFiState, WiFireHotspot wiFireHotspot) {
Log.d("WiFireStateChanged", wiFiState.name());
//WiFi network's state has changed, possible states are
//connected, disconnected, captive portal detected.
// WiFireHotspot object will tell you which network the user is connected to.
// It will be null if WiFiState is NO_WIFI or if the network that the user is connected to is not a public WiFire network.
}
@Override
public void onWiFiNetworkInRange(ArrayList<WiFireHotspot> wiFireHotspots) {
//This callback will work while WiFire sync is enabled.
//You can show notification for WiFi availability here.
//This will also have the business name so you can detect where the user is.
//You will receiver this callback only once for a fixed set of WiFi networks.
//When there are no networks in range, you will receive this callback once
//with an empty list to help clear any connectivity/business related notifications.
}
}Set-up the intent filter for it like this
<receiver
android:name=".my.package.MyWiFireReceiver"
android:enabled="true">
<intent-filter>
<!--For listening to changes in WiFi state-->
<action android:name="com.mobstac.wifire.WIFI_STATE_CHANGE" />
<!--For listening to WiFi networks in range-->
<action android:name="com.mobstac.wifire.WIFI_IN_RANGE" />
</intent-filter>
</receiver>WiFire SDK requires that the network stay in range for at least one minute (60 seconds) before a notification is sent to the user. This avoids spamming the user while they are walking or driving.
To change the delay for this notification, you can use
WiFire.getInstance().setHotspotNotificationDelay(timeInSeconds);Note that this only affects the onWiFiNetworkInRange callback. WiFi state events will be delivered instantly.
try {
wiFire.startAutomaticLogin(this);
} catch (WiFireInitException e) {
Log.e("WiFire", e.getMessage());
// This is to catch errors which can stop automatic login from starting. Possible errors are
// - User details have not been provided
// - Not connected to WiFi
}This will launch an activity which will take care of the login flow.
To check if the activity successfully completed login, use onActivityResult()
@Override
public void onActivityResult(int requestCode, int responseCode, Intent data) {
super.onActivityResult(requestCode, responseCode, data);
if (requestCode == WiFire.CAPTIVE_LOGIN_REQUEST) {
if (responseCode == WiFire.CAPTIVE_LOGIN_SUCCESS) {
Log.d("WiFire", "Login successful");
} else if (responseCode == WiFire.CAPTIVE_LOGIN_FAILED) {
Log.e("WiFire", "Login failed");
} else if (responseCode == WiFire.CAPTIVE_LOGIN_CANCELLED) {
String reason = data.getStringExtra("reason");
if (reason == null)
reason = "Login cancelled";
Log.e("WiFire", reason);
} else if (responseCode == WiFire.CAPTIVE_LOGIN_NETWORK_FAILURE) {
String reason = data.getStringExtra("reason");
if (reason == null)
reason = "Login failed because of network failure";
Log.e("WiFire", reason);
}
}
}wiFire.getCurrentState(new NetworkStateListener() {
@Override
public void onResult(WiFiState wiFiState) {
switch (wiFiState) {
case NO_WIFI:
//Not connected to WiFi;
break;
case WIFI_CAPTIVE_PORTAL:
//Login needed to access network;
break;
case WIFI_INTERNET:
//On the internet
break;
default:
//No internet access
break;
}
}
});String networkName = wiFire.getCurrentNetworkName();null if not connected to WiFi
boolean verified = wiFire.isWiFireNetwork();As per TRAI regulations a public WiFi hotspot is supposed to collect the user's phone number
WiFire.getInstance().setUserDetails(countryCode, phoneNumber, emailID, name);You will need to set the user's details in the SDK before connecting to a network. Email ID and name fields are optional, but some providers require those fields to be filled out before they give you Internet access.