See: Description
Interface | Description |
---|---|
BleSetupHelper.ResultListener |
This class holds a permission and user defined metadata.
|
BluetoothEnabler.BluetoothEnablerFilter |
Provide an implementation to
BluetoothEnabler.BluetoothEnabler(Activity, BluetoothEnablerFilter) to receive callbacks or simply use the provided class
BluetoothEnabler.DefaultBluetoothEnablerFilter by calling BluetoothEnabler.start(Activity) . |
DebugLogger.LogEvent | |
ForEach_Breakable<T> | |
ForEach_Returning<T> | |
ForEach_Void<T> | |
FutureData |
A simple interface whose implementations should be passed to methods like
BleDevice.write(UUID, FutureData)
so you can provide time-sensitive data at the last possible moment. |
GenericListener_T<T_Event extends Event,T_Return> | |
GenericListener_Void<T_Event extends Event> | |
HistoricalDataCursor |
This interface defines a wrapper around a database cursor (similar to
Cursor )
specific to a database representing a series of HistoricalData serializations. |
LogFunction |
Interface used internally to record log entries where classes don't have access to the logger.
|
P_JSONUtil.JSONApplier | |
P_JSONUtil.JSONExtractor | |
State |
Bitwise enum contract for representing the state of devices and managers.
|
UsesCustomNull |
Interface implemented by some enums and mostly other
Immutable structs
that have custom "null" behavior in place of Java's built-in null . |
UsesInstanceId |
Interface to enforce instance Id methods in classes that use an instance Id.
|
UuidNameMap |
Provide an implementation to
BleManagerConfig.uuidNameMaps . |
Class | Description |
---|---|
BasicUuidNameMap |
Manual convenience implementation of
UuidNameMap that's basically just a HashMap . |
BleManagerConfig_Bonding |
Convenience class for setting common options when communicating with device which require bonding/pairing.
|
BleManagerConfig_LowPower |
Convenience config class to use lower power.
|
BleScanRecord |
Class used to store information from a BLE scan record.
|
BleServices |
Static-only class with some common BLE services for
BleServer.addService(BleService) . |
BleSetupHelper |
This class is used to handle the new hairy logic for getting bluetooth low-energy scan results that is introduced with
Build.VERSION_CODES.M . |
BleSetupHelper.BluetoothEnablerImpl |
This class implements all of the enabler logic that can be overridden to alter the look or the messaging of the enabler.
|
BleSetupHelper.PermissionInstance |
This class holds a permission and user defined metadata.
|
BleSetupHelper.Result |
This class will be passed into your
BleSetupHelper.ResultListener when the enabler finishes |
BleUuid | |
BluetoothEnabler | Deprecated
Use
BleSetupHelper instead. |
BluetoothEnabler.BluetoothEnablerFilter.BluetoothEnablerEvent |
Events passed to
BluetoothEnabler.BluetoothEnablerFilter.onEvent(BluetoothEnablerEvent) so that the programmer can assign logic to the user's decision to
enable or disable certain required permissions and settings. |
BluetoothEnabler.BluetoothEnablerFilter.Please |
Return value for the interface method
BluetoothEnabler.BluetoothEnablerFilter.onEvent(BluetoothEnablerEvent) . |
BluetoothEnabler.DefaultBluetoothEnablerFilter |
A default implementation of BluetoothEnablerListener used in
BluetoothEnabler.start(Activity) . |
CharacteristicBuilder |
Builder class used to create and configure a
BluetoothGattCharacteristic to be entered into a BluetoothGattService . |
CharacteristicPermissions | |
CodeHelper | |
DebugLogger |
Logger class which prints SweetBlue logs to Android's logcat.
|
DescriptorBuilder |
Builder class used to create and configure a
BleDescriptor to be added to a BleCharacteristic . |
DescriptorPermissions | |
Distance |
Wrapper for a positive-only physical distance supporting various units of measurement.
|
EmptyCursor |
An implementation of
Cursor used for error conditions and things like that where we don't want to return null. |
EmptyIterator<T> |
Convenience class for implementing an
Iterator with no elements. |
EpochTime |
A class fulfilling a similar role to Java's built-in
Date , i.e. |
EpochTimeRange |
Class representing a range of time between two instances of
EpochTime . |
Event |
Abstract base class for all events in SweetBlue, e.g.
|
EventQueue | |
ForEach_Breakable.Please | |
GattDatabase |
Use this class to build out a GATT database for your simulated devices when unit testing.
|
HistoricalData |
Simple struct wrapping arbitrary blob data as a byte array along with an epoch timestamp
marking when the blob was originally created/collected.
|
HistoricalDataQuery |
Class used to construct queries for
BleNode.select() . |
HistoricalDataQuery.Part | |
HistoricalDataQuery.Part_AllowsFrom | |
HistoricalDataQuery.Part_AllowsSelectColumn | |
HistoricalDataQuery.Part_ClauseColumn | |
HistoricalDataQuery.Part_From | |
HistoricalDataQuery.Part_Function | |
HistoricalDataQuery.Part_Select | |
HistoricalDataQuery.Part_SelectColumn | |
HistoricalDataQuery.Part_Where | |
Interval |
Used to set time-based options in
BleManagerConfig and BleDeviceConfig and
for various methods and callbacks of BleManager and BleDevice . |
ManufacturerData |
POJO to hold the manufacturer id, and manufacturer data parsed from a device's scan record.
|
NativeScanFilter |
This class is essentially a clone of
ScanFilter . |
NativeScanFilter.Builder |
Builder class for
NativeScanFilter . |
P_Bridge_Utils | |
P_Const |
Class which simply houses static final empty constructs which are used throughout the library (rather than instantiating new ones
every time)
|
P_JSONUtil | |
Percent |
Wrapper for a percentage value, generally from 0-100%;
|
Permissions<T extends Permissions> | |
Pointer<T> |
Provides a way to be able to change a value declared in the outer scope of an anonymous inline class.
|
PresentData |
Simple dummy implementation of
FutureData that just returns whatever is passed into the constructor. |
Properties | |
ReflectionUuidNameMap |
Convenience implementation of
UuidNameMap that takes a Class object
and through reflection attempts to parse out all the static UUID members, for example
on Uuids . |
ServiceBuilder |
Builder class used to help building out
BleService s. |
SingleElementIterator<T> |
Convenience class for implementing an
Iterator with a single element. |
StablePriorityQueue<E> | |
State.ChangeEvent<T_State extends State> |
Abstract base class for
DeviceStateListener.StateEvent and ManagerStateListener.StateEvent . |
TimeEstimator |
A zero-dependency utility class to track running average time of operations
and estimate the completion time of long running operations like firmware updates.
|
TimeTracker | |
Unit<T extends Unit> |
Common abstract base class for all units of measurement, providing default convenience methods
for things like comparison.
|
Util_Unit |
Utility class to handle various things when unit testing, such as generating random mac addresses, random byte arrays.
|
Utils |
Some static utility methods that are probably not very useful outside the library.
|
Utils_Config | |
Utils_Reflection |
Some utilities for dealing with raw byte array scan records.
|
Utils_Rssi |
Some static utility methods for RSSI-related calculations.
|
Utils_ScanRecord |
Some utilities for dealing with raw byte array scan records.
|
Utils_State |
Some helper utilities for dealing with
State implementors. |
Utils_String |
Utility methods for string manipulation and creation needed by SweetBlue, mostly for debug purposes.
|
Utils_Time |
Utilities for dealing with time with an emphasis on BLE.
|
UuidNameMap_ListWrapper |
Convenience implementation that wraps a
List of other UuidNameMap instances. |
Uuids |
A collection of standard
UUID s for services, characteristics, and descriptors. |
Enum | Description |
---|---|
AdvertisingFlag | |
BleScanRecord.Option |
Enumeration for advertising options
|
BleSetupHelper.DefaultString |
Enumerates the built in strings used by the enabler to convey information to users.
|
BleSetupHelper.ErrorCode |
Enumerates the various errors that can happen.
|
BleSetupHelper.Permission |
Enumerates the various permissions that we will try to enable (if needed)
|
BleSetupHelper.State | |
BleUuid.UuidSize |
Enumeration used to dictate the "size" of a
UUID when building a scan packet. |
BluetoothEnabler.BluetoothEnablerFilter.Stage |
Enumerates changes in the "enabling" stage before a
Bluetooth LE scan is started.
|
BluetoothEnabler.BluetoothEnablerFilter.Status |
The Status of the current
BluetoothEnabler.BluetoothEnablerFilter.Stage |
HistoricalDataColumn |
Enumeration/abstraction of database columns used to persist
HistoricalData . |
Phy |
Enumeration used to specify which Bluetooth 5 features to use.
|
State.ChangeIntent |
Enumerates the intention behind a state change - as comprehensively as possible, whether the
application user intended for the state change to happen or not.
|
UpdateThreadType |
Enumeration used to strictly type the different options for SweetBlue's update logic.
|
Utils_String.HexOption | |
Uuids.GATTCharacteristic | |
Uuids.GATTDescriptor | |
Uuids.GATTDisplayType | |
Uuids.GATTFormatType |
Exception | Description |
---|---|
Uuids.GATTCharacteristicFormatTypeConversionException |