Link Search Menu Expand Document
ExpoFP SDK

4.2.14 version

Table of Contents

What’s New in ExpoFP Fplan version 4.2.14

CrowdConnected packages have been updated to version 1.3.6.

Setup

Add Maven repository reference to settings.gradle file(in root of your project):

repositories {
    maven { url "https://s01.oss.sonatype.org/content/repositories/releases" }
    
    //If you want to use navigation from CrowdConnected, add a link to the repository
    //maven { url "https://maven2.crowdconnected.net/" }
	
    //If you want to use navigation from IndoorAtlas, add a link to the repository
    //maven { url "https://dl.cloudsmith.io/public/indooratlas/mvn-public/maven/" }
    ...
}

Add dependency to build.gradle file(in module):

dependencies {
    implementation 'com.expofp:common:4.2.14'
    implementation 'com.expofp:fplan:4.2.14'
    
    //If you want to use navigation from CrowdConnected, add a link to the package
    //implementation 'com.expofp:crowdconnected:4.2.14'
    
    //If you want to use navigation from IndoorAtlas, add a link to the package
    //implementation 'com.expofp:indooratlas:4.2.14'
    
    ... 
}

Add permissions in “AndroidManifest.xml” file:

    <uses-permission android:name="android.permission.INTERNET" />
    <uses-permission android:name="android.permission.ACCESS_NETWORK_STATE" />
    <uses-permission android:name="android.permission.ACCESS_WIFI_STATE" />

Usage

Add FplanView to layout:

<?xml version="1.0" encoding="utf-8"?>
<androidx.constraintlayout.widget.ConstraintLayout xmlns:android="http://schemas.android.com/apk/res/android"
    xmlns:app="http://schemas.android.com/apk/res-auto"
    xmlns:tools="http://schemas.android.com/tools"
    android:layout_width="match_parent"
    android:layout_height="match_parent"
    tools:context=".MainActivity">

    <com.expofp.fplan.FplanView
        android:id="@+id/fplanView"
        android:layout_width="0dp"
        android:layout_height="0dp"
        app:layout_constraintBottom_toBottomOf="parent"
        app:layout_constraintLeft_toLeftOf="parent"
        app:layout_constraintRight_toRightOf="parent"
        app:layout_constraintTop_toTopOf="parent" />
  
</androidx.constraintlayout.widget.ConstraintLayout>

Init FplanView:

Settings settings = new Settings()
                //.withLocationProvider(new CrowdConnectedProvider(getApplication(), new com.expofp.crowdconnected.Settings("APP_KEY","TOKEN","SECRET")))
                //.withLocationProvider(new IndoorAtlasProvider(getApplication(), "API_KEY", "API_SECRET_KEY"))
                //.withGlobalLocationProvider()
                .withEventsListener(new FplanEventsListener() {
                    @Override
                    public void onFpConfigured() {
                    }

                    @Nullable
                    @Override
                    public void onFpConfigureError(int errorCode, String description) {
                    }

                    @Override
                    public void onBoothClick(@Nullable String id, @Nullable String name) {
                    }

                    @Override
                    public void onDirection(@Nullable Route route) {
                    }

                    @Override
                    public void onDetails(@Nullable Details details) {
                    }

                    @Override
                    public void onExhibitorCustomButtonClick(String externalId, int buttonNumber, String buttonUrl) {
                    }

                    @Override
                    public void onMessageReceived(@Nullable String message) {
                    }
                });

_fplanView = findViewById(R.id.fplanView);
_fplanView.init("https://demo.expofp.com", settings);

Stop FplanView.
After you finish working with FplanView, you need to stop it.
To do this, you need to call the ‘destroy’ function:

_fplanView = findViewById(R.id.fplanView);
_fplanView.destroy();

Offline mode

ExpoFP SDK provides the following offline modes:

  1. Default - ExpoFP SDK itself caches all the necessary data during the initial loading of the plan.

  2. Opening a zip archive with a plan - you can download the plan archive from the “Integration options” page (windows section), add this archive to your application (assets) and then open this plan using the “openZipFromAssets()” function.

Example:

Settings settings = new Settings();

_fplanView = findViewById(R.id.fplanView);
_fplanView.openZipFromAssets("demo.zip", null, settings, getApplicationContext());

You can also open a zip using the “openZip()” function, this allows you to open an archive stored in the device’s memory.

Example:

Settings settings = new Settings();
File zipFile = new File("/mnt/sdcard/demo.zip");

_fplanView = findViewById(R.id.fplanView);
_fplanView.openZip(zipFile, null, settings);

3. In the init() method, it is possible to specify the path to the offline archive with the plan. This archive will be opened automatically in case of poor or no internet connection.

Settings settings = new Settings();
File offlineZipFile = new File("/mnt/sdcard/demo.zip");

_fplanView = findViewById(R.id.fplanView);
_fplanView.init("https://demo.expofp.com", settings, offlineZipFile);

It is also possible to specify the name of the file (archive with the plan) from assets:

Settings settings = new Settings();
String offlineZipFileAssetName = "demo.zip";

_fplanView = findViewById(R.id.fplanView);
_fplanView.init("https://demo.expofp.com", settings, offlineZipFileAssetName);

Settings сlass

The Settings class contains all the parameters necessary for the initialization and operation of the plan.

Parameters passed to the constructor

  • focusOnLocation(boolean, optional) - a parameter that activates autofollowing the blue dot. If the value of the parameter is true, the plan will follow the blue dot, while the value of the focusOnFirstLocation parameter is ignored. The default value for this parameter is false.
  • focusOnFirstLocation(boolean, optional) - a parameter that activates focusing when only the blue dot is displayed for the first time. If the value of the parameter is true, the plan will focus on the blue dot only once when it appears on the map, further behavior of the plan will depend on whether the focusOnLocation parameter is enabled. The default value for this parameter is false.
  • loadingTimeout(int, optional) - timeout for loading the plan, after this time has elapsed, FplanView will try to load the offline version or give an error. The default value is 15000 milliseconds.
Settings settings = new Settings(focusOnLocation: false, focusOnFirstLocation: true);

WithEventsListener method

Specifies a subscriber for plan events. Events are described in the Events chapter.

Settings settings = new Settings()
                .withEventsListener(new FplanEventsListener() {
                    @Override
                    public void onFpConfigured() {
                    }

                    @Nullable
                    @Override
                    public void onFpConfigureError(int errorCode, String description) {
                    }

                    @Override
                    public void onBoothClick(@Nullable String id, @Nullable String name) {
                    }

                    @Override
                    public void onDirection(@Nullable Route route) {
                    }

                    @Override
                    public void onDetails(@Nullable Details details) {
                    }

                    @Override
                    public void onExhibitorCustomButtonClick(String externalId, int buttonNumber, String buttonUrl) {
                    }

                    @Override
                    public void onMessageReceived(@Nullable String message) {
                    }
                });

WithFestivalEventsListener method

Specifies a subscriber for Festival events. Festival events are described in the Festival events chapter.

Settings settings = new Settings()
                .withFestivalEventsListener(new FestivalEventsListener() {
                    @Override
                    public void onDirectionsClick(String id, String url) {
                    }

                    @Override
                    public void onMoreDetailsClick(String id) {
                    }
                });

WithLocationProvider method

Specifies the location provider. The location provider is described in the Navigation chapter.

Settings settings = new Settings()
                .withLocationProvider(new GpsProvider(getApplication()));

WithGlobalLocationProvider method

Specifies that the GlobalLocationProvider should be used. The GlobalLocationProvider is described in the GlobalLocationProvider chapter.

Settings settings = new Settings()
                .withGlobalLocationProvider();

Functions

Select booth function 

_fplanView.selectBooth("720");

Select exhibitor function 

_fplanView.selectExhibitor("ExpoPlatform");

Build route function 

_fplanView.selectRoute("720", "751");

Set current position(Blue-dot) function 

_fplanView.selectCurrentPosition(2875, 1734);

Clear floor plan function 

_fplanView.clear();

Get exhibitor list 

_fplanView.exhibitorsList(exhibitors -> {});
com.expofp.fplan.Exhibitor properties:
  • id(int) - exhibitor id
  • name(String) - exhibitor name
  • externalId(String) - exhibitor external id
  • booths(int[]) - booth ids

Get category list 

_fplanView.categoriesList(categories -> {});
com.expofp.fplan.Category properties:
  • id(int) - category id
  • name(String) - category name
  • exhibitors(int[]) - exhibitor ids

Get booth list 

_fplanView.boothsList(booths -> {});
com.expofp.fplan.Booth properties:
  • id(int) - booth id
  • name(String) - booth name
  • externalId(String) - booth external id
  • isSpecial(Boolean) - true if booth is special
  • exhibitors(int[]) - exhibitor ids

Events

Floor plan ready event

This event is called when the plan initialization process has successfully completed.

@Override
public void onFpConfigured() {
}

Floor plan init error event

This event is called when an error occurs while initializing the plan.

@Nullable
@Override
public void onFpConfigureError(int errorCode, String description) {
}

Select booth event

This event is called when a booth is clicked.

@Override
public void onBoothClick(@Nullable String id, @Nullable String name) {
}

Route create event

This event is called when the route is successfully built.

@Override
public void onDirection(@Nullable Route route) {
}
com.expofp.fplan.Route properties:
  • from(RouteBooth) - start booth
  • to(RouteBooth) - destination booth
  • distance(String) - information about distances, for example: 15m
  • time(int) - estimated time to final destination booth in seconds
com.expofp.fplan.RouteBooth properties:
  • id(String) - booth id
  • name(String) - booth name

Receive message event

Currently not in use.

@Override
public void onMessageReceived(@Nullable String message) {
}

Details open event

This event is called when opening a panel with information, it can be a panel with information about an open booth, a route, etc.

@Override
public void onDetails(@Nullable Details details) {
}
Details properties:
  • type(String) - "booth" | "exhibitor" | "route"
  • id(String) - booth id | exhibitor id | null for route
  • name(String) - booth name | exhibitor name | null for route
  • externalId(String) - booth externalId | exhibitor externalId | null for route

Exhibitor custom button click event

This event is called after clicking a custom button in the panel with information about the exhibitor.

@Override
public void onExhibitorCustomButtonClick(String externalId, int buttonNumber, String buttonUrl) {
}

Festivals

Init FplanView 

Settings settings = new Settings()
                  .withEventsListener(new FplanEventsListener() {
                    @Override
                    public void onFpConfigured() {
                        Log.d("Demo", "[onFpConfigured]");
                    }

                    @Nullable
                    @Override
                    public void onFpConfigureError(int errorCode, String description) {
                        Log.d("Demo", "[onFpConfigureError] " + description);
                    }

                    @Override
                    public void onBoothClick(@Nullable String id, @Nullable String name) {
                        Log.d("Demo", String.format(Locale.US, "[onBoothClick] booth id: '%s'; booth name: '%s'", id, name));
                    }

                    @Override
                    public void onDirection(@Nullable Route route) {
                        if (route != null) {
                            String from = route.getBoothFrom() != null ? route.getBoothFrom().getName() : "null";
                            String to = route.getBoothTo() != null ? route.getBoothTo().getName() : "null";

                            String message = String.format(Locale.US, "[onDirection] distance: '%s'; time: '%d'; from: '%s'; to: '%s';",
                                    route.getDistance(), route.getTime(), from, to);

                            Log.d("Demo", message);
                        } else {
                            Log.d("Demo", "route = NULL");
                        }
                    }

                    @Override
                    public void onMessageReceived(@Nullable String message) {
                        Log.d("Demo", String.format(Locale.US, "[onMessageReceived] message: '%s'", message));
                    }

                    @Override
                    public void onDetails(@Nullable Details details) {
                        Log.d("Demo", "[onDetails]");
                        if (details != null) {
                            Log.d("Demo", "details name=" + details.getName());
                        } else {
                            Log.d("Demo", "details = NULL");
                        }
                    }

                    @Override
                    public void onExhibitorCustomButtonClick(String externalId, int buttonNumber, String buttonUrl) {
                        Log.d("Demo", "[onExhibitorCustomButtonClick] externalId=" + externalId + "; buttonNumber=" + buttonNumber + "; buttonUrl=" + buttonUrl);
                    }
                })
                .withFestivalEventsListener(new FestivalEventsListener() {
                    @Override
                    public void onDirectionsClick(String id, String url) {
                        Log.d("Demo", String.format(Locale.US, "[onDirectionsClick] url: '%s'", url));
                    }

                    @Override
                    public void onMoreDetailsClick(String id) {
                        Log.d("Demo", String.format(Locale.US, "[onMoreDetailsClick] id: '%s'", id));
                    }
                });

_fplanView = findViewById(R.id.fplanView);
_fplanView.init("https://fest-digitalx23.expofp.com/", settings);

Stop FplanView

After you finish working with FplanView, you need to stop it.
To do this, you need to call the ‘destroy’ function:

_fplanView = findViewById(R.id.fplanView);
_fplanView.destroy();

Festival events

‘Directions’ button click event

This event is called after clicking a ‘Directions’ button in the panel with information about the exhibitor.

@Override
public void onDirectionsClick(String id, String url) {
	Log.d("Demo", String.format(Locale.US, "[onDirectionsClick] url: '%s'", url));
}
‘More details’ button click event

This event is called after clicking a ‘More details’ button in the panel with information about the exhibitor.

@Override
public void onMoreDetailsClick(String id) {
	Log.d("Demo", String.format(Locale.US, "[onMoreDetailsClick] id: '%s'", id));
}

There are 2 ways to use navigation in FplanView. The first way is to explicitly specify the provider in the FplanView settings. In this case, FplanView will start and stop the LocationProvider on its own.

LocationProvider locationProvider = ...;

Settings settings = new Settings()
                .withLocationProvider(locationProvider);

_fplanView = findViewById(R.id.fplanView);
_fplanView.init("https://demo.expofp.com", settings);

The second way is to run in the background using GlobalLocationProvider.

GlobalLocationProvider

Very often needed to run a location provider in the background, ExpoFP SDK has a GlobalLocationProvider for this. The GlobalLocationProvider runs once at program startup and work in the background.

LocationProvider locationProvider = ...;

GlobalLocationProvider.init(locationProvider);
GlobalLocationProvider.start();

When using the GlobalLocationProvider in the FplanView settings, you need to call the ‘withGlobalLocationProvider’ function:

Settings settings = new Settings()
                 .withGlobalLocationProvider();

_fplanView = findViewById(R.id.fplanView);
_fplanView.init("https://demo.expofp.com", settings);

When the program terminates, the GlobalLocationProvider must also be stopped:

GlobalLocationProvider.stop();

CrowdConnected location provider

Setup

Add Maven repository reference to settings.gradle file(in root of your project):

repositories {
    maven { url "https://maven2.crowdconnected.net/" }
    ...
}

Add dependency to build.gradle file(in module):

dependencies {
    implementation 'com.expofp:crowdconnected:4.2.14'
    implementation 'net.crowdconnected.android.core:android-core:1.3.4'
    implementation 'net.crowdconnected.android.ips:android-ips:1.3.4'
    implementation 'net.crowdconnected.android.geo:android-geo:1.3.4'
    
    ... 
}

Add permissions in “AndroidManifest.xml” file:

<uses-permission android:name="android.permission.ACCESS_COARSE_LOCATION" />
<uses-permission android:name="android.permission.ACCESS_FINE_LOCATION" />

<uses-permission android:name="android.permission.BLUETOOTH" />
<uses-permission android:name="android.permission.BLUETOOTH_ADMIN" />
<uses-permission android:name="android.permission.BLUETOOTH_SCAN" />
<uses-permission android:name="android.permission.BLUETOOTH_CONNECT" />

com.expofp.crowdconnected.Settings

Constructor parameters:

  • appKey(String) - Your Crowd Connected App Key
  • token(String) - Your Crowd Connected Token
  • secret(String) - Your Crowd Connected Secret
  • mode(Mode) - IPS_ONLY | GPS_ONLY | IPS_AND_GPS
  • aliases(Map<String, String>) - Aliases

Functions:

  • enableNavigation() - If you are using the GPS_ONLY | IPS_AND_GPS mode for navigation you call method to notify the library. This increases the frequency of GPS location updates.
  • setAlias(String key, String value) - Sets an alias
  • setServiceNotificationInfo(String notificationText, int serviceIcon) - Sets the notification text and icon for the background service

LocationProvider initialization 

com.expofp.crowdconnected.Settings lpSettings = new com.expofp.crowdconnected.Settings("APP_KEY", "TOKEN", "SECRET", MODE);
LocationProvider locationProvider = new com.expofp.crowdconnected.CrowdConnectedProvider(getApplication(), lpSettings);

Background mode

[!IMPORTANT] To run the location provider in the background, you must specify NOTIFICATION_TEXT and SERVICE_ICON (to do this, you need to call Settings.setServiceNotificationInfo(“NOTIFICATION_TEXT”, SERVICE_ICON)).

com.expofp.crowdconnected.Settings lpSettings = new com.expofp.crowdconnected.Settings("APP_KEY", "TOKEN", "SECRET", MODE);
lpSettings.setServiceNotificationInfo("NOTIFICATION_TEXT", SERVICE_ICON);
LocationProvider locationProvider = new com.expofp.crowdconnected.CrowdConnectedProvider(getApplication(), lpSettings);

GlobalLocationProvider.init(locationProvider);
GlobalLocationProvider.start();

When using CrowdConnectedProvider, it is recommended to run it in the background (when the program starts) using the GlobalLocationProvider.

[!IMPORTANT] To run the location provider in the background, you must specify NOTIFICATION_TEXT and SERVICE_ICON (to do this, you need to call Settings.setServiceNotificationInfo(“NOTIFICATION_TEXT”, SERVICE_ICON)).

com.expofp.crowdconnected.Settings lpSettings = new com.expofp.crowdconnected.Settings("APP_KEY", "TOKEN", "SECRET", MODE);
lpSettings.setServiceNotificationInfo("NOTIFICATION_TEXT", SERVICE_ICON);
LocationProvider locationProvider = new com.expofp.crowdconnected.CrowdConnectedProvider(getApplication(), lpSettings);

GlobalLocationProvider.init(locationProvider);
GlobalLocationProvider.start();

On initial startup, the CrowdConnectedProvider checks for permissions, if the permissions are delegated by the user then the CrowdConnectedProvider starts running, if there are no permissions, the CrowdConnectedProvider waits for any plan to open and requests the necessary permissions after the plan is opened. When opening a plan, you must specify “withGlobalLocationProvider” in the settings:

Settings settings = new Settings()
                 .withGlobalLocationProvider();

_fplanView = findViewById(R.id.fplanView);
_fplanView.init("https://demo.expofp.com", settings);

When the program terminates, the GlobalLocationProvider must also be stopped:

GlobalLocationProvider.stop();

Aliases 

com.expofp.crowdconnected.Settings lpSettings = new com.expofp.crowdconnected.Settings("APP_KEY", "TOKEN", "SECRET", MODE);
lpSettings.setAlias("KEY_1", "VALUE_1");
lpSettings.setAlias("KEY_2", "VALUE_2");
LocationProvider locationProvider = new com.expofp.crowdconnected.CrowdConnectedProvider(getApplication(), lpSettings);

Notification settings 

com.expofp.crowdconnected.Settings lpSettings = new com.expofp.crowdconnected.Settings("APP_KEY", "TOKEN", "SECRET", MODE);
lpSettings.setServiceNotificationInfo("NOTIFICATION_TEXT", SERVICE_ICON);
LocationProvider locationProvider = new com.expofp.crowdconnected.CrowdConnectedProvider(getApplication(), lpSettings);

IndoorAtlas location provider

Setup

Add Maven repository reference to settings.gradle file(in root of your project):

repositories {
    maven { url "https://dl.cloudsmith.io/public/indooratlas/mvn-public/maven/" }
    ...
}

Add dependency to build.gradle file(in module):

dependencies {
    implementation 'com.expofp:indooratlas:4.2.14'
    implementation "com.indooratlas.android:indooratlas-android-sdk:3.5.5@aar"
    
    ... 
}

Add permissions in “AndroidManifest.xml” file:

<uses-permission android:name="android.permission.ACCESS_COARSE_LOCATION" />
<uses-permission android:name="android.permission.ACCESS_FINE_LOCATION" />

<uses-permission android:name="android.permission.BLUETOOTH" />
<uses-permission android:name="android.permission.BLUETOOTH_ADMIN" />
<uses-permission android:name="android.permission.BLUETOOTH_SCAN" />
<uses-permission android:name="android.permission.BLUETOOTH_CONNECT" />

LocationProvider initialization: 

LocationProvider locationProvider = new com.expofp.indooratlas.IndoorAtlasProvider(getApplication(), "API_KEY", "API_SECRET_KEY");