briangriffey / android-ibeacon-service

An Android library providing APIs to interact with iBeacons

Android iBeacon Library

An Android library providing APIs to interact with iBeacons

What does this library do?

It allows Android devices to use iBeacons much like iOS devices do. An app can request to get notifications when one or more iBeacons appear or disappear. An app can also request to get a ranging update from one or more iBeacons at a frequency of 1Hz.

How to Use this Library

The project website is the best place to go if you want to learn how to use this library. It includes binary downloads, a quick start guide, sample code, full API docs and even a reference application.

IMPORTANT: This project now uses an AndroidStudio/gradle build system and the source code may no longer be imported into Eclipse as a library project. Eclipse users may download the latest release binary as a tar.gz file, which may then be imported as an Eclipse Library Project. See the quick start on the project website for more information.

Build Instructions

Known working with Android Studio 0.4.0

Key Gradle build targets:

./gradlew test # run unit tests
./gradlew build # development build
./gradlew uploadArchives -Prelease # release build

License

Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at

    http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.

This software is available under the Apache License 2.0, allowing you to use the library in your applications.

If you want to help with the open source project, contact [email protected]