MCPcopy Index your code
hub / github.com/RadiusNetworks/android-ibeacon-service

github.com/RadiusNetworks/android-ibeacon-service @0.7.7.1

Chat with this repo
repository ↗ · DeepWiki ↗ · release 0.7.7.1 ↗ · + Follow
246 symbols 498 edges 28 files 72 documented · 29%
What it actually does AI analysis from the code graph — generated when you open this
loading…
README

Android iBeacon Library Build Status

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 david@radiusnetworks.com

Extension points exported contracts — how you extend this code

IBeaconDataFactory (Interface)
This can be configured for the public iBeacon data store, or a private iBeacon data store. In the public data store, you [2 …
src/main/java/com/radiusnetworks/ibeacon/client/IBeaconDataFactory.java
BeaconSimulator (Interface)
Created by dyoung on 4/18/14. [2 implementers]
src/main/java/com/radiusnetworks/ibeacon/simulator/BeaconSimulator.java
IBeaconConsumer (Interface)
An interface for an Android Activity or Service that wants to interact with iBeacons. The int
src/main/java/com/radiusnetworks/ibeacon/IBeaconConsumer.java
MonitorNotifier (Interface)
This interface is implemented by classes that receive iBeacon monitoring notifications @see IBeaconManager#setMonitorNo
src/main/java/com/radiusnetworks/ibeacon/MonitorNotifier.java
RangeNotifier (Interface)
This interface is implemented by classes that receive iBeacon ranging notifications @see IBeaconManager#setRangeNotifie
src/main/java/com/radiusnetworks/ibeacon/RangeNotifier.java

Core symbols most depended-on inside this repo

isDebugEnabled
called by 27
src/main/java/com/radiusnetworks/bluetooth/BluetoothCrashResolver.java
get
called by 17
src/main/java/com/radiusnetworks/ibeacon/IBeaconData.java
getBluetoothAdapter
called by 10
src/main/java/com/radiusnetworks/ibeacon/service/IBeaconService.java
getProximityUuid
called by 7
src/main/java/com/radiusnetworks/ibeacon/Region.java
equals
called by 7
src/main/java/com/radiusnetworks/ibeacon/Region.java
getScanPeriod
called by 6
src/main/java/com/radiusnetworks/ibeacon/IBeaconManager.java
getBetweenScanPeriod
called by 6
src/main/java/com/radiusnetworks/ibeacon/IBeaconManager.java
getMajor
called by 5
src/main/java/com/radiusnetworks/ibeacon/Region.java

Shape

Method 211
Class 27
Interface 8

Languages

Java100%

Modules by API surface

src/main/java/com/radiusnetworks/ibeacon/service/IBeaconService.java37 symbols
src/main/java/com/radiusnetworks/ibeacon/IBeaconManager.java36 symbols
src/main/java/com/radiusnetworks/bluetooth/BluetoothCrashResolver.java30 symbols
src/main/java/com/radiusnetworks/ibeacon/IBeacon.java17 symbols
src/main/java/com/radiusnetworks/ibeacon/service/RangedIBeacon.java13 symbols
src/main/java/com/radiusnetworks/ibeacon/Region.java12 symbols
src/main/java/com/radiusnetworks/ibeacon/service/StartRMData.java10 symbols
src/main/java/com/radiusnetworks/ibeacon/IBeaconData.java9 symbols
src/main/java/com/radiusnetworks/ibeacon/service/RangingData.java8 symbols
src/main/java/com/radiusnetworks/ibeacon/service/MonitoringData.java8 symbols
src/main/java/com/radiusnetworks/ibeacon/service/IBeaconData.java8 symbols
src/test/java/com/radiusnetworks/ibeacon/IBeaconTest.java6 symbols

For agents

$ claude mcp add android-ibeacon-service \
  -- python -m otcore.mcp_server <graph>

⬇ download graph artifact

Ask about this repo answers extend the page