Faketooth is a library that allows you to simulate a Bluetooth Low Energy (BLE) interface on iOS/macOS/watchOS/tvOS platforms. It leverages swizzling techniques to emulate a BLE device, enabling you to create virtual peripherals with custom services, characteristics, descriptors, and advertisement data.
You can integrate Faketooth into your project using Swift Package Manager. Simply add the following dependency to your Package.swift file:
dependencies: [
.package(url: "https://github.com/rozd/faketooth.git", from: "0.5.0")
]To start using Faketooth, follow the steps below:
- Import the
Faketoothmodule in your code:
import Faketooth- Set up the simulated peripherals by assigning an array of
FaketoothPeripheralinstances toCBCentralManager.simulatedPeripherals. EachFaketoothPeripheralrepresents a virtual BLE device with its own unique identifier, name, services, advertisement data, and more.
Here's an example that demonstrates the basic usage:
CBCentralManager.simulatedPeripherals = [
FaketoothPeripheral(
identifier: UUID(),
name: "Test",
services: [
FaketoothService(
uuid: CBUUID(),
isPrimary: true,
characteristics: [
FaketoothCharacteristic(
uuid: CBUUID(),
properties: [.read, .notify, .write],
descriptors: [
FaketoothDescriptor(
uuid: CBUUID(string: "2902"),
valueProducer: { () -> Any? in
return Data(capacity: 2)
}
)
],
valueProducer: { "Hello".data(using: .utf8) },
valueHandler: { data in
print("\(String(data: data!, encoding: .utf8)!)")
}
)
]
)
],
advertisementData: [
CBAdvertisementDataLocalNameKey: "Name for Advertisement"
]
)
]In this example, we create a single virtual peripheral named "Test" with a primary service. The service contains one characteristic with read, notify, and write properties. Additionally, the characteristic has a descriptor with a UUID of "2902". We also specify an advertisement name for the peripheral.
- Build and run your project. Faketooth will now simulate the BLE interface, allowing you to interact with your virtual peripherals as if they were real devices.
To help you get started, the Faketooth repository provides examples that demonstrate different use cases and configurations. You can find these examples in the Demo directory.
Contributions to Faketooth are welcome! If you encounter any issues, have questions, or would like to suggest improvements, please open an issue on the GitHub repository.
Faketooth is available under the MIT license. See the LICENSE file for more information.
Thank you for using Faketooth! I hope this library simplifies your BLE testing and development workflows. If you find it helpful, please consider giving it a star on GitHub.