[
This is an Android library to simplify integrating with a FIND server to add WiFi-based indoor positioning support to your app.
To use this you will need to have your own FIND server configured. Alternatively, you can make use of the public demo FIND server at: https://ml.internalpositioning.com/ (with the security implications that using a public demo server entails :)
First create a FindClient with your server config:
FindClient findClient = new FindClient.Builder(this)
.baseUrl("http://your-server:8003")
.group("your_group")
.username("your_username")
.build();Ensure you have the required permissions, then get the device location with:
findClient.track()
.subscribeOn(Schedulers.io())
.observeOn(AndroidSchedulers.mainThread())
.subscribe(new Consumer<String>() {
@Override
public void accept(String location) {
Timber.d("Location: " + location);
}
});That's all you'll need to add indoor-location support to your app.
If you also want to be able to train your FIND server with new locations from your app, use the learn() method:
findClient.learn("living-room")
.subscribeOn(Schedulers.io())
.observeOn(AndroidSchedulers.mainThread())
.subscribe(new CompletableObserver() {
@Override
public void onSubscribe(Disposable d) {}
@Override
public void onComplete() {
Timber.d("WiFi fingerprint submitted!");
}
@Override
public void onError(Throwable e) {
Timber.e("onError: " + e.toString(), e);
}
});For the FindClient to work, the user must have enabled Location Services and granted the ACCESS_FINE_LOCATION permission to your app.
ACCESS_FINE_LOCATION must be granted by the user at runtime on Android 6.0 and above. To do this, see the official documentation on runtime permissions and/or check out the Dexter library.
Refer to the included sample app in sample/ for an example.
This library makes use of RxJava 2, Retrofit, OkHttp and AutoValue.
Note on RxJava2 types
The API of FindClient makes use of some RxJava 2 reactive base types which might be new to those familiar with RxJava 1.X.
track() returns a Single<String> which either emits a single location string, or fails.
learn(location) returns a Completable which either completes successfully (with no value) or fails.
For more on differences between RxJava2 and RxJava1, see the official What's different in 2.0 wiki page and Exploring RxJava 2 for Android
Step 1.
Add the JitPack repository to your root build.gradle at the end of repositories:
allprojects {
repositories {
maven { url 'https://jitpack.io' }
}
}Step 2.
Add the dependency to your app's build.gradle
dependencies {
compile 'com.github.kiwiandroiddev:find-client-android:v0.2-alpha'
}This SDK and sample was forked from the official Find client for Android.
The Framework for Internal Navigation and Discovery (FIND) allows you to use your (Android) smartphone or WiFi-enabled computer (laptop or Raspberry Pi or etc.) to determine your position within your home or office. You can easily use this system in place of motion sensors as its resolution will allow your phone to distinguish whether you are in the living room, the kitchen or the bedroom, etc. The position information can then be used in a variety of ways including home automation, way-finding, or tracking! To learn more about it or to run your own private server, check out https://github.com/schollz/find
- Akshay Dekate (sample app)
- Shailesh Srivastava (sample app)
- Matthew Clarke (SDK)
The code supplied here is covered under the MIT Open Source License:
Original work Copyright (c) 2016 Akshay Dekate
Modified work Copyright (c) 2017 Orion Health
Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.