Parker Lougheed
f4083c19b2
|
9 months ago | |
---|---|---|
.. | ||
android | 12 months ago | |
example | 9 months ago | |
ios | 12 months ago | |
lib | 9 months ago | |
src | 9 months ago | |
.gitignore | 2 years ago | |
.metadata | 2 years ago | |
CHANGELOG.md | 2 years ago | |
LICENSE | 2 years ago | |
README.md | 12 months ago | |
analysis_options.yaml | 2 years ago | |
ffigen.yaml | 1 year ago | |
jnigen.yaml | 1 year ago | |
pubspec.yaml | 9 months ago |
README.md
FFIgen + JNIgen pedometer
This is a demo for some of our tooling around calling platform APIs directly from dart code. This repository represents a demo of a plugin that leverages FFIgen & JNIgen. There is also an example pedometer app that uses the bindings generated from these tools.
- FFIgen is used to generate bindings for C, Objective-C and Swift APIs.
- JNIgen is used to generate bindings for Java and Kotlin APIs.
These tools are both experimental and are currently a work in progress. If you find any issues or have feedback, please file it on the corresponding GitHub repositories.
Re-generating bindings
The bindings that allow the Dart code to call the platform code have
already been generated in the \lib
folder.
You can regenerate them by following the steps below:
FFIgen
Configuration of FFIgen for the
CoreMotion framework
is in the ffigen.yaml
file.
FFIgen currently does not support autogenerating code to handle callbacks.
So, there are a few extra steps needed to
appropriately handle callbacks in Objective-C.
You can read more about this limitation on
dart.dev.
dart run ffigen --config ffigen.yaml
JNIgen
Configuration of JNIgen for the
HealthConnect API
is in the jnigen.yaml
file.
-
Build an Android APK file from the example app. Currently, JNIgen requires at least one APK build to obtain the classpaths of Android Gradle libraries.
cd example && flutter build apk
-
Return to the
/pedometer
directory and runjnigen
:cd .. && dart run jnigen --config jnigen.yaml
Running the example app
The example app is located in the /example
directory,
and the following commands assume they are being run from that location.
Note that step counting is only available on physical devices.
iOS
- Run
flutter run
and choose your physical device. - Allow the pedometer app access to step counting.
Android
- Make sure that Google Fit is installed (to ensure that steps are being counted).
- Run
flutter run
and choose your physical device. - Install Health Connect and grant access to Google Fit and the jni_demo app.
Project structure
-
src
: Contains the native source code, and aCMakeLists.txt
file for building that source code into a dynamic library. -
lib
: Contains the Dart code that defines the API of the plugin and calls into the native code usingdart:ffi
. -
platform folders (
ios
etc.): Contain the build files for building and bundling the native code library with the platform application. -
example
: Contains the native source code for building that source code into a dynamic library.