Skip to content

Latest commit

 

History

History
145 lines (98 loc) · 3.83 KB

README.md

File metadata and controls

145 lines (98 loc) · 3.83 KB
Raw

RxHeartRateMonitors

CI Status Version License Platform

RxHeartRateMonitors is a lightweight layer on top of RxSwift, RxBluetoothKit and Core Bluetooth to interact with BTLE Heart Rate Monitors.

It allows you to communicate with Heart Rate Monitors in a seamless way.

  • Connect to BTLE heart rate monitors avoiding the complexities of CoreBluetooth.

  • No need to parse raw data.

  • No need to care about services and characteristics.

  • Extensible. If you want to connect to other types of devices, like speedometers, you can create your own central.

Documentation & Support

See some demonstration code bellow. Also, make sure you checkout the example app. It contains the usual code to interact with monitors: list, connect, disconnect, auto-connect.

Read this medium post I wrote about RxHeartRateMonitors

Found a bug? open an issue on GitHub.

Example

To run the example project, clone the repo, and run pod install from the Example directory first.

Important:

  • Specify a bundle identifier, Team and provisioning profiles to run.

  • You will need an actual device to connect to HR monitors.

Requirements

Swift 4.0

Installation

RxHeartRateMonitors is available through CocoaPods. To install it, simply add the following line to your Podfile:

pod 'RxHeartRateMonitors'

Usage

Import

import RxHeartRateMonitors

Create a central

let central = HeartRateMonitorCentral()

Display bluetooth state

central.state
    .map{"Bluetooth is \($0.isOn ? "ON" : "OFF")"}
    .asDriver(onErrorDriveWith: .never())
    .drive(self.stateLabel.rx.text)
    .disposed(by: disposeBag)

Display monitors in a UITableView

private func bindMonitors(){
    self.central.monitors
        .bind(to: self.table.rx.items) { (table, row, heartRateMonitor) in
            let cell = tv.dequeueReusableCell(withIdentifier: "Cell")!
            cell.textLabel?.text = heartRateMonitor.name
            return cell
        }
    .disposed(by: disposeBag)
}

Connect to a monitor

self.heartRateMonitor
    .connect()
    .subscribe()
    .disposed(by: disposeBag)

Disconnect from a monitor

self.heartRateMonitor
    .disconnect()
    .subscribe()
    .disposed(by: disposeBag)

Display Heart Rate

self.heartRateMonitor
    .heartRate
    .map{$0.description}
    .asDriver(onErrorJustReturn: "N/A")
    .drive(self.heartRateLabel.rx.text)
    .disposed(by: disposeBag)

Display a Monitor's State

self.heartRateMonitor
    .monitoredState
    .asDriver(onErrorJustReturn: .disconnected)
    .map{$0.description}
    .drive(self.stateLabel.rx.text)
    .disposed(by: disposeBag)

Auto-Connect to a previously connected monitor

let monitor : Observable<HeartRateMonitor> = central.whenOnlineConnectToFirstAvailablePeripheral()

Author

Leandro Perez, leandromperez@gmail.com

License

RxHeartRateMonitors is available under the MIT license. See the LICENSE file for more info.