Configuring Android with Firebase Cloud Messaging
Follow the instructions given below to configure WSO2 IoT Server Firebase Cloud Messaging (FCM):
Prerequisites
Clone the
cdmf-agent-android
GIT repository. This is be referred to as<ANDROID_AGENT_SOURCE_CODE>
throughout this document.git clone https://github.com/wso2/cdmf-agent-android/tree/release-3.1.27
Make sure that the Android agent release version matches the IoT Server release version. Click here for more information.
- Download and install Android Studio. For more information, see installing Android Studio.
- Go to the Firebase API Console.
- Click CREATE NEW PROJECT.
Provide a preferred name for the project (example: WSO2-FCM), select the country/region, and click CREATE PROJECT.
The new project is created in few seconds, and you are navigated to the overview page of the project.Click Add Firebase to your Android App on the overview page of the project.
-
Provide the package name of the WSO2 Android agent, that is
org.wso2.iot.agent
and click REGISTER APP. Click Download google-service.json to download the configurations.
- Replace the
<ANDROID_AGENT_SOURCE_CODE>/client/client/google-services.json
file with thegoogle-services.json
file you just downloaded. - Click CONTINUE > FINISH to finish the process and create the application.
You are navigated to the overview of the created application. Scroll up the page and go to the CLOUD MESSAGING tab. Note down the Firebase Cloud messaging token. You need to provide this token as the server key when configuring the Android platform.
Open
<ANDROID_AGENT_SOURCE_CODE>
via Android Studio, clean the project, and build the project.The WSO2 Android agent can't be built via the usual Android developer SDK, as it requires access to developer restricted APIs. Therefore, you need to replace the existing
android.jar
file that is in the<SDK_LOCATION>/platforms/android-<COMPILE_SDK_VERSION>
directory with the explicitly builtandroid.jar
file that has access to the restricted APIs.
For more information on how to build the project, see creating a new APK file.- Rename the created
.apk
file toandroid-agent.apk
. - Copy the renamed file and replace the existing
android-agent.apk
file that is in the<IoT_HOME>/repository/deployment/server/jaggeryapps/devicemgt/app/units/cdmf.unit.device.type.android.type-view/public/assets
directory. - Open the
<IoT_HOME>/repository/deployment/server/devicetypes/android.xml
file and uncomment the configuration given below to enable communication via FCM.<PushNotificationProviderConfig type="FCM" isScheduled="false"> </PushNotificationProviderConfig>
The
isScheduled
element used to enable the scheduler task that sends push notifications. The task sends the push notifications in batches. So this reduces the sudden request burst when many devices try to access the server after receiving the push notification. - Restart the WSO2 IoT Server in order to apply the changes.