C++
You can integrate the Ditto SDK into C++ projects to develop for Linux and Android platforms.
To install the C++ SDK:
Fetch and extract the Ditto package. (Downloading and Unpacking Ditto)
Configure your app to link to the Ditto static library. (Linking to Ditto)
Download Ditto.tar.gz and unpack an archive containing the libditto.a static library and Ditto header:
Add -lditto as a compilation step in the main.cpp source file:
For instructions on adding cross-platform Bluetooth Low Energy (LE) capabilities, see Bluetooth on Linux.
BlueZ is the official Bluetooth protocol stack implementation for Linux systems to communicate with other Bluetooth-enabled platforms.
The Ditto C++ SDK for Android is available in the Maven Central repository: https://central.sonatype.com/artifact/live.ditto/ditto-cpp
Integrating the C++ SDK into an Android app requires use of the Android Native Development Kit (NDK) and the Java Native Interface (JNI) mechanism. To learn more about the NDK and JNI, see https://developer.android.com/ndk/guides.
Include the Maven Central repository in your Gradle file, and then synchronize it with your project.
From your project-level build.gradle file located in the app's root directory, ensure the mavenCentral() repository is included in the repositories section:
Synchronize your project with the Gradle file by clicking File > Sync Project with Gradle Files.
Add the Ditto SDK to your app’s build.gradle file in the dependencies block with the appropriate version:
To ensure that your app links properly with the shared objects in the SDK, and that your app has debugging symbols for the SDK, add these rules to your android packagingOptions block:
The C++ SDK for Android requires that the app call Ditto::set_android_context(JNIEnv* env, jobject context) with an application context object after creating an instance of the C++ Ditto class. This context is required by the SDK on Android to access system resources such as network interfaces and files.
The Android operating system limits access to some device functionality for end-user control and privacy. In order to use this functionality, configure your app to declare and request permissions from end users at runtime:
Review permissions used by Ditto. (Declaring Permissions)
Proactively check permission status to avoid unnecessary delay between granting access and Ditto being able to use the feature. (Requesting Permissions)
Android requires certain permissions to be explicitly requested by the app to access features like Bluetooth Low Energy and Wi-Fi Aware. These permissions must be declared in the app's manifest file and requested from the end user at runtime.
The Ditto SDK's AndroidManifest.xml includes all of the necessary permissions for enabling its mesh network capabilities. These permissions will automatically be merged with your app's permissions, so you should be aware of them.
Some of these permissions have an android:maxSdkVersion attribute which means they are not used on devices running newer versions of Android. This is a best practice to respect users' privacy when those permissions are not necessary.
However, some apps may still need to use one or more of the above permissions across more versions of Android. This can be accomplished by overriding the permission configuration in your app's AndroidManifest.xml
To override any of these permission limitations in your app, do the following:
Open the AndroidManifest.xml located in the app/src/main directory of your project.
Within the same <manifest> tag, just before the <application> tag, add the relevant permissions you want to configure (location example):
Note the additional tools:remove attribute. This tells the manifest merger to selectively remove the android:maxSdkVersion behavior from the associated permissions, changing them to apply to all Android versions.
For more information, see the official Permissions on Android and Merge manifest files documentation.
At runtime, your app can call the C++ Ditto::missing_permissions() function to get a list of permissions required by Ditto that are missing, and your app can request them.
From the source code of your app, add #include <Ditto.h> and provide your access credentials: