BTKit
Access Ruuvi BLE devices with dot syntax: device.ruuvi?.tag
Scan for Ruuvi BLE devices and access them with dot syntax. See tutorial.
Features
- Listen to RuuviTag advertisements
- Connect/disconnect RuuviTag
- Read RuuviTag logs
- RuuviTag logging in background (firmware 3.27.2+)
Requirements
- iOS 10.0+
- Xcode 12.0+
Installation
CocoaPods
You can use CocoaPods to install BTKit by adding it to your Podfile:
platform :ios, '10.0'
use_frameworks!
pod 'BTKit'Swift Package Manager
You can add link to this repo in XCode/File/Swift Packages/Add Package Dependency...
Usage example
To make it work import BTKit
import BTKitCheck for iPhone/iPad Bluetooth state
view.isBluetoothEnabled = scanner.bluetoothState == .poweredOn
BTForeground.shared.state(self, closure: { (observer, state) in
observer.view.isBluetoothEnabled = state == .poweredOn
})Listen to advertisements in foreground
BTForeground.shared.scan(self) { (observer, device) in
if let ruuviTag = device.ruuvi?.tag {
print(ruuviTag)
}
}Determine if device is out of range or went offline
BTForeground.shared.lost(self, options: [.lostDeviceDelay(10)], closure: { (observer, device) in
if let ruuviTag = device.ruuvi?.tag {
print("Ruuvi Tag is offline or went out of range")
}
})Observe specific device advertisements
BTForeground.shared.observe(self, uuid: ruuviTag.uuid, options: [.callbackQueue(.untouch)]) { (observer, device) in
print("Specific RuuviTag is advertising")
}Connect to specific device
if ruuviTag.isConnectable {
ruuviTag.connect(for: self, options: [.connectionTimeout(10)], connected: { observer, result in
switch result {
case .just:
print("just connected")
case .already:
print("was already connected")
case .disconnected:
print("just disconnected")
case .failure(let error):
print(error.localizedDescription)
}
}, heartbeat: { observer, device in
if let ruuviTag = device.ruuvi?.tag {
print(ruuviTag)
}
}, disconnected: { observer, result in
switch result {
case .just:
print("just disconnected")
case .already:
print("disconnected")
case .stillConnected:
print("still connected because of other callers")
case .failure(let error):
print(error.localizedDescription)
}
})
}or use uuid
BTBackground.shared.connect(for: self, options: [.connectionTimeout(10)], connected: { observer, result in
switch result {
case .just:
print("just connected")
case .already:
print("was already connected")
case .disconnected:
print("just disconnected")
case .failure(let error):
print(error.localizedDescription)
}
}, heartbeat: { observer, device in
if let ruuviTag = device.ruuvi?.tag {
print(ruuviTag)
}
}, disconnected: { observer, result in
switch result {
case .just:
print("just disconnected")
case .already:
print("disconnected")
case .stillConnected:
print("still connected because of other callers")
case .failure(let error):
print(error.localizedDescription)
}
})
}Read temperature, humidity, pressure logs from the connectable device
if let from = Calendar.current.date(byAdding: .minute, value: -5, to: Date()) {
ruuviTag.celisus(for: self, from: from) { (observer, result) in
switch result {
case .success(let values):
print(values)
case .failure(let error):
print(error.localizedDescription)
}
}
ruuviTag.humidity(for: self, from: from) { (observer, result) in
switch result {
case .success(let values):
print(values)
case .failure(let error):
print(error.localizedDescription)
}
}
ruuviTag.pressure(for: self, from: from) { (observer, result) in
switch result {
case .success(let values):
print(values)
case .failure(let error):
print(error.localizedDescription)
}
}
}or use BTKit if you know only the uuid:
BTBackground.shared.services.ruuvi.nus.celisus(for: self, uuid: ruuviTag.uuid, from: from, result: { (observer, result) in
switch result {
case .success(let values):
print(values)
case .failure(let error):
print(error.localizedDescription)
}
})
BTBackground.shared.services.ruuvi.nus.humidity(for: self, uuid: ruuviTag.uuid, from: from, result: { (observer, result) in
switch result {
case .success(let values):
print(values)
case .failure(let error):
print(error.localizedDescription)
}
})
BTBackground.shared.services.ruuvi.nus.pressure(for: self, uuid: ruuviTag.uuid, from: from, result: { (observer, result) in
switch result {
case .success(let values):
print(values)
case .failure(let error):
print(error.localizedDescription)
}
})Read full log in one batch
if let from = Calendar.current.date(byAdding: .minute, value: -5, to: Date()) {
ruuviTag.log(for: self, from: from) { (observer, result) in
switch result {
case .success(let logs):
print(logs)
case .failure(let error):
print(error.localizedDescription)
}
}
}Or use BTKit if you know only the uuid
BTBackground.shared.services.ruuvi.nus.log(for: self, uuid: ruuviTag.uuid, from: from, result: { (observer, result) in
switch result {
case .success(let logs):
print(logs)
case .failure(let error):
print(error.localizedDescription)
}
})Disconnect from the device
ruuviTag.disconnect(for: self) { (observer, result) in
switch result {
case .just:
observer.isConnected = false
case .already:
observer.isConnected = false
case .stillConnected:
observer.isConnected = true
case .failure(let error):
observer.isConnected = false
print(error.localizedDescription)
}
}or use BTKit if you know only uuid
BTBackground.shared.disconnect(for: self, uuid: ruuviTag.uuid) { (observer, result) in
switch result {
case .just:
observer.isConnected = false
case .already:
observer.isConnected = false
case .stillConnected:
observer.isConnected = true
case .failure(let error):
observer.isConnected = false
print(error.localizedDescription)
}
}Contribute
We would love you for the contribution to BTKit, check the LICENSE file for more info.
Meta
Rinat Enikeev – rinat.enikeev@gmail.com
Distributed under the BSD license. See LICENSE for more information.
