How to use a Shared HERE SDK Module Across SDK example projects
How to use a Shared HERE SDK Module Across SDK example projects
===================================================================
This guide explains how to integrate a shared HERE SDK module (shared-sdk-module) into multiple HERE Android example projects. It centralizes the HERE SDK AAR file and credential configuration, so all projects can reuse them without duplication.
---
Prerequisites
-----------------
Unzip the provided shared-sdk-module.zip into the parent directory that contains all HERE SDK sample projects:<br />heresdk-navigate-android-examples-4.21.5.0/├── shared-sdk-module/ ← This is where you extract it<br />
Do not place it inside individual projects.
1. Folder Structure
-----------------------
Make sure your project directory looks like this:<br />heresdk-navigate-android-examples-4.21.5.0/├── shared-sdk-module/ ← Place the shared module here├── HelloMap/├── Navigation/├── ...├── gradlew.bat ← You will run this├── build.gradle├── shared-sdk-config.gradle└── update-projects.gradle <br /> <br /><br />
2. Add HERE SDK AAR to the Shared Module
--------------------------------------------
Copy your HERE SDK .aar file into the following location:<br />shared-sdk-module/libs/heresdk-.aar<br />
Example:<br />shared-sdk-module/libs/heresdk-4.21.5.0.aar <br /> <br /><br />
---
3. Configure Credentials
----------------------------
Edit the file:<br />shared-sdk-module/gradle.properties<br />
Add your HERE credentials:<br />HERE_ACCESS_KEY_ID=your_access_key_idHERE_ACCESS_KEY_SECRET=your_access_key_secret <br /> <br /><br />
In shared-sdk-module/build.gradle, ensure the following lines exist in defaultConfig:<br />buildConfigField "String", "HERE_ACCESS_KEY_ID", "\"${HERE_ACCESS_KEY_ID}\""buildConfigField "String", "HERE_ACCESS_KEY_SECRET", "\"${HERE_ACCESS_KEY_SECRET}\""<br />
Also make sure buildConfig is enabled:<br />buildFeatures { buildConfig = true} <br /> <br /><br />
---
4. Run Batch Setup from the Parent Directory
------------------------------------------------
Open a terminal in the parent folder (heresdk-navigate-android-examples) and run:<br />gradlew.bat setupAllProjects on Windows<br />
or<br />gradlew setupAllProjects on Mac.<br />
This script should automatically:
Add shared-sdk-module to each project's settings.gradle
Insert implementation project(':shared-sdk-module') into each app/build.gradle
Replace hardcoded credentials in Java code with:<br />String accessKeyID = com.example.sharedsdkmodule.BuildConfig.HERE_ACCESS_KEY_ID;String accessKeySecret = com.example.sharedsdkmodule.BuildConfig.HERE_ACCESS_KEY_SECRET;<br />
Make sure your script performs these tasks. If needed, I can help improve it.
---
5. Open Projects in Android Studio
--------------------------------------
After running setupAllProjects, you can open any individual project (e.g., HelloMap/) in Android Studio and build it normally. The project will now use the shared SDK module and credentials.
Make sure running File\Sync Project with Gradle Files before rebuild.
Then you shall be able to run different samples without reconfiguring them repeatedly :)
---
6. Notes
------------
Do not open the shared module or subproject directly before running the batch setup.
* Keep the credentials in gradle.properties, but avoid uploading this file to a public repository.