Close Menu

beaconmanager

Welcome to the BeaconManager documentation! Here you will find everything you need to know about integrating and using BeaconManager in your iOS application. BeaconManager is a powerful library that allows you to easily detect and interact with Bluetooth beacons.

Getting Started

To get started with BeaconManager, follow the steps below:

  • Install BeaconManager: Open your Xcode project and add BeaconManager to your project using Swift Package Manager or CocoaPods.
  • Import BeaconManager: Import BeaconManager to the files where you want to use it.
  • Set Up Bluetooth Permissions: Add the necessary permissions for Bluetooth to your app’s Info.plist file.
  • Configure BeaconManager: Set up your BeaconManager instance with your app’s configuration.
  • Start Monitoring: Start monitoring for beacons and receive their proximity updates.

API Reference

BeaconManager provides a comprehensive set of APIs that allow you to manage and interact with Bluetooth beacons. Below you will find an overview of the available methods and properties:

BeaconManager

BeaconManager is the main class that you will use to interact with the library. It provides the following important methods and properties:

  • shared: Singleton instance of BeaconManager.
  • initialize(with config: BeaconManagerConfig): Initializes the BeaconManager with the given configuration.
  • startMonitoring(): Starts monitoring for beacons.
  • stopMonitoring(): Stops monitoring for beacons.

BeaconManagerDelegate

The BeaconManagerDelegate protocol provides the necessary delegate methods to receive beacon proximity updates:

  • beaconManager(_:didEnterRegionWithBeacons:): Called when the device enters a monitored region with detected beacons.
  • beaconManager(_:didExitRegionWithBeacons:): Called when the device exits a monitored region with detected beacons.
  • beaconManager(_:didUpdateBeacons:): Called when the device’s proximity to detected beacons changes.
  • beaconManager(_:didFailWithError:): Called when an error occurs during beacon monitoring.

Example Usage

Below is an example of how to use BeaconManager in your iOS application:

import BeaconManager

class MyViewController: UIViewController, BeaconManagerDelegate {
    private var beaconManager: BeaconManager!

    override func viewDidLoad() {
        super.viewDidLoad()

        // Initialize BeaconManager
        let config = BeaconManagerConfig()
        beaconManager = BeaconManager.shared
        beaconManager.delegate = self
        beaconManager.initialize(with: config)

        // Start monitoring for beacons
        beaconManager.startMonitoring()
    }

    // Implement the BeaconManagerDelegate methods
    func beaconManager(_ beaconManager: BeaconManager, didEnterRegionWithBeacons beacons: [Beacon]) {
        // Handle entering a beacon region
    }

    func beaconManager(_ beaconManager: BeaconManager, didExitRegionWithBeacons beacons: [Beacon]) {
        // Handle exiting a beacon region
    }

    func beaconManager(_ beaconManager: BeaconManager, didUpdateBeacons beacons: [Beacon]) {
        // Handle proximity updates for beacons
    }

    func beaconManager(_ beaconManager: BeaconManager, didFailWithError error: Error) {
        // Handle beacon monitoring errors
    }
}

Support

If you encounter any issues or need further assistance, please contact our support team at support@example.com.