Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/fitnesskit/bluetoothmessageprotocol
Swift Implementation of Bluetooth Message Protocols. Encode and Decode BLE Characteristics
https://github.com/fitnesskit/bluetoothmessageprotocol
ble blemesh bluetooth characteristics decode encoder homekit-accessory-protocol spm swift swift-package-manager
Last synced: 12 days ago
JSON representation
Swift Implementation of Bluetooth Message Protocols. Encode and Decode BLE Characteristics
- Host: GitHub
- URL: https://github.com/fitnesskit/bluetoothmessageprotocol
- Owner: FitnessKit
- License: mit
- Created: 2017-08-20T16:50:29.000Z (over 7 years ago)
- Default Branch: master
- Last Pushed: 2022-03-12T15:35:02.000Z (over 2 years ago)
- Last Synced: 2024-10-30T12:16:17.852Z (21 days ago)
- Topics: ble, blemesh, bluetooth, characteristics, decode, encoder, homekit-accessory-protocol, spm, swift, swift-package-manager
- Language: Swift
- Homepage: https://fitnesskit.github.io/BluetoothMessageProtocol/
- Size: 289 MB
- Stars: 44
- Watchers: 5
- Forks: 12
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# BluetoothMessageProtocol
[](https://developer.apple.com/swift)
[](http://cocoapods.org/pods/BluetoothMessageProtocol)
[](http://cocoapods.org/pods/BluetoothMessageProtocol)
[](http://cocoapods.org/pods/BluetoothMessageProtocol)
[](http://clayallsopp.github.io/readme-score?url=https://github.com/fitnesskit/bluetoothmessageprotocol)
[](https://codebeat.co/projects/github-com-fitnesskit-bluetoothmessageprotocol-master)
[Docs](https://fitnesskit.github.io/BluetoothMessageProtocol/)
This is not a BLE Manager for your phone. There are plenty of those out there. BluetoothMessageProtocol provides functions for encoding and decoding Bluetooth Characteristic data.
## Installation
BluetoothMessageProtocol is available through [CocoaPods](http://cocoapods.org). To install it, simply add the following line to your Podfile:
```ruby
pod 'BluetoothMessageProtocol'
```
Swift Package Manager:
```swift
dependencies: [
.package(url: "https://github.com/FitnessKit/BluetoothMessageProtocol", from: "2.0.1")
]
```
## How to Use
### Services
The Service class helps to describe a BLE Service. There is no assumption to which Characteristics the Service contains.
Example Using CoreBluetooth:
```swift
centralManager.scanForPeripherals(withServices: [CBUUID(string: ServiceHeartRate.uuidString),],
options: [CBCentralManagerScanOptionAllowDuplicatesKey : true])
```
#### Supported Services
* BLE SIG Services
* Home Kit Accessory Protocol (HAP)
* BLE Mesh
### Characteristic
Each Bluetooth Characteristic has an encode and decode method. When you receive the data from a sensor you call the static decode method to turn the data into a Characteristic Object as seen below in the example:
```swift
func peripheral(_ peripheral: CBPeripheral, didUpdateValueFor characteristic: CBCharacteristic, error: Error?) {
if let sensorData = characteristic.value {
if characteristic.uuid.uuidString == CharacteristicHeartRateMeasurement.uuidString {
doDecodeHRMess(sensorData: sensorData)
}
if characteristic.uuid.uuidString == CharacteristicBodySensorLocation.uuidString {
doDecodeBody(sensorData: sensorData)
}
}
}
func doDecodeHRMess(sensorData: Data) {
let hrData: Result = CharacteristicHeartRateMeasurement.decode(with: sensorData)
switch hrData {
case .success(let char):
print("HR: \(char.heartRate)")
case .failure(let error):
print(error)
}
/// Or you can stil use the doCatch
do {
let hrData = try CharacteristicHeartRateMeasurement.decode(with: sensorData).get()
print("HR: \(hrData.heartRate)")
} catch {
print(error)
}
}
func doDecodeBody(sensorData: Data) {
let sensor: Result = CharacteristicBodySensorLocation.decode(with: sensorData)
switch sensor {
case .success(let char):
print("Location: \(char.sensorLocation.stringValue)")
case .failure(let error):
print(error)
}
/// Or you can stil use the doCatch
do {
let sensor = try CharacteristicBodySensorLocation.decode(with: sensorData).get()
print("Location: \(sensor.sensorLocation.stringValue)")
} catch {
print(error)
}
}
```
### Manufacturer Specific Data
Manufacturer Specific data contains a Company Assigned Number and specific data defined by the Manufacturer.
Example using Apple iBeacon:
```swift
func centralManager(_ central: CBCentralManager, didDiscover peripheral: CBPeripheral, advertisementData: [String : Any], rssi RSSI: NSNumber) {
if let advertData = advertisementData[CBAdvertisementDataManufacturerDataKey] as? Data {
switch ManufacturerDataAppleiBeacon.decode(with: advertData) {
case .success(let beacon):
print(beacon.proximityUUID.uuidString)
case .failure(let error):
print(error)
}
/// Or you can stil use the doCatch
if let beacon = try? ManufacturerDataAppleiBeacon.decode(with: advertData).get() {
print(beacon.proximityUUID.uuidString)
}
}
}
```
#### Manufacturer Specific Data
* Apple iBeacon
* AltBeacon
* HomeKit
* HomeKit Encrypted Notification Advertisement
* Polar Heart Rate
## Author
This package is developed and maintained by Kevin A. Hoogheem
## License
BluetoothMessageProtocol is available under the [MIT license](http://opensource.org/licenses/MIT)