Installation#
BrainAccessKit iOS version 1.0.0 ships as source Swift package plus a prebuilt
.xcframework distribution zip. It is not published to a public package registry; consumers
receive a checkout, archive or local URL from Neurotechnology.
Requirements#
Xcode with Swift 5.9 or newer.
iOS 13.0 or newer for the default SDK products:
BrainAccessKit,BrainAccessCore,BrainAccessProtocolandBrainAccessBLE.iOS 17.0 or newer when Lab Streaming Layer is enabled (source package only), because the caller-supplied
vendor/liblsl.xcframeworkhas that deployment floor.A physical iPhone or iPad for BLE. CoreBluetooth scanning and GATT do not run in the iOS Simulator.
Swift Package Manager (source)#
Add the repository root, the folder containing Package.swift, to your app and depend on the
umbrella product:
// Package.swift for an app or local integration package.
let package = Package(
name: "BrainAccessConsumer",
platforms: [.iOS(.v13)],
dependencies: [
.package(path: "../BrainAccessKit-iOS")
],
targets: [
.target(
name: "BrainAccessConsumer",
dependencies: [
.product(name: "BrainAccessKit", package: "BrainAccessKit")
]
)
]
)
import BrainAccessKit re-exports BrainAccessCore and BrainAccessBLE. Granular products
are available for narrower integrations: BrainAccessProtocol, BrainAccessCore,
BrainAccessBLE and BrainAccessLSL.
Prebuilt xcframework bundle#
Neurotechnology supplies the bundle as BrainAccessKit-1.0.0.zip. It contains:
Path |
Required |
Purpose |
|---|---|---|
|
yes |
Umbrella framework: |
|
yes |
|
|
yes |
Pure Swift wire codec and protocol/configuration types. |
|
yes |
CoreBluetooth transport. |
|
optional |
Local binary package wrapping the xcframeworks as the |
|
yes |
Consumer guide (including the signing status), release notes, license and notices. |
|
optional |
Source-package and LSL guides. |
|
optional |
SwiftUI scan, connect and stream harness and its Xcode project. |
BrainAccessKit-1.0.0.zip.sha256 accompanies the zip for checking it after transfer.
The frameworks in the zip may be signed or only ad-hoc signed; the bundle’s README.md states
which.
Add the bundle folder as a local package and depend on BrainAccessKit, or add all four
frameworks to the app target and set them to Embed & Sign. The prebuilt bundle has no
BrainAccessLSL; LSL is source-package only (BRAINACCESS_ENABLE_LSL=1 plus your own
vendor/liblsl.xcframework from liblsl v1.17.7; Neurotechnology ships no liblsl binary).
Info.plist#
The SDK never writes app Info.plist keys and never presents permission UI. The app must add:
<key>NSBluetoothAlwaysUsageDescription</key>
<string>Connect to your BrainAccess EEG headset.</string>
For background streaming, optionally add bluetooth-central:
<key>UIBackgroundModes</key>
<array>
<string>bluetooth-central</string>
</array>
No location permission is required on iOS: CoreBluetooth scanning needs none.