docs: add iOS SDK build and integration instructions (fixes #769) - #864
Open
samerzumot wants to merge 1 commit into
Open
docs: add iOS SDK build and integration instructions (fixes #769)#864samerzumot wants to merge 1 commit into
samerzumot wants to merge 1 commit into
Conversation
…-dev#769) - Add dedicated iOS section in docs/BuildBrainFlow.rst with SPM, XCFramework, permissions, and compilation guides - Add iOS cross-reference to the Swift section in BuildBrainFlow.rst - Add iOS to supported platforms for Synthetic, Streaming, and Playback boards in docs/SupportedBoards.rst
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Description
Fixes #769.
This PR adds comprehensive iOS SDK build, installation, and app integration instructions to the BrainFlow documentation, modeled after the existing Android guide.
Context & Evaluation
tools/apple/build_xcframeworks.sh,tools/apple/regenerate_artifacts.sh) and demo app (swift_package/examples/apps/ios/BrainFlowiOSDemo) were already present in the codebase,docs/BuildBrainFlow.rstpreviously lacked a dedicated iOS section parallel to the Android documentation.swift_package/) are already complete with full API parity (BoardShim,DataFilter,MLModel) and CI tests, so Add swift binding #327 can be closed as completed.Changes Made
docs/BuildBrainFlow.rst:iOSsection (:ref:ios-label``) covering:BrainFlowSwiftPackageRemotewith checksums) and local binary package (BrainFlowSwiftBinaryPackage).BoardController.xcframework,DataHandler.xcframework, andMLModule.xcframeworkin Xcode.NSBluetoothAlwaysUsageDescription,NSBluetoothPeripheralUsageDescription), network access, andPrivacyInfo.xcprivacymanifest requirements.DataFilter.perform_lowpass).tools/apple/build_xcframeworks.shandtools/apple/regenerate_artifacts.sh, artifact layout (XCFrameworks/,BrainFlowSwiftBinaryPackage,SwiftPMArtifacts/), and feature flags (BRAINFLOW_APPLE_BUILD_BLE=ON).swift_package/examples/apps/ios/BrainFlowiOSDemoin Xcode and simulator (including--autorunsmoke testing).AppleBinaryDistribution.rst,AppStoreReadiness.rst, andSwiftAPIParity.rst.:ref:ios-label`` in the Swift precompiled libraries section.docs/SupportedBoards.rst:- iOSto the supported platforms list for Streaming Board, Synthetic Board, and Playback Board.Verification
swift_package/Package.swiftwithswift package dump-package.xcodebuild -list -project swift_package/examples/apps/ios/BrainFlowiOSDemo/BrainFlowiOSDemo.xcodeproj.tools/apple/build_xcframeworks.sh -h.