example-android-inferencing

Edge Impulse Inferencing on Android

This repository contains a minimal example for running an Edge Impulse machine learning model on an Android device using Android NDK and TensorFlow Lite.

See the Android Documentation.

Prerequisites

Edge Impulse:

• Ensure you have followed the Android guide and have a trained model.
• Export your model as a C++ library from Edge Impulse Studio.

Android Development:

• Install Android Studio.
• Install Android NDK and CMake via the Android Studio SDK Manager. The example is tested to work with Android Studio Ladybug Feature Drop | 2024.2.2, Android API 35, Android SDK Build-Tools 35.0.1, NDK 27.0.12077973, CMake 3.22.1.

---

Cloning the Base Repository

We created an example repository that contains an Android Studio project with C++ support. Clone or download this repository:

git clone https://github.com/edgeimpulse/example-android-inferencing.git
cd example-inferencing-android

Run the Windows / Linux / OSX script to fetch resources

cd example-android-inferencing/example_static_buffer/app/src/main/cpp/tflite
sh download_tflite_libs.bat # download_tflite_libs.sh for OSX and Linux

Import the Project to Android Studio

Choose the project to import

• WearOS
• Android
• Static Buffer

1. Open Android Studio.
2. Select Open an existing Android Studio project.
3. Navigate to the cloned repository and select it.

Download CPP Project from Edge Impulse

1. Go to Edge Impulse Studio.
2. Export your trained model as a C++ library.
3. Download the exported model.

Integrate the Model with the Project

1. Extract the downloaded C++ library.
2. Copy the extracted files into the example-android-inferencing/example_static_buffer/app/src/main/cpp directory, dont copy the CMake.txt file.

Paste in the Test Feature Set for the CPP Test

1. Obtain the test feature set from Edge Impulse Studio test impulse tab.
2. Paste the test feature set into the raw_features array the native_lib.cpp licated in the cpp directory.

std::vector<float> raw_features = {
    // Copy raw features here (e.g. from the 'Model testing' page)
};

Build and Run the Project

1. In Android Studio, click on Build > Make Project.
2. Once the build is successful, run the project on an Android device or emulator.

Adding New Sensors to the WearOS example

If you want to integrate additional sensors, such as a Gyroscope or Heart Rate Sensor, follow these steps:

1. Enable the Sensor in the Code In MainActivity.kt, locate the sensor initialization section and uncomment the corresponding lines:

// Uncomment to add Gyroscope support
private var gyroscope: Sensor? = null

// Uncomment to add Heart Rate sensor support
private var heartRateSensor: Sensor? = null

2. Initialize the Sensor in onCreate Inside onCreate(), uncomment and initialize the sensor:

 gyroscope = sensorManager.getDefaultSensor(Sensor.TYPE_GYROSCOPE)
// heartRateSensor = sensorManager.getDefaultSensor(Sensor.TYPE_HEART_RATE)

3. Register the Sensor in onResume To start collecting sensor data when the app is active, uncomment the registration logic:

 gyroscope?.also {
     sensorManager.registerListener(this, it, SensorManager.SENSOR_DELAY_NORMAL)
 }

// heartRateSensor?.also {
//     sensorManager.registerListener(this, it, SensorManager.SENSOR_DELAY_NORMAL)
// }

4. Handle Sensor Data in onSensorChanged Modify the onSensorChanged() function to collect new sensor data:

 Gyroscope data
 Sensor.TYPE_GYROSCOPE -> {
     ringBuffer[ringBufferIndex++] = event.values[0] // X rotation
     ringBuffer[ringBufferIndex++] = event.values[1] // Y rotation
     ringBuffer[ringBufferIndex++] = event.values[2] // Z rotation
 }

// Heart Rate data
// Sensor.TYPE_HEART_RATE -> {
//     ringBuffer[ringBufferIndex++] = event.values[0] // Heart rate BPM
// }

5. Unregister the Sensor in onPause To save battery and improve performance, ensure sensors stop when the app is paused:

sensorManager.unregisterListener(this)

6. Run the App and Verify Build and deploy the app on a WearOS device. Check logs for new sensor data. Ensure inference runs correctly with the additional inputs.