SDK Integration Technical Document
SDK Integration Technical Document
By
reading, downloading, or otherwise using this document, you agree to abide by the Bridgefy Terms of
Service and Privacy Policy, which are available on www.bridgefy.me
For any questions, additional information, or to sign-up to use the Bridgefy SDK, please visit
www.bridgefy.me
Bridgefy SDK
The Bridgefy Software Development Kit (SDK) is a state-of-the-art, plug-and-play
package that will let people use your mobile app when they don’t have access to the
Internet, by using Bluetooth mesh networks.
Integrate the Bridgefy SDK into your Android and iOS app to reach the 3.5 billion people
that don’t always have access to an Internet connection, and watch engagement and
revenue grow!
Android SDK
The SDK for Android is distributed from our private repository; estimated file size is 1
MB.
Gradle
To install through Gradle, include the following in your Gradle compilation file:
val bridgefy_release_maven_url = "http://34.82.5.94:8081/artifactory/libs-
release-local"
allprojects {
repositories {
maven {
url = java.net.URI(bridgefy_release_maven_url)
isAllowInsecureProtocol = true
}
}
}
/**
* Declare dependencies
* @see
http://www.gradle.org/docs/current/userguide/userguide_single.html#sec:how_to_
declare_your_dependencies
*/
dependencies {
implementation ("me.bridgefy:android-sdk:1.0.0@aar") {
isTransitive = true
}
}
Your project needs to be compatible with Java 8 and later. If you haven’t already, add
the next section to the module android in the file build.gradle:
android {
...
compileOptions {
sourceCompatibility JavaVersion.VERSION_1_8
targetCompatibility JavaVersion.VERSION_1_8
}
...
}
Supported Versions
Supported on Android 6 (minSdk = 23) and above with compileSdk >= 31
Needed Permissions
These are the permissions needed to enable communication; you can access the
complete document on permissions here.
23 28 One of below:
- android.permission.ACCESS_COARSE_LOCATION
- android.permission.ACCESS_FINE_LOCATION
29 30 - android.permission.ACCESS_FINE_LOCATION
-
android.permission.ACCESS_BACKGROUND_LOCATION*
31 current - android.permission.BLUETOOTH_SCAN
- android.permission.ACCESS_FINE_LOCATION**
iOS SDK
The SDK for iOS is available through a direct download. It will also be available for the
Swift Package Manager dependency manager, at a later date.
Direct Download
Download the SDK from this link or the Github repository. The file size is 17.8 MB,
reduced to 4 MB on an app compiled for delivery.
By choosing this method, you must follow these steps to complete the integration:
Needed Permissions
In the info.plist file you must add use descriptions for keys Privacy - Bluetooth
Always Usage Description and Privacy - Bluetooth Peripheral Usage Description ,
indicating the use of BLE for communication without the Internet.