How to set up Discovery for background scanning on Android?

Use the Android-specific methods `setScanForSeconds` and `setWaitForSeconds` to configure scan cycles. Adjust these based on your app's needs to balance discovery frequency and battery life, as the library follows Android best practices for background BLE.

Discovery vs react-native-ble-plx for Bluetooth in React Native?

Discovery is focused on simple device discovery and identifier exchange with a minimal API, ideal for proximity apps. In contrast, react-native-ble-plx offers comprehensive BLE operations including GATT services, making it better for data-intensive applications like sensor connectivity.

Can Discovery handle multiple Bluetooth devices at once?

Yes, with multi-UUID support, you can initialize separate sessions for different UUIDs and manage discovery and advertising for each independently. This allows handling multiple device groups within a single app, as per the updated API.

How to monitor Bluetooth state changes with Discovery?

Listen to the `bleStateChanged` event using React Native's `DeviceEventEmitter`. This provides updates on whether BLE is on or off, enabling your app to respond dynamically, as demonstrated in the example code snippet.

What's the best way to configure user timeouts in Discovery?

Use the `setUserTimeoutInterval` method to specify how long in seconds a user remains in the list after last detection. Set this based on your app's logic to automatically clean up inactive devices, with a default of 5 seconds.

Does Discovery work with Expo or managed React Native workflows?

No, Discovery requires native linking and manual setup for iOS and Android, so it's not compatible with Expo's managed workflow. You'll need to use the bare workflow or eject to integrate it.

react-native-discovery — BLE Device Discovery Library

What is react-native-discovery?

Discovery is a React Native library that enables apps to discover nearby devices using Bluetooth Low Energy (BLE) and exchange identifier values, functioning reliably in both foreground and background states. It provides a simple API for device discovery and advertising, making it ideal for proximity-based applications.

Target Audience

React Native developers building mobile applications that require proximity-based device discovery, such as social apps, multiplayer games, or location-aware services.

Value Proposition

Developers choose Discovery for its straightforward API that abstracts BLE complexities, reliable foreground/background operation, and cross-platform consistency on iOS and Android.

Discover nearby devices using BLE.

Use Cases

Best For

Building React Native apps that need to detect nearby devices via Bluetooth Low Energy (BLE).
Creating proximity-based applications like social networks or games that exchange user identifiers.
Developing apps requiring reliable device discovery in both foreground and background states.
Implementing multi-UUID support for managing separate discovery sessions within a single app.
Optimizing BLE scanning on Android with customizable scan cycles to conserve battery.
Monitoring Bluetooth state changes in React Native applications through event emitters.

Not Ideal For

Applications requiring extensive data transfer beyond simple identifiers, such as file sharing or streaming.
Projects needing fine-grained control over BLE GATT profiles or custom service/characteristic management.
Teams seeking a zero-config, auto-linked React Native library with modern Expo or CLI integration.
Developers building cross-platform apps not based on React Native.

Pros & Cons

Pros

Simple API Abstraction

Provides straightforward methods like `initialize` and `setShouldAdvertise` to handle BLE discovery without low-level complexities, as shown in the minimal example code.

Reliable Background Operation

Functions consistently in both foreground and background states, enabling proximity-based apps to work even when minimized, as stated in the key features.

Multi-UUID Session Management

Supports initializing and managing multiple UUIDs separately for different discovery sessions, evidenced by the API changes requiring UUID parameters for actions.

Android Battery Optimization

Offers customizable scan cycles with `setScanForSeconds` and `setWaitForSeconds` to follow Android best practices and conserve battery, as detailed in the API section.

Bluetooth State Monitoring

Includes event emitters for real-time BLE state changes via `bleStateChanged`, allowing apps to react dynamically to Bluetooth availability.

Cons

Manual Native Setup

Requires manual steps like dragging Xcode projects and editing Gradle files, which is more complex and error-prone compared to auto-linking in modern React Native.

Platform Callback Inconsistencies

The README notes a 'slight callback discrepancy between the iOS and Android libraries,' forcing developers to handle differences with conditional checks, as seen in the example code.

Limited Data Payload

Only exchanges identifier values or usernames, not supporting larger data transfers, which restricts use cases to simple proximity detection rather than full BLE communication.

Breaking API Changes

Version updates introduced significant API changes, such as requiring UUID parameters for methods that previously didn't need them, which could break existing implementations without clear migration paths.

Frequently Asked Questions

What is react-native-discovery?

Target Audience

React Native developers building mobile applications that require proximity-based device discovery, such as social apps, multiplayer games, or location-aware services.

Value Proposition

Developers choose Discovery for its straightforward API that abstracts BLE complexities, reliable foreground/background operation, and cross-platform consistency on iOS and Android.

Use Cases

Best For

Building React Native apps that need to detect nearby devices via Bluetooth Low Energy (BLE).
Creating proximity-based applications like social networks or games that exchange user identifiers.
Developing apps requiring reliable device discovery in both foreground and background states.
Implementing multi-UUID support for managing separate discovery sessions within a single app.
Optimizing BLE scanning on Android with customizable scan cycles to conserve battery.
Monitoring Bluetooth state changes in React Native applications through event emitters.

Not Ideal For

Applications requiring extensive data transfer beyond simple identifiers, such as file sharing or streaming.
Projects needing fine-grained control over BLE GATT profiles or custom service/characteristic management.
Teams seeking a zero-config, auto-linked React Native library with modern Expo or CLI integration.
Developers building cross-platform apps not based on React Native.

Pros & Cons

Pros

Simple API Abstraction

Provides straightforward methods like `initialize` and `setShouldAdvertise` to handle BLE discovery without low-level complexities, as shown in the minimal example code.

Reliable Background Operation

Functions consistently in both foreground and background states, enabling proximity-based apps to work even when minimized, as stated in the key features.

Multi-UUID Session Management

Supports initializing and managing multiple UUIDs separately for different discovery sessions, evidenced by the API changes requiring UUID parameters for actions.

Android Battery Optimization

Offers customizable scan cycles with `setScanForSeconds` and `setWaitForSeconds` to follow Android best practices and conserve battery, as detailed in the API section.

Bluetooth State Monitoring

Includes event emitters for real-time BLE state changes via `bleStateChanged`, allowing apps to react dynamically to Bluetooth availability.

Cons

Manual Native Setup

Requires manual steps like dragging Xcode projects and editing Gradle files, which is more complex and error-prone compared to auto-linking in modern React Native.

Platform Callback Inconsistencies

The README notes a 'slight callback discrepancy between the iOS and Android libraries,' forcing developers to handle differences with conditional checks, as seen in the example code.

Limited Data Payload

Only exchanges identifier values or usernames, not supporting larger data transfers, which restricts use cases to simple proximity detection rather than full BLE communication.

Breaking API Changes

Frequently Asked Questions

react-native-discovery

What is react-native-discovery?

Overview

Use Cases

Best For

Not Ideal For

Pros & Cons

Pros

Cons

Frequently Asked Questions

Related Projects

Found a gem we're missing?

react-native-discovery

What is react-native-discovery?

Overview

Use Cases

Best For

Not Ideal For

Pros & Cons

Pros

Cons

Frequently Asked Questions

Related Projects

Found a gem we're missing?