Integrating ML Kit Through HMS Toolkit

Configuration Wizard

Installing HMS Toolkit

Windows: Start Android Studio, go to File > Settings > Plugins > Marketplace, enter HMS Toolkit in the search box, and click Install. After the installation is complete, restart Android Studio.

macOS: Start Android Studio, go to Preferences > Plugins > Marketplace, enter HMS Toolkit in the search box, and click Install. After the installation is complete, restart Android Studio.

Configuring the Development Environment

Configuring App Information in AppGallery Connect

To develop an app, create it in AppGallery Connect and set required information.

1. Use your HUAWEI ID to sign in to AppGallery Connect. If you do not have any HUAWEI ID, register one by referring to Registration and Verification.
2. Create a project and create an app. Note that set Package type to APK (Android app).

   You only need to perform the preceding two steps in AppGallery Connect. Then go to Configuration Wizard of HMS Toolkit and perform configurations according to Configuring the HMS Toolkit Environment.

Configuring the HMS Toolkit Environment

Before calling the ML Kit capabilities, perform the following steps to configure the environment:

1. In Android Studio, go to HMS > Configuration Wizard.
   NOTE

   If you have not signed in to AppGallery Connect, Toolkit automatically opens the browser and prompts you to sign in and perform authorization.

2. After sign-in authorization, select the team name, project module, integrated kit (ML Kit), and certificate type, and click Next.
   NOTE

   After you select the team name and project module, HMS Toolkit automatically checks whether the corresponding app is available in AppGallery Connect. If the error messages in red in the following figure are displayed, click Link to check whether the app has been created in AppGallery Connect.

   • If not, create the app and click Retry.
   • If so, verify that the team name and project module are correct and click Retry.

   

   The following figure shows the page after the errors are rectified.

   

   HMS Toolkit automatically checks the integration environment of ML Kit, including the general environment and the environment dedicated for the kit.

   

   HMS Toolkit checks whether each configuration item is correct.

   • If an item fails to pass the check, as shown in the preceding figure, click Link to manually modify the item as prompted. You can also click or refer to the following table to rectify the item. After the setting, click Retry to perform the check again.
     Expand

     No.	Check Item	Suggestions
     1	Obtain the package name of your application	Create an app in AppGallery Connect in advance, and make sure that its package name is the same as that specified in HMS Toolkit for the app that you are developing. NOTE HMS Toolkit only queries the app in AppGallery Connect based on the package name and does not proactively create an app. The package name is specified by android.defaultConfig.applicationId in build.gradle.
     2	Check whether there is any app corresponding to your application's package name in AppGallery Connect
     3	Verify the package name	Make sure that the package name ends with .HUAWEI or .huawei. This restriction is applied only to joint operations games.
     4	Generate a signing certificate	If you select Use Your Certificate, make sure that the certificate file is created successfully, and keyPassword and storePassword are set correctly.
     5	Configure signing certificate information
     6	Generate a certificate fingerprint
     7	Configure the certificate fingerprint in AppGallery Connect	Manually copy the SHA-256 certificate fingerprint and paste it in the text box under Generate a certificate fingerprint, click the link that appears in the HMS Toolkit window, and enter the SHA-256 certificate fingerprint for the app.
     8	Check whether the data storage location was set	Click the link that appears in the HMS Toolkit window, and set a data storage location.
     9	Check whether the required xxx Kit service was enabled	Click the link that appears in the HMS Toolkit window, and enable required services. After a service is enabled in HMS Toolkit, go to Project settings > Manage APIs in AppGallery Connect and enable the service.
     10	Check whether the required xxx Kit API was enabled
     11	Download the agconnect-services.json file	Ensure that the package name that you have specified for the app when you create it in AppGallery Connect is the same as that of the selected project template.
     12	Copy the agconnect-services.json file to the module directory
     13	Add the HMS Maven repository address to the build.gradle file in the project directory for xxx Kit	No manual intervention is required.
     14	Add dependencies from AppGallery Connect to the build.gradle file in the project directory for xxx Kit
     15	Add dependencies from AppGallery Connect to the build.gradle file in the module directory for xxx Kit
     16	Add dependencies from the xxx Kit SDK to the build.gradle file in the module directory
     17	Configure obfuscation scripts of xxx Kit

   • If all the items are passed, click Go to coding assistant to call APIs. For details, please refer to en-us_topic_0000001050061057.html.

     

Integrating ML Kit Through Coding Assistant

Go to HMS > Coding Assistant > AI, and select ML Kit in the kit list. The following figure shows all the scenarios of ML Kit.

Completing the Code by Dragging and Dropping Scenario Cards

Select a scenario card, for example, Text Recognition from Images on the Device, and drag and drop it to the code editing area to create code for on-device text recognition.

Other Functions

To implement other functions such as on-cloud text recognition, on-device text recognition from camera streams, document recognition, and face detection, drag and drop the related cards or copy the related code. You can also manually implement them by referring to the development guide.

Building, Loading, and Debugging the App

After the preceding operations are complete, you can use Cloud Debugging in HMS Toolkit to debug the app on a real device. For details, please refer to Cloud Debugging.

Running or Debugging an App on a Remote Real Device

Running or Debugging an App on a Local Real Device

Click or to run or debug the app, respectively, on the local device.

Using Cloud Testing to Test the APK

1. Go to HMS > Cloud Testing or click the icon shown in the following figure.

   

2. In Cloud Testing, click New Task.

   

3. Set the following task parameters and click Confirm to start the test task:
   • Select Category: Test category. You can select Compatibility Test, Stability Test, Performance Test, and Consumption Test.
   • Please Select Apk File: APK file to be tested.
   • Test Devices: Device for app testing. Only one device can be selected for the stability test (Stability Test). For other tests, you can select multiple devices.

   • Test Duration: This parameter is valid only when Select Category is set to Stability Test. This parameter is optional. The value ranges from 10 to 60 minutes.

   • Application Classification: This parameter is valid only when Select Category is set to Performance Test or Consumption Test. This parameter is optional.

     

4. After the task is complete, click to view the test report.

   

   Click Download report to download the report locally. Click to view the test details. For details about the report description of each test, please refer to Operation Guide.

   

Publish to AppGallery Connect

After developing and debugging an app, Publish to AppGallery Connect helps you to release the APK package to AppGallery Connect.

1. In HMS, click Publish to AppGallery Connect.
2. Select the team name and the APK file (with 1 GB at most) to be released, and click Upload.
   NOTE

   When the APK file is uploaded, the following two checks are performed. If an error is reported, modify the file and upload it again.

   • The file must be in release format. For details about how to generate such an APK file, please refer to How do I generate a release.apk file in a project?.
   • The SHA-256 certificate fingerprint has been obtained and configured in the app information in AppGallery Connect. Procedure: Run the following command in the cmd window to read the information value of the APK file, obtain the SHA-256 certificate fingerprint from the information value, and fill in the SHA-256 certificate fingerprint to the app:

     >keytool -printcert -jarfile app-release.apk directory in the project directory

     Set app-release.apk directory in the project directory as required.

   

3. After the upload is complete, click RELEASE. On the page that is displayed, go to Release app > Draft.

   

4. Enter the information about the app release and submit for review.