All Classes Interface Summary Class Summary Exception Summary
| Class |
Description |
| AltBeacon |
The AltBeacon class represents a single hardware AltBeacon detected by
an Android device.
|
| AltBeacon.Builder |
Builder class for AltBeacon objects.
|
| AltBeaconParser |
A specific beacon parser designed to parse only AltBeacons from raw BLE packets detected by
Android.
|
| AndroidModel |
Represents a specific Android device model based on the available device build information
Created by dyoung on 8/28/14.
|
| ArmaRssiFilter |
This filter calculates its rssi on base of an auto regressive moving average (ARMA)
It needs only the current value to do this; the general formula is n(t) = n(t-1) - c * (n(t-1) - n(t))
where c is a coefficient, that denotes the smoothness - the lower the value, the smoother the average
Note: a smoother average needs longer to "settle down"
Note: For signals, that change rather frequently (say, 1Hz or faster) and tend to vary more a recommended
value would be 0,1 (that means the actual value is changed by 10% of the difference between the
actual measurement and the actual average)
For signals at lower rates (10Hz) a value of 0.25 to 0.5 would be appropriate
|
| BackgroundPowerSaver |
Simply creating an instance of this class and holding a reference to it in your Application can
improve battery life by 60% by slowing down scans when your app is in the background.
|
| Beacon |
The Beacon class represents a single hardware Beacon detected by
an Android device.
|
| Beacon.Builder |
Builder class for Beacon objects.
|
| BeaconConsumer |
An interface for an Android Activity or Service
that wants to interact with beacons.
|
| BeaconData |
Server-side data associated with a beacon.
|
| BeaconDataFactory |
This can be configured for the public beacon data store, or a private beacon data store.
|
| BeaconDataNotifier |
Notifies when server-side beacon data are available from a web service.
|
| BeaconIntentProcessor |
Converts internal intents to notifier callbacks
This is used with the BeaconService and supports scanning in a separate process.
|
| BeaconLocalBroadcastProcessor |
Converts internal intents to notifier callbacks
This is used with ScanJob and supports delivering intents even under Android O background
restrictions preventing starting a new IntentService.
|
| BeaconManager |
A class used to set up interaction with beacons from an Activity or Service.
|
| BeaconParser |
Created by dyoung on 7/21/14.
|
| BeaconParser.BeaconLayoutException |
|
| BeaconService |
|
| BeaconSimulator |
Created by dyoung on 4/18/14.
|
| BeaconTransmitter |
Provides a mechanism for transmitting as a beacon.
|
| BleAdvertisement |
Parses a byte array representing a BLE advertisement into
a number of "Payload Data Units" (PDUs).
|
| BleNotAvailableException |
Indicates that Bluetooth Low Energy is not available on this device
|
| BluetoothCrashResolver |
This class provides relief for Android Bug 67272.
|
| BluetoothCrashResolver.UpdateNotifier |
|
| BluetoothMedic |
Utility class for checking the health of the bluetooth stack on the device by running two kinds
of tests: scanning and transmitting.
|
| BluetoothTestJob |
|
| BootstrapNotifier |
|
| Callback |
|
| CurveFittedDistanceCalculator |
This class estimates the distance between the mobile device and a BLE beacon based on the measured
RSSI and a txPower calibration value that represents the expected RSSI for an iPhone 5 receiving
the signal when it is 1 meter away.
|
| CycledLeScanCallback |
Android API agnostic Bluetooth scan callback wrapper.
|
| CycledLeScanner |
|
| CycledLeScannerForJellyBeanMr2 |
|
| CycledLeScannerForLollipop |
|
| DataProviderException |
|
| DetectionTracker |
Created by dyoung on 1/10/15.
|
| DistanceCalculator |
Interface for a class that can estimate the distance between a mobile
device and a beacon based on the measured RSSI and a reference txPower
calibration value.
|
| DistanceConfigFetcher |
Created by dyoung on 12/11/13.
|
| DistinctPacketDetector |
Created by dyoung on 4/8/17.
|
| EddystoneTelemetryAccessor |
Utility class for working beacons that include Eddystone-TLM (telemetry) information
Created by dyoung on 12/21/15.
|
| ExtraDataBeaconTracker |
Keeps track of beacons that have ever been seen and
merges them together depending on configured beacon parsers
Created by dyoung on 5/5/15.
|
| Identifier |
Encapsulates a beacon identifier of arbitrary byte length.
|
| Logger |
Logging interface for logging messages in the android-beacon-library.
|
| Loggers |
Static factory methods for getting different Logger
implementations. |
| LogManager |
Manager for logging in the Altbeacon library.
|
| ModelSpecificDistanceCalculator |
Obtains a DistanceCalculator appropriate for a specific Android model.
|
| ModelSpecificDistanceUpdater |
Created by dyoung on 9/12/14.
|
| MonitoringData |
|
| MonitoringStatus |
|
| MonitorNotifier |
This interface is implemented by classes that receive beacon monitoring notifications
|
| NonBeaconLeScanCallback |
Allows an implementation to see non-Beacon BLE devices as they are scanned.
|
| NullBeaconDataFactory |
|
| Pdu |
Converts a byte string from a Bluetooth LE scan into a Payload Data Unit (PDU)
Created by dyoung on 4/14/15.
|
| ProcessUtils |
Created by dyoung on 3/10/17.
|
| RangedBeacon |
|
| RangeNotifier |
This interface is implemented by classes that receive beacon ranging notifications
|
| RangeState |
|
| RangingData |
Internal class used to transfer ranging data between the BeaconService and the client
|
| Region |
This class represents a criteria of fields used to match beacons.
|
| RegionBootstrap |
Class allowing a user to set up background launching of an app when a user enters a beacon Region.
|
| RegionMonitoringState |
|
| RssiFilter |
Interface that can be implemented to overwrite measurement and filtering
of RSSI values
|
| RunningAverageRssiFilter |
Calculate a RSSI value on base of an arbitrary list of measured RSSI values
The list is clipped by a certain length at start and end and the average
is calculate by simple arithmetic average
|
| ScanFilterUtils |
Created by dyoung on 1/12/15.
|
| ScanJob |
Used to perform scans periodically using the JobScheduler
Only one instance of this will be active, even with multiple jobIds.
|
| ScanJobScheduler |
Schedules two types of ScanJobs:
1.
|
| ScanState |
Stores the full state of scanning for the libary, including all settings so it can be ressurrected easily
for running from a scheduled job
Created by dyoung on 3/26/17.
|
| SettingsData |
Created by dyoung on 3/10/17.
|
| StartRMData |
Internal class used to transfer ranging and monitoring data between the BeaconService and client
|
| StartupBroadcastReceiver |
|
| StaticBeaconSimulator |
Created by dyoung on 4/18/14.
|
| Stats |
Stats module used for internal performance testing of the library
Created by dyoung on 10/16/14.
|
| Stats.Sample |
|
| UrlBeaconUrlCompressor |
Provides encoding / decoding functions for the URL beacon https://github.com/google/uribeacon
|