Easy to use Bluetooth open source library brought to you by Netguru.
๐คน๐ปโโ๏ธ Features
- Handles connection with remote peripherals.
- Handles advertising an iPhone as Bluetooth LE peripheral.
- Closure based read/write/notify requests.
- Built in data conversion method with
Command
wrapper.
๐ฒ Connection:
Below you can find an easy code sample to connect to the peripheral.
Really thats all that is needed
let connection = BluetoothConnection.shared
let characteristic = try! Characteristic(uuid: "your_characteristic_uuid", shouldObserveNotification: true)
let service = try! Service(uuid: "your_service_uuid", characteristics: [characteristic])
let configuration = try! Configuration(services: [service], advertisement: "your_advertising_uuid")
let peripheral = Peripheral(configuration: configuration)
connection.connect(peripheral) { error in
// do awesome stuff
}
๐ก Advertisement:
Below you can find a code sample the setup the iPhone to advertise Bluetooth.
That's all it takes to advertise one service containing one characteristic.
let characteristic = try! Characteristic(uuid: "your_characteristic_uuid")
let service = try! Service(uuid: "your_service_uuid", characteristics: [characteristic])
let configuration = try! Configuration(services: [service], advertisement: "your_service_uuid")
let peripheral = Peripheral(configuration: configuration, advertisementData: [.localName("Test"), .servicesUUIDs("your_service_uuid")])
advertisement.advertise(peripheral: peripheral) { error in
// oh no, something failed in that case
}
๐ ๐ฒ Data transfer:
Of course data transfer is also possible, both for advertising and connection mode!
Below there are some basic examples, for more please see More usage
section ๐๐ป
Connection mode:
let command = Command.utf8String("Hello world")
peripheral.write(command: command, characteristic: someCharacteristic, handler: { error in
// written!
})
peripheral.read(characteristic, handler: { data, error in
// read!
})
Advertisement mode:
let command = Command.int8(3)
advertisement.update(command, characteristic: characteristic) { error in
// data updated!
}
advertisement.writeRequestCallback = { characteristic, data in
// written!
}
โ๏ธ More usage:
For more advanced usage check out documentation page at: https://netguru.github.io/BlueSwift/.
Also feel free to check example project bundled with this repository! ๐ฉ๐ผโ๐ซ ๐จ๐ผโ๐ซ
It's a complete app that allows connection and sending text messages between two iPhones.
๐ Dependency management:
BlueSwift can be drag'n dropped to the project directory,
but what's more important it's supported by most common dependency management!
Just drop the line below to your Podfile:
pod 'BlueSwift'
(but probably you'd like to pin it to the nearest major release, so pod 'BlueSwift' , '~> 1.1.5'
)
The same as with Cocoapods, insert the line below to your Cartfile:
github 'netguru/BlueSwift'
, or including version - github 'netguru/BlueSwift' ~> 1.1.5
๐ License
(As all cool open source software, it's...)
Licensed under MIT license.
Also it would be really nice if you could drop us a line about your usage!!