doc22940 / rxbluetoothkit

iOS & OSX Bluetooth library for RxSwift

RxBluetoothKit is a Bluetooth library that makes interaction with BLE devices much more pleasant. It's backed by RxSwift and CoreBluetooth and it provides nice API, for both Central and Peripheral modes. All to work with and make your code more readable, reliable and easier to maintain.

Here is a sneak peek of what you can do with RxBluetoothKit:

manager.scanForPeripherals(withServices: [serviceId])
    .take(1)
    .flatMap { $0.peripheral.establishConnection() }
    .flatMap { $0.discoverServices([serviceId]) }
    .flatMap { Observable.from($0) }
    .flatMap { $0.discoverCharacteristics([characteristicId]) }
    .flatMap { Observable.from($0) }
    .flatMap { $0.readValue() }
    .subscribe(onNext: { print("Value: \($0.value)") })

With just 9 lines it started scanning, connecting to the peripheral, discovering service and characteristics and read charecteristic's value!

Central mode features

• Observing manager states
• Scanning for peripherals
• Connecting to peripheral
• Discovering peripheral's services and characteristics
• Reading & Writing to characteristic's value
• Monitoring characteristic value change
• Opening L2CAP channels
• Convenience helper methods
• And a lot more!

Peripheral mode features

• Observing manager states
• Advertising
• Observing read & writes
• Observing subscribe
• Publishing L2CAP channels
• And a lot more!

Recent Changes

5.3.0

• Always connect to retrieved peripherals first (#337)
• Addded a customisation point for injecting a logger (#341)
• Fixed L2CAP API to support OSX 10.14 (#345)

All previous changes

Want to migrate from 4.x to 5.x? Check guidelines here.

Installation

CocoaPods

CocoaPods is a dependency manager for CocoaProjects. To integrate RxBluetoothKit into your Xcode project using CocoaPods specify it in your Podfile:

pod 'RxBluetoothKit'

Then, run the following command: $ pod install

Carthage

Carthage is a decentralized dependency manager that builds your dependencies and provides you with binary frameworks. To integrate RxBluetoothKit into your Xcode project using Carthage specify it in your Cartfile:

github "Polidea/RxBluetoothKit"

Then, run carthage update to build framework and drag RxBluetoothKit.framework into your Xcode project.

Swift Package Manager

Versions >= 4.0 of the library integrate with the Swift Package Manager. In order to do that please specify our project as one of your dependencies in Package.swift file.

Getting Started

Check our Wiki with guidelines to (almost) all library functionalites.

Documentation & Support

• Api reference
• Sample App
• Gitter channel if you want to talk about it, ask questions or give feedback.
• StackOverflow if you have a problem
• Or open an issue on GitHub

Remember to follow Polidea's Blog blog to get all the news and updates!

Contact us

Learn more about Polidea's BLE services here.

Requirements

• iOS 8.0+
• OSX 10.10+
• watchOS 4.0+
• tvOS 11.0+
• Xcode 7.3+

Swift versions

• 3.0 version supports Swift 3.0 and 3.1
• 5.0 version supports Swift 3.2 and 4.0
• 5.1.2 version supports Swift 4.1
• 5.2 version supports Swift 5.0 and 4.2