Skip to content

Latest commit

 

History

History
69 lines (48 loc) · 6.09 KB

README.md

File metadata and controls

69 lines (48 loc) · 6.09 KB

Bluetooth Low Energy Kit

Leveraging swift new concurrency model

SwiftUI example

For an example of using BluetoothLEManager in a SwiftUI application, please follow the link swiftui example.

macOS 11

Main Features

  • Bluetooth Authorization Management
  • Bluetooth Power Management
  • State Publishing
  • User Interface Integration
  • Peripheral Management
  • Multi-platform
  • Utilizing modern concurrency in Swift with Async stream
  • Scanning of available devices
  • Fetching services for discovered devices asynchronously (the example is coming)

macOS 11

Bluetooth LE Manager Implementation Specifics

BluetoothLEManager serves as a wrapper around CBCentralManager, providing a streamlined interface for managing Bluetooth Low Energy (BLE) operations. This package integrates the authorization and power state monitoring specific to Apple's implementation for BLE devices, which simplifies handling these aspects within your application.

Key Implementation Details

  1. Authorization and Power State Management:

    • When a CBCentralManager is instantiated, it automatically prompts the user for Bluetooth authorization if it hasn't been granted yet. This prompt is managed by the system, and no additional code is needed to request authorization.
    • If Bluetooth is turned off during the lifecycle of BluetoothLEManager, the manager will handle this state change and update the relevant properties (isAuthorized, isPowered, etc.) accordingly. This ensures that your application remains informed about the Bluetooth state throughout its lifecycle.

  2. Handling Mid-Lifecycle Bluetooth State Changes:

    • If Bluetooth is turned off or access is denied while BluetoothLEManager is active, the manager will process this change and provide the necessary updates to the state properties. This allows your application to respond to changes in Bluetooth availability dynamically.

  3. User Authorization Handling:

    • When a CBCentralManager is created, it prompts the user for authorization if it hasn't been granted yet. If the user denies this request, BluetoothLEManager will detect this and update its isAuthorized property accordingly.
    • If authorization is denied, the manager can inform the user and suggest that they enable Bluetooth access in the device settings. This ensures that your application can guide users to resolve authorization issues without requiring additional implementation.

  4. Dynamic Scanning Based on Subscribers:

    • BluetoothLEManager manages the scanning process based on the number of active subscribers waiting the peripheral list.
    • Scanning for peripherals starts only when at least one subscriber is connected through the peripheralsStream method to get the list of peripherals. This ensures that scanning is active when there is a need for peripheral data.
    • When the number of subscribers drops to zero, the manager stops scanning to conserve resources and battery life. This allows efficient use of the device's Bluetooth capabilities.

  5. Specifics of Authorizing Access to Bluetooth and Checking Availability for macOS:

    • Detailed guidance on these aspects can be found here.

Public API

Name Type Description Type/Return Type
isAuthorized Property Indicates if Bluetooth is authorized. Bool
isPowered Property Indicates if Bluetooth is powered on. Bool
isScanning Property Indicates if scanning for peripherals is ongoing. Bool
getStatePublisher Property Gets the state publisher from the delegate handler. StatePublisher
getPeripheralPublisher Property Gets the peripheral publisher from the delegate handler. PeripheralPublisher
peripheralsStream Property Provides an asynchronous stream of discovered Bluetooth peripherals. AsyncStream<[CBPeripheral]>
discoverServices Method Discovers services for a given peripheral. Throws an error if service discovery fails or the peripheral is already connected. async throws -> [CBService]

Description of IBluetoothLEManager Protocol

The IBluetoothLEManager protocol encapsulates the essential functionalities required for managing BLE operations. It includes properties for Bluetooth state, scanning status, and publishers for state and peripherals. The protocol also provides a method for discovering services on a given peripheral.

License

This project is licensed under the MIT License.